API Message Reference

RX - Register External Router

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose This message indicates to CallGem that an application wants to register as a router for inbound or outbound calls, filtered by tenant or campaign.
Example RX\TDdefault\CNVaijo\OB\TXApp_Vaijo_1200\CP10
Notes See External Routing.
introduced V10.6.769
Parameters
Code Name Type Mandatory? Min Val Max Val Description
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 / \ : * ? " < > | & % + ! ' ;
CP CallPriority int false 0 1000000 The priority of the router relative to other routers.
Routers that simply make address modifications for LCR/ billing prefixes/ suffixes should set this value to less than 10000.
Routers that perform DNC screening should set this value to more than 10000.
FS ForceScreening boolean false 0 0 Forces screening of all outbound calls that match the tenant/ campaign, not just those calls marked to screen against specific routers.
GA GroupAddress string false 1 80 From V10.7.1401 - The queue to filter for inbound queue routing. If not passed, then the campaign filter or the tenant presides.
IB Inbound boolean false 0 0 From V10.7.1401 - To register as an external router for inbound queues. If neither IB nor OB are specified, the router will be deemed to be performing DNC screening
IO InboundOffering boolean false 0 0 From V10.7.1401 - Used to register a router for Inbound queue processing of newly-enqueued calls.
OB Outbound boolean false 0 0 From V10.7.1401 - To register as an external router for outbound (Predictive) campaigns, when determining which agent to assign a connected call. If neither IB nor OB are specified, the router will be deemed to be performing DNC screening
RX RouteExternal boolean false 0 0 From V10.7.1401 - The RX parameter is used to identify the router as an inbound routing table router for either landlord or tenant-level route requests.
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
TX TransactionIdentifier string true 1 87 Used by CallGem to uniquely identify this router.

 

Copyright © 2004 - 2019  Sytel Limited