Skip to content
View as Markdown
Enter your site to enable Send. Requests are sent from your browser, so the site must allow cross-origin calls (CORS).

GET Get Messaging Campaign Status​

GET
/messaging/campaigns/{id}/status

Delivery status of a campaign (campaign or automation type). While the campaign is processing or pending-scheduled the response is an empty shell (stat: [], sent_count: 0) because messages are still being generated. Otherwise stat holds message counts grouped by status and sent_count counts messages whose status is exactly sent. This GET also flips a scheduled campaign whose time has passed to working, and adds campaign.sent_by (display name and email of the user who started it, or false).

Channel: this route does not take a channel; the channel is the one stored on the campaign (sms or whatsapp) and the matching channel hooks are fired. PRO — requires the FluentCampaign Pro Messaging module with at least one channel (SMS or WhatsApp) active.

Required capability: fcrm_read_emails or fcrm_manage_emails — which one applies depends on the action being performed.

Enforced by MessagePolicy::verifyRequest(), the policy default for this route group.

Requires: FluentCampaign Pro with the Messaging module enabled. While no messaging channel (SMS or WhatsApp) is switched on the route is not registered at all and returns a 404.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Path Parameters

id*

Campaign id.

Type
integer
Required

Responses​

Status.

application/json
JSON
{
"current_timestamp": "string",
"stat": [
{
"status": "string",
"total": 0
}
],
"campaign": {
"id": 0,
"parent_id": 0,
"type": "string",
"title": "string",
"slug": "string",
"status": "string",
"message_content": "string",
"sender_number": "string",
"recipients_count": 0,
"sent_count": 0,
"failed_count": 0,
"delay": 0,
"scheduled_at": "string",
"settings": {
"sending_filter": "string",
"sending_type": "string",
"is_transactional": "string",
"subscribers": [
{
"list": "string",
"tag": "string"
}
],
"excludedSubscribers": [
{
"list": "string",
"tag": "string"
}
],
"dynamic_segment": {
"id": "string",
"slug": "string"
},
"advanced_filters": [
[
]
],
"template_id": 0,
"template_variables": {
"additionalProperties": "string"
},
"one_time_audience": {
"active_batch_id": "string",
"accepted_count": 0,
"default_country": "string",
"consent_user_id": 0,
"consent_channel": "string",
"consent_confirmed": "string"
}
},
"channel": "string",
"created_by": 0,
"created_at": "string",
"updated_at": "string",
"next_step": "string",
"labels": [
{
"id": 0,
"slug": "string",
"title": "string",
"color": "string"
}
],
"server_time": "string"
},
"sent_count": 0,
"analytics": [
],
"subject_analytics": [
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI