# im.notify.schema.get

URL: https://chugunov.pro/api-bitrix24/chats/notifications/im-notify-schema-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить схему типов уведомлений
Scope: `im`
Кто может выполнять метод: любой пользователь

## Описание

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

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "tasks": {
            "NAME": "Задачи",
            "MODULE_ID": "tasks",
            "LIST": [
                {
                    "ID": "tasks|task_update",
                    "NAME": "Изменения задач"
                }
            ]
        }
    },
    "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`. Объект схемы уведомлений, ключ верхнего уровня — `MODULE_ID`.
  Структура объекта модуля подробно описана [ниже](#module-object)
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 401

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


## Примеры запроса

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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)
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
    console.info(Object.keys(result), result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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
      console.info(Object.keys(result), result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getNotificationSchema)
</script>
```

### Python

```python
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}")
```

### PHP

```php
try {
    $response = $b24Service->core->call('im.notify.schema.get', []);
    $result = $response->getResponseData()->getResult();

    if ($result->error()) {
        echo 'Error: ' . $result->error();
    } else {
        var_dump($result->data());
    }
} catch (Throwable $exception) {
    echo $exception->getMessage();
}
```

### BX24.js

```js
BX24.callMethod('im.notify.schema.get', {}, function(result) {
    if (result.error()) {
        console.error(result.error().ex);
    } else {
        console.log(result.data());
    }
});
```

### PHP CRest

```php
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']);
}
```

### Go

```go
// 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)
}

// Метод заворачивает ответ в объект с ключом "tasks".
raw, ok := b24.Unwrap(res.Result, "tasks")
if !ok {
	return fmt.Errorf("в ответе нет ключа tasks")
}

var item struct {
	Name     string `json:"name"`
	ModuleID string `json:"module_id"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Name, item.ModuleID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-schema-get.html