潮汐文档
  1. SDK 参考
  2. 客户端
  3. 实时消息

潮汐实时消息 SDK

v2.4.0 稳定版

为 Web、移动端和小程序提供低延迟的消息收发、在线状态与历史同步能力。本页文字均为中文占位内容。

更新于 2026-09-18 · 阅读约 5 分钟

什么是潮汐 SDK

潮汐 SDK 是一套轻量的实时消息客户端，帮助你在几分钟内为产品接入聊天、通知与多人协作。这里是中文占位文字，用来展示正文段落在文档站中的排版、行高与字重层次。

  • 毫秒级送达

    全球 30+ 边缘节点就近接入，端到端延迟通常低于 100ms。

  • 断线不丢消息

    自动重连并补发离线期间的消息，历史记录默认保留 7 天。

  • 多端一套 API

    Web、iOS、Android 与小程序共用同一套接口与事件模型。

适用场景 在线客服 直播弹幕 协同编辑 订单通知 IoT 设备上报
快速安装 $npm install @tide/realtime 需要 Node.js 18 及以上，或任意现代浏览器
createClient(options: ClientOptions): TideClient 同步 · 返回客户端实例

创建客户端实例；创建后不会自动连接，需要再调用 client.connect()。下表为 options 的字段说明（占位）。

参数类型默认值说明
appId必填 string — 在控制台创建应用后获得的唯一标识
region 'cn' | 'global' 'cn' 接入区域，决定优先连接的边缘节点
reconnect boolean true 网络中断后是否自动重连并补发消息
timeout number 10000 建立连接的超时时间，单位为毫秒

订阅频道并发送一条消息

一段最小可运行代码，以及它运行后在界面上的效果示意。

chat.ts TypeScript 
import { createClient } from '@tide/realtime'

const client = createClient({ appId: 'demo-app' })
await client.connect()

// 订阅频道：收到新消息时渲染到界面
client.subscribe('room:42', (msg) => render(msg))
await client.publish('room:42', { text: '大家好！' })

常见问题

共 3 个问题
01 如何获取 appId 和密钥？

登录潮汐控制台，进入「应用管理」并点击「新建应用」，创建完成后即可在应用详情页看到 appId。密钥只用于服务端签名，请不要写进前端代码或提交到代码仓库。

02 网络断开后，消息会丢失吗？

不会。SDK 默认开启自动重连（reconnect: true），恢复连接后会按顺序补发离线期间的消息；超过 7 天的历史消息，可以通过服务端接口分页拉取。

03 支持哪些平台和浏览器？

支持 Chrome、Edge、Safari、Firefox 的最近两个大版本，以及 iOS 13+、Android 8+ 和微信、支付宝小程序。服务端推荐使用 Node.js 18 及以上版本。

潮汐文档 · 示例页面，内容均为占位