Loading
Cart Total
$0.00
-
Your shopping cart is empty
Loading
Hello! Log in Your Account
New customer? Start here
Voicemails & Mailboxes
Storefronts
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
Phone Books
VoIP Phone Speed Dial
Text (SMS) Messaging
Mailbox Menus allow Mailboxes to be accessed using an extension number
Become a ResellerFilter:
* You will be charged every time this command is run.
Gets all active Mailbox Menus on an account
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
200 Response
{
"result" : [
{
"created_on" : "2023-02-07",
"extension" : 8001,
"mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
"name" : "Pete's Mailbox Menu",
"updated_on" : "2023-02-07",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"status_code" : 200,
"status_message" : "OK"
}
Gets a specific Mailbox Menu 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 Menu to be queried
200 Response
{
"result" : {
"created_on" : "2023-02-07",
"extension" : 8001,
"mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
"name" : "Pete's Mailbox Menu",
"updated_on" : "2023-02-07",
"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 Menu
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
POST body
Name
Type
Required
extension
Integer
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"
}
201 Response
{
"result" : {
"created_on" : "2023-02-07",
"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"
}
Updates the specified Mailbox Menu
Back to top
Request Details
Response 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
Integer
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"
}
200 Response
{
"result" : {
"created_on" : "2023-02-07",
"extension" : 8001,
"mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
"name" : "Pete's Mailbox Menu",
"updated_on" : "2023-02-07",
"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"
}
Deletes the specified Mailbox Menu
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Mailbox Menu to be deleted
204 Response
{
"result" : {},
"status_code" : 204,
"status_message" : "No Content"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Gets the next valid Mailbox menu extension
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}