API Message Reference

TC - Transaction Complete

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose This message tells CallGem that the specified agent has completed all phases of a call.
Example TC\AN2\AO101\SR50
Explanation The agent with identifier 2 has completed both the talk phase as well as the wrap phase (if there is one) of a call. In Softdial RepositoryAgent Outcomes, code '101' is defined as a call to be rescheduled.

The SR parameter allows an agent application to specify a success rate for a call. This need not just be for a live call. For example, in the case of this rescheduled call, success might be defined in terms of how quickly the next call will be made, whether the call is being made to the same person, or whether an agreement to commit then is expected or promised.

Notes Unless CallGem now immediately sends an Agent Free [AF] message (in response to an outstanding Agent Unavailable [AU] request from the agent application, to make this agent unavailable), the agent is now immediately available to take another call.
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string   1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
AO AgentOutcome int false 0 9999 This parameter must always have a numeric value associated with it, with a range from 0 to 9999. See Agent Outcomes for details of how to use this parameter.

From V10.6.944 -

  1. For preview calls not launched, the AO must resolve to outcome category Not Made (1)
  2. For all calls launched, the AO must not resolve to the following outcome categories:
    • Not Made (1)
    • Abandon (2)
    • Host Interrupt (3)
    • Timeout(4)
    • Planned Not Made (13)
    • Inbound Drop (15)
    • Inbound Abandon (16)
BA RingBackAgent string false 1 80 The agent identifier of the agent that will be talking to the customer.
BN RingBackNumber string false 1 80 The telephone number that will be dialed.
BT RingBackTimer string false 1 50 This parameter follows the OLEDateTime format.
CN CampaignName string 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.
CU ConversionUnsuccessful int false 0 99 Legacy Conversion Unsuccessful parameter.
Re-Introduced with V9.1.0.33
DT Data struct false 1 128000 Use this parameter to pass data back to the application server on completion of a call.
MD MediaData string false 1 128000 From V10.7.324 - Data used to build up conversation history for a session
NL NotLive int false 0 99 Legacy Not Live parameter.
Re-Introduced with V9.1.0.33
QI UserIdentifier string false 1 80 From V10.7.28 - Mutually exclusive with AN Parameter. If the user ID is specified, CallGem will treat this as a request to complete transaction for the current active login session. User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
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.
T1 CallRecordingTag1 string false 0 80 There are 6 parameter tags- T1 to T6.

The T(n) parameters represent tags that will be stored against any call recordings made for a call session. There are three points at which the user can specify tag data:

T2 CallRecordingTag2 string false 0 80 See above
T3 CallRecordingTag3 string false 0 80 See above
T4 CallRecordingTag4 string false 0 80 See above
T5 CallRecordingTag5 string false 0 80 See above
T6 CallRecordingTag6 string false 0 80 See above
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

 

Copyright © 2004 - 2019  Sytel Limited