TCXC API Documentation

Everything the TelecomsXChange platform exposes over HTTPS: market rates, interconnects, CDRs, DIDs, eSIMs, HLR, balances and messaging. One base URL, one set of credentials, JSON in and out.

Base URL
https://apiv2.telecomsxchange.com
Endpoints
54
Auth
HTTP Digest
Format
JSON (CSV for rate decks)

Introduction

Telecomsxchange's platfom application programming interfaces (APIs) empower you to automate significant operations in the telecom industry's wholesale buying and selling landscape. These operations range from establishing interconnections and overseeing carrier relationships to exploring market opportunities and handling support tickets. They also include managing communications, controlling traffic routing, offering ratings and reviews, and orchestrating financial settlements for voice, SMS, and virtual numbers.

To access and utilize this API, it is essential to have a valid TelecomsXChange buyer or seller account. If you don't have an account yet, you can easily sign up by clicking on the following link: Signup Here.

1

Create a buyer or seller account and generate an API key under Preferences in the members portal.

2

Authenticate every request with HTTP Digest, using your TCXC username and the API key as the password.

3

Call any endpoint below. Start with Get Accounts Balance to confirm your credentials work.

curl --digest \
  -u "$TCXC_USERNAME:$TCXC_API_KEY" \
  -X POST \
  "https://apiv2.telecomsxchange.com/buyers/balance"

Authentication

Every request must be authenticated. Two methods are supported. Digest is the one to use unless you have a reason not to.

HTTP Digest (recommended)

Standard Digest access authentication. Your credentials never travel in clear text, and every HTTP client library supports it. The samples on every endpoint page use this method.

UsernameYour TCXC username
PasswordYour API key

Generate or rotate your API key in the members portal under Preferences. Buyer and seller accounts each have their own key.

Signature-based (legacy v1)

The original v1 endpoints under api.telecomsxchange.com authenticate with a per-request signature instead of a Digest challenge. Send three extra form fields with each call:

  • api_login: your TCXC username.
  • ts: the current Unix timestamp.
  • signature: sha256(controller + api_key + api_login + ts), where controller is the script name of the endpoint, for example lookup for lookup.php.

Signatures expire quickly, so compute them at request time. Tools like Postman cannot generate them without scripting, which is why the reference below documents the Digest-based v2 API.

curl --digest -u "YOUR_TCXC_USERNAME:YOUR_TCXC_API_KEY" \
  -X POST "https://apiv2.telecomsxchange.com/buyers/balance"
<?php
// Legacy v1 endpoints: https://api.telecomsxchange.com/<controller>.php
$api_login = "YOUR_TCXC_USERNAME";
$api_key   = "YOUR_TCXC_API_KEY";
$controller = "lookup";          // script name without .php
$ts = time();                    // unix timestamp, keeps the signature short-lived

$signature = hash("sha256", $controller . $api_key . $api_login . $ts);

$params = [
    "api_login" => $api_login,
    "ts"        => $ts,
    "signature" => $signature,
    "webapi"    => "1",          // required
    "prefix"    => "962",
    "type"      => "CLI",
];

$ch = curl_init("https://api.telecomsxchange.com/$controller.php");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => http_build_query($params),
    CURLOPT_RETURNTRANSFER => true,
]);
echo curl_exec($ch);
Adapted from the official TelecomsXChange MarketView sample on GitHub.

Rate limits

TCXC API rate limits your requests to a specified hourly value based on your account. Contact us if you desire a higher rate limit. Users are also limited to a number of requests per second. If you exceed either limit you will receive an HTTP 429 error.

Back off and retry with a delay when you see a 429. If your integration needs more headroom, contact us and we will raise the limit on your account.

429
HTTP/1.1 429 Too Many Requests
Content-Type: application/json

{ "status": "error", "message": "Rate limit exceeded" }

Browse the API

Voice Exchange

9 endpoints

The voice exchange section of this API represents all the exposed APIs related to voice buying and selling. Developers use this section to integrate rates, cdrs, route testing with third

  • POSTSearch Market View (Voice)
  • POSTCarrier Rate Download (CSV)
  • GETTop Voice Destinations
  • POSTList Buyer Accounts
  • +5 more

SMS Exchange

3 endpoints

The SMS exchange section of this API represents all the exposed APIs related to SMS buying and selling. Developers use this section to integrate rates, SDRs with third party applications.

  • POSTList SDRs
  • POSTSearch Market View (SMS)
  • GETTop SMS Destinations

DID Exchange

7 endpoints

TCXC DID Exchange, enables modern communication providers (buyers/sellers) to programmatically buy and/or sell virtual phone numbers on the exchange after pointng them via SIP/SMPP protocols. The DID

  • POSTAdd / Sell New DID Number
  • POSTList DIDs
  • POSTUpdate DID Record
  • POSTSearch DID Market View
  • +3 more

eSIM Exchange

7 endpoints

Welcome to the TCXC eSIM Exchange , your gateway to global mobile data connectivity. These APIs let you integrate eSIM provisioning directly into your platform, enabling your customers to stay connect

  • GETList Countries
  • POSTMarket View (eSIM)
  • POSTPurchase eSIM
  • POSTTop-up Packages
  • +3 more

Interconnect

3 endpoints

Imagine that you're able to interconnect with Tier 1 carriers like Airtel, TATA, Others.. using programmatically using API! This is exactly what this API endpoiunt allows you to acheive, afte

  • POSTInitiate Interconnect
  • POSTList Interconnects
  • POSTBlock Interconnection

Money

4 endpoints

All APIs related to prepaid balances for buyers and sellers.

  • POSTGet Accounts Balance
  • POSTPayment History
  • POSTGet Seller Balance
  • POSTPayout History

Tools

4 endpoints

This folder contains utility endpoints and helper workflows for working with the TelecomsXChange (TCXC) platform. Use these requests to validate credentials, inspect account configuration, and trouble

  • POSTList Sellers IDs
  • GETGet Test Numbers
  • GETGet Phone Number Score
  • POSTInitiate Route Test

Members Messaging

10 endpoints

Keep it professional! APis related to platform internal messaging, TCXC buyer and seller can communicate through this system to discuss deals, or raise trouble tickets. Examples Buyer may send a messa

  • POSTList Incoming messages
  • POSTList Outgoing messages
  • POSTReply to Seller Message
  • POSTCompose New Message To Seller
  • +6 more

Rates

2 endpoints

The API endpoints below are recommended for those who want to sync large amount of data with their backend systems frequently. it enables you to download the current sell rates for a specific seller,

  • POSTCarrier Rate Download (CSV)
  • POSTList Sellers Route Information

HLR Lookups

2 endpoints

You can perform Global HLR lookups using Web UI or API. Get to know the portable status of the number,mobile network operator, active status, roaming and other details. With HLR Lookup you can clean y

  • POSTLookup Number
  • POSTLookup Number

IoT

1 endpoint

All Internet of Things (IoT) apis go here.

  • POSTBuyer IoT History

Reports

2 endpoints

  • POSTVoice Summary Report
  • POSTSMS Summary Report

Tooling

Prefer a client? Import every endpoint into Postman, Insomnia or Bruno, generate an SDK from the OpenAPI spec, feed the Markdown version to your AI assistant, or operate your account through the TCXC MCP server.

Frequently asked questions

What is the base URL for the TelecomsXChange API?

All v2 endpoints live under https://apiv2.telecomsxchange.com over HTTPS. Each endpoint page shows the full path, for example https://apiv2.telecomsxchange.com/marketview/search for voice and SMS market rates.

How do I authenticate API requests?

Use HTTP Digest authentication with your TCXC username as the username and your API key as the password. The API key is generated in the members portal under Preferences. Legacy v1 endpoints on api.telecomsxchange.com accept a SHA-256 signature instead.

Do I need a TCXC account to use the API?

Yes. The API is available to registered TelecomsXChange buyer and seller accounts. Buyer endpoints cover purchasing, testing and reporting on routes, DIDs, eSIMs and HLR lookups; seller endpoints cover listing DIDs, balances, payouts and buyer messaging.

What request and response formats does the API use?

Requests send parameters as application/x-www-form-urlencoded form fields, or as query parameters on GET calls. Responses are JSON objects with a status field of success or error, except rate deck downloads, which return CSV.

Are there rate limits?

Yes. Each account has an hourly request quota and a per-second cap. Exceeding either returns HTTP 429. Contact TelecomsXChange to raise the limit for high-volume integrations.

What can I do with the TCXC API?

Search live wholesale voice and SMS rates, download full rate decks, list CDRs and SDRs, run route tests, interconnect with carriers, buy and sell DID numbers, provision and top up eSIMs, run HLR lookups, check balances and payment history, message other members, and pull traffic summary reports.

Can I import the API into Postman or use it with AI agents?

Yes. Download the Postman collection or the OpenAPI 3.0 specification from this page, read the Markdown version of the reference, or connect an AI assistant through the TCXC MCP server.