Notifications OneSignal

Aperçu

• Source: https://onesignal.com
• Prise en charge des images: Oui
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Configuration du Compte

1. Visitez https://onesignal.com pour créer votre compte.
2. Pour obtenir votre {appid} et votre {apikey}, cliquez sur Keys and IDs.
   

Syntaxe

La syntaxe valide est la suivante :

• onesignal://{app_id}@{apikey}/#{include_segment}
• onesignal://{app_id}@{apikey}/#{include_segment1}/#{include_segment2}/#{include_segmentN}
• onesignal://{app_id}@{apikey}/{player_id}/
• onesignal://{app_id}@{apikey}/{player_id1}/{player_id2}/{player_idN}
• onesignal://{app_id}@{apikey}/@{user_id}/
• onesignal://{app_id}@{apikey}/@{user_id1}/@{user_id2}/@{user_idN}
• onesignal://{app_id}@{apikey}/{email}/
• onesignal://{app_id}@{apikey}/{email1}/{email2}/{emailN}

Vous pouvez également combiner les cibles :

• onesignal://{app_id}@{apikey}/{email}/@{user_id}/#{include_segment}/{player_id}

Si vous avez défini un modèle avec OneSignal, vous pouvez également l’utiliser :

• onesignal://{template_id}:{app_id}@{apikey}/#{include_segment}
• onesignal://{template_id}:{app_id}@{apikey}/#{include_segment1}/#{include_segment2}/#{include_segmentN}
• onesignal://{template_id}:{app_id}@{apikey}/{player_id}/
• onesignal://{template_id}:{app_id}@{apikey}/{player_id1}/{player_id2}/{player_idN}
• onesignal://{template_id}:{app_id}@{apikey}/@{user_id}/
• onesignal://{template_id}:{app_id}@{apikey}/@{user_id1}/@{user_id2}/@{user_idN}
• onesignal://{template_id}:{app_id}@{apikey}/{email}/
• onesignal://{template_id}:{app_id}@{apikey}/{email1}/{email2}/{emailN}

Détail des Paramètres

Variable	Requis	Description
app_id	Oui	L’identifiant d’application associé à votre compte OneSignal.
apikey	Oui	La clé API associée à votre compte OneSignal.
template_id	Non	L’identifiant UUID du modèle à utiliser.
player_id	Non	Un identifiant Player à notifier.
user_id	Non	Un identifiant User à notifier. Remarque : ces valeurs doivent être préfixées par le symbole @ sinon elles seront interprétées comme un Player ID.
include_segment	Non	Un segment d’inclusion. Remarque : ces valeurs doivent être préfixées par le symbole # sinon elles seront interprétées comme un Player ID.
email	Non	Une adresse e-mail à notifier.
subtitle	Non	Le sous-titre de votre notification push. Apparaît uniquement sur les appareils iOS.
language	Non	Le code langue à 2 caractères pour l’envoi du message. Par défaut, cette valeur est en si non spécifiée.
image	Non	Permet d’inclure l’icône/image associée au message. Par défaut, cette valeur est yes.
batch	Non	Définissez à Oui si vous souhaitez que toutes les cibles identifiées soient notifiées par lots (plutôt qu’individuellement). Par défaut : Non.

Paramètres Globaux

Variable	Description
overflow	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.

Exemples

Envoyer une notification OneSignal à tous les appareils associés à un projet :

# Assume:
#  - our {app_id} is abc123
#  - our {apikey} is a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
#  - our {player_id} is 3456-2345-a3ef
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   onesignal://abc123@a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty/3456-2345-a3ef

# Override the subtitle (Mac users only) by doing the following:
# You must use URL encoded strings, below the spaces are swapped with %20
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   onesignal://abc123@a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty/3456-2345-a3ef?subtitle=A%20Different%20Subtitle

Données Personnalisées (Modèles)

L’utilisation du : dans l’URL Apprise permet de modifier et d’enrichir le payload de votre publication onesignal.

# As an example:
apprise -vv -b "Corps du Message de Test" \
   "onesignal://credentials/?:key1=value1"

L’exemple ci-dessus ajouterait ces assignations dans le payload sous custom_data :

{
   ... previous payload elements... and then:
   "custom_data": {"key1": "value1"}
}

Données

L’utilisation du + dans l’URL Apprise permet de modifier et d’enrichir le payload de votre publication onesignal.

# As an example:
apprise -vv -b "Corps du Message de Test" \
   "onesignal://credentials/?+key1=value1"

L’exemple ci-dessus ajouterait ces assignations dans le payload sous data :

{
   ... previous payload elements... and then:
   "data": {"key1": "value1"}
}