Skip to content

Семейство: notify

norm_notify

Уведомить человека о том, что требует его внимания: о незаполненном, о неуверенно определённом, о готовности. Получатель — идентификатор человека из norm_people_list; record связывает уведомление с записью, канал доставки выбирает реализация. Уровень warning требует внимания, info — норма. Разница существенная: warning по той же записи СНИМАЕТ ваши прежние предупреждения, а info накапливается как история. Поэтому в новом предупреждении перечисляйте всё нерешённое заново, а не только изменения. Если к следующему прогону всё дозаполнено и писать нечего — вызовите с clear_only: true и record.key: прежние предупреждения снимутся, новых не появится. Без clear_only обязательны recipient_id и text; при clear_only обязателен record.key или record.meeting_id. Умолчание уровня — warning. Ответ delivered: false — доставлять было некуда (запись ещё не создана или удалена), это не сбой. Доменные состояния: unknown_user — получателя нет в системе компании; not_ready, unknown_target, temporary, rate_limited.

Доступ: запись · Списковый: нет · Версии: 1

Вход

ПолеОбязательноТипЗначение
clear_onlyнетboolean
levelнетwarning | info
recipient_idнетstring
recordнетRecordRefСсылка на запись
textнетstring

Данные ответа

ПолеПри успехеТипЗначение
clearedдаinteger
deliveredдаboolean
errorнетDomainErrorДоменное состояние
levelдаwarning | info
noteнетstring
Пример: успешный ответ
json
{
  "source_refs": [
    {
      "source": "company-data",
      "ref": "record:meeting-protocols:notify",
      "label": "Уведомление по записи"
    }
  ],
  "freshness": {
    "as_of": "2026-09-21T09:32:00.000Z",
    "ttl_sec": 0,
    "stale": false
  },
  "data": {
    "delivered": true,
    "cleared": 1,
    "level": "warning"
  }
}
Пример: случай «domain_error»
json
{
  "source_refs": [
    {
      "source": "company-data",
      "ref": "record:meeting-protocols:notify"
    }
  ],
  "freshness": {
    "as_of": "2026-09-21T09:32:00.000Z",
    "ttl_sec": 0,
    "stale": false
  },
  "data": {
    "delivered": false,
    "error": {
      "code": "unknown_user",
      "message": "Получателя с таким идентификатором нет в системе компании.",
      "retryable": false
    }
  }
}