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

dingtalk.oapi.kac.openlive.record.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。

请求参数

名称	类型	是否必须	示例值	描述
page_start	Number	必须	1	第几页，从1开始
page_size	Number	必须	100	分页大小，小于等于100
begin_time	Number	可选	12300000	查询时间范围开始时间戳
end_time	Number	可选	12400000	查询时间范围结束时间戳
author_user_id	String	必须	abcdxxx	员工id
status	String	可选	init	直播状态：init: 未开播, living: 直播中，end: 直播已结束, null或空: 全体

响应参数

名称	类型	示例值	描述
result	ResultList	result	结果集合
└ total_cnt Number 100 直播总数 values ListOpenLiveRecordRspModel [] 无集合子对象 └ live_link String https://dt.live.com/xxx 直播观看链接 └ status String init 直播状态：init: 未开播, living: 直播中，end: 直播已结束 └ start_time Number 1230000 预约开始时间戳 └ title String 直播测试直播标题 └ live_id String xxx 直播ID └ public_type Number 0 公开类型 0: 不公开; 1: 完全公开; 2:组织内公开
success	Boolean	true	是否调用成功
errcode	Number	400002	错误代码
errmsg	String	参数错误	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/openlive/record/list");
OapiKacOpenliveRecordListRequest req = new OapiKacOpenliveRecordListRequest();
req.setPageStart(1L);
req.setPageSize(100L);
req.setBeginTime(12300000L);
req.setEndTime(12400000L);
req.setAuthorUserId("abcdxxx");
req.setStatus("init");
OapiKacOpenliveRecordListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/openlive/record/list");
OapiKacOpenliveRecordListRequest req = new OapiKacOpenliveRecordListRequest();
req.PageStart = 1L;
req.PageSize = 100L;
req.BeginTime = 12300000L;
req.EndTime = 12400000L;
req.AuthorUserId = "abcdxxx";
req.Status = "init";
OapiKacOpenliveRecordListResponse 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 OapiKacOpenliveRecordListRequest;
$req->setPageStart("1");
$req->setPageSize("100");
$req->setBeginTime("12300000");
$req->setEndTime("12400000");
$req->setAuthorUserId("abcdxxx");
$req->setStatus("init");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/kac/openlive/record/list");

curl -X POST "https://oapi.dingtalk.com/topapi/kac/openlive/record/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=0216d420-5489-4cbf-9bdd-cf5ec5d06dbb' \
-d 'author_user_id=abcdxxx' \
-d 'begin_time=12300000' \
-d 'end_time=12400000' \
-d 'page_size=100' \
-d 'page_start=1' \
-d 'status=init'

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

req=dingtalk.api.OapiKacOpenliveRecordListRequest("https://oapi.dingtalk.com/topapi/kac/openlive/record/list")

req.page_start=1
req.page_size=100
req.begin_time=12300000
req.end_time=12400000
req.author_user_id="abcdxxx"
req.status="init"
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.openlive.record.list");
add_param(pRequest,"page_start","1");
add_param(pRequest,"page_size","100");
add_param(pRequest,"begin_time","12300000");
add_param(pRequest,"end_time","12400000");
add_param(pRequest,"author_user_id","abcdxxx");
add_param(pRequest,"status","init");
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.openlive.record.list', {
	'page_start':'1',
	'page_size':'100',
	'begin_time':'12300000',
	'end_time':'12400000',
	'author_user_id':'abcdxxx',
	'status':'init'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "total_cnt":100,
        "values":[
            {
                    "live_link":"https:\/\/dt.live.com\/xxx",
                    "status":"init",
                    "start_time":1230000,
                    "title":"直播测试",
                    "live_id":"xxx",
                    "public_type":0
            }
        ]
    },
    "success":true,
    "errcode":400002,
    "errmsg":"参数错误"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.kac.openlive.record.list (查询组织内公开直播列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ