Como enviar notificações via API Active Campaign no WhatsApp e RCS 30 de setembro de 2026 19:13 Atualizado Contexto Resumo das requisições Entidades Enviando uma campanha Campanha individual Campanha em massa com disparo único Campanha em massa com audiência dinâmica (Beta) Resumo da campanha Audiência da campanha Mensagem da campanha Relatório da campanha Exemplos de disparos ativos via API da ActiveCampaign Perguntas frequentes (FAQ) ContextoPara realizar envios de mensagens ativas via API pela Blip, você deve utilizar a API do Active Campaign . Ela permite a integração e automação de suas campanhas de marketing, gerenciamento de contatos, rastreamento de atividades e muito mais. Com esta API, você pode acessar e manipular dados em tempo real, personalizar fluxos de trabalho automatizados e otimizar suas estratégias de marketing digital.Este artigo contém a documentação com os endpoints, parâmetros de solicitação, exemplos de requisição e respostas esperadas para a criação de campanhas de envio individual ou em lote, para envios pelo canal WhatsApp ou RCS.Antes de começar A chave de acesso (Authorization/Key) utilizada no cabeçalho das requisições deve sempre corresponder ao bot que possui o canal conectado. Para localizar sua chave de acesso, acesse a documentação: Como encontrar a API-KEY do meu bot? Se você estiver trabalhando com uma arquitetura que envolve múltiplos subbots vinculados a um bot roteador, a chave de acesso deve sempre ser a do bot roteador. Caso contrário, utilize a chave específica do subbot; Não é possível fazer o envio de mensagens ativas em templates que possuem Flows; Resumo das requisiçõesCriar nova campanha: /campaign/full /campaign/v2 /audiences/v2/{CAMPAIGN_ID} /audiences/v2/{CAMPAIGN_ID}/file /dispatch/v2 Resumo da campanha /campaigns/summaries /campaigns/{CAMPAIGN_ID}/summaries Público da campanha/audiences/{CAMPAIGN_ID}Mensagens da campanha/messages/{CAMPAIGN_ID}Relatório da campanha/campaigns/{CAMPAIGN_ID}/reports EntidadesA integração com a API do Active Campaign baseia-se em três entidades principais: Campanha, Audiência e Mensagem. CampanhaUma campanha refere-se a uma ação de envio de mensagens de forma individual ou em massa (Campaign Type) para um grupo específico de usuários. É uma forma de alcançar e se comunicar com um grande número de usuários de forma automatizada e eficiente. Através da plataforma, os desenvolvedores e profissionais de marketing podem criar campanhas que enviam mensagens para o WhatsApp. É possível configurar o redirecionamento do cliente para uma etapa (StateId) do fluxo do bot (FlowId) ao responder uma mensagem. As campanhas podem ser configuradas para enviar mensagens em tempo real ou agendadas (scheduled) para um horário específico. Campos da entidade da campanha Campo Descrição Obrigatório Id Identificador único da campanha. Name O nome da campanha. * CampaignType O tipo de estratégia de envio da campanha. Individual ou em massa. * Scheduled A data para agendamento da campanha. O padrão de formato de data esperado é UTF MasterState Bot onde a campanha será direcionada. Ou seja, bot onde o cliente irá seguir o fluxo após responder o envio. O formato é IdDoBot@msging.net. FlowId Identificação do fluxo do bot. É único por bot e pode ser recuperado dentro das configurações do builder (Obrigatório). StateId Identificador do bloco, ou seja, o estado específico em que o cliente será direcionado após responder. Você pode obter essa informação, selecionando o bloco no Builder e clicando em ‘Copiar Id’. ChannelType É a definição do canal que será utilizado no disparo. Se não for informado, então utilizará o canal WhatsApp como padrão. WhatsApp ou GoogleRcs SourceApplication Identificador de ferramenta de origem da campanha. Caso as campanhas tem múltiplas origens, esse campo pode ajudar a marcar onde cada uma foi criada. WhatsApp ou GoogleRcs Tags Elementos personalizados que permitem agrupamentos das campanhas. Conteúdo deve ser passado como um array. WhatsApp ou GoogleRcs AudiênciaA audiência é o público-alvo específico da campanha de marketing, composta por uma lista de indivíduos que receberão a mensagem. Cada item contém um número de telefone (recipient) e os parâmetros referentes a ele que serão adicionados à mensagem (messageParams). No campo MessageParams, todos os valores (exceto o número de telefone) serão salvos nos extras do contato (contact.extras). Isso permite incluir dados como idade, localização geográfica, preferências de produto, histórico de compras, entre outros, para permitir segmentação e análise mais eficazes. Os "dados extras dos contatos" se referem a informações adicionais armazenadas sobre cada contato em um sistema de gerenciamento de contatos. Esses dados extras podem incluir campos personalizados que capturam informações específicas sobre cada contato, para permitir segmentação, personalização e análise mais eficazes das campanhas de marketing. Por exemplo, além dos dados comuns como nome e e-mail, você pode adicionar campos extras para armazenar informações como idade, localização geográfica, preferências de produto, histórico de compras, entre outros. No campo ContextVariables, todos os valores adicionados serão salvos no contato como variável de contexto. Você pode utilizar esses valores dentro de um fluxo com {{context.nomeVariavel}} ou apenas {{nomeVariavel}}. Caso seja um objeto complexo, pode usar {{nomeVariavel@empresaId}} Campos da entidade da audiência: Campo Descrição Obrigatório Recipient Quem irá receber a campanha. Deve ter DDI + DDD + número de telefone. O formato MSISDN será aplicado ao número, caso contrário. * MessageParams Parâmetros que fazem parte da personalização da mensagem. Se houver, adicione como dicionário. ContextVariables Parâmetros que fazem parte da personalização das variáveis do contexto do contato. Se houver necessidade de adicionar variáveis de contexto, adicione como dicionário. MensagemRepresenta a mensagem que será enviada na campanha de marketing. Possui o nome do template (message Template) que contém o conteúdo da mensagem e uma lista de parâmetros utilizados para personalizar a mensagem com os valores específicos de cada destinatário (messageParams).Campos da entidade da mensagem Campo Descrição Obrigatório MessageTemplate Nome do template da mensagem Não existe template caso seja o canal RCS MessageParams Parâmetros que fazem parte da personalização da mensagem. Obs: O número de parâmetros precisa ser a quantidade exata de parâmetros do seu modelo de mensagem escolhido. Total de caracteres: 250 Listada em formato de array MessageContent Campo que possui o conteúdo da mensagem caso seja o canal RCS ChannelType É a definição do canal que será utilizado no disparo. Se não for informado, então utilizará o canal WhatsApp como padrão. WhatsApp ou GoogleRcs Enviando uma campanhaA API do Active Campaign permite a criação de campanhas para envio individual ou em lote. Para criar e enviar uma campanha, você precisará preencher as entidades de campanha, audiência e mensagem conforme as orientações anteriores.Após a requisição, os seguintes campos retornam na resposta: Campo Descrição Status O status de envio da campanha. Created A data e hora de criação da campanha. FailedReason Motivo em caso de falha no envio. Campanha individualPara realizar o disparo imediato de uma mensagem indiviaul, utilize o endpoint /campaign/full configurado com "campaignType": "Individual". É necessário enviar como "resource" um objeto que contenha as propriedades: campaign, audience e message. Endpoint: POST https://{{sua_url}}.http.msging.net/commands Cabeçalhos (Headers): Content-Type: application/json Authorization: Key SUA_CHAVE_DE_AUTENTICACAO_AQUI Requisição para WhatsApp{ "id": "%commandId", "to": "postmaster@activecampaign.msging.net", "method": "set", "uri": "/campaign/full", "type": "application/vnd.iris.activecampaign.full-campaign+json", "resource": { "campaign": { "name": "Campanha individual completo e sem disparo", "campaignType": "Individual", "flowId": "{flowId}", "stateId": "{stateId}", //only for router "masterstate": "masterstate@msging.net", "channelType": "WhatsApp", "sourceApplication": "Postman", "tags": ["value1","valeu2","valeu3" ], }, "audience": { "recipient": "+5531999...", "messageParams": { "1": "Repasse do novo Broadcast" }, "contextVariables": { "cpf": "123456789001", "cpf2": 1000111222, "canUseTheseValues": false, "specificContext": { "foo": "111specififForFoo44431", "bar": "222specififForBar55512" } }, "message": { "messageTemplate": "email_commerce_resposta", "messageParams": [ "1" ], "channelType": "WhatsApp" } } }Requisição para Google RCS{ "id": "%commandId", "to": "postmaster@activecampaign.msging.net", "method": "set", "uri": "/campaign/full", "type": "application/vnd.iris.activecampaign.full-campaign+json", "resource": { "campaign": { "name": "Campanha individual completo e sem disparo", "campaignType": "Individual", "flowId": "{flowId}", "stateId": "{stateId}", //only for router "masterstate": "masterstate@msging.net", "channelType": "GoogleRcs" "sourceApplication": "Postman", "tags": ["value1","valeu2","valeu3" ], }, "audience": { "recipient": "+5531999...", "messageParams": { "1": "Repasse do novo Broadcast" }, }, "message": { "messageContent": "Exemplo de mensagem", "messageParams": [ "1" ], "channelType": "GoogleRcs" } } }Resposta{ "type": "application/vnd.iris.activecampaign.campaign+json", "resource": { "id": "37162f14-2d45...", "name": "Campanha individual completo e disparo", "campaignType": "INDIVIDUAL", "flowId": "{flowId}", "stateId": "{stateId}" "status": "processing", "created": "2021-10-22T14:14:02.310Z" }, "method": "set", "status": "success", "id": "...", "from": "...", "to": "...", "metadata": { "#command.uri": "..." } }Caso haja necessidade de ter informações extras em cada contato, é possível adicionar parâmetros dentro do objeto audience na propriedade messageParams, nomeados como por exemplo “extras1”, “extras2”, e assim por diante. Não necessariamente precisa ser definido como “extra1” ou “extra2”, o importante é seguir o padrão de “chave” e “valor”.Dessa forma:"audience": { "recipient": "+55319...", "messageParams": { "1": "valor", "2": "dois", "extras1": " dados ocultos", "extras2": "que serão ser armazenadas no contato" } }Campanha em massa com disparo únicoPara enviar uma campanha para vários contatos simultaneamente, o objeto resource deve possuir as propriedades: campaign, audiences e message. O campo audiences deve ser um array e a informação definida no campaignType deve ser "Batch".Endpoint: /campaign/fullRequisição para WhatsApp{ "id": "%commandId", "to": "postmaster@activecampaign.msging.net", "method": "set", "uri": "/campaign/full", "type": "application/vnd.iris.activecampaign.full-campaign+json", "resource": { "campaign": { "name": "Campanha batch completo e sem disparo", "campaignType": "Batch", "flowId": "{flowId}", "stateId": "{stateId}", //only for router "masterstate": "masterstate@msging.net", "channelType": "WhatsApp" "sourceApplication": "Postman", "tags": ["value1","valeu2","valeu3" ], }, "audiences": [ { "recipient": "+55319...", "messageParams": { "1": "Repasse do novo Broadcast" } }, { "recipient": "+55319..", "messageParams": { "1": "Repasse do novo Broadcast 2" }, } ], "message": { "messageTemplate": "email_commerce_resposta", "messageParams": [ "1" ], "channelType": "WhatsApp" } } }Requisição para GoogleRcs{ "id": "%commandId", "to": "postmaster@activecampaign.msging.net", "method": "set", "uri": "/campaign/full", "type": "application/vnd.iris.activecampaign.full-campaign+json", "resource": { "campaign": { "name": "Campanha batch completo e sem disparo", "campaignType": "Batch", "flowId": "{flowId}", "stateId": "{stateId}", //only for router "masterstate": "masterstate@msging.net", "channelType": "GoogleRcs", "sourceApplication": "Postman", "tags": ["value1","valeu2","valeu3" ], }, "audiences": [ { "recipient": "+55319...", "messageParams": { "1": "Repasse do novo Broadcast" } }, { "recipient": "+55319..", "messageParams": { "1": "Repasse do novo Broadcast 2" }, } ], "message": { "messageContent": "Mensagem de teste", "messageParams": [ "1" ], "channelType": "GoogleRcs" } } }Resposta{ "type": "application/vnd.iris.activecampaign.campaign+json", "resource": { "id": "37162f14-2d45-...", "name": "Campanha individual completo e disparo", "campaignType": "INDIVIDUAL", "flowId": "{flowId}", "stateId": "{stateId}" "status": "processing", "created": "2021-10-22T14:14:02.310Z" }, "method": "set", "status": "success", "id": "...", "from": "...", "to": "...", "metadata": { "#command.uri": "..." } }Campanha em massa com audiência dinâmica (Beta)Essa abordagem envolve a utilização de múltiplas requisições, uma pra criar a campanha, várias para adicionar a audiência e, posteriormente, uma última para disparar a campanha. Ao contrário da campanha em massa com disparo único, onde tudo é feito em uma única requisição, o fluxo dinâmico oferece maior controle e flexibilidade ao separar as etapas em diferentes requisições. Com o fluxo dinâmico, você pode ter um controle mais granular sobre cada etapa do processo de campanha.Criação da campanhaEndpoint: /campaign/v2Requisição para WhatsApp{ "id": "{{$guid}}", "to": "postmaster@activecampaign.msging.net", "method": "set", "uri": "/campaign/v2", "type": "application/vnd.iris.activecampaign.campaign-dynamic+json", "resource": { "campaign": { "name": "Campanha em Massa postman {{$guid}}", "campaignType": "Batch", "flowId": "{{flowId}}", "stateId": "{{stateId}}" //only for router "masterstate": "masterstate@msging.net", "channelType": "WhatsApp", "sourceApplication": "Postman", "tags": ["value1","valeu2","valeu3"], }, "message": { "messageTemplate": "{{messageTemplate}}", "channelType": "WhatsApp" } } }Requisição para GoogleRcs{ "id": "{{$guid}}", "to": "postmaster@activecampaign.msging.net", "method": "set", "uri": "/campaign/v2", "type": "application/vnd.iris.activecampaign.campaign-dynamic+json", "resource": { "campaign": { "name": "Campanha em Massa postman {{$guid}}", "campaignType": "Batch", "flowId": "{{flowId}}", "stateId": "{{stateId}}" //only for router "masterstate": "masterstate@msging.net", "channelType": "GoogleRcs", "sourceApplication": "Postman", "tags": ["value1","valeu2","valeu3"], }, "message": { "messageContent": "Exemplo de mensagem", "channelType": "GoogleRcs" } } }Resposta{ "type": "application/vnd.iris.activecampaign.campaign+json", "resource": { "id": "ffc99160-5182...", "name": "Campanha em Massa", "campaignType": "BATCH", "flowId": "f7bfd815-1327...", "stateId": "onboarding", "status": "new", "created": "2024-06-03T17:21:05.577Z" }, "method": "set", "status": "success", "id": "...", "from": "...", "to": "...", "metadata": { "traceparent": "...", "#command.uri": "..." } } Inclusão de audiênciaA inclusão de audiência pode ser chamada quantas vezes for necessário limitado apenas a quantidade de audiência aceita na campanha.Envio de lista na requisiçãoEndpoint: /audiences/v2/{{id da campanha criada}}Requisição{ "id": "{{$guid}}", "to": "postmaster@activecampaign.msging.net", "method": "set", "uri": "/audiences/v2/{{resource.id}}", "type": "application/vnd.lime.collection+json", "resource": { "itemType": "application/vnd.iris.activecampaign.audience+json", "items": [ {"recipient": "+5520900000001"}, {"recipient": "+5520900000002"}, {"recipient": "+5520900000003"} ] } }Resposta{ "type": "application/vnd.iris.activecampaign.audience-json+json", "resource": { "": [], "TotalValidNumbers": 3, "TotalInvalidNumbers": 0, "Status": "Success" }, "method": "set", "status": "success", "id": "...", "from": "...", "to": "...", "metadata": { "traceparent": "...", "#command.uri": "..." } }Envio de lista por arquivo CSVEndpoint: /audiences/v2/{{id da campanha criada}}Requisição{ "id": "{{$guid}}", "to": "postmaster@activecampaign.msging.net", "method": "set", "uri": "/audiences/v2/{{create_campaign}}/file", "type": "application/vnd.iris.activecampaign.audience-file+json", "resource": { "url": "{{create_bach_file}}" } }Resposta{ "type": "application/vnd.iris.activecampaign.audience-json+json", "resource": { "": [], "TotalValidNumbers": 3, "TotalInvalidNumbers": 0, "Status": "Success" }, "method": "set", "status": "success", "id": "e3a955cb-d2bb-42f5-892d-430a7355872a", "from": "postmaster@activecampaign.msging.net/#msging-application-activecampaign-c76f85944-526dw", "to": "whatsappcloudapihmg@msging.net/!msging-server-l5xk4-mibif7au", "metadata": { "traceparent": "00-5ad953eb416091184339a794fe08814e-d15f81f9a03b326f-01", "#command.uri": "lime://whatsappcloudapihmg@msging.net/audiences/v2/00a54137-b1f4-483b-99aa-f7c854b8146d/file" } }ObservaçõesPara informar as variáveis de contexto no csv, é possível passar um json escapado, conforme exemplo, com a coluna de título #contextvariables#Exemplo: {\"cpf\":\"123456789001\",\"cpf2\":1000111222,\"canUseTheseValues\":false,\"specificContext\":{\"foo\":\"111specififForFoo44431\",\"bar\":\"222specififForBar55512\"} Envio da campanhaTrata-se da ação de enviar a campanha que foi criada e que possui sua audiência preenchida. Obs: Uma vez a campanha enviada, não é mais possível incluir novas audiências.Endpoint: /dispatch/v2Requisição{ "id": "{{$guid}}", "to": "postmaster@activecampaign.msging.net", "method": "set", "uri": "/dispatch/v2", "type": "application/vnd.iris.activecampaign.campaign+json", "resource": { "id": "{{create_campaign}}" } }Resposta{ "method": "set", "status": "success", "id": "...", "from": "...", "to": "...", "metadata": { "traceparent": "...", "#command.uri": "..." } } Resumo da campanhaAtravés dessa funcionalidade, você terá acesso a informações importantes sobre suas campanhas, permitindo uma análise detalhada do desempenho e status do público-alvo.Obs: Se nenhum filtro for informado, serão retornadas todas as campanhas criadas na data informada ou posterior. A requisição pode receber os seguintes dados como filtro: Campo Descrição SourceApplication Origem da campanha, exemplo: Portal, Desk, Broadcast-Plugin ou API. CampaignSender Quem enviou a campanha. Created A data que determina quais campanhas serão incluídas na resposta da requisição. Somente as campanhas criadas nessa data serão consideradas. No caso do filtro criado não ser informado, serão retornadas todas as campanhas criadas na data informada ou posterior.A resposta da requisição é composta por: Campo Descrição id Identificador da campanha messageTemplate Nome do modelo de mensagem name Nome da campanha sendDate Data de envio e status do público-alvo FlowId Identificação do fluxo do bot. StateId Identificador do bloco enviado statusAudience O Status da audiência é composto por uma lista com o status de processamento do destinatário e identidade RequisitosÉ necessário ter pelo menos uma campanha registrada para o bot.ComandosObter o resumo das campanhasAo utilizar essa requisição, serão retornadas as campanhas que atendem aos critérios do filtro informado.Endpoint: /campaigns/summariesRequisição{ "id": "{commandId}", "to": "postmaster@activecampaign.msging.net", "method": "get", "uri": "/campaigns/summaries?created=2022-06-26T18%3A02%3A40.000Z&SourceApplication=Portal&CampaignSender=user.sender@take.net" }Resposta{ "type": "application/vnd.lime.collection+json", "resource": { "total": 1, "itemType": "application/vnd.iris.activecampaign.campaignsummary+json", "items": [ { "id": "{id}", "messageTemplate": "email_commerce_resposta", "sendDate": "2022-06-14T18:02:40.300Z", "statusAudience": [ { "RecipientIdentity": "555555555555@wa.gw.msging.net", "Status": "FAILED", "ReasonCode": 61, "ReasonDescription": "An unexpected error occurred while set transaction." }, { "RecipientIdentity": "555555555551@wa.gw.msging.net", "Status": "READ" } ] } ] }, "method": "get", "status": "success", "id": "...", "from": "postmaster@activecampaign.msging.net/#...", "to": "whatsapp2@msging.net/...", "metadata": { "#command.uri": "...", "uber-trace-id": "..." } } Obter o resumo de uma campanha específicaPara obter o resumo de uma campanha específica, você pode usar esta requisição fornecendo o ID da campanha. Isso permitirá que você obtenha informações detalhadas sobre essa campanha específica, como template utilizado, data de envio e status do público-alvo.Endpoint: /campaigns/{Id da campanha}/summariesRequisitosO ID da campanhaRequisição{ "id": "%commandId", "to": "postmaster@activecampaign.msging.net", "method": "get", "uri": "/campaigns/{Id da campanha}/summaries" }Resposta{ "type": "application/vnd.lime.collection+json", "resource": { "total": 1, "itemType": "application/vnd.iris.activecampaign.campaignsummary+json", "items": [ { "id": "{id}", "messageTemplate": "email_commerce_resposta", "sendDate": "2022-06-14T18:02:40.300Z", "statusAudience": [ { "RecipientIdentity": "555555555555@wa.gw.msging.net", "Status": "FAILED", "ReasonCode": 61, "ReasonDescription": "An unexpected error occurred while set transaction." }, { "RecipientIdentity": "555555555551@wa.gw.msging.net", "Status": "READ", } ] } ] }, "method": "get", "status": "success", "id": "...", "from": "postmaster@activecampaign.msging.net/...", "to": "whatsapp2@msging.net/...", "metadata": { "#command.uri": "...", "uber-trace-id": "..." } } Audiência da campanhaA audiência de uma campanha é o público-alvo específico da campanha de marketing. Ela é composta por um grupo de indivíduos, sendo que a escolha destes pode ser com base em critérios demográficos, comportamentais ou outros fatores relevantes.Com nossa API, você pode obter informações sobre a audiência de uma campanha.Campos da entidade da audiência Campo Descrição Obrigatório Recipient O número de telefone do destinatário da mensagem. Somente números de telefone válidos serão considerados. * MessageParams O dicionário com os nomes e valores dos parâmetros do modelo de mensagem. Campos da resposta Campo Descrição Total Total da audiência Items Lista especificando a audiência Os itens são compostos por: Campo Descrição CampaignId Id da campanha Recipient O destinatário da mensagem RecipientType O tipo referente ao que foi enviado em recipient, por exemplo, se é número de celular ChannelType O canal em que o público foi alcançado MessageParams Parâmetros que foram enviados na mensagem. Limite máximo de caracteres é de 250. Status O status do envio AudienceStatus O status de envio do público-alvo. ValidatedAccount A conta validada do público-alvo. Received A data e hora em que a mensagem foi recebida. Read A data e hora em que a mensagem foi lida. Failed A data e hora em que a mensagem falhou. ReasonCode O código do motivo de falha. ReasonDescription A descrição do motivo de falha. Obter audiência da campanhaEndpoint: /audiences/{Id da campanha}Podemos usar esse endpoint para obter a audiência de uma campanha específica. RequisitosO ID da campanha.Requisição{ "id": "%commandId", "to": "postmaster@activecampaign.msging.net", "method": "get", "uri": "/audiences/{id da campanha}", }Resposta{ "type": "application/vnd.lime.collection+json", "resource": { "total": 1, "itemType": "application/vnd.iris.activecampaign.audience+json", "items": [ { "OwnerIdentity": "whatsappcloudapi@msging.net", "CampaignId": "....", "recipient": "+5531...", "recipientType": "PhoneNumber", "channelType": "WHATSAPP", "messageParams": { "1": "valor", "2": "dois", "extras1": " dados ocultos", "extras2": "que serão ser armazenadas no contato" }, "status": "VALID", "validatedAccount": "553197...@wa.gw.msging.net", "processed": "2024-05-16T18:54:31.930Z", "received": "2024-05-16T18:54:39.290Z", "read": "2024-05-16T18:55:40.980Z" } ] }, "method": "get", "status": "success", "id": "%commandId", "from": "...", "to": "...": { "traceparent": "...", "#command.uri": "..." } } Mensagem da campanha Campos do template da mensagem Campo Descrição Obrigatório ChannelType O tipo de canal. "WhatsApp" = Padrão ou “GoogleRcs” MessageTemplate O nome do template da mensagem. Usado com o canal WhatsApp MessageContent O conteúdo da mensagem Usado com o canal RCS MessageTemplateLanguage* O idioma do template da mensagem. MessageParams A lista de nomes de parâmetros. Esse valor é usado para validar o número de parâmetros do público-alvo quando a campanha é individual. *O ActiveCampaign define Português (PT-BR) como idioma padrão. Portanto, ao enviar uma notificação ativa via API em outro idioma, é obrigatório especificar o campo messageTemplateLanguage.Campos da RespostaA resposta é composta por: Campo Descrição Total Total de mensagens Items Lista das mensagens enviadas O campo Items é composto por: Campo Descrição ChannelType Tipo de canal MessageTemplate Nome do template da mensagem MessageParams Parâmetros que foram enviados na mensagem. Obter as mensagens de uma campanhaEndpoint: /messages/{campaignId}RequisitosO ID da campanhaRequisição{ "id": "%commandId", "to": "postmaster@activecampaign.msging.net", "method": "get", "uri": "/messages/{CAMPAIGN_ID}", }Resposta{ "type": "application/vnd.lime.collection+json", "resource": { "total": 1, "itemType": "application/vnd.iris.activecampaign.message+json", "items": [ { "channelType": "WHATSAPP", "messageTemplate": "email_commerce_resposta", "messageParams": "1" } ] }, "method": "get", "status": "success", "id": "%id", "from": "postmaster@activecampaign.msging.net/#note-mc159", "to": "whatsapp1@msging.net/default", "metadata": { "#command.uri": "lime://whatsapp1@msging.net/messages/{CAMPAIGN_ID}" } } Relatório da campanha Para obter um relatório do estado de uma campanha, você pode usar esta requisição. O relatório inclui informações sobre o modelo de mensagem utilizado na campanha e o destino de redirecionamento. Isso permitirá que você tenha uma visão abrangente do desempenho e dos resultados da campanha, ajudando a tomar decisões para otimização futura.RequisitosId da campanhaCampos da RespostaA resposta é composta por: Campo Descrição Id Id da campanha Name Nome da campanha MessageTemplate Modelo de mensagem escolhido para a campanha. MasterState O estado principal da campanha, se o bot for um roteador. FlowId ID do Fluxo da campanha. StateId ID do Estado da campanha. StateName Nome do Estado da campanha. AttendanceRedirect E-mail do atendente para quem a campanha será redirecionada, caso essa opção tenha sido escolhida. CampaignSender E-mail de quem enviou a campanha. SendDate Data em que a campanha foi enviada. StatusAudience Uma lista de status dos números da campanha. A propriedade StatusAudience é uma lista em que cada item é composto por: Campo Descrição RecipientIdentity Número do contato. Se não ocorreu nenhum erro durante o pré-processamento desse número, será exibido o número validado fornecido pelo Whatsapp. Caso contrário, será exibido o número fornecido no arquivo de público-alvo ou na requisição no momento da criação da campanha. Status O status do público-alvo no momento da solicitação. ReasonCode O código do motivo da falha do público-alvo. ReasonDescription A descrição do motivo de falha do público-alvo. Processed A data e hora em que o público-alvo foi enviado ao usuário final. Received A data e hora em que o público-alvo foi recebido pelo usuário final. Read A data e hora em que o público-alvo foi lido pelo usuário final. Failed A data e hora em que o público-alvo falhou. NumberStatus O status de processamento do público-alvo. Obter relatório de uma campanha específicaEndpoint: /campaigns/{campaignId}/reportsRequisição{ "id": "%commandId", "to": "postmaster@activecampaign.msging.net", "method": "get", "uri": "/campaigns/{campaignId}/reports?shouldHaveStateName=true" }Resposta{ "type": "application/vnd.iris.activecampaign.campaignsummary+json", "resource": { "id": "#campaignId", "name": "%name", "messageTemplate": "berlin_fttr_monitoramento_", "flowId": "%flowId", "stateName": "welcome", "stateId": "%stateId8", "sendDate": "2022-11-22T19:58:21.050Z", "statusAudience": [ { "recipientIdentity": "%Number of the contact@wa.gw.msging.net", "status": "PROCESSED", "processed": "2022-11-22T19:58:24.050Z", "numberStatus": "VALID" }, { "recipientIdentity": "%Number of the contac 2@wa.gw.msging.net", "status": "PROCESSED", "processed": "2022-11-22T19:58:23.910Z", "numberStatus": "VALID" }, { "recipientIdentity": "+%Number of the contac 3", "status": "FAILED", "reasonCode": 1505, "reasonDescription": "Invalid recipient for WhatsApp channel.", "failed": "2022-11-22T07:57:44.000Z", "numberStatus": "INVALID" } ] }, "method": "get", "status": "success", "id": "%id", "from": "postmaster@activecampaign.msging.net/#hmg-az-iris2", "to": "whatsapp2@msging.net/default", "metadata": { "#command.uri": "lime://whatsapp2@msging.net/campaigns/{campaignId}/reports", "uber-trace-id": " %trace-id" } } Exemplos de disparos ativos via API da ActiveCampaign Consulte nosso guia de exemplos de requisições para cada tipo de template: Guia técnico: Exemplos de disparos ativos via API da ActiveCampaign Perguntas frequentes (FAQ)É possível fazer um disparo por v2 com agendamento? Existe essa possibilidade sim, basta informar o campo ‘Scheduled’ no formato ‘aaaa-MM-dd hh:mm’ da entidade Campanha. É possível cancelar uma campanha agendada? Você pode cancelar um agendamento enviando um comando DELETE. Substitua {campaignId} pelo id da campanha para a mensagem programada que você deseja excluir.A campanha vai ser excluída e o agendamento cancelado.Corpo da Requisição:{ "id": "{{$guid}}", "to": "postmaster@activecampaign.msging.net", "method": "delete", "uri": "/campaigns/{campaignId}}" }Após o agendamento de campanha, é possível inserir mais dados no agendamento? Não é possível mudar (acrescentar ou editar) valores de uma campanha quando elas estão agendadas, para isso, é preciso excluir o agendamento e criar uma nova campanha.Disparo de campanhas no modo manual, gera evidência de que a mensagem foi disparada? Para realizar o disparo de mensagem ativa manual, é possível agendar ou realizar os disparos pelo growth, e todas as informações serão registradas na tela, sejam as que falharam, que foram recebidas ou que foram lidas:É possível realizar um disparo sem direciona-lo para um ponto especifico do fluxo?Sim, o estado do usuário é definido pelo StateId e FlowId. Basta não incluir essas linhas em seu disparo, que ao responder, o cliente será direcionado para o bloco Inicio do bot principal. 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 😃 Artigos relacionados Como configurar e enviar Mensagens Ativas do WhatsApp no Blip Desk FAQs - Smart Care Como agendar campanhas de mensagens ativas no WhatsApp Política de upload de mídias no Blip Engaje usuários a iniciar conversas utilizando Ice Breakers no Instagram