MegaAPI icon

MegaAPI

Interact with MegaAPI WhatsApp service

Overview

This node interacts with the MegaAPI WhatsApp service, specifically providing operations related to a WhatsApp instance. The Status operation under the Instance resource retrieves the current status and information of your WhatsApp instance. This is useful for monitoring the connection state, availability, or health of the WhatsApp integration.

Practical examples include:

  • Checking if the WhatsApp instance is online and ready to send/receive messages.
  • Monitoring the instance status as part of an automated workflow to trigger alerts or retries.
  • Verifying connectivity before performing other WhatsApp-related operations.

Properties

Name Meaning
Information ℹ️ This will retrieve the current status and information of your WhatsApp instance

Output

The output JSON contains the current status and detailed information about the WhatsApp instance. This typically includes fields such as connection status, session details, and any relevant metadata returned by the MegaAPI service regarding the instance's operational state.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the MegaAPI WhatsApp service.
  • The node expects configuration of the base URL and authorization token via credentials.
  • Internet access to communicate with the MegaAPI endpoints.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or expired API tokens.
    • Network connectivity problems preventing communication with the MegaAPI service.
    • Receiving unexpected or empty status responses if the WhatsApp instance is offline or disconnected.
  • Error messages:

    • Unknown operation: status — indicates the operation parameter was not correctly set to "status".
    • Unknown resource: instance — indicates the resource parameter was not correctly set to "instance".
    • API errors returned from MegaAPI (e.g., unauthorized, timeout) should be checked in the node’s error output.
  • Resolutions:

    • Verify that the API key credential is correctly configured and valid.
    • Ensure the WhatsApp instance is active and connected.
    • Check network settings and firewall rules allowing outbound requests to the MegaAPI host.

Links and References

Discussion