z-api by @jaimeflneto icon

z-api by @jaimeflneto

Interact with Z-API to send WhatsApp messages

Overview

This node operation sends a WhatsApp message with interactive buttons to a specified phone number using the Z-API service. It is useful for scenarios where you want to provide users with predefined options to choose from, such as customer support menus, surveys, or quick replies in chatbots.

Use Case Examples

  1. Sending a message with up to 3 buttons to a customer to select a service option.
  2. Providing quick reply buttons in a WhatsApp marketing campaign to gather user preferences.

Properties

Name Meaning
Phone Number The recipient's phone number including country code, without any formatting.
Button Message The text message displayed above the buttons to provide context or instructions to the user.
Buttons A JSON array of button objects, each with an 'id' and 'label', defining up to 3 interactive buttons for the message.
Options Additional optional settings such as typing delay, message delay, and reply message ID to customize message sending behavior.

Output

JSON

  • json - The response from the Z-API service after sending the button message, typically including message status and metadata.

Dependencies

  • Requires an API key credential for Z-API to authenticate and send WhatsApp messages.

Troubleshooting

  • Ensure the phone number is correctly formatted with country code and contains only numbers, as incorrect formatting will cause message sending to fail.
  • The buttons JSON must be a valid array with up to 3 button objects, each having unique 'id' and 'label' fields; invalid JSON or exceeding button count will cause errors.
  • Delays for typing and message sending must be between 0 and 15 seconds; values outside this range may be ignored or cause errors.
  • If replying to a message, ensure the replyMessageId is valid and corresponds to an existing message ID in the chat.

Discussion