Silenciar chat

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>"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({number: '<string>', mute: true, duration: '<string>'})
};

fetch('https://api.example.com/api/chat/mute/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/chat/mute/:instance"

payload = {
    "number": "<string>",
    "mute": True,
    "duration": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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"
  }'

await fetch(`https://ryzeapi.cloud/api/chat/mute/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:   "5511999999999",
    mute:     true,
    duration: "8h"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/mute/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":   "5511999999999",
        "mute":     True,
        "duration": "8h"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number":   "5511999999999",
        "mute":     true,
        "duration": "8h"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/mute/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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"
  }'

await fetch(`https://ryzeapi.cloud/api/chat/mute/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:   "5511999999999",
    mute:     true,
    duration: "always"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/mute/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":   "5511999999999",
        "mute":     True,
        "duration": "always"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number":   "5511999999999",
        "mute":     true,
        "duration": "always"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/mute/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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
  }'

await fetch(`https://ryzeapi.cloud/api/chat/mute/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number: "5511999999999",
    mute:   false
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/mute/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number": "5511999999999",
        "mute":   False
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number": "5511999999999",
        "mute":   false
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/mute/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

string

requerido

Nombre de la instancia.

Cabeceras

Nombre	Requerido	Ejemplo	Descripción
`Content-Type`	sí	`application/json`	,
`token`	sí (o `Authorization`)	`a1b2c3d4-...`	TokenAccount o TokenInstance.

Cuerpo de la solicitud

string

requerido

Número de teléfono, JID privado (...@s.whatsapp.net o ...@lid), JID de grupo (...@g.us) o newsletter.

boolean

requerido

true silencia, false reactiva.

string

Duración del silencio. Acepta los formatos de la tabla siguiente. Ignorado cuando mute=false.

Valores aceptados para `duration`

Valor	Significado
`"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

HTTP	`error.message`	Cuándo ocurre
400	`Instance name is required`	,
400	`Invalid request body: <...>`	JSON malformado.
400	`Number is required`	,
400	`Invalid duration: <...>`	Formato no reconocido.
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance 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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Descripción

Ejemplos

Silenciar por 8h

Silenciar permanentemente

Reactivar (unmute)

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Valores aceptados para `duration`

Respuestas de error

Relacionados

Archivar chat

Bloquear contacto

​Descripción

​Ejemplos

​Silenciar por 8h

​Silenciar permanentemente

​Reactivar (unmute)

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Valores aceptados para duration

​Respuestas de error

​Relacionados

Archivar chat

Bloquear contacto

Descripción

Ejemplos

Silenciar por 8h

Silenciar permanentemente

Reactivar (unmute)

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Valores aceptados para `duration`

Respuestas de error

Relacionados