Register the Connector imconnector.register

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 imconnector.register registers a custom connector for Open Channels.

If the method is called again with the same ID, the method updates the current connector.

The method works only in the context of an application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
ID* `string`	Unique identifier for the connector. The method converts the value to lowercase. It is recommended to add a unique prefix at the beginning of the identifier to avoid conflicts with existing and future identifiers of other connectors. Use digits, lowercase letters, and the underscore `_` to form the identifier. The `.` character is prohibited. Use this value in all methods where the connector identifier is required — usually in the `CONNECTOR` parameter
NAME* `string`	Name of the connector in the interface
ICON* `object`	Parameters for the main icon. The structure of the object is described in detail below
PLACEMENT_HANDLER* `string`	URL of the embedding handler for the connector settings. At this address, Bitrix24 opens the settings interface in a slider for the user. Read more about embedding interfaces in the article Widget Embedding Mechanism
ICON_DISABLED `object`	Parameters for the inactive state icon. The structure of the object is described in detail below
DEL_EXTERNAL_MESSAGES `boolean`	Allows deleting incoming messages. Default value is `true`
EDIT_INTERNAL_MESSAGES `boolean`	Allows editing operator messages. Default value is `true`
DEL_INTERNAL_MESSAGES `boolean`	Allows deleting operator messages. Default value is `true`
NEWSLETTER `boolean`	Allows using the channel in CRM newsletters. Default value is `true`
NEED_SYSTEM_MESSAGES `boolean`	Allows sending system messages to the channel. Default value is `true`
NEED_SIGNATURE `boolean`	Adds the operator's signature to messages. Default value is `true`
CHAT_GROUP `boolean`	Connector chat processing mode indicator: `true` — grouping by `chat.id` (group chat), `false` — by `user.id` (one-on-one chat). Default value is `false`. In group mode, the incoming message CRM tracker is not launched. Because of this, standard CRM auto-linking and auto-creation of CRM items may not be performed for some dialogues. If a one-on-one chat with CRM auto-linking is required for the connector, pass `false`

Parameter ICON

Name `type`	Description
DATA_IMAGE* `string`	SVG icon in Data URI format: a string with the prefix `data:image/svg+xml,`, followed by the SVG content, usually URL-encoded
COLOR `string`	Background color of the icon. Example: `#69acc0`
SIZE `string`	Background size. Example: `90%`
POSITION `string`	Background position. Example: `center`

Parameter ICON_DISABLED

Name `type`	Description
DATA_IMAGE `string`	SVG icon for the inactive state in Data URI format: a string with the prefix `data:image/svg+xml,`, followed by the SVG content, usually URL-encoded
COLOR `string`	Background color of the inactive icon
SIZE `string`	Background size of the inactive icon
POSITION `string`	Background position of the inactive icon

Code Examples

How to Use Examples in Documentation

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 '{
            "ID": "myconnector",
            "NAME": "Mein Connector",
            "ICON": {
              "DATA_IMAGE": "data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E",
              "COLOR": "#69acc0",
              "SIZE": "90%",
              "POSITION": "center"
            },
            "PLACEMENT_HANDLER": "https://example.com/connector/settings",
            "ICON_DISABLED": {
              "DATA_IMAGE": "data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E",
              "COLOR": "#99adb3"
            },
            "DEL_EXTERNAL_MESSAGES": true,
            "EDIT_INTERNAL_MESSAGES": true,
            "DEL_INTERNAL_MESSAGES": true,
            "NEWSLETTER": true,
            "NEED_SYSTEM_MESSAGES": true,
            "NEED_SIGNATURE": true,
            "CHAT_GROUP": false,
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imconnector.register

// 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<{ result: boolean; error?: string; error_description?: string }>({
            method: 'imconnector.register',
            params: {
              ID: 'myconnector',
              NAME: 'My Connector',
              ICON: {
                DATA_IMAGE: 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E',
                COLOR: '#69acc0',
                SIZE: '90%',
                POSITION: 'center',
              },
              PLACEMENT_HANDLER: 'https://example.com/connector/settings',
              ICON_DISABLED: {
                DATA_IMAGE: 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E',
                COLOR: '#99adb3',
              },
              DEL_EXTERNAL_MESSAGES: true,
              EDIT_INTERNAL_MESSAGES: true,
              DEL_INTERNAL_MESSAGES: true,
              NEWSLETTER: true,
              NEED_SYSTEM_MESSAGES: true,
              NEED_SIGNATURE: true,
              CHAT_GROUP: false,
            },
            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('Connector registered:', result.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 registerConnector() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'imconnector.register',
                params: {
                  ID: 'myconnector',
                  NAME: 'My Connector',
                  ICON: {
                    DATA_IMAGE: 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E',
                    COLOR: '#69acc0',
                    SIZE: '90%',
                    POSITION: 'center',
                  },
                  PLACEMENT_HANDLER: 'https://example.com/connector/settings',
                  ICON_DISABLED: {
                    DATA_IMAGE: 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E',
                    COLOR: '#99adb3',
                  },
                  DEL_EXTERNAL_MESSAGES: true,
                  EDIT_INTERNAL_MESSAGES: true,
                  DEL_INTERNAL_MESSAGES: true,
                  NEWSLETTER: true,
                  NEED_SYSTEM_MESSAGES: true,
                  NEED_SIGNATURE: true,
                  CHAT_GROUP: false,
                },
                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('Connector registered:', result.result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', registerConnector)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.imconnector.register(
                bitrix_id="myconnector",
                name="My Connector",
                icon={
                    "DATA_IMAGE": "data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E",
                    "COLOR": "#69acc0",
                    "SIZE": "90%",
                    "POSITION": "center",
                },
                placement_handler="https://example.com/connector/settings",
                icon_disabled={
                    "DATA_IMAGE": "data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E",
                    "COLOR": "#99adb3",
                },
                del_external_messages=True,
                edit_internal_messages=True,
                del_internal_messages=True,
                newsletter=True,
                need_system_messages=True,
                need_signature=True,
                chat_group=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}")

$result = $b24Service->core->call(
            'imconnector.register',
            [
                'ID' => 'myconnector',
                'NAME' => 'Mein Connector',
                'ICON' => [
                    'DATA_IMAGE' => 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E',
                    'COLOR' => '#69acc0',
                    'SIZE' => '90%',
                    'POSITION' => 'center',
                ],
                'PLACEMENT_HANDLER' => 'https://example.com/connector/settings',
                'ICON_DISABLED' => [
                    'DATA_IMAGE' => 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E',
                    'COLOR' => '#99adb3',
                ],
                'DEL_EXTERNAL_MESSAGES' => true,
                'EDIT_INTERNAL_MESSAGES' => true,
                'DEL_INTERNAL_MESSAGES' => true,
                'NEWSLETTER' => true,
                'NEED_SYSTEM_MESSAGES' => true,
                'NEED_SIGNATURE' => true,
                'CHAT_GROUP' => false,
            ]
        );

BX24.callMethod(
          'imconnector.register',
          {
            ID: 'myconnector',
            NAME: 'Mein Connector',
            ICON: {
              DATA_IMAGE: 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E',
              COLOR: '#69acc0',
              SIZE: '90%',
              POSITION: 'center',
            },
            PLACEMENT_HANDLER: 'https://example.com/connector/settings',
            ICON_DISABLED: {
              DATA_IMAGE: 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E',
              COLOR: '#99adb3',
            },
            DEL_EXTERNAL_MESSAGES: true,
            EDIT_INTERNAL_MESSAGES: true,
            DEL_INTERNAL_MESSAGES: true,
            NEWSLETTER: true,
            NEED_SYSTEM_MESSAGES: true,
            NEED_SIGNATURE: true,
            CHAT_GROUP: false,
          },
          function(result) {
            console.log(result.data());
          }
        );

$result = CRest::call(
            'imconnector.register',
            [
                'ID' => 'myconnector',
                'NAME' => 'Mein Connector',
                'ICON' => [
                    'DATA_IMAGE' => 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E',
                    'COLOR' => '#69acc0',
                    'SIZE' => '90%',
                    'POSITION' => 'center',
                ],
                'PLACEMENT_HANDLER' => 'https://example.com/connector/settings',
                'ICON_DISABLED' => [
                    'DATA_IMAGE' => 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E',
                    'COLOR' => '#99adb3',
                ],
                'DEL_EXTERNAL_MESSAGES' => true,
                'EDIT_INTERNAL_MESSAGES' => true,
                'DEL_INTERNAL_MESSAGES' => true,
                'NEWSLETTER' => true,
                'NEED_SYSTEM_MESSAGES' => true,
                'NEED_SIGNATURE' => true,
                'CHAT_GROUP' => false,
            ]
        );

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imconnector.register", b24.Params{
        	"ID":   "myconnector",
        	"NAME": "Mein Connector",
        	"ICON": b24.Params{
        		"DATA_IMAGE": "data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E",
        		"COLOR":      "#69acc0",
        		"SIZE":       "90%",
        		"POSITION":   "center",
        	},
        	"PLACEMENT_HANDLER": "https://example.com/connector/settings",
        	"ICON_DISABLED": b24.Params{
        		"DATA_IMAGE": "data:image/svg+xml,%3Csvg%20xmlns%3D%22http://www.w3.org/2000/svg%22/%3E",
        		"COLOR":      "#99adb3",
        	},
        	"DEL_EXTERNAL_MESSAGES":  true,
        	"EDIT_INTERNAL_MESSAGES": true,
        	"DEL_INTERNAL_MESSAGES":  true,
        	"NEWSLETTER":             true,
        	"NEED_SYSTEM_MESSAGES":   true,
        	"NEED_SIGNATURE":         true,
        	"CHAT_GROUP":             false,
        })
        if err != nil {
        	return fmt.Errorf("imconnector.register: %w", err)
        }
        
        var item struct {
        	Result bool `json:"result"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Result)

Response Handling

HTTP status: 200

{
            "result": {
                "result": true
            },
            "time": {
                "start": 1738065600.11,
                "finish": 1738065600.38,
                "duration": 0.27,
                "processing": 0.10,
                "date_start": "2025-01-28T12:00:00+00:00",
                "date_finish": "2025-01-28T12:00:00+00:00"
            }
        }

Returned Data

Name `type`	Description
result `object`	Connector registration result (detailed description)
time `time`	Information about the request execution time

result Object

Name `type`	Description
result `boolean`	`true` if the connector was successfully registered. If registration fails, returns `false`, and the object includes the `error` and `error_description` fields
error `string`	Error code. Returned when `result = false`
error_description `string`	Error description. Returned when `result = false`

Error Handling

The method can return two error formats:

HTTP Status: 200 with result = false

{
            "result": {
                "result": false,
                "error": "CONNECTOR_ID_REQUIRED",
                "error_description": "Connector-ID nicht angegeben"
            }
        }

HTTP Status: 403 for a system authorization error

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Current authorization type is denied for this method Application context required"
        }

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
`200`	`APPLICATION_REGISTRATION_ERROR_POINT`	Application registration error. Using a dot in the connector identifier is not allowed	The `ID` contains the `.` character
`200`	`CONNECTOR_ID_REQUIRED`	Connector ID is not specified	Empty or non-string `ID`
`200`	`NAME_REQUIRED`	Connector name is not specified	Empty or non-string `NAME`
`200`	`ICON_REQUIRED`	Connector icon is not specified	`ICON.DATA_IMAGE` is not provided or not a string
`200`	`NO_APPLICATION_ID`	Failed to get application ID	No application found in the request context
`200`	`NO_PLACEMENT_HANDLER`	Failed to get embedding handler URL	Empty or non-string `PLACEMENT_HANDLER`
`200`	`APPLICATION_REGISTRATION_ERROR`	Application registration error	Failed to complete registration: connector data and embedding parameters were not saved
`200`	`GENERAL_CONNECTOR_REGISTRATION_ERROR`	General connector registration error	Other validation errors in input data
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method Application context required	The method was called outside the OAuth application context

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?

Overview of Methods

Activate a Connector

Register the Connector imconnector.register

Method ParametersMethod Parameters

Parameter ICONParameter ICON

Parameter ICON_DISABLEDParameter ICON_DISABLED

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

result Objectresult Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning