Uzapi icon

Uzapi

Interage com a API da Uzapi (WhatsApp)

Overview

This node, named "Uzapi," integrates with the Uzapi API to interact with WhatsApp messaging services. It enables sending various types of messages such as text, images, files, audio, and video through WhatsApp by leveraging the Uzapi platform.

A common use case for this node is automating WhatsApp communications in workflows, such as sending notifications, alerts, or media files to customers or team members directly via WhatsApp.

For example, you can use it to send a file (like a PDF invoice or an image) to a specified phone number with an optional description.

Properties

Name Meaning
Número (com DDI) Destination phone number including country code, e.g., 5511999998888
Descrição Description or caption for the image or file being sent
Link URL link to the file or image to be sent

These properties are used when performing operations related to sending media or files, specifically for the "Enviar Arquivo" operation.

Output

The node outputs JSON data representing the response from the Uzapi API after attempting the requested operation. This typically includes status information about the message sent, such as success confirmation or error details.

If the operation involves sending files or media, the output JSON may include metadata about the sent file or message.

The node does not explicitly handle binary data output; all responses are returned as JSON objects.

Dependencies

  • Requires an active Uzapi API credential configured in n8n, which provides authentication to the Uzapi WhatsApp API.
  • The node depends on the external Uzapi service endpoint specified by the base URL in the credentials.
  • No other external dependencies are indicated in the source code.

Troubleshooting

  • Operation Not Implemented Error: If you specify an operation that is not supported, the node will throw an error stating the operation is not implemented. Ensure you select a valid operation from the available options.
  • Invalid Credentials: Failure to authenticate with the Uzapi API due to incorrect or missing API credentials will cause errors. Verify that the API key or token is correctly set up in the node credentials.
  • Invalid Phone Number Format: Providing a phone number without the correct international format (including country code) may result in message delivery failure.
  • File Link Issues: For file sending operations, ensure the provided link is accessible and points directly to the file resource; otherwise, the API call may fail.

Links and References

Discussion