MegaAPI icon

MegaAPI

Interact with MegaAPI WhatsApp service

Overview

The "Restart" operation under the "Instance" resource allows you to restart your WhatsApp instance managed via the MegaAPI WhatsApp service. Restarting the instance will terminate all active connections and require the instance to reconnect. This operation is useful when you need to reset the WhatsApp connection, for example, after configuration changes, troubleshooting connectivity issues, or recovering from an unexpected state.

Practical examples:

  • You have updated some settings on your WhatsApp instance and want to apply them by restarting.
  • The WhatsApp instance becomes unresponsive or disconnected; restarting can restore normal operation.
  • You want to programmatically trigger a restart as part of maintenance workflows.

Properties

Name Meaning
Confirmation ⚠️ This is a notice property warning that restarting the instance will terminate all active connections and require reconnection. It serves as a confirmation prompt before proceeding with the restart.

Output

The node outputs JSON data representing the result of the restart operation. Typically, this would include status information confirming whether the restart command was successfully issued. The exact structure depends on the API response but generally includes success indicators or error messages.

This node does not output binary data.

Dependencies

  • Requires an API key credential to authenticate with the MegaAPI WhatsApp service.
  • The node uses the configured base URL and authorization token from the credentials to make API requests.
  • Proper network connectivity to the MegaAPI service endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Restart command fails due to invalid or expired API credentials.
    • Network connectivity problems prevent communication with the MegaAPI service.
    • Attempting to restart while another critical operation is in progress may cause conflicts.
  • Error Messages:

    • "Unknown operation: restart": This indicates a misconfiguration where the operation name is incorrect or unsupported. Ensure the operation is set to "Restart".
    • API errors returned from the service (e.g., authentication failures) will be passed through. Verify API keys and permissions.
  • Resolution Tips:

    • Double-check API credentials and refresh tokens if needed.
    • Confirm the MegaAPI service endpoint is reachable.
    • Use the confirmation notice carefully to avoid unintended restarts.

Links and References

Discussion