FluentCRM Developers

Appearance

View as Markdown

GET List All SMS Messages​

GET
/sms/messages

Retrieve a paginated list of all SMS messages across all campaigns and types. Supports filtering by status and searching by message content, phone number, or subscriber details. Also returns status counts for filter dropdowns. 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​

Query Parameters

per_page

Number of results per page.

Type
integer
Default
10
page

Page number.

Type
integer
Default
1
status

Filter by message status. Use empty string or all to show all statuses.

Type
string
Valid values
"""all""pending""sent""delivered""failed""cancelled"
search

Search by message content, phone number, or subscriber details (name, email).

Type
string
channel

Messaging channel to list messages for.

Type
string
Default
"sms"

Responses​

Paginated list of SMS messages with status counts.

application/json
JSON
{
"sms": {
"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": {
}
}
],
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"from": 0,
"to": 0,
"next_page_url": "string",
"prev_page_url": "string"
},
"statuses": [
{
"value": "string",
"label": "string",
"count": 0
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI