暴风云API接口文档112

1、暴风云API接口文档1. 点播1.1.点播发布状态查询域名：协议：HTTP POST请求包POST /query HTTP/1.1Host: Content-Type: application/jsonContent-Length: 1234"token":"RzcS42tk1jLuoY4KdSH5XwcHKvYjb-SC9aGhakBH:EmZts8IUJhyGD1LSdFAOqF/g458=:eyJmaWxlbmFtZSI6IjkubXA0IiwiZmlsZWtleSI6IiIsInNlcnZpY2V0eXBlIjoxfQ="token内容包含：fi

2、lename='abc.mp4' /文件名filekey='tom' /文件防重名加扰，可以为空servicetype=0 /1是点播服务，0是视频云托管服务应答包：HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 124Cache-Control: no-storeConnection: close"status":0,"fileid":"7A3526BEBD2A3063E2F4DCD852A34033","servic

3、etype":1,"filename":"9.mp4","showname":"9.mp4","filekey":"","filesize":202853188,"duration":3903226,"uploadtime":"2015-12-09 23:09:02","publishtime":"2015-12-10 00:10:57",&quo

4、t;ifpublic":1,"url":"servicetype=1&uid=5294383&fid=7A3526BEBD2A3063E2F4DCD852A34033"返回码为:* 0：操作成功* 90：网络错误* 99：系统错误* 101：文件已成功发布完成* 102：文件上传中* 103：文件转码中* 104：用户未购买对应服务* 105：用户空间不足* 106：用户已被禁* 107：用户余额不足* 131：用户请求不支持* 132：非法用户* 133：校验错误* 134：用户请求无法解析或缺少字段* 135：文件格式不支持

5、* 136：文件长度超长* 137：请求时间戳过期* 138：文件不存在* 200：发布中* 210：上传成功* 211：转码成功* 212：审核通过* 214：CDN发布成功* 220：上传失败* 221：转码失败* 222：审核不通过* 224：CDN发布失败* 230：超时失败1.2.视频删除接口域名：协议：HTTP POST请求包POST /delete HTTP/1.1Host: Content-Type: application/jsonContent-Length: 1234"token":"RzcS42tk1jLuoY4KdSH5XwcH

6、KvYjb-SC9aGhakBH:EmZts8IUJhyGD1LSdFAOqF/g458=:eyJmaWxlbmFtZSI6IjkubXA0IiwiZmlsZWtleSI6IiIsInNlcnZpY2V0eXBlIjoxfQ="token内容包含：filename='abc.mp4' /文件名filekey='tom' /文件防重名加扰，可以为空deadline=1451491200 /过期时间callbackurl='' /删除成功后回调的url，可为空servicetype = 1 /1是点播服务，0是视频云托管服务，不能为空应答包

7、：HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 23Cache-Control: no-storeConnection: close"status": errorcode返回码为:同上1.3.视频更改属性接口域名：协议：HTTP POST请求包POST /changeproperty HTTP/1.1Host: Content-Type: application/jsonContent-Length: 1234"token":"RzcS42tk1jLuoY4K

8、dSH5XwcHKvYjb-SC9aGhakBH:EmZts8IUJhyGD1LSdFAOqF/g458=:eyJmaWxlbmFtZSI6IjkubXA0IiwiZmlsZWtleSI6IiIsInNlcnZpY2V0eXBlIjoxfQ="token内容包含：filename='abc.mp4' /文件名filekey='test' /文件防重名加扰，可以为空filetype=1 /希望更改成的文件类型，0表示私有，1表示公开servicetype = 1 /1是点播服务，0是视频云托管服务应答包：HTTP/1.1 200 OKContent-Ty

9、pe: application/jsonContent-Length: 23Cache-Control: no-storeConnection: close"status": errorcode返回码为:同上1.4.点播回调接口l 上传回调POST /callback HTTP/1.1Host: Content-Length: 197Content-Type: application/jsonAccept: */*“status”:0,”type”:”upload”,”filename”:”hello.mp4”,”filekey”:”yhc”,”filesize”:1024

10、00,”duration”:5400,”servicetype”:0,”ifpublic”:0,”url”:”xxxxxxxxxx”l 删除回调POST /callback HTTP/1.1Host: Content-Length: 197Content-Type: application/jsonAccept: */*“status”:0,”type”:”delete”,”filename”:”hello.mp4”,”filekey”:”yhc”,”filesize”:102400,”duration”:5400,”servicetype”:0,”ifpublic”:0,”url”:”xxx

11、xxxxxxx”1.5.点播大图获取接口一个点播文件会有8张截图，获取方式如下所示。l 访问域名l /15/11618581和用户绑定，可以认为是不动的，其中15是由11618581 MOD 256再转换为16进制得到的l /00表示云托管，1表示点播l /common目录名，可以认为是不动的l /9039D72FF3DF7191693287121FD8D598.cov文件id，每个文件都对应一个idl .0取值0-7，分别对应8个截图l .jpg图片扩展名1.6.点播小图获取接口点播文件有一个截图伴随文件kfp文件，这个文件中包含视频文件的全程截图（每隔10s）。这个文件的作用主要是用于图片

12、审核、播放器进度条展示。kfp文件格式如下所示：整个文件由文件头部和文件体组成。文件头包括：picnum ，headsize ，videotime和 全部的PicMetaData 文件体包括：各个Pic图片文件各部分说明：picnum：整个文件中包含图片的个数Headsize：文件头部的长度Videotime: 视频时长，单位秒PicMetaData ：PicName图片名PicPos图片文件相对于文件头的偏移PicTime图片文件相对于的视频起始位置的秒数PicSize图片文件的大小单位字节Pic：图片文件headsize = 4 + 4 + 4 +sizeof(PicMetaData) *

13、 picnumPicPos1 = headsizePicPos2 = PicPos1 + PicSize1PicPos3 = PicPos2 + PicSize2.PicPosn = PicPosn-1 + PicSizen-12. 直播2.1.创建频道域名：协议：HTTP POSTHTTP头部：POST /createchannel HTTP/1.1Host: Content-Type: application/jsonContent-Length: 1234HTTP 包体："token": "createtoken"说明：createtoken的内容

14、包括：* ifpublic：0是私有频道，1是公有频道* channelname：频道名字* callback：回调地址，可以为空，如果不指定该字段则不回调。该回调地址会被直播开始、直播结束、录制结束等操作触发* ifrecord：是否允许录制，0表示不录制，1表示录制，取1时下面的参数有效* recordname：录制文件名前缀，可以为空，如果不指定该字段则录制文件以频道名称为前缀* sizelimit：录制文件最大字节数，以B为单位，最小不低于10M，最大不超过2G，与timelimit二选一* timelimit：录制文件最大时

15、长，以秒为单位，最小不低于3分钟，最大不超过3小时，与sizelimit二选一* recordposition：录制文件存储位置，0表示云托管，1表示点播，可以为空，如果不指定该字段则默认存储到云托管* deadline=1451491200 /该token过期时间，Unix时间返回包HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 1234Cache-Control: no-store"status":0,"channelid":"EF57D8EBF286B7D

16、6E80050970F3B59FC", "gcid":"545ED44113C2557662DD3E2321FF40D2F0579C58", "url":"servicetype=2&uid=4995606&fid=545ED44113C2557662DD3E2321FF40D2F0579C58"status为0表示创建直播频道成功,并带有channelid(频道ID)和gcid(使用ID)。频道ID指的是频道上传ID，用户利用频道上传ID，可使用软件将视频直播流上传到云平台中。频道ID是

17、用户私有信息，用户应保证不让第三方知道，如果频道ID泄露，用户可以在管理频道页面修改频道ID（修改频道ID将不会影响视频播放）。"status":returncode返回码为:*0表示操作成功* 99表示系统错误* 100表示请求的方法不支持* 101表示token无效* 102表示创建直播频道失败，参数值有错误* 103表示json数据格式错误* 104表示频道个数超上限* 105表示非法用户2.2.删除频道域名：协议：HTTP POSTHTTP头部：POST /deletechannel HTTP/1

18、.1Host: Content-Type: application/jsonContent-Length: 1234HTTP 包体："token": "deletetoken"说明：deletetoken的内容包括：* channelid = "EF57D8EBF286B7D6E80050970F3B59FC " /频道id，创建频道成功时，从返回http包体中获得* deadline=1451491200 /该token过期时间，Unix时间返回包HTTP/1.1 200 OKContent-Type: appl

19、ication/jsonContent-Length: 1234Cache-Control: no-store"status":returncode返回码为:* 0表示操作成功* 99表示系统错误* 100表示请求的方法不支持* 101表示token无效* 102表示删除直播频道失败，参数值有错误* 103表示json数据格式错误* 104表示频道个数超上限* 105表示非法用户2.3.修改频道域名：协议：HTTP POSTHTTP头部：POST /modifychannel HTTP/1.1Host:

20、Content-Type: application/jsonContent-Length: 1234HTTP 包体："token": "modifytoken"说明：modifytoken的内容包括：* ifpublic：0是私有频道，1是公有频道* channelname：频道名字* callback：回调地址，可以为空，如果不指定该字段则不回调。该回调地址会被直播开始、直播结束、录制结束等操作触发* ifrecord：是否允许录制，0表示不录制，1表示录制，取1时下面的参数有效* recordname：录制文件

21、名前缀，可以为空，如果不指定该字段则录制文件以频道名称为前缀* sizelimit：录制文件最大字节数，以B为单位，最小不低于10M，最大不超过2G，与timelimit二选一* timelimit：录制文件最大时长，以秒为单位，最小不低于3分钟，最大不超过3小时，与sizelimit二选一* recordposition：录制文件存储位置，0表示云托管，1表示点播，可以为空，如果不指定该字段则默认存储到云托管* deadline=1451491200 /该token过期时间，Unix时间返回包HTTP/1.1 200 OKContent-Type: applic

22、ation/jsonContent-Length: 1234Cache-Control: no-store"status":returncode返回码为:* 0表示操作成功* 99表示系统错误* 100表示请求的方法不支持* 101表示token无效* 102表示修改直播频道失败，参数值有错误* 103表示json数据格式错误* 104表示频道个数超上限* 105表示非法用户2.4.录制开始域名：协议：HTTP POST请求包:POST /startrecord HTTP/1.1Host: Co

23、ntent-Type: application/jsonContent-Length: 1234"channelid":"01234567890123456789012345678901","callback":"","filename":"xxxlive",”recordname”:”test”,"sizelimit":1232141,”recordposition”:0或"channelid":"0123456789012

24、3456789012345678901","callback":"","filename":"xxxlive",”recordname”:”test”,"timelimit":300,”recordposition”:0channelid：直播频道上传idcallback：回调地址recordname：录制文件名前缀sizelimit：录制文件最大字节数，以B为单位，最大不能超过2Gtimelimit：录制文件最大时长，以秒为单位，最大不能超过2小时recordposition：录制文

25、件存储位置，0表示云托管，1表示点播返回包HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 1234Cache-Control: no-store"status":0status值定义：0：操作成功99：系统错误300：磁盘空间满301：频道不存在302：不允许录制303：处理超时2.5.结束录制域名：协议：HTTP POST请求包:POST /stoprecord HTTP/1.1Host: Content-Type: application/jsonContent-Length: 1234"

26、;channelid":"01234567890123456789012345678901"channelid：直播频道上传id应答包：HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 1234Cache-Control: no-store"status":0status值定义：0：操作成功99：系统错误2.6.获取录制列表域名：协议：HTTP POST或者GETPOST请求包:POST /getrecordlist HTTP/1.1Host: Content-Type:

27、application/jsonContent-Length: 1234"channelid":"72BC7FD637503A68985186CF464C47DC"channelid：直播频道上传idGET请求包:GET /getrecordlist?channelid=72BC7FD637503A68985186CF464C47DC HTTP/1.1Host: Content-Type: application/json应答包：HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 12

28、34Cache-Control: no-store "status":0,"channelid":"CD9EE463EF5324C36F20CD8748F8E0F8","recordlist": "filename":"record_test_20160106124240_8561.mp4","duration":186130,"url":"servicetype=0&uid=5263465&fid=3238E

29、E7CE532AE117DF4FC41EFC39D5C","servicetype":0,"updatetime":"2016-01-06 12:45:54" ,"uploadstatus":0,"pictureurl":"http:/69/5263465/0/common/record_test_20160106124240_8561.jpg","filename":"record_test_20160106124547_7

30、752.mp4","duration":187488,"url":"servicetype=0&uid=5263465&fid=067AF4DFC6B6322C2D4894E2B18BC1D8","servicetype":0,"updatetime":"2016-01-06 12:45:54" ,"uploadstatus":0,"pictureurl":"http:/69/5263465

31、/0/common/record_test_20160106124547_7752.jpg"channelid：直播频道上传idrecordlist：直播录制文件列表filename：录制文件名称duration：录制文件播放时长，以毫秒为单位ifpublic：视频属性，0表示私有，1表示公有url：文件移动端代码servicetype: 业务类型，0表示云存储，1表示点播uploadstatus: 上传状态，0发布中，1发布成功，2发布失败pictureurl：录制文件截图下载地址servicetype：业务类型，0表示云存储，1表示点播status值定义：0：操作成功-1：没有录

32、制文件2.7.删除录制文件域名：协议：HTTP POST请求包:POST /delrecordfile HTTP/1.1Host: Content-Type: application/jsonContent-Length: 1234"channelid":"01234567890123456789012345678901",”filename”:”test.mp4”channelid：直播频道上传idfilename：录制文件名，可以为空，如果filename为空则删除频道对应所有的录制文件应答包：HTTP/1.1 200 OKContent-Type:

33、 application/jsonContent-Length: 1234Cache-Control: no-store“status”:0status值定义：0：操作成功-1：操作失败2.8.获取直播截图一个直播频道对应2个id，一个是上传id（32B），一个是使用id（40B），直播截图的命名方式为：使用id-用户id-时间戳.jpg，截图大约30秒生成一个，每个截图的名字都不一样。举例说明假设一个直播频道：上传id为：C346096876246F6BAA7265B1F8455F99使用id为：6E3F673D61A4558CC318BCE9F63F0EBD9D53EA14截图：6E3F6

34、73D61A4558CC318BCE9F63F0EBD9D53EA14-4985300-1438166631.jpg域名：协议：HTTP GET请求包GET /queryliveimage?gcid=223939BCF66055A327BB1845F6703D6C1163AA09 HTTP/1.1Host: Content-Type: application/json应答包：HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 1234Cache-Control: no-store"status":0,&q

35、uot;url":"http:/07/11886343/2/livepic/223939BCF66055A327BB1845F6703D6C1163AA09-11886343-1438655563.jpg" status值定义：0：表示查询成功，其中url为截图下载地址。-1：表示查询失败示例：2.9.直播在线人数查询域名：协议：HTTP GET请求包GET /channelusercount?gcid=223939BCF66055A327BB1845F6703D6C1163AA09 HTTP/1.1Host: Content-Type: application/

36、json应答包：HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 1234Cache-Control: no-store"usercount":0示例：2.10.直播频道状态查询接口域名：协议：HTTP GET请求包GET /channelstate?gcid=223939BCF66055A327BB1845F6703D6C1163AA09 HTTP/1.1Host: Content-Type: application/json应答包：HTTP/1.1 200 OKContent-Type: appli

37、cation/jsonContent-Length: 1234Cache-Control: no-store"status":0,"gcid":"223939BCF66055A327BB1845F6703D6C1163AA09"status值定义：0：正在直播100：直播没开始101：直播已经结束102：直播请求错误2.11.直播回调l 直播开始回调POST /live/recordcallback?room_id=5465 HTTP/1.1Host: Content-Length: 197Content-Type: applicat

38、ion/jsonAccept: */*"type":"startlive","gcid":"8CD4967029E04C68B406BA4129BDD06120894919","channelid":"C14EE21DF122F698D41A9762A08C767F","url":"servicetype=2&uid=11618581&fid=8CD4967029E04C68B406BA4129BDD06120894919&quo

39、t;l 直播结束回调POST /live/recordcallback?room_id=5465 HTTP/1.1Host: Content-Length: 197Content-Type: application/jsonAccept: */*"type":"stoplive","gcid":"8CD4967029E04C68B406BA4129BDD06120894919","channelid":"C14EE21DF122F698D41A9762A08C767F",&q

40、uot;url":"servicetype=2&uid=11618581&fid=8CD4967029E04C68B406BA4129BDD06120894919"l 录制结束回调POST /recordcallback HTTP/1.1Host: Content-Length: 197Content-Type: application/jsonAccept: */*“status”:0,"type":"liverecord",”channelid”:”0123456789012345678901234567

41、8901”,”recordlist”:”filename”:”test_1”,”duration”:13678,”ifpublic”:1,”url”:”servicetype=1&uid=5294383&fid=C346096876246F6BAA7265B1F8455F99”，“pictureurl”:”http:/71/5304689/1/common/test_1.jpg”,"servicetype":1,”filename”:”test_2”,”duration”:16788,”ifpublic”:1,”url”:”servicetype=1&

42、;uid=5294383&fid=881EA544D58C2D4131FBC2FCE9962D6B”“pictureurl”:”http:/71/5304689/1/common/test_2.jpg”,"servicetype":1channelid：直播频道上传idrecordlist：直播录制文件列表filename：录制文件名称duration：录制文件播放时长，以毫秒为单位ifpublic：视频属性，0表示私有，1表示公有url：文件移动端代码pictureurl：录制文件截图下载地址servicetype：业务类型，0表示云存储，1表示点播2.12.统计

43、状态查询接口2.12.1按月查询点播文件统计信息域名：协议：HTTP GET请求包GET / filestatmonth?fileid=EED3549D2FB7DC8E2181967869D60CB7&time=20160101&uid=5263465&servicetype=1 HTTP/1.1Host: Content-Type: application/json应答包：HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 1234Cache-Control: no-store"statu

44、s":0,"uid":5263465,"fileid":"EED3549D2FB7DC8E2181967869D60CB7","time":"20160101","vv":108,"downloads":60012000,"totaltime":1256status：0成功，-1失败uid：用户idfileid：需要查询的文件idtime：需要查询时间servicetype：需要查询的业务id，0云托管，1点播vv：文件本月内

45、的总访问量downloads：文件本月内的总下载量totaltime：文件本月内的总播放时间2.12.2按天查询点播文件统计信息域名：协议：HTTP GET请求包GET / filestatday?fileid=EED3549D2FB7DC8E2181967869D60CB7&time=20160101&uid=5263465&servicetype=1 HTTP/1.1Host: Content-Type: application/json应答包：HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 1234Cache-Control: no-store"status":0,"uid":5263465,"fi