XuqmGroup-Web/docs-site/docs/guide/concepts.md
XuqmGroup 6cd938cfbc feat(android-sdk): 添加完整的IM客户端SDK实现
- 实现了Android SDK的完整IM功能接口,包括消息、群组、好友、会话等核心功能
- 添加了消息收发、历史记录、撤回编辑等完整的消息操作能力
- 实现了群组管理功能,包括创建、成员管理、权限设置等操作
- 添加了好友关系链管理,支持添加、删除、分组等操作
- 实现了会话管理功能,包括置顶、免打扰、已读状态等
- 添加了黑名单、资料管理、搜索等辅助功能
- 补齐了批量操作接口,提升客户端操作效率
- 实现了WebSocket连接管理和事件监听机制
- 添加了离线消息同步和状态管理功能
2026-05-02 22:57:55 +08:00

2.9 KiB

平台概念

了解 XuqmGroup 平台的核心概念,有助于更好地接入 SDK。


App / Tenant

概念 说明
Tenant租户 对应一个开发者账号/企业,可在控制台创建多个应用
App应用 对应一个具体的客户端应用,拥有独立的 appKeyappSecret
appKey 应用唯一标识,客户端初始化时传入
appSecret 应用密钥,仅保存在服务端,用于签发 UserSig

UserSig

UserSig 是 XuqmGroup 的登录鉴权凭证,由业务服务端用 appSecret 为用户签发的安全凭证。

特点

  • 当前版本不过期,只校验 userId + UserSig 是否匹配
  • appSecret 绝不下发到客户端
  • 若需撤销权限,可在租户平台重置 appSecret 或拉黑账号

签发方式(示例)

// Node.js 示例
import jwt from 'jsonwebtoken'

const userSig = jwt.sign(
  { userId: 'user_001', appKey: 'your_app_key' },
  'your_app_secret',
  { algorithm: 'HS256' }
)

消息类型

类型 说明 content 结构
TEXT 纯文本 String
IMAGE 图片 {url, width, height, thumbnailUrl?}
VIDEO 视频 {url, duration, thumbnailUrl, size}
AUDIO 语音 {url, duration, size}
FILE 文件 {url, name, size, mimeType}
LOCATION 位置 {lat, lng, address, title}
CUSTOM 自定义 任意 JSON
NOTIFY 系统通知 {title, content}
RICH_TEXT 富文本 {html}
CALL_AUDIO 语音通话信令 {action}
CALL_VIDEO 视频通话信令 {action}
QUOTE 引用 {quotedMsgId, quotedContent, text}
MERGE 合并转发 {title, msgList}
FORWARD 转发 {originalSender, originalContent}
REVOKED 撤回 系统内部填充

会话

会话Conversation是用户与单聊对象或群组的聊天关系抽象。

属性 说明
targetId 对方用户 ID 或群 ID
chatType SINGLE / GROUP
unreadCount 未读消息数
isPinned 是否置顶
isMuted 是否免打扰
lastMsgContent 最后一条消息内容
lastMsgTime 最后一条消息时间Unix 毫秒)

群组

属性 说明
id 群唯一 ID
name 群名称
creatorId 创建者用户 ID
memberIds 成员列表JSON 数组字符串)
adminIds 管理员列表JSON 数组字符串)
groupType 群类型:WORK / PUBLIC / PRIVATE
announcement 群公告

群角色

角色 说明
OWNER 群主
ADMIN 管理员
MEMBER 普通成员

消息状态

状态 说明
SENDING 发送中
SENT 已发送
DELIVERED 已送达
READ 已读
FAILED 发送失败
REVOKED 已撤回

→ 接入流程 →