Действие Publish

Статья создана

Обновлена 13 декабря 2024 г.

HTTP-запрос
- Query-параметры
- Атрибуты
Ответ
- Успешный ответ
- Ответ с ошибкой
См. также

Отправляет Push-уведомление в эндпоинт.

HTTP-запрос

POST https://notifications.yandexcloud.net/

Query-параметры

Параметр	Описание
`Action`	string Обязательное поле. Параметр для обозначения типа операции. Значение: `Publish`.
`Message`	string Обязательное поле. Сообщение, которое вы хотите отправить в эндпоинт. Возможные форматы: Простой текст. JSON. В формате JSON вы можете опционально передать текст для конкретной мобильной платформы, например: { "default": "This is the default message which must be present when publishing a message to a topic. The default message will only be used if a message is not present for one of the notification platforms.", "APNS": "{"aps":{"alert": "Check out these awesome deals!","url":"yandex.cloud"} }", "GCM": "{"data":{"message":"Check out these awesome deals!","url":"yandex.cloud"},"notification":{"title":"GCM notification title"}}" "HMS": "{"data":{"message":"Check out these awesome deals!","url":"yandex.cloud"},"notification":{"title":"HMS notification title"}}" } В сообщениях для платформ FCM и HMS обязательно должно присутствовать хотя бы одно из полей `data` или `notification`.
`MessageStructure`	string Если в поле `Message` вы передаете сообщение в формате JSON, задайте в поле `MessageStructure` значение `json`.
`MessageAttributes.entry.N.Name`	string Обязательное поле. Имя атрибута. `N` — числовое значение. Пример: `MessageAttributes.entry.1.Name=FirstName&MessageAttributes.entry.2.Name=SecondName`.
`MessageAttributes.entry.N.Value.DataType`	string Обязательное поле. Тип данных атрибута. `N` — числовое значение. Пример: `MessageAttributes.entry.1.Value.DataType=String&MessageAttributes.entry.2.Value.DataType=Number`.
`MessageAttributes.entry.N.Value.StringValue`	string Обязательное поле. Значение атрибута. `N` — числовое значение. Пример: `MessageAttributes.entry.1.Value.StringValue=background&MessageAttributes.entry.2.Value.StringValue=5`.
`TargetArn`	string Обязательное поле. Идентификатор (ARN) мобильного эндпоинта. Пример: `arn:aws:sns::aoegtvhtp8ob******:endpoint/GCM/test-cns-9990/4cbe148515360244248c993abe0a12884d162bb15e87d6c16bd0c810******`.
`ResponseFormat`	string Формат ответа. Возможные значения: `XML` (по умолчанию). `JSON`.

Атрибуты

С помощью атрибутов вы можете передать специфичные для мобильной платформы параметры. В значениях MessageAttributes нельзя передать бинарные данные.

Атрибуты APNS и APNS_SANDBOX

Атрибут	Описание
AWS.SNS.MOBILE.APNS.TTL	Время жизни уведомления в секундах.
AWS.SNS.MOBILE.APNS_SANDBOX.TTL	Время жизни уведомления в секундах. Для тестируемых приложений.
AWS.SNS.MOBILE.APNS_VOIP.TTL	Время жизни уведомления о входящем VoIP-вызове в секундах.
AWS.SNS.MOBILE.APNS_VOIP_SANDBOX.TTL	Время жизни уведомления о входящем VoIP-вызове в секундах. Для тестируемых приложений.
AWS.SNS.MOBILE.APNS.COLLAPSE_ID	Идентификатор для нескольких уведомлений, которые сворачиваются в одно.
AWS.SNS.MOBILE.APNS.PRIORITY	Приоритет вывода уведомления. Значение от `1` до `10`.
AWS.SNS.MOBILE.APNS.PUSH_TYPE	Тип уведомления. Подробнее см. в документации Apple.
AWS.SNS.MOBILE.APNS.TOPIC	Тема уведомления. Подробнее см. в документации Apple.