Shared Voicemails
Manage your shared voicemail.
Retrieve a collection of shared voicemails.
Use the filter
query parameter to retrieve just a subset of a collection.
Use the search
query parameter to restrict the results of a request to match a search criterion.
Use the orderby
query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip
query parameter to set the number of items to skip at the start of a collection.
0
Use the top
query parameter to specify the page size of the result set.
100
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"
}
]
}
Add a new shared voicemail.
The name of shared voicemail.
The extension number.
[0-9]{3,64}
The prompt set name of shared voicemail.
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.
en-US
Whether the PIN is required to access shared voicemail.
true
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 notify or not.
false
Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.
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.
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 shared voicemail by ID.
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
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
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The name of shared voicemail.
The prompt set name of shared voicemail.
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.
en-US
Whether the PIN is required to access shared voicemail.
true
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 notify or not.
false
Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.
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.
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
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
POST /api/shared_voicemails/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of shared voicemail mails.
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
Use the filter
query parameter to retrieve just a subset of a collection.
Use the search
query parameter to restrict the results of a request to match a search criterion.
Use the orderby
query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip
query parameter to set the number of items to skip at the start of a collection.
0
Use the top
query parameter to specify the page size of the result set.
100
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 shared voicemail mail details.
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The unique ID of voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
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
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The unique ID of voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
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
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The unique ID of voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
POST /api/shared_voicemails/{id}/voicemails/{mail_id}/set_unread HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Remove a mail from shared voicemail.
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The unique ID of voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
POST /api/shared_voicemails/{id}/voicemails/{mail_id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieves a collection of greetings of shared voicemail.
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
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.
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The unique ID of the file.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
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"
}
Set one of shared voicemail's greetings to activated state.
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The unique ID of greeting.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
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 by it's unique ID.
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The unique ID of greeting.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
POST /api/shared_voicemails/{id}/greetings/{greeting_id}/disable HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Destroy a greeting from shared voicemail.
The unique ID of shared voicemail.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The unique ID of greeting.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
POST /api/shared_voicemails/{id}/greetings/{greeting_id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content