wasender.users.get ​
Read-only: fetch the connected WhatsApp account info; no database writes
Fetch the WhatsApp user/account info for the connection's session (GET /user).
Inputs:
- cloud_connection_uuid: UUID — the cloud connection holding the Wasender token.
Outputs (terminal state_data):
- id: str — WhatsApp user id / account id
- jid: str — bare JID of the connected account
- name: str — display name / push name
- phone_number: str — paired phone number (E.164)
- status: str — account "about" / status text
- picture_url: str — profile-picture URL, if any
- provider_metadata: dict — full provider user object (opaque)
Plugin required: context.get_plugin("wasender") must expose .api_token.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-wasender |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | Yes | — | Cloud connection holding the Wasender credential |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | No | — | — |
id | string | No | — | WhatsApp user id / account id |
jid | string | No | — | Bare JID of the connected account |
name | string | No | — | Display name / push name |
phone_number | string | No | — | Paired phone number (E.164) |
status | string | No | — | Account 'about' / status text |
picture_url | string | No | — | Profile-picture URL, if any |
provider_metadata | json | No | — | Full provider user object (opaque) |
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.users.get",
"initial_data": {
"cloud_connection_uuid": "value"
}
}