金山文档开放平台

主题

回到顶部
本页内容

批量删除文档

批量移动文档到回收站，移动至回收站的文件可再次恢复

基本信息

请求方法：POST

请求路径：/api/v1/openapi/personal/tasks/files/delete

请求主机：developer.kdocs.cn

限流频次

应用类型限额
测试应用
500 次/天
正式应用
100,000 次/天

权限范围

权限值显示名称权限说明
remove_personal_files
删除个人文档
删除用户个人文档

Query 参数

参数必须类型说明
access_token
是
string
访问令牌

Body 参数

参数必须类型说明
file_ids
是
string[]
要删除的文档 ID。单次请求不能超过 100 个。

返回参数

参数类型说明
code
integer
错误码
+
data
data {}
响应数据

提示

大部分情况下批量任务会异步执行，开放平台返回异步任务 task_id，可以通过查询批量任务结果接口查询执行结果。

如果 task_id 返回空，则表示批量任务已经被同步执行且执行成功。常见于小批量移动文档操作。

示例

请求示例 

curl --request POST \
	--url 'https://developer.kdocs.cn/api/v1/openapi/personal/tasks/files/delete?access_token=kvqxrspxjctdojjqdildjhonzwusaquc' \
	--data '{"file_ids":["kvqxrspxjctdojjqdildjhonzwusaquc"]}'

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"file_ids\":[\"kvqxrspxjctdojjqdildjhonzwusaquc\"]}");
Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/personal/tasks/files/delete?access_token=kvqxrspxjctdojjqdildjhonzwusaquc")
	.post(body)
	.build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://developer.kdocs.cn/api/v1/openapi/personal/tasks/files/delete?access_token=kvqxrspxjctdojjqdildjhonzwusaquc"

	payload := strings.NewReader("{\"file_ids\":[\"kvqxrspxjctdojjqdildjhonzwusaquc\"]}")

	req, _ := http.NewRequest("POST", url, payload)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

import http.client

conn = http.client.HTTPSConnection("developer.kdocs.cn")

payload = "{\"file_ids\":[\"kvqxrspxjctdojjqdildjhonzwusaquc\"]}"

conn.request("POST", "/api/v1/openapi/personal/tasks/files/delete?access_token=kvqxrspxjctdojjqdildjhonzwusaquc", payload)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
	CURLOPT_URL => "https://developer.kdocs.cn/api/v1/openapi/personal/tasks/files/delete?access_token=kvqxrspxjctdojjqdildjhonzwusaquc",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "POST",
	CURLOPT_POSTFIELDS => "{\"file_ids\":[\"kvqxrspxjctdojjqdildjhonzwusaquc\"]}",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

const data = JSON.stringify({
	"file_ids": [
		"kvqxrspxjctdojjqdildjhonzwusaquc"
	]
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open("POST", "https://developer.kdocs.cn/api/v1/openapi/personal/tasks/files/delete?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");

xhr.send(data);

const http = require("https");

const options = {
	"method": "POST",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/personal/tasks/files/delete?access_token=kvqxrspxjctdojjqdildjhonzwusaquc",
	"headers": {}
};

const req = http.request(options, function (res) {
	const chunks = [];

	res.on("data", function (chunk) {
		chunks.push(chunk);
	});

	res.on("end", function () {
		const body = Buffer.concat(chunks);
		console.log(body.toString());
	});
});

req.write(JSON.stringify({file_ids: ['kvqxrspxjctdojjqdildjhonzwusaquc']}));
req.end();

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://developer.kdocs.cn/api/v1/openapi/personal/tasks/files/delete?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"file_ids\":[\"kvqxrspxjctdojjqdildjhonzwusaquc\"]}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/personal/tasks/files/delete?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");
var request = new RestRequest(Method.POST);
request.AddParameter("undefined", "{\"file_ids\":[\"kvqxrspxjctdojjqdildjhonzwusaquc\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": {
    "task_id": "2v4ga8zuykc12kgmdeqpbh"
  }
}

错误码

请参考错误码说明