TMT Live 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

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
application/json
Example
{
  • "40722570240": {
    }
}

ENUM Services

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 live.tmtvelocity.com

Output Data

Field Description
tel The original number queried
npdi Number Portability Dip Indicator (indicates to any downstream systems a portability lookup has been performed)
np Indicates if the number was ported.
Values: yes / no / na.
rn Routing Number (LRN for USA/Canada)
cic Carrier Identification Code (list provided by TMT).
cc Country Code
cn Carrier short name (list provided by TMT)
nt Indicates the type of the Number Type.
Values: mobile / fixed.
ocn Operating Company Number (only for Canada & USA)
mcc Mobile Country Code of the current network (if nt = mobile)
mnc Mobile Network Code of the network (if nt = mobile).
imsi First 5 digits of the International Mobile Subscriber Identity number
pres Indicates if the subscriber is present in the network.
Values: yes / no / na
e Error indicator – 0 (zero) = ok. Other values than “0” are detailed in ERROR codes section
roaming, rcic, rocn, rmnc, rmcc Not provided data

Successful Query & Response

A successful query will return a NAPTR Record with a tel-uri format.

Command:
$ dig +short +yaml -t naptr @176.9.67.8 9.8.9.3.5.2.2.2.7.0.4.live.tmtvelocity.com

  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NOERROR
  [..]
  ANSWER: 1
  [..]
  10 100 "u" "E2U+pstn:tel""!^(.*)$!tel:\\1;npdi;np=no;rn=;cic=4018720;ocn=;cc=ro;cn=Vodafone Romania;nt=mobile;mcc=226;mnc=01;oname=Vodafone Romania;imsi=22601XXXXXXXXXX;pres=yes;roaming=na;rcic=;rocn=;rmcc=;rmnc=;e=0!"

Please note that all parameters, including null or N/A values, are currently provided in the response by default. If you require the removal of null parameters, please contact us at support@tmtid.com. Our team will configure this change for you.

Response example for Invalid Number

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.live.tmtvelocity.com
  -
  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NXDOMAIN
  id: 13664
  flags: qr aa rd
  QUESTION: 1
  ANSWER: 0
  AUTHORITY: 0
  ADDITIONAL: 0

Error Code 191 Response Example

191 error Is returned when the queried destination is not covered by the Live service. The service will return MNC, MCC, and the Name for the Current Carrier.

Command:
$ dig +short +yaml -t naptr @176.9.67.8 4.4.0.0.0.0.0.1.0.7.4.3.2.live.tmtvelocity.com

  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NOERROR
  [..]
  ANSWER: 1
  [..]
  10 100 "u" "E2U+pstn:tel""!^(.*)$!tel:\\1;np=yes;rn=;cic=234503;ocn=;cc=ng;cn=9Mobile(ETISALAT);nt=mobile;mcc=621;mnc=60;oname=Airtel;imsi=62160XXXXXXXXXX;pres=na;roaming=na;rcic=;rocn=;rmcc=;rmnc=;e=191!"

Error Code 192 Response Example

192 error is returned when the queried destination is not covered by the services. The service will return MNC, MCC, and the Name for the Origin Carrier.

Command:
$ dig +short +yaml -t naptr @176.9.67.8 2.0.3.8.7.0.4.4.0.3.2.9.live.tmtvelocity.com

  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NOERROR
  [..]
  ANSWER: 1
  [..]
  10 100 "u" "E2U+pstn:tel" "!^(.*)$!tel:\\1;np=na;rn=;cic=92500;ocn=;cc=pk;cn=Jazz (Mobilink);nt=mobile;mcc=410;mnc=01;oname=Jazz (Mobilink);imsi=41001XXXXXXXXXX;pres=na;roaming=na;rcic=;rocn=;rmcc=;rmnc=;e=192!"

Error Code 193 Response Example

193 error is returned when the queried destination is a fixed line. Indicates that the queried number represents a fixed line (Landline).

Command:
$ dig +short +yaml -t naptr @176.9.67.8 3.3.1.0.4.8.7.8.3.3.3.live.tmtvelocity.com

  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NOERROR
  [..]
  ANSWER: 1
  [..]
  10 100 "u" "E2U+pstn:tel" "!^(.*)$!tel:\\1;np=no;rn=;cic=33511;ocn=;cc=fr;cn=Orange;nt=fixed;mcc=;mnc=;oname=Orange;imsi=;pres=na;roaming=na;rcic=;rocn=;rmcc=;rmnc=;e=193!"

ENUM SIP-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 live-sip.tmtvelocity.com

Output Data

Field Description
tel The original number queried
npdi Number Portability Dip Indicator (indicates to any downstream systems a portability lookup has been performed)
np Indicates if the number was ported.
Values: yes / no / na.
rn Routing Number (LRN for USA/Canada)
cic Carrier Identification Code (list provided by TMT).
cc Country Code
cn Carrier short name (list provided by TMT)
nt Indicates the type of the Number Type.
Values: mobile / fixed.
ocn Operating Company Number (only for Canada & USA)
mcc Mobile Country Code of the current network (if nt = mobile)
mnc Mobile Network Code of the network (if nt = mobile).
imsi First 5 digits of the International Mobile Subscriber Identity number
pres Indicates if the subscriber is present in the network.
Values: yes / no / na
e Error indicator – 0 (zero) = ok. Other values than “0” are detailed in ERROR codes section
roaming, rcic, rocn, rmnc, rmcc Not provided data

Successful Query & Response

A successful query will return a NAPTR Record with SIP-URI in the format sip:+msisdn@ims.mnc.mcc.3gppnetwork.org.

Command:
$ dig +short +yaml -t naptr @176.9.67.8 9.8.9.3.5.2.2.2.7.0.4.live-sip.tmtvelocity.com

  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NOERROR
  [..]
  ANSWER: 1
  [..]
  10 100 "u" "E2U+sip" "!^.*$!sip:+40722253989@ims.mnc01.mcc226.3gppnetwork.org;npdi;np=no;rn=;cic=4018720;ocn=;cc=ro;cn=Vodafone Romania;nt=mobile;mcc=226;mnc=01;oname=Vodafone Romania;imsi=22601XXXXXXXXXX;pres=yes;roaming=na;rcic=;rocn=;rmcc=;rmnc=;e=0!"

Please note that all parameters, including null or N/A values, are currently provided in the response by default. If you require the removal of null parameters, please contact us at support@tmtid.com. Our team will configure this change for you.

Response example for Invalid Number

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.live-sip.tmtvelocity.com
  -
  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NXDOMAIN
  id: 13664
  flags: qr aa rd
  QUESTION: 1
  ANSWER: 0
  AUTHORITY: 0
  ADDITIONAL: 0

Error Code 191 Response Example

191 error Is returned when the queried destination is not covered by the Live service. The service will return MNC, MCC, and the Name for the Current Carrier.

Command:
$ dig +short +yaml -t naptr @176.9.67.8 4.4.0.0.0.0.0.1.0.7.4.3.2.live-sip.tmtvelocity.com

  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NOERROR
  [..]
  ANSWER: 1
  [..]
  10 100 "u" "E2U+sip" "!^.*$!sip:+2347010000044@ims.mnc60.mcc621.3gppnetwork.org;np=yes;cic=234503;cc=ng;cn=9Mobile(ETISALAT);nt=mobile;mcc=621;mnc=60;oname=Airtel;imsi=62160XXXXXXXXXX;pres=na;roaming=na;e=191!"

Error Code 192 Response Example

192 error is returned when the queried destination is not covered by the service. The service will return MNC, MCC, and the Name for the Origin Carrier.

Command:
$ dig +short +yaml -t naptr @176.9.67.8 2.0.3.8.7.0.4.4.0.3.2.9.live-sip.tmtvelocity.com

  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NOERROR
  [..]
  ANSWER: 1
  [..]
  10 100 "u" "E2U+sip" "!^.*$!sip:+923044078302@ims.mnc01.mcc410.3gppnetwork.org;np=na;cic=92500;cc=pk;cn=Jazz (Mobilink);nt=mobile;mcc=410;mnc=01;oname=Jazz (Mobilink);imsi=41001XXXXXXXXXX;pres=na;roaming=na;e=192!"

Error Code 193 Response Example

193 error is returned when the queried destination is a fixed line. Indicates that the queried number represents a fixed line (Landline).

Command:
$ dig +short +yaml -t naptr @176.9.67.8 3.3.1.0.4.8.7.8.3.3.3.live-sip.tmtvelocity.com

  type: MESSAGE
  message:
  type: AUTH_RESPONSE
  [..]
  response_message_data:
  opcode: QUERY
  status: NOERROR
  [..]
  ANSWER: 1
  [..]
  10 100 "u" "E2U+sip" "!^.*$!sip:+33387840133@ims.mnc.mcc.3gppnetwork.org;np=no;cic=33511;cc=fr;cn=Orange;nt=fixed;oname=Orange;pres=na;roaming=na;e=193!"

Error Codes

Code (dec) Code (hex) Presence Description
1 0x1 no Unknown subscriber: The number is not allocated.
2 0x2 no The owning network cannot be reached.
3 0x3 no The network cannot reach the number.
4 0x4 no The location of the number is not known to the network.
5 0x5 no The number, as published in HLR, in not known to the MSC.
6 0x6 no The number is absent for SM.
7 0x7 no Unknown equipment.
8 0x8 no Roaming not allowed.
9 0x9 no Illegal subscriber.
10 0xA no Bearer service not provisioned.
11 0xB no Tele-service not provisioned.
12 0xC no Illegal equipment.
13 0xD no Call barred.
21 0x15 no Facility not supported.
27 0x1B no Phone switched off.
28 0x1C no Incompatible terminal.
31 0x1F no The subscriber is busy.
32 0x20 no The delivery of the SM has failed.
33 0x21 n/a A congestion (a full waiting list) occurred.
34 0x22 n/a System failure.
35 0x23 no Missing data.
36 0x24 no Data error.
191 0xBF n/a Unsupported network for which TMT offers portability status.
192 0xC0 n/a Unsupported network for which TMT offers the Origin Network.
193 0xC1 n/a Landline / Fixed network (not covered)

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. 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.
  • 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.
  • Live_coverage – indicates if the destination is covered at present time:
    • true (covered)
    • false (not covered)

Example:

filename United Arab Emirates_live_operators.csv

  971500;Emirates Telecom Corp-ETISALAT;424;02;true
  971501;Emirates Integrated Telecommunications Company PJSC (DU);424;03;true
  971502;All landline United Arab Emirates;424;;false