Sign in
Phone Numbers

Search rentable phone numbers in inventory

Searches the telephony provider's inventory for available numbers matching the requested country (and optional area code). Returns up to 5 candidates per call.

Use the returned phoneNumber value in POST /product/rent-number to actually rent it.

get/product/get-available-numbers

Query parameters

countryCodestring required

ISO 3166-1 alpha-2 country code (e.g. US, IN, GB).

provider'twilio' | 'plivo' | 'custom' | 'whatsapp' required

Telephony provider to search.

areaCodestring

Optional area-code / region filter — provider-dependent (US area codes for plivo/twilio, etc.).

Response

Successful response

statusboolean

Example response

{
  "status": true,
  "data": [
    {
      "phoneNumber": "13183747513",
      "countryCode": "US",
      "provider": "plivo",
      "areaCode": "Louisiana"
    }
  ]
}

Changes

Changed in 2 of the 52 revisions of this API.23

  • 49ce8525306e22See the full diff
    • ●

      added the new custom enum value to the data/items/provider response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new whatsapp enum value to the data/items/provider response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value custom to the query request parameter provider

      request-parameter-enum-value-added

    • ○

      added the new enum value whatsapp to the query request parameter provider

      request-parameter-enum-value-added

  • 4cc40f995db81See the full diff
    • ○

      endpoint added

      endpoint-added