Pular para o conteúdo principal
Use sessions para pareamento, consulta de status e desconexão da sessão WhatsApp. Para instâncias e billing, veja Instâncias e billing. Para chats, veja Chats.

​
Sessão

​
sessions.status(instanceId, options?)

const status = await vzaps.sessions.status('VZ...', {
  instanceToken: 'instance-token',
});
Retorna SessionStatusResponse. Campos de data nesta ordem:
  1. connected — sempre primeiro
  2. phone
  3. whatsappJid
  4. pushName
  5. businessName
  6. businessProfile — subcampos: businessHoursTimezone, categories, profileOptions, address, email
  7. profilePictureId
  8. profilePictureUrl
  9. profileUrl
  10. verifiedName — about, website (quando aplicavel)
Quando desconectada, data so tem connected: false. Campos vazios sao omitidos.

​
sessions.qr(instanceId, options?)

const qr = await vzaps.sessions.qr('VZ...', {
  instanceToken: 'instance-token',
});
Retorno: envelope { code, success, data }. Se ainda nao conectada, data.qrCode (data URL PNG). Se ja conectada, data.status e data.phone.

​
sessions.pairCode(instanceId, phone, options?)

const pairCode = await vzaps.sessions.pairCode('VZ...', '5511999999999', {
  instanceToken: 'instance-token',
});
Retorno: envelope { code, success, data } com data.linkingCode (codigo de pareamento).

​
sessions.disconnect(instanceId, options?)

await vzaps.sessions.disconnect('VZ...', {
  instanceToken: 'instance-token',
});
Retorno: InstanceActionResponse — instanceId, status, details.