API Message Guide

FF - Force Failed

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose This diagnostic message is sent to the CampaignManager layer to put the campaign into database failure mode.
Example CM:DE:FF\TDdefault\CY1\OIxyz
Explanation The client is putting campaign with ID 1 into 'database failed' mode. This message is used to test database failure recovery within CM.
Notes See also SDMP (Softdial Message Protocol)
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CY CampaignIdentifier int true 0 9999 A unique integer ID for the campaign, which can be extracted from the Status Broadcast 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