Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node interacts with the Evolution API to perform various operations related to instances. Specifically, the 'Set Presence' operation allows users to update the presence status of a specified instance, marking it as either 'Available' or 'Unavailable'. This is useful in scenarios where managing the real-time status of instances is critical, such as in communication platforms or service monitoring systems.

Use Case Examples

  1. Setting an instance's presence to 'Available' to indicate it is online and ready to receive requests.
  2. Marking an instance as 'Unavailable' during maintenance or downtime to prevent new connections.

Properties

Name Meaning
Instance Name The name of the instance whose presence status is to be set.
Presence The presence status to assign to the instance, either 'Available' or 'Unavailable'.

Output

JSON

  • presenceStatus - The updated presence status of the instance.
  • instanceName - The name of the instance whose presence was set.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.

Troubleshooting

  • If the node throws an 'Unsupported operation' error, verify that the 'Set Presence' operation is correctly selected under the 'Instance' resource.
  • Ensure the 'Instance Name' is correctly provided and matches an existing instance in the Evolution API system.
  • Check that the API key credential is valid and has the necessary permissions to update instance presence.

Links

  • Evolution API Documentation - Official documentation for the Evolution API, including details on instance management and presence operations.

Discussion