WAHA

Connect with Whatsapp HTTP API
Join our community

Actions116

Overview

This node operation allows users to set or unset a star on a specific chat message within a chat session. It is useful for marking important messages for easy retrieval or highlighting within chat applications. For example, a user can star a message to indicate it requires follow-up or to bookmark it for later reference.

Use Case Examples

  1. Marking a message as starred to highlight it in a chat application.
  2. Removing the star from a message to indicate it is no longer important.

Properties

Name Meaning
Session The chat session identifier where the message belongs.
Message Id The unique identifier of the message to be starred or unstarred.
Chat Id The identifier of the chat to which the message belongs.
Star Boolean flag to set (true) or unset (false) the star on the message.

Output

JSON

  • success - Indicates if the star operation was successful.
  • messageId - The ID of the message that was starred or unstarred.
  • star - The star status after the operation (true if starred, false if unstarred).

Dependencies

  • Requires an API key credential or authentication token to interact with the chat service API.

Troubleshooting

  • Ensure the session, messageId, and chatId are correctly provided and valid; otherwise, the operation may fail.
  • If the star operation fails, check network connectivity and API authentication credentials.
  • Timeouts can occur if the server does not respond within the specified timeout period; adjust the timeout setting if necessary.

Discussion