WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Actions50

Overview

This node enables sending a contact card via WhatsApp using the WSAPI WhatsApp API. It is designed to share a contact's information (name and phone number) with a specified WhatsApp user or group. This functionality is useful in scenarios such as customer support, networking, or any situation where sharing contact details quickly within WhatsApp conversations is needed.

Practical examples:

  • A support agent sends a colleague’s contact info to a customer for follow-up.
  • A sales team shares a new lead’s contact details within a group chat.
  • An event organizer distributes key contacts to participants through WhatsApp messages.

Properties

Name Meaning
To The WhatsApp ID of the recipient. For individual contacts, this is the phone number followed by @s.whatsapp.net (e.g., 1234567890@s.whatsapp.net). For groups, it is the group ID followed by @g.us.
Contact Name Full name of the contact to be shared. This will appear as the display name in WhatsApp when the contact card is received.
Contact Phone Phone number of the contact to share, including country code but without the + symbol (e.g., 1234567890).
Advanced Options Additional optional settings:
- Mentions: Comma-separated list of phone numbers (without @) to mention in the message.
- Reply To Message ID: ID of a message to reply to.
- Is Forwarded: Boolean indicating if the message is forwarded.

Output

The node outputs JSON data representing the result of the send contact operation. This typically includes metadata about the sent message such as message ID, status, timestamps, and possibly delivery information.

No binary data output is involved in this operation since it deals with sending contact cards as structured message content.

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API service.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The base URL for the WSAPI must be set in the credentials configuration.
  • Internet access from the n8n instance to reach the WSAPI endpoint.

Troubleshooting

  • Invalid "To" format: Ensure the recipient ID follows the correct format (phone@s.whatsapp.net for individuals, group@g.us for groups). Missing country codes or incorrect suffixes will cause errors.
  • Missing required fields: The contact name and phone number are mandatory. Omitting these will prevent the message from being sent.
  • Authentication errors: Verify that the API key/token is valid and has not expired.
  • Network issues: Check connectivity to the WSAPI endpoint; timeouts or unreachable host errors indicate network problems.
  • Permission errors: The authenticated account must have permission to send messages to the specified recipients.
  • Reply to invalid message ID: If using the reply option, ensure the message ID exists and belongs to the same chat.

Links and References

Discussion