Skip to main content
A token is a stable sessionId. Use it as the path parameter for pairing, status, connection, and messaging endpoints.

​
Create token

POST /api/v1/sessions
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "displayName": "Support line",
  "deviceBrowser": "Chrome"
}

​
List all tokens

GET /api/v1/sessions
Authorization: Bearer <access_token>

​
List connected tokens

Call GET /api/v1/sessions and keep records where connected is true. status: "connected" alone means the token has connected before. A backend restart or runtime stop can leave a paired token with status: "connected" and connected: false. In that case, reconnect the token before sending.

​
Get token status

GET /api/v1/sessions/{sessionId}
Authorization: Bearer <access_token>
The status response includes connection state, pairing state, linked phone JID, QR availability, and timestamps. Important fields: 
{
  "paired": true,
  "active": true,
  "connected": true,
  "connectionState": "connected"
}
  • paired: WhatsApp credentials exist for this token.
  • active: WADial has a runtime loaded for this token.
  • connected: the runtime is connected and ready for message sends.
  • connectionState: current runtime state, such as connecting, connected, inactive, disconnected, or error.

​
Delete token

DELETE /api/v1/sessions/{sessionId}
Authorization: Bearer <access_token>