Skip to main content
POST
Enviar lista

Autorizações

Authorization
string
header
obrigatório

Token de instância (zpfy_inst_...) — envia mensagens.

Corpo

application/json
to
string
obrigatório

Destinatário da mensagem: telefone em E.164 (ex.: 5511999998888) ou um id do WhatsApp — o chat.id de um webhook, ou um id de grupo.

Exemplo:

"5511999998888"

title
string
obrigatório

Título do cabeçalho.

Exemplo:

"Nossos planos"

description
string
obrigatório

Texto do corpo.

Exemplo:

"Escolha o plano ideal"

buttonText
string
obrigatório

Rótulo do botão que abre a lista.

Exemplo:

"Abrir menu"

Texto do rodapé.

Exemplo:

"Zapfy"

sections
object[]
obrigatório

Seções, cada uma com um ou mais itens. É obrigatória pelo menos uma seção com um item.

Minimum array length: 1
mentionedPhones
string[]

Telefones a mencionar no texto do corpo.

mentionAll
boolean

Menciona todos os participantes (apenas em grupos).

delay
integer

Atraso opcional em milissegundos antes do envio; o WhatsApp mostra "digitando…" nesse intervalo.

quoted
object

Cita (responde) uma mensagem anterior.

Resposta

Envio aceito. A mensagem sai em seguida, na ordem em que você pediu; o resultado chega por webhook (MESSAGE.SENT, ou MESSAGE.STATUS_UPDATED com status FAILED) e em GET /messages/{messageId}.

data
object

Identificador da mensagem enviada. Guarde o messageId: com o mesmo to do envio, é o que /messages/delete e /messages/edit pedem.