API Message Guide

DL - Data Lookup

Layer Campaign
Direction From CallGem
Type of Service CG
Interface ID CA
Message Purpose Request to retrieve data from a customer record
Example XML Format: DL\CNInbound\SIInbound_1\TN01296381234\DN01296381200\DT<MagicXMLDocument xmlns="http://www.sytelco.com/SCC/CM"><r><c n="Contact_ID" m="true" d="00001234" /></r></MagicXMLDocument>\XT5 Legacy Format: DL\CNInbound\SIInbound_1\TN01296381234\DN01296381200\DTCONTACT_ID~N~00001234\XT5
Explanation Campaign Manager has been asked to return data from the customer record with CONTACT_ID = 00001234.
Notes
Last Changed 10.0.0.62
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
DN DialedNumber string false 0 80 Dialed number parameter. Only specified for inbound.
DT Data string false 1 128000 This parameter may contain additional data to assist in finding the customer. 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 according to the Campaign Manager Data Protocol. See Data (DT) Parameter - XML Format page
SI SessionIdentifier string false 1 120 The session identifier for the call. Either this parameter or the TN parameter must be specified in order to uniquely identify the session.
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
TN TelephoneNumber string false 0 80 The telephone number for the call.
XT RequestTimeout int 5 60 The timeout for this message in seconds