Получить схему типов уведомлений im.notify.schema.get

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: im

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

Метод im.notify.schema.get возвращает типы уведомлений портала, сгруппированные по модулям.

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

Без параметров.

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify.schema.get
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/im.notify.schema.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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
// Keys of result are module codes: blog, calendar, tasks and so on
type NotificationSchemaResult = Record<string, ModuleSchema>

type ModuleSchema = {
  NAME: string
  MODULE_ID: string
  LIST: Array<{
    ID: string
    NAME: string
  }>
}

try {
  const response = await $b24.actions.v2.call.make<NotificationSchemaResult>({
    method: 'im.notify.schema.get',
    params: {},
    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
    for (const module of Object.values(result)) {
      console.info(module.NAME, module.LIST.map((item) => item.ID))
    }
  }
} 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 getNotificationSchema() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.notify.schema.get',
        params: {},
        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
      for (const module of Object.values(result)) {
        console.info(module.NAME, module.LIST.map((item) => item.ID))
      }
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getNotificationSchema)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.notify.schema.get().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.schema.get', []);
    $result = $response->getResponseData()->getResult();

    print_r($result);
} catch (Throwable $exception) {
    echo $exception->getMessage();
}
BX24.callMethod('im.notify.schema.get', {}, function(result) {
    if (result.error()) {
        console.error(result.error().ex);
    } else {
        console.log(result.data());
    }
});
require_once('crest.php');

$result = CRest::call('im.notify.schema.get', []);

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.schema.get", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("im.notify.schema.get: %w", err)
}

// Ключи result — коды модулей: blog, calendar, tasks и другие
var modules map[string]struct {
	Name     string `json:"NAME"`
	ModuleID string `json:"MODULE_ID"`
	List     []struct {
		ID   string `json:"ID"`
		Name string `json:"NAME"`
	} `json:"LIST"`
}
if err := json.Unmarshal(res.Result, &modules); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for code, module := range modules {
	fmt.Println(code, module.Name, len(module.List))
}

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

HTTP-статус: 200

{
    "result": {
        "tasks": {
            "NAME": "Задачи",
            "MODULE_ID": "tasks",
            "LIST": [
                {
                    "ID": "tasks|comment",
                    "NAME": "Новый комментарий к задаче"
                },
                {
                    "ID": "tasks|reminder",
                    "NAME": "Напоминание о задаче"
                },
                {
                    "ID": "tasks|manage",
                    "NAME": "Создание или изменение задачи"
                },
                {
                    "ID": "tasks|task_assigned",
                    "NAME": "Вас назначили исполнителем"
                },
                {
                    "ID": "tasks|task_expired_soon",
                    "NAME": "Задача почти просрочена"
                }
            ]
        },
        "rest": {
            "NAME": "Маркетплейс",
            "MODULE_ID": "rest",
            "LIST": [
                {
                    "ID": "rest|app_install",
                    "NAME": "Установлено новое приложение"
                },
                {
                    "ID": "rest|app_install_request",
                    "NAME": "Запрос на установку приложения"
                },
                {
                    "ID": "rest|vi_user_data_request",
                    "NAME": "Приложение запрашивает доступ к данным"
                }
            ]
        }
    },
    "time": {
        "start": 1794317532,
        "finish": 1794317532.176408,
        "duration": 0.176408052444458,
        "processing": 0,
        "date_start": "2026-11-10T16:32:12+03:00",
        "date_finish": "2026-11-10T16:32:12+03:00",
        "operating_reset_at": 1794318120,
        "operating": 0
    }
}

В примере показаны два модуля из ответа. Полный ответ содержит все модули портала, которые отправляют уведомления, например blog, calendar, crm, disk, im, tasks.

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

Название
тип

Описание

result
object

Объект, в котором ключ — код модуля, например tasks, а значение — описание модуля и его типов уведомлений (подробное описание)

time
time

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

Объект модуля

Название
тип

Описание

NAME
string

Название модуля

MODULE_ID
string

Код модуля. Совпадает с ключом объекта в result и с полем notify_module уведомления

LIST
array

Массив типов уведомлений модуля (подробное описание)

Элемент LIST

Название
тип

Описание

ID
string

Код типа уведомления в формате MODULE|EVENT, например tasks|comment.

Используйте в параметрах SEARCH_TYPE и SEARCH_TYPES метода im.notify.history.search. Совпадает с полем setting_name уведомления в ответе im.notify.get.

В схеме есть не все коды, которые встречаются в уведомлениях: например, уведомления приложений приходят с кодом rest|rest_notify, которого нет в LIST

NAME
string

Название типа уведомления

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

HTTP-статус: 401

{
    "error": "INVALID_CREDENTIALS",
    "error_description": "Invalid request credentials"
}

У метода нет собственных кодов ошибок, возможны только системные ошибки REST API.

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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