Saltar al contenido principal
GET
/
api
/
events
/
getWebsocket
/
:instance
Consultar Websocket
curl --request GET \
  --url https://api.example.com/api/events/getWebsocket/:instance \
  --header 'token: <token>'
Auth: TokenAccount o TokenInstance • Rate limit: Global (100/min) • Idempotente: sí

​
Descripción

Retorna la configuración actual del WebSocket de la instancia. Retorna 404 cuando no hay fila en websocket_configs (la instancia nunca fue configurada vía POST), no existe una “configuración default implícita”.
Atención a la ortografía: la ruta correcta es getWebsocket (con w minúscula en socket), diferente de POST /websocket. Esta inconsistencia es histórica, usa el literal exacto del registro.

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Ejemplo

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

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Respuesta exitosa

Retorna el objeto websocket con la configuración actual: enabled, events y mediaBase64. Nota: 404 significa “nunca configurado” (sin fila en websocket_configs), diferente de enabled=false (que retorna 200 con la fila persistida y los campos limpios). Maneja ambos casos en el cliente.
200 OK
{
  "success": true,
  "message": "WebSocket configuration retrieved",
  "websocket": {
    "enabled":     true,
    "events":      ["message.exchange"],
    "mediaBase64": false
  }
}
200 OK (disabled)
{
  "success": true,
  "message": "WebSocket configuration retrieved",
  "websocket": {
    "enabled":     false,
    "events":      [],
    "mediaBase64": false
  }
}

​
Errores

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
Envoltorio: 
{
  "success": false,
  "error": { "message": "WebSocket not configured for this instance" }
}

​
Notas

  • 404 ≠ “deshabilitado”: 404 significa “nunca se creó una fila”; un enabled=false retorna 200 normalmente con "enabled": false. Maneja ambos casos en el cliente.
  • Sin alias GET /websocket/:instance: a diferencia del webhook, no existe alias con la ortografía “regular”, solo getWebsocket (minúscula).

​
Siguiente

Configurar WebSocket

POST /api/events/websocket/:instance

Conectar vía WebSocket

GET /ws/:instance