Register the Connector imconnector.register

Scope: imopenlines

Who can execute the method: any user

The method imconnector.register registers a custom connector for Open Channels.

The method works only in the context of the 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`	Indicates the chat processing mode of the connector: `true` — grouping by `chat.id` (group chat), `false` — by `user.id` (one-on-one chat). Default value is `false`
COMMENT `string`	Text explanation displayed in the connector settings block in the slider

ICON Parameter

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`

ICON_DISABLED Parameter

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)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "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,
            "COMMENT": "Channel settings",
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imconnector.register

const payload = {
          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,
          COMMENT: 'Channel settings',
        };
        
        const response = await $b24.callMethod('imconnector.register', payload);
        console.log(response.getData());

$result = $b24Service->core->call(
            'imconnector.register',
            [
                '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,
                'COMMENT' => 'Channel settings',
            ]
        );

BX24.callMethod(
          'imconnector.register',
          {
            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,
            COMMENT: 'Channel settings',
          },
          function(result) {
            console.log(result.data());
          }
        );

$result = CRest::call(
            'imconnector.register',
            [
                '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,
                'COMMENT' => 'Channel settings',
            ]
        );

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 `boolean`	`true` if the connector was successfully registered
time `time`	Information about the request execution time

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 is not specified"
            }
        }

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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`200`	`APPLICATION_REGISTRATION_ERROR_POINT`	Application registration error. The connector identifier cannot contain a dot	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 the 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	Method called outside of the OAuth application context

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Typical Use-Cases

Activate a Connector

Register the Connector imconnector.register

Method ParametersMethod Parameters

ICON ParameterICON Parameter

ICON_DISABLED ParameterICON_DISABLED Parameter

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