1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
|
# coding: utf-8
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
"""
FILE: send_template_notification_messages.py
DESCRIPTION:
This sample demonstrates sending an Whatsapp template message from business phone number to a single user.
Template to be used in the sample needs to be created in WhatsApp Business account first.
Follow the instructions in the Meta Business Help Center at https://www.facebook.com/business/help/2055875911147364?id=2129163877102343.
The NotificationMessageClient is authenticated using a connection string.
USAGE:
python send_template_notification_messages.py
Set the environment variable with your own value before running the sample:
1) COMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource
2) RECIPIENT_PHONE_NUMBER - a phone number with Whatsapp capabilities. Use list for recipient phone number.
3) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging.
"""
import os
import sys
sys.path.append("..")
class SendWhatsAppTemplateMessageSample(object):
connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING")
phone_number = os.getenv("RECIPIENT_PHONE_NUMBER")
channel_id = os.getenv("WHATSAPP_CHANNEL_ID")
def send_template_send_message(self):
from azure.communication.messages import NotificationMessagesClient
from azure.communication.messages.models import TemplateNotificationContent, MessageTemplate
messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
# Setting template options
input_template: MessageTemplate = MessageTemplate(name="cpm_welcome", language="en_us")
template_options = TemplateNotificationContent(
channel_registration_id=self.channel_id, to=[self.phone_number], template=input_template
)
# calling send() with whatsapp message details
message_responses = messaging_client.send(template_options)
response = message_responses.receipts[0]
print("Message with message id {} was successful sent to {}".format(response.message_id, response.to))
def send_template_message_with_parameters(self):
from azure.communication.messages import NotificationMessagesClient
from azure.communication.messages.models import (
TemplateNotificationContent,
MessageTemplate,
MessageTemplateText,
WhatsAppMessageTemplateBindings,
WhatsAppMessageTemplateBindingsComponent,
)
messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
# Setting template options
templateName = "sample_shipping_confirmation"
templateLanguage = "en_us"
shippingConfirmationTemplate: MessageTemplate = MessageTemplate(name=templateName, language=templateLanguage)
threeDays = MessageTemplateText(name="threeDays", text="3")
bindings = WhatsAppMessageTemplateBindings(
body=[WhatsAppMessageTemplateBindingsComponent(ref_value=threeDays.name)]
)
shippingConfirmationTemplate.bindings = bindings
shippingConfirmationTemplate.template_values = [threeDays]
template_options = TemplateNotificationContent(
channel_registration_id=self.channel_id, to=[self.phone_number], template=shippingConfirmationTemplate
)
# calling send() with whatsapp message details
message_responses = messaging_client.send(template_options)
response = message_responses.receipts[0]
print("Message with message id {} was successful sent to {}".format(response.message_id, response.to))
def send_template_message_with_buttons(self):
from azure.communication.messages import NotificationMessagesClient
from azure.communication.messages.models import (
TemplateNotificationContent,
MessageTemplate,
MessageTemplateText,
WhatsAppMessageTemplateBindings,
WhatsAppMessageTemplateBindingsComponent,
MessageTemplateQuickAction,
WhatsAppMessageTemplateBindingsButton,
WhatsAppMessageButtonSubType,
)
messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
# Setting template options
templateName = "sample_issue_resolution"
templateLanguage = "en_us"
shippingConfirmationTemplate: MessageTemplate = MessageTemplate(name=templateName, language=templateLanguage)
name = MessageTemplateText(name="first", text="Joe")
yes = MessageTemplateQuickAction(name="Yes", payload="Joe said yes")
no = MessageTemplateQuickAction(name="No", payload="Joe said no")
bindings = WhatsAppMessageTemplateBindings(body=[WhatsAppMessageTemplateBindingsComponent(ref_value=name.name)])
bindings.buttons = [
WhatsAppMessageTemplateBindingsButton(
sub_type=WhatsAppMessageButtonSubType.QUICK_REPLY, ref_value=yes.name
),
WhatsAppMessageTemplateBindingsButton(sub_type=WhatsAppMessageButtonSubType.QUICK_REPLY, ref_value=no.name),
]
shippingConfirmationTemplate.bindings = bindings
shippingConfirmationTemplate.template_values = [name, yes, no]
template_options = TemplateNotificationContent(
channel_registration_id=self.channel_id, to=[self.phone_number], template=shippingConfirmationTemplate
)
# calling send() with whatsapp message details
message_responses = messaging_client.send(template_options)
response = message_responses.receipts[0]
print("Message with message id {} was successful sent to {}".format(response.message_id, response.to))
def send_template_message_with_media(self):
from azure.communication.messages import NotificationMessagesClient
from azure.communication.messages.models import (
TemplateNotificationContent,
MessageTemplate,
MessageTemplateText,
WhatsAppMessageTemplateBindings,
WhatsAppMessageTemplateBindingsComponent,
MessageTemplateImage,
)
messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
# Setting template options
templateName = "sample_movie_ticket_confirmation"
templateLanguage = "en_us"
imageUrl = "https://aka.ms/acsicon1"
sample_movie_ticket_confirmation: MessageTemplate = MessageTemplate(
name=templateName, language=templateLanguage
)
image = MessageTemplateImage(name="image", url=imageUrl)
title = MessageTemplateText(name="title", text="Contoso")
time = MessageTemplateText(name="time", text="July 1st, 2023 12:30PM")
venue = MessageTemplateText(name="venue", text="Southridge Video")
seats = MessageTemplateText(name="seats", text="Seat 1A")
bindings = WhatsAppMessageTemplateBindings(
header=[WhatsAppMessageTemplateBindingsComponent(ref_value=image.name)],
body=[
WhatsAppMessageTemplateBindingsComponent(ref_value=title.name),
WhatsAppMessageTemplateBindingsComponent(ref_value=time.name),
WhatsAppMessageTemplateBindingsComponent(ref_value=venue.name),
WhatsAppMessageTemplateBindingsComponent(ref_value=seats.name),
],
)
sample_movie_ticket_confirmation.bindings = bindings
sample_movie_ticket_confirmation.template_values = [image, title, time, venue, seats]
template_options = TemplateNotificationContent(
channel_registration_id=self.channel_id, to=[self.phone_number], template=sample_movie_ticket_confirmation
)
# calling send() with whatsapp message details
message_responses = messaging_client.send(template_options)
response = message_responses.receipts[0]
print("Message with message id {} was successful sent to {}".format(response.message_id, response.to))
def send_template_message_with_call_to_action(self):
from azure.communication.messages import NotificationMessagesClient
from azure.communication.messages.models import (
TemplateNotificationContent,
MessageTemplate,
MessageTemplateText,
WhatsAppMessageTemplateBindings,
WhatsAppMessageTemplateBindingsComponent,
MessageTemplateQuickAction,
MessageTemplateImage,
WhatsAppMessageTemplateBindingsButton,
WhatsAppMessageButtonSubType,
)
messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
# Setting template options
templateName = "purchase_feedback"
templateLanguage = "en_us"
imageUrl = "https://aka.ms/acsicon1"
sample_purchase_feedback: MessageTemplate = MessageTemplate(name=templateName, language=templateLanguage)
name = MessageTemplateText(name="first", text="Joe")
image = MessageTemplateImage(name="image", url=imageUrl)
uri_to_click = MessageTemplateQuickAction(name="url", text="questions")
bindings = WhatsAppMessageTemplateBindings(
body=[WhatsAppMessageTemplateBindingsComponent(ref_value=name.name)],
header=[WhatsAppMessageTemplateBindingsComponent(ref_value=image.name)],
buttons=[
WhatsAppMessageTemplateBindingsButton(
sub_type=WhatsAppMessageButtonSubType.URL, ref_value=uri_to_click.name
)
],
)
sample_purchase_feedback.bindings = bindings
sample_purchase_feedback.template_values = [name, image, uri_to_click]
template_options = TemplateNotificationContent(
channel_registration_id=self.channel_id, to=[self.phone_number], template=sample_purchase_feedback
)
# calling send() with whatsapp message details
message_responses = messaging_client.send(template_options)
response = message_responses.receipts[0]
print(
"WhatsApp Call To Action Templated Message with message id {} was successfully sent to {}".format(
response.message_id, response.to
)
)
def send_template_message_with_location(self):
from azure.communication.messages import NotificationMessagesClient
from azure.communication.messages.models import (
TemplateNotificationContent,
MessageTemplate,
MessageTemplateText,
WhatsAppMessageTemplateBindings,
WhatsAppMessageTemplateBindingsComponent,
MessageTemplateLocation,
)
messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
# Setting template options
templateName = "sample_movie_location"
templateLanguage = "en_us"
sample_movie_location: MessageTemplate = MessageTemplate(name=templateName, language=templateLanguage)
name = MessageTemplateText(name="first", text="Joe")
location = MessageTemplateLocation(
name="location",
location_name="Pablo Morales",
address="1 Hacker Way, Menlo Park, CA 94025",
latitude=37.483307,
longitude=122.148981,
)
bindings = WhatsAppMessageTemplateBindings(
body=[WhatsAppMessageTemplateBindingsComponent(ref_value=name.name)],
header=[WhatsAppMessageTemplateBindingsComponent(ref_value=location.name)],
)
sample_movie_location.bindings = bindings
sample_movie_location.template_values = [name, location]
template_options = TemplateNotificationContent(
channel_registration_id=self.channel_id, to=[self.phone_number], template=sample_movie_location
)
# calling send() with whatsapp message details
message_responses = messaging_client.send(template_options)
response = message_responses.receipts[0]
print(
"WhatsApp Location Templated Message with message id {} was successfully sent to {}".format(
response.message_id, response.to
)
)
if __name__ == "__main__":
sample = SendWhatsAppTemplateMessageSample()
sample.send_template_send_message()
sample.send_template_message_with_parameters()
sample.send_template_message_with_buttons()
sample.send_template_message_with_location()
sample.send_template_message_with_call_to_action()
sample.send_template_message_with_media()
|
