im.notify.get
Получить уведомления
Описание
Метод im.notify.get возвращает список уведомлений пользователя частями. Следующая часть запрашивается через LAST_ID и LAST_TYPE.
Сортировка уведомлений: сначала по убыванию даты создания, затем по убыванию идентификаторов.
Параметры
LAST_ID
integer
необязательный
Идентификатор последнего уведомления предыдущей страницы для загрузки следующей. Обычно берется из поля id последнего элемента массива notifications в ответе предыдущего шага выборки или в ответе im.notify.history.search
Идентификатор уведомления также возвращают методы im.notify, im.notify.personal.add и im.notify.system.add.
Параметр нужно использовать вместе с LAST_TYPE
LAST_TYPE
integer
необязательный
Технический курсор пагинации.
Допустимые значения:
- 1 — продолжить выборку с этапа подтверждений
- 3 — продолжить выборку с этапа обычных уведомлений
Параметр нужно использовать вместе с LAST_ID.
Для значений, отличных от 1 и 3, сервер не возвращает отдельную ошибку
LIMIT
integer
необязательный
Количество уведомлений на страницу. Значение по умолчанию — 50. Максимальное значение — 50
CONVERT_TEXT
string
необязательный
Преобразовать текст уведомлений. Значение Y включает преобразование, любое другое значение отключает
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"LAST_ID":1500,"LAST_TYPE":3,"LIMIT":20,"CONVERT_TEXT":"Y"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"LAST_ID":1500,"LAST_TYPE":3,"LIMIT":20,"CONVERT_TEXT":"Y","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.notify.get
// 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
type NotificationItem = {
id: number
chat_id: number
author_id: number
date: ISODate
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
notify_buttons?: string
params: object | null
}
type UserItem = {
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
mobile_last_date: ISODate | false
desktop_last_date: ISODate | false
absent: ISODate | false
departments: number[]
phones: Record<string, string> | false
bot_data: object | null
type: string
website: string
email: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type ImNotifyGetResult = {
total_count: number
total_unread_count: number
chat_id: number
notifications: NotificationItem[]
users: UserItem[]
}
try {
const response = await $b24.actions.v2.call.make<ImNotifyGetResult>({
method: 'im.notify.get',
params: {
LAST_ID: 1500,
LAST_TYPE: 3,
LIMIT: 20,
CONVERT_TEXT: 'Y',
},
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('Total notifications:', result.total_count, 'Unread:', result.total_unread_count)
console.info('Notifications on page:', 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 getNotifications() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.notify.get',
params: {
LAST_ID: 1500,
LAST_TYPE: 3,
LIMIT: 20,
CONVERT_TEXT: 'Y',
},
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('Total notifications:', result.total_count, 'Unread:', result.total_unread_count)
console.info('Notifications on page:', result.notifications.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getNotifications)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.notify.get(
last_id=1500,
last_type=3,
limit=20,
convert_text=True,
).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.get',
[
'LAST_ID' => 1500,
'LAST_TYPE' => 3,
'LIMIT' => 20,
'CONVERT_TEXT' => 'Y',
]
);
$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.get',
{
LAST_ID: 1500,
LAST_TYPE: 3,
LIMIT: 20,
CONVERT_TEXT: 'Y',
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.notify.get',
[
'LAST_ID' => 1500,
'LAST_TYPE' => 3,
'LIMIT' => 20,
'CONVERT_TEXT' => 'Y',
]
);
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.get", b24.Params{
"LAST_ID": 1500,
"LAST_TYPE": 3,
"LIMIT": 20,
"CONVERT_TEXT": "Y",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("im.notify.get: %w", err)
}
var item struct {
TotalCount int `json:"total_count"`
TotalUnreadCount int `json:"total_unread_count"`
ChatID int `json:"chat_id"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.TotalCount, item.TotalUnreadCount)
Ответ
HTTP-статус: 200
{
"result": {
"total_count": 120,
"total_unread_count": 5,
"chat_id": 77,
"notifications": [
{
"id": 1500,
"chat_id": 77,
"author_id": 1,
"date": "2026-03-03T09:00:00+00:00",
"notify_type": 2,
"notify_module": "rest",
"notify_event": "rest_notify",
"notify_tag": "MP|12345|TASK_42",
"notify_sub_tag": "MP|12345|TASK|42",
"notify_title": "",
"setting_name": "rest|rest_notify",
"text": "Напоминание",
"notify_read": "N",
"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-03T15: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-03T10:00:00+03:00",
"date_finish": "2026-03-03T10:00:00+03:00",
"operating_reset_at": 1760030000,
"operating": 0
}
}
Возвращаемые данные
result
object
Объект с данными уведомлений.
Структура объекта подробно описана ниже
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "LAST_ID_AND_LAST_TYPE",
"error_description": "Parameters LAST_ID and LAST_TYPE should be used together."
}
| Код | Описание | Значение |
|---|---|---|
LAST_ID_AND_LAST_TYPE |
Parameters LAST_ID and LAST_TYPE should be used together | Передан только один параметр из пары LAST_ID и LAST_TYPE |
LAST_ID_STRING |
Last notification ID can't be string | Параметр LAST_ID содержит нечисловое значение |

