Actions7
- Mensagem Actions
- Contato Actions
- Grupo Actions
Contato → Listar Contatos
AI-generatedOverview
This node interacts with the WhatsApp API to perform various actions related to WhatsApp contacts, sessions, messages, groups, and media. Specifically, for the 'Contato' resource with the 'Listar Contatos' operation, it lists all contacts associated with a specified WhatsApp session. This is useful for scenarios where you need to retrieve and manage contact lists from WhatsApp sessions programmatically, such as syncing contacts with a CRM or automating contact-based workflows.
Use Case Examples
- Listing all contacts from a specific WhatsApp session to display in a dashboard.
- Automating the retrieval of contact lists for marketing or customer support purposes.
Properties
| Name | Meaning |
|---|---|
| Sessão | The name of the WhatsApp session from which to fetch contacts. This identifies the session context for the contact list retrieval. |
Output
JSON
- ``
id- Unique identifier of the contactname- Name of the contactphoneNumber- Phone number of the contactstatus- Status or presence information of the contactprofilePicUrl- URL to the contact's profile picture
Dependencies
- Requires an API key credential for the WhatsApp API (referred to as 'whatsAppBrApi'). The node makes authenticated HTTP requests to the WhatsApp API endpoint using this credential.
Troubleshooting
- Common issues include invalid or expired API tokens leading to authentication errors. Ensure the API key credential is valid and has the necessary permissions.
- Incorrect session names can cause the API to return empty results or errors. Verify the session name matches an active WhatsApp session.
- Network connectivity issues can cause request failures. Check network access to the WhatsApp API endpoint.
- Error messages from the API are typically propagated; review the error message for details and ensure all required parameters are correctly set.