Skip to main content
POST
Send interactive message (buttons or link)

Authorizations

X-API-Key
string
header
required

Preferred. API key value directly.

Query Parameters

channelId
string

Channel id. Auto-selects when omitted.

Example:

"ch_123"

to
string

Recipient phone or WhatsApp BSUID.

Example:

"919876543210"

type
string

button (reply buttons) or cta_url (one link button).

Example:

"YOUR_TYPE"

body
string

Message text, up to 1024 characters.

Example:

"YOUR_BODY"

buttons
any[]

type=button only. 1 to 3 items { id, title }: title up to 20 characters, id (optional, up to 256 characters) comes back as button_id when tapped. Titles and ids must be different. JSON string for GET.

Example:
buttonLabel
string

type=cta_url only. Text on the link button, up to 20 characters.

Example:

"YOUR_BUTTONLABEL"

buttonUrl
string

type=cta_url only. The link to open (http or https).

Example:

"YOUR_BUTTONURL"

header
string

Header text, up to 60 characters. Not together with headerUrl.

Example:

"YOUR_HEADER"

headerType
string

image | video | document. Required with headerUrl.

Example:

"YOUR_HEADERTYPE"

headerUrl
string

Public URL of the header file.

Example:

"YOUR_HEADERURL"

headerFilename
string

File name shown for a document header.

Example:

"YOUR_HEADERFILENAME"

Footer text, up to 60 characters.

Example:

"YOUR_FOOTER"

Body

application/json
to
string
required

Recipient phone or WhatsApp BSUID.

Example:

"919876543210"

type
string
required

button (reply buttons) or cta_url (one link button).

Example:

"YOUR_TYPE"

body
string
required

Message text, up to 1024 characters.

Example:

"YOUR_BODY"

channelId
string

Channel id. Auto-selects when omitted.

Example:

"ch_123"

buttons
any[]

type=button only. 1 to 3 items { id, title }: title up to 20 characters, id (optional, up to 256 characters) comes back as button_id when tapped. Titles and ids must be different. JSON string for GET.

Example:
buttonLabel
string

type=cta_url only. Text on the link button, up to 20 characters.

Example:

"YOUR_BUTTONLABEL"

buttonUrl
string

type=cta_url only. The link to open (http or https).

Example:

"YOUR_BUTTONURL"

header
string

Header text, up to 60 characters. Not together with headerUrl.

Example:

"YOUR_HEADER"

headerType
string

image | video | document. Required with headerUrl.

Example:

"YOUR_HEADERTYPE"

headerUrl
string

Public URL of the header file.

Example:

"YOUR_HEADERURL"

headerFilename
string

File name shown for a document header.

Example:

"YOUR_HEADERFILENAME"

Footer text, up to 60 characters.

Example:

"YOUR_FOOTER"

Response

Success. Envelope: { success:true, data, message? }.

success
boolean
required
Example:

true

data
any
message
string
pagination
object
total
number