Cart Total
$0.00
-
Your shopping cart is empty
Loading
-
Hello! Log in Your Account
Log inNew customer? Start here
Loading
Hello! Log in Your Account
New customer? Start here
Voicemails & Mailboxes
Customer Management
VoIP Bundle (Subscriptions)
SIP Account Management
Audio Management
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
eFax Management
Voicemails & Mailboxes
Caller ID
SIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
Call Queueing
Latest
News
Alex - April 9 2021
Alex - December 17 2020
Alex - November 25 2020
Mailboxes are used in call routes to allow callers to leave a voicemail message
Become a ResellerFilter:
* You will be charged every time this command is run.
Gets all active mailboxes on an account
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
200 Response
{
"result" : [
{
"beep" : true,
"created_on" : "2021-04-15",
"email_recipients" : [],
"greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
"mailbox" : "8001",
"name" : "Pete's Mailbox",
"password" : "1234",
"play_caller_id" : false,
"play_timestamp" : false,
"transcribe" : true,
"updated_on" : "2021-04-15",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"status_code" : 200,
"status_message" : "OK"
}Gets the details for a specific mailbox on an account
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Mailbox to be queried
200 Response
{
"result" : {
"beep" : true,
"created_on" : "2021-04-15",
"email_recipients" : [],
"greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
"mailbox" : "8001",
"name" : "Pete's Mailbox",
"password" : "1234",
"play_caller_id" : false,
"play_timestamp" : false,
"transcribe" : true,
"updated_on" : "2021-04-15",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 200,
"status_message" : "OK"
}404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}Creates a new Mailbox
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
POST body
Name
Type
Required
beep
Boolean
False
Should the beep be played after the greeting
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
play_caller_id
Boolean
False
Read back the caller ID of the message when listening to it
play_timestamp
Boolean
False
Play back the timestamp when listening to messages
transcribe
Boolean
False
Should messages received by the mailbox be transcribed (maximum duration is 1 minute for transcriptions)
email_address
String
True
The email address of this Email Recipient
JSON all-fields example:
{
"beep" : true,
"greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
"mailbox" : "8001",
"name" : "Pete's Mailbox",
"password" : "1234",
"play_caller_id" : false,
"play_timestamp" : false,
"transcribe" : true
}201 Response
{
"result" : {
"beep" : true,
"created_on" : "2021-04-15",
"email_recipients" : [],
"greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
"mailbox" : "8001",
"name" : "Pete's Mailbox",
"password" : "1234",
"play_caller_id" : false,
"play_timestamp" : false,
"transcribe" : true,
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 201,
"status_message" : "Created"
}400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}Updates the specified mailbox
Back to top
Request Details
Response 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 beep be played after the greeting
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
play_caller_id
Boolean
False
Read back the caller ID of the message when listening to it
play_timestamp
Boolean
False
Play back the timestamp when listening to messages
transcribe
Boolean
False
Should messages received by the mailbox be transcribed (maximum duration is 1 minute for transcriptions)
email_address
String
True
The email address of this Email Recipient
JSON all-fields example:
{
"beep" : true,
"greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
"mailbox" : "8001",
"name" : "Pete's Mailbox",
"password" : "1234",
"play_caller_id" : false,
"play_timestamp" : false,
"transcribe" : true
}200 Response
{
"result" : {
"beep" : true,
"created_on" : "2021-04-15",
"email_recipients" : [],
"greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
"mailbox" : "8001",
"name" : "Pete's Mailbox",
"password" : "1234",
"play_caller_id" : false,
"play_timestamp" : false,
"transcribe" : true,
"updated_on" : "2021-04-15",
"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"
}Deletes the specified mailbox
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Mailbox to be deleted
204 Response
{
"result" : {},
"status_code" : 204,
"status_message" : "No Content"
}404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
