Pular para o conteúdo principal

Enviando Mensagens Ativas com Template order_details

  • Atualizado

Este documento demonstra como usar a API Active Campaign para enviar mensagens ativas do WhatsApp usando o template order_details com diferentes tipos de configurações de pagamento (PIX dinâmico, link de pagamento e boleto).

 

Relação entre message.messageParams e audience.messageParams

O campos se relacionam devido às variáveis dos templates, ou seja, se um template tem uma lista de variáveis, como o exemplo abaixo, é necessário que essas variáveis sejam declaradas no objeto message.messageParams e que seus valores sejam preenchidos no objeto audience.messageParams.

 

Para o caso do order_details, mesmo que o template não possua variáveis, será necessário passar a variável #payment# no objeto audience.messageParams contendo diretamente o JSON do objeto order_details.
 

IMPORTANTE: O campo message.messageParams deve conter apenas os nomes das variáveis, e os valores dessas variáveis devem estar nos messageParams das audiências.


 

{
  "message": {
    "messageParams": [
      "cliente_nome",        // Nome da variável
      "pedido_numero",       // Nome da variável  
      "valor_total",         // Nome da variável
    ]
  },
  "audience": {
    "messageParams": {
      "cliente_nome": "João Silva",   // Valor da variável
      "pedido_numero": "12345",       // Valor da variável
      "valor_total": "R$ 150,00",     // Valor da variável
      "#payment#": "{...}"            // JSON direto do objeto order_details
    }
  }
}


 

Esta correspondência permite que o sistema substitua automaticamente os nomes das variáveis pelos seus respectivos valores durante o envio da mensagem.

 

Método Principal

POST /campaigns/full-campaign

Exemplo de requisição:

POST https://{{contract.id}}.http.msging.net/commands HTTP/1.1

Content-Type: application/json

Authorization: {{authorizationKey}}

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "set",
    "uri": "/campaigns/full-campaign",
    "type": "application/vnd.iris.activecampaign.full-campaign+json",
    "resource": {
   {payload_da_campanha}
   }
}


 

Tipos de Campanha Suportados

  • Individual: Para envio individual (campaign.CampaignType = "Individual")
  • Group: Para grupos (campaign.CampaignType = "Group")
  • Batch: Para envio em lote (campaign.CampaignType = "Batch")
     

Para verificar todos os campos de uma campanha de ActiveCampaign, consulte a documentação ou confira os exemplos completos de payload.

 

Estrutura Detalhada do Order Details

Deve-se seguir corretamente a estrutura do tipo “order_details”, conforme documentação da Meta. Segue abaixo com mais detalhes e exemplos práticos.

 

Campos Principais

 

{
  "reference_id": "string",      // ID único do pedido (obrigatório)
  "type": "string",              // "digital-goods" ou "physical-goods" (obrigatório)
  "payment_type": "br",          // Tipo de pagamento para Brasil (obrigatório)
  "currency": "BRL",             // Moeda (obrigatório)
  "total_amount": {              // Valor total (obrigatório)
    "value": 15000,              // Valor em centavos
    "offset": 100                // Offset para casas decimais
  },
  "payment_settings": [...],     // Configurações de pagamento (obrigatório)
  "order": {                     // Detalhes do pedido (opcional)
    "status": "pending",
    "subtotal": {...},
    "tax": {...},
    "shipping": {...},
    "discount": {...},
    "items": [...]
  }
}

 

Estrutura de Itens do Pedido

{
  "retailer_id": "ITEM001",      // ID do produto/serviço
  "name": "Nome do Produto",     // Nome do item
  "amount": {                    // Valor do item
    "value": 13000,
    "offset": 100
  },
  "quantity": 1                  // Quantidade
}


 

Configurações de Payment Settings

 

1. PIX Dinâmico (pix_dynamic_code)

{
  "type": "pix_dynamic_code",
  "pix_dynamic_code": {
    "code": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426614174000520400005303986540510.005802BR5913Nome Empresa6014Rio de Janeiro62190515PIX123456789630445E3",
    "merchant_name": "Nome da Empresa",
    "key": "12345678000195",
    "key_type": "CNPJ"
  }
}

 

Campos obrigatórios:

  • code: Código PIX dinâmico válido
  • merchant_name: Nome do comerciante
  • key: Chave PIX (CPF/CNPJ/email/telefone)
  • key_type: Tipo da chave ("CNPJ", "CPF", "EMAIL", "PHONE")


 

2. Link de Pagamento (payment_link)

{
  "type": "payment_link",
  "payment_link": {
    "link": "https://pagamento.empresa.com.br/checkout/abc123def456"
  }
}

 

Campos obrigatórios:

  • link: URL válida para o pagamento

 

3. Boleto (boleto)

{
  "type": "boleto",
  "boleto": {
  "digitable_line":
    "code": "23791234500001234567891234567890123456789012"
  }
}

Campos obrigatórios:

  • code: Código de barras do boleto


 

Exemplos Completos de Payload

Exemplo 1: Campanha Individual com PIX Dinâmico

{
  "campaign": {
    "name": "Pagamento PIX - Pedido #12345",
    "campaignType": "Individual"
  },
  "audience": {
    "recipient": "+5511999887766",
    "name": "João Silva",
    "messageParams": {
      "cliente_nome": "João Silva",
      "pedido_numero": "12345",
      "valor_total": "R$ 150,00",
      "#payment#": "{\"reference_id\":\"12345\",\"type\":\"digital-goods\",\"payment_type\":\"br\",\"currency\":\"BRL\",\"total_amount\":{\"value\":15000,\"offset\":100},\"payment_settings\":[{\"type\":\"pix_dynamic_code\",\"pix_dynamic_code\":{\"code\":\"00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426614174000520400005303986540510.005802BR5913Nome Empresa6014Rio de Janeiro62190515PIX123456789630445E3\",\"merchant_name\":\"Minha Empresa\",\"key\":\"12345678000195\",\"key_type\":\"CNPJ\"}}],\"order\":{\"status\":\"pending\",\"subtotal\":{\"value\":13000,\"offset\":100},\"tax\":{\"value\":1500,\"offset\":100,\"description\":\"Impostos\"},\"shipping\":{\"value\":500,\"offset\":100,\"description\":\"Frete\"},\"items\":[{\"retailer_id\":\"ITEM001\",\"name\":\"Produto Digital\",\"amount\":{\"value\":13000,\"offset\":100},\"quantity\":1}]}}"
    }
  },
  "message": {
    "channelType": "WhatsApp",
    "messageTemplate": "order_details",
    "messageTemplateLanguage": "pt_BR",
    "messageParams": [
      "cliente_nome",
      "pedido_numero",
      "valor_total"
    ]
  }
}


 

Exemplo 2: Campanha Individual com Link de Pagamento

{
  "campaign": {
    "name": "Pagamento Link - Pedido #12346",
    "campaignType": "Individual"
  },
  "audience": {
    "recipient": "+5511999887767",
    "name": "Maria Santos",
    "messageParams": {
      "cliente_nome": "Maria Santos",
      "pedido_numero": "12346",
      "valor_total": "R$ 299,90",
      "#payment#": "{\"reference_id\":\"12346\",\"type\":\"physical-goods\",\"payment_type\":\"br\",\"currency\":\"BRL\",\"total_amount\":{\"value\":29990,\"offset\":100},\"payment_settings\":[{\"type\":\"payment_link\",\"payment_link\":{\"link\":\"https://pagamento.empresa.com.br/checkout/abc123def456\"}}],\"order\":{\"status\":\"pending\",\"subtotal\":{\"value\":25000,\"offset\":100},\"tax\":{\"value\":2500,\"offset\":100,\"description\":\"ICMS\"},\"shipping\":{\"value\":2490,\"offset\":100,\"description\":\"Entrega expressa\"},\"items\":[{\"retailer_id\":\"PROD002\",\"name\":\"Smartphone XYZ\",\"amount\":{\"value\":25000,\"offset\":100},\"quantity\":1}]}}"
    }
  },
  "message": {
    "channelType": "WhatsApp",
    "messageTemplate": "order_details",
    "messageTemplateLanguage": "pt_BR",
    "messageParams": [
      "cliente_nome",
      "pedido_numero",
      "valor_total"
    ]
  }
}


 

Exemplo 3: Campanha Individual com Boleto

{
  "campaign": {
    "name": "Pagamento Boleto - Pedido #12347",
    "campaignType": "Individual"
  },
  "audience": {
    "recipient": "+5511999887768",
    "name": "Carlos Oliveira",
    "messageParams": {
      "cliente_nome": "Carlos Oliveira",
      "pedido_numero": "12347",
      "valor_total": "R$ 750,00",
      "#payment#": "{\"reference_id\":\"12347\",\"type\":\"physical-goods\",\"payment_type\":\"br\",\"currency\":\"BRL\",\"total_amount\":{\"value\":75000,\"offset\":100},\"payment_settings\":[{\"type\":\"boleto\",\"boleto\":{\"code\":\"23791234500001234567891234567890123456789012\"}}],\"order\":{\"status\":\"pending\",\"subtotal\":{\"value\":65000,\"offset\":100},\"tax\":{\"value\":6500,\"offset\":100,\"description\":\"ICMS\"},\"shipping\":{\"value\":3500,\"offset\":100,\"description\":\"Transportadora\"},\"items\":[{\"retailer_id\":\"SERV001\",\"name\":\"Consultoria Premium\",\"amount\":{\"value\":65000,\"offset\":100},\"quantity\":1}]}}"
    }
  },
  "message": {
    "channelType": "WhatsApp",
    "messageTemplate": "order_details",
    "messageTemplateLanguage": "pt_BR",
    "messageParams": [
      "cliente_nome",
      "pedido_numero",
      "valor_total"
    ]
  }
}


 

Exemplo 4: Campanha Batch com Múltiplas Audiências

{
  "campaign": {
    "name": "Cobrança em Lote - Janeiro 2024",
    "campaignType": "Batch"
  },
  "audiences": [
    {
      "recipient": "+5511999887766",
      "name": "João Silva",
      "messageParams": {
        "cliente_nome": "João Silva",
        "pedido_numero": "12345",
        "valor_total": "R$ 150,00",
        "#payment#": "{\"reference_id\":\"12345\",\"type\":\"digital-goods\",\"payment_type\":\"br\",\"currency\":\"BRL\",\"total_amount\":{\"value\":15000,\"offset\":100},\"payment_settings\":[{\"type\":\"pix_dynamic_code\",\"pix_dynamic_code\":{\"code\":\"00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426614174000520400005303986540510.005802BR5913Nome Empresa6014Rio de Janeiro62190515PIX123456789630445E3\",\"merchant_name\":\"Minha Empresa\",\"key\":\"12345678000195\",\"key_type\":\"CNPJ\"}}],\"order\":{\"status\":\"pending\",\"subtotal\":{\"value\":13000,\"offset\":100},\"tax\":{\"value\":1500,\"offset\":100,\"description\":\"Impostos\"},\"shipping\":{\"value\":500,\"offset\":100,\"description\":\"Frete\"},\"items\":[{\"retailer_id\":\"ITEM001\",\"name\":\"Produto Digital\",\"amount\":{\"value\":13000,\"offset\":100},\"quantity\":1}]}}"
      }
    },
    {
      "recipient": "+5511999887767",
      "name": "Maria Santos",
      "messageParams": {
        "cliente_nome": "Maria Santos",
        "pedido_numero": "12346",
        "valor_total": "R$ 299,90",
        "#payment#": "{\"reference_id\":\"12346\",\"type\":\"physical-goods\",\"payment_type\":\"br\",\"currency\":\"BRL\",\"total_amount\":{\"value\":29990,\"offset\":100},\"payment_settings\":[{\"type\":\"payment_link\",\"payment_link\":{\"link\":\"https://pagamento.empresa.com.br/checkout/maria123\"}}],\"order\":{\"status\":\"pending\",\"subtotal\":{\"value\":25000,\"offset\":100},\"tax\":{\"value\":2500,\"offset\":100,\"description\":\"ICMS\"},\"shipping\":{\"value\":2490,\"offset\":100,\"description\":\"Entrega expressa\"},\"items\":[{\"retailer_id\":\"PROD002\",\"name\":\"Smartphone XYZ\",\"amount\":{\"value\":25000,\"offset\":100},\"quantity\":1}]}}"
      }
    }
  ],
  "message": {
    "channelType": "WhatsApp",
    "messageTemplate": "order_details",
    "messageTemplateLanguage": "pt_BR",
    "messageParams": [
      "cliente_nome",
      "pedido_numero",
      "valor_total"
    ]
  }
}


 

Considerações Importantes

Valores Monetários

  • Todos os valores devem ser enviados em centavos
  • O campo offset define as casas decimais (100 = 2 casas decimais)
  • Exemplo: R$ 150,00 = {"value": 15000, "offset": 100}


 

Template do WhatsApp

  • O template order_details deve estar aprovado no WhatsApp Business Manager
  • A estrutura dos parâmetros deve seguir a configuração do template
  • O último parâmetro sempre contém o JSON do order_details


 

Tipos de Chave PIX

  • CNPJ: Para empresas
  • CPF: Para pessoas físicas
  • EMAIL: Endereço de email
  • PHONE: Número de telefone


 

Validações

  • URLs de pagamento devem usar HTTPS
  • Códigos de boleto devem ter o formato válido (linha digitável)
  • Códigos PIX devem seguir o padrão BR Code
  • Todos os campos obrigatórios devem ser fornecidos


 

Monitoramento e Logs

Verificação de Status

Após o envio, você pode verificar o status da campanha usando:

GET /campaigns/{campaignId}


 

Relatórios

Para obter relatórios detalhados:

GET /campaigns/{campaignId}/reports

GET /campaigns/{campaignId}/reports/csv


 

Conclusão

Esta documentação fornece todos os elementos necessários para implementar o envio de mensagens ativas com o template order_details usando diferentes métodos de pagamento. Certifique-se de que:
 

  1. O template esteja aprovado no WhatsApp Business Manager
  2. Todos os campos obrigatórios sejam fornecidos
  3. Os valores monetários estejam no formato correto
  4. As configurações de pagamento sejam válidas para cada tipo


 

Para dúvidas ou suporte adicional, consulte a documentação completa da API ou entre em contato com a equipe de desenvolvimento.


 

Artigos relacionados