Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Shared Voicemails

Manage your shared voicemail.

List shared voicemails.

get

Retrieve a collection of shared voicemails.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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
countinteger · int64Optional

Total number of resource.

Example: 100
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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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}
promptstringOptional

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
idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptional

The unique ID of the resource.

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

The name of shared voicemail.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

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

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:
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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

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

The name of shared voicemail.

promptstringOptional

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

Destroy a shared voicemail

post

Destroy a shared voicemail

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
post/shared_voicemails/{id}/destroy
POST /api/shared_voicemails/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List shared voicemail mails

get

Retrieve a collection of shared voicemail mails.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
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
countinteger · int64Optional

Total number of resource.

Example: 100
get/shared_voicemails/{id}/voicemails
GET /api/shared_voicemails/{id}/voicemails HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "sender": "text",
      "created_at": "2017-07-21T17:32:28Z",
      "duration": 1,
      "status": "READ",
      "file_name": "text",
      "file_size": 0,
      "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
    }
  ]
}

Retrieve a shared voicemail mail

get

Retrieve shared voicemail mail details.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
mail_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
senderstringOptional

The sender number of the voicemail.

created_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
durationinteger · int32Optional

The playback time (in seconds).

statusstring · enumOptional

Status of the voicemail includes:

  • READ: read mail
  • UNREAD: unread mail
Possible values:
file_namestringOptional

The name of the file.

file_sizeinteger · int64Optional

The file size in bytes.

Example: 0
file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK
get/shared_voicemails/{id}/voicemails/{mail_id}
GET /api/shared_voicemails/{id}/voicemails/{mail_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "sender": "text",
  "created_at": "2017-07-21T17:32:28Z",
  "duration": 1,
  "status": "READ",
  "file_name": "text",
  "file_size": 0,
  "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}

Update shared voicemail mail status to read

post

Update shared voicemail mail status to read

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
mail_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

No content
post/shared_voicemails/{id}/voicemails/{mail_id}/set_read
POST /api/shared_voicemails/{id}/voicemails/{mail_id}/set_read HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update shared voicemail mail status to unread

post

Update shared voicemail mail status to unread

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
mail_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

No content
post/shared_voicemails/{id}/voicemails/{mail_id}/set_unread
POST /api/shared_voicemails/{id}/voicemails/{mail_id}/set_unread HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete a shared voicemail mail

post

Remove a mail from shared voicemail.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
mail_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
post/shared_voicemails/{id}/voicemails/{mail_id}/destroy
POST /api/shared_voicemails/{id}/voicemails/{mail_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List shared voicemail greetings

get

Retrieves a collection of greetings of shared voicemail.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

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

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "enabled": true,
      "file_name": "text",
      "file_size": 0,
      "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
    }
  ]
}

Create voicemail greeting for shared voicemail

post

Create voicemail greeting for shared voicemail.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
file_idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
201

OK

application/json
idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
post/shared_voicemails/{id}/greetings
POST /api/shared_voicemails/{id}/greetings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "file_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Enable one of shared voicemail's greetings.

post

Set one of shared voicemail's greetings to activated state.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
greeting_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

No content
post/shared_voicemails/{id}/greetings/{greeting_id}/enable
POST /api/shared_voicemails/{id}/greetings/{greeting_id}/enable HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Disable shared voicemail greeting

post

Disable shared voicemail greeting by it's unique ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
greeting_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

No content
post/shared_voicemails/{id}/greetings/{greeting_id}/disable
POST /api/shared_voicemails/{id}/greetings/{greeting_id}/disable HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete shared voicemail greeting

post

Destroy a greeting from shared voicemail.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
greeting_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
post/shared_voicemails/{id}/greetings/{greeting_id}/destroy
POST /api/shared_voicemails/{id}/greetings/{greeting_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousRing Groups
NextSecurity

Last updated

Was this helpful?