Sending Non-Sounded / Custom Sound Push Notifications via Urban Airship

This guide will show you how to send a non-sounded push and a custom sound push for Airship.

Method to send Non-Sounded/Custom pushes in:

• Android Versions (using Urban Airship Android Plugin ABOVE version  3.0.3)

Using Urban Airship plugin version 3.0.3 and above in Android, The main Push configurations have Moved to a Plugin-Level:

Here is a screenshot from the plugin config of Android (ver 3.0.3 and above):
​​

Now, pushes are arriving to BOTH new and Old Android plugin versions, using the new configuration (if you use the Old configurations explained below for plugin version inferior to 3.0.3, the pushes will be sent Only to the older versions of the app).

PRE-REQUIRED CONFIGURATIONS IN URBAN AIRSHIP:
i- Settings —> Configuration
ii- From left-hand side menu select “Android Notification Categories”
iii- New Notification Category
iv- crate two categories:
  (a)- Name=general, Category ID=general
  (b)- Name=silent, Category ID=silent
​​
v- Open the “Urban Airship” plugin configurations in your Android version in Zapp:
vi- Insert the configuration for the "Custom Notification Channel Name" and "Notification Channel ID" according to the name that appears in to the Notification Category in the Urban Airship Dashboard.

​​

vii- Insert the configuration for the "Notification Channel Sound __" according to the name that appears in the Assets section in Zapp, so that it will use the .mp3 Sound File uploaded to Zapp:​​

Do the same for any consecutive Custom Sound you want to have in your app.
The important thing to notice, is that the “Notification Channel ID” is identical to the Category ID in the Urban Airship Dashboard:
​​

viii- In order to configure the Silent Push options, Insert the configuration for the Custom Notification Channel Name and ID, and select it as “silent”.

​​

Once again, make sure that the "Notification Channel Name" and “Notification Channel ID” is identical to the Category ID in the Urban Airship Dashboard.

SENDING A CUSTOM PUSH

A) Push with Custom Sound -
i- Configure your Push Audience and Content, normally

ii- In the "Delivery" Screen, scroll down to "Android Only", and Toggle On the “Notifications Category” button
ii- In the dropdown menu, select the name of the Custom notification
(Make sure that the plugin has the channel ID configured correctly and that the Name of the custom sound, is selected there as well)

For example, The custom Sound here is that of "Survivor":

​

It's important that:

i- The Configuration in the Plugin "Push Sound 1", Corresponds to the Actual "Push Sound 1" File/Asset"in Zapp: For example:

Plugin Level-

Zapp Level-

https://assets-production.applicaster.com/zapp/assets/app_versions/435ae7af-92fa-44c0-bfce-1ba0e0f62e3d/media_files/push_sound_1.mp3

ii- The Notification Channel ID in the plugin, is written the exact same way in the Urban Airship Dashboard.

survivor (in plugin) = survivor (in Airship)

B) Push with Default Sound -

For default sound, Don’t select anything in the “Notifications Category” /OR/ Toggle it off.

Make sure that Both the Urban Airship Dashboard (Settings Section), and the plugin, have the "general" option configured and written in the same manner.

C) Push with No Sound -
i- Enter “Android Options” and Toggle On the “Notifications Category” —> Then, select “silent” in the dropdown menu
ii- Activate “Custom Keys” —> Select “Android from” Dropdown menu —> insert “custom sound” as the Key —> insert “silent” as  the value

​

Method to send Non-Sounded/Custom pushes in:

• i- Android Versions (using Urban Airship Android Plugin BELOW version  3.0.3) 
• ii- All iOS Versions

Verify "Custom Keys" feature is activated in your Airship app.

First, we need to make sure the "Custom Keys" feature is activated in your Airship account in order to configure custom keys. 

Once you are logged in your Airship account and have selected your relevant app, You need to click on the "Settings" drop-down menu and select the option "Configuration". 

Once in the Configuration screen, you will see a left side menu with 6 options, the option we need to select is "Composer" and here you will see a few options with toggles to turn on/off. 

We need to check the "Custom Keys" feature and make sure the toggle is in the 'ON' position and if it's not, please make sure to switch the toggle to the 'ON' position. This change does not require saving of any sorts.

A. NON-Sounded Push

Configure the Audience and Content screens, and proceed to the "Delivery" screen:

Android

1. Toggle on the "Custom keys" option, and select the platform "Android" from the drop-down menu
2. Enter ‘custom sound’ as the Key.
3. The value needs be ‘silent’, which means that the push won’t have any sound 

iOS

Under the "IOS OPTIONS" you will notice that toggle is in an off position, which means you will receive a non-sounded push by default if this option is not changed. 

If you would like to send push with sound, please follow these steps. 

1. Place the toggle in an on position
2. Type any character e.g "1" in the empty field right below and the system will send a push with sound. The value does not matter.

B. Custom Sound Push

Configure the Audience and Content screens, and proceed to the "Delivery" screen:

Android

1. Toggle on the "Custom keys" option, and select the platform "Android" from the drop-down menu
2. Enter ‘custom sound’ as the Key.
3. For a custom sound, please enter the name of the file you uploaded to ZAPP and do not include the extension when inserting in the "Value" field. 
   Example: sound_1 and not sound_1.wav

FYI:

• When uploading new custom sounds in ZAPP, this change requires generating a new build.
• If no custom sound or non-sounded push is needed, the custom key toggle should remain in an off position.

iOS

Under the "IOS OPTIONS" you will notice that toggle is in an off position, which means you will receive a non-sounded push by default if this option is not changed. 

If you would like to send push with a custom sound, please follow these steps. 

1. Place the toggle in an on position
2. For a custom sound, please enter the name of the file you uploaded to ZAPP and include the extension when inserting in the field right below. 
   Example: sound_1.mp3 not sound_1

FYI:

• When uploading new custom sounds in ZAPP, this change requires generating a new build.