Dialpeers API

get listing

GET /api/rest/admin/dialpeers

Parameters

Name Description
filter[id] id filter
filter[external-id] external id filter
filter[prefix] prefix filter
filter[routing-group-id] routing group id filter
filter[enabled-eq] enabled eq filter
filter[enabled-not-eq] enabled not eq 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-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[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[reverse-billing-eq] reverse billing eq filter
filter[reverse-billing-not-eq] reverse billing 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[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[src-rewrite-rule-eq] src rewrite rule eq filter
filter[src-rewrite-rule-not-eq] src rewrite rule not eq filter
filter[src-rewrite-rule-cont] src rewrite rule cont filter
filter[src-rewrite-rule-start] src rewrite rule start filter
filter[src-rewrite-rule-end] src rewrite rule end filter
filter[src-rewrite-rule-in] src rewrite rule in filter
filter[src-rewrite-rule-not-in] src rewrite rule not in filter
filter[src-rewrite-rule-cont-any] src rewrite rule cont any filter
filter[dst-rewrite-rule-eq] dst rewrite rule eq filter
filter[dst-rewrite-rule-not-eq] dst rewrite rule not eq filter
filter[dst-rewrite-rule-cont] dst rewrite rule cont filter
filter[dst-rewrite-rule-start] dst rewrite rule start filter
filter[dst-rewrite-rule-end] dst rewrite rule end filter
filter[dst-rewrite-rule-in] dst rewrite rule in filter
filter[dst-rewrite-rule-not-in] dst rewrite rule not in filter
filter[dst-rewrite-rule-cont-any] dst rewrite rule cont any 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[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[src-rewrite-result-eq] src rewrite result eq filter
filter[src-rewrite-result-not-eq] src rewrite result not eq filter
filter[src-rewrite-result-cont] src rewrite result cont filter
filter[src-rewrite-result-start] src rewrite result start filter
filter[src-rewrite-result-end] src rewrite result end filter
filter[src-rewrite-result-in] src rewrite result in filter
filter[src-rewrite-result-not-in] src rewrite result not in filter
filter[src-rewrite-result-cont-any] src rewrite result cont any filter
filter[dst-rewrite-result-eq] dst rewrite result eq filter
filter[dst-rewrite-result-not-eq] dst rewrite result not eq filter
filter[dst-rewrite-result-cont] dst rewrite result cont filter
filter[dst-rewrite-result-start] dst rewrite result start filter
filter[dst-rewrite-result-end] dst rewrite result end filter
filter[dst-rewrite-result-in] dst rewrite result in filter
filter[dst-rewrite-result-not-in] dst rewrite result not in filter
filter[dst-rewrite-result-cont-any] dst rewrite result cont any filter
filter[locked-eq] locked eq filter
filter[locked-not-eq] locked not eq filter
filter[priority-eq] priority eq filter
filter[priority-not-eq] priority not eq filter
filter[priority-gt] priority gt filter
filter[priority-gteq] priority gteq filter
filter[priority-lt] priority lt filter
filter[priority-lteq] priority lteq filter
filter[priority-in] priority in filter
filter[priority-not-in] priority not in filter
filter[exclusive-route-eq] exclusive route eq filter
filter[exclusive-route-not-eq] exclusive route not eq filter
filter[capacity-eq] capacity eq filter
filter[capacity-not-eq] capacity not eq filter
filter[capacity-gt] capacity gt filter
filter[capacity-gteq] capacity gteq filter
filter[capacity-lt] capacity lt filter
filter[capacity-lteq] capacity lteq filter
filter[capacity-in] capacity in filter
filter[capacity-not-in] capacity not in filter
filter[lcr-rate-multiplier-eq] lcr rate multiplier eq filter
filter[lcr-rate-multiplier-not-eq] lcr rate multiplier not eq filter
filter[lcr-rate-multiplier-gt] lcr rate multiplier gt filter
filter[lcr-rate-multiplier-gteq] lcr rate multiplier gteq filter
filter[lcr-rate-multiplier-lt] lcr rate multiplier lt filter
filter[lcr-rate-multiplier-lteq] lcr rate multiplier lteq filter
filter[lcr-rate-multiplier-in] lcr rate multiplier in filter
filter[lcr-rate-multiplier-not-in] lcr rate multiplier not in filter
filter[force-hit-rate-eq] force hit rate eq filter
filter[force-hit-rate-not-eq] force hit rate not eq filter
filter[force-hit-rate-gt] force hit rate gt filter
filter[force-hit-rate-gteq] force hit rate gteq filter
filter[force-hit-rate-lt] force hit rate lt filter
filter[force-hit-rate-lteq] force hit rate lteq filter
filter[force-hit-rate-in] force hit rate in filter
filter[force-hit-rate-not-in] force hit rate 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[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

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MzE1Nzg3NTQsInN1YiI6ODV9.0vX3LsPb-6UhmuqiMUh43FGIgcpk390rnPZWWlEbuQw
Host: example.org
Cookie: 

Route

GET /api/rest/admin/dialpeers

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/"92bc6de6eb5f5b1a27b80ebb127fd955"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 3b8ec245-af21-4aa4-bb76-34bef02ad688
X-Runtime: 0.011152
Content-Length: 5480

Status

200 OK

Body

{
  "data": [
    {
      "id": "1376789",
      "type": "dialpeers",
      "links": {
        "self": "http://example.org/api/rest/admin/dialpeers/1376789"
      },
      "attributes": {
        "enabled": true,
        "next-rate": "0.0",
        "connect-fee": "0.0",
        "initial-rate": "0.0",
        "initial-interval": 60,
        "next-interval": 60,
        "valid-from": "2024-11-04T09:55:54.389Z",
        "valid-till": "2024-11-24T09:55:54.389Z",
        "prefix": "",
        "src-rewrite-rule": null,
        "dst-rewrite-rule": null,
        "acd-limit": 0.0,
        "asr-limit": 0.0,
        "src-rewrite-result": null,
        "dst-rewrite-result": null,
        "locked": false,
        "priority": 100,
        "exclusive-route": false,
        "capacity": 1,
        "lcr-rate-multiplier": "1.0",
        "force-hit-rate": null,
        "network-prefix-id": null,
        "created-at": "2024-11-14T09:55:54.462Z",
        "short-calls-limit": 1.0,
        "external-id": 6,
        "routing-tag-ids": [

        ],
        "dst-number-min-length": 0,
        "dst-number-max-length": 100,
        "reverse-billing": false
      },
      "relationships": {
        "gateway": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376789/relationships/gateway",
            "related": "http://example.org/api/rest/admin/dialpeers/1376789/gateway"
          },
          "data": null
        },
        "gateway-group": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376789/relationships/gateway-group",
            "related": "http://example.org/api/rest/admin/dialpeers/1376789/gateway-group"
          },
          "data": {
            "type": "gateway-groups",
            "id": "8"
          }
        },
        "routing-group": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376789/relationships/routing-group",
            "related": "http://example.org/api/rest/admin/dialpeers/1376789/routing-group"
          },
          "data": {
            "type": "routing-groups",
            "id": "27"
          }
        },
        "vendor": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376789/relationships/vendor",
            "related": "http://example.org/api/rest/admin/dialpeers/1376789/vendor"
          },
          "data": {
            "type": "contractors",
            "id": "70"
          }
        },
        "account": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376789/relationships/account",
            "related": "http://example.org/api/rest/admin/dialpeers/1376789/account"
          },
          "data": {
            "type": "accounts",
            "id": "74"
          }
        },
        "routing-tag-mode": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376789/relationships/routing-tag-mode",
            "related": "http://example.org/api/rest/admin/dialpeers/1376789/routing-tag-mode"
          },
          "data": {
            "type": "routing-tag-modes",
            "id": "0"
          }
        },
        "routeset-discriminator": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376789/relationships/routeset-discriminator",
            "related": "http://example.org/api/rest/admin/dialpeers/1376789/routeset-discriminator"
          },
          "data": {
            "type": "routeset-discriminators",
            "id": "7"
          }
        },
        "dialpeer-next-rates": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376789/relationships/dialpeer-next-rates",
            "related": "http://example.org/api/rest/admin/dialpeers/1376789/dialpeer-next-rates"
          }
        }
      }
    },
    {
      "id": "1376790",
      "type": "dialpeers",
      "links": {
        "self": "http://example.org/api/rest/admin/dialpeers/1376790"
      },
      "attributes": {
        "enabled": true,
        "next-rate": "0.0",
        "connect-fee": "0.0",
        "initial-rate": "0.0",
        "initial-interval": 60,
        "next-interval": 60,
        "valid-from": "2024-11-04T09:55:54.472Z",
        "valid-till": "2024-11-24T09:55:54.472Z",
        "prefix": "",
        "src-rewrite-rule": null,
        "dst-rewrite-rule": null,
        "acd-limit": 0.0,
        "asr-limit": 0.0,
        "src-rewrite-result": null,
        "dst-rewrite-result": null,
        "locked": false,
        "priority": 100,
        "exclusive-route": false,
        "capacity": 1,
        "lcr-rate-multiplier": "1.0",
        "force-hit-rate": null,
        "network-prefix-id": null,
        "created-at": "2024-11-14T09:55:54.534Z",
        "short-calls-limit": 1.0,
        "external-id": 7,
        "routing-tag-ids": [

        ],
        "dst-number-min-length": 0,
        "dst-number-max-length": 100,
        "reverse-billing": false
      },
      "relationships": {
        "gateway": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376790/relationships/gateway",
            "related": "http://example.org/api/rest/admin/dialpeers/1376790/gateway"
          },
          "data": null
        },
        "gateway-group": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376790/relationships/gateway-group",
            "related": "http://example.org/api/rest/admin/dialpeers/1376790/gateway-group"
          },
          "data": {
            "type": "gateway-groups",
            "id": "9"
          }
        },
        "routing-group": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376790/relationships/routing-group",
            "related": "http://example.org/api/rest/admin/dialpeers/1376790/routing-group"
          },
          "data": {
            "type": "routing-groups",
            "id": "28"
          }
        },
        "vendor": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376790/relationships/vendor",
            "related": "http://example.org/api/rest/admin/dialpeers/1376790/vendor"
          },
          "data": {
            "type": "contractors",
            "id": "71"
          }
        },
        "account": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376790/relationships/account",
            "related": "http://example.org/api/rest/admin/dialpeers/1376790/account"
          },
          "data": {
            "type": "accounts",
            "id": "75"
          }
        },
        "routing-tag-mode": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376790/relationships/routing-tag-mode",
            "related": "http://example.org/api/rest/admin/dialpeers/1376790/routing-tag-mode"
          },
          "data": {
            "type": "routing-tag-modes",
            "id": "0"
          }
        },
        "routeset-discriminator": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376790/relationships/routeset-discriminator",
            "related": "http://example.org/api/rest/admin/dialpeers/1376790/routeset-discriminator"
          },
          "data": {
            "type": "routeset-discriminators",
            "id": "8"
          }
        },
        "dialpeer-next-rates": {
          "links": {
            "self": "http://example.org/api/rest/admin/dialpeers/1376790/relationships/dialpeer-next-rates",
            "related": "http://example.org/api/rest/admin/dialpeers/1376790/dialpeer-next-rates"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/dialpeers?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/dialpeers?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}