Microsoft Azure Numbers API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Numbers API
tags:
- name: Numbers
paths:
  /numbers:
    get:
      operationId: microsoftAzureNumbersList
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - in: query
        name: number
        description: Query information for a specific number.
        schema:
          type: string
          maxLength: 16
          minLength: 1
          pattern: ^\+[1-9]\d+$
      - in: query
        name: maxpagesize
        description: Maximum number of records to include in a single response. Defaults to 200, and must not exceed 500.
        schema:
          type: integer
          format: int32
      - in: query
        name: skip
        description: An offset into the collection of the first record to be returned.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumbersList'
        default:
          description: An error response object.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Get all numbers configured on the provisioning platform.:
          $ref: ./examples/GetNumbers.json
      tags:
      - Numbers
      description: Gets a list of all configured numbers across all accounts. Response pagination can be controlled with a combination of the maxpagesize and skip parameters. Limit the number of records in a response with the maxpagesize parameter. Specify the starting record using the skip parameter.
      summary: Microsoft Azure Get Numbers
components:
  schemas:
    ErrorResponse:
      title: Error details.
      description: Contains details when the response code indicates an error.
      type: object
      properties:
        error:
          description: The error details.
          $ref: '#/components/schemas/ErrorDetail'
      required:
      - error
    NumberConfiguration:
      additionalProperties: false
      properties:
        customSipHeader:
          pattern: ^([A-Za-z0-9_-])+$
          minLength: 1
          maxLength: 100
          type: string
          description: Contents of the custom SIP header to use with this number. Can only contain letters, numbers, underscores and dashes. Can be up to 100 characters in length. The name of the custom header is set as part of deploying Azure Communications Gateway.
      type: object
      description: Configuration for this number.
    NumberResponse:
      additionalProperties: false
      properties:
        etag:
          type: string
          description: ETag for use with If-Match headers for optimistic concurrency.
        accountName:
          minLength: 1
          type: string
          description: Account name which owns this number.
        phoneNumber:
          minLength: 1
          type: string
          description: The phone number corresponding to this entry.
        details:
          $ref: '#/components/schemas/NumberDetails'
      required:
      - accountName
      - details
      - phoneNumber
      type: object
      description: Details of the number as returned on a GET request.
    NumberDetails:
      additionalProperties: false
      properties:
        configuration:
          $ref: '#/components/schemas/NumberConfiguration'
        services:
          $ref: '#/components/schemas/NumberServices'
      required:
      - services
      type: object
      description: Details of the number.
    NumberServices:
      additionalProperties: false
      properties:
        teamsDrEnabled:
          type: boolean
          description: Enables/disables Microsoft Teams Direct Routing for the number.
        teamsOcEnabled:
          type: boolean
          description: Enables/disables Operator Connect for the number.
        zoomEnabled:
          type: boolean
          description: Enables/disables Zoom for the number.
      required:
      - teamsDrEnabled
      - teamsOcEnabled
      - zoomEnabled
      type: object
      description: Communications services enabled for this number.
    ErrorDetail:
      title: The code and message for an error.
      type: object
      properties:
        code:
          description: A machine readable error code.
          type: string
        message:
          description: A human readable representation of the error.
          type: string
        details:
          description: An array of details about specific errors that led to this error.
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
        innererror:
          description: An object containing more specific information about the error.
          $ref: '#/components/schemas/InnerError'
        additionalProperties:
          description: Additional properties that can be provided about the error.
      required:
      - code
      - message
    InnerError:
      title: More specific information on an error object.
      type: object
      properties:
        code:
          description: A machine readable error code.
          type: string
        innererror:
          description: Inner error details if they exist.
          $ref: '#/components/schemas/InnerError'
    NumbersList:
      additionalProperties: false
      properties:
        value:
          items:
            $ref: '#/components/schemas/NumberResponse'
          type: array
          description: Number of records for the page.
        nextLink:
          type: string
          format: uri
          description: Link to the next page of results.
      required:
      - value
      type: object
      description: List of number records.
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client API version
      x-ms-parameter-location: client
      schema:
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'