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

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.callMethod(
                'im.message.add',
                {
                    DIALOG_ID: 'chat2941',
                    MESSAGE: 'Текст сообщения',
                    SYSTEM: 'N',
                    URL_PREVIEW: 'Y',
                    REPLY_ID: 34237
                }
            );
            
            const result = response.getData().result;
            console.log('Created message with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', 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>';

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

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`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`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-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Работа с контекстным меню

Изменить отправленное сообщение

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

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

Примеры кодаПримеры кода

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

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

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

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

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

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