z-api by @jaimeflneto icon

z-api by @jaimeflneto

Interact with Z-API to send WhatsApp messages

Overview

This node operation sends a contact message via WhatsApp using the Z-API integration. It allows users to specify the recipient's phone number, the contact's name, and the contact's phone number to share as a contact card. It supports optional delays for typing status and message sending, as well as replying to a specific message. This operation is useful for automating the sharing of contact information in WhatsApp conversations, such as sending business contacts or personal contacts programmatically.

Use Case Examples

  1. Sending a contact card to a customer with their phone number and name.
  2. Automating the sharing of a team member's contact details in a group chat.
  3. Replying to a specific message with a contact card after a delay to simulate typing.

Properties

Name Meaning
Phone Number The recipient's phone number with country code, formatted as numbers only without any special characters or formatting.
Contact Name The name of the contact to be sent as a contact card.
Contact Phone The phone number of the contact to be sent, formatted as numbers only without any special characters or formatting.
Options Additional optional settings for the message, including delay for typing status, delay before sending the message, and the ID of a message to reply to.

Output

JSON

  • phone - The recipient's phone number to whom the contact was sent.
  • contactName - The name of the contact that was sent.
  • contactPhone - The phone number of the contact that was sent.
  • messageId - The unique identifier of the sent message, useful for tracking or replying.

Dependencies

  • Z-API service for WhatsApp messaging

Troubleshooting

  • Ensure the phone numbers are correctly formatted with country code and contain only numbers, as incorrect formatting will cause message sending to fail.
  • If the message fails to send, check the validity and permissions of the Z-API credentials used in the node.
  • Delays for typing and message sending must be between 0 and 15 seconds; values outside this range may be ignored or cause errors.
  • Reply Message ID must correspond to a valid message ID in the chat; otherwise, the reply feature will not work.

Links

Discussion