Skip to content

AQI Reporting on WhatsApp and Messenger using the Vonage and WAQP APIs

License

Notifications You must be signed in to change notification settings

sudiptog81/vonage-aqi

Repository files navigation

Vonage AQICN

license dependencies contributors

Features

  • Replies with the detailed Air Quality Information sourced from the weather stations under the World Air Quality Project.
  • Supports WhatsApp and Messenger channels by leveraging the Messages API provided by Vonage.

Usage

Supported Commands

  • aqi station-name (alias: a): Displays Brief Information about the Air Quality from a weather station.
  • info station-name (alias: i): Displays Detailed Information about the Air Quality from a weather station.
  • act: Displays Information about what Actions one can take to know more about the effects of Air Pollution.
  • help (alias: h): Displays Help Information.

WhatsApp

whatsapp

Messenger

messenger

Getting Started

  • Register at https://dashboard.nexmo.com/ and go to the Messages API Sandbox.
  • Whitelist a test recipient by following the instructions for the WhatsApp channel and/or the Messenger channel.
  • Note down the API Key and the API Secret as well as the Sandox Numbers and/or the Sandbox IDs.
  • Clone this repository and install the required dependencies.
  • Copy .env.example to .env and set the required variables.
  • Run the Express Application using yarn start or yarn run dev and expose the endpoints with a ngrok tunnel by executing ngrok http <application-port>.
  • Set the following Webhook Endpoints on the Messages API Sandbox.
    • Inbound: <ngrok-tunnel>/webhook/inbound
    • Status: <ngrok-tunnel>/webhook/status

License

The MIT License

About

AQI Reporting on WhatsApp and Messenger using the Vonage and WAQP APIs

Topics

Resources

License

Stars

Watchers

Forks