TikChat SDK

TikChat SDK 面向构建商业化即时通讯产品的业务团队，提供从 App 登录到 IM 长连接、服务端管理、 消息投递和运营治理的一套清晰边界。

当前协议原则

TikChat Protocol 是唯一协议 Source of Truth。Core、Java SDK、App Server 和客户端 UI 都围绕 同一套业务语义构建，不在 SDK 内维护历史字段兼容层。

三个 SDK 层次

层次	面向对象	主要能力	不应承担的职责
Core SDK	iOS、Android、桌面客户端	Token、连接、同步、消息、本地库、媒体和回调	管理密钥、后台权限、用户登录业务
Java Platform SDK	App Server、管理后台、机器人服务、频道服务	用户、关系、群组、消息、会话、频道、聊天室、媒体和运营 API	直接运行在不可信客户端
App Server API	iOS/Android/Web 业务客户端	验证码登录、IM Token、设备、版本、业务聚合	直接暴露 IM 管理密钥

按领域查找

Platform API 已按业务域拆分菜单；进入一个领域后，再按“概述、查询、写入、治理”等能力继续查找， 例如用户下包含概述、查询用户、更新个人资料、用户设置、创建用户、管理用户、在线状态、 通知账号和账号治理。完整的层级菜单见Platform API 总览。

• 用户：概述、查询、创建、管理、在线状态、通知账号、账号治理；
• 认证：管理员签名、用户登录、IM Token 和强制下线；
• 关系：概述、好友申请、查询好友、管理好友和黑名单；
• 群组：群资料、成员、设置、角色和生命周期；
• 频道：频道资料、频道身份和订阅；
• 聊天室：在线成员和临时会话关系；
• 会话：会话模型、查询、批量设置、已读未读、置顶和免打扰；
• 消息：发送、输入状态、撤回、删除、历史和运营消息；
• 设备与在线：设备登记、终端会话、在线查询和受控踢下线；
• 机器人：机器人账号管理和机器人身份发消息；
• 开放平台：开发者应用、机器人、频道/聊天室授权、消息 Open API 和 Webhook；
• 日志：客户端排障日志、审计字段和敏感信息边界；
• 系统与运营：健康检查、服务端时间、系统设置和运营台查询；
• Webhooks：事件回调、签名校验、幂等消费和安全边界；
• 内容治理：敏感词库、消息匹配和结构化治理错误；
• 错误码与排障：场景、错误信息、解决建议和重试策略。
• 枚举与常量：协议枚举、Java 门面常量、状态码和位掩码。
• Broker 配置与策略：部署配置键、客户端群组开关、好友和聊天室策略。
• OpenIM 能力对比：以 OpenIM 为参考，记录 TikChat 的能力取舍和改造优先级。

Platform API 菜单采用统一的“领域 → 分组 → 页面”结构。例如用户领域的菜单为：

1. 用户
   1. 概述
   2. 用户资料：查询用户、更新个人资料、用户设置
   3. 账号管理：创建用户、管理用户、账号治理
   4. 在线与通知：在线状态、通知账号

其他领域遵循相同规则：先进入领域概述，再按查询、变更、治理或运营能力选择页面。完整目录和维护 顺序见 Platform API 领域总览。

推荐接入路径

1. 业务客户端通过 App Server 完成登录并取得用户 IM Token；
2. 客户端创建 Core 实例，启动连接并监听消息、回执和连接状态；
3. App Server 使用 Java Platform SDK 调用受信任的管理能力；
4. 管理后台通过 App Server 或管理接口控制用户、群组、消息和版本；
5. 所有失败记录统一错误码、请求 ID、操作 ID 和链路 ID。

开始阅读：快速开始。