On this page	1 What’s about 2 Contact Variables 3 List Variables 4 Voice Channel 4.1 Inbound Call 4.2 Outbound Call 4.3 Motion Bull 5 Chat Channel 6 Email Channel 7 SMS Channel 8 Openchannel 9 WhatsApp Channel 10 How to retrieve variable

On this page	1 What’s about 2 Contact Variables 3 List Variables 4 Voice Channel 4.1 Inbound Call 4.2 Outbound Call 4.3 Motion Bull 5 Chat Channel 6 Email Channel 7 SMS Channel 8 Openchannel 9 WhatsApp Channel 10 How to retrieve variable

This page is under revision

What’s about

On this page, you can find the list of Standard Variables available in XCALLY Motion application.

Remember that the variable field name must be exactly as mentioned in the database tables.

Contact Variables

These are variables related to cm_contacts, valid for all channels. The field is the name of a contact's field in Contact Manager.

Title	Variable	Description

Title	Variable	Description
Contact ID	id	Unique identifier of contact
Contact First Name	firstName	Contact’s First Name
Contact Last Name	lastName	Contact’s Last Name
Postal Code	postalCode	Numerical or alphanumeric string representing a postal (ZIP) code
Contact city	city	Contact’s city
Contact country	country	Contact’s country
Contact Date of Birth	dateOfBirth	Contact’s Date of Birth (Day, Month, Year)
Contact primary phone number	phone	Main phone number of the contact
Contact mobile phone number	mobile	Contact mobile phone number
Contact email	email	Contact’s email address
Agent ID	UserId	Agent managing contact
Scheduled At date and time	scheduledat	scheduledat timestamp (used by Motion Bull)
Created At date and time	createdAt	Contact creation timestamp
Updated At date and time	updatedAt	Contact update timestamp
Deleted At date and time	deletedAt	Contact deletion timestamp
Contact company ID	CompanyId	External company reference
Contact Manager List ID	ListId	ID of Contact Manager List in which contact is saved
Contact Additional Phones	AdditionalPhones	Contact Additional Phones

List Variables

These are variables related to cm_lists, valid for all channels.

Title	Variable	Description

Title	Variable	Description
List ID	id	Unique identifier of list
List name	name	list name
List prefix	dialPrefix	Prefix added to phone numbers before dialing
Created At date and time	createdAt	List creation timestamp
Updated At date and time	updatedAt	List update timestamp

Voice Channel

Inbound Call

Title	Variable	Description

Title	Variable	Description
Unique ID	uniqueid	unique identifier associated with each call
Caller Number	calleridnum	parameter indicating the caller's telephone number
Caller Name	calleridname	parameter indicating the name associated with the caller's telephone number
Queue	queue	this variable indicates the destination queue or group of agents that handled the call
Hold Time	holdtime	indicates the time spent on hold during call handling
Talk Time	talktime	indicates the total time spent in conversation
Connected Time	agentconnectAt	indicates the moment when an agent connects to the incoming call and becomes active in handling it
Called Time	agentcalledAt	indicates the moment when an agent was called to handle an incoming call
DNID	destexten	used to identify the destination extension or department to which the call was routed
Destination caller ID number	destcalleridnum	used to identify the Agent’s internal extension to which the call was routed
Destination caller ID name	destcalleridname	used to identify the Agent’s name to which the call was routed
Destination channel	destchannel	indicates the final channel where the call is connected
Context	context	indicates the used context
Complete Time	agentcompleteAt	provides information on the time when the agent finished interaction with the caller and ended the call
No Answer Time	agentringnoanswerAt	indicates the moment when an agent was called but did not answer within a certain time interval
Recording URL Available for Zendesk, Salesforce, Sugar CRM, Freshdesk and Zoho integrations.	recordingURL	indicates the URL or access path to the audio recording of the call

Outbound Call

Title	Variable	Description

Title	Variable	Description
Unique ID	uniqueid	unique identifier associated with each call
Route ID	routeId	unique identifier associated with the route
Destination	destination	value of destination phone number
Out Prefix	prefix	value of outprefix (if present)
Caller Number	calleridnum	used to specify the caller ID number: it allows the caller to check the number that appears on the recipient's caller ID display
Caller Name	calleridname	used to specify the caller ID name: it allows the caller to customize the name associated with the caller ID number
Called Number	destcalleridnum	used to specify the recipient's phone number or the number to which the call is being directed
Called Name	destcalleridname	used to specify the recipient's name
Start Time	starttime	used to indicate the start time or initiation time of the call. It represents the moment when the outbound call was first initiated or placed
Answer Time	answertime	used to indicate the time when the call was answered. It represents the moment when the call was picked up or connected
Complete Time	endtime	used to indicate the time when the call ended. It represents the moment when the call was terminated, either by the caller or the recipient.
Recording URL	recordingURL	indicates the URL or access path to the audio recording of the call

Motion Bull

The Motion Bull variables must be used with all lowercase characters in the triggers within {{ }}, while in the Square projects they must be used with all uppercase characters within { }

Title	Variable	Description

Title	Variable	Description
Queue Campaign ID	xmd-voicequeueid	Available for Queue Campaign to identify a voice queue
IVR Campaign ID	xmd-campaignid	Available for IVR Campaign to identify the id of IVR
Caller ID	xmd-callerid	Refers to the caller ID information. In "Caller Name"<Caller Number> format
Contact ID	xmd-contactid	Used to uniquely identify and reference a specific contact or customer
Contact's Fields	xmd-{name_field}	name_field is the name of a contact's field in Contact Manager. You have to replace the field with e.g. xmd-firstname, xmd-phone, xmd-email and so on
Contact's Custom Fields	xmd-cf_{ID}	ID is the custom field's ID. You have to replace the field: if e.g. the contact has a custom field with ID=5, the variable name will be xmd-cf_5.

Chat Channel

Account

With this data you can retrieve variables related to the chat website account.

Title	Variable	Note

Title	Variable	Note
Chat website ID	id	Unique identifier of chat website
Chat website name	name	Name of the Chat website
Website Address	address	Chat website address
List ID	ListId	ID of Contact Manager List involved in the account

Interaction

At the first contact with a new customer, the interaction object is created, which acts as a “container”.
A high-level interaction variable is then created which contains general data e.g. creation date and contact ID, but other variables such as the body message will not be present at interaction level, but within the message itself.

Title	Variable	Description

Title	Variable	Description
Interaction ID	id	Unique identifier of interaction
Interaction status	closed	True if the interaction is closed
Interaction close timestamp	closedAt	Timestamp of close action
Disposition	disposition	Interaction disposition
Second Level disposition	secondDisposition	Interaction second level disposition
Third Level disposition	thirdDisposition	Interaction third level disposition
Note	note	Interaction note
Agent ID	UserId	To identify agent involved in conversation
Contact ID	ContactId	Unique identifier for customer
Website ID	ChatWebsiteId	identifier to the specific website where there is the snippet and the chat conversation takes place
Customer Browser	browserName browserVersion	Information on browser used by the customer
Customer OS	osName osVersion	Information on OS used by the customer
Customer Device	deviceModel deviceVendor deviceType	Information on device used by the customer
Customer Referer	referer	Referer page of the customer
Customer IPs	customerIp	List of IPs used by the customer to reach the webchat
First Read timestamp	read1stAt	Datetime of first read message
Last Read timestamp	lastMsgAt	Datetime of last read message
Last Message Direction	lastMsgDirection	Direction (in or out) of the last message
Interaction create timestamp	createdAt	Creation timestamp when a chat conversation was started
Interaction update timestamp	updatedAt	Update timestamp when a WhatsApp interaction was updated
Queue ID	queueId	To identify queue involved in chat channel
Agent interface	interface	Refers to a data structure that represents the chat interface through which users interact with the chat application

Message

Title	Variable	Description

Title	Variable	Description
Message ID	id	Unique identifier of message
Text message	body	The body message
Message status	read	True if the message is read
Message direction	direction	Used to indicate the direction of the chat message (in / out)
ReadAt	readAt	Timestamp of when a message was marked as read
Provider Name	providerName	Name of provider used in chat channel
Chat Website ID	ChatWebsiteId	Identifier to the specific website where there is the snippet and the chat conversation takes place
Chat Interaction ID	ChatInteractionId	Unique identifier of interaction
Agent ID	UserId	To identify agent involved in message exchange
Contact ID	ContactId	Unique identifier for customer
Message create timestamp	createdAt	Creation timestamp when a chat message was sent
Interaction update timestamp	updatedAt	Update timestamp when a chat interaction was updated
Translation Source Language	translationSourceLanguage	Original language of a message auto detected by the translation service
Translation target language	translationTargetLanguage	Language into which a message is translated
Message Traslation	messageTranslation	Actual translation of the message, null means no translation

Email Channel