curl --request POST \
--url https://api.zapfy.io/v1/messages/send-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "5511999998888",
"title": "Nossos planos",
"description": "Escolha o plano ideal",
"buttonText": "Abrir menu",
"footerText": "Zapfy",
"sections": [
{
"rows": [
{
"title": "Plano Básico",
"description": "R$ 29,90/mês",
"rowId": "plan_basic"
}
],
"title": "Planos"
}
],
"mentionedPhones": [
"5511999998888"
],
"mentionAll": true,
"delay": 123
}
'import requests
url = "https://api.zapfy.io/v1/messages/send-list"
payload = {
"to": "5511999998888",
"title": "Nossos planos",
"description": "Escolha o plano ideal",
"buttonText": "Abrir menu",
"footerText": "Zapfy",
"sections": [
{
"rows": [
{
"title": "Plano Básico",
"description": "R$ 29,90/mês",
"rowId": "plan_basic"
}
],
"title": "Planos"
}
],
"mentionedPhones": ["5511999998888"],
"mentionAll": True,
"delay": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: '5511999998888',
title: 'Nossos planos',
description: 'Escolha o plano ideal',
buttonText: 'Abrir menu',
footerText: 'Zapfy',
sections: [
{
rows: [{title: 'Plano Básico', description: 'R$ 29,90/mês', rowId: 'plan_basic'}],
title: 'Planos'
}
],
mentionedPhones: ['5511999998888'],
mentionAll: true,
delay: 123
})
};
fetch('https://api.zapfy.io/v1/messages/send-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zapfy.io/v1/messages/send-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => '5511999998888',
'title' => 'Nossos planos',
'description' => 'Escolha o plano ideal',
'buttonText' => 'Abrir menu',
'footerText' => 'Zapfy',
'sections' => [
[
'rows' => [
[
'title' => 'Plano Básico',
'description' => 'R$ 29,90/mês',
'rowId' => 'plan_basic'
]
],
'title' => 'Planos'
]
],
'mentionedPhones' => [
'5511999998888'
],
'mentionAll' => true,
'delay' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zapfy.io/v1/messages/send-list"
payload := strings.NewReader("{\n \"to\": \"5511999998888\",\n \"title\": \"Nossos planos\",\n \"description\": \"Escolha o plano ideal\",\n \"buttonText\": \"Abrir menu\",\n \"footerText\": \"Zapfy\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"title\": \"Plano Básico\",\n \"description\": \"R$ 29,90/mês\",\n \"rowId\": \"plan_basic\"\n }\n ],\n \"title\": \"Planos\"\n }\n ],\n \"mentionedPhones\": [\n \"5511999998888\"\n ],\n \"mentionAll\": true,\n \"delay\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zapfy.io/v1/messages/send-list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"5511999998888\",\n \"title\": \"Nossos planos\",\n \"description\": \"Escolha o plano ideal\",\n \"buttonText\": \"Abrir menu\",\n \"footerText\": \"Zapfy\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"title\": \"Plano Básico\",\n \"description\": \"R$ 29,90/mês\",\n \"rowId\": \"plan_basic\"\n }\n ],\n \"title\": \"Planos\"\n }\n ],\n \"mentionedPhones\": [\n \"5511999998888\"\n ],\n \"mentionAll\": true,\n \"delay\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zapfy.io/v1/messages/send-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"5511999998888\",\n \"title\": \"Nossos planos\",\n \"description\": \"Escolha o plano ideal\",\n \"buttonText\": \"Abrir menu\",\n \"footerText\": \"Zapfy\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"title\": \"Plano Básico\",\n \"description\": \"R$ 29,90/mês\",\n \"rowId\": \"plan_basic\"\n }\n ],\n \"title\": \"Planos\"\n }\n ],\n \"mentionedPhones\": [\n \"5511999998888\"\n ],\n \"mentionAll\": true,\n \"delay\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"messageId": "3EB0C767D4..."
}
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}Enviar lista
Envia uma mensagem interativa com lista de opções para o usuário selecionar. Ideal para menus, catálogos e formulários simples. As opções são agrupadas em seções e o usuário escolhe uma. Retorna { messageId }.
curl --request POST \
--url https://api.zapfy.io/v1/messages/send-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "5511999998888",
"title": "Nossos planos",
"description": "Escolha o plano ideal",
"buttonText": "Abrir menu",
"footerText": "Zapfy",
"sections": [
{
"rows": [
{
"title": "Plano Básico",
"description": "R$ 29,90/mês",
"rowId": "plan_basic"
}
],
"title": "Planos"
}
],
"mentionedPhones": [
"5511999998888"
],
"mentionAll": true,
"delay": 123
}
'import requests
url = "https://api.zapfy.io/v1/messages/send-list"
payload = {
"to": "5511999998888",
"title": "Nossos planos",
"description": "Escolha o plano ideal",
"buttonText": "Abrir menu",
"footerText": "Zapfy",
"sections": [
{
"rows": [
{
"title": "Plano Básico",
"description": "R$ 29,90/mês",
"rowId": "plan_basic"
}
],
"title": "Planos"
}
],
"mentionedPhones": ["5511999998888"],
"mentionAll": True,
"delay": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: '5511999998888',
title: 'Nossos planos',
description: 'Escolha o plano ideal',
buttonText: 'Abrir menu',
footerText: 'Zapfy',
sections: [
{
rows: [{title: 'Plano Básico', description: 'R$ 29,90/mês', rowId: 'plan_basic'}],
title: 'Planos'
}
],
mentionedPhones: ['5511999998888'],
mentionAll: true,
delay: 123
})
};
fetch('https://api.zapfy.io/v1/messages/send-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zapfy.io/v1/messages/send-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => '5511999998888',
'title' => 'Nossos planos',
'description' => 'Escolha o plano ideal',
'buttonText' => 'Abrir menu',
'footerText' => 'Zapfy',
'sections' => [
[
'rows' => [
[
'title' => 'Plano Básico',
'description' => 'R$ 29,90/mês',
'rowId' => 'plan_basic'
]
],
'title' => 'Planos'
]
],
'mentionedPhones' => [
'5511999998888'
],
'mentionAll' => true,
'delay' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zapfy.io/v1/messages/send-list"
payload := strings.NewReader("{\n \"to\": \"5511999998888\",\n \"title\": \"Nossos planos\",\n \"description\": \"Escolha o plano ideal\",\n \"buttonText\": \"Abrir menu\",\n \"footerText\": \"Zapfy\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"title\": \"Plano Básico\",\n \"description\": \"R$ 29,90/mês\",\n \"rowId\": \"plan_basic\"\n }\n ],\n \"title\": \"Planos\"\n }\n ],\n \"mentionedPhones\": [\n \"5511999998888\"\n ],\n \"mentionAll\": true,\n \"delay\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zapfy.io/v1/messages/send-list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"5511999998888\",\n \"title\": \"Nossos planos\",\n \"description\": \"Escolha o plano ideal\",\n \"buttonText\": \"Abrir menu\",\n \"footerText\": \"Zapfy\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"title\": \"Plano Básico\",\n \"description\": \"R$ 29,90/mês\",\n \"rowId\": \"plan_basic\"\n }\n ],\n \"title\": \"Planos\"\n }\n ],\n \"mentionedPhones\": [\n \"5511999998888\"\n ],\n \"mentionAll\": true,\n \"delay\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zapfy.io/v1/messages/send-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"5511999998888\",\n \"title\": \"Nossos planos\",\n \"description\": \"Escolha o plano ideal\",\n \"buttonText\": \"Abrir menu\",\n \"footerText\": \"Zapfy\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"title\": \"Plano Básico\",\n \"description\": \"R$ 29,90/mês\",\n \"rowId\": \"plan_basic\"\n }\n ],\n \"title\": \"Planos\"\n }\n ],\n \"mentionedPhones\": [\n \"5511999998888\"\n ],\n \"mentionAll\": true,\n \"delay\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"messageId": "3EB0C767D4..."
}
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}Autorizações
Token de instância (zpfy_inst_...) — envia mensagens.
Corpo
Destinatário da mensagem: telefone em E.164 (ex.: 5511999998888) ou id de grupo.
"5511999998888"
Título do cabeçalho.
"Nossos planos"
Texto do corpo.
"Escolha o plano ideal"
Rótulo do botão que abre a lista.
"Abrir menu"
Texto do rodapé.
"Zapfy"
Seções, cada uma com um ou mais itens. É obrigatória pelo menos uma seção com um item.
1Show child attributes
Show child attributes
Telefones a mencionar no texto do corpo.
Menciona todos os participantes (apenas em grupos).
Atraso opcional em milissegundos antes do envio; o WhatsApp mostra "digitando…" nesse intervalo.
Cita (responde) uma mensagem anterior.
Show child attributes
Show child attributes
Resposta
Mensagem aceita pelo WhatsApp.
Identificador da mensagem enviada. Guarde o messageId: com o mesmo to do envio, é o que /messages/delete e /messages/edit pedem.
Show child attributes
Show child attributes