Lodol Docs

LiveChat

API actions for the LiveChat integration.

LiveChat

Send messages and review active chats via the LiveChat Agent API.


List active LiveChat conversations

Retrieve a list of active chats with optional pagination.

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

Post a text message to a LiveChat chat using an agent access token.

Parameters

ParameterTypeRequiredDescription
chat_idstringYesThe LiveChat chat identifier.
textstringYesThe message text to send.
author_idstringNoOptional agent identifier to attribute the message.

Response

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

On this page