Поиск по истории уведомлений im.notify.history.search

Scope: im

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

Метод im.notify.history.search выполняет поиск по истории уведомлений пользователя.

Сортировка уведомлений: сначала по убыванию даты создания, затем по убыванию идентификаторов.

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

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

Название `Тип`	Описание
SEARCH_TEXT `string`	Текст поиска. Если `SEARCH_TYPE` и `SEARCH_DATE` не заданы, длина строки должна быть не меньше `3` символов
SEARCH_TYPE `string`	Фильтр по типу уведомления в формате `MODULE` или `MODULE\|EVENT`. Готовые значения можно получить методом im.notify.schema.get
SEARCH_TYPES `array`	Массив фильтров по типам уведомлений в формате `MODULE` или `MODULE\|EVENT`
SEARCH_DATE `string`	Фильтр по дате в формате ISO 8601 (RFC3339)
SEARCH_DATE_FROM `string`	Начало диапазона дат в формате ISO 8601 (RFC3339). Используется вместе с `SEARCH_DATE_TO`
SEARCH_DATE_TO `string`	Конец диапазона дат в формате ISO 8601 (RFC3339). Используется вместе с `SEARCH_DATE_FROM`
SEARCH_AUTHORS `array`	Массив идентификаторов авторов уведомлений для фильтрации
LAST_ID `integer`	Идентификатор последнего уведомления предыдущей страницы для загрузки следующей. Обычно берется из поля `id` последнего элемента массива `notifications` в ответе предыдущего шага поиска или в ответе im.notify.get
LIMIT `integer`	Количество уведомлений на страницу. Значение по умолчанию — `50`. Максимальное значение — `50`
CONVERT_TEXT `string`	Преобразовать текст уведомлений. Значение `Y` включает преобразование, любое другое значение отключает
GROUP_TAG `string`	Групповой тег уведомлений для дополнительной фильтрации

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"SEARCH_TEXT":"счет","SEARCH_TYPE":"tasks|task_update","SEARCH_DATE":"2026-03-03T16:52:29+03:00","LAST_ID":1500,"LIMIT":20,"CONVERT_TEXT":"Y","GROUP_TAG":"TASK|42"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify.history.search

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"SEARCH_TEXT":"счет","SEARCH_TYPE":"tasks|task_update","SEARCH_DATE":"2026-03-03T16:52:29+03:00","LAST_ID":1500,"LIMIT":20,"CONVERT_TEXT":"Y","GROUP_TAG":"TASK|42","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.notify.history.search

try {
          const response = await $b24.callMethod('im.notify.history.search', {
            SEARCH_TEXT: 'счет',
            SEARCH_TYPE: 'tasks|task_update',
            SEARCH_DATE: '2026-03-03T16:52:29+03:00',
            LAST_ID: 1500,
            LIMIT: 20,
            CONVERT_TEXT: 'Y',
            GROUP_TAG: 'TASK|42',
          });
        
          const { result } = response.getData();
          console.log(result);
        } catch (error) {
          console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'im.notify.history.search',
                [
                    'SEARCH_TEXT' => 'счет',
                    'SEARCH_TYPE' => 'tasks|task_update',
                    'SEARCH_DATE' => '2026-03-03T16:52:29+03:00',
                    'LAST_ID' => 1500,
                    'LIMIT' => 20,
                    'CONVERT_TEXT' => 'Y',
                    'GROUP_TAG' => 'TASK|42',
                ]
            );
        
            $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.notify.history.search',
            {
                SEARCH_TEXT: 'счет',
                SEARCH_TYPE: 'tasks|task_update',
                SEARCH_DATE: '2026-03-03T16:52:29+03:00',
                LAST_ID: 1500,
                LIMIT: 20,
                CONVERT_TEXT: 'Y',
                GROUP_TAG: 'TASK|42',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.notify.history.search',
            [
                'SEARCH_TEXT' => 'счет',
                'SEARCH_TYPE' => 'tasks|task_update',
                'SEARCH_DATE' => '2026-03-03T16:52:29+03:00',
                'LAST_ID' => 1500,
                'LIMIT' => 20,
                'CONVERT_TEXT' => 'Y',
                'GROUP_TAG' => 'TASK|42',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            var_dump($result['result']);
        }

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

HTTP-код: 200

{
            "result": {
                "chat_id": 77,
                "total_results": 1,
                "notifications": [
                    {
                        "id": 1500,
                        "chat_id": 77,
                        "author_id": 1,
                        "date": "2026-03-03T09:00:00+00:00",
                        "notify_type": 2,
                        "notify_module": "tasks",
                        "notify_event": "task_update",
                        "notify_tag": "TASK|42",
                        "notify_sub_tag": "",
                        "notify_title": "",
                        "setting_name": "tasks|task_update",
                        "text": "счет",
                        "notify_read": "Y",
                        "params": null
                    }
                ],
                "users": [
                    {
                        "id": 1,
                        "active":true,
                        "name": "Иван Петров",
                        "first_name":"Иван",
                        "last_name":"Петров",
                        "work_position":"",
                        "color":"#1eb4aa",
                        "avatar":"https://example.bitrix24.ru/upload/main/avatar.png",
                        "avatar_hr":"https://example.bitrix24.ru/upload/main/avatar.png",
                        "gender":"M",
                        "birthday":"15-05",
                        "extranet":false,
                        "network":false,
                        "bot":false,
                        "connector":false,
                        "external_auth_id":"socservices",
                        "status":"online",
                        "idle":false,
                        "last_activity_date":"2026-03-04T15:04:20+03:00",
                        "mobile_last_date":false,
                        "desktop_last_date":false,
                        "absent":false,
                        "departments":[1],
                        "phones":{
                            "work_phone":"+71234567890",
                            "inner_phone":"22"
                        },
                        "bot_data":null,
                        "type":"user",
                        "website":"example.ru",
                        "email":"ivan@example.ru"
                    }
                ]
            },
            "time": {
                "start": 1760000000.0,
                "finish": 1760000000.1,
                "duration": 0.1,
                "processing": 0.04,
                "date_start": "2026-03-04T16:00:00+03:00",
                "date_finish": "2026-03-04T16:00:00+03:00",
                "operating_reset_at": 1760030000,
                "operating": 0
            }
        }

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

Название
Тип

Описание

result
object

Объект с результатом поиска.

Структура объекта подробно описана ниже

time
time

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

Объект result

Название `Тип`	Описание
chat_id `integer`	Идентификатор системного чата уведомлений
total_results `integer`	Общее количество результатов поиска. Поле возвращается только при первой странице поиска
notifications `array`	Список уведомлений. Структура объекта подробно описана ниже
users `array`	Пользователи-авторы уведомлений Структура объекта подробно описана ниже

Объект notification

Название `Тип`	Описание
id `integer`	Идентификатор уведомления
chat_id `integer`	Идентификатор системного чата уведомлений
author_id `integer`	Идентификатор автора уведомления
date `string`	Дата и время уведомления в формате ISO 8601 (RFC3339)
notify_type `integer`	Тип уведомления
notify_module `string`	Идентификатор модуля уведомления
notify_event `string`	Код события уведомления
notify_tag `string`	Тег уведомления
notify_sub_tag `string`	Дополнительный тег уведомления
notify_title `string`	Заголовок уведомления
setting_name `string`	Код настройки в формате `MODULE\|EVENT`
text `string`	Текст уведомления
notify_read `string`	Статус прочтения уведомления: `Y` или `N`
notify_buttons `string`	JSON клавиатуры для уведомлений типа подтверждения. Поле присутствует не всегда
params `object` `null`	Дополнительные параметры уведомления

Объект user

Название `Тип`	Описание
id `integer`	Идентификатор пользователя
active `boolean`	Признак активности учетной записи пользователя
name `string`	Имя и фамилия пользователя
first_name `string`	Имя пользователя
last_name `string`	Фамилия пользователя
work_position `string`	Должность пользователя
color `string`	Цвет пользователя в формате HEX
avatar `string` `null`	Ссылка на аватар пользователя
avatar_hr `string` `null`	Ссылка на аватар высокого разрешения. На текущий момент поле возвращается всегда, независимо от значения `AVATAR_HR`
gender `string`	Пол пользователя: `M`, `F` или пустое значение, если не указан
birthday `string`	День рождения в формате `DD-MM` или пустая строка
extranet `boolean`	Признак экстранет-пользователя
network `boolean`	Признак пользователя Битрикс24 Network
bot `boolean`	Признак пользователя-бота
connector `boolean`	Признак пользователя-коннектора открытых линий
external_auth_id `string`	Идентификатор внешней авторизации
status `string`	Статус пользователя. В новом мессенджере поле всегда содержит `online` независимо от фактически установленного статуса. Проверить установленный статус можно методом im.user.status.get, изменить — методом im.user.status.set
idle `string` `boolean`	Время перехода в статус «Отошел» в формате ISO 8601 (RFC3339) или `false`
last_activity_date `string` `boolean`	Время последней активности в формате ISO 8601 (RFC3339) или `false`
mobile_last_date `string` `boolean`	Время последней активности в мобильном приложении в формате ISO 8601 (RFC3339) или `false`
desktop_last_date `string` `boolean`	Время последней активности в десктопном приложении в формате ISO 8601 (RFC3339) или `false`
absent `string` `boolean`	Дата окончания отсутствия в формате ISO 8601 (RFC3339) или `false`
departments `array`	Массив идентификаторов подразделений
phones `object` `boolean`	Телефоны пользователя или `false`. Структура объекта подробно описана ниже
website `string`	Сайт пользователя или пустая строка
email `string`	Email пользователя или пустая строка
bot_data `object` `null`	Данные бота для пользователей-ботов
type `string`	Тип пользователя

Объект phones

Название `Тип`	Описание
personal_mobile `string`	Мобильный телефон
work_phone `string`	Рабочий телефон
inner_phone `string`	Внутренний телефон

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

HTTP-статус: 400

{
            "error": "SEARCH_TEXT_ERROR",
            "error_description": "SEARCH_TEXT can't be less then 3 symbols"
        }

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

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

Код	Описание	Значение
`SEARCH_TEXT_ERROR`	SEARCH_TEXT can't be less then 3 symbols	Ошибка возникает, если не заданы `SEARCH_TYPE`, `SEARCH_DATE`, `SEARCH_TYPES`, `SEARCH_AUTHORS`, пара `SEARCH_DATE_FROM` и `SEARCH_DATE_TO`, а длина `SEARCH_TEXT` меньше `3`
`LAST_ID_STRING`	Last notification ID can't be string	Параметр `LAST_ID` содержит нечисловое значение

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

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.notify.history.search

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

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

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

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

Объект resultОбъект result

Объект notificationОбъект notification

Объект userОбъект user

Объект phonesОбъект phones

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

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

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

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