import{_ as p}from"./plugin-vue_export-helper-c27b6911.js";import{r as o,o as c,c as h,a as t,d as a,b as s,w as e,e as r}from"./app-e0095480.js";const u={},b={class:"hint-container warning"},k=t("p",{class:"hint-container-title"},"注意",-1),f=r('

上传私聊文件

该接口用于上传私聊文件。

注意

只能上传本地文件, 需要上传 http 文件的话请先下载至本地

API 端点

/upload_private_file

参数

字段类型说明
user_idint64目标
filestring本地文件路径 或 文件base64 或 文件url
namestring文件名称

注意

本地文件路径为绝对路径，文件base64为base64://开头，文件url则应该是正确的http请求地址。

响应

',9),_=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"字段"),t("th",null,"类型"),t("th",null,"说明")])]),t("tbody",null,[t("tr",null,[t("td",null,"msg_id"),t("td",null,"int32"),t("td",null,"消息id")]),t("tr",null,[t("td",null,"bizid"),t("td",null,"int32"),t("td")]),t("tr",null,[t("td",null,"md5"),t("td",null,"string"),t("td",null,"MD5")]),t("tr",null,[t("td",null,"file_id"),t("td",null,"string"),t("td",null,"文件uuid")])])],-1),m=t("div",{class:"language-json line-numbers-mode","data-ext":"json"},[t("pre",{class:"language-json"},[t("code",null,[t("span",{class:"token punctuation"},"{"),a(` `),t("span",{class:"token property"},'"status"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'"ok"'),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"retcode"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"0"),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"data"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token punctuation"},"{"),a(` `),t("span",{class:"token property"},'"msg_id"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"286479341"),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"bizid"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"102"),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"md5"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'"6742327a8b0147eebd6e1d4018626082"'),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"sha"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'""'),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"sha3"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'""'),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"file_id"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'"/c65b7c5c-50e0-47c6-951f-4e3377505f7f"'),a(` `),t("span",{class:"token punctuation"},"}"),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"echo"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'""'),a(` `),t("span",{class:"token punctuation"},"}"),a(` `)])]),t("div",{class:"line-numbers","aria-hidden":"true"},[t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"})])],-1),v=r('

上传群文件

该接口用于上传群文件。

注意

只能上传本地文件, 需要上传 http 文件的话请先下载至本地

API 端点

/upload_group_file

参数

字段类型说明
group_idint64群号
filestring本地文件路径 或 文件base64 或 文件url
namestring文件名称

注意

本地文件路径为绝对路径，文件base64为base64://开头，文件url则应该是正确的http请求地址。

响应

',9),g=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"字段"),t("th",null,"类型"),t("th",null,"说明")])]),t("tbody",null,[t("tr",null,[t("td",null,"msg_id"),t("td",null,"int32"),t("td",null,"消息id")]),t("tr",null,[t("td",null,"bizid"),t("td",null,"int32"),t("td")]),t("tr",null,[t("td",null,"md5"),t("td",null,"string"),t("td",null,"MD5")]),t("tr",null,[t("td",null,"file_id"),t("td",null,"string"),t("td",null,"文件uuid")])])],-1),y=t("div",{class:"language-json line-numbers-mode","data-ext":"json"},[t("pre",{class:"language-json"},[t("code",null,[t("span",{class:"token punctuation"},"{"),a(` `),t("span",{class:"token property"},'"status"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'"ok"'),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"retcode"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"0"),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"data"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token punctuation"},"{"),a(` `),t("span",{class:"token property"},'"msg_id"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"286479341"),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"bizid"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"102"),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"md5"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'"6742327a8b0147eebd6e1d4018626082"'),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"sha"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'""'),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"sha3"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'""'),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"file_id"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'"/c65b7c5c-50e0-47c6-951f-4e3377505f7f"'),a(` `),t("span",{class:"token punctuation"},"}"),t("span",{class:"token punctuation"},","),a(` `),t("span",{class:"token property"},'"echo"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'""'),a(` `),t("span",{class:"token punctuation"},"}"),a(` `)])]),t("div",{class:"line-numbers","aria-hidden":"true"},[t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"})])],-1),x=r(`

注意

参数 folder在Shamrock不受支持。

删除群文件

该接口用于删除群文件。

API 端点

/delete_group_file

参数

字段类型说明
group_idint64群号
file_idstring文件ID 参考 File 对象
busidint32文件类型 参考 File 对象

提示

该 API 无响应数据

创建群文件文件夹

该接口用于创建群文件文件夹。

注意

仅能在根目录创建文件夹

API 端点

/create_group_file_folder

参数

字段类型说明
group_idint64群号
namestring群文件夹名字

响应示例

{
  "status": "ok",
  "retcode": 0,
  "data": {
    "folder_id": "/ad86c100-031d-4139-8cab-c6c661a413ba",
    "parent_folder_id": "/",
    "folder_name": "测试",
    "create_time": 1706269735,
    "modify_time": 1706269735,
    "creator_uin": 1650114384,
    "modifier_uin": 1650114384
  },
  "message": "成功",
  "echo": 111
}

重命名群文件夹

把已经存在的群文件夹改个名字。

API 端点

/rename_group_folder

字段类型说明
group_idint64群号
folder_idstring群文件夹ID
namestring群文件夹名字

响应解释

可通过返回的状态码判断重命名是否成功。

删除群文件文件夹

该接口用于删除群文件文件夹。

API 端点

/delete_group_folder

参数

字段类型说明
group_idint64群号
folder_idstring文件夹ID 参考 Folder 对象

响应解释

可通过返回的状态码判断删除是否成功。

获取群文件系统信息

该接口用于获取群文件系统信息。

API 端点

/get_group_file_system_info

参数

字段类型说明
group_idint64群号

响应

字段类型说明
file_countint32文件总数
limit_countint32文件上限
used_spaceint64已使用空间
total_spaceint64空间上限

获取群根目录文件列表

该接口用于获取群根目录文件列表。

API 端点

/get_group_root_files

参数

字段类型说明
group_idint64群号

响应

字段类型说明
filesList<File>文件列表
foldersList<Folder>文件夹列表

File

字段类型说明
group_idint32群号
file_idstring文件ID
file_namestring文件名
busidint32文件类型
file_sizeint64文件大小
upload_timeint64上传时间
dead_timeint64过期时间，永久文件恒为0
modify_timeint64最后修改时间
download_timesint32下载次数
uploaderint64上传者ID
uploader_namestring上传者名字
md5stringmd5
shastringsha
sha3stringsha3 可能获取不到

Folder

字段类型说明
group_idint32群号
folder_idstring文件夹ID
folder_namestring文件名
create_timeint64创建时间
creatorint64创建者
creator_namestring创建者名字
total_file_countint32子文件数量

获取群子目录文件列表

该接口用于获取群子目录文件列表。

API 端点

/get_group_files_by_folder

参数

字段类型说明
group_idint64群号
folder_idstring文件夹ID 参考 Folder 对象

响应

字段类型说明
filesFile[]文件列表
foldersFolder[]文件夹列表

获取群文件资源链接

该接口用于获取群文件资源链接。

API 端点

/get_group_file_url

参数

字段类型说明
group_idint64群号
file_idstring文件ID 参考 File 对象
busidint32文件类型 参考 File 对象

响应

字段类型说明
urlstring文件下载链接
`,68);function q(A,I){const l=o("Badge"),i=o("Tabs");return c(),h("div",null,[t("div",b,[k,t("p",null,[a("对于 Shamrock 尚未实现的 API，会在标题添加标记 "),s(l,{text:"未实现",type:"danger",vertical:"baseline"})])]),f,s(i,{id:"83",data:[{id:"响应字段"},{id:"响应示例"}]},{title0:e(({value:n,isActive:d})=>[a("响应字段")]),title1:e(({value:n,isActive:d})=>[a("响应示例")]),tab0:e(({value:n,isActive:d})=>[_]),tab1:e(({value:n,isActive:d})=>[m]),_:1}),v,s(i,{id:"229",data:[{id:"响应字段"},{id:"响应示例"}]},{title0:e(({value:n,isActive:d})=>[a("响应字段")]),title1:e(({value:n,isActive:d})=>[a("响应示例")]),tab0:e(({value:n,isActive:d})=>[g]),tab1:e(({value:n,isActive:d})=>[y]),_:1}),x])}const w=p(u,[["render",q],["__file","file.html.vue"]]);export{w as default};