vértice
Produto Preços Painel
Contatos

Contatos

Agenda local, metadados, foto, checagem de números, bloqueio e perfil business de contatos.

Referência

13 endpoints

GET /instances/:id/contacts →

Listar contatos conhecidos localmente

Lista contatos conhecidos localmente, com busca por nome, telefone ou JID.

API key · Escopo read
POST /instances/:id/contacts →

Adicionar ou editar contato

Adiciona ou edita um contato na agenda do WhatsApp.

API key · Escopo write
GET /instances/:id/contacts/blocked →

Listar contatos bloqueados

Lista os contatos bloqueados.

API key · Escopo read
POST /instances/:id/contacts/check →

Verificar números em lote

Verifica em lote quais números possuem WhatsApp.

API key · Escopo write
GET /instances/:id/contacts/:jid →

Metadados de um contato

Retorna existência, nome local, foto e contagem de mensagens de um contato.

API key · Escopo read
GET /instances/:id/contacts/:jid/picture →

Foto do contato

Retorna a URL da foto do contato.

API key · Escopo read
GET /instances/:id/contacts/:jid/status →

Recado/status do contato

Consulta o recado/status do contato.

API key · Escopo read
GET /instances/:id/contacts/:jid/business →

Perfil business do contato

Retorna o perfil business do contato, quando existir.

API key · Escopo read
POST /instances/:id/contacts/:jid/block →

Bloqueia contato

Bloqueia o contato.

API key · Escopo write
DELETE /instances/:id/contacts/:jid/block →

Desbloqueia contato

Desbloqueia o contato.

API key · Escopo write
POST /instances/:id/contacts/:jid/report →

Denuncia contato

Denuncia contato (não suportado).

API key · Escopo write
DELETE /instances/:id/contacts/:jid →

Remover contato da agenda

Remove o contato da agenda do WhatsApp.

API key · Escopo write
GET /instances/:id/contacts/:jid/labels →

Etiquetas do contato

Etiquetas do contato (não suportado).

API key · Escopo read