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

dingtalk.oapi.wiki.doc.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	必须	111		应用agentId
repo_id	String	必须	xx		知识本ID（加密后的值）

响应参数

名称	类型	示例值	描述
result	OpenPageResult		返回结果
data OpenDocVO [] 知识页列表 └ group_id String xxx 知识库ID（加密后的） └ name String 专题研究知识页的名字 └ id String xxx 知识页ID（加密后的） └ repo_id String xxx 知识页所在知识本id（加密后的值） └ share_url String xxx 文档分享链接的url └ latest_cp_url String xxx 文档最近一次cp的url └ next_cursor Number 0 下一次分页的游标 └ has_more Boolean true 是否还有更多的数据
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/list");
OapiWikiDocListRequest req = new OapiWikiDocListRequest();
req.setCursor(0L);
req.setSize(20L);
req.setAgentid(111L);
req.setRepoId("xx");
OapiWikiDocListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

JSON示例

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

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.wiki.doc.list (查询组织内知识页列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ