Zalo Pin MessageInstall

Overview

This node allows users to pin or unpin conversations in a messaging platform (likely Zalo, based on naming). Pinning a conversation keeps it at the top of the chat list for easy access, while unpinning removes this priority. This is useful for managing important chats, such as prioritizing customer support threads or group discussions.

Typical use cases include:

• Automatically pinning a conversation when a new important message arrives.
• Unpinning conversations after they are resolved or no longer relevant.
• Managing pinned conversations programmatically in bulk.

Properties

Output

The node outputs JSON data with the following structure:

• success: Boolean indicating if the operation succeeded.
• operation: The performed operation, e.g., "pinConversation" or "unpinConversation".
• threadId: The ID of the conversation targeted.
• threadType: The type of the conversation ("user" or "group").
• result: An object containing:
  • success: Boolean confirming success.
  • result: The raw result returned by the API call.
  • methodUsed: The internal method used to perform the action.
  • parameters: Parameters passed to the method.
  • debug: Debug information including thread ID, thread type, and API response.

If an error occurs, the output JSON will contain:

• success: false
• error: Error message string describing the failure.

No binary data output is produced by this node.

Dependencies

• Requires an API key credential for authenticating with the messaging platform's API.
• Uses an internal API client instantiated with cookie, IMEI, and user agent values extracted from credentials.
• No additional external services beyond the messaging platform API are required.

Troubleshooting

• Common issues:

  • Invalid or missing Thread ID: Ensure the Thread ID corresponds to an existing conversation.
  • Incorrect Thread Type: Use "user" for one-on-one chats and "group" for group chats.
  • Authentication failures: Verify that the API key credential is correctly configured and valid.
  • API rate limits or network errors may cause failures.

• Error messages:

  • "Missing or invalid authentication": Check API credentials.
  • "Failed to pin/unpin conversation": Confirm Thread ID and Thread Type are correct.
  • Node operation errors will be thrown with descriptive messages; enabling debug logs can help identify issues.

Links and References

• Zalo Official API Documentation (assumed based on context)
• n8n documentation on creating custom nodes: https://docs.n8n.io/integrations/creating-nodes/
• General best practices for managing pinned conversations in chat applications.