You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**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.**
<imgwidth="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
+
<
25
28
26
29
<br />
27
30
<br />
@@ -33,13 +36,15 @@ ___
33
36
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).
34
37
5.`Is Active`- the check box is by default checked. Keep it checked.
35
38
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
+
---
41
47
42
-
___
43
48
## Buttons in HSM Template
44
49
45
50
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
59
64
60
65
<br />
61
66
62
-
___
67
+
---
68
+
63
69
## Attachments in HSM Template
64
70
65
71
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
68
74
69
75
1. `Attachment Type` - Select the attachment type if you wish to send an attachment in your HSM template message Ex. Image, Audio, Video, etc...
70
76
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
+
71
78
<br />
72
79
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.
73
80
@@ -85,7 +92,8 @@ Notice a simulator available in the form, as you will fill in the details of the
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
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.
Glific has added a support to apply HSM messages for multiple templates by obtaining approval under the same element name.
133
143
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.
134
144
135
145
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.
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
176
189
177
190
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.
178
191
179
-
___
192
+
---
193
+
180
194
## Bulk Apply HSM Templates
181
195
182
196
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
185
199
186
200
2. Click on `File` and then `Make a copy` to create a copy of the sheet
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.
232
246
<br />
233
-
___
247
+
248
+
---
249
+
234
250
## Suggestions to get the HSM template approved
235
251
236
252
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 @@ ___
240
256
1.**_Use absolute URL_** in HSM text. Short URLs don't work and the template got rejected with an error message "Invalid format"
241
257
1.**Emojis are not allowed** in HSM buttons. If you add emojis the template will be rejected.
242
258
1.**GIFs are not allowed** in HSM attachments. If you add Gifs as an attachment, it will be rejected.
243
-
<br />
259
+
<br />
244
260
261
+
## Sync the HSM messages from Gupshup-
245
262
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,
**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).
0 commit comments