API Message Reference

XD - Chat Data

Layer Management
Direction From CallGem
Type of Service CG
Interface ID MA
Message Purpose This message is sent by CallGem in response to an Enumerate Chat [QC] request.
Example XD\TDdefault\TXABC123\YS...\SIinbound_123\CNinbound\QIFred\ANFred.1\TS40678.445786\Z040678.445478\Z140678.445525\Z20\Z30\Z40\Z50\RS1\DT...
Explanation CallGem is informing the control application, in response to request ABC001, that A chat message has been sent from the
Notes
Introduced V10.7.697
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string false 1 80 The agent endpoint name associated with the chat session.
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
DT Data string false 1 128000 The chat data that has given rise to this event.
QI UserIdentifier string true 1 80 The user associated with the chat session
SI SessionIdentifier string true 1 120 The session identifier associated with the message.
TD TenantDescriptor struct true 1 80

This parameter is alphanumeric and identifies to which tenant this message applies.

TS TimeStamp double true 1 50 This parameter follows the Windows DATE format. This indicates the exact time that the event was processed by CallGem.
TX TransactionIdentifier string true 1 87 Used by CallGem to identify to which request this message is responding. Must be unique across all requests.
YA AgentUniqueId string false 1 80 The agent endpoint GUID associated with the chat session.
YC CampaignUniqueId string false 1 80 Provides an internally generated unique session id for the campaign identified in the CN parameter.
YS SessionUniqueId string false 1 80 Provides an internally generated unique session id for the call session identified in the SI parameter.
Z0 TimeStamp0 double true 1 50 This parameter follows the Windows DATE format. Timestamp of the previous agent-to-customer message.
Z1 TimeStamp1 double true 1 50 This parameter follows the Windows DATE format. Timestamp of the previous customer-to-agent message.
Z2 TimeStamp2 double true 1 50 This parameter follows the Windows DATE format. Timestamp of the previous customer starts typing message.
Z3 TimeStamp3 double true 1 50 This parameter follows the Windows DATE format. Timestamp of the previous customer stops typing message.
Z4 TimeStamp4 double true 1 50 This parameter follows the Windows DATE format. Timestamp of the previous agent starts typing message.
Z5 TimeStamp5 double true 1 50 This parameter follows the Windows DATE format. Timestamp of the previous agent stops typing message.

 

Copyright © 2004 - 2019  Sytel Limited