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

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.

Visão geral do caso de uso

O cenário envia para um gerente ou despachante um contato de um template personalizado do WhatsApp quando uma nova rota de entrega ou viagem é criada. A mensagem inclui o nome do contato, número da rota ou viagem, nome da rota ou região, e um resumo do cronograma. Um botão de URL estático abre os detalhes da rota no portal de logística.

Exemplo de modelo

Olá,{{1}}! Uma nova rota #{{2}}foi criado.{{3}}.{{4}}.

Detalhes da rota
  • {{1}}
    nome do contato do gerente ou despachante
  • {{2}}
    número da rota ou da viagem
  • {{3}}
    nome da rota ou região de serviço
  • {{4}}
    janela de partida, contagem de paradas ou próximo passo operacional
  • “Detalhes da rota”
    botão — fixado no template Meta
WhatsApp Business API for new route or trip notification

Quando usá-lo

Acesse este cenário quando seu TMS cria ou publica uma rota de entrega ou viagem e o gerente ou despachante responsável precisa saber antes de atualizar o e-mail ou fazer login no portal da desktop. Isso se adequa a hubs de despacho de frota alertando os gerentes dos hubs, equipes de logística B2B notificando despachantes parceiros sobre viagens atribuídas, e integradores conectando webhooks de rota criados pelo TMS ao WhatsApp para envios.

Menos partidas perdidas
O número da rota, nome e resumo do cronograma chegam como quatro variáveis de corpo no WhatsApp do gerente (MANAGER_PHONE), então os detalhes da atribuição vão para um canal que eles checam na estrada em vez de uma aba de portal que eles abrem tarde demais.
Menos tempo verificando o portal
O botão de URL dos detalhes da Rota está fixo no modelo Meta aprovado e abre o portal de logística a partir da mensagem, assim o gerente não precisa procurar a viagem no TMS primeiro.
Sem alertas de despachante manual
O evento de criação de rota do TMS resolve os campos de telefone do gerente e da rota, e então envia automaticamente o template personalizado — ninguém fica digitando novamente o contexto da rota ou se lembrando de avisar a equipe de campo.
Acompanhamento da frota e OMS
O resultado da entrega é registrado após o envio, para que as operações da frota ou o OMS possam rastrear quais notificações de rota chegaram ao contato responsável e tentar novamente em caso de falha, de acordo com as regras da plataforma.

Fluxo de Trabalho

  1. Gatilho

    O TMS cria ou publica uma rota e dispara um evento.

    event · triggered

  2. Evento de captura

    O sistema resolve os campos de telefone e rota do gerente.

    phone: "+…"

  3. Construir e enviar

    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 contato do gerente recebe a atualização pelo WhatsApp e pode abrir os detalhes da rota 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 new route or trip notification

Implementação técnica

Pré-requisitos

  1. Chave da API 1MSG · Como obter a chave da API
  2. Conta do WhatsApp Business · Como Conectar o WABA
  3. Modelo de WhatsApp · Como Aprovar o Template WABA
  4. 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 ===
MANAGER_PHONE="___"                 # manager phone in international format
TEST_MANAGERNAME="___"         # {{1}} manager name
TEST_TICKETNUMBER="___"         # {{2}} ticket number
TEST_TOPIC="___"         # {{3}} topic or subject
TEST_NEXTSTEP="___"         # {{4}} next step

PHONE_NORM="$(printf '%s' "$MANAGER_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" "MANAGER_PHONE=$MANAGER_PHONE" \
            "TEST_MANAGERNAME=$TEST_MANAGERNAME" \
            "TEST_TICKETNUMBER=$TEST_TICKETNUMBER" \
            "TEST_TOPIC=$TEST_TOPIC" \
            "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}} manager name → ${TEST_MANAGERNAME}
# {{2}} ticket number → ${TEST_TICKETNUMBER}
# {{3}} topic or subject → ${TEST_TOPIC}
# {{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_MANAGERNAME}" },
        { "type": "text", "text": "${TEST_TICKETNUMBER}" },
        { "type": "text", "text": "${TEST_TOPIC}" },
        { "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 manager."
    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 1MSGaceito/aa mensagem para envio — não que já tenha chegado ao telefone do cliente.idcampowamid.…) para correlacionar os retornos de entrega.

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

    Aprovado para envio —nãoainda no telefone do cliente

  • id

    Armazene; retornos de chamada de entrega ehookInfosão focados nisso

A entrega em si chega mais tarde, como um retorno 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

    Correla o retorno da chamada com oidretornado pela chamada de envio

  • timestamp

    Segundos Unix, como uma string

Se você prefere não receber ligações, escolha.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 ela.

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 no WhatsApp para início a frio requerem um modelo aprovado pela Meta.

Relacionado

Pedidos & Entrega
WhatsApp Business API para notificação de ausência
O cenário envia ao cliente um template personalizado do WhatsApp quando ele não responde a uma mensagem anterior relacionada ao pedido dentro do tempo esperado.
Pedidos & Entrega
WhatsApp Business API para notificação de entrega de pedido
O cenário envia ao cliente um modelo personalizado de WhatsApp quando seu pedido é entregue a um parceiro de entrega para a última milha de cumprimento.
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 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
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.
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.

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