Added Whatsapp Template Messages

Author: JorisPenningsCM

.idea/.gitignore

@@ -13,14 +13,15 @@ class Message:
     maximumNumberOfMessageParts = 8
     hybridAppKey = ''
     allowedChannels = ['SMS']
+    template = None
     richContent = None
     SENDER_FALLBACK = 'cm.com'
     MESSAGEPARTS_MINIMUM = 1
     MESSAGEPARTS_MAXIMUM = 8
     RECIPIENTS_MAXIMUM  = 1000
 
     # init function of class Message
-    def __init__(self, body='', type=MessageBodyTypes.AUTO, from_=None, to=[], reference=None, allowedChannels=None, media=None):
+    def __init__(self, body='', type=MessageBodyTypes.AUTO, from_=None, to=[], reference=None, allowedChannels=None, media=None, template=None):
         self.body = body
         self.type = type
         if from_ is not None:
@@ -37,6 +38,10 @@ def __init__(self, body='', type=MessageBodyTypes.AUTO, from_=None, to=[], refer
         if media is not None:
             self.richContent = media
 
+        # if template is not None
+        if template is not None:
+            self.template = template
+
         self.reference = reference
         self.AddRecipients(recipients=to)
 

CMText/Message.py

@@ -1,11 +1,10 @@
 from CMText.Gateways import Gateways
 from CMText.Message import Message
+from CMText.WhatsappTemplate import WhatsappTemplate
 from CMText.version import __version__
 import json
 import requests
 
-
-
 class TextClient:
     gateway = ''
     apikey = ''
@@ -32,6 +31,10 @@ def AddMessage(self, message, from_='', to=[], reference=None, allowedChannels=N
     def AddRichMessage(self, message, media, from_='', to=[], reference=None, allowedChannels=None):
         self.messages.append(Message(message, media=media, from_=from_, to=to, reference=reference, allowedChannels=allowedChannels))
 
+    # Add a Whatsapp Template message to the list
+    def AddWhatsappTemplateMessage(self, template, from_='', to=[], reference=None, media=None):
+        self.messages.append(Message(media=media, from_=from_, to=to, reference=reference, allowedChannels=['Whatsapp'], template=template))
+
     # Send all messages in the list
     def send(self):
         if len(self.messages) == 0:
@@ -51,7 +54,7 @@ def send(self):
              'X-CM-SDK': 'text-sdk-python-' + self.VERSION
          }
 
-        # Send the message
+        # Send the message(s)
         try:
             response = requests.post("https://gw.cmtelecom.com/v1.0/message", data=data, headers=headers)
         except Exception as e:
@@ -68,7 +71,6 @@ def encodeData(self, messages):
         data = {"messages": {"authentication":{"producttoken": self.apikey}}}
         data['messages']['msg'] = []
 
-
         # For each message do this
         for message in messages:
             # List all recipients
@@ -86,8 +88,29 @@ def encodeData(self, messages):
                     }
                     }
 
-            # If message is rich
-            if message.richContent is not None:
+            # If message is template
+            if message.template is not None:
+                temp["richContent"] = {
+                    "conversation": [{
+                        "template":
+                            {
+                                "whatsapp":
+                                    {
+                                        "namespace": message.template.namespace,
+                                        "element_name": message.template.element_name,
+                                        "language":
+                                            {
+                                                "policy": message.template.language_policy,
+                                                "code": message.template.language_code
+                                            },
+                                        "components": message.template.components
+                                    }
+                            }
+                    }]
+                }
+
+            # If message is rich and no template
+            if message.template is None and message.richContent is not None:
                 temp["richContent"] = {
                     "conversation": [{
                         "text": message.body

CMText/TextClient.py

@@ -0,0 +1,19 @@
+from CMText.version import __version__
+
+class WhatsappTemplate:
+    namespace = ''
+    element_name = ''
+    language_policy = ''
+    language_code = ''
+    components = []
+    media = None
+
+    # init function of class Message
+    def __init__(self, namespace, element_name, components=[], media=None, language_policy="deterministic", language_code="en"):
+        self.namespace = namespace
+        self.element_name = element_name
+        self.components = components
+        self.media = media
+        self.language_policy = language_policy
+        self.language_code = language_code
+

CMText/WhatsappTemplate.py

@@ -1,2 +1,2 @@
 #project Version
-__version__ = '1.0.5'
+__version__ = '1.1.0'

CMText/version.py

@@ -0,0 +1,25 @@
+from CMText.TextClient import TextClient
+from CMText.WhatsappTemplate import WhatsappTemplate
+
+# Your api-Key
+key = 'Your-Key'
+
+# Recipients
+to = ['00123456789','00986837265']
+
+# Template
+template_namespace = "Your_Template_Namespace"
+template_element_name = "Your_Template_Name"
+template = WhatsappTemplate(template_namespace, template_element_name)
+
+# Instantiate client with your own api-key
+client = TextClient(apikey=key)
+
+# Add message to queue
+client.AddWhatsappTemplateMessage(from_='pythonSDK', to=to, template=template)
+
+# Send message
+response = client.send()
+
+# Response is an object of type: https://www.w3schools.com/python/ref_requests_response.asp
+print(response.text)

Examples/Whatsapp_Template_Message_Example.py

@@ -0,0 +1,53 @@
+from CMText.TextClient import TextClient
+from CMText.WhatsappTemplate import WhatsappTemplate
+
+# Your api-Key
+key = 'Your-Key'
+
+# Recipients
+to = ['00123456789','00986837265']
+
+# Template
+template_namespace = "Your_Template_Namespace"
+template_element_name = "Your_Template_Name"
+template_parameters = [
+            {
+                "type": "header",
+                "parameters": [
+                    {
+                        "type": "image",
+                        "media": {
+                            "mediaName": "template_media_name",
+                            "mediaUri": "https://www.cm.com/cdn/cm/cm.png",
+                            "mimeType": "image/png"
+                        }
+                    }
+                ]
+            },
+            {
+                "type": "body",
+                "parameters": [
+                    {
+                        "type": "text",
+                        "text": "test string"
+                    },
+                    {
+                        "type": "text",
+                        "text": "test string"
+                    }
+                ]
+            }]
+
+template = WhatsappTemplate(template_namespace, template_element_name, template_parameters)
+
+# Instantiate client with your own api-key
+client = TextClient(apikey=key)
+
+# Add message to queue
+client.AddWhatsappTemplateMessage(from_='pythonSDK', to=to, template=template)
+
+# Send message
+response = client.send()
+
+# Response is an object of type: https://www.w3schools.com/python/ref_requests_response.asp
+print(response.text)

Examples/Whatsapp_Template_with Media.py

@@ -0,0 +1,47 @@
+from CMText.TextClient import TextClient
+from CMText.WhatsappTemplate import WhatsappTemplate
+
+# Your api-Key
+key = 'Your-Key'
+
+# Recipients
+to = ['00123456789','00986837265']
+
+# Template
+template_namespace = "Your_Template_Namespace"
+template_element_name = "Your_Template_Name"
+template_parameters = [{
+            "type": "body",
+            "parameters": [
+                {
+                    "type": "text",
+                    "text": "Name"
+                },
+                {
+                    "type": "text",
+                    "text": "test"
+                },
+                {
+                    "type": "text",
+                    "text": "Order2"
+                },
+                {
+                    "type": "text",
+                    "text": "cm.com"
+                }
+            ]
+        }]
+
+template = WhatsappTemplate(template_namespace, template_element_name, template_parameters)
+
+# Instantiate client with your own api-key
+client = TextClient(apikey=key)
+
+# Add message to queue
+client.AddWhatsappTemplateMessage(from_='pythonSDK', to=to, template=template)
+
+# Send message
+response = client.send()
+
+# Response is an object of type: https://www.w3schools.com/python/ref_requests_response.asp
+print(response.text)

Examples/Whatsapp_Template_with_Components.py

@@ -55,6 +55,21 @@ By calling `AddRichMessage` and providing `Media`, message text, sender name, re
     response = client.send()
 ```
 
+## Sending a Whatsapp Template message
+By calling `AddWhatsappTemplateMessage` and providing `Template`, sender name, recipient phone number(s) you can queue multiple Whatsapp Template messages. Send them by calling `send`.
+
+```cs
+    template_namespace = "Your-Template-Namespace"
+    template_element_name = "Replace with Template Name"
+    template = WhatsappTemplate(template_namespace, template_element_name)
+    
+    client = TextClient(apikey=key)
+    client.AddWhatsappTemplateMessage(from_='pythonSDK', to=to, template=template)
+    response = client.send()
+```
+
+See Examples folder for more examples.
+
 ## Get the result
 Sending a message by calling `send` returns the response body. Response is of type: https://requests.readthedocs.io/en/master/user/quickstart/#response-content
 ```cs