WAHA icon

WAHA

Connect with Whatsapp HTTP API
Join our community

Actions101

Overview

This node operation allows users to pin a specific message in a chat session for a defined duration. It is useful in scenarios where important messages need to be highlighted or kept accessible in chat conversations, such as pinning announcements, reminders, or key information in team chats or customer support interactions.

Use Case Examples

  1. Pinning a message in a team chat to highlight a meeting agenda for 24 hours.
  2. Pinning a customer support message to keep critical information visible for 7 days.

Properties

Name Meaning
Session The name of the chat session where the message will be pinned.
Chat Id The unique identifier of the chat where the message is located.
Message Id The unique identifier of the message to be pinned.
Duration The length of time in seconds that the message will remain pinned. Common values include 86400 (24 hours), 604800 (7 days), and 2592000 (30 days).
Request Options Additional settings for the request such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • success - Indicates whether the pin message operation was successful.
  • pinnedMessageId - The ID of the message that was pinned.
  • chatId - The ID of the chat where the message was pinned.
  • duration - The duration in seconds for which the message is pinned.

Dependencies

  • Requires an active chat session and valid chat and message IDs to perform the pin operation.

Troubleshooting

  • Ensure the session name, chat ID, and message ID are correctly provided and correspond to existing entities.
  • Check that the duration is a positive number and within allowed limits (e.g., 24 hours, 7 days, 30 days).
  • If using proxy or SSL options, verify the proxy settings and SSL certificates are correctly configured.
  • Timeout errors may occur if the server is unresponsive; consider increasing the timeout value in request options.

Discussion