Webex Features: Call Queue API
The Features: Call Queue API from Webex — 24 operation(s) for features: call queue.
Webex Features: Call Queue 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: Call Queue. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 37 operations across 24 paths, and defines 73 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
37 operations
24 paths
73 schemas
5 DELETE19 GET4 POST9 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Webex Features: Call Queue 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 YOURAUTHORIZATIONTOKENbearerAuth— OAuth 2.0 Bearer token authentication
Paths & Operations 37
Across 24 paths, the API surfaces 37 operations — 5 DELETE, 19 GET, 4 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.
Features: Call Queue 37
GET
/telephony/config/queues
Read the List of Call Queues with Customer Assist
POST
/telephony/config/locations/{locationId}/queues
Create a Call Queue with Customer Assist
DELETE
/telephony/config/locations/{locationId}/queues/{queueId}
Delete a Call Queue
GET
/telephony/config/locations/{locationId}/queues/{queueId}
Get Details for a Call Queue with Customer Assist
PUT
/telephony/config/locations/{locationId}/queues/{queueId}
Update a Call Queue
GET
/telephony/config/locations/{locationId}/queues/{queueId}/announcements
Read the List of Call Queue Announcement Files
DELETE
/telephony/config/locations/{locationId}/queues/{queueId}/announcements/{fileName}
Delete a Call Queue Announcement File
GET
/telephony/config/locations/{locationId}/queues/{queueId}/callForwarding
Get Call Forwarding Settings for a Call Queue
PUT
/telephony/config/locations/{locationId}/queues/{queueId}/callForwarding
Update Call Forwarding Settings for a Call Queue
POST
/telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/selectiveRules
Create a Selective Call Forwarding Rule for a Call Queue
GET
/telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/selectiveRules/{ruleId}
Get Selective Call Forwarding Rule for a Call Queue
PUT
/telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/selectiveRules/{ruleId}
Update a Selective Call Forwarding Rule for a Call Queue
DELETE
/telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/selectiveRules/{ruleId}
Delete a Selective Call Forwarding Rule for a Call Queue
GET
/telephony/config/locations/{locationId}/queues/{queueId}/holidayService
Get Details for a Call Queue Holiday Service
PUT
/telephony/config/locations/{locationId}/queues/{queueId}/holidayService
Update a Call Queue Holiday Service
GET
/telephony/config/locations/{locationId}/queues/{queueId}/nightService
Get Details for a Call Queue Night Service
PUT
/telephony/config/locations/{locationId}/queues/{queueId}/nightService
Update a Call Queue Night Service
GET
/telephony/config/locations/{locationId}/queues/{queueId}/forcedForward
Get Details for a Call Queue Forced Forward
PUT
/telephony/config/locations/{locationId}/queues/{queueId}/forcedForward
Update a Call Queue Forced Forward Service
GET
/telephony/config/locations/{locationId}/queues/{queueId}/strandedCalls
Get Details for a Call Queue Stranded Calls
PUT
/telephony/config/locations/{locationId}/queues/{queueId}/strandedCalls
Update a Call Queue Stranded Calls Service
GET
/telephony/config/locations/{locationId}/queues/availableNumbers
Get Call Queue Primary Available Phone Numbers
GET
/telephony/config/locations/{locationId}/queues/alternate/availableNumbers
Get Call Queue Alternate Available Phone Numbers
GET
/telephony/config/locations/{locationId}/queues/callForwarding/availableNumbers
Get Call Queue Call Forward Available Phone Numbers
GET
/telephony/config/queues/agents/availableAgents
Get Call Queue Available Agents
GET
/telephony/config/supervisors
Get List of Supervisors with Customer Assist
POST
/telephony/config/supervisors
Create a Supervisor with Customer Assist
DELETE
/telephony/config/supervisors
Delete Bulk Supervisors
DELETE
/telephony/config/supervisors/{supervisorId}
Delete a Supervisor
GET
/telephony/config/supervisors/{supervisorId}
Get Supervisor Detail with Customer Assist
PUT
/telephony/config/supervisors/{supervisorId}
Assign or Unassign Agents to Supervisor with Customer Assist
GET
/telephony/config/supervisors/availableSupervisors
List Available Supervisors with Customer Assist
GET
/telephony/config/supervisors/availableAgents
List Available Agents with Customer Assist
GET
/telephony/config/queues/agents
Read the List of Call Queue Agents with Customer Assist
GET
/telephony/config/queues/agents/{id}
Get Details for a Call Queue Agent with Customer Assist
PUT
/telephony/config/queues/agents/{id}/settings
Update an Agent's Settings of One or More Call Queues with Customer Assist
POST
/telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/actions/switchMode/invoke
Switch Mode for Call Forwarding Settings for a Call Queue
Schemas 73
The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are GetCallQueueEssentialsObject (19 properties), ModifyCallQueueObject (19 properties), CreateCallQueueEssentialsObject (16 properties), GetCallQueueNightServiceObject (13 properties). Each schema is shown below with its type and property counts.
CallQueueCallForwardAvailableNumberObject
object
8 properties
5 required
ListCallQueueEssentialsObject
object
9 properties
6 required
ModifyPersonPlaceVirtualLineCallQueueObject
object
4 properties
1 required
AnnouncementAudioFile
object
4 properties
PostCallQueueEssentialCallPolicyObject
object
4 properties
4 required
CallQueueAlternateAvailableNumberObject
object
6 properties
6 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.…
UserType
string
PEOPLE - The associated member is a person. PLACE - The associated member is a workspace. VIRTUALLINE - The associated member is a virtual line.
DirectLineCallerIdNameObject
object
Settings for the direct line caller ID name to be shown for this workspace.
2 properties
ModesGet
object
6 properties
6 required
ModifyCallQueueStrandedCallsObject
object
4 properties
2 required
mediaType
string
WMA - WMA File Extension. WAV - WAV File Extension. GP - 3GP File Extension. MOV - MOV File Extension.
CallQueueCallForwardAvailableNumberListGetObject
object
1 property
1 required
GetPersonPlaceObject
object
6 properties
1 required
GetCallQueueEssentialsCallPolicyObject
object
3 properties
3 required
CallQueueAlternateAvailableNumberListGetObject
object
1 property
1 required
HuntRoutingTypeSelection
string
PRIORITYBASED - Default routing type which directly uses the routing policy to dispatch calls to the agents. SKILLBASED - This option uses skill level as the c…
ModifyCallQueueForcedForwardObject
object
5 properties
3 required
CallForwardSettingsGet
object
1 property
1 required
ModifyCallQueueHolidayObject
object
8 properties
5 required
PostPersonPlaceVirtualLineSupervisorObject
object
1 property
1 required
CallQueueHolidaySchedulesObject
object
2 properties
2 required
GetCallQueueAgentObject
object
2 properties
2 required
ModifyCallQueueCallPolicyObject
object
4 properties
1 required
BulkSupervisorsDelete
object
2 properties
1 required
ListCallQueueAgentObject
object
13 properties
9 required
CallForwardRulesGet
object
6 properties
1 required
GetCallQueueHolidayObject
object
9 properties
5 required
CallQueueNightSchedulesObject
object
2 properties
2 required
AudioAnnouncementFileFeatureObject
object
4 properties
CreateSupervisorObject
object
2 properties
2 required
AudioAnnouncementFileFeatureGetObject
object
5 properties
5 required
CreateCallQueueEssentialsObject
object
16 properties
4 required
PostPersonPlaceVirtualLineCallQueueObject
object
3 properties
1 required
GetCallQueueEssentialsObject
object
19 properties
8 required
CallQueueQueueEssentialsSettingsObject
object
4 properties
2 required
CallForwardRulesSet
object
2 properties
1 required
ListSupervisorAgentObject
object
6 properties
1 required
AvailableAgentObject
object
8 properties
7 required
ListSupervisorAgentStatusObject
object
3 properties
3 required
PatchCallQueueNightServiceObject
object
12 properties
6 required
CallQueuePrimaryAvailableNumberObject
object
6 properties
6 required
GetCallQueueForcedForwardObject
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
ModifyCallForwardingObject
object
1 property
AvailableAgentListGetObject
object
1 property
1 required
STATE
string
ACTIVE - Phone number is in the active state. INACTIVE - Phone number is in the inactive state.
ModifyAgentsForCallQueueObject
object
1 property
1 required
GetUserNumberItemObject
object
2 properties
AvailableAgentListObject
object
9 properties
2 required
AlternateNumbersWithPattern
object
2 properties
1 required
level
string
ORGANIZATION - Organization level. LOCATION - Location level. ENTITY - Entity level.
AgentAction
string
ADD - Assign an agent to a supervisor. DELETE - Remove an agent from a supervisor.
HuntPolicyEssentialSelection
string
CIRCULAR - This option cycles through all agents after the last agent that took a call. It sends calls to the next available agent. REGULAR - Send the call thr…
CreateForwardingRuleObject
object
7 properties
3 required
GetForwardingRuleObject
object
8 properties
4 required
CreateAgentObject
object
1 property
1 required
HuntPolicySelection
string
CIRCULAR - This option cycles through all agents after the last agent that took a call. It sends calls to the next available agent. This is supported for SKILL…
AvailableSupervisorsListObject
object
8 properties
1 required
CallQueuePrimaryAvailableNumberListGetObject
object
1 property
1 required
CallQueueQueueSettingsObject
object
10 properties
2 required
GetAnnouncementFileInfo
object
6 properties
6 required
ListSupervisorObject
object
8 properties
2 required
GetCallQueueStrandedCallsObject
object
4 properties
2 required
GetCallQueueNightServiceObject
object
13 properties
6 required
ModifyCallQueueObject
object
19 properties
1 required
ModifyForwardingRuleObject
object
7 properties
DirectLineCallerIdNameObjectForPut
object
Settings for the direct line caller ID name to be shown for this workspace.
2 properties
TelephonyType
string
PSTNNUMBER - The object is a PSTN number.
RingPatternObject
string
NORMAL - Normal incoming ring pattern. LONGLONG - Incoming ring pattern of two long rings. SHORTSHORTLONG - Incoming ring pattern of two short rings, followed…
CallForwardingNumbers
object
3 properties
1 required
PutPersonPlaceVirtualLineAgentObject
object
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Webex 12
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
#Features: Call Queue