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

Scope: imbot

Кто может выполнять метод: авторизованный пользователь приложения, которое зарегистрировало чат-бота. Метод работает только с ботами этого приложения.

DEPRECATED

Развитие метода остановлено. Используйте imbot.v2.Chat.Message.send.

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

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

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

Название
Тип

Описание

BOT_ID
integer

Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list.

Если параметр не передан, метод ищет первого бота, который зарегистрирован текущим приложением

DIALOG_ID
string

Идентификатор объекта, который получит сообщение: пользователь или чат.

Поддерживаемые форматы:

  • USER_ID — идентификатор пользователя, который можно получить через user.get или user.search
  • chatXXX, где XXX — идентификатор чата, который можно получить через imbot.chat.get

Параметр обязателен, если не переданы одновременно FROM_USER_ID и TO_USER_ID.

FROM_USER_ID
integer

Идентификатор пользователя-отправителя для отправки в приватный диалог. Получить идентификатор пользователя можно с помощью user.get и user.search.

Используется только вместе с TO_USER_ID. Если оба параметра переданы и больше 0, поле DIALOG_ID игнорируется, а SYSTEM принудительно становится Y

TO_USER_ID
integer

Идентификатор пользователя-получателя для отправки в приватный диалог. Получить идентификатор пользователя можно с помощью user.get и user.search.

Используется только вместе с FROM_USER_ID

MESSAGE*
string

Текст сообщения. Метод автоматически убирает пробелы и переносы по краям текста сообщения

ATTACH
object
string

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

  • строку JSON
  • объект с корневым ключом BLOCKS
  • массив блоков без обертки

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

KEYBOARD
object
string

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

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

MENU
object
string

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

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

SYSTEM
string

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

Допустимые значения:

  • Y — системное сообщение
  • N — обычное сообщение, значение по умолчанию

В режиме FROM_USER_ID + TO_USER_ID значение принудительно устанавливается в Y.

URL_PREVIEW
string

Управляет отображением ссылок: при включении ссылка показывается как «богатая ссылка» с карточкой.

Допустимые значения:

  • Y — включено, по умолчанию
  • N — выключено

SKIP_CONNECTOR
string

Пропустить отправку сообщения во внешние коннекторы открытых линий.

Допустимые значения:

  • Y — пропустить
  • N — не пропускать (по умолчанию)

CLIENT_ID
string

Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота

Примеры кода

Как использовать примеры в документации

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"BOT_ID":39,"DIALOG_ID":"chat123","MESSAGE":"Текст сообщения","SYSTEM":"N","URL_PREVIEW":"Y","CLIENT_ID":"**put_your_client_id_here**"}' /
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.message.add
        
curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"BOT_ID":39,"DIALOG_ID":"chat123","MESSAGE":"Текст сообщения","auth":"**put_access_token_here**"}' /
          https://**put_your_bitrix24_address**/rest/imbot.message.add
        
try {
          const response = await $b24.callMethod('imbot.message.add', {
            BOT_ID: 39,
            DIALOG_ID: 'chat123',
            MESSAGE: 'Текст сообщения',
            URL_PREVIEW: 'Y',
          });
        
          const { result } = response.getData();
          console.log('Created message ID:', result);
        } catch (error) {
          console.error('Error sending message:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.message.add',
                    [
                        'BOT_ID' => 39,
                        'DIALOG_ID' => 'chat123',
                        'MESSAGE' => 'Текст сообщения',
                        'URL_PREVIEW' => 'Y',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Created message ID: ' . $result->data();
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error sending message: ' . $exception->getMessage();
        }
        
BX24.callMethod(
            'imbot.message.add',
            {
                BOT_ID: 39,
                DIALOG_ID: 'chat123',
                MESSAGE: 'Текст сообщения',
                URL_PREVIEW: 'Y',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imbot.message.add',
            [
                'BOT_ID' => 39,
                'DIALOG_ID' => 'chat123',
                'MESSAGE' => 'Текст сообщения',
                'URL_PREVIEW' => 'Y',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Created message ID: ' . $result['result'];
        }

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

HTTP-код: 200

{
            "result": 19880117,
            "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",
                "operating_reset_at": 1762349466,
                "operating": 0
            }
        }

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

Название
Тип

Описание

result
integer

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

time
time

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

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

HTTP-статус: 400

{
            "error": "MESSAGE_EMPTY",
            "error_description": "Message can't be empty"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

BOT_ID_ERROR

Bot not found

Бот не найден или у приложения нет доступного бота для автоподстановки BOT_ID

APP_ID_ERROR

Bot was installed by another rest application

Переданный BOT_ID принадлежит другому приложению

DIALOG_ID_EMPTY

Dialog ID can't be empty

Не передан корректный DIALOG_ID, если не используется пара FROM_USER_ID и TO_USER_ID

MESSAGE_EMPTY

Message can't be empty

Не передан текст сообщения

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

Превышен допустимый размер ATTACH — 30 Кб

ATTACH_ERROR

Incorrect attach params

Невалидная структура ATTACH

KEYBOARD_ERROR

Incorrect keyboard params

Невалидная структура KEYBOARD

KEYBOARD_OVERSIZE

You have exceeded the maximum allowable size of keyboard

Превышен допустимый размер KEYBOARD — 30 Кб

MENU_ERROR

Incorrect menu params

Невалидная структура MENU

MENU_OVERSIZE

You have exceeded the maximum allowable size of menu

Превышен допустимый размер MENU — 30 Кб

WRONG_REQUEST

Message isn't added

Внутренняя ошибка при добавлении сообщения

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

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

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

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

Предыдущая
Обзор методов
Следующая
Изменить отправленное сообщение