API Message Guide

UO - Update Outcomes

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose This message is sent by the control application to CallGem to update an incoming call route
Example UO\TDdefault\CNSample\TN01296381200\RE98\TXUpdate00001
Explanation The control application is updating an incoming call route GarryMail to routes all sessions with destanation address garryp@sytelco.com to a queue named spamfilter.
Last Changed 10.2.0.50
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AO AgentOutcome int false 0 9999 The agent disposition to be applied. Either the AO parameter or RE parameter may be specified, but not both.
AS ApplicationSpecificData string false 1 4000 Application Specific parameter. In this case is used to contain the record key, as per CM use of the AS parameter.
CN CampaignName string false 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CO Conversion string false 1 50 The CO parameter allows a numeric value, of up to six digits to be sent, indicating the scale of the conversion or commitment, e.g. CO20.99, meaning say a pledge of $20.99 The parameter may be positive or negative.
DT Data string true 1 128000 This parameter may be used to pass line-of-business data to be updated in the customer record. Data should be framed as per Campaign Manager's XML schema.
RE Reason int true 0 999 This code indicates the outcome of all calls whether successful or not.
0 Call not made. Reasons for this will include - end of shift, a request by the agent application to return the number in the Remove Number [RN] message, and value in Planned Time (PT) parameter (see Make Call [MC] message) has been exceeded whilst campaign suspended.
1Busy
2No Answer
3Fax
4Modem
5Answering machine
6Call failure. e.g. on account of network load, phone offhook, dead line
7Abandoned call
8Call interrupted by telephony layer (e.g. switch)
9 The call was timed out and not made because the switch did not respond to a Call Initiate [CI] message
10Connected: i.e. a call, of whatever type (live call, answering machine, etc), that was transferred to an agent
20Telephone number unobtainable
21Telephone number out of order
22Telephone number changed
23Incoming calls barred
24Call rejected - e.g. non standard device such as videophone, would not accept call
25Not in use - e.g. number has been disconnected
26Fast busy - e.g. unable to access the number through its local exchange because of network congestion
27Hi and dry - no information about why call did not get through, in the US especially associated with the absence of SIT tones.
30Other
31 Called party hang-up (available only when using Switch-Determined Routing): the call has been connected, but the called party has hung up during the interval allowed before CallGem must abandon the call. This interval is specified in the Abandoned Call Delay (DE) parameter of the Overdial Tuning [OT] and Call Initiate [CI] messages.
32Agent specified for agent specific call back is not logged in
SR SuccessRate int false 0 100 Whether or not a live call results in any kind of financial commitment, users may wish to record a success rating for reporting purposes. An example of its use might be in market research, as a way of recording the success of an interview in terms of numbers of questions answered. Allowable values are any integer value between 0 and 100.
TD TenantDescriptor string false 1 80 Optional when operating in Multi-Tenancy. Otherwise it must not be used. This parameter is alphanumeric and identifies to which tenant this message applies.
TK Token string false 1 80 Token parameter
TN TelephoneNumber string false 0 80 Either the TN or the SI parameter must be used to identify the called party. Session Identifiers.
TX TransactionIdentifier string true 1 87 Used by CallGem to identify to which request this message is responding. Must be unique across all requests.