Suggest

[POST] .../v1/chatmessage/suggest

Publishes ephemeral quick reply suggestions from ChatBot without storing a message in the database. Use this method when a ChatBot needs to show temporary quick replies for a chat message without creating a permanent ChatMessage row. The request body is required, chat_id must identify the chat, author_entity_type must be ChatBot, author_entity_id must identify a bot participant and suggestions must contain the proposed quick replies. Access is scoped to the bot participant and current integration context and the method publishes a realtime suggestion event instead of changing the message history. Missing body, missing chat_id or suggestions, unsupported author type, too many or too long suggestions, invalid source_message_id, denied bot access and delivery failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
author_entity_id Int64 Required Author chat bot identifier.
author_entity_type String Required Suggestion author type. Only ChatBot is supported. Allowed values: Default, User, ChatBot, Client.
chat_id String Required Chat UUID.
source_message_id String Optional UUID of the message that the suggestions belong to.
suggestions Array of String Required Quick-reply suggestions.

Request Example

{
  "chat_id": "8cdd646d-dbd0-45c0-8f5b-d90a9b000001",
  "author_entity_type": "ChatBot",
  "author_entity_id": 77,
  "suggestions": [
    "Approve",
    "Reject"
  ],
  "source_message_id": "4b9727ec-a389-4274-95b6-069350000001"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}