Push Message Payload Mapping

The push server provides a convenient wrapper on top of the push messages sent to various platforms (APNS, FCM). This chapter describes what fields of the abstract push message are mapped to particular fields of APNS or FCM payload.

Abstract Push Message Object

Abstract push message payload is represented using this object:

public class PushMessageBody {

    private String title;
    private String titleLocKey;
    private String[] titleLocArgs;
    private String body;
    private String bodyLocKey;
    private String[] bodyLocArgs;
    private Integer badge;
    private String sound;
    private String icon;
    private String category;
    private String collapseKey;
    private Date validUntil;
    private Map<String, Object> extras;

}

APNS Mapping

Attributes of the abstract push message object are mapped to APNS payload in following way:

For the documentation of the APNS payload reference, please read the official Apple documentation:

• Local and Remote Notification Programming Guide

Silent Messages

In case a push message is marked with the silent flag, we add content-available = 1 key to the aps payload.

FCM Mapping

Attributes of the abstract push message object are mapped to FCM payload in following way:

For the documentation of the FCM payload reference, please read the official Google documentation:

• Cloud Messaging - About FCM Messages

Silent Messages

In case a push message is marked with the silent flag, we do not add attributes that trigger visible push notifications (attributes with notification.* path), even if they are present in the abstract push message object.