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

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

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

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 -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
// 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<boolean>({
    method: 'imopenlines.bot.session.message.send',
    params: {
      CHAT_ID: 112,
      NAME: 'DEFAULT',
      MESSAGE: 'Hello! How can I help you?',
    },
    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('Auto message sent:', 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 sendSessionMessage() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'imopenlines.bot.session.message.send',
        params: {
          CHAT_ID: 112,
          NAME: 'DEFAULT',
          MESSAGE: 'Hello! How can I help you?',
        },
        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('Auto message sent:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.imopenlines.bot.session.message.send(
        chat_id=112,
        name="DEFAULT",
        message="Hello! How can I help you?",
    ).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(
            '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);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imopenlines.bot.session.message.send", b24.Params{
	"CHAT_ID": 112,
	"NAME":    "DEFAULT",
	"MESSAGE": "Здравствуйте! Чем могу помочь?",
})
if err != nil {
	return fmt.Errorf("imopenlines.bot.session.message.send: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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
string

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

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

Статус

Код

Описание

Значение

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-статус: 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

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

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