Webex Telephony API

The Telephony API from Webex — 1 operation(s) for telephony.

OpenAPI Specification

webex-telephony-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Webex Telephony API
  version: 1.0.0
  description: 'Operations tagged Telephony across 2 of this provider''s published API definitions: webex-cloud-calling-openapi.json,
    webex-telephony-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: 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: Telephony
paths:
  /telephony/config/people/me/settings/contactCenterExtensions:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactCenterExtensionsGetObject'
              example:
                ccExtensions:
                - directNumber: '+13374831550'
                  extension: '1550'
                  type: PRIMARY
                  lineOwnerType: PEOPLE
                  lineOwnerId: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU
                  preferredAnsweringEndPointId: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2Q0OTE3ZWFiLTQ4Y2EtNGRlZC1iOTczLWQzNTFhOTU5OWZhZB
                  endpoints:
                  - id: Y2lzY29zcGFyazovL3VzL0hPVERFU0tJTkdfR1VFU1QvNDE1YjFkODUtZDA3NS00ZTNmLWExMGItMGVjOGExMjRjMWQ4
                    type: HOTDESKING_GUEST
                  - id: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2Q0OTE3ZWFiLTQ4Y2EtNGRlZC1iOTczLWQzNTFhOTU5OWZhZB
                    type: CALLING_DEVICE
                  - id: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2QxYzM5M2QwLTg1M2ItNDc3MC1iZjA1LWQyMDU2MWRhM2NjZh
                    type: APPLICATION
                endpoints:
                - id: Y2lzY29zcGFyazovL3VzL0hPVERFU0tJTkdfR1VFU1QvNDE1YjFkODUtZDA3NS00ZTNmLWExMGItMGVjOGExMjRjMWQ4
                  type: HOTDESKING_GUEST
                  name: Cisco HotDesking
                  status: CONNECTED
                - id: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2Q0OTE3ZWFiLTQ4Y2EtNGRlZC1iOTczLWQzNTFhOTU5OWZhZB
                  type: CALLING_DEVICE
                  name: Cisco 9841
                  status: CONNECTED
                - id: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2QxYzM5M2QwLTg1M2ItNDc3MC1iZjA1LWQyMDU2MWRhM2NjZh
                  type: APPLICATION
                  name: Webex Desktop Application
                  status: CONNECTED
        '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 Contact Center Extensions
      operationId: Read the Contact Center Extensions
      description: "Retrieves the Contact Center phone number, extension, virtual numbers, endpoints, and endpoints registration\
        \ status associated with the authenticated user. This API returns all primary and secondary endpoints, the hot desk\
        \ guest profiles currently hosted on the agent's own devices, if any, and registration status of those endpoints.\
        \ Only virtual line extensions hosted exclusively on the agent's devices and the registration status of those virtual\
        \ line endpoints will be retrieved. Any virtual lines shared with devices not owned by the current user will be excluded.\n\
        \n A Webex Calling Contact Center extension is a calling extension assigned to a user or device within the Webex Contact\
        \ Center for internal dialing.\n\nThis API requires a user auth token with a scope of spark:telephony_config_read."
      tags:
      - Telephony
      parameters: []
components:
  schemas:
    EndpointType:
      type: string
      enum:
      - CALLING_DEVICE
      - APPLICATION
      - HOTDESKING_GUEST
      description: " * `CALLING_DEVICE` - Endpoint is a calling device.\n * `APPLICATION` - Endpoint is an application.\n\
        \ * `HOTDESKING_GUEST` - Endpoint is a hotdesking guest.\n"
    UserExtensions:
      type: object
      required:
      - directNumber
      - extension
      - type
      - lineOwnerType
      - lineOwnerId
      - preferredAnsweringEndPointId
      - endpoints
      properties:
        directNumber:
          type: string
          example: '+13374831550'
          description: Direct number of the user.
        extension:
          type: string
          example: '1550'
          description: Extension of the user.
        type:
          type: string
          $ref: '#/components/schemas/ExtensionType'
          description: Type of User Extension.
        lineOwnerType:
          type: string
          $ref: '#/components/schemas/LineOwnerType'
          description: Type of the line owner. Indicates whether the line is owned by a person, workspace, or virtual line.
        lineOwnerId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU
          description: Unique identifier of the line owner.
        preferredAnsweringEndPointId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2Q0OTE3ZWFiLTQ4Y2EtNGRlZC1iOTczLWQzNTFhOTU5OWZhZB
          description: Unique identifier of the set preferred answering endpoint.
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/UserEndpointType'
          description: List of user endpoints with type.
    EndpointStatus:
      type: string
      enum:
      - CONNECTED
      - NOT_CONNECTED
      description: " * `CONNECTED` - Device is connected.\n * `NOT_CONNECTED` - Device is not connected.\n"
    ExtensionType:
      type: string
      enum:
      - PRIMARY
      - SECONDARY
      description: " * `PRIMARY` - Indicates that the extension is owned by the user.\n * `SECONDARY` - Indicates that the\
        \ extension is not owned by the user and is a secondary line on one of the users devices.\n"
    UserEndpoints:
      type: object
      required:
      - id
      - type
      - name
      - status
      properties:
        id:
          type: string
          example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM
          description: Unique identifier of the endpoint.
        type:
          $ref: '#/components/schemas/EndpointType'
          description: Type of the endpoint.
        name:
          type: string
          example: Webex Go Device
          description: Name of the endpoint.
        status:
          $ref: '#/components/schemas/EndpointStatus'
          description: SIP Registration status of the device.
    LineOwnerType:
      type: string
      enum:
      - PEOPLE
      - PLACE
      - VIRTUAL_LINE
      description: " * `PEOPLE` - The line is owned by a person.\n * `PLACE` - The line is owned by a workspace.\n * `VIRTUAL_LINE`\
        \ - The line is owned by a virtual line.\n"
    ContactCenterExtensionsGetObject:
      type: object
      required:
      - ccExtensions
      - endpoints
      properties:
        ccExtensions:
          type: array
          items:
            $ref: '#/components/schemas/UserExtensions'
          description: List of user extensions.
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/UserEndpoints'
          description: List of user endpoints details.
    UserEndpointType:
      type: object
      required:
      - id
      - type
      properties:
        id:
          type: string
          example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM
          description: Unique identifier of the endpoint.
        type:
          $ref: '#/components/schemas/EndpointType'
          description: Type of the endpoint.
  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: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- webex-cloud-calling-openapi.json
- webex-telephony-api-openapi.yml