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

dingtalk.oapi.live.grouplive.detail.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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
req	GroupLiveStatisticsReq	必须			群直播详情请求
└ live_uuid String 必须 53b20173-c0c9-4d35-9dbd-869f2cbb43d8 群直播id └ dept_id Number 必须 123456 直播所属群对应部门id

响应参数

名称	类型	示例值	描述
result	GroupLiveStatistics	{}	直播详情
group_live_viewers Groupliveviewers [] 查看人员列表 └ play_record_duration Number 10 回放观看时长 └ play_duration Number 10 直播观看时长 └ userid String userId123 观看用户userid └ live_share_url String https://h5.dingtalk.com/group-live-share/index.htm?encCid=25a56bce1751980054b64ef102a5841e&liveUuid=53b20173-c0c9-4d35-9dbd-869f2cbb43d8#/ 群直播分享url └ unviewed_count Number 12 未看人数 └ viewer_count Number 11 已看人数 └ message_count Number 10 消息数 └ praise_count Number 99 点赞数 └ pv Number 10 直播观看人次
errmsg	String	ok	错误描述
errcode	Number	0	错误码

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/live/grouplive/detail/get");
OapiLiveGroupliveDetailGetRequest req = new OapiLiveGroupliveDetailGetRequest();
GroupLiveStatisticsReq obj1 = new GroupLiveStatisticsReq();
obj1.setLiveUuid("53b20173-c0c9-4d35-9dbd-869f2cbb43d8");
obj1.setDeptId(123456L);
req.setReq(obj1);
OapiLiveGroupliveDetailGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/live/grouplive/detail/get");
OapiLiveGroupliveDetailGetRequest req = new OapiLiveGroupliveDetailGetRequest();
OapiLiveGroupliveDetailGetRequest.GroupLiveStatisticsReqDomain obj1 = new OapiLiveGroupliveDetailGetRequest.GroupLiveStatisticsReqDomain();
obj1.LiveUuid = "53b20173-c0c9-4d35-9dbd-869f2cbb43d8";
obj1.DeptId = 123456L;
req.Req_ = obj1;
OapiLiveGroupliveDetailGetResponse 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 OapiLiveGroupliveDetailGetRequest;
$req = new GroupLiveStatisticsReq;
$req->live_uuid="53b20173-c0c9-4d35-9dbd-869f2cbb43d8";
$req->dept_id="123456";
$req->setReq($req);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/live/grouplive/detail/get");

curl -X POST "https://oapi.dingtalk.com/topapi/live/grouplive/detail/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=42f7bbce-5512-48ce-93e0-6be0fe8d4cb2' \
-d 'req=null'

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

req=dingtalk.api.OapiLiveGroupliveDetailGetRequest("https://oapi.dingtalk.com/topapi/live/grouplive/detail/get")

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

响应示例

JSON示例

{
    "result":{
        "group_live_viewers":[
            {
                    "play_record_duration":10,
                    "play_duration":10,
                    "userid":"userId123"
            }
        ],
        "live_share_url":"https:\/\/h5.dingtalk.com\/group-live-share\/index.htm?encCid=25a56bce1751980054b64ef102a5841e&liveUuid=53b20173-c0c9-4d35-9dbd-869f2cbb43d8#\/",
        "unviewed_count":12,
        "viewer_count":11,
        "message_count":10,
        "praise_count":99,
        "pv":10
    },
    "errmsg":"ok",
    "errcode":0
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.live.grouplive.detail.get (查询群直播详情信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ