💬 Shared Inbox do WhatsApp na nova PlataformaMais
1msg official logo

WhatsApp Business API para lembrete de preparação. Preços.

O cenário envia ao cliente um modelo personalizado de WhatsApp antes de um procedimento ou teste com etapas de preparação.

Visão geral do caso de uso

O cenário envia ao cliente um modelo de WhatsApp personalizado antes de um procedimento ou teste com etapas de preparação. A mensagem inclui o nome do cliente, serviço, data e a próxima etapa de preparação. Um botão de URL estático abre os detalhes da reserva.

Exemplo de modelo

Olá,{{1}}! Antes do seu{{2}}em{{3}}Desculpe, mas parece que você não forneceu um texto para tradução. Poderia me enviar o texto que você gostaria que eu traduzisse?{{4}}

Ver reserva
  • {{1}}
    nome do cliente
  • {{2}}
    nome do procedimento ou teste
  • {{3}}
    data programada
  • {{4}}
    etapa ou instrução de preparação
  • “Ver reserva”
    botão — fixo no template Meta
WhatsApp Business API for procedure preparation reminder

Quando usar isso

Aproveite para este cenário quando um procedimento agendado ou exame de laboratório estiver se aproximando e o cliente ainda precisar de passos claros de preparação antes de chegar — regras de jejum, documentos a serem trazidos ou outras instruções pré-visita que são fáceis de esquecer em e-mails ou em papel. Isso se aplica a laboratórios de diagnóstico que dependem da preparação de amostras, clínicas onde a falta de preparo força um reagendamento, e integradores conectando as regras de preparo do procedimento a partir de um sistema de agendamento ao WhatsApp.

Menos horários reagendados
A etapa de preparação chega como a quarta variável do corpo, ao lado do nome do cliente, nome do procedimento e data agendada, para que o cliente veja o que fazer antes da consulta em um canal que já abre.
Instruções de preparo permanecem pesquisáveis.
Nome, serviço, data e o próximo passo de preparação aparecem como quatro variáveis principais no WhatsApp, em vez de instruções enterradas em e-mails que o cliente nunca abre.
Sem trabalho de lembrete manual
O sistema de agendamento dispara o template aprovado em um evento de lembrete de preparação, resolve automaticamente os campos de telefone e reserva, e registra a entrega para agendamento ou acompanhamento no CRM.
Detalhes da reserva a um toque de distância
Um botão de URL estático fixo no template Meta abre os detalhes da reserva para qualquer coisa que as quatro variáveis do corpo não cobrem — apenas as variáveis do corpo são enviadas via API.

Fluxo de Trabalho

  1. Desencadear

    O sistema de agendamento dispara um evento de lembrete de preparação.

    event · triggered

  2. Captura de evento

    O sistema resolve os campos de número de telefone do cliente e de reserva.

    phone: "+…"

  3. Construir e enviar

    Uma mensagem de template personalizada é criada com quatro variáveis e um botão de URL estático.

    POST /sendTemplate

  4. Entregue

    O cliente recebe o lembrete de preparação pelo WhatsApp.

    delivered

  5. Status rastreado

    O resultado da entrega é registrado para agendamento ou acompanhamento no CRM.

    status: "read"

WhatsApp Business API for procedure preparation reminder

Implementação técnica

Pré-requisitos

  1. 1MSG API Key · Como obter a chave da API
  2. Conta do WhatsApp Business · Como Conectar WABA
  3. Modelo de WhatsApp · Como Aprovar o Modelo WABA
  4. Opt-in 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_SERVICE="___"         # {{2}} service name
TEST_BOOKINGDATE="___"         # {{3}} booking date
TEST_NEXTSTEP="___"         # {{4}} next step

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_SERVICE=$TEST_SERVICE" \
            "TEST_BOOKINGDATE=$TEST_BOOKINGDATE" \
            "TEST_NEXTSTEP=$TEST_NEXTSTEP"; 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}} service name → ${TEST_SERVICE}
# {{3}} booking date → ${TEST_BOOKINGDATE}
# {{4}} next step → ${TEST_NEXTSTEP}
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_SERVICE}" },
        { "type": "text", "text": "${TEST_BOOKINGDATE}" },
        { "type": "text", "text": "${TEST_NEXTSTEP}" }
      ]
    }

  ]
}
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 1MSGaceitoa mensagem para envio — não que já tenha chegado ao telefone do cliente.idcampowamid.…) para correlacionar callbacks de entrega.

200 OKResposta
{
  "sent": true,
  "id": "wamid.HBgLMzgwNjM5...",
  "message": "Message accepted for delivery"
}
  • sent

    Aceito para envio —nãoainda no telefone do cliente

  • id

    Terminologia não está clara; considere revisar para melhor contexto.hookInfoestão focados nisso

A entrega em si chega mais tarde, como um callback separado. Registre um webhook (POST …/webhook) e 1MSG envia atualizações de status para seu endpoint HTTPS em um nível superiorhooks[]carga.

200 OKWebhook de status de entrega — payload recebido
{
  "hooks": [
    {
      "id": "gBGGeSaGViBfAgnlzOSHEwK9O6F",
      "type": "message",
      "status": "sent",
      "timestamp": "1654864094",
      "recipient_id": "556123122026"
    }
  ]
}
  • status

    sent, delivered, read— ou um status de falha quando aplicável

  • id

    Correlaciona a chamada de volta com aidretornado pela chamada de envio

  • timestamp

    Segundos Unix, como uma string

Se você prefere não receber chamadas de retorno, participe da pesquisa.GET {base}/{channel}/hookInfo?messageId=<id>em vez disso. Na prática, a entrega muitas vezes é concluída em segundos — mas o contrato da API não garante isso, então nunca bloqueie um fluxo esperando por isso.

Erros comuns

StatusRespostaCausa
200Message was not sent: template is not definednamespace, template or language missing from the request body.
200template name (…) does not exist in <language>The template is approved in a different language than the one requested.
200Message was not sent: provide chatId, phone, bsuid, or usernameNo recipient the channel could resolve.
403access deniedThe token is wrong, or belongs to a different channel than the URL.
429too many requests. please try laterThe channel is over its send rate.

FAQ

Sim — mensagens de WhatsApp com início a frio requerem um modelo aprovado pelo Meta.

Relacionado

Crie para o WhatsApp em horas
sem complicações de infraestrutura