错误代码

Zoho Docs API

Zoho Docs API 为合作伙伴和组织提供更紧密集成的方法与 Zoho 的应用程序交互,实现安全的存储和文档编辑功能。

Zoho Docs API 可集成到现有文档系统,扩展功能的范围。合作伙伴可使用集成的 Zoho 服务来构建他们自己的应用程序,并利用协作和文档编辑功能。Zoho Docs API 提供一种文档存储和文档编辑方法,以便合作伙伴可以集中于其核心应用程序和服务,而不用花时间来构建和管理存储解决方案。

Zoho Docs 提供以下 API:

授权请求

身份验证令牌

若要使用 Zoho Docs API,您将需要来自 Zoho 账户的 Zoho Docs 身份验证令牌。请确保您可以从 Zoho Docs API 服务检索或提取数据。

生成身份验证令牌

若要生成身份验证令牌,您需要按如下所述向 Zoho 账户发送请求。身份验证令牌可按两种方式来生成:

  • API 模式
  • 浏览器模式

API 模式

描述生成身份验证令牌。
URL 结构https://accounts.zoho.com/apiauthtoken/nb/create
方法POST
参数
参数描述
SCOPE字符串 - (ZohoPC/docsapi)必填。将值指定为 ZohoPC/docsapi
EMAIL_ID字符串必填。指定您的 Zoho Docs 用户名或电子邮件 ID
PASSWORD字符串必填。指定您的 Zoho Docs 密码
DISPLAY_NAME字符串 - (ZOHODOCS)必填。指定您的用户应用名称
返回返回为指定用户生成的身份验证令牌。

浏览器模式

描述生成身份验证令牌。
URL 结构https://accounts.zoho.com/apiauthtoken/create
方法GET
参数
参数描述
SCOPE字符串 - (ZohoPC/docsapi)必填。将值指定为 ZohoPC/docsapi
DISPLAY_NAME字符串 - (ZOHODOCS)必填。指定您的用户应用名称
返回返回为指定用户生成的身份验证令牌。

AuthToken 的示例响应

#
#Tue Aug 27 16:26:02 IST 2013
AUTHTOKEN=f46973ff35f9778a940a89fa7a48cd7f
RESULT=TRUE

管理身份验证令牌

您可以从‘我的 Zoho 账户’页面查看、删除和重新生成为您的账户生成的身份验证令牌。
  1. 登录到 Zoho Docs
  2. 打开[用户名] > 我的 Zoho 账户
  3. 在“我的 Zoho 账户”页面,点击设置 > 活动授权标记

在此页面中,您也可以删除或重新生成身份验证令牌

注:
  • 删除身份验证令牌将永久删除令牌。
  • 如果您重新生成身份验证令牌,请使用新令牌更新您的程序。

上传文件

/upload

描述使用 POST 语义上传文件。
URL 结构https://apidocs.zoho.com/files/v1/upload?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
filename字符串必填。待上传文件的名称
fid字符串可选。要在其中上传文件的文件夹的 ID
wsid字符串可选。要在其中上传文件的工作空间的 ID
content字符串必填。要上传的实际文档内容
返回返回已上传文档的元数据
错误404 用户无效
9837 丢失内容
此 API 为免费用户支持 100 MB 的最大文件大小限制,为付费用户支持 250 MB。

upload 的示例响应

{
"response":
[
{"uri":"/files/v1/upload"},
{"message":"UPLOAD_SUCCESS"},
{"result":
[
{"documentname":"Tulips.jpg"},
{"uploaddocid":"3yprga7361deb32524816b36e72f27baa02c9"}
]
}
]
}

下载文件

/download

描述下载文件。
URL 结构https://apidocs.zoho.com/files/v1/content/<DOC_ID>?authtoken=AuthToken&scope=docsapi
方法GET
参数
参数描述
docversion字符串可选。待下载文档的版本。这默认为最新版本。
返回指定文件的内容和请求的版本。
错误9832 未找到具有给定文档 id 的文件。

管理文件元数据

/create

描述创建新文档或文件
URL 结构https://apidocs.zoho.com/files/v1/create?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
filename字符串必填。待创建文件的名称
service字符串 - (document | spreadsheet | presentation)必填。任何给定服务
type字符串 - (doc | template)必填。指定要创建的模板或文档的类型
parentfolderid字符串可选。要在其中创建文档的文件夹的 ID。这默认为根文件夹。
返回返回成功消息
错误404 用户无效
9822 未指定有效的服务类型
9823 创建文档时出错

/files

描述取回用户的文件
URL 结构https://apidocs.zoho.com/files/v1/files?authtoken=AuthToken&scope=docsapi
方法GET
参数
参数描述
category字符串 - (documents | spreadsheets | presentations | pictures | music | videos | sharedbyme | sharedtome | thrashed)可选。基于类别的文件列表
start整数可选。此值设置为从该条目开始获取文件列表
limit整数可选。此值设置为获取文件列表限制。如果 start 和 limit 均未设置,则将分别取默认值 0 和 200。
返回指定的类别文件。
错误404 用户无效
9830 start 参数未正确设置
9831 limit 参数未正确设置
此 API 也支持范围以允许取回部分文件列表。

files 的示例响应

{
"FILES": [
{
"AUTHOR":"Tom Hill",
"AUTHOR_EMAIL":"tomhill@yahoo.com",
"LAST_MODIFIEDTIME_IN_MILLISECONDS":1371015460774,
"SCOPE":0,
"FILE_EXTN":"jpg",
"DOCID":"8tw2gf0022bc32fb94c4990f40658dd091983",
"DOCNAME":"Chrysanthemum.jpg",
"FOLDER_ID":"folder",
"LAST_MODIFIEDTIME":"Jun 11",
"SERVICE_TYPE":"upload",
"IS_LOCKED":false,
"FILETYPE":"image"
}
]
}

/copy

描述将文件或文档复制到新位置
URL 结构https://apidocs.zoho.com/files/v1/copy?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。待复制的文档或文件的 ID
folderid字符串必填。用于复制新文件的文件夹的 ID
返回返回成功消息
错误404 用户无效
9832 未找到具有给定文档 id 的文件。

Copy 的示例响应

{
"response":
{
"result":
{"message":"DOCUMENT_COPIED_SUCCESSFULLY"},
"uri":"/files/v1/move"
}
}

/move

描述将文件或文档移动到指定位置
URL 结构https://apidocs.zoho.com/files/v1/move?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。待移动的文档或文件的 ID
folderid字符串必填。用于复制新文件的文件夹的 ID
返回返回成功消息
错误404 用户无效
9832 未找到具有给定文档 id 的文件。

move 的示例响应

{
"response":
{
"result":
{"message":"DOCUMENT_MOVED_SUCCESSFULLY"},
"uri":"/files/v1/move"
}
}

/trash

描述将文件移至回收站。
URL 结构https://apidocs.zoho.com/files/v1/trash?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。待移至回收站的文档或文件的 ID
返回返回成功消息
错误404 用户无效
9832 未找到具有给定文档 id 的文件。

trash 的示例响应

{
"response":
{
"result":
{"message":"DOCUMENT_TRASHED_SUCCESSFULLY"},
"uri":"/files/v1/move"
}
}

/restore

描述恢复已移至回收站的文件
URL 结构https://apidocs.zoho.com/files/v1/restore?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。待恢复的文档或文件的 ID
返回返回成功消息
错误404 用户无效
9832 未找到具有给定文档 id 的文件。

Restore 的示例响应

{
"response":
{
"result":
{"message":"DOCUMENT_RESTORED_SUCCESSFULLY"},
"uri":"/files/v1/move"
}
}

/delete

描述文件将从用户的账户中删除
URL 结构https://apidocs.zoho.com/files/v1/delete?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。待删除的文档或文件的 ID
返回返回成功消息
错误404 用户无效
9832 未找到具有给定文档 id 的文件。

Delete 的示例响应

{
"response":
{
"result":
{"message":"DOCUMENT_DELETED_SUCCESSFULLY"},
"uri":"/files/v1/move"
}
}

/rename

描述重命名现有文件或文档
URL 结构https://apidocs.zoho.com/files/v1/rename?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。待重命名的文档或文件的 ID
docname字符串必填。文档或文件的新名称
返回返回成功消息
错误404 用户无效
9832 未找到具有给定文档 id 的文件。

Rename 的示例响应

{
"response":
{"result":
{"DocumentDetails":
{"DocumentDetail":
{ "message":"DOCUMENT_RENAMED_SUCCESSFULLY",
"DOCUMENT_NAME":"chumma.png",
"DOCID":"3yprg69b889a4c0634f77986f948a38ce8b1c"
}
}
}
,"uri":"/files/v1/rename"
}
}

共享文件

/share

描述向私人电子邮件 ID 共享文件
URL 结构https://apidocs.zoho.com/files/v1/share?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docids字符串必填。待共享的文档或文件的 ID
emailids字符串必填。要与之共享的用户的邮件 ID
permission字符串 - (readonly|readwrite|coowner)必填。共享给用户的文件具有指定的权限
通知布尔值 - (true|false)可选。当文件或文档通过邮件共享时通知共享用户
message字符串可选。通过邮件发送给共享用户的消息
返回返回成功消息
错误404 用户无效
9832 未找到具有给定文档 id 的文件。
9839 给定的电子邮件 ID 无效

Share 的示例响应

{
response:
[
{
uri: "/files/v1/share"
},
{
message: "SHARED_DOCUMENT_SUCCESS"
},
{
result:
[
{
shareduserlist: "calvin@gmail.com,xylan@gmail.com,"
},
{
sharedgroupslist: "2345234,343424,3483439,143840,"
}
]
}
]
}

/visibility

描述通过链接共享文件
URL 结构https://apidocs.zoho.com/files/v1/share/visibility?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。待通过链接共享的文档或文件的 ID
visibility字符串 - (orglinkshare | orgshare | linkshare | private )必填。更改文档的可见性。
permission字符串 - (readonly|readwrite)必填。共享给用户的文件具有指定的权限
password字符串可选。如果文档通过链接安全地共享,则需要密码
expireson日期 - (mm/dd/yyyy)可选。指定文档可通过链接共享的开始日期
返回返回成功消息,并带有生成的链接
错误404 用户无效
9832 未找到具有给定 docid 的文件。
9834 visibility 参数无效

visibility 的示例响应

{
response:
[
{
uri: "/files/v1/share/visibility"
},
{
message: "CHANGE_VISIBILITY_SUCCESS"
},
{
result:
[
{
permaLink:"https://docs.zoho.com/file/i5fa1a0081eed629b4f978aae3a6ab296790a"
}
]
}
]
}

/update

描述更新现有共享文件的权限
URL 结构https://apidocs.zoho.com/files/v1/share/update?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。要更新文档可见性的文档或文件的 ID
visibility字符串 - (orglinkshare | orgshare | linkshare | private )必填。更改文档的可见性。
permission字符串 - (readonly|readwrite)必填。共享给用户的文件具有指定的权限
emailids字符串可选。要与之共享的用户的邮件 ID(如果可见性设置为私有,则必填)。
返回返回成功消息。
错误404 用户无效
9832 未找到具有给定文档 id 的文件。
9839 给定的电子邮件 ID 无效
9834 visibility 参数无效

update 的示例响应

{
response:
[
{
uri: "/files/v1/share/update"
},
{
message: "UPDATE_SHARE_SUCCESS"
},
{
result:
[
{
documentid: "i5fa1a0081eed629b4f978aae3a6ab296790a"
}
]
}
]
}

/remove

描述删除共享用户的共享权限
URL 结构https://apidocs.zoho.com/files/v1/share/remove?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。待删除共享的文档或文件的 ID
emailids字符串必填。要与之共享的用户的邮件 ID
返回返回成功消息
错误404 用户无效
9832 未找到具有给定文档 id 的文件。
9839 给定的电子邮件 ID 无效

Remove 的示例响应

{
response:
[
{
uri: "/files/v1/share/remove"
},
{
message: "UNSHARED_DOCUMENT_SUCCESS"
},
{
result:
[
{
documentid: "i5fa1a0081eed629b4f978aae3a6ab296790a"
}
]
}
]
}

/details

描述返回文档或文件的共享详细信息
URL 结构https://apidocs.zoho.com/files/v1/share/details?authtoken=AuthToken&scope=docsapi
方法GET
参数
参数描述
docid字符串必填。要获取其共享详细信息的文档或文件的 ID
返回返回共享详细信息
错误9832 未找到具有给定文档 id 的文件。
404 用户无效

共享详细信息的示例响应

{
"response":{
"result":{
"ReadOnly":{
"sharedGroups":"",
"sharedUserZuids":"",
"sharedEmails":"",
"sharedUsers":""
},
"coOwner":{
"sharedUserZuids":"",
"sharedEmails":"",
"sharedUsers":""
},
"ReadWrite":{
"sharedGroups":"332613,336474",
"sharedUserZuids":"2324,17560",
"sharedEmails":"",
"sharedUsers":"tomhill@abc.com,jamesandy@biz.com"
},
"visibility":"orgshare",
"permaLink":"https://docs.zoho.com/file/i5fa1a0081eed629b4f978aae3a6ab296790a"
},
"uri":"/files/v1/share/details"
}
}

文件修订

/revision

描述使用 POST 语义修订现有文件的内容。
URL 结构https://apidocs.zoho.com/files/v1/revision?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。待修订的文档的 ID
filename字符串必填。待修订文件的名称。
content字符串必填。待上传文件的内容
返回返回成功消息
错误404 用户无效
9837 丢失内容
此 API 为免费用户支持 100 MB 的最大文件大小限制,为付费用户支持 500 MB。

revision 的示例响应

{
"response":
[
{"uri":"/files/v1/revision"},
{"message":"Version Updated Successfully"},
{"result":
[
{"documentname":"Tulips.jpg"},
{"uploaddocid":"3yprga7361deb32524816b36e72f27baa02c9"}
]
}
]
}

/details

描述列出给定文档的修订详细信息。
URL 结构https://apidocs.zoho.com/files/v1/revision/details?authtoken=AuthToken&scope=docsapi
方法GET
参数
参数描述
docid字符串必填。待修订的文档的 ID
type字符串 - (owned|shared)必填。指定文档是什么类型。
返回返回成功时的版本详细信息列表
错误404 用户无效
9832 未找到具有给定 docid 的文档。

版本详情的示例响应

{
"DOCTYPE":"image",
"FORMAT":"jpg",
"DOCID":"3yprga7361deb32524816b36e72f27baa02c9",
"DOCNAME":"Inventory stocks.jpg"
"VERSION_INFO":
[
{
"VERSION":"2.0",
"DOCSIZE":"777 KB",
"DOCUPLOADTIME":"Aug 29 12:24 PM 2013"
},
{
"VERSION":"1.0",
"DOCSIZE":"620 KB",
"DOCUPLOADTIME":"Aug 28 10:59 AM 2013"
}
]
}

文件夹

/folders

描述返回用户账户中包含的文件夹列表
URL 结构https://apidocs.zoho.com/files/v1/folders?authtoken=AuthToken&scope=docsapi
方法GET
参数
参数描述
folderid字符串可选。待获取其子文件夹列表的文件夹的 ID。这默认为根文件夹
返回返回文件夹列表
错误404 用户无效

folder 的示例响应

[
{"FOLDER_NAME":"My Folders","SUCCESS":"1"},
[
{
"FOLDER_ID":"3yprg626b688109df404da92acd6c5f1894a6",
"PARENT_FOLDER_ID":"1",
"FOLDER_NAME":"ABC"
}
]
]

/create

描述创建新文件夹。
URL 结构https://apidocs.zoho.com/files/v1/folders/create?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
foldername字符串必填。要在其中创建文件夹的文件夹的名称。
parentfolderid字符串可选。要在其中创建文件夹的文件夹的 ID。这默认为根文件夹。
返回返回新创建的文件夹 ID
错误404 用户无效

创建文件夹的示例响应

{
"response":
{
"result":
{"FolderDetails":
{"FolderDetail":
{
"message":"FOLDER_CREATED_SUCCESSFULLY",
"folder_name":"Projects",
"folder_id":"8tw2g62a6bc3d81da4c2c85646d679628aacb"
}
}
}
,"uri":"/files/v1/folders/create"
}
}

/rename

描述重命名现有文件夹
URL 结构https://apidocs.zoho.com/files/v1/folders/rename?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
folderid字符串必填。待重命名的文件夹的 ID
foldername字符串必填。文件夹的新名称
返回返回成功消息
错误404 用户无效

重命名文件夹的示例响应

{
"response":
{
"result":
{"FolderDetails":
{"FolderDetail":
{"message":"FOLDER_RENAMED_SUCCESSFULLY",
"folder_name":"testapi1",
"folder_id":"8tw2g62a6bc3d81da4c2c85646d679628aacb"
}
}
},
"uri":"/files/v1/folders/rename"
}
}

/move

描述将现有文件夹移至指定位置
URL 结构https://apidocs.zoho.com/files/v1/folders/move?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
folderid字符串必填。待移动的文件夹的 ID
destfolderid字符串必填。待移动的文件夹的 ID
prevparentfolderid字符串必填。当前文件夹所在的文件夹的 ID。
返回返回成功消息
错误404 用户无效

移动文件夹的示例响应

{
"response":
{
"result":
{
"message":"FOLDER_MOVED_SUCCESSFULLY"
}
,"uri":"/files/v1/folders/move"
}
}

/copy

描述将现有文件夹复制到指定文件夹
URL 结构https://apidocs.zoho.com/files/v1/folders/copy?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
folderid字符串必填。待复制文件夹的 ID
destfolderid字符串必填。指定目的文件夹的 ID(现有文件夹将要复制到其中)。
返回返回成功消息
错误404 用户无效

复制文件夹的示例响应

{"response":
{"result":
{
"message":"COPY_FOLDER_SUCCESS",
"folderid":"3yprgba1a3aeccdfc44a1afc51e8aa3c99b26",
"status":"1"
},
"uri":"/files/v1/folders/copy"
}
}

/trash

描述将移动到回收站的文件夹
URL 结构https://apidocs.zoho.com/files/v1/folders/trash?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
folderid字符串必填。待移至回收站的文件夹的 ID
返回返回成功消息
错误404 用户无效

废弃文件夹的示例响应

{
"response":
{
"result":
{
"message":"FOLDER_TRASHED_SUCCESSFULLY"
}
,"uri":"/files/v1/folders/move"
}
}

/restore

描述恢复已移至回收站的文件夹
URL 结构https://apidocs.zoho.com/files/v1/folders/restore?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
folderid字符串必填。待恢复的文件夹的 ID
返回返回成功消息
错误404 用户无效

恢复文件夹的示例响应

{
"response":
{
"result":
{
"message":"FOLDER_RESTORED_SUCCESSFULLY"
}
,"uri":"/files/v1/folders/move"
}
}

/delete

描述从用户账户删除文件夹
URL 结构https://apidocs.zoho.com/files/v1/folders/delete?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
folderid字符串必填。待删除的文件夹的 ID
返回返回成功消息
错误404 用户无效

删除文件夹的示例响应

{
"response":
{
"result":
{
"message":"FOLDER_DELETED_SUCCESSFULLY"
}
,"uri":"/files/v1/folders/move"
}
}

/files

描述检索该文件夹中的文件和文件夹
URL 结构https://apidocs.zoho.com/files/v1/folders/files?authtoken=AuthToken&scope=docsapi
方法GET
参数
参数描述
folderid字符串可选。用于检索列表的文件夹的 ID。这默认为我的文件夹。
返回返回文件和文件夹的列表
错误404 用户无效

文件夹中的文件的示例响应

{
"FILES":
[
{
"FOLDER_ID":"cm31cdf8d437e1d89475490c8d78790c7478b",
"AUTHOR_ID":"4145547",
"LAST_MODIFIEDTIME_IN_MILLISECONDS":1369397398535,
"SCOPE":0,
"FILE_EXTN":"txt",
"DOCID":"cm31c1882749ac9de48518691c0e48111c083",
"LAST_MODIFIEDBY":"4145547",
"LAST_MODIFIEDTIME":"May 24",
"SERVICE_TYPE":"upload",
"IS_LOCKED":false,
"FILETYPE":"docs",
"DOCNAME":"ids.txt"
}
],
"FOLDER":
[
{
"PARENTFOLDERID":"cm31cdf8d437e1d89475490c8d78790c7478b",
"FOLDERID":"z1g204cd6a2f5080f459b8659f8e24a1bd61e",
"FOLDERNAME":"test"
}
]
}

共享文件夹

/share

描述向私人电子邮件 ID 共享文件夹
URL 结构https://apidocs.zoho.com/files/v1/share?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
folderids字符串必填。指定文件夹 ID
emailids字符串必填。指定待共享用户的电子邮件 ID
permission字符串 - (readonly|readwrite | coowner)必填。指定共享文件夹的访问权限。
通知布尔值 - (true|false)可选。当文件夹通过电子邮件共享时通知共享用户
message字符串可选。消息通过电子邮件发送给共享用户。
返回返回成功消息
错误404 用户无效。
9832 未找到具有给定 folderid 的文件夹。
9839 给定的 emailid 无效。

共享文件夹的示例响应

{"response":
[
{"uri":"/files/v1/share"},
{"message":"SHARE_FOLDER_SUCCESS"},
{"result":
[
{"shareduserlist":"aravind694,"}
]
}
]
}

/visibility

描述通过链接共享文件夹
URL 结构https://apidocs.zoho.com/files/v1/share/visibility?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
folderid字符串必填。文件夹 ID 通过链接共享。
visibility字符串 - (orglinkshare | orgshare | linkshare | private )必填。更改文件夹可见性
permission字符串 - readonly | readwrite必填。共享给用户的文件夹具有指定的权限。
password字符串可选。如果文件夹通过链接共享且受密码保护,则需要密码。
expireson日期 - (mm/dd/yyyy)可选。指定文件夹可通过链接访问的开始日期。
返回返回成功消息,并带有生成的链接
错误404 用户无效
9832 未找到具有给定 folderid 的文件夹。
9834 visibility 参数无效

Visibility 的示例响应

{"response":
[
{"uri":"/files/v1/share/visibility"},
{"message":"CHANGE_VISIBILITY_SUCCESS"},
{"result":
[
{"permaLink":"https://docs.zoho.com/folder/3yprgf644c24c4c7f43b79d852e02646109bd"}
]
}
]
}

/update

描述更新现有共享文件夹的权限
URL 结构https://apidocs.zoho.com/files/v1/share/update?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
folderid字符串必填。指定文件夹 ID 以更改现有权限/可见性。
visibility字符串 - (orglinkshare | orgshare | linkshare | private )必填。更改文件夹可见性
permission字符串 - readonly | readwrite | coowner必填。共享给用户的文件夹具有指定的权限。
emailids字符串可选。共享用户电子邮件 ID。(如果可见性设置为私有,则必填。)
返回返回成功消息。
错误404 用户无效
9832 未找到具有给定 folderid 的文件夹。
9839 给定 emailid 无效
9834 visibility 参数无效

update 的示例响应

{"response":
[
{"uri":"/files/v1/share/update"},
{"message":"UPDATE_SHARE_SUCCESS"},
{"result":
[
{"folderid":"3yprgf644c24c4c7f43b79d852e02646109bd"}
]
}
]
}

/remove

描述删除共享用户的共享权限
URL 结构https://apidocs.zoho.com/files/v1/share/remove?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
folderid字符串必填。指定文件夹 ID 以移除共享。
emailids字符串必填。共享用户电子邮件 ID。
返回返回成功消息。
错误404 用户无效
9832 未找到具有给定 folderid 的文件夹。
9839 给定的 emailid 无效

Remove 的示例响应

{"response":
[
{"uri":"/files/v1/share/remove"},
{"message":"UNSHARE_FOLDER_SUCCESS"},
{"result":
[
{"folderid":"3yprgf644c24c4c7f43b79d852e02646109bd"}
]
}
]
}

/details

描述返回文件夹的共享详细信息
URL 结构https://apidocs.zoho.com/files/v1/share/details?authtoken=AuthToken&scope=docsapi
方法GET
参数
参数描述
folderid字符串必填。指定文件夹 ID 以获取共享详细信息。
返回返回共享详细信息
错误9832 未找到具有给定 folderid 的文件夹。
404 用户无效

共享详细信息的示例响应

{
"response":{
"result":{
"ReadOnly":{
"sharedGroups":"",
"sharedUserZuids":"1482406",
"sharedEmails":"tomhill@abc.com",
"sharedUsers":""
},
"coOwner":{
"sharedUserZuids":"",
"sharedEmails":"",
"sharedUsers":""
},
"ReadWrite":{
"sharedGroups":"",
"sharedUserZuids":"",
"sharedEmails":"",
"sharedUsers":""
},
"visibility":"linkshare",
"permaLink":"https://docs.zoho.com/folder/i5fa1a0081eed629b4f978aae3a6ab296790a"
},
"uri":"/files/v1/share/details"
}
}

标签

/tags

描述返回用户标签列表
URL 结构https://apidocs.zoho.com/files/v1/tags?authtoken=AuthToken&scope=docsapi
方法GET
返回返回用户标签列表
错误404 用户无效

tags 的示例响应

{
"UserTagDetails":
[
{
"tagName":"ABC",
"tagId":"403347000000204019"
}
]
}

/create

描述创建新用户标签
URL 结构https://apidocs.zoho.com/files/v1/tags/create?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
tagname字符串必填。待创建标签的名称。
返回返回标签 ID
错误404 用户无效

创建标签的示例响应

{
"response":
{
"result":
{"TagDetails":
{
"message":"TAG_ADDED_SUCCESSFULLY",
"tag_name":"Required for Project",
"tag_id":"403347000000261006"
}
},
"uri":"/files/v1/tags/create"
}
}

/add

描述将标签添加到文件或文档
URL 结构https://apidocs.zoho.com/files/v1/tags/add?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。应为其添加标签的文件的 ID
tagname字符串必填。待添加标签的名称。
返回返回成功消息。
错误9832 未找到具有给定文档 id 的文件。
404 用户无效

添加标签的示例响应

{
"response":
{
"result":
{
"TagDetails":
{
"message":"TAG_ADDED_SUCCESSFULLY",
"tags":"Related to Finance",
"taggedDocIds":"docids=cm31c1882749ac9de48518691c0e48111c083"
}
},
"uri":"/files/v1/tags/add"
}
}

/remove

描述删除已映射到文档或文件的标签
URL 结构https://apidocs.zoho.com/files/v1/tags/remove?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。其标签待删除的文件的 ID
tagname字符串必填。待从文件或文档中删除的标签的名称
返回返回成功消息
错误9832 未找到具有给定文档 id 的文件。
404 用户无效

删除标签的示例响应

{
"response":
{
"result":
{
"message":"TAG_REMOVED_SUCCESSFULLY",
"unTaggedDocIds":"docids=cm31c1882749ac9de48518691c0e48111c083"
},
"uri":"/files/v1/tags/remove"
}
}

/delete

描述从用户账户中删除用户标签
URL 结构https://apidocs.zoho.com/files/v1/tags/delete?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
tagid长整型必填。待删除的标签的 ID
返回返回成功消息
错误404 用户无效

删除标签的示例响应

{
"response":
{
"result":
{
"message":"TAG_DELETED_SUCCESSFULLY"
}
,"uri":"/files/v1/tag/delete"
}

发布

/publish

描述向公众或向组织发布文档
URL 结构https://apidocs.zoho.com/files/v1/publish?authtoken=AuthToken&scope=docsapi
方法POST
参数
参数描述
docid字符串必填。待发布的文档的 ID。
action字符串 - (external|org|change|remove)必填。待发布的任何给定值
type字符串 - (org|external)必填。当发布类型从外部更改为组织(反之亦然)设置此参数
filename字符串必填。待发布的文档的名称
返回成功时返回发布 URL
错误404 用户无效
9820 不是有效的文件名
9821 不是有效的 action 参数
9850 用户不属于组织,不能在组织内发布
9832 未找到具有给定 docId 的文档 Id。
9402 文件不支持发布选项。
此 API 仅支持图像和 PDF 文件。

publish 的示例响应

{
"response":
{
"result":
{"PublishURL":
{
"MESSAGE":"https://docs.zoho.com/file/3yprg7adc992a0f4d448e830934cc63a780f6"
}
}
,"uri":"/files/v1/publish"
}
}

错误代码

代码描述
404不是有效的用户
500内部服务器错误
9832无效的文档 ID
9830Start 参数未正确设置
9831limit 参数未正确设置
9837缺少内容
9838恢复文档失败
9839给定的电子邮件 ID 无效
9834visibility 参数无效
9840受病毒感染的文件
9820不是有效的文件名
9821不是有效的 action 参数
9850用户不属于组织,不能在组织内发布
9402文件不支持发布选项

分享此文章: FacebookTwitter

还是没有找到您要寻找的内容?

写信给我们:support@zohodocs.com