Actions101
- š¤ Chatting Actions
- š„ļø Sessions Actions
- š Auth Actions
- š¼ļø Screenshot Actions
- š¢ Channels Actions
- š¢ Status Actions
- š¬ Chats Actions
- š¤ Contacts Actions
- š„ Groups Actions
- ā Presence Actions
- š·ļø Labels Actions
- š Observability Actions
Overview
This node operation mutes a WhatsApp Channel within a specified session. It is useful for scenarios where you want to temporarily silence notifications or messages from a particular WhatsApp Channel without deleting or disconnecting it. For example, muting a channel during non-working hours or when managing multiple channels to avoid distractions.
Use Case Examples
- Mute a WhatsApp Channel by providing the session name and channel ID to stop receiving notifications from that channel.
- Use batching options to control the rate of mute requests when muting multiple channels programmatically.
Properties
| Name | Meaning |
|---|---|
| Session | The name of the session associated with the WhatsApp Channel to be muted. |
| Id | The unique identifier of the WhatsApp Channel to mute. |
| Request Options | Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings to customize the API request behavior. |
Output
JSON
success- Indicates if the mute operation was successful.channelId- The ID of the WhatsApp Channel that was muted.message- Additional information or status message about the mute operation.
Dependencies
- Requires an API key credential or authentication token to access the WhatsApp API for muting channels.
Troubleshooting
- Ensure the session name and channel ID are correct and valid; incorrect values will cause the mute operation to fail.
- If SSL certificate validation fails and the request is rejected, enable the 'Ignore SSL Issues' option to bypass SSL errors (not recommended for production).
- Proxy settings must be correctly configured if used; incorrect proxy details can cause request failures.
- Timeout settings should be adjusted based on network conditions; too short a timeout may abort valid requests.