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

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

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

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

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

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

string

obrigatório

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

string

obrigatório

Telefone, JID privado (...@s.whatsapp.net ou ...@lid), JID de grupo (...@g.us) ou newsletter.

boolean

obrigatório

true silencia, false desfaz.

string

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

{
  "success": false,
  "error": { "message": "Invalid duration: 5y" }
}

Relacionados

Arquivar chat

POST /api/chat/archive/:instance

Bloquear contato

POST /api/chat/block/:instance

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplos

Silenciar 8h

Silenciar permanente

Desativar

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Valores aceitos para `duration`

Respostas de erro

Relacionados

Arquivar chat

Bloquear contato

​Descrição

​Exemplos

​Silenciar 8h

​Silenciar permanente

​Desativar

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Valores aceitos para duration

​Respostas de erro

​Relacionados

Arquivar chat

Bloquear contato

Descrição

Exemplos

Silenciar 8h

Silenciar permanente

Desativar

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Valores aceitos para `duration`

Respostas de erro

Relacionados