Notifications Octopush

Aperçu

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

Configuration du Compte

Pour utiliser Octopush, vous aurez besoin de votre API Login et de votre API Key. L’API login correspond a l’adresse e-mail associee a votre compte Octopush.

Vous pouvez aussi definir facultativement une valeur Sender. Octopush accepte un expediteur alphanumerique de 3 a 11 caracteres pour les routes qui le prennent en charge.

Syntaxe

La syntaxe valide est la suivante :

• octopush://{api_login}/{api_key}/{phone_no}
• octopush://{api_login}/{api_key}/{phone_no1}/{phone_no2}/{phone_noN}
• octopush://{sender}:{api_login}/{api_key}/{phone_no}
• octopush://{sender}:{api_login}/{api_key}/{phone_no1}/{phone_no2}?batch=yes

Vous pouvez aussi transmettre les valeurs sous forme de parametres de requete :

• octopush://_?login={api_login}&key={api_key}&to={phone_no}
• octopush://_?login={api_login}&key={api_key}&sender={sender}&to={phone_no}&type=sms_low_cost

Détail des Paramètres

Variable	Obligatoire	Description
api_login	Oui	API Login associe a votre compte Octopush. Il doit s’agir d’une adresse e-mail valide.
api_key	Oui	API Key associee a votre compte Octopush.
sender	Non	Identifiant expediteur facultatif a afficher si votre route Octopush le prend en charge.
phone_no	Oui	Au moins un numero de telephone doit etre fourni pour utiliser ce plugin. Ce champ accepte aussi les parentheses, espaces et tirets pour une meilleure lisibilite.
batch	Non	Octopush prend en charge un mode lot. Si vous indiquez plusieurs numeros, vous pouvez les envoyer en une seule fois dans l’URL au lieu de l’approche normale d’Apprise, qui les envoie un par un. Par defaut, ce mode est desactive.
replies	Non	Lorsque cette valeur est definie sur yes, Apprise demande la gestion des reponses via Octopush. Par defaut, cette option vaut no.
purpose	Non	Objet du message. Les valeurs prises en charge sont alert et wholesale. Par defaut, cette valeur est alert.
type	Non	Type de message. Les valeurs prises en charge sont sms_premium et sms_low_cost. Par defaut, cette valeur est sms_premium.

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

Envoyer une notification Octopush sous forme de SMS :

# Supposons que notre {api_login} soit user@example.com
# Supposons que notre {api_key} soit my-api-key
# Supposons que notre {phone_no} soit aux Etats-Unis, donc avec l'indicatif pays +1,
# et corresponde au numero 800-555-1223
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "octopush://user@example.com/my-api-key/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" \
   "octopush://user@example.com/my-api-key/1-(800) 555-1223"

Envoyer via un identifiant expediteur et la route low-cost :

# Supposons que notre {api_login} soit user@example.com
# Supposons que notre {api_key} soit my-api-key
# Supposons que notre {sender} soit MyCompany
# Supposons que notre {phone_no} soit +33-6-00-01-02-03
apprise -vv -b "Your order has shipped" \
   "octopush://MyCompany:user@example.com/my-api-key/33600010203?type=sms_low_cost"

Envoyer un message a plusieurs cibles avec le mode lot d’Octopush :

# Supposons que notre {api_login} soit user@example.com
# Supposons que notre {api_key} soit my-api-key
# Supposons que notre {sender} soit MyCompany
# Supposons que notre {phone_no1} soit +33-6-00-01-02-03
# Supposons que notre {phone_no2} soit +33-6-00-01-02-04
apprise -vv -b "System maintenance starts in 15 minutes" \
   "octopush://MyCompany:user@example.com/my-api-key/33600010203/33600010204?batch=yes&purpose=alert"