Get Livechat Configurations
    • Dark
      Light
    • PDF

    Get Livechat Configurations

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/livechat/config

    Get Livechat widget configuration information and additional visitor data.

    Changelog

    VersionDescription
    0.70.0Added
    Query parameters
    token
    string

    The visitor token.

    department
    string

    The visitor's department.

    Responses
    200

    OK

    Success Example
    {
      "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": "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": "[email protected]",
              "verified": true
            }
          ],
          "name": "Livechat Agent",
          "username": "livechat.agent"
        }
      },
      "success": true
    }
    Expand All
    object
    config
    object
    enabled
    boolean
    settings
    object
    registrationForm
    boolean
    allowSwitchingDepartments
    boolean
    nameFieldRegistrationForm
    boolean
    emailFieldRegistrationForm
    boolean
    displayOfflineForm
    boolean
    videoCall
    boolean
    fileUpload
    boolean
    language
    string
    transcript
    boolean
    historyMonitorType
    string
    forceAcceptDataProcessingConsent
    boolean
    showConnecting
    boolean
    agentHiddenInfo
    boolean
    clearLocalStorageWhenChatEnded
    boolean
    limitTextLength
    boolean
    theme
    object
    title
    string
    color
    string
    offlineTitle
    string
    offlineColor
    string
    actionLinks
    Array of object
    object
    icon
    string
    i18nLabel
    string
    method_id
    string
    params
    string
    messages
    object
    offlineMessage
    string
    offlineSuccessMessage
    string
    offlineUnavailableMessage
    string
    conversationFinishedMessage
    string
    transcriptMessage
    string
    survey
    object
    items
    Array of string
    string
    values
    Array of string
    string
    departments
    Array of object
    object
    _id
    string
    name
    string
    showOnRegistration
    boolean
    showOnOfflineForm
    boolean
    online
    boolean
    guest
    object
    _id
    string
    username
    string
    token
    string
    name
    string
    room
    object
    _id
    string
    servedBy
    object
    _id
    string
    username
    string
    open
    boolean
    agent
    object
    _id
    string
    emails
    Array of object
    object
    address
    string
    verified
    boolean
    name
    string
    username
    string
    success
    boolean

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.