Destinations API

create new entry

POST /api/rest/admin/routing/destinations

Parameters

Name Description
data[type] Resource type (destinations)
data[attributes][enabled] Enabled
data[attributes][next-rate] Next rate
data[attributes][connect-fee] Connect fee
data[attributes][initial-interval] Initial interval
data[attributes][next-interval] Next interval
data[attributes][dp-margin-fixed] Dp margin fixed
data[attributes][dp-margin-percent] Dp margin percent
data[attributes][initial-rate] Initial rate
data[attributes][asr-limit] Asr limit
data[attributes][acd-limit] Acd limit
data[attributes][short-calls-limit] Short calls limit
data[attributes][prefix] Prefix
data[attributes][reject-calls] Reject calls
data[attributes][use-dp-intervals] Use dp intervals
data[attributes][valid-from] Valid from
data[attributes][valid-till] Valid till
data[attributes][external-id] External id
data[attributes][routing-tag-ids] Routing tag ids
data[attributes][dst-number-min-length] Dst number min length
data[attributes][dst-number-max-length] Dst number max length
data[attributes][reverse-billing] Reverse billing
data[attributes][profit-control-mode-id] Profit control mode id
data[attributes][rate-policy-id] Rate policy id
data[relationships][rate-group] Rate group
data[relationships][routing-tag-modes] Routing tag modes

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MzE1Nzg3NTksInN1YiI6MTYyfQ.hBcmAzqe3-FjGTnRwUx_ZeDuC8rdYkObV0P5UrHuGxc
Host: example.org
Cookie: 

Route

POST /api/rest/admin/routing/destinations

Body

{"data":{"type":"destinations","attributes":{"enabled":true,"next-rate":0,"connect-fee":0,"initial-interval":60,"next-interval":60,"dp-margin-fixed":0,"dp-margin-percent":0,"initial-rate":0,"dst-number-min-length":0,"dst-number-max-length":100,"reverse-billing":true,"profit-control-mode-id":2,"rate-policy-id":1},"relationships":{"rate-group":{"data":{"type":"rate-groups","id":9}}}}}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"361b85e9d8753f9eb5ee40c3c5b8dfee"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 25937c01-5647-442f-a96f-fc4d54b50ae0
X-Runtime: 0.021010
Content-Length: 1082

Status

201 Created

Body

{
  "data": {
    "id": "4201539",
    "type": "destinations",
    "links": {
      "self": "http://example.org/api/rest/admin/routing/destinations/4201539"
    },
    "attributes": {
      "enabled": true,
      "next-rate": "0.0",
      "connect-fee": "0.0",
      "initial-interval": 60,
      "next-interval": 60,
      "dp-margin-fixed": "0.0",
      "dp-margin-percent": "0.0",
      "initial-rate": "0.0",
      "asr-limit": 0.0,
      "acd-limit": 0.0,
      "short-calls-limit": 0.0,
      "prefix": "",
      "reject-calls": false,
      "use-dp-intervals": false,
      "valid-from": "2024-11-14T09:55:59.830Z",
      "valid-till": "2029-11-14T09:55:59.830Z",
      "external-id": null,
      "routing-tag-ids": [

      ],
      "dst-number-min-length": 0,
      "dst-number-max-length": 100,
      "reverse-billing": true,
      "profit-control-mode-id": 2,
      "rate-policy-id": 1
    },
    "relationships": {
      "country": {
        "links": {
          "self": "http://example.org/api/rest/admin/routing/destinations/4201539/relationships/country",
          "related": "http://example.org/api/rest/admin/routing/destinations/4201539/country"
        }
      },
      "network": {
        "links": {
          "self": "http://example.org/api/rest/admin/routing/destinations/4201539/relationships/network",
          "related": "http://example.org/api/rest/admin/routing/destinations/4201539/network"
        }
      }
    }
  }
}