FluentCRM Developers

Appearance

View as Markdown

GET Get SMS Campaign Recipients​

GET
/sms/campaigns/{id}/recipients

Retrieve a paginated list of SMS message recipients for a specific campaign. Supports filtering by message status (sent, failed, delivered) and searching by subscriber details. 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

filter_type

Filter recipients by message status or activity.

Type
string
Valid values
"sent""failed""delivered""click"
search

Search recipients by subscriber name, email, or other fields.

Type
string
per_page

Number of results per page.

Type
integer
Default
15
page

Page number.

Type
integer
Default
1

Responses​

Paginated list of campaign recipients.

application/json
JSON
{
"recipients": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"data": [
{
"id": 0,
"subscriber_id": 0,
"campaign_id": 0,
"mobile_number": "string",
"message_content": "string",
"status": "string",
"sms_type": "string",
"delivery_status": "string",
"sent_at": "string",
"scheduled_at": "string",
"created_at": "string",
"updated_at": "string",
"subscriber": {
},
"campaign": {
}
}
]
},
"failed_counts": 0
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI