wasender.sessions.list ​
Read-only: list WhatsApp sessions; no database writes
List all WhatsApp sessions on the account via GET /whatsapp-sessions.
Inputs (optional pagination):
- page: INTEGER — 1-based page number.
- limit: INTEGER — max sessions per page.
- cursor: STRING — opaque pagination cursor.
Outputs (terminal state_data):
- sessions: list of session objects.
- count / total / next_cursor — pagination metadata.
- provider_metadata: raw provider list envelope.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-wasender |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | Yes | — | Selects the Wasender connection/plugin |
page | integer | No | — | 1-based page number for pagination |
limit | integer | No | — | Max sessions per page |
cursor | string | No | — | Opaque pagination cursor |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | No | — | — |
page | integer | No | — | — |
limit | integer | No | — | — |
cursor | string | No | — | — |
sessions | list | No | — | List of session objects |
count | integer | No | — | Sessions returned in this page |
total | integer | No | — | Total sessions across all pages |
next_cursor | string | No | — | Cursor for the next page |
provider_metadata | json | No | — | Raw provider list envelope |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | integer | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "wasender.sessions.list",
"initial_data": {
"cloud_connection_uuid": "value"
}
}