Create a new Voicemail Group for a Location
Create a new voicemail group for the given location for a customer.
A voicemail group can be created for given location for a customer.
Creating a voicemail group for the given location requires a full or user administrator or location administrator auth token with a scope of spark-admin:telephony_config_write
.
URI Parameters
Create a new voice mail group for this location.
Query Parameters
Create a new voice mail group for this organization.
Body Parameters
Set name to create new voicemail group for a particular location for a customer.
Set voicemail group phone number for this particular location.
Set unique voicemail group extension number for this particular location.
Set voicemail group caller ID first name.
Set voicemail group called ID last name.
Set passcode to access voicemail group when calling.
Language code for voicemail group audio announcement.
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 information
Set to true
to enable fax messaging.
Set valid phone number to receive fax message.
Set fax messaging extension number.
Transfer message information
Set to true
to enable to transfer message.
Set phone number and dial '0' to transfer message to the provided number.
Message copy information
Set to true
to enable email message copy.
Set email to receive message copy to the email address provided.
Response Properties
UUID of the newly created voice mail group.
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
- orgIdstringCreate a new voice mail group for this organization.
Body
- namestringRequiredSet name to create new voicemail group for a particular location for a customer.
- phoneNumberstringSet voicemail group phone number for this particular location.
- extensionnumberRequiredSet unique voicemail group extension number for this particular location.
- firstNamestringSet voicemail group caller ID first name.
- lastNamestringSet voicemail group called ID last name.
- passcodenumberRequiredSet passcode to access voicemail group when calling.
- languageCodestringRequiredLanguage code for voicemail group audio announcement.
- messageStorageobjectRequiredMessage storage information
- notificationsobjectRequiredMessage notifications
- faxMessageobjectRequiredFax message information
- transferToNumberobjectRequiredTransfer message information
- emailCopyOfMessageobjectRequiredMessage copy information
{ "name": "Voicemail Group Name", "phoneNumber": "+16066412147", "extension": "1273", "firstName": "rcdnfTest", "lastName": "rcdnlTest", "passcode": "1373", "languageCode": "en_us", "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" } }
{ "id": "997e8784-e2e4-4aa3-93d6-679b2b128d8e" }