Outbound Routes

API for browsing, adding, editing and deleting Outbound Routes.

URLs

GET /System/OutboundRoutes
Return a list of Outbound Routes.
GET /System/OutboundRoutes/{OutboundRouteId}
Return a specific Outbound Route.
POST /System/OutboundRoutes
Create a new Outbound Route.
PUT /System/OutboundRoutes
Update an existing Outbound Route.
DELETE /System/OutboundRoutes/{OutboundRouteId}
Delete the specified Outbound Route.

References

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

Notes

Outbound Route Object

{
  "OutboundRouteId": 0,
  "NodeName": "",
  "OutboundRouteName": "",
  "Origin": "",
  "TrimPrefix": "",
  "AddPrefix": "",
  "AddSuffix": "",
  "CallOrigination": "",
  "DestinationDeviceId": 0,
  "CodecClassId": 0,
  "CostScheduleId": 0,
  "CostScheduleName": "",
  "Port": 0,
  "CpmIncompleteTimer": 0,
  "DelaySingleStageEarlyMedia": false,
  "CarrierPrefix": "",
  "RedirectType": "rtTalkingSip",
  "PrefixDelimiter": "",
  "PrefixLength": 0,
  "StripPrefix": false,
  "Enabled": false,
  "Description": "",
  "Realms": [],
  "Notes": ""
}

Table Definition

OUTBOUND_ROUTES

Outbound Routes are entries that specify an outbound device, along with formatting information, to be used to route outbound calls to different destinations. Outbound Routes, and their list entries in the Route_Groups table, 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.

Field Name	Type	Size	Description
OUTBOUND_ROUTE_ID	int	-	Primary key.
NODE_NAME	varchar	25	Node Name associated with this outbound route.
OUTBOUND_ROUTE_NAME	varchar	40	Name of this outbound route.
ORIGIN	varchar	40	Origin of inbound call.
TRIM_PREFIX	varchar	40	Specifies the digit or series of digits that are stripped off of the front of the destination number before it is dialed by the outbound device.
ADD_PREFIX	varchar	40	Specifies a digit or a series of digits that are added in front of the destination number before it is dialed by the outbound device.
ADD_SUFFIX	varchar	40	Specifies additional digits that are added to the end of the destination number before it is dialed by the outbound device.
CALL_ORIGINATION	varchar	100	Specifies how the outbound call is identified to the terminating device - the device that is ultimately going to answer or process this call on the far side.
DESTINATION_DEVICE_ID	smallint	-	Foreign key into DEVICES table that references the device on which outbound calls will be processed by this given Outbound Route.
CODEC_CLASS_ID	smallint	-	Foreign key into the CODEC_CLASSES table.
COST_SCHEDULE_ID	smallint	-	Foreign key into the COST_SCHEDULES table used for outbound costing.
PORT	int	-	Specifies the SIP signaling port to be used when communicating with the Destination Device (default: 5060).
CPM_INCOMPLETE_TIMER	tinyint	-	Specifies the number of seconds to wait for a provisional response (e.g. 100 TRYING or 180 RINGING) from an endpoint before returning an 'INCOMPLETE' that can then be used to select an alternate route if the Route Group that is being used to service the call has more than one Outbound Route associated with it. Set this value to zero (0) to disable this timer.
DELAY_SINGLE_STAGE_EARLY_MEDIA	bit	-	Indicates whether a 183 will be proxied to the inbound call leg during a single stage call.
CARRIER_PREFIX	varchar	20	Carrier prefix used to identify this outbound route for use by a redirect server.
REDIRECT_TYPE	tinyint	-	Foreign key into the REDIRECT_TYPES table. This value determines how Talking SIP will process 302 Redirect Messages.
PREFIX_DELIMITER	varchar	4	Optional value to be used as the delimiter when parsing the list of destinations returned by a redirect server.
STRIP_PREFIX	bit	-	If true, use the value specified in the PREFIX_DELIMITER to remove strip digits from the list of destinations returned by the redirect server.
ENABLED	bit	-	Specifies whether or not this Outbound Route is enabled for use. 0 – Disabled 1 – Enabled
DESCRIPTION	varchar	40	Description of this outbound route.
REALMS	varchar	1024	Specifies the realms/domains that will be used, and the order that they will be searched, when trying to locate registered users.
NOTES	varchar	1024	Used to add or specify any additional information about this Outbound Route so that the information is available for future reference.