Verificar Websocket

GET

api

events

getWebsocket

:instance

Verificar 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 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

string

obrigatório

Nome da instância.

Exemplo

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)
}

Headers

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

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`

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).

Configurar WebSocket

POST /api/events/websocket/:instance

Conectar via WebSocket

GET /ws/:instance

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Verificar Websocket

Descrição

Parâmetros de rota

Exemplo

Headers

Resposta de sucesso

Erros

Notas

Próximo

Configurar WebSocket

Conectar via WebSocket

​Descrição

​Parâmetros de rota

​Exemplo

​Headers

​Resposta de sucesso

​Erros

​Notas

​Próximo

Configurar WebSocket

Conectar via WebSocket

Descrição

Parâmetros de rota

Exemplo

Headers

Resposta de sucesso

Erros

Notas

Próximo