z-api by @jaimeflneto icon

z-api by @jaimeflneto

Interact with Z-API to send WhatsApp messages

Overview

This node sends an audio message via WhatsApp using the Z-API service. It is useful for automating the sending of audio clips to specified phone numbers, such as sending voice messages, audio notifications, or prerecorded announcements. For example, a business can use this node to send promotional audio messages to customers or provide audio instructions in customer support workflows.

Use Case Examples

  1. Send an audio greeting to a customer by specifying their phone number and the URL of the audio file.
  2. Automate sending audio notifications to a list of phone numbers with optional delays for typing and message sending.

Properties

Name Meaning
Phone Number The recipient's phone number including country code, formatted as digits only without any special characters or spaces.
Audio URL The URL pointing to the audio file to be sent as a message.
Options Additional optional settings for the message such as delay before typing status, delay before sending the message, and replying to a specific message ID.

Output

JSON

  • phone - The phone number to which the audio message was sent.
  • audioUrl - The URL of the audio file sent.
  • messageId - The unique identifier of the sent message returned by the API.
  • status - The status of the message sending operation (e.g., success or failure).

Dependencies

  • Z-API service for WhatsApp messaging
  • An API key credential for authenticating with Z-API

Troubleshooting

  • Ensure the phone number is correctly formatted with country code and contains only digits; otherwise, the message may fail to send.
  • Verify the audio URL is accessible and points to a valid audio file format supported by WhatsApp.
  • If delays are set too high, the message sending might be noticeably slow; keep delays within recommended ranges (0-15 seconds).
  • Common error messages include authentication failures (check API key), invalid phone number format, or network issues connecting to Z-API service.

Links

  • Z-API Documentation - Official documentation for the Z-API WhatsApp messaging service used by this node.

Discussion