Read Voicemail Settings for a Person
Retrieve a person's Voicemail settings.
The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, .wav, format.
Optionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.
This API requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:people_read or a user auth token with spark:people_read scope can be used by a person to read their settings.
URI Parameters
Unique identifier for the person.
Query Parameters
ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
Response Properties
Voicemail is enabled or disabled.
Settings for sending all calls to voicemail.
All calls will be sent to voicemail.
Settings for sending calls to voicemail when the line is busy.
Calls will be sent to voicemail when busy.
DEFAULT indicates the default greeting will be played. CUSTOM indicates a custom .wav file will be played.
The default greeting will be played.
Designates that a custom .wav file will be played.
A custom greeting has been uploaded.
Enables and disables sending unanswered calls to voicemail.
DEFAULT indicates the default greeting will be played. CUSTOM indicates a custom .wav file will be played.
The default greeting will be played.
Designates that a custom .wav file will be played.
A custom greeting has been uploaded
Number of rings before unanswered call will be sent to voicemail.
System-wide maximum number of rings allowed for numberOfRings setting.
Settings for notifications when there are any new voicemails.
Send of unanswered calls to voicemail is enabled or disabled.
Email address to which the notification will be sent. For text messages, use an email to text message gateway like 2025551212@txt.example.net.
Settings for voicemail caller to transfer to a different number by pressing zero (0).
If true, state of giving caller option to transfer to destination when pressing zero (0) is enabled.
Number voicemail caller will be transferred to when they press zero (0).
Settings for sending a copy of new voicemail message audio via email.
When true copy of new voicemail message audio will be sent to the designated email.
Email address to which the new voicemail audio will be sent.
When true desktop phone will indicate there are new voicemails.
Designates which type of voicemail message storage is used.
For message access via phone or the Calling User Portal.
For sending all messages to the person's email.
External email address to which the new voicemail audio will be sent. A value for this field must be provided in the request if a storageType of EXTERNAL is given in the request.
When true FAX messages for new voicemails will be sent to the designated number.
Designates phone number for the FAX. A value for this field must be provided in the request if faxMessage enabled field is given as true in the request.
Designates optional extension for the FAX.
Disable the user-level control when set to "false".
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
{
"enabled": true,
"sendAllCalls": {
"enabled": true
},
"sendBusyCalls": {
"enabled": false,
"greeting": "DEFAULT",
"greetingUploaded": false
},
"sendUnansweredCalls": {
"enabled": false,
"greeting": "DEFAULT",
"greetingUploaded": true,
"numberOfRings": 3,
"systemMaxNumberOfRings": 20
},
"notifications": {
"enabled": true,
"destination": "julie@example.com"
},
"transferToNumber": {
"enabled": false
},
"emailCopyOfMessage": {
"enabled": false,
"emailId": "julie@example.com"
},
"messageStorage": {
"mwiEnabled": true,
"storageType": "INTERNAL",
"externalEmail": "julia@example.com"
},
"faxMessage": {
"enabled": false
},
"voiceMessageForwardingEnabled": false
}