Open topic with navigation

API Message Reference

CZ - Campaign Data

Layer Management
Direction From CallGem
Type of Service CG
Interface ID MA
Message Purpose This message is sent by CallGem to report Campaign status information in response to an Enumerate Campaigns [EC] request.
Example CZ\TXABC001\TDdefault\CNCustCare\YC{...}\ZC1\ZO0\TS40575.511171\DM0
Explanation CallGem is informing the control application, in response to request ABC001, that the CustCare campaign on the default tenant is currently running.
Notes CallGem sends a Campaign Data [CZ] message for each campaign included in the Enumerate Campaigns [EC] request. Each time a campaign changes state, it will send this message with the updated state, and will continue to do so until an Enumerate End [EE] message is received.

For on overview of the query process, see Resilience Measures.

The YC parameter was added with V10.5 to support the requirement for a Campaign unique session id.

Parameters
Code Name Type Mandatory? Min Val Max Val Description
AT AbandonCallTarget double false 1 20

From V10.7.625 - If this parameter is

  • present - it must have a value in the range 1 - 5%, specified in the form x.y. Examples are 1.0, 3.45, 4.931
  • not present - the default target is 1.
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
DM DialingMethod int true 0 102 If this parameter is not present, the default is 0. Note these values are not the same as the Campaign Type values used by Campaign Manager - See Campaign Properties XML
0Predictive
1Redundant, reverts to 0
2Manual Outbound (From V10.6.341)
3Progressive
4Preview (Open Progressive)
5Inbound
6Agentless
7Inbound On Hook (From V10.6.341)
101System
L1 CallRecordingLabel1 string false 0 80 There are 6 label names - L1 to L6. This parameter may include any characters.
L2 CallRecordingLabel2 string false 0 80 As above
L3 CallRecordingLabel3 string false 0 80 As above
L4 CallRecordingLabel4 string false 0 80 As above
L5 CallRecordingLabel5 string false 0 80 As above
L6 CallRecordingLabel6 string false 0 80 As above
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 OLE Automation date format. When sent in the CZ 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.
TZ TimeZone string false 1 80 From V10.6.263 - This parameter may be in numeric and/or alpha form and will be used to report results by time zones.
YC CampaignUniqueId string false 1 80 Provides an internally generated unique session id for the campaign identified in the CN parameter.
ZC CampaignState int true 0 2
0 Stopped
1 Running
2 Suspended
3 Abend (Abnormal End)
4 Stopping
5 No Further Database Transactions for this campaign
ZO OldState int true 0 2
0 Stopped
1 Running
2 Suspended
3 Abend (Abnormal End)
4 Stopping
5 No Further Database Transactions for this campaign

 

Copyright © 2004 - 2019  Sytel Limited