Actions56
- Message Actions
- Group Actions
- Chat Actions
- Profile Actions
- Event Actions
- Integration Actions
Chat → List Contacts
AI-generatedSummary
Lists contacts from the SendWave API. If List All is true (default), returns all contacts; otherwise returns the contact specified by the Contact (remote JID) field. The Instance Name is required. An optional API Key can be provided to override the default key.
Inputs
- Instance Name (required) — The SendWave instance name to target.
- List All (required) — When true, returns all contacts; when false, returns a specific contact.
- Contact (remote JID) — Specific contact number to retrieve when List All is false.
- API Key (Optional) — Optional override of the API key via webhook JSON data.
Output shape
Array of contact objects (or single contact object when List All false).
Exact shape depends on the underlying SendWave API response; includes contact details such as name, status, etc.
Examples
Example 1: List all contacts
Instance Name: 'myinstance', List All: true
Example 2: Get a single contact
Instance Name: 'myinstance', List All: false, Contact: '1234567890@c.us'