WAREST icon

WAREST

Interact with the WARest WhatsApp REST API

Overview

This node operation mutes a chat in a WhatsApp session using the WARest WhatsApp REST API. It allows users to specify a session and a chat recipient (phone number or JID) to mute, optionally setting the mute duration in minutes. This is useful for automating chat management, such as silencing notifications from specific chats for a defined period.

Use Case Examples

  1. Mute a chat for 60 minutes to avoid notifications during a meeting.
  2. Automatically mute chats from a specific contact or group during non-working hours.

Properties

Name Meaning
Session The WhatsApp session identifier to use for the operation, selected from a list or entered manually.
Recipient / Chat (to) The phone number or JID of the chat to mute. Can be a single or comma-separated list of recipients.
Mute Duration (minutes) Optional duration in minutes to mute the chat. Defaults to 60 minutes if not specified.

Output

JSON

  • json - The JSON response from the WARest API indicating the result of the mute chat operation.

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; otherwise, the API call will fail.
  • The 'to' field must be a valid phone number or JID; invalid formats will cause errors.
  • If the mute duration is not specified, the default of 60 minutes is used, but setting an invalid duration may cause the API to reject the request.
  • Network or authentication issues with the WARest API will prevent the operation from succeeding.

Links

Discussion