Group Trunking Capacity

Display group’s trunking capacity

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

Get the details about the trunking capacity of the group.

Authorization rights: minimum Group Admin.

Example request:

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

Example response:

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

{
   "maxActiveCalls": 10,
   "burstingMaxActiveCalls": {
      "unlimited": false,
      "maximum": 0
   },
   "maxAvailableActiveCalls": {
      "unlimited": false,
      "maximum": 9999
   },
   "burstingMaxAvailableActiveCalls": {
      "unlimited": false,
      "maximum": 9999
   }
}
Response JSON Object:

  • maxActiveCalls (integer) – the maximum number of concurrent active trunk calls.

  • burstingMaxActiveCalls (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.

  • maxAvailableActiveCalls (object) – the maximum permissible active trunk group calls for the group. See Unlimited_Integer.

  • burstingMaxAvailableActiveCalls (object) – the bursting maximum permissible active trunk group calls for the group. See Unlimited_Integer.

Status Codes:

Update group’s trunking capacity

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

Update the details about the trunking capacity of the group.

Authorization rights: minimum Tenant Admin.

Example request:

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

{
   "maxActiveCalls": 5,
   "burstingMaxActiveCalls": {
      "unlimited": false,
      "maximum": 100
   }
}
Response JSON Object:

  • maxActiveCalls (optional) (integer) – the maximum number of concurrent active trunk calls.

  • 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.

Response:

Similar to GET instance method response.

Status Codes: