Chat
Fixar mensagem
Fixa (pin) ou desfixa uma mensagem dentro de um chat
POST
Fixar mensagem
Auth:
TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim
Descrição
Fixa (pin: true) ou desfixa (pin: false) uma mensagem dentro de um chat. O chat, o autor da mensagem e a direção (fromMe) são resolvidos automaticamente a partir do messageId, você só precisa informar a mensagem.
A mensagem precisa existir no banco da instância (ter sido recebida/enviada por ela). Caso contrário a API retorna
message with ID ... not found.Exemplos
Fixar
Compin: true, a mensagem é fixada no topo do chat pelo tempo definido em duration.
Desfixar
Compin: false, a mensagem é desfixada. O campo duration é ignorado.
cURL
Resposta de sucesso
chat_jid é resolvido a partir do messageId, pinned reflete o estado final e duration é ecoado apenas quando se fixa. A message muda conforme o pin: "Message pinned successfully" ou "Message unpinned successfully".
200 OK
Parâmetros de rota
string
obrigatório
Nome da instância.
Headers
Request body
boolean
obrigatório
true fixa, false desfixa.string
obrigatório
ID da mensagem a fixar/desfixar. O chat e o autor são resolvidos automaticamente a partir dele.
string
padrão:"7d"
Por quanto tempo a mensagem fica fixada:
"24h", "7d" ou "30d". Usado apenas quando pin: true; ignorado ao desfixar.Respostas de erro
Erro 400
Relacionados
Fixar chat
POST /api/chat/pinChat/:instanceFavoritar
POST /api/chat/favorite/:instance