Skip to content

Commit

Permalink
modify
Browse files Browse the repository at this point in the history
  • Loading branch information
haoxiuwen committed Dec 6, 2023
1 parent e162214 commit 3921035
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 34 deletions.
32 changes: 32 additions & 0 deletions docs/document/server-side/callback_configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2139,6 +2139,38 @@ payload 示例:
}
```

#### 拉黑好友

payload 字段含义:

| 字段 | 数据类型 | 含义 |
| :----------- | :------- | :--------------------- |
| `operation` | String | `ban`:拉黑好友。 |
| `status` | object | 包含 `error_code`|
| `error_code` | String | 操作失败对应的错误码。 |

payload 示例:

```json
{
"chat_type":"roster",
"callId":"XXXX#XXXX_966725184268539960",
"security":"00f070116668034ddecf3fb7db92087c",
"payload":{
"operation":"ban",
"status":{
"error_code":"ok"
}
},
"host":"XXXX",
"appkey":"XXXX#XXXX",
"from":"XXXX#XXXX",
"to":"tst",
"eventType":"chat",
"msg_id":"9XXXX0",
"timestamp":1642648046912
}
```


#### 解除拉黑好友
Expand Down
37 changes: 3 additions & 34 deletions docs/document/server-side/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -1057,7 +1057,6 @@ POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/share_files
| `Accept` | String || 内容类型。请填 `application/json`|
| `Authorization` | String || App 管理员的鉴权 token,格式为 `Bearer YourAppToken`,其中 `Bearer` 为固定字符,后面为英文空格和获取到的 app token。 |
| `Content-Type` | String || 内容类型。请填 `multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW`|
| `restrict-access` | Bool || 是否仅群成员可见。<br/> - `true`:是。<br/> - `false`:否。 |
| `file` | String || 待上传文件的本地路径。 |

#### HTTP 响应
Expand Down Expand Up @@ -1086,7 +1085,7 @@ POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/share_files
```shell
# 将 <YourAppToken> 替换为你在服务端生成的 App Token

curl -X POST 'https://XXXX/XXXX/XXXX/chatgroups/66021836783617/share_files' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -H 'Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' -H 'restrict-access: true' -F file=@/Users/test/image/IMG_3.JPG
curl -X POST 'https://XXXX/XXXX/XXXX/chatgroups/66021836783617/share_files' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -H 'Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' -F file=@/Users/test/image/IMG_3.JPG
```

##### 响应示例
Expand Down Expand Up @@ -1138,18 +1137,7 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/share_files/{file

##### 响应 body

如果返回的 HTTP 状态码为 `200`,表示请求成功,响应包体中包含以下字段:

| 字段 | 类型 | 描述 |
| :--------------- | :----- | :--------------------------------------------------------- |
| `data.file_url` | String | 群组共享文件的 URL,在环信即时通讯 IM 服务器上保存的地址。 |
| `data.group_id` | String | 群组 ID。 |
| `data.file_name` | String | 群组共享文件的名称。 |
| `data.created` | Long | 上传群组共享文件的时间。 |
| `data.file_id` | String | 群组共享文件 ID。该参数在删除共享文件时需要提供。 |
| `data.file_size` | Long | 群组共享文件大小,单位为字节。 |

其他字段及描述详见 [公共参数](#公共参数)
如果返回的 HTTP 状态码为 `200`,表示请求成功,响应体中为上传的文件的内容,例如,上传的文件内容为“Hello world”,响应中返回“Hello world”。

如果返回的 HTTP 状态码非 `200`,表示请求失败。你可以参考 [响应状态码](error.html) 了解可能的原因。

Expand All @@ -1165,26 +1153,7 @@ curl -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H

##### 响应示例

```json
{
"action": "post",
"application": "7fXXXXef",
"uri": "https://XXXX/XXXX/XXXX/chatgroups/6XXXX7/share_files",
"entities": [],
"data": {
"file_url": "https://XXXX/XXXX/XXXX/chatgroups/6XXXX7/share_files/c6XXXXc0",
"group_id": "6XXXX7",
"file_name": "img_3.jpg",
"created": 1599050554954,
"file_id": "c6XXXXc0",
"file_size": 13512
},
"timestamp": 1599050554978,
"duration": 0,
"organization": "XXXX",
"applicationName": "testapp"
}
```
返回上传的文件的内容。例如,上传的文件内容为“Hello world”,响应中返回“Hello world”。

### 删除群组共享文件

Expand Down

0 comments on commit 3921035

Please sign in to comment.