Tenant Trunking Capacity

Display tenant’s trunking capacity

GET /api/v1/tenants/(string: tenant_id)/features/trunk_groups/

Retrieve the Trunking Capacity of a Tenant

Example request:

GET /api/v1/tenants/foo/features/trunk_groups/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "maxActiveCalls": {
      "unlimited": false,
      "maximum": 16
   },
   "burstingMaxActiveCalls": {
      "unlimited": false,
      "maximum": 1
   }
}
Response JSON Object:

  • maxActiveCalls (object) – the maximum number of concurrent active trunk calls. See Unlimited_Integer.

  • disableCallingLineIdDelivery (object) – the maximum number of trunk calls that could be done on top of the maximum active calls. They could be tagged differently in CDR. See Unlimited_Integer.

Status Codes:

Update tenant’s trunking capacity

PUT /api/v1/tenants/(string: tenant_id)/features/trunk_groups/

Update the Trunking Capacity of a Tenant.

Example request:

PUT /api/v1/tenants/foo/features/trunk_groups/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "maxActiveCalls": {
      "unlimited": false,
      "maximum": 16
   },
   "burstingMaxActiveCalls": {
      "unlimited": true
   }
}
Request JSON Object:

  • maxActiveCalls (optional) (object) – the maximum number of concurrent active trunk calls. See Unlimited_Integer.

  • burstingMaxActiveCalls (optional) (object) – the maximum number of trunk calls that could be done on top of the maximum active calls. They could be tagged differently in CDR. See Unlimited_Integer.

Example response:

Response:

Similar to GET instance method response.

Status Codes: