Tenant Trunking

Retrieve the list of tenant’s trunk instances

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

The API is mapped to EnterpriseEnterpriseTrunkGetListRequest.

Retrieve a tenant’s trunk instance

GET /api/v1/tenants/(string: tenant_id)/services/trunk_groups/(string: instance_name)/

The API is mapped to EnterpriseEnterpriseTrunkGetRequest.

Additional restrictions

Is returned only one from orderedRouting OR priorityWeightedRouting based on the settings.

Create a tenant’s trunk

POST /api/v1/tenants/(string: tenant_id)/services/trunk_groups/

The API is mapped to EnterpriseEnterpriseTrunkAddRequest.

Additional restrictions

Response JSON Object:

  • routeExhaustionAction (string) – Value from “None”, “Forward”. When routeExhaustionAction is set to Forward, routeExhaustionForwardAddress is mandatory.

  • orderingAlgorithm (string) – Value from “Ordered Load Balancing”, “Overflow”, “Most Idle”, “Least Idle”.

  • maxActiveCalls (string) – Value in range 1 - 10 (only from OCI Rel 21).

  • capacityExceededTrapInitialCalls (string) – Value >= 0 (only from OCI Rel 21).

  • capacityExceededTrapOffsetCalls (string) – Value >= 0 (only from OCI Rel 21).

Note:

When orderedRouting trunk group:

Update a tenant’s trunk instance

PUT /api/v1/tenants/(string: tenant_id)/services/trunk_groups/(string: instance_name)/

The API is mapped to EnterpriseEnterpriseTrunkModifyRequest.

Additional restrictions

Response JSON Object:

  • routeExhaustionAction (string) – Value from “None”, “Forward”. When routeExhaustionAction is set to Forward, routeExhaustionForwardAddress is mandatory.

  • orderingAlgorithm (string) – Value from “Ordered Load Balancing”, “Overflow”, “Most Idle”, “Least Idle”.

  • maxActiveCalls (string) – Value in range 1 - 10 (only from OCI Rel 21).

  • capacityExceededTrapInitialCalls (string) – Value >= 0 (only from OCI Rel 21).

  • capacityExceededTrapOffsetCalls (string) – Value >= 0 (only from OCI Rel 21).

Note:

When orderedRouting trunk group:

Delete a tenant’s trunk instance

DELETE /api/v1/tenants/(string: tenant_id)/services/trunk_groups/(string: instance_name)/

The API is mapped to EnterpriseEnterpriseTrunkDeleteRequest.

Display tenant’s trunking available trunk list

GET /api/v1/tenants/(string: tenant_id)/services/trunk_groups/available/trunks/

The API is mapped to EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest.