Webex APIs
OverviewBasicsComplianceHybrid ServicesAPI Changelog
Full API reference
Admin Audit Events Attachment Actions BroadWorks Enterprises BroadWorks Subscribers Call Controls Device Configurations Devices Events Historical Analytics Hybrid Clusters Hybrid Connectors Licenses Locations Meeting Invitees Meeting Participants Meeting Preferences Meeting Qualities Meeting Transcripts Meetings Memberships Messages Organizations People Places Recordings Report Templates Reports Resource Group Memberships Resource Groups Roles Room Tabs Rooms Space Classifications Team Memberships Teams Webex Calling Organization Settings Webex Calling Person Settings Webhooks Workspace Metrics Workspaces xAPI

Read Settings for a Call Queue

Retrieve a Call Queue's Settings

Call queues temporarily hold calls in the cloud when all users (agents) assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent when he/she is no longer 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.

Retrieving call queue settings requires a full, user, or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

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

Read settings for a call queue in this location.

queueId
stringrequired

Get settings for the call queue with this identifier.

Query Parameters
orgId
string

Read call queue settings from this organization.

Response Properties
id
string

A unique identifier for the call queue.

name
string

Unique name for the call queue.

enabled
boolean

Whether or not the call queue is enabled.

language
string

Language for 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 call queue.

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

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

phoneNumber
string

Alternate phone number for the hunt group.

ringPattern
RingPatternObject

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

language
string

Language for call queue.

languageCode
string

Language code for call queue.

timeZone
string

Time zone for the call queue.

callPolicies
GetCallQueueCallPolicyObject

Policy controlling how calls are routed to agents.

agents
array

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

id
string

ID of person or workspace.

firstName
string

First name of person or workspace.

lastName
string

First name of person or workspace.

phoneNumber
string

Phone number of person or workspace.

extension
string

Extension 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.
GET
/v1/telephony/config/locations//queues//queues/{?orgId}
Log in to try the API.
Header
Query Parameters
  • Read call queue settings from this organization.
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA/queues/Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
    "id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
    "name": "CallQueue-1",
    "enabled": true,
    "language": "English",
    "languageCode": "en-US",
    "firstName": "Hakim",
    "lastName": "Smith",
    "timeZone": "Central/Chicago",
    "alternateNumberSettings": {
        "distinctiveRingEnabled": true,
        "alternateNumbers": [
            {"phoneNumber": "9725554726","ringPattern": "NORMAL"},
            {"phoneNumber": "9725554729","ringPattern": "NORMAL"}, ]
            },
    "callPolicies": {
        "policy": "REGULAR",
        "callBounce": {
            "callBounceEnabled": true,
            "callBounceMaxRings": 8,
            "agentUnavailableEnabled": false,
            "alertAgentEnabled": false,
            "alertAgentMaxSeconds": 30,
            "callBounceOnHoldEnabled": false,
            "callBounceOnHoldMaxSeconds": 60},
        "distinctiveRing": {"enabled": false,"ringPattern": "NORMAL"}},
    "queueSettings": {
        "queueSize": 10,
        "callOfferToneEnabled": false,
        "resetCallStatisticsEnabled": false,
        "overflow": {
            "action":  "PERFORM_BUSY_TREATMENT",
            "sendToVoicemail": false,
            "overflowAfterWaitEnabled": false,
            "overflowAfterWaitTime": 30,
            "playOverflowGreetingEnabled": false,
            "greeting": "DEFAULT",
            "isTransferNumberSet": false},
        "waitMessage": {
            "enabled": false,
            "waitMode": "TIME",
            "handlingTime": 100,
            "queuePosition": 100,
            "highVolumeMessageEnabled": true,
            "defaultHandlingTime": 5},
        "welcomeMessage": {
            "enabled": true,
            "alwaysEnabled": false,
            "greeting": "DEFAULT"},
        "comfortMessage": {
            "enabled": true,
            "timeBetweenMessages": 10,
            "greeting": "DEFAULT"},
        "mohMessage": {
            "normalSource": {
                "enabled": false,
                "greeting": "DEFAULT"},
            "alternateSource": {"enabled":  false,"greeting":  "DEFAULT"}}},
    "agents": []}