API Message Reference

SW - Start Wrap

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose This message informs CallGem that a particular agent has just finished talking to a called party, and has gone into wrap mode.
Example SW\AN2
Explanation The agent with identifier 2 has just finished talking to a called party, and is now in wrap mode.
Notes If there is wrap, this message should be sent as soon as talking has finished.

Whether or not there is wrap, the agent application will always send a Transaction Complete [TC] message, on call completion. See especially The Outbound Calling Cycle.

Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
AO AgentOutcome int false 0 9999 From V10.6.365 - This parameter must always have a numeric value associated with it, with a range from 0 to 9999.
See Agent Outcomes for details of how to use this parameter.
CN CampaignName string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
EX ExternalAddress string false 1 80 The external address the CTI layer should be asked to transfer the session to as an alternative method of call disconnection. Note this is unvalidated and passed through to the telephony layer directly.
PM PlayMessage string false 1 80 This parameter is alphanumeric and may contain parameter data which is a symbolic name relating to the sound fragement. The symbolic name is validated against what is in Softdial RepositorySounds.

The parameter data may be omitted. In the case where the data is omitted the sound played will be the default 'call completion' sound referenced in Softdial RepositorySounds.

QI UserIdentifier string false 1 80 From V10.7.28 - Mutually exclusive with AN Parameter. If the user ID is specified, CallGem will treat this as a request to hang up the call for the current active login session. 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

 

Copyright © 2004 - 2019  Sytel Limited