метод REST scope: imbot

imbot.v2.Chat.Message.send

Отправить сообщение

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

Описание

Метод imbot.v2.Chat.Message.send отправляет сообщение от имени бота в указанный диалог.

Параметры

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

ID бота

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

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

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

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

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

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

Содержимое сообщения. Структура объекта описана ниже

Параметр fields

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

Текст сообщения. Максимальная длина — 20 000 символов. При превышении текст обрезается с добавлением (...)

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

Вложения. Подробнее: Как использовать вложения

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

Клавиатура с кнопками. Подробнее: Работа с клавиатурами

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

Системное сообщение. Допустимые значения: true, false. По умолчанию false

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

Показывать превью ссылок. Допустимые значения: true, false. По умолчанию true

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

ID сообщения, на которое отвечает бот

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

UUID шаблона сообщения

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

Сообщения для пересылки. Формат: {uuid: messageId}, где uuid — произвольная UUID-строка как ключ, messageId — ID исходного сообщения. В ответе uuidMap вернет {uuid: newMessageId}.

Бот может пересылать только сообщения из чатов, в которых он является участником. Максимум 100 сообщений

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"botToken":"my_bot_token","dialogId":"chat5","fields":{"message":"Hello from bot!","keyboard":[{"TEXT":"Open","LINK":"https://example.com","BG_COLOR_TOKEN":"primary"}]}}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.Message.send

Ответ

HTTP-статус: 200

{
    "result": {
        "id": 789,
        "uuidMap": {}
    },
    "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": "EMPTY_MESSAGE",
    "error_description": "Message is empty"
}
Код Описание Значение
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 Бот не является участником чата
EMPTY_MESSAGE Message is empty Пустое сообщение — нет текста или вложений
SENDING_FAILED Sending failed Ошибка отправки сообщения

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

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