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 Thread Messages​

GET
/messaging/threads/{id}/messages

Messages of one conversation, oldest first within the returned window, together with the thread (including the contact's list and tag titles). The newest per_page messages are returned; to page backwards through history pass before=<oldest message id you have> and the next older window comes back. has_more tells you whether anything older exists. Message time is sent_at, falling back to scheduled_at then created_at. PRO (FluentCampaign Pro Messaging module).

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

Enforced by InboxPolicy::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​

Path Parameters

id*

Message thread ID.

Type
integer
Required

Query Parameters

before

Return only messages with an ID lower than this.

Type
integer
per_page

Window size. Clamped to 1-100.

Type
integer
Default
25

Responses​

A window of messages.

application/json
JSON
{
"messages": [
{
"id": 0,
"thread_id": 0,
"direction": "string",
"message_type": "string",
"content": "string",
"template_name": "string",
"media": [
{
}
],
"status": "string",
"error_message": "string",
"created_at": "string"
}
],
"has_more": true,
"thread": {
"id": 0,
"channel": "string",
"phone_number": "string",
"profile_name": "string",
"wa_id": "string",
"status": "string",
"unread_count": 0,
"updated_at": "string",
"session": {
"has_active_session": true,
"expires_at": "string"
},
"subscriber": {
"id": 0,
"full_name": "string",
"email": "string",
"phone": "string",
"photo": "string",
"status": "string",
"lists": [
"string"
],
"tags": [
"string"
]
},
"last_message": {
"text": "string",
"direction": "string",
"status": "string",
"message_type": "string",
"created_at": "string"
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI