Chatbot Operations

Start or end live chat

Toggle or set the state of a live chat session for a specific conversation. Your plan must include live chat, and live chat must be enabled in the chatbot's settings.

post/livechat-state

Request

  • Base URL: https://api.chat-data.com/api/v2
  • URL: https://api.chat-data.com/api/v2/livechat-state
  • Auth: HTTP bearer

Request body

chatbotIdstring required

The unique identifier of the chatbot.

conversationIdstring required

The unique identifier of the conversation.

endboolean

If provided, true ends the live chat session and false reopens it. If omitted, the current state is toggled.

Response

Successful response.

status'success' required
liveChatEndedboolean required

Whether the live chat session has ended after this request.

Changes

No recorded changes to this operation across all 1 revision of this API.