Actions90
- Sessions Actions
- Messages - Sending Actions
- Chats Actions
- Messages - Actions Actions
- Groups Actions
- List Groups
- Group Info
- Get Invite Link
- Revoke Invite Link
- Join via Link
- Preview via Link
- Create Group
- Delete Group
- Update Group Description
- Toggle Announcement Mode
- List Participants
- Add Participants
- Remove Participants
- Demote Participants
- Approve Join Request
- Reject Join Request
- List Join Requests
- Get Group Picture
- Set Group Picture
- Delete Group Picture
- Leave Group
- Update Group Name
- Lock Group Edits
- Promote Participants
- Profile Actions
- Server Actions
- Miscellaneous Actions
Overview
This node operation lists contacts from a specified WhatsApp session using the WARest WhatsApp REST API. It allows users to retrieve contact information such as contacts or groups, with options for deep lookup, filtering by group IDs, and pagination through limit and offset parameters. This is useful for scenarios where you need to manage or analyze WhatsApp contacts programmatically, such as syncing contacts with a CRM or performing bulk operations on contact lists.
Use Case Examples
- Retrieve a list of contacts from a specific WhatsApp session to update a customer database.
- Fetch groups associated with a WhatsApp session for group management or analytics.
- Perform a deep lookup to get detailed contact information for targeted messaging campaigns.
Properties
| Name | Meaning |
|---|---|
| Session | Identifier of the WhatsApp session from which to list contacts. It can be selected from a list of available sessions or entered manually. |
| Type | Specifies whether to list 'contacts' or 'groups' from the session. |
| Deep Lookup | Boolean flag to perform a deep lookup for more detailed contact information. |
| Group IDs (CSV) | Comma-separated list of group IDs to filter the contacts or groups. |
| Limit | Maximum number of contacts or groups to return. |
| Offset | Number of contacts or groups to skip before starting to collect the result set. |
Output
JSON
json- Array of contact or group objects returned by the WARest API representing the listed contacts or groups.
Dependencies
- Requires an API key credential for the WARest WhatsApp REST API and the base URL of the API server.
Troubleshooting
- Ensure the session ID is valid and active; invalid or expired sessions will cause errors.
- Check API credentials and base URL configuration to avoid authentication or connection errors.
- If no contacts are returned, verify the 'Type' parameter and any filters like 'Group IDs' or pagination settings.
- Errors related to missing parameters indicate required fields like 'Session' are not set properly.
Links
- Baileys WhatsApp Library - Underlying WhatsApp library often used with WARest API for WhatsApp automation.
- WARest API Documentation - Official documentation for the WARest WhatsApp REST API used by this node.