Pular para o conteúdo principal
GET
/
api
/
instance
/
getSettings
/
:instance
Verificar Configurações
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 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"

​
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

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Campos

CampoTipoDescrição
autoRejectCallsbooleanRejeita chamadas automaticamente
callRejectMessagestringMensagem enviada ao rejeitar
ignoreGroupMessagesbooleanIgnora eventos de grupo na ingestão
keepOnlineStatusbooleanMantém presença available
autoReadMessagesbooleanMarca mensagens recebidas como lidas
disableHistorySyncbooleanDesliga sync de histórico (default true)
ignoreStatusbooleanIgnora mensagens do tipo “status” (stories)

​
Erros

HTTPerror.messageQuando
401Invalid tokenToken ausente ou inválido.
404Instance not foundNome não existe.
429Rate limit exceeded. Try again later.Mais de 100 req/min.
500Failed to get settings configurationErro de banco.
{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

​
Próximo

Atualizar settings

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