Webex Cloud Calling — Features: Call Queue

naftiko: 1.0.0-alpha2
info:
  label: 'Webex Cloud Calling — Features:  Call Queue'
  description: 'Webex Cloud Calling — Features:  Call Queue. 37 operations. Lead operation: Create a Call Queue with Customer
    Assist. Self-contained Naftiko capability covering one Webex business surface.'
  tags:
  - Webex
  - 'Features:  Call Queue'
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBEX_API_KEY: WEBEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-calling-features-call-queue
    baseUri: ''
    description: 'Webex Cloud Calling — Features:  Call Queue business capability. Self-contained, no shared references.'
    resources:
    - name: telephony-config-locations-locationId-queues
      path: /telephony/config/locations/{locationId}/queues
      operations:
      - name: createcallqueue
        method: POST
        description: Create a Call Queue with Customer Assist
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: The location ID where the call queue needs to be created.
          required: true
        - name: orgId
          in: query
          type: string
          description: The organization ID where the call queue needs to be created.
        - name: hasCxEssentials
          in: query
          type: boolean
          description: Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-queues-alternate-availableNumbers
      path: /telephony/config/locations/{locationId}/queues/alternate/availableNumbers
      operations:
      - name: getcallqueuealternateavailablephonenumbers
        method: GET
        description: Get Call Queue Alternate Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Return the list of phone numbers for this location within the given organization. The maximum length
            is 36.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
    - name: telephony-config-locations-locationId-queues-availableNumbers
      path: /telephony/config/locations/{locationId}/queues/availableNumbers
      operations:
      - name: getcallqueueprimaryavailablephonenumbers
        method: GET
        description: Get Call Queue Primary Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Return the list of phone numbers for this location within the given organization. The maximum length
            is 36.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
    - name: telephony-config-locations-locationId-queues-callForwarding-availableNumbers
      path: /telephony/config/locations/{locationId}/queues/callForwarding/availableNumbers
      operations:
      - name: getcallqueuecallforwardavailablephonenumbers
        method: GET
        description: Get Call Queue Call Forward Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Return the list of phone numbers for this location within the given organization. The maximum length
            is 36.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
        - name: ownerName
          in: query
          type: string
          description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255.
        - name: extension
          in: query
          type: string
          description: Returns the list of PSTN phone numbers with the given `extension`.
    - name: telephony-config-locations-locationId-queues-queueId
      path: /telephony/config/locations/{locationId}/queues/{queueId}
      operations:
      - name: deletecallqueue
        method: DELETE
        description: Delete a Call Queue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location from which to delete a call queue.
          required: true
        - name: queueId
          in: path
          type: string
          description: Delete the call queue with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Delete the call queue from this organization.
      - name: getcallqueuewithcustomerassist
        method: GET
        description: Get Details for a Call Queue with Customer Assist
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieves the details of a call queue in this location.
          required: true
        - name: queueId
          in: path
          type: string
          description: Retrieves the details of call queue with this identifier.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieves the details of a call queue in this organization.
        - name: hasCxEssentials
          in: query
          type: boolean
          description: Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise
            be ommited or set to `false`.
      - name: updatecallqueue
        method: PUT
        description: Update a Call Queue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which this call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Update setting for the call queue with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update call queue settings from this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-queues-queueId-announcements
      path: /telephony/config/locations/{locationId}/queues/{queueId}/announcements
      operations:
      - name: listcallqueueannouncementfiles
        method: GET
        description: Read the List of Call Queue Announcement Files
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which this call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Retrieve anouncement files for the call queue with this identifier.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve announcement files for a call queue from this organization.
    - name: telephony-config-locations-locationId-queues-queueId-announcements-fileName
      path: /telephony/config/locations/{locationId}/queues/{queueId}/announcements/{fileName}
      operations:
      - name: deletecallqueueannouncementfile
        method: DELETE
        description: Delete a Call Queue Announcement File
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Delete an announcement for a call queue in this location.
          required: true
        - name: queueId
          in: path
          type: string
          description: Delete an announcement for the call queue with this identifier.
          required: true
        - name: fileName
          in: path
          type: string
          required: true
        - name: orgId
          in: query
          type: string
          description: Delete call queue announcement from this organization.
    - name: telephony-config-locations-locationId-queues-queueId-callForwarding
      path: /telephony/config/locations/{locationId}/queues/{queueId}/callForwarding
      operations:
      - name: getcallqueuecallforwardingsettings
        method: GET
        description: Get Call Forwarding Settings for a Call Queue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which this call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Retrieve the call forwarding settings for this call queue.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve call queue forwarding settings from this organization.
      - name: updatecallqueuecallforwardingsettings
        method: PUT
        description: Update Call Forwarding Settings for a Call Queue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which this call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Update call forwarding settings for this call queue.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update call queue forwarding settings from this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-queues-queueId-callForwarding-actions-swit
      path: /telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/actions/switchMode/invoke
      operations:
      - name: switchcallqueuecallforwardingmode
        method: POST
        description: Switch Mode for Call Forwarding Settings for a Call Queue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: '`Location` in which this `call queue` exists.'
          required: true
        - name: queueId
          in: path
          type: string
          description: Switch operating mode to normal operations for this `call queue`.
          required: true
        - name: orgId
          in: query
          type: string
          description: Switch operating mode as per normal operations for the `call queue` from this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-queues-queueId-callForwarding-selectiveRul
      path: /telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/selectiveRules
      operations:
      - name: createcallqueueselectivecallforwardingrule
        method: POST
        description: Create a Selective Call Forwarding Rule for a Call Queue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which the call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Create the rule for this call queue.
          required: true
        - name: orgId
          in: query
          type: string
          description: Create the call queue rule for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-queues-queueId-callForwarding-selectiveRul
      path: /telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/selectiveRules/{ruleId}
      operations:
      - name: getcallqueueselectivecallforwardingrule
        method: GET
        description: Get Selective Call Forwarding Rule for a Call Queue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which to call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Retrieve setting for a rule for this call queue.
          required: true
        - name: ruleId
          in: path
          type: string
          description: Call queue rule you are retrieving settings for.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve call queue rule settings for this organization.
      - name: updatecallqueueselectivecallforwardingrule
        method: PUT
        description: Update a Selective Call Forwarding Rule for a Call Queue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which this call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Update settings for a rule for this call queue.
          required: true
        - name: ruleId
          in: path
          type: string
          description: Call queue rule you are updating settings for.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update call queue rule settings for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletecallqueueselectivecallforwardingrule
        method: DELETE
        description: Delete a Selective Call Forwarding Rule for a Call Queue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which this call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Delete the rule for this call queue.
          required: true
        - name: ruleId
          in: path
          type: string
          description: Call queue rule you are deleting.
          required: true
        - name: orgId
          in: query
          type: string
          description: Delete call queue rule from this organization.
    - name: telephony-config-locations-locationId-queues-queueId-forcedForward
      path: /telephony/config/locations/{locationId}/queues/{queueId}/forcedForward
      operations:
      - name: getcallqueueforcedforward
        method: GET
        description: Get Details for a Call Queue Forced Forward
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve settings for a call queue in this location.
          required: true
        - name: queueId
          in: path
          type: string
          description: Retrieve settings for the call queue with this identifier.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve call queue settings from this organization.
      - name: updatecallqueueforcedforward
        method: PUT
        description: Update a Call Queue Forced Forward Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which this call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Update setting for the call queue with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update call queue settings from this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-queues-queueId-holidayService
      path: /telephony/config/locations/{locationId}/queues/{queueId}/holidayService
      operations:
      - name: getcallqueueholidayservice
        method: GET
        description: Get Details for a Call Queue Holiday Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve settings for a call queue in this location.
          required: true
        - name: queueId
          in: path
          type: string
          description: Retrieve settings for the call queue with this identifier.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve call queue settings from this organization.
      - name: updatecallqueueholidayservice
        method: PUT
        description: Update a Call Queue Holiday Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which this call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Update setting for the call queue with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update call queue settings from this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-queues-queueId-nightService
      path: /telephony/config/locations/{locationId}/queues/{queueId}/nightService
      operations:
      - name: getcallqueuenightservice
        method: GET
        description: Get Details for a Call Queue Night Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve settings for a call queue in this location.
          required: true
        - name: queueId
          in: path
          type: string
          description: Retrieve settings for the call queue night service with this identifier.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve call queue night service settings from this organization.
      - name: updatecallqueuenightservice
        method: PUT
        description: Update a Call Queue Night Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Update settings for a call queue in this location.
          required: true
        - name: queueId
          in: path
          type: string
          description: Update settings for the call queue night service with this identifier.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update call queue night service settings from this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-queues-queueId-strandedCalls
      path: /telephony/config/locations/{locationId}/queues/{queueId}/strandedCalls
      operations:
      - name: getcallqueuestrandedcalls
        method: GET
        description: Get Details for a Call Queue Stranded Calls
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve settings for a call queue in this location.
          required: true
        - name: queueId
          in: path
          type: string
          description: Retrieve settings for the call queue with this identifier.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve call queue settings from this organization.
      - name: updatecallqueuestrandedcalls
        method: PUT
        description: Update a Call Queue Stranded Calls Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location in which this call queue exists.
          required: true
        - name: queueId
          in: path
          type: string
          description: Update setting for the call queue with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update call queue settings from this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-queues
      path: /telephony/config/queues
      operations:
      - name: listcallqueues
        method: GET
        description: Read the List of Call Queues with Customer Assist
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Returns the list of call queues in this organization.
        - name: locationId
          in: query
          type: string
          description: Returns the list of call queues in this location.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: name
          in: query
          type: string
          description: Returns only the call queues matching the given name.
        - name: phoneNumber
          in: query
          type: string
          description: Returns only the call queues matching the given primary phone number or extension.
        - name: departmentId
          in: query
          type: string
          description: Returns only call queues matching the given department ID.
        - name: departmentName
          in: query
          type: string
          description: Returns only call queues matching the given department name.
        - name: hasCxEssentials
          in: query
          type: boolean
          description: Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the
            list of Customer Experience Basic call queues.
    - name: telephony-config-queues-agents
      path: /telephony/config/queues/agents
      operations:
      - name: listcallqueueagents
        method: GET
        description: Read the List of Call Queue Agents with Customer Assist
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List call queues agents in this organization.
        - name: locationId
          in: query
          type: string
          description: Return only the call queue agents in this location.
        - name: queueId
          in: query
          type: string
          description: Only return call queue agents with the matching queue ID.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: name
          in: query
          type: string
          description: Returns only the list of call queue agents that match the given name.
        - name: phoneNumber
          in: query
          type: string
          description: Returns only the list of call queue agents that match the given phone number or extension.
        - name: joinEnabled
          in: query
          type: boolean
          description: Returns only the list of call queue agents that match the given `joinEnabled` value.
        - name: hasCxEssentials
          in: query
          type: boolean
          description: Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the
            list of Customer Experience Basic call queues.
        - name: order
          in: query
          type: string
          description: Sort results alphabetically by call queue agent's name, in ascending or descending order.
    - name: telephony-config-queues-agents-availableAgents
      path: /telephony/config/queues/agents/availableAgents
      operations:
      - name: getcallqueueavailableagents
        method: GET
        description: Get Call Queue Available Agents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: query
          type: string
          description: The location ID of the call queue. Temporary mandatory query parameter, used for performance reasons
            only and not a filter.
          required: true
        - name: orgId
          in: query
          type: string
          description: List available agents for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: name
          in: query
          type: string
          description: Search based on name (user first and last name combination).
        - name: phoneNumber
          in: query
          type: string
          description: Search based on number or extension.
        - name: order
          in: query
          type: string
          description: 'Order the available agents according to the designated fields. Up to three comma-separated sort order
            fields may be specified. Available sort fields are: `userI'
    - name: telephony-config-queues-agents-id
      path: /telephony/config/queues/agents/{id}
      operations:
      - name: getcallqueueagent
        method: GET
        description: Get Details for a Call Queue Agent with Customer Assist
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Retrieve call queue agents with this identifier.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve call queue agents from this organization.
        - name: hasCxEssentials
          in: query
          type: boolean
          description: Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise
            be ommited or set to `false`.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
          required: true
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
          required: true
    - name: telephony-config-queues-agents-id-settings
      path: /telephony/config/queues/agents/{id}/settings
      operations:
      - name: updateagentcallqueuesettings
        method: PUT
        description: Update an Agent's Settings of One or More Call Queues with Customer Assist
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string


# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/capabilities/cloud-calling-features-call-queue.yaml