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

dingtalk.oapi.robot.message.statistics.listbyconversationid (conversionid维度的机器人消息批量推送统计数据获取接口)

ISV通过该接口可以获取conversationid维度的机器人消息批量推送统计数据

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
read_status	Boolean	可选	false		已读状态
push_id	String	必须	123		机器人消息推送Id
conversation_ids	String []	必须	123	最大列表长度：20	群Id列表
page_size	Number	必须	10		分页大小
page	Number	必须	1		当前页码

响应参数

名称	类型	描述
result	RobotMsgStatPageResponse	result
list MsgStatByCIdResVo [] list └ name String 张三成员名称 └ conversation_id String 123 群Id └ push_id String 123 机器人消息推送Id └ read_status Boolean 是否已读 └ dingtalk_id String 钉钉id pagination PaginationVo pagination └ total_record_num Number 100 总记录数 └ total_page Number 10 总页数 └ current_page Number 1 当前页数
success	Boolean	是否调用成功
errcode	Number	错误码
errmsg	String	错误值

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/robot/message/statistics/listbyconversationid");
OapiRobotMessageStatisticsListbyconversationidRequest req = new OapiRobotMessageStatisticsListbyconversationidRequest();
req.setReadStatus(false);
req.setPushId("123");
req.setConversationIds("123");
req.setPageSize(10L);
req.setPage(1L);
OapiRobotMessageStatisticsListbyconversationidResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/robot/message/statistics/listbyconversationid");
OapiRobotMessageStatisticsListbyconversationidRequest req = new OapiRobotMessageStatisticsListbyconversationidRequest();
req.ReadStatus = false;
req.PushId = "123";
req.ConversationIds = "123";
req.PageSize = 10L;
req.Page = 1L;
OapiRobotMessageStatisticsListbyconversationidResponse 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 OapiRobotMessageStatisticsListbyconversationidRequest;
$req->setReadStatus("false");
$req->setPushId("123");
$req->setConversationIds("123");
$req->setPageSize("10");
$req->setPage("1");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/robot/message/statistics/listbyconversationid");

curl -X POST "https://oapi.dingtalk.com/topapi/robot/message/statistics/listbyconversationid" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=fe02c919-2de1-461d-a327-521033ad0160' \
-d 'conversation_ids=123' \
-d 'page=1' \
-d 'page_size=10' \
-d 'push_id=123' \
-d 'read_status=false'

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

req=dingtalk.api.OapiRobotMessageStatisticsListbyconversationidRequest("https://oapi.dingtalk.com/topapi/robot/message/statistics/listbyconversationid")

req.read_status=false
req.push_id="123"
req.conversation_ids="123"
req.page_size=10
req.page=1
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.robot.message.statistics.listbyconversationid");
add_param(pRequest,"read_status","false");
add_param(pRequest,"push_id","123");
add_param(pRequest,"conversation_ids","123");
add_param(pRequest,"page_size","10");
add_param(pRequest,"page","1");
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.robot.message.statistics.listbyconversationid', {
	'read_status':'false',
	'push_id':'123',
	'conversation_ids':'123',
	'page_size':'10',
	'page':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "list":[
            {
                    "name":"张三",
                    "conversation_id":"123",
                    "push_id":"123",
                    "read_status":,
                    "dingtalk_id":""
            }
        ],
        "pagination":{
            "total_record_num":100,
            "total_page":10,
            "current_page":1
        }
    },
    "success":,
    "errcode":,
    "errmsg":""
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

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

联系方式

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

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

提交反馈

用户反馈

感谢您的反馈！

用户反馈

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

钉钉API

dingtalk.oapi.robot.message.statistics.listbyconversationid (conversionid维度的机器人消息批量推送统计数据获取接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈