Get Details for an Auto Attendant
Retrieve an Auto Attendant details.
Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.
Retrieving an auto attendant details requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve an auto attendant details in this location.
Retrieve the auto attendant with the matching ID.
Query Parameters
Retrieve auto attendant details from this organization.
Response Properties
A unique identifier for the auto attendant.
Unique name for the auto attendant.
Flag to indicate if auto attendant number is enabled or not.
Auto attendant phone number. Either phoneNumber or extension is mandatory.
Auto attendant extension. Either phoneNumber or extension is mandatory.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
Flag to indicate if auto attendant number is toll-free number.
First name defined for an auto attendant.
Last name defined for an auto attendant.
Alternate numbers defined for the auto attendant.
Phone number defined as alternate number.
Flag to indicate if auto attendant number is toll-free number.
Ring pattern that will be used for the alternate number.
Language for the auto attendant.
Language code for the auto attendant.
Business hours defined for the auto attendant.
Holiday defined for the auto attendant.
Extension dialing setting. If the values are not set default will be set as ENTERPRISE.
Name dialing setting. If the values are not set default will be set as ENTERPRISE.
Time zone defined for the auto attendant.
Business hours menu defined for the auto attendant.
Greeting type defined for the auto attendant.
Flag to indicate if auto attendant extension is enabled or not.
Announcement Audio File details.
A unique identifier for the announcement.
Audio announcement file name.
Audio announcement file type.
WAV File Extension.
WMA File Extension.
3GP File Extension.
Audio announcement file type location.
Specifies this audio file is configured across organisation.
Specifies this audio file is configured across location.
Key configurations defined for the auto attendant.
Key assigned to specific menu configuration.
Action assigned to specific menu key configuration.
Plays a recorded message and then returns to the current Auto Attendant menu.
Transfers the call to the specified number, without playing a transfer prompt.
Plays the message and then transfers the call to the specified number.
Plays the message and then transfers the call to the specified operator number.
Prompts the user for an extension, and transfers the user to voice mailbox of the dialed extension.
Brings the user into the automated name directory.
Prompts the user for an extension, and transfers the user.
Replays the Auto Attendant greeting.
Terminates the call.
The description of each menu key.
Value based on actions.
Pre-configured announcement audio files when PLAY_ANNOUNCEMENT is set.
A unique identifier for the announcement.
Audio announcement file name.
Audio announcement file type.
WAV File Extension.
WMA File Extension.
3GP File Extension.
Audio announcement file type location.
Specifies this audio file is configured across organisation.
Specifies this audio file is configured across location.
After hours menu defined for the auto attendant.
Greeting type defined for the auto attendant.
Flag to indicate if auto attendant extension is enabled or not.
Announcement Audio File details.
A unique identifier for the announcement.
Audio announcement file name.
Audio announcement file type.
WAV File Extension.
WMA File Extension.
3GP File Extension.
Audio announcement file type location.
Specifies this audio file is configured across organisation.
Specifies this audio file is configured across location.
Key configurations defined for the auto attendant.
Key assigned to specific menu configuration.
Action assigned to specific menu key configuration.
Plays a recorded message and then returns to the current Auto Attendant menu.
Transfers the call to the specified number, without playing a transfer prompt.
Plays the message and then transfers the call to the specified number.
Plays the message and then transfers the call to the specified operator number.
Prompts the user for an extension, and transfers the user to voice mailbox of the dialed extension.
Brings the user into the automated name directory.
Prompts the user for an extension, and transfers the user.
Replays the Auto Attendant greeting.
Terminates the call.
The description of each menu key.
Value based on actions.
Pre-configured announcement audio files when PLAY_ANNOUNCEMENT is set.
A unique identifier for the announcement.
Audio announcement file name.
Audio announcement file type.
WAV File Extension.
WMA File Extension.
3GP File Extension.
Audio announcement file type location.
Specifies this audio file is configured across organisation.
Specifies this audio file is configured across location.
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 auto attendant details from this organization.
{
"id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"name": "Main Line AA - Test",
"enabled": true,
"phoneNumber": "+19705550026",
"extension": "200",
"routingPrefix": "1234",
"esn": "1234200",
"tollFreeNumber": false,
"firstName": "Main Line AA",
"lastName": "Test",
"language": "English",
"languageCode": "en_us",
"businessSchedule": "AUTOATTENDANT-BUSINESS-HOURS",
"holidaySchedule": "AUTOATTENDANT-HOLIDAY",
"extensionDialing": "ENTERPRISE",
"nameDialing": "ENTERPRISE",
"timeZone": "America/Los_Angeles",
"businessHoursMenu": {
"greeting": "DEFAULT",
"extensionEnabled": true,
"audioAnnouncementFile": {
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
"fileName": "announcement.wav",
"mediaFileType": "WAV",
"level": "LOCATION"
},
"keyConfigurations": [
{
"key": "0",
"action": "EXIT"
},
{
"key": "1",
"action": "TRANSFER_WITHOUT_PROMPT",
"value": "+19175551092"
},
{
"key": "2",
"action": "TRANSFER_WITH_PROMPT",
"value": "+19073569984"
},
{
"key": "3",
"action": "EXTENSION_DIALING"
},
{
"key": "4",
"action": "TRANSFER_TO_MAILBOX",
"value": "+19705550006"
},
{
"key": "5",
"action": "PLAY_ANNOUNCEMENT",
"audioAnnouncementFile": {
"id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"fileName": "AUDIO_FILE.wav",
"mediaFileType": "WAV",
"level": "ORGANIZATION"
}
},
{
"key": "6",
"action": "REPEAT_MENU"
}
]
},
"afterHoursMenu": {
"greeting": "DEFAULT",
"extensionEnabled": true,
"audioAnnouncementFile": {
"id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
"fileName": "announcement.wav",
"mediaFileType": "WAV",
"level": "LOCATION"
},
"keyConfigurations": [
{
"key": "0",
"action": "EXIT"
},
{
"key": "1",
"action": "PLAY_ANNOUNCEMENT",
"audioAnnouncementFile": {
"id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"fileName": "AUDIO_FILE.wav",
"mediaFileType": "WAV",
"level": "ORGANIZATION"
}
}
]
}
}