GET Get SMS Campaign Recipients Count

GET

/sms/campaigns/{id}/estimated-recipients-count

Get the estimated number of recipients for an SMS campaign. For campaigns in draft, processing, or pending-scheduled status, a live count is computed from the subscriber model. For other statuses, the stored recipients_count is returned. 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

Estimated recipients count.

Content-Type

application/json

{

"estimated_count": 0

}

GET

/sms/campaigns/{id}/estimated-recipients-count

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI