Skip to content

Commit 5bd9f8d

Browse files
ridleesridlees
authored
tyntec WhatsApp Business (#439)
* added tyntec-WA * remove intro * add icon.png * replaced icon.png * Delete icon.png * Add icon.png * Delete icon.png * Add Icon.png * Delete Icon.png * Fix: Brand color * Added: API key requirement * Changes to the title * minor update * Update: Readme * production version * Returned: default responses Custom responses don't show consistently in Designer * responses update * Responses fix * update Readme * Update apiDefinition.swagger.json
1 parent 89a1158 commit 5bd9f8d

File tree

3 files changed

+88
-64
lines changed

3 files changed

+88
-64
lines changed

‎certified-connectors/tyntec-WA/README.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
## Tyntec Conversation API - Send template WhatsApp message
1+
## Tyntec Conversations API - Send template WhatsApp message
22

3-
Tyntec Conversation API allows you to send template WhatsApp messages.
3+
Tyntec Conversations API allows you to send template WhatsApp messages.
44

5-
### User Cases of this connector
5+
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.
6+
7+
### Use Cases of this connector
68
- Use this connector in PowerApps Workflows (great for Marketing, CRM or Sales)
79
- Send SMS messages using Azure Logic Apps
810
- Build SMS support in your Microsoft Power Automate automatizations
@@ -19,23 +21,19 @@ You will need the following to proceed:
1921

2022

2123
## Supported requests
22-
- **Send_WhatsApp** using tyntec Conversation API [reference](https://api.tyntec.com/reference/#conversations-send-messages-send-a-message)
24+
- **Send WhatsApp** using tyntec Conversations API [reference](https://api.tyntec.com/reference/#conversations-send-messages-send-a-message)
2325
- To make a successful request, please, populate the followings fields:
24-
- **apikey** - your tyntec API key
2526
- **to** - receiver's phone number in _international_ form without leading 00 (_E.g. 4989202451100_)
2627
- **from** - your WhatsApp Business account number number
2728
- **templateId** - the name of your approved template
28-
- **contentType** - content type of your message, use **body**
2929
- **language-policy** - language policy of your template
3030
- **language-code** - language code of your template
31-
- **channels key item** - used tyntec Conversation API channel, use **whatsapp**
3231
- **parameter-type** - use **text**
3332
- **parameter-text** - input your parameter
3433
- _if your template uses more parameters, repeat **parameter-type** and **parameter-text** for each parameter your template requires_
35-
36-
- **Status_Check**
34+
35+
- **Status Check**
3736
- To make a successful status check, please, provide the connector with the following values
38-
- **apikey** - your tyntec API key
3937
- **id** - messageID of your message (_returned after each request_)
4038

4139

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

Lines changed: 64 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
22
"swagger": "2.0",
33
"info": {
4-
"title": "tyntec-wa",
5-
"description": "Send a WhatsApp template message using the tyntec conversation API. You can also use Status_check to check status (accepted/delivered/failed)",
4+
"title": "tyntec WhatsApp Business",
5+
"description": "Enables WhatsApp communication channel using the tyntec Conversations API to improve your communication ability",
66
"contact": {
77
"name": "tyntec support",
88
"url": "https://www.tyntec.com/get-help-support",
99
"email": "support@tyntec.com"
1010
},
11-
"version": "1.0"
11+
"version": "1.1"
1212
},
1313
"host": "api.tyntec.com",
1414
"basePath": "/",
@@ -18,87 +18,90 @@
1818
"consumes": [],
1919
"produces": [],
2020
"paths": {
21-
"/chat-api/v2/messages/": {},
2221
"/chat-api/v2/messages/{id}/status": {
2322
"get": {
24-
"responses": {
25-
"default": {
26-
"description": "default",
23+
"responses": {
24+
"202": {
25+
"description": "Returned when the operation successfully connects to Conversations API",
2726
"schema": {
2827
"type": "object",
2928
"properties": {
3029
"messageId": {
3130
"type": "string",
32-
"description": "messageId"
31+
"description": "messageId",
32+
"x-ms-visibility": "important"
3333
},
3434
"deliveryChannel": {
3535
"type": "string",
36-
"description": "deliveryChannel"
36+
"description": "deliveryChannel",
37+
"x-ms-visibility": "important"
3738
},
3839
"status": {
3940
"type": "string",
40-
"description": "status"
41+
"description": "status",
42+
"x-ms-visibility": "important"
4143
},
4244
"timestamp": {
4345
"type": "string",
44-
"description": "timestamp"
46+
"description": "timestamp",
47+
"x-ms-visibility": "important"
4548
}
4649
}
4750
}
51+
},
52+
"404":{
53+
"description": "No message was found on given ID"
54+
},
55+
"403":{
56+
"description": "Invalid authentication credentials"
4857
}
4958
},
50-
"summary": "Status_Check",
51-
"description": "Check for status of your Message on given MessageID. Returned response holds the status (delivered/accepted/failed) in the status field.",
52-
"operationId": "Status_Check",
59+
"summary": "Status Check",
60+
"description": "Check for status of your message",
61+
"operationId": "StatusCheck",
5362
"parameters": [
5463
{
5564
"name": "id",
5665
"in": "path",
5766
"required": true,
5867
"type": "string",
59-
"description": "To check status of your message, you need to provide tyntec Conversation API with ID",
60-
"x-ms-summary": "ID of your message"
61-
},
62-
{
63-
"name": "apikey",
64-
"in": "header",
65-
"required": true,
66-
"type": "string",
67-
"description": "Your tyntec Conversation API key received from https://my.tyntec.com/api-settings.",
68-
"x-ms-summary": "Your tyntec API key"
68+
"description": "messageId",
69+
"x-ms-summary": "message ID",
70+
"x-ms-url-encoding": "single"
6971
}
7072
]
7173
}
7274
},
73-
"/api.tyntec.com/chat-api/v2/messages": {},
7475
"/chat-api/v2/messages": {
7576
"post": {
7677
"responses": {
77-
"default": {
78-
"description": "default",
78+
"2O2": {
79+
"description": "Returned when the operation successfully connects to Conversations API",
7980
"schema": {
8081
"type": "object",
8182
"properties": {
8283
"messageId": {
8384
"type": "string",
84-
"description": "messageId"
85+
"description": "messageId",
86+
"x-ms-visibility": "important"
8587
}
8688
}
8789
}
90+
},
91+
"400": {
92+
"description": "There was an issue with your channel."
93+
},
94+
"401": {
95+
"description": "The Viber Service ID or WhatsApp Business Account Number is not authorized with used API key."
96+
},
97+
"403":{
98+
"description": "You attempting to use a number that is not assigned to your account"
8899
}
89100
},
90101
"summary": "Send WhatsApp Template message",
91102
"description": "Send WhatsApp Template message",
92-
"operationId": "Send_WhatsApp",
103+
"operationId": "SendWhatsApp",
93104
"parameters": [
94-
{
95-
"name": "apikey",
96-
"in": "header",
97-
"required": true,
98-
"type": "string",
99-
"description": "Your tyntec Conversation API key received from https://my.tyntec.com/api-settings.",
100-
"x-ms-summary": "Your tyntec API key"
101-
},
102105
{
103106
"name": "body",
104107
"in": "body",
@@ -117,7 +120,8 @@
117120
"type": "string",
118121
"description": "tyntec Conversation API channel",
119122
"title": "Channel",
120-
"default": "whatsapp"
123+
"default": "whatsapp",
124+
"x-ms-visibility": "internal"
121125
},
122126
"description": "channels"
123127
},
@@ -142,13 +146,13 @@
142146
"properties": {
143147
"policy": {
144148
"type": "string",
145-
"description": "policy (use deterministic)",
149+
"description": "language policy",
146150
"title": "language-policy",
147151
"default": "deterministic"
148152
},
149153
"code": {
150154
"type": "string",
151-
"description": "code",
155+
"description": "language code",
152156
"title": "language-code",
153157
"default": "en"
154158
}
@@ -166,9 +170,10 @@
166170
"properties": {
167171
"type": {
168172
"type": "string",
169-
"description": "type (use body)",
173+
"description": "type",
170174
"title": "type",
171-
"default": "body"
175+
"default": "body",
176+
"x-ms-visibility": "internal"
172177
},
173178
"parameters": {
174179
"type": "array",
@@ -204,9 +209,10 @@
204209
},
205210
"contentType": {
206211
"type": "string",
207-
"description": "contentType (use template)",
212+
"description": "contentType",
208213
"title": "contentType",
209-
"default": "template"
214+
"default": "template",
215+
"x-ms-visibility": "internal"
210216
}
211217
},
212218
"description": "whatsapp",
@@ -228,6 +234,18 @@
228234
}
229235
}
230236
},
237+
"definitions": {},
238+
"parameters": {},
239+
"responses": {},
240+
"securityDefinitions": {
241+
"api_key": {
242+
"type": "apiKey",
243+
"in": "header",
244+
"name": "apikey"
245+
}
246+
},
247+
"security": [],
248+
"tags": [],
231249
"x-ms-connector-metadata": [
232250
{
233251
"propertyName": "Website",
@@ -241,11 +259,5 @@
241259
"propertyName": "Categories",
242260
"propertyValue": "Communication;Commerce"
243261
}
244-
],
245-
"definitions": {},
246-
"parameters": {},
247-
"responses": {},
248-
"securityDefinitions": {},
249-
"security": [],
250-
"tags": []
251-
}
262+
]
263+
}

‎certified-connectors/tyntec-WA/apiProperties.json‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
11
{
22
"properties": {
3-
"connectionParameters": {},
4-
"iconBrandColor": "#F99831",
3+
"connectionParameters": {
4+
"api_key": {
5+
"type": "securestring",
6+
"uiDefinition": {
7+
"displayName": "apikey",
8+
"description": "The apikey for this api",
9+
"tooltip": "Provide your apikey",
10+
"constraints": {
11+
"tabIndex": 2,
12+
"clearText": false,
13+
"required": "true"
14+
}
15+
}
16+
}
17+
},
18+
"iconBrandColor": "#F8981D",
519
"capabilities": [],
620
"publisher": "tyntec GmbH",
721
"stackOwner": "tyntec GmbH"

0 commit comments

Comments
 (0)