Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://zapo.to/llms.txt

Use this file to discover all available pages before exploring further.

O zapo conecta-se como um dispositivo complementar (companion device) — exatamente como vincular o WhatsApp Web ou o Desktop. A primeira conexão pareia o dispositivo; depois disso, as credenciais armazenadas na sua store são reutilizadas automaticamente.

​
O fluxo de pareamento

O pareamento é conduzido inteiramente por eventos emitidos durante o connect():
EventoPayloadQuando
auth_qr{ qr: string, ttlMs: number }Um novo QR está disponível para renderizar. Reemitido conforme ele rotaciona.
auth_pairing_code{ code: string }Um código de pareamento de 8 dígitos foi emitido (fluxo por código).
auth_pairing_required{ forceManual: boolean }A sessão precisa de entrada de pareamento.
auth_paired{ credentials: WaAuthCredentials }O pareamento foi bem-sucedido; as credenciais agora estão persistidas.
Assim que auth_paired dispara, as credenciais são gravadas na store e reutilizadas em todo connect() subsequente — você não verá auth_qr novamente, a menos que a sessão seja desvinculada ou limpa.

​
Pareamento com um QR code

Este é o fluxo padrão. Renderize a string qr como uma imagem de QR e escaneie a partir de WhatsApp → Aparelhos conectados → Conectar um aparelho. 
import qrcode from 'qrcode-terminal'

client.on('auth_qr', ({ qr, ttlMs }) => {
  qrcode.generate(qr, { small: true })
  console.log(`QR valid for ${ttlMs}ms`)
})

client.on('auth_paired', ({ credentials }) => {
  console.log('Paired as', credentials.meJid)
})

await client.connect()
O QR rotaciona automaticamente; auth_qr dispara novamente com um valor novo a cada vez, então sempre renderize o mais recente.

​
Pareamento com um código

Prefere digitar um código de 8 dígitos no telefone em vez de escanear? Solicite um através de client.auth depois que a conexão estiver estabelecida. Escute o auth_pairing_required e então solicite o código para o número de telefone alvo (apenas dígitos, com código do país): 
client.on('auth_pairing_required', async () => {
  const code = await client.auth.requestPairingCode('5511999999999')
  // Formatar para exibição, ex.: "ABCD-1234"
  console.log('Enter on your phone:', code.match(/.{1,4}/g)?.join('-'))
})

client.once('auth_paired', () => console.log('Paired!'))

await client.connect()
requestPairingCode(phoneNumber, shouldShowPushNotification?, customCode?) requer uma conexão ativa e retorna o código como uma string. No telefone, abra Aparelhos conectados → Conectar com número de telefone.

​
Credenciais

Após o pareamento, as credenciais atuais ficam disponíveis de forma síncrona: 
const credentials = client.getCredentials() // WaAuthCredentials | null
console.log(credentials?.meJid)
WaAuthCredentials contém as chaves secretas do dispositivo. Está marcado como @sensitive por um motivo: qualquer coisa que consiga ler isso pode se passar pelo dispositivo. Se você persistir essas credenciais fora da store embutida, criptografe-as em repouso.

​
Fazendo logout

O logout() desvincula o dispositivo complementar no servidor (ele remove este dispositivo dos aparelhos conectados da conta). Requer uma sessão autenticada: 
await client.logout()
Por padrão, isso também limpa o estado armazenado. Você pode controlar exatamente quais domínios da store são apagados no logout através da opção logoutStoreClear — veja Configuração.

​
Disconnect vs. logout

disconnect()logout()
Fecha o socketSimSim
Mantém as credenciaisSim — reconecte mais tarde sem reparearNão — o dispositivo é desvinculado
Efeito no servidorNenhumRemove o dispositivo conectado
Use disconnect() para um encerramento gracioso que você pretende retomar; use logout() para desvincular permanentemente.

​
A seguir

Stores

Onde as credenciais e o estado do Signal são persistidos.

Reconexão

Trate o connection: close e reconecte.
Last modified on May 27, 2026