WhatsApp Business API para transmissão de campanha sazonal
O cenário envia um template de marketing personalizado pelo WhatsApp quando uma campanha sazonal baseada em calendário é ativada.
Visão geral do caso de uso
O cenário envia um modelo de marketing personalizado pelo WhatsApp quando uma campanha sazonal dirigida pelo calendário é ativada. A mensagem inclui o nome do cliente, o nome da estação ou ocasião, detalhes da oferta sazonal e a data de término da campanha. Um botão de URL estático abre a página de destino da coleção ou venda sazonal.
Exemplo de modelo
Olá{{1}}! Nossa{{2}}campanha está no ar:{{3}}. A promoção de temporada vai até{{4}}. Toque o botão abaixo para explorar a coleção e comprar agora.
- {{1}}nome do cliente
- {{2}}estação ou ocasião do calendário (Black Friday, Ano Novo, volta às aulas, promoção de verão)
- {{3}}detalhes da oferta sazonal (tema de desconto, categorias em destaque ou foco em presentes)
- {{4}}campanha válida até a data
- “Compre na liquidação de temporada”botão — fixo no modelo Meta

Quando usá-lo
Use este cenário quando uma temporada do calendário ou feriado for a principal razão para comprar — Black Friday, guias de presentes de Ano Novo, volta às aulas ou uma liquidação de verão com uma janela de campanha fixa — e você já tiver uma lista de WhatsApp opt-in. Isso se encaixa em impulsos sazonais de varejo, ondas de matrícula educacional e agências que realizam campanhas de feriados nomeadas para marcas de clientes de segmentos de CRM. Não é para um desconto genérico sem um gancho sazonal, uma push de banner apenas criativa, ou um lembrete de que uma oferta não relacionada está prestes a acabar.
Fluxo de Trabalho
- Desencadear
O marketing planeja uma campanha sazonal com um calendário definido e um segmento de contatos.
event·triggered - Evento de captura
O sistema resolve números de telefone e campos de personalização sazonais para cada contato.
phone:"+…" - Construir e enviar
Um modelo sazonal personalizado é construído com quatro variáveis e um botão URL estático.
POST/sendTemplate - Entregue
Cada contato que optou por receber informações recebe a mensagem da campanha sazonal via WhatsApp.
delivered - Status em acompanhamento
Os resultados de entrega são registrados para o acompanhamento do desempenho da campanha sazonal.
status:"read"

Implementação técnica
Pré-requisitos
- 1MSG API Key · Como conseguir a chave da API
- Conta do WhatsApp Business · Como Conectar WABA
- Modelo de WhatsApp · Como Aprovar o Template WABA
- Consentimento do cliente · Como Gerenciar o Consentimento dos Clientes
Exemplos de código
#!/usr/bin/env bash
set -euo pipefail
# === Configuration (replace "___" placeholders) ===
API_BASE_URL="https://api.1msg.io" # production 1MSG API base URL
CHANNEL_ID="___" # channel ID from 1MSG dashboard
API_TOKEN="___" # channel JWT token (Bearer)
TEMPLATE_NAME="___" # approved template name
TEMPLATE_NAMESPACE="___" # template namespace (required — send fails without it)
TEMPLATE_LANGUAGE="___" # template language code, e.g. "en"
# === Test data ===
TEST_PHONE="___" # client phone in international format
TEST_CUSTOMERNAME="___" # {{1}} customer name
TEST_TOPIC="___" # {{2}} topic or subject
TEST_DETAILS="___" # {{3}} change details
TEST_DATE="___" # {{4}} date or time
PHONE_NORM="$(printf '%s' "$TEST_PHONE" | tr -cd '0-9')"
for pair in "CHANNEL_ID=$CHANNEL_ID" "API_TOKEN=$API_TOKEN" \
"TEMPLATE_NAME=$TEMPLATE_NAME" "TEMPLATE_NAMESPACE=$TEMPLATE_NAMESPACE" \
"TEMPLATE_LANGUAGE=$TEMPLATE_LANGUAGE" "TEST_PHONE=$TEST_PHONE" \
"TEST_CUSTOMERNAME=$TEST_CUSTOMERNAME" \
"TEST_TOPIC=$TEST_TOPIC" \
"TEST_DETAILS=$TEST_DETAILS" \
"TEST_DATE=$TEST_DATE"; do
val="${pair#*=}"
if [ -z "$val" ] || [ "$val" = "___" ]; then
echo "Missing configuration value: ${pair%%=*}" >&2
exit 1
fi
done
if [ -z "$PHONE_NORM" ]; then
echo "Error: phone number has no digits after normalization" >&2
exit 1
fi
URL="${API_BASE_URL%/}/${CHANNEL_ID}/sendTemplate"
# params carries body ONLY. Button text is fixed in the Meta template — no button param.
# {{1}} customer name → ${TEST_CUSTOMERNAME}
# {{2}} topic or subject → ${TEST_TOPIC}
# {{3}} change details → ${TEST_DETAILS}
# {{4}} date or time → ${TEST_DATE}
read -r -d '' PAYLOAD <<JSON || true
{
"phone": "${PHONE_NORM}",
"template": "${TEMPLATE_NAME}",
"namespace": "${TEMPLATE_NAMESPACE}",
"language": { "policy": "deterministic", "code": "${TEMPLATE_LANGUAGE}" },
"params": [
{
"type": "body",
"parameters": [
{ "type": "text", "text": "${TEST_CUSTOMERNAME}" },
{ "type": "text", "text": "${TEST_TOPIC}" },
{ "type": "text", "text": "${TEST_DETAILS}" },
{ "type": "text", "text": "${TEST_DATE}" }
]
}
]
}
JSON
RESPONSE="$(curl -s -w '\n%{http_code}' -X POST "$URL" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${API_TOKEN}" \
-d "$PAYLOAD")"
HTTP_CODE="$(printf '%s' "$RESPONSE" | tail -n1)"
BODY="$(printf '%s' "$RESPONSE" | sed '$d')"
case "$BODY" in
*'"sent":true'*) ok=1 ;;
*) ok=0 ;;
esac
if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ] && [ "$ok" -eq 1 ]; then
echo "Message sent to client."
echo "API response: $BODY"
else
echo "Send failed. HTTP status: $HTTP_CODE" >&2
echo "$BODY" >&2
exit 1
fi
Status de resposta e entrega
HTTP 2xx e JSON"sent": truemean 1MSGaceitaa mensagem para envio — não que já tenha chegado ao telefone do cliente.idcampowamid.…) para correlacionar os retornos de entrega.
{
"sent": true,
"id": "wamid.HBgLMzgwNjM5...",
"message": "Message accepted for delivery"
}sentAprovado para envio.nãoainda no telefone do cliente
idArmazene isso; chamadas de entrega.
hookInfoestão focados nisso
A entrega em si chega mais tarde, como um retorno separado. Registre um webhookPOST …/webhook) e 1MSG envia atualizações de status para o seu endpoint HTTPS em um nível superiorhooks[]carga.
{
"hooks": [
{
"id": "gBGGeSaGViBfAgnlzOSHEwK9O6F",
"type": "message",
"status": "sent",
"timestamp": "1654864094",
"recipient_id": "556123122026"
}
]
}statussent,delivered,read— ou um status de falha quando aplicávelidCorrela o retorno de chamada com o
idretornado pela chamada de enviotimestampSegundos Unix, como uma string
Se você prefere não receber retornos de chamada, escolha não participar.GET {base}/{channel}/hookInfo?messageId=<id>em vez disso. Na prática, a entrega geralmente é concluída em segundos — mas o contrato da API não garante isso, então nunca bloqueie um fluxo esperando por ela.
Erros comuns
| Status | Resposta | Causa |
|---|---|---|
| 200 | Message was not sent: template is not defined | namespace, template or language missing from the request body. |
| 200 | template name (…) does not exist in <language> | The template is approved in a different language than the one requested. |
| 200 | Message was not sent: provide chatId, phone, bsuid, or username | No recipient the channel could resolve. |
| 403 | access denied | The token is wrong, or belongs to a different channel than the URL. |
| 429 | too many requests. please try later | The channel is over its send rate. |

