API Message Guide

EO - Enumerate Outcomes

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose This message is sent by the application to Softdial in order to provide third-party applications with information about call outcomes reported by the CT layer and/or by the call center agent.
Example EO\CNSales1\TXEOSales1\FO\SO
Explanation A transaction for delivering both success and failure notifications has been set up against campaign Sales1. For each call success or failure, CallGem will send an Outcome Data [OZ] message detailing dispositions and associated call data.
Notes

For an overview of the query process, see Resource Enumeration API

From V10.6.263 there is a change to Enumeration behaviour when using the PersistToken (PS) parameter - see Resource Enumeration API.

Last Changed Pre V9.2
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string false 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CS RateControl string false 1 1000000 From V10.6.660 - The number of event messages per second that the subscriber can handle during rollforward after re-subscribing. Defaults to 100 (per PersistToken). See Resource Enumeration API.
FO FailureOutcomes boolean false (See description) 0 0 Request notification of call failure outcomes. Either FO or SO (or both) must be specified.
MO ManagementOutcomes boolean false 0 0 Management outcomes parameter. Only for use by Campaign Manager.
PS PersistToken string false 1 80 Persist token. This tells CallGem to persist this transaction even if the socket connection from the originator fails. The transaction will buffer events in anticipation of reconnect and re-issue of the transaction.
SO SuccessOutcomes boolean false (See description) 0 0 Request notification of call success outcomes. Either FO or SO (or both) must be specified.
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
TX TransactionIdentifier string true 1 87 Used by subsequent messages from CallGem to identify the corresponding requests. Must be unique across all requests.