API Message Reference

TZ - Turret 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 Turrets [QE] request.
Example TZ\TXABC001\TDdefault\QIUser1\RS2\OS2\ANUser1.1\DS
Explanation
Notes
Introduced V10.7.697
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
DS DetailState int true 0 99

The DS parameter is only presented in the AZ message when the Enumerate Agents [EA] message is sent with a an LevelOfDetail (LD) parameter value of 2 or 3.

0 Not logged in
1 Awaiting station tie-up
2 Logged in and not ACD available
3 Waiting for call
4 Previewing
5 Preview campaign breather
6 Talking
7 In Wrap
8 In follow-up or agent-directed preview
9 Processing call transfer
10 Being offered a call
11 Monitoring another agent
12 Waiting for call (reserved for specific call)
13 On Hold
MN NumberMediaSessions int false 1 32768 Number of media sessions in progress on this turret
NA NumberAgentSessions int false 1 32768 Number of Agent Sessions contained by this turret
NC NumberChats int false 1 32768 Number of chatr sessions in progress on this turret
OS OldState int true 0 99 As for DS parameter.
QI UserIdentifier string true 1 80 User Identifier
RS ResourceState int true 0 2 Reports User State code where:
0Not logged in
1Awaiting station tie-up
2Logged in and not ACD available
TD TenantDescriptor string false 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. When sent in the AZ message it 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 Provides an internally generated unique session id for the agent identified in the AN parameter.

 

Copyright © 2004 - 2019  Sytel Limited