Shared voicemails

List shared voicemails.

get

Retrieve a collection of shared voicemails.

Authorizations
Query parameters
filterstringOptional

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

searchstringOptional

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

orderbystringOptional

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

skipinteger · int32Optional

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

Default: 0
topinteger · int32 · min: 1 · max: 100Optional

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

Default: 100
Responses
200

OK

application/json
get
/shared_voicemails
GET /api/shared_voicemails HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create a shared voicemail

post

Add a new shared voicemail.

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}
promptall ofOptional

The prompt set name of shared voicemail.

stringOptional

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: en-US
enable_pinbooleanOptional

Whether the PIN is required to access shared voicemail.

Default: true
pinstring · min: 6 · max: 10Required

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_notifybooleanOptional

Enable email notify or not.

Default: false
recipientsstringOptional

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

play_datetimestring · enumOptional

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.
Possible values:
Responses
201

Created

application/json
post
/shared_voicemails
POST /api/shared_voicemails HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

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

Retrieve a shared voicemail

get

Retrieve shared voicemail by ID.

Authorizations
Path parameters
idall ofRequired

The unique ID of shared voicemail.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
get
/shared_voicemails/{id}
GET /api/shared_voicemails/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update a shared voicemail

post

Update a shared voicemail

Authorizations
Path parameters
idall ofRequired

The unique ID of shared voicemail.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
namestring · min: 1 · max: 64Optional

The name of shared voicemail.

promptall ofOptional

The prompt set name of shared voicemail.

stringOptional

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: en-US
enable_pinbooleanOptional

Whether the PIN is required to access shared voicemail.

Default: true
pinstring · min: 6 · max: 10Optional

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_notifybooleanOptional

Enable email notify or not.

Default: false
recipientsstringOptional

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

play_datetimestring · enumOptional

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.
Possible values:
Responses
200

OK

No content
post
/shared_voicemails/{id}
POST /api/shared_voicemails/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "name": "text",
  "prompt": "en-US",
  "enable_pin": true,
  "pin": "text",
  "enable_email_notify": false,
  "recipients": "text",
  "play_datetime": "DISABLE"
}
No content
PreviousDestroyNextDestroy