Get Regions

Get the available regions for a given country. Use this as the first step when browsing phone numbers to purchase.

Endpoint

GET https://api.p.2chat.io/open/numbers/regions

Authentication

Include your API key in the X-User-API-Key header. Learn more about authentication.

Parameters

These are query-string parameters.

Field	Type	Required	Description
country	string	Yes	ISO country code (e.g. US, BR, DE)

Invocation

cURL

curl --location --request GET 'https://api.p.2chat.io/open/numbers/regions?country=US' \
--header 'X-User-API-Key: your_api_key_here'

Python

import requests

url = "https://api.p.2chat.io/open/numbers/regions"
headers = {
    "X-User-API-Key": "your_api_key_here"
}
params = {
    "country": "US"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

JavaScript

const axios = require('axios');

const response = await axios.get('https://api.p.2chat.io/open/numbers/regions', {
    params: { country: 'US' },
    headers: {
        'X-User-API-Key': 'your_api_key_here'
    }
});

console.log(response.data);

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.p.2chat.io/open/numbers/regions?country=US',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'X-User-API-Key: your_api_key_here'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response

Success

{
    "success": true,
    "data": {
        "regions": [
            {
                "id": 123,
                "region_name": "California",
                "iso_country_code": "US"
            }
        ]
    }
}

Field	Description
regions[].id	Region ID to use with other endpoints (e.g. filtering cities)
regions[].region_name	Human-readable name of the region
regions[].iso_country_code	ISO country code the region belongs to

Error

{
    "success": false,
    "error": true,
    "error_message": "Description of what went wrong"
}