Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Получить данные о чате imbot.dialog.get». Вы узнаете экспертные методики работы с imbot.dialog.get и научитесь избегать типичных ошибок начинающих разработчиков.

Получить данные о чате imbot.dialog.get

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

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

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

Метод imbot.dialog.get получает информацию о диалоге.

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

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'imbot.dialog.get',
    		{
    			DIALOG_ID: 'chat29'
    		}
    	);
    	
    	const result = response.getData().result;
    	console.log(result);
    }
    catch( error )
    {
    	console.error(error.ex);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'imbot.dialog.get',
                [
                    'DIALOG_ID' => 'chat29',
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error getting dialog: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        'imbot.dialog.get',
        {
            DIALOG_ID: 'chat29'
        },
        function(result){
            if(result.error())
            {
                console.error(result.error().ex);
            }
            else
            {
                console.log(result.data());
            }
        }
    );

• PHP CRest

    $result = restCommand(
        'imbot.dialog.get',
        Array(
            'DIALOG_ID' => 'chat29'
        ),
        $_REQUEST[
            "auth"
        ]
    );

• cURL

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

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

{
    "result":
{
    "id": "21191",
    "title": "Мятный чат №3",
    "owner": "2",
    "extranet": false,
    "avatar": "",
    "color": "#4ba984",
    "type": "chat",
    "entity_type": "",
    "entity_data_1": "",
    "entity_data_2": "",
    "entity_data_3": "",
    "date_create": "2017-10-14T12:15:32+02:00",
    "message_type": "C"
}
}

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

• id – идентификатор чата
• title – название чата
• owner – идентификатор пользователя владельца чата
• extranet – признак участия в чате внешнего экстранет-пользователя (true/false)
• color – цвет чата в формате hex
• avatar – ссылка на аватар (если пусто, значит аватар не задан)
• type – тип чата (групповой чат, чат для звонка, чат открытой линии и тд)
• entity_type – внешний код для чата – тип
• entity_id – внешний код для чата – идентификатор
• entity_data_1 – внешние данные для чата
• entity_data_2 – внешние данные для чата
• entity_data_3 – внешние данные для чата
• date_create – дата создания чата в формате АТОМ
• message_type – тип сообщений чата

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

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

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

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

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