Skip to content

Commit

Permalink
Updating whatsappgroups onboarding (#240)
Browse files Browse the repository at this point in the history 
* Create WhatsApp Groups Automation Features.md

Created a separate md file listing the features and how to use them.

* Steps to be followed for Onboarding for new NGOs.md

* Create Setting up WhatsApp Groups Automation for existing NGOs.md

* Update Onboarding for new NGOs.md

* Delete docs/WhatsApp Groups Automation.md

removing the earlier documentation.
  • Loading branch information
@mahajantejas
mahajantejas authored Nov 19, 2024
1 parent ccddece commit de658c3
Show file tree
Hide file tree
Showing 3 changed files with 112 additions and 50 deletions.
60 changes: 60 additions & 0 deletions docs/WhatsApp Groups Automation/Onboarding for new NGOs.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
### **5 minute read                                                                                                                         `Beginner`**

### Contents
1. [Pre-requisites](#pre-requisites)
2. [Set-up](#set-up)
8. [Pricing](#pricing)

### Pre-requisites
1. Have an active phone number with a normal WhatsApp account linked to it.
3. Should have the WhatsApp groups created and the phone number should be part of the WhatsApp groups. (it is advised to have the WhatsApp Groups named in an appropriate manner)


### Set-up
#### Step 1: Linking phone number to Maytapi account


1. Create maytapi account https://console.maytapi.com/login
2. Log in with google id and link a phone number (follow instructions given on Maytapi page)
3. Set up the payment option (~30$ per phone per month) in Maytapi. (For difficulties with the payments reach out directly to Maytapi team on info@maytapi.com keeping your Glific team POC in loop.)
4. Or proceed with free trial which disables the connection in 3 days.
5. Make a note of the "product id" and "token" given by Maytapi. This needs to be shared with the Glific team.
<img width="1276" alt="Screenshot 2024-11-18 at 3 52 57 PM" src="https://github.com/user-attachments/assets/408e6382-4c49-4a6c-ab51-67c185ff59b7" />


#### Step 2: Filling the Glific onboarding form
1. Fill the Glific [onboarding form](https://prod.glific.com/organization-registration).
- For "App Name" and "Gupshup API key" fill the following details respectively
- App name: 2023OBF1
- Gupshup API key: 9imaygevg6fuwa82s54hbuyoiuuohmug
- Follow the rest of the onboarding form documentation [here](https://glific.github.io/docs/docs/Onboarding/Onboarding%20Form%20Fill%20Up/)
<img width="824" alt="Screenshot 2024-11-18 at 3 35 30 PM" src="https://github.com/user-attachments/assets/68ddcd1b-8872-4b92-b2ba-e0074d602f6e" />
2. After completion of this step, Glific team will share the platform url, along with the log-in credentials.


#### Step 3: Connecting Maytapi to Glific

1. In Maytapi go to webhook and enter the following webhook url `https://api.**ngo-shortcode**.glific.com/maytapi`

Ex, if your glific domain is `www.xyz.glific.com` then use the maytapi webhook url becomes `https://api.xyz.glific.com/maytapi`

<img width="1274" alt="Screenshot 2024-11-18 at 3 59 18 PM" src="https://github.com/user-attachments/assets/a2ff1a6e-b034-47e5-90de-ce2bfe37df44" />

2. In Glific, go to setting, go to maytapi, and check if the product and token id as provided my Maytapi is added.
3. If it is not, then add the product and token it from Maytapi and click save.
4. This completes the set-up
<img width="1277" alt="Screenshot 2024-11-18 at 3 57 07 PM" src="https://github.com/user-attachments/assets/b76f6415-4ee0-4d56-9555-1304886df5d5" />

You should be able to see the whatsapp groups option in the left panel that the phone number is part of and perform operations like send, receive and schedule message to a group of groups.

### Pricing
#### MayTapi
1. Free trial for 3 days
2. 30$ per month per phone being linked to Maytapi
3. Upto 3 phones can be linked per Maytapi account

#### Messaging
No separate cost for messaging needs to be paid.

### Video Showcase
<iframe width="560" height="315" src="https://www.youtube.com/embed/RdYJTBmSXYs?si=r1lCTEq2eO18ZEXo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
48 changes: 48 additions & 0 deletions ...pp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
### **5 minute read &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `Beginner`**

### Pre-requisites
1. Have an active phone number with a normal WhatsApp account linked to it.
2. Should have the WhatsApp groups created and the phone number should be part of the WhatsApp groups. (it is advised to have the WhatsApp Groups named in an appropriate manner)
3. Go to your Glific platform and see if the "WhatsApp Groups" option is shown. If it is not visible then contact Glific team POC or go to [NGO support](https://discord.gg/YWgGxWJsMh) Discord channel and create an issue requesting for the WhatsApp Groups Automation to be enabled for your NGO account.
<img width="887" alt="Screenshot 2024-11-18 at 4 18 08 PM" src="https://github.com/user-attachments/assets/33bebb70-d70d-421e-bb22-7ae3811dba84" />



### Set-up
#### Step 1: Connecting Phone number to Maytapi

1. Create Maytapi account at https://console.maytapi.com/login
2. Log in with google id and link a phone number (follow instructions given on Maytapi page)
3. Set up the payment option (~30$ per phone per month) in Maytapi.
4. Or proceed with free trial which disables the connection in 3 days.
5. Make a note of the "product id" and "token" given by Maytapi. This needs to be shared with the Glific team.

<img width="1276" alt="Screenshot 2024-11-18 at 3 52 57 PM" src="https://github.com/user-attachments/assets/86b89bfb-4d7d-414b-93b2-ad4305122093" />

#### Step 2: Connecting Maytapi to Glific

1. In Maytapi go to webhook and enter the following webhook url : `https://api.**ngo-shortcode**.glific.com/maytapi`

<img width="1274" alt="Screenshot 2024-11-18 at 3 59 18 PM" src="https://github.com/user-attachments/assets/83972900-4dd5-4f53-9f6f-e1c9f3ef054a" />

Ex, if your glific domain is `www.xyz.glific.com` then use the maytapi webhook url becomes `https://api.xyz.glific.com/maytapi`

2. In Glific, go to setting, go to Maytapi, add product and token id from the Maytapi
<img width="1277" alt="Screenshot 2024-11-18 at 3 57 07 PM" src="https://github.com/user-attachments/assets/59cf5745-bed1-4d88-8bb9-128816653c6e" />

4. Click on save
5. This completes the set-up

You should be able to see the whatsapp groups option in the left panel that the phone number is part of and perform operations like send, receive and schedule message to a group of groups.

### Pricing
#### MayTapi
1. Free trial for 3 days
2. 30$ per month per phone being linked to Maytapi
3. Upto 3 phones can be linked per Maytapi account

#### Messaging
No separate cost for messaging needs to be paid.

### Video Showcase
<iframe width="560" height="315" src="https://www.youtube.com/embed/RdYJTBmSXYs?si=r1lCTEq2eO18ZEXo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
54 changes: 4 additions & 50 deletions docs/WhatsApp Groups Automation.md → ...on/WhatsApp Groups Automation Features.md
View file
Original file line number Diff line number Diff line change
@@ -1,45 +1,7 @@
> ### **5 minute read &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `Beginner`**
### **5 minute read &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `Beginner`**

## User Guide: WhatsApp Groups Automation

### Contents
1. [Pre-requisites](#pre-requisites)
2. [Set-up](#set-up)
3. [Group chats](#group-chats)
4. [Group collections](#group-collections)
5. [Sending messages](#sending-messages)
6. [Sending media](#sending-media)
7. [Scheduling messages and media](#scheduling-messages-and-media)
8. [Pricing](#pricing)
9. [Video Showcase](#video-showcase)

### Pre-requisites
1. Have a phone number on whatsapp
2. Phone number to be part of the WhatsApp groups (this has to be done manually)
3. The trial (free) account of Maytapi ( active for 3 days.) for more details
4. Should be onboarded to Glific platform

### Set-up
Step 1: Connecting Phone number to Maytapi

1. Create maytapi account https://console.maytapi.com/login
2. Log in with google id and link a phone number (follow instructions on the page)
3. Set up the payment option (30$ per phone per month) in Maytapi
4. Or proceed with free trial which enables the phone to be active for 3 days)

Step 2: Connecting Maytapi to Glific

1. In Maytapi go to webhook and enter the following webhook url

https://api.**ngo-shortcode**.glific.com/maytapi

Ex, if your glific domain is www.xyz.glific.com then use the maytapi webhook url becomes https://api.xyz.glific.com/maytapi

2. In Glific, go to setting, go to maytapi, add product id and token id from the Maytapi
3. Click on save
4. This completes the set-up

You should be able to see the whatsapp groups option in the left panel that the phone number is part of and perform operations like send, receive and schedule message to a group of groups.
## User Guide: WhatsApp Groups Automation Features: Basic
This document provides details on using basic features of syncing all the WhatsApp Groups, sending messages and media to the groups from the Glific interface, creating collections or groups of groups to send targetted messages to a large number of groups and scheduling messages to the collections in advance.

### Group Chats

Expand All @@ -49,7 +11,7 @@ You should be able to see the whatsapp groups option in the left panel that the
### Group Collections
1. Group collection is a group of groups. A way to club together with groups. This is to enable sending or scheduling of messages to the bulk of the groups from the single action.

#### How to create.
#### How to create Group Collections
1. Go to Group Collection

<img width="1129" alt="Screenshot 2024-04-16 at 3 27 27 PM" src="https://github.com/glific/docs/assets/141305477/10d30710-c7d2-4c3b-b9f0-b9675bba0c70"/>
Expand Down Expand Up @@ -109,14 +71,6 @@ Follow the same steps as above under the `Groups Collection` menu in the `Group

<img width="653" alt="Screenshot 2024-04-16 at 4 31 14 PM" src="https://github.com/glific/docs/assets/141305477/99bf5651-985d-4a2e-a243-cdcf89a72887" />

### Pricing
#### MayTapi
1. Free trial for 3 days
2. 30$ per month per phone being linked to Maytapi
3. Upto 3 phones can be linked per Maytapi account

#### Messaging
No separate cost for messaging needs to be paid.

### Video Showcase
<iframe width="560" height="315" src="https://www.youtube.com/embed/RdYJTBmSXYs?si=r1lCTEq2eO18ZEXo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

0 comments on commit de658c3

Please sign in to comment.