Table of Contents

API : Special destination List

Introduction

This request will return a list of special destinations: Danish service numbers (e.g. 90-numbers) with their own connection fee and pr. minute rate.

Request

URL https://api.telecomx.dk/destination/special
Method GET
Access level VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN, ADMIN.
Query prefix [optional] Numeric prefix that the special destinations must start with. A +45 is prepended when sent without a leading +. Ignored if not valid.
offset [optional] Index of the first special destination to return, default 0.
limit [optional] The number of special destinations to return, default 100, min 1, max 1000.

Query examples

https://api.telecomx.dk/destination/special
https://api.telecomx.dk/destination/special?prefix=90
https://api.telecomx.dk/destination/special?offset=100&limit=50

Response

JSON object
offset Index of the first special destination returned.
limit Number of special destinations to return. Note that the actual number returned may be lower.
total Number of special destinations that can be returned when offset and limit is not considered. This is to be used for paging through the data.
destinations Array of special destinations, see definition below.
Special destination object (JSON)
_id String Prefix of the Danish special number, e.g. +459095.
name String Name of the service offered.
fee Number Connection fee.
rate Number Pr. minute rate.
vatExemption Boolean True if the call is VAT free.

Example

{
  "offset": 0,
  "limit": 100,
  "total": 2,
  "destinations": [
    {
      "_id": "+4590123456",
      "name": "Example fundraising show",
      "fee": 1.5,
      "rate": 0.5,
      "vatExemption": true
    },
    {
      "_id": "+4590200000",
      "name": "Example support hotline",
      "fee": 2,
      "rate": 1.25,
      "vatExemption": false
    }
  ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>