FluentCRM Developers

Appearance

View as Markdown

GET Get SMS Campaign Status​

GET
/sms/campaigns/{id}/status

Get the current sending status of an SMS campaign, including message statistics, sent count, and analytics. For working campaigns, this endpoint also performs housekeeping: resets stale processing messages, schedules recovery batch sends, and auto-archives completed campaigns. PRO (requires FluentCampaign Pro SMS module).

Required capability: fcrm_read_emails

Route exists only while the SMS module is enabled; the policy returns false otherwise.

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

Requires: FluentCampaign Pro with the SMS module enabled. While SMS is switched off 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*

SMS campaign ID.

Type
integer
Required

Query Parameters

request_counter

Poll counter used to trigger periodic cleanup of stale processing messages (runs every 4th request).

Type
integer

Responses​

Campaign status with message statistics.

application/json
JSON
{
"current_timestamp": "string",
"stat": [
{
"status": "string",
"total": 0
}
],
"campaign": {
"id": 0,
"title": "string",
"message_content": "string",
"status": "string",
"type": "string",
"recipients_count": 0,
"scheduled_at": "string",
"settings": {
},
"created_at": "string",
"updated_at": "string",
"sent_by": "string"
},
"sent_count": 0,
"analytics": {
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI