6 檔案操作介面#
6.1 下載頭像#
GET /file/download/avatar
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| h | double | false | 圖片高 |
| image_type | int32 | false | 圖片類型，1: 原圖，2: 縮略圖, 3: 封面圖 |
| object_name | string | true | 物件名 |
| sdk_sign | string | false | SDK的簽名 |
| store_token | string | false | 檔案token |
| thumbnail_strategy | int32 | false | 縮略圖生成策略, 1 - 第三方伺服器生成， 2 - 本地伺服器生成，預設值是 1 |
| w | double | false | 圖片寬 |
響應體#
● 200 響應資料格式：JSON
介面描述#
6.2 下載聊天檔案#
GET /file/download/chat
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| file_sign | string | true | 檔案簽名 |
| format | string | false | 需要下載的音訊檔案格式amr/mp3 預設為amr |
| h | double | false | 圖片高 |
| image_type | int32 | false | 圖片類型，1: 原圖，2: 縮略圖, 3: 封面圖 |
| sdk_sign | string | false | SDK的簽名 |
| source | string | false | 請求來源, miniprogram - 小程式，預設值是 '' |
| store_token | string | false | 檔案token |
| thumbnail_strategy | int32 | false | 縮略圖生成策略, 1 - 第三方伺服器生成， 2 - 本地伺服器生成，預設值是 1 |
| w | double | false | 圖片寬 |
響應體#
● 200 響應資料格式：JSON
介面描述#
6.3 取得上傳群頭像URL#
GET /file/upload/avatar/group
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| group_id | int64 | true | group_id |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ download_url | string | 下載地址 |
| ⇥ oss_body_param | object | 上傳時需要設定的OSS參數 |
| ⇥ upload_method | string | 上傳方式: POST/PUT |
| ⇥ upload_url | string | 上傳地址 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
6.4 取得上傳使用者頭像URL#
GET /file/upload/avatar/user
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ download_url | string | 下載地址 |
| ⇥ oss_body_param | object | 上傳時需要設定的OSS參數 |
| ⇥ upload_method | string | 上傳方式: POST/PUT |
| ⇥ upload_url | string | 上傳地址 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
6.5 取得上傳聊天檔案的URL#
GET /file/upload/chat
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| file_type | int32 | true | 檔案類型 100: 普通聊天檔案, 101: 語音聊天檔案(amr格式),102: 圖片聊天檔案, 103: 視訊聊天檔案, 104: 語音聊天檔案(mp3格式)200: 普通共享檔案, 201: 語音共享檔案, 202: 圖片共享檔案, 203: 視訊共享檔案 |
| to_id | int64 | true | to_id |
| to_type | int32 | false | 1: 使用者，2: 群組 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ download_url | string | 下載地址 |
| ⇥ oss_body_param | object | 上傳時需要設定的OSS參數 |
| ⇥ upload_method | string | 上傳方式: POST/PUT |
| ⇥ upload_url | string | 上傳地址 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
6.6 取得聊天檔案轉發的URL#
GET /file/upload/forward
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| file_sign | string | true | 檔案簽名 |
| to_id | int64 | true | to_id |
| to_type | int32 | false | 1: 使用者，2: 群組 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | string | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |