Skip to content

Commit 40340c2

Browse files
committed
Add image for HSM template documentation
1 parent 78a409f commit 40340c2

File tree

2 files changed

+63
-48
lines changed

2 files changed

+63
-48
lines changed

docs/3. Product Features/06. Templates.md

Lines changed: 63 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
> ### **6 minutes read                                                                                                               `Beginner`**
22
33
**HSM (Highly Structured Message) templates are pre-approved messages by Whatsapp which are used to send to the users when their session window is closed (i.e after 24hours of inactive conversation). These templates ensure compliance with WhatsApp's guidelines and allow NGO's to send notifications, customer support messages and alerts with placeholders for personalized information.**
4-
___
4+
5+
---
6+
57
## Prerequisites
8+
69
- [Flow Variables](https://glific.github.io/docs/docs/category/flow-variables)
710
- [Glific Simulator](https://glific.github.io/docs/docs/Product%20Features/Others/All%20product%20features/#simulator)
8-
___
11+
12+
---
913

1014
## HSM Template Creation & Approval Submission
1115

@@ -20,8 +24,7 @@ ___
2024
<br />
2125

2226
3. `Add A New HSM Template` page opens up.
23-
<img width="623" alt="Screenshot 2024-07-01 at 4 57 35 PM" src="https://github.com/glific/docs/assets/141305477/cb6928b7-ef2d-4696-8400-bbfb70a3fe01" />
24-
27+
<![alt text](image.png)
2528

2629
<br />
2730
<br />
@@ -33,13 +36,15 @@ ___
3336
4. `Title` - Enter the name you want for your HSM Template as it would appear in Glific (It should be what use case does this template serves eg. OTP, Optin, Activity Preference).
3437
5. `Is Active`- the check box is by default checked. Keep it checked.
3538
6. `Message` - Type the message you want to send to users in this HSM template.
36-
7. `Add Variable` - Click on add variable if you'd like to insert a variable values (ex- preferred names, locations, any other value being captured in flow or contact variables). This provides further fields below to enter a sample value for the variables.
37-
1. `Category` - Select the most relevant category from the dropdown. Ex. Utility or Marketing
38-
2. `Attachment type` - An image, video or document can be sent as an attachment with the HSM template.
39-
3. `Attachment URL` - Provide an example referece to the attachment that will be sent
40-
(for more info please follow : https://developers.facebook.com/docs/whatsapp/updates-to-pricing/new-template-guidelines)
39+
7. `Footer` - Add the message which you want to act like a subtext
40+
8. `Add Variable` - Click on add variable if you'd like to insert a variable values (ex- preferred names, locations, any other value being captured in flow or contact variables). This provides further fields below to enter a sample value for the variables.
41+
9. `Category` - Select the most relevant category from the dropdown. Ex. Utility or Marketing
42+
10. `Attachment type` - An image, video or document can be sent as an attachment with the HSM template.
43+
11. `Attachment URL` - Provide an example referece to the attachment that will be sent
44+
(for more info please follow : https://developers.facebook.com/docs/whatsapp/updates-to-pricing/new-template-guidelines)
45+
46+
---
4147

42-
___
4348
## Buttons in HSM Template
4449

4550
You can use `Add Buttons` checkbox to use buttons in HSM templates.
@@ -59,7 +64,8 @@ Add a variable like \{\{1\}\} at the end of the URL and add it to the **Call to
5964

6065
<br />
6166

62-
___
67+
---
68+
6369
## Attachments in HSM Template
6470

6571
The below fields (Attachment Type & URL) are optional. it needs to be filled only if an attachment is required to be sent in the HSM template to the beneficiary.
@@ -68,6 +74,7 @@ The attachment URL is the sample URL, the exact attachment URL could be added wh
6874

6975
1. `Attachment Type` - Select the attachment type if you wish to send an attachment in your HSM template message Ex. Image, Audio, Video, etc...
7076
2. `Attachment URL`- Paste the attachment URL ( public URL) from the GCS bucket. Refer [How to upload files on GCS?](https://glific.github.io/docs/docs/Integrations/How%20to%20upload%20files%20on%20GCS/) to copy public URL from GCS
77+
7178
<br />
7279
Notice a simulator available in the form, as you will fill in the details of the HSM template, it will start previewing the message. Simulator helps you to get an idea about how the message will look like when the contact receives it.
7380

@@ -85,7 +92,8 @@ Notice a simulator available in the form, as you will fill in the details of the
8592
<img width="1243" alt="image" src="https://github.com/glific/docs/assets/122982753/e14e89c0-b8fe-439d-9a84-03679790d858"/>
8693
<br />
8794

88-
___
95+
---
96+
8997
## How to use HSM Templates in your flows
9098

9199
Common messages used in flow are session messages, which are open to send only within the 24 hours of users sending a message. If beneficiary responds within 24 hours, the session remains active. After 24 hours NGO users cannot send messages on chat bot to the beneficiary, until they send some message from their WhatsApp.
@@ -118,65 +126,71 @@ You can use approved HSM templates in your flow, to send to multiple users autom
118126

119127
![image](https://user-images.githubusercontent.com/32592458/218255903-8e46afe9-8228-4aed-b18a-70f6c4a14a0b.png)
120128

121-
___
129+
---
130+
122131
## Sending HSM Template to Contacts
123132

124133
Go to `Chat` window and to the particular contact to whom you want to send message. Click on upward arrow in the message box and click on the `Templates` tab there. You will see the message in the list of approved template messages. Select the message and send it to your contact.
125134

126135
<img width="931" alt="image" src="https://github.com/glific/docs/assets/122982753/7e946b65-3fde-4635-bfa1-1ca9df1f22f6"/>
127136
<br />
128137

129-
___
138+
---
139+
130140
## Approve Multi-lingual HSM templates
131141

132142
Glific has added a support to apply HSM messages for multiple templates by obtaining approval under the same element name.
133143
When the templates are already approved, simply add it in the default language, and other languages will be automatically tagged since the element name remains consistent.
134144

135145
Steps 1: Create and Approve English Template
136-
1. Click “Create Template.”
137-
2. Fill in the template in English, with a unique element name.
138-
3. Choose category (e.g., Utility, Marketing).
139-
4. Submit the template for approval.
140-
5. Wait until it is approved by WhatsApp.
146+
147+
1. Click “Create Template.”
148+
2. Fill in the template in English, with a unique element name.
149+
3. Choose category (e.g., Utility, Marketing).
150+
4. Submit the template for approval.
151+
5. Wait until it is approved by WhatsApp.
141152

142153
**English**
143154

144155
<img width="519" alt="image" src="https://github.com/user-attachments/assets/29764c5c-80c9-487c-bbe2-857b86c0486b"/>
145156

146157
Step 2: Create the Template in Another Language (e.g., Hindi)
147-
1. Click “Create Template.”
148-
2. Select “Language Variant” from the drop-down.
149158

150-
<img width="519" alt="image" src="https://github.com/user-attachments/assets/918237e0-6b73-42fc-b7a2-33bc4803e542"/>
151-
152-
4. Choose the target language (e.g., Hindi).
153-
5. Important: Check the “Translate existing HSM” box.
159+
1. Click “Create Template.”
160+
2. Select “Language Variant” from the drop-down.
154161

155-
<img width="519" alt="image" src="https://github.com/user-attachments/assets/29300f35-8e13-4e3a-a8bd-8d0d8bc54028"/>
162+
<img width="519" alt="image" src="https://github.com/user-attachments/assets/918237e0-6b73-42fc-b7a2-33bc4803e542"/>
156163

157-
<img width="519" alt="image" src="https://github.com/user-attachments/assets/5dfd616b-eb38-4896-a730-16abf2e44d15"/>
164+
3. Choose the target language (e.g., Hindi).
165+
4. Important: Check the “Translate existing HSM” box.
158166

159-
_This reveals a dropdown of element names from already approved HSM templates._
160-
161-
7. Select the same element name as the English template (e.g., multi_lingual_hsm_test).
162-
8. Alternatively, Enter the same Element Name as the approved English version. (_This links both templates under the same template family_)
163-
9. Input the translated version of the HSM message in Hindi
164-
10. Submit for approval.
167+
<img width="519" alt="image" src="https://github.com/user-attachments/assets/29300f35-8e13-4e3a-a8bd-8d0d8bc54028"/>
168+
169+
<img width="519" alt="image" src="https://github.com/user-attachments/assets/5dfd616b-eb38-4896-a730-16abf2e44d15"/>
170+
171+
_This reveals a dropdown of element names from already approved HSM templates._
172+
173+
5. Select the same element name as the English template (e.g., multi_lingual_hsm_test).
174+
6. Alternatively, Enter the same Element Name as the approved English version. (_This links both templates under the same template family_)
175+
7. Input the translated version of the HSM message in Hindi
176+
8. Submit for approval.
165177

166178
**Hindi**
167179

168180
<img width="499" alt="image" src="https://github.com/user-attachments/assets/4b76dc4a-ae76-4473-91af-1e1650799c34"/>
169181

170182
Step 3: Repeat for Other Languages (Optional)
171-
1. Follow Step 2 for additional languages (e.g., Marathi, Kannada, Tamil).
172-
2. Always ensure:
173-
Same element name
174-
Accurate translation
175-
Matched placeholders
183+
184+
1. Follow Step 2 for additional languages (e.g., Marathi, Kannada, Tamil).
185+
2. Always ensure:
186+
Same element name
187+
Accurate translation
188+
Matched placeholders
176189

177190
Note: Now when adding the template in flow, you can add English template in default language flow. If contact selects a different language (Hindi), then the Hindi version of HSM will be send to the contact. It chooses the language specific HSM automatically based on the selection of language by the end-user.
178191

179-
___
192+
---
193+
180194
## Bulk Apply HSM Templates
181195

182196
Multiple templates can also be applied by using Bulk Apply HSM templates using Google Sheet
@@ -185,7 +199,6 @@ Multiple templates can also be applied by using Bulk Apply HSM templates using G
185199

186200
2. Click on `File` and then `Make a copy` to create a copy of the sheet
187201
![image](https://user-images.githubusercontent.com/40158831/218453349-087e3e8a-bc55-4ce2-9b8a-301a8c0fbefe.jpeg)
188-
189202

190203
3. Fill in details for templates in rows. Here's what each column represent in the sheet
191204

@@ -225,12 +238,15 @@ Multiple templates can also be applied by using Bulk Apply HSM templates using G
225238

226239
![image](https://user-images.githubusercontent.com/40158831/218454345-d0e80605-335f-4078-8782-613a96873cae.jpeg)
227240

228-
___
241+
---
242+
229243
## HSM templates limit
230244

231245
By default, there is a **limit of 250 HSM templates per phone number**. If incase more HSM templates are required, then you need to submit a request to WhatsApp to increase the limit.
232246
<br />
233-
___
247+
248+
---
249+
234250
## Suggestions to get the HSM template approved
235251

236252
1. **Avoid doing** - Hi, here are the activities for today. We hope you complete them by the end of the day and submit them.
@@ -240,17 +256,15 @@ ___
240256
1. **_Use absolute URL_** in HSM text. Short URLs don&#39;t work and the template got rejected with an error message &quot;Invalid format&quot;
241257
1. **Emojis are not allowed** in HSM buttons. If you add emojis the template will be rejected.
242258
1. **GIFs are not allowed** in HSM attachments. If you add Gifs as an attachment, it will be rejected.
243-
<br />
259+
<br />
244260

261+
## Sync the HSM messages from Gupshup-
245262

246-
## Sync the HSM messages from Gupshup-
247-
248-
1. Sometimes it takes time to sync from Gupshup to Glific. To sync it instantly sync, click on `Sync HSM` at the top of the page,
263+
1. Sometimes it takes time to sync from Gupshup to Glific. To sync it instantly sync, click on `Sync HSM` at the top of the page,
249264

250265
<img width="1290" alt="image" src="https://github.com/glific/docs/assets/122982753/5c3459a8-8f59-443d-a0f7-94c08d562c34"/>
251266
<br />
252267

253-
254268
## How to check the reason for HSM rejection.
255269

256270
1 . Log in to Gupshup ([https://www.gupshup.io/](https://www.gupshup.io/)).
@@ -276,7 +290,8 @@ If there are further any queries about the template getting rejected. Please che
276290
[https://developers.facebook.com/docs/whatsapp/message-templates/guidelines/](https://developers.facebook.com/docs/whatsapp/message-templates/guidelines/)
277291

278292
**Note** - The HSM templates need to be in one language. Do not mix the languages in one template (Ex. words of both English and Hindi language should not be in one HSM template).
279-
___
293+
294+
---
280295

281296
## Tags
282297

docs/3. Product Features/image.png

117 KB
Loading

0 commit comments

Comments
 (0)