Dialpeers API

update values

PUT /api/rest/admin/dialpeers/:id

Parameters

Name Description
data[type] Resource type (dialpeers)
data[id] Dialpeer ID
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

Request

Headers

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

Route

PUT /api/rest/admin/dialpeers/1376793

Body

{"data":{"type":"dialpeers","id":1376793,"attributes":{"capacity":20}}}

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/"44962a022802cffc913ac80659ded8ab"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 38bdc6e7-0f67-4854-9f2b-7001be09bccd
X-Runtime: 0.029999
Content-Length: 2366

Status

200 OK

Body

{
  "data": {
    "id": "1376793",
    "type": "dialpeers",
    "links": {
      "self": "http://example.org/api/rest/admin/dialpeers/1376793"
    },
    "attributes": {
      "enabled": true,
      "next-rate": "0.0",
      "connect-fee": "0.0",
      "initial-rate": "0.0",
      "initial-interval": 60,
      "next-interval": 60,
      "valid-from": "2024-03-02T14:35:30.084Z",
      "valid-till": "2024-03-22T14:35:30.084Z",
      "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": 20,
      "lcr-rate-multiplier": "1.0",
      "force-hit-rate": null,
      "network-prefix-id": null,
      "created-at": "2024-03-12T14:35:30.151Z",
      "short-calls-limit": 1.0,
      "external-id": 9,
      "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/1376793/relationships/gateway",
          "related": "http://example.org/api/rest/admin/dialpeers/1376793/gateway"
        }
      },
      "gateway-group": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376793/relationships/gateway-group",
          "related": "http://example.org/api/rest/admin/dialpeers/1376793/gateway-group"
        }
      },
      "routing-group": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376793/relationships/routing-group",
          "related": "http://example.org/api/rest/admin/dialpeers/1376793/routing-group"
        }
      },
      "vendor": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376793/relationships/vendor",
          "related": "http://example.org/api/rest/admin/dialpeers/1376793/vendor"
        }
      },
      "account": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376793/relationships/account",
          "related": "http://example.org/api/rest/admin/dialpeers/1376793/account"
        }
      },
      "routing-tag-mode": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376793/relationships/routing-tag-mode",
          "related": "http://example.org/api/rest/admin/dialpeers/1376793/routing-tag-mode"
        }
      },
      "routeset-discriminator": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376793/relationships/routeset-discriminator",
          "related": "http://example.org/api/rest/admin/dialpeers/1376793/routeset-discriminator"
        }
      },
      "dialpeer-next-rates": {
        "links": {
          "self": "http://example.org/api/rest/admin/dialpeers/1376793/relationships/dialpeer-next-rates",
          "related": "http://example.org/api/rest/admin/dialpeers/1376793/dialpeer-next-rates"
        }
      }
    }
  }
}