tyntec WhatsApp Business

certified-connectors/tyntec-WA/README.md

@@ -1,8 +1,10 @@
-## Tyntec Conversation API - Send template WhatsApp message
+## Tyntec Conversations API - Send template WhatsApp message
 
-Tyntec Conversation API allows you to send template WhatsApp messages.
+Tyntec Conversations API allows you to send template WhatsApp messages.
 
-### User Cases of this connector
+Create conversational experiences with your customers right on the world’s number one messaging app (over 2 billion monthly active users). Leveraging WhatsApp’s end-to-end encryption and rich features (images, videos, audios, documents, interactive buttons, etc.), you can remove friction from customer onboarding, notifications and support communication.
+
+### Use Cases of this connector
 -   Use this connector in PowerApps Workflows (great for Marketing, CRM or Sales)
 -   Send SMS messages using Azure Logic Apps
 -   Build SMS support in your Microsoft Power Automate automatizations
@@ -19,23 +21,19 @@ You will need the following to proceed:
 
 
 ## Supported requests
--   **Send_WhatsApp** using tyntec Conversation API [reference](https://api.tyntec.com/reference/#conversations-send-messages-send-a-message)
+-   **Send WhatsApp** using tyntec Conversations API [reference](https://api.tyntec.com/reference/#conversations-send-messages-send-a-message)
     -   To make a successful request, please, populate the followings fields:
-        -   **apikey**  - your tyntec API key
         -   **to** - receiver's phone number in _international_ form without leading 00 (_E.g. 4989202451100_)
         -   **from** - your WhatsApp Business account number number
         -   **templateId** - the name of your approved template
-        -   **contentType** - content type of your message, use **body**
         -   **language-policy** - language policy of your template
         -   **language-code** - language code of your template
-        -   **channels key item** - used tyntec Conversation API channel, use **whatsapp**
         -   **parameter-type** - use **text**
         -   **parameter-text** - input your parameter
         -   _if your template uses more parameters, repeat **parameter-type** and **parameter-text** for each parameter your template requires_
-
-- **Status_Check**
+        
+- **Status Check**
     -   To make a successful status check, please, provide the connector with the following values
-        -   **apikey**  - your tyntec API key
         -   **id** - messageID of your message (_returned after each request_)
 
 

certified-connectors/tyntec-WA/apiDefinition.swagger.json

@@ -1,14 +1,14 @@
 {
   "swagger": "2.0",
   "info": {
-    "title": "tyntec-wa",
-    "description": "Send a WhatsApp template message using the tyntec conversation API. You can also use Status_check to check status (accepted/delivered/failed)",
+    "title": "tyntec WhatsApp Business",
+    "description": "Enables WhatsApp communication channel using the tyntec Conversations API to improve your communication ability",
     "contact": {
       "name": "tyntec support",
       "url": "https://www.tyntec.com/get-help-support",
       "email": "support@tyntec.com"
     },
-    "version": "1.0"
+    "version": "1.1"
   },
   "host": "api.tyntec.com",
   "basePath": "/",
@@ -18,87 +18,90 @@
   "consumes": [],
   "produces": [],
   "paths": {
-    "/chat-api/v2/messages/": {},
     "/chat-api/v2/messages/{id}/status": {
       "get": {
-        "responses": {
-          "default": {
-            "description": "default",
+      "responses": {
+          "202": {
+            "description": "Returned when the operation successfully connects to Conversations API",
             "schema": {
               "type": "object",
               "properties": {
                 "messageId": {
                   "type": "string",
-                  "description": "messageId"
+                  "description": "messageId",
+                  "x-ms-visibility": "important"
                 },
                 "deliveryChannel": {
                   "type": "string",
-                  "description": "deliveryChannel"
+                  "description": "deliveryChannel",
+                  "x-ms-visibility": "important"
                 },
                 "status": {
                   "type": "string",
-                  "description": "status"
+                  "description": "status",
+                  "x-ms-visibility": "important"
                 },
                 "timestamp": {
                   "type": "string",
-                  "description": "timestamp"
+                  "description": "timestamp",
+                  "x-ms-visibility": "important"
                 }
               }
             }
+          },
+          "404":{
+            "description": "No message was found on given ID"
+          },
+          "403":{
+            "description": "Invalid authentication credentials"
           }
         },
-        "summary": "Status_Check",
-        "description": "Check for status of your Message on given MessageID. Returned response holds the status (delivered/accepted/failed) in the status field.",
-        "operationId": "Status_Check",
+        "summary": "Status Check",
+        "description": "Check for status of your message",
+        "operationId": "StatusCheck",
         "parameters": [
           {
             "name": "id",
             "in": "path",
             "required": true,
             "type": "string",
-            "description": "To check status of your message, you need to provide tyntec Conversation API with ID",
-            "x-ms-summary": "ID of your message"
-          },
-          {
-            "name": "apikey",
-            "in": "header",
-            "required": true,
-            "type": "string",
-            "description": "Your tyntec Conversation API key received from https://my.tyntec.com/api-settings.",
-            "x-ms-summary": "Your tyntec API key"
+            "description": "messageId",
+            "x-ms-summary": "message ID",
+            "x-ms-url-encoding": "single"
           }
         ]
       }
     },
-    "/api.tyntec.com/chat-api/v2/messages": {},
     "/chat-api/v2/messages": {
       "post": {
         "responses": {
-          "default": {
-            "description": "default",
+          "2O2": {
+            "description": "Returned when the operation successfully connects to Conversations API",
             "schema": {
               "type": "object",
               "properties": {
                 "messageId": {
                   "type": "string",
-                  "description": "messageId"
+                  "description": "messageId",
+                  "x-ms-visibility": "important"
                 }
               }
             }
+          },
+          "400": {
+            "description": "There was an issue with your channel."
+          },
+          "401": {
+            "description": "The Viber Service ID or WhatsApp Business Account Number is not authorized with used API key."
+          },
+          "403":{
+            "description": "You attempting to use a number that is not assigned to your account"
           }
         },
         "summary": "Send WhatsApp Template message",
         "description": "Send WhatsApp Template message",
-        "operationId": "Send_WhatsApp",
+        "operationId": "SendWhatsApp",
         "parameters": [
-          {
-            "name": "apikey",
-            "in": "header",
-            "required": true,
-            "type": "string",
-            "description": "Your tyntec Conversation API key received from https://my.tyntec.com/api-settings.",
-            "x-ms-summary": "Your tyntec API key"
-          },
           {
             "name": "body",
             "in": "body",
@@ -117,7 +120,8 @@
                     "type": "string",
                     "description": "tyntec Conversation API channel",
                     "title": "Channel",
-                    "default": "whatsapp"
+                    "default": "whatsapp",
+                    "x-ms-visibility": "internal"
                   },
                   "description": "channels"
                 },
@@ -142,13 +146,13 @@
                           "properties": {
                             "policy": {
                               "type": "string",
-                              "description": "policy (use deterministic)",
+                              "description": "language policy",
                               "title": "language-policy",
                               "default": "deterministic"
                             },
                             "code": {
                               "type": "string",
-                              "description": "code",
+                              "description": "language code",
                               "title": "language-code",
                               "default": "en"
                             }
@@ -166,9 +170,10 @@
                             "properties": {
                               "type": {
                                 "type": "string",
-                                "description": "type (use body)",
+                                "description": "type",
                                 "title": "type",
-                                "default": "body"
+                                "default": "body",
+                                "x-ms-visibility": "internal"
                               },
                               "parameters": {
                                 "type": "array",
@@ -204,9 +209,10 @@
                     },
                     "contentType": {
                       "type": "string",
-                      "description": "contentType (use template)",
+                      "description": "contentType",
                       "title": "contentType",
-                      "default": "template"
+                      "default": "template",
+                      "x-ms-visibility": "internal"
                     }
                   },
                   "description": "whatsapp",
@@ -228,6 +234,18 @@
       }
     }
   },
+  "definitions": {},
+  "parameters": {},
+  "responses": {},
+  "securityDefinitions": {
+    "api_key": {
+      "type": "apiKey",
+      "in": "header",
+      "name": "apikey"
+    }
+  },
+  "security": [],
+  "tags": [],
   "x-ms-connector-metadata": [
     {
       "propertyName": "Website",
@@ -241,11 +259,5 @@
       "propertyName": "Categories",
       "propertyValue": "Communication;Commerce"
     }
-  ],
-  "definitions": {},
-  "parameters": {},
-  "responses": {},
-  "securityDefinitions": {},
-  "security": [],
-  "tags": []
-}
+  ]
+}

certified-connectors/tyntec-WA/apiProperties.json

@@ -1,7 +1,21 @@
 {
   "properties": {
-    "connectionParameters": {},
-    "iconBrandColor": "#F99831",
+    "connectionParameters": {
+      "api_key": {
+        "type": "securestring",
+        "uiDefinition": {
+          "displayName": "apikey",
+          "description": "The apikey for this api",
+          "tooltip": "Provide your apikey",
+          "constraints": {
+            "tabIndex": 2,
+            "clearText": false,
+            "required": "true"
+          }
+        }
+      }
+    },
+    "iconBrandColor": "#F8981D",
     "capabilities": [],
     "publisher": "tyntec GmbH",
     "stackOwner": "tyntec GmbH"