- 实现了聊天消息发送功能,支持文本、图片、视频、音频、文件等多种消息类型 - 集成了文件上传下载功能,支持多媒体文件的传输和管理 - 添加了群组管理功能,包括创建群组、成员管理、权限控制等操作 - 实现了好友系统,支持好友添加、删除、分组等功能 - 集成了黑名单管理,提供用户屏蔽和解除屏蔽功能 - 添加了会话管理功能,支持对话列表、未读消息统计等 - 实现了历史消息查询和搜索功能 - 添加了实时连接状态管理和自动重连机制
2.2 KiB
2.2 KiB
接入流程
完整的 XuqmGroup SDK 接入流程,从注册账号到客户端收发消息。
1. 注册开发者账号
- 访问 XuqmGroup 控制台
- 点击注册,填写企业/个人信息
- 完成邮箱/手机验证
2. 创建应用
- 登录控制台 → 应用管理 → 创建应用
- 填写应用名称、平台类型(Android / iOS / Web / RN / 小程序 / HarmonyOS)
- 创建成功后获得:
appKey(客户端使用)
3. 获取 AppKey
在应用详情页复制 appKey,用于客户端 SDK 初始化:
// Android
XuqmSDK.initialize(context, appKey = "your_app_key")
// iOS
XuqmSDK.shared.initialize(config: config)
// Vue3 / Web
4. 服务端签发 UserSig
签发逻辑(示例)
// Node.js
import jwt from 'jsonwebtoken'
return jwt.sign(
{ userId, appKey },
{ algorithm: 'HS256' }
)
}
# Python
import jwt
def generate_user_sig(user_id: str, app_key: str, app_secret: str) -> str:
return jwt.encode(
{"userId": user_id, "appKey": app_key},
app_secret,
algorithm="HS256"
)
// Go
import "github.com/golang-jwt/jwt/v5"
token := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
"userId": userID,
"appKey": appKey,
})
}
接口设计建议
POST /api/auth/xuqm-login
Headers: Authorization: Bearer {your-app-auth-token}
Body: { "userId": "user_001" }
Response: { "userSig": "jwt_token_string" }
5. 客户端接入 SDK
登录流程
客户端
→ 业务登录(用户名/密码)
→ 业务服务端验证成功
→ 返回 userSig 给客户端
→ 客户端调用 XuqmSDK.login(userId, userSig)
→ 开始收发消息
各平台接入
| 平台 | 文档 |
|---|---|
| Android | Android SDK → |
| iOS | iOS SDK → |
| React Native | RN SDK → |
| Vue3 / Web | Vue3 SDK → |
| HarmonyOS | HarmonyOS SDK → |
| 微信小程序 | 小程序 SDK → |
安全提示
- 所有 API 通信使用 HTTPS
- UserSig 当前版本不过期,业务方可自行控制签发逻辑