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

​
Contacts

​
contacts.list(instanceId, options?)

const contacts = await vzaps.contacts.list('VZ...', {
  instanceToken: 'instance-token',
});
Return: envelope { code, success, data } with contact array (jid, Name, IsInWhatsapp, etc.).

​
contacts.add(request)

await vzaps.contacts.add({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511888888888',
  firstName: 'Maria',
  fullName: 'Maria Silva',
});
Return: envelope { code, success, data } with confirmation text (e.g. "Contact added").

​
Users

​
users.info(request)

const info = await vzaps.users.info({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});
Return: envelope { code, success, data } with user profile fields (VerifiedName, Status, PictureId, etc.).

​
users.check(request)

const exists = await vzaps.users.check({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});
Return: envelope { code, success, data.users[] } with phone, exists, jid per checked number.

​
users.avatar(request)

const avatar = await vzaps.users.avatar({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});
Return: envelope { code, success, data } with avatar base64 and mimetype.

​
users.contacts(instanceId, options?)

const contacts = await vzaps.users.contacts('VZ...', {
  instanceToken: 'instance-token',
});
Return: envelope { code, success, data } — JID map to contact fields (FirstName, FullName, PushName, etc.).