Получение информации о диалоге (чате) оператора открытой линии

Ревизия: 2
Получить информацию о текущей ревизии API (версии платформы Открытых линий) – imopenlines.revision.get.

Параметры

Можно использовать для вызова любой из параметров.

Вызов метода и ответ

JavaScript

BX24.callMethod('imopenlines.dialog.get', {USER_CODE: 'livechat|1|1373|211'}, function(result){
    if(result.error())
    {
        console.error(result.error().ex);
    }
    else
    {
        console.log(result.data());
    }
});

PHP

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

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

{
    "result": 
  {
	avatar: ""
	color: "#4ba984"
	date_create: "2020-05-12T17:40:55+02:00"
	dialog_id: null
	entity_data_1: "N|NONE|0|N|N|0|1591872180|1|0|"
	entity_data_2: ""
	entity_data_3: ""
	entity_id: "livechat|1|1363|203"
	entity_type: "LINES"
	extranet: false
	id: 1364
	manager_list: []
	message_type: "L"
	name: "Евгений Перекопский - Приоритетная поддержка"
	owner: 0
	type: "lines"
  }
}

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

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

Пример ответа при возникновении ошибки

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

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

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

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