Microsoft Azure

Microsoft Azure Numbers API

The Numbers API from Microsoft Azure — 1 operation(s) for numbers.

Documentation GitHub OpenAPI

Operations 1

GET /numbers Microsoft Azure Get Numbers #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-numbers-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Microsoft Azure Numbers API
  x-refined-note:
  - x-typespec-generated differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Numbers across 2 of this provider''s published API definitions: microsoftvoiceservicesacgprovisioningplatformapi-openapi-original.yml, microsoftvoiceservicesprovisioning-openapi-original.yml. Each path carries the servers of the definition it was published in.'
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
      security:
      - OAuth2:
        - https://func-voiceservice-rp-prod-eastuseuap.azurewebsites.net/.default
components:
  schemas:
    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.
    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.
    NumberDetails:
      additionalProperties: false
      properties:
        configuration:
          $ref: '#/components/schemas/NumberConfiguration'
        services:
          $ref: '#/components/schemas/NumberServices'
      required:
      - services
      type: object
      description: Details of the number.
    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'
    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
    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
    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.
    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
    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
    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
    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.
    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
    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
    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
    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
    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
    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
    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.
    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
    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
    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
    PagedNumberList:
      type: object
      description: Paged collection of NumberResource items
      properties:
        value:
          type: array
          description: The NumberResource items on this page
          items:
            $ref: '#/components/schemas/NumberResource'
          x-ms-identifiers: []
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    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.
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client API version
      x-ms-parameter-location: client
      schema:
        type: string
    Azure.Core.MaxPageSizeQueryParameter:
      name: maxpagesize
      in: query
      description: The maximum number of result items per page.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
    RecordCountQueryParameter:
      name: countRecords
      in: query
      description: Whether to return a count of the total number of records available for this request.
      required: false
      x-ms-parameter-location: method
      schema:
        type: boolean
    FilterQueryParameter:
      name: filter
      in: query
      description: Filter the result list using the given expression
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    Azure.Core.TopQueryParameter:
      name: top
      in: query
      description: The number of result items to return.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
    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.SkipQueryParameter:
      name: skip
      in: query
      description: The number of result items to skip.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        default: 0
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            https://func-voiceservice-rp-prod-eastuseuap.azurewebsites.net/.default: Grants the associated roles assigned to the client application
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
      description: Azure Active Directory OAuth2 Flow.
    OAuth2Auth:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            https://func-voiceservice-rp-prod-eastuseuap.azurewebsites.net/.default: ''
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
x-refined-from:
- microsoftvoiceservicesacgprovisioningplatformapi-openapi-original.yml
- microsoftvoiceservicesprovisioning-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'