Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-wasender
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
cloud_connection_uuiduuidYes—Cloud connection holding the Wasender credential
phonestringYes—Phone number to check (E.164, path param)

Output Schema ​

FieldTypeRequiredDefaultDescription
cloud_connection_uuiduuidNo——
phonestringNo—Echoed phone number queried
existsbooleanNo—Whether the number is on WhatsApp
jidstringNo—Resolved WhatsApp JID, if registered
provider_metadatajsonNo—Raw provider response (opaque)
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.numbers.check_on_whatsapp",
  "initial_data": {
    "cloud_connection_uuid": "value",
    "phone": "value"
  }
}