跳到主要内容

挂载 Live Sideband

GET 

wss://api.knox.chat/v1/live/sessions/:session_id/attach

在已有 Live 会话上打开 sideband WebSocket。音频继续走主 WebSocket 或 WebRTC/SIP 媒体路径。从服务器使用 sideband 可以:

  • 观察转写、session.delegation.created 和嵌套 response.event
  • 发送 session.thinking.append / session.commentary.append / session.update
  • 发送 session.close 以挂断并收取最终用量

关闭 sideband 不会结束主会话。Knox 内部也会用 sideband 为 WebRTC 和 SIP 按时长计费。

你必须拥有该会话(或对尚未写入 Knox 表的来电 SIP id 提供有效 Knox key)。见 GPT-Live 指南和 OpenAI 服务端控制。

请求​

路径参数​

名称类型必填描述
session_idString是来自 session.started 或创建响应的 Live 会话 id。

请求头​

名称类型必填描述
AuthorizationString是Bearer sk-… 或 Bearer ek_knox_…。
UpgradeString是必须为 websocket。

非 WebSocket 的 GET 返回 400:请通过 WebSocket 连接 /v1/live/sessions/{id}/attach。

连接示例​

import WebSocket from "ws";

const sessionId = "sess_…";
const ws = new WebSocket(
`wss://api.knox.chat/v1/live/sessions/${sessionId}/attach`,
{ headers: { Authorization: "Bearer " + process.env.KNOX_API_KEY } }
);

ws.on("message", (data) => {
const event = JSON.parse(data.toString());
console.log(event.type);
});

// 从服务器结束通话:
// ws.send(JSON.stringify({ type: "session.close" }));

sideband 上的 session.update 与主连接校验方式相同(delegation.responses.model 必须被允许)。

错误响应​

状态何时
400不是 WebSocket 升级,或会话 id 无效。
401缺少或无效的 Knox API key。
403Token 未被授权使用 gpt-live-1。
404会话不存在,或不属于当前用户。
502上游 attach 失败。