TMT Velocity API specs

Download OpenAPI specification:Download

About TMT

TMT ID is a leading provider of data, intelligence and analytics, helping customers find extra value from the information they hold. Our team of technology and telecommunications specialists has a proven track record empowering companies, brands and agencies around the world to better understand their businesses and their customers. TMT ID has a suite of technology and telecommunications data available, for further information, please visit www.tmtid.com or email info@tmtid.com.

HTTP API

GET method

path Parameters
format
required
string

JSON CSV

key
required
string

API credentials – delivered to you via email

secret
required
string

API credentials – delivered to you via email

number
required
string

The number in E.164 format (includes the country code sufix)

Responses

Response samples

Content type
Example
{
  • "number": 40721275636,
  • "current_carrier": {
    },
  • "ocn": null,
  • "original_carrier": {
    },
  • "ported": true,
  • "status": 0,
  • "status_message": "Success",
  • "type": "mobile"
}

POST method

path Parameters
key
required
string

API credentials – delivered to you via email

secret
required
string

API credentials – delivered to you via email

Request Body schema: JSON
format
string

json/csv

number
string

The number in E.164 format.(Only for one query numbers).

numbers
Array of strings

The numbers in E.164 format.(Only for multiple query numbers).

Responses

Request samples

Content type
JSON
{
  • "format": "json",
  • "number": 40721275636,
  • "numbers": [
    ]
}

Response samples

Content type
Example
{
  • "number": 40721275636,
  • "current_carrier": {
    },
  • "original_carrier": {
    },
  • "ported": true,
  • "status": 0,
  • "status_message": "Success",
  • "type": "mobile"
}

ENUM Service

ENUM TEL-URI

Query Format

dig -t naptr @NodeIP Phone_number_in_enum_format.live.tmtvelocity.com

Query Parameter Description

Record-Type NAPTR
Node IPs x.x.x.x
Phone Number in enum format The E.164 number needs to be transformed as follows (eg. for: +40/766610060):
  • Remove all special characters: +40/766610060 becomes 40766610060.
  • Reverse all digits from the number: 40766610060 becomes 06001666704.
  • Add Dots between all digits: 06001666704 becomes 0.6.0.0.1.6.6.6.7.0.4.
Domain e164enum.tmtvelocity.com
Port 53

Output Data

Field Description
tel Queried phone number
npdi Number Portability Dip Indicator (indicates to any downstream systems a portability lookup has been performed)
rn Routing Number (LRN for USA/Canada)
cic Carrier Identification Code (list provided by TMT).
ocn Operating Company Name is the carrier’s Company Code - only for USA / Canada
cc Country Code
cn Carrier short name (list provided by TMT)
nt Number type
Values:
  • mobile
  • fixed.
mcc Mobile Country Code of the carrier
mnc Mobile Network Code of the carrier
np Indicates the portability status. It is a custom field that can be added upon request.
Values:
  • yes = ported
  • no = not ported

ENUM – Successful Query & Response

Command:
$ dig +yaml -t naptr @176.9.67.8 9.8.9.3.5.2.2.2.7.0.4.e164enum.tmtvelocity.com
-
  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NOERROR
  [..]
  QUESTION_SECTION:
  - 9.8.9.3.5.2.2.2.7.0.4.e164enum.tmtvelocity.com. IN NAPTR
  ANSWER_SECTION:
  - 9.8.9.3.5.2.2.2.7.0.4.e164enum.tmtvelocity.com. 3600 IN NAPTR 10 100 "u" "E2U+pstn:tel""!^(.*)$!tel:1;npdi;np=no;rn=;cic=4018720;ocn=;cc=ro;cn=VODA;nt=mobile;mcc=226;mnc=01!" .

ENUM – Unsuccessful Query & Response

In the example below an invalid phone number was queried. The output status is NXDOMAIN and the answer section is blank.

Command:
$ dig +short +yaml -t naptr @176.9.67.8 4.3.2.1.0.4.e164enum.tmtvelocity.com
-
  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  query_time: !!timestamp 2023-03-27T15:34:53.879Z
  response_time: !!timestamp 2023-03-27T15:34:53.879Z
  {..}
  response_address: 176.9.67.8
  response_port: 53
  query_address: 0.0.0.0
  [..]
  opcode: QUERY
  status: NXDOMAIN
  id: 13664
  flags: qr aa rd
  QUESTION: 1
  ANSWER: 0
  AUTHORITY: 0
  ADDITIONAL: 0

Service Coverage

Velocity coverage is constantly changing. Each update is uploaded on the Viteza Customer Portal. Users can download all files at once (zip archive) or country by country (CSV file).
For each country, an operators file is provided during the provisioning process via Email. The up-to-date coverage files are updated in the Viteza Customer Portal.

  • network_id – unique across the system (assigned by TMTID). You will find this in the download files as well as in the CIC field of the ENUM response. You should use this field for mapping to our system.
  • ocn – (only for US/Canada files) – Operating Company Name is the carrier’s Company Code. It is assigned by the National Exchange Carrier Association. You should use this field for mapping to our system.
  • network – carriers’ short name. Unique per country. You will find this in the download files as well as in the CN field of the ENUM response. This field is for quickly identifying networks during operator-assisted tests.
  • full_name – the full name of the operator/carrier.
  • mcc – the mobile country code of the operator/carrier.
  • mnc – mobile network code for the operator/carrier.

Example:

filename SK_operators.csv
  4219920;SKOTW;O2 Slovakia;231;06
  4219910;SKOGE;Orange Slovakia;231;01
  4219900;SKTEL;Slovak Telekom;231;02
  4219903;SKSWA;Swan 4KA Slovakia;231;03
  4219930;SKZSR;ZSR Slovakia;231;99