API Message Guide

CN - Callback Notify

Layer Management
Direction From CallGem
Type of Service CG
Interface ID MA
Message Purpose This message is sent to the control application by CallGem to advise that a callback will become due soon
Example CN\TDdefault\CNsystem\ANpolly\SIdefault_0001_00001234\TXABC001\TS4397.666667\TW297\TV300
Explanation A callback is due in 297 seconds time for agent polly on campaign MyCampaign. The session will remain queued for a further 300 seconds after the due time, after which it will be returned undialed if polly does not log on to an outbouned campaign.
Notes
Introduced 10.5.330 & 10.6.196
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string true 1 80 This may include any characters except "\".
CN CampaignName string true 1 80 This may include any characters except "\".
SI SessionIdentifier string true 1 120 Used to give each called party a unique key.
TD TenantDescriptor string false 1 80 If the tenant descriptor is passed any callback handshaking will be filtered by a specific tenant. If passed, the tenant descriptor _will_ be validated.
TK Token string false 1 80 Token parameter
TS TimeStamp double true 1 50 This parameter follows the Windows OLE Automation date format. When sent in the CN message it indicates the exact time that the event was processed by CallGem.
TV TimeoutValue int false 1 3600 The number of seconds following the callback due time the system will wait for an agent before returning the callback undialed.
TW TimeWindow int false 1 1440 Indicates the number of seconds following send of this message that the callback is due.
TX TransactionIdentifier string true 1 87 Used by subsequent messages from CallGem to identify the corresponding request. Must be unique across all requests.