static.migucloud.comstatic.migucloud.com/imgcache/doc/咪咕视频云直播接口 … · Web...

咪咕云直播系统 API 接口文件状态：[] 草稿[√] 正式发布[]正在修改

文件编号：当前版本：

作者：完成日期：

修订历史版本作者参与评审方描述和总结完成日期

(YY-MM-DD)0.1.0 贺梓超起稿 2016-03-10

1.0.0 贺梓超修改部分接口说明和实例 2016-07-14

1.1.0 贺梓超增添直播拉流模式接口 2016-08-11

1.2.0 贺梓超增添截图功能接口 2016-08-16

2.0.0 贺梓超 Java版本直播后台 2016-12-01

目录1. 文档概述.....................................................................................................................................4

1.1. 阅读对象..........................................................................................................................41.2. 约定..................................................................................................................................41.3. 符号定义..........................................................................................................................4

2. 接口设计.....................................................................................................................................42.1. 直播管理..........................................................................................................................4

2.1.1. 创建直播..............................................................................................................42.1.2. 查询直播..............................................................................................................72.1.3. 修改直播............................................................................................................102.1.4. 删除直播............................................................................................................122.1.5. 关闭直播频道....................................................................................................132.1.6. 获取直播列表....................................................................................................142.1.7. 获取推流地址....................................................................................................182.1.8. 获取播放地址....................................................................................................202.1.9. 拉流模式开始直播............................................................................................212.1.10. 拉流模式停止直播..........................................................................................23

2.2. 直播录制管理................................................................................................................242.2.1. 直播录制列表....................................................................................................242.2.2. 直播录制删除....................................................................................................272.2.3. 导入云点播........................................................................................................28

2.3. nofity 通知.....................................................................................................................302.3.1. 注册接口............................................................................................................302.3.2. 注销接口............................................................................................................312.3.3. publish 通知接口...............................................................................................322.3.4. vod 通知接口.....................................................................................................33

2.4. 直播截图管理（暂未使用）........................................................................................342.4.1. 创建截图............................................................................................................342.4.2. 删除截图............................................................................................................362.4.3. 查看截图列表....................................................................................................37

2.5. 播放器管理....................................................................................................................382.5.1. 播放器设置........................................................................................................382.5.2. 播放器设置查询................................................................................................40

2.6. 播放页面管理................................................................................................................422.6.1. 播放页面设置....................................................................................................422.6.2. 播放页面设置查询............................................................................................43

2.7. 安全管理（暂未使用）................................................................................................452.7.1. 安全设置............................................................................................................452.7.2. 安全设置查询....................................................................................................46

3. 附录...........................................................................................................................................48

1. 文档概述1.1. 阅读对象

第三方业务服务器的开发人员1.2. 约定C: 客户端缩写S：服务端缩写…

所有接口均为 http+json 格式接口定义中所有键必须包含，值可以为空。1.3. 符号定义

序号符号缩写符号性质符号说明1 M 强制域(Mandatory) 此域必选，否则将被认为格式出

错2 C 条件域(Conditional) 此域在一定条件下必选3 O 选用域(Optional) 此域由发送方自选,表格项为空时

默认为选用域

2. 接口设计2.1. 直播管理2.1.1. 创建直播接口描述接口名称创建直播接口描述

接口使用者平台门户http 请求类型 Post

服务类 /l2/live/create_channel?uid=xx&token=xx

返回示例 { "ret": "0", "msg": "success", "result": { "channelId": 548588416 }}失败：{

"ret": 1,//参考附录 1 返回码及返回码描述"msg": "创建失败","result": {

},}

请求示例 {"startTime":"2016-12-1 00:00:00","endTime":"2017-12-1 00:00:00","title":"non","subject":"yeeep","description":"lllxxx","liveType":"push","ingestSrc":"","videoType":"","cameraNum":1,"record":0,"demand":0,"transcode":0,"timeShift":0,"playMode":0,"delayTime":0,"cdnType":0}

备注请求参数

字段名注释类型（长度）

可否为空备注uid 用户 ID string Mtoken 用户签权 string Mtitle 直播名称 string MstartTime 直播开始时间 string MendTime 直播结束时间 string Msubject 直播主题 string Mdescription 直播描述 string M

liveType 直播类型 String M 默认为推流直播“push”-推流直播“pull”-拉流直播

ingestSrc 拉流直播源 String C 仅当 live_type为 pull 时有效

imgUrl 直播封面 string O 若此参数为null，设置默认 url，默认封面

videoType 画质 string M 流畅-1，标清-2，高清-3，超清-4，若表示需要转高清和超清两路，则video_type=”3,4”

cameraNum 机位数 int M 默认值 11-4 机位选择(目前仅支持单机位)

record 是否录制 int M 是否录制0 否1 是

demand 是否导入云点播 int C 该字段仅在recorde_on=1下有效，0 否1 是

transcode 是否将转码结果导入点播

int C 该字段仅在demand_on=1下有效，0 否1 是

timeshift 是否支持时移 int C 是否支持时移0 否1 是

playMode 播放模式 int M 0-实时直播;1-延时直播

delayTime 延时时间 int C 该字段仅当play_mode=1 时有效,单位 min

lowDelay 是否开启低延时模式

int M 0-高缓存模式1-低延时模式

cdnType Cdn 类型 Int M 0-对接网宿 cdn1-对接咪咕 cdn2-对接 live-cdn默认为 0

应答参数


可否为空备注ret 状态码 string M 附录 1 返回码

及返回码描述msg 失败错误描述 string Oresult 输出结果集 Object O 请求成功或者

失败即使 result为空也需要返回一个空的结果集,前端需要

输出结果集参数项channelId 直播 id int M

2.1.2. 查询直播接口描述接口名称查询直播接口描述接口使用者平台门户http 请求类型 get

服务类 /l2/live/query_channel?uid=xx&token=xx

返回示例 { "ret": 0, "msg": "success", "result": { "id": xxx, "uid": "527", "randCode": "xxx", "imgUrl": null, "title": "tty",

"subject": "tty1", "description": "test", "startTime": 1480521600000, "endTime": 1512057600000, "liveType": "push", "ingestSrc": "", "ingestOptStatus": , "lowDelay": 0, "cameraNum": 1, "videoType": "0", "record": 0, "demand": 0, "transcode": 0, "timeShift": 0, "playMode": 0, "delayTime": 0, "illegal": 0, "status": 2, "lastPushTime": null, "liveTime": 0, "createTime": 1481176337000, "updateTime": null }}

失败：{

"ret": 1,//参考附录 1 返回码及返回码描述"msg": "修改失败","result":{}

}请求示例 http://test.migucloud.com/l2/live/query_channel?

uid=527&token=xxx&id=537210330备注请求参数


可否为空备注uid 用户 ID string Mtoken 用户签权 string Mid 直播 id int M

应答参数





输出结果集参数项title 直播名称 string MstartTime 直播开始时间 string M 为 unix 时间

戳，单位：毫秒

endTime 直播结束时间 string M 为 unix 时间戳，单位：毫秒

subject 直播主题 string Mdescription 直播描述 string OliveType 直播类型 String O 默认为推流直

播“push”-推流直播“pull”-拉流直播

ingestSrc 拉流直播源 String O 仅当 live_type为 pull 时有效

ingestOptStatus 拉流状态 Int M 仅当 live_type为 pull 时有效0-暂停1-直播中

imgUrl 直播封面 string MvideoType 画质 string M 流畅-1，

标清-2，高清-3，超清-4，若表示需要转高清和超清两路，则video_type=”3,4”

cameraNum 机位数 int M 1-4 机位选择record 是否录制 int M 是否录制

0 否、1 是

demand 是否导入云点播 int C 该字段仅在recorde_on=1下有效，0 否，1 是

transcode 是否转码 int C 该字段仅在demand_on=1下有效，0 否，1 是

timeshift 是否时移 int M 是否时移 0 否、1 是

playMode 播放模式 int M 0-实时直播;1-延时直播

delayTime 延时时间 int C 该字段仅当play_mode=1 时有效,单位 min




2.1.3. 修改直播接口描述接口名称修改直播接口描述接口使用者平台门户http 请求类型 Post

服务类 /l2/live/alter_channel?uid=xx&token=xx

返回示例成功：{"ret": 0,"msg": "成功",

"result": null}失败：{


}请求示例 {

"id":xxx,"startTime":"2016-12-1 00:00:00","endTime":"2017-12-1 00:00:00","title":"rec-test2","subject":"me1","description":"testqq-me","liveType":"push","ingestSrc":"","videoType":"","cameraNum":1,"record":1,"demand":0,"transcode":0,"timeShift":0,"playMode":0,"delayTime":0}

备注请求参数


可否为空备注uid 用户 id string Mtoken 用户签权 string Mid 频道 ID string Mchannel 直播名称 string OstartTime 直播开始时间 string OendTime 直播结束时间 string Osubject 直播主题 string Odescription 直播描述 string OliveType 直播类型 String O 默认为推流直


ingestSrc 拉流直播源 String O 仅当 live_type

为 pull 时有效imgUrl 直播封面 string OvideoType 画质 string O 流畅-1，

标清-2，高清-3，超清-4，若表示需要转高清和超清两路，则video_type=”3,4”

cameraNum 机位数 int O 1-4 机位选择recorde 是否录制 int O 是否录制 0

否、1 是demand 是否导入云点播 int O 该字段仅在

recorde_on=1下有效，0否，1 是

transcode 是否转码 int O 该字段仅在demand_on=1下有效，0否，1 是

timeshift 是否时移 int O 是否时移 0否、1 是

playMode 播放模式 int O 0-实时直播;1-延时直播

delayTime 延时时间 int O 该字段仅当play_mode=1 时有效,单位 min




应答参数



及返回码描述

msg 失败错误描述 string Oresult 输出结果集 object O 请求成功或者


2.1.4. 删除直播接口描述接口名称删除直播接口描述接口使用者平台门户http 请求类型 Post

服务类 /l2/live/delete_channel?uid=xx&token=xx

返回示例成功：{"ret": 0,"msg": "成功","result": null}失败：{


}请求示例 {

"id":"xxx"}

备注请求参数


可否为空备注uid 用户 id string Mtoken 用户签权 string Mid 频道 ID int M

应答参数



及返回码描述msg 失败错误描述 string Oresult 输出结果集 object O 请求成功或者


2.1.5. 关闭直播频道接口描述接口名称结束直播接口描述将用户强制下线并且关闭该直播频道，不允许再推流接口使用者平台门户http 请求类型 get

服务类 /l2/ctrl/kickoff?uid=xx&token=xx

返回示例成功：{ "ret": 0,

"result":{ }}失败：{

"ret": 1,//参考附录 1 返回码及返回码描述"msg": "修改失败","result":{

}}

请求示例 http://www.migucloud.com/l2/ctrl/kickoff?uid=527&token=xxx&channelId=xxx

备注

请求参数字段名注释类型（长

度）可否为空备注

uid 用户 id string Mtoken 用户签权 string MchannelId 用户 ID int M

应答参数



及返回码描述msg 失败错误描述 string Oresult 输出结果集 object O 请求成功或者


输出结果集参数项

2.1.6. 获取直播列表接口描述接口名称用户直播列表接口描述获取用户当前创建直播列表接口使用者平台门户http 请求类型 Get

服务类 /l2/live/query_channel_list?uid=527&token=xxx

返回示例成功：{ "ret": 0, "msg": "success", "result": { "total": 5, "offset": 0,

"limit": 2, "channelList": [ { "id": 260462029, "uid": "527", "randCode": "9E81DTC0", "imgUrl": null, "title": "rec-trans", "subject": "tty1", "description": "test", "startTime": 1480521600000, "endTime": 1512057600000, "liveType": "push", "ingestSrc": , "ingestOptStatus": , "lowDelay": 0, "cameraNum": 1, "videoType": "1,2", "record": 1, "demand": 0, "transcode": 0, "timeShift": 0, "playMode": 0, "delayTime": 0, "illegal": 0, "status": 2, "lastPushTime": null, "liveTime": 0, "createTime": 1481789951000, "updateTime": null }, { "id": 369837599, "uid": "527", "randCode": "OLGSQ37Y", "imgUrl": null, "title": "record-test1", "subject": "rec-test1", "description": "rec-test", "startTime": 1480521600000, "endTime": 1512057600000, "liveType": "push", "ingestSrc": "", "ingestOptStatus": , "lowDelay": 0, "cameraNum": 1, "videoType": "", "record": 1, "demand": 0, "transcode": 0, "timeShift": 0, "playMode": 0, "delayTime": 0, "illegal": 0,

"status": 2, "lastPushTime": null, "liveTime": 0, "createTime": 1481695075000, "updateTime": 1481696251000 } ] }}

失败：{

"ret": 1,//参考附录 1 返回码及返回码描述"msg": "","result": {

}}请求示例 http://test.migucloud.com/l2/live/query_channel_list?uid=527&token=xxx&offset=0&limit=2&liveType=push&title=xxx

备注请求参数


可否为空备注uid 用户 id string Mtoken Token string Mlimit 列表数量 int M 每次取列表

数，limit=-1 时取全部符合条件列表

offset 偏移量 int M 期望获取条目的起始位置。例如，offset=n，limit=m，则获取第 n+1条至第 n+m 条的信息。其中 limit 为上一行参数的值n 必须大于等于0

title 搜索条件 string O title=””或没有该字段时不搜

索直播名称或 id筛选

subject 直播主题 string O subject=””或没有该字段时返回所有主题

status 直播状态 int O 0 未开始，1 直播中，2 暂停，3 结束若没有该字段表示查询全部结果

liveType 直播类型 string O 当值为push-获取推流直播列表pull-获取拉流直播列表没有该字段-获取全部直播列表

应答参数字段名注释类型（长


ret 状态码 string M 附录 1 返回码及返回码描述

msg 失败错误描述 string Oresult 输出结果集 Object O 请求成功或者


输出结果集参数项total 用户直播总数 int Mlimit 列表数量 int M 每次获取的条

目数，limit=-1时取全部符合条件列表

offset 偏移量 int M 期望获取条目的起始位置。例

如，offset=n，limit=m，则获取第 n+1条至第 n+m 条的信息。其中 limit 为上一行参数的值n 必须大于等于0

id 直播 id int M title 直播名称 string M startTime 直播开始时间 string M 为 unix 时间

戳，单位：毫秒

endTime 直播结束时间 string M 为 unix 时间戳，单位：毫秒

subject 直播主题 string M description 直播描述 string O liveType 直播类型 String O 默认为推流直


status 播放状态 int M 0 未开始1 直播中2 暂停3 结束

ingestOptStatus 拉流状态 Int M 仅当 live_type为 pull 时有效0-暂停1-直播中

illegal 是否违规 int M 1 是，0 否2.1.7. 获取推流地址接口描述接口名称获取直播推流地址接口描述开始直播之前需要调用此接口以获取地址接口使用者平台门户

http 请求类型 Get

服务类 /l2/addr/get_push_addr?uid=527&token=xxx

返回示例成功：{ "msg": "success", "result": { "cameraList": [ { "camIndex": "C0", "status": 0, "url": "rtmp://117.131.17.14:1935/live/9E81DTC0_C0" } ], "channelId": 260462029, "uid": 527 }, "ret": 0}失败：{

"ret": 1,//参考附录 1 返回码及返回码描述"msg": "","result": {}

}请求示例 http://test.migucloud.com/l2/addr/get_push_addr?

uid=527&token=xxx&client_ip=1.1.1.1&channel_id=260462029备注请求参数


可否为空备注uid 用户 id string Mtoken Token string Mchannel_id 频道 id int Mclient_ip 推流用户的 ip 地

址String O 若该字段不存

在，则默认为上海用户



ret 是否成功 string M 附录 1 返回码



输出结果集参数项channelId 频道 id int Muid 用户 id string McameraList 机位列表 Array M status 机位状态 int M 0 未开始

1 直播中2 暂停3 结束

camIndex 机位编号 string M url 推流地址 string M

2.1.8. 获取播放地址接口描述接口名称直播预览接口描述接口使用者平台门户http 请求类型 Get

服务类 /l2/addr/get_pull_addr?uid=527&token=xxx

返回示例成功：{ "msg": "success", "result": { "cameraList": [ { "camIndex": "C0", "transcodeList": [ { "transIndex": "V0", "transType": "0", "urlFlv": "http://devlivepull.migucloud.com/live/OLGSQ37Y_C0.flv", "urlHls": "http://devlivepull.migucloud.com/live/OLGSQ37Y_C0/playlist.m3u8",

"urlRtmp": "rtmp://devlivepull.migucloud.com/live/OLGSQ37Y_C0" } ] } ], "channelId": 369837599, "uid": 527, "viewerNum": 0 }, "ret": 0}

失败：{


}请求示例 http://test.migucloud.com/l2/addr/get_pull_addr?

uid=527&token=xxx&client_ip=1.1.1.1&channel_id=369837599备注调用直播预览时，需要获取播放器设置请求参数


可否为空备注uid 用户 id string Mtoken Token string Mchannel_id 直播 ID int Mclient_ip 推流用户的 ip 地

址String O 若该字段不存

在，则默认为上海用户



ret 状态码 string M 附录 1 返回码及返回码描述


失败即使 result为空也需要返

回一个空的结果集,前端需要

输出结果集参数项channelId 直播 id int Muid 用户 id string McameraList 机位列表 array M camIndex 机位 id string M transcodeList 转码列表 array M transIndex 转码 id string M transType 转码类型 string M 与创建直播

时，videoType中类型对应

urlFlv flv观看地址 string M urlHls hls观看地址 String M urlRtmp Rtmp观看地址 String M

2.1.9. 拉流模式开始直播接口描述接口名称开始直播接口描述当直播频道处于拉流模式时，调用该接口开始拉流并分发，开始直播接口使用者平台门户http 请求类型 get

服务类 /l2/ingest/start?uid=527&token=xxx&channelId=xxx



}请求示例 http://www.migucloud.com/l2/ingest/start?

uid=2&token=2&channelId=xxx备注直播开始后可以获取相应的通知消息，具体见《咪咕视频云直播产品

notify 接口文档.docx》

请求参数字段名注释类型（长


uid 用户 id string Mtoken Token string MchannelId 频道 id int M



ret 是否成功 string M 附录 1 返回码及返回码描述



2.1.10.拉流模式停止直播接口描述接口名称开始直播接口描述当直播频道处于拉流模式时，调用该接口停止直播接口使用者平台门户http 请求类型 Get

服务类 /l2/ingest/stop?uid=527&token=xxx


"ret": 1,//参考附录 1 返回码及返回码描述

"msg": "","result": {}

}请求示例 http://www.migucloud.com/l2/ingest/stop?

uid=2&token=2&channelId=xxx备注直播结束后可以获取相应的通知消息，具体见《咪咕视频云直播产品

notify 接口文档.docx》请求参数


可否为空备注uid 用户 id string Mtoken Token string MchannelId 频道 id int M






2.2. 直播录制管理2.2.1. 直播录制列表接口描述接口名称直播录制列表接口描述接口使用者门户http 请求类型 post

服务类 /l2/record/query_record_list?uid=xxx&token=xxx

返回示例成功：{"ret": 0,"msg": "......","result": {"count": 2,"offset": 0,"limit": 10,"list": [{"vid": "4049XTQ7_C1.123.flv","uid": "196","channelId": "201610111629424951_xxx","title": "test","subject": "...","imgUrl": "http://test.migucloud.com/mod_live.html?ch_id=201610111629424951_xxx","recordStartTime": "2016-10-12T16:48:47+08:00","recordLength": 63,"status": 0,"vidVod": "","updateTime": "2016-10-12T16:48:47+08:00"},{"vid": "4049XTQ7_C1.1476261522820.flv","uid": "196","channelId": "201610111629424951_xxx","title": "test","subject": "...","imgUrl": "http://test.migucloud.com/mod_live.html?ch_id=201610111629424951_4049XTQ7","recordStartTime": "2016-10-12T16:48:47+08:00","recordLength": 5,"status": 0,

"vidVod": "","updateTime": "2016-10-12T16:48:47+08:00"}]}}

失败：{


//失败也需要返回一个空的结果集}

}请求域 {

“id”:1,“uid”:”123”,“vid”:”afadf32dfdfgkkgx490dne.flv”,“channelId”:5,“title”:”hello”,“subject”:”world”,“imgUrl”:””,“recordUrl”:”/mnt1/cloud/ afadf32dfdfgkkgx490dne.flv”,“recordStartTime”:”2016-12-21 15:00:00”,“recordStopTime”:”2016-12-21 15:00:30”,“recordLength”:30,“status”:0,“vidVod”:””,“updateTime”:” 2016-12-21 15:00:30”}

备注

请求参数字段含义类型必填备注

uid 用户 ID string Mtoken 用户签权 token string Mtitle 直播名称 O 对直播名称进行

模糊搜索order 按照录制时间进

行升序或者降序输出

O 1-升序0-降序

pageSize 每页记录条数 int M 每次取条目数pageNum 页数 int M 第一页值为 1

应答参数字段含义类型必填备注




输出结果集参数项id 唯一标识 int Muid 用户 id String Mvid 视频 id String M 已录制视频唯

一标识符channelId 频道 id string Msubject 主题 string Mtitle 标题 string MimgUrl 封面地址 string MrecordStartTime 录制起始时间 string MtimeLength 录制时长 string Mstatus 录制状态 string M 0 为已录制 1 导

入中 2已导入vidVod 点播系统中视频

idString M 若该视频导入

了云点播系统，则该字段表示点播系统中该视频的 id

2.2.2. 直播录制删除接口描述接口名称直播录制删除接口描述接口使用者门户

http 请求类型 post

服务类 /l2/record/delete_record?uid=xxx&token=xxx




}请求域 {

“uid”:””“token”:””“id”:””}

备注

请求参数

字段含义类型必填备注uid 用户 ID string Mtoken 用户签权 token string Mid 唯一标识 string M





2.2.3. 导入云点播接口描述接口名称点播管理接口描述接口使用者门户http 请求类型 post

服务类 /l2/record/upload_video?uid=xxx&token=xxx




}请求域 {

"id":"21","filename":"hzc.flv","category":"0","tips":"dsad","transcode":"1","videoType":"0,1,2,3,4","online":"1","uid":"196","token":"xxx"}

备注完成导入云点播后可以获取相应的通知消息，具体见《咪咕视频云直播产品 notify 接口文档.docx》


uid 用户 ID string Mtoken 用户签权 token string Mid 视频 id String M 视频记录 id

filename 导入点播后文件名

string M

category 分类 string Otips 标签 string O 若有多条标签，

则用逗号隔开，例如tips=”funny,sweet,hot”

transcode 是否开启转码 string M 0-否1-是

videoType 画质 string M 仅当 transcode =1 下有效原画-0，流畅-1，标清-2，高清-3，超清-4，若表示需要转高清和超清两路，则video_type=”3,4”

online 是否上线 string M 0-否1-是





2.3. nofity 通知2.3.1. 注册接口接口描述接口名称申请通知接口描述当某三方平台需要咪咕云平台提供推流或断流的 nofity 通知机制时，

需要调用该接口进行注册接口使用者第三方服务器->咪咕云平台http 请求类型 post

服务类 /l2/notify/reg?uid=xxx&token=xxx

返回示例成功：{

"ret": 0,"msg": 0

}失败：{

"ret": 1,"msg": "",

}请求域 {

"event":"dsad","url":"http://127.0.0.1:8080/test/reg"}

备注

请求参数

字段含义类型必填备注uid 该三方服务器对

应的 uidstring M

token 鉴权参数 String Mevent 触发该 nofity

的事件类型string M “publish”:表示当

直播流连接或断开的事件发生

时，触发通知；“vod”:当导入云点播事件发生

时，触发通知**注**

各 event 对应的通知消息内容见2.3.3~2.3.4小结

url 该 nofity的通知地址

String M


ret 是否成功 int M 附录 1 返回码及返回码描述

msg 失败错误描述 string O 仅当返回失败时才有该字段

2.3.2. 注销接口接口描述接口名称注销通知接口描述当某三方平台不再需要咪咕云平台提供推流的 nofity 通知机制时，需

要调用该接口进行注销接口使用者第三方服务器->咪咕云平台http 请求类型 post

服务类 /l2/notify/unreg?uid=xxx&token=xxx


"ret": 0,"msg": 0

}失败：{

"ret": 1,"msg": "",

}请求域 {

"event":"dsad"}

备注

请求参数

字段含义类型必填备注uid 该三方服务器对

应的 uidstring M

tokenevent 触发该 nofity

的事件类型string M “publish”:表示当

直播流连接或断开的事件发生

时，触发通知；“vod”:当导入云点播事件发生时，触发通知




2.3.3. publish 通知接口接口描述接口名称直播状态通知接口描述当某用户开始向流媒体或 CDN系统推流时，后台系统将根据注册信息

发起请求接口使用者咪咕云平台->第三方服务器http 请求类型 post

服务类注册时提供的 url返回示例成功：

{"ret": 0,"msg": 0

}

失败：{

"ret": 1,"msg": "",

}请求域 {

"channelId": ,"status": "",

}备注

请求参数

字段含义类型必填备注channelId 直播 id string Mstatus 直播状态 String M 0-未开始

1-直播中2-暂停3-结束




2.3.4. vod 通知接口接口描述接口名称导入点播状态通知接口描述当触发导入云点播流程时时，后台系统将根据注册信息发起请求接口使用者咪咕云平台->第三方服务器http 请求类型 post

服务类注册时提供的 url返回示例成功：

{"ret": 0,"msg": 0

}失败：{

"ret": 1,"msg": "",

}请求域 {

"retcode": , "msg": "", "vid": ,

"channelId": ,

}备注

请求参数

字段含义类型必填备注retcode 返回导入点播结

果int M 0-导入成功

非 0-导入失败msg 导入结果说明 string MchannelId 直播 id string Mvid 已录制视频 id String M




2.4. 直播截图管理（暂未使用）2.4.1. 创建截图接口描述接口名称创建截图接口描述接口使用者门户http 请求类型 post

服务类 /l2/record/create_snapshot?uid=xx&token=xxx


"ret": 0, "msg": 0,

"result": {"id": "xxx"

}}失败：{



}请求域 http://www.migucloud.com/l2/snapshot/create?

uid=xx&token=xxx&streamcode=xxxx&num=xxx&channel_id=xxxx备注

请求参数

字段含义类型必填备注uid 用户 ID string Mtoken 用户签权 token string Mstreamcode 待截图直播流的

直播码String M

num 截图张数 Int O 默认截图一张channel_id 频道 id String M





Id 截图图片 id String O

2.4.2. 删除截图接口描述接口名称删除截图接口描述接口使用者门户http 请求类型 post

服务类 /l2/record/delete_snapshot?uid=xx&token=xxx


"ret": 0, "msg": 0,

"result": {}}失败：{



}请求域 http://www.migucloud.com/l2/snapshot/delete?

uid=xx&token=xxx&id=xxxx备注

请求参数

字段含义类型必填备注uid 用户 ID string Mtoken 用户签权 token string MId 截图图片 id String M





2.4.3. 查看截图列表接口描述接口名称删除截图接口描述接口使用者门户http 请求类型 post

服务类 /l2/record/query_snapshot_list?uid=xx&token=xxx


"ret": 0, "msg": 0,

"result": [

{“id”:”xx”,”channel_id”:”xx”....},{“id”:”xx”,”channel_id”:”xx”....},{“id”:”xx”,”channel_id”:”xx”....},

...]

}

失败：{



}请求域 http://www.migucloud.com/l2/snapshot/query_snapshot_list?

uid=xx&token=xxx&channel_id=xxx&limit=5&offset=0备注

请求参数

字段含义类型必填备注uid 用户 ID string Mtoken 用户签权 token string MChannel_id 直播频道 id String O 查看某频道下的

截图，若没有该字段或该字段值为空，则查询整个用户下的截图信息

Limit 每页显示个数 Int Moffset 偏移量 Int MCondition_title 按照 title过滤

搜索string O condition_title=”

”或没有该字段时返回所有

Condition_subject 按照 subject过滤搜索

String O condition_subject=””或没有该字段时返回所有




失败即使 result

为空也需要返回一个空的结果集,前端需要

2.5. 播放器管理2.5.1. 播放器设置接口描述接口名称播放器管理接口描述接口使用者门户http 请求类型 Post

服务类 /l2/live/config_player?uid=196&token=xxx

返回示例成功：{"ret": 0,"msg": "成功","result": null}

失败：{



}请求域 {

"viewerNumOn":"0","shareOn":"0","logoOn":"0","logoUrl":"...","waterMarkOn":"1","waterMarkPostion":"0","waterMarkUrl":"...","uid":"196","token":"xxx"}

备注

请求参数

字段含义类型必填备注uid 用户 ID string Mtoken 用户签权 token string MviewerNumOn 启用人数 int M 默认启用

0-关闭，1-启用

shareOn 启用分享 int M 默认启用0-关闭，1-启用

logoOn 启用 logo int M 默认启用0-关闭，1-启用

logoUrl 上传 logo路径 string OwaterMarkOn 启用水印 int M 默认启用

0-关闭，1-启用

waterMarkPostion 水印位置 int O 0 为左上1 为右上2 为左下3 为右下

waterMarkUrl 水印上传路径 string O





2.5.2. 播放器设置查询接口描述接口名称播放器设置查询接口描述接口使用者门户http 请求类型 get

服务类 /l2/live/query_player

返回示例成功：{"ret": 0,"msg": "","result": {"Id": 1,"Uid": "196","ViewerNumOn": "1","ShareOn": "1","LogoOn": "1","LogoUrl": "http://www.migucloud.com/images/player/cklogo.png","WaterMarkOn": "1","WaterMarkPosition": "4","WaterMarkUrl": "http://www.migucloud.com/images/player/cklogo.png"}}失败：{



}请求域 http://www.migucloud.com/l2/live/query_player?

uid=196&token=xxx

备注

请求参数

字段含义类型必填备注uid 用户 ID string Mtoken 用户签权 token string M





输出结果集参数项ViewerNumOn 启用人数 int M 默认启用

0-关闭，1-启用

ShareOn 启用分享 int M 默认启用0-关闭，1-启用

LogoOn 启用 logo int M 默认启用0-关闭，1-启用

LogoUrl Logo地址 string MWaterMarkOn 启用水印 int M 默认启用

0-关闭，1-启用

WaterMarkUrl 水印地址 int MWaterMarkPosition 水印位置 string M 1 为左上

2 为右上3 为左下4 为右下

2.6. 播放页面管理2.6.1. 播放页面设置接口描述接口名称播放页面设置接口描述接口使用者门户http 请求类型 post

服务类 /l2/live/config_page




}请求域 {

"pageBackground":"http%3A%2F%2Fwww.migucloud.com%2Fimages%2Fplayer%2Fym_bg.jpg","playerTop":"22","playerLeft":"44","playerLenx":"520","playerLeny":"310","uid":"196","token":"xxx"}

备注

请求参数

字段含义类型必填备注

uid 用户 ID string Mtoken 用户签权 token string MpageBackground 设置播放器背景

urlstring M

playerTop 播放器顶部位置 int MplayerLeft 播放器左侧位置 int MplayerLenx 播放器宽 int MplayerLeny 播放器高 int M





2.6.2. 播放页面设置查询接口描述接口名称播放页面设置查询接口描述接口使用者门户http 请求类型 get

服务类 /l2/live/query_page返回示例成功：

{"ret": 0,"msg": "","result": {"Id": 1,"Uid": "196","PageBackground": "http%3A%2F%2Fwww.migucloud.com%2Fimages%2Fplayer%2Fym_bg.jpg","PlayerTop": "22","PlayerLeft": "44",

"PlayerLenx": "520","PlayerLeny": "310"}}失败：{



}请求域 http://www.migucloud.com/l2/live/query_page?

uid=196&token=xxx备注

请求参数

字段含义类型必填备注uid 用户 idtoken 鉴权应答参数

字段含义类型必填备注ret 是否成功 string M 附录 1 返回码



输出结果集参数项PageBackground 设置播放器背景

urlstring M

PlayerTop 播放器顶部位置 string MPlayerLeft 播放器左侧位置 string MPlayerLenx 播放器底部位置 string MPlayerLeny 播放器右侧位置 string M

2.7. 安全管理（暂未使用）2.7.1. 安全设置接口描述接口名称安全设置接口描述接口使用者门户http 请求类型 post

服务类 /l2/safety/config_safety


"ret": 0, "result": {

}}失败：{



}请求域 {

"uid":"3","token":"tokennnnn","domain_safety_mode":"1","domain_list":[{"domain":"www.hello.com"},{"domain":"www.world.com"}],"ip_safety_mode":"0","ip_list":[{"ip":"1.2.1.1"},{"ip":"1.2.1.2"}],"autitheft_on":"1","effective_time":"30","signature_key":"gl2728#"}

备注


uid 用户 ID string Mtoken 用户签权

tokenstring M

domain_safety_mode 播放域名限制类型

string M 0-黑名单模式1-白名单模式

domain_list 域名列表 array M domain 域名 string Mip_safety_mode 推流 ip限制类

型string M 0-黑名单模式

1-白名单模式ip_list ip列表 array M ip ip地址 string Mautitheft_on 是否开启防盗链 string M 0-关闭

1-开启effective_time 有效时间 string M 仅在

autitheft_on=1条件下有效，单位 min

signature_key 签名秘钥 striing M 仅在autitheft_on=1条件下有效



msg 失败错误描述 string O resultresult 输出结果集 object O 请求成功或者


2.7.2. 安全设置查询接口描述接口名称安全设置查询接口描述接口使用者门户http 请求类型 get

服务类 /l2/safety/query_safety


"ret": 0, "result": {“domain_safety_mode”:“domain_list”:[{“domain”:},{”domain”:},],“ip_safety_mode”:“ip_list”:[{“ip”:}{“ip”:}],“autitheft_on”:“effective_time”:“signature_key”:

}}失败：{



}请求域 http://www.migucloud.com/l2/safety/query_safety?uid=&token=

备注请求参数

字段含义类型必填备注uid 用户 ID string M

token 用户签权 token string M



msg 失败错误描述 string O resultresult 输出结果集 object O 请求成功或者


输出结果集参数项domain_safety_mode

播放域名限制类型

string M 0-黑名单模式1-白名单模式

domain_list 域名列表 array M domain 域名 string Mip_safety_mode 推流 ip限制类型 string M 0-黑名单模式

1-白名单模式ip_list ip列表 array M ip ip地址 string Mautitheft_on 是否开启防盗链 string M 0-关闭

1-开启effective_time 有效时间 string M 仅在

autitheft_on=1条件下有效，单位 min

signature_key 签名秘钥 striing M 仅在autitheft_on=1条件下有效

3. 附录返回码说明

返回码说明0 正确1 错误

static.migucloud.comstatic.migucloud.com/imgcache/doc/咪咕视频云直播接口 … · Web...

Documents

Transcript of static.migucloud.comstatic.migucloud.com/imgcache/doc/咪咕视频云直播接口 … · Web...