Azure Communication Services SIP Routing API

openapi: 3.0.3
info:
  title: SipRouting Service
  description: SipRouting Service
  contact:
    email: acsdevexdisc@microsoft.com
  version: '2023-03-01'
servers:
- url: '{endpoint}'
  variables:
    endpoint:
      default: https://{resource}.communication.azure.com
      description: The communication resource, for example https://resourcename.communication.azure.com
paths:
  /sip:
    get:
      tags:
      - SipConfiguration
      summary: Gets SIP configuration for resource.
      operationId: SipRouting_Get
      x-ms-examples:
        Get SIP configuration for resource:
          $ref: ./examples/GetSipConfiguration.json
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipConfiguration'
        default:
          description: Failure
          content:
            application/json:
              schema:
                $ref: ../../../Common/stable/2022-07-13/common.json#/components/schemas/CommunicationErrorResponse
          headers:
            x-ms-error-code:
              description: Error code
              schema:
                type: string
    patch:
      tags:
      - SipConfiguration
      summary: Updates SIP configuration for resource.
      operationId: SipRouting_Update
      x-ms-examples:
        Update SIP configuration for resource:
          $ref: ./examples/UpdateSipConfiguration.json
      requestBody:
        required: false
        description: Sip configuration update object.
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/SipConfigurationUpdate'
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Updated configuration is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipConfiguration'
        default:
          description: Failure
          content:
            application/json:
              schema:
                $ref: ../../../Common/stable/2022-07-13/common.json#/components/schemas/CommunicationErrorResponse
          headers:
            x-ms-error-code:
              description: Error code
              schema:
                type: string
components:
  schemas:
    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
    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
    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.\r\nThe regex should match only digits with an optional '+' prefix without spaces.\r\nI.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
    SipConfiguration:
      description: "Represents a SIP configuration.\r\nWhen a call is being routed the routes are applied in the same order as in the routes list.\r\nA route is matched by its number pattern.\r\nCall 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.\r\nMap 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'
    SipConfigurationUpdate:
      description: Represents a SIP configuration update.
      type: object
      properties:
        trunks:
          description: "SIP trunks for routing calls.\r\nMap 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'
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: Version of API to invoke
      required: true
      schema:
        type: string
    Endpoint:
      name: endpoint
      in: path
      description: The communication resource, for example https://resourcename.communication.azure.com
      required: true
      schema:
        type: string
      x-ms-skip-url-encoding: true
      x-ms-parameter-location: client
  securitySchemes:
    azure_auth:
      type: oauth2
      description: Azure Active Directory OAuth2 Flow
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account
    apiKey:
      type: apiKey
      name: access_key
      in: header
      description: An authentication string containing a signature generated using HMAC-SHA256 scheme.
security:
- azure_auth:
  - user_impersonation
- apiKey: []
x-converted-from:
  format: swagger 2.0
  source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/communication/data-plane/SipRouting/stable/2023-03-01/communicationservicessiprouting.json
  tool: apievangelist s2o.py (structural conversion, no content added)