Cisco Expressway SIP API

openapi: 3.1.0
info:
  title: Cisco Expressway Configuration Admin Account SIP API
  description: RESTful API for configuring and managing Cisco Expressway systems including zones, search rules, transforms, DNS servers, NTP servers, SFTP configuration, system upgrades, and admin account management. The API uses JSON Schema version 4 for request and response schemas and is self-documented via RAML definitions available at /api/raml on the Expressway system. All endpoints require HTTPS and HTTP Basic Authentication using Expressway administrator credentials.
  version: 14.2.0
  contact:
    name: Cisco TAC
    email: tac@cisco.com
    url: https://www.cisco.com/c/en/us/support/unified-communications/expressway-series/tsd-products-support-series-home.html
  license:
    name: Cisco EULA
    url: https://www.cisco.com/c/en/us/about/legal/cloud-and-software/end_user_license_agreement.html
  x-logo:
    url: https://www.cisco.com/c/dam/en/us/products/collateral/unified-communications/expressway-series/datasheet-c78-733751.jpg
servers:
- url: https://{host}/api
  description: Cisco Expressway server
  variables:
    host:
      default: expressway.example.com
      description: The FQDN or IP address of the Cisco Expressway node. The API is only accessible via HTTPS.
security:
- basicAuth: []
tags:
- name: SIP
  description: SIP protocol configuration
paths:
  /provisioning/common/sip/configuration:
    get:
      operationId: getSipConfiguration
      summary: Cisco Expressway Retrieve SIP configuration
      description: Returns the current SIP protocol configuration for the Expressway including SIP mode, listening ports, transport protocols, registration settings, and session timer parameters.
      tags:
      - SIP
      responses:
        '200':
          description: SIP configuration retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    put:
      operationId: updateSipConfiguration
      summary: Cisco Expressway Update SIP configuration
      description: Modifies the SIP protocol configuration on the Expressway including SIP mode, transport settings, registration proxy behavior, and session timer parameters.
      tags:
      - SIP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SipConfigurationInput'
      responses:
        '200':
          description: SIP configuration updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipConfiguration'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  responses:
    BadRequest:
      description: The request body contains invalid data or missing required fields.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication credentials are missing or invalid. The API requires HTTP Basic Authentication with administrator credentials over HTTPS.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The authenticated user does not have sufficient permissions for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    SipConfigurationInput:
      type: object
      description: Input for updating SIP configuration
      allOf:
      - $ref: '#/components/schemas/SipConfiguration'
    SipConfiguration:
      type: object
      description: SIP protocol configuration for the Expressway
      properties:
        SIPMode:
          type: string
          description: Whether SIP functionality is enabled
          enum:
          - 'On'
          - 'Off'
        TCPMode:
          type: string
          description: Whether SIP over TCP is enabled
          enum:
          - 'On'
          - 'Off'
        TCPPort:
          type: integer
          description: TCP port for SIP signaling
          default: 5060
        TLSPort:
          type: integer
          description: TLS port for SIP signaling
          default: 5061
        UDPMode:
          type: string
          description: Whether SIP over UDP is enabled
          enum:
          - 'On'
          - 'Off'
        UDPPort:
          type: integer
          description: UDP port for SIP signaling
          default: 5060
        SessionRefreshInterval:
          type: integer
          description: Session refresh interval in seconds
          default: 1800
        SessionRefreshMethod:
          type: string
          description: Method used for session refresh
          enum:
          - UPDATE
          - INVITE
        RegistrationProxyMode:
          type: string
          description: Whether the Expressway acts as a SIP registrar proxy
          enum:
          - 'On'
          - 'Off'
    Error:
      type: object
      description: Standard error response from the Expressway API
      properties:
        error:
          type: string
          description: Error code or type
        message:
          type: string
          description: Human-readable error description
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Expressway administrator credentials. The API is only accessible via HTTPS.
externalDocs:
  description: Cisco Expressway REST API Summary Guide (X14.2)
  url: https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/expressway/admin_guide/X14-2/rest-api/exwy_b_cisco-expressway-rest-api-summary-guide--x142/exwy_m_using-the-expressway-rest-api.html