Параметры

• Поиск осуществляется по следующим полям: Заголовок, Имя и Фамилия участников чата.
• Метод поддерживает стандартную постраничную навигацию Bitrix24 Rest Api, но в добавок к ней есть возможность построить навигацию с помощью параметров OFFSET и LIMIT.

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

JavaScript

BX24.callMethod('im.search.chat.list', {
	FIND: 'Мятный'
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log('users', result.data());
		console.log('total', result.total());
	}
});

PHP

$result = restCommand('im.search.chat.list', Array(
	'FIND' => 'Мятный'
), $_REQUEST["auth"]);

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

{    
	"result": {
		21191:  {
			"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"
		}
	},
	"total": 1
}    

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

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

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

{
    "error": "FIND_SHORT",
    "error_description": "Too short a search phrase."
}

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

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

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