Get started with the API

This quickstart takes you from no key to buying a route and reading its call records in five steps, in about ten minutes. Every request and response below is real in shape; your IDs and prices will differ. For every endpoint and parameter, see the API reference.

Before you start#

• A buyer login with at least one account that has funds.
• curl, or Python with requests, or PHP with the curl extension. The examples use cURL; the reference shows each call in all three.

Turn on API access#

1. Go to Settings → Profile & Preferences.
2. Tick Allow API Access.
3. Copy the API Key and click Save. Regenerate replaces the key at once; the old one stops working.

Keep the key out of source code. The examples read it from the environment:

export TCXC_USERNAME="your-portal-username"
export TCXC_API_KEY="the-key-from-preferences"

Make your first call#

Read the balance of every account. Each call uses HTTP Digest authentication: your username, and the API key as the password.

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

{
  "status": "success",
  "accounts": [
    {
      "i_account": "1022",
      "name": "Northwind",
      "currency": "USD",
      "balance": "4106.06",
      "credit_limit": "0",
      "smpp": "0",
      "blocked": "0"
    }
  ]
}

Note the i_account of the account you'll send traffic from: most buyer calls take it. An account that shares another account's balance shows that account in use_balance and its balance in parent_balance.

Find a route#

Search Market View for a destination prefix. Leave smpp out for voice routes, or set it to 1 for SMS.

curl --digest -u "$TCXC_USERNAME:$TCXC_API_KEY" -X POST \
  https://apiv2.telecomsxchange.com/marketview/search \
  -d searchform=1 -d prefix=4477 -d type=CLI -d pager=20 -d off=0

Each route in rates carries its seller, price per minute (price_1, price_n with the billing intervals), daily and weekly ASR and ACD, and its i_connection: the ID you buy it with. Prices already include the platform commission, as in the portal. See Search Market View for every filter.

Buy the route#

Purchasing creates an interconnect between your account and the seller's route. It costs nothing; you pay per minute or message as traffic flows.

curl --digest -u "$TCXC_USERNAME:$TCXC_API_KEY" -X POST \
  https://apiv2.telecomsxchange.com/buyers/interconnect \
  -d add=1 -d i_account=1022 -d id=38 -d agree=yes

{
  "status": "success",
  "message": "Interconnection with TATA Communications completed",
  "rates_url": "https://members.telecomsxchange.com/accounts.php?download=38",
  "tech_prefix": "33270#",
  "route_type": "voice"
}

Send calls to sip01.telecomsxchange.com, port 5060, with the tech_prefix in front of the number in E.164 format: 33270#447700900123. See Send your first call.

Read your call records#

Fetch the call detail records for a time range. show=good returns answered calls, bad failed ones, all both.

curl --digest -u "$TCXC_USERNAME:$TCXC_API_KEY" -X POST \
  https://apiv2.telecomsxchange.com/buyers/callhistory \
  -d show=all -d "date_from=2026-10-21 00:00:00" -d "date_to=2026-10-21 23:59:59"

Each record has the number dialled (CLD), caller (CLI), connect_time, billed_duration, the price, the amount charged (customer_amount), the seller and route, and the SIP disconnect_code with its reason.

Where next#

What if something goes wrong?#