vértice
Produto Preços Painel
Conversas

Conversas

Histórico local e ações de chat: arquivar, fixar, mutar, limpar, deletar, etiquetas e notas internas.

Referência

19 endpoints

GET /instances/:id/chats →

Conversas recentes

Lista as conversas recentes do histórico local com nome, última mensagem e horário.

API key · Escopo read
GET /instances/:id/chats/messages →

Mensagens de uma conversa

Retorna as mensagens de uma conversa, ordenadas da mais antiga para a mais recente, com limite configurável.

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

Detalhe do chat

Retorna resumo, foto, mensagens recentes e metadados do grupo quando aplicável.

API key · Escopo read
GET /instances/:id/chats/:jid/messages →

Mensagens do chat

Lista as mensagens locais do chat com limite configurável.

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

Foto do chat/contato

Retorna a foto do contato ou grupo.

API key · Escopo read
POST /instances/:id/chats/:jid/presence →

Atualizar presença no chat

Atualiza presença (digitando, pausado, disponível) no chat.

API key · Escopo write
PATCH /instances/:id/chats/:jid →

Arquiva, fixa, muta, lê ou expira o chat

Combina arquivamento, fixação, mudo, leitura e expiração em uma chamada.

API key · Escopo write
POST /instances/:id/chats/:jid/archive →

Arquiva/desarquiva chat

Arquiva ou desarquiva o chat.

API key · Escopo write
POST /instances/:id/chats/:jid/pin →

Fixa/desafixa chat

Fixa ou desafixa o chat.

API key · Escopo write
POST /instances/:id/chats/:jid/mute →

Muta/desmuta chat

Muta ou desmuta o chat por duração em segundos.

API key · Escopo write
POST /instances/:id/chats/:jid/read →

Marcar chat como lido/não lido

Marca o chat como lido ou não lido.

API key · Escopo write
POST /instances/:id/chats/:jid/clear →

Limpar mensagens do chat

Limpa as mensagens do chat no WhatsApp e no histórico local.

API key · Escopo write
POST /instances/:id/chats/:jid/expiration →

Definir mensagens temporárias

Define mensagens temporárias para o chat.

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

Deleta o chat

Deleta o chat para o número conectado.

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

Etiquetas vinculadas ao chat

Lista as etiquetas vinculadas ao chat no Vértice.

API key · Escopo read
POST /instances/:id/chats/:jid/labels →

Vincula etiqueta ao chat

Vincula uma etiqueta ao chat e ao app state do WhatsApp.

API key · Escopo write
DELETE /instances/:id/chats/:jid/labels/:labelId →

Remover etiqueta do chat

Remove a etiqueta do chat.

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

Nota interna do chat

Retorna a nota interna do chat.

API key · Escopo read
PUT /instances/:id/chats/:jid/note →

Salva nota interna do chat

Salva uma nota interna do chat no Postgres do Vértice.

API key · Escopo write