CodeChat - WhatsApp Free Api icon

CodeChat - WhatsApp Free Api

Rest api for communication with WhatsApp
Join our community

Actions6

Overview

This node enables sending WhatsApp messages using a free WhatsApp API service. Specifically, the "Send List" operation under the "Send Message" resource allows users to send interactive list messages to recipients. These list messages contain a title, description, button text, optional footer text, and multiple sections with selectable rows, making it useful for presenting options or menus within a chat.

Common scenarios include:

  • Sending product catalogs or service menus where users can select an option.
  • Interactive customer support messages that guide users through choices.
  • Event invitations with RSVP options presented as list items.

Example: A business sends a list message to a customer with sections like "Available Products" containing rows for each product, allowing the customer to tap and respond easily.

Properties

Name Meaning
Recipient The phone number of the message recipient including country code (e.g., 5531900000000).
Delay Optional delay in milliseconds before sending the message (e.g., 1200 ms).
Presence Status to inform about sender's presence while sending the message. Options: Available, Composing, Paused, Recording, Unavailable, or Empty (no status).
Title Title of the list message shown at the top (required).
Description Description text providing details about the list message (required).
Button Text Text displayed on the button that triggers the list (required).
Footer Text Optional footer text shown at the bottom of the list message.
Sections JSON array defining sections of the list. Each section has a title and rows. Rows are objects with title, description, and rowId (required).

Output

The node outputs JSON data representing the response from the WhatsApp API after attempting to send the list message. This typically includes confirmation of message delivery status, message IDs, or error information if sending failed.

If binary data is supported (not explicitly indicated here), it would represent media attachments or similar content related to the message.

Dependencies

  • Requires an API key credential for authenticating with the WhatsApp API service.
  • Needs the base URL of the WhatsApp API instance configured in credentials.
  • The node uses HTTP POST requests to send messages to the endpoint /message/sendList/{instanceName}/.

Troubleshooting

  • Invalid Phone Number: Ensure the recipient number includes the correct country code without extra characters.
  • Missing Required Fields: Title, Description, Button Text, and Sections must be provided; otherwise, the API will reject the request.
  • Incorrect JSON Format in Sections: The Sections property must be valid JSON with the expected structure; malformed JSON will cause errors.
  • API Authentication Errors: Verify that the API key credential is correctly set up and has necessary permissions.
  • Delay Property Typo: Note that the property name for delay is misspelled as "dalay" in the input properties; this might cause the delay not to work unless corrected.

Links and References

Discussion