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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: im

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

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

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

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

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

Название
тип

Описание

FIND
string

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

FIND_LINES
string

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

OFFSET
integer

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

LIMIT
integer

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

Нужно передать хотя бы один параметр: FIND или FIND_LINES. Если передать оба, приоритет у FIND, а поиск по Открытым линиям не выполняется.

Примеры кода

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

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
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"FIND":"Проект","OFFSET":0,"LIMIT":10,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/im.search.chat.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each ChatItem returned in result[]
type ChatItem = {
  id: number
  parent_chat_id: number
  parent_message_id: number
  name: string
  description: string | null
  owner: number
  extranet: boolean
  avatar: string | null
  color: string
  type: string
  counter: number
  user_counter: number
  message_count: number
  unread_id: number
  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
  }
  last_message_id: number
  last_id: number
  marked_id: number
  disk_folder_id: number
  entity_type: string
  entity_id: string
  entity_data_1: string
  entity_data_2: string
  entity_data_3: string
  mute_list: unknown[]
  date_create: ISODate | null
  message_type: string
  public: string | { code: string; link: string }
  role: string
  entity_link: {
    type: string
    url: string
    id: string | number
  }
  text_field_enabled: boolean
  background_id: number | null
  permissions: {
    manage_users_add: string
    manage_users_delete: string
    manage_ui: string
    manage_settings: string
    manage_messages: string
    can_post: string
  }
  is_new: boolean
}

try {
  // im.search.chat.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<ChatItem[]>({
    method: 'im.search.chat.list',
    params: {
      FIND: 'Project',
      OFFSET: 0,
      LIMIT: 10,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Found chats:', result.length, result[0]?.name)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function searchChatList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // im.search.chat.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'im.search.chat.list',
        params: {
          FIND: 'Project',
          OFFSET: 0,
          LIMIT: 10,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Found chats:', result.length, result[0]?.name)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', searchChatList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.search.chat.list(
        find="точно",
        find_lines="отдел",
        offset=0,
        limit=10,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service->core->call(
        'im.search.chat.list',
        [
            'FIND' => 'Проект',
            '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: 'Проект',
        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' => 'Проект',
        'OFFSET' => 0,
        'LIMIT' => 10,
    ]
);

if (!empty($result['error'])) {
    echo 'Error: ' . $result['error_description'];
} else {
    var_dump($result['result']);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.search.chat.list", b24.Params{
	"FIND":       "Проект",
	"OFFSET":     0,
	"LIMIT":      10,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("im.search.chat.list: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.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

Публичная ссылка на чат

Название
тип

Описание

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
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Код

Описание

Значение

FIND_SHORT

Too short a search phrase

Не передан ни один поисковый параметр или фраза меньше двух символов

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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