Zalo OA icon

Zalo OA

Tương tác với Zalo Official Account API

Overview

This node interacts with the Zalo Official Account (OA) API to check the status of a specific message sent via the Zalo OA platform. It is useful for scenarios where you need to verify whether a message has been delivered, read, or encountered any issues after being sent through Zalo OA.

Practical examples include:

  • Confirming delivery status of customer notifications.
  • Tracking message read receipts in marketing campaigns.
  • Debugging message sending issues by checking message states.

Properties

Name Meaning
Message ID The unique identifier of the message whose status you want to check. This is required to query the message status from Zalo OA.

Output

The node outputs a JSON object containing the response from the Zalo OA API's message status endpoint. This typically includes details such as:

  • The current status of the message (e.g., sent, delivered, read).
  • Any error codes or messages if the status could not be retrieved.
  • Additional metadata related to the message status.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Zalo OA API.
  • The node uses the Zalo OA API v3.0 endpoint https://openapi.zalo.me/v3.0/oa/message/status.
  • Proper OAuth tokens or access tokens must be configured and valid.
  • Network connectivity to the Zalo OA API service is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or expired access token leading to authentication errors.
    • Incorrect or non-existent Message ID causing "message not found" errors.
    • Insufficient permissions on the Zalo OA app to access message status.
  • Error Messages:

    • "Error when calling message/status API: <error message>": Indicates failure in API call; check network, token validity, and permissions.
    • Response with error field and suggestion to verify OA access rights and token validity.
  • Resolutions:

    • Ensure the access token is up-to-date and has the required scopes.
    • Verify that the Message ID is correct and corresponds to a message sent by your OA.
    • Confirm that the OA app has granted the "Manage message status" permission.
    • Check the Zalo OA API documentation for any changes or updates to the endpoint.

Links and References


Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion