Modify Location Voicemail Group
Modifies the voicemail group location details for a particular location for a customer.
Manage your voicemail settings, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.
Modifying the voicemail group location details requires a full, user administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.
URI Parameters
Modifies the voicemail group details for this location.
Modifies the voicemail group details for this voicemail group ID.
Query Parameters
Modifies the voicemail group details for a customer location.
Body Parameters
Set the name of the voicemail group.
Set voicemail group phone number.
Set unique voicemail group extension number.
Set the voicemail group caller ID first name.
Set the voicemail group called ID last name.
Set to true to enable the voicemail group.
Set passcode to access voicemail group when calling.
Language code for the voicemail group audio announcement.
Voicemail group greeting type.
Set to DEFAULT to play default voicemail group greeting.
Set to CUSTOM to play previously uploaded custom voicemail group greeting.
CUSTOM greeting for previously uploaded.
Message storage information
Message storage type.
Set to INTERNAL to store messages in internal mailbox.
Set to EXTERNAL to send messages to the email address provided.
Set external email to forward the messages.
Message notifications
Set to true to enable message notification.
Set email to SMS gateway to send notifications.
Fax message receive settings
Set to true to enable FAX messaging.
Set valid phone number to receive FAX messages.
Set FAX messaging extension number.
Transfer message information
Set to true to enable to transfer message.
Set phone number and transfer message to the provided number when '0' is dialed.
Message copy information
Set to true to enable email message copy.
Set email to receive message copy to the email address provided.
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
- Modifies the voicemail group details for a customer location.
Body
- Set the name of the voicemail group.
- Set voicemail group phone number.
- Set unique voicemail group extension number.
- Set the voicemail group caller ID first name.
- Set the voicemail group called ID last name.
- Set to `true` to enable the voicemail group.
- Set passcode to access voicemail group when calling.
- Language code for the voicemail group audio announcement.
- Voicemail group greeting type.
- CUSTOM greeting for previously uploaded.
- Message storage information
- Message notifications
- Fax message receive settings
- Transfer message information
- Message copy information
{
"name": "Voicemail Group Name",
"phoneNumber": "+16066412147",
"extension": "1273",
"firstName": "rcdnfTest",
"lastName": "rcdnlTest",
"passcode": "1234",
"enabled": true,
"languageCode": "en_us",
"greeting": "DEFAULT",
"greetingDescription": "greetings.wav",
"messageStorage":{
"storageType": "EXTERNAL",
"externalEmail": "user@flex2.cisco.com"
},
"notifications": {
"enabled" : true,
"destination" : "user@flex2.cisco.com"
},
"faxMessage" : {
"enabled": true,
"phoneNumber": "+1234234324",
"extension": "23455"
},
"transferToNumber": {
"enabled": true,
"destination": "+12147691003"
},
"emailCopyOfMessage": {
"enabled": true,
"emailId": "<user@flex2.cisco.com"
}
}