Notifications Evolution API

Aperçu

• Source: https://github.com/EvolutionAPI/evolution-api
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 65536
• Créer votre URL Apprise

Configuration du Compte

Evolution API est une passerelle WhatsApp auto-hébergée qui expose une API REST au-dessus du protocole WhatsApp Web.

1. Déployer Evolution API

La méthode recommandée passe par Docker :

docker run -d \
  -p 8080:8080 \
  --name evolution-api \
  atendai/evolution-api:latest

Les instructions complètes de déploiement ainsi que des exemples docker-compose sont disponibles dans le dépôt officiel.

2. Créer et Connecter une Instance

1. Ouvrez le tableau de bord Evolution API (par exemple http://yourserver:8080).
2. Créez une nouvelle instance et donnez-lui un nom (par exemple MyInstance).
3. Scannez le QR code affiché dans le tableau de bord avec l’application mobile WhatsApp pour lier votre compte.
4. Une fois connecté, l’état de l’instance passe à open.

3. Récupérer Votre Clé API

La clé API est affichée dans la page de paramètres de l’instance, dans le tableau de bord. Copiez-la : vous l’utiliserez comme {apikey} dans l’URL Apprise.

Format des Numéros de Téléphone

Tous les numéros de téléphone doivent être fournis au format international sans le + initial, par exemple :

Pays	Numéro	Format pour Apprise
Brésil	+55 11 99999-9999	5511999999999
USA	+1 (555) 123-4567	15551234567
Allemagne	+49 30 12345678	493012345678

Syntaxe

HTTP simple (port 80 par défaut) :

• evolution://{apikey}@{host}/{instance}/{phoneNo}
• evolution://{apikey}@{host}:{port}/{instance}/{phoneNo}

HTTPS (port 443 par défaut) :

• evolutions://{apikey}@{host}/{instance}/{phoneNo}
• evolutions://{apikey}@{host}:{port}/{instance}/{phoneNo}

Destinataires multiples :

• evolution://{apikey}@{host}/{instance}/{phoneNo1}/{phoneNo2}/{phoneNoN}

Destinataires supplémentaires via un paramètre de requête :

• evolution://{apikey}@{host}/{instance}/{phoneNo}?to={phoneNo2}

Détail des Paramètres

Variable	Requis	Description
apikey	Oui	La clé API affichée dans les paramètres de votre instance Evolution API.
host	Oui	Le nom d’hôte ou l’adresse IP sur lequel Evolution API s’exécute.
port	Non	Le port écouté par Evolution API. Par défaut : 80 pour evolution:// et 443 pour evolutions://.
instance	Oui	Le nom de l’instance WhatsApp créée dans le tableau de bord Evolution API.
phoneNo	Oui	Un ou plusieurs numéros de destination au format international sans le + initial. Séparez plusieurs numéros avec une barre oblique / dans l’URL.
to	Non	Alias de phoneNo. Peut être utilisé comme paramètre de requête (?to=) pour préciser des destinataires supplémentaires.

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 message WhatsApp via HTTP :

# Assuming our {apikey} is abc123secret
# Assuming our Evolution API is running at myserver.local:8080
# Assuming our instance name is MyInstance
# Assuming the destination number is +55 11 99999-9999
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "evolution://abc123secret@myserver.local:8080/MyInstance/5511999999999"

Envoyer via HTTPS (Evolution API derrière un reverse proxy avec TLS) :

# Assuming our {apikey} is abc123secret
# Assuming our Evolution API is reachable at api.example.com (HTTPS)
# Assuming our instance name is MyInstance
apprise -vv -t "Alert" -b "Le serveur est indisponible !" \
   "evolutions://abc123secret@api.example.com/MyInstance/5511999999999"

Envoyer à plusieurs destinataires :

# Notify two numbers in a single command
apprise -vv -t "Broadcast" -b "Maintenance window starts in 30 minutes" \
   "evolution://abc123secret@myserver.local:8080/MyInstance/5511999999999/5521888888888"