API Message Reference

XR - External Router Decision

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose This message indicates to CallGem that an external router application is returning a selection for how to route the call, and may modify the CLI and Telephone number to dial.
Example XR\TDdefault\CNVaijo\SIdefault_0001_00001337\TXApp_Vaijo_1200\RS1\CL02073338888\TN02071112222
Explanation The external router has passed any DNC screening and has updated the CLI to present (CL parameter) and the number to be dialed (TN parameter)
Notes See External Routing.
Introduced V10.6.769
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string false 1 80 The agent to which the session specified should be routed
CL CallingLineIdentity string false 1 80 The CLI to be presented when the number is dialed. If passed in this message, it will override the default CLI and the CLI passed on the Make Call [MC] message. Any value passed here must be a valid address terminating to your equipment.
CN CampaignName string true 1 80 The campaign to filter for outbound routing. If not passed, the router is an 'all campaigns' router.
User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
GA GroupAddress string false 1 80 The queue to which the session specified should be routed
RS ResourceStatus int true 0 2 This parameter may have the following values:
0DNC Screened. Do not dial this number. Do not process any more routes.
1The call has passed DNC screening and may be dialed. Other routers may further modify the addresses. If the CL and TN parameters are sent these should replace the original values passed on the Make Call [MC] message.
2The call has passed DNC screening and may be dialed. If the CL and TN parameters are sent these should replace the original values passed on the Make Call [MC] message. No other routers in the priority chain may modify the address.
SI SessionIdentifier string true 1 120 The SI parameter uniquely identifies the call. Either the SI or YS parameters must be passed to identify the call session.
TD TenantDescriptor string false 1 80

The tenant to filter for outbound routing. If not passed, the router is an 'all tenants' router.

TK Token string false 1 80 Token parameter
TN TelephoneNumber string false 0 80 Telephone Number parameter. If passed in this message, will modify the number to be dialed specified in the Make Call [MC] message.
YS SessionUniqueId string false 1 80 Each media session has a universally unique identifier assigned on creation. The SessionUniqueId can be used by telephony layer messaging as an alternative unique form of reference to the SI parameter

 

Copyright © 2004 - 2019  Sytel Limited