Nvoip icon

Nvoip

Node for sending SMS via Nvoip

Actions6

Overview

This node enables sending WhatsApp template messages using Highly Structured Messages (HSM) via the Nvoip service. It is designed for automated communication scenarios where predefined WhatsApp templates are used to send notifications, alerts, or transactional messages to customers or users.

Typical use cases include:

  • Sending appointment reminders or confirmations.
  • Delivering shipping or delivery updates.
  • Notifying users about account activities or alerts.
  • Sending marketing or promotional messages with approved WhatsApp templates.

The node supports specifying the destination phone number, selecting a WhatsApp template by name or ID, providing template variables in order, and optionally attaching an image URL to enrich the message.

Properties

Name Meaning
Destination Number Phone number with country code to which the WhatsApp message will be sent (e.g., 5511999999999).
Image (URL) Optional public URL of an image to send along with the WhatsApp template message.
WhatsApp Template Name or ID Select a WhatsApp template from a list or specify its ID using an expression.
WhatsApp Template Variables List of values to fill the placeholders in the WhatsApp template, provided in the correct order.

Output

The node outputs JSON data representing the response from the Nvoip API after attempting to send the WhatsApp template message. This typically includes information about the message status, any identifiers returned by the API, and error details if the request failed.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "messageId": "string",
  "status": "string",
  "details": { /* additional info from API */ }
}

If an error occurs and "Continue On Fail" is enabled, the output will contain an error field describing the issue.

Dependencies

  • Requires an API key credential configured in n8n to authenticate with the Nvoip API.
  • The node makes HTTP requests to Nvoip endpoints:
    • To fetch available WhatsApp templates: GET https://api.nvoip.com.br/v3/wa/listTemplates
    • To send WhatsApp template messages: POST https://api.nvoip.com.br/v3/wa/sendTemplates
  • Proper network connectivity to Nvoip's API endpoints is necessary.

Troubleshooting

  • Template Not Found Error: If the specified WhatsApp template ID does not exist or cannot be found, the node throws an error indicating the template was not found. Ensure the template ID is correct and that it exists in your Nvoip WhatsApp templates.
  • Missing Template Variables: Attempting to send a WhatsApp template without providing required variables results in an error. Always provide all necessary variables in the correct order matching the template placeholders.
  • Invalid Destination Number: The destination number must include the country code and be in the correct format (e.g., 5511999999999). Incorrect formatting may cause message delivery failures.
  • Authentication Issues: Errors related to authentication usually indicate missing or invalid API credentials. Verify that the API key credential is correctly set up in n8n.
  • Network or API Errors: Temporary network issues or API downtime can cause request failures. Check connectivity and retry later if needed.

Links and References

Discussion