API : Destination Get

Introduction

This request will return a specific destination.

A destination consists of the prefixes (e.g. +4677 and +4674 for Swedish high-rated numbers) that is the beginning of the number you dial to get to a number in that destination, the country it belongs to, the type of numbers that the destination holds (landline, mobile, special, free) and the connection fee and rates for calling a number in the destination.

Destinations are common for all customers, but a reseller may create one or more destination overrides that alter the pricing for all of the resellers customers and/or for an individual customer. The prices presented here will include the overrides if a product is specified.

Request

URL	https://api.telecomx.dk/destination/COUNTRY_CODE
Method	GET
Access level	VIEWER, MANAGER or OWNER, RESELLER, RESELLER_ADMIN, ADMIN.
Param	COUNTRY_CODE	2-Char ISO3166 country code.
Query	product	`[optional]` Id of product with possible overrides to apply. Ignored if not a valid id.

Query example

https://api.telecomx.dk/destination/DE
https://api.telecomx.dk/destination/DE?product=650000000000000000000004

Response

JSON object
_id	String	ISO3166 2-char uppercase country code.
prefix	String	Prefix for the country, e.g. +45.
image	ObjectId	Image Id
names	Array	List of names, used for localization
names[].language	String	ISO 639-1 language code: 'da' or 'en'
names[].text	String	The localization of the name.
region	String	Voice region the country belongs to: HOMELAND, EU_NORDIC, REST_OF_EUROPE, WORLD1, WORLD2, WORLD3
roamingRegion	Object	Roaming region the country belongs to, depending on mobile network. The key is the provider ID, and the value is the region. Keys can be “telenor”, or “tdc”
roamingRegion.<provider>	ObjectId	ID of roaming region
breakouts	Array	List of breakouts within a country, with prefix, type, fee-cost, fee-rate
breakouts[].prefix	Array	Array of strings, which is the prefixes, that this destination/type covers
breakouts[].type	String	FIXED, MOBILE, SPECIAL
breakouts[].cost	Object	Cost prices for each peer (RESELLER_ADMIN/ADMIN only).
breakouts[].cost.<PeerId>	Object	Cost prices for one peer, keyed by peer id: TELENOR, SUPERTEL or TDC.
breakouts[].cost.<PeerId>.fee	Number	Connection fee cost.
breakouts[].cost.<PeerId>.rate	Number	Pr. minute cost.
breakouts[].cost.<PeerId>.rates	Array	List of cost rates for the prefixes in this breakout.
fixed	Object	prices for fixed destinations
fixed.wholesaleFee	Number	Connection fee for reseller (RESELLER/RESELLER_ADMIN/ADMIN only)
fixed.customerFee	Number	Connection fee for customer
fixed.wholesaleRate	Number	Pr. minute rate for reseller (RESELLER/RESELLER_ADMIN/ADMIN only)
fixed.customerRate	Number	Pr. minute rate for customer
mobile	Object	prices for mobile destinations
mobile.wholesaleFee	Number	Connection fee for reseller (RESELLER/RESELLER_ADMIN/ADMIN only)
mobile.customerFee	Number	Connection fee for customer
mobile.wholesaleRate	Number	Pr. minute rate for reseller (RESELLER/RESELLER_ADMIN/ADMIN only)
mobile.customerRate	Number	Pr. minute rate for customer
special	Object	prices for special destinations
special.wholesaleFee	Number	Connection fee for reseller (RESELLER/RESELLER_ADMIN/ADMIN only)
special.customerFee	Number	Connection fee for customer
special.wholesaleRate	Number	Pr. minute rate for reseller (RESELLER/RESELLER_ADMIN/ADMIN only)
special.customerRate	Number	Pr. minute rate for customer

Note that properties holding no value may be omitted from the object.

Example

{
  "_id": "DE",
  "prefix": "+49",
  "image": "650000000000000000000001",
  "names": [
    { "language": "da", "text": "Tyskland" },
    { "language": "en", "text": "Germany" }
  ],
  "region": "EU_NORDIC",
  "roamingRegion": {
    "tdc": "650000000000000000000002",
    "telenor": "650000000000000000000003"
  },
  "breakouts": [
    {
      "prefix": [ "+4915", "+49151", "+49152", "+49160", "+49170" ],
      "type": "MOBILE",
      "cost": {
        "TELENOR": { "fee": 0.02, "rate": 0.1795 },
        "TDC": { "fee": 0, "rate": 0.2931 },
        "SUPERTEL": { "fee": 0, "rate": 0.161, "rates": [ 0.1523, 0.161 ] }
      }
    },
    {
      "prefix": [ "+49", "+4930", "+4940" ],
      "type": "FIXED",
      "cost": {
        "TELENOR": { "fee": 0.02, "rate": 0.0955 },
        "TDC": { "fee": 0, "rate": 0.4266 },
        "SUPERTEL": { "fee": 0, "rate": 0.0647, "rates": [ 0.055, 0.0647 ] }
      }
    },
    {
      "prefix": [ "+49700", "+49701" ],
      "type": "SPECIAL",
      "cost": {
        "TELENOR": { "fee": 0.2, "rate": 0.1975 },
        "TDC": { "fee": 0, "rate": 0.18 }
      }
    }
  ],
  "fixed": {
    "wholesaleFee": 0.1,
    "wholesaleRate": 0.15,
    "customerFee": 0.2,
    "customerRate": 0.25
  },
  "mobile": {
    "wholesaleFee": 0.1,
    "wholesaleRate": 0.5,
    "customerFee": 0.2,
    "customerRate": 0.75
  },
  "special": {
    "wholesaleFee": 0.2,
    "wholesaleRate": 0.5,
    "customerFee": 0.2,
    "customerRate": 0.6
  }
}

Errors

Error code	Message	Description
422	id	Country code is not valid
404	not_found	Destination not found
404	product	Product not found or not a rateplan product
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents