Contact UsGet started

Publish

Written by
Updated at July 4, 2024

Sends a push notification to an endpoint.

HTTP request

POST https://notifications.yandexcloud.net/

Query parameters

Parameter Description
Action string
Required field.
Parameter to indicate the operation type.
Value: Publish.
Message string
Required field.
Message to send to an endpoint.
The possible formats include:
  • Simple text
  • JSON

In JSON format, you can optionally provide text for a specific mobile platform, e.g.:
{ "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"}}" }
Messages for the FCM and HMS platforms must contain at least one of the data or notification fields.
MessageStructure string
If you are providing a message in the Message field in JSON format, set the MessageStructure field to json.
MessageAttributes.entry.N.key string
Required field.
Attribute key. N: Numerical value.
Example: MessageAttributes.entry.1.key=AWS.SNS.MOBILE.APNS.PUSH_TYPE&MessageAttributes.entry.2.key=AWS.SNS.MOBILE.APNS.PRIORITY.
MessageAttributes.entry.N.value string
Required field.
Attribute value. N: Numerical value.
Example: MessageAttributes.entry.1.value={"DataType":"String","StringValue":"background"}&MessageAttributes.entry.2.value={"DataType":"String","StringValue":"5"}.
TargetArn string
Required field.
Mobile endpoint ID (ARN).
Example: arn:aws:sns::aoegtvhtp8ob********:endpoint/GCM/test-cns-9990/4cbe148515360244248c993abe0a12884d162bb15e87d6c16bd0c810********.
ResponseFormat string
Response format.
The possible values include:
  • XML (by default)
  • JSON.

Attributes

You can use attributes to provide mobile platform-specific parameters. You cannot provide binary data in the MessageAttributes values.

APNS and APNS_SANDBOX attributes

Attribute Description
AWS.SNS.MOBILE.APNS.TTL Notification lifetime in seconds
AWS.SNS.MOBILE.APNS_SANDBOX.TTL Notification lifetime in seconds for apps under testing
AWS.SNS.MOBILE.APNS_VOIP.TTL Lifetime of an incoming VoIP call notification in seconds
AWS.SNS.MOBILE.APNS_VOIP_SANDBOX.TTL Lifetime of an incoming VoIP call notification in seconds for apps under testing
AWS.SNS.MOBILE.APNS.COLLAPSE_ID ID for multiple notifications that are collapsed into one
AWS.SNS.MOBILE.APNS.PRIORITY Notification output priority, which is a value from 1 to 10
AWS.SNS.MOBILE.APNS.PUSH_TYPE Notification type; see the Apple documentation
AWS.SNS.MOBILE.APNS.TOPIC Notification topic; see the Apple documentation

FCM attributes

Attribute Description
AWS.SNS.MOBILE.FCM.TTL Message lifetime in seconds

Response

Successful response

If there are no errors, Cloud Notification Service returns the 200 HTTP code.

Error response

In case of an error, Cloud Notification Service returns a message with the appropriate HTTP code.

For a list of common error codes for all actions, see Errors.

See also

Previous
Delete