Create a shared voicemail box

post

https://api.emaktalk.com/api/v1/voicemails

Creates a shared voicemail box on an account you administer. Leave voicemail_id out and a mailbox number is allocated for you from 2000–2999; a number you choose must not collide with an existing extension or mailbox and must stay clear of the reserved 10000–19999 range. The mailbox's own identifier is assigned by the server, and voicemail_attach_file and voicemail_name_base64 are always stored empty. Options, copy destinations and greetings are written after the mailbox itself, so one of those can fail once the mailbox already exists.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

domain_uuid

string

Identifier of the account to create the mailbox on; defaults to your current account, and you must be able to administer it.

voicemail_id

string | null

The dialable mailbox number; leave it out to have one allocated from 2000–2999, and a number you choose must avoid existing extensions and mailboxes and the reserved 10000–19999 range.

voicemail_password

string | null

Mailbox password, at least four characters after trimming; defaults to 1234 when you send nothing.

greeting_id

number | null

The greeting to play; defaults to none.

voicemail_alternate_greet_id

string | null

Alternate greeting to play; forwarded as sent, without conversion or validation.

voicemail_mail_to

string | null

Email address to send voicemail to; an empty value is stored as none.

voicemail_file

string | null

How the voicemail audio is attached to the email.

voicemail_sms_to

string | null

Phone number to notify by SMS.

voicemail_description

string | null

Description of the mailbox.

voicemail_local_after_email

boolean

Whether to keep the message in the mailbox after emailing it; defaults to false.

voicemail_enabled

boolean

Whether the mailbox accepts messages; defaults to true.

voicemail_transcription_enabled

boolean

Whether messages are transcribed; defaults to false.

voicemail_tutorial

boolean

Whether the first-login tutorial runs; defaults to false.

voicemail_recording_instructions

boolean

Whether the caller hears recording instructions; defaults to true.

voicemail_recording_options

boolean

Whether the caller hears the post-recording options; defaults to true.

voicemail_options

string

Keypad options for the mailbox; each entry carries voicemail_option_uuid, digits, action, param, order and description.

voicemail_destinations

array of objects

Other mailboxes to copy messages to; each entry carries voicemail_destination_uuid and voicemail_uuid_copy.

voicemail_destinations

voicemail_greetings

string

Greetings to attach; each entry carries voicemail_greeting_uuid, greeting_id, greeting_name and greeting_filename, with an optional description, audit fields, and a greeting_action of create, update, delete or none.

Responses

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The shared mailbox was created.

400The body is empty, the mailbox settings are invalid or conflict with an existing number, no number could be allocated, or the create failed.

403The API key cannot administer the target account.