金山文档开放平台

主题

回到顶部
本页内容

获取表单列表

注意

表单相关接口目前处于 alpha 阶段，接口可能会随时调整，请慎重使用。

获取当前用户的表单列表

基本信息

请求方法：GET

请求路径：/api/v1/openapi/personal/forms

请求主机：developer.kdocs.cn

限流频次

应用类型限额
测试应用
10,000 次/天
正式应用
1,000,000 次/天

权限范围

权限值显示名称权限说明
access_form
访问表单
访问表单

Path 参数

参数必须类型说明
form_id
是
string
表单 id

Query 参数

参数必须类型说明
access_token
是
string
访问令牌
limit
否
integer
每次请求返回的记录数
offset
否
integer
偏移量，第 n 次请求的偏移量为 offset = (n-1) * limit
star
否
boolean
星标
kind
否
string
表单类型 form_v2 form_v2_file form_v2_vote form_v2_questionnaire
type
否
string
表单状态 Release 已经发布 Draft 草稿

返回参数

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

示例

请求示例 

curl --request GET \
	--url 'https://developer.kdocs.cn/api/v1/openapi/personal/forms?access_token=kvqxrspxjctdojjqdildjhonzwusaquc' \
	--header 'Content-Type: application/json'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/personal/forms?access_token=kvqxrspxjctdojjqdildjhonzwusaquc")
	.get()
	.addHeader("Content-Type", "application/json")
	.build();

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Content-Type", "application/json")

	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")

headers = { 'Content-Type': "application/json" }

conn.request("GET", "/api/v1/openapi/personal/forms?access_token=kvqxrspxjctdojjqdildjhonzwusaquc", headers=headers)

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/forms?access_token=kvqxrspxjctdojjqdildjhonzwusaquc",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "GET",
	CURLOPT_HTTPHEADER => [
		"Content-Type: application/json"
	],
]);

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

curl_close($curl);

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

const data = null;

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

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

xhr.open("GET", "https://developer.kdocs.cn/api/v1/openapi/personal/forms?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

const http = require("https");

const options = {
	"method": "GET",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/personal/forms?access_token=kvqxrspxjctdojjqdildjhonzwusaquc",
	"headers": {
		"Content-Type": "application/json"
	}
};

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.end();

CURL *hnd = curl_easy_init();

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

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/personal/forms?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": [
    {
      "id": {
          "open_id": "JxdxSDJpnZKRRr0dEKZRuMIxZQOfViWmf6OQDNkupVDhwRK7fy_gEkONxCTxvPLUrqw9EMICvkWFiESUXtXNzA",
          "union_id": "-9Yu8Qo2oJirjqhvNofycMIxZQOfViWmf6OQDNkupVDhwRK7fy_gEkONxCTxvPLUrqw9EMICvkWFiESUXtXNzA"
      },
      "version": 8,
      "edit_version": 0,
      "title": "test form",
      "star": false,
      "count": 0,
      "share_id": "9NUnzdNl",
      "created_ts": 1667307495,
      "modified_ts": 1667307496,
      "kind": "form_v2",
      "type": "Release",
      "user_id": {
          "open_id": "JxdxSDJpnZKRRr0dEKZRuChR6r3Gtc-oHiH_VOrjHKg",
          "union_id": "-9Yu8Qo2oJirjqhvNofycChR6r3Gtc-oHiH_VOrjHKg"
      },
      "expire": 0,
      "start_at": 0,
      "end_at": 0,
      "max_write_times": -1
    }
  ]
}

错误码

请参考错误码说明