Pular para o conteúdo principal
GET
/
api
/
events
/
getWebsocket
/
:instance
Verificar Websocket
curl --request GET \
  --url https://api.example.com/api/events/getWebsocket/: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 a configuração atual do WebSocket da instância. Retorna 404 quando não há linha em websocket_configs (a instância nunca foi configurada via POST), não existe “config default implícita”.
Atenção à grafia: o path correto é getWebsocket (w minúsculo em socket), diferente de POST /websocket. Esta inconsistência é histórica, use o literal exato do registro.

​
Parâmetros de rota

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

​
Exemplo

curl -X GET "https://ryzeapi.cloud/api/events/getWebsocket/$Instance_Name" \
  -H "token: $Token_Instance"

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Resposta de sucesso

Retorna o objeto websocket com a configuração atual: enabled, events e mediaBase64. Atenção: 404 significa “nunca foi configurado” (não há linha em websocket_configs), diferente de enabled=false (que retorna 200 com a linha persistida e os campos zerados). Trate os dois casos no cliente.
200 OK
{
  "success": true,
  "message": "WebSocket configuration retrieved",
  "websocket": {
    "enabled":     true,
    "events":      ["message.exchange"],
    "mediaBase64": false
  }
}
200 OK (desabilitado)
{
  "success": true,
  "message": "WebSocket configuration retrieved",
  "websocket": {
    "enabled":     false,
    "events":      [],
    "mediaBase64": false
  }
}

​
Erros

HTTPerror.message
401Invalid token
404Instance not found
404WebSocket not configured for this instance
429Rate limit exceeded. Try again later.
500Failed to get instance
500Failed to get websocket configuration
Envelope: 
{
  "success": false,
  "error": { "message": "WebSocket not configured for this instance" }
}

​
Notas

  • 404 ≠ “desabilitado”: 404 significa “nunca criou linha”; um enabled=false retorna 200 normalmente com "enabled": false. Trate os dois casos no cliente.
  • Sem alias GET /websocket/:instance: diferente do webhook, não há um alias na grafia “regular”, apenas getWebsocket (minúsculo).

​
Próximo

Configurar WebSocket

POST /api/events/websocket/:instance

Conectar via WebSocket

GET /ws/:instance