Найти сообщение в чате im.dialog.messages.search

Scope: im

Кто может выполнять метод: участник чата

Метод im.dialog.messages.search выполняет поиск сообщений в чате.

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

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

Название `тип`	Описание
CHAT_ID^* `integer`	Идентификатор чата, в котором выполняется поиск
SEARCH_MESSAGE `string`	Строка поиска по тексту сообщения. Поиск по этому параметру выполняется для строк длиной более 2 символов
DATE_FROM `datetime`	Начало периода поиска в формате ISO 8601 (RFC3339)
DATE_TO `datetime`	Конец периода поиска в формате ISO 8601 (RFC3339)
DATE `datetime`	Поиск сообщений за конкретную дату в формате ISO 8601 (RFC3339). Если параметр передан, поиск выполняется в пределах суток от указанной даты
ORDER `object`	Параметры сортировки. Поддерживаемое поле: `ID` — сортировка по идентификатору сообщения, значения `ASC` или `DESC` По умолчанию: `{"ID": "DESC"}`
LIMIT `integer`	Количество возвращаемых сообщений. Значение по умолчанию: `50`. Максимальное значение: `200`
LAST_ID `integer`	Идентификатор последнего сообщения из предыдущей выборки для пагинации

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CHAT_ID":3,"SEARCH_MESSAGE":"test","ORDER":{"ID":"DESC"},"LIMIT":20}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.dialog.messages.search

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CHAT_ID":3,"SEARCH_MESSAGE":"test","ORDER":{"ID":"DESC"},"LIMIT":20,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/im.dialog.messages.search

try
        {
            const response = await $b24.callMethod(
                'im.dialog.messages.search',
                {
                    CHAT_ID: 3,
                    SEARCH_MESSAGE: 'test',
                    ORDER: { ID: 'DESC' },
                    LIMIT: 20
                }
            );
        
            const result = response.getData().result;
            console.log('Search result:', result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.dialog.messages.search',
                    [
                        'CHAT_ID' => 3,
                        'SEARCH_MESSAGE' => 'test',
                        'ORDER' => ['ID' => 'DESC'],
                        'LIMIT' => 20,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.dialog.messages.search',
            {
                CHAT_ID: 3,
                SEARCH_MESSAGE: 'test',
                ORDER: { ID: 'DESC' },
                LIMIT: 20
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.dialog.messages.search',
            [
                'CHAT_ID' => 3,
                'SEARCH_MESSAGE' => 'test',
                'ORDER' => ['ID' => 'DESC'],
                'LIMIT' => 20,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "users": [
                    {
                        "id": 1,
                        "active": true,
                        "name": "Алекс",
                        "firstName": "Алекс",
                        "lastName": "",
                        "workPosition": "",
                        "color": "#df532d",
                        "avatar": "https://cdn-ru.bitrix24.ru/path/avatar.jpg",
                        "avatarHr": "https://cdn-ru.bitrix24.ru/path/avatar.jpg",
                        "gender": "F",
                        "birthday": "",
                        "extranet": false,
                        "network": false,
                        "bot": false,
                        "connector": false,
                        "externalAuthId": "socservices",
                        "status": "online",
                        "idle": false,
                        "lastActivityDate": "2026-02-13T14:27:33+03:00",
                        "mobileLastDate": false,
                        "desktopLastDate": false,
                        "absent": false,
                        "departments": [1, 107, 47, 3],
                        "phones": {
                            "personal_mobile": "79998887766",
                            "inner_phone": "111"
                        },
                        "botData": null,
                        "type": "user",
                        "website": "",
                        "email": "user@example.com"
                    }
                ],
                "files": [],
                "additionalMessages": [],
                "copilot": null,
                "stickers": [],
                "reactions": [],
                "tariffRestrictions": {
                    "isHistoryLimitExceeded": false
                },
                "usersShort": [],
                "messages": [
                    {
                        "id": 33653,
                        "chat_id": 2421,
                        "author_id": 1,
                        "date": "2026-02-13T14:28:00+03:00",
                        "text": "test message",
                        "isSystem": false,
                        "uuid": "18533186-232b-4423-8438-64501da182f5",
                        "forward": null,
                        "params": [],
                        "viewedByOthers": false,
                        "unread": false,
                        "viewed": true
                    }
                ]
            },
            "time": {
                "start": 1770982150,
                "finish": 1770982150.503861,
                "duration": 0.5038609504699707,
                "processing": 0,
                "date_start": "2026-02-13T14:29:10+03:00",
                "date_finish": "2026-02-13T14:29:10+03:00",
                "operating_reset_at": 1770982750,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
result.messages `array`	Массив найденных сообщений (подробное описание)
result.users `array`	Пользователи, связанные с найденными сообщениями (подробное описание)
result.files `array`	Файлы из найденных сообщений
result.additionalMessages `array`	Дополнительные сообщения, связанные с найденными, например пересылаемые или цитируемые (подробное описание)
result.copilot `object`	Данные BitrixGPT, если присутствуют в ответе. Может быть `null`
result.stickers `array`	Стикеры, связанные с найденными сообщениями
result.reactions `array`	Реакции на найденные сообщения (подробное описание)
result.tariffRestrictions `object`	Информация о тарифных ограничениях истории. Содержит флаг `isHistoryLimitExceeded` — признак превышения лимита истории сообщений по тарифу
result.usersShort `array`	Краткая информация о пользователях, поставивших реакции. Используется как дополняющий справочник к `result.reactions.reactionUsers`, содержит `id`, `name`, `avatar`
time `time`	Информация о времени выполнения запроса

Сообщение

Название `тип`	Описание
id `integer`	Идентификатор сообщения
chat_id `integer`	Идентификатор чата
author_id `integer`	Идентификатор автора сообщения
date `datetime`	Дата и время создания сообщения
text `string`	Текст сообщения
isSystem `boolean`	Признак системного сообщения
uuid `string`	Внешний UUID сообщения. Может быть `null`
forward `object`	Информация о пересылке. Может быть `null`
params `array`	Параметры сообщения
viewedByOthers `boolean`	Признак, что сообщение просмотрено другими участниками
unread `boolean`	Признак непрочитанного сообщения для текущего пользователя
viewed `boolean`	Признак, что сообщение просмотрено текущим пользователем

Пользователь

Название `тип`	Описание
id `integer`	Идентификатор пользователя
active `boolean`	Пользователь активен
name `string`	Полное имя
firstName `string`	Имя
lastName `string`	Фамилия
workPosition `string`	Должность
color `string`	Цвет профиля в формате hex
avatar `string`	URL аватара
avatarHr `string`	URL аватара в высоком разрешении
gender `string`	Пол
birthday `string`	День рождения
extranet `boolean`	Признак экстранет-пользователя
network `boolean`	Признак пользователя Bitrix24 Network
bot `boolean`	Признак бота
connector `boolean`	Признак пользователя-коннектора
externalAuthId `string`	Код внешней авторизации
status `string`	Статус пользователя
idle `boolean`	Признак неактивности
lastActivityDate `datetime`	Дата и время последней активности
mobileLastDate `datetime`	Последняя активность в мобильном приложении. Может быть `false`
desktopLastDate `datetime`	Последняя активность в десктоп-приложении. Может быть `false`
absent `boolean`	Признак отсутствия
departments `array`	Массив идентификаторов подразделений
phones `object`	Телефоны пользователя
botData `object`	Дополнительные данные бота. Для обычного пользователя `null`
type `string`	Тип пользователя
website `string`	Веб-сайт пользователя
email `string`	E-mail пользователя

Реакции

Название `тип`	Описание
messageId `integer`	Идентификатор сообщения
reactionCounters `object`	Количество реакций по каждому типу
reactionUsers `object`	Пользователи по типам реакций
ownReactions `array`	Реакции текущего пользователя

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

HTTP-статус: 400, 403

{
            "error": "CHAT_ID_EMPTY",
            "error_description": "CHAT_ID can`t be empty"
        }

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

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

Код	Описание	Значение
`CHAT_ID_EMPTY`	CHAT_ID cant be empty	Не передан обязательный параметр `CHAT_ID`
`ACCESS_ERROR`	You do not have access to this chat	Нет доступа к указанному чату

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

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.dialog.messages.search

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

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

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

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

СообщениеСообщение

ПользовательПользователь

РеакцииРеакции

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

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

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

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