Widget for IM_SIDEBAR

Scope: im

You can add your item to the chat sidebar.

The widget code is specified in the PLACEMENT parameter of the placement.bind method.

The widget will not be displayed in the interface until the application installation is complete. Check the application installation

Widget Code	Location
`IM_SIDEBAR`	Item in the chat sidebar

Where to find it in the interface

Open the chat and click the sidebar button on the right side of the top chat panel. In the opened sidebar, there is an Applications block at the bottom, which displays the application item with PLACEMENT=IM_SIDEBAR.

What the handler receives

Data is transmitted as a POST request

Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => de
            [APP_SID] => 99c80eff6378726287350416ee5fef0
            [AUTH_ID] => 6061e72600631fcd00005a4b00000001f0f1076700000000f69dd5fc643d9ce2fdbc1
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 50e00aa340631fcd00005a4b00000001f0f1071111116580a5b83c2de639ef28c12
            [member_id] => da45a03b265ed12127f8a258d793cc5d
            [status] => F
            [PLACEMENT] => IM_SIDEBAR
            [PLACEMENT_OPTIONS] => {"dialogId":"chat1489"}
        )

Required parameters are marked with *

Parameter `type`	Description
DOMAIN* `string`	The Bitrix24 address where the widget handler was invoked
PROTOCOL* `string`	Secure or non-secure HTTP protocol: `0` - HTTP `1` - HTTPS
LANG* `string`	The user interface language of Bitrix24 that invoked the widget. You can localize the interface language in your widget based on this value
APP_SID `string`	String identifier of the application that registered the widget handler
AUTH_ID `string`	Authorization token OAuth 2 issued for the user who invoked the widget. Can be used for REST API calls on behalf of this user
AUTH_EXPIRES `integer`	Time in seconds after which the authorization token will become invalid
REFRESH_ID `string`	Refresh token OAuth 2 issued for the user who invoked the widget. Can be used to refresh the authorization token on behalf of this user
member_id* `string`	Unique string identifier of Bitrix24 where the widget handler was invoked.
status `string`	Type of application that registered the handler for this widget. Accepts values: `L` - local application `F` - free mass-market application
PLACEMENT* `string`	Code for the widget embedding location. You can use the same handler URL for all your widgets. The value that Bitrix24 will report in the `PLACEMENT` parameter will help determine from which specific widget embedding location your handler was invoked in each case
PLACEMENT_OPTIONS `string`	Additional data in the form of a JSON string that defines the context of the widget execution. For example, this could be an array containing the numeric identifier of the CRM entity in the detail form where the widget handler was invoked, etc. The `PLACEMENT_OPTIONS` parameter, along with the `PLACEMENT` parameter, allows you to accurately determine for which specific widget embedding location and object the widget handler was invoked.

PLACEMENT_OPTIONS

The value of PLACEMENT_OPTIONS is passed as a JSON string with the context of the call.

For IM_SIDEBAR, the following key is passed in the context:

dialogId — the identifier of the current chat

OPTIONS when registering via placement.bind

For IM_SIDEBAR, the placement.bind method supports OPTIONS parameters.

Required parameters are marked with *

Parameter `type`	Description
iconName* `string`	Label of the item in the interface. Up to 50 characters, Latin letters, spaces, and `-` are allowed
extranet `string`	Access in the extranet, default is `N`. Possible values: `N` — application is not available for extranet users `Y` — application is available for extranet users
context `string`	Display context, default is `ALL`. Multiple values can be passed using `;`. Possible values: `ALL` — all chats `USER` — personal chats of users, excluding chats with bots `CHAT` — group chats, excluding `LINES` and `CRM` `LINES` — chats of open channels `CRM` — chats created within CRM If `ALL` is passed along with other values, only `ALL` is used. An invalid value will cause a registration error
role `string`	User role, default is `USER`. Possible values: `USER` — application is available to all users `ADMIN` — application is available only to portal administrators
color `string`	Icon color from the IM palette. Possible values: `RED` — red `GREEN` — green `MINT` — mint `LIGHT_BLUE` — light blue `DARK_BLUE` — dark blue `PURPLE` — purple `AQUA` — aqua `PINK` — pink `LIME` — lime `BROWN` — brown `AZURE` — azure `KHAKI` — khaki `SAND` — sand `ORANGE` — orange `MARENGO` — marengo `GRAY` — gray `GRAPHITE` — graphite

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 '{
            "PLACEMENT": "IM_SIDEBAR",
            "HANDLER": "https://your-domain.com/widgets/im-sidebar-handler.php",
            "TITLE": "My sidebar item",
            "LANG_ALL": {
              "de": {
                "TITLE": "Mein Sidebar-Element"
              },
              "en": {
                "TITLE": "My sidebar item"
              }
            },
            "OPTIONS": {
              "iconName": "chat-tools",
              "context": "ALL",
              "role": "USER",
              "extranet": "N",
              "color": "LIGHT_BLUE"
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/placement.bind

try
        {
            const response = await $b24.callMethod(
                'placement.bind',
                {
                    PLACEMENT: 'IM_SIDEBAR',
                    HANDLER: 'https://your-domain.com/widgets/im-sidebar-handler.php',
                    TITLE: 'My sidebar item',
                    LANG_ALL: {
                        de: {
                            TITLE: 'Mein Sidebar-Element',
                        },
                        en: {
                            TITLE: 'My sidebar item',
                        }
                    },
                    OPTIONS: {
                        iconName: 'chat-tools',
                        context: 'ALL',
                        role: 'USER',
                        extranet: 'N',
                        color: 'LIGHT_BLUE',
                    }
                }
            );
        
            const result = response.getData().result;
            if (result.error())
                console.error(result.error());
            else
                console.info(result.data());
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bind',
                    [
                        'PLACEMENT' => 'IM_SIDEBAR',
                        'HANDLER' => 'https://your-domain.com/widgets/im-sidebar-handler.php',
                        'TITLE' => 'My sidebar item',
                        'LANG_ALL' => [
                            'de' => [
                                'TITLE' => 'Mein Sidebar-Element',
                            ],
                            'en' => [
                                'TITLE' => 'My sidebar item',
                            ],
                        ],
                        'OPTIONS' => [
                            'iconName' => 'chat-tools',
                            'context' => 'ALL',
                            'role' => 'USER',
                            'extranet' => 'N',
                            'color' => 'LIGHT_BLUE',
                        ],
                    ]
                );
        
            $result = $response->getResponseData()->getResult();
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error binding placement: ' . $e->getMessage();
        }

BX24.callMethod(
            'placement.bind',
            {
                PLACEMENT: 'IM_SIDEBAR',
                HANDLER: 'https://your-domain.com/widgets/im-sidebar-handler.php',
                TITLE: 'My sidebar item',
                LANG_ALL: {
                    de: { TITLE: 'Mein Sidebar-Element' },
                    en: { TITLE: 'My sidebar item' }
                },
                OPTIONS: {
                    iconName: 'chat-tools',
                    context: 'ALL',
                    role: 'USER',
                    extranet: 'N',
                    color: 'LIGHT_BLUE'
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'placement.bind',
            [
                'PLACEMENT' => 'IM_SIDEBAR',
                'HANDLER' => 'https://your-domain.com/widgets/im-sidebar-handler.php',
                'TITLE' => 'My sidebar item',
                'LANG_ALL' => [
                    'de' => [
                        'TITLE' => 'Mein Sidebar-Element',
                    ],
                    'en' => [
                        'TITLE' => 'My sidebar item',
                    ],
                ],
                'OPTIONS' => [
                    'iconName' => 'chat-tools',
                    'context' => 'ALL',
                    'role' => 'USER',
                    'extranet' => 'N',
                    'color' => 'LIGHT_BLUE',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Continue Learning

Widget Above Message

Context Menu Item for Message

Widget for IM_SIDEBAR

Where the widget is embeddedWhere the widget is embedded

Where to find it in the interfaceWhere to find it in the interface

What the handler receivesWhat the handler receives

PLACEMENT_OPTIONSPLACEMENT_OPTIONS

OPTIONS when registering via placement.bindOPTIONS when registering via placement.bind

Code ExamplesCode Examples

Continue LearningContinue Learning

Where the widget is embedded