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

dingtalk.oapi.material.news.list (查询消息卡片列表)

查询消息卡片素材列表

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
unionid	String	必须	jYdrJoCmTo0iE		服务号的unionid
page_start	Number	可选	1		页码，第几页，从1开始算
page_size	Number	可选	5	最小值：1 最大值：20	每页条数

响应参数

名称	类型	示例值	描述
errmsg	String	ok	错误信息
errcode	Number	0	错误码
total_count	Number	99	总记录数
item_count	Number	10	当前返回记录数
items	NewsCardDTO []		卡片列表
articles ArticleDTO [] 文章列表 └ article_id Number 120001 文章id └ title String 健康小提醒标题 └ thumb_media_id String dsa8d87y7c8d8c 封面图片的素材id └ publish_status Number 1 发布状态，0-未发布，1-已发布 └ publish_time Number 1442027997327 发布时间 └ user_view_count Number 1 已读用户数 └ total_view_count Number 12 阅读次数 └ create_time Number 1442027997327 创建时间 └ update_time Number 1442027997327 修改时间 └ url String https://content.dingtalk.com/article?articleId=1234 文章链接 └ content String <p>第一个段落</p> 文章内容 └ digest String 关于这篇文章... 摘要 └ update_time Number 1442027997327 消息卡片更新时间 └ media_id String dsa8d87y7c8d8c 消息卡片的素材id

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/material/news/list");
OapiMaterialNewsListRequest req = new OapiMaterialNewsListRequest();
req.setUnionid("jYdrJoCmTo0iE");
req.setPageStart(1L);
req.setPageSize(5L);
OapiMaterialNewsListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/material/news/list");
OapiMaterialNewsListRequest req = new OapiMaterialNewsListRequest();
req.Unionid = "jYdrJoCmTo0iE";
req.PageStart = 1L;
req.PageSize = 5L;
OapiMaterialNewsListResponse 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 OapiMaterialNewsListRequest;
$req->setUnionid("jYdrJoCmTo0iE");
$req->setPageStart("1");
$req->setPageSize("5");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/material/news/list");

curl -X POST "https://oapi.dingtalk.com/topapi/material/news/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=08f84999-f0b9-4026-9b0e-d7cb764327d0' \
-d 'page_size=5' \
-d 'page_start=1' \
-d 'unionid=jYdrJoCmTo0iE'

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

req=dingtalk.api.OapiMaterialNewsListRequest("https://oapi.dingtalk.com/topapi/material/news/list")

req.unionid="jYdrJoCmTo0iE"
req.page_start=1
req.page_size=5
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.material.news.list");
add_param(pRequest,"unionid","jYdrJoCmTo0iE");
add_param(pRequest,"page_start","1");
add_param(pRequest,"page_size","5");
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.material.news.list', {
	'unionid':'jYdrJoCmTo0iE',
	'page_start':'1',
	'page_size':'5'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errmsg":"ok",
    "errcode":0,
    "total_count":99,
    "item_count":10,
    "items":[
        {
                "articles":[
                    {
                            "article_id":120001,
                            "title":"健康小提醒",
                            "thumb_media_id":"dsa8d87y7c8d8c",
                            "publish_status":1,
                            "publish_time":1442027997327,
                            "user_view_count":1,
                            "total_view_count":12,
                            "create_time":1442027997327,
                            "update_time":1442027997327,
                            "url":"https:\/\/content.dingtalk.com\/article?articleId=1234",
                            "content":"<p>第一个段落<\/p>",
                            "digest":"关于这篇文章..."
                    }
                ],
                "update_time":1442027997327,
                "media_id":"dsa8d87y7c8d8c"
        }
    ]
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

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

联系方式

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

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

提交反馈

用户反馈

感谢您的反馈！

用户反馈

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

钉钉API

dingtalk.oapi.material.news.list (查询消息卡片列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈