Consultar Websocket

GET

api

events

getWebsocket

:instance

Consultar Websocket

curl --request GET \
  --url https://api.example.com/api/events/getWebsocket/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://api.example.com/api/events/getWebsocket/: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

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

string

requerido

Nombre de la instancia.

Ejemplo

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

await fetch(`https://ryzeapi.cloud/api/events/getWebsocket/${process.env.Instance_Name}`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/events/getWebsocket/{os.environ['Instance_Name']}",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/events/getWebsocket/"+os.Getenv("Instance_Name"), nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Cabeceras

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

HTTP	`error.message`
401	`Invalid token`
404	`Instance not found`
404	`WebSocket not configured for this instance`
429	`Rate limit exceeded. Try again later.`
500	`Failed to get instance`
500	`Failed 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).

Configurar WebSocket

POST /api/events/websocket/:instance

Conectar vía WebSocket

GET /ws/:instance

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Consultar Websocket

Descripción

Parámetros de ruta

Ejemplo

Cabeceras

Respuesta exitosa

Errores

Notas

Siguiente

Configurar WebSocket

Conectar vía WebSocket

​Descripción

​Parámetros de ruta

​Ejemplo

​Cabeceras

​Respuesta exitosa

​Errores

​Notas

​Siguiente

Configurar WebSocket

Conectar vía WebSocket

Descripción

Parámetros de ruta

Ejemplo

Cabeceras

Respuesta exitosa

Errores

Notas

Siguiente