Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-wasender
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
cloud_connection_uuiduuidYes—Selects the Wasender connection/plugin
pageintegerNo—1-based page number for pagination
limitintegerNo—Max sessions per page
cursorstringNo—Opaque pagination cursor

Output Schema ​

FieldTypeRequiredDefaultDescription
cloud_connection_uuiduuidNo——
pageintegerNo——
limitintegerNo——
cursorstringNo——
sessionslistNo—List of session objects
countintegerNo—Sessions returned in this page
totalintegerNo—Total sessions across all pages
next_cursorstringNo—Cursor for the next page
provider_metadatajsonNo—Raw provider list envelope
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerintegerNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "wasender.sessions.list",
  "initial_data": {
    "cloud_connection_uuid": "value"
  }
}