Push notifications messages import

You can create several push notification messages by file import. This function is compatible with all iOS or Android applications and allows you to create messages for different applications in one single import.

Message list import

To access the import function, click on the menu Actions > Push notifications then on the "Import messages" button. You will land on the import page and be able to import a list of messages relative to all applications you manage (and not only relative to the application visible in the top right corner of the page).

When you first import a file, don't forget to upload a template in order to retrieve the appropriate field names. You can upload an OS specific template (depending on the selected application's OS) and a general template including all common and OS specific fields. The file's fields are explained further on.

Once your file is ready for import, click on the file selection button, select the file you want to import and click on Submit. A confirmation message will inform you on the number of successfully imported messages and if needed, on the incorrect messages that could not be imported. So you can better detect the messages that could not be imported, a detailed report of errors will enable you to identify the concerned lines and sources of error.

The import file's fields

iOS and Android common fields

  • App ID: Compulsory field used to specify the application's Accengage ID for which you want to create the message. If needed, you can retrieve application IDs in the Settings > Manage application section.
  • Campaign ID: Compulsory field in which you need to specify the campaign's Accengage ID associated to the message. Therefore, the campaign needs to have been created beforehand. If needed, you can retrieve campaign IDs in the campaign list accessible in the Actions > Push notifications section.
  • Name: Compulsory field for the notification's name.
  • External ID: Optional field in which you can specify an ID specific to your entity. Please note that this ID needs to be unique and cannot already exist for the specified application.
  • Language: Optional field if unilingual message but compulsory if multilingual message. For more information on how to configure a multilingual message via import, please refer to specific section further on.
  • Message: Optional field in which you can type the message content.
  • Sound: Optional field allowing you to choose the sound to trigger when the notification is received. This field accepts one of the following values : "none" if no sound must be triggered when notification is received, "default" if at reception the device's default sound must be triggered or "custom" if message reception must trigger an app specific sound (this last option is only compatible if your application includes a built-in library of specific sounds). By default, the field's value is "default", even if it is empty in the import file.
  • Sound name: Optional field enabling to specify the name of the sound file to call if the value of the "Sound" field is set as "custom".
  • Badge: Optional field in which you can specify whether or not the notification displays a number on the application's launch icon when received. The number typed in this field can increase or replace the badge's value depending on on how the "Badge increment" field is set. The number "0" resets the badge and the later disappears when the notification is received. By default, the field's value is empty, thereby no modification is made to any already existing badge on the application's launcher.
  • Badge increment: Optional field enabling you to indicate, when a badge is set, whether or not its value must increase any already existing badge. Please indicate "TRUE" in the import file if you want the badges value to be added to any existing one or "FALSE" if you want its value to replace any existing one. By default, the field's value is "FALSE", even if it is empty in the import file.
  • Rich push URL: Optional field in which you can specify the redirect link upon click on the notification. Please note that the URL must start with "http://" or "https://" and that if you wish the redirect link to be compatible with iOS 9, the URL must be a secure one or the application must allow exceptions.
  • Open richpush in: Optional field enabling you to specify whether the Rich push URL must be opened in a webview or in a browser. Please indicate "webview" in the import file if you want the redirect link to open in the application via a webview or "browser" if you wish it to open in a web browser application. By default, the field's value is "webview", even if it is empty in the import file.
  • Marketing pressure: Optional field in which you can specify whether or not the message must be taken into account in the marketing pressure. This option is only valid if a marketing pressure has been configured in the application's settings (menu Settings > Settings). Otherwise it is ignored, even if the field is filled in. Please indicate "TRUE" in the import file if you want the message to be counted in the marketing pressure or "FALSE" if not. By default, when a marketing pressure has been configured, the field's value is "TRUE", even if it is empty in the import file.
  • Show in foreground: Optional field enabling you to specify whether or not the notification can be displayed it the application is in foreground. Please indicate "FALSE" in the import file if you want to prevent the message's display when the application is in foreground or "TRUE" if not. By default, the field's value is "FALSE", even if it is empty in the import file.
  • Custom params: Optional field in which you can type additional parameters. A custom parameter must be formatted the following way: [key]=[value]. If you want to add several custom parameters, each have to be separated by a " | " (for example, "A=a | B=b").
  • Test segment IDs: Optional field in which you can indicate the Accengage IDs of the message's test segments. If needed, you can retrieve segment IDs in the Targeting > Segments / Lists section. If you want to add several test segments to the message, please separate IDs with a coma no space (for example, "123,456").
  • Campaign segment IDs: Optional field in which you can indicate the Accengage IDs of the message's campaign segments. If needed, you can retrieve segment IDs in the Targeting > Segments / Lists section. If you want to add several campaign segments to the message, please separate IDs with a coma no space (for example, "123,456"). Please note that this field is not compatible with list IDs and all unknown IDs will be ignored (but will not block message import).
  • Test: Optional field allowing you to indicate if the message has already been tested or not. If the message is specified as tested, it can be sent without being tested via the interface. Please indicate "TRUE" in the import file if you want to tag the message as tested or "FALSE" if you want the message to be tested via the interface. By default, the field's value is "FALSE", even if it is empty in the import file.
  • Child message: Optional field enabling you to indicate whether or not a message is linked to a previous one. This function is essentially used to configure localized versions of a same message (for more information on how to create multilingual messages, please refer to specific section below). Please indicate "FALSE" in the import file if you want to add an independent message or "TRUE" if the message constitutes a localized version of a message situated above in the file. By default, the field's value is "FALSE", even if it is empty in the import file.

iOS specific fields

  • Action label: Optional field allowing you to personalize the iOS Switch button.
  • Content available: Optional field that enables to send a silent parameter to the app (when value is set as "TRUE"), thereby notifying it that it has content to download in the background. Please indicate "TRUE" in the import file if you want to activate the "Content available" parameter or "FALSE" if not. By default, the field's value is "FALSE", even if it is empty in the import file.

Android specific fields

  • Show popup: Optional field in which you can specify whether or not the notification should be displayed as a pop-up message. Please indicate "TRUE" in the import file if you want the message to be displayed as a pop-up or "FALSE" otherwise. By default, the field's value is "FALSE", even if it is empty in the import file.
  • Popup OK button label: Optional field enabling you to specify the OK button label of the pop-up message.
  • Popup Cancel button label: Optional field enabling you to specify the Cancel button label of the pop-up message.
  • Customized title: Optional field allowing you to personalize the notification's title.
  • Short message: Optional field in which you can type the short message content (for Android BigPicture style templates for exemple).
  • Image URL: Optional field allowing you to add an image to the message (for Android BigPicture style templates for exemple). Please note, the image's URL must start with "http://" or "https://".
  • Collapse key: Optional field in which you can specify the message's collapse key if needed. The collapse key's value must match its Accengage ID and therefore has to have been added to the interface beforehand. If needed, you can retrieve collapse key IDs in the Settings > Settings section.
  • Thumbnail URL: Optional field allowing you to personalize the notification's thumbnail. Please note, the thumbnail's URL must start with "http://" or "https://". By default, the message's thumbnail matches the application's launcher.

Importing a multilingual message

When importing a multilingual message, each language must constitute a distinct message and therefore line in the file.

  • The "Language" filed must contain the language code of the specific message. You can download the language code library via this link.
  • All linguistic versions of the main message must contain the value "TRUE" in the "Child message" field. Please note that this specific field for the main message (line in the file with the first localized version of the message) must be empty or contain the value "FALSE".
  • All common fields to the linguistic versions (app ID, campaign ID, notification name, external ID, segments, Android thumbnail...) only take into account the values specified for the main message.

Example of multilingual message configuration

In the above exemple,

  • A multilingual message is created on the App A, with the English message constituting the main message. The "Child message" for this specific line is therefore empty (the field's value could have also been set as "FALSE"). The two following lines are localized versions of the main message for which the "Child message" field has to be set as "TRUE". For these localized versions, it is not necessary to fill in the common message fields such as App ID, Campaign ID or even segment IDs.
  • An other message follows in the import file for which the "Child message" field is empty. It is important to reset the "Child message" field for all new messages. Otherwise, the import will return an error, blocking the import of the following message.