Отправить сообщение пользователю от имени открытой линии imopenlines.network.message.add

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

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

Scope: imopenlines

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

Метод imopenlines.network.message.add отправляет сообщение пользователю от имени открытой линии, подключенной в Битрикс24 Network.

Ограничения работы метода:

  1. Метод недоступен при сессионной авторизации. Для сессионной авторизации возвращает ошибку WRONG_AUTH_TYPE
  2. Можно отправлять сообщение не более одного раза для каждого пользователя в течение одной недели. Для аккаунта с лицензией Партнера (NFR) ограничений по лимиту нет
  3. Можно использовать клавиатуру только для форматирования кнопки ссылки на стороннем сайте

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

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

Название
тип

Описание

CODE*
string

Код открытой линии, строка из 32 символов, например ab515f5d85a8b844d484f6ea75a2e494

USER_ID*
integer

Идентификатор получателя сообщения, например 2

MESSAGE*
string

Текст сообщения.

Как форматировать текст — в статье форматирование

ATTACH
object

Вложение.

Формат вложения описан в статье Как использовать вложения

KEYBOARD
object

Клавиатура.

Как создавать клавиатуры — в статье Работа с клавиатурами

URL_PREVIEW
char

Предпросмотр ссылок. Включен Y по умолчанию.

Передайте N, чтобы отключить предпросмотр ссылок

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "CODE": "ab515f5d85a8b844d484f6ea75a2e494",
    "USER_ID": 2,
    "MESSAGE": "Подготовили материалы по подключению открытых линий",
    "ATTACH": {
      "ID": 1,
      "COLOR_TOKEN": "primary",
      "BLOCKS": [
        {
          "MESSAGE": "Во вложении отправили чек-лист и схему подключения"
        },
        {
          "FILE": [
            {
              "NAME": "checklist-openlines.pdf",
              "LINK": "https://cdn.example.com/docs/checklist-openlines.pdf",
              "SIZE": 428736
            }
          ]
        },
        {
          "IMAGE": [
            {
              "NAME": "Схема подключения",
              "LINK": "https://cdn.example.com/images/openlines-setup.png",
              "PREVIEW": "https://cdn.example.com/images/openlines-setup-preview.png",
              "WIDTH": 1280,
              "HEIGHT": 720
            }
          ]
        }
      ]
    },
    "KEYBOARD": {
      "BUTTONS": [
        {
          "TEXT": "Открыть инструкцию",
          "LINK": "https://help.example.com/openlines/setup",
          "DISPLAY": "LINE",
          "BG_COLOR_TOKEN": "primary"
        }
      ]
    },
    "URL_PREVIEW": "N"
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.network.message.add
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "CODE": "ab515f5d85a8b844d484f6ea75a2e494",
    "USER_ID": 2,
    "MESSAGE": "Подготовили материалы по подключению открытых линий",
    "ATTACH": {
      "ID": 1,
      "COLOR_TOKEN": "primary",
      "BLOCKS": [
        {
          "MESSAGE": "Во вложении отправили чек-лист и схему подключения"
        },
        {
          "FILE": [
            {
              "NAME": "checklist-openlines.pdf",
              "LINK": "https://cdn.example.com/docs/checklist-openlines.pdf",
              "SIZE": 428736
            }
          ]
        },
        {
          "IMAGE": [
            {
              "NAME": "Схема подключения",
              "LINK": "https://cdn.example.com/images/openlines-setup.png",
              "PREVIEW": "https://cdn.example.com/images/openlines-setup-preview.png",
              "WIDTH": 1280,
              "HEIGHT": 720
            }
          ]
        }
      ]
    },
    "KEYBOARD": {
      "BUTTONS": [
        {
          "TEXT": "Открыть инструкцию",
          "LINK": "https://help.example.com/openlines/setup",
          "DISPLAY": "LINE",
          "BG_COLOR_TOKEN": "primary"
        }
      ]
    },
    "URL_PREVIEW": "N",
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/imopenlines.network.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<boolean>({
    method: 'imopenlines.network.message.add',
    params: {
      CODE: 'ab515f5d85a8b844d484f6ea75a2e494',
      USER_ID: 2,
      MESSAGE: 'We have prepared materials on connecting open lines',
      ATTACH: {
        ID: 1,
        COLOR_TOKEN: 'primary',
        BLOCKS: [
          {
            MESSAGE: 'Attached are the checklist and connection diagram',
          },
          {
            FILE: [
              {
                NAME: 'checklist-openlines.pdf',
                LINK: 'https://cdn.example.com/docs/checklist-openlines.pdf',
                SIZE: 428736,
              },
            ],
          },
          {
            IMAGE: [
              {
                NAME: 'Connection diagram',
                LINK: 'https://cdn.example.com/images/openlines-setup.png',
                PREVIEW: 'https://cdn.example.com/images/openlines-setup-preview.png',
                WIDTH: 1280,
                HEIGHT: 720,
              },
            ],
          },
        ],
      },
      KEYBOARD: {
        BUTTONS: [
          {
            TEXT: 'Open instructions',
            LINK: 'https://help.example.com/openlines/setup',
            DISPLAY: 'LINE',
            BG_COLOR_TOKEN: 'primary',
          },
        ],
      },
      URL_PREVIEW: 'N',
    },
    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('Message sent successfully:', 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 sendNetworkMessage() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'imopenlines.network.message.add',
        params: {
          CODE: 'ab515f5d85a8b844d484f6ea75a2e494',
          USER_ID: 2,
          MESSAGE: 'We have prepared materials on connecting open lines',
          ATTACH: {
            ID: 1,
            COLOR_TOKEN: 'primary',
            BLOCKS: [
              {
                MESSAGE: 'Attached are the checklist and connection diagram',
              },
              {
                FILE: [
                  {
                    NAME: 'checklist-openlines.pdf',
                    LINK: 'https://cdn.example.com/docs/checklist-openlines.pdf',
                    SIZE: 428736,
                  },
                ],
              },
              {
                IMAGE: [
                  {
                    NAME: 'Connection diagram',
                    LINK: 'https://cdn.example.com/images/openlines-setup.png',
                    PREVIEW: 'https://cdn.example.com/images/openlines-setup-preview.png',
                    WIDTH: 1280,
                    HEIGHT: 720,
                  },
                ],
              },
            ],
          },
          KEYBOARD: {
            BUTTONS: [
              {
                TEXT: 'Open instructions',
                LINK: 'https://help.example.com/openlines/setup',
                DISPLAY: 'LINE',
                BG_COLOR_TOKEN: 'primary',
              },
            ],
          },
          URL_PREVIEW: 'N',
        },
        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('Message sent successfully:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.imopenlines.network.message.add(
        code="ab515f5d85a8b844d484f6ea75a2e494",
        user_id=2,
        message="We have prepared materials on connecting open lines",
        attach={
            "ID": 1,
            "COLOR_TOKEN": "primary",
            "BLOCKS": [
                {
                    "MESSAGE": "Attached are the checklist and connection diagram",
                },
                {
                    "FILE": [
                        {
                            "NAME": "checklist-openlines.pdf",
                            "LINK": "https://cdn.example.com/docs/checklist-openlines.pdf",
                            "SIZE": 428736,
                        },
                    ],
                },
                {
                    "IMAGE": [
                        {
                            "NAME": "Connection diagram",
                            "LINK": "https://cdn.example.com/images/openlines-setup.png",
                            "PREVIEW": "https://cdn.example.com/images/openlines-setup-preview.png",
                            "WIDTH": 1280,
                            "HEIGHT": 720,
                        },
                    ],
                },
            ],
        },
        keyboard={
            "BUTTONS": [
                {
                    "TEXT": "Open instructions",
                    "LINK": "https://help.example.com/openlines/setup",
                    "DISPLAY": "LINE",
                    "BG_COLOR_TOKEN": "primary",
                },
            ],
        },
        url_preview=False,
    ).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.network.message.add',
            [
                'CODE' => 'ab515f5d85a8b844d484f6ea75a2e494',
                'USER_ID' => 2,
                'MESSAGE' => 'Подготовили материалы по подключению открытых линий',
                'ATTACH' => [
                    'ID' => 1,
                    'COLOR_TOKEN' => 'primary',
                    'BLOCKS' => [
                        [
                            'MESSAGE' => 'Во вложении отправили чек-лист и схему подключения'
                        ],
                        [
                            'FILE' => [
                                [
                                    'NAME' => 'checklist-openlines.pdf',
                                    'LINK' => 'https://cdn.example.com/docs/checklist-openlines.pdf',
                                    'SIZE' => 428736
                                ]
                            ]
                        ],
                        [
                            'IMAGE' => [
                                [
                                    'NAME' => 'Схема подключения',
                                    'LINK' => 'https://cdn.example.com/images/openlines-setup.png',
                                    'PREVIEW' => 'https://cdn.example.com/images/openlines-setup-preview.png',
                                    'WIDTH' => 1280,
                                    'HEIGHT' => 720
                                ]
                            ]
                        ]
                    ]
                ],
                'KEYBOARD' => [
                    'BUTTONS' => [
                        [
                            'TEXT' => 'Открыть инструкцию',
                            'LINK' => 'https://help.example.com/openlines/setup',
                            'DISPLAY' => 'LINE',
                            'BG_COLOR_TOKEN' => 'primary'
                        ]
                    ]
                ],
                'URL_PREVIEW' => 'N',
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
BX24.callMethod(
    'imopenlines.network.message.add',
    {
        CODE: 'ab515f5d85a8b844d484f6ea75a2e494',
        USER_ID: 2,
        MESSAGE: 'Подготовили материалы по подключению открытых линий',
        ATTACH: {
            ID: 1,
            COLOR_TOKEN: 'primary',
            BLOCKS: [
                {
                    MESSAGE: 'Во вложении отправили чек-лист и схему подключения'
                },
                {
                    FILE: [
                        {
                            NAME: 'checklist-openlines.pdf',
                            LINK: 'https://cdn.example.com/docs/checklist-openlines.pdf',
                            SIZE: 428736
                        }
                    ]
                },
                {
                    IMAGE: [
                        {
                            NAME: 'Схема подключения',
                            LINK: 'https://cdn.example.com/images/openlines-setup.png',
                            PREVIEW: 'https://cdn.example.com/images/openlines-setup-preview.png',
                            WIDTH: 1280,
                            HEIGHT: 720
                        }
                    ]
                }
            ]
        },
        KEYBOARD: {
            BUTTONS: [
                {
                    TEXT: 'Открыть инструкцию',
                    LINK: 'https://help.example.com/openlines/setup',
                    DISPLAY: 'LINE',
                    BG_COLOR_TOKEN: 'primary'
                }
            ]
        },
        URL_PREVIEW: 'N'
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'imopenlines.network.message.add',
    [
        'CODE' => 'ab515f5d85a8b844d484f6ea75a2e494',
        'USER_ID' => 2,
        'MESSAGE' => 'Подготовили материалы по подключению открытых линий',
        'ATTACH' => [
            'ID' => 1,
            'COLOR_TOKEN' => 'primary',
            'BLOCKS' => [
                [
                    'MESSAGE' => 'Во вложении отправили чек-лист и схему подключения'
                ],
                [
                    'FILE' => [
                        [
                            'NAME' => 'checklist-openlines.pdf',
                            'LINK' => 'https://cdn.example.com/docs/checklist-openlines.pdf',
                            'SIZE' => 428736
                        ]
                    ]
                ],
                [
                    'IMAGE' => [
                        [
                            'NAME' => 'Схема подключения',
                            'LINK' => 'https://cdn.example.com/images/openlines-setup.png',
                            'PREVIEW' => 'https://cdn.example.com/images/openlines-setup-preview.png',
                            'WIDTH' => 1280,
                            'HEIGHT' => 720
                        ]
                    ]
                ]
            ]
        ],
        'KEYBOARD' => [
            'BUTTONS' => [
                [
                    'TEXT' => 'Открыть инструкцию',
                    'LINK' => 'https://help.example.com/openlines/setup',
                    'DISPLAY' => 'LINE',
                    'BG_COLOR_TOKEN' => 'primary'
                ]
            ]
        ],
        'URL_PREVIEW' => 'N',
    ]
);

print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imopenlines.network.message.add", b24.Params{
	"CODE":    "ab515f5d85a8b844d484f6ea75a2e494",
	"USER_ID": 2,
	"MESSAGE": "Подготовили материалы по подключению открытых линий",
	"ATTACH": b24.Params{
		"ID":          1,
		"COLOR_TOKEN": "primary",
		"BLOCKS": []b24.Params{
			{
				"MESSAGE": "Во вложении отправили чек-лист и схему подключения",
			},
			{
				"FILE": []b24.Params{
					{
						"NAME": "checklist-openlines.pdf",
						"LINK": "https://cdn.example.com/docs/checklist-openlines.pdf",
						"SIZE": 428736,
					},
				},
			},
			{
				"IMAGE": []b24.Params{
					{
						"NAME":    "Схема подключения",
						"LINK":    "https://cdn.example.com/images/openlines-setup.png",
						"PREVIEW": "https://cdn.example.com/images/openlines-setup-preview.png",
						"WIDTH":   1280,
						"HEIGHT":  720,
					},
				},
			},
		},
	},
	"KEYBOARD": b24.Params{
		"BUTTONS": []b24.Params{
			{
				"TEXT":           "Открыть инструкцию",
				"LINK":           "https://help.example.com/openlines/setup",
				"DISPLAY":        "LINE",
				"BG_COLOR_TOKEN": "primary",
			},
		},
	},
	"URL_PREVIEW": "N",
})
if err != nil {
	return fmt.Errorf("imopenlines.network.message.add: %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": 1773740787,
        "finish": 1773740787.828814,
        "duration": 0.8288140296936035,
        "processing": 0,
        "date_start": "2026-03-17T12:46:27+03:00",
        "date_finish": "2026-03-17T12:46:27+03:00",
        "operating_reset_at": 1773741387,
        "operating": 0.17312097549438477
    }
}

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

Название
тип

Описание

result
boolean

Возвращает true, если сообщение отправлено

time
time

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

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

HTTP-статус: 400

{
    "error": "CODE",
    "error_description": "You entered an invalid code"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

403

WRONG_AUTH_TYPE

Access for this method not allowed by session authorization

Метод вызван с сессионной авторизацией

400

CODE

You entered an invalid code

Некорректный код в параметре CODE, ожидается строка из 32 символов

400

IMBOT_ERROR

Module IMBOT is not installed

Не установлен модуль imbot

400

NOT_FOUND

Line not found

Открытая линия не найдена

400

USER_ID_EMPTY

User ID can't be empty

Не указан идентификатор пользователя

400

USER_MESSAGE_LIMIT

You cant send more than one message per week to each user

Превышен лимит сообщений для конкретного пользователя

400

MESSAGE_EMPTY

Message can't be empty

Не указан текст сообщения

400

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

Превышен максимально допустимый размер вложения 30 Кб

400

ATTACH_ERROR

Incorrect attach params

Объект вложения не прошел проверку

400

KEYBOARD_ERROR

Incorrect keyboard params

Объект клавиатуры не прошел проверку

400

WRONG_REQUEST

Message isn't added

Сообщение не отправлено

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

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

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

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