API Message Reference

XL - ExternalRouterDecision

Layer Management
Direction From CallGem
Type of Service CG
Interface ID MA
Message Purpose CallGem is requesting that an external application registered to route or screen outbound calls performs its screening
Example XL\TDdefault\CNVaijo\SIdefault_0001_00001337\TXApp_Vaijo_1200\CL02071110000\TN02071113333\TV5
Explanation CallGem is asking the external router identified by transaction tag App_Vaijo_1200 to screen the session with CLI 02071110000 and number to dial 02071113333, and has set a 5 second response timeout.
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 that the specified session should be routed to.
CL CallingLineIdentity string false 1 80 The CLI to be presented when this number is dialed. If passed in this message, will override the default CLI passed on on Make Call. Any value passed here must be a valid address terminating to your equipment.
CN CampaignName string false 1 80 The campaign to filter for outbound routing. If not passed, the router is an 'all campaigns' router.
DT Data struct false 1 128000 Contains the list of options (as an XML/JSON object) that can be paired with the specified agent/ call.
SI SessionIdentifier string false 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.
TV TimeoutValue int true 1 10 The number of seconds after which the call screening request will be deemed to be passed by CallGem.
YA AgentUniqueId string false 1 80 Provides an internally generated unique session id for the agent identified in the AN parameter.
YS SessionUUID string false 20 50 Each media session has a universally unique identifier assigned on creation. The UUID can be used by telephony layer messaging as an alternative unique form of reference to the SI parameter.

 

Copyright © 2004 - 2019  Sytel Limited