Отправка push-уведомлений по топикам
Для работы с топиками потребуются следующие артефакты:
- project_id (ID проекта), ss_token (сервисный токен) — Эти значения можно получить в консоли разработчика. Для этого нужно перейти в раздел «Push-уведомления», открыть вкладку «Проекты» на странице приложения. Подробнее смотрите в разделе Отправка push-уведомлений.
- push_token — Пуш-токен(ы) устройств для подписки на рассылку по топику и отписки от неё.
- topic — Топик в проекте.
Отправка push-уведомления в топик
Требуется наличие заголовка Authorization: Authorization: Bearer $ss_token.
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
| data |
map |
Объект, содержащий пары « |
|
notification |
object (message.notification) |
Базовый шаблон уведомления для использования на всех платформах |
|
android |
object (message.android) |
Специальные параметры Android для сообщений |
Тело успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
|
message |
text |
Сообщение об успешной отправке пуша |
Тело ответа ошибки
| Параметр | Тип | Описание |
|---|---|---|
|
code |
int | Код ошибки |
| status | text | Статус |
| message | text | Подробная ошибка |
Подписка на push-уведомления по топику
Требуется наличие заголовка Authorization: Authorization: Bearer $ss_token.
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
|
push_tokens |
array (string) | Пуш-токены, которые нужно подписать на топик |
Тело успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
|
message |
text | Сообщение об успешной подписке или наличии ошибок |
| errors | object array (Тело ошибки по токену) | Ошибки по токенам |
Тело ошибки по токену
| Параметр | Тип | Описание |
|---|---|---|
|
push_token |
text | Пуш-токен |
| error | object (Тело ответа ошибки) | Ошибка |
Тело ответа ошибки
| Параметр | Тип | Описание |
|---|---|---|
|
code |
int | Код ошибки |
| status | text | Статус |
| message | text | Подробная ошибка |
Отписка от push-уведомлений по топику
Требуется наличие заголовка Authorization: Authorization: Bearer $ss_token.
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
|
push_tokens |
string array | Пуш-токены, которые нужно отписать от топика |
Тело успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
|
message |
text | Сообщение об успешной подписке или наличии ошибок |
| errors | object array (Тело ошибки по токену) | Ошибки по токенам |
Тело ошибки по токену
| Параметр | Тип | Описание |
|---|---|---|
|
push_token |
text |
Пуш-токен |
| error | object (Тело ответа ошибки) | Ошибка |
Тело ответа ошибки
| Параметр | Тип | Описание |
|---|---|---|
|
code |
int | Код ошибки |
| status | text | Статус |
| message | text | Подробная ошибка |
Обновлено 20 июня 2023 г.
Was this information helpful?