List Virtual Numbers

This endpoint will help you list the virtual numbers you have in your 2Chat account.

Query parameters

Parameter	Description	Example
page_number	Page number to return	2
results_per_page	Number of results to return per page. Default is 200	20

cURL

curl -L -G 'https://api.p.2chat.io/open/voip/virtual-numbers?page_number=0' \
    --header 'X-User-API-Key: your_api_key_here' 

Python

import requests

url = "https://api.p.2chat.io/open/voip/virtual-numbers?page_number=0"

payload = ""
headers = {
  'X-User-API-Key': 'your_api_key_here'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

JavaScript

var axios = require('axios');
var data = '';

var config = {
  method: 'get',
  url: 'https://api.p.2chat.io/open/voip/virtual-numbers?page_number=0',
  headers: { 
    'X-User-API-Key': 'your_api_key_here'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Response

The API will return an array of numbers based on the numbers you have connected to 2Chat. In the example below, only 1 number is returned.

{
    "success": true,
    "count": 1,
    "page": 0,
    "numbers": [
        {
            "uuid": "DID64a54de2-8ebe-4c01-838f-a2235815dab4",
            "account_uuid": "ACC91be87af-5a29-4034-b599-342f2aeb5d52",
            "phone_number": "+18132522492",
            "formatted_phone_number": "+1 813-252-2492",
            "iso_country_code": "US",
            "region_name": "Tampa",
            "emoji": null,
            "friendly_name": "+18132522492",
            "record_inbound": true,
            "is_toll_free": false,
            "provider_type": "local",
            "priced_per_minute": false,
            "incoming_price_per_minute": 0.0,
            "ivr_uuid": null,
            "timezone": "America/New_York",
            "status": 1,
            "status_text": "ACTIVE",
            "created_at": "2025-08-13T19:46:21Z",
            "updated_at": "2025-08-29T21:26:04Z",
            "expires_at": "2025-09-14T13:49:56Z"
        }
    ]
}

Field	Description	Example values
uuid	The unique identifier of the number	DID64a54de2-8ebe-4c01-838f-a2235815dab4
phone_number	the phone number in international format	+18132522492
formatted_phone_number	the phone number in international format, formatted for easier reading	+1 813-252-2492
friendly_name	the friendly name you chose for your number	my number
iso_country_code	the two-letter country code of the number	US
record_inbound	true when call recording is enabled	true
is_toll_free	true when the number is toll-free	true
provider_type	Type of number: mobile, local, shared-cost, national	local
priced_per_minute	true when the number has a charge for incoming calls	false
incoming_price_per_minute	Price (USD) to pay per minute of incoming calls	0.01
ivr_uuid	UUID of the associated IVR	IVR91be87af-5a29-4034-b599-342f2aeb5d52
status	Status of the number. See status_text for a description	1
status_text	Text status of the number. E.g.: ACTIVE, AWAITING_REGISTRATION, PENDING_ACTIVATION, PENDING_CANCELLATION, RELEASED.	ACTIVE