API Message Reference

DR - Data Return

Layer Agent
Direction From CallGem
Type of Service CG
Interface ID AG
Message Purpose This message returns requested line-of-business data for a call.
Example DR\CNCustCare\SI1234\AN2\RS0\DTCONTACT_ID~Y~1234|SURNAME~N~Doe|FORENAME~N~John
Explanation CallGem reports to Agent 2 that session the agent is connected to has an exact match in the database, and passes the line-of-business data to the agent.
Notes
Last Changed 10.0.0.62
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
DT Data struct false 1 128000 If RS=0 indicating a successful match the DT parameter will contain additional data to assist in finding the required record. This parameter is application-dependent and will be reflected via the Campaign layer DL message. If using Softdial Campaign Manager the data parameter should be formatted as specified inXML Framing.
RS ResourceStatus int true 0 4 This parameter may have the following values:
0Successful, Exact Match
1No record Match
2Multiple Matches
3Query Failure
4Query Timeout
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.

 

Copyright © 2004 - 2019  Sytel Limited