Отправить автоматическое сообщение в диалог imopenlines.bot.session.message.send

Scope: imopenlines, imbot

Кто может выполнять метод: любой пользователь

Метод imopenlines.bot.session.message.send отправляет в диалог открытой линии автоматическое сообщение от чат-бота приложения.

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

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

Название `тип`	Описание
CHAT_ID* `integer`	Идентификатор чата, в который метод отправляет сообщение. Идентификатор чата можно получить с помощью методов imopenlines.dialog.get или imopenlines.crm.chat.get
NAME `string`	Код типа автоответа. Допустимые значения: `WELCOME` — отправляет автоматическое приветствие из настроек Открытой линии, параметр `MESSAGE` в этом режиме игнорируется `DEFAULT` — отправляет текст из параметра `MESSAGE`
MESSAGE `string`	Текст сообщения для режима `NAME=DEFAULT`. По умолчанию используется пустая строка. Если передать `NAME=DEFAULT` и пустой `MESSAGE`, новое сообщение в чат не добавится

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CHAT_ID":112,"NAME":"DEFAULT","MESSAGE":"Здравствуйте! Чем могу помочь?"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.bot.session.message.send

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CHAT_ID":112,"NAME":"DEFAULT","MESSAGE":"Здравствуйте! Чем могу помочь?","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imopenlines.bot.session.message.send

try {
          const response = await $b24.callMethod('imopenlines.bot.session.message.send', {
            CHAT_ID: 112,
            NAME: 'DEFAULT',
            MESSAGE: 'Здравствуйте! Чем могу помочь?',
          });
        
          const { result } = response.getData();
          console.log('Auto message sent:', result);
        } catch (error) {
          console.error('Error sending auto message:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.bot.session.message.send',
                    [
                        'CHAT_ID' => 112,
                        'NAME' => 'DEFAULT',
                        'MESSAGE' => 'Здравствуйте! Чем могу помочь?',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Auto message sent: ' . var_export($result, true);
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error sending auto message: ' . $exception->getMessage();
        }

BX24.callMethod(
            'imopenlines.bot.session.message.send',
            {
                CHAT_ID: 112,
                NAME: 'DEFAULT',
                MESSAGE: 'Здравствуйте! Чем могу помочь?',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.bot.session.message.send',
            [
                'CHAT_ID' => 112,
                'NAME' => 'DEFAULT',
                'MESSAGE' => 'Здравствуйте! Чем могу помочь?',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Auto message sent: ' . var_export($result['result'], true);
        }

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1728626400.456,
                "finish": 1728626400.539,
                "duration": 0.083,
                "processing": 0.031,
                "date_start": "2024-10-11T10:00:00+03:00",
                "date_finish": "2024-10-11T10:00:00+03:00",
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `boolean`	Флаг успешного вызова метода. Метод не возвращает признак фактического создания сообщения в чате
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400, 403

{
            "error": "CHAT_ID_EMPTY",
            "error_description": "Chat ID can't be empty"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус	Код	Описание	Значение
`400`	`CHAT_ID_EMPTY`	Chat ID can't be empty	Не передан `CHAT_ID` или передано значение `<= 0`
`403`	`WRONG_AUTH_TYPE`	Access for this method not allowed by session authorization	Метод вызван с сессионной авторизацией, для которой он запрещен

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

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

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

Обзор методов

Переключить диалог на свободного оператора

Отправить автоматическое сообщение в диалог imopenlines.bot.session.message.send

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

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

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

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

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

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

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

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