WAREST icon

WAREST

Interact with the WARest WhatsApp REST API

Overview

This node operation 'Check On WhatsApp' under the 'Profile' resource allows users to verify the presence of one or more phone numbers on WhatsApp using a specified session. It is useful for scenarios where you need to confirm if certain contacts are registered on WhatsApp before sending messages or performing other actions. For example, a business can use this to filter out non-WhatsApp numbers from a contact list before launching a marketing campaign.

Use Case Examples

  1. Check if a list of customer phone numbers are registered on WhatsApp before sending promotional messages.
  2. Verify the WhatsApp availability of contacts in a CRM system to update contact status.

Properties

Name Meaning
Session The WhatsApp session identifier to use for the API call, selected from existing sessions or entered manually.
Phone Numbers Comma separated list of phone numbers to check on WhatsApp (e.g., 62812,62813).
Additional Fields Optional parameters to refine the check, including type (contacts or groups), deep lookup flag, group IDs, limit, and offset for pagination.

Output

JSON

  • json - The result of the check operation, typically an array or object indicating which numbers are on WhatsApp.

Dependencies

  • Requires an API key credential for the WARest WhatsApp REST API and the base URL of the API server.

Troubleshooting

  • Ensure the session ID is valid and active; invalid or expired sessions will cause errors.
  • Phone numbers must be provided in the correct comma-separated format without spaces.
  • API connectivity issues may arise if the base URL or API key credentials are incorrect or missing.

Links

Discussion