Dialpeers API

create new entry

POST /api/rest/admin/dialpeers

Parameters

Name	Description
data[type]	Resource type (dialpeers)
data[attributes][enabled]	Enabled
data[attributes][next-rate]	Next rate
data[attributes][connect-fee]	Connect fee
data[attributes][initial-rate]	Initial rate
data[attributes][initial-interval]	Initial interval
data[attributes][next-interval]	Next interval
data[attributes][valid-from]	Valid from
data[attributes][valid-till]	Valid till
data[attributes][prefix]	Prefix
data[attributes][src-rewrite-rule]	Src rewrite rule
data[attributes][dst-rewrite-rule]	Dst rewrite rule
data[attributes][acd-limit]	Acd limit
data[attributes][asr-limit]	Asr limit
data[attributes][src-rewrite-result]	Src rewrite result
data[attributes][dst-rewrite-result]	Dst rewrite result
data[attributes][locked]	Locked
data[attributes][priority]	Priority
data[attributes][exclusive-route]	Exclusive route
data[attributes][capacity]	Capacity
data[attributes][lcr-rate-multiplier]	Lcr rate multiplier
data[attributes][force-hit-rate]	Force hit rate
data[attributes][network-prefix-id]	Network prefix id
data[attributes][created-at]	Created at
data[attributes][short-calls-limit]	Short calls limit
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[relationships][routing-group]	Routing group
data[relationships][vendor]	Vendor
data[relationships][account]	Account
data[relationships][routeset-discriminator]	Routeset discriminator
data[relationships][gateway]	Gateway
data[relationships][gateway-group]	Gateway group
data[relationships][routing-tag-modes]	Routing tag modes

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjkwLCJhdWQiOlsiYWRtaW4iXSwiZXhwIjoxNzY3MzU4NTY0fQ.ipR010v7fhBo36H9Oy1OEjpbAp-Xwxr1lo5nWjezDgE
Host: example.org
Cookie: 

Route

POST /api/rest/admin/dialpeers

Body

{"data":{"type":"dialpeers","attributes":{"enabled":true,"next-rate":0.0,"initial-rate":0.0,"initial-interval":60,"next-interval":60,"valid-from":"2026-01-02T12:46:04.605+00:00","valid-till":"2027-01-02T12:46:04.605Z","dst-number-min-length":0,"dst-number-max-length":100,"reverse-billing":true},"relationships":{"routing-group":{"data":{"type":"routing-groups","id":30}},"vendor":{"data":{"type":"contractors","id":49}},"account":{"data":{"type":"accounts","id":54}},"routeset-discriminator":{"data":{"type":"routeset-discriminators","id":10}},"gateway-group":{"data":{"type":"gateway-groups","id":11}}}}}

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
location: http://example.org/api/rest/admin/dialpeers/1376792
vary: Accept
etag: W/"f541f68d99a308760ab0773d23142ab4"
cache-control: max-age=0, private, must-revalidate
x-request-id: 68e67caf-2edb-4eba-be6e-89995c1fc0b9
x-runtime: 0.023426
content-length: 2417

Status

201 Created

Body

{
  "data": {
    "id": "1376792",
    "type": "dialpeers",
    "links": {
      "self": "http://example.org/api/rest/admin/dialpeers/1376792"
    },
    "attributes": {
      "enabled": true,
      "next-rate": "0.0",
      "connect-fee": "0.0",
      "initial-rate": "0.0",
      "initial-interval": 60,
      "next-interval": 60,
      "valid-from": "2026-01-02T12:46:04.605Z",
      "valid-till": "2027-01-02T12:46:04.605Z",
      "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": null,
      "lcr-rate-multiplier": "1.0",
      "force-hit-rate": null,
      "network-prefix-id": null,
      "created-at": "2026-01-02T12:46:04.659Z",
      "short-calls-limit": 1.0,
      "external-id": null,
      "routing-tag-ids": [

      ],
      "dst-number-min-length": 0,
      "dst-number-max-length": 100,
      "reverse-billing": true,
      "routing-tag-mode-id": 0
    },
    "relationships": {
      "gateway": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376792/relationships/gateway",
          "related": "http://example.org/api/rest/admin/dialpeers/1376792/gateway"
        },
        "data": null
      },
      "gateway-group": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376792/relationships/gateway-group",
          "related": "http://example.org/api/rest/admin/dialpeers/1376792/gateway-group"
        },
        "data": {
          "type": "gateway-groups",
          "id": "11"
        }
      },
      "routing-group": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376792/relationships/routing-group",
          "related": "http://example.org/api/rest/admin/dialpeers/1376792/routing-group"
        },
        "data": {
          "type": "routing-groups",
          "id": "30"
        }
      },
      "vendor": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376792/relationships/vendor",
          "related": "http://example.org/api/rest/admin/dialpeers/1376792/vendor"
        },
        "data": {
          "type": "contractors",
          "id": "49"
        }
      },
      "account": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376792/relationships/account",
          "related": "http://example.org/api/rest/admin/dialpeers/1376792/account"
        },
        "data": {
          "type": "accounts",
          "id": "54"
        }
      },
      "routeset-discriminator": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376792/relationships/routeset-discriminator",
          "related": "http://example.org/api/rest/admin/dialpeers/1376792/routeset-discriminator"
        },
        "data": {
          "type": "routeset-discriminators",
          "id": "10"
        }
      },
      "dialpeer-next-rates": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376792/relationships/dialpeer-next-rates",
          "related": "http://example.org/api/rest/admin/dialpeers/1376792/dialpeer-next-rates"
        }
      }
    }
  }
}