Telephony

Search available numbers

Search PyAI's managed number inventory in the US, Canada, or India. country selects the market (US default; India numbers are subject to regulatory review). Filter by area_code (NPA, US and Canada) or a contains digit pattern. Monthly line prices are $1 for US and Canada numbers and $6 for India numbers. The response's provisioning field reports whether automated ordering is available or assisted ordering is required. Requires the telephony:manage scope.

get/v1/telephony/available

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/telephony/available
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

country'US' | 'CA' | 'IN'

ISO-2 country to search in.

area_codestring

3-digit US or Canada area code (NPA).

containsstring

Digit pattern the number should contain.

limitinteger

Response

Available numbers

objectstring

Example response

{
  "object": "list",
  "data": [
    {
      "object": "telephony.available_number",
      "phone_number": "+14155550123",
      "country": "US",
      "area_code": "415",
      "locality": "San Francisco",
      "region": "CA"
    }
  ],
  "provisioning": {
    "capability": "available"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.