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

Notificação de entrega falha no WhatsApp Business API

O cenário envia ao cliente um modelo personalizado de WhatsApp quando uma tentativa de entrega falha.

Use case overview

O cenário envia ao cliente um modelo personalizado de WhatsApp quando uma tentativa de entrega falha. A mensagem inclui o nome do cliente, número do pedido, nome do produto e instruções para a próxima tentativa ou retirada. Um botão de URL estático abre para reagendamento ou rastreamento.

Exemplo de template

Olá, {{1}}! O mensageiro não conseguiu entregar o pedido #{{2}} para "{{3}}". {{4}}.

Reagendar entrega
  • {{1}}
    nome do cliente
  • {{2}}
    número do pedido
  • {{3}}
    nome do produto
  • {{4}}
    data da próxima tentativa, opção de retirada, ou motivo da falha
  • “Reagendar entrega”
    botão — fixo no modelo Meta
WhatsApp Business API for failed delivery attempt notification

Quando usar isso

Use esse cenário quando um entregador registrar uma tentativa de entrega falhada e o cliente precisar saber o que aconteceu antes do pacote retornar para o depósito — sem um chat aberto no WhatsApp para mensagem livre. Isso se encaixa em equipes de logística de última milha, lojas de e-commerce cansadas de chamadas de suporte do tipo "ninguém estava em casa" e integradores conectando webhooks de tentativas falhadas de transportadoras ao WhatsApp outbound.

Menos chamadas de suporte "onde está meu pedido?"
Quatro variáveis do corpo carregam o nome do cliente, número do pedido, produto e nota sobre a próxima etapa, assim a razão da falha e as opções de reedição são enviadas pelo WhatsApp em vez de forçar uma ligação para o suporte.
Ação mais rápida antes que o pacote retorne ao depósito
O evento de tentativa falha do transportador ativa o template aprovado imediatamente, dando ao cliente tempo para reagendar ou organizar a coleta através do botão antes que o pacote saia da rota.
Sem acompanhamento manual da equipe de logística
O sistema resolve os campos de telefone e tentativa do evento da operadora e envia o template automaticamente — nenhum representante precisa digitar os detalhes do pedido para cada visita perdida.
Opções de reentrega e retirada mais claras
Um botão de URL "Reprogramar entrega" está fixo no modelo Meta e abre o rastreamento ou reprogramação; apenas as quatro variáveis do corpo são enviadas via API.
Status de entrega registrado para acompanhamento no CRM
O resultado da entrega é registrado após o envio, assim a plataforma de e-commerce ou o CRM mantém a tentativa no registro do pedido para acompanhamento logístico.

Fluxo de Trabalho

  1. Disparador

    O transportador registra uma tentativa de entrega falha e dispara um evento.

    event · triggered

  2. Registrar evento

    O sistema identifica o número de telefone do cliente e as tentativas.

    phone: "+…"

  3. Crie & envie

    Uma mensagem de modelo personalizada é construída com quatro variáveis de corpo e um botão de URL estático.

    POST /sendTemplate

  4. Entregue

    O cliente recebe a atualização do WhatsApp e pode reagendar através do botão.

    delivered

  5. Status rastreado

    O resultado da entrega é registrado; os erros são tratados de acordo com as regras da plataforma.

    status: "read"

WhatsApp Business API for failed delivery attempt notification

Implementação técnica

Pré-requisitos

  1. 1MSG Chave de API · Como obter a Chave de API
  2. Conta do WhatsApp Business · Como Conectar WABA
  3. Modelo do WhatsApp · Como Aprovar o Modelo do WABA
  4. Opt-in do cliente · Como Gerenciar o Consentimento

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_TICKETNUMBER="___"         # {{2}} ticket number
TEST_PRODUCTNAME="___"         # {{3}} product name
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_TICKETNUMBER=$TEST_TICKETNUMBER" \
            "TEST_PRODUCTNAME=$TEST_PRODUCTNAME" \
            "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}} ticket number → ${TEST_TICKETNUMBER}
# {{3}} product name → ${TEST_PRODUCTNAME}
# {{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_TICKETNUMBER}" },
        { "type": "text", "text": "${TEST_PRODUCTNAME}" },
        { "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": true significam que 1MSG aceitou a mensagem para envio — não que ela já chegou ao telefone do cliente. Salve o campo id (parece com wamid.…) para correlacionar os callbacks de entrega.

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

    Aceito para envio — não ainda no telefone do cliente

  • id

    Armazene-o; os retornos de entrega e hookInfo são vinculados a isso.

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

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

    enviado, entregue, lido — ou um status de falha quando aplicável

  • id

    Correla o retorno da chamada com o id retornado pela chamada de envio.

  • timestamp

    Segundos Unix, como uma string

Se você prefere não receber chamadas de retorno, consulte 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 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.

Perguntas Frequentes.

Sim — mensagens de WhatsApp de inicialização a frio exigem um modelo aprovado pelo Meta.

Relacionado

Pedidos & Entrega
WhatsApp Business API para confirmação de entrega de pedido
O cenário envia ao cliente um modelo personalizado WhatsApp quando seu pedido é marcado como entregue.
Pedidos & Entrega
WhatsApp Business API para notificação de pedido cancelado
O cenário envia ao cliente um modelo de WhatsApp personalizado quando um pedido é cancelado.
Pedidos & Entrega
WhatsApp Business API para notificação de nova rota
O cenário faz com que um gerente ou despachante envie um modelo personalizado de WhatsApp quando uma nova rota ou viagem é criada.
Pedidos & Entrega
WhatsApp Business API para confirmação de novos pedidos
O cenário envia ao cliente um modelo de WhatsApp personalizado logo após um novo pedido ser criado.
Pedidos & Entrega
WhatsApp Business API para entrega — compartilhe localização
Este cenário envia uma localização de mapa com sendLocation durante a janela de atendimento ao cliente de 24 horas.
Pedidos & Entrega
WhatsApp Business API para notificação de atraso na entrega
O cenário envia ao cliente um template personalizado pelo WhatsApp quando a entrega do pedido está atrasada.
Pedidos & Entrega
WhatsApp Business API para contato de entregador.
Este cenário envia um cartão de contato do WhatsApp com sendContact durante a janela de atendimento ao cliente após um motorista ser designado ao pedido.
Pedidos & Entrega
WhatsApp Business API para notificação de mudança de status
O cenário envia ao cliente um template personalizado pelo WhatsApp quando o status do seu pedido, solicitação ou requisição muda.

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