Send a message to a user on behalf of the Open Channel imopenlines.network.message.add

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: imopenlines

Who can execute the method: any user

The method imopenlines.network.message.add sends a message to a user on behalf of the open channel connected in Bitrix24 Network.

Method operation limitations:

The method is unavailable during session authorization. It returns the error WRONG_AUTH_TYPE for session authorization.
A message can be sent no more than once per user within one week. There are no limits for accounts with a Partner (NFR) license.
The keyboard can only be used for formatting the link button to an external site.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CODE* `string`	Code of the open channel, a string of 32 characters, for example `ab515f5d85a8b844d484f6ea75a2e494`
USER_ID* `integer`	Identifier of the message recipient, for example `2`
MESSAGE* `string`	Text of the message. How to format text — in the article formatting
ATTACH `object`	Attachment. The format of the attachment is described in the article How to use attachments
KEYBOARD `object`	Keyboard. How to create keyboards — in the article Working with keyboards
URL_PREVIEW `char`	Link preview. Enabled `Y` by default. Pass `N` to disable link preview

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "CODE": "ab515f5d85a8b844d484f6ea75a2e494",
            "USER_ID": 2,
            "MESSAGE": "We have prepared materials for connecting open channels",
            "ATTACH": {
              "ID": 1,
              "COLOR_TOKEN": "primary",
              "BLOCKS": [
                {
                  "MESSAGE": "We have sent a checklist and connection diagram in the attachment"
                },
                {
                  "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"
          }' \
          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": "We have prepared materials for connecting open channels",
            "ATTACH": {
              "ID": 1,
              "COLOR_TOKEN": "primary",
              "BLOCKS": [
                {
                  "MESSAGE": "We have sent a checklist and connection diagram in the attachment"
                },
                {
                  "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",
            "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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.network.message.add',
                    [
                        'CODE' => 'ab515f5d85a8b844d484f6ea75a2e494',
                        'USER_ID' => 2,
                        'MESSAGE' => 'We have prepared materials for connecting open channels',
                        'ATTACH' => [
                            'ID' => 1,
                            'COLOR_TOKEN' => 'primary',
                            'BLOCKS' => [
                                [
                                    'MESSAGE' => 'We have sent a checklist and connection diagram in the attachment'
                                ],
                                [
                                    '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',
                    ]
                );
        
            $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: 'We have prepared materials for connecting open channels',
                ATTACH: {
                    ID: 1,
                    COLOR_TOKEN: 'primary',
                    BLOCKS: [
                        {
                            MESSAGE: 'We have sent a checklist and connection diagram in the attachment'
                        },
                        {
                            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'
            },
            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' => 'We have prepared materials for connecting open channels',
                'ATTACH' => [
                    'ID' => 1,
                    'COLOR_TOKEN' => 'primary',
                    'BLOCKS' => [
                        [
                            'MESSAGE' => 'We have sent a checklist and connection diagram in the attachment'
                        ],
                        [
                            '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',
            ]
        );
        
        print_r($result);

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imopenlines.network.message.add", b24.Params{
        	"CODE":    "ab515f5d85a8b844d484f6ea75a2e494",
        	"USER_ID": 2,
        	"MESSAGE": "We have prepared materials for connecting open channels",
        	"ATTACH": b24.Params{
        		"ID":          1,
        		"COLOR_TOKEN": "primary",
        		"BLOCKS": []b24.Params{
        			{
        				"MESSAGE": "We have sent a checklist and connection diagram in the attachment",
        			},
        			{
        				"FILE": []b24.Params{
        					{
        						"NAME": "checklist-openlines.pdf",
        						"LINK": "https://cdn.example.com/docs/checklist-openlines.pdf",
        						"SIZE": 428736,
        					},
        				},
        			},
        			{
        				"IMAGE": []b24.Params{
        					{
        						"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": b24.Params{
        		"BUTTONS": []b24.Params{
        			{
        				"TEXT":           "Open Instructions",
        				"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("parse response: %w", err)
        }
        fmt.Println("done:", ok)

Response Handling

HTTP Status: 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
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Returns `true` if the message was sent
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

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

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status	Code	Description	Value
`403`	`WRONG_AUTH_TYPE`	Access for this method not allowed by session authorization	Method called with session authorization
`400`	`CODE`	You entered an invalid code	Invalid code in the `CODE` parameter, expected a string of 32 characters
`400`	`IMBOT_ERROR`	Module IMBOT is not installed	IMBOT module is not installed
`400`	`NOT_FOUND`	Line not found	Open channel not found
`400`	`USER_ID_EMPTY`	User ID can't be empty	User identifier not specified
`400`	`USER_MESSAGE_LIMIT`	You can't send more than one message per week to each user	Message limit exceeded for a specific user
`400`	`MESSAGE_EMPTY`	Message can't be empty	Message text not specified
`400`	`ATTACH_OVERSIZE`	You have exceeded the maximum allowable size of attach	Maximum allowable attachment size exceeded 30 KB
`400`	`ATTACH_ERROR`	Incorrect attach params	Attachment object failed validation
`400`	`KEYBOARD_ERROR`	Incorrect keyboard params	Keyboard object failed validation
`400`	`WRONG_REQUEST`	Message isn't added	Message not sent

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Connect External Open Channel to Account

Get Link to Public Page of Open Channels in Account

Send a message to a user on behalf of the Open Channel imopenlines.network.message.add

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning