z-api by @jaimeflneto icon

z-api by @jaimeflneto

Interact with Z-API to send WhatsApp messages

Overview

This node sends a text message via WhatsApp using the Z-API service. It is useful for automating communication by sending messages to specified phone numbers with optional delays and reply references. For example, it can be used to send notifications, alerts, or customer support messages automatically.

Use Case Examples

  1. Send a text message to a customer with a delay to simulate typing.
  2. Reply to a specific message in a chat by providing the message ID to reply to.

Properties

Name Meaning
Phone Number The recipient's phone number including country code, entered as digits only without formatting.
Message The text content of the message to be sent.
Options Additional settings for the message such as typing delay, message sending delay, and replying to a specific message ID.

Output

JSON

  • phone - The phone number to which the message was sent.
  • message - The text content of the sent message.
  • messageId - The unique identifier of the sent message.
  • status - The status of the message sending operation (e.g., sent, failed).

Dependencies

  • Requires Z-API service credentials for authentication to send WhatsApp messages.

Troubleshooting

  • Ensure the phone number is in the correct format with country code and no special characters or spaces.
  • Delays must be between 0 and 15 seconds; values outside this range may cause errors.
  • If replying to a message, ensure the replyMessageId is valid and corresponds to an existing message.
  • Common errors include authentication failures due to invalid API credentials and message sending failures due to invalid phone numbers or network issues.

Links

Discussion