Notifications RingCentral

Aperçu

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

Configuration du Compte

1. Inscrivez-vous sur https://ringcentral.com.
2. Connectez-vous a la Console Developpeur RingCentral.
3. Cliquez sur Create App et choisissez REST API App -> Server/Bot (No UI).
4. Sous Permissions, activez SMS et MMS (MMS est requis pour la prise en charge des pieces jointes).
5. Dans l’onglet Credentials, copiez le Client ID et le Client Secret.

Deux modes d’authentification sont supportes :

Mode BASIC (utilisateur + mot de passe)

Utilisez le mot de passe du compte utilisateur RingCentral associe a votre numero source. C’est l’option la plus simple lorsque vous ne souhaitez pas gerer des tokens JWT.

Mode JWT

Generez un token JWT dans le portail developpeur et utilisez-le a la place du mot de passe. Les tokens JWT sont plus longs (> 60 caracteres) et Apprise detecte automatiquement ce mode si aucun parametre ?mode= explicite n’est fourni.

Pieces Jointes

Lorsqu’une piece jointe est incluse dans une notification, Apprise bascule automatiquement vers le point de terminaison MMS. Aucune configuration supplementaire n’est necessaire — SMS est utilise pour les messages simples et MMS est utilise lorsque des fichiers sont joints.

Syntaxe

La syntaxe valide est la suivante :

• ringc://{NumeroSource}:{MotDePasse}@{ClientID}/{ClientSecret}
• ringc://{NumeroSource}:{MotDePasse}@{ClientID}/{ClientSecret}/{NumeroDestinataire}
• ringc://{NumeroSource}:{MotDePasse}@{ClientID}/{ClientSecret}/{Dest1}/{Dest2}/{DestN}
• ringc://{NumeroSource}:{TokenJWT}@{ClientID}/{ClientSecret}
• ringc://{NumeroSource}:{TokenJWT}@{ClientID}/{ClientSecret}/{NumeroDestinataire}

Vous pouvez egalement fournir les identifiants sous forme de parametres de requete (utile dans les fichiers de configuration YAML) :

• ringc://_?token={TokenOuMotDePasse}&secret={ClientSecret}&from={NumeroSource}
• ringc://_?token={TokenOuMotDePasse}&secret={ClientSecret}&from={NumeroSource}&to={NumeroDestinataire}

Si aucun numero destinataire n’est fourni, la notification est envoyee au numero source lui-meme (utile pour les tests).

Detail des Parametres

Variable	Obligatoire	Description
NumeroSource	*Oui	Le numero de telephone RingCentral utilise comme expediteur. Doit etre associe a votre compte.
MotDePasse	*Oui	Le mot de passe utilisateur RingCentral (mode BASIC) ou le token JWT (mode JWT).
ClientID	*Oui	L’identifiant client provenant de l’onglet credentials du portail developpeur.
ClientSecret	*Oui	Le secret client provenant de l’onglet credentials du portail developpeur.
NumeroDestinataire	Non	Un ou plusieurs numeros de telephone destinataires. Si omis, le numero source est utilise.
to	Non	Alias pour le(s) numero(s) destinataire(s) ; accepte des valeurs separees par des virgules.
from	Non	Alias pour le numero source ; utile sous forme de parametre de requete.
source	Non	Alias de from.
token	Non	Alias du mot de passe ou du token JWT sous forme de parametre de requete.
secret	Non	Alias du Client Secret sous forme de parametre de requete.
mode	Non	Forcer le mode d’authentification : basic ou jwt. Detecte automatiquement si omis.
env	Non	Environnement API : prod (par defaut) ou sandbox (devtest RingCentral).

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.
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é. L’appel global notify() retourne quand même True 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

Envoyer un SMS en mode BASIC :

# NumeroSource : +15551230000
# MotDePasse : MonMotDePasse
# ClientID : AbCdEf123
# ClientSecret : secret123
# NumeroDestinataire : +15559998888
apprise -vv -t "Titre de Test" -b "Corps du Message" \
    "ringc://15551230000:MonMotDePasse@AbCdEf123/secret123/15559998888"

Envoyer un SMS JWT a plusieurs destinataires :

apprise -vv -t "Titre de Test" -b "Corps du Message" \
    "ringc://15551230000:eyJhbGciOiJSUzI1NiJ9...@AbCdEf123/secret123/15559998881/15559998882"

Envoyer un MMS avec une piece jointe (MMS est selectionne automatiquement) :

apprise -vv -t "Titre de Test" -b "Corps du Message" \
    --attach /chemin/vers/image.jpg \
    "ringc://15551230000:MonMotDePasse@AbCdEf123/secret123/15559998888"

Envoyer via des parametres de requete (format adapte au YAML) :

apprise -vv -t "Titre de Test" -b "Corps du Message" \
    "ringc://_?token=MonMotDePasse&secret=secret123&from=15551230000&to=15559998888"