Chat
Silenciar chat
Silencia notificações de um chat por um período definido ou indefinido
POST
Silenciar chat
Auth:
Valores aceitos para
TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim
Descrição
Silencia (mute: true) ou desativa o silenciamento (mute: false) de um chat. O parâmetro duration aceita vários formatos legíveis para configurar a janela.
Exemplos
Silenciar 8h
Silencia o chat por uma janela de 8 horas comduration: "8h". Ao fim do período, as notificações voltam automaticamente sem necessidade de outra chamada.
Silenciar permanente
Comduration: "always" (aceita "forever" e "permanent" também), o chat fica silenciado indefinidamente, até que você envie outra chamada com mute: false.
Desativar
Commute: false, remove qualquer silenciamento ativo no chat e volta a entregar notificações normalmente. O campo duration é ignorado nesta variante.
Resposta de sucesso
muted indica o estado final e duration vem em segundos (28800 = 8h, 604800 = 1 semana, 0 = permanente ou desativado). A message muda conforme a operação: "Chat muted permanently", "Chat muted for 8 hours", "Chat muted for 1 week" ou "Chat notifications unmuted successfully".
200 OK
Parâmetros de rota
Nome da instância.
Headers
| Nome | Obrigatório | Exemplo | Descrição |
|---|---|---|---|
Content-Type | sim | application/json | , |
token | sim (ou Authorization) | a1b2c3d4-... | TokenAccount ou TokenInstance. |
Request body
Telefone, JID privado (
...@s.whatsapp.net ou ...@lid), JID de grupo (...@g.us) ou newsletter.true silencia, false desfaz.Tempo de silenciamento. Aceita os formatos da tabela abaixo. Ignorado quando
mute=false.Valores aceitos para duration
| Valor | Significado |
|---|---|
"8h" ou "8 hours" | 8 horas |
"1w", "7d" ou "1 week" | 1 semana |
"always", "forever", "permanent" | Sem expiração |
| (vazio) | Sem expiração |
Respostas de erro
| HTTP | error.message | Quando ocorre |
|---|---|---|
| 400 | Instance name is required | , |
| 400 | Invalid request body: <...> | JSON malformado. |
| 400 | Number is required | , |
| 400 | Invalid duration: <...> | Formato não reconhecido. |
| 401 | Invalid token | , |
| 404 | Instance not found | , |
| 503 | Instance is not connected to WhatsApp | , |
Erro 400
Relacionados
Arquivar chat
POST /api/chat/archive/:instanceBloquear contato
POST /api/chat/block/:instance