Отправить сообщение im.message.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: im

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

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

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

DIALOG_ID*
string

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

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

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

MESSAGE*
string

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

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

ATTACH
object
string

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

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

KEYBOARD
object
string

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

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

MENU
object
string

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

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

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
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,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.message.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<number>({
    method: 'im.message.add',
    params: {
      DIALOG_ID: 'chat2941',
      MESSAGE: 'Message text',
      SYSTEM: 'N',
      URL_PREVIEW: 'Y',
      REPLY_ID: 34237,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Created message with ID:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function sendMessage() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.message.add',
        params: {
          DIALOG_ID: 'chat2941',
          MESSAGE: 'Message text',
          SYSTEM: 'N',
          URL_PREVIEW: 'Y',
          REPLY_ID: 34237,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Created message with ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', sendMessage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.message.add(
        dialog_id="chat2941",
        message="Текст сообщения",
        system=False,
        url_preview=True,
        reply_id=34237,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'im.message.add',
            [
                'DIALOG_ID' => 'chat2941',
                'MESSAGE' => 'Текст сообщения',
                'SYSTEM' => 'N',
                'URL_PREVIEW' => 'Y',
                'REPLY_ID' => 34237
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding message: ' . $e->getMessage();
}
BX24.callMethod(
    'im.message.add',
    {
        DIALOG_ID: 'chat2941',
        MESSAGE: 'Текст сообщения',
        SYSTEM: 'N',
        URL_PREVIEW: 'Y',
        REPLY_ID: 34237
    },
    function(result)
    {
        if (result.error())
            console.error(result.error());
        else
            console.log(result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'im.message.add',
    [
        'DIALOG_ID' => 'chat2941',
        'MESSAGE' => 'Текст сообщения',
        'SYSTEM' => 'N',
        'URL_PREVIEW' => 'Y',
        'REPLY_ID' => 34237
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.message.add", b24.Params{
	"DIALOG_ID":   "chat2941",
	"MESSAGE":     "Текст сообщения",
	"SYSTEM":      "N",
	"URL_PREVIEW": "Y",
	"REPLY_ID":    34237,
})
if err != nil {
	return fmt.Errorf("im.message.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)

Обработка ответа

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"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Описание

Значение

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

Нельзя отвечать на сообщение из другого чата

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение