метод REST scope: im

im.search.chat.list

Найти чаты

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

Описание

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

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

Параметры

FIND string необязательный

Поисковая фраза для поиска по индексируемым данным чата. Минимальное количество символов для поиска — 2

FIND_LINES string необязательный

Поисковая фраза для поиска чатов среди Открытых линий. Минимальное количество символов для поиска — 2

OFFSET integer необязательный

Смещение выборки чатов. По умолчанию 0

LIMIT integer необязательный

Количество элементов в выборке. По умолчанию 10. Максимальное значение 50

Примеры запроса

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

Ответ

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

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": "FIND_SHORT",
    "error_description": "Too short a search phrase."
}
Код Описание Значение
FIND_SHORT Too short a search phrase Не передан ни один поисковый параметр или фраза меньше двух символов

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.