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

dingtalk.oapi.blackboard.listtopten (列出用户的公告列表)

列出用户当前有权限看到的10条公告，可用于在企业自定义工作首页进行公告轮播展示

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
userid	String	必须	manager01		用户id
categoryId	String	可选	2645cae53a1b2e8139b		公告分类id

响应参数

名称	类型	示例值	描述
errcode	Number	0	errcode
errmsg	String	ok	errmsg
blackboard_list	OapiBlackboardVo []		result
└ gmt_create Date 1497249913000 创建时间 └ title String 标题标题 └ url String https://app.dingtalk.com/blackboard/h5/listNotice?dd_nav_bgcolor=FF5E97F6&showmenu={0}&dd_progress=false&dd_share={1}&ddfrom={2}&logkey={3}&corpid={4}#/detail/{5} 跳转URL。参数解释：{2}：公告来源；{4}：企业corpId；{5}：公告id └ categoryId String 576920db 分类id └ id String a3071449 公告id └ categoryName String 企业文化分类名称 └ privateLevel Number 20 公告保密等级。0为非保密，20为保密 └ isPushTop Number 0 置顶公告标识。0为非置顶，1为置顶

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/blackboard/listtopten");
OapiBlackboardListtoptenRequest req = new OapiBlackboardListtoptenRequest();
req.setUserid("manager01");
req.setCategoryId("2645cae53a1b2e8139b");
OapiBlackboardListtoptenResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/blackboard/listtopten");
OapiBlackboardListtoptenRequest req = new OapiBlackboardListtoptenRequest();
req.Userid = "manager01";
req.CategoryId = "2645cae53a1b2e8139b";
OapiBlackboardListtoptenResponse 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 OapiBlackboardListtoptenRequest;
$req->setUserid("manager01");
$req->setCategoryId("2645cae53a1b2e8139b");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/blackboard/listtopten");

curl -X POST "https://oapi.dingtalk.com/topapi/blackboard/listtopten" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d0fb301e-a7e4-4a81-a12d-e30e1a601b60' \
-d 'categoryId=2645cae53a1b2e8139b' \
-d 'userid=manager01'

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

req=dingtalk.api.OapiBlackboardListtoptenRequest("https://oapi.dingtalk.com/topapi/blackboard/listtopten")

req.userid="manager01"
req.categoryId="2645cae53a1b2e8139b"
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.blackboard.listtopten");
add_param(pRequest,"userid","manager01");
add_param(pRequest,"categoryId","2645cae53a1b2e8139b");
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.blackboard.listtopten', {
	'userid':'manager01',
	'categoryId':'2645cae53a1b2e8139b'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"ok",
    "blackboard_list":[
        {
                "gmt_create":"1497249913000",
                "title":"标题",
                "url":"https:\/\/app.dingtalk.com\/blackboard\/h5\/listNotice?dd_nav_bgcolor=FF5E97F6&showmenu={0}&dd_progress=false&dd_share={1}&ddfrom={2}&logkey={3}&corpid={4}#\/detail\/{5}",
                "categoryId":"576920db",
                "id":"a3071449",
                "categoryName":"企业文化",
                "privateLevel":20,
                "isPushTop":0
        }
    ]
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案
isp.-1

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.blackboard.listtopten (列出用户的公告列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ