Категории Push-уведомлений
Общее описание
Функциональность «Категории Push» позволяет классифицировать Push-уведомления по тематическим категориям. Код категории сохраняется в архивном хранилище и передаётся через API, что позволяет мобильному приложению распределять уведомления по вкладкам.
Важно: функционал доступен только при подключенном сервисе архивного хранения. Узнать о его наличии на вашем проекте или подключить архивное хранение можно с помощью вашего менеджера проекта.
Настроить категории для Push-сообщений можно в разделе Campaign «Настройки».
Категория не попадает в содержимое самого Push-уведомления, которое получает пользователь на устройство.
Права доступа
Раздел «Настройки → Категории Push» доступен для просмотра всем авторизованным пользователям.
Операции редактирования (создание, переименование, удаление категорий) требуют привилегии «Категории Push», которая настраивается администратором в Campaign UI-Admin в разделе ролей.
| Привилегия | Просмотр списка | Создание | Переименование | Удаление |
| Не назначена | Да | Нет | Нет | Нет |
| Назначена | Да | Да | Да | Да |
Управление справочником категорий
Просмотр списка категорий
Перейдите в раздел Настройки → Категории Push.
Отображается таблица с колонками:
- Код — уникальный латинский идентификатор категории.
- Название — русскоязычное отображаемое имя.
Если категории ещё не созданы, отображается текст-заглушка. Кнопка «Создать» доступна при наличии привилегии редактирования.
Для поиска используйте строку поиска — фильтрация работает по названию и по коду.
Создание категории
1. Перейдите в Настройки → Категории Push.
2. Нажмите кнопку Создать.
3. Откроется окно создания новой категории.
Заполните поля в модальном окне:
Поле | Требования |
Код | Только латиница, цифры, дефис ( - ) или подчёркивание (_). Длина: 1–32 символа. Задаётся один раз — изменить нельзя. |
Название | Русскоязычное имя. Длина: 1–64 символа. |
4. Нажмите "Сохранить".
После создания хотя бы одной категории поле «Категория Push» появится в шаблонах и шагах с отправкой Push в конструкторе коммуникаций.
Переименование категории
В списке категорий наведите курсор на нужную запись и нажмите на значок редактирования.
2. Отредактируйте поле Название.
3. Нажмите Сохранить.
Важно: редактирование меняет только русскоязычное название. Код категории изменить невозможно, он задаётся один раз при создании.
Новое название сразу отображается во всех шаблонах и шагах Push любого статуса акции.
Удаление категории
1. В списке категорий наведите курсор на нужную запись и нажмите на значок удаления.
2. Подтвердите действие.
Ограничения на удаление. Категорию нельзя удалить, если она:
- используется хотя бы в одном Push-шаблоне;
- связана с акцией в любом статусе, кроме «Остановлена» и «Завершена».
При попытке удаления связанной категории система выведет информационное сообщение: Категорию невозможно удалить, так как есть связь с действующей акцией или шаблоном.
Чтобы удалить такую категорию:
- Откройте все связанные шаблоны сообщений и снимите категорию (отметьте «Не выбрано»).
- Остановите связанные действующие акции.
- Повторите удаление.
Удалённые категории исчезают из списка и недоступны для выбора в новых шаблонах. При этом название категории продолжает отображаться в шагах Push остановленных и завершённых акций.
Использование категории в Push-шаблоне
1. Перейдите в раздел Шаблоны → Шаблоны Push.
2. Откройте существующий шаблон или создайте новый.
3. В нижней части конкструктора настроек найдите поле «Категория Push».
4. Выберите нужную категорию из выпадающего списка (отображаются русскоязычные названия).
5. Нажмите "Сохранить".
Примечания:
- Поле «Категория Push» отображается только при наличии хотя бы одной категории в справочнике.
- Поле необязательное, его можно оставить со значением по умолчанию «Не выбрано».
- Для снятия ранее выбранной категории выберите вариант «Не выбрано».
- При копировании шаблона категория push копируется вместе с ним.
- Видимость поля не зависит от привилегии (роли) пользователя.
Использование категории в Push-шаге рассылки
1. Откройте акцию и перейдите к настройке Push-шага.2.
В поле «Категория Push» выберите нужную категорию.
3. Сохраните шаг.
Поведение аналогично шаблону:
- поле необязательное,
- доступно при наличии категорий в справочнике,
- вариант «Не выбрано» снимает категорию.
Архивное хранилище и API
Как сохраняется категория
При каждой отправке Push-уведомления код категории записывается в поле Category архивной записи.
- Если категория выбрана — поле Category присутствует в записи с кодом категории.
- Если категория не выбрана («Не выбрано») — поле Category в записи отсутствует.
Код категории не включается в содержимое Push-уведомления, отправляемого на устройство пользователя.
Запрос к архивному хранилищу с фильтрацией по категории
POST /message/getallbycontact
{
"contactguid": "<GUID контакта>",
"steptype": [12],
"category": "<код категории>",
"take": 50,
"skip": 0
}
Возвращаются только записи с указанной категорией.
Запрос без фильтрации по категории
POST /message/getallbycontact
{
"contactguid": "<GUID контакта>",
"steptype": [12],
"take": 50,
"skip": 0
}
Возвращаются все записи независимо от категории.
Пример ответа с категорией
{
"Title": "Название уведомления",
"StepType": 12,
"Category": "promotions",
"Body": "Текст уведомления"
}
Пример ответа без категории
{
"Title": "Название уведомления",
"StepType": 12,
"Body": "Текст уведомления"
}
При запросе с несуществующим кодом категории возвращается 200 и пустой список.