SR - Status Request

Layer	Campaign Manager
Direction	To CallGem
Type of Service	CM
Interface ID	DE
Message Purpose	The Status Request message requests a list of campaigns and their status from Campaign Manager.
Example	CM:DE:SR\TDdefault\TXhello\TK123\OIxyz
Explanation	A client requests broadcast of campaign status, with transaction tag 'Hello'. The campaign status information is returned in the Status Broadcast [SB] message.
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. The XML data in the DT parameter is returned in the following format: <CampaignStatus Time="2009-10-27T08:45:27Z"> <Campaign ID="1" Name="Campaign1" State="0" Type="6" Cache="0" LinkMaster="" IsLocked="false" LockTag="" LockTime="" Agents="0" CallsMade="4166" ListRemaining="0" ListTotal="0" RunoutEstimate="0"/> <Campaign ID="2" Name="Sample" State="2" Type="0" Cache="306" LinkMaster="" IsLocked="false" LockTag="" LockTime="" Agents="0" CallsMade="1530" ListRemaining="9591" ListTotal="10000" RunoutEstimate="9591"/> </CampaignStatus>

Parameters
Code	Name	Type	Mandatory?	Min Val	Max Val	Description
LD	LevelOfDetail	int	false	1	2	From 10.6.841 & V10.7.1047 - Level of Detail. Determines which parameters are included in the SB messages. 1 - (default) Only includes the tenant time and timezone information. 2 - Include a digest of status for each of the campaigns configured for the tenant See also the Status Broadcast [SB] message.
OI	OriginatorID	string	true	1	255	Originator ID. A token identifying the originator of the message. The Originator ID (OI) parameter does not need to be specified if using the RouterNet method and event API. RouterNet appends the Originator ID by default.
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.
TK	Token	string	false	1	80	Token parameter
TV	TimeoutValue	int	false	1	3600	From V10.6.849 & V10.7.1226 - The frequency with which status changes are broadcast, in seconds. This value sets the time between updates. This defaults to 10 seconds if not passed.
TX	TransactionIdentifier	string	true	1	87	Transaction identifier.