Leer settings

GET

api

instance

getSettings

:instance

Leer settings

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

Descripción

Devuelve los 7 flags de comportamiento de la instancia: rechazo de llamadas, ignorar grupos, mantener online, marcar como leído, sincronización de historial, ignorar status.

Ejemplo

Realiza un GET en la ruta de la instancia y devuelve el objeto settings con todos los flags actuales. No se aceptan query params, solo el nombre en el path y el token en la cabecera.

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

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

import os, requests

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

package main

import (
    "net/http"
    "os"
)

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

Respuesta exitosa

200 OK

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

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

Campos

Campo	Tipo	Descripción
`autoRejectCalls`	boolean	Rechaza llamadas automáticamente
`callRejectMessage`	string	Mensaje enviado al rechazar
`ignoreGroupMessages`	boolean	Ignora eventos de grupo en la ingesta
`keepOnlineStatus`	boolean	Mantiene presencia como `available`
`autoReadMessages`	boolean	Marca mensajes recibidos como leídos
`disableHistorySync`	boolean	Deshabilita la sincronización de historial (default `true`)
`ignoreStatus`	boolean	Ignora mensajes de tipo “status” (stories)

Errores

HTTP	`error.message`	Cuándo
401	`Invalid token`	Token faltante o inválido.
404	`Instance not found`	Nombre no existe.
429	`Rate limit exceeded. Try again later.`	Más de 100 req/min.
500	`Failed to get settings configuration`	Error de base de datos.

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

Actualizar settings

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Descripción

Ejemplo

Respuesta exitosa

Parámetros de ruta

Cabeceras

Campos

Errores

Siguiente

Actualizar settings

​Descripción

​Ejemplo

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Campos

​Errores

​Siguiente

Actualizar settings

Descripción

Ejemplo

Respuesta exitosa

Parámetros de ruta

Cabeceras

Campos

Errores

Siguiente