Evolution API icon

Evolution API

Interact with Evolution API

Actions114

EvoAI → Ignore JID

AI-generated

Overview

The EvoAI Ignore JID operation allows users to manage an ignore list for contacts by adding or removing a specified contact JID (Jabber ID) from the list. This is useful in scenarios where users want to filter or block communications from certain contacts within the Evolution API environment, such as ignoring messages from specific WhatsApp contacts.

Use Case Examples

  1. Add a contact JID to the ignore list to stop receiving messages from that contact.
  2. Remove a contact JID from the ignore list to resume receiving messages from that contact.

Properties

Name Meaning
Instance Name The name of the instance where the ignore action will be applied.
Contact JID The JID of the contact to be added or removed from the ignore list, e.g., a WhatsApp contact identifier.
Action Specifies whether to add the contact JID to the ignore list or remove it from the ignore list.

Output

JSON

  • success - Indicates whether the ignore action was successfully performed.
  • message - A message providing additional information about the result of the ignore action.

Dependencies

  • Requires an API key credential for the Evolution API to authenticate requests.

Troubleshooting

  • Ensure the 'Instance Name' and 'Contact JID' are correctly specified and valid.
  • Verify that the API key credential for the Evolution API is correctly configured and has the necessary permissions.
  • Common error: 'Unsupported operation.' indicates the specified operation is not implemented or incorrectly referenced; verify the operation name.
  • Errors related to network or authentication failures may occur if the API endpoint is unreachable or credentials are invalid.

Discussion