Tenant Trunking¶

Retrieve the list of tenant’s trunk instances¶

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

Retrieve the list of tenant’s trunk instances.

Example request:

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

Example response:

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

{
   "tenantTrunks": [
      {
         "name": "ApioEntTest_Trunk_modified",
         "routingMode": "ordered"
      }
   ]
}

Response JSON Object:

name (list) – the list of Tenant Trunk objects as defined as Tenant Trunk Instance in List.

Status Codes:

200 OK – no error
404 Not Found – not found

Retrieve a tenant’s trunk instance¶

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

Retrieve a tenant’s trunk instance.

Example request:

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

Example response:

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

{
   "maximumRerouteAttempts": 5,
   "routeExhaustionAction": "None",
   "orderedRouting": {
      "trunkGroups": [
         {
            "groupId": "ApioEntGrpTest",
            "name": "APIO_Trunk_Group_Existing"
         }
      ]
   }
}

Response JSON Object:

maximumRerouteAttempts (integer) – the maximum number of reroute attempts within an enterprise trunk.
routeExhaustionAction (string) – the Trunk Route Exhaustion Action. See Tenant Trunk Route Exhaustion Action.
routeExhaustionDestination (string) – (conditional) Phone Number or SIP URI that will be called in case of the routes are exhausted and the action is Forward
orderedRouting (object) – (conditional) an orderedRouting object defined as Tenant Trunk Ordered Routing.
priorityWeightedRouting (object) – (conditional) an priorityWeightedRouting object defined as Tenant Trunk Priority Weighted Routing.
enableCapacityManagement (boolean) – (optional) enable capacity management.
maxActiveCalls (integer) – (optional) the maximum number of concurrent active trunk calls.
capacityExceededTrapInitialCalls (integer) – (optional) An SNMP trap will be sent when the number of counted events crosses this threshold value.
capacityExceededTrapOffsetCalls (integer) – (optional) Subsequent SNMP traps will be sent after the initial trap each time the number of counted events increases by this value since the last trap.

Note:

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

Status Codes:

200 OK – no error
404 Not Found – not found

Create a tenant’s trunk¶

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

Create a new tenant’s trunk.

Example request:

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

{
   "name": "ApioEntTest_Trunk",
   "maximumRerouteAttempts": 5,
   "orderedRouting": {
      "trunkGroups": [
         {
            "groupId": "ApioEntGrpTest",
            "name": "APIO_Trunk_Group_Existing"
         }
      ]
   }
}

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

{
   "name": "ApioEntTest_Trunk",
   "maximumRerouteAttempts": 5,
   "priorityWeightedRouting": {
      "trunkGroups": [
         {
            "trunkGroup" :{
               "groupId": "ApioEntGrpTest",
               "name": "APIO_Trunk_Group_Existing"
            },
            "priority": 1,
            "weight": 1
         }
      ]
   }
}

Request JSON Object:

name (string) – the name of the enterprise trunk.
maximumRerouteAttempts (integer) – the maximum number of reroute attempts within an enterprise trunk.
routeExhaustionAction (string) – the Trunk Route Exhaustion Action. See Tenant Trunk Route Exhaustion Action.
routeExhaustionDestination (string) – (conditional) Phone Number or SIP URI that will be called in case of the routes are exhausted and the action is Forward
orderedRouting (object) – (conditional) an orderedRouting object defined as Tenant Trunk Ordered Routing.
priorityWeightedRouting (object) – (conditional) an priorityWeightedRouting object defined as Tenant Trunk Priority Weighted Routing.
enableCapacityManagement (boolean) – (required) enable capacity management.
maxActiveCalls (integer) – (optional) the maximum number of concurrent active trunk calls. Note: Maximum active calls allowed shall not exceed the enterprise available licenses of 3.
capacityExceededTrapInitialCalls (integer) – (optional) An SNMP trap will be sent when the number of counted events crosses this threshold value.
capacityExceededTrapOffsetCalls (integer) – (optional) Subsequent SNMP traps will be sent after the initial trap each time the number of counted events increases by this value since the last trap.

Note:

When routeExhaustionAction is set to Forward, routeExhaustionForwardAddress is mandatory.

Note:

Is mandatory one of orderedRouting OR priorityWeightedRouting.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

201 Created – no error

Update a tenant’s trunk instance¶

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

Update a new tenant’s trunk.

Example request:

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

{
   "name": "ApioEntTest_Trunk_modified",
   "maximumRerouteAttempts": 10,
   "routeExhaustionAction": "Forward",
   "routeExhaustionDestination": "test_trunk@netaxis.be",
   "orderedRouting": {
      "orderingAlgorithm": "Overflow"
   }
}

Request JSON Object:

name (string) – (optional) the new name of the enterprise trunk.
maximumRerouteAttempts (integer) – (optional) the maximum number of reroute attempts within an enterprise trunk.
routeExhaustionAction (string) – (optional) the Trunk Route Exhaustion Action. See Tenant Trunk Route Exhaustion Action.
routeExhaustionDestination (string) – (conditional) Phone Number or SIP URI that will be called in case of the routes are exhausted and the action is Forward .
orderedRouting (object) – (conditional) an orderedRouting object defined as Tenant Trunk Ordered Routing.
priorityWeightedRouting (object) – (conditional) an priorityWeightedRouting object defined as Tenant Trunk Priority Weighted Routing.
enableCapacityManagement (boolean) – (optional) enable capacity management.
maxActiveCalls (integer) – (optional) the maximum number of concurrent active trunk calls. Note: Maximum active calls allowed shall not exceed the enterprise available licenses of 3.
capacityExceededTrapInitialCalls (integer) – (optional) An SNMP trap will be sent when the number of counted events crosses this threshold value.
capacityExceededTrapOffsetCalls (integer) – (optional) Subsequent SNMP traps will be sent after the initial trap each time the number of counted events increases by this value since the last trap.

Note:

When routeExhaustionAction is set to Forward, routeExhaustionForwardAddress is mandatory.

Note:

Is mandatory one of orderedRouting OR priorityWeightedRouting.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error

Delete a tenant’s trunk instance¶

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

Example request:

DELETE /api/v1/tenants/foo/services/trunk_groups/ApioEntTest_Trunk/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{}

Example response:

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

{}

Status Codes:

200 OK – no error

Retrieves tenant’s trunking available trunk group list¶

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

Retrieve the list of tenant’s available trunk groups.

Example request:

GET /api/v1/tenants/foo/services/trunk_groups/available/trunks/ HTTP/1.1
Host: example.com

Response JSON Object:

responseSizeLimit (integer) – See responseSizeLimit from Search criteria.
sensitiveGroupIdStarts (string) – See sensitiveGroupIdStarts from Search criteria.
sensitiveGroupIdContains (string) – See sensitiveGroupIdContains from Search criteria.
sensitiveGroupIdEquals (string) – See sensitiveGroupIdEquals from Search criteria.
insensitiveGroupIdStarts (string) – See insensitiveGroupIdStarts from Search criteria.
insensitiveGroupIdContains (string) – See insensitiveGroupIdContains from Search criteria.
insensitiveGroupIdEquals (string) – See insensitiveGroupIdEquals from Search criteria.
sensitiveTrunkGroupNameStarts (string) – See sensitiveTrunkGroupNameStarts from Search criteria.
sensitiveTrunkGroupNameContains (string) – See sensitiveTrunkGroupNameContains from Search criteria.
sensitiveTrunkGroupNameEquals (string) – See sensitiveTrunkGroupNameEquals from Search criteria.
insensitiveTrunkGroupNameStarts (string) – See insensitiveTrunkGroupNameStarts from Search criteria.
insensitiveTrunkGroupNameContains (string) – See insensitiveTrunkGroupNameContains from Search criteria.
insensitiveTrunkGroupNameEquals (string) – See insensitiveTrunkGroupNameEquals from Search criteria.

Example response:

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

{
   "trunk_groups": [
      {
         "groupId": "ApioEntGrpTest",
         "name": "APIO_Trunk_Group_Existing"
      }
   ]
}

Response JSON Object:

trunk_groups (array) – a list of objects as defined in Tenant Trunk Group.

Status Codes:

200 OK – no error

Tenant Trunk Ordered Routing¶

Name	Type	Method	Method	Method	Description
Name	Type	GET	POST	PUT	Description
orderingAlgorithm	String	A	O	O	The ordering algorithm
trunkGroups	Array	A	A	O	A list of unique trunk groups objects as defined by Tenant Trunk Group

Tenant Trunk Priority Weighted Routing¶

Name	Type	Method	Method	Method	Description
Name	Type	GET	POST	PUT	Description
maximumRerouteAttemptsWithinPriority	Integer	A	O	O	The maximum number of reroute attempts within a tenant trunk.
trunkGroups	Array	A	A	O	A list of unique trunk groups sd defined by Tenant Trunk Group Priority Trunk Group Entry.

Tenant Trunk Group¶

Name	Type	Method	Method	Method	Description
Name	Type	GET	POST	PUT	Description
groupId	String	A	A	A	The group id
name	String	A	A	A	The name

Tenant Trunk Group List Entry¶

Name	Type	Method	Method	Method	Description
Name	Type	GET	POST	PUT	Description
trunkGroup	Object	A	A	O	The trunk group. See Tenant Trunk Group.

Tenant Trunk Group Priority Trunk Group Entry¶

Name	Type	Method	Method	Method	Description
Name	Type	GET	POST	PUT	Description
trunkGroup	Object	A	A	O	The trunk group. See Tenant Trunk Group.
priority	Integer	A	A	O	The priority of this TG, the lower the more priority (1-10).
weight	Integer	A	A	O	The weight of the TG inside this priority.

Tenant Trunk Instance in List¶

Name	Type	Method	Method	Method	Description
Name	Type	GET	POST	PUT	Description
name	String	A	O	O	The name of the tenant trunk.
routingMode	String	A	A	O	The routing mode. See Tenant Trunk Routing Mode.

Tenant Trunk Routing Mode¶

Value from:
* ordered,
* weighted.

Tenant Trunk Route Exhaustion Action¶

Value from:
* Forward,
* None.