Skip to main content

How to Send Notifications via the ActiveCampaign API on WhatsApp and RCS

  • Updated
  1. Context
  2. Request summary
  3. Entities
  4. Sending a campaign
    1. Individual campaign
    2. Mass campaign with a single send
    3. Mass campaign with dynamic audience (Beta)
  5. Campaign summary
  6. Campaign audience
  7. Campaign message 
  8. Campaign report
  9. Examples of active sends via the ActiveCampaign API 
  10. Frequently asked questions (FAQ)

 

Context

To send active messages via the Blip API, you must use the Active Campaign API. It enables the integration and automation of your marketing campaigns, contact management, activity tracking, and much more. With this API, you can access and manipulate data in real time, customize automated workflows, and optimize your digital marketing strategies.

This article contains documentation for the endpoints, request parameters, request examples, and expected responses for creating individual or batch sending campaigns through the WhatsApp or RCS channel.

Before you start

  • The access key (Authorization/Key) used in the request headers must always correspond to the bot that has the connected channel. To locate your access key, see the documentation: How do I find my bot's API-KEY? 

  • If you are working with an architecture involving multiple subbots linked to a router bot, the access key must always be that of the router bot. Otherwise, use the specific subbot key;

  • It is not possible to send active messages using templates that contain Flows;

 

Request summary

Create a new campaign:

  • /campaign/full

  • /campaign/v2

  • /audiences/v2/{CAMPAIGN_ID}

  • /audiences/v2/{CAMPAIGN_ID}/file

  • /dispatch/v2

Campaign summary

  • /campaigns/summaries

  • /campaigns/{CAMPAIGN_ID}/summaries

Campaign audience

  • /audiences/{CAMPAIGN_ID}

Campaign messages

  • /messages/{CAMPAIGN_ID}

Campaign report

  • /campaigns/{CAMPAIGN_ID}/reports

 

Entities

The integration with the Active Campaign API is based on three main entities: Campaign, Audience, and Message. 

 

Campaign

A campaign refers to an individual or mass message-sending action (Campaign Type) for a specific group of users. It is a way to reach and communicate with a large number of users automatically and efficiently.

  • Through the platform, developers and marketing professionals can create campaigns that send messages to WhatsApp.

  • It is possible to configure the redirection of the customer to a step (StateId) in the bot flow (FlowId) when they reply to a message.

  • Campaigns can be configured to send messages in real time or scheduled for a specific time.

Campaign entity fields

Field Description Required
Id Unique campaign identifier.
Name The campaign name. *
CampaignType The campaign's sending strategy type. Individual or mass. *
Scheduled The date scheduled for the campaign. The expected date format standard is UTF
MasterState The bot to which the campaign will be directed. In other words, the bot where the customer will continue the flow after replying to the send. The format is BotId@msging.net.
FlowId Bot flow identification. It is unique per bot and can be retrieved in the Builder settings (Required).
StateId Block identifier, that is, the specific state to which the customer will be directed after replying. You can obtain this information by selecting the block in Builder and clicking ‘Copy Id’.
ChannelType The definition of the channel to be used for the send. If it is not provided, WhatsApp will be used as the default channel. WhatsApp or GoogleRcs
SourceApplication Identifier of the campaign's source tool. If campaigns have multiple sources, this field can help identify where each one was created. WhatsApp or GoogleRcs
Tags Custom elements that allow campaigns to be grouped. Content must be provided as an array. WhatsApp or GoogleRcs

 

Audience

The audience is the specific target audience of the marketing campaign, consisting of a list of individuals who will receive the message.

  • Each item contains a phone number (recipient) and the parameters related to it that will be added to the message (messageParams).

  • In the MessageParams field, all values (except the phone number) will be saved in the contact's extras (contact.extras). This allows you to include data such as age, geographic location, product preferences, purchase history, and more, enabling more effective segmentation and analysis. "Contact extra data" refers to additional information stored about each contact in a contact management system. This extra data may include custom fields that capture specific information about each contact, enabling more effective segmentation, personalization, and analysis of marketing campaigns.
    For example, in addition to common data such as name and email, you can add extra fields to store information such as age, geographic location, product preferences, purchase history, and more.

  • In the ContextVariables field, all added values will be saved to the contact as context variables. You can use these values within a flow with {{context.nomeVariavel}} or simply {{nomeVariavel}}. If it is a complex object, you can use {{nomeVariavel@empresaId}}

 Audience entity fields:

Field Description Required
Recipient

Who will receive the campaign.

It must contain the country code + area code + phone number. The MSISDN format will be applied to the number otherwise.

 *
MessageParams Parameters that are part of the message personalization. If applicable, add them as a dictionary.
ContextVariables Parameters that are part of the personalization of the contact's context variables. If context variables need to be added, add them as a dictionary.

 

Message

Represents the message that will be sent in the marketing campaign. It contains the template name (message Template) with the message content and a list of parameters used to personalize the message with the specific values of each recipient (messageParams).

Message entity fields

Field Description Required
MessageTemplate Message template name There is no template if the channel is RCS
MessageParams

Parameters that are part of the message personalization. 

Note: The number of parameters must be exactly the same as the number of parameters in your selected message template.

Total characters: 250

Listed in array format
MessageContent Field containing the message content when the channel is RCS
ChannelType The definition of the channel to be used for the send. If it is not provided, WhatsApp will be used as the default channel. WhatsApp or GoogleRcs

 

Sending a campaign

The Active Campaign API allows you to create campaigns for individual or batch sending. To create and send a campaign, you must fill in the campaign, audience, and message entities according to the previous guidelines.

After the request, the following fields are returned in the response:

Field Description
Status The campaign sending status.
Created The date and time the campaign was created.
FailedReason Reason in case of a sending failure.

 

Individual campaign

To immediately send an individual message, use the /campaign/full endpoint configured with "campaignType": "Individual". 

You must send a "resource" object containing the following properties: campaign, audience, and message.

  • Endpoint: POST https://{{your_url}}.http.msging.net/commands

  • Headers:

    • Content-Type: application/json

    • Authorization: Key YOUR_AUTHENTICATION_KEY_HERE

WhatsApp request

{
    "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"
            }
    }
}

Google RCS request

{
    "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"
            }
    }
}

Response

{
    "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": "..."
    }
}

If you need to have extra information in each contact, you can add parameters inside the audience object in the messageParams property, named, for example, “extras1”, “extras2”, and so on. They do not necessarily need to be defined as “extra1” or “extra2”; the important thing is to follow the “key” and “value” pattern.

As follows:

"audience": {
    "recipient": "+55319...",
    "messageParams": {
        "1": "valor",
        "2": "dois",
        "extras1": " dados ocultos",
        "extras2": "que serão ser armazenadas no contato"
    }
}

Mass campaign with a single send

To send a campaign to multiple contacts simultaneously, the resource object must contain the following properties: campaign, audiences, and message. The audiences field must be an array, and the information defined in campaignType must be "Batch".

  • Endpoint: /campaign/full

WhatsApp request

{
    "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"
            }
    }
}

GoogleRcs request

{
    "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"
            }
    }
}

Response

{
    "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": "..."
    }
}

Mass campaign with dynamic audience (Beta)

This approach involves using multiple requests: one to create the campaign, several to add the audience, and finally one to send the campaign. Unlike a mass campaign with a single send, where everything is done in a single request, the dynamic flow offers greater control and flexibility by separating the steps into different requests.

 With the dynamic flow, you can have more granular control over each step of the campaign process.

Campaign creation

  • Endpoint: /campaign/v2

WhatsApp request

{
    "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"
        }
    }
}

GoogleRcs request

{
    "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"
        }
    }
}

Response

{
    "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": "..."
    }
}

 

Adding an audience

Audience inclusion can be called as many times as necessary, limited only by the amount of audience accepted in the campaign.

Sending a list in the request

  • Endpoint: /audiences/v2/{{created campaign ID}}

Request

{
    "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"}
        ]
    }
}

Response

{
    "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": "..."
    }
}

Sending a list via CSV file

  • Endpoint: /audiences/v2/{{created campaign ID}}

Request

{
    "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}}"
    }
}

Response

{
    "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"
    }
}

Notes

To provide context variables in the CSV, you can pass escaped JSON, as in the example, using a column titled #contextvariables#

Example: 

{\"cpf\":\"123456789001\",\"cpf2\":1000111222,\"canUseTheseValues\":false,\"specificContext\":{\"foo\":\"111specififForFoo44431\",\"bar\":\"222specififForBar55512\"}
 

Sending the campaign

This is the action of sending the campaign that was created and has its audience populated. 

Note: Once the campaign has been sent, it is no longer possible to add new audiences.

  • Endpoint: /dispatch/v2

Request

{
    "id": "{{$guid}}",
    "to": "postmaster@activecampaign.msging.net",
    "method": "set",
    "uri": "/dispatch/v2",
    "type": "application/vnd.iris.activecampaign.campaign+json",
    "resource": {
     "id": "{{create_campaign}}"
    }
}

Response

{
    "method": "set",
    "status": "success",
    "id": "...",
    "from": "...",
    "to": "...",
    "metadata": {
     "traceparent": "...",
     "#command.uri": "..."
    }
}

 

Campaign summary

Through this feature, you will have access to important information about your campaigns, allowing you to perform a detailed analysis of the performance and status of the target audience.

Note: If no filter is provided, all campaigns created on or after the specified date will be returned. 

The request can receive the following data as filters:

Field Description
SourceApplication Campaign source, for example: Portal, Desk, Broadcast-Plugin, or API.
CampaignSender Who sent the campaign.
Created The date that determines which campaigns will be included in the request response. Only campaigns created on this date will be considered.

If the Created filter is not provided, all campaigns created on or after the specified date will be returned.

The request response consists of: 

Field Description
id Campaign identifier
messageTemplate Message template name
name Campaign name
sendDate Send date and target audience status
FlowId Bot flow identification.
StateId Identifier of the block sent
statusAudience The audience status consists of a list containing the recipient and identity processing status

Requirements

At least one campaign must be registered for the bot.

Commands

Get the campaign summary

When using this request, the campaigns that meet the specified filter criteria will be returned.

  • Endpoint: /campaigns/summaries

Request

{
    "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"
}

Response

{
    "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": "..."
    }
}

 

Get the summary of a specific campaign

To get the summary of a specific campaign, you can use this request by providing the campaign ID. This will allow you to obtain detailed information about that specific campaign, such as the template used, send date, and target audience status.

Endpoint:  /campaigns/{Campaign ID}/summaries

Requirements

  • The campaign ID

Request

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "get",
    "uri": "/campaigns/{Campaign ID}/summaries"
}

Response

{
  "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": "..."
  }
}

 

Campaign audience

A campaign audience is the specific target audience of a marketing campaign. It consists of a group of individuals, who may be selected based on demographic, behavioral, or other relevant criteria.

With our API, you can obtain information about a campaign's audience.

Audience entity fields

Field Description Required
Recipient The phone number of the message recipient. Only valid phone numbers will be considered. *
MessageParams The dictionary containing the names and values of the message template parameters.

Response fields

Field  Description
Total Total audience
Items List specifying the audience

The items consist of:

Field Description
CampaignId Campaign ID
Recipient The message recipient
RecipientType The type referring to what was sent in recipient, for example, whether it is a mobile phone number
ChannelType The channel through which the audience was reached
MessageParams

Parameters sent in the message. 

Maximum character limit is 250.
Status Send status
AudienceStatus The target audience's send status.
ValidatedAccount The target audience's validated account.
Received The date and time when the message was received.
Read The date and time when the message was read.
Failed The date and time when the message failed.
ReasonCode The failure reason code.
ReasonDescription The description of the failure reason.

 

Get campaign audience

  • Endpoint: /audiences/{Campaign ID}

This endpoint can be used to obtain the audience of a specific campaign. 

Requirements

  • The campaign ID.

Request

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "get",
    "uri": "/audiences/{campaign ID}",
}

Response

{
  "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": "..."
  }
}

 

Campaign message 

Message template fields

Field Description Required
ChannelType

The channel type. 

"WhatsApp" = Standard or

“GoogleRcs”
MessageTemplate The message template name. Used with the WhatsApp channel
MessageContent The message content Used with the RCS channel
MessageTemplateLanguage* The message template language.
MessageParams The list of parameter names. This value is used to validate the number of audience parameters for an individual campaign.

*ActiveCampaign defines Portuguese (PT-BR) as the default language. Therefore, when sending an active notification via the API in another language, it is mandatory to specify the messageTemplateLanguage field.

Response fields

The response consists of:

Field Description
Total Total messages
Items List of sent messages

The Items field consists of:

Field Description
ChannelType Channel type
MessageTemplate Message template name
MessageParams Parameters sent in the message.

 

Get a campaign's messages

  • Endpoint: /messages/{campaignId}

Requirements

  • The campaign ID

Request

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "get",
    "uri": "/messages/{CAMPAIGN_ID}",
}

Response

{
  "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}"
  }
}


Campaign report

To obtain a report on a campaign's status, you can use this request. The report includes information about the message template used in the campaign and the redirection destination. This will provide you with a comprehensive view of the campaign's performance and results, helping you make decisions for future optimization.

Requirements

  • Campaign ID

Response fields

The response consists of:

Field Description
Id Campaign ID
Name Campaign name
MessageTemplate Message template selected for the campaign.
MasterState The campaign's main state, if the bot is a router.
FlowId Campaign flow ID.
StateId Campaign state ID.
StateName Campaign state name.
AttendanceRedirect The attendant's email address to whom the campaign will be redirected, if this option was selected.
CampaignSender The email address of the person who sent the campaign.
SendDate The date on which the campaign was sent.
StatusAudience A list of statuses for the campaign numbers.

The StatusAudience property is a list in which each item consists of:

Field Description
RecipientIdentity Contact number. If no errors occurred during preprocessing of this number, the validated number provided by WhatsApp will be displayed. Otherwise, the number provided in the audience file or request at the time the campaign was created will be displayed.
Status The target audience's status at the time of the request.
ReasonCode The reason code for the target audience failure.
ReasonDescription The description of the target audience failure reason.
Processed The date and time when the target audience was sent to the end user.
Received The date and time when the target audience was received by the end user.
Read The date and time when the target audience was read by the end user.
Failed The date and time when the target audience failed.
NumberStatus The target audience processing status.

 

Get a report for a specific campaign

  • Endpoint: /campaigns/{campaignId}/reports

Request

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "get",
    "uri": "/campaigns/{campaignId}/reports?shouldHaveStateName=true"
}

Response

{
  "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"
  }
}

 

Examples of active sends via the ActiveCampaign API 

See our request examples guide for each template type: Technical guide: Examples of active sends via the ActiveCampaign API
 

Frequently asked questions (FAQ)

Is it possible to send via v2 with scheduling? 

Yes, this is possible. Simply provide the ‘Scheduled’ field in the ‘yyyy-MM-dd hh:mm’ format in the Campaign entity. 

Is it possible to cancel a scheduled campaign? 

You can cancel a schedule by sending a DELETE command. Replace {campaignId} with the campaign ID for the scheduled message you want to delete.
The campaign will be deleted and the schedule canceled.

Request body:

{ 
  "id": "{{$guid}}",
  "to": "postmaster@activecampaign.msging.net",
  "method": "delete",
  "uri": "/campaigns/{campaignId}}"
}

After scheduling a campaign, is it possible to add more data to the schedule? 

It is not possible to change (add or edit) campaign values when they are scheduled. To do so, you must delete the schedule and create a new campaign.

Does manually sending campaigns generate evidence that the message was sent? 

To send an active message manually, you can schedule or send it through Growth, and all information will be recorded on the screen, including messages that failed, were received, or were read:

Is it possible to send a message without directing it to a specific point in the flow?

Yes, the user's state is defined by the StateId and FlowId. Simply do not include these lines in your send request; when the customer replies, they will be directed to the Start block of the main bot.

 

 

Need more help? Explore our content on Blip Academy or Blip Community, watch tutorials on our YouTube channel or get your questions answered through our support channel 😃

Related articles