API Message Reference

BD - Begin Dial

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose This message is only used in 'preview (open progressive)' mode (OC with DM4). It is used to indicate that the agent is ready for the number to be dialed, or that the agent does not want to dial the number.
Example BD\TDdefault\CNCustCare\AN2
Explanation CallGem recognises that the agent is ready to dial and it starts dialing the number.
Notes This message cancels the Preview Timer set by the P1 parameter in the Overdial Tuning [OT] and Make Call [MC] messages.
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 If the DD parameter is specified, the AO parameter can be used to provide non-live classification information. In order to use this, some additional setup work is required to set up a range of non-live switch and agent dispositions to cover the various types of failures one might record in this scenario.
CN CampaignName string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
DD DontDial boolean false 0 0 Don't dial parameter. No value required.

If specified, it means that the agent does not want to dial the number.

If it is not specified, then the message signals that the agent is ready to have the call dialed.

QI TurretUserIdentifierIdentifier 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 begin dial for the active login session for theuser . 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
UE UpdateRecord boolean false 0 0 From V10.6.200 - No value required. If specified, it means that the agent wishes to update the record even though the Previewed record will not be dialled .

From V10.7.346 - parameter code has changed from UR to UE

 

Copyright © 2004 - 2019  Sytel Limited