curl --request POST \
  --url https://api.wsapi.chat/messages/buttons \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "to": "1234567890@s.whatsapp.net",
  "text": "Can we confirm your appointment for tomorrow at 10:00?",
  "footer": "Reply with a button",
  "buttons": [
    {
      "id": "confirm",
      "text": "Confirm"
    },
    {
      "id": "reschedule",
      "text": "Reschedule"
    },
    {
      "id": "cancel",
      "text": "Cancel"
    }
  ]
}
'

{
  "id": "01234567890123456"
}

{
  "status": 400,
  "detail": "invalid request body"
}

{
  "status": 401,
  "detail": "unauthorized"
}

{
  "status": 409,
  "detail": "device not paired"
}

{
  "status": 503,
  "detail": "instance not available"
}

Messages

Send a buttons message (beta)

Beta. Send a message with 1 to 3 buttons. The response contains the message ID.

Button types can be mixed in one message:

reply (default) — sends a reply back to you. Needs an id, unique within the message. Tapping it produces a message event of type button_reply with the button’s id and text. This is the only button type that produces an event.
url — opens url on the recipient’s device.
copy — copies copyCode to the recipient’s clipboard.
call — calls phoneNumber from the recipient’s device.

Header and footer are text only. Set aiLabel to show WhatsApp’s “AI” badge on the message; it applies to 1:1 chats only and is ignored in groups.

Rendering: buttons render on phones and on WhatsApp Web.

Interactive messages rely on WhatsApp behaviour that is not an official contract and may change without notice. WhatsApp accepts the message even if a client does not render it, so a 201 response does not guarantee the buttons are displayed.

Limits mirror the WhatsApp Cloud API: text up to 1024 characters, header and footer up to 60, button text up to 20, button id up to 256.

POST

messages

buttons

curl --request POST \
  --url https://api.wsapi.chat/messages/buttons \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "to": "1234567890@s.whatsapp.net",
  "text": "Can we confirm your appointment for tomorrow at 10:00?",
  "footer": "Reply with a button",
  "buttons": [
    {
      "id": "confirm",
      "text": "Confirm"
    },
    {
      "id": "reschedule",
      "text": "Reschedule"
    },
    {
      "id": "cancel",
      "text": "Cancel"
    }
  ]
}
'

{
  "id": "01234567890123456"
}

{
  "status": 400,
  "detail": "invalid request body"
}

{
  "status": 401,
  "detail": "unauthorized"
}

{
  "status": 409,
  "detail": "device not paired"
}

{
  "status": 503,
  "detail": "instance not available"
}

Authorizations

X-Api-Key

string

header

required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

X-Instance-Id

string

default:{{instanceId}}

required

The ID of the WhatsApp instance to use

Body

application/json

string

required

text

string

required

Message body

Maximum string length: 1024

buttons

object[]

required

Buttons to show. Types can be mixed. Reply button ids must be unique within the message.

Required array length: 1 - 3 elements

Show child attributes

header

string

Optional header text shown above the body

Maximum string length: 60

footer

string

Optional footer text shown below the body

Maximum string length: 60

aiLabel

boolean

default:false

Show WhatsApp's "AI" badge on the message. 1:1 chats only; ignored in groups.

Response

Resource created

string

ID of the created resource

Overview

Reference

Endpoints

Send a buttons message (beta)

Authorizations

Headers

Body

Response