Для AI-агентов: markdown этой страницы — /docs-content/notifications/groups.md индекс документации — /llms.txt

Группы уведомлений

Группа уведомлений отбирает уведомления пользователя по модулю и событию, из которых они пришли. Пара модуля и события — условие группы. Операции читают группы, создают группу с первым условием, переименовывают и удаляют её, добавляют и убирают условия.

Скоуп: im | Базовый URL: https://vibecode.bitrix24.tech/v1 | Авторизация: X-Api-Key

Список групп уведомлений

GET /v1/notifications/groups

Возвращает группы уведомлений пользователя: системные и созданные им самим. Вызывайте перед изменением группы, чтобы узнать её идентификатор и текущие условия.

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/notifications/groups" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/notifications/groups" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/groups', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
const ownGroups = data.items.filter((group) => group.isEditable)
console.log('Своих групп:', ownGroups.length)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/groups', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
const ownGroups = data.items.filter((group) => group.isEditable)
console.log('Своих групп:', ownGroups.length)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.items array Группы уведомлений: сначала системные, за ними созданные пользователем
data.items[].tag string Идентификатор группы. У системной группы — метка: confirm, mention или admin. У группы пользователя — числовой идентификатор строкой, например "12". Его передают числом в путь :groupId операций Переименовать группу уведомлений, Удалить группу уведомлений, Добавить условие в группу уведомлений и Убрать условие из группы уведомлений
data.items[].title string Название группы
data.items[].isEditable boolean false у системной группы — её нельзя переименовать, удалить или изменить её условия. true у группы пользователя
data.items[].conditions object Условия, по которым группа отбирает уведомления
data.items[].conditions.notifyType number Есть только у группы confirm. Значение 1 — группа отбирает запросы подтверждения, уведомления с кнопками ответа
data.items[].conditions.moduleConditions object Условия по модулям. Ключ — идентификатор модуля без изменений, например tasks или vendor.my_module. Ключ all — условие без модуля
data.items[].conditions.moduleConditions.<module>.isWhole boolean true — группа отбирает все события модуля, список events отбор не ограничивает. false — только события из events
data.items[].conditions.moduleConditions.<module>.events array Идентификаторы событий модуля, которые отбирает группа

Пример ответа

HTTP 200:

JSON 
{
  "success": true,
  "data": {
    "items": [
      {
        "tag": "confirm",
        "title": "Требуют действия",
        "conditions": { "notifyType": 1 },
        "isEditable": false
      },
      {
        "tag": "mention",
        "title": "С упоминанием меня",
        "conditions": {
          "moduleConditions": {
            "all": { "isWhole": false, "events": ["mention", "mention_comment"] }
          }
        },
        "isEditable": false
      },
      {
        "tag": "12",
        "title": "Задачи и календарь",
        "conditions": {
          "moduleConditions": {
            "tasks": { "isWhole": false, "events": ["comment"] },
            "calendar": { "isWhole": false, "events": ["invite"] }
          }
        },
        "isEditable": true
      }
    ]
  }
}

Пример ответа при ошибке

400 — передан параметр запроса:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Query parameter `limit` is not accepted by GET /v1/notifications/groups. It takes no query parameters."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передан параметр запроса — операция их не принимает. Имя параметра — в message
422 BITRIX_ERROR Битрикс24 отклонил запрос, код портала — в поле error.b24Code
403 SCOPE_DENIED У ключа нет скоупа im
401 TOKEN_MISSING У ключа нет настроенных токенов

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Группы принадлежат пользователю, от имени которого выполнен вызов. По личному ключу это владелец ключа, по ключу OAuth-приложения — пользователь сессии из заголовка Authorization: Bearer. Все операции с группами и условиями группы работают с группами того же пользователя.

Смотрите также