Tools

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 troubleshoot common integration issues.

Base URLhttps://apiv2.telecomsxchange.com
AuthenticationHTTP Digest

#List Sellers IDs

POSThttps://apiv2.telecomsxchange.com/sellers/list

“pager” and “off” (should be set or unset both) allow to limit and paginate results. “pager” is a limit of the numbers to be returned, “off” is offset.

Body parameters

application/x-www-form-urlencoded
pagerintegerrequired

integer

Example 10000

offintegerrequired

integer

Example 0

curl --digest \
  -u "$TCXC_USERNAME:$TCXC_API_KEY" \
  -X POST \
  "https://apiv2.telecomsxchange.com/sellers/list" \
  -d "pager=10000" \
  -d "off=0"
Sellers and routes3 results
Selleri_tariffi_connectionVisibility
JOJOODUAE129128public
JOJOODOrange130129public
JOJOODMy Route 1e134133public
Rendered from the example response.

#Get Test Numbers

GEThttps://apiv2.telecomsxchange.com/buyers/tools/getnumbers

This API allows you to get valid phone numbers to any country in the world, and initiate your voice, sms test on.This API is designed for network operation center (NOC) that continously looking for working numbers in different countries to initiate tests on.

Try Demo App

Features for NOC automation

  • Get valid phone numbers to any country in the world
  • Set a limit in the API call to how many numbers to get in the response
  • Get Country name, Code, Description in response
  • Get only valid numbers
  • Random Numbers on every API call to avoid duplicates

Once numbers are retreived you can use the Route Test API to intiate test calls.

Query parameters

prefixintegerrequired

Country Code + Area code (e.164 format)

Example 91

countrystringrequired

country name - i.e. India

Example india

descriptionstringrequired

network name - i.e. Airtel

Example Airtel

curl --digest \
  -u "$TCXC_USERNAME:$TCXC_API_KEY" \
  "https://apiv2.telecomsxchange.com/buyers/tools/getnumbers?prefix=91&country=india&description=Airtel"
Test numbers3 numbers available
  • +201021634650Egypt · Mobile - Vodafone
  • +201023792381Egypt · Mobile - Vodafone
  • +201032091935Egypt · Mobile - Vodafone
Rendered from the example response.

#Get Phone Number Score

GEThttps://apiv2.telecomsxchange.com/buyers/tools/numberscore/

Features:

  • Look up phone number
  • Get phone number score against TCXC database (Good Number or Risky)

Good:
the number has been recorded in our database and had high durations and most probably a good number that belongs to a real person.

Risky:
We have never seen this number before or it had too many failed calls that never connected.

Use Cases:

-Build Whitelist/Blacklist systems through API -Decrease SPAM/ROBO incoming calls -Save on HLR costs -Reject the risky phone numbers calls before it hits your infrastructure

Query parameters

cldintegerrequired

Phone number to check

Example 380913104703

curl --digest \
  -u "$TCXC_USERNAME:$TCXC_API_KEY" \
  "https://apiv2.telecomsxchange.com/buyers/tools/numberscore/?cld=380913104703"
Number score
Risky number+380910101783 · Ukraine · Ukr Telecom Mobile

Use the score to reject risky callers before they reach your switch, or to skip HLR lookups on numbers you already trust.

Rendered from the example response.

#Initiate Route Test

POSThttps://apiv2.telecomsxchange.com/buyers/routetest

This API allows you to initiate testing to one or more routes using a single API request.

Body parameters

application/x-www-form-urlencoded
i_accountintegerrequired

Billing Account ID

Example 1022

cld1integerrequired

The first phone number to dial

Example 962790326274

cli1integerrequired

The caller id to use when calling the first number or CLD1

Example 18882874637

i_connection1integerrequired

Carrier Route to use for the test call e.g 315 is IDT, You can find this infromation in Market View API.

Example 315

cld2stringrequired

The second phone number to dial

Example ‭1305)7763097‬

cli2integerrequired

The second caller id to use when calling the second number or CLD 2

Example 9542405411

i_connection2integerrequired

Carrier Route to use for the test call on second number

Example 864

curl --digest \
  -u "$TCXC_USERNAME:$TCXC_API_KEY" \
  -X POST \
  "https://apiv2.telecomsxchange.com/buyers/routetest" \
  -d "i_account=1022" \
  -d "cld1=962790326274" \
  -d "cli1=18882874637" \
  -d "i_connection1=315" \
  -d "cld2=‭1305)7763097‬" \
  -d "cli2=9542405411" \
  -d "i_connection2=864"
Route test
Test not startedSelected account does not have a purchased for selected route(s), please choose other combination or purchase selected route(s) on this account

Results (PDD, ASR, audio) arrive in the members portal and via CDRs once the call completes.

Rendered from the example response.