Skip to main content
POST
Enviar botão PIX

Autorizações

token
string
header
obrigatório

Corpo

application/json
number
string
obrigatório

ID do chat para o qual a mensagem será enviada. Pode ser um número de telefone em formato internacional, um ID de grupo (@g.us), um ID de usuário (com @s.whatsapp.net ou @lid).

Exemplo:

"5511999999999"

pixType
string
obrigatório

Tipo da chave PIX. Valores aceitos: CPF, CNPJ, PHONE, EMAIL ou EVP

Exemplo:

"EVP"

pixKey
string
obrigatório

Valor da chave PIX (CPF/CNPJ/telefone/email/EVP)

Exemplo:

"123e4567-e89b-12d3-a456-426614174000"

pixName
string

Nome exibido como recebedor do PIX (padrão "Pix" se vazio)

Exemplo:

"Loja Exemplo"

async
boolean

Enfileira o envio para processamento assíncrono

delay
integer

Atraso em milissegundos antes do envio (exibe "digitando..." no WhatsApp)

readchat
boolean

Marca o chat como lido após enviar a mensagem

readmessages
boolean

Marca mensagens recentes como lidas após o envio

replyid
string

ID da mensagem que será respondida

mentions
string

Lista de números mencionados separados por vírgula

track_source
string

Origem de rastreamento (ex.: chatwoot, crm-interno)

track_id
string

Identificador de rastreamento (aceita valores duplicados)

Resposta

Botão PIX enviado com sucesso

Representa uma mensagem trocada no sistema

id
string<uuid>

ID único interno da mensagem (formato r + 7 caracteres hex aleatórios)

messageid
string

ID original da mensagem no provedor

chatid
string

ID da conversa relacionada

sender
string

ID do remetente da mensagem

senderName
string

Nome exibido do remetente

isGroup
boolean
padrão:false

Indica se é uma mensagem de grupo

fromMe
boolean
padrão:false

Indica se a mensagem foi enviada pelo usuário

messageType
string

Tipo de conteúdo da mensagem

source
string

Plataforma de origem da mensagem

messageTimestamp
integer
padrão:0

Timestamp original da mensagem em milissegundos

status
string

Status do ciclo de vida da mensagem. Exemplos comuns: Queued, Canceled, Failed, Sent, Delivered, Read. Em mensagem de grupo, segue o participante mais adiantado: Delivered quando pelo menos um recebeu, Read quando pelo menos um leu e Played quando pelo menos um ouviu.

text
string
padrão:""

Texto original da mensagem

quoted
string
padrão:""

ID da mensagem citada/respondida

edited
string
padrão:""

Histórico de edições da mensagem

reaction
string
padrão:""

ID da mensagem reagida

vote
string
padrão:""

Dados de votação de enquete e listas

convertOptions
string
padrão:""

Conversão de opções da mensagem, lista, enquete e botões

buttonOrListid
string
padrão:""

ID do botão ou item de lista selecionado

owner
string
padrão:""

Dono da mensagem

error
string
padrão:""

Mensagem de erro caso o envio tenha falhado

content

Conteúdo bruto da mensagem (JSON serializado ou texto)

wasSentByApi
boolean

Indica se a mensagem foi enviada via API

pinned
boolean

Mensagem fixada na conversa (fixar e desafixar chegam também em messages_update, tipos Pinned e Unpinned)

sendFunction
string

Função usada para enviar a mensagem (quando enviada via API)

sendPayload

Payload usado no envio quando disponível. Dados de mídia em base64 são omitidos.

fileURL
string

URL ou referência de arquivo da mensagem

callPeer
object

Contato conhecido associado a uma ligação, quando disponível em messageType: call.

send_folder_id
string

Pasta associada ao envio (quando aplicável)

track_source
string

Origem de rastreamento

track_id
string

ID de rastreamento (pode repetir)

ai_metadata
object

Registro de uma rodada da IA. O completo (pedido ao modelo, resposta e outcome) fica uma vez, na última mensagem do contato que a rodada respondeu, também quando nada saiu (erro, resposta descartada). Cada mensagem enviada pela IA leva só agent_id e turn (o id dessa mensagem do contato).

sender_pn
string | null

JID PN resolvido do remetente (quando disponível)

sender_lid
string | null

LID original do remetente (quando disponível)

sender_image_preview_url
string<uri>

URL temporária de preview do remetente, quando conhecida. A hidratação desta versão preenche mensagens recebidas em grupos; o campo pode ser omitido. Não provoca consulta de foto ao WhatsApp na listagem.

response
object