Microsoft Azure Communication Services SIP Configuration API

openapi: 3.2.0
info:
  title: SipRouting Service Sip Configuration API
  description: SipRouting Service
  contact:
    email: acsdevexdisc@microsoft.com
  version: '2023-03-01'
security:
- azure_auth:
  - user_impersonation
- apiKey: []
tags:
- name: SIP Configuration
paths:
  /sip:
    get:
      tags:
      - SIP Configuration
      summary: Gets SIP configuration for resource
      operationId: SipRouting_Get
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipConfiguration'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              description: Error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
    patch:
      tags:
      - SIP Configuration
      summary: Updates SIP configuration for resource
      operationId: SipRouting_Update
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Updated configuration is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipConfiguration'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              description: Error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/SipConfigurationUpdate'
        description: Sip configuration update object.
components:
  schemas:
    TrunkUpdate:
      description: Represents a SIP trunk update.
      type: object
      properties:
        sipSignalingPort:
          format: int32
          description: Gets or sets SIP signaling port of the trunk.
          type: integer
    SipConfigurationUpdate:
      description: Represents a SIP configuration update.
      type: object
      properties:
        trunks:
          description: 'SIP trunks for routing calls.

            Map key is trunk''s FQDN (1-249 characters).'
          maxProperties: 250
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TrunkUpdate'
        routes:
          description: Trunk routes for routing calls.
          maxItems: 250
          type: array
          items:
            $ref: '#/components/schemas/TrunkRoute'
    CommunicationErrorResponse:
      description: The Communication Services error.
      type: object
      required:
      - error
      properties:
        error:
          description: The Communication Services error.
          $ref: '#/components/schemas/CommunicationError'
    Trunk:
      description: Represents a SIP trunk for routing calls. See RFC 4904.
      required:
      - sipSignalingPort
      type: object
      properties:
        sipSignalingPort:
          format: int32
          description: Gets or sets SIP signaling port of the trunk.
          type: integer
    SipConfiguration:
      description: 'Represents a SIP configuration.

        When a call is being routed the routes are applied in the same order as in the routes list.

        A route is matched by its number pattern.

        Call is then directed into route''s first available trunk, based on the order in the route''s trunks list.'
      type: object
      properties:
        trunks:
          description: 'SIP trunks for routing calls.

            Map key is trunk''s FQDN (1-249 characters).'
          maxProperties: 250
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Trunk'
        routes:
          description: Trunk routes for routing calls.
          maxItems: 250
          type: array
          items:
            $ref: '#/components/schemas/TrunkRoute'
    TrunkRoute:
      description: Represents a trunk route for routing calls.
      required:
      - name
      - numberPattern
      type: object
      properties:
        description:
          description: Gets or sets description of the route.
          maxLength: 1024
          type: string
        name:
          description: Gets or sets name of the route.
          maxLength: 256
          type: string
        numberPattern:
          description: 'Gets or sets regex number pattern for routing calls. .NET regex format is supported.

            The regex should match only digits with an optional ''+'' prefix without spaces.

            I.e. "^\+[1-9][0-9]{3,23}$".'
          maxLength: 1024
          type: string
        trunks:
          description: Gets or sets list of SIP trunks for routing calls. Trunks are represented as FQDN.
          maxItems: 250
          type: array
          items:
            type: string
  parameters:
    ApiVersionParameter:
      in: query
      name: api-version
      description: Version of API to invoke
      required: true
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
    apiKey:
      type: apiKey
      name: access_key
      in: header
      description: An authentication string containing a signature generated using HMAC-SHA256 scheme.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'