ZapClass API icon

ZapClass API

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

Mensagem → Enviar Lista

AI-generated

Overview

This node integrates with the ZapClass API to send WhatsApp messages, specifically supporting the operation to send a list message to a recipient. It is useful for scenarios where you want to send interactive list messages, such as product catalogs or menu selections, to users on WhatsApp. For example, a business can send a catalog list with categories and items, allowing the recipient to interact with the message by selecting options.

Use Case Examples

  1. Sending a product catalog list to a customer with categories and items.
  2. Sending a menu list for a restaurant with different food categories and items.

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 list button. It serves as the header for the list message.
Choices A JSON array representing sections and items in the list. Sections are denoted by titles in square brackets, and items are strings with title, ID, and description separated by pipes. This defines the content of the list message.
Additional Options Optional additional fields to customize the list message, including button text, delay before sending, secondary description text, phone numbers to mention, message tracking IDs, source identifier, and flags to mark the conversation or previous messages as read after sending.

Output

JSON

  • number - The recipient's phone number to whom the list message was sent.
  • title - The main title of the list message sent.
  • choices - The list of sections and items sent in the message.
  • additionalFields
    • button_text - The button text used to open the list.
    • delay - The delay before sending the message in milliseconds.
    • description - Secondary description text shown below the title.
    • mentions - Phone numbers mentioned in the message.
    • message_id - UUID for tracking the sent message.
    • message_reply_id - UUID of the message replied to.
    • message_source - Source identifier for tracking.
    • read - Whether the conversation was marked as read after sending.
    • read_messages - Whether previous messages were marked as read after sending.

Dependencies

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

Troubleshooting

  • Common issues include invalid phone number format, missing required fields like number or title, and incorrect JSON format for choices. Ensure the phone number is in international format (DDI + DDD + number).
  • Error messages may indicate unsupported resource or operation if the resource or operation parameters are incorrect. Verify that the resource is 'Mensagem' and operation is 'Enviar Lista'.
  • API authentication errors may occur if the API key credential is missing or invalid. Ensure proper credential configuration.

Discussion