SB - Status Broadcast

Layer

Campaign Manager

Direction

From CallGem

Type of Service

Interface ID

Message Purpose

Status Broadcast

Example

CM:DE:SB\TDTenant1\DT<xml data .../>

Explanation

CallGem is asking Campaign Manager server to send an XML file containing information about the status of all campaigns known to it.

Notes

This message is deprecated, and the response is limited to the first 500 campaigns configured for a tenant. Third party integrators are encouraged to use the Enumerate Status [ES] and Status Data [SD] message pairs.

The client application should parse the XML and store the information for cross-reference purposes; particularly important is the fact that the data contains a cross-reference between campaign names and campaign IDs. The CM interface relies on IDs as the unique form of reference for a campaign.

From 10.6.841 & V10.7.1047 - The xml data in the DT parameter is returned depending on the setting of the Level of Detail (LD) parameter in the Status Request [SR] message.

LD1 example (low level of detail):

CM:DE:SB\TDdefault\TX3\DT<CampaignStatus Time="2018-02-08T12:41:53+02:00" TenantTZ="GTB Standard Time"/>\TS43139.445749

LD2 example (high level of detail):

CM:DE:SB\TDdefault\TX1\DT<CampaignStatus Time="2018-02-08T12:40:32+02:00" TenantTZ="GTB Standard Time"><Campaign ID="1" Name="Mobiles" State="0" Type="0" MediaType="" Cache="0" LinkMaster="" IsLocked="false" LockTag="" Agents="0" CallsMade="3" ListRemaining="0" ListTotal="0" RunoutEstimate="0" RetriesRemaining="0" PPState="0"/><Campaign ID="2" Name="test" State="0" Type="3" MediaType="" Cache="0" LinkMaster="" IsLocked="false" LockTag="" Agents="0" CallsMade="1" ListRemaining="0" ListTotal="0" RunoutEstimate="0" RetriesRemaining="0" PPState="0"/></CampaignStatus>\TS43139.444820

The State value for each campaign is defined as follows:

Value	State
0	Closed
1	Opening
2	Open
3	Suspended
4	Awaiting Suspend (Both)
5	Awaiting Suspend (Campaign)
6	Awaiting Suspend (Database)
7	Awaiting Close (Both)
8	Awaiting Close (Campaign)
9	Awaiting Close (Database)
10	Preprocessing
11	Resetting Tables
999	Unused

Parameters
Code	Name	Type	Mandatory?	Min Val	Max Val	Description
DT	Data	struct	false	1	128000	The DT parameter contains XML describing the status of all campaigns known to this instance of CM
TD	TenantDescriptor	string	true	1	80	Mandatory when operating in Multi-Tenancy. Otherwise it must not be used. This parameter is alphanumeric and identifies to which tenant this message applies. Typically contains a company name.