Create Voicemail

Add a new Voicemail to an account.

Notes

label

Name/Label of the Voicemail box.

access_id

1 to 6 digit access id to access a voicemail box.

access_pin

1 to 6 digit access pin to access a voicemail box.

email_preference

Voicemail messages can be delivered to an email address. Delivery of the messages depends on the email preference. Email preference can be:

  • OnDemand - Default option. Messages won't be delivered to an email unless it is asked.
  • Notification - Only notification of the message will be sent to an email address.
  • Message - Message audio file will be sent to an email address.

email

Email address for the email delivery of voicemail messages.

delete_emailed_messages

Delete emailed messages from voicemail box or not. It is advisable to keep this option true.

Sample Response

{
  "voicemail": {
    "id": "VM1212121211",
    "label": "Test VM 1",
    "access_id": "1111",
    "access_pin": "1111",
    "email_preference": "Notification",
    "email": "[email protected]",
    "delete_emailed_messages": true,
    "active": true
  }
}

Response Properties

PropertyTypeDescription
idstringVoicemail ID
labelstringName/Label for Voicemail
access_idstring1 to 6 digit access id
access_pinstring1 to 6 digit access pin
email_preferencestringOne of the Email preference - Message, Notification or OnDemand
emailstringEmail address for sending voicemail messages
delete_emailed_messagesbooleanDelete emailed message or not
activebooleanVoicemail box is active or not
Language
Authentication
Header
Response
Click Try It! to start a request and see the response here!