Zalo Pin MessageInstall

Overview

This node allows users to manage pinned conversations in a messaging platform, specifically enabling the action to unpin a conversation thread. It is useful when you want to programmatically remove the "pinned" status from a chat thread, either with an individual user or a group.

Common scenarios include:

• Automatically unpinning conversations after certain events or time periods.
• Managing pinned threads in bulk via automation workflows.
• Integrating with external systems to update conversation statuses dynamically.

For example, you could use this node to unpin a group chat once a project is completed or to clear pinned messages for inactive users.

Properties

Output

The node outputs JSON data containing the result of the unpin operation. The structure includes:

• success: Boolean indicating if the operation was successful.
• operation: The name of the operation performed (unpinConversation).
• threadId: The ID of the thread targeted.
• threadType: The type of the thread ("user" or "group").
• result: An object containing:
  • success: Boolean confirming success.
  • result: The raw response from the API call.
  • methodUsed: The internal method used to perform the unpin action.
  • parameters: Parameters passed to the method (thread ID and unpin flag).
  • debug: Debug information including thread ID, thread type, and full API response.

If the node encounters an error and the workflow is set to continue on failure, it outputs JSON with success: false and an error message describing the issue.

Dependencies

• Requires an API key credential for authenticating with the messaging platform's API.
• Uses an internal API client class to interact with the platform, which requires session cookies, device IMEI, and user agent strings obtained from credentials.
• No additional external services are explicitly required beyond the messaging platform's API.

Troubleshooting

• Common issues:

  • Invalid or missing Thread ID will cause the operation to fail.
  • Incorrect Thread Type may lead to unexpected results or errors.
  • Authentication failures if the API key or session details are invalid or expired.
  • Network or API downtime can cause request failures.

• Error messages:

  • If no valid authentication cookie is found, the node throws an error indicating missing credentials.
  • API call failures return error messages from the platform; these should be checked for rate limits, permission issues, or invalid parameters.
  • When the node is configured not to continue on failure, any error will stop execution and throw a detailed error message.

To resolve errors:

• Verify that the Thread ID and Thread Type are correct.
• Ensure the API key credential is valid and has necessary permissions.
• Check network connectivity and API service status.
• Enable "Continue On Fail" in the node settings to handle errors gracefully within workflows.

Links and References

• Messaging platform API documentation (not provided here, but typically available from the platform vendor).
• n8n documentation on creating and using custom nodes: https://docs.n8n.io/integrations/creating-nodes/
• General best practices for managing pinned conversations in chat applications.