Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" provides an interface to interact with the Evolution API, specifically allowing operations on various resources. For the resource "Grupo" and operation "Actualizar Miembros" (Update Participants), this node enables managing group members by adding, removing, promoting, or demoting participants within a specified group instance.

This functionality is useful in scenarios where automated management of group memberships is required, such as:

  • Adding new users to a chat group automatically based on external triggers.
  • Removing inactive or unauthorized members from groups.
  • Promoting trusted members to administrators for better group moderation.
  • Demoting administrators when necessary to maintain group hierarchy.

For example, a company could use this node to synchronize their internal user database with group memberships in a messaging platform, ensuring that only current employees have access to certain groups.

Properties

Name Meaning
Nombre De La Instancia The name of the instance where the group exists; identifies the specific environment or setup.
ID Del Grupo The unique identifier of the group whose members will be updated.
Acción The action to perform on the members. Options: Añadir Miembro (add), Eliminar Miembro (remove), Promover a Administrador (promote), Degradar a Miembro (demote).
Miembros A comma-separated list of member phone numbers to apply the action to (e.g., 5511999999999,5511888888888).

Output

The node outputs a JSON array containing the result of the update operation performed on the group members. Each element in the output array corresponds to the response from the Evolution API after executing the requested action on the specified participants.

If the API returns any binary data (not indicated in the provided code), it would typically represent files or media related to the group or members, but this node primarily deals with JSON responses reflecting membership updates.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The base URL for requests is set to https://doc.evolution-api.com/api-reference.
  • Proper configuration of the API credential in n8n is necessary to authorize requests.
  • Network connectivity to the Evolution API endpoint.

Troubleshooting

  • Unsupported Operation Error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "groups-api" and "update-participants" respectively.
  • Invalid Group ID or Instance Name: Errors may occur if the group ID or instance name does not exist or is misspelled. Double-check these values.
  • Malformed Participants List: Ensure the participants' phone numbers are correctly formatted and separated by commas without extra spaces.
  • Authentication Failures: Confirm that the API key credential is valid and has the necessary permissions.
  • API Rate Limits or Downtime: Temporary failures might happen due to API rate limits or service outages; retry after some time.

Links and References

Discussion