Update Voicemail Rules
Update the organization's default voicemail passcode and/or rules.
Organizational voicemail rules specify the default passcode requirements.
If you choose to set a default passcode for new people added to your organization, communicate to your people what that passcode is, and that it must be reset before they can access their voicemail. If this feature is not turned on, each new person must initially set their own passcode.
Updating an organization's voicemail passcode and/or rules requires a full administrator auth token with a scope of spark-admin:telephony_config_write
.
Query Parameters
Update voicemail rules for this organization.
Body Parameters
Set to true
to enable the default voicemail passcode.
Default voicemail passcode.
Settings for passcode expiry.
Set to true
to expire passcode after the number of days specified.
Number of days for password expiry. The minimum value is 15. The maximum value is 100.
Settings for passcode changes.
Set to true
to change the 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.
Set to true
to specify how many of the previous passcode 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
- orgIdstringUpdate voicemail rules for this organization.
Body
- defaultVoicemailPinEnabledbooleanSet to `true` to enable the default voicemail passcode.
- defaultVoicemailPinstringDefault voicemail passcode.
- expirePasscodeobjectSettings for passcode expiry.
- changePasscodeobjectSettings for passcode changes.
- blockPreviousPasscodesobjectSettings for previous passcode usage.
{ "defaultVoicemailPinEnabled": true, "defaultVoicemailPin": "123544", "expirePasscode":{ "enabled": true, "numberOfDays": 100 }, "changePasscode":{ "enabled": true, "numberOfDays": 1 }, "blockPreviousPasscodes": { "enabled": false, "numberOfPasscodes": 10 } }