Guia de Migração: /messages → /campaign/full (API Active Campaign Growth)

1. Visão geral das duas abordagens

2. Diferenças conceituais principais

3. Exemplo prático

4. Mapeamento dos tipos de componentes do template para chaves de messageParams

5. Campos sem equivalente

6. Campos opcionais da campanha

7. Estrutura da resposta

8. Checklist de migração

9. Documentação de apoio

Este documento descreve como migrar o envio de mensagens com template WhatsApp do endpoint LIME /messages para a API Active Campaign Growth utilizando o endpoint /campaign/full.

Visão geral das duas abordagens

Diferenças conceituais principais

1. Endpoint HTTP e primitiva de protocolo

Esta é a diferença mais importante entre as duas abordagens.

Antes (/messages) — o payload é uma mensagem LIME enviada ao endpoint /messages:

POST https://{{contract.id}}.http.msging.net/messages HTTP/1.1
Content-Type: application/json
Authorization: Key {YOUR_TOKEN}

Depois (/campaign/full) — o payload é um comando LIME enviado ao endpoint /commands:

POST https://{{contract_id}}.http.msging.net/commands HTTP/1.1
Content-Type: application/json
Authorization: Key {YOUR_TOKEN}

No protocolo LIME, mensagens são usadas para troca direta de conteúdo entre o bot e um usuário final. Comandos são usados para interagir com extensões e serviços da plataforma, como o Active Campaign. Por isso, além de trocar o endereço de destino, toda a estrutura do envelope muda: o campo content dá lugar a method, uri e resource.

2. Estrutura do template

A segunda grande diferença é a forma como os parâmetros do template são expressos.

Antes (/messages) — árvore completa de componentes WhatsApp:

{
  "type": "template",
  "template": {
    "language": {
      "policy": "deterministic",
      "code": "pt_BR"
    },
    "name": "dia_do_doce_v11",
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "image",
            "image": {
              "link": "https://example.com/image.jpg"
            }
          }
        ]
      }
    ]
  }
}

Depois (/campaign/full) — nome do template + parâmetros nomeados:

"message": {
  "messageTemplate": "dia_do_doce_v11",
  "messageTemplateLanguage": "pt_BR",
  "messageParams": ["image"],
  "channelType": "WhatsApp"
}

O serviço Active Campaign reconstrói a árvore de componentes WhatsApp internamente a partir dos metadados do template e dos valores fornecidos em audience.messageParams. Não é mais necessário descrever a estrutura dos componentes.

3. Vinculação de parâmetros

Na abordagem /messages, os valores dos parâmetros ficam embutidos diretamente na árvore de componentes. No /campaign/full, os valores são informados separadamente por destinatário no objeto audience.messageParams (dicionário chave → valor), enquanto message.messageParams carrega apenas a lista de nomes das chaves (o schema), usada para validar que cada destinatário possui os valores necessários.

Exemplo prático

Antes — envio via /messages

POST https://{{contract.id}}.http.msging.net/messages HTTP/1.1
Content-Type: application/json
Authorization: Key {YOUR_TOKEN}


{
  "id": "activecampaign:335924e6-6831-4ddf-b400-2296cf6c94cc",
  "to": "5592994397150@wa.gw.msging.net",
  "type": "application/json",
  "content": {
    "type": "template",
    "template": {
      "language": {
        "policy": "deterministic",
        "code": "pt_BR"
      },
      "name": "dia_do_doce_v11",
      "components": [
        {
          "type": "header",
          "parameters": [
            {
              "type": "image",
              "image": {
                "link": "https://www.iped.com.br/_upload/galleries/2015/05/19/organizao-pblica-555b72de0abc9.jpg"
              }
            }
          ]
        }
      ]
    }
  }
}

Características:

• Mensagem direta, nenhum registro de campanha é criado.
• Nenhum redirecionamento para fluxo do bot.
• Nenhum rastreamento de entrega.
• Idioma do template pt_BR com política deterministic.

Depois — envio via /campaign/full

POST https://{{contract_id}}.http.msging.net/commands HTTP/1.1
Content-Type: application/json
Authorization: Key {YOUR_TOKEN}


{
  "id": "{{$guid}}",
  "to": "postmaster@activecampaign.msging.net",
  "method": "set",
  "uri": "/campaign/full",
  "type": "application/vnd.iris.activecampaign.full-campaign+json",
  "resource": {
    "campaign": {
      "name": "Dia do Doce - individual",
      "campaignType": "Individual",
      "channelType": "WhatsApp",
      "sourceApplication": "MyApp"
    },
    "audience": {
      "recipient": "+5592994397150",
      "messageParams": {
        "image": "https://www.iped.com.br/_upload/galleries/2015/05/19/organizao-pblica-555b72de0abc9.jpg"
      }
    },
    "message": {
      "messageTemplate": "dia_do_doce_v11",
      "messageTemplateLanguage": "pt_BR",
      "messageParams": ["image"],
      "channelType": "WhatsApp"
    }
  }
}

Mudanças notáveis:

1. Endpoint HTTP passou de .../messages para .../commands.

2. to passou para postmaster@activecampaign.msging.net.

3. Adicionados method: "set" e uri: "/campaign/full" — obrigatórios em comandos LIME.

4. O content com a árvore de componentes foi removido; no lugar entram campaign, audience e message dentro de resource.

5. A URL da imagem foi movida para audience.messageParams["image"].

6. O telefone do destinatário foi movido para audience.recipient no formato E.164 (com código do país, sem o sufixo @wa.gw.msging.net).

7. flowId / stateId são omitidos intencionalmente — a mensagem é enviada sem redirecionar o usuário a nenhum fluxo do bot.

8. campaignType é sempre Individual neste cenário (envio para um único destinatário por chamada).

Importante: message.messageParams é um array de nomes de chaves (strings), não de valores. Ele define quais chaves de audience.messageParams serão usadas como parâmetros do template. O serviço Active Campaign utiliza essa lista para validar se o destinatário possui todos os valores necessários antes do disparo.

Mapeamento dos tipos de componentes do template para chaves de messageParams

Quando o template possui múltiplos tipos de componentes, todos os valores de parâmetros são achatados no dicionário audience.messageParams. Use nomes descritivos para as chaves; o serviço os mapeia na ordem de declaração dentro de cada tipo de componente.

Os nomes das chaves são livres, desde que sejam consistentes entre audience.messageParams (valores) e message.messageParams (schema). A ordem em message.messageParams deve corresponder à ordem dos parâmetros no template cadastrado na Meta.

Campos sem equivalente

Os seguintes campos da abordagem /messages não têm equivalente em /campaign/full porque são tratados automaticamente ou não se aplicam:

Campos opcionais da campanha

Estes campos estão ausentes no exemplo mínimo acima, mas estão disponíveis para enriquecimento:

Estrutura da resposta

Em caso de sucesso, o serviço responde com um documento Campaign:

{
  "type": "application/vnd.iris.activecampaign.campaign+json",
  "resource": {
    "id": "37162f14-2d45-...",
    "name": "Dia do Doce - individual",
    "campaignType": "INDIVIDUAL",
    "status": "processing",
    "created": "2026-07-02T14:00:00.000Z"
  },
  "method": "set",
  "status": "success"
}

Utilize o id retornado para consultar o status, os detalhes da audiência e os relatórios de entrega:

GET /campaigns/{id}/reports

GET /audiences/{id}

GET /campaigns/summaries

Checklist de migração

• Trocar o endpoint HTTP de .../messages para .../commands

• Trocar o to da identidade do usuário para postmaster@activecampaign.msging.net

• Alterar o tipo do envelope para application/vnd.iris.activecampaign.full-campaign+json

• Adicionar method: "set" e uri: "/campaign/full"

• Mover o nome do template para message.messageTemplate

• Mover o código do idioma para message.messageTemplateLanguage (obrigatório se diferente de pt_BR)

• Converter os valores dos parâmetros dos componentes para um dicionário plano em audience.messageParams

• Listar os nomes das chaves em message.messageParams (array, mesma ordem dos parâmetros do template cadastrado na Meta)

• Converter o destinatário de numero@wa.gw.msging.net para formato E.164 (ex.: +5592994397150)

• Definir campaign.campaignType como Individual

• Omitir flowId / stateId se não for desejado redirecionamento para fluxo do bot

• Usar messageTemplate, não messageContent, para WhatsApp

Documentação de apoio

• Como enviar notificações via API Active Campaign (Growth) — Blip Help
• Templates Utilitários WhatsApp (Meta for Developers)
• Mensagens de Marketing WhatsApp (Meta for Developers)
• Blip Docs — Enviando Mensagens
• Blip Docs — Campanha Individual

Precisa de mais ajuda? Explore nossos conteúdos na Blip Academy ou Blip Community, assista a tutoriais no nosso canal do YouTube ou tire suas dúvidas em nosso canal de atendimento 😃