Lodol Docs

LiveChat

API actions for the LiveChat integration.

LiveChat

Send messages and review active chats in LiveChat.


List active LiveChat conversations

List the chats that are currently active in LiveChat, with an optional limit on how many to return.

Parameters

ParameterTypeRequiredDescription
limitnumberNoMaximum number of active chats to return (default 20).

Response

{
  "chats": [
    {
      "chat_id": "mock_value",
      "last_message": "mock_value",
      "thread_id": "mock_value"
    }
  ],
  "status": "mock_value"
}

Send a message to a LiveChat conversation

Send a text message to a LiveChat chat.

Parameters

ParameterTypeRequiredDescription
chat_idstringYesThe ID of the LiveChat chat to send the message to.
textstringYesThe message text to send.
author_idstringNoOptional ID of the agent to send the message as.

Response

{
  "chat_id": "mock_value",
  "event_id": "mock_value",
  "status": "mock_value",
  "text": "mock_value"
}

On this page