json

{
  "PhoneNumber": "+11234567890",
  "AccountId": "AID-ab12345-2725-45a1-bd5e-526ed19799xx",
  "PIN": "1234",
  "FirstName": "John",
  "LastName": "Doe",
  "Email": "john@example.com"
}

{
  "PhoneNumber": "+11234567890",
  "VoicemailActivated": true,
  "Successful": true
}

Numbers

Activate Voicemail

Prerequisites:

Required: Bearer token — POST /v1.0/oauth2/tokens
Required: Provisioned phone number — POST /v1.0/numbers/provision

Activate voicemail for a phone number. Set a PIN, notification email, and subscriber name. Once activated, unanswered calls to this number will be directed to voicemail.

What this does: Enables voicemail on the number and returns a confirmation. Once activated, unanswered calls are captured as voicemail and a notification is sent to the configured email. The PIN is required to retrieve messages.

Next steps:

Confirm voicemail is active — POST /v1.0/numbers/voicemail/info
Update settings — POST /v1.0/numbers/voicemail/update

POST

v1.0

numbers

voicemail

activate

json

{
  "PhoneNumber": "+11234567890",
  "AccountId": "AID-ab12345-2725-45a1-bd5e-526ed19799xx",
  "PIN": "1234",
  "FirstName": "John",
  "LastName": "Doe",
  "Email": "john@example.com"
}

{
  "PhoneNumber": "+11234567890",
  "VoicemailActivated": true,
  "Successful": true
}

Body

application/json

PhoneNumber

string

required

The phone number to activate voicemail for (E.164 format)

Example:

"+11234567890"

AccountId

string

Optional account ID associated with the phone number

Example:

"AID-ab12345-2725-45a1-bd5e-526ed19799xx"

string

Voicemail PIN for the subscriber

Example:

"1234"

FirstName

string

Subscriber first name

Example:

"John"

LastName

string

Subscriber last name

Example:

"Doe"

string

Email address for voicemail notifications

Example:

"john@example.com"

Response

Success — returns voicemail activation status

The response is of type object.

Get Voicemail Info Update Voicemail

⌘I

Documentation Index

Body

Response