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

dingtalk.oapi.kac.datav.chat.summary.get (大客户聊天数据统计查询)

大客户钉钉数据：查询当前企业每天的聊天汇总数据

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
request	ImSummaryRequest	可选			请求对象
└ data_id String 必须 20200501 日期标识

响应参数

名称	类型	示例值	描述
errcode	Number	0	结果码
errmsg	String	成功	提示信息
result	ImSummaryResponse	result	结果对象
└ group_chat_user_count Number 10 群聊用户数 └ message_total_count Number 20 消息数 └ message_user_count Number 30 聊天用户数 └ chat_user_count Number 4 单聊用户数 └ group_count Number 100 总群数 └ new_group_count Number 100 新增群数（当日） └ active_group_count Number 2 活跃群数（当日） └ group_message_count Number 12 群聊消息数 └ single_message_count Number 30 单聊消息数 └ message_avg_count String 3.2 人均发送消息数 └ group_send_file_message_count String 3 发送群文件数（当日）

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/datav/chat/summary/get");
OapiKacDatavChatSummaryGetRequest req = new OapiKacDatavChatSummaryGetRequest();
ImSummaryRequest obj1 = new ImSummaryRequest();
obj1.setDataId("20200501");
req.setRequest(obj1);
OapiKacDatavChatSummaryGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/datav/chat/summary/get");
OapiKacDatavChatSummaryGetRequest req = new OapiKacDatavChatSummaryGetRequest();
OapiKacDatavChatSummaryGetRequest.ImSummaryRequestDomain obj1 = new OapiKacDatavChatSummaryGetRequest.ImSummaryRequestDomain();
obj1.DataId = "20200501";
req.Request_ = obj1;
OapiKacDatavChatSummaryGetResponse 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 OapiKacDatavChatSummaryGetRequest;
$request = new ImSummaryRequest;
$request->data_id="20200501";
$req->setRequest($request);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/kac/datav/chat/summary/get");

curl -X POST "https://oapi.dingtalk.com/topapi/kac/datav/chat/summary/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=0d543fd7-cf72-45ed-9d41-0b1b01a2b70a' \
-d 'request=null'

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

req=dingtalk.api.OapiKacDatavChatSummaryGetRequest("https://oapi.dingtalk.com/topapi/kac/datav/chat/summary/get")

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

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"成功",
    "result":{
        "group_chat_user_count":10,
        "message_total_count":20,
        "message_user_count":30,
        "chat_user_count":4,
        "group_count":100,
        "new_group_count":100,
        "active_group_count":2,
        "group_message_count":12,
        "single_message_count":30,
        "message_avg_count":"3.2",
        "group_send_file_message_count":"3"
    }
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.kac.datav.chat.summary.get (大客户聊天数据统计查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ