GET Get SMS Campaign Processing Status

GET

/sms/campaigns/{id}/processing-stat

Get the processing status of an SMS campaign that is being prepared for sending. If the campaign is in pending-scheduled status and its scheduled time is within 6 minutes, it transitions to processing. Returns whether the client should reload for updated data. 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

Responses

Processing status.

Content-Type

application/json

{

"reload": true,

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

},

"didRun": true,

"scheduling_method": "string"

}

GET

/sms/campaigns/{id}/processing-stat

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI