Найти чаты im.search.chat.list

Scope: im

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

Метод im.search.chat.list выполняет поиск чатов, к которым текущий пользователь имеет доступ. Поиск выполняется по заголовку, имени и фамилии участников чата.

Результаты сортируются в порядке убывания идентификаторов.

Параметры метода

Обязательные параметры отмечены *

Название `Тип`	Описание
FIND `string`	Поисковая фраза для поиска по индексируемым данным чата. Минимальное количество символов для поиска — `3`
FIND_LINES `string`	Поисковая фраза для поиска чатов среди Открытых линий. Минимальное количество символов для поиска — `3`
OFFSET `integer`	Смещение выборки чатов. По умолчанию `0`
LIMIT `integer`	Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50`

Нужно передать хотя бы один параметр: FIND или FIND_LINES.

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"FIND":"Проект","FIND_LINES":"Линия","OFFSET":0,"LIMIT":10}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.search.chat.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"FIND":"Проект","FIND_LINES":"Линия","OFFSET":0,"LIMIT":10,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.search.chat.list

try {
          const response = await $b24.callMethod('im.search.chat.list', {
            FIND: 'Проект',
            FIND_LINES: 'Линия',
            OFFSET: 0,
            LIMIT: 10,
          });
        
          const { result, total, next } = response.getData();
          console.log(result, total, next);
        } catch (error) {
          console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'im.search.chat.list',
                [
                    'FIND' => 'Проект',
                    'FIND_LINES' => 'Линия',
                    'OFFSET' => 0,
                    'LIMIT' => 10,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                var_dump($result->data());
            }
        } catch (Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'im.search.chat.list',
            {
                FIND: 'Проект',
                FIND_LINES: 'Линия',
                OFFSET: 0,
                LIMIT: 10,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data(), result.total(), result.next());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.search.chat.list',
            [
                'FIND' => 'Проект',
                'FIND_LINES' => 'Линия',
                'OFFSET' => 0,
                'LIMIT' => 10,
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            var_dump($result['result']);
        }

Обработка ответа

HTTP-код: 200

{
            "result": [
                {
                    "id": 1137,
                    "parent_chat_id": 0,
                    "parent_message_id": 0,
                    "name": "Проект: \"разработка шаблона\"",
                    "description": null,
                    "owner": 27,
                    "extranet": false,
                    "avatar": "",
                    "color": "#3e99ce",
                    "type": "sonetGroup",
                    "counter": 0,
                    "user_counter": 2,
                    "message_count": 4,
                    "unread_id": 0,
                    "restrictions": {
                        "avatar": false,
                        "rename": false,
                        "extend": false,
                        "call": true,
                        "mute": true,
                        "leave": false,
                        "leave_owner": false,
                        "send": true,
                        "user_list": true,
                        "path": "/workgroups/group/#ID#/",
                        "path_title": "Перейти в группу"
                    },
                    "last_message_id": 80461,
                    "last_id": 80461,
                    "marked_id": 0,
                    "disk_folder_id": 0,
                    "entity_type": "SONET_GROUP",
                    "entity_id": "121",
                    "entity_data_1": "",
                    "entity_data_2": "",
                    "entity_data_3": "",
                    "mute_list": [],
                    "date_create": "2024-07-26T15:28:02+03:00",
                    "message_type": "C",
                    "public": "",
                    "role": "owner",
                    "entity_link": {
                        "type": "SONET_GROUP",
                        "url": "/workgroups/group/121/",
                        "id": "121"
                    },
                    "text_field_enabled": true,
                    "background_id": null,
                    "permissions": {
                        "manage_users_add": "member",
                        "manage_users_delete": "manager",
                        "manage_ui": "member",
                        "manage_settings": "owner",
                        "manage_messages": "member",
                        "can_post": "member"
                    },
                    "is_new": false
                },
                ... // описание для каждого чата
            ],
            "total": 2,
            "time": {
                "start": 1772645157,
                "finish": 1772645157.558317,
                "duration": 0.5583169460296631,
                "processing": 0,
                "date_start": "2026-03-04T20:25:57+03:00",
                "date_finish": "2026-03-04T20:25:57+03:00",
                "operating_reset_at": 1772645757,
                "operating": 0
            }
        }

Возвращаемые данные

Название `Тип`	Описание
result `array`	Список найденных чатов. Структура объекта чата подробно описана ниже
total `integer`	Общее количество найденных чатов
next `integer`	Смещение следующей страницы. Поле возвращается, если есть следующая страница
time `time`	Информация о времени выполнения запроса

Объект чата

Название `Тип`	Описание
id `integer`	Идентификатор чата
parent_chat_id `integer`	Идентификатор родительского чата
parent_message_id `integer`	Идентификатор родительского сообщения
name `string`	Название чата
description `string` `null`	Описание чата
owner `integer`	Идентификатор владельца чата
extranet `boolean`	Признак участия экстранет-пользователей
avatar `string` `null`	Ссылка на аватар чата
color `string`	Цвет чата в формате HEX
type `string`	Тип чата
counter `integer`	Значение счетчика непрочитанных сообщений для текущего пользователя
user_counter `integer`	Количество участников чата
message_count `integer`	Количество сообщений чата
unread_id `integer`	Идентификатор первого непрочитанного сообщения
restrictions `object`	Ограничения действий в чате. Структура объекта подробно описана ниже
last_message_id `integer`	Идентификатор последнего сообщения
last_id `integer`	Идентификатор последнего сообщения в чате, которое отмечено как прочитанное текущим пользователем
marked_id `integer`	Идентификатор помеченного сообщения
disk_folder_id `integer`	Идентификатор папки Диска, которая связана с чатом
entity_type `string`	Тип объекта, к которому привязан чат
entity_id `string`	Идентификатор объекта, к которому привязан чат
entity_data_1 `string`	Дополнительные данные объекта чата — поле 1
entity_data_2 `string`	Дополнительные данные объекта чата — поле 2
entity_data_3 `string`	Дополнительные данные объекта чата — поле 3
mute_list `array` `object`	Список пользователей с выключенными уведомлениями
date_create `string`	Дата создания чата в формате ISO 8601 (RFC3339)
message_type `string`	Тип сообщения чата из поля `TYPE` таблицы чатов
public `object` `string`	Публичные данные чата. Структура объекта подробно описана ниже
role `string`	Роль текущего пользователя в чате
entity_link `object`	Ссылка на связанный объект чата. Структура объекта подробно описана ниже
text_field_enabled `boolean`	Признак доступности поля ввода текста
background_id `integer` `null`	Идентификатор фона чата
permissions `object`	Права текущего пользователя. Структура объекта подробно описана ниже
is_new `boolean`	Признак нового чата

Объект restrictions

Название `Тип`	Описание
avatar `boolean`	Разрешено менять аватар чата
rename `boolean`	Разрешено менять название чата
extend `boolean`	Разрешено расширять функциональность чата
call `boolean`	Разрешены звонки в чате
mute `boolean`	Разрешено отключать уведомления чата
leave `boolean`	Разрешено выйти из чата
leave_owner `boolean`	Разрешено выйти из чата владельцу
send `boolean`	Разрешено отправлять сообщения
user_list `boolean`	Доступен просмотр списка участников
path `string`	Системный путь для перехода к связанному объекту, например к рабочей группе
path_title `string`	Текст ссылки для перехода по `path`. Поле доступно вместе с `path`

Объект public

Название `Тип`	Описание
code `string`	Публичный код чата
link `string`	Публичная ссылка на чат

Объект entity_link

Название `Тип`	Описание
type `string`	Тип связанного объекта
url `string`	URL связанного объекта
id `string` `integer`	Идентификатор связанного объекта

Объект permissions

Название `Тип`	Описание
manage_users_add `string`	Право добавлять пользователей
manage_users_delete `string`	Право удалять пользователей
manage_ui `string`	Право управлять интерфейсными настройками
manage_settings `string`	Право управлять настройками чата
manage_messages `string`	Право управлять сообщениями
can_post `string`	Право писать сообщения

Обработка ошибок

HTTP-статус: 400

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`FIND_SHORT`	Too short a search phrase	Не передан ни один поисковый параметр или фраза меньше трех символов

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Обзор методов

Найти подразделения

Найти чаты im.search.chat.list

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект чатаОбъект чата

Объект restrictionsОбъект restrictions

Объект publicОбъект public

Объект entity_linkОбъект entity_link

Объект permissionsОбъект permissions

Обработка ошибокОбработка ошибок

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

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение