Pular para o conteúdo principal
POST
/
api
/
chat
/
mute
/
:instance
Silenciar chat
curl --request POST \
  --url https://api.example.com/api/chat/mute/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "mute": true,
  "duration": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: 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 com duration: "8h". Ao fim do período, as notificações voltam automaticamente sem necessidade de outra chamada. 
curl -X POST "https://ryzeapi.cloud/api/chat/mute/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":   "5511999999999",
    "mute":     true,
    "duration": "8h"
  }'

​
Silenciar permanente

Com duration: "always" (aceita "forever" e "permanent" também), o chat fica silenciado indefinidamente, até que você envie outra chamada com mute: false. 
curl -X POST "https://ryzeapi.cloud/api/chat/mute/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":   "5511999999999",
    "mute":     true,
    "duration": "always"
  }'

​
Desativar

Com mute: false, remove qualquer silenciamento ativo no chat e volta a entregar notificações normalmente. O campo duration é ignorado nesta variante. 
curl -X POST "https://ryzeapi.cloud/api/chat/mute/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "mute":   false
  }'

​
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
{
  "success": true,
  "message": "Chat muted for 8 hours",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "muted": true,
  "duration": 28800
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

NomeObrigatórioExemploDescrição
Content-Typesimapplication/json—
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

​
Request body

​
number
string
obrigatório
Telefone, JID privado (...@s.whatsapp.net ou ...@lid), JID de grupo (...@g.us) ou newsletter.
​
mute
boolean
obrigatório
true silencia, false desfaz.
​
duration
string
Tempo de silenciamento. Aceita os formatos da tabela abaixo. Ignorado quando mute=false.

​
Valores aceitos para duration

ValorSignificado
"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

HTTPerror.messageQuando ocorre
400Instance name is required—
400Invalid request body: <...>JSON malformado.
400Number is required—
400Invalid duration: <...>Formato não reconhecido.
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsApp—
Erro 400
{
  "success": false,
  "error": { "message": "Invalid duration: 5y" }
}

​
Relacionados

Arquivar chat

POST /api/chat/archive/:instance

Bloquear contato

POST /api/chat/block/:instance