WAREST icon

WAREST

Interact with the WARest WhatsApp REST API

Overview

This node interacts with the WARest WhatsApp REST API to retrieve the business profile information associated with specified phone numbers in a given WhatsApp session. It is useful for users who want to fetch detailed business profile data for one or more phone numbers on WhatsApp, such as business name, description, address, and other relevant details. For example, a user can input a session ID and a list of phone numbers to get their corresponding business profiles for marketing or customer support purposes.

Use Case Examples

  1. Retrieve business profile information for a list of phone numbers in a specific WhatsApp session to display business details in a CRM system.
  2. Check the business profile of contacts before sending promotional messages to ensure compliance with WhatsApp business policies.

Properties

Name Meaning
Session Identifier of the WhatsApp session to use for the API call. It can be selected from a list of existing sessions or entered manually.
Phone Numbers Comma separated list of phone numbers to check for business profile information (e.g., 62812,62813). This is required to specify which numbers' business profiles to retrieve.

Output

JSON

  • json - The JSON output contains the business profile information for the specified phone numbers as returned by the WARest API.

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 provided is valid and active; otherwise, the API call will fail.
  • The phone numbers must be in the correct format and separated by commas; invalid formatting may cause errors or empty results.
  • If the API key or base URL credentials are incorrect or missing, authentication errors will occur.
  • The node throws an error if the operation is not implemented or if required parameters are missing.

Links

  • WARest API Documentation - Official documentation for the WARest WhatsApp REST API, including endpoints and usage details.

Discussion