Uzapi Business icon

Uzapi Business

Interage com a API da Uzapi Business (WhatsApp)

Overview

This node integrates with the Uzapi Business API to send WhatsApp messages. It supports sending different types of messages such as text, images, audio, video, and documents to specified recipients. This node is useful for automating communication workflows where businesses need to send notifications, alerts, or multimedia content directly via WhatsApp.

Practical examples include:

  • Sending order confirmations or delivery updates as text messages.
  • Sharing product images or promotional videos with customers.
  • Delivering audio instructions or documents like invoices or contracts.

Properties

Name Meaning
Destinatário Recipient's phone number including country code (e.g., 5511999998888).
Tipo de Mensagem Type of message to send: Texto (text), Imagem (image), Áudio (audio), Vídeo (video), Documento (document).
Texto Text content of the message (required if message type is text).
Preview de URL Enable URL preview in the text message (boolean).
Link da Imagem URL of the image to be sent (required if message type is image).
Legenda da Imagem Optional caption for the image.
Link do Áudio URL of the audio file to be sent (required if message type is audio).
Legenda do Áudio Optional caption for the audio.
Link do Vídeo URL of the video to be sent (required if message type is video).
Legenda do Vídeo Optional caption for the video.
Link do Documento URL of the document to be sent (required if message type is document).

Output

The node outputs an array of JSON objects representing the response from the Uzapi Business API for each message sent. Each object typically contains details about the message status, IDs, or any error information returned by the API.

If binary data were involved (e.g., media files), it would be handled via URLs rather than direct binary output, so no binary output is expected here.

Dependencies

  • Requires an API key credential for authenticating with the Uzapi Business API.
  • The node depends on the ApiClient class (from bundled source) to handle API requests.
  • Proper configuration of credentials with username, version, and optionally a phone number ID is necessary.
  • Network access to the URLs provided for media (images, audio, video, documents) must be available.

Troubleshooting

  • Common issues:

    • Invalid or missing recipient phone number format may cause message sending failures.
    • Incorrect or expired API credentials will result in authentication errors.
    • Providing invalid or inaccessible media URLs will cause media message sending to fail.
    • Unsupported operation names will throw an error indicating the operation is not implemented.
  • Error messages:

    • "Operation \"sendMessage\" não implementada" means the requested operation is not supported; ensure the operation name is correct.
    • Authentication errors usually indicate problems with the API key or credential setup.
    • Media-related errors often stem from invalid URLs or unsupported media formats.

To resolve these, verify all input parameters, check credentials, and ensure media URLs are publicly accessible and valid.

Links and References

Discussion