UR - Update Record

Layer	Campaign Manager
Direction	To CallGem
Type of Service	CM
Interface ID	DE
Message Purpose	This message is sent to the CampaignManager layer requesting it update a record in the database
Example	CM:DE:UR\TDdefault\CNSales\TX1234\DTxml column data
Explanation	The client is requesting to update a database record to the 'Sales' campaign on the 'default' tenant. The record will be updated with the data in the DT param and will be available for immediate dialling
Notes	See Updating Campaign Tables. See also SDMP Message Protocol
Introduced	10.6.787 & 10.7.701

Parameters
Code	Name	Type	Mandatory?	Min Val	Max Val	Description
AN	AgentIdentifier	string	true	1	80	From 10.6.796 - Set this value to mark the record to be called by a specific agent. Setting this field marks the record as a callback. User defined parameter values may include any characters except */ \ : ? " < > \| & % + ! ' ;**
AO	AgentOutcome	int	false	0	9999	From 10.6.796 - Set this value to mark the record as having a specific agent outcome. 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.
BN	RingBackNumber	string	false	1	80	From 10.6.808 & 10.7.728 - The specific number to be dialled for callback (if overriding the regular number selection)
CA	Cause	int	true	0	999	Set this value to mark the record as having a specific telephony outcome. Note if the Planned Time (PT) parameter is specified, the record will be written with cause value -4 regardless of any setting for this parameter so that the record is processed as a callback.
CB	Callback	boolean	false	0	0	From 10.6.796 - Boolean (param exists or not) Set this parameter to explicitly mark the record as a callback. Setting the Planned Time (PT) parameter on its own marks the record as a retry rather than a callback. Callback records always reserve an agent.The CB parameter explicitly marks the update as a callback. A callback may also be implied by, for example setting both the PT and AN parameter.
CN	CampaignName	string	true (See Description)	1	80	Identifies the target campaign table by name. Either the CN or CY parameter must be passed.
CR	CompletedRecord	string	false	0	0	From 10.6.796 & 10.7.728 - The CR parameter explicitly marks the record as complete. This results in the complete timestamp on the record being set to the current time. Setting this will set the outcome time for the record, and will also mean that the PT, AN and CB parameters are ignored.
CY	CampaignIdentifier	int	true (See Description)	0	9999	From - V10.7.830 - A unique integer ID for the target campaign table, which can be extracted from the Status Broadcast message. Either the CN or CY parameter must be passed.
DT	Data	struct	true	1	128000	If other columns in the record are to be updated, the Data (DT) parameter will contain the data to be updated, in XML framing - see documentation for the Insert Record [IR] message.
PT	PlannedTime	string	false	1	50	From 10.6.796 - This is the time that the agent application is asking CallGem to make the call. The time is treated as local to the Server where CallGem resides. Set this value to set the time at which the record is to be attempted. This is a floating point number as per the Windows OLE Automation date format. If the planned time is entered in this format the time should be specified in UTC time.
TD	TenantDescriptor	string	true	1	80	Mandatory when operating in Multi-Tenancy. Otherwise it must not be used. This parameter is alphanumeric and identifies to which tenant this message applies. Typically contains a company name.
TX	TransactionIdentifier	string	true	1	87	The transaction tag that uniquely identifies this update. Either a sequence ID or a GUID should be used. Used by CallGem to identify to which request this message is responding. Must be unique across all requests.