Customer Management
Storefronts
- Invoices
- Credit Notes
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
Wallboard Statistics
VoIP Phone Provisioning
- Devices
Call Queueing
Phone Books
- Phone Book
- Phone Book Contact

API Access

Build custom apps using our JSON API

Configure API

Mailboxes

Mailboxes are used in call routes to allow callers to leave a voicemail message

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

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

GET/voip/mailbox

Gets all active mailboxes on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "beep" : true,
            "created_on" : "2021-12-03",
            "email_recipients" : [
                {
                    "created_on" : "2021-12-03",
                    "updated_on" : "2021-12-03",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
                }
            ],
            "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
            "name" : "Pete's Mailbox",
            "password" : "1234",
            "play_caller_id" : true,
            "play_timestamp" : true,
            "transcribe" : true,
            "updated_on" : "2021-12-03",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/mailbox/{uuid}

Gets the details for a specific mailbox 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 to be queried

Response Details

200 Response

{
    "result" : {
        "beep" : true,
        "created_on" : "2021-12-03",
        "email_recipients" : [
            {
                "created_on" : "2021-12-03",
                "updated_on" : "2021-12-03",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
            }
        ],
        "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
        "name" : "Pete's Mailbox",
        "password" : "1234",
        "play_caller_id" : true,
        "play_timestamp" : true,
        "transcribe" : true,
        "updated_on" : "2021-12-03",
        "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

Creates a new Mailbox

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- beep
- boolean
- False
Should the system play the 'beep' sound after the greeting
- greeting
- String
- False
The UUID of the Sound used as a greeting
- name
- String
- True
The name of this Mailbox
- password
- String
- False
The 4 digit pass code required to access this mailbox
- play_caller_id
- boolean
- False
Should the voicemail system announce the caller ID of the message
- play_timestamp
- boolean
- False
Should the voicemail system announce the date and time the message was received
- transcribe
- boolean
- False
When set to true, incoming messages will be transcribed by the system

MailboxEmailRecipient

JSON all-fields example:

{
    "beep" : true,
    "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
    "name" : "Pete's Mailbox",
    "password" : "1234",
    "play_caller_id" : true,
    "play_timestamp" : true,
    "transcribe" : true
}

Response Details

201 Response

{
    "result" : {
        "beep" : true,
        "created_on" : "2021-12-03",
        "email_recipients" : [
            {
                "created_on" : "2021-12-03",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
            }
        ],
        "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
        "name" : "Pete's Mailbox",
        "password" : "1234",
        "play_caller_id" : true,
        "play_timestamp" : true,
        "transcribe" : true,
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

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

PUT/voip/mailbox/{uuid}

Updates the specified mailbox

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

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

PUT body

Name
Type
Required

- beep
- boolean
- False
Should the system play the 'beep' sound after the greeting
- greeting
- String
- False
The UUID of the Sound used as a greeting
- name
- String
- True
The name of this Mailbox
- password
- String
- False
The 4 digit pass code required to access this mailbox
- play_caller_id
- boolean
- False
Should the voicemail system announce the caller ID of the message
- play_timestamp
- boolean
- False
Should the voicemail system announce the date and time the message was received
- transcribe
- boolean
- False
When set to true, incoming messages will be transcribed by the system

MailboxEmailRecipient

JSON all-fields example:

{
    "beep" : true,
    "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
    "name" : "Pete's Mailbox",
    "password" : "1234",
    "play_caller_id" : true,
    "play_timestamp" : true,
    "transcribe" : true
}

Response Details

200 Response

{
    "result" : {
        "beep" : true,
        "created_on" : "2021-12-03",
        "email_recipients" : [
            {
                "created_on" : "2021-12-03",
                "updated_on" : "2021-12-03",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
            }
        ],
        "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
        "name" : "Pete's Mailbox",
        "password" : "1234",
        "play_caller_id" : true,
        "play_timestamp" : true,
        "transcribe" : true,
        "updated_on" : "2021-12-03",
        "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"
}

DELETE/voip/mailbox/{uuid}

Deletes the specified mailbox
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 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"
}
```