Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Shared Voicemail

Retrieve a shared voicemail

Retrieve shared voicemail by ID.

get/shared_voicemails/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the shared voicemail.

Response

OK

idstring

The unique ID of the resource.

namestring

The name of shared voicemail.

extension_numberstring

The extension number.

promptstring

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.

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_datetime'DISABLE' | '12_HOUR_CLOCK' | '24_HOUR_CLOCK'

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.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "prompt": "en-US"
}