Skip to content

Commit 67d2cbc

Browse files
skiffer-gitskiffer-git
authored
Merge pull request #163 from icey-yu/feat-server
feat: fix doc
2 parents ea9cf25 + a94a681 commit 67d2cbc

24 files changed

+407
-399
lines changed

‎docs/restapi/webhooks/group/applyJoinGroupBefore.mdx‎

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,28 +31,29 @@ http://www.example.com/callbackBeforeApplyMemberJoinGroupCommand?contenttype=jso
3131

3232
### 请求参数说明
3333

34-
| 参数 | 说明 |
35-
|-----------------|-----------------------------------------------|
36-
| http | 请求协议为 HTTP，请求方式为 POST |
37-
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
38-
| CallbackCommand | 此处为：callbackBeforeApplyMemberJoinGroupCommand |
39-
| contenttype | 固定值为：JSON |
34+
| 参数 | 说明 |
35+
| --------------- | ------------------------------------------------- |
36+
| http | 请求协议为 HTTP，请求方式为 POST |
37+
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
38+
| CallbackCommand | 此处为：`callbackBeforeJoinGroupCommand` |
39+
| contenttype | 固定值为：JSON |
4040

4141
### Header
42+
4243
| header名 | 示例值 | 选填 | 类型 | 说明 |
4344
|:------------|:-------|:----|--------|---------------------|
4445
| operationID | 123456 | 必填 | string | operationID用于全局链路追踪 |
4546

4647
### 请求包示例
4748
```json
4849
{
49-
"callbackCommand": "CallbackBeforeApplyMemberJoinGroupCommand",
50+
"callbackCommand": "callbackBeforeJoinGroupCommand",
5051
"groupID": "12345",
51-
"userID": "user789",
52-
"ex": "Extra data",
53-
"groupEx": "GroupExtra data"
52+
"groupType": 2,
53+
"applyID": "user789",
54+
"reqMessage": "hello",
55+
"ex": "Extra data"
5456
}
55-
5657
```
5758

5859

@@ -61,11 +62,11 @@ http://www.example.com/callbackBeforeApplyMemberJoinGroupCommand?contenttype=jso
6162
| 对象 | 类型 | 描述 |
6263
|-----------------|--------|-----------------------|
6364
| callbackCommand | string | 回调命令，这里是新成员申请进群之前的回调。 |
64-
| operationID | string | 唯一操作ID |
65-
| userID | string | 加入群组的用户ID。 |
66-
| groupID | string | 群组的唯一标识符。 |
65+
| groupID | string | 群组的唯一标识符。 |
66+
| groupType | int | 群类型，固定为2。 |
67+
| applyID | string | 申请加入群组的用户ID。 |
68+
| reqMessage | string | 申请信息 |
6769
| ex | string | 额外的数据字段。 |
68-
| groupEx | string | 群组额外的数据字段。 |
6970

7071

7172

@@ -79,9 +80,7 @@ http://www.example.com/callbackBeforeApplyMemberJoinGroupCommand?contenttype=jso
7980
"errCode": 0,
8081
"errMsg": "Success",
8182
"errDlt": "",
82-
"nextCode": 0,
83-
"roleLevel": 1,
84-
"ex": "Some extra data"
83+
"nextCode": 0
8584
}
8685

8786
```
@@ -95,7 +94,4 @@ http://www.example.com/callbackBeforeApplyMemberJoinGroupCommand?contenttype=jso
9594
| errMsg | "An error message" | 自定义错误码对应的简单错误信息。|
9695
| errDlt | "Detailed error information" | 自定义错误码对应的详细错误信息。|
9796
| nextCode | 1 | 下一步执行指令，actionCode等于`0`时设置，`1`表示拒绝继续执行。|
98-
| roleLevel | int32 | 加入群组用户的权限级别。|
99-
| ex | string | 额外的数据或信息。 |
100-
10197

‎docs/restapi/webhooks/group/createAfter.mdx‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ http://www.example.com/callbackAfterCreateGroupCommand?contenttype=json
3131

3232
### 请求参数说明
3333

34-
| 参数 | 说明 |
35-
|-----------------|-----------------------------------------------|
36-
| http | 请求协议为 HTTP，请求方式为 POST |
37-
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
38-
| CallbackCommand | 此处为：callbackAfterCreateGroupCommand |
39-
| contenttype | 固定值为：JSON |
34+
| 参数 | 说明 |
35+
| --------------- | ------------------------------------------------- |
36+
| http | 请求协议为 HTTP，请求方式为 POST |
37+
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
38+
| CallbackCommand | 此处为：`callbackAfterCreateGroupCommand` |
39+
| contenttype | 固定值为：JSON |
4040

4141
### Header
4242
| header名 | 示例值 | 选填 | 类型 | 说明 |
@@ -122,8 +122,6 @@ App 后台同步数据后，发送回调应答包。
122122

123123
```
124124

125-
126-
127125
## 应答包字段说明
128126

129127
| 字段 | 值 | 说明 |
@@ -134,4 +132,3 @@ App 后台同步数据后，发送回调应答包。
134132
| errDlt | "Detailed error information" | 自定义错误码对应的详细错误信息。|
135133
| nextCode | 1 | 下一步执行指令，`1`表示拒绝继续执行，actionCode等于`0`时设置。|
136134

137-

‎docs/restapi/webhooks/group/createBefore.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,15 @@ http://www.example.com/callbackBeforeCreateGroupCommand?contenttype=json
3131

3232
### 请求参数说明
3333

34-
| 参数 | 说明 |
35-
|-----------------|-----------------------------------------------|
36-
| http | 请求协议为 HTTP，请求方式为 POST |
37-
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
38-
| CallbackCommand | 此处为：callbackBeforeCreateGroupCommand |
39-
| contenttype | 固定值为：JSON |
34+
| 参数 | 说明 |
35+
| --------------- | ------------------------------------------------- |
36+
| http | 请求协议为 HTTP，请求方式为 POST |
37+
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
38+
| CallbackCommand | 此处为：`callbackBeforeCreateGroupCommand` |
39+
| contenttype | 固定值为：JSON |
4040

4141
### Header
42+
4243
| header名 | 示例值 | 选填 | 类型 | 说明 |
4344
|:------------|:--------------|:----|--------|---------------------|
4445
| operationID | 1646445464564 | 必填 | string | operationID用于全局链路追踪 |
@@ -163,4 +164,3 @@ http://www.example.com/callbackBeforeCreateGroupCommand?contenttype=json
163164

164165

165166

166-

‎docs/restapi/webhooks/group/disMissGroupAfter.mdx‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ http://www.example.com/callbackAfterUngroupCommand?contenttype=json
3232

3333
### 请求参数说明
3434

35-
| 参数 | 说明 |
36-
|-----------------|-----------------------------------------------|
37-
| http | 请求协议为 HTTP，请求方式为 POST |
38-
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
39-
| CallbackCommand | 此处为：callbackAfterUngroupCommand |
40-
| contenttype | 固定值为：JSON |
35+
| 参数 | 说明 |
36+
| --------------- | ------------------------------------------------- |
37+
| http | 请求协议为 HTTP，请求方式为 POST |
38+
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
39+
| CallbackCommand | 此处为：callbackAfterDisMissGroupCommand |
40+
| contenttype | 固定值为：JSON |
4141

4242
### Header
4343
| header名 | 示例值 | 选填 | 类型 | 说明 |
@@ -47,11 +47,11 @@ http://www.example.com/callbackAfterUngroupCommand?contenttype=json
4747
### 请求包示例
4848
```json
4949
{
50-
"callbackCommand": "callbackAfterUngroupCommand",
50+
"callbackCommand": "callbackAfterDisMissGroupCommand",
5151
"groupID": "G001",
52-
"groupType": 1,
52+
"groupType": 2,
5353
"ownerID": "user123",
54-
"memberList": ["user456", "user789"]
54+
"membersID": ["user456", "user789"]
5555
}
5656

5757
```
@@ -67,8 +67,7 @@ http://www.example.com/callbackAfterUngroupCommand?contenttype=json
6767
| groupID | string | 群组的唯一标识符 |
6868
| groupType | int32 | 群组的类型 |
6969
| ownerID | string | 群主ID |
70-
| memberList | array | 群组成员的列表，包括用户ID，表示解散时群组中的成员 |
71-
| muteEndTime | int64 | 群组中成员的禁言截止时间戳（毫秒），如果未被禁言则为空 |
70+
| membersID | array | 群组成员的列表，包括用户ID，表示解散时群组中的成员 |
7271

7372

7473
## 应答包示例

‎docs/restapi/webhooks/group/groupMsgRead.mdx‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ http://www.example.com/callbackGroupMsgReadCommand?contenttype=json
2929

3030
### 请求参数说明
3131

32-
| 参数 | 说明 |
33-
|-----------------|-----------------------------------------------|
34-
| http | 请求协议为 HTTP，请求方式为 POST |
35-
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
36-
| CallbackCommand | 此处为：callbackGroupMsgReadCommand |
37-
| contenttype | 固定值为：JSON |
32+
| 参数 | 说明 |
33+
| --------------- | ------------------------------------------------- |
34+
| http | 请求协议为 HTTP，请求方式为 POST |
35+
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
36+
| CallbackCommand | 此处为：`callbackAfterGroupMsgReadCommand` |
37+
| contenttype | 固定值为：JSON |
3838

3939
### Header
4040
| header名 | 示例值 | 选填 | 类型 | 说明 |
@@ -47,7 +47,8 @@ http://www.example.com/callbackGroupMsgReadCommand?contenttype=json
4747
"callbackCommand": "callbackGroupMsgReadCommand",
4848
"sendID": "user123",
4949
"receiveID": "group789",
50-
"unreadMsgNum": 5
50+
"unreadMsgNum": 5,
51+
"contentType": 101,
5152
}
5253
```
5354

@@ -59,6 +60,7 @@ http://www.example.com/callbackGroupMsgReadCommand?contenttype=json
5960
| sendID | string | 发送消息的用户ID |
6061
| receiveID | string | 接收消息的群组ID |
6162
| unreadMsgNum | int64 | 未读消息数量 |
63+
| contentType | int | 消息类型 |
6264

6365

6466
## 应答包示例
@@ -84,4 +86,3 @@ http://www.example.com/callbackGroupMsgReadCommand?contenttype=json
8486
| errDlt | "Detailed error information" | 自定义错误码对应的详细错误信息。|
8587
| nextCode | 1 | 下一步执行指令，`1`表示拒绝继续执行，actionCode等于`0`时设置。|
8688

87-

‎docs/restapi/webhooks/group/inviteJoinGroupBefore.mdx‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,26 +32,28 @@ http://www.example.com/CallbackBeforeInviteMemberJoinGroupCommand?contenttype=js
3232

3333
### 请求参数说明
3434

35-
| 参数 | 说明 |
36-
|-----------------|-----------------------------------------------|
37-
| http | 请求协议为 HTTP，请求方式为 POST |
38-
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
39-
| CallbackCommand | 此处为：CallbackBeforeInviteMemberJoinGroupCommand |
40-
| contenttype | 固定值为：JSON |
35+
| 参数 | 说明 |
36+
| --------------- | ------------------------------------------------- |
37+
| http | 请求协议为 HTTP，请求方式为 POST |
38+
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
39+
| CallbackCommand | 此处为：callbackBeforeInviteJoinGroupCommand` |
40+
| contenttype | 固定值为：JSON |
4141

4242
### Header
4343
| header名 | 示例值 | 选填 | 类型 | 说明 |
4444
|:------------|:--------------|:----|--------|---------------------|
4545
| operationID | 1646445464564 | 必填 | string | operationID用于全局链路追踪 |
4646

4747
### 请求包示例
48+
4849
```json
4950
{
50-
"callbackCommand": "CallbackBeforeInviteMemberJoinGroupCommand",
51+
"callbackCommand": "callbackBeforeInviteJoinGroupCommand",
52+
"operationID": "1646445464564",
5153
"groupID": "12345",
54+
"reason": "friend",
5255
"invitedUserIDs": "[user1,user2]"
5356
}
54-
5557
```
5658

5759

@@ -60,7 +62,9 @@ http://www.example.com/CallbackBeforeInviteMemberJoinGroupCommand?contenttype=js
6062
| 对象 | 类型 | 描述 |
6163
|-------------------------|--------|----------------------------------------------------------------|
6264
| callbackCommand | string | 回调命令，这里是邀请好友加入群组之前的回调。 |
65+
| operationID | string | operationID用于全局链路追踪 |
6366
| groupID | string | 群组的唯一标识符。 |
67+
| reason | string | 邀请理由 |
6468
| invitedUserIDs | string[] | 加入群组的用户ID。 |
6569

6670
## 应答包示例

‎docs/restapi/webhooks/group/joinGroupAfter.mdx‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,24 @@ http://www.example.com/CallbackAfterMemberJoinGroupCommand?contenttype=json
3535

3636
### 请求参数说明
3737

38-
| 参数 | 说明 |
39-
|-----------------|-----------------------------------------------|
40-
| http | 请求协议为 HTTP，请求方式为 POST |
41-
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
42-
| CallbackCommand | 此处为：CallbackAfterMemberJoinGroupCommand |
43-
| contenttype | 固定值为：JSON |
38+
| 参数 | 说明 |
39+
| --------------- | ------------------------------------------------- |
40+
| http | 请求协议为 HTTP，请求方式为 POST |
41+
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
42+
| CallbackCommand | 此处为：`callbackAfterJoinGroupCommand` |
43+
| contenttype | 固定值为：JSON |
4444

4545
### Header
4646
| header名 | 示例值 | 选填 | 类型 | 说明 |
4747
|:------------|:--------------|:----|--------|---------------------|
4848
| operationID | 1646445464564 | 必填 | string | operationID用于全局链路追踪 |
4949

5050
### 请求包示例
51+
5152
```json
5253
{
53-
"callbackCommand": "CallbackAfterMemberJoinGroupCommand",
54+
"callbackCommand": "callbackAfterJoinGroupCommand",
55+
"operationID": "1646445464564",
5456
"groupID": "12345",
5557
"userID": "user789",
5658
"ex": "Extra data",
@@ -65,6 +67,7 @@ http://www.example.com/CallbackAfterMemberJoinGroupCommand?contenttype=json
6567
| 对象 | 类型 | 描述 |
6668
|-------------------------|--------|----------------------------------------------------------------|
6769
| callbackCommand | string | 回调命令，这里是创建群组之前的回调。 |
70+
| operationID | string | operationID用于全局链路追踪 |
6871
| userID | string | 加入群组的用户ID。 |
6972
| groupID | string | 群组的唯一标识符。 |
7073
| ex | string | 额外的数据字段。 |
@@ -94,4 +97,3 @@ App 后台同步数据后，发送回调应答包
9497
| errDlt | "Detailed error information" | 自定义错误码对应的详细错误信息。|
9598
| nextCode | 1 | 下一步执行指令，`1`表示拒绝继续执行，actionCode等于`0`时设置。|
9699

97-

‎docs/restapi/webhooks/group/killGroupMember.mdx‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ http://www.example.com/kickGroupMemberCommand?contenttype=json
2929

3030
### 请求参数说明
3131

32-
| 参数 | 说明 |
33-
|-----------------|-----------------------------------------------|
34-
| http | 请求协议为 HTTP，请求方式为 POST |
35-
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
36-
| CallbackCommand | 此处为：kickGroupMemberCommand |
37-
| contenttype | 固定值为：JSON |
32+
| 参数 | 说明 |
33+
| --------------- | ------------------------------------------------- |
34+
| http | 请求协议为 HTTP，请求方式为 POST |
35+
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
36+
| CallbackCommand | 此处为：`callbackAfterKickGroupCommand` |
37+
| contenttype | 固定值为：JSON |
3838

3939
### Header
4040
| header名 | 示例值 | 选填 | 类型 | 说明 |
@@ -44,7 +44,7 @@ http://www.example.com/kickGroupMemberCommand?contenttype=json
4444
### 请求包示例
4545
```json
4646
{
47-
"callbackCommand": "kickGroupMemberCommand",
47+
"callbackCommand": "callbackAfterKickGroupCommand",
4848
"groupID": "G001",
4949
"kickedUserIDs": ["user123", "user456"],
5050
"reason": "Violation of group rules"
@@ -71,7 +71,7 @@ http://www.example.com/kickGroupMemberCommand?contenttype=json
7171
"errCode": 0,
7272
"errMsg": "Success",
7373
"errDlt": "",
74-
"nextCode": "nextCodeValue"
74+
"nextCode": 0
7575
}
7676
```
7777

@@ -85,4 +85,3 @@ http://www.example.com/kickGroupMemberCommand?contenttype=json
8585
| errDlt | "Detailed error information" | 自定义错误码对应的详细错误信息。|
8686
| nextCode | 1 | 下一步执行指令，`1`表示拒绝继续执行，actionCode等于`0`时设置。|
8787

88-

‎docs/restapi/webhooks/group/memberJoinGroupBefore.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ http://www.example.com/CallbackBeforeMembersJoinGroupCommand?contenttype=json
4343
| --------------- | ------------------------------------------------- |
4444
| http | 请求协议为 HTTP，请求方式为 POST |
4545
| www.example.com | configy.yaml 中的 callback.url 字段，域名或主机名 |
46-
| CallbackCommand | 此处为：CallbackBeforeMembersJoinGroupCommand |
46+
| CallbackCommand | 此处为：`callbackBeforeMembersJoinGroupCommand` |
4747
| contenttype | 固定值为：JSON |
4848

4949
### Header
@@ -56,7 +56,7 @@ http://www.example.com/CallbackBeforeMembersJoinGroupCommand?contenttype=json
5656

5757
```json
5858
{
59-
"callbackCommand": "CallbackBeforeMembersJoinGroupCommand",
59+
"callbackCommand": "callbackBeforeMembersJoinGroupCommand",
6060
"groupID": "12345",
6161
"memberList": [
6262
{

0 commit comments

Comments
 (0)