Connectors Reference

tyntec WhatsApp Business

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

 

Status: Preview

Tier: Premium

Version: 2.0

 

Actions:

Name

Summary

StatusCheck (string id)

Status Check

SendWhatsApp (SendWhatsAppParameterBody body)

Send WhatsApp Template message

 

Triggers:

Name

Summary

incoming ([Optional]object body)

Incoming message

 

Objects:

Name

Summary

SendWhatsAppParameterBody

 

SendWhatsAppResponse

 

StatusCheckResponse

 

 

Actions:

StatusCheck

Summary: Status Check

Description: Check for status of your message

 

Syntax:

tyntecWhatsAppBusiness.StatusCheck (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(message ID)

messageId

True

 

Returns:

          Type:StatusCheckResponse

 

SendWhatsApp

Summary: Send WhatsApp Template message

Description: Send WhatsApp Template message

 

Syntax:

tyntecWhatsAppBusiness.SendWhatsApp (SendWhatsAppParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SendWhatsAppParameterBody

 

 

True

 

Returns:

          Type:SendWhatsAppResponse

 

Triggers:

Trigger incoming

Summary: Incoming message

Description: Triggers on Incoming message

 

Syntax:

tyntecWhatsAppBusiness.incoming ([Optional]object body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Here something ese

 

 

False

 

Returns:

 


 

SendWhatsAppParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

to

string

 

Receiver's phone number

channels

array of (string)

 

channels

whatsapp

Whatsapp

 

whatsapp

 

Whatsapp

Summary:

Description: whatsapp

 

          Properties:

Name

Type

Summary

from

string

 

Your WhatsApp Business Account Number

template

Template

 

template

contentType

string

 

contentType

 

Template

Summary:

Description: template

 

          Properties:

Name

Type

Summary

templateId

string

 

Your template id

language

Language

 

language

components

array of (ComponentsItem)

 

components

 

Language

Summary:

Description: language

 

          Properties:

Name

Type

Summary

policy

string

 

language policy

code

string

 

language code

 

ComponentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

type

parameters

array of (ParametersItem)

 

parameters

 

ParametersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

type of parameter

media

Media

 

media

text

string

 

text

 

Media

Summary:

Description: media

 

          Properties:

Name

Type

Summary

url

string

 

url

type

string

 

Type of used media

filename

string

 

filename

 


 

SendWhatsAppResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

messageId

string

 

messageId


 

StatusCheckResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

messageId

string

 

messageId

deliveryChannel

string

 

deliveryChannel

status

string

 

status

timestamp

string

 

timestamp