Microsoft Azure Communication Services Browse for available countries, cities and area codes API

openapi: 3.2.0
info:
  title: PhoneNumbersClient Browse for available countries, cities…
  description: The phone numbers client uses Azure Communication Services to purchase and manage phone numbers.
  version: '2025-06-01'
tags:
- name: Browse for available countries, cities and area codes
paths:
  /availablePhoneNumbers/countries/{countryCode}/areaCodes:
    get:
      tags:
      - Browse for available countries, cities and area codes
      summary: Gets the list of available area codes
      operationId: PhoneNumbers_ListAreaCodes
      parameters:
      - in: path
        name: countryCode
        description: The ISO 3166-2 country code, e.g. US.
        required: true
        schema:
          type: string
      - in: query
        name: phoneNumberType
        description: Filter by numberType, e.g. Geographic, TollFree, Mobile.
        required: true
        x-ms-enum:
          name: PhoneNumberType
          modelAsString: true
        schema:
          type: string
          enum:
          - geographic
          - tollFree
          - mobile
      - in: query
        name: skip
        description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0.
        schema:
          type: integer
          format: int32
          default: 0
      - in: query
        name: maxPageSize
        description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100.
        schema:
          type: integer
          format: int32
          default: 100
      - in: query
        name: assignmentType
        description: Filter by assignmentType, e.g. Person, Application.
        x-ms-enum:
          name: PhoneNumberAssignmentType
          modelAsString: true
        schema:
          type: string
          enum:
          - person
          - application
      - in: query
        name: locality
        description: The name of locality or town in which to search for the area code. This is required if the number type is Geographic.
        schema:
          type: string
      - in: query
        name: administrativeDivision
        description: The name of the state or province in which to search for the area code.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - in: header
        name: accept-language
        description: The locale to display in the localized fields in the response. e.g. 'en-US'
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberAreaCodes'
        default:
          description: Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: areaCodes
  /availablePhoneNumbers/countries:
    get:
      tags:
      - Browse for available countries, cities and area codes
      summary: Gets the list of supported countries
      operationId: PhoneNumbers_ListAvailableCountries
      parameters:
      - in: query
        name: skip
        description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0.
        schema:
          type: integer
          format: int32
          default: 0
      - in: query
        name: maxPageSize
        description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100.
        schema:
          type: integer
          format: int32
          default: 100
      - $ref: '#/components/parameters/ApiVersionParameter'
      - in: header
        name: accept-language
        description: The locale to display in the localized fields in the response. e.g. 'en-US'
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberCountries'
        default:
          description: Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: countries
  /availablePhoneNumbers/countries/{countryCode}/localities:
    get:
      tags:
      - Browse for available countries, cities and area codes
      summary: Gets the list of cities or towns with available phone numbers
      operationId: PhoneNumbers_ListAvailableLocalities
      parameters:
      - in: path
        name: countryCode
        description: The ISO 3166-2 country code, e.g. US.
        required: true
        schema:
          type: string
      - in: query
        name: skip
        description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0.
        schema:
          type: integer
          format: int32
          default: 0
      - in: query
        name: maxPageSize
        description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100.
        schema:
          type: integer
          format: int32
          default: 100
      - in: query
        name: administrativeDivision
        description: An optional parameter for the name of the state or province in which to search for the area code.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - in: header
        name: accept-language
        description: The locale to display in the localized fields in the response. e.g. 'en-US'
        schema:
          type: string
      - in: query
        name: phoneNumberType
        description: Filter by numberType, e.g. Geographic, TollFree, Mobile.
        x-ms-enum:
          name: PhoneNumberType
          modelAsString: true
        schema:
          type: string
          enum:
          - geographic
          - tollFree
          - mobile
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberLocalities'
        default:
          description: Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: phoneNumberLocalities
  /availablePhoneNumbers/countries/{countryCode}/offerings:
    get:
      tags:
      - Browse for available countries, cities and area codes
      summary: List available offerings of capabilities with rates for the given country
      operationId: PhoneNumbers_ListOfferings
      parameters:
      - in: path
        name: countryCode
        description: The ISO 3166-2 country code, e.g. US.
        required: true
        schema:
          type: string
      - in: query
        name: skip
        description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0.
        schema:
          type: integer
          format: int32
          default: 0
      - in: query
        name: maxPageSize
        description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100.
        schema:
          type: integer
          format: int32
          default: 100
      - in: query
        name: phoneNumberType
        description: Filter by numberType, e.g. Geographic, TollFree, Mobile.
        x-ms-enum:
          name: PhoneNumberType
          modelAsString: true
        schema:
          type: string
          enum:
          - geographic
          - tollFree
          - mobile
      - in: query
        name: assignmentType
        description: Filter by assignmentType, e.g. Person, Application.
        x-ms-enum:
          name: PhoneNumberAssignmentType
          modelAsString: true
        schema:
          type: string
          enum:
          - person
          - application
      - $ref: '#/components/parameters/ApiVersionParameter'
      - in: header
        name: accept-language
        description: The locale to display in the localized fields in the response. e.g. 'en-US'
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfferingsResponse'
        default:
          description: Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: phoneNumberOfferings
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
    PhoneNumberAdministrativeDivision:
      description: Represents an administrative division. e.g. state or province.
      required:
      - abbreviatedName
      - localizedName
      type: object
      properties:
        localizedName:
          description: Represents the localized name of the administrative division of the locality. e.g. state or province localized name.
          type: string
        abbreviatedName:
          description: Represents the abbreviated name of the administrative division of the locality. e.g. state or province abbreviation such as WA (Washington).
          type: string
    PhoneNumberCountry:
      description: Represents a country.
      required:
      - countryCode
      - localizedName
      type: object
      properties:
        localizedName:
          description: Represents the name of the country.
          type: string
        countryCode:
          description: Represents the abbreviated name of the country.
          type: string
    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
    PhoneNumberLocalities:
      description: Represents a wrapper around a list of cities or towns.
      type: object
      properties:
        phoneNumberLocalities:
          description: Represents the underlying list of localities, e.g. cities or town.
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberLocality'
        nextLink:
          description: Represents the URL link to the next page.
          type: string
    OfferingsResponse:
      description: Represents a wrapper around a list of offerings.
      type: object
      properties:
        phoneNumberOfferings:
          description: Represents the underlying list of offerings.
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberOffering'
        nextLink:
          description: Represents the URL link to the next page.
          type: string
    PhoneNumberAreaCodes:
      description: The list of available area codes.
      required:
      - areaCodes
      type: object
      properties:
        areaCodes:
          description: Represents a list of available toll-free area codes.
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberAreaCode'
        nextLink:
          description: Represents the URL link to the next page.
          type: string
    PhoneNumberAreaCode:
      description: Represents an Area Code.
      type: object
      properties:
        areaCode:
          description: An area code.
          type: string
    CommunicationErrorResponse:
      description: The Communication Services error.
      type: object
      required:
      - error
      properties:
        error:
          description: The Communication Services error.
          $ref: '#/components/schemas/CommunicationError'
    PhoneNumberCountries:
      description: Represents a wrapper around a list of countries.
      type: object
      properties:
        countries:
          description: Represents the underlying list of countries.
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberCountry'
        nextLink:
          description: Represents the URL link to the next page
          type: string
    PhoneNumberLocality:
      description: Represents a locality.
      required:
      - localizedName
      type: object
      properties:
        localizedName:
          description: Represents the localized name of the locality.
          type: string
        administrativeDivision:
          $ref: '#/components/schemas/PhoneNumberAdministrativeDivision'
    PhoneNumberOffering:
      description: Represents a phone number capability offering
      required:
      - cost
      type: object
      properties:
        phoneNumberType:
          description: Represents the number type of the offering.
          enum:
          - geographic
          - tollFree
          - mobile
          type: string
          x-ms-enum:
            name: PhoneNumberType
            modelAsString: true
        assignmentType:
          description: Represents the assignment type of the offering.
          enum:
          - person
          - application
          type: string
          x-ms-enum:
            name: PhoneNumberAssignmentType
            modelAsString: true
        availableCapabilities:
          $ref: '#/components/schemas/PhoneNumberCapabilities'
        cost:
          $ref: '#/components/schemas/PhoneNumberCost'
    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'