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

dingtalk.oapi.chat.getReadList (查询群消息已读人员列表)

查询群消息已读人员列表

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
messageId	String	可选	111	发送群消息接口返回的加密消息id
cursor	Number	可选	0	分页查询的游标，第一次可以传0，后续传返回结果中的next_cursor的值。当返回结果中，没有next_cursor时，表示没有后续的数据了，可以结束调用
size	Number	可选	10	分页查询的大小，最大可以传100

响应参数

名称	类型	示例值	描述
next_cursor	Number	0	next_cursor
readUserIdList	String []		readUserIdList
errmsg	String	ok	errmsg
errcode	Number	0	errcode

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/chat/getReadList");
OapiChatGetReadListRequest req = new OapiChatGetReadListRequest();
req.setMessageId("111");
req.setCursor(0L);
req.setSize(10L);
req.setHttpMethod("GET");
OapiChatGetReadListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/chat/getReadList");
OapiChatGetReadListRequest req = new OapiChatGetReadListRequest();
req.MessageId = "111";
req.Cursor = 0L;
req.Size = 10L;
req.SetHttpMethod("GET");
OapiChatGetReadListResponse 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_GET , DingTalkConstant::$FORMAT_JSON);
$req = new OapiChatGetReadListRequest;
$req->setMessageId("111");
$req->setCursor("0");
$req->setSize("10");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/chat/getReadList");

curl -X GET "https://oapi.dingtalk.com/chat/getReadList" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=4a2e4d29-cbcf-4e40-baff-d3575dc632c5' \
-d 'cursor=0' \
-d 'messageId=111' \
-d 'size=10'

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

req=dingtalk.api.OapiChatGetReadListRequest("https://oapi.dingtalk.com/chat/getReadList")

req.messageId="111"
req.cursor=0
req.size=10
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.chat.getReadList");
add_param(pRequest,"messageId","111");
add_param(pRequest,"cursor","0");
add_param(pRequest,"size","10");
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.chat.getReadList', {
	'messageId':'111',
	'cursor':'0',
	'size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "next_cursor":0,
    "readUserIdList":{
        "string":[
            ""
        ]
    },
    "errmsg":"ok",
    "errcode":0
}

异常示例

JSON示例

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.chat.getReadList (查询群消息已读人员列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ