Skip to content
View as Markdown
Enter your site to enable Send. Requests are sent from your browser, so the site must allow cross-origin calls (CORS).

GET List Messaging Messages​

GET
/messaging/messages

The Activities list: every message, inbound and outbound, newest activity first. channel is a filter here: sms or whatsapp narrows the list (and the status counts); omit it, or send anything else, to include all channels. The result key is still named sms for backward compatibility even though rows can be WhatsApp. status and sms_type accept comma-separated lists; unknown values are dropped. The statuses array carries a count per status for the filter dropdown, limited to pending, sent, delivered, failed, cancelled and received (messages in other states such as read or scheduled are not counted or filterable here). PRO — requires the FluentCampaign Pro Messaging module with at least one channel (SMS or WhatsApp) active.

Required capability: fcrm_read_emails or fcrm_manage_emails — which one applies depends on the action being performed.

Enforced by MessagePolicy::verifyRequest(), the policy default for this route group.

Requires: FluentCampaign Pro with the Messaging module enabled. While no messaging channel (SMS or WhatsApp) is switched on 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

channel

Filter by channel.

Type
string
Valid values
"sms""whatsapp"
status

Comma-separated statuses: pending, sent, delivered, failed, cancelled, received.

Type
string
sms_type

Comma-separated types: campaign, automation, custom_sms, broadcast, incoming. custom_sms and broadcast both mean outbound with no campaign or automation behind it.

Type
string
search

Match message content, the conversation's phone number or the contact's name/email.

Type
string
page

Page number.

Type
integer
Default
1
per_page

Rows per page.

Type
integer
Default
10

Responses​

Activity page.

application/json
JSON
{
"sms": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"from": 0,
"to": 0,
"next_page_url": "string",
"prev_page_url": "string",
"data": [
{
"id": 0,
"message_content": "string",
"mobile_number": "string",
"channel": "string",
"sms_type": "string",
"status": "string",
"direction": "string",
"sent_at": "string",
"scheduled_at": "string",
"created_at": "string",
"subscriber_id": 0,
"subscriber": {
},
"campaign": {
"title": "string"
}
}
]
},
"statuses": [
{
"value": "string",
"label": "string",
"count": 0
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI