How to Create an Open Channels Connector for Website Chat

<?php
        // composer require bitrix24/b24phpsdk:"^3.0"
        require_once 'vendor/autoload.php';
        
        use Bitrix24\SDK\Core\Credentials\ApplicationProfile;
        use Bitrix24\SDK\Core\Credentials\AuthToken;
        use Bitrix24\SDK\Core\Credentials\DefaultOAuthServerUrl;
        use Bitrix24\SDK\Services\ServiceBuilderFactory;
        use Monolog\Handler\StreamHandler;
        use Monolog\Logger;
        use Symfony\Component\EventDispatcher\EventDispatcher;
        use Symfony\Component\HttpFoundation\Request;
        
        $request = Request::createFromGlobals();
        $appProfile = ApplicationProfile::initFromArray([
            'BITRIX24_PHP_SDK_APPLICATION_CLIENT_ID' => 'local.xxxxxxxx.xxxxxxxx',
            'BITRIX24_PHP_SDK_APPLICATION_CLIENT_SECRET' => 'yyyyyyyy',
            'BITRIX24_PHP_SDK_APPLICATION_SCOPE' => 'imopenlines,imconnector,im',
        ]);
        
        $authToken = AuthToken::initFromEventRequest($request);
        $domain = (string)$request->request->all('auth')['domain'];
        
        $log = new Logger('openlines');
        $log->pushHandler(new StreamHandler('php://stdout'));
        
        $b24 = (new ServiceBuilderFactory(new EventDispatcher(), $log))
            ->init($appProfile, $authToken, $domain, DefaultOAuthServerUrl::default());
        

# pip install b24pysdk flask
        from flask import request
        from b24pysdk import BitrixApp, BitrixToken, Client
        
        APP = BitrixApp(client_id="local.xxxxxxxx.xxxxxxxx", client_secret="yyyyyyyy")
        
        def make_client(auth: dict) -> tuple[Client, BitrixToken]:
            token = BitrixToken(
                domain=auth["domain"],
                auth_token=auth["access_token"],
                refresh_token=auth.get("refresh_token", ""),
                bitrix_app=APP,
            )
            return Client(token), token
        
        auth = request.json["auth"]  # auth dictionary from the handler request body
        client, token = make_client(auth)
        

<?php
        // $b24 is built on an application token
        $connectorId = 'example_site_chat';
        $handlerUrl = 'https://your-domain.example/handler';
        $icon = [
            'DATA_IMAGE' => 'data:image/svg+xml;charset=US-ASCII,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%2070%2071%22%3E%3C/svg%3E',
            'COLOR' => '#a6ffa3', 'SIZE' => '100%', 'POSITION' => 'center',
        ];
        
        $reg = $b24->getIMOpenLinesScope()->connector()->register([
            'ID' => $connectorId,
            'NAME' => 'ExampleSiteChat',
            'ICON' => $icon,
            'ICON_DISABLED' => array_merge($icon, ['COLOR' => '#ffb3a3']),
            'PLACEMENT_HANDLER' => $handlerUrl,
        ]);
        
        if ($reg->isSuccess()) {
            // event.bind is not part of the typed connector service, so call it through the core
            $b24->core->call('event.bind', [
                'event' => 'OnImConnectorMessageAdd',
                'handler' => $handlerUrl,
            ]);
        }
        

# client is built on an application token
        connector_id = "example_site_chat"
        handler_url = "https://your-domain.example/handler"
        icon = {
            "DATA_IMAGE": "data:image/svg+xml;charset=US-ASCII,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%2070%2071%22%3E%3C/svg%3E",
            "COLOR": "#a6ffa3", "SIZE": "100%", "POSITION": "center",
        }
        
        reg = client.imconnector.register(
            bitrix_id=connector_id,
            name="ExampleSiteChat",
            icon=icon,
            placement_handler=handler_url,
            icon_disabled={**icon, "COLOR": "#ffb3a3"},
        ).response
        
        if reg.result:
            client.event.bind(event="OnImConnectorMessageAdd", handler=handler_url).response
        

$options = json_decode($_REQUEST['PLACEMENT_OPTIONS'], true);
        $line = (string)(int)$options['LINE'];
        
        $b24->getIMOpenLinesScope()->connector()->activate($connectorId, $line, (int)$options['ACTIVE_STATUS']);
        
        $b24->getIMOpenLinesScope()->connector()->setData($connectorId, $line, [
            'ID' => $connectorId . '_line_' . $line,
            'URL_IM' => $widgetUri,
            'NAME' => $widgetName,
        ]);
        

import json
        options = json.loads(request.form["PLACEMENT_OPTIONS"])
        line = int(options["LINE"])
        
        client.imconnector.activate(connector=connector_id, line=line, active=int(options["ACTIVE_STATUS"])).response
        
        client.imconnector.connector.data.set(
            connector=connector_id,
            line=line,
            data={"ID": f"{connector_id}_line_{line}", "URL_IM": widget_uri, "NAME": widget_name},
        ).response
        

if (($_REQUEST['event'] ?? '') === 'ONIMCONNECTORMESSAGEADD'
            && ($_REQUEST['data']['CONNECTOR'] ?? '') === $connectorId) {
            foreach ($_REQUEST['data']['MESSAGES'] as $message) {
                $messageId = saveMessage($message['chat']['id'], $message); // local storage
                $b24->getIMOpenLinesScope()->connector()->sendStatusDelivery($connectorId, getLine(), [
                    [
                        'im' => [
                            'chat_id' => $message['im']['chat_id'],
                            'message_id' => $message['im']['message_id'],
                        ],
                        'message' => ['id' => [$messageId], 'date' => time()],
                        'chat' => ['id' => $message['chat']['id']],
                    ],
                ]);
            }
        }
        

import time
        
        if request.form.get("event") == "ONIMCONNECTORMESSAGEADD":
            for message in messages:  # data[MESSAGES] from the event body
                message_id = save_message(message["chat"]["id"], message)  # local storage
                client.imconnector.send.status.delivery(
                    connector=connector_id,
                    line=get_line(),
                    messages=[{
                        "im": {"chat_id": message["im"]["chat_id"], "message_id": message["im"]["message_id"]},
                        "message": {"id": [message_id], "date": int(time.time())},
                        "chat": {"id": message["chat"]["id"]},
                    }],
                ).response
        

$arMessage = [
            'user' => ['id' => $chatID, 'name' => htmlspecialchars($_POST['name'])],
            'message' => ['id' => $messageId, 'date' => time(), 'text' => htmlspecialchars($_POST['message'])],
            'chat' => ['id' => $chatID, 'url' => htmlspecialchars($_SERVER['HTTP_REFERER'])],
        ];
        
        $b24->getIMOpenLinesScope()->connector()->sendMessages($connectorId, $lineId, [$arMessage]);
        

import time
        ar_message = {
            "user": {"id": chat_id, "name": visitor_name},
            "message": {"id": message_id, "date": int(time.time()), "text": visitor_text},
            "chat": {"id": chat_id, "url": page_url},
        }
        
        client.imconnector.send.messages(connector=connector_id, line=line_id, messages=[ar_message]).response