文档中心 > API类目 > 钉钉API

dingtalk.oapi.wiki.doc.public.list (查询公开发布的知识页列表)

根据知识本id 查询公开发布的知识页列表

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
cursor	Number	可选	0	默认值：0	分页游标（默认0）
size	Number	可选	20	默认值：20	分页大小（默认20）
agentid	Number	必须	1111		应用agentId
group_id	String	必须	xxx		知识库ID（加密后的值）

响应参数

名称	类型	示例值	描述
result	OpenPageResult		返回结果
└ next_cursor Number 0 下一次分页的游标 data OpenDocVo [] 知识页列表 └ group_id String L4BYma3gAj03zNA8 知识页所在知识库id（加密后的值） └ name String 专题研究知识页的名字 └ id String L4BYmaRdORrDGNA8 知识页ID（加密后的值） └ latest_cp_url String xxx 文档最近一次cp的url └ share_url String xxx 文档分享链接的url └ repo_id String xxx 知识页所在知识本id（加密后的值） └ has_more Boolean false 是否还有更多的数据
success	Boolean	true	是否操作成功
errcode	Number	0	返回码
errmsg	String	ok	对返回码的文本描述内容

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/wiki/doc/public/list");
OapiWikiDocPublicListRequest req = new OapiWikiDocPublicListRequest();
req.setCursor(0L);
req.setSize(20L);
req.setAgentid(1111L);
req.setGroupId("xxx");
OapiWikiDocPublicListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/wiki/doc/public/list");
OapiWikiDocPublicListRequest req = new OapiWikiDocPublicListRequest();
req.Cursor = 0L;
req.Size = 20L;
req.Agentid = 1111L;
req.GroupId = "xxx";
OapiWikiDocPublicListResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiWikiDocPublicListRequest;
$req->setCursor("0");
$req->setSize("20");
$req->setAgentid("1111");
$req->setGroupId("xxx");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/wiki/doc/public/list");

curl -X POST "https://oapi.dingtalk.com/topapi/wiki/doc/public/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=25f31429-38d0-48ae-8ea1-90726d74fd15' \
-d 'agentid=1111' \
-d 'cursor=0' \
-d 'group_id=xxx' \
-d 'size=20'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiWikiDocPublicListRequest("https://oapi.dingtalk.com/topapi/wiki/doc/public/list")

req.cursor=0
req.size=20
req.agentid=1111
req.group_id="xxx"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.wiki.doc.public.list");
add_param(pRequest,"cursor","0");
add_param(pRequest,"size","20");
add_param(pRequest,"agentid","1111");
add_param(pRequest,"group_id","xxx");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.wiki.doc.public.list', {
	'cursor':'0',
	'size':'20',
	'agentid':'1111',
	'group_id':'xxx'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "next_cursor":0,
        "data":[
            {
                    "group_id":"L4BYma3gAj03zNA8",
                    "name":"专题研究",
                    "id":"L4BYmaRdORrDGNA8",
                    "latest_cp_url":"xxx",
                    "share_url":"xxx",
                    "repo_id":"xxx"
            }
        ],
        "has_more":false
    },
    "success":true,
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.wiki.doc.public.list (查询公开发布的知识页列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈