FluentCRM Developers

Appearance

View as Markdown

GET Subscriber WhatsApp Messages​

GET
/whatsapp/subscribers/{id}/messages

Retrieve paginated WhatsApp message history for a specific subscriber/contact. PRO (requires FluentCampaign Pro WhatsApp module).

Required capability: fcrm_read_emails

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

Query Parameters

page

Page number.

Type
integer
Default
1
per_page

Rows per page.

Type
integer
Default
20
filter_type

Optional UI filter key for future filtering.

Type
string

Responses​

Paginated WhatsApp messages for the subscriber.

application/json
JSON
{
"messages": {
"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,
"subscriber_id": 0,
"campaign_id": 0,
"sms_type": "string",
"channel": "string",
"direction": "string",
"mobile_number": "string",
"message_content": "string",
"status": "string",
"delivery_status": "string",
"provider_message_id": "string",
"template_id": 0,
"sent_at": "string",
"delivered_at": "string",
"read_at": "string",
"created_at": "string",
"updated_at": "string"
}
]
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI