Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" allows users to interact with the Evolution API service, specifically enabling sending status updates (stories) through a messaging platform. The "Enviar Status" operation under the "Mensagem" resource lets users post different types of status updates such as text, image, video, or audio. This is useful for automating status sharing in messaging apps, for example, broadcasting announcements, sharing multimedia content, or updating contacts with real-time information.

Practical examples:

  • Posting a text status update to all contacts announcing a new product launch.
  • Sharing an image or video story with selected contacts.
  • Sending an audio message as a status update to specific recipients.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the status update.
Tipo Do Status The type of status to post. Options: Status De Texto (text), Status De Imagem (image), Status De Video (video), Status De Audio (audio).
Conteudo Ou URL The content or URL of the image/video/audio to be posted. Required for all types.
Texto Para Status De Imagem/Video Text caption for image or video status updates. Optional.
Cor Do Background Background color for the status (hex color code). Default is black (#000000).
Font Do Texto Font type for the text. Options: SERIF, NORICAN REGULAR, BRYNDAN WRITE, BEBASNEUE REGULAR, OSWALD HEAVY.
Enviar Para Todos Boolean flag indicating whether to send the status to all contacts.
Lista De Contatos Comma-separated list of contacts who will receive the status. Required if not sending to all.

Output

The node outputs a JSON array containing the result of the status sending operation. Each item in the output array corresponds to the response from the Evolution API after attempting to send the status update. The exact structure depends on the API response but generally includes success confirmation or error details.

If the status includes media (image, video, audio), the node handles URLs pointing to these resources; however, it does not output binary data directly.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API endpoint and authentication to be configured properly within n8n credentials.
  • Network access to the Evolution API service is necessary.

Troubleshooting

  • Common issues:
    • Missing or invalid API credentials will cause authentication failures.
    • Incorrect or empty required fields like "Nome Da Instância" or "Conteudo Ou URL" will lead to errors.
    • Providing an invalid contact list format may cause the API to reject the request.
  • Error messages:
    • "Operação não suportada." indicates the requested operation is not implemented or recognized.
    • API errors returned by the Evolution API should be checked for details; ensure all required parameters are correctly set.
  • Resolutions:
    • Verify API credentials and permissions.
    • Double-check required input properties.
    • Ensure contact lists are comma-separated without extra spaces or invalid characters.

Links and References

  • Evolution API official documentation (not provided here, check your API provider's site)
  • n8n documentation on creating custom nodes and using credentials: https://docs.n8n.io/
  • General info on status/story posting in messaging platforms for context.

Discussion