Get Available Numbers

Get specific available phone numbers within a number group. Use this after finding a group via the Search Number Groups endpoint.

Endpoint

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

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
group_id	string	Yes	The group ID from the Search Number Groups endpoint
number_contains	string	No	Filter numbers containing this digit sequence

Invocation

cURL

curl --location --request GET 'https://api.p.2chat.io/open/numbers/available?group_id=abc-123' \
--header 'X-User-API-Key: your_api_key_here'

Python

import requests

url = "https://api.p.2chat.io/open/numbers/available"
headers = {
    "X-User-API-Key": "your_api_key_here"
}
params = {
    "group_id": "abc-123"
}

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/available', {
    params: { group_id: 'abc-123' },
    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/available?group_id=abc-123',
  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": {
        "numbers": [
            {
                "id": "did-xyz",
                "number": "+12135551234"
            }
        ]
    }
}

Field	Description
numbers[].id	The DID identifier for this number
numbers[].number	The phone number in E.164 format

Error

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