21.03.2026 15:10

Suggest

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

Публикует ephemeral-подсказки быстрого ответа от ChatBot без записи сообщения в БД.

Входные параметры

Название Тип данных Обязательность Описание
chat_id String Обязательный UUID чата
author_entity_type String(ChatEntityTypeEnum) Обязательный Тип автора подсказок, только ChatBot
author_entity_id Int64 Обязательный Идентификатор чат-бота-автора
suggestions Array of String Обязательный Подсказки быстрого ответа
source_message_id String Необязательный UUID сообщения, к которому относятся подсказки

Ограничения и проверки

  • chat_id обязателен и должен быть корректным UUID.
  • author_entity_type и author_entity_id обязательны и передаются парой.
  • Для метода допускается только author_entity_type = ChatBot.
  • Указанный ChatBot должен быть участником чата.
  • suggestions после нормализации (trim + удаление пустых + dedupe) должны содержать от 1 до 5 элементов.
  • Длина каждой подсказки не должна превышать 200 символов.
  • source_message_id (если передан) должен быть корректным UUID.
  • Метод не создает запись в ctlg_cht_messages_ref, не влияет на unread_count и last_message.
  • Идентичные payload подсказок от одного бота в одном чате сервер может кратковременно дедуплицировать (debounce).

Пример запроса

{
  "chat_id": "6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef",
  "author_entity_type": "ChatBot",
  "author_entity_id": 12,
  "suggestions": [
    "Добрый день! Чем могу помочь?",
    "Подтвердите, пожалуйста, номер заказа",
    "Спасибо, передал запрос оператору"
  ],
  "source_message_id": "5f3f6a84-2f3e-4c4a-ae2b-2f6c5a813b66"
}

Выходные параметры

Название Тип данных Описание
result.row_affected Int64 Количество обработанных событий

Пример ответа

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