Actions29
- Sessions Actions
- Chats Actions
- Contacts Actions
- Groups Actions
- Messages Actions
Overview
This node connects to a WhatsApp HTTP API service to list contacts associated with a given session. It is useful for workflows that need to retrieve and process contact information from a WhatsApp account programmatically. For example, it can be used to synchronize WhatsApp contacts with a CRM system or trigger actions based on the contact list.
Properties
| Name | Meaning |
|---|---|
| Phone | The session ID representing the WhatsApp session. This is required to authenticate and identify the session from which to list contacts. |
Output
The node outputs JSON data containing the list of contacts retrieved from the WhatsApp API for the specified session. The exact structure depends on the API response but typically includes contact identifiers, names, and possibly status or metadata related to each contact.
If the API supports binary data (e.g., profile pictures), the node may also output binary fields corresponding to such data, but this is not explicitly shown in the provided code.
Dependencies
- Requires an active WhatsApp HTTP API service endpoint.
- Needs an API URL and authentication credentials configured in n8n (such as an API key or token).
- The node uses a bundled OpenAPI specification to define its properties and requests.
- The "Phone" property must be set, usually linked to stored credentials representing the WhatsApp session.
Troubleshooting
- Missing or invalid session ID: Ensure the "Phone" property is correctly set and corresponds to a valid WhatsApp session.
- Authentication errors: Verify that the API credentials are correct and have sufficient permissions.
- API connectivity issues: Check network access to the WhatsApp API endpoint and confirm the base URL is properly configured.
- Unexpected API responses: Confirm the WhatsApp API version matches what the node expects; mismatches can cause parsing errors.