Notifications Mobile Message
Configuration du compte
Section intitulée « Configuration du compte »- Créez un compte sur mobilemessage.com.au.
- Connectez-vous et ouvrez Settings -> API. Créez une clé API, puis copiez son nom d’utilisateur API et son mot de passe API.
- Ouvrez Settings -> Sender IDs et choisissez un identifiant d’expéditeur approuvé. Il peut s’agir d’un numéro dédié, d’un mobile vérifié ou d’un nom enregistré auprès de l’ACMA, comme
ALERTS.
Les syntaxes valides sont les suivantes :
mobilemessage://{apiUser}:{apiPass}@{senderID}/{toPhoneNo}mobilemessage://{apiUser}:{apiPass}@{senderID}/{toPhoneNo1}/{toPhoneNo2}/{toPhoneNoN}
Vous pouvez raccourcir mobilemessage:// en mobilemsg://.
Utilisez le format local (0412345678) ou international (61412345678). Apprise convertit les numéros au format international.
Détail des paramètres
Section intitulée « Détail des paramètres »| Variable | Obligatoire | Description |
|---|---|---|
| apiUser | *Oui | Le nom d’utilisateur API créé dans Settings -> API. |
| apiPass | *Oui | Le mot de passe API fourni avec votre nom d’utilisateur API. |
| senderID | *Oui | L’identifiant d’expéditeur utilisé pour la livraison. Il doit déjà être enregistré sur votre compte. |
| toPhoneNo | *Oui | Un ou plusieurs numéros de mobile australiens. Séparez-les par un / dans le chemin de l’URL. |
| to | Non | Alias des numéros de destination. Accepte une liste séparée par des virgules et peut se combiner aux numéros présents dans le chemin de l’URL. |
| from | Non | Alias de senderID. Pratique dans un fichier YAML pour placer l’identifiant d’expéditeur sur sa propre ligne. |
| batch | Non | Regroupe jusqu’à 10 000 destinataires par requête plutôt que d’envoyer une requête par destinataire. Vaut yes par défaut. |
| unicode | Non | Conserve les emojis et les caractères accentués au lieu de les supprimer. Cette option réduit la taille de chaque partie et peut utiliser plus de crédits. Vaut no par défaut. |
| max_parts | Non | Nombre maximal de parties par notification, entre 1 et 99. Réduisez-le pour limiter le coût d’une alerte. Vaut 10 par défaut. |
| ref | Non | Référence ajoutée à chaque message et renvoyée par le service. Elle facilite la recherche dans l’historique Mobile Message. |
Paramètres Globaux
Section intitulée « Paramètres Globaux »| Variable | Description |
|---|---|
| overflow | Gère les messages qui dépassent la limite documentée d’un service. La valeur par défaut est upstream.👉 upstream : envoie un seul message sans le découper ni le tronquer selon cette limite.👉 truncate : conserve la partie qui tient dans la limite et supprime le reste.👉 split : privilégie une coupure lisible, utilise une coupure stricte si nécessaire, puis envoie toutes les parties dans l’ordre.Le découpage d’un contenu non déclaré ou structuré reste une solution au mieux. Utilisez upstream si le corps doit rester intact. |
| 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. |
| redirect | Par défaut, Apprise suit les redirections HTTP (réponses 3xx) émises par le serveur distant, conformément au comportement de la bibliothèque requests sous-jacente. Si vous souhaitez empêcher la transmission des en-têtes personnalisés et des identifiants vers des destinations différentes de l’URL d’origine, définissez cette option sur no. Par défaut, elle 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. |
| retry | Nombre de tentatives de remise supplémentaires après le premier échec, avant d’abandonner. Accepte un entier compris entre 0 et 10. La valeur par défaut est 0 (aucune nouvelle tentative — une seule tentative est effectuée). Lorsqu’il est combiné avec wait, Apprise marque une pause du nombre de secondes spécifié entre chaque tentative. |
| wait | Nombre de secondes à attendre entre les nouvelles tentatives. Accepte une valeur décimale comprise entre 0.0 et 20.0 ; les entiers sont automatiquement convertis en virgule flottante. La valeur par défaut est 0.5. Ce paramètre n’est utile que si retry est supérieur à zéro — un service avec retry=0 effectue exactement une tentative, quelle que soit la valeur de wait. |
| optional | Lorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. Le résultat global de notify() est quand même considéré comme réussi même si ce point de terminaison était injoignable, à condition que tous les services requis (non optionnels) du même lot aient réussi. Ce drapeau ne saute pas la remise ni ne contourne la logique de nouvelles tentatives — toutes les tentatives configurées sont effectuées avant que l’échec soit absorbé. Par défaut, il vaut no, ce qui signifie que chaque échec est propagé à l’appelant. |
Exemples
Section intitulée « Exemples »Envoyer une alerte vers un seul numéro :
# Supposons que notre nom d'utilisateur API soit apiuser01# Supposons que notre mot de passe API soit s3cr3tpassw0rd# Supposons que notre identifiant d'expéditeur soit ALERTSapprise -vv -t "Titre du message de test" -b "Corps du message de test" \ "mobilemessage://apiuser01:s3cr3tpassw0rd@ALERTS/0412345678"Envoyer à plusieurs destinataires dans une seule requête :
apprise -vv -b "La tâche de sauvegarde a échoué" \ "mobilemessage://apiuser01:s3cr3tpassw0rd@ALERTS/0412345678/0498765432"Envoyer depuis un numéro dédié plutôt que depuis un nom alphanumérique :
apprise -vv -b "Le serveur est hors service" \ "mobilemsg://apiuser01:s3cr3tpassw0rd@61400000000/0412345678"Limiter une alerte à une seule partie pour contrôler son coût :
apprise -vv -b "Utilisation du disque au-delà de 90 %" \ "mobilemessage://apiuser01:s3cr3tpassw0rd@ALERTS/0412345678?max_parts=1"Autoriser les emojis et les caractères accentués, puis ajouter votre propre référence :
apprise -vv -b "Sauvegarde terminée, serveur café inclus" \ "mobilemessage://apiuser01:s3cr3tpassw0rd@ALERTS/0412345678?unicode=yes&ref=nightly-backup"Utiliser des paramètres de requête pour séparer les valeurs dans un fichier YAML :
apprise -vv -b "Bonjour tout le monde" \ "mobilemessage://apiuser01:s3cr3tpassw0rd@?from=ALERTS&to=0412345678,0498765432" Questions ou commentaires ?
Documentation
Vous avez repéré une faute de frappe ou une erreur ?
Problèmes Techniques
Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :