Notifications Kavenegar
Configuration du compte
Section intitulée « Configuration du compte »Pour utiliser Kavenegar, commencez par creer un compte sur leur site web. Une fois cela fait, vous pourrez recuperer votre cle API depuis la section profil du compte.
La syntaxe valide est la suivante :
kavenegar://{apikey}/{to_phone_no}kavenegar://{from_phone_no}@{apikey}/{to_phone_no}kavenegar://{apikey}/{to_phone_no}/{to_phone_no2}/{to_phone_noN}/kavenegar://{from_phone_no}@{apikey}/{to_phone_no}/{to_phone_no2}/{to_phone_noN}/
Détail des Paramètres
Section intitulée « Détail des Paramètres »| Variable | Obligatoire | Description |
|---|---|---|
| ApiKey | Oui | API Key associee a votre compte Kavenegar. Elle est disponible dans la section profil du compte de leur site, apres connexion. |
| ToPhoneNo | Oui | Kavenegar ne prend pas en charge le signe + devant les indicatifs de pays. Vous devez donc remplacer ce prefixe par le bon nombre de zeros en tete du numero sortant pour que l’appel aboutisse. |
| FromPhoneNo | Non | Numero a utiliser comme identifiant de l’appelant. Cet argument est facultatif. |
Paramètres Globaux
Section intitulée « 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
Section intitulée « Exemples »Envoyer une notification Kavenegar sous forme de SMS :
# Supposons que notre {ApiKey} soit gank339l7jk3cjaE# Supposons que notre {PhoneNo}# - se trouve aux Etats-Unis, donc avec l'indicatif pays 001# - corresponde a 800-555-1223apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \ kavenegar://gank339l7jk3cjaE/0018005551223
# 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" \ kavenegar://gank339l7jk3cjaE/001 - (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