Get Location Voicemail Group
Retrieve voicemail group details for a location.
Manage your voicemail group settings for a specific location, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.
Retrieving voicemail group details requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve voicemail group details for this location.
Retrieve voicemail group details for this voicemail group ID.
Query Parameters
Retrieve voicemail group details for a customer location.
Response Properties
UUID of voicemail group of a particular location.
Name of the voicemail group.
Voicemail group phone number.
Voicemail group extension number.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
Voicemail group toll free number.
Voicemail group caller ID first name.
Voicemail group called ID last name.
Enable/disable voicemail group.
Language for voicemail group audio announcement.
Set voicemail group greeting type.
Default voicemail group greeting.
Custom voicemail group greeting.
Enabled if CUSTOM greeting is previously uploaded.
CUSTOM greeting for previously uploaded.
Message storage information
Message storage type
Store messages in internal mailbox.
Send messages to the email address provided.
External email to forward the message.
Message notifications
Enable/disable messages notification
Notifications to be sent to provided email to SMS gateway.
Fax message receive settings
Enable/disable fax messaging.
Phone number to receive fax messages.
Extension to receive fax messages.
Transfer message information
Enable/disable to transfer message.
Transfer phone number to be called when '0' is dialed.
Message copy information
Enable/disable to email message copy.
Email message copy to email address provided.
Enable/disable to forward voice message.
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 group details for a customer location.
{
"id": "a7dd4d39-4a78-4516-955f-7810dbe379cf",
"name": "Voicemail Group Name",
"phoneNumber": "+16066412147",
"extension": "1273",
"routingPrefix": "123",
"esn": "1231273",
"tollFreeNumber": "false",
"firstName": "rcdnfTest",
"lastName": "rcdnlTest",
"enabled": true,
"languageCode": "en_us",
"greeting": "DEFAULT",
"greetingUploaded": true,
"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"
},
"voiceMessageForwardingEnabled": true
}