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

WhatsApp Business API para notificação de retorno de pedido

O cenário envia ao cliente um template personalizado do WhatsApp quando um retorno de pedido é registrado ou atualizado.

Visão geral do caso de uso

O cenário envia ao cliente um modelo de WhatsApp personalizado quando um retorno de pedido é registrado ou atualizado. A mensagem inclui o nome do cliente, número do pedido, nome do produto e o próximo passo para retorno ou reembolso. Um botão de URL estático abre os detalhes do retorno ou o download da etiqueta.

Exemplo de template

Olá,{{1}}! Um retorno foi iniciado para o pedido #{{2}}para{{3}}.{{4}}.

Detalhes de devolução
  • {{1}}
    nome do cliente
  • {{2}}
    número do pedido
  • {{3}}
    nome do produto
  • {{4}}
    retorno do status, prazo de reembolso ou instruções de devolução
  • “Detalhes de devolução”
    botão — fixo no template Meta
WhatsApp Business API for order return notification

Quando usá-lo

Procure por isso quando o OMS ou o portal de devoluções registrar ou atualizar uma devolução e o cliente precisar de uma atualização de status proativa em um canal que eles realmente chequem — muitas vezes sem uma conversa aberta no WhatsApp, então apenas um template aprovado pode ser enviado primeiro. Isso se encaixa em fluxos de devoluções de e-commerce, marketplaces lidando com perguntas sobre o status de devolução e integradores conectando webhooks do portal de devoluções ao WhatsApp.

Menos contatos de "onde está meu reembolso?"
O nome do cliente, o número do pedido, o nome do produto e o próximo passo para devolução ou reembolso chegam como quatro variáveis no corpo do WhatsApp, para que o cliente tenha uma atualização pesquisável ao invés de abrir um chamado de suporte.
Menos disputas de chargeback
A variável quatro traz o cronograma de reembolso ou instruções de devolução no momento em que a devolução é registrada, fornecendo ao cliente um registro escrito no chat antes de contestar a cobrança.
Nenhuma mensagem de status de retorno manual
O sistema de retornos ativa o template quando registra ou atualiza um retorno, para que os funcionários não precisem reescrever os detalhes do pedido ou enviar e-mails isolados.
Detalhes a um toque de distância.
O botão estático de detalhes da URL de Devolução está fixo no modelo Meta — o cliente abre o download do rótulo ou as instruções de devolução pelo chat sem precisar pedir o link ao suporte.
Entrega registrada para acompanhamento financeiro
O resultado da entrega é registrado após o envio, então a plataforma de e-commerce ou o CRM possui um registro vinculado ao evento de retorno para acompanhamento financeiro ou de suporte.

Fluxo de Trabalho

  1. Gatilho

    O sistema de retornos registra ou atualiza um retorno e dispara um evento.

    event · triggered

  2. Capturar evento

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

    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 cliente recebe a atualização do WhatsApp e pode abrir os detalhes da devolução 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 order return notification

Implementação técnica

Pré-requisitos

  1. 1MSG API Key · Como obter a chave da API
  2. Conta do WhatsApp Business · Como Conectar o WABA
  3. Modelo de WhatsApp · Como Aprovar o Modelo 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 ===
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": truemean 1MSGaceitoa mensagem para enviar — não que já tenha chegado ao telefone do cliente.idcampowamid.…para correlacionar retornos de entrega.

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

    Aceito para enviar.nãoainda no telefone do cliente

  • id

    Armazene-o; retornos de entrega.hookInfoestão focados nisso

A entrega em si chega mais tarde, como um retorno separado. Registre um webhookPOST …/webhook) e 1MSG POSTs atualizações de status para seu endpoint HTTPS em um nível superior.hooks[]carga útil.

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 o callback com oidretornado pela chamada de envio

  • timestamp

    Segundos Unix, como uma string

Se você preferir não receber retornos, 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 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 do WhatsApp de "cold-start" exigem um modelo aprovado pela Meta.

Relacionado

Pedidos & Entrega
WhatsApp Business API para notificação de chegada de estoque
O cenário envia ao cliente um modelo personalizado de WhatsApp quando o estoque solicitado ou reservado chega ao armazém.
Pedidos & Entrega
WhatsApp Business API para confirmação de entrega
O cenário envia um contato de parceiro ou distribuidor um template personalizado pelo WhatsApp quando um pedido é entregue em sua localização.
Pedidos & Entrega
WhatsApp Business API para notificação de pedido enviado
O cenário envia ao cliente um template personalizado pelo WhatsApp quando o pedido é marcado como enviado no OMS ou entregue a um transportador.
Pedidos & Entrega
WhatsApp Business API para notificação de pedido pronto
O cenário envia ao cliente um modelo personalizado de WhatsApp quando o pedido é marcado como pronto no armazém ou OMS.
Pedidos & Entrega
WhatsApp Business API para pedido aceito para processamento
O cenário envia ao cliente um modelo personalizado de WhatsApp quando seu pedido é aceito para processamento no armazém ou OMS.
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.

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