Webex Features: Call Queue API

openapi: 3.2.0
info:
  title: 'Webex Features:  Call Queue API'
  version: 1.0.0
  description: 'Operations tagged Features:  Call Queue across 2 of this provider''s published API definitions: webex-cloud-calling-openapi.json, webex-features-call-queue-api-openapi.yml. Each path carries the servers of the definition it was published in.'
  x-provenance:
    method: harvested
    authored_by: Cisco Webex
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
    derived_view: Per-tag view of webex-cloud-calling-openapi.json, the provider's source document. Operations and schemas are the provider's, unmodified; only the partition is ours.
    derived_from: webex-cloud-calling-openapi.json
    operation_coverage: 50/50
  x-evidence:
  - type: source
    url: https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-cloud-calling.json
  - type: raw
    url: https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-cloud-calling.json
tags:
- name: 'Features:  Call Queue'
paths:
  /telephony/config/queues:
    get:
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                required:
                - queues
                properties:
                  queues:
                    type: array
                    items:
                      $ref: '#/components/schemas/ListCallQueueEssentialsObject'
                    description: Array of call queues.
              example:
                queues:
                - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTg0Y2Y0Y2QtZWVhNy00YzhjLTgzZWUtNjdkODhmYzZlYWE1
                  name: '5714328359'
                  hasCxEssentials: true
                  locationName: WXCSIVDKCPAPIC4S1
                  locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
                  enabled: true
                  extension: '8000'
                  department:
                    id: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ
                    name: HR
                  digitalInboxEnabled: true
                - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc0
                  name: bram
                  hasCxEssentials: true
                  locationName: Brampton
                  locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQwMjgw
                  phoneNumber: '+15558675309'
                  enabled: true
                  digitalInboxEnabled: false
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: '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':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: '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':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: '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':
          description: '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':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: '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':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Read the List of Call Queue or Customer Assist Queues
      operationId: listCallQueues
      description: "List all Call Queues for the organization.\n\nCall queues temporarily hold calls in the cloud, when all agents\nassigned to receive calls from the queue are unavailable. Queued calls are routed to \nan available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach the users assigned to the call queue.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
      tags:
      - 'Features:  Call Queue'
      parameters:
      - name: orgId
        in: query
        description: Returns the list of call queues in this organization.
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
        schema:
          type: string
      - name: locationId
        in: query
        description: Returns the list of call queues in this location.
        example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
        schema:
          type: string
      - name: max
        in: query
        description: Limit the number of objects returned to this maximum count.
        example: '5'
        schema:
          type: number
      - name: start
        in: query
        description: Start at the zero-based offset in the list of matching objects.
        example: '0'
        schema:
          type: number
      - name: name
        in: query
        description: Returns only the call queues matching the given name.
        example: Customer Support
        schema:
          type: string
      - name: phoneNumber
        in: query
        description: Returns only the call queues matching the given primary phone number or extension.
        example: '+15558675309'
        schema:
          type: string
      - name: departmentId
        in: query
        description: Returns only call queues matching the given department ID.
        example: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ
        schema:
          type: string
      - name: departmentName
        in: query
        description: Returns only call queues matching the given department name.
        example: HR
        schema:
          type: string
      - name: hasCxEssentials
        in: query
        description: Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.
        example: true
        schema:
          type: boolean
      - name: digitalInboxEnabled
        in: query
        description: Returns only the list of call queues with digital inbox enabled when `true`, or disabled when `false`. This query parameter is only valid when `hasCxEssentials` is `true`.
        example: true
        schema:
          type: boolean
  /telephony/config/queues/settings:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallQueueSettingsGet'
              example:
                maintainQueuePositionForSimRingEnabled: true
                forceAgentUnavailableOnBouncedEnabled: true
                playToneToAgentForBargeInEnabled: true
                playToneToAgentForSilentMonitoringEnabled: true
                playToneToAgentForSupervisorCoachingEnabled: true
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: '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':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: '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':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: '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':
          description: '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':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: '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':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Get Call Queue Settings
      operationId: getCallQueueSettings
      description: 'Retrieve Call Queue Settings for a specific organization.


        Call Queue Settings configure organization-wide defaults for call queues, including supervisor tone notifications for barge in, silent monitoring, and coaching; optimized simultaneous-ring handling that preserves caller queue position; and bounced-call handling for Customer Assist agents. Individual call queues can use the organization-level tone defaults or override them with queue-specific `playToneToAgent*` settings.


        Retrieving Call Queue Settings requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.'
      tags:
      - 'Features:  Call Queue'
      parameters:
      - name: orgId
        in: query
        description: Call Queue Settings for this organization.
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
        schema:
          type: string
    put:
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: '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':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: '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':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: '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':
          description: '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':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: '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':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Update Call Queue Settings
      operationId: updateCallQueueSettings
      description: 'Update Call Queue Settings for a specific organization.


        Call Queue Settings configure organization-wide defaults for call queues, including supervisor tone notifications for barge in, silent monitoring, and coaching; optimized simultaneous-ring handling that preserves caller queue position; and bounced-call handling for Customer Assist agents. Individual call queues can use the organization-level tone defaults or override them with queue-specific `playToneToAgent*` settings.


        Updating Call Queue Settings requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.'
      tags:
      - 'Features:  Call Queue'
      parameters:
      - name: orgId
        in: query
        description: Call Queue Settings for this organization.
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              maintainQueuePositionForSimRingEnabled: true
              forceAgentUnavailableOnBouncedEnabled: true
              playToneToAgentForBargeInEnabled: true
              playToneToAgentForSilentMonitoringEnabled: true
              playToneToAgentForSupervisorCoachingEnabled: true
            schema:
              $ref: '#/components/schemas/CallQueueSettingsPatch'
  /telephony/config/locations/{locationId}/queues:
    post:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                required:
                - id
                properties:
                  id:
                    type: string
                    description: ID of the newly created call queue.
              example:
                id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: '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':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: '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':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: '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':
          description: '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':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: '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':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Create Call Queue or Customer Assist Queue
      operationId: createCallQueue
      description: 'Create new Call Queues for the given location.


        Call queues temporarily hold calls in the cloud, when all 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 that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,

        which can be dialed internally to reach the users assigned to the call queue.


        Creating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
      tags:
      - 'Features:  Call Queue'
      parameters:
      - name: locationId
        in: path
        description: The location ID where the call queue needs to be created.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg
        schema:
          type: string
      - name: orgId
        in: query
        description: The organization ID where the call queue needs to be created.
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
        schema:
          type: string
      - name: hasCxEssentials
        in: query
        description: Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.
        example: true
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            example:
              name: CallQueue-1
              phoneNumber: '+12225555309'
              extension: '5309'
              firstName: Hakim
              lastName: Smith
              callPolicies:
                policy: CIRCULAR
                routingType: SKILL_BASED
                waitingEnabled: false
                noAnswer:
                  nextAgentEnabled: false
                  nextAgentRings: 5
                  forwardEnabled: false
                  numberOfRings: 0
                  destinationVoicemailEnabled: false
                businessContinuity:
                  enabled: false
                  destinationVoicemailEnabled: false
              queueSettings:
                queueSize: 10
                callOfferToneEnabled: true
                resetCallStatisticsEnabled: true
                useEnterprisePlayToneToAgentSettingsEnabled: false
                playToneToAgentForBargeInEnabled: true
                playToneToAgentForSilentMonitoringEnabled: true
                playToneToAgentForSupervisorCoachingEnabled: true
                overflow:
                  action: PERFORM_BUSY_TREATMENT
                  overflowAfterWaitEnabled: false
                  overflowAfterWaitTime: 30
                  playOverflowGreetingEnabled: false
                  greeting: DEFAULT
                  audioAnnouncementFiles:
                  - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                    fileName: announcement.wav
                    mediaFileType: WAV
                    level: LOCATION
                welcomeMessage:
                  enabled: true
                  alwaysEnabled: false
                  greeting: DEFAULT
                  audioAnnouncementFiles:
                  - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                    fileName: announcement.wav
                    mediaFileType: WAV
                    level: LOCATION
                waitMessage:
                  enabled: true
                  waitMode: POSITION
                  handlingTime: 100
                  defaultHandlingTime: 100
                  queuePosition: 100
                  highVolumeMessageEnabled: false
                  estimatedWaitingTime: 600
                  playUpdatedEstimatedWaitMessage: true
                comfortMessage:
                  enabled: true
                  timeBetweenMessages: 10
                  greeting: DEFAULT
                  audioAnnouncementFiles:
                  - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                    fileName: announcement.wav
                    mediaFileType: WAV
                    level: LOCATION
                mohMessage:
                  normalSource:
                    enabled: true
                    greeting: DEFAULT
                    audioAnnouncementFiles:
                    - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                      fileName: announcement.wav
                      mediaFileType: WAV
                      level: LOCATION
                  alternateSource:
                    enabled: true
                    greeting: DEFAULT
                    audioAnnouncementFiles:
                    - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                      fileName: announcement.wav
                      mediaFileType: WAV
                      level: LOCATION
                comfortMessageBypass:
                  enabled: true
                  callWaitingAgeThreshold: 30
                  greeting: CUSTOM
                  audioAnnouncementFiles:
                  - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                    fileName: announcement.wav
                    mediaFileType: WAV
                    level: LOCATION
                whisperMessage:
                  enabled: true
                  greeting: DEFAULT
                  audioAnnouncementFiles:
                  - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI
                    fileName: announcement.wav
                    mediaFileType: WAV
                    level: LOCATION
              agents:
              - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MGU3MjYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc1MWQ
                skillLevel: 7
              - id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzgzYjQ0OTIyLWZlOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ
                skillLevel: 1
              enabled: true
              phoneNumberForOutgoingCallsEnabled: true
              callingLineIdPolicy: DIRECT_LINE
              callingLineIdPhoneNumber: '+12072342368'
              allowAgentJoinEnabled: true
              directLineCallerIdName:
                selection: CUSTOM_NAME
                customName: Hakim Smith
              dialByName: Hakim Smith
              digitalInboxEnabled: true
            schema:
              $ref: '#/components/schemas/CreateCallQueueEssentialsObject'
  /telephony/config/locations/{locationId}/queues/{queueId}:
    delete:
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: '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':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: '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':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: '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':
          description: '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':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: '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':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Delete a Call Queue
      operationId: deleteCallQueue
      description: 'Delete 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.


        Deleting a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
      tags:
      - 'Features:  Call Queue'
      parameters:
      - name: locationId
        in: path
        description: Location from which to delete a call queue.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
        schema:
          type: string
      - name: queueId
        in: path
        description: Delete the call queue with the matching ID.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0
        schema:
          type: string
      - name: orgId
        in: query
        description: Delete the call queue from this organization.
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
        schema:
          type: string
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCallQueueEssentialsObject'
              example:
                id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTU1MzY4Y2QtZDg5Mi00YzFlLTk0YjYtNzdjNjRiYWQ3NWMx
                name: CallQueue-1
                hasCxEssentials: true
                enabled: true
                language: English
                languageCode: en-US
                firstName: Hakim
                lastName: Smith
                timeZone: Central/Chicago
                numberUsageType: SERVICE_NUMBER
                businessTextingEnabled: true
                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
                    callBounceOnHoldMaxSecon

# --- truncated at 32 KB (412 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-features-call-queue-api-openapi.yml