Microsoft Azure SipConfiguration API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SipConfiguration API
schemes:
- https
tags:
- name: SipConfiguration
paths:
  /sip:
    get:
      tags:
      - SipConfiguration
      summary: Microsoft Azure Gets Sip Configuration For Resource
      operationId: microsoftAzureSiproutingGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ExpandSipConfiguration'
      responses:
        '200':
          description: Ok.
          schema:
            $ref: '#/definitions/SipConfiguration'
        default:
          description: Failure
          schema:
            $ref: ../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse
          headers:
            x-ms-error-code:
              type: string
              description: Error code
      x-ms-examples:
        Get SIP configuration for resource with Trunk Health expand:
          $ref: ./examples/GetSipConfigurationWithExpand.json
      description: Needs a more full description created.
    patch:
      tags:
      - SipConfiguration
      summary: Microsoft Azure Updates Sip Configuration For Resource
      operationId: microsoftAzureSiproutingUpdate
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: body
        description: Sip configuration update object.
        schema:
          $ref: '#/definitions/SipConfigurationUpdate'
      responses:
        '200':
          description: Updated configuration is returned.
          schema:
            $ref: '#/definitions/SipConfiguration'
        default:
          description: Failure
          schema:
            $ref: ../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse
          headers:
            x-ms-error-code:
              type: string
              description: Error code
      x-ms-examples:
        Update SIP configuration for resource:
          $ref: ./examples/UpdateSipConfiguration.json
      description: Needs a more full description created.
definitions:
  Health:
    description: Represents health state of a SIP trunk for routing calls.
    type: object
    required:
    - tls
    - ping
    - overall
    properties:
      tls:
        $ref: '#/definitions/Tls'
      ping:
        $ref: '#/definitions/Ping'
      overall:
        $ref: '#/definitions/OverallHealth'
  Enabled:
    type: boolean
    description: "Flag if domain is enabled or not.\r\nIf enabled it's used in configuration, if not enabled it's not used."
  OverallHealth:
    type: object
    description: The overall health status of Trunk.
    required:
    - status
    properties:
      status:
        type: string
        description: The overall health status of Trunk.
        enum:
        - unknown
        - active
        - inactive
        x-ms-enum:
          name: overallHealthStatus
          modelAsString: true
          values:
          - value: unknown
            description: Indicates an unknown health status.
          - value: active
            description: Indicates the Trunk is active.
          - value: inactive
            description: Indicates the Trunk is inactive.
      reason:
        type: string
        description: The reason overall status of Trunk is inactive.
        enum:
        - noRecentCalls
        - noRecentPings
        - noRecentCallsAndPings
        x-ms-enum:
          name: inactiveStatusReason
          modelAsString: true
          values:
          - value: noRecentCalls
            description: Indicates no recent calls.
          - value: noRecentPings
            description: Indicates ping status is expired.
          - value: noRecentCallsAndPings
            description: Indicates no recent calls and ping status is expired.
  SipConfigurationUpdate:
    description: Represents a SIP configuration update.
    type: object
    properties:
      domains:
        description: "Domains that will be used.\r\nMap key is domain."
        type: object
        additionalProperties:
          $ref: '#/definitions/DomainPatch'
      trunks:
        description: "SIP trunks for routing calls.\r\nMap key is trunk's FQDN (1-249 characters)."
        maxProperties: 250
        type: object
        additionalProperties:
          $ref: '#/definitions/TrunkUpdate'
      routes:
        description: Trunk routes for routing calls.
        maxItems: 250
        type: array
        items:
          $ref: '#/definitions/TrunkRoute'
  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. The configuration can be expanded with additional data."
    type: object
    properties:
      domains:
        description: "Validated Domains.\r\nMap key is domain."
        maxProperties: 250
        type: object
        additionalProperties:
          $ref: '#/definitions/Domain'
      trunks:
        description: "SIP trunks for routing calls.\r\nMap key is trunk's FQDN (1-249 characters)."
        maxProperties: 250
        type: object
        additionalProperties:
          $ref: '#/definitions/Trunk'
      routes:
        description: Trunk routes for routing calls.
        maxItems: 250
        type: array
        items:
          $ref: '#/definitions/TrunkRoute'
  Trunk:
    description: Represents a SIP trunk for routing calls. See RFC 4904. Can be expanded with additional data.
    required:
    - sipSignalingPort
    - enabled
    type: object
    properties:
      sipSignalingPort:
        format: int32
        description: Gets or sets SIP signaling port of the trunk.
        type: integer
      enabled:
        description: Enabled flag
        $ref: '#/definitions/Enabled'
      health:
        description: Represents health state of a SIP trunk for routing calls.
        type: object
        readOnly: true
        $ref: '#/definitions/Health'
  Domain:
    description: "Represents Domain object as response of validation api.\r\nMap key is domain."
    required:
    - enabled
    type: object
    properties:
      enabled:
        description: Enabled flag
        $ref: '#/definitions/Enabled'
  Tls:
    type: object
    description: The status of the TLS connections of the Trunk.
    required:
    - status
    properties:
      status:
        type: string
        description: The status of the TLS connections of the Trunk.
        enum:
        - unknown
        - ok
        - certExpiring
        - certExpired
        x-ms-enum:
          modelAsString: true
          name: tlsStatus
          values:
          - value: unknown
            description: Indicates an unknown status.
          - value: ok
            description: Indicates the status is okay.
          - value: certExpiring
            description: Indicates the Trunk certificate is expiring.
          - value: certExpired
            description: Indicates the Trunk certificate is expired.
  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
      enabled:
        description: Enabled flag
        $ref: '#/definitions/Enabled'
  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
  Ping:
    type: object
    description: The status of SIP OPTIONS message sent by Trunk.
    required:
    - status
    properties:
      status:
        type: string
        description: The status of SIP OPTIONS message sent by Trunk.
        enum:
        - unknown
        - ok
        - expired
        - error
        x-ms-enum:
          name: pingStatus
          modelAsString: true
          values:
          - value: unknown
            description: Indicates an unknown status.
          - value: ok
            description: Indicates the status is okay.
          - value: expired
            description: Indicates the status is expired.
          - value: error
            description: Indicates the status is at an error level.
  DomainPatch:
    description: "Represents Domain that will be used.\r\nMap key is domain."
    type: object
    properties:
      enabled:
        description: Enabled flag
        $ref: '#/definitions/Enabled'
parameters:
  ApiVersionParameter:
    in: query
    name: api-version
    description: Version of API to invoke
    required: true
    type: string
  ExpandSipConfiguration:
    name: expand
    in: query
    required: false
    type: string
    description: Sip configuration expand. Optional.
    x-ms-parameter-location: method
    enum:
    - trunks/health
    x-ms-enum:
      name: ExpandEnum
      modelAsString: true
      values:
      - value: trunks/health
        description: Health state of a SIP trunk for routing calls.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'