Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

servid

widgetid

serv_name

beginTime

endTime

Name

Type

Description

_id

id

Status
title

lang

userID

users

id [user object]

nicknamebeginTime

STRING

Internal object identifier

id

Status
titleSTRING

agent/customer nickname

Chat unique identifier

servid

Status
titleSTRING

/

Chat start time

endTime

Service unique identifier

widgetid

Status
title

NUMBER

STRING

Widget unique identifier

serv_name

Status
titleSTRING

/

Service name

beginTime

Status
title

NUMBER

number

Chat

end

start time

isOnline

endTime

Status
title

BOOLEAN

Identifies if a chat is currently active

userAgent

number

Chat end time

title

Status
titleSTRING

Browser user agent

firstUri

Chat title

lang

Status
titleSTRING

Web page url

firstTitle

Chat language

userID

Status
titleSTRING

Web page title

channel

Unique identifier of the user who started the chat

agentID

Status
titleSTRING

Identifies chat channel. Can assume one of the following values:

“WEB”

“WHATSAPP”

firstIP

Unique identifier of the agent who managed the chat

users

Status
title

STRINGAgent/customer IP

object

Hash of the partecipants to the chat. See User Object for more details

dataCollections

callData

Status
title

Example

...

languagejson

...

object

Hash containing Data Collection Object

callData

Status
titleobject

Hash containing call data variables and values

contact_events

Status
titlearray

Array containing contact events. See Contact Event Object for more details

ctlive_type

Status
titlestring

Chat type according to the initiator. Can be one of the following values:

“chat”

“cbn”

“cbl”

“cbfs”

“call”

User Object

Name

Type

Description

id

Status
titleSTRING

User unique identifier

nickname

Status
titleSTRING

agent/customer nickname

beginTime

Status
titleSTRING
/
Status
titleNUMBER

Chat start time

endTime

Status
titleSTRING
/
Status
titleNUMBER

Chat end time

isOnline

Status
titleBOOLEAN

Identifies if a chat is currently active

userAgent

Status
titleSTRING

Browser user agent

firstUri

Status
titleSTRING

Web page url from which the chat started

uriHistory

Status
titlearray

Array containing all the web page urls navigated during the chat

firstTitle

Status
titleSTRING

Web page title

channel

Status
titleSTRING

Identifies chat channel. Can assume one of the following values:

“web”

“whatsapp”

“messenger”

“instagram”

firstIP

Status
titleSTRING

Agent/customer IP

Contact Event Object

Name

Type

Description

event

Status
titlestring

Event name. Event can be one of the following:

"newContactAccepted"
"joinContact"
"endByAgent"
"endByCustomer"
"endedByExternalWs"
"endedByKeepaliveKeyExpired"
"cb_success"
"cb_error"
"serverError"

“clientError”

ts

Status
titlenumber

timestamp of the event

origin

Status
titlestring

User id who performed the action

Example

Code Block
languagejson
{
    "_id" : "CHAT_DEFAULT_8857106a-55b8-4c47-a5af-a3aae7530e5a",
    "contact_events" : [ 
        {
            "event" : "newContactAccepted",
             {  "ts" : 1642604343456.0,
            "_idorigin" : "5c6e700404445e26d8dbeee44747235938674011",
        }, 
     "dc_type":"nickname",   {
            "labelevent" : "NicknamejoinContact",
  
            "isMandatoryts" :true 1642604351430.0,
            "origin" : "USER_gverde1@acd.enghouse.com"
 "isVisibleAgent":true,       }, 
       "isVisibleCustomer":true, {
            "event" : "isEditableendByAgent":true,
  
            "custom_regexpts":"", : 1642604409653.0,
            "origin" : "USER_gverde1@acd.enghouse.com"
  "value":"Gabry",      }
    ],
    "nameid" :"nickname",
         "CHAT_DEFAULT_8857106a-55b8-4c47-a5af-a3aae7530e5a",
      "modeservid" : "manualctlivesocial_instagram",
        "ctlive_type" : "chat",
   }, "widgetid" : "",
    "serv_name" : "ctlivesocial_instagram",
  {  "beginTime" : 1642604342648.0,
    "endTime" :  1642604409492.0,
    "_idtitle" : "5c6e700404445e26d8dbeee3",
         "lang" : "",
     "dc_typeuserID" : "name4747235938674011",
    "users" : {
        "label4747235938674011" :"Name", {
            "id" : "isMandatory4747235938674011":false,
            "nickname" : "Malcom "isVisibleAgentSgatti":true,
               "isVisibleCustomerisAgent" :true false,
  
            "isEditablebeginTime" :true 1642604342648.0,

              "custom_regexpendTime":"",
 : 1642604409492.0,
              "valueisOnline" :"",
   false,
            "nameuserAgent" : "name",
  
            "modefirstUri" : "manual",
            "uriHistory" :  }[],
            {"firstTitle" :   "",
            "_idchannel" : "5c6e700404445e26d8dbeee2instagram",
            "firstIP" :  "dc_type":"surname","::ffff:127.0.0.1"
        },
         "label":"surname",
"USER_gverde1@acd#_#enghouse#_#com" : {
            "id" : "isMandatory":falseUSER_gverde1@acd.enghouse.com",
            "nickname" : "Gabriele Verde"isVisibleAgent":true,
  
            "isVisibleCustomerisAgent" : true,
  
            "isEditablebeginTime" :true,
   1642604351284.0,
            "custom_regexpendTime":"",
   : 1642604409492.0,
            "valueisOnline" :"",
   false,
            "nameuserAgent" :"surname",
               "mode":"manual" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.71 Safari/537.36",
            }"firstUri"     : "http://localhost:3003/AD/AD.html",
    ],          "_iduriHistory" :"5c6e700404445e26d8dbeee1" ["http://localhost:3003/AD/AD.html"],
         "id":"67990d2d-5d35-4d7d-93ac-df3d9edb636d",   "firstTitle" : "AgentDesktop - Enghouse Interactive",
 "title":"Anagrafica #1",          "dc_modechannel" : "chatweb",
            "nextfirstIP" : "",::ffff:127.0.0.1"
        }
    },
 "__v":0   "dataCollections" : {
 },       "fc0450c8c2ae3430-4b2ca76c-42b344e4-b8c9a885-04b672ca4a9010fc9fb06c33" : {
            "datacollection" : [ 
                {
                    "dc_idtype" : "5c6e700404445e26d8dbeee8nickname",
                    "dc_typelabel" : "emailnickname",
  
            "label":"Email",        "isMandatory" :  false,
    "isMandatory":true,                "isVisibleAgent" : true,
                    "isVisibleCustomer" :true, false,
                    "isEditable" :true, false,
                    "custom_regexp" : "",
          
    "value":"Gabriele.Verde@enghouse.com",                 "namecustomMandatoryErrorMessage" : "email",
                    "modecustomValidationErrorMessage" : "manual",
              },      "value" : "Malcom Sgatti",
   {                 "_idname" : "5c6e700404445e26d8dbeee7nickname",
                    "dc_typemode" : "phoneauto",
  
            "label":"Phone number",   }
            "isMandatory":false],
            "id"  : "isVisibleAgent":truee1c8cd7e-b0c3-4791-ab4b-3f3ee761dafb",
            "title" :  "isVisibleCustomer":true,
            "dc_mode"  : "isEditable":true,
  chat",
            "custom_regexpnext" :"[0-9]{10}", ""
        },
        "value":"",
  ea1f8791-df7c-4c43-b09d-2fd043756c4c" : {
            "namedatacollection":"phone_number", : [ 
                "mode":"manual"{
             },       "dc_type" : "text",
   {                 "_idlabel" : "5c6e700404445e26d8dbeee6last agent ID",
                    "dc_typeisMandatory" :"date", false,
                    "labelisVisibleAgent" :"Birthdate", true,
                    "isMandatoryisVisibleCustomer" : false,
                    "isVisibleAgentisEditable" :true, false,
                    "isVisibleCustomercustom_regexp" :true, "",
                    "isEditablecustomMandatoryErrorMessage" :true, "",
                    "custom_regexpcustomValidationErrorMessage" : "",
                    "value" : "",
                    "name" : "birthdateLastAgentID",
                    "mode" : "manualauto"
            }    }
     ],       ],
  "_id":"5c6e700404445e26d8dbeee5",          "id" : "fc0450c8e4e82b29-4b2c9287-42b34cb1-b8c9a2eb-04b672ca4a904effeb374f9d",
            "title" : "Anagrafica #2",
            "dc_mode" : "chat",
            "next" : "",
         "__v":0}
      }
 ,
 },    "callData" : {
        "_NICK_" :"Gabry",
      "email":"Gabriele.Verde@enghouse.com "Malcom Sgatti",
        "_CTHISTORY_1_Q_" : "QUEUE42@acd.enghouse.com",
        "birthdateLastAgentID" : "",
        "phoneREC_numberCALLCENTER":"",
      "name":"",
      "surname":"", : "CC_DEFAULT",
        "ECID" : "felixct7|1|295039|15"
    },
    "__v" : 0
}