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'plivo' | 'twilio' required
Telephony provider to search.
areaCodestring
Optional area-code / region filter — provider-dependent (US area codes for plivo/twilio, etc.).
Response
Successful response
Example response
{
"status": true,
"data": [
{
"phoneNumber": "13183747513",
"countryCode": "US",
"provider": "plivo",
"areaCode": "Louisiana"
}
]
}