Aysali API icon

Aysali API

Interact with Aysali API

Chat → List Contacts

AI-generated

Summary

Lists contacts from the selected WhatsApp instance via the Aysali API.

Inputs

  • instanceName (required) — Name of the Aysali API instance to use.
  • listAll (required) — If true, returns all contacts; if false, returns a single contact.
  • remoteJid — WhatsApp ID of the contact to retrieve. Required when List All is false.

Output shape

Array of contact objects

Each object contains contact details such as name, number, and profile information.

Examples

Example 1: Retrieve all contacts

Set List All to true.

Example 2: Retrieve a specific contact

Set List All to false and provide the Contact number.

Links

Discussion