wasender.numbers.check_on_whatsapp ​
Read-only: check whether a phone number is registered on WhatsApp; no database writes
Check whether a phone number is registered on WhatsApp (GET /on-whatsapp/{phone}).
Inputs:
- cloud_connection_uuid: UUID — the cloud connection holding the Wasender token.
- phone: str — phone number to check (E.164, path param).
Outputs (terminal state_data):
- phone: str — echoed phone number queried.
- exists: bool — whether the number is on WhatsApp.
- jid: str — resolved WhatsApp JID, if registered.
- provider_metadata: JSON — raw provider response (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 |
phone | string | Yes | — | Phone number to check (E.164, path param) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | No | — | — |
phone | string | No | — | Echoed phone number queried |
exists | boolean | No | — | Whether the number is on WhatsApp |
jid | string | No | — | Resolved WhatsApp JID, if registered |
provider_metadata | json | No | — | Raw provider response (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.numbers.check_on_whatsapp",
"initial_data": {
"cloud_connection_uuid": "value",
"phone": "value"
}
}