File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11---
22sidebar_position : 1
3- title : 获取用户token
3+ title : 获取管理员token
44hide_title : true
55---
66
77<center >
88
9- ## 获取用户 token
9+ ## 获取管理员 token
1010
1111</center >
1212
1313### 简要描述
1414
15- - 获取用户或 APP 管理员 token。
15+ - 获取 APP 管理员 token。
1616
1717⚠️ ** 注意** : OpenIM Server 内置了一个 APP 管理员,它的 ` userID ` 是` imAdmin ` :
1818
Original file line number Diff line number Diff line change 11---
22sidebar_position : 2
3- title : 管理员获取用户token
3+ title : 获取用户token
44hide_title : true
55---
66
77<center >
88
9- ## 管理员获取用户 token
9+ ## 获取用户 token
1010
1111</center >
1212
1313### 简要描述
1414
15- - 管理员可以获取用户的 token。
15+ - 获取用户的 token。
1616
1717⚠️ ** 注意** : OpenIM Server 内置了一个 APP 管理员,它的 ` userID ` 是` imAdmin ` :
1818
Original file line number Diff line number Diff line change 11---
22sidebar_position : 4
3- title : 获取用户ID列表
3+ title : 获取已注册用户ID列表
44hide_title : true
55---
66
77<center >
88
9- ## 获取用户 ID 列表
9+ ## 获取已注册用户 ID 列表
1010
1111</center >
1212
Original file line number Diff line number Diff line change 11---
2- sidebar_position : 7
2+ sidebar_position : 6
33title : 获取指定用户在线状态
44hide_title : true
55---
Original file line number Diff line number Diff line change 11---
2- sidebar_position : 6
2+ sidebar_position : 7
33title : 获取指定用户在线状态详情
44hide_title : true
55---
Original file line number Diff line number Diff line change 11---
2- sidebar_position : 14
2+ sidebar_position : 11
33title : 修改用户的在线状态订阅关系
44hide_title : true
55---
Original file line number Diff line number Diff line change @@ -19,16 +19,18 @@ OpenIM Server 提供了 **REST API** 供业务系统使用,以增强业务功
1919>
2020> 调用 ** REST API** ,需要以 ** APP 管理员** 身份进行,此服务由端口 ` 10002 ` 提供。所谓 ** APP 管理员** ,即有超级权限的用户。OpenIM Server 内置了一个 APP 管理员,它的 userID 为 imAdmin
2121>
22+ > API 鉴权流程:
23+ >
24+ > 1 . 通过 [ ` user_token API ` ] ( ./apis/authenticationManagement/getToken ) 获取管理员 token
25+ > 2 . 使用管理员 token 调用其他 API
26+ >
2227> ` API ` 请求参数中所有的` array ` 最大长度限制为` 1000 ` 。
2328
24- 在开始调用 API 之前,需首先使用 secret [ 获取管理员 token] ( ./apis/authenticationManagement/getToken )
25- ,对于 [ 导入用户] ( ./apis/userManagement/userRegister ) 接口,也需要使用 secret 验证。
26-
2729## 🔗 Webhooks
2830
2931OpenIM Server 还提供了强大的回调功能,以满足更多的业务需求。** 回调** 的定义是,当某事件发生前或后,OpenIM Server 会向业务服务器发出请求。如:
3032
3133- 📤 发送消息前的回调
3234- 📥 发送消息后的回调
3335
34- > 请求 URL 中的 ` {WEBHOOK_ADDRESS} ` 为` webhook ` 部署的主机地址。
36+ > 请求 URL 中的 ` {WEBHOOK_ADDRESS} ` 为 ` webhook ` 部署的主机地址。
You can’t perform that action at this time.
0 commit comments