ZapClass API icon

ZapClass API

Integração com a API do ZapClass para envio de mensagens WhatsApp

Actions12

Mensagem → Enviar Carrossel

AI-generated

Overview

This node integrates with the ZapClass API to send WhatsApp carousel messages. It is useful for scenarios where users want to send interactive carousel messages containing multiple cards with text, images, and optional buttons to WhatsApp recipients. For example, businesses can use it to showcase product offers or promotions in a visually engaging format.

Use Case Examples

  1. Sending a carousel message to a customer with multiple product cards, each containing an image, title, and a button linking to the product page.
  2. Sending a promotional carousel with special offers to a list of WhatsApp contacts.

Properties

Name Meaning
Number The recipient's phone number in international format (country code + area code + number). Required to specify the message destination.
Title The main title displayed above the carousel. Used to introduce or highlight the carousel content.
Choices JSON array defining the carousel cards. Each card can include text (in square brackets), an image URL (in curly braces), and optional buttons with labels and URLs.
Additional Options Optional settings such as delay before sending, phone numbers to mention, message tracking IDs, reply message ID, source identifier, and flags to mark the conversation or previous messages as read.

Output

JSON

  • number - The recipient phone number to whom the carousel message was sent.
  • title - The title displayed above the carousel.
  • choices - The array of carousel card elements including text, images, and buttons.
  • additionalFields
    • delay - Optional delay before sending the message.
    • mentions - Optional phone numbers mentioned in the message.
    • message_id - Optional UUID for message tracking.
    • message_reply_id - Optional UUID of the message being replied to.
    • message_source - Optional source identifier for tracking.
    • read - Optional flag indicating if the conversation is marked as read after sending.
    • read_messages - Optional flag indicating if previous messages are marked as read after sending.

Dependencies

  • ZapClass API service requiring an API key credential for authentication.

Troubleshooting

  • Ensure the recipient number is in the correct international format (DDI + DDD + number) to avoid delivery failures.
  • Verify that the ZapClass API credentials are correctly configured and valid to prevent authentication errors.
  • Check the JSON format of the 'Choices' property to ensure it is valid and correctly structured to avoid message formatting issues.
  • If the message fails to send, review the optional fields such as message IDs and mentions for correctness and existence.

Links

  • ZapClass API Documentation - Official documentation for the ZapClass API used to send WhatsApp messages including carousel messages.

Discussion