Query the Full List

Pricing & Coverage API | Options | Query the full list

The coverage of tyntec’s services and the respective pricing can be queried in three ways:

tyntec resource URLs to retrieve coverage and pricing

Operation

Resource URL

Method

Query the full coverage

/${baseURL}/coverage

GET

Query the coverage for one country

/${baseURL}/coverage?alpha3=${alpha3}
/${baseURL}/coverage?alpha2=${alpha2}
/${baseURL}/coverage?countryCode=${countryCode}
/${baseURL}/coverage?mcc=${mcc}

GET

Query the list of currently unavailable networks

/${baseURL}/coverage/unavailable

GET

To retrieve the full coverage and pricing list, make a GET request to the coverage resource using the credentials of the respective account. The following code blocks provide examples for SMS-MT:

Example of Query (JSON):

<div class="geshifilter"><pre class="php geshifilter-php">curl
<span class="sy0">-</span>u username<span class="sy0">:</span>password
<span class="sy0">-</span>X GET
<span class="sy0">-</span>H <span class="st0">"Accept:application/json"</span>
https<span class="sy0">:</span><span class="co1">//rest.tyntec.com/sms/v1/outbound/coverage</span></pre></div>

Response to Query Containing the Full Coverage and Price List (JSON):

<div class="geshifilter"><pre class="php geshifilter-php">HTTP<span class="sy0">/</span><span class="nu19">1.1</span> <span class="nu0">200</span> OK
<span class="br0">{</span>
      <span class="br0">{</span>
      <span class="st0">"region"</span><span class="sy0">:</span><span class="st0">"Western Europe"</span><span class="sy0">,</span>
      <span class="st0">"country"</span><span class="sy0">:</span><span class="st0">"Germany"</span><span class="sy0">,</span>
      <span class="st0">"alpha3"</span><span class="sy0">:</span><span class="st0">"DEU"</span><span class="sy0">,</span>
      <span class="st0">"alpha2"</span><span class="sy0">:</span><span class="st0">"DE"</span><span class="sy0">,</span>
<span class="st0">"countryCode"</span><span class="sy0">:</span><span class="nu0">49</span><span class="sy0">,</span>
<span class="st0">"ttid"</span><span class="sy0">:</span><span class="nu0">15</span><span class="sy0">,</span>
<span class="st0">"operator"</span><span class="sy0">:</span><span class="st0">"Vodafone D2 GmbH"</span><span class="sy0">,</span>
<span class="st0">"networkType"</span><span class="sy0">:</span><span class="st0">"GSM"</span><span class="sy0">,</span>
<span class="st0">"available"</span><span class="sy0">:</span><span class="kw4">true</span><span class="sy0">,</span>
<span class="st0">"classification"</span><span class="sy0">:</span><span class="st0">"unrestricted"</span><span class="sy0">;</span>
<span class="st0">"mcc"</span><span class="sy0">:</span><span class="st0">"262"</span><span class="sy0">,</span>
<span class="st0">"mnc"</span><span class="sy0">:</span><span class="st0">"02"</span><span class="sy0">,</span>
<span class="st0">"accountSet"</span><span class="sy0">:</span><span class="nu0">1</span><span class="sy0">,</span>
<span class="st0">"price"</span><span class="sy0">:</span><span class="nu19">0.07</span><span class="sy0">,</span>
<span class="st0">"currency"</span><span class="sy0">:</span><span class="st0">"EUR"</span><span class="sy0">,</span>
<span class="st0">"priceEffective"</span><span class="sy0">:</span><span class="st0">"2010-11-01T00:00:00+0000"</span><span class="sy0">,</span>
<span class="st0">"comment"</span><span class="sy0">:</span><span class="st0">""</span>
<span class="br0">}</span><span class="sy0">,</span>
…
<span class="br0">}</span></pre></div>

Parameters and Descriptions in Reply:

Parameter

Default

Description

region

UTF-8 encoded string

The geographic region the country belongs to

country

UTF-8 encoded string

The respective name of the country

alpha3

Country code following ISO 3166-1 alpha-3

The three-letter country code.

alpha2

Country code following ISO 3166-1 alpha-2

The two-letter country code.

countryCode

Country code according to ITU E.164

The international call prefix.

ttid

integer

The respective tyntec id of the target network.

operator

UTF-8 encoded string

The name of the operator.

networkType

GSM/CDMA

The technology used by the respective network.

available

boolean

The current availability of the network.

classification

Unrestricted / restricted / P2P

Allowed traffic type.

mcc

Country code following ITU E.212

The mobile country code according to the ITU E.212 numbering standard.

mnc

Network code following ITU E.212

The mobile network code according to the ITU E.212 numbering standard.

accountSet

integer

The pricing set used for the account.

price

float

The price per message for the respective network.

currency

Currency code following ISO 4217

The currency in which the price is given; this corresponds to the currency of the invoice.

priceEffective

Date in the format “yyyy-MM-ddTHH:mm:ss” (according to ISO 8601)

The date when the “price” became effective.

comment

UTF-8 encoded string

Further information regarding the respective network.