Last updated: Dec 12 2018
This topic introduces mobile push messages for Episerver Campaign. A mobile push notification is delivered from a software application to a mobile device, and appears on the device without a specific request from the client. The publisher can send the message at any time, recipients do not have to use their devices to receive them.
To set up and use Mobile Push with Episerver Campaign, you need the following:
- An app that you created and manage.
- A user account for Firebase Cloud Messaging Service (FCM), a cross-platform messaging solution to notify a client app that new data is available for synchronization.
Operating system depending on device:
- Android, version 4.1 and higher
- iOS, version 8.0 and higher
The following information is required for the setup:
- Name of your Episerver Campaign client.
- The app’s icon in a PNG file format (512x512 pixels and not greater than 1 MB).
- The app ID/package name of the app into which the SDK is integrated.
- Your FCM account’s API key.
- The sender ID with which the app registers at FCM.
- The name of your app
- The desired recipient list fields.
Complete a form from Episerver customer support for setting up the client, and email it to customer support.
Adapting your app
When the configuration of your client is completed, you will receive the following from Episerver:
- Depending on device:
- SDK for Android (ZIP file contains the executable JAR file).
- SDK for iOS (ZIP file contains the SDK source code).
- SDK documentation.
- Episerver Campaign authentication token that is generated for the app and required for the SDK.
Note: You can only have one recipient list per app in Episerver Campaign.
The SDK is integrated into the app, and when a user installs the app on a device, FCM automatically generates a registration token, when the SDK is initialized on the device. The registration token is a unique key used to identify the user in a recipient list, and is sent to Episerver Campaign.
The app sends this user registration token together with the following information about the device used:
- Language used
- Operating system platform
- Operating system version
- Operating system SDK
- App version
- App SDK
- Device manufacturer
- Device model
- Device brand
The app can also transfer additional client data such as user email address, if the user is registered in the app.
Note: Email addresses that are transferred with customer data are not a valid opt-in for your email marketing. However, you may still use these email addresses for reconciliation with other recipient lists.
- Android. No mandatory opt-in method exists currently for end-devices running Android. App developers are free to offer a setting for receiving messages when installing the push messages app.
- iOS. iOS requires users to consent to receiving messages.
If users disable push notifications in the app settings or deletes the app, they will no longer receive push notifications.
Effects on recipient lists
If the user disables push notifications or deletes the app, the user is not entered in the blacklist. However, the user is deleted from the list at the next dispatch attempt if:
- The push token is the recipient ID.
- The push media field is the only media field in the recipient list.
- The push media field is required.
The user is not deleted from mixed recipient lists with several media type fields. Only the push token data is removed from the push media field at the next sending trial.