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

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

请求参数

名称	类型	是否必须	示例值	描述
cid	Number	必须	123456	群id
open_id	Number	可选	12345	用户id
to_time	Number	可选	1234567890	开始时间ms
from_time	Number	可选	1234599999	截止时间ms

响应参数

名称	类型	示例值	描述
result	Result []		返回列表
└ is_landscape Boolean 1 是否横屏 └ cid Number 1234456 群id └ live_uuid String 3ca3c2e4-258a-4808-94eb-a17ddceb7a2a 直播id └ open_id Number 149777 openid └ title String 直播测试标题 └ start_time Number 1234567890 开始时间ms └ duration Number 2000000 时长
errcode	Number	1	错误码
errmsg	String	直播不存在	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/live/grouplive/list");
OapiLiveGroupliveListRequest req = new OapiLiveGroupliveListRequest();
req.setCid(123456L);
req.setOpenId(12345L);
req.setToTime(1234567890L);
req.setFromTime(1234599999L);
OapiLiveGroupliveListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/live/grouplive/list");
OapiLiveGroupliveListRequest req = new OapiLiveGroupliveListRequest();
req.Cid = 123456L;
req.OpenId = 12345L;
req.ToTime = 1234567890L;
req.FromTime = 1234599999L;
OapiLiveGroupliveListResponse 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 OapiLiveGroupliveListRequest;
$req->setCid("123456");
$req->setOpenId("12345");
$req->setToTime("1234567890");
$req->setFromTime("1234599999");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/live/grouplive/list");

curl -X POST "https://oapi.dingtalk.com/topapi/live/grouplive/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=bfab0c0f-968f-4857-83b4-edfa4c68893e' \
-d 'cid=123456' \
-d 'from_time=1234599999' \
-d 'open_id=12345' \
-d 'to_time=1234567890'

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

req=dingtalk.api.OapiLiveGroupliveListRequest("https://oapi.dingtalk.com/topapi/live/grouplive/list")

req.cid=123456
req.open_id=12345
req.to_time=1234567890
req.from_time=1234599999
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.list");
add_param(pRequest,"cid","123456");
add_param(pRequest,"open_id","12345");
add_param(pRequest,"to_time","1234567890");
add_param(pRequest,"from_time","1234599999");
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.list', {
	'cid':'123456',
	'open_id':'12345',
	'to_time':'1234567890',
	'from_time':'1234599999'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":[
        {
                "is_landscape":1,
                "cid":1234456,
                "live_uuid":"3ca3c2e4-258a-4808-94eb-a17ddceb7a2a",
                "open_id":149777,
                "title":"直播测试",
                "start_time":1234567890,
                "duration":2000000
        }
    ],
    "errcode":1,
    "errmsg":"直播不存在"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.live.grouplive.list (查询内部群直播的列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ