Aller au contenu

Notifications Sinch

Aperçu

Pour utiliser Sinch, vous devez obtenir votre Service Plan ID et votre API Token. Ces deux éléments sont accessibles via le tableau de bord Sinch ou depuis la section API.

Vous devez avoir un numéro défini comme numéro actif (depuis votre tableau de bord ici). Ce numéro deviendra votre {FromPhoneNo} lors de l’identification des détails ci-dessous.

La syntaxe valide est la suivante :

  • sinch://{ServicePlanID}:{ApiToken}@{FromPhoneNo}/{PhoneNo}
  • sinch://{ServicePlanID}:{ApiToken}@{FromPhoneNo}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}

Si aucun ToPhoneNo n’est spécifié, le FromPhoneNo sera utilisé comme destinataire ; la syntaxe suivante est donc valide :

  • sinch://{ServicePlanID}:{ApiToken}@{FromPhoneNo}/

Les codes courts (Short Codes) sont également pris en charge, mais nécessitent au moins un numéro de téléphone cible (Target PhoneNo) :

  • sinch://{ServicePlanID}:{ApiToken}@{ShortCode}/{PhoneNo}
  • sinch://{ServicePlanID}:{ApiToken}@{ShortCode}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}
VariableRequisDescription
ServicePlanIDOuiL’Account SID associé à votre compte Sinch. Il est disponible depuis le tableau de bord Sinch.
ApiTokenOuiL’Auth Token associé à votre compte Sinch. Il est disponible depuis le tableau de bord Sinch.
FromPhoneNo*NonLe numéro de téléphone actif associé à votre compte Sinch depuis lequel vous souhaitez envoyer le SMS. Ce doit être un numéro enregistré auprès de Sinch. En alternative au FromPhoneNo, vous pouvez également fournir un ShortCode. Le numéro de téléphone DOIT inclure le préfixe d’indicatif du pays. Ce champ est très flexible et prend en charge les parenthèses, les espaces et les tirets pour faciliter la lisibilité du numéro.
ShortCode*NonLe code court (ShortCode) associé à votre compte Sinch depuis lequel vous souhaitez envoyer le SMS. Ce doit être un numéro enregistré auprès de Sinch. En alternative au ShortCode, vous pouvez fournir un FromPhoneNo.
PhoneNo*NonUn numéro de téléphone DOIT inclure le préfixe d’indicatif du pays. Ce champ est très flexible et prend en charge les parenthèses, les espaces et les tirets pour faciliter la lisibilité du numéro.
Remarque : Si vous utilisez un ShortCode, au moins un PhoneNo DOIT être défini.
RegionNonPeut être soit us soit eu. Par défaut, la région est définie sur us.
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 Sinch par SMS :

Fenêtre de terminal
# Assuming our {ServicePlanID} is AC735c307c62944b5a
# Assuming our {ApiToken} is e29dfbcebf390dee9
# Assuming our {FromPhoneNo} is +1-900-555-9999
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
# - identifies as 800-555-1223
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
sinch://AC735c307c62944b5a:e29dfbcebf390dee9@19005559999/18005551223
# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
sinch://AC735c307c62944b5a:e29dfbcebf390dee9@1-(900) 555-9999/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