Pular para o conteúdo principal
Use users e contacts para consultar perfis no WhatsApp e gerenciar contatos da instância. Para instâncias, veja Instâncias e billing.

​
Contatos

​
contacts.list(instanceId, options?)

const contacts = await vzaps.contacts.list('VZ...', {
  instanceToken: 'instance-token',
});
Retorno: envelope { code, success, data } com data[] de contatos (jid, Name, IsInWhatsapp, etc.).

​
contacts.add(request)

await vzaps.contacts.add({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511888888888',
  firstName: 'Maria',
  fullName: 'Maria Silva',
});
Retorno: envelope { code, success, data } com mensagem de confirmacao (ex.: "Contact added").

​
Usuários

​
users.info(request)

const info = await vzaps.users.info({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});
Retorno: envelope { code, success, data } com perfil do usuario (VerifiedName, Status, PictureId, etc.).

​
users.check(request)

const exists = await vzaps.users.check({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});
Retorno: envelope { code, success, data.users[] } com phone, exists, jid por numero consultado.

​
users.avatar(request)

const avatar = await vzaps.users.avatar({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});
Retorno: envelope { code, success, data } com base64 e mimetype da foto.

​
users.contacts(instanceId, options?)

const contacts = await vzaps.users.contacts('VZ...', {
  instanceToken: 'instance-token',
});
Retorno: envelope { code, success, data } — mapa JID → contato (FirstName, FullName, PushName, etc.).