Aller au contenu

Notifications Short Message Peer-to-Peer (SMPP)

Aperçu

SMPP (Short Message Peer-to-Peer) est un protocole telecom utilise pour transmettre des SMS a un SMSC. Apprise s’integre a SMPP via la bibliotheque Python smpplib.

Fenêtre de terminal
pip install smpplib

Pour utiliser ce service, vous aurez besoin de :

  1. du nom d’hote, ou de l’adresse IP, et du port du serveur SMPP ;
  2. d’un nom d’utilisateur et d’un mot de passe SMPP valides, parfois appeles system_id et password ;
  3. d’une adresse expediteur, en general votre numero de telephone au format E.164, c’est-a-dire le numero From ;
  4. d’un ou plusieurs numeros de telephone destinataires.

Si vous n’administrez pas vous-meme un serveur SMPP, votre fournisseur SMS pourra generalement vous fournir ces informations.


La syntaxe valide est la suivante :

  • smpp://{user}:{password}@{host}/{from_phone}/{targets}
  • smpp://{user}:{password}@{host}:{port}/{from_phone}/{targets}

Variantes securisees :

  • smpps://{user}:{password}@{host}/{from_phone}/{targets}
  • smpps://{user}:{password}@{host}:{port}/{from_phone}/{targets}

Ou {targets} represente un ou plusieurs numeros de telephone separes par / :

  • .../{to_phone}
  • .../{to_phone1}/{to_phone2}/{to_phoneN}

Pour les fichiers de configuration et les environnements ou les chemins sont peu pratiques, vous pouvez aussi utiliser :

  • from= comme alias du numero expediteur
  • to= comme liste separee par des virgules des numeros destinataires

Exemple :

  • smpps://_?user=user&pass=password&host=smpp.example.ca&from=+15551234567&to=+15557654321,+15559876543

  • Les titres ne sont pas utilises pour les SMS. Si vous en fournissez un, Apprise l’integrera au corps du message lorsque c’est possible.
  • Les numeros de telephone devraient, si possible, etre fournis au format E.164 par exemple +15551234567.
  • smpp:// est considere comme un transport non securise. Preferez smpps:// lorsque votre fournisseur le prend en charge.

VariableObligatoireDescription
userOuiNom d’utilisateur SMPP (system_id).
passwordOuiMot de passe SMPP.
hostOuiNom d’hote du serveur SMPP.
portNonPort SMPP. La valeur par defaut est 2775 pour smpp:// et 3550 pour smpps://, sauf surcharge.
from_phoneOuiNumero de telephone expediteur, idealement au format E.164.
targetsOuiUn ou plusieurs numeros de telephone destinataires.
fromNonAlias en chaine de requete pour from_phone.
toNonAlias en chaine de requete pour fournir des destinataires supplementaires separes par des virgules.
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 un SMS a un destinataire unique :

Fenêtre de terminal
apprise -vv -b "Test message" \
smpp://user:password@smpp.example.ca/+15551234567/+15557654321

Envoyer a plusieurs destinataires :

Fenêtre de terminal
apprise -vv -b "Maintenance window starts at 22:00" \
smpp://user:password@smpp.example.ca/+15551234567/+15557654321/+15559876543

Utiliser smpps:// en mode securise sur un port personnalise :

Fenêtre de terminal
apprise -vv -b "Secure SMPP test" \
smpps://user:password@smpp.example.ca:3550/+15551234567/+15557654321

Utiliser des parametres de requete, pratique dans YAML et les variables d’environnement :

Fenêtre de terminal
apprise -vv -b "Query string example" \
"smpps://_?user=user&pass=password&host=smpp.example.ca&from=+15551234567&to=+15557654321,+15559876543"
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