Webex Call Queue Settings with Playlist Settings API

The Call Queue Settings with Playlist Settings API from Webex — 1 operation(s) for call queue settings with playlist settings.

OpenAPI Specification

webex-call-queue-settings-with-playlist-settings-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Webex Call Queue Settings with Playlist Settings API
  version: 1.0.0
  description: 'Operations tagged Call Queue Settings with Playlist Settings across 2 of this provider''s published API definitions:
    webex-call-queue-settings-with-playlist-settings-api-openapi.yml, webex-cloud-calling-openapi.json. 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: 1/1
  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: Call Queue Settings with Playlist Settings
paths:
  /telephony/config/announcements/playlists/{playListId}/usage:
    get:
      summary: Get Playlist Usage
      operationId: getPlaylistUsage
      tags:
      - Call Queue Settings with Playlist Settings
      parameters:
      - name: playListId
        in: path
        required: true
        description: Unique identifier of the playlist.
        schema:
          type: string
        example: Y2lzY29zcGFyazovL3VzL1BMQVlMSVNULzg1NWU1N2M0LWUzYTAtNGEyZS1hYWYxLTQ3ZWUxMmI3M2U2MA==
      - name: playlistUsageType
        in: query
        schema:
          type: string
          enum:
          - feature
          - location
        description: Filter usage by type.
        example: feature
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaylistUsage'
              example:
                id: Y2lzY29zcGFyazovL3VzL1BMQVlMSVNULzg1NWU1N2M0LWUzYTAtNGEyZS1hYWYxLTQ3ZWUxMmI3M2U2MA
                locations:
                - name: RCDN6
                  id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAxNWFmN2QzLTRlNzktNGY2ZC04Nzk5LWRlMjEzYTBhZDNhYQ
                  featureReference:
                    id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNGFlMzJkMTAtNWI0Zi00NmNmLWI4ZTQtYmE2YzNiZjMyZGZi
                    name: Test Call Queue
                    type: CALL_QUEUE
                - name: RCDN6
                  id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAxNWFmN2QzLTRlNzktNGY2ZC04Nzk5LWRlMjEzYTBhZDNhYQ
                  featureReference:
                    id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvMTkyNDYxMjEtZDhiYi00NTdjLWEzZjQtNGQ3YTBlYmQ4Nzk2
                    name: Test Call Queue 3
                    type: CALL_QUEUE
        '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.'
components:
  schemas:
    PlaylistUsage:
      description: Mapping of a playlist to the locations and features where it is used.
      type: object
      properties:
        id:
          type: string
          description: Identifier of the playlist.
        locations:
          type: array
          description: List of locations using this playlist.
          items:
            type: object
            description: Location and feature referencing this playlist.
            properties:
              id:
                type: string
                description: Location identifier.
              name:
                type: string
                description: Location name.
              featureReference:
                type: object
                description: Feature referencing the playlist.
                properties:
                  id:
                    type: string
                    description: Feature identifier.
                  name:
                    type: string
                    description: Feature name.
                  type:
                    type: string
                    description: Feature type.
                required:
                - id
                - name
                - type
            required:
            - id
            - name
            - featureReference
      required:
      - id
      - locations
      example:
        id: Y2lzY29zcGFyazovL3VzL1BMQVlMSVNULzg1NWU1N2M0LWUzYTAtNGEyZS1hYWYxLTQ3ZWUxMmI3M2U2MA
        locations:
        - name: RCDN6
          id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAxNWFmN2QzLTRlNzktNGY2ZC04Nzk5LWRlMjEzYTBhZDNhYQ
          featureReference:
            id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNGFlMzJkMTAtNWI0Zi00NmNmLWI4ZTQtYmE2YzNiZjMyZGZi
            name: Test Call Queue
            type: CALL_QUEUE
        - name: RCDN6
          id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAxNWFmN2QzLTRlNzktNGY2ZC04Nzk5LWRlMjEzYTBhZDNhYQ
          featureReference:
            id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvMTkyNDYxMjEtZDhiYi00NTdjLWEzZjQtNGQ3YTBlYmQ4Nzk2
            name: Test Call Queue 3
            type: CALL_QUEUE
  securitySchemes:
    oauth2:
      flows:
        authorizationCode:
          authorizationUrl: /
          scopes: {}
          tokenUrl: /
      type: oauth2
    bearer-key:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: oauth2
      description: OAuth 2.0 Bearer token authentication
      flows:
        authorizationCode:
          authorizationUrl: https://webexapis.com/v1/authorize
          tokenUrl: https://webexapis.com/v1/access_token
          scopes:
            spark:applications_token: Create access tokens for Service Apps
x-refined-from:
- webex-call-queue-settings-with-playlist-settings-api-openapi.yml
- webex-cloud-calling-openapi.json