Customer Management
VoIP Bundle (Subscriptions)
- VoIP Subscription Bundle
SIP Account Management
Audio Management
- Sounds
- Playlists
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
- Short Codes
eFax Management
- Fax Messages
- Fax Authorized Senders
Voicemails & Mailboxes
Caller ID
- Caller IDs
- Caller ID Requests
SIP Trunks
- Trunk Authentication
- VoIP Trunks
VoIP Phone Provisioning
- Devices
Call Queueing

API Access

Build custom apps using our JSON API

Configure API

11 July 2019

We’re ISO accredited G-Cloud 11 suppliers

By Adrian
27 June 2019

Exciting New Features Added to the Yay.com Calling App

By Meg

Mailbox Menus

Mailbox Menus allow Mailboxes to be accessed using an extension number

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/voip/mailbox-menu

Gets all active Mailbox Menus on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "created_on" : "2020-01-20",
            "extension" : 8001,
            "mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
            "name" : "Pete's Mailbox Menu",
            "updated_on" : "2020-01-20",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/mailbox-menu/{uuid}

Gets a specific Mailbox Menu on an account

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Mailbox Menu to be queried

Response Details

200 Response

{
    "result" : {
        "created_on" : "2020-01-20",
        "extension" : 8001,
        "mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
        "name" : "Pete's Mailbox Menu",
        "updated_on" : "2020-01-20",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

POST/voip/mailbox-menu

Creates a new Mailbox Menu

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- extension
- int
- True
The extension number assigned to this Mailbox Menu
- mailbox
- String
- True
The UUID of the Mailbox this Menu provides access to, or 'personal' if linked to a User's personal Mailbox
- name
- String
- True
The name of this Mailbox Menu

JSON all-fields example:

{
    "extension" : 8001,
    "mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
    "name" : "Pete's Mailbox Menu"
}

Response Details

201 Response

{
    "result" : {
        "created_on" : "2020-01-20",
        "extension" : 8001,
        "mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
        "name" : "Pete's Mailbox Menu",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

409 Response

{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}

PUT/voip/mailbox-menu/{uuid}

Updates the specified Mailbox Menu

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Mailbox Menu to be updated

PUT body

Name
Type
Required

- extension
- int
- True
The extension number assigned to this Mailbox Menu
- mailbox
- String
- True
The UUID of the Mailbox this Menu provides access to, or 'personal' if linked to a User's personal Mailbox
- name
- String
- True
The name of this Mailbox Menu

JSON all-fields example:

{
    "extension" : 8001,
    "mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
    "name" : "Pete's Mailbox Menu"
}

Response Details

200 Response

{
    "result" : {
        "created_on" : "2020-01-20",
        "extension" : 8001,
        "mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
        "name" : "Pete's Mailbox Menu",
        "updated_on" : "2020-01-20",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

409 Response

{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}

DELETE/voip/mailbox-menu/{uuid}

Deletes the specified Mailbox Menu
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Mailbox Menu to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```
GET/voip/next-extension/mailbox-menu

Gets the next valid Mailbox menu extension
Back to top

Request Details

Response Details

Request Details

This command has no URL/Query String parameters
Response Details

400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```