Un framework API officiel de Whatsapp indépendant du serveur TypeScript.
WhatsApp-api-js v4
Liste des matières
Installation
Exemples et tutoriels
Espèces
Journal des modifications
Documentation
Contributeurs
Cotisations
Modifications radicales
Versions bêta
Avant tout, vous aurez besoin d’une application Meta Bussiness avec l’API WhatsApp activée. Vous pouvez créer votre première application en suivant ces étapes.
Obtenez le jeton API, qu'il soit temporel ou permanent.
Obtenez le secret de votre application à partir du tableau de bord dans Paramètres de l'application > De base > Secret de l'application.
Des informations plus détaillées sur la façon de définir et de récupérer ces valeurs sont disponibles dans la documentation du module.
Vous pouvez maintenant installer le module en utilisant npm :
npm installer WhatsApp-api-js
Ce qui vous permettra d'écrire du code comme celui-ci :
import { WhatsAppAPI } depuis "whatsapp-api-js"; import { Document, Image, Text } depuis "whatsapp-api-js/messages";// Rappel aimable de ne pas coder en dur votre token et secretconst TOKEN = "YOUR_TOKEN";const APP_SECRET = "VOTRE_SECRET";/** @type WhatsAppAPI<numéro> */const Whatsapp = new WhatsAppAPI({ jeton : TOKEN, appSecret : APP_SECRET });// En supposant que post soit appelé lors d'une requête POST adressée à votre fonction serverasync post(e) {// Trop long ? Lisez https://whatsappapijs.web.app/modules/middleware.htmlreturn wait Whatsapp.post(JSON.parse(e.data),e.data,e.headers["x-hub-signature-256"]); }Whatsapp.on.message = async ({phoneID, from, message, nom, réponse }) => {console.log(`User ${name} (${from}) envoyé au bot ${phoneID} ${JSON.stringify( message )}`);let réponse;if (message.type === "text") {response = wait réponse(new Text(`*${name}* a déclaré :nn ${message.text.body}`),true);}if (message.type === "image") {response = waitanswer(new Image(message.image.id, true, `Belle photo, ${name}`));}if (message.type === "document") {response = waitanswer(new Document(message.document.id, true, undefined, "Notre document"));}console. log(response ??"Il existe d'autres types de messages, tels que les contacts, les " +"emplacements, les modèles, les interactions, les réactions et " +"tous les autres types de médias.");Whatsapp.markAsRead(phoneID, message.id) ;retour 200;};Whatsapp.on.sent = ({ phoneID, to, message }) => {console.log(`Bot ${phoneID} envoyé à l'utilisateur ${to} ${message}`);};
Pour recevoir les mises à jour des messages, vous devez configurer le webhook sur votre application Meta. De retour dans le tableau de bord, cliquez sur WhatsApp > Paramètres, notez l'URL de votre webhook et assurez-vous de vous abonner à l'événement de messages. Il vous sera également demandé un jeton de vérification. Cela peut être n’importe quelle chaîne de votre choix.
Le package comprend également un gestionnaire GET pour l'authentification du webhook :
importer { WhatsAppAPI } depuis "whatsapp-api-js" ; const TOKEN = " VOTRE_TOKEN " ; const APP_SECRET = " VOTRE_SECRET " ; const VERIFY_TOKEN = " VOTRE_VERIFY_TOKEN " ; const Whatsapp = new WhatsAppAPI ({token : TOKEN, appSecret : APP_SECRET, webhookVerifyToken : VERIFY_TOKEN});// En supposant que get soit appelé lors d'une requête GET adressée à votre fonction serveur get(e) {// Trop long !? Lire https://whatsappapijs.web.app/modules/middleware.htmlreturn Whatsapp.get(e.query);}
Et c'est tout ! Vous disposez désormais d’un Bot Whatsapp fonctionnel connecté à votre serveur. Pour plus d'informations sur le processus de configuration pour des environnements d'exécution et des frameworks spécifiques, consultez le fichier Environments.md.
Il existe quelques exemples expliquant comment créer chaque type de message et comment utiliser les méthodes de base de la bibliothèque.
Découvrez-les dans le dossier des exemples.
La bibliothèque est entièrement typée. La plupart des types sont disponibles en important des fichiers /types
ou /emitters
:
importer { GetParams, PostData } depuis "whatsapp-api-js/types" ; importer { OnMessage, OnSent, OnStatus } depuis "whatsapp-api-js/emitters" ;
Pour savoir ce qui a changé entre les mises à jour, consultez les versions sur Github.
La documentation de la dernière version est disponible sur whatsappapijs.web.app et les versions précédentes sont archivées sur secreto31126.github.io/whatsapp-api-js.
Clé émoji
Diego Carrillo | Omar | Rahul Lanjewar | Félix Arjuna |
Si vous avez du temps libre et que vous souhaitez vraiment améliorer la bibliothèque ou corriger des bugs stupides, n'hésitez pas à lire le fichier CONTRIBUTING.md.
Vous pouvez obtenir une liste complète des modifications avec rupture dans le fichier BREAKING.md.
Installez la dernière version bêta avec npm install whatsapp-api-js@beta
. Comme toute version bêta, elle a 110 % de chances de tomber en panne. J'utilise également cette balise pour tester les versions de npm. Utilisez-le à vos propres risques.