Skip to main content
GET
/
v1
/
telephony
/
available
Search available numbers
curl --request GET \
  --url https://api.pyai.com/v1/telephony/available \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "object": "telephony.available_number",
      "phone_number": "+14155550123",
      "country": "US",
      "area_code": "415",
      "locality": "San Francisco",
      "region": "CA",
      "capabilities": {
        "voice": true,
        "sms": true
      },
      "monthly_cost_cents": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Query Parameters

​
area_code
string

3-digit US area code (NPA).

Pattern: ^[2-9][0-9]{2}$
​
contains
string

Digit pattern the number should contain.

​
limit
integer
default:20
Required range: 1 <= x <= 50

Response

Available numbers

​
object
string
Example:

"list"

​
data
object[]