Zappfy API icon

Zappfy API

Interact with Zappfy API

Overview

The node "Zappfy API" provides integration with the Zappfy messaging API, enabling users to send contact information via WhatsApp. Specifically, the "Enviar Contato" (Send Contact) operation under the "Mensagem" (Message) resource allows sending one or multiple contacts to a specified recipient's WhatsApp number through a configured instance.

This node is useful in scenarios such as:

  • Automating the sharing of business contacts or customer details via WhatsApp.
  • Integrating CRM or contact management systems with WhatsApp messaging for quick contact dissemination.
  • Sending contact cards during customer support or sales workflows.

Example: Automatically send a list of new leads' contact cards to a sales representative's WhatsApp number.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the contact message. This identifies which configured sender to use.
Número Do Destinatário The recipient's WhatsApp number in string format.
Contatos A list of contacts to send. Each contact includes:
- Nome Completo: Full name of the contact.
- Número Do WhatsApp: WhatsApp number (digits only, e.g., 559999999999).
- Número Formatado: Formatted phone number (e.g., +55 99 9 9999-9999).
- Organização: Organization or company name.
- Email: Contact's email address.
- URL: URL of the contact's webpage.

Output

The node outputs a JSON array containing the response from the Zappfy API after attempting to send the contact(s). The exact structure depends on the API response but typically includes status and confirmation details about the sent message.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Zappfy API.
  • The node expects the base URL https://docs.zappfy.io/api-reference for API requests.
  • Proper configuration of the instance name and recipient WhatsApp number is necessary.
  • Network access to the Zappfy API endpoint must be available.

Troubleshooting

  • Operation Not Supported Error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "messages-api" and "send-contact" respectively.
  • Invalid Recipient Number: Ensure the recipient's WhatsApp number is correctly formatted and includes country code without special characters unless specified.
  • Missing Required Fields: All required fields such as instance name, recipient number, and contact details must be provided; missing these will cause errors.
  • API Authentication Failures: Confirm that the API key credential is valid and has proper permissions.
  • Network Issues: Check connectivity to the Zappfy API endpoint if requests time out or fail.

Links and References

  • Zappfy API Documentation (official API reference)
  • WhatsApp contact card formatting guidelines (consult WhatsApp Business API docs for best practices)

Discussion