Saltar al contenido 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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

​
Descripción

Silencia (mute: true) o reactiva (mute: false) un chat. El parámetro duration acepta varios formatos legibles para definir la ventana.

​
Ejemplos

​
Silenciar por 8h

Silencia el chat por una ventana de 8 horas con duration: "8h". Al final del periodo las notificaciones vuelven automáticamente, no se necesita otra llamada. 
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 permanentemente

Con duration: "always" (también acepta "forever" y "permanent"), el chat queda silenciado por tiempo indefinido hasta que envíes otra llamada con 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"
  }'

​
Reactivar (unmute)

Con mute: false, quita cualquier silencio activo del chat y las notificaciones se reanudan normalmente. El campo duration es ignorado en esta 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
  }'

​
Respuesta exitosa

muted indica el estado final y duration viene en segundos (28800 = 8h, 604800 = 1 semana, 0 = permanente o sin silencio). El message cambia por operación: "Chat muted permanently", "Chat muted for 8 hours", "Chat muted for 1 week" o "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 ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

NombreRequeridoEjemploDescripción
Content-Typesíapplication/json—
tokensí (o Authorization)a1b2c3d4-...TokenAccount o TokenInstance.

​
Cuerpo de la solicitud

​
number
string
requerido
Número de teléfono, JID privado (...@s.whatsapp.net o ...@lid), JID de grupo (...@g.us) o newsletter.
​
mute
boolean
requerido
true silencia, false reactiva.
​
duration
string
Duración del silencio. Acepta los formatos de la tabla siguiente. Ignorado cuando mute=false.

​
Valores aceptados para duration

ValorSignificado
"8h" o "8 hours"8 horas
"1w", "7d" o "1 week"1 semana
"always", "forever", "permanent"Sin expiración
(vacío)Sin expiración

​
Respuestas de error

HTTPerror.messageCuándo ocurre
400Instance name is required—
400Invalid request body: <...>JSON malformado.
400Number is required—
400Invalid duration: <...>Formato no reconocido.
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsApp—
Error 400
{
  "success": false,
  "error": { "message": "Invalid duration: 5y" }
}

​
Relacionados

Archivar chat

POST /api/chat/archive/:instance

Bloquear contacto

POST /api/chat/block/:instance