livechat-config.md

Get Livechat Configurations

Get Livechat widget configuration information and additional visitor data.

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/config	no

Query Parameters

Key	Example Value	Description
token	iNKE8a6k6cjbqWhWd	The visitor token.
department	department	The visitor's department.

Example Calls

Without query parameters:

curl --location 'http://localhost:3000/api/v1/livechat/config'

With query parameters:

curl --location 'http://localhost:3000/api/v1/livechat/config?token=iNKE8a6k6cjbqWhWd'
curl --location 'http://localhost:3000/api/v1/livechat/config?department=department'

Example Response

{
  "config": {
    "enabled": true,
    "settings": {
      "registrationForm": true,
      "allowSwitchingDepartments": false,
      "nameFieldRegistrationForm": true,
      "emailFieldRegistrationForm": true,
      "displayOfflineForm": true,
      "videoCall": false,
      "fileUpload": true,
      "language": "",
      "transcript": false,
      "historyMonitorType": "url",
      "forceAcceptDataProcessingConsent": false,
      "showConnecting": true,
      "agentHiddenInfo": false,
      "clearLocalStorageWhenChatEnded": false,
      "limitTextLength": false
    },
    "theme": {
      "title": "Rocket.Chat",
      "color": "#C1272D",
      "offlineTitle": "Leave a message",
      "offlineColor": "#666666",
      "actionLinks": [{
          "icon": "icon-videocam",
          "i18nLabel": "Accept",
          "method_id": "createLivechatCall",
          "params": ""
        },
        {
          "icon": "icon-cancel",
          "i18nLabel": "Decline",
          "method_id": "denyLivechatCall",
          "params": ""
        }
      ],
    },
    "messages": {
      "offlineMessage": "",
      "offlineSuccessMessage": "",
      "offlineUnavailableMessage": "",
      "conversationFinishedMessage": "",
      "transcriptMessage": ""
    },
    "survey": {
      "items": [
        "satisfaction",
        "agentKnowledge",
        "agentResposiveness",
        "agentFriendliness"
      ],
      "values": [
        "1",
        "2",
        "3",
        "4",
        "5"
      ],
    },
    "departments": [
    {
        "_id": "64cf6c6feb07a913d946f34d",
        "name": "Test",
        "showOnRegistration": false,
        "showOnOfflineForm": false
     },
     {
        "_id": "6523ff86a2f73c7460e18d6d",
        "name": "Dept-011",
        "showOnRegistration": false,
        "showOnOfflineForm": true
      },
      {
         "_id": "652882d8a2f73c7460e18dc4",
         "name": "Support",
         "showOnRegistration": false,
         "showOnOfflineForm": false
       },
       {
          "_id": "64181a0728384134ed600dcc",
          "name": "Lost",
          "showOnRegistration": false,
          "showOnOfflineForm": false
        }
        ],
    "online": true,
    "guest": {
      "_id": "2KNu66RPCwxA4ncy7",
      "username": "guest-3",
      "token": "iNKE8a6k6cjbqWhWd",
      "name": "Livechat Visitor"
    },
    "room": {
      "_id": "zRAeTszXor8CCPceB",
      "servedBy": {
        "_id": "7Gm3PoFCJWTCJ68XR",
        "username": "livechat.agent"
      },
      "open": true
    },
    "agent": {
      "_id": "7Gm3PoFCJWTCJ68XR",
      "emails": [{
        "address": "agent@rocket.chat",
        "verified": true
      }],
      "name": "Livechat Agent",
      "username": "livechat.agent"
    }
  },
  "success": true
}

Change Log

Version	Description
0.70.0	Added