Отправить сообщение в открытую линию imopenlines.crm.message.add

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

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

Scope: imopenlines

Кто может выполнять метод: пользователь с правом чтения элемента CRM, к которому привязан чат

Метод imopenlines.crm.message.add отправляет сообщение от имени сотрудника или бота в чат, который привязан к элементу CRM.

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

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

Название
Тип

Описание

CRM_ENTITY_TYPE*
string

Тип объекта CRM:

  • lead — лид
  • deal — сделка
  • company — компания
  • contact — контакт

CRM_ENTITY*
integer

Идентификатор элемента CRM, к которому привязан чат.

Список элементов определенного типа объекта CRM можно получить с помощью метода crm.item.list

USER_ID*
integer

Идентификатор отправителя сообщения — пользователя или бота, который должен быть участником чата и иметь доступ к элементу CRM.

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

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

CHAT_ID*
integer

Идентификатор чата открытой линии, который связан с элементом CRM.

Идентификатор чата можно получить с помощью метода imopenlines.crm.chat.get или imopenlines.dialog.get

MESSAGE*
string

Текст сообщения, который будет отображен в чате

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1195,"USER_ID":27,"CHAT_ID":1341,"MESSAGE":"Текст сообщения"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.crm.message.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1195,"USER_ID":27,"CHAT_ID":1341,"MESSAGE":"Текст сообщения","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/imopenlines.crm.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: 'imopenlines.crm.message.add',
            params: {
              CRM_ENTITY_TYPE: 'lead',
              CRM_ENTITY: 1195,
              USER_ID: 27,
              CHAT_ID: 1341,
              MESSAGE: 'Message text',
            },
            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 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 sendCrmMessage() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'imopenlines.crm.message.add',
                params: {
                  CRM_ENTITY_TYPE: 'lead',
                  CRM_ENTITY: 1195,
                  USER_ID: 27,
                  CHAT_ID: 1341,
                  MESSAGE: 'Message text',
                },
                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 ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', sendCrmMessage)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.crm.message.add',
                    [
                        'CRM_ENTITY_TYPE' => 'lead',
                        'CRM_ENTITY' => 1195,
                        'USER_ID' => 27,
                        'CHAT_ID' => 1341,
                        'MESSAGE' => 'Текст сообщения',
                    ]
                );
        
            $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(
            'imopenlines.crm.message.add',
            {
                CRM_ENTITY_TYPE: 'lead',
                CRM_ENTITY: 1195,
                USER_ID: 27,
                CHAT_ID: 1341,
                MESSAGE: 'Текст сообщения',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.crm.message.add',
            [
                'CRM_ENTITY_TYPE' => 'lead',
                'CRM_ENTITY' => 1195,
                'USER_ID' => 27,
                'CHAT_ID' => 1341,
                'MESSAGE' => 'Текст сообщения',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Created message ID: ' . $result['result'];
        }
        
// client и ctx уже созданы — см. раздел «SDK для Go»
        res, err := client.Core().Call(ctx, "imopenlines.crm.message.add", b24.Params{
        	"CRM_ENTITY_TYPE": "lead",
        	"CRM_ENTITY":      1195,
        	"USER_ID":         27,
        	"CHAT_ID":         1341,
        	"MESSAGE":         "Текст сообщения",
        })
        if err != nil {
        	return fmt.Errorf("imopenlines.crm.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": 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": "CHAT_NOT_IN_CRM",
            "error_description": "Chat does not belong to the CRM entity being checked"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

CHAT_NOT_IN_CRM

Chat does not belong to the CRM entity being checked

Чат не связан с CRM

CANCELED

Вы не можете отправлять сообщения в указанный чат

У пользователя нет доступа к чату

ACCESS_DENIED

Access denied! User dont have access to this entity

У пользователя нет доступа к объекту CRM

ERROR_ARGUMENT

Argument CRM_ENTITY_TYPE is null or empty

Неверно указан обязательный параметр CRM_ENTITY_TYPE

ERROR_ARGUMENT

Argument CRM_ENTITY is null or empty

Неверно указан обязательный параметр CRM_ENTITY

ERROR_ARGUMENT

Argument USER_ID is null or empty

Неверно указан обязательный параметр USER_ID

ERROR_ARGUMENT

Argument MESSAGE is null or empty

Неверно указан обязательный параметр MESSAGE

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

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

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

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