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

dingtalk.oapi.blackboard.listids (获取未删除公告Id列表)

通过接口可以获取到企业未删除的钉钉公告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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
query_request	OapiBlackboardQueryVo	可选			请求入参
└ operation_userid String 必须 manager01 操作人userId(必须是公告管理员) └ page_size Number 必须 10 分页大小，必须为正整数，且不超过30 └ start_time Date 可选 2019-10-07 10:10:10 开始时间(闭区间） └ end_time Date 可选 2019-11-07 10:10:10 结束时间(开区间） └ page Number 必须 1 页码，从1开始且必须为正整数 └ category_id String 可选 9i9u7y7g6t65 分类id，可以通过https://oapi.dingtalk.com/blackboard/category/get获取有效值

响应参数

名称	类型	示例值	描述
result	String []		success为true时，返回公告id列表。否则值为空
success	Boolean	false	本次调用是否成功，该值为false时，根据errcode和errMsg排查失败原因
errcode	Number	400001	请求失败的错误码
errmsg	String	系统错误	请求失败的错误原因

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/blackboard/listids");
OapiBlackboardListidsRequest req = new OapiBlackboardListidsRequest();
OapiBlackboardQueryVo obj1 = new OapiBlackboardQueryVo();
obj1.setOperationUserid("manager01");
obj1.setPageSize(10L);
obj1.setStartTime(StringUtils.parseDateTime("2019-10-07 10:10:10"));
obj1.setEndTime(StringUtils.parseDateTime("2019-11-07 10:10:10"));
obj1.setPage(1L);
obj1.setCategoryId("9i9u7y7g6t65");
req.setQueryRequest(obj1);
OapiBlackboardListidsResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/blackboard/listids");
OapiBlackboardListidsRequest req = new OapiBlackboardListidsRequest();
OapiBlackboardListidsRequest.OapiBlackboardQueryVoDomain obj1 = new OapiBlackboardListidsRequest.OapiBlackboardQueryVoDomain();
obj1.OperationUserid = "manager01";
obj1.PageSize = 10L;
obj1.StartTime = DateTime.Parse(2019-10-07 10:10:10");
obj1.EndTime = DateTime.Parse(2019-11-07 10:10:10");
obj1.Page = 1L;
obj1.CategoryId = "9i9u7y7g6t65";
req.QueryRequest_ = obj1;
OapiBlackboardListidsResponse 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 OapiBlackboardListidsRequest;
$query_request = new OapiBlackboardQueryVo;
$query_request->operation_userid="manager01";
$query_request->page_size="10";
$query_request->start_time="2019-10-07 10:10:10";
$query_request->end_time="2019-11-07 10:10:10";
$query_request->page="1";
$query_request->category_id="9i9u7y7g6t65";
$req->setQueryRequest($query_request);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/blackboard/listids");

curl -X POST "https://oapi.dingtalk.com/topapi/blackboard/listids" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d7ed1254-bf45-4ec5-8d56-1bedd75e4680' \
-d 'query_request=null'

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

req=dingtalk.api.OapiBlackboardListidsRequest("https://oapi.dingtalk.com/topapi/blackboard/listids")

req.query_request=""
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.listids");
add_param(pRequest,"query_request","数据结构JSON示例");
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.listids', {
	'query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "string":[
            ""
        ]
    },
    "success":false,
    "errcode":400001,
    "errmsg":"系统错误"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.blackboard.listids (获取未删除公告Id列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ