whatsapp cloud api

WhatsApp-облако-API

whatsapp-cloud-api — это библиотека Node.js для создания ботов и отправки/получения сообщений с использованием Whatsapp Cloud API.

Содержит встроенные объявления Typescript.

---

Статус

Этот проект сейчас находится в архиве . Пожалуйста, прочитайте больше здесь.

---

Установить

Использование НПМ:

npm i whatsapp-cloud-api

Использование пряжи:

yarn add whatsapp-cloud-api

Использование

 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 ) ;
  }
} ) ( ) ; 

Документация

• Справочник по API.
• Инструкция с пошаговыми инструкциями, как все настроить.

Примеры

Отправка других типов сообщений (подробнее читайте в справочнике API):

 // 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' ) ;

Индивидуальный экспресс-сервер (подробнее читайте ниже):

 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 ( ) ) ,
  } ,
} ) ;

Прослушивание других типов сообщений (подробнее читайте в справочнике по API):

 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!' ) ;
} ) ; 

Примечания

1. Проверка URL-адреса веб-перехватчика

По умолчанию конечной точкой для запросов, связанных с WhatsApp, будет: /webhook/whatsapp . Это означает, что локально ваш URL-адрес будет выглядеть так: http://localhost/webhook/whatsapp .

Вы можете использовать обратный прокси-сервер, чтобы сделать сервер общедоступным. Примером этого является ngrok.

Подробнее вы можете прочитать в Учебнике.

2. Обработка входящих сообщений

Приведенная выше реализация создает для вас экспресс-сервер, через который он прослушивает входящие сообщения. В будущем могут быть планы по поддержке других типов серверов (пиар приветствуются! :)).

Вы можете изменить порт следующим образом:

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

По умолчанию все запросы обрабатываются конечной точкой POST|GET /webhook/whatsapp . Вы можете изменить это, как показано ниже:

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

Примечание. Помните о начале / ; т. е. не используйте custom/whatsapp ; вместо этого используйте /custom/whatsapp .

Если вы уже используете экспресс-сервер в своем приложении, вы можете избежать создания нового, используя его, как показано ниже:

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

...

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

Чтобы добавить промежуточное ПО:

 import cors from 'cors' ;

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

Полная индивидуальная настройка:

 import cors from 'cors' ;

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

3. слушатель on()

Эта библиотека использует один процесс pubsub, а это означает, что она не будет работать должным образом, если вы развертываете кластеры с несколькими экземплярами, например распределенные кластеры Kubernetes. В будущем могут быть планы по экспорту/поддержке ссылки на pubsub, которая может храниться во внешнем хранилище, например, Redis (PR приветствуются! :)).

Разработка

 # 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

Локальное тестирование

Создайте файл .env в корне вашего проекта:

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

Атрибуция

API библиотеки, вдохновленный node-telegram-bot-api.

Запросы на извлечение

Любые PR открыты.