Node.js WhatsApp Library#

JavaScript библиотека для интеграции с мессенджером WhatsAPP через API сервиса green-api.com. Чтобы воспользоваться библиотекой нужно получить регистрационный токен и id инстанса в личном кабинете. Для тестирования рекомендуем воспользоваться бесплатным тарифом "Разработчик".

API#

Документация к REST API находится по ссылке. Библиотека является оберткой к REST API, поэтому документация по ссылке выше применима и к самой библиотеке.

Авторизация#

Чтобы отправить сообщение или выполнить другой метод Green-API, аккаунт WhatsApp в приложении телефона должен быть в авторизованном состоянии. Для авторизации аккаунта перейдите в личный кабинет и сканируйте QR-код с использованием приложения WhatsApp.

Разворачивание окружения разработки#

1. Склонируйте репозиторий через git clone
2. Установите зависимости через npm install
3. Установите глобально библиотеку rollup для сборки.
4. Для вебхуков добавьте express как новую зависимость через npm
5. Создайте файл .env в рутовом каталоге и пропишите переменные окружения. Образец переменных в файле env.example

Сборка#

Скомпилировать как browser, так и node/webpack версии либы можно одной командой

npm run build

Примеры использования#

• Как отправить текстовое сообщение

• Как отправить файл по ссылке

• Как отправить файл загрузкой с диска

• Как принять и обработать уведомление

• Как принять и обработать уведомления используя сервер

• Как принимать webhook endpoint уведомления на локальной машине

• Как получить QR код

Документация по методам сервиса#

• Документация по методам сервиса

Сторонние продукты#

• axios - для http запросов
• express - сервер приложений для вебхуков

Лицензия#

Лицензировано на условиях Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0).

Смотрите файл LICENSE.