APIs
Getting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Overview
Guides
Reference
Admin Audit EventsEventsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesMembershipsOrganizationsPeopleRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSpace ClassificationsWebex Calling Organization SettingsWebex Calling Person SettingsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Contact Center
Devices
imiconnect
Meetings
Messaging
Webex Assistant Skills
Full API Reference
Admin Audit EventsAttachment ActionsBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMembershipsMessagesMock API for integration testOrganizationsPeoplePlacesRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebhooksWorkspace LocationsWorkspace MetricsWorkspacesxAPI
API Changelog

Update a Call Queue

Update the designated Call Queue.

Call queues temporarily hold calls in the cloud when all agents, which can be users or agents, assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent when not on an active call. Each call queue is assigned a Lead Number, which is a telephone number outside callers can dial to reach users assigned to the call queue. Call queues are also assigned an internal extension, which can be dialed internally to reach users assigned to the call queue.

Updating a call queue requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

PUT/v1/telephony/config/locations/{locationId}/queues/{queueId}
URI Parameters
locationId
stringrequired

Location in which this call queue exists.

queueId
stringrequired

Update setting for the call queue with the matching ID.

Query Parameters
orgId
string

Update call queue settings from this organization.

Body Parameters
enabled
boolean

Whether or not the call queue is enabled.

name
string

Unique name for the call queue.

languageCode
string

Language code.

firstName
string

First name to be shown when calls are forwarded out of this call queue. Defaults to ".".

lastName
string

Last name to be shown when calls are forwarded out of this call queue. Defaults to the phone number if set, otherwise defaults to call group name.

timeZone
string

Time zone for the hunt group.

phoneNumber
string

Primary phone number of the call queue.

extension
string

Extension of the call queue.

alternateNumberSettings
object

The alternate numbers feature allows you to assign multiple phone numbers or extensions to a call queue. Each number will reach the same greeting and each menu will function identically to the main number. The alternate numbers option enables you to have up to ten (10) phone numbers ring into the call queue.

distinctiveRingEnabled
boolean

Distinctive Ringing selected for the alternate numbers in the call queue overrides the normal ringing patterns set for Alternate Number.

alternateNumbers
array[AlternateNumbersWithPattern]

Specifies up to 10 numbers which can each have an overriden distinctive ring setting.

phoneNumber
stringrequired

Alternate phone number for the hunt group.

ringPattern
enum

Ring pattern for when this alternate number is called. Only available when distinctiveRing is enabled for the hunt group.

NORMAL
string

Normal incoming ring pattern.

LONG_LONG
string

Incoming ring pattern of two long rings.

SHORT_SHORT_LONG
string

Incoming ring pattern of two short rings, followed by a short ring.

SHORT_LONG_SHORT
string

Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.

callPolicies
ModifyCallQueueCallPolicyObject

Policy controlling how calls are routed to agents.

policy
HuntPolicySelection

Call routing policy to use to dispatch calls to agents.

CIRCULAR
string

(Max 1,000 agents) This option cycles through all agents after the last agent that took a call. It sends calls to the next available agent.

REGULAR
string

(Max 1,000 agents) Send the call through the queue of agents in order, starting from the top each time.

SIMULTANEOUS
string

(Max 50 agents) Sends calls to all agents at once

UNIFORM
string

(Max 1,000 agents) Sends calls to the agent that has been idle the longest. If they don't answer, proceed to the next agent who has been idle the second longest, and so on until the call is answered.

WEIGHTED
string

(Max 100 agents) Sends call to idle agents based on percentages you assign to each agent (up to 100%).

callBounce
object

Settings for when the call is not answered.

callBounceEnabled
boolean

If enabled, bounce calls after the set number of rings.

callBounceMaxRings
number

Number of rings after which to bounce call, if call bounce is enabled.

agentUnavailableEnabled
boolean

Bounce if agent becomes unavailable.

alertAgentEnabled
boolean

Alert agent if call on hold more than alertAgentMaxSeconds.

alertAgentMaxSeconds
number

Number of second after which to alert agent if alertAgentEnabled.

callBounceOnHoldEnabled
boolean

Bounce if call on hold more than callBounceMaxSeconds.

callBounceOnHoldMaxSeconds
number

Number of second after which to bounce if callBounceEnabled.

distinctiveRing
object

Whether or not the call queue has the distinctive ring option enabled.

enabled
boolean

Whether or not the distinctive ring is enabled.

ringPattern
RingPatternObject

Ring pattern for when this callqueue is called. Only available when distinctiveRing is enabled for the call queue.

NORMAL
string

Normal incoming ring pattern.

LONG_LONG
string

Incoming ring pattern of two long rings.

SHORT_SHORT_LONG
string

Incoming ring pattern of two short rings, followed by a short ring.

SHORT_LONG_SHORT
string

Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.

agents
array[PostPersonPlaceObject]

People, including workspaces, that are eligible to receive calls.

id
stringrequired

ID of person or workspace.

weight
string

Weight of person or workspace. Only applied when call policy is WEIGHTED.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
PUT
/v1/telephony/config/locations//queues//queues/{?orgId}
Log in to try the API.
Header
Query Parameters
  • Update call queue settings from this organization.
Body
  • Whether or not the call queue is enabled.
  • Unique name for the call queue.
  • Language code.
  • First name to be shown when calls are forwarded out of this call queue. Defaults to ".".
  • Last name to be shown when calls are forwarded out of this call queue. Defaults to the phone number if set, otherwise defaults to call group name.
  • Time zone for the hunt group.
  • Primary phone number of the call queue.
  • Extension of the call queue.
  • The alternate numbers feature allows you to assign multiple phone numbers or extensions to a call queue. Each number will reach the same greeting and each menu will function identically to the main number. The alternate numbers option enables you to have up to ten (10) phone numbers ring into the call queue.
  • Policy controlling how calls are routed to agents.
  • People, including workspaces, that are eligible to receive calls.
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx/queues/Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
    "enabled": true,
    "name": "3168898911",
    "language": "English",
    "languageCode": "en_au",
    "firstName": "CQ",
    "lastName": "3168898911",
    "queueSettings": {"queueSize": 10}}
}
204 / No Content