im.notify.history.search
Поиск по истории уведомлений
Описание
Метод 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 -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
// 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 the payload returned in result (match the "response handling" section of the page)
type NotifyHistorySearchResult = {
chat_id: number
total_results: number
notifications: Array<{
id: number
chat_id: number
author_id: number
date: ISODate | null
notify_type: number
notify_module: string
notify_event: string
notify_tag: string
notify_sub_tag: string
notify_title: string
setting_name: string
text: string
notify_read: string
params: object | null
}>
users: Array<{
id: number
active: boolean
name: string
first_name: string
last_name: string
work_position: string
color: string
avatar: string
avatar_hr: string
gender: string
birthday: string
extranet: boolean
network: boolean
bot: boolean
connector: boolean
external_auth_id: string
status: string
idle: ISODate | false
last_activity_date: ISODate | null
mobile_last_date: ISODate | false
desktop_last_date: ISODate | false
absent: ISODate | false
departments: number[]
phones: { work_phone?: string; inner_phone?: string } | false
bot_data: object | null
type: string
website: string
email: string
}>
}
try {
const response = await $b24.actions.v2.call.make<NotifyHistorySearchResult>({
method: 'im.notify.history.search',
params: {
SEARCH_TEXT: 'invoice',
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',
},
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(
result.chat_id,
result.total_results,
result.notifications.length,
)
}
} 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 searchNotifyHistory() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.notify.history.search',
params: {
SEARCH_TEXT: 'invoice',
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',
},
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(
result.chat_id,
result.total_results,
result.notifications.length,
)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', searchNotifyHistory)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.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=True,
group_tag="TASK|42",
).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.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']);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.notify.history.search", b24.Params{
"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 err != nil {
return fmt.Errorf("im.notify.history.search: %w", err)
}
var item struct {
ChatID int `json:"chat_id"`
TotalResults int `json:"total_results"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ChatID, item.TotalResults)
Ответ
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
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "SEARCH_TEXT_ERROR",
"error_description": "SEARCH_TEXT can't be less then 3 symbols"
}
| Код | Описание | Значение |
|---|---|---|
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 содержит нечисловое значение |

