Chatbot Messages

Poll New Messages

Poll for new messages in a conversation (typically used while waiting for or chatting with a human agent). Returns only messages with id greater than after_id, plus the current conversation state.

Recommended polling interval: 3-5 seconds while a chat is active.

get/chatbots/{chatbot_id}/conversations/{conversation_id}/messages

Request

  • Base URL
    https://app.boei.help/api/v1
  • Auth
    HTTP bearer

Query parameters

after_idinteger

Optional. Return only messages with id greater than this.

Example:12345

Request body

after_idinteger nullable

Must be at least 0.

Example request

{
  "after_id": 27
}

Response

conversation_idstring
modestring
waiting_for_agentboolean
is_closedboolean
last_message_idinteger

Example response

{
  "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
  "mode": "live",
  "waiting_for_agent": false,
  "agent": {
    "name": "Sarah"
  },
  "is_closed": false,
  "messages": [
    {
      "id": 12346,
      "role": "agent",
      "sender_name": "Sarah",
      "content": "Hi! How can I help?",
      "created_at": "2026-05-11T10:30:05Z"
    }
  ],
  "last_message_id": 12346
}

Changes

No recorded changes to this operation across all 2 revisions of this API.