POST
/
message

Authorizations

​
apikey
string
headerrequired

Authentication is done via apikey provided for your account

Include the following in your request header

apikey: "your_apikey_here"

Body

application/json

SendMessage model used as request body for sending messages

​
channel
enum<string>
required
Available options:
whatsapp
​
recipient
string
required

For channel whatsapp -> E.164 format without leading +

​
type
enum<string>
required
Available options:
text,
image,
document,
audio,
video,
location,
sticker,
contacts,
template,
richTemplate,
buttonTemplate
​
message
string

Content of the message.

type text - contains text content of the message

type image,document, audio, video, sticker - contains the file URL

type location - contains latitude and longitude in the format <latitude>:<longitude>

type template, richTemplate, buttonTemplate, contacts - field is NOT used

Required string length: 1 - 4096
​
caption
string

Describes the specified image, video or document media. Do not use with audio media.

Required string length: 1 - 1024
​
templateId
string

Template ID

mandatory for message type template, richTemplate and buttonTemplate

​
templateArgs
string[]

Template placeholder values in the same order as in the template.

mandatory for message type template, richTemplate and buttonTemplate

​
templateLanguage
string

Template Language

Language is defaulted to en (English), if not provided

mandatory for message type template, richTemplate and buttonTemplate only if the template is not in default language en

​
assign
object

If the customer (recipient) needs to be assigned to an agent

​
contacts
object

Contacts array for message type contacts

Response

200 - application/json

SendMessage model

​
status
string
​
statusText
string
​
messageId
string
Get Message TemplatesGet Message