Skip to content

Commit b66a15e

Browse files
ridleesridlees
authored
Tyntec viber (microsoft#416)
* added tyntec-viber * remove intro * Fix: Brand color
1 parent 4c536c3 commit b66a15e

File tree

3 files changed

+244
-0
lines changed

3 files changed

+244
-0
lines changed

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## Tyntec Conversation API - Send Viber
2+
3+
Tyntec Conversation API allows you to send customized Viber messages.
4+
5+
### User Cases of this connector
6+
- Use this connector in PowerApps Workflows (great for Marketing, CRM or Sales)
7+
- Send SMS messages using Azure Logic Apps
8+
- Build SMS support in your Microsoft Power Automate automatizations
9+
10+
And many more!
11+
12+
13+
## Pre-requisites
14+
You will need the following to proceed:
15+
- A Microsoft Power Apps or Power Automate plan with custom connector feature
16+
- [tyntec API Key](http://my.tyntec.com/api-settings)
17+
- [Viber Service ID](https://www.tyntec.com/viber-business-messages#contact)
18+
19+
## Supported requests
20+
- **Send_Viber** using tyntec Conversation API [reference](https://api.tyntec.com/reference/#conversations-send-messages-send-a-message)
21+
- To make a successful request, please, populate the followings fields:
22+
- **apikey** - your tyntec API key
23+
- **to** - receiver's phone number in _international_ form without leading 00 (_E.g. 4989202451100_)
24+
- **from** - your Viber Service ID
25+
- **contentType** - content type of your message, use **text**
26+
- **channels key item** - used tyntec Conversation API channel, use **viber**
27+
- **text** - text of your Viber message
28+
- **Status_Check**
29+
- To make a successful status check, please, provide the connector with the following values
30+
- **apikey** - your tyntec API key
31+
- **id** - messageID of your message (_returned after each request_)
32+
33+
34+
## How to get API key
35+
Please [sign up for a free account](https://www.tyntec.com/create-account). In your account, select the [API settings](http://my.tyntec.com/api-settings) and copy your API key.
36+
37+
## How to get Viber Service ID
38+
Please, fill our [form](https://www.tyntec.com/viber-business-messages#contact). Tyntec will guide you through the whole process.
39+
40+
## Deployment instructions
41+
Please use [these instructions](https://docs.microsoft.com/en-us/connectors/custom-connectors/paconn-cli) to deploy this connector as a custom connector in Microsoft Power Automate and Power Apps.
42+

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

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"title": "tyntec-viber",
5+
"description": "Send a Viber message using the tyntec Conversation API and retrieve its Status (accepted/delivered/failed) using Status_check.",
6+
"contact": {
7+
"name": "tyntec support",
8+
"url": "https://www.tyntec.com/get-help-support",
9+
"email": "support@tyntec.com"
10+
},
11+
"version": "1.0"
12+
},
13+
"host": "api.tyntec.com",
14+
"basePath": "/",
15+
"schemes": [
16+
"https"
17+
],
18+
"consumes": [],
19+
"produces": [],
20+
"paths": {
21+
"/chat-api/v2/messages/": {
22+
"post": {
23+
"responses": {
24+
"default": {
25+
"description": "default",
26+
"schema": {
27+
"type": "object",
28+
"properties": {
29+
"messageId": {
30+
"type": "string",
31+
"description": "messageId"
32+
}
33+
}
34+
}
35+
}
36+
},
37+
"summary": "Send Viber Message",
38+
"description": "Send Viber Message",
39+
"operationId": "Send_Viber",
40+
"parameters": [
41+
{
42+
"name": "apikey",
43+
"in": "header",
44+
"required": true,
45+
"type": "string",
46+
"description": "Your tyntec API key with the Viber Service ID enabled.",
47+
"x-ms-summary": "A tyntec API key"
48+
},
49+
{
50+
"name": "body",
51+
"in": "body",
52+
"required": true,
53+
"schema": {
54+
"type": "object",
55+
"properties": {
56+
"to": {
57+
"type": "string",
58+
"description": "Receiver's phone number",
59+
"title": "to"
60+
},
61+
"channels": {
62+
"type": "array",
63+
"items": {
64+
"type": "string",
65+
"description": "The tyntec conversation API channel. Use Viber",
66+
"title": "Channel",
67+
"default": "viber"
68+
},
69+
"description": "channels"
70+
},
71+
"viber": {
72+
"type": "object",
73+
"properties": {
74+
"from": {
75+
"type": "string",
76+
"description": "Your Viber Service ID",
77+
"title": "from"
78+
},
79+
"components": {
80+
"type": "array",
81+
"items": {
82+
"type": "object",
83+
"properties": {
84+
"type": {
85+
"type": "string",
86+
"description": "The type of your message. Use default text.",
87+
"title": "type",
88+
"default": "text"
89+
},
90+
"text": {
91+
"type": "string",
92+
"description": "Your custom text for Viber message",
93+
"title": "text"
94+
}
95+
},
96+
"required": [
97+
"text",
98+
"type"
99+
]
100+
},
101+
"description": "components"
102+
}
103+
},
104+
"description": "viber",
105+
"required": [
106+
"components",
107+
"from"
108+
]
109+
}
110+
},
111+
"required": [
112+
"to",
113+
"channels",
114+
"viber"
115+
]
116+
}
117+
}
118+
]
119+
}
120+
},
121+
"/chat-api/v2/messages/{id}/status": {
122+
"get": {
123+
"responses": {
124+
"default": {
125+
"description": "default",
126+
"schema": {
127+
"type": "object",
128+
"properties": {
129+
"messageId": {
130+
"type": "string",
131+
"description": "messageId"
132+
},
133+
"deliveryChannel": {
134+
"type": "string",
135+
"description": "deliveryChannel"
136+
},
137+
"status": {
138+
"type": "string",
139+
"description": "status"
140+
},
141+
"timestamp": {
142+
"type": "string",
143+
"description": "timestamp"
144+
}
145+
}
146+
}
147+
}
148+
},
149+
"summary": "Status Check",
150+
"description": "Check for status of your message",
151+
"operationId": "Status_Check",
152+
"parameters": [
153+
{
154+
"name": "id",
155+
"in": "path",
156+
"required": true,
157+
"type": "string",
158+
"description": "Message ID",
159+
"x-ms-summary": "ID of the checked Message"
160+
},
161+
{
162+
"name": "apikey",
163+
"in": "header",
164+
"required": true,
165+
"type": "string",
166+
"description": "Your tyntec API key",
167+
"x-ms-summary": "Your tyntec API key"
168+
}
169+
]
170+
}
171+
}
172+
},
173+
"x-ms-connector-metadata": [
174+
{
175+
"propertyName": "Website",
176+
"propertyValue": "https://www.tyntec.com"
177+
},
178+
{
179+
"propertyName": "Privacy policy",
180+
"propertyValue": "https://www.tyntec.com/data-privacy-statement"
181+
},
182+
{
183+
"propertyName": "Categories",
184+
"propertyValue": "Communication;Marketing"
185+
}
186+
],
187+
"definitions": {},
188+
"parameters": {},
189+
"responses": {},
190+
"securityDefinitions": {},
191+
"security": [],
192+
"tags": []
193+
}

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"properties": {
3+
"connectionParameters": {},
4+
"iconBrandColor": "#F99831",
5+
"capabilities": [],
6+
"publisher": "tyntec GmbH",
7+
"stackOwner": "tyntec GmbH"
8+
}
9+
}

0 commit comments

Comments
 (0)