Skip to main content
POST
Enviar botão PIX

Autorizações

token
string
header
obrigatório

Corpo

application/json
number
string
obrigatório

Número do destinatário (DDD + número, formato internacional)

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

fromMe
boolean
padrão:false

Indica se a mensagem foi enviada pelo usuário

isGroup
boolean
padrão:false

Indica se é uma mensagem de grupo

messageType
enum<string>

Tipo de conteúdo da mensagem

Opções disponíveis:
text,
image,
video,
document,
audio,
location,
button,
list,
reaction
messageTimestamp
integer
padrão:0

Timestamp original da mensagem em milissegundos

edited
string
padrão:""

Histórico de edições da mensagem

quoted
string
padrão:""

ID da mensagem citada/respondida

reaction
string
padrão:""

ID da mensagem reagida

sender
string
padrão:""

ID do remetente da mensagem

senderName
string
padrão:""

Nome exibido do remetente

source
enum<string>
padrão:""

Plataforma de origem da mensagem

Opções disponíveis:
ios,
web,
android
status
enum<string>
padrão:""

Status do ciclo de vida da mensagem

Opções disponíveis:
pending,
sent,
delivered,
read,
failed,
deleted
text
string
padrão:""

Texto original da mensagem

vote
string
padrão:""

Dados de votação de enquete e listas

buttonOrListid
string
padrão:""

ID do botão ou item de lista selecionado

convertOptions
string
padrão:""

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

fileURL
string<uri>
padrão:""

URL para download de arquivos de mídia

content
string

Conteúdo completo da mensagem em formato JSON

owner
string
padrão:""

Dono da mensagem

track_source
string
padrão:""

Origem do rastreamento da mensagem

track_id
string
padrão:""

ID para rastreamento da mensagem (aceita valores duplicados)

created
string<date-time>
padrão:(strftime('%Y-%m-%d %H:%M:%f', 'now'))

Data de criação no sistema (formato SQLite YYYY-MM-DD HH:MM:SS.FFF)

updated
string<date-time>
padrão:(strftime('%Y-%m-%d %H:%M:%f', 'now'))

Data da última atualização (formato SQLite YYYY-MM-DD HH:MM:SS.FFF)

ai_metadata
object

Metadados do processamento por IA

response
object