跳到文档正文

WebSocket 快速开始

添加一个监控账号,打开服务端 WebSocket,然后输出每个 v1 消息信封。

获取 API 密钥
在聊天中打开
按产品代码校对:2026年9月24日

运行 5 分钟连通性测试

添加一个监控账号,复制示例并运行。看到 TweetStream connected 表示认证成功。该账号发布内容后会收到事件。

// bun add ws
// TWEETSTREAM_API_KEY=ts_... bun run smoke.ts
import WebSocket from "ws";
 
const apiKey = process.env.TWEETSTREAM_API_KEY;
if (!apiKey) {
  throw new Error("Missing TWEETSTREAM_API_KEY");
}
 
const ws = new WebSocket("wss://ws-global.tweetstream.io/ws", [
  "tweetstream.v1",
  `tweetstream.auth.token.${apiKey}`,
]);
 
ws.on("open", () => {
  console.log("TweetStream connected");
});
 
ws.on("message", (raw) => {
  const event = JSON.parse(raw.toString());
  console.log(event.t, event.op, event.d);
});
 
ws.on("close", (code, reason) => {
  console.log("TweetStream closed", code, reason.toString());
});
 
ws.on("unexpected-response", (_request, response) => {
  console.error(
    "Connection rejected",
    response.statusCode,
    response.statusMessage,
  );
  response.resume();
  process.exitCode = 1;
});
 
ws.on("error", (error) => {
  console.error("WebSocket error", error.message);
});

分发操作

每个事件在 t 中标明类别,在 op 中标明操作。交付参考列出全部 18 种服务端操作。

让消费者可靠运行