Contatos

This content is not available in your language yet.

Endpoints para gerenciar contatos, consultar informações de usuários, e configurar privacidade.

Verificar número

Verifica se um número está registrado no WhatsApp.

POST /user/check

{ "phone": "5511999999999" }

Resposta:

{
  "isOnWhatsApp": true,
  "jid": "5511999999999@s.whatsapp.net",
  "phone": "5511999999999"
}

Listar contatos

Retorna todos os contatos salvos na sessão.

GET /user/contacts

Resposta:

{
  "success": true,
  "contacts": [
    { "jid": "5511999999999@s.whatsapp.net", "name": "João Silva", "pushName": "João" },
    { "jid": "5521988888888@s.whatsapp.net", "name": "Maria Santos", "pushName": "Mari" }
  ]
}

Adicionar contato

POST /user/contact/add

{ "jid": "5511999999999@s.whatsapp.net", "name": "João Silva" }

Resposta:

{ "success": true }

Remover contato

POST /user/contact/remove

{ "jid": "5511999999999@s.whatsapp.net" }

Resposta:

{ "success": true }

Foto de perfil (avatar)

Busca a URL da foto de perfil de um número.

POST /user/avatar

{ "phone": "5511999999999" }

Resposta:

{ "success": true, "url": "https://pps.whatsapp.net/v/t61.24694-24/..." }

Foto da sessão

Busca a foto de perfil da própria sessão ou de outro usuário.

POST /user/photo

{ "jid": "5511999999999@s.whatsapp.net" }

Resposta:

{ "success": true, "url": "https://pps.whatsapp.net/v/t61.24694-24/..." }

Remover foto de perfil

Remove a foto de perfil da sessão conectada.

POST /user/photo/remove

Resposta:

{ "success": true }

Informações do usuário

Retorna informações detalhadas de um contato.

POST /user/info

{ "jid": "5511999999999@s.whatsapp.net" }

Resposta:

{
  "success": true,
  "info": {
    "verifiedName": "Loja Example",
    "status": "Atendimento das 9h às 18h",
    "pictureId": "1625309847",
    "devices": ["5511999999999.0:1@s.whatsapp.net"]
  }
}

Push name

Retorna o nome configurado pelo usuário no WhatsApp.

POST /user/pushname

{ "jid": "5511999999999@s.whatsapp.net" }

Resposta:

{ "success": true, "pushName": "João" }

Status (recado)

Retorna o texto de status (recado) de um contato.

POST /user/status

{ "jid": "5511999999999@s.whatsapp.net" }

Resposta:

{ "success": true, "status": "Disponível" }

Presença

Inscreve-se para receber atualizações de presença (online/offline) de um contato. Os eventos chegam via webhook.

POST /user/presence

{ "jid": "5511999999999@s.whatsapp.net" }

Resposta:

{ "success": true }

Blocklist

Consultar

Retorna a lista de contatos bloqueados.

GET /privacy/blocklist

Resposta:

{
  "success": true,
  "blocklist": [
    "5511977777777@s.whatsapp.net",
    "5521966666666@s.whatsapp.net"
  ]
}

Bloquear ou desbloquear

POST /privacy/blocklist

{ "jid": "5511977777777@s.whatsapp.net", "action": "block" }

Campo	Valores
`action`	`block` ou `unblock`

Resposta:

{ "success": true }

Mensagens temporárias

Configura o timer de mensagens temporárias para um chat.

POST /privacy/disappearing-timer

{ "jid": "5511999999999@s.whatsapp.net", "duration": 604800 }

Valor de `duration`	Efeito
`86400`	24 horas
`604800`	7 dias
`7776000`	90 dias
`0`	Desativar

Resposta:

{ "success": true }

Configurações de privacidade

Retorna as configurações de privacidade da sessão (visto por último, foto, status, etc.).

GET /privacy/settings

Resposta:

{
  "success": true,
  "settings": {
    "lastSeen": "contacts",
    "profilePhoto": "all",
    "status": "contacts",
    "readReceipts": "all",
    "groupAdd": "contacts",
    "online": "all"
  }
}

Dispositivos vinculados

Lista todos os dispositivos conectados à conta.

GET /device/linked

Resposta:

{
  "success": true,
  "devices": [
    { "id": "5511999999999.0:1@s.whatsapp.net", "platform": "smba", "pushName": "Chrome" },
    { "id": "5511999999999.0:4@s.whatsapp.net", "platform": "web", "pushName": "Firefox" }
  ]
}

Plataforma do dispositivo

Retorna informações sobre a plataforma do dispositivo principal.

GET /device/platform

Resposta:

{ "success": true, "platform": "android" }