Get Voicemail Rules
Retrieve the organization's voicemail rules.
Organizational voicemail rules specify the default passcode requirements. They are provided for informational purposes only and cannot be modified.
Retrieving the organization's voicemail rules requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
Retrieve voicemail rules for this organization.
Response Properties
Default voicemail passcode requirements.
If enabled, the passcode should not contain repeated pattern.
Settings for not allowing single or groups of repeated digits in passcode (for example, 22888, 121212, or 408408).
If enabled, passcode should not contain repeated digits.
Maximum number of repeaed digits. The minimum value is 1. The maximum value is 6.
Settings for not allowing numerical sequence in passcode (for example, 012345 or 987654).
If enabled, passcode should not contain a numerical sequence.
Number of ascending digits in sequence. The minimum value is 2. The maximum value is 5.
Number of descending digits in sequence. The minimum value is 2. The maximum value is 5.
Length of the passcode.
The minimum value is 2. The maximum value is 15.
The minimum value is 3. The maximum value is 30.
If enabled, the default voicemail passcode can be set.
Settings for passcode expiry.
If enabled, passcode expires after the number of days specified.
Number of days for password expiry. The minimum value is 15. The maximum value is 180.
Settings for passcode changes.
If enabled, set minimum number of days between passcode changes.
Number of days between passcode changes. The minimum value is 1. The maximum value is 7.
Settings for previous passcode usage.
If enabled, set how many of the previous passcodes are not allowed to be re-used.
Number of previous passcodes. The minimum value is 1. The maximum value is 10.
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
- Retrieve voicemail rules for this organization.
{
"defaultVoicemailPinRules": {
"blockRepeatedPatternsEnabled": true,
"blockRepeatedDigits": {
"enabled": true,
"max": 3
},
"blockContiguousSequences": {
"enabled": true,
"numberOfAscendingDigits": 3,
"numberOfDescendingDigits": 3
},
"length": {
"min": 6,
"max": 30
},
"defaultVoicemailPinEnabled": true
},
"expirePasscode": {
"enabled": true,
"numberOfDays": 100
},
"changePasscode": {
"enabled": true,
"numberOfDays": 1
},
"blockPreviousPasscodes": {
"enabled": false,
"numberOfPasscodes": 10
}
}