Aller au contenu

Notifications Société Française du Radiotéléphone (SFR)

Aperçu

La syntaxe valide est la suivante :

  • sfr://{user}:{password}@{space_id}/{PhoneNo}
  • sfr://{user}:{password}@{space_id}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}
VariableObligatoireDescription
userOuiUtilisateur associe a votre compte SFR.
passwordOuiMot de passe associe a votre compte SFR.
space_idOuiSpace ID associe a votre compte SFR.
PhoneNo*NonNumero de telephone a notifier.
toOuiNumero de telephone qui recevra la notification ; il s’agit d’un alias de PhoneNo.
langNon, valeur par defautValeur requise par SFR lors de l’envoi d’un SMS. La valeur par defaut est fr_FR.
fromNonNom d’expediteur visible par les destinataires du SMS. Il DOIT avoir ete enregistre au prealable dans le compte SFR Business DMC.
timeoutNonDuree apres laquelle le SMS sera abandonne par SFR. La valeur par defaut est 2880 minutes.
voiceNonVoix utilisee lorsque le SMS est encode sous forme vocale. Ce parametre n’est pas exploite par Apprise, mais doit etre present pour des raisons de compatibilite API. Sa valeur par defaut est claire08s.
VariableDescription
overflowCe 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.
formatCe 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é.
verifyLes 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.
ctoSignifie 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.
rtoSignifie 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.
emojisActive 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.
tzIdentifie 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.

Envoyer une notification SFR :

Fenêtre de terminal
# Supposons que notre {user} soit foo
# Supposons que notre {password} soit bar
# Supposons que notre {space_id} soit 1234
# Supposons que notre {PhoneNo}
# - se trouve aux Etats-Unis, donc avec l'indicatif pays +1
# - corresponde a 800-555-1223
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
sfr://foo:bar@1234/18005551223
# la variante suivante aurait aussi fonctionne
# les espaces, parentheses et tirets sont acceptes dans ce champ :
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
sfr://foo:bar@1234//1-(800) 555-1223
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ? Signalez-la ou proposez une correction .

Problèmes Techniques

Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :

Conçu avec amour depuis le Canada