Searches for available phone numbers from the telephony provider. Use the results to find a number to purchase.
Endpoint
GET /user/phone-numbers/search
Query parameters
ISO 3166-1 alpha-2 country code to search in (e.g., US, GB, CA).
Filter numbers that contain specific digits. Numeric characters only, maximum 10 digits.
Response
Array of available phone numbers.Show Available number properties
Phone number in E.164 format.
Formatted display number.
Monthly rental price in USD.
Stripe price ID used for billing.
Address requirements: none, local, foreign, or inventory.
Whether the number supports SMS.
Supported countries
| Country | Code |
|---|
| United States | US |
| Canada | CA |
| United Kingdom | GB |
| Australia | AU |
| Israel | IL |
| Poland | PL |
| Finland | FI |
| Netherlands | NL |
| Denmark | DK |
| Italy | IT |
Example
curl -X GET "https://portal.intellixent.ai/api/user/phone-numbers/search?country_code=US" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": [
{
"phone_number": "+14155551234",
"phone_number_formatted": "+1 415-555-1234",
"country_code": "US",
"price": 3.99,
"stripe_price_id": "price_1PkA4dBXoZOzqQuAsvGvVJTZ",
"address_requirements": "none",
"sms_capable": true
},
{
"phone_number": "+14155555678",
"phone_number_formatted": "+1 415-555-5678",
"country_code": "US",
"price": 3.99,
"stripe_price_id": "price_1PkA4dBXoZOzqQuAsvGvVJTZ",
"address_requirements": "none",
"sms_capable": false
}
]
}
Pass a number from these results to the Purchase phone number endpoint.