Get VoicePortal Passcode Rule
Retrieve the voice portal passcode rule for a location.
Voice portals provide an interactive voice response (IVR) system so administrators can manage auto attendant anouncements
Retrieving the voice portal passcode rule requires a full read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve voice portal passcode rules for this location.
Query Parameters
Retrieve voice portal passcode rules for this organization.
Response Properties
Settings for passcode expiry.
If enabled, passcode expires after the number of days specified.
Number of days for passcode expiry. The minimum value is 15. The maximum value is 100.
Number of failed attempts allowed.
If enabled, allows specified number of attempts before locking voice portal access.
Number of failed attempts allowed.
Settings for previous passcode usage.
If enabled, the specified number of passcode changes must occur before a passcode can be re-used.
Number of required passcodes changes. The minimum value is 1. The maximum value is 10.
Settings for not allowing single or groups of repeated digits in passcode (for example, 22888, 121212, or 408408).
+ enabled: true (boolean) - If enabled, passcode should not contain repeated digits.
+ max: `3` (number) - Maximum number of digits to be considered as a repeated sequence. The minimum value is 1. The maximum value is 6.
Settings for not allowing numerical sequence in passcode (for example, 012345 or 987654).
+ enabled: true (boolean) - If enabled, do not allow the specified number of ascending or descending digits in a row.
+ numberOfAscendingDigits: `3` (number) - Number of ascending digits in sequence. The minimum value is 2. The maximum value is 5.
+ numberOfDescendingDigits: `3` (number) - Number of descending digits in sequence. The minimum value is 2. The maximum value is 5.
Allowed 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 passcode do not contain repeated pattern.
If enabled, the passcode do not allow user phone number or extension.
If enabled, the passcode do not allow revered phone number or extension.
If enabled, the passcode do not allow setting reversed old passcode.
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 voice portal passcode rules for this organization.
{
"expirePasscode": {
"enabled": true,
"numberOfDays": 180
},
"failedAttempts": {
"enabled": true,
"attempts": 3
},
"blockPreviousPasscodes": {
"enabled": true,
"numberOfPasscodes": 3
},
"blockRepeatedDigits": {},
"blockContiguousSequences": {},
"length": {
"min": 3,
"max": 3
},
"blockRepeatedPatternsEnabled": true,
"blockUserNumberEnabled": true,
"blockReversedUserNumberEnabled": true,
"blockReversedOldPasscodeEnabled": true
}