API : Breakout List

API : Breakout List

Introduction

This request will return a breakout list with each destination and type listed with all details. A product can be specified to apply the overrides the product may hold. These may be generel connection fee override, a percentage rate discount and destination price overrides.

The list can be returned as JSON or as a CSV file.

The primary use of this API call is to get all destinations rates for import into a 3'rd party system.

Request

URL	https://api.telecomx.dk/destination/breakout
Method	GET
Access level	VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN, ADMIN.
Query	product	`[optional]` A product which may contain overrides. If so they are merged into the result.
	format	`[optional]` The format to return the result in: JSON (default) or CSV.
	prefixes	`[optional]` True to include each breakout types prefixes in the result (default), false to omit.

Query examples

https://api.telecomx.dk/destination/breakout
https://api.telecomx.dk/destination/breakout?product=123457890123457890ABCD
https://api.telecomx.dk/destination/breakout?format=CSV&prefixes=false

JSON Response

A JSON array of breakout object.

Breakout objects
countryCode	String	2-Char ISO3166 country code.
countryPrefix	String	The common prefix for the whole country, e.g. +45 for Denmark.
region	String	The region the country belongs to: HOMELAND, EU_NORDIC, REST_OF_EUROPE, WORLD1, WORLD2, WORLD3.
type	String	Type of destination: FIXED, MOBILE, SPECIAL.
prefixes	Array	List of prefixes that belongs to the breakout.
customerFee	Number	Connection fee for end customer.
customerRate	Number	Pr. minute rate for end customer.
wholesaleFee	Number	Connection fee for reseller (RESELLER only).
wholesaleRate	Number	Pr. minute rate for reseller (RESELLER only).
costFee	Number	Connection fee cost (ADMIN only).
costRate	Number	Pr. minute rate cost (ADMIN only).

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

JSON Response examples

[
  {
    countryCode: 'DE',
    countryPrefix: '+49',
    region: 'EU_NORDIC',
    prefixes: [ '+4915', '+49151', '+49152', '+491521', '+49155', '+49157', '+49159', '+4916', '+49160', '+49162', '+49163', '+49170', '+49171', '+49172', '+49173', '+49174', '+49175', '+49176', '+49177', '+49178', '+49179' ],
    type: 'MOBILE',
    costFee: 0.02,
    costRate: 0.1795,
    wholesaleFee: 0.1,
    wholesaleRate: 0.15,
    customerFee: 0.2,
    customerRate: 0.25
  },
  {
    ...
  }
]

CSV Response

The CSV file is a semicolon separated textfile with “ as a text qualifier, formatted with a header line that describes the fields, and one line pr. breakout.

Column
Country	String	Name of the country in English.
CountryCode	String	2-Char ISO3166 country code.
CountryPrefix	String	The common prefix for the whole country, e.g. +45 for Denmark.
Region	String	The region the country belongs to: HOMELAND, EU_NORDIC, REST_OF_EUROPE, WORLD1, WORLD2, WORLD3.
Type	String	Type of destination: FIXED, MOBILE, SPECIAL.
Prefixes	String	Space separated list of prefixes that belongs to the breakout.
CustomerFee	Number	Connection fee for end customer.
CustomerRate	Number	Pr. minute rate for end customer.
WholesaleFee	Number	Connection fee for reseller (RESELLER only).
WholesaleRate	Number	Pr. minute rate for reseller (RESELLER only).
CostFee	Number	Connection fee cost (ADMIN only).
CostRate	Number	Pr. minute rate cost (ADMIN only).

Errors

Error code	Message	Description
404	product	Product not found
422	product	Not a rateplan
422	format	Unknown format
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

Table of Contents