Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Найти чаты по названиям im.search.chat.list», проанализируем лучшие практики и покажем, как правильно использовать im.search.chat.list в реальных задачах.

Найти чаты по названиям im.search.chat.list

Тут может не хватать некоторых данных — дополним в ближайшее время

• нужны правки под стандарт написания
• не указаны типы параметров
• отсутствуют примеры

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

Метод im.search.chat.list выполняет поиск чатов.

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

Практические примеры использования в коде

• JS

    // callListMethod рекомендуется использовать, когда необходимо получить весь набор списочных данных и объём записей относительно невелик (до примерно 1000 элементов). Метод загружает все данные сразу, что может привести к высокой нагрузке на память при работе с большими объемами.
    
    try {
      const response = await $b24.callListMethod(
        'im.search.chat.list',
        {
          FIND: 'Мятный'
        },
        (progress) => { console.log('Progress:', progress) }
      )
      const items = response.getData() || []
      for (const entity of items) { console.log('Entity:', entity) }
    } catch (error) {
      console.error('Request failed', error)
    }
    
    // fetchListMethod предпочтителен при работе с крупными наборами данных. Метод реализует итеративную выборку с использованием генератора, что позволяет обрабатывать данные по частям и эффективно использовать память.
    
    try {
      const generator = $b24.fetchListMethod('im.search.chat.list', { FIND: 'Мятный' }, 'ID')
      for await (const page of generator) {
        for (const entity of page) { console.log('Entity:', entity) }
      }
    } catch (error) {
      console.error('Request failed', error)
    }
    
    // callMethod предоставляет ручной контроль над процессом постраничного получения данных через параметр start. Подходит для сценариев, где требуется точное управление пакетами запросов. Однако при больших объемах данных может быть менее эффективным по сравнению с fetchListMethod.
    
    try {
      const response = await $b24.callMethod('im.search.chat.list', { FIND: 'Мятный' }, 0)
      const result = response.getData().result || []
      for (const entity of result) { console.log('Entity:', entity) }
    } catch (error) {
      console.error('Request failed', error)
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'im.search.chat.list',
                [
                    'FIND' => 'Мятный'
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'users: ' . print_r($result->data(), true);
        echo 'total: ' . $result->total();
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error searching chat list: ' . $e->getMessage();
    }

• BX24.js

    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 CRest

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

• cURL

// пример для cURL

Ответ в случае успеха

{    
    "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 – краткое описание возникшей ошибки

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