Saltar al contenido principal
GET
/
api
/
instance
/
getSettings
/
:instance
Leer settings
curl --request GET \
  --url https://api.example.com/api/instance/getSettings/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

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"

​
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

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Campos

CampoTipoDescripción
autoRejectCallsbooleanRechaza llamadas automáticamente
callRejectMessagestringMensaje enviado al rechazar
ignoreGroupMessagesbooleanIgnora eventos de grupo en la ingesta
keepOnlineStatusbooleanMantiene presencia como available
autoReadMessagesbooleanMarca mensajes recibidos como leídos
disableHistorySyncbooleanDeshabilita la sincronización de historial (default true)
ignoreStatusbooleanIgnora mensajes de tipo “status” (stories)

​
Errores

HTTPerror.messageCuándo
401Invalid tokenToken faltante o inválido.
404Instance not foundNombre no existe.
429Rate limit exceeded. Try again later.Más de 100 req/min.
500Failed to get settings configurationError de base de datos.
{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

​
Siguiente

Actualizar settings

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