Skip to content

Commit 0ca7355

Browse files
authored
feat: server doc (#171)
1 parent 625fee4 commit 0ca7355

3 files changed

Lines changed: 4 additions & 6 deletions

File tree

docs/restapi/introduction.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ OpenIM Server 提供了 **REST API** 供业务系统使用,以增强业务功
1818
> 请求 URL 中的 `{API_ADDRESS}` 为 OpenIM Server 部署的主机地址,如 `http://IP:10002`
1919
>
2020
> 调用 **REST API** ,需要以 **APP 管理员** 身份进行,此服务由端口 `10002` 提供。所谓 **APP 管理员**,即有超级权限的用户。OpenIM Server 内置了一个 APP 管理员,它的 userID 为 imAdmin
21+
>
22+
> `API`请求参数中所有的`array`最大长度限制为`1000`
2123
2224
在开始调用 API 之前,需首先使用 secret [获取管理员 token](./apis/authenticationManagement/getToken)
2325
,对于 [导入用户](./apis/userManagement/userRegister) 接口,也需要使用 secret 验证。
@@ -28,3 +30,5 @@ OpenIM Server 还提供了强大的回调功能,以满足更多的业务需求
2830

2931
- 📤 发送消息前的回调
3032
- 📥 发送消息后的回调
33+
34+
>请求 URL 中的 `{WEBHOOK_ADDRESS}``webhook`部署的主机地址。

docs/restapi/webhooks/group/setGroupInfoAfter.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,6 @@ App 业务服务端可以通过该回调实时查看群资料的变更,包括
2828
http://{WEBHOOK_ADDRESS}/callbackAfterSetGroupInfoExCommand?contenttype=json
2929
```
3030

31-
### 请求参数说明
32-
33-
34-
### Header
35-
3631

3732
### 请求包示例
3833
```json

docs/restapi/webhooks/user/updateUserInfoAfter.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ http://{WEBHOOK_ADDRESS}/callbackAfterUpdateUserInfoExCommand?contenttype=json
3535

3636
### 请求参数说明
3737

38-
3938
### Header
4039

4140

0 commit comments

Comments
 (0)