Z-API icon

Z-API

Send messages

Actions10

Overview

This node integrates with the Z-API service to send various types of WhatsApp messages programmatically. Specifically, for the Send Sticker operation under the Send Message resource, it allows users to send a sticker message to a specified phone number via WhatsApp.

Common scenarios where this node is beneficial include:

  • Automating customer engagement by sending branded or custom stickers.
  • Enhancing chatbot interactions with expressive media.
  • Sending quick visual responses in support or marketing workflows.

For example, a business could automatically send a thank-you sticker after a customer completes a purchase or trigger a fun sticker response based on user input in a conversational flow.

Properties

Name Meaning
Instance ID Your Z-API Instance ID used to identify your Z-API account instance.
Instance Token Your Z-API Instance Token for authenticating API requests (kept secret).
Client Token Your Z-API Client Token for additional authentication (kept secret).
Phone The recipient's phone number in international format (e.g., 5511999999999).
URL or Base64 The URL or base64-encoded string of the sticker image to be sent.
Additional Fields Optional extra settings:
• Delay Message: Seconds to wait before sending the message (1-15).
• Delay Typing: Seconds to show "Typing..." status before sending (0-15).
• Message ID to Reply: ID of a message to reply to (for threaded conversations).

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the response from the Z-API service after attempting to send the sticker message. This typically includes confirmation details such as message IDs or status indicators.

No binary data is output by this node; all results are returned as JSON.

Dependencies

  • Requires access to the Z-API WhatsApp messaging service.
  • Needs valid credentials: Instance ID, Instance Token, and Client Token.
  • No additional environment variables are required beyond these credentials.
  • The node uses an internal helper function to make authenticated HTTP POST requests to the Z-API endpoint.

Troubleshooting

  • Invalid Credentials: If the Instance ID, Instance Token, or Client Token are incorrect or expired, the API request will fail. Verify and update credentials accordingly.
  • Invalid Phone Number Format: Ensure the phone number is in the correct international format without spaces or special characters.
  • Invalid Media URL/Base64: The sticker must be a valid image accessible via URL or correctly encoded in base64. Invalid or inaccessible URLs will cause errors.
  • Unknown Operation or Resource Errors: These occur if unsupported operations or resources are selected. Confirm that "send-sticker" is chosen under the "send-message" resource.
  • Delays Not Working: Delays for typing or message sending must be within allowed ranges (typing: 0-15 seconds, message delay: 1-15 seconds).
  • API Rate Limits or Network Issues: Temporary failures may happen due to network problems or API rate limits. Retrying or checking network connectivity can help.

Links and References

Discussion