GET Get Subscriber SMS Statistics

GET

/sms/subscribers/{id}/stats

Retrieve SMS statistics for a specific subscriber/contact, including total message counts broken down by type (campaign, automation, custom) and status (sent, delivered, failed, pending). 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*

Subscriber (contact) ID.

Type

integer

Required

Responses

SMS statistics for the subscriber.

Content-Type

application/json

{

"stats": {

"total_messages": 0,

"campaign_messages": 0,

"automation_messages": 0,

"custom_sms": 0,

"sent_messages": 0,

"delivered_messages": 0,

"failed_messages": 0,

"pending_messages": 0,

"last_sent": "string"

}

}

GET

/sms/subscribers/{id}/stats

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI