метод REST scope: im

im.message.add

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

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

Описание

Метод im.message.add отправляет сообщение в чат.

Параметры

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

Идентификатор чата в формате:

  • chatXXX — чат
  • sgXXX — чат группы или проекта
  • XXX — идентификатор пользователя личного чата

    Идентификатор чата можно получить с помощью метода im.chat.get. Идентификатор пользователя — с помощью методов user.get и user.search
MESSAGE string обязательный

Текст сообщения. Обязателен, если не передан ATTACH.

Поддерживается форматирование

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

Вложение с блоками контента: изображения, ссылки, файлы. Обязателен, если не передан MESSAGE.

Подробнее читайте в разделе Вложения

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

Кнопки под сообщением, с которыми может взаимодействовать пользователь.

Подробнее читайте в статье Работа с клавиатурами

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

Дополнительные пункты в контекстном меню чата.

Подробнее читайте в статье Контекстное меню

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

Признак системного сообщения.

Допустимые значения:
- Y — системное сообщение
- N — обычное сообщение

По умолчанию — N

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

Преобразование ссылок в rich-ссылки.

Допустимые значения:
- Y — включено
- N — выключено

По умолчанию — Y

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

Идентификатор сообщения, на которое отправляется ответ. Сообщение для ответа должно быть в том же чате.

Идентификатор можно получить с помощью метода im.dialog.messages.get

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DIALOG_ID":"chat2941","MESSAGE":"Текст сообщения","SYSTEM":"N","URL_PREVIEW":"Y","REPLY_ID":34237}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.message.add

Ответ

HTTP-статус: 200

{
    "result": 34239,
    "time": {
        "start": 1772552939,
        "finish": 1772552939.091396,
        "duration": 0.09139609336853027,
        "processing": 0,
        "date_start": "2026-03-03T17:48:59+03:00",
        "date_finish": "2026-03-03T17:48:59+03:00",
        "operating_reset_at": 1772553539,
        "operating": 0
    }
}

Возвращаемые данные

result integer

Идентификатор отправленного сообщения

time time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": "MESSAGE_EMPTY",
    "error_description": "Message can't be empty"
}
Код Описание Значение
MESSAGE_EMPTY Message can't be empty Пустой MESSAGE и отсутствует ATTACH
USER_ID_EMPTY User ID can't be empty Не передан или некорректен идентификатор пользователя в DIALOG_ID
USER_NOT_FOUND User not found Пользователь не найден
CHAT_ID Ошибка при создании сообщения Не удалось создать сообщение. Убедитесь, что чат с таким ID существует
ACCESS_ERROR Action unavailable Недостаточно прав для отправки сообщения
PARAMS_ERROR Incorrect params Некорректный набор параметров запроса
ATTACH_ERROR Incorrect attach params Невалидный объект ATTACH
ATTACH_OVERSIZE You have exceeded the maximum allowable size of attach Размер ATTACH превышает допустимый
KEYBOARD_ERROR Incorrect keyboard params Невалидный объект KEYBOARD
MENU_ERROR Incorrect menu params Невалидный объект MENU
REPLY_ACCESS_ERROR Action unavailable Нет доступа к сообщению в REPLY_ID
REPLY_FROM_OTHER_CHAT_ERROR You can only reply to a message within the same chat Нельзя отвечать на сообщение из другого чата

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

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