Параметры

Вызов метода

JavaScript

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

PHP

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

Пример ответа

{
    "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 – краткое описание возникшей ошибки

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