-
In this example we demo a building management use case.
-
We use ngrok to create temporary https reverse proxy so whatsapp can reach our demo api.
-
Because ngrok public url changes everytime we also change webhook settings in our instance at boot. This should not be used like this in production environments.
-
NOTE: Before testing the demo you need to create your phone instance and connect an active WhatsApp account to instance in Phones Page. (Create a trial Maytapi Whatsapp API account and register the test phone via Whatsapp Web QR code)
Link to full Maytapi docs for more details: https://maytapi.com/whatsapp-api-documentation
pip install -r requirements.txt
You need to change PRODUCT_ID, PHONE_ID, API_TOKEN, MANAGER_GROUP and USER_GROUPS (list of strings) values in app.py file.
You can find your Product ID and Token in Settings Token Page.
Phone Id can be found in Phones Page or with /listPhones endpoint.
MANAGER_GROUP and USER_GROUPS are the conversation IDs of each respective Whatsapp groupchat. They can be obtained from your Maytapi Developer account dashboard -> Developers -> Logs, find value of "conversation" in the JSON data logs. (e.g. "6582698370-1606900617@g.us")
export FLASK_APP=app.py
flask run --host 0.0.0.0 --port 9000 --no-debugger --no-reload
set FLASK_APP=app.py
flask run --host 0.0.0.0 --port 9000 --no-debugger --no-reload
$env:FLASK_APP = "app.py"
flask run --host 0.0.0.0 --port 9000 --no-debugger --no-reload
This project serves as a demo for use case:
There are 3 main whatsapp groups created:
- WA Group 1 - Republic Plaza: This groupchat is for building staff to send updates on incident report and incident resolved for Republic Plaza. This groupchat includes the building staff (end user) and the bot.
- WA Group 2 - City Square Mall: Similarly, this groupchat is for building staff to send updates on incident report and incident resolved for City Square Mall. This groupchat includes the building staff (end user) and the bot.
- WA Group 3 - CDL Ops Manager Groupchat: This groupchat acts as a log and receives message updates from the bot whenever there is a incident report or incident resolved from any one of the buildings. This groupchat includes the manager and the bot. Thus, the manager does not need to be in every single building groupchat, he only needs to be in this one.
The Operations Dashboard is done in Vue (similar to Yoobot) and gets JSON data from the backend (app.py) via its GET method.
Create the 3 seperate Whatsapp groups and make sure the correct members are in each group (as mentioned above).
In any one of the building chatgroups, start the text message with '@6582698370 ' or '@saved_contact_name_of_bot ' (a list of suggestions should automatically appear).
Once this message is sent, the bot will reply with a confirmation message.
A message will also be sent to the manager groupchat to log the incident.
Reply 'Incident resolved' to the bot-generated 'incident received' message that has the corresponding incident number as the incident you wish to resolve. This can be done by swiping the message to the right, or pressing and holding -> select 'reply'.
Once done, the bot will send a confirmation message that the incident is closed.
A message will also be sent to the manager groupchat to log the closure of the incident.
This project can be replicated to serve many use cases:
- management of delivery fleet, where constant updates/actions to the central controller might be needed
- management of incident reporting (maintainene/crime/information gathering/etc)
- large scale amazing race events (central controller can act as the manager group, while many teams each have a phone that can log direct updates to the central controller, who then can monitor the situation live)