Number

List available numbers

Get available phone numbers for the specified country or virtual numbers.

get/available_numbers

Query parameters

page_sizeinteger
Example:25

Number of results to return per page.

country_codestring

The ISO country code. Required when type is not virtual.

type'normal' | 'virtual'

The type of the number.

Example:normal

The type of available numbers to retrieve (normal or virtual). Defaults to normal.

Response

A list of available phone numbers.

Example response

{
  "result": [
    {
      "number": "+14155551234",
      "country": "US",
      "region": "California",
      "postal_code": "94105",
      "features": [
        "voice"
      ]
    }
  ]
}

Changes

Changed in 2 of the 54 revisions of this API.21010

  • 788bc9d03134110See the full diff
    • the allOf[subschema #1]/result/items/ response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • added the optional property allOf[subschema #1]/result/items/country to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #1]/result/items/features to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #1]/result/items/number to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #1]/result/items/postal_code to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #1]/result/items/region to the response with the 200 status

      response-optional-property-added

    • removed the emergency enum value from the allOf[subschema #1]/result/items/ response property for the response status 200

      response-property-enum-value-removed

    • removed the fax enum value from the allOf[subschema #1]/result/items/ response property for the response status 200

      response-property-enum-value-removed

    • removed the mms enum value from the allOf[subschema #1]/result/items/ response property for the response status 200

      response-property-enum-value-removed

    • removed the sms enum value from the allOf[subschema #1]/result/items/ response property for the response status 200

      response-property-enum-value-removed

    • removed the voice enum value from the allOf[subschema #1]/result/items/ response property for the response status 200

      response-property-enum-value-removed

  • 995c56ba9219110See the full diff
    • the allOf[subschema #1]/result/items/ response's property type/format changed from object/ to string/ for status 200

      response-property-type-changed

    • removed the optional property allOf[subschema #1]/result/items/country from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #1]/result/items/features from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #1]/result/items/number from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #1]/result/items/postal_code from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #1]/result/items/region from the response with the 200 status

      response-optional-property-removed

    • added the new emergency enum value to the allOf[subschema #1]/result/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new fax enum value to the allOf[subschema #1]/result/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new mms enum value to the allOf[subschema #1]/result/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new sms enum value to the allOf[subschema #1]/result/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new voice enum value to the allOf[subschema #1]/result/items/ response property for the response status 200

      response-property-enum-value-added

    This revision also has 20 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog