List of system variables for remote systems integration

Below is the full list of system variables available for use when forming requests to remote systems. These variables can be used both when creating requests to a remote system and when handling responses.

Visitor

Everything related to website visitor: Geographic data, Device details, Provided personal info, ...

NameDescription
CITY

City

COUNTRY

Country

CUSTOM1

Permanent custom string value #1

CUSTOM2

Permanent custom string value #2

CUSTOM3

Permanent custom string value #3

EMAIL

Visitor's email-address

EXTENSION1...N

Extension visitor fields 1 ... N

FIRST_VISIT

Date and time of first visit

FLAG1

Sessional integer value #1

FLAG2

Sessional integer value #2

FLAG3

Sessional integer value #3

ID

Visitor's unique identifier

IP_ADDRESS

Visitor's IP address

IP_LASTCOMMENT

Last agent's comment to visitor's IP address

LAST_VISIT

Date and time of last visit (current if visitor is still on site)

NAME

Name provided by visitor or assigned by an agent

OS

Operating system the visitor is using

PHONE

Visitor's phone number

REFERRER_NAME

Referring source name detected by system

REFERRER_URL

Complete URL of referring website

REGISTER1

Permanent integer value #1

REGISTER2

Permanent integer value #2

REGISTER3

Permanent integer value #3

SCREEN

Visitor's screen resolution

SEARCH_REQUEST

Search query that lead the visitor to the website

SUBDIVISION

Geographical subdivision

USER_AGENT

Visitor's internet browser

Operator (Chat Agent)

Data related to the last agent in chat.

NameDescription
OPERATOR_CUSTOM1

Agent's custom field #1

OPERATOR_CUSTOM10

Agent's custom field #10

OPERATOR_CUSTOM2

Agent's custom field #2

OPERATOR_CUSTOM3

Agent's custom field #3

OPERATOR_CUSTOM4

Agent's custom field #4

OPERATOR_CUSTOM5

Agent's custom field #5

OPERATOR_CUSTOM6

Agent's custom field #6

OPERATOR_CUSTOM7

Agent's custom field #7

OPERATOR_CUSTOM8

Agent's custom field #8

OPERATOR_CUSTOM9

Agent's custom field #9

OPERATOR_FIRSTNAME

Agent's first name

OPERATOR_FULLNAME

Agent's full name

OPERATOR_ID

Agent's unique identifier

OPERATOR_LASTNAME

Agent's last name

OPERATOR_NICK

Agent's chat nickname which is visible for website visitors

Sender

Sender (Chat agent who initiated the sending of data) related data.

NameDescription
SENDER_CUSTOM1

Agent's custom field #1

SENDER_CUSTOM10

Agent's custom field #10

SENDER_CUSTOM2

Agent's custom field #2

SENDER_CUSTOM3

Agent's custom field #3

SENDER_CUSTOM4

Agent's custom field #4

SENDER_CUSTOM5

Agent's custom field #5

SENDER_CUSTOM6

Agent's custom field #6

SENDER_CUSTOM7

Agent's custom field #7

SENDER_CUSTOM8

Agent's custom field #8

SENDER_CUSTOM9

Agent's custom field #9

SENDER_FIRSTNAME

Agent's first name

SENDER_FULLNAME

Agent's full name

SENDER_ID

Agent's unique identifier

SENDER_LASTNAME

Agent's last name

SENDER_NICK

Agent's chat nickname

Chat

Current chat session data.

NameDescription
CHAT_ALL

Full list of message

CHAT_ALL_HTML

HTML-formatted chat transcript.

[13:40]
<strong>Visitor's name</strong>
<br/><br/>
Website visitor's message.
<br/><br/>
[13:40]
<strong>Agent John</strong>
<br/><br/>
Agent's message.
<br/><br/>
CHAT_ALL_JSON

JSON formatted chat transcript.

[
    {
        "action" : 271,
        "author" : "visitor",
        "text"   : "Website visitor's message",
        "time"   : "2016-01-12 13:40:32",
        "nick"   : "Visitor's name"
    },
    {
        "action"        : 260,
        "author"        : "operator",
        "text"          : "Agent's message",
        "time"          : "2016-01-12 13:40:59",
        "nick"          : "Agent John",
        "operator_id"   : "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "operator_name" : "John Doe"
    } 
]
CHAT_ALL_XML

XML-formatted chat transcript.

<chat id="123456">
    <message>
        <action>271</action>
        <author>visitor</author>
        <text>Website visitor's message.</text>
        <time>2016-01-12 13:40:32</time>
        <nick>Visitor's name</nick>
    </message>
    <message>
        <action>260</action>
        <author>operator</author>
        <text>Agent's message.</text>
        <time>2016-01-12 13:40:59</time>
        <nick>Agent John</nick>
        <operator_id><!-- Agent ID (GUID) --></operator_id>
        <operator_name>John Doe</operator_name>
    </message>
</chat>
CHAT_LAST_MESSAGE

Last message in chat

CHAT_MSG_COUNT

Total messages count in chat session

CHAT_OPERATORS

List of agents who participated in this chat in "Full name (ID)" format

John Smith (7ad962bed-0354-4694-35d9-40a24aa482e5), James Johnson (...
CHAT_OPERATORS_JSON

JSON formatted list of agents who participated in chat.

{
    "OPERATOR_ID_1" :
    {
        "id"   : "OPERATOR_ID_1",
        "name" : "Jeff Hanneman",
        "nick" : "Jeff"
    },
    /* ... */
    "OPERATOR_ID_N" :
    {
        "id"   : "OPERATOR_ID_N",
        "name" : "Dave Lombardo",
        "nick" : "Dave"
    } 
}
CHAT_OPERATORS_XML

XML formatted list of agents who participated in chat

<operators>
    <operator id="OPERATOR_ID_1">
        <id>OPERATOR_ID_1</id>
        <name>Jeff Hanneman</name>
        <nick>Jeff</nick>
    </operator>
    <!-- ... -->
    <operator id="OPERATOR_ID_N">
        <id>OPERATOR_ID_N</id>
        <name>Dave Lombardo</name>
        <nick>Dave</nick>
    </operator>
</operators>
CHAT_OPERATOR_MSGS

List of agent messages in chat

CHAT_SYS_MSGS

List of system messages

CHAT_VISITOR_MSGS

List of visitor's messages

Behavior

Visitor's website behavior data

NameDescription
DOMAIN

Domain name of the webpage visitor is currently on

LAST_PAGE

Last visited page (title and URL)

LAST_PAGE_TITLE

Title of last visited page

LAST_PAGE_URL

URL address of last visited page

PAGES

List of visited pages

PAGE_COUNT

Number of visited pages during last session

TIME_ON_LASTPAGE

Time spent on the last visited page

TIME_ON_SITE

Time spent on the entire site

Misc

NameDescription
DATETIME_DMY

Date in dd.mm.yyyy format

DATETIME_YMD

Date in yyy-mm-dd format


All rights reserved. Copyright © 2020 Netrox SC
Host CMS