get https://examplebaseURL.com/v1/api/apps//data/sent-campaigns-summary
Response Format
Parameter | Type | Description | Availability |
---|---|---|---|
id | String | - The unique ID of the created campaign. - This ID serves as the historyID of the particular campaign when you use the open API to get the sent campaign details. - Please refer to Get Sent Campaigns Details for more details. | In the WhatsApp and SMS Campaigns |
date | String | The date and time the campaign was sent. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. | In the WhatsApp and SMS Campaigns |
campaignName | String | The campaign name of the sent campaign. | In the WhatsApp and SMS Campaigns |
channel | String | The channel used to send the campaign. The channel can be SMS or WhatsApp. | In the WhatsApp and SMS Campaigns |
createdBy | String | The staff name who created the sent campaign. | In the WhatsApp and SMS Campaigns |
sender.phone | String | - The phone number used to send the campaign. - For the SMS campaign, this phone number can be the virtual number, service number or alphanumeric Sender ID. - For the WhatsApp campaign, this phone number is bound to the WhatsApp Channel | In the WhatsApp and SMS Campaigns |
sender.channelName | String | The channel name used to send the campaign. | In the WhatsApp Campaign |
sender.sourceName | String | The source of the template used in the sent campaign. | In the WhatsApp Campaign |
sender.senderEID | String | The staff unique ID who sent the campaign. | In the SMS Campaign |
subject | String | The name of the template used for the campaign. | In the WhatsApp Campaign |
totalRecipients | Number | The total phone number of campaign recipients of the WhatsApp or SMS Campaign. | In the WhatsApp and SMS Campaigns |
delivered | Number | The total number of campaign messages successfully sent to recipients. | In the WhatsApp and SMS Campaigns |
read | Number | The total number of campaign messages read by recipients. | In the WhatsApp Campaign |
replied | Number | Represents the total number of replies generated through clicks on buttons or web links included in the WhatsApp campaign message. The 'replied status' counts replies to the campaign message based on the following criteria: - Replies via buttons: If a recipient clicks on a button multiple times, the replies are only counted once. - Replies via web links: If a recipient clicks on a web link, each click is counted as a separate reply, even if the same recipient makes multiple clicks. | In the WhatsApp Campaign |
pending | Number | The campaign message was successfully sent from CINNOX, but it is still waiting for a "Delivered" response from the 360dialog to the recipients. | In the WhatsApp Campaign |
failed | Number | The total number of campaign messages that failed to send to recipients. | In the WhatsApp Campaign |
For more details on the Sent Campaign, please refer to the Get Sent Campaigns Details section of our User Guides.