Phone & voice · Phone Numbers

List offerable number countries

Returns offerable number countries.

GEThttps://api.pozy.ai/v1/phone-numbers/countries

Public, no API keylistPhoneNumberCountries

Request

This endpoint is public. Call it without an API key.

Example

curl -X GET "https://api.pozy.ai/v1/phone-numbers/countries"

const res = await fetch("https://api.pozy.ai/v1/phone-numbers/countries");
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/phone-numbers/countries",
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

countriesarray of object
11 child fields
- codestring
- tierinteger
  One of 1, 2, 3, 4.
- monthlyCentsinteger
- needsKycboolean
- callsAvailableboolean
- whatsappAvailableboolean
- smsAvailableboolean
- outboundCallingAvailableboolean
- inStockboolean
- preOrderableboolean
- typesarray of object
  10 child fields
  numberTypestring
  One of local, mobile, national, toll_free.
  tierinteger
  One of 1, 2, 3, 4. Can be null.
  needsKycboolean
  monthlyCentsinteger
  whatsappAvailableboolean
  smsAvailableboolean
  callsAvailableboolean
  inStockboolean
  fulfilmentstring
  One of instant, request.
  preOrderableboolean

200 response

{
  "countries": [
    {
      "code": "string",
      "tier": 1,
      "monthlyCents": 1,
      "needsKyc": true,
      "callsAvailable": true,
      "whatsappAvailable": true,
      "smsAvailable": true,
      "outboundCallingAvailable": true,
      "inStock": true,
      "preOrderable": true,
      "types": [
        {
          "numberType": "local",
          "tier": 1,
          "needsKyc": true,
          "monthlyCents": 1,
          "whatsappAvailable": true,
          "smsAvailable": true,
          "callsAvailable": true,
          "inStock": true,
          "fulfilment": "instant",
          "preOrderable": true
        }
      ]
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

Request

Example

Response

Errors

More in Phone Numbers