Definir Configurações

POST

api

instance

settings

:instance

Definir Configurações

curl --request POST \
  --url https://api.example.com/api/instance/settings/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "autoRejectCalls": true,
  "callRejectMessage": "<string>",
  "ignoreGroupMessages": true,
  "keepOnlineStatus": true,
  "autoReadMessages": true,
  "disableHistorySync": true,
  "ignoreStatus": true
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    autoRejectCalls: true,
    callRejectMessage: '<string>',
    ignoreGroupMessages: true,
    keepOnlineStatus: true,
    autoReadMessages: true,
    disableHistorySync: true,
    ignoreStatus: true
  })
};

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

import requests

url = "https://api.example.com/api/instance/settings/:instance"

payload = {
    "autoRejectCalls": True,
    "callRejectMessage": "<string>",
    "ignoreGroupMessages": True,
    "keepOnlineStatus": True,
    "autoReadMessages": True,
    "disableHistorySync": True,
    "ignoreStatus": True
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

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

print(response.text)

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

Descrição

Aceita body parcial, campos não enviados são mantidos. Pelo menos um campo precisa ser informado. Se keepOnlineStatus é enviado e a instância está conectada, a presença é aplicada em tempo real (envia PresenceAvailable ou PresenceUnavailable).

Exemplos

Alterar só autoReadMessages

Body parcial com apenas autoReadMessages: true, os outros 6 settings ficam intocados, o servidor só atualiza o campo enviado e devolve o objeto completo na resposta.

curl -X POST "https://ryzeapi.cloud/api/instance/settings/minha-instancia" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"autoReadMessages":true}'

await fetch("https://ryzeapi.cloud/api/instance/settings/minha-instancia", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ autoReadMessages: true })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/settings/minha-instancia",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={"autoReadMessages": True}
)

package main

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

func main() {
    body := strings.NewReader(`{"autoReadMessages":true}`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/settings/minha-instancia", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Combo anti-ruído

Aplica de uma vez quatro settings para silenciar o número: ignora mensagens de grupo, ignora stories, rejeita chamadas e responde ao chamador com a callRejectMessage. Combinação típica para bots 1-a-1 que não querem ser interrompidos.

curl -X POST "https://ryzeapi.cloud/api/instance/settings/minha-instancia" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "ignoreGroupMessages": true,
    "ignoreStatus": true,
    "autoRejectCalls": true,
    "callRejectMessage": "Não atendo ligações por aqui."
  }'

await fetch("https://ryzeapi.cloud/api/instance/settings/minha-instancia", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    ignoreGroupMessages: true,
    ignoreStatus:        true,
    autoRejectCalls:     true,
    callRejectMessage:   "Não atendo ligações por aqui."
  })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/settings/minha-instancia",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "ignoreGroupMessages": True,
        "ignoreStatus":        True,
        "autoRejectCalls":     True,
        "callRejectMessage":   "Não atendo ligações por aqui."
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "ignoreGroupMessages": true,
        "ignoreStatus":        true,
        "autoRejectCalls":     true,
        "callRejectMessage":   "Não atendo ligações por aqui."
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/settings/minha-instancia", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Resposta de sucesso

A resposta inclui todos os 7 settings (os não modificados vêm com o valor atual do banco).

200 OK

{
  "success": true,
  "message": "Settings updated successfully",
  "settings": {
    "autoRejectCalls": true,
    "callRejectMessage": "Não atendo ligações por aqui.",
    "ignoreGroupMessages": true,
    "keepOnlineStatus": false,
    "autoReadMessages": false,
    "disableHistorySync": true,
    "ignoreStatus": true
  }
}

Path parameters

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json.

Request body

boolean

Rejeita chamadas recebidas automaticamente.

string

Mensagem automática ao rejeitar chamada.

boolean

Não processa mensagens recebidas em grupos.

boolean

Mantém presença available. Aplicado imediatamente se a instância estiver conectada.

boolean

Marca mensagens recebidas como lidas.

boolean

padrão:"true"

Desliga sincronização de histórico no primeiro connect. Default true.

boolean

Ignora mensagens tipo “status” (stories) do WhatsApp.

Notas

disableHistorySync=true no update não apaga histórico já importado, só afeta futuros connect.

Aplicar ignoreGroupMessages=true não apaga mensagens de grupos já gravadas; só para de gravar novas.

Erros

HTTP	`error.message`	Quando
400	`Invalid request body`	JSON malformado.
400	`At least one setting must be provided`	Body sem nenhum campo.
401	`Invalid token`	Token ausente ou inválido.
404	`Instance not found`	Nome não existe.
429	`Rate limit exceeded. Try again later.`	Mais de 100 req/min.
500	`Failed to update settings configuration`	Erro de banco.

{
  "success": false,
  "error": {
    "message": "At least one setting must be provided"
  }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Definir Configurações

Descrição

Exemplos

Alterar só autoReadMessages

Combo anti-ruído

Resposta de sucesso

Path parameters

Headers

Request body

Notas

Erros

​Descrição

​Exemplos

​Alterar só autoReadMessages

​Combo anti-ruído

​Resposta de sucesso

​Path parameters

​Headers

​Request body

​Notas

​Erros

Descrição

Exemplos

Alterar só autoReadMessages

Combo anti-ruído

Resposta de sucesso

Path parameters

Headers

Request body

Notas

Erros