Verificar Configurações

GET

api

instance

getSettings

:instance

Verificar Configurações

curl --request GET \
  --url https://api.example.com/api/instance/getSettings/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

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

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

Descrição

Retorna as 7 flags de comportamento da instância: rejeição de chamadas, ignorar grupos, manter online, marcar como lida, sync de histórico, ignorar status.

Exemplo

Faz GET no path da instância e devolve o objeto settings com todas as flags atuais. Não aceita query params, apenas o nome no path e o token no header.

curl -X GET "https://ryzeapi.cloud/api/instance/getSettings/minha-instancia" \
  -H "token: $Token_Instance"

await fetch("https://ryzeapi.cloud/api/instance/getSettings/minha-instancia", {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    "https://ryzeapi.cloud/api/instance/getSettings/minha-instancia",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/instance/getSettings/minha-instancia", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Resposta de sucesso

200 OK

{
  "success": true,
  "message": "Settings retrieved successfully",
  "settings": {
    "autoRejectCalls": false,
    "callRejectMessage": "",
    "ignoreGroupMessages": false,
    "keepOnlineStatus": false,
    "autoReadMessages": false,
    "disableHistorySync": true,
    "ignoreStatus": false
  }
}

Path parameters

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

Campos

Campo	Tipo	Descrição
`autoRejectCalls`	boolean	Rejeita chamadas automaticamente
`callRejectMessage`	string	Mensagem enviada ao rejeitar
`ignoreGroupMessages`	boolean	Ignora eventos de grupo na ingestão
`keepOnlineStatus`	boolean	Mantém presença `available`
`autoReadMessages`	boolean	Marca mensagens recebidas como lidas
`disableHistorySync`	boolean	Desliga sync de histórico (default `true`)
`ignoreStatus`	boolean	Ignora mensagens do tipo “status” (stories)

Erros

HTTP	`error.message`	Quando
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 get settings configuration`	Erro de banco.

{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

Atualizar settings

POST /api/instance/settings/:instance para alterar.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Verificar Configurações

Descrição

Exemplo

Resposta de sucesso

Path parameters

Headers

Campos

Erros

Próximo

Atualizar settings

​Descrição

​Exemplo

​Resposta de sucesso

​Path parameters

​Headers

​Campos

​Erros

​Próximo

Atualizar settings

Descrição

Exemplo

Resposta de sucesso

Path parameters

Headers

Campos

Erros

Próximo