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

dingtalk.oapi.live.playback (直播回放查询能力开放)

提供ISV开放回访获取能力：ISV通过该接口调用，根据直播的开始和结束时间，分页获取到所有的直播回放信息。

公共参数

环境	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	PlayBackReqModel	必须			回放查询请求model
└ start_time Date 可选 2019-03-22 11:31:06 直播开始时间 └ page_size Number 可选 100 直播结束时间 └ offset Number 可选 0 页面大小 └ end_time Date 可选 2019-03-22 11:31:06 偏移量

响应参数

名称	类型	示例值	描述
result	PlayBackRespModel		回放查询响应model
└ has_more Boolean true 是否还有 └ offset Number 0 偏移量 └ page_size Number 100 页面大小 └ all_count Number 150 结果总数 play_back_list PlayBackModel [] 分页查询结果 └ total_view_count Number 150 总共访问次数,PV └ total_join_count Number 100 总共参加人数,UV └ playback_url String http://aliliving.alicdn.com/live_hp/playbackUrl.m3u8 回放地址 └ time_length Number 50 直播时长 └ end_time Date 2019-03-22 11:31:06 直播结束时间 └ start_time Date 2019-03-22 11:31:06 直播开始时间 └ uuid String f7fa3a1d-7bc9-4497-b0df-c72361f354a9 直播UUID └ land_scape Boolean true 横竖屏: false 竖屏, true 横屏(默认) └ cover_url String https://static.dingtalk.com/media/coverUrl.png 封面图 └ shared Boolean true 直播可观看类型: false 受限制的直播, true 公开的直播(默认) └ intro String intro 简介 └ title String title 标题 └ user_nick String userNick 别名 └ userid String 158178 主播ID
errcode	Number	400001	错误码
errmsg	String	系统错误	错误描述

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/live/playback");
OapiLivePlaybackRequest req = new OapiLivePlaybackRequest();
PlayBackReqModel obj1 = new PlayBackReqModel();
obj1.setStartTime(StringUtils.parseDateTime("2019-03-22 11:31:06"));
obj1.setPageSize(100L);
obj1.setOffset(0L);
obj1.setEndTime(StringUtils.parseDateTime("2019-03-22 11:31:06"));
req.setRequest(obj1);
OapiLivePlaybackResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/live/playback");
OapiLivePlaybackRequest req = new OapiLivePlaybackRequest();
OapiLivePlaybackRequest.PlayBackReqModelDomain obj1 = new OapiLivePlaybackRequest.PlayBackReqModelDomain();
obj1.StartTime = DateTime.Parse(2019-03-22 11:31:06");
obj1.PageSize = 100L;
obj1.Offset = 0L;
obj1.EndTime = DateTime.Parse(2019-03-22 11:31:06");
req.Request_ = obj1;
OapiLivePlaybackResponse 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 OapiLivePlaybackRequest;
$request = new PlayBackReqModel;
$request->start_time="2019-03-22 11:31:06";
$request->page_size="100";
$request->offset="0";
$request->end_time="2019-03-22 11:31:06";
$req->setRequest($request);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/live/playback");

curl -X POST "https://oapi.dingtalk.com/topapi/live/playback" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2e2b8310-c914-44c0-842d-dd6076a4fa7e' \
-d 'request=null'

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

req=dingtalk.api.OapiLivePlaybackRequest("https://oapi.dingtalk.com/topapi/live/playback")

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.live.playback");
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.live.playback', {
	'request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "has_more":true,
        "offset":0,
        "page_size":100,
        "all_count":150,
        "play_back_list":[
            {
                    "total_view_count":150,
                    "total_join_count":100,
                    "playback_url":"http:\/\/aliliving.alicdn.com\/live_hp\/playbackUrl.m3u8",
                    "time_length":50,
                    "end_time":"2019-03-22 11:31:06",
                    "start_time":"2019-03-22 11:31:06",
                    "uuid":"f7fa3a1d-7bc9-4497-b0df-c72361f354a9",
                    "land_scape":true,
                    "cover_url":"https:\/\/static.dingtalk.com\/media\/coverUrl.png",
                    "shared":true,
                    "intro":"intro",
                    "title":"title",
                    "user_nick":"userNick",
                    "userid":"158178"
            }
        ]
    },
    "errcode":400001,
    "errmsg":"系统错误"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.live.playback (直播回放查询能力开放)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ