GET
/
v1
/
phone-numbers
/
available
Get Available Phone Numbers
curl --request GET \
  --url https://api.eqho.ai/v1/phone-numbers/available \
  --header 'X-API-KEY: <api-key>'
{
  "phone_numbers": [
    {
      "type": "local",
      "phone_number": "<string>",
      "lata": "<string>",
      "locality": "<string>",
      "region": "<string>",
      "postal_code": "<string>",
      "country_code": "<string>",
      "address_requirements": "<string>",
      "capabilities": {
        "mms": false,
        "sms": false,
        "voice": false
      }
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
contains
string | null
default:""

Optional string that if present must be at least 2 characters and only contain *, 0-9, a-z, and A-Z

​
show_toll_free
boolean
default:false
​
area_code
string
default:""
​
exclude_all_address_required
boolean
default:true
​
in_postal_code
string
default:""
​
in_region
string
default:""

Response

200
application/json

Successful Response

The response is of type object.