tyntec WhatsApp Business

  • Reference

Enables WhatsApp communication channel using the tyntec Conversations API to improve your communication ability

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name tyntec support
URL https://www.tyntec.com/get-help-support
Email support@tyntec.com
Connector Metadata
Publisher tyntec GmbH
Website https://www.tyntec.com
Privacy policy https://www.tyntec.com/data-privacy-statement
Categories Communication;Commerce

The "tyntec WhatsApp Business" connector enriches communication capabilities of Power Apps, Power Automation or Azure Logic Apps by enabling a one-way WhatsApp channel. It allows you to send notifications, alerts, memos, or customer engagement materials using the tyntec Conversations API.

Pre-requisites

You will need the following to proceed:

How to get API Key?

  1. Sign up/Login to your tyntec account
  2. Click on API settings
  3. In the API settings, click on New API KEY
  4. Copy the newly assigned API key

How to get WhatsApp Business Account Number?

  1. Follow up the guideline [on tyntec website](https://www.tyntec.com/docs/ whatsapp-business-api-account-information-get-started#toc--set-up-your-whatsapp-business-account-waba-)

How to get WhatsApp Message Template?

  1. Follow up the guideline on tyntec webiste

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
apikey securestring The apikey for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Send Free-form Audio Message

Sends Free-form audio message. Usable only in support window (24 hours after last message from customer)
Send Free-form Image Message

Sends Free-from Image Message. Usable only in support window (24 hours after last message from customer)
Send Whatsapp Free-form Contact Message

Sends contact message through WhatsApp. Usable only in support window (24 hours after last message from customer)
Send WhatsApp Free-form Document Message

Sends WhatsApp free-form document message. Usable only in support window (24 hours after last message from customer)
Send WhatsApp Free-form List Message

Sends WhatsApp list message. Usable only in support window (24 hours after last message from customer)
Send WhatsApp Free-form Location Message

Sends WhatsApp Location message. Usable only in support window (24 hours after last message from customer)
Send WhatsApp Free-form Product List

Sends WhatsApp product list. Usable only in support window (24 hours after last message from customer)
Send WhatsApp Free-form Quick Reply

Sends WhatsApp quick reply. Usable only in support window (24 hours after last message from customer)
Send WhatsApp Free-form Single Product

Sends WhatsApp single product message. Usable only in support window (24 hours after last message from customer)
Send WhatsApp Free-form Sticker Message

Sends WhatsApp sticker Message. Usable only in support window (24 hours after last message from customer)
Send WhatsApp Free-form Text Message

Sends simple free-form text message through WhatsApp. Usable only in support window (24 hours after last message from customer).
Send WhatsApp Free-form Video Message

Sends WhatsApp free-form video message. Usable only in support window (24 hours after last message from customer)
Send WhatsApp Template Document Message

Sends WhatsApp template document image. Usable anytime. Requires registered template.
Send WhatsApp Template Dynamic URL Button

Sends WhatsApp template dynamic URL button. Usable anytime. Requires registered template.
Send WhatsApp Template Image Message

Sends WhatsApp template message with image. Usable anytime. Requires registered template.
Send WhatsApp Template Location Message

Sends WhatsApp location template message. Usable anytime. Requires registered template.
Send WhatsApp Template message (deprecated) [DEPRECATED]

Send WhatsApp Template message (deprecated)
Send WhatsApp Template Quick Reply

This action sends WhatsApp template with quick reply. Usable anytime. Requires registered template.
Send WhatsApp Template Text Message

Sends WhatsApp template text message. Usable anytime. Requires registered template.
Send Whatsapp Template Video Message

Sends Whatsapp template video message. Usable anytime. Requires registered template.
Status Check

Check for status of your message
Status Check (deprecated) [DEPRECATED]

Check for status of your message (deprecated)
Validate your WABA number

Validate your WABA number
WhatsApp Free-Form Message (deprecated) [DEPRECATED]

Send free form message (deprecated)

Send Free-form Audio Message

Operation ID:
SendWhatsAppAudio

Sends Free-form audio message. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
url
 url string

url

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send Free-form Image Message

Operation ID:
SendsWhatsAppImage

Sends Free-from Image Message. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
url
 url string

url
caption
 caption string

caption

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send Whatsapp Free-form Contact Message

Operation ID:
SendWhatsAppContact

Sends contact message through WhatsApp. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
city
 city string

city
country
 country string

country
countryCode
 countryCode string

countryCode
street
 street string

street
type
 type string

type
zip
 zip string

zip
formattedName
 formattedName string

formattedName
lastName
 lastName string

lastName

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Free-form Document Message

Operation ID:
SendWhatsAppDocument

Sends WhatsApp free-form document message. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
url
 url string

url
caption
 caption string

caption
filename
 filename string

filename

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Free-form List Message

Operation ID:
SendWhatsAppList

Sends WhatsApp list message. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
type
 type string

type
text
 text string

text
type
 type string

type
text
 text string

text
type
 type string

type
text
 text string

text
title
 title string

title
title
 title string

title
payload
 payload string

payload
title
 title string

title
description
 description string

description

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Free-form Location Message

Operation ID:
SendWhatsAppLocation

Sends WhatsApp Location message. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
longitude
 longitude float

longitude
latitude
 latitude float

latitude
name
 name string

name
address
 address string

address

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Free-form Product List

Operation ID:
SendWhatsAppProductList

Sends WhatsApp product list. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
type
 type string

type
text
 text string

text
type
 type string

type
text
 text string

text
type
 type string

type
text
 text string

text
catalogId
 catalogId string

catalogId
productId
 productId string

productId

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Free-form Quick Reply

Operation ID:
SendWhatsAppQuickReply

Sends WhatsApp quick reply. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
type
 type string

type
text
 text string

text
type
 type string

type
text
 text string

text
type
 type string

type
text
 text string

text
payload
 payload string

payload
title
 title string

title

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Free-form Single Product

Operation ID:
SendWhatsAppProduct

Sends WhatsApp single product message. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
type
 type string

type
text
 text string

text
type
 type string

type
text
 text string

text
type
 type string

type
text
 text string

text
catalogId
 catalogId string

catalogId
productId
 productId string

productId

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Free-form Sticker Message

Operation ID:
SendWhatsAppSticker

Sends WhatsApp sticker Message. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
url
 url string

url

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Free-form Text Message

Operation ID:
SendWhatsAppText

Sends simple free-form text message through WhatsApp. Usable only in support window (24 hours after last message from customer).

Parameters

Name Key Required Type Description
from
 from True string

from
to
 to True string

to
text
 text True string

text

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Free-form Video Message

Operation ID:
SendWhatsAppVideo

Sends WhatsApp free-form video message. Usable only in support window (24 hours after last message from customer)

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
url
 url string

url
caption
 caption string

caption

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Template Document Message

Operation ID:
SendWhatsAppTemplateDocument

Sends WhatsApp template document image. Usable anytime. Requires registered template.

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
templateId
 templateId string

templateId
templateLanguage
 templateLanguage string

templateLanguage
type
 type string

type
url
 url string

url
type
 type string

type
text
 text string

text

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Template Dynamic URL Button

Operation ID:
SendWhatsAppTemplateDynamicButton

Sends WhatsApp template dynamic URL button. Usable anytime. Requires registered template.

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
templateId
 templateId string

templateId
templateLanguage
 templateLanguage string

templateLanguage
type
 type string

type
text
 text string

text
type
 type string

type
index
 index integer

index
text
 text string

text

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Template Image Message

Operation ID:
SendWhatsAppTemplateImage

Sends WhatsApp template message with image. Usable anytime. Requires registered template.

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
templateId
 templateId string

templateId
templateLanguage
 templateLanguage string

templateLanguage
type
 type string

type
url
 url string

url
text
 text string

text

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Template Location Message

Operation ID:
SendWhatsAppTemplateLocation

Sends WhatsApp location template message. Usable anytime. Requires registered template.

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
templateId
 templateId string

templateId
templateLanguage
 templateLanguage string

templateLanguage
longitude
 longitude float

longitude
latitude
 latitude float

latitude
name
 name string

name
address
 address string

address
type
 type string

type
text
 text string

text

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Template message (deprecated) [DEPRECATED]

Operation ID:
SendWhatsApp

Send WhatsApp Template message (deprecated)

Parameters

Name Key Required Type Description
to
 to True string

Receiver's phone number
channels
 channels True array of string

channels
from
 from True string

Your WhatsApp Business Account Number
templateId
 templateId True string

Your template id
language-policy
 policy True string

language policy
language-code
 code True string

language code
type
 type True string

type
type
 type string

type of the parameter
subType
 subType string

Used for Call to action buttons
url
 url string

url
type
 type string

Type of used media
filename
 filename string

filename
text
 text string

text

Returns

Name Path Type Description
messageId
 messageId string

messageId

Send WhatsApp Template Quick Reply

Operation ID:
SendWhatsAppTemplateQuickReply

This action sends WhatsApp template with quick reply. Usable anytime. Requires registered template.

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
templateId
 templateId string

templateId
templateLanguage
 templateLanguage string

templateLanguage
type
 type string

type
text
 text string

text
type
 type string

type
index
 index integer

index
payload
 payload string

payload

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send WhatsApp Template Text Message

Operation ID:
SendWhatsAppTemplateText

Sends WhatsApp template text message. Usable anytime. Requires registered template.

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
templateId
 templateId string

templateId
templateLanguage
 templateLanguage string

templateLanguage
type
 type string

type
text
 text string

text
type
 type string

type
text
 text string

text

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Send Whatsapp Template Video Message

Operation ID:
SendWhatsAppTemplateVideo

Sends Whatsapp template video message. Usable anytime. Requires registered template.

Parameters

Name Key Required Type Description
from
 from string

from
to
 to string

to
channel
 channel string

channel
contentType
 contentType string

contentType
templateId
 templateId string

templateId
templateLanguage
 templateLanguage string

templateLanguage
type
 type string

type
url
 url string

url
type
 type string

type
text
 text string

text

Returns

Name Path Type Description
messageId
 messageId string

messageId
timestamp
 timestamp string

timestamp

Status Check

Operation ID:
StatusCheckV3

Check for status of your message

Parameters

Name Key Required Type Description
Message ID
 messageId True string

Message ID

Returns

Name Path Type Description
messageId
 messageId string

messageId
status
 status string

status
timestamp
 timestamp string

timestamp

Status Check (deprecated) [DEPRECATED]

Operation ID:
StatusCheck

Check for status of your message (deprecated)

Parameters

Name Key Required Type Description
message ID
 id True string

messageId

Returns

Name Path Type Description
messageId
 messageId string

messageId
deliveryChannel
 deliveryChannel string

deliveryChannel
status
 status string

status
timestamp
 timestamp string

timestamp

Validate your WABA number

Operation ID:
TestPhoneNumber

Validate your WABA number

Parameters

Name Key Required Type Description
WhatsAppBusinessNumber
 whatsAppBusinessNumber True string

WABA for validation

Returns

Name Path Type Description
phoneNumber
 phoneNumber string

Your Number
displayPhoneNumber
 displayPhoneNumber string

The displayed version of the phone number
verifiedName
 verifiedName string

The verified name
qualityRating
 qualityRating string

Your quality rating
status
 status string

status
whatsAppAccountId
 whatsAppAccountId string

Your WhatsApp account ID
accountName
 managedBy.accountName string

Your account name
accountName
 messagingVia.accountName string

The managinng account name
messagingTier
 messagingTier string

Your messaging tier
score
 qualityScore.score string

Your score

WhatsApp Free-Form Message (deprecated) [DEPRECATED]

Operation ID:
SendFreeformMessage

Send free form message (deprecated)

Parameters

Name Key Required Type Description
to
 to string

to
channels
 channels True array of string

channels
from
 from string

from
type
 type string

type
url
 url string

url
caption
 caption string

caption
contentType
 contentType string

contentType
text
 text string

text

Returns

Name Path Type Description
messageId
 messageId string

messageId

Triggers

Incoming message

Triggers on Incoming message
Incoming message (deprecated) [DEPRECATED]

Triggers on Incoming message (deprecated)

Incoming message

Operation ID:
IncomingV2

Triggers on Incoming message

Parameters

Name Key Required Type Description
Your WhatsApp Business Account Number
 WABA True string

Your WhatsApp Business Account Number

Incoming message (deprecated) [DEPRECATED]

Operation ID:
Incoming

Triggers on Incoming message (deprecated)