Skip to content

Commit

Permalink
feat: doc (#192)
Browse files Browse the repository at this point in the history
  • Loading branch information
@icey-yu
icey-yu authored Sep 29, 2024
1 parent 01ddb57 commit ba6232c
Show file tree
Hide file tree
Showing 56 changed files with 764 additions and 53 deletions.
Binary file added docs/guides/assets/br-cpu.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/assets/br-login.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/assets/br-mem.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/assets/br-msg.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
361 changes: 361 additions & 0 deletions docs/guides/benchmark_test.mdx
View file

Large diffs are not rendered by default.

7 changes: 5 additions & 2 deletions docs/guides/gettingStarted/dockerCompose.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ git clone https://github.com/openimsdk/openim-docker
GRAFANA_URL="http://external_ip:13000/"
```

- 配置格式说明：

例如修改`openim-server`的配置文件`openim-api.yml`中的`prometheus.grafanaURL`字段，则应添加的环境变量为：`- IMENV_OPENIM_API_PROMETHEUS_GRAFANAURL=${GRAFANA_URL}`。`IMENV`为`openim-server`配置的固定前缀，文件名和字段之间的分隔符全部为`_`，并且全部改为大写。

- 其他配置请参考 .env 中的注释

## 服务启动 🚀
Expand Down Expand Up @@ -152,7 +156,7 @@ docker compose logs -f openim-server
1. 修改 `.env` 文件：更新 **`.env`** 文件中的相关配置项。
2. 手动更新配置文件：根据 **`.env`** 文件的修改，相应地更新 **`openim-server/config/config.yaml`** 和 **`openim-chat/config/config.yaml`** 文件中的配置项。
3. 特殊变量的额外处理：如果修改了 **`OPENIM_IP`**、**`API_OPENIM_PORT`**、**`MINIO_PORT`**、**`GRAFANA_PORT`**，则需要在 **`openim-server/config/config.yaml`** 中更新以下配置项：

```yaml
object:
apiURL: "http://$OPENIM_IP:$API_OPENIM_PORT"
Expand Down Expand Up @@ -210,4 +214,3 @@ grep "127.0.0.1" openim-server/_output/logs/openim-docker.log
- 运行时日志：`{openim-server, openim-chat}/_output/logs/openim-all.*`
- 启动时日志：`{openim-server, openim-chat}/_output/logs/openim-docker.log`


2 changes: 1 addition & 1 deletion docs/restapi/apis/groupManagement/createGroup.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ hide_title: true
|groupInfo.introduction|选填|string|群介绍|
|groupInfo.faceURL|选填|string|群头像地址|
|groupInfo.ex|选填|string|群扩展字段|
|groupInfo.groupType|必填|int|群状态|
|groupInfo.groupType|必填|int|群类型，固定为2。|
|groupInfo.needVerification|选填|int|进群是否需要验证|
|groupInfo.lookMemberInfo|选填|int|能否查看其他群成员信息|
|groupInfo.applyMemberFriend|选填|int|群成员是否允许添加好友|
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/commonFields.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: 常用结构体说明
| 字段名 | 类型 | 字符串长度限制 | 说明 | 取值说明 |
| -------------- | ------ | -------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| secret | string | 32 | OpenIM 秘钥，服务端 config/share.yml 的 secret 字段 | 字符串 |
| platformID | int | | 用户登录时的终端类型 | iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6，linux 7, AndroidPad 8, IPad 9, Admin 10 |
| platformID | int | | 用户登录时的终端类型 | 1：iOS，2：Android，3：Windows，4：OSX，5：WEB，6：小程序，7：linux，8：AndroidPad，9：IPad，10：Admin|
| userID | string | 64 | 用户 ID，保证 IM 内唯一 | 字符串 |
| nickname | string | 255 | 昵称 | 字符串 |
| faceURL | string | 255 | 头像URL | URL 链接 |
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/applyJoinGroupBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ App 业务服务端可以通过该回调实时查看用户申请加入群组的
此处`CallbackCommand`为：`callbackBeforeJoinGroupCommand`

```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeJoinGroupCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeJoinGroupCommand?contenttype=json
```

### 请求包示例
Expand Down
4 changes: 2 additions & 2 deletions docs/restapi/webhooks/group/createAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ App 业务服务端可以通过该回调实时查看用户创建群组的信息
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterCreateGroupCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterCreateGroupCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterCreateGroupCommand?contenttype=json
```

### 请求包示例
Expand Down Expand Up @@ -83,7 +83,7 @@ http://{WEBHOOK_ADDRESS}/callbackAfterCreateGroupCommand?contenttype=json
| ex | string | 额外的数据字段 |
| status | int32 | 群组的状态 |
| creatorUserID | string | 群组的创建者的用户ID |
| groupType | int32 | 群组的类型 |
| groupType | int32 | 群类型，固定为2。 |
| needVerification | int32 | 是否需要验证加入群组 |
| lookMemberInfo | int32 | 是否可以查看群成员信息 |
| applyMemberFriend | int32 | 是否可以申请加群成员为好友 |
Expand Down
6 changes: 3 additions & 3 deletions docs/restapi/webhooks/group/createBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ App 业务服务端可以通过该回调获取用户创建群组的请求，同
### 请求 URL 示例
此处`CallbackCommand`为：`callbackBeforeCreateGroupCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeCreateGroupCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeCreateGroupCommand?contenttype=json
```

### 请求包示例
Expand Down Expand Up @@ -83,7 +83,7 @@ http://{WEBHOOK_ADDRESS}/callbackBeforeCreateGroupCommand?contenttype=json
| ex | string | 额外的数据字段 |
| status | int32 | 群组的状态 |
| creatorUserID | string | 群组的创建者的用户ID |
| groupType | int32 | 群组的类型 |
| groupType | int32 | 群类型，固定为2。 |
| needVerification | int32 | 是否需要验证加入群组 |
| lookMemberInfo | int32 | 是否可以查看群成员信息 |
| applyMemberFriend | int32 | 是否可以申请加群成员为好友 |
Expand Down Expand Up @@ -142,7 +142,7 @@ http://{WEBHOOK_ADDRESS}/callbackBeforeCreateGroupCommand?contenttype=json
| ex | string | 额外的数据或信息。 |
| status | int32 | 群组的状态。 |
| creatorUserID | string | 创建群组的用户ID。 |
| groupType | int32 | 群组的类型。 |
| groupType | int32 | 群类型，固定为2。 |
| needVerification | int32 | 是否需要验证才能加入群组。 |
| lookMemberInfo | int32 | 是否可以查看群组成员信息。 |
| applyMemberFriend | int32 | 是否可以申请成为群组成员的好友。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/restapi/webhooks/group/disMissGroupAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ App 业务服务端可以通过该回调获取群组解散的信息，包括：
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterDisMissGroupCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterDisMissGroupCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterDisMissGroupCommand?contenttype=json
```

### 请求包示例
Expand All @@ -50,7 +50,7 @@ http://{WEBHOOK_ADDRESS}/callbackAfterDisMissGroupCommand?contenttype=json
|-------------------------|--------|----------------------------------------------------------------|
| callbackCommand | string | 回调命令，这里是群组解散后的回调 |
| groupID | string | 群组的唯一标识符 |
| groupType | int32 | 群组的类型 |
| groupType | int32 | 群类型，固定为2。 |
| ownerID | string | 群主ID |
| membersID | array | 群组成员的列表，包括用户ID，表示解散时群组中的成员 |

Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/groupMsgRead.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ App 业务服务端可以通过该回调实时查看用户的单聊消息的已
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterGroupMsgReadCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterGroupMsgReadCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterGroupMsgReadCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/inviteJoinGroupBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ App 业务服务端可以通过该回调实时查看群成员拉其他用户加
### 请求 URL 示例
此处`CallbackCommand`为：`callbackBeforeInviteJoinGroupCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeInviteJoinGroupCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeInviteJoinGroupCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/joinGroupAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ App 业务服务端可以通过该回调实时查看群成员加入的消息，
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterJoinGroupCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterJoinGroupCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterJoinGroupCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/killGroupMember.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ App 业务服务端可以通过该回调处理群组管理员踢出成员的请
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterKickGroupCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterKickGroupCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterKickGroupCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/memberJoinGroupBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ App 业务服务端可以通过该回调实时查看群成员进群的信息,

此处`CallbackCommand`为：`callbackBeforeMembersJoinGroupCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeMembersJoinGroupCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeMembersJoinGroupCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/quitGroup.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ App 业务服务端可以通过该回调查看用户退出群组的请求，App
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterQuitGroupCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterQuitGroupCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterQuitGroupCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/sendGroupMsgAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ App 业务服务端可以通过该回调实时查看用户的群发消息，包
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterSendGroupMsgCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterSendGroupMsgCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterSendGroupMsgCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/sendGroupMsgBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ App 后台可以通过该回调实时查看用户的群发消息，包括：
### 请求 URL 示例
此处`CallbackCommand`为：`callbackBeforeSendGroupMsgCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeSendGroupMsgCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeSendGroupMsgCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/setGroupInfoAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ App 业务服务端可以通过该回调实时查看群资料的变更，包括
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterSetGroupInfoExCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterSetGroupInfoExCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterSetGroupInfoExCommand?contenttype=json
```


Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/setGroupInfoBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ App 业务服务端可以通过该回调在设置群组信息之前进行干预
### 请求 URL 示例
此处`CallbackCommand`为：`callbackBeforeSetGroupInfoExCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeSetGroupInfoExCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeSetGroupInfoExCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/setMemberInfoAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ App 业务服务端可以通过该回调获取设置群成员信息的请求，A
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterSetGroupMemberInfoCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterSetGroupMemberInfoCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterSetGroupMemberInfoCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/setMemberInfoBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ App 业务服务端可以通过该回调查看修改后的群成员信息，。
### 请求 URL 示例
此处`CallbackCommand`为：`callbackBeforeSetGroupMemberInfoCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeSetGroupMemberInfoCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeSetGroupMemberInfoCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/group/transferGroupOwnerAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ App 业务服务端可以通过该回调获取群组所有权转移的信息，
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterTransferGroupOwnerCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterTransferGroupOwnerCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterTransferGroupOwnerCommand?contenttype=json
```

### 请求包示例
Expand Down
5 changes: 2 additions & 3 deletions docs/restapi/webhooks/introduction.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ hide_title: true

```yaml
callback:
url:
url: http://127.0.0.1:10006/callbackExample
beforeCreateGroup:
enable: true
timeout: 5
Expand All @@ -40,14 +40,13 @@ callback:
### 请求 URL 示例

```plaintext
http://{WEBHOOK_ADDRESS}/callbackCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackCommand?contenttype=json
```

### 请求参数说明

| 参数 | 说明 |
| ----------------- | ---------------------------------------- |
| http | 请求协议为 HTTP，请求方式为 POST |
| {WEBHOOK_ADDRESS} | webhooks.yml 中的 url 字段，域名或主机名 |
| callbackCommand | 回调命令，可在各个回调方法说明中具体查看 |
| contenttype | 请求入参，为`json`类型 |
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/msg/msgModify.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ App 业务服务端可以通过该回调修改消息内容，如：不合规内
### 请求 URL 示例
此处`CallbackCommand`为：`callbackBeforeMsgModifyCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeMsgModifyCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeMsgModifyCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/msg/sendSingleMsgAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ App 业务服务端可以通过该回调实时对用户的单聊消息进行操
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterSendSingleMsgCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterSendSingleMsgCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterSendSingleMsgCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/msg/sendSingleMsgBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ App 业务服务端可以通过该回调实时对用户的单聊信息进行操
### 请求 URL 示例
此处`CallbackCommand`为：`callbackBeforeSendSingleMsgCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeSendSingleMsgCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeSendSingleMsgCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/msg/singleMsgRead.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ App 业务服务端可以通过该回调实时查看用户的单聊消息的已
### 请求 URL 示例
此处`CallbackCommand`为：`callbackAfterSingleMsgReadCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterSingleMsgReadCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterSingleMsgReadCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/msg/singleMsgRevokeAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ App 业务服务端可以通过该回调获取用户撤回单聊消息的请求
### 请求 URL 示例
此处`CallbackCommand`为：`callbackBeforeAfterMsgCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeAfterMsgCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeAfterMsgCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/push/offlinePushBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ hide_title: true

此处`CallbackCommand`为：`callbackBeforeOfflinePushCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeOfflinePushCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeOfflinePushCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/push/onlinePushBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ hide_title: true

此处`CallbackCommand`为：`callbackBeforeOnlinePushCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeOnlinePushCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeOnlinePushCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/relationship/addBlack.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ App 业务服务端可以通过该回调获取用户添加黑名单的请求，

此处`CallbackCommand`为：`callbackBeforeAddBlackCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeAddBlackCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeAddBlackCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/relationship/addFriendAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ App 后台可以通过该回调实时查看用户的新增好友信息。

此处`CallbackCommand`为：`callbackAfterAddFriendCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterAddFriendCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterAddFriendCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/relationship/addFriendAgreeAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ App 后台可以通过该回调实时查看用户的新增好友信息。

此处`CallbackCommand`为：`callbackAfterAddFriendCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterAddFriendCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterAddFriendCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/relationship/addFriendAgreeBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ App 后台可以通过该回调实时查看用户的加好友回应请求，包
### 请求 URL 示例
此处`CallbackCommand`为：`callbackBeforeAddFriendAgreeCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeAddFriendAgreeCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeAddFriendAgreeCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/relationship/addFriendBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ App 业务服务端可以通过该回调获取用户发送的添加好友请求

此处`CallbackCommand`为：`callbackBeforeAddFriendCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeAddFriendCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeAddFriendCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/relationship/deleteFriendAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ App 业务服务端可以通过该回调实时查看用户的好友删除信息

此处`CallbackCommand`为：`callbackAfterDeleteFriendCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterDeleteFriendCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterDeleteFriendCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/relationship/importFriendAfter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ App 业务服务端可以通过该回调获取用户导入好友的请求，同

此处`CallbackCommand`为：`callbackBeforeImportFriendsCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackBeforeImportFriendsCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackBeforeImportFriendsCommand?contenttype=json
```

### 请求包示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/webhooks/relationship/importFriendsBefore.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ App 业务服务端可以通过该回调获取用户导入好友的请求，同

此处`CallbackCommand`为：`callbackAfterImportFriendsCommand`
```plaintext
http://{WEBHOOK_ADDRESS}/callbackAfterImportFriendsCommand?contenttype=json
{WEBHOOK_ADDRESS}/callbackAfterImportFriendsCommand?contenttype=json
```

### 请求包示例
Expand Down
Loading

0 comments on commit ba6232c

Please sign in to comment.