Destinations API

get listing

GET /api/rest/admin/routing/destinations

Parameters

Name Description
filter[id] id filter
filter[external-id] external id filter
filter[prefix] prefix filter
filter[rate-group-id] rate group id filter
filter[enabled-eq] enabled eq filter
filter[enabled-not-eq] enabled not eq filter
filter[prefix-eq] prefix eq filter
filter[prefix-not-eq] prefix not eq filter
filter[prefix-cont] prefix cont filter
filter[prefix-start] prefix start filter
filter[prefix-end] prefix end filter
filter[prefix-in] prefix in filter
filter[prefix-not-in] prefix not in filter
filter[prefix-cont-any] prefix cont any filter
filter[next-rate-eq] next rate eq filter
filter[next-rate-not-eq] next rate not eq filter
filter[next-rate-gt] next rate gt filter
filter[next-rate-gteq] next rate gteq filter
filter[next-rate-lt] next rate lt filter
filter[next-rate-lteq] next rate lteq filter
filter[next-rate-in] next rate in filter
filter[next-rate-not-in] next rate not in filter
filter[connect-fee-eq] connect fee eq filter
filter[connect-fee-not-eq] connect fee not eq filter
filter[connect-fee-gt] connect fee gt filter
filter[connect-fee-gteq] connect fee gteq filter
filter[connect-fee-lt] connect fee lt filter
filter[connect-fee-lteq] connect fee lteq filter
filter[connect-fee-in] connect fee in filter
filter[connect-fee-not-in] connect fee not in filter
filter[initial-interval-eq] initial interval eq filter
filter[initial-interval-not-eq] initial interval not eq filter
filter[initial-interval-gt] initial interval gt filter
filter[initial-interval-gteq] initial interval gteq filter
filter[initial-interval-lt] initial interval lt filter
filter[initial-interval-lteq] initial interval lteq filter
filter[initial-interval-in] initial interval in filter
filter[initial-interval-not-in] initial interval not in filter
filter[next-interval-eq] next interval eq filter
filter[next-interval-not-eq] next interval not eq filter
filter[next-interval-gt] next interval gt filter
filter[next-interval-gteq] next interval gteq filter
filter[next-interval-lt] next interval lt filter
filter[next-interval-lteq] next interval lteq filter
filter[next-interval-in] next interval in filter
filter[next-interval-not-in] next interval not in filter
filter[dp-margin-fixed-eq] dp margin fixed eq filter
filter[dp-margin-fixed-not-eq] dp margin fixed not eq filter
filter[dp-margin-fixed-gt] dp margin fixed gt filter
filter[dp-margin-fixed-gteq] dp margin fixed gteq filter
filter[dp-margin-fixed-lt] dp margin fixed lt filter
filter[dp-margin-fixed-lteq] dp margin fixed lteq filter
filter[dp-margin-fixed-in] dp margin fixed in filter
filter[dp-margin-fixed-not-in] dp margin fixed not in filter
filter[dp-margin-percent-eq] dp margin percent eq filter
filter[dp-margin-percent-not-eq] dp margin percent not eq filter
filter[dp-margin-percent-gt] dp margin percent gt filter
filter[dp-margin-percent-gteq] dp margin percent gteq filter
filter[dp-margin-percent-lt] dp margin percent lt filter
filter[dp-margin-percent-lteq] dp margin percent lteq filter
filter[dp-margin-percent-in] dp margin percent in filter
filter[dp-margin-percent-not-in] dp margin percent not in filter
filter[initial-rate-eq] initial rate eq filter
filter[initial-rate-not-eq] initial rate not eq filter
filter[initial-rate-gt] initial rate gt filter
filter[initial-rate-gteq] initial rate gteq filter
filter[initial-rate-lt] initial rate lt filter
filter[initial-rate-lteq] initial rate lteq filter
filter[initial-rate-in] initial rate in filter
filter[initial-rate-not-in] initial rate not in filter
filter[reject-calls-eq] reject calls eq filter
filter[reject-calls-not-eq] reject calls not eq filter
filter[use-dp-intervals-eq] use dp intervals eq filter
filter[use-dp-intervals-not-eq] use dp intervals not eq filter
filter[valid-from-eq] valid from eq filter
filter[valid-from-not-eq] valid from not eq filter
filter[valid-from-gt] valid from gt filter
filter[valid-from-gteq] valid from gteq filter
filter[valid-from-lt] valid from lt filter
filter[valid-from-lteq] valid from lteq filter
filter[valid-from-in] valid from in filter
filter[valid-from-not-in] valid from not in filter
filter[valid-till-eq] valid till eq filter
filter[valid-till-not-eq] valid till not eq filter
filter[valid-till-gt] valid till gt filter
filter[valid-till-gteq] valid till gteq filter
filter[valid-till-lt] valid till lt filter
filter[valid-till-lteq] valid till lteq filter
filter[valid-till-in] valid till in filter
filter[valid-till-not-in] valid till not in filter
filter[external-id-eq] external id eq filter
filter[external-id-not-eq] external id not eq filter
filter[external-id-gt] external id gt filter
filter[external-id-gteq] external id gteq filter
filter[external-id-lt] external id lt filter
filter[external-id-lteq] external id lteq filter
filter[external-id-in] external id in filter
filter[external-id-not-in] external id not in filter
filter[asr-limit-eq] asr limit eq filter
filter[asr-limit-not-eq] asr limit not eq filter
filter[asr-limit-gt] asr limit gt filter
filter[asr-limit-gteq] asr limit gteq filter
filter[asr-limit-lt] asr limit lt filter
filter[asr-limit-lteq] asr limit lteq filter
filter[asr-limit-in] asr limit in filter
filter[asr-limit-not-in] asr limit not in filter
filter[acd-limit-eq] acd limit eq filter
filter[acd-limit-not-eq] acd limit not eq filter
filter[acd-limit-gt] acd limit gt filter
filter[acd-limit-gteq] acd limit gteq filter
filter[acd-limit-lt] acd limit lt filter
filter[acd-limit-lteq] acd limit lteq filter
filter[acd-limit-in] acd limit in filter
filter[acd-limit-not-in] acd limit not in filter
filter[short-calls-limit-eq] short calls limit eq filter
filter[short-calls-limit-not-eq] short calls limit not eq filter
filter[short-calls-limit-gt] short calls limit gt filter
filter[short-calls-limit-gteq] short calls limit gteq filter
filter[short-calls-limit-lt] short calls limit lt filter
filter[short-calls-limit-lteq] short calls limit lteq filter
filter[short-calls-limit-in] short calls limit in filter
filter[short-calls-limit-not-in] short calls limit not in filter
filter[quality-alarm-eq] quality alarm eq filter
filter[quality-alarm-not-eq] quality alarm not eq filter
filter[uuid-eq] uuid eq filter
filter[uuid-not-eq] uuid not eq filter
filter[uuid-in] uuid in filter
filter[uuid-not-in] uuid not in filter
filter[dst-number-min-length-eq] dst number min length eq filter
filter[dst-number-min-length-not-eq] dst number min length not eq filter
filter[dst-number-min-length-gt] dst number min length gt filter
filter[dst-number-min-length-gteq] dst number min length gteq filter
filter[dst-number-min-length-lt] dst number min length lt filter
filter[dst-number-min-length-lteq] dst number min length lteq filter
filter[dst-number-min-length-in] dst number min length in filter
filter[dst-number-min-length-not-in] dst number min length not in filter
filter[dst-number-max-length-eq] dst number max length eq filter
filter[dst-number-max-length-not-eq] dst number max length not eq filter
filter[dst-number-max-length-gt] dst number max length gt filter
filter[dst-number-max-length-gteq] dst number max length gteq filter
filter[dst-number-max-length-lt] dst number max length lt filter
filter[dst-number-max-length-lteq] dst number max length lteq filter
filter[dst-number-max-length-in] dst number max length in filter
filter[dst-number-max-length-not-in] dst number max length not in filter
filter[reverse-billing-eq] reverse billing eq filter
filter[reverse-billing-not-eq] reverse billing not eq filter
filter[profit-control-mode-id-eq] profit control mode id eq filter
filter[profit-control-mode-id-not-eq] profit control mode id not eq filter
filter[profit-control-mode-id-gt] profit control mode id gt filter
filter[profit-control-mode-id-gteq] profit control mode id gteq filter
filter[profit-control-mode-id-lt] profit control mode id lt filter
filter[profit-control-mode-id-lteq] profit control mode id lteq filter
filter[profit-control-mode-id-in] profit control mode id in filter
filter[profit-control-mode-id-not-in] profit control mode id not in filter
filter[rate-policy-id-eq] rate policy id eq filter
filter[rate-policy-id-not-eq] rate policy id not eq filter
filter[rate-policy-id-gt] rate policy id gt filter
filter[rate-policy-id-gteq] rate policy id gteq filter
filter[rate-policy-id-lt] rate policy id lt filter
filter[rate-policy-id-lteq] rate policy id lteq filter
filter[rate-policy-id-in] rate policy id in filter
filter[rate-policy-id-not-in] rate policy id not in filter
filter[rateplan-id-eq] rateplan id eq filter
filter[country-id-eq] country id eq filter

Request

Headers

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

Route

GET /api/rest/admin/routing/destinations

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/"a08ac35ed757ed250e35f431100cf06f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 73466fc2-8ff0-4e05-949d-bcd099fb3603
X-Runtime: 0.008914
Content-Length: 2392

Status

200 OK

Body

{
  "data": [
    {
      "id": "4201536",
      "type": "destinations",
      "links": {
        "self": "http://example.org/api/rest/admin/routing/destinations/4201536"
      },
      "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-13T09:55:59.645Z",
        "valid-till": "2024-11-15T09:55:59.645Z",
        "external-id": 6,
        "routing-tag-ids": [

        ],
        "dst-number-min-length": 0,
        "dst-number-max-length": 100,
        "reverse-billing": false,
        "profit-control-mode-id": 2,
        "rate-policy-id": 1
      },
      "relationships": {
        "country": {
          "links": {
            "self": "http://example.org/api/rest/admin/routing/destinations/4201536/relationships/country",
            "related": "http://example.org/api/rest/admin/routing/destinations/4201536/country"
          }
        },
        "network": {
          "links": {
            "self": "http://example.org/api/rest/admin/routing/destinations/4201536/relationships/network",
            "related": "http://example.org/api/rest/admin/routing/destinations/4201536/network"
          }
        }
      }
    },
    {
      "id": "4201537",
      "type": "destinations",
      "links": {
        "self": "http://example.org/api/rest/admin/routing/destinations/4201537"
      },
      "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-13T09:55:59.671Z",
        "valid-till": "2024-11-15T09:55:59.671Z",
        "external-id": 7,
        "routing-tag-ids": [

        ],
        "dst-number-min-length": 0,
        "dst-number-max-length": 100,
        "reverse-billing": false,
        "profit-control-mode-id": 2,
        "rate-policy-id": 1
      },
      "relationships": {
        "country": {
          "links": {
            "self": "http://example.org/api/rest/admin/routing/destinations/4201537/relationships/country",
            "related": "http://example.org/api/rest/admin/routing/destinations/4201537/country"
          }
        },
        "network": {
          "links": {
            "self": "http://example.org/api/rest/admin/routing/destinations/4201537/relationships/network",
            "related": "http://example.org/api/rest/admin/routing/destinations/4201537/network"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/routing/destinations?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/routing/destinations?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}