whatsapp cloud api

WhatsApp-Cloud-API

whatsapp-cloud-api ist eine Node.js-Bibliothek zum Erstellen von Bots und zum Senden/Empfangen von Nachrichten mithilfe der Whatsapp Cloud API.

Enthält integrierte Typescript-Deklarationen.

---

Status

Dieses Projekt ist jetzt archiviert . Bitte lesen Sie hier mehr.

---

Installieren

Mit npm:

npm i whatsapp-cloud-api

Verwendung von Garn:

yarn add whatsapp-cloud-api

Verwendung

 import { createBot } from 'whatsapp-cloud-api' ;
// or if using require:
// const { createBot } = require('whatsapp-cloud-api');

( async ( ) => {
  try {
    // replace the values below
    const from = 'YOUR_WHATSAPP_PHONE_NUMBER_ID' ;
    const token = 'YOUR_TEMPORARY_OR_PERMANENT_ACCESS_TOKEN' ;
    const to = 'PHONE_NUMBER_OF_RECIPIENT' ;
    const webhookVerifyToken = 'YOUR_WEBHOOK_VERIFICATION_TOKEN' ;

    // Create a bot that can send messages
    const bot = createBot ( from , token ) ;

    // Send text message
    const result = await bot . sendText ( to , 'Hello world' ) ;

    // Start express server to listen for incoming messages
    // NOTE: See below under `Documentation/Tutorial` to learn how
    // you can verify the webhook URL and make the server publicly available
    await bot . startExpressServer ( {
      webhookVerifyToken ,
    } ) ;

    // Listen to ALL incoming messages
    // NOTE: remember to always run: await bot.startExpressServer() first
    bot . on ( 'message' , async ( msg ) => {
      console . log ( msg ) ;

      if ( msg . type === 'text' ) {
        await bot . sendText ( msg . from , 'Received your text message!' ) ;
      } else if ( msg . type === 'image' ) {
        await bot . sendText ( msg . from , 'Received your image!' ) ;
      }
    } ) ;
  } catch ( err ) {
    console . log ( err ) ;
  }
} ) ( ) ; 

Dokumentation

• API-Referenz.
• Tutorial für eine Schritt-für-Schritt-Anleitung zur Einrichtung.

Beispiele

Senden anderer Nachrichtentypen (weitere Informationen finden Sie in der API-Referenz):

 // Send image
const result = await bot . sendImage ( to , 'https://picsum.photos/200/300' , {
  caption : 'Random jpg' ,
} ) ;

// Send location
const result = await bot . sendLocation ( to , 40.7128 , - 74.0060 , {
  name : 'New York' ,
} ) ;

// Send template
const result = await bot . sendTemplate ( to , 'hello_world' , 'en_us' ) ;

Maßgeschneiderter Express-Server (mehr dazu weiter unten):

 import cors from 'cors' ;

// Create bot...
const bot = createBot ( ... ) ;

// Customize server
await bot . startExpressServer ( {
  webhookVerifyToken : 'my-verification-token' ,
  port : 3000 ,
  webhookPath : `/custom/webhook` ,
  useMiddleware : ( app ) => {
    app . use ( cors ( ) ) ,
  } ,
} ) ;

Andere Nachrichtentypen abhören (weitere Informationen finden Sie in der API-Referenz):

 const bot = createBot ( ... ) ;

await bot . startExpressServer ( { webhookVerifyToken } ) ;

// Listen to incoming text messages ONLY
bot . on ( 'text' , async ( msg ) => {
  console . log ( msg ) ;
  await bot . sendText ( msg . from , 'Received your text!' ) ;
} ) ;

// Listen to incoming image messages ONLY
bot . on ( 'image' , async ( msg ) => {
  console . log ( msg ) ;
  await bot . sendText ( msg . from , 'Received your image!' ) ;
} ) ; 

Notizen

1. Überprüfen Sie Ihre Webhook-URL

Standardmäßig lautet der Endpunkt für WhatsApp-bezogene Anfragen: /webhook/whatsapp . Das bedeutet, dass Ihre URL lokal lautet: http://localhost/webhook/whatsapp .

Sie können einen Reverse-Proxy verwenden, um den Server öffentlich verfügbar zu machen. Ein Beispiel hierfür ist Ngrok.

Weitere Informationen finden Sie im Tutorial.

2. Umgang mit eingehenden Nachrichten

Die obige Implementierung erstellt für Sie einen Express-Server, über den eingehende Nachrichten abgehört werden. Möglicherweise gibt es Pläne, in Zukunft andere Servertypen zu unterstützen (PRs sind willkommen! :)).

Sie können den Port wie folgt ändern:

 await bot . startExpressServer ( {
  port : 3000 ,
} ) ;

Standardmäßig werden alle Anfragen vom Endpunkt POST|GET /webhook/whatsapp verarbeitet. Sie können dies wie folgt ändern:

 await bot . startExpressServer ( {
  webhookPath : `/custom/webhook` ,
} ) ;

Hinweis: Denken Sie an das führende / ; dh nicht custom/whatsapp verwenden; Verwenden Sie stattdessen /custom/whatsapp .

Wenn Sie in Ihrer Anwendung bereits einen Express-Server ausführen, können Sie die Erstellung eines neuen Servers vermeiden, indem Sie ihn wie folgt verwenden:

 // your code...
import express from 'express' ;
const app = express ( ) ;

...

// use the `app` variable below:
await bot . startExpressServer ( {
  app ,
} ) ;

So fügen Sie Middleware hinzu:

 import cors from 'cors' ;

await bot . startExpressServer ( {
  useMiddleware : ( app ) => {
    app . use ( cors ( ) ) ,
  } ,
} ) ;

Vollständig angepasstes Setup:

 import cors from 'cors' ;

await bot . startExpressServer ( {
  webhookVerifyToken : 'my-verification-token' ,
  port : 3000 ,
  webhookPath : `/custom/webhook` ,
  useMiddleware : ( app ) => {
    app . use ( cors ( ) ) ,
  } ,
} ) ;

3. on() Listener

Diese Bibliothek verwendet einen einzelnen Prozess-Pubsub, was bedeutet, dass sie nicht gut funktioniert, wenn Sie sie auf Clustern mit mehreren Instanzen bereitstellen, z. B. verteilten Kubernetes-Clustern. In Zukunft gibt es möglicherweise Pläne, eine Pubsub-Referenz zu exportieren/zu unterstützen, die in einem externen Speicher, z. B. Redis, gespeichert werden kann (PRs sind willkommen! :)).

Entwicklung

 # install npm modules
npm i

# eslint
npm run lint

# typescript check
npm run ts-check

# test
# # Read 'Local Testing' below before running this
npm t

# build
npm run build

Lokale Tests

Erstellen Sie eine .env-Datei im Stammverzeichnis Ihres Projekts:

FROM_PHONE_NUMBER_ID=""
ACCESS_TOKEN=""
VERSION=""
TO=""
WEBHOOK_VERIFY_TOKEN=""
WEBHOOK_PATH=""

Namensnennung

Bibliotheks-API, inspiriert von Node-Telegram-Bot-API.

Pull-Anfragen

Alle PRs sind offen.