Route Groups

API for browsing, adding, editing and deleting Route Groups.

URLs

• GET /System/RouteGroups
  Return a list of Route Groups.

• GET /System/RouteGroups/{RouteGroupId}
  Return a specific Route Group.

• POST /System/RouteGroups
  Create a new Route Group.

• PUT /System/RouteGroups
  Update an existing Route Group.

• DELETE /System/RouteGroups/{RouteGroupId}
  Delete the specified Route Group.

References

Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource
Outbound Routes

Notes

When returning a list of Route Groups, AvailableRoutes and AssignedRoutes will return a list of the actual Outbound Routes that are available/assigned to this Route Group.

When adding/updating a Route Group, the API will ignore whatever you specified in the RoutePath and will rebuild it based exclusively on the OutboundRouteId field of each element in the AssignedRoutes array (other fields are ignored). The AvailableRoutes field will also be ignored.

Route Group Object

{
  "RouteGroupId": 0,
  "RouteGroupName": "",
  "RoutePath": "",
  "AssignedRoutes": [],
  "AvailableRoutes": []
}

Table Definition

OUTBOUND_ROUTES

Route Groups are collections of entries that specify the outbound routes that will be used to terminate a call. Route Groups are created to allow traffic to be directed in a predictable and desirable fashion, perhaps from the cheapest, least reliable route to the most expensive but most reliable route.