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" : [
        {
            "created_on" : "2020-01-20",
            "email_recipients" : [],
            "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
            "mailbox" : "8001",
            "name" : "Pete's Mailbox",
            "password" : "1234",
            "updated_on" : "2020-01-20",
            "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" : {
        "created_on" : "2020-01-20",
        "email_recipients" : [],
        "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
        "mailbox" : "8001",
        "name" : "Pete's Mailbox",
        "password" : "1234",
        "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

Creates a new Mailbox
Back to top

Request Details

Response Details
Request Details

This command has no URL/Query String parameters

POST body
- Name
- Type
- Required
- greeting
  
  String
  
  False
  
  The UUID of the Sound used as a greeting
- mailbox
  
  String
  
  True
  
  The internal name for the Mailbox, this is normal set to match the menu extension number
- name
  
  String
  
  True
  
  The name of this Mailbox
- password
  
  String
  
  False
  
  The 4 digit pass code required to access this mailbox
MailboxEmailRecipient

email_address

String

True

The email address of this Email Recipient
JSON all-fields example:
{ "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b", "mailbox" : "8001", "name" : "Pete's Mailbox", "password" : "1234" }
Response Details

201 Response
```
{
    "result" : {
        "created_on" : "2020-01-20",
        "email_recipients" : [],
        "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
        "mailbox" : "8001",
        "name" : "Pete's Mailbox",
        "password" : "1234",
        "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

- greeting
- String
- False
The UUID of the Sound used as a greeting
- mailbox
- String
- True
The internal name for the Mailbox, this is normal set to match the menu extension number
- name
- String
- True
The name of this Mailbox
- password
- String
- False
The 4 digit pass code required to access this mailbox

MailboxEmailRecipient

- email_address
- String
- True
The email address of this Email Recipient

JSON all-fields example:

{
    "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
    "mailbox" : "8001",
    "name" : "Pete's Mailbox",
    "password" : "1234"
}

Response Details

200 Response

{
    "result" : {
        "created_on" : "2020-01-20",
        "email_recipients" : [],
        "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
        "mailbox" : "8001",
        "name" : "Pete's Mailbox",
        "password" : "1234",
        "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"
}

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"
}
```