TMT Velocity API specs

Download OpenAPI specification:Download

About TMT

TMT Analysis 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 Analysis has a suite of technology and telecommunications data available, for further information, please visit www.tmtanalysis.com or email info@tmtanalysis.com.

HTTP API

GET method

path Parameters
format
required
string

json,csv.

key
required
string

The API key (obtained from https://viteza.tmtanalysis.com or from Support during customer on-boarding).

secret
required
string

The API secret (obtained from https://viteza.tmtanalysis.com or from Support during customer on-boarding).

number
required
string

The number in E.164 format.

Responses

Response samples

Content type
{
  • "number": 40721275636,
  • "original_carrier": {
    },
  • "current_carrier": {
    },
  • "type": "mobile",
  • "status_message": "Success"
}

POST method

header Parameters
X-API-Key
required
string

The API key (obtained from https://viteza.tmtanalysis.com or from Support during customer on-boarding).

X-API-Secret
required
string

The API secret (obtained from https://viteza.tmtanalysis.com or from Support during customer on-boarding).

Request Body schema: application/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
application/json
{
  • "format": "json",
  • "number": 40721275636,
  • "numbers": [
    ]
}

Response samples

Content type
{
  • "number": 40721275636,
  • "original_carrier": {
    },
  • "current_carrier": {
    },
  • "type": "mobile",
  • "status_message": "Success"
}

ENUM Services

ENUM Parameters

The parameters for the communication are: - Record-Type: NAPTR - Domain: e164enum.tmtvelocity.com - IPs for the service: To be provided during provisioning, referred below as TMTIP - Port: 53

ENUM Query format

ENUM resolution operates much like reverse DNS lookup. To perform the lookup, the E.164 number needs to be transformed as follows:

  • Remove non-numeric characters such as spaces, +, dashes, etc. (e.g. number “+40766-610060” needs transforming to “40766610060”).
  • Reverse the digits and add a dot between every digit (e.g. 40766610060 becomes 0.6.0.0.1.6.6.6.7.0.4)
  • Add suffix domain e164enum.tmtvelocity.com (e.g. the number now becomes 0.6.0.0.1.6.6.6.7.0.4.e164enum.tmtvelocity.com)

After transforming the number, perform a DNS lookup looking for NAPTR records:

$ dig -t naptr @TMTIP 0.6.0.0.1.6.6.6.7.0.4.e164enum.tmtvelocity.com

  ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 40696
  ;; flags: qr aa rd; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0

  ;; QUESTION SECTION:
  ;0.6.0.0.1.6.6.6.7.0.4.e164enum.tmtvelocity.com. IN NAPTR

ENUM response

A successful query will return a NAPTR Record with a tel-uri in the format tel:+msisdn. Example:
;; ANSWER SECTION:
0.6.0.0.1.6.6.6.7.0.4.e164enum.tmtvelocity.com. 3600 IN NAPTR 10 100 "u" "E2U+pstn:tel"
"!^(.*)$!tel:1\;npdi\;rn=\;cic=4018720\;cc=ro\;cn=VODA\;nt=mobile\;mcc=226\;mnc=01!" .

The parameters returned are based on RFC4694:

  • tel – the original number queried
  • npdi – NP Database 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)
  • cc – Country Code
  • cn – Carrier short name (list provided by TMT)
  • nt – Number type (mobile/fixed)
  • mcc – MCC of the network (if mobile nt)
  • mnc – MNC of the network (if mobile nt)

Unsuccessful query response

Unsuccessful queries will be responded to with status NXDOMAIN and a blank answer section.

Example:

$ dig -t naptr @TMTIP 0.6.0.0.1.6.6.6.1.0.4.e164enum.tmtvelocity.com

  ;; Got answer:
  ;; ->>HEADER<<- opcode: QUERY, status: NXDOMAIN, id: 19974
  ;; flags: qr aa rd; QUERY: 1, ANSWER: 0, AUTHORITY: 0, ADDITIONAL: 0
  ;; WARNING: recursion requested but not available

  ;; QUESTION SECTION:
  ;0.6.0.0.1.6.6.6.1.0.4.e164enum.tmtvelocity.com. IN NAPTR

SIP Redirect

TMT Sip Redirect Server
The purpose of the TMT Sip Redirect server is to provide TMT customers with real-time NP data by redirecting SIP messages to the appropriate routing endpoint based on the current network of the called party.

Simplified, the call-flow is:

sip1

  • TMT SIP Redirect Server Architecture

For each network in the countries to which the Customer can request NP query, the customer will provide:

  • Network (e.g. ‘H3G’, ‘TIM’, ‘WIN’, etc...)
  • Contact header information
    • 3xx message type needed (e.g. 300 if multiple routes need to be chosen).
      Recommended: 301 Moved temporarily with Expires header indicating the next NPDB refresh time. This allows the Customer to cache the result until the NP data is refreshed.
    • Prefix (if necessary to prefix the number)
    • New Route(s)

Example:

For network ‘TIM’, the customer wants to be able to send the calls to 10.1.1.1 and 10.1.1.2 with prefix 998. In this example, 10.1.1.1 is the first route and fails the call to 404 not found. sip2

TMT Sip Redirect server can handle any variables in the message type (3xx message type) and any variables in the Contact field for the 3xx message (multiple routes, q=, expires=, prefix).

Operators files

For each country provisioned, an operators file is provided during the provisioning process. If any time there are movements in the operators list for a provisioned country, an update is sent by TMT Analysis support to its customers with the new operators file.

The files contain the following fields, separated by “;”:

  • Service provider ID – unique across the system, TMT assigned. You will find this in the download files as well as in the cic field of the ENUM response. This is the field you should use for mapping to your system.
  • Network 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.
  • Network Full name – the full name of the operator
  • MCC
  • MNC

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