Shared voicemails

PreviousDestroy NextDestroy

Was this helpful?

List shared voicemails.

Retrieve a collection of shared voicemails.

get

/shared_voicemails

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/shared_voicemails' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "name": "text",
      "extension_number": "text",
      "enable_pin": true,
      "pin": "text",
      "enable_email_notify": false,
      "recipients": "text",
      "play_datetime": "DISABLE",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "prompt": "en-US"
    }
  ]
}

Create a shared voicemail

Add a new shared voicemail.

post

/shared_voicemails

Authorizations

Body

namestring · min: 1 · max: 64required

The name of shared voicemail.

extension_numberstring · min: 3 · max: 64required

The extension number.

Pattern: [0-9]{3,64}

enable_pinboolean · default: true

Whether the PIN is required to access shared voicemail.

pinstring · min: 6 · max: 10required

The PIN number for accessing.
The PIN policies include:

A sequence of numbers 6-10 digits in length.
No repeating numbers (e.g. "111", "222")
No sequential numbers (e.g. "012", "789")

enable_email_notifyboolean

Enable email notify or not.

recipientsstring

Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.

play_datetimestring · enum

Announces Date and Time of Message.

DISABLE: Do not read;
12_HOUR_CLOCK: Read in 12-hour clock;
24_HOUR_CLOCK: Read in 24-hour clock.

Options: DISABLE, 12_HOUR_CLOCK, 24_HOUR_CLOCK

promptall of

The prompt set name of shared voicemail.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/shared_voicemails' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","extension_number":"text","enable_pin":true,"pin":"text","enable_email_notify":false,"play_datetime":"DISABLE","prompt":"en-US"}'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve a shared voicemail

Retrieve shared voicemail by ID.

get

/shared_voicemails/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of shared voicemail.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/shared_voicemails/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "name": "text",
  "extension_number": "text",
  "enable_pin": true,
  "pin": "text",
  "enable_email_notify": false,
  "recipients": "text",
  "play_datetime": "DISABLE",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "prompt": "en-US"
}

Update a shared voicemail

post

/shared_voicemails/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of shared voicemail.

Body

namestring · min: 1 · max: 64

The name of shared voicemail.

enable_pinboolean · default: true

Whether the PIN is required to access shared voicemail.

pinstring · min: 6 · max: 10

The PIN number for accessing.
The PIN policies include:

A sequence of numbers 6-10 digits in length.
No repeating numbers (e.g. "111", "222")
No sequential numbers (e.g. "012", "789")

enable_email_notifyboolean

Enable email notify or not.

recipientsstring

Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.

play_datetimestring · enum

Announces Date and Time of Message.

DISABLE: Do not read;
12_HOUR_CLOCK: Read in 12-hour clock;
24_HOUR_CLOCK: Read in 24-hour clock.

Options: DISABLE, 12_HOUR_CLOCK, 24_HOUR_CLOCK

promptall of

The prompt set name of shared voicemail.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/shared_voicemails/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"enable_pin":true,"enable_email_notify":false,"play_datetime":"DISABLE","prompt":"en-US"}'

200

4XX

No body