Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Features: Auto Attendant API

The Features: Auto Attendant API from Webex — 12 operation(s) for features: auto attendant.

Webex Features: Auto Attendant API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Features: Auto Attendant. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 17 operations across 12 paths, and defines 49 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

17 operations 12 paths 49 schemas 3 DELETE8 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex Features: Auto Attendant API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 17

Across 12 paths, the API surfaces 17 operations — 3 DELETE, 8 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Features: Auto Attendant 17
GET
/telephony/config/autoAttendants
Read the List of Auto Attendants
listAutoAttendants 6 params → 200400401403404405409410
GET
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}
Get Details for an Auto Attendant
getAutoAttendant 3 params → 200400401403404405409410
PUT
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}
Update an Auto Attendant
updateAutoAttendant 3 params body → 204400401403404405409410
DELETE
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}
Delete an Auto Attendant
deleteAutoAttendant 3 params → 204400401403404405409410
POST
/telephony/config/locations/{locationId}/autoAttendants
Create an Auto Attendant
createAutoAttendant 2 params body → 201400401403404405409410
GET
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}/callForwarding
Get Call Forwarding Settings for an Auto Attendant
getAutoAttendantCallForwardingSettings 3 params → 200400401403404405409410
PUT
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}/callForwarding
Update Call Forwarding Settings for an Auto Attendant
updateAutoAttendantCallForwardingSettings 3 params body → 204400401403404405409410
POST
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}/callForwarding/selectiveRules
Create a Selective Call Forwarding Rule for an Auto Attendant
createAutoAttendantSelectiveCallForwardingRule 3 params body → 201400401403404405409410
GET
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}/callForwarding/selectiveRules/{ruleId}
Get Selective Call Forwarding Rule for an Auto Attendant
getAutoAttendantSelectiveCallForwardingRule 4 params → 200400401403404405409410
PUT
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}/callForwarding/selectiveRules/{ruleId}
Update Selective Call Forwarding Rule for an Auto Attendant
updateAutoAttendantSelectiveCallForwardingRule 4 params body → 201400401403404405409410
DELETE
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}/callForwarding/selectiveRules/{ruleId}
Delete a Selective Call Forwarding Rule for an Auto Attendant
deleteAutoAttendantSelectiveCallForwardingRule 4 params → 204400401403404405409410
GET
/telephony/config/locations/{locationId}/autoAttendants/availableNumbers
Get Auto Attendant Primary Available Phone Numbers
getAutoAttendantPrimaryAvailablePhoneNumbers 5 params → 200400401403404405409410
GET
/telephony/config/locations/{locationId}/autoAttendants/alternate/availableNumbers
Get Auto Attendant Alternate Available Phone Numbers
getAutoAttendantAlternateAvailablePhoneNumbers 5 params → 200400401403404405409410
GET
/telephony/config/locations/{locationId}/autoAttendants/callForwarding/availableNumbers
Get Auto Attendant Call Forward Available Phone Numbers
getAutoAttendantCallForwardAvailablePhoneNumbers 7 params → 200400401403404405409410
POST
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}/callForwarding/actions/switchMode/invoke
Switch Mode for Call Forwarding Settings for an Auto Attendant
switchAutoAttendantCallForwardingMode 3 params body → 204400401403404405409410
DELETE
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}/announcements/{fileName}
Delete a Auto Attendant Announcement File
deleteAutoAttendantAnnouncementFile 4 params → 204400401403404405409410
GET
/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}/announcements
Read the List of Auto Attendant Announcement Files
listAutoAttendantAnnouncementFiles 3 params → 200400401403404405409410

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are GetAutoAttendantObject (22 properties), PostAutoAttendantObject (16 properties), ModifyAutoAttendantObject (16 properties), ListAutoAttendantObject (9 properties). Each schema is shown below with its type and property counts.

AlternateNumbersObject
object
3 properties 2 required
KeyConfigurationsGetObject
object
5 properties 2 required
AutoAttendantCallForwardAvailableNumberObject
object
8 properties 5 required
AutoAttendantPrimaryAvailableNumberListGetObject
object
1 property 1 required
AutoAttendantCallForwardSettingsDetailsObject
object
4 properties 3 required
NumberOwnerType
string
PLACE - PSTN phone number's owner is a workspace. PEOPLE - PSTN phone number's owner is a person. VIRTUALLINE - PSTN phone number's owner is a Virtual Profile.…
ModesGet
object
6 properties 6 required
DirectLineCallerIdNameObject
object
Settings for the direct line caller ID name to be shown for this workspace.
2 properties
mediaType
string
WMA - WMA File Extension. WAV - WAV File Extension. GP - 3GP File Extension. MOV - MOV File Extension.
GetCallForwardSelectiveSettingObject
object
4 properties 3 required
GetCallForwardAlwaysSettingObject
object
4 properties 3 required
CallForwardSelectiveCallsFromObject
object
2 properties 1 required
CallForwardSelectiveCallsFromCustomNumbersObject
object
3 properties 3 required
CallTreatmentObject
object
3 properties
AudioAnnouncementFileObject
object
4 properties
ModifyCallForwardSelectiveSettingObject
object
4 properties
GetAutoAttendantObject
object
22 properties 11 required
AudioAnnouncementFileGetObject
object
4 properties 4 required
ModifyAutoAttendantObject
object
16 properties
AutoAttendantAlternateAvailableNumberListGetObject
object
1 property 1 required
PostAutoAttendantObject
object
16 properties 4 required
ActionToBePerformedObject
object
4 properties 2 required
AutoAttendantCallForwardSettingsModifyDetailsObject
object
4 properties
CallForwardSelectiveForwardToObject
object
2 properties 1 required
AutoAttendantCallForwardAvailableNumberListGetObject
object
1 property 1 required
CallForwardRulesModifyObject
object
2 properties 1 required
HoursMenuGetObject
object
5 properties 3 required
AutoAttendantPrimaryAvailableNumberObject
object
6 properties 6 required
PostAutoAttendantCallForwardSelectiveRuleObject
object
7 properties 3 required
AutoAttendantAlternateAvailableNumberObject
object
6 properties 6 required
ModifyAutoAttendantCallForwardSettingsObject
object
1 property 1 required
ModifyAutoAttendantCallForwardSelectiveRuleObject
object
7 properties 1 required
PostHoursMenuObject
object
5 properties 3 required
SelectionObject
string
DISPLAYNAME - When this option is selected, displayName is to be shown for this workspace. CUSTOMNAME - When this option is selected, customName is to be shown…
ModesPatch
object
3 properties 3 required
ListAutoAttendantObject
object
9 properties 5 required
KeyConfigurationsObject
object
5 properties 2 required
STATE
string
ACTIVE - Phone number is in the active state. INACTIVE - Phone number is in the inactive state.
CallForwardRulesObject
object
6 properties 2 required
GetAutoAttendantCallForwardSelectiveRuleObject
object
8 properties 7 required
CallForwardSelectiveCallsToObject
object
1 property
level
string
ORGANIZATION - Organization level. LOCATION - Location level. ENTITY - Entity level.
GetAutoAttendantCallForwardSettingsObject
object
1 property 1 required
HoursMenuObject
object
5 properties 3 required
GetAnnouncementFileInfo
object
6 properties 6 required
CallForwardSelectiveCallsToNumbersObject
object
3 properties 1 required
TelephonyType
string
PSTNNUMBER - The object is a PSTN number.
DirectLineCallerIdNameObjectForPut
object
Settings for the direct line caller ID name to be shown for this workspace.
2 properties
ModifyCallForwardAlwaysSettingObject
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-features-auto-attendant-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API