Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Закрепить чат вверху списка im.recent.pin». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Закрепить чат вверху списка im.recent.pin

Тут может не хватать некоторых данных — дополним в ближайшее время

• нужны правки под стандарт написания
• не указаны типы параметров
• отсутствуют примеры

> Scope: im
>
> Кто может выполнять метод: любой пользователь

Метод im.recent.pin закрепляет диалог вверху списка чатов.

Входящие параметры и конфигурация метода

• Если указать параметр PIN = N, то закрепленный диалог будет откреплен.

Практические примеры использования в коде

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'im.recent.pin',
    		{
    			'DIALOG_ID': 'chat17',
    			'PIN': 'Y'
    		}
    	);
    	
    	const result = response.getData().result;
    	console.log(result);
    }
    catch( error )
    {
    	console.error(error.ex);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'im.recent.pin',
                [
                    'DIALOG_ID' => 'chat17',
                    'PIN'       => 'Y'
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        if ($result->error()) {
            error_log($result->error()->ex);
        } else {
            echo 'Success: ' . print_r($result->data(), true);
        }
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error pinning recent dialog: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        'im.recent.pin',
        {
            'DIALOG_ID': 'chat17',
            'PIN': 'Y'
        },
        function(result){
            if(result.error())
            {
                console.error(result.error().ex);
            }
            else
            {
                console.log(result.data());
            }
        }
    );

• PHP CRest

    $result = restCommand(
        'im.recent.pin',
        Array(
            'DIALOG_ID' => 'chat17',
            'PIN' => 'Y'
        ),
        $_REQUEST[
            "auth"
        ]
    );    

• cURL

// пример для cURL

Ответ в случае успеха

{
    "result": true
}

Ответ в случае ошибки

{
    "error": "DIALOG_ID_EMPTY",
    "error_description": "Dialog ID can't be empty"
}

Описание ключей

• error – код возникшей ошибки
• error_description – краткое описание возникшей ошибки

Возможные коды ошибок