Skip to main content
POST
Send buttons

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
number
string
required

Recipient phone in E.164 without +, or a JID.

Example:

"5511999999999"

buttons[].type
string
required

Button type: reply, copy, url, call, or pix.

buttons
object[]

Array of button objects (see fields below).

Example:
buttons[].displayText
string

Text shown on the button.

buttons[].id
string

Button id (for reply).

buttons[].url
string

URL to open (for url).

buttons[].phoneNumber
string

Phone number to call (for call).

buttons[].currency
string

Currency (for pix).

buttons[].name
string

Merchant/key name (for pix).

buttons[].keyType
string

Pix key type: phone, email, cpf, cnpj, random.

buttons[].key
string

Pix key value (for pix).

title
string

Message title.

Example:

"How can we help?"

description
string

Message body text.

Example:

"Choose an option below"

Footer text.

Example:

"Pilot Status"

thumbnailUrl
string

URL of a thumbnail image.

delay
integer

Delay before sending, in milliseconds.

quoted
object

Message to quote/reply to (key, message).

everyOne
boolean

Mention everyone in the group.

mentioned
string[]

Array of numeric strings to mention.

Response

Success — provider-native response body.

Sent an interactive buttons message. Returns the persisted Baileys messageRaw envelope containing an interactiveMessage with a nativeFlowMessage of buttons.

key
object
pushName
string
status
enum<string>
Available options:
ERROR,
PENDING,
SERVER_ACK,
DELIVERY_ACK,
READ,
PLAYED
message
object
contextInfo
object | null
messageType
string
messageTimestamp
integer
instanceId
string
source
string