Skip to main content
Use users and contacts to look up WhatsApp profiles and manage instance contacts. For instances, see Instances and billing.

​
Contacts

​
client.contacts.list(instance_id, instance_token=...)

contacts = client.contacts.list("VZ...", instance_token="instance-token")
Return: envelope { code, success, data } with contact array (jid, Name, IsInWhatsapp, etc.).

​
client.contacts.add(...)

client.contacts.add(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511888888888",
    first_name="Maria",
    full_name="Maria Silva",
)
Return: envelope { code, success, data } with confirmation text (e.g. "Contact added").

​
Users

​
client.users.info(...)

info = client.users.info(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)
Return: envelope { code, success, data } with user profile fields (VerifiedName, Status, PictureId, etc.).

​
client.users.check(...)

exists = client.users.check(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)
Return: envelope { code, success, data.users[] } with phone, exists, jid per checked number.

​
client.users.avatar(...)

avatar = client.users.avatar(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)
Return: envelope { code, success, data } with avatar base64 and mimetype.

​
client.users.contacts(instance_id, instance_token=...)

contacts = client.users.contacts("VZ...", instance_token="instance-token")
Return: envelope { code, success, data } — JID map to contact fields (FirstName, FullName, PushName, etc.).