метод REST scope: im

im.dialog.messages.search

Найти сообщение в чате

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

Описание

Метод 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 -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

Ответ

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,
                "chatId": 2421,
                "chat_id": 2421,
                "authorId": 1,
                "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,
                "block": null,
                "unread": false,
                "viewed": true,
                "viewedCount": 0
            }
        ]
    },
    "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

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

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

HTTP-статус: 400

{
    "error": "CHAT_ID_EMPTY",
    "error_description": "CHAT_ID can`t be empty"
}
Код Описание Значение
CHAT_ID_EMPTY CHAT_ID can't be empty Не передан обязательный параметр CHAT_ID
ACCESS_ERROR You do not have access to this chat Нет доступа к указанному чату

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

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