简介
本文档提供关于文档审核的 API 概览和 SDK 示例代码。
注意
COS Javascript SDK 版本需要大于等于 v1.3.1。
API | 操作描述 |
用于提交一个文档审核任务 | |
用于查询指定的文档审核任务 |
提交文档审核任务
功能说明
用于提交一个文档审核任务。
请求示例
function postDocumentAuditing() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';var url = 'https://' + host + '/document/auditing';var body = COS.util.json2xml({Request: {Input: {Object: 'test.xlsx', /* 需要审核的文档文件,存储桶里的路径 */},Conf: {BizType: '',}}});cos.request({Bucket: config.Bucket,Region: config.Region,Method: 'POST',Url: url,Key: '/document/auditing', /** 固定值,必须 */ContentType: 'application/xml', /** 固定值,必须 */Body: body},function(err, data){console.log(err || data);});}postDocumentAuditing();
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Input | Request | 需要审核的内容 | Container | 是 |
Conf | Request | 审核规则配置 | Container | 是 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Url | Request.Input | 文档文件的链接地址,例如 http://www.example.com/doctest.doc | String | 是 |
Type | Request.Input | 指定文档文件的类型,如未指定则默认以文件的后缀为类型。 如果文件没有后缀,该字段必须指定,否则会审核失败。例如:doc、docx、ppt、pptx 等 | String | 否 |
Container 类型 Conf 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Callback | Request.Conf | 审核结果可以回调形式发送至您的回调地址,支持以 http:// 或者 https:// 开头的地址,例如:http://www.callback.com | String | 否 |
BizType | Request.Conf | 审核策略,不填写则使用默认策略。可在控制台进行配置,详情请参见 设置审核策略 | String | 否 |
返回结果说明
查询文档审核任务
功能说明
用于查询文档审核任务执行情况和结果。
请求示例
function getDocumentAuditingResult() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var jobId = 'sd7815c21caff611eca12f525400d88xxx'; // jobId可以通过提交文档审核任务返回var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';var url = 'https://' + host + '/document/auditing/' + jobId;cos.request({Bucket: config.Bucket,Region: config.Region,Method: 'GET',Key: '/document/auditing/' + jobId,Url: url,},function(err, data){console.log(err || data);});}getDocumentAuditingResult();
参数说明
参数名称 | 描述 | 类型 | 是否必选 |
jobId | 需要查询的任务 ID | String | 是 |