Microsoft Azure Communication Services Find and purchase available phone numbers API

openapi: 3.2.0
info:
  title: PhoneNumbersClient Find and purchase available phone…
  description: The phone numbers client uses Azure Communication Services to purchase and manage phone numbers.
  version: '2025-06-01'
tags:
- name: Find and purchase available phone numbers
paths:
  /availablePhoneNumbers/countries/{countryCode}/:search:
    post:
      tags:
      - Find and purchase available phone numbers
      summary: Search for available phone numbers to purchase
      operationId: PhoneNumbers_SearchAvailablePhoneNumbers
      parameters:
      - in: path
        name: countryCode
        description: The ISO 3166-2 country code, e.g. US.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          description: The service has accepted the request and will start processing later. It will return 'Accepted' immediately and include an 'Operation-Location' and 'Location' headers. Client side should further query the operation status using the URL specified in 'Operation-Location' header. When operation completes successfully query final result using URL specified in 'Location' header.
          headers:
            Location:
              description: URL to retrieve the final result after operation completes.
              schema:
                type: string
            Operation-Location:
              description: URL to query for status of the operation.
              schema:
                type: string
            operation-id:
              description: The operation id.
              schema:
                type: string
            search-id:
              description: The search operation id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberSearchResult'
        default:
          description: Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneNumberSearchRequest'
        description: The phone number search request.
        required: true
  /availablePhoneNumbers/searchResults/{searchId}:
    get:
      tags:
      - Find and purchase available phone numbers
      summary: Gets a phone number search result by search id
      operationId: PhoneNumbers_GetSearchResult
      parameters:
      - in: path
        name: searchId
        description: The search Id.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberSearchResult'
        default:
          description: Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
  /availablePhoneNumbers/:purchase:
    post:
      tags:
      - Find and purchase available phone numbers
      summary: Purchases phone numbers
      operationId: PhoneNumbers_PurchasePhoneNumbers
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          description: The service has accepted the request and will start processing later. It will return 'Accepted' immediately and include an 'Operation-Location' header. Client side should further query the operation status using the URL specified in 'Operation-Location' header.
          headers:
            Operation-Location:
              description: URL to query for status of the operation.
              schema:
                type: string
            operation-id:
              description: The operation id.
              schema:
                type: string
            purchase-id:
              description: The purchase operation id.
              schema:
                type: string
        default:
          description: Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneNumberPurchaseRequest'
        description: The phone number purchase request
        required: true
components:
  schemas:
    PhoneNumberCapabilities:
      description: Capabilities of a phone number.
      required:
      - calling
      - sms
      type: object
      properties:
        calling:
          description: Capability value for calling.
          enum:
          - none
          - inbound
          - outbound
          - inbound+outbound
          type: string
          x-ms-enum:
            name: PhoneNumberCapabilityType
            modelAsString: true
        sms:
          description: Capability value for SMS.
          enum:
          - none
          - inbound
          - outbound
          - inbound+outbound
          type: string
          x-ms-enum:
            name: PhoneNumberCapabilityType
            modelAsString: true
    PhoneNumberSearchRequest:
      description: Represents a phone number search request to find phone numbers. Found phone numbers are temporarily held for a following purchase.
      required:
      - assignmentType
      - capabilities
      - phoneNumberType
      type: object
      properties:
        phoneNumberType:
          description: The type of phone numbers to search for, e.g. geographic, tollFree, mobile.
          enum:
          - geographic
          - tollFree
          - mobile
          type: string
          x-ms-enum:
            name: PhoneNumberType
            modelAsString: true
        assignmentType:
          description: The assignment type of the phone numbers to search for. A phone number can be assigned to a person, or to an application.
          enum:
          - person
          - application
          type: string
          x-ms-enum:
            name: PhoneNumberAssignmentType
            modelAsString: true
        capabilities:
          $ref: '#/components/schemas/PhoneNumberCapabilities'
        areaCode:
          description: The area code of the desired phone number, e.g. 425.
          type: string
        quantity:
          format: int32
          description: The quantity of desired phone numbers. The default value is 1.
          default: 1
          maximum: 2147483647
          minimum: 1
          type: integer
    PhoneNumberPurchaseRequest:
      description: The phone number search purchase request.
      type: object
      properties:
        searchId:
          description: The search id.
          type: string
        agreeToNotResell:
          description: The agreement to not resell the phone numbers. Defaults to false if not provided.
          type: boolean
    PhoneNumberCost:
      description: The incurred cost for a single phone number.
      required:
      - amount
      - billingFrequency
      - currencyCode
      type: object
      properties:
        amount:
          format: double
          description: The cost amount.
          type: number
        currencyCode:
          description: The ISO 4217 currency code for the cost amount, e.g. USD.
          type: string
        billingFrequency:
          description: The frequency with which the cost gets billed.
          enum:
          - monthly
          type: string
          x-ms-enum:
            name: BillingFrequency
            modelAsString: true
    PhoneNumberSearchResult:
      description: The result of a phone number search operation.
      required:
      - assignmentType
      - capabilities
      - cost
      - phoneNumbers
      - phoneNumberType
      - searchExpiresBy
      - searchId
      type: object
      properties:
        searchId:
          description: The search id.
          type: string
        phoneNumbers:
          description: The phone numbers that are available. Can be fewer than the desired search quantity.
          type: array
          items:
            type: string
        phoneNumberType:
          description: The phone number's type, e.g. geographic, tollFree, mobile.
          enum:
          - geographic
          - tollFree
          - mobile
          type: string
          x-ms-enum:
            name: PhoneNumberType
            modelAsString: true
        assignmentType:
          description: Phone number's assignment type.
          enum:
          - person
          - application
          type: string
          x-ms-enum:
            name: PhoneNumberAssignmentType
            modelAsString: true
        capabilities:
          $ref: '#/components/schemas/PhoneNumberCapabilities'
        cost:
          $ref: '#/components/schemas/PhoneNumberCost'
        searchExpiresBy:
          format: date-time
          description: The date that this search result expires and phone numbers are no longer on hold. A search result expires in less than 15min, e.g. 2020-11-19T16:31:49.048Z.
          type: string
        isAgreementToNotResellRequired:
          description: Indicates if do not resell agreement is required. If true, the phone numbers cannot be acquired unless the customer provides explicit agreement to not resell them.
          type: boolean
        errorCode:
          format: int32
          description: The error code of the search.
          type: integer
        error:
          description: Mapping Error Messages to Codes
          enum:
          - NoError
          - UnknownErrorCode
          - OutOfStock
          - AuthorizationDenied
          - MissingAddress
          - InvalidAddress
          - InvalidOfferModel
          - NotEnoughLicenses
          - NoWallet
          - NotEnoughCredit
          - NumbersPartiallyAcquired
          - AllNumbersNotAcquired
          - ReservationExpired
          - PurchaseFailed
          - BillingUnavailable
          - ProvisioningFailed
          - UnknownSearchError
          type: string
          x-ms-enum:
            name: Error
            modelAsString: true
    CommunicationErrorResponse:
      description: The Communication Services error.
      type: object
      required:
      - error
      properties:
        error:
          description: The Communication Services error.
          $ref: '#/components/schemas/CommunicationError'
    CommunicationError:
      description: The Communication Services error.
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: The error code.
        message:
          type: string
          description: The error message.
        target:
          type: string
          readOnly: true
          description: The error target.
        details:
          type: array
          items:
            $ref: '#/components/schemas/CommunicationError'
          readOnly: true
          description: Further details about specific errors that led to this error.
        innererror:
          x-ms-client-name: innerError
          readOnly: true
          $ref: '#/components/schemas/CommunicationError'
          description: The inner error if any.
  parameters:
    ApiVersionParameter:
      in: query
      name: api-version
      description: Version of API to invoke
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'