Microsoft Azure BatchNumbers API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Batch Numbers API
tags:
- name: BatchNumbers
paths:
  /account/{accountName}/numbers:batch:
    post:
      operationId: microsoftAzureAccountCreateorreplacenumbers
      parameters:
      - in: path
        name: accountName
        required: true
        description: Name of the account. Can only contain letters, numbers, underscores and dashes, and is case-sensitive. Can be up to 100 characters in length.
        schema:
          type: string
          maxLength: 100
          minLength: 1
          pattern: ^([A-Za-z0-9_-]+)$
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchNumbersResponse'
        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-examples:
        Batch put numbers.:
          $ref: ./examples/BatchPutNumbers.json
      tags:
      - BatchNumbers
      description: Adds or replaces between 1 and 100 numbers (inclusive) in the specified account. In the body, specify a list of phone numbers and and the corresponding details (for example, the services to enable) for each number. This operation is atomic; if any item fails, then all items fail.
      summary: Microsoft Azure Post Account Accountname Numbers:batch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchNumbers'
        description: Batch of numbers to create or replace.
        required: true
  /accounts/{accountName}:createOrUpdateNumbers:
    post:
      operationId: microsoftAzureAccountsCreateorupdatenumbers
      tags:
      - BatchNumbers
      summary: Microsoft Azure Create Or Update Numbers
      description: Create or update up to 100 Numbers on the specified account.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: accountName
        in: path
        description: Name of the account.
        required: true
        schema:
          type: string
          maxLength: 100
          minLength: 1
          pattern: ^([A-Za-z0-9_-]+)$
      - $ref: '#/components/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId'
      - $ref: '#/components/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent'
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            Repeatability-Result:
              description: Indicates whether the repeatable request was accepted or rejected.
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                - name: accepted
                  value: accepted
                  description: If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.
                - name: rejected
                  value: rejected
                  description: 'If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid

                    or because the Repeatability-First-Sent value was outside the range of values held by the server.'
              schema:
                type: string
                enum:
                - accepted
                - rejected
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchNumbers_2'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        Create or update Numbers.:
          $ref: ./examples/PostAccountNumbersBatch.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchNumbers_2'
        required: true
  /accounts/{accountName}:deleteNumbers:
    post:
      operationId: microsoftAzureAccountsDeletenumbers
      tags:
      - BatchNumbers
      summary: Microsoft Azure Delete Numbers
      description: Delete up to 100 Numbers on the specified account.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: accountName
        in: path
        description: Name of the account.
        required: true
        schema:
          type: string
          maxLength: 100
          minLength: 1
          pattern: ^([A-Za-z0-9_-]+)$
      - $ref: '#/components/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId'
      - $ref: '#/components/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent'
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
          headers:
            Repeatability-Result:
              description: Indicates whether the repeatable request was accepted or rejected.
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                - name: accepted
                  value: accepted
                  description: If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.
                - name: rejected
                  value: rejected
                  description: 'If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid

                    or because the Repeatability-First-Sent value was outside the range of values held by the server.'
              schema:
                type: string
                enum:
                - accepted
                - rejected
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        Delete batches of numbers.:
          $ref: ./examples/PostAccountNumbersDelete.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchNumbersDelete'
        required: true
components:
  parameters:
    Azure.Core.ClientRequestIdHeader:
      name: x-ms-client-request-id
      in: header
      description: An opaque, globally-unique, client-generated string identifier for the request.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: clientRequestId
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client API version
      x-ms-parameter-location: client
      schema:
        type: string
    Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent:
      name: Repeatability-First-Sent
      in: header
      description: Specifies the date and time at which the request was first created.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: repeatabilityFirstSent
      schema:
        type: string
        format: date-time
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
    Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId:
      name: Repeatability-Request-ID
      in: header
      description: An opaque, globally-unique, client-generated string identifier for the request.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: repeatabilityRequestId
      schema:
        type: string
  schemas:
    Azure.Core.Foundations.Error:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
        target:
          type: string
          description: The target of the error.
        details:
          type: array
          description: An array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          x-ms-identifiers: []
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
    NumberDetails:
      additionalProperties: false
      properties:
        configuration:
          $ref: '#/components/schemas/NumberConfiguration'
        services:
          $ref: '#/components/schemas/NumberServices'
      required:
      - services
      type: object
      description: Details of the number.
    ZoomPhoneCloudPeeringNumberDetails:
      type: object
      description: Details for the Zoom Phone Cloud Peering service on this Number.
      properties:
        enabled:
          type: boolean
          description: Boolean indicating if the service is enabled on this Number.
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - enabled
    TeamsOperatorConnectNumberDetails:
      type: object
      description: Details for the Teams Operator Connect service on this Number.
      properties:
        enabled:
          type: boolean
          description: Boolean indicating if the service is enabled on this Number.
          x-ms-mutability:
          - read
          - update
          - create
        assignmentStatus:
          $ref: '#/components/schemas/TelephoneNumberAssignmentStatus'
          description: The assignment status of this Number.
          x-ms-mutability:
          - read
          - update
          - create
        configuration:
          $ref: '#/components/schemas/TeamsOperatorConnectNumberConfig'
          description: The configuration for Teams Operator Connect on this number.
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - enabled
    NumberConfiguration_2:
      type: object
      description: Configuration for this number.
      properties:
        customSipHeader:
          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 the provisioning platform configuration on Azure Communications Gateway.
          minLength: 1
          maxLength: 100
          pattern: ^([A-Za-z0-9_-])+$
          x-ms-mutability:
          - read
          - update
          - create
    ServiceProvisioningStatus:
      type: string
      description: The provisioning states of an object on any relevant backend service.
      enum:
      - pending
      - synced
      - failed
      x-ms-enum:
        name: ServiceProvisioningStatus
        modelAsString: true
        values:
        - name: pending
          value: pending
          description: The object is pending provisioning.
        - name: synced
          value: synced
          description: The object has been synced with the relevant backend service.
        - name: failed
          value: failed
          description: The object provisioning operation failed with the relevant backend service.
    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'
    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.
    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.
    TelephoneNumberAssignmentStatus:
      type: string
      description: Indicates whether a number is assigned to a user.
      enum:
      - assigned
      - unassigned
      x-ms-enum:
        name: TelephoneNumberAssignmentStatus
        modelAsString: true
        values:
        - name: assigned
          value: assigned
          description: The telephone number is assigned to a user.
        - name: unassigned
          value: unassigned
          description: The telephone number is not assigned to a user.
    TeamsPhoneMobileNumberDetails:
      type: object
      description: Details for the Teams Phone Mobile service on this Number.
      properties:
        enabled:
          type: boolean
          description: Boolean indicating if the service is enabled on this Number.
          x-ms-mutability:
          - read
          - update
          - create
        assignmentStatus:
          $ref: '#/components/schemas/TelephoneNumberAssignmentStatus'
          description: The assignment status of this Number.
          x-ms-mutability:
          - read
          - update
          - create
        configuration:
          $ref: '#/components/schemas/TeamsPhoneMobileNumberConfig'
          description: The configuration for Teams Phone Mobile on this number.
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - enabled
    BatchNumbers_2:
      type: object
      description: List of telephone numbers to be uploaded to an account via a PUT request.
      properties:
        numbers:
          type: array
          description: The list of numbers to upload. At most 100 can be uploaded in one request.
          maxItems: 100
          items:
            $ref: '#/components/schemas/NumberResource'
          x-ms-identifiers: []
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - numbers
    Azure.Core.Foundations.InnerError:
      type: object
      description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    TeamsOperatorConnectNumberConfig:
      type: object
      description: Telephone number configuration for Teams Operator Connect telephone numbers.
      properties:
        usage:
          type: string
          description: The usage for this telephone number.
          x-ms-mutability:
          - read
          - update
          - create
        choosableCapabilities:
          type: array
          description: The choosable capabilities for this telephone number.
          items:
            type: string
          x-ms-mutability:
          - read
          - update
          - create
        acquiredCapabilities:
          type: array
          description: The acquired capabilities for this telephone number.
          items:
            type: string
          readOnly: true
        availableCapabilities:
          type: array
          description: The available capabilities for this telephone number.
          items:
            type: string
          readOnly: true
        additionalUsages:
          type: array
          description: The additional usages for this telephone number.
          items:
            type: string
          x-ms-mutability:
          - read
          - update
          - create
        civicAddressId:
          type: string
          description: The ID of the civic address to be used as the emergency address for this telephone number.
          x-ms-mutability:
          - read
          - update
          - create
        locationId:
          type: string
          description: The ID of the location to be used as the emergency address for this telephone number.
          x-ms-mutability:
          - read
          - update
          - create
        allowTenantAddressUpdate:
          type: boolean
          description: If the enterprise is allowed to update the address for this telephone number.
          default: false
          x-ms-mutability:
          - read
          - update
          - create
        displayedCountryCode:
          type: string
          description: The country code to be displayed with this telephone number
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - usage
      - choosableCapabilities
    BatchNumbersItem:
      additionalProperties: false
      description: Details for a single number.
      properties:
        details:
          $ref: '#/components/schemas/NumberDetails'
        phoneNumber:
          pattern: ^\+[1-9]\d+$
          minLength: 3
          maxLength: 16
          type: string
          description: The E.164 phone number whose record should be created/replaced.
      required:
      - details
      - phoneNumber
      type: object
    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.
    TeamsPhoneMobileNumberConfig:
      type: object
      description: Telephone number configuration for Teams Phone Mobile telephone numbers.
      properties:
        usage:
          type: string
          description: The usage for this telephone number.
          x-ms-mutability:
          - read
          - update
          - create
        choosableCapabilities:
          type: array
          description: The choosable capabilities for this telephone number.
          items:
            type: string
          x-ms-mutability:
          - read
          - update
          - create
        acquiredCapabilities:
          type: array
          description: The acquired capabilities for this telephone number.
          items:
            type: string
          readOnly: true
        availableCapabilities:
          type: array
          description: The available capabilities for this telephone number.
          items:
            type: string
          readOnly: true
        additionalUsages:
          type: array
          description: The additional usages for this telephone number.
          items:
            type: string
          x-ms-mutability:
          - read
          - update
          - create
        civicAddressId:
          type: string
          description: The ID of the civic address to be used as the emergency address for this telephone number.
          x-ms-mutability:
          - read
          - update
          - create
        locationId:
          type: string
          description: The ID of the location to be used as the emergency address for this telephone number.
          x-ms-mutability:
          - read
          - update
          - create
        allowTenantAddressUpdate:
          type: boolean
          description: If the enterprise is allowed to update the address for this telephone number.
          default: false
          x-ms-mutability:
          - read
          - update
          - create
        displayedCountryCode:
          type: string
          description: The country code to be displayed with this telephone number
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - usage
      - choosableCapabilities
    NumberServiceDetails:
      type: object
      description: Configuration of backend services for a telephone number.
      properties:
        teamsOperatorConnect:
          $ref: '#/components/schemas/TeamsOperatorConnectNumberDetails'
          description: Details for the Teams Operator Connect service on this Number.
          x-ms-mutability:
          - read
          - update
          - create
        teamsDirectRouting:
          $ref: '#/components/schemas/TeamsDirectRoutingNumberDetails'
          description: Details for the Teams Direct Routing service on this Number.
          x-ms-mutability:
          - read
          - update
          - create
        teamsPhoneMobile:
          $ref: '#/components/schemas/TeamsPhoneMobileNumberDetails'
          description: Details for the Teams Phone Mobile service on this Number.
          x-ms-mutability:
          - read
          - update
          - create
        zoomPhoneCloudPeering:
          $ref: '#/components/schemas/ZoomPhoneCloudPeeringNumberDetails'
          description: Details for the Zoom Phone Cloud Peering service on this Number.
          x-ms-mutability:
          - read
          - update
          - create
        azureOperatorCallProtection:
          $ref: '#/components/schemas/AzureOperatorCallProtectionNumberDetails'
          description: Details for the Azure Operator Call Protection service on this Number.
          x-ms-mutability:
          - read
          - update
          - create
    BatchNumbersDelete:
      type: object
      description: A list of telephone numbers to delete.
      properties:
        numbers:
          type: array
          description: The list of number to delete. At most 100 can be deleted in one request.
          maxItems: 100
          items:
            $ref: '#/components/schemas/NumberIdentifier'
          x-ms-identifiers: []
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - numbers
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
    TeamsDirectRoutingNumberDetails:
      type: object
      description: Details for the Teams Direct Routing service on this Number.
      properties:
        enabled:
          type: boolean
          description: Boolean indicating if the service is enabled on this Number.
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - enabled
    NumberIdentifier:
      type: object
      description: An identifier, used to identify a Number resource.
      properties:
        telephoneNumber:
          type: string
          description: Telephone number in E.164 format.
          minLength: 3
          maxLength: 16
          pattern: ^\+[1-9]\d+$
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - telephoneNumber
    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
    AzureOperatorCallProtectionNumberDetails:
      type: object
      description: Details for the Azure Operator Call Protection service on this Number.
      properties:
        enabled:
          type: boolean
          description: Boolean indicating if the service is enabled on this Number.
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - enabled
    NumberResource:
      type: object
      description: The configuration for a telephone number provisioned in Azure Communications Gateway.
      properties:
        serviceProvisioningStatus:
          $ref: '#/components/schemas/ServiceProvisioningStatus'
          description: The status of the provisioning action associated with this resource.
          readOnly: true
        serviceProvisioningErrors:
          type: array
          description: Any errors pertaining to the provisioning of this resource.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          readOnly: true
          x-ms-identifiers: []
        telephoneNumber:
          type: string
          description: Telephone number in E.164 format.
          minLength: 1
          maxLength: 16
          pattern: ^\+[1-9]\d+$
          x-ms-mutability:
          - read
          - update
          - create
        accountName:
          type: string
          description: Name of the account. Can only contain letters, numbers, underscores and dashes, and is case-sensitive. Can be up to 100 characters in length.
          minLength: 1
          maxLength: 100
          pattern: ^([A-Za-z0-9_-]+)$
          x-ms-mutability:
          - read
          - update
          - create
        serviceDetails:
          $ref: '#/components/schemas/NumberServiceDetails'
          description: Configuration of the individual backend services for this number.
          x-ms-mutability:
          - read
          - update
          - create
        configuration:
          $ref: '#/components/schemas/NumberConfiguration_2'
          description: Configuration for this number.
          x-ms-mutability:
          - read
          - update
          - create
      required:
      - telephoneNumber
      - accountName
      - serviceDetails
    BatchNumbers:
      additionalProperties: false
      description: Batch of numbers with configuration.
      properties:
        numbers:
          items:
            $ref: '#/components/schemas/BatchNumbersItem'
          maxItems: 100
          type: array
          description: Records to use for create/replace.
      required:
      - numbers
      type: object
    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
    BatchNumbersResponse:
      additionalProperties: false
      properties:
        numbers:
          items:
            $ref: '#/components/schemas/NumberResponse'
          type: array
          description: Details of the created/replaced numbers.
      required:
      - numbers
      type: object
      description: List of created or replaced numbers.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'