List Phone Numbers

List phone numbers

curl --request GET \
  --url https://www.tryunleashx.com/api/v1/global/list-phone-numbers \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://www.tryunleashx.com/api/v1/global/list-phone-numbers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.tryunleashx.com/api/v1/global/list-phone-numbers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "token: <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.tryunleashx.com/api/v1/global/list-phone-numbers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("token", "<token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/list-phone-numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["token"] = '<token>'

response = http.request(request)
puts response.read_body

GET

list-phone-numbers

List phone numbers

curl --request GET \
  --url https://www.tryunleashx.com/api/v1/global/list-phone-numbers \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://www.tryunleashx.com/api/v1/global/list-phone-numbers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.tryunleashx.com/api/v1/global/list-phone-numbers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "token: <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.tryunleashx.com/api/v1/global/list-phone-numbers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("token", "<token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/list-phone-numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["token"] = '<token>'

response = http.request(request)
puts response.read_body

Retrieve a list of all available phone numbers from various telephony providers. This endpoint returns phone numbers grouped by provider, allowing you to manage and assign numbers to your voice agents.

API Endpoint

GET /api/v1/global/list-phone-numbers Content-Type: application/json Authentication: Required (Token header: token or api_access_token)

Query Parameters

Parameter	Type	Required	Description
`provider`	string	No	Filter by specific provider. Supported values: `san`, `ozonetell`, `twilio`, `exotel`

Response

Success Response

Status Code: 200 OK

{
  "error": false,
  "code": 200,
  "message": "",
  "timestamp": 1769244619292,
  "data": {
    "providers": {
      "San Software": [
        {
          "number": "+9180********",
          "label_name": null,
          "number_purpose": null
        },
        {
          "number": "+9180********",
          "label_name": null,
          "number_purpose": null
        },
        {
          "number": "+9180********",
          "label_name": "Sales Team",
          "number_purpose": "TEST"
        }
      ],
      "Ozonetell": [
        {
          "number": "+9180********",
          "label_name": null,
          "number_purpose": null
        }
      ],
      "Twilio": [
        {
          "number": "+120********",
          "label_name": "Customer Support",
          "number_purpose": "PRODUCTION"
        }
      ],
      "Exotel": [
        {
          "number": "+9198********",
          "label_name": "Marketing",
          "number_purpose": "OUTBOUND"
        }
      ]
    }
  }
}

Response Fields

Field	Type	Description
`error`	boolean	Indicates if there was an error
`code`	integer	HTTP status code
`message`	string	Success or error message
`timestamp`	integer	Unix timestamp in milliseconds
`data`	object	Response data object
`data.providers`	object	Phone numbers grouped by provider name

Phone Number Object Fields

Field	Type	Description
`number`	string	Phone number in E.164 format (e.g., +918062810341)
`label_name`	string	Custom label assigned to the number (nullable)

Common Number Purpose Values

Purpose	Description
`TEST`	Number used for testing purposes
`PRODUCTION`	Number used in production environment

Error Responses

401 - Authentication Error

Status Code: 401 Unauthorized

{
  "error": true,
  "code": 401,
  "message": "Invalid Auth Key or Session Expired",
  "data": {}
}

404 - No Numbers Found

Status Code: 404 Not Found

{
  "error": true,
  "code": 404,
  "message": "No phone numbers found",
  "data": {}
}

500 - Server Error

Status Code: 500 Internal Server Error

{
  "error": true,
  "code": 500,
  "message": "Internal server error",
  "data": {}
}

Supported Providers

Provider	Key	Description
San Software	`san`	San Software telephony platform
Ozonetel	`ozonetel`	Ozonetel cloud communication platform
Twilio	`twilio`	Global cloud communications platform
Exotel	`exotel`	Leading cloud telephony provider in India

Important Notes

Phone Number Format: Phone numbers are returned in E.164 format (e.g., +918062810341)
Provider Grouping: Numbers are grouped by provider for easy organization
Label Management: label_name can be used to identify numbers by custom names
Available Numbers: Numbers without a number_purpose are typically available for new assignments
Provider Setup: Some providers may require additional setup before numbers can be used
Permissions: Ensure you have proper permissions and provider configurations before using numbers
Rate Limits: API calls are subject to rate limiting based on your plan

Attach Phone Number - Assign phone numbers to voice agents
Create Voice Agent - Create a new voice agent
Update Voice Agent - Update agent configuration

Headers

token

string

required

API token for authentication

Query Parameters

provider

enum<string>

Filter by specific provider. Supported values: san, ozonetell, twilio, exotel

Available options:

Exotel,

Twilio,

San Software,

Novus,

Deepijatel,

San Bajaj GSM,

Ozonetel

Response

200

API Documentation

Phone Numbers

Voice AI

Click to Call

Call Logs

Campaigns

Users

List Phone Numbers

API Endpoint

Query Parameters

Response

Success Response

Response Fields

Phone Number Object Fields

Common Number Purpose Values

Error Responses

401 - Authentication Error

404 - No Numbers Found

500 - Server Error

Supported Providers

Important Notes

Headers

Query Parameters

Response

​API Endpoint

​Query Parameters

​Response

​Success Response

​Response Fields

​Phone Number Object Fields

​Common Number Purpose Values

​Error Responses

​401 - Authentication Error

​404 - No Numbers Found

​500 - Server Error

​Supported Providers

​Important Notes

​Related Endpoints

Headers

Query Parameters

Response

API Endpoint

Query Parameters

Response

Success Response

Response Fields

Phone Number Object Fields

Common Number Purpose Values

Error Responses

401 - Authentication Error

404 - No Numbers Found

500 - Server Error

Supported Providers

Important Notes

Related Endpoints