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

dingtalk.oapi.live.create (直播创建能力开放)

提供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	CreateLiveReqModel	必须			直播创建请求model
└ userid String 必须 157187 主播ID,必填 └ user_nick String 可选 userNick 别名,选填 └ title String 必须 title 标题,必填 └ intro String 可选 intro 简介,选填 └ shared Boolean 可选 true 直播可观看类型类型,必填: false 受限制的直播, true 公开的直播(默认) └ cover_url String 可选 https://static.dingtalk.com/media/coverUrl.png 封面图,选填: 如果不填写, 则采用默认 └ land_scape Boolean 可选 true 横竖屏,选填: false 竖屏, true 横屏(默认) └ appt_begin_time Date 可选 2019-03-07 11:31:06 直播计划开始时间,选填: 如果不填写, 则取当前时间 └ appt_end_time Date 可选 2019-03-07 11:31:06 直播计划结束时间,选填 └ pre_video_play_url String 可选 http://aliliving.alicdn.com/live_hp/preVideoPlayUrl.m3u8 预告视频Url,选填

响应参数

名称	类型	示例值	描述
result	CreateLiveRespModel		直播创建响应model
└ playback_url String http://aliliving.alicdn.com/live_hp/preVideoPlayUrl.m3u8 直播回放地址 └ live_url_hls String http://alilive.alicdn.com/live_hp/liveUrlHls.m3u8 原始HLS直播地址 live_url_ext LiveUrlExtModel 转码直播地址 └ live_url_high String http://alilive.alicdn.com/live_hp/liveUrlHigh-180p-hp.flv 播放地址flv,超清-720p └ live_url_normal String http://alilive.alicdn.com/live_hp/liveUrlNormal-180p-hp.flv 播放地址flv,高清-480p └ live_url_low String http://alilive.alicdn.com/live_hp/liveUrlLow-180p-hp.flv 播放地址flv,标清-360p └ live_url_very_low String http://alilive.alicdn.com/live_hp/liveUrlVeryLow-180p-hp.flv 播放地址flv,流畅 └ live_url_ultra_low String http://alilive.alicdn.com/live_hp/liveUrlUltraLow-180p-hp.flv 播放地址flv,极速 └ live_url String http://alilive.alicdn.com/live_hp/liveUrl.flv 原始直播地址 └ input_stream_url String rtmp://alilive-push.alicdn.com/live_hp/inputStreamUrl 推流地址 └ appointment_time Date 2019-03-22 11:31:06 预约直播时间 └ uuid String 41d2088c-9d73-4db9-9b2b-be50704dc4fe 直播UUID
errcode	Number	400001	错误码
errmsg	String	系统错误	错误描述

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/live/create");
OapiLiveCreateRequest req = new OapiLiveCreateRequest();
CreateLiveReqModel obj1 = new CreateLiveReqModel();
obj1.setUserid("157187");
obj1.setUserNick("userNick");
obj1.setTitle("title");
obj1.setIntro("intro");
obj1.setShared(true);
obj1.setCoverUrl("https://static.dingtalk.com/media/coverUrl.png");
obj1.setLandScape(true);
obj1.setApptBeginTime(StringUtils.parseDateTime("2019-03-07 11:31:06"));
obj1.setApptEndTime(StringUtils.parseDateTime("2019-03-07 11:31:06"));
obj1.setPreVideoPlayUrl("http://aliliving.alicdn.com/live_hp/preVideoPlayUrl.m3u8");
req.setRequest(obj1);
OapiLiveCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/live/create");
OapiLiveCreateRequest req = new OapiLiveCreateRequest();
OapiLiveCreateRequest.CreateLiveReqModelDomain obj1 = new OapiLiveCreateRequest.CreateLiveReqModelDomain();
obj1.Userid = "157187";
obj1.UserNick = "userNick";
obj1.Title = "title";
obj1.Intro = "intro";
obj1.Shared = true;
obj1.CoverUrl = "https://static.dingtalk.com/media/coverUrl.png";
obj1.LandScape = true;
obj1.ApptBeginTime = DateTime.Parse(2019-03-07 11:31:06");
obj1.ApptEndTime = DateTime.Parse(2019-03-07 11:31:06");
obj1.PreVideoPlayUrl = "http://aliliving.alicdn.com/live_hp/preVideoPlayUrl.m3u8";
req.Request_ = obj1;
OapiLiveCreateResponse 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 OapiLiveCreateRequest;
$request = new CreateLiveReqModel;
$request->userid="157187";
$request->user_nick="userNick";
$request->title="title";
$request->intro="intro";
$request->shared="true";
$request->cover_url="https://static.dingtalk.com/media/coverUrl.png";
$request->land_scape="true";
$request->appt_begin_time="2019-03-07 11:31:06";
$request->appt_end_time="2019-03-07 11:31:06";
$request->pre_video_play_url="http://aliliving.alicdn.com/live_hp/preVideoPlayUrl.m3u8";
$req->setRequest($request);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/live/create");

curl -X POST "https://oapi.dingtalk.com/topapi/live/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=c0c9ed7a-6b9f-41e2-8af8-5a592dc8c6ef' \
-d 'request=null'

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

req=dingtalk.api.OapiLiveCreateRequest("https://oapi.dingtalk.com/topapi/live/create")

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

响应示例

JSON示例

{
    "result":{
        "playback_url":"http:\/\/aliliving.alicdn.com\/live_hp\/preVideoPlayUrl.m3u8",
        "live_url_hls":"http:\/\/alilive.alicdn.com\/live_hp\/liveUrlHls.m3u8",
        "live_url_ext":{
            "live_url_high":"http:\/\/alilive.alicdn.com\/live_hp\/liveUrlHigh-180p-hp.flv",
            "live_url_normal":"http:\/\/alilive.alicdn.com\/live_hp\/liveUrlNormal-180p-hp.flv",
            "live_url_low":"http:\/\/alilive.alicdn.com\/live_hp\/liveUrlLow-180p-hp.flv",
            "live_url_very_low":"http:\/\/alilive.alicdn.com\/live_hp\/liveUrlVeryLow-180p-hp.flv",
            "live_url_ultra_low":"http:\/\/alilive.alicdn.com\/live_hp\/liveUrlUltraLow-180p-hp.flv"
        },
        "live_url":"http:\/\/alilive.alicdn.com\/live_hp\/liveUrl.flv",
        "input_stream_url":"rtmp:\/\/alilive-push.alicdn.com\/live_hp\/inputStreamUrl",
        "appointment_time":"2019-03-22 11:31:06",
        "uuid":"41d2088c-9d73-4db9-9b2b-be50704dc4fe"
    },
    "errcode":400001,
    "errmsg":"系统错误"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.live.create (直播创建能力开放)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ