API Message Guide

LR - Listen Request

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose A request to monitor an agent.
Example LR\CNCustCare\AN1\A22\BL\ON
Explanation Agent 1 is requesting to monitor agent 2 in 'blind' mode.
Notes BL parameter 'true' = request that monitored agent is not notified.

CH parameter "true" = request that monitoring agent may communicate with monitored agent.

The agent to be monitored must be logged in to a campaign.
Parameters
Code Name Type Mandatory? Min Val Max Val Description
A2 MonitoredAgent string 1 80 The agent to be monitored.
User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
AN AgentIdentifier string 1 80 Monitoring Agent
BL Blind boolean false 0 0 Request 'Blind' monitoring.
If "true" the monitored agent is not aware that they are being monitored.
If "false" a Monitor Notify [MN] message is sent to notify the monitored agent of their monitoring state.
CH Coaching boolean false 0 0 Request 'Coaching' mode. If "true" the monitoring agent can communicate (coach) the monitored agent.
CN CampaignName string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
ON OnOff boolean false 0 0 On parameter
QI TurretIdentifier string false 1 80 From V10.6.341. Deprecated V10.6.706. Mutually exclusive with AN Parameter. If the turret ID is specified, CallGem will treat this as a request for the current login session to listen to the second agent. User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TK Token string false 1 80 Token parameter