Number

List available numbers

Changed on

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

get/available_numbers

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/available_numbers
  • Auth
    none declared

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

    • breaking

      the // response's property type changed from string to object for status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      removed the emergency enum value from the // response property for the response status

    • info

      removed the fax enum value from the // response property for the response status

    • info

      removed the mms enum value from the // response property for the response status

    • info

      removed the sms enum value from the // response property for the response status

    • info

      removed the voice enum value from the // response property for the response status

    • breaking

      the // response's property type changed from object to string for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      added the new emergency enum value to the // response property for the response status

    • warning

      added the new fax enum value to the // response property for the response status

    • warning

      added the new mms enum value to the // response property for the response status

    • warning

      added the new sms enum value to the // response property for the response status

    • warning

      added the new voice enum value to the // response property for the response status