метод REST scope: imbot

imbot.v2.Chat.InputAction.notify

Отправить индикатор действия бота

Кто может выполнять: владелец зарегистрированного бота

Описание

Метод imbot.v2.Chat.InputAction.notify отправляет индикатор действия бота в чат — например, «бот печатает».

Параметры

botId integer обязательный

ID бота

botToken string необязательный

Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.

Передавайте тот же botToken, который был указан при регистрации чат-бота

dialogId string обязательный

ID диалога. Для групповых чатов — chat{chatId}, для личных — {userId}

statusMessageCode string необязательный

Код статуса действия. Список доступных кодов описан ниже. Если не указан, отображается стандартный индикатор «печатает»

duration integer необязательный

Длительность отображения индикатора в секундах (1–600). По умолчанию определяется сервером

Доступные коды statusMessageCode

IMBOT_AGENT_ACTION_THINKING необязательный

Агент размышляет...

IMBOT_AGENT_ACTION_SEARCHING необязательный

Агент ищет информацию...

IMBOT_AGENT_ACTION_GENERATING необязательный

Агент готовит ответ...

IMBOT_AGENT_ACTION_ANALYZING необязательный

Агент анализирует запрос...

IMBOT_AGENT_ACTION_PROCESSING необязательный

Агент обрабатывает данные...

IMBOT_AGENT_ACTION_TRANSLATING необязательный

Агент переводит текст...

IMBOT_AGENT_ACTION_CONNECTING необязательный

Агент подключается к сервису...

IMBOT_AGENT_ACTION_CHECKING необязательный

Агент проверяет данные...

IMBOT_AGENT_ACTION_CALCULATING необязательный

Агент выполняет расчет...

IMBOT_AGENT_ACTION_READING_DOCS необязательный

Агент изучает документы...

IMBOT_AGENT_ACTION_COMPOSING необязательный

Агент составляет ответ...

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"botToken":"my_bot_token","dialogId":"chat5","statusMessageCode":"IMBOT_AGENT_ACTION_THINKING","duration":30}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.InputAction.notify

Ответ

HTTP-статус: 200

{
    "result": {
        "result": true
    },
    "time": {
        "start": 1728626400.123,
        "finish": 1728626400.234,
        "duration": 0.111,
        "processing": 0.045,
        "date_start": "2024-10-11T10:00:00+03:00",
        "date_finish": "2024-10-11T10:00:00+03:00"
    }
}

Обработка ошибок

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied"
}
Код Описание Значение
BOT_TOKEN_NOT_SPECIFIED Bot token is not specified Не указан botToken. Обязателен при авторизации через вебхук
BOT_ID_REQUIRED Bot ID is required Не указан botId
BOT_NOT_FOUND Bot not found Бот не найден
BOT_OWNERSHIP_ERROR Bot is registered by another application Бот зарегистрирован другим приложением
ACCESS_DENIED Access denied Бот не является участником чата

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.