Shared voicemails

List shared voicemails.

Retrieve a collection of shared voicemails.

GEThttp://127.0.0.1:8888/api/shared_voicemails

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/shared_voicemails', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a shared voicemail

Add a new shared voicemail.

POSThttp://127.0.0.1:8888/api/shared_voicemails

Body

application/json

name*string

The name of shared voicemail.

extension_number*string

The extension number.

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

promptall of

The prompt set name of shared voicemail.

enable_pinboolean

Whether the PIN is required to access shared voicemail.

pin*string

The PIN number for accessing.
The PIN policies include:

1. A sequence of numbers 6-10 digits in length.
2. No repeating numbers (e.g. "111", "222")
3. 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_datetimeenum

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.

DISABLE12_HOUR_CLOCK24_HOUR_CLOCK

Response

2014XX

Created

Body

application/json

idall of

The unique ID of shared voicemail.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/shared_voicemails', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "extension_number": "text",
      "pin": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve a shared voicemail

Retrieve shared voicemail by ID.

GEThttp://127.0.0.1:8888/api/shared_voicemails/{id}

Path parameters

id*all of

The unique ID of shared voicemail.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of shared voicemail.

namestring

The name of shared voicemail.

extension_numberstring

The extension number.

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

promptall of

The prompt set name of shared voicemail.

enable_pinboolean

Whether the PIN is required to access shared voicemail.

pinstring

The PIN number for accessing.
The PIN policies include:

1. A sequence of numbers 6-10 digits in length.
2. No repeating numbers (e.g. "111", "222")
3. 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_datetimeenum

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.

DISABLE12_HOUR_CLOCK24_HOUR_CLOCK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/shared_voicemails/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update a shared voicemail

Update a shared voicemail

POSThttp://127.0.0.1:8888/api/shared_voicemails/{id}

Path parameters

id*all of

The unique ID of shared voicemail.

Body

application/json

namestring

The name of shared voicemail.

promptall of

The prompt set name of shared voicemail.

enable_pinboolean

Whether the PIN is required to access shared voicemail.

pinstring

The PIN number for accessing.
The PIN policies include:

1. A sequence of numbers 6-10 digits in length.
2. No repeating numbers (e.g. "111", "222")
3. 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_datetimeenum

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.

DISABLE12_HOUR_CLOCK24_HOUR_CLOCK

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/shared_voicemails/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();