Skip to content
View as Markdown

GET Subscriber WhatsApp Session​

GET
/whatsapp/subscribers/{id}/session

Return whether the contact currently has an open 24-hour WhatsApp customer-service session. 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

Responses​

WhatsApp session information for the subscriber.

application/json
JSON
{
"session": {
"has_active_session": true,
"expires_at": "string",
"session_type": "string",
"message_count": 0,
"total_sessions": 0
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI