Skip to main content
POST
Send an experimental interactive message

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

X-Device-Id
string

Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default. Can also be provided as device_id query parameter.

Example:

"my-device-id"

Body

application/json
phone
string
required

Phone number or full individual user or group JID.

body
string
required

Required nonblank text, maximum 4096 bytes.

buttons
object[]
required
Required array length: 1 - 10 elements

Maximum 256 bytes.

cards
object[]
Required array length: 2 - 10 elements

Response

Accepted for send; recipient rendering is unverified

code
string
Example:

"SUCCESS"

message
string
Example:

"Success"

results
object