目录 第 1 章直播 API 概述... 1 第 2 章调用方式 请求结构说明 请求地址 地址示例 返回结果... 2 第 3 章直播 创建直播频道 功能描述

Transcription

1 ONAIR 视频云 直播 API 接口调用规范 版本号 :V1.2 北京阳光云视科技有限公司 2018 年 9 月

2 目录 第 1 章直播 API 概述... 1 第 2 章调用方式 请求结构说明 请求地址 地址示例 返回结果... 2 第 3 章直播 创建直播频道 功能描述 返回参数 请求示例 返回示例 创建自定义直播频道 功能描述 请求参数 返回参数 请求示例 返回示例 开启直播频道流监控 功能描述 请求参数 请求示例 返回示例 回调示例 关闭直播频道流监控 功能描述 请求参数 请求示例 返回示例 查询推流在线列表 功能描述 请求参数 返回参数 请求示例 返回示例 查询推流黑名单 功能描述 请求参数 返回参数 请求示例 返回示例 查询流控历史 I

3 3.7.1 功能描述 请求参数 返回参数 请求示例 返回示例 查询直播流历史帧率和码率 功能描述 请求参数 返回参数 请求示例 返回示例 查询推流历史 功能描述 请求参数 返回参数 请求示例 返回示例 禁止直播流推送 功能描述 请求参数 请求示例 返回示例 恢复直播流推送 功能描述 请求参数 请求示例 返回示例 查询直播流实时帧率和码率 功能描述 请求参数 返回参数 请求示例 返回示例 第 4 章拉流 添加拉流 功能描述 请求参数 返回参数 请求示例 返回示例 删除拉流 功能描述 请求参数 返回参数 II

4 4.2.4 请求示例 返回示例 查询拉流信息 功能描述 请求参数 返回参数 请求示例 返回示例 第 5 章直播转码 添加转码配置 功能描述 请求参数 返回参数 请求示例 返回示例 删除转码配置 功能描述 请求参数 请求示例 返回示例 查询转码配置信息 功能描述 请求参数 返回参数 请求示例 返回示例 第 6 章收录 开始直播录制 功能描述 请求参数 返回参数 请求示例 返回示例 回调示例 创建直播录制同步任务 功能描述 请求参数 返回参数 请求示例 返回示例 停止直播录制 功能描述 请求参数 返回参数 III

5 6.3.4 请求示例 返回示例 查询录制任务 功能描述 请求参数 返回参数 请求示例 返回示例 查询录制内容 功能描述 请求参数 返回参数 请求示例 返回示例 第 7 章直播截图 添加截图配置 功能描述 请求参数 返回参数 请求示例 返回示例 删除截图配置 功能描述 请求参数 请求示例 返回示例 查询应用下的截图配置 功能描述 请求参数 返回参数 请求示例 返回示例 更新截图配置 功能描述 请求参数 返回参数 请求示例 返回示例 查询截图信息 功能描述 请求参数 返回参数 请求示例 返回示例 IV

6 第 8 章直播鉴权 鉴权 URL 描述 鉴权 URL 组成 鉴权字段描述 添加直播鉴权 功能描述 请求参数 请求示例 返回示例 关闭直播鉴权 功能描述 请求参数 请求示例 返回示例 更新直播鉴权 功能描述 请求参数 请求示例 返回示例 第 9 章直播鉴黄 添加鉴黄配置 功能描述 请求参数 返回参数 请求示例 返回示例 查询鉴黄任务 功能描述 请求参数 返回参数 请求示例 返回示例 删除鉴黄配置 功能描述 请求参数 请求示例 返回示例 第 10 章直播错误码 V

7 功能 描述 创建直播频道创建自定义直播频道开启直播频道流监控关闭直播频道流监控查询推流在线列表查询推流黑名单查询流控历史查询直播流历史帧率和码率查询推流历史禁止直播流推送恢复直播流推送查询直播流实时帧率和码率添加拉流删除拉流查询拉流信息添加转码配置删除转码配置查询转码配置信息开始直播录制创建直播录制同步任务停止直播录制查询录制内容添加截图配置删除截图配置查询应用下的截图配置更新截图配置查询截图信息添加直播鉴权关闭直播鉴权更新直播鉴权添加鉴黄配置删除鉴黄配置 创建直播频道创建自定义直播频道通过回调方式通知流频道的推流断流情况关闭直播频道流监控查看该用户下所有正在推流的频道信息列表查询该用户下所有推流的的黑名单查询该用户或者该用户下某一个直播频道的所有直播流操作记录查询该用户或者该用户下某一个直播频道的帧率和码率信息查询该用户或者该用户下某一个直播频道的所有推流历史记录将某个直播频道加入黑名单, 加入后该地址将无法进行推流将某个直播频道解除黑名单, 解除后该地址正常进行推流实时查询该用户或者该用户下某一个直播频道的帧率和码率信息创建直播拉流频道删除拉流信息, 删除后将停止拉流查询该用户或者该用户下某一个直播频道内所有正在拉流的信息添加转码配置信息, 创建成功后该直播频道将按照设置开始直播流转码删除转码配置信息, 删除成功后该直播频道将停止直播流转码查询该用户下或者改用户下某一个直播频道内所有转码配置信息创建直播录制任务创建直播录制任务, 同步返回录制结果停止直播录制任务查询该用户下或者改用户下某个直播频道的直播流录制内容或者列表配置该用户下截图设置删除该用户下截图设置查询该用户下或者该用户下某个直播频道的截图配置信息更新直播流下的截图配置查询该用户下或者该用户下某个直播频道的截图内该用户或者该用户下某一个直播频道添加直播鉴权信息关闭该用户或者该用户下某一个直播频道的鉴权信息更新该用户或者该用户下某一个直播频道的鉴权信息配置该用户下鉴黄设置删除该用户下截图设置 VI

8 第 1 章直播 API 概述 欢迎使用视频云直播 API 服务 用户可以使用本文档介绍的 API 调用标准对点播服务进行相关接口对接工作 对服务接口调用统一采用标准的 RESTfull 风格的 API 接口, 支持 HTTP GET 方法发送请求, 这种方式下请求参数需要包含在请求的 URL 中接口, 同时支持 HTTP POST 发送请求, 这种方式下请求参数需要以 JSON 格式放到 HTTP BODY 里传输 根据请求的处理情况, 系统响应数据格式统一为 JSON 数据格式 1

9 第 2 章调用方式 2.1 请求结构说明 请求地址服务调用接口地址规则 : 域名 ]/[ 接口地址 ]?[ 接口参数 ] 访问地址由三部分组成 : 域 名 : 接口服务部署后提供访问域名 接口地址 : 接口服务根据实现功能的不同提供相应的地址 接口参数 : 接口参数是指具体接口时需要使用到的参数 注 : 接口参数中所有必填项及其值必须传递, 非必填项的值可以不传 所有参数区分大小写, 命名遵循驼峰命名规则 请求及返回结果都使用 UTF-8 字符集进行编码, 因调用接口时华为网关会对请求进行自动 urlencode 编码, 不需额外编码请求参数 地址示例 [ 第一部分 ][ 第二部分 ][ 第三部分 ] 第一部分为域名, 是接口服务部署后的访问地址 ; 第二部分是具体接口服务的接口地址, 由接口服务根据一定规则 ( 按照不同功能进行命名上的区分 ) 定义 ; 第三部分为接口参数, 在调用具体接口时需填入 2.2 返回结果 # 状态码, 参照附录 "message": "success",# 描述信息 "data": "requestid": " F38-4W33-BER5-D CA58" # 结果数据 2

10 第 3 章直播 直播服务提供用户通过接口方式启用直播通道, 通过推流或拉流方式将信号源注入到直播平台, 在直播平台完成实时流编码, 并通过分发网络注入到 CDN 服务中, 完成互联网视频直播的业务需求 3.1 创建直播频道 功能描述 根据华为云用户唯一标识创建直播频道, 返回该用户在视频云直播 API 服务内 应用标识 流名称 推流地址和对应播放地址 返回参数 参数 含义 格式 说明 appname 应用标识 String 用户唯一标识 streamname 流名称 String 流名称唯一 publishurl 推流地址 String 直播流发布后 RTMP 协议推流地址 cdnurl HLS 播放 String 直播流的 HLS 播放 HTTPS 地址 地址 rtmpurl RTMP 播 String 直播流的 RTMP 播放地址 放地址 flvurl FLV 播放 String 直播流的 FLV 播放地址 地址 请求示例 域名 ]/live/createlvbchannel?streamname= 返回示例 "message": "success", "data": "requestid": 65736y3g3hjo345o37g567234if234g234h43, "appname": "dnc19d ", "cdnurl": " 域名 3

11 /dnc19d/dnc19d/789/dnc19d/zo38n7.m3u8", "rtmpurl": "rtmp:// 域名 /dnc19d/dnc19d/789/dnc19d/zo38n7", "flvurl": " 域名 /dnc19d/dnc19d/789/dnc19d/zo38n7.flv", "streamname": "zo38n7", "publishurl": "rtmp:// 域名 /dnc19d/dnc19d/789/dnc19d/zo38n7" 3.2 创建自定义直播频道 功能描述创建自定义直播频道, 可对通道推流地址 appname streamname 及播放地址 streamname 进行自定义设置 appname 与 streamname 的命名是系统中所有用户共用的, 不可重复使用 请求参数属性含义类型说明必填 appname 应用标识 String 支持小写英文字母 数字及其组合, 限定长度为 6 个字符 streamname 流名称 String 支持小写英文字母 数字及其组合, 限定 长度为 6 个字符 是 是 返回参数 参数 含义 格式 说明 appname 应用标识 String 用户唯一标识 streamname 流名称 String 流名称唯一 publishurl 推流地址 String 直播流发布后 RTMP 协议推流地址 cdnurl HLS 播放 String 直播流的 HLS 播放 HTTPS 地址 地址 rtmpurl Rtmp 播 String 直播流的 RTMP 播放地址 放地址 flvurl FLV 播放 String 直播流的 FLV 播放地址 地址 4

12 3.2.4 请求示例 域名 ]/live/createuserdefinedchannel?appname=123456&streamname= 返回示例 "message": "success", "data": "requestid": 65736y3g3hjo345o37g567234if234g234h43, "appname": "dnc19d ", "cdnurl": " 域名 /dnc19d/dnc19d/789/dnc19d/zo38n7.m3u8", "rtmpurl": "rtmp:// 域名 /dnc19d/dnc19d/789/dnc19d/zo38n7", "flvurl": " 域名 /dnc19d/dnc19d/789/dnc19d/zo38n7.flv", "streamname": "zo38n7", "publishurl": "rtmp:// 域名 /dnc19d/dnc19d/789/dnc19d/zo38n7" 3.3 开启直播频道流监控 功能描述 根据应用标识 流名称及回调地址开启直播频道流监控 开启后, 频道的直播流 流入与断开时会向回调地址发送对应信息进行通知 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 callbackurl 监控回调 String 回调地址, 会将该通道的直播流流入 断 是 地址 开状况实时反馈至给定地址 请求示例 域 5

13 名 ]/live/setcallback?appname=35l4r7&streamname=mc63jf&callbackurl= 返回示例 "message": "success", "data": "requestid": 65736y3g3h-jo345o37g if234g23-4h 回调示例属性含义类型说明 appname 应用标识 String streamname 流名称 String status 流状态 String 直播频道中的流状态值为 pull 时为流入 ; 值为 break 时为断开 流推入时回调信息 : appname=1sfgh1, streamname=1tyui1, status=pull 流断开时回调信息 : appname=1sfgh1, streamname=1tyui1, status=break 3.4 关闭直播频道流监控 功能描述根据应用标识 流名称关闭该用户下对应直播频道的流监控 6

14 3.4.2 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 请求示例 域名 ]/live/cancelcallback?appname=35147r&streamname=mc63jf&callbackurl= 返回示例 "message": "success", "data": "requestid": 65736y3g3h-jo345o37g if234g23-4h 查询推流在线列表 功能描述 根据应用标识查看该用户下所有正在推流的频道信息列表, 支持按照顺序 / 倒序 排序, 支持分页大小 分页页数设置 请求参数 属性 含义 类型 说明 必填 order 排序 String 排序,asc: 升序,desc: 降序, 默认 :asc pagesize 分页大小 Long 分页大小, 默认 3000, 最 大 3000, 取值 :1~3000 之间的任意整数 否 否 pagenumber 当前页数 long 展示出的页数编号, 默认 1 否 7

15 3.5.3 返回参数 参数 含义 格式 说明 onlineinfo 信息集合 livestreamonlineinfo [] 正在推送流的信息 pagesize 每页大小 Integer order 排序 String numtotal 符合条件 的总个数 Integer livestreamonlineinfo 数据类型 参数 含义 格式 说明 appname 应用标识 String streamname 流名称 String publishtime 推流时间 String 时间格式 :yyyy-mm-dd HH:mm:ss publishurl 推流地址 String 直播流发布后 rtmp 协议推流地址 请求示例 域名 ]/live/describelivestreamsonlinelist?appname= 返回示例 "message": "", "data": "onlineinfo": "livestreamonlineinfo": [ "appname": "dnc19d", "streamname": "zo38n7", "publishtime": " :58:04", "publishurl": "rtmp://onairzb.onairsaas.com/dnc19d/zo38n7" ], "requestid": " F38-4W33-BER5-D CA58", 8

16 "pagenum": 1, "pagesize": 10, "order": "asc", "numtotal": 查询推流黑名单 功能描述 根据用户唯一标识查询该用户下的推流黑名单 请求参数 属性 含义 类型 说明 必填 返回参数参数 含义 格式 说明 blockstreams 信息集合 publishurls 完整推流 URL 列表 streamlist 数据类型参数 含义 格式 说明 publishurls 信息集合 String[] 完整流 URL 请求示例 域名 ]/live/describelivestreamsblocklist?appname= 返回示例 "message": "", "data": "publishurls": "publishurl": [ "rtmp: // 域名 /dnc19d/zo38n7" ], 9

17 "requestid": " F38-4W33-BER5-D CA58" 3.7 查询流控历史 功能描述 根据应用标识 流名称以及时间周期, 查询该用户或者该用户下某一个直播频道 的所有直播流操作记录 请求参数 属性 含义 类型 说明 必填 starttime 开始时间 String 时间格式 :yyyy-mm-dd HH:mm:ss endtime 结束时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 和 starttime 不能超 过 30 天 是 是 streamname 流名称 String 否 返回参数 参数 含义 格式 说明 controlinfo 记录 livestreamcontrolinfo[] 直播流的操作记录 livestreamcontrolinfo 数据类型 参数 含义 格式 说明 streamname 流名称 String action 执行的操 作 String timestamp 操作时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 请求示例 域 名 ]/live/describelivestreamscontrolhistory?appname=123&starttime=star ttime&endtime=endtime 10

18 3.7.5 返回示例 "message": "", "data": "controlinfo": "livestreamcontrolinfo": [ "action": "forbid", "timestamp": " T16:36:18Z", "streamname": "xxxx" ], "requestid": "9C31856F-386D-4DB3-BE79-A0AA493D702A" 3.8 查询直播流历史帧率和码率 功能描述 根据应用标识 流名称 时间周期, 查询该用户或者该用户下某一个直播频道的 历史帧率和码率信息, 支持按照顺序 / 倒序排序, 支持分页大小 分页页数设置 请求参数 属性 含义 类型 说明 必填 starttime 开始时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 是 endtime 结束时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 是 streamname 流名称 String 否 order 排序 String 排序,asc: 升序,desc: 降序, 默认 : asc pagesize 每页大小 Long 每页大小, 默认 3000, 最大 3000, 取 值 :1~6000 之前的任意整数 否 否 11

19 pagenumber 当前页数 long 展示出的页数编号, 默认 1 否 返回参数 参数含义格式说明 framerateandbitrateinfos 记录 framerateandbitrateinfo 各直播流的帧 率 / 码率信息 pagesize 每页大小 Integer order 排序 String numtotal 符合条件 的总个数 Integer pagenum 当前页 Integer framerateandbitrateinfo 数据类型 参数 含义 格式 说明 publishurl String 直播流的 URL videoframerate int 直播流的视频帧率 audioframerate int 直播流的音频帧率 bitrate int 直播流的码率 time String 时间格式 :yyyy-mmdd HH:mm:ss 请求示例 域 名 ]/live/describelivestreambitratedata?appname=123&starttime=starttime&e ndtime=endtime 返回示例 "message": "", "data": "framerateandbitrateinfos": "framerateandbitrateinfo": [ "streamurl": "rtmp://push.onairsaas.com/live/test101", "videoframerate": "30.01", 12

20 "audioframerate": "167.67", "bitrate": "192.02", "time": " : 05: 00" ], "requestid": "9C31856F-386D-4DB3-BE79-A0AA493D702A", "pagenum": 1, "pagesize": 10, "order": "asc", "numtotal": 查询推流历史 功能描述 根据应用标识 流名称以及时间周期, 查询该用户下所有或者某一个直播频道的 推流历史记录, 支持按照顺序 / 倒序排序, 支持分页大小 分页页数设置 请求参数 属性 含义 类型 说明 必填 starttime 开始时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 是 endtime 结束时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 和 starttime 不能超过 30 天 是 streamname 流名称 String 否 order 排序 String 排序,asc: 升序,desc: 降序 ; 否 默认 :asc pagesize 分页大小 Long 分页大小, 默认 3000, 最大 3000, 取值 :1~3000 之前的任意整 数 否 pagenumber 当前页数 long 展示出的页数编号, 默认 1 否 13

21 3.9.3 返回参数参数 含义 格式 说明 publishinfo 记录 PublishInfoModel[] 推流记录信息 pagesize 每页大小 Integer order 排序 String numtotal 符合条件的总个数 Integer pagenum 当前页 Integer PublishInfoModel 数据类型 参数 含义 格式 说明 publishurl 直播流的 URL String 直播流发布后 rtmp 协议推流地址 appname 应用名称 String streamname 流名称 String publishtime 推流时间 String 时间格式 :yyyy-mm-dd HH:mm:ss stoptime 结束时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 请求示例 域名 ]/live/ describelivestreamspublishlist?appname=123&starttime=starttime&endt ime=endtime 返回示例 "message": "", "data": "publishinfo": "publishinfomodel": [ "publishurl": "rtmp://push.onairsaas.com/live/test101", "appname": "appname", "streamname": "streamname", "publishtime": " : 05: 00", 14

22 "stoptime": " : 05: 00" ], "requestid": "9C31856F-386D-4DB3-BE79-A0AA493D702A", "pagenum": 1, "pagesize": 10, "order": "asc", "numtotal": 禁止直播流推送 功能描述根据应用标识 流名称, 可以将某个直播频道加入黑名单, 加入后该地址将无法进行推流 请求参数属性含义类型说明必填 streamname 流名称 String 是 请求示例 域名 ]/live/forbidlivestream?appname=123&streamname=streamname 返回示例 "message": "", "data": "requestid": "9C31856F-386D-4DB3-BE79-A0AA493D702A" 15

23 3.11 恢复直播流推送 功能描述根据应用标识和流名称, 可以将某个直播频道解除黑名单, 解除后该地址可正常进行推流 请求参数属性含义类型说明必填 streamname 流名称 String 是 请求示例 域名 ]/live/resumelivestream?appname=123&streamname=streamname 返回示例 "message": "", "data": "requestid": "9C31856F-386D-4DB3-BE79-A0AA493D702A" 3.12 查询直播流实时帧率和码率 功能描述 根据应用标识和流名称, 实时查询该用户下所有或者某一个直播频道的帧率和码 率信息, 支持按照分钟展示结果 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 返回参数参数 含义 格式 说明 16

24 framerateandbitrat einfos 记录 framerateandbitrateinfo[] 各直播流的帧率 / 码率 信息 framerateandbitrateinfo 数据类型参数含义格式说明 streamurl String 直播流的 URL videoframerate String 直播流的视频帧率 audioframerate String 直播流的音频帧率 bitrate String 直播流的码率, 单位 bps time 时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 请求示例 域名 ]/live/describelivestreamsframerateandbitratedata?appname=123&st reamname=streamname 返回示例 "message": "", "data": "framerateandbitrateinfos": "framerateandbitrateinfo": [ "streamurl": "rtmp://test101.cdnpe.com/live/test101", "videoframerate": "30.01", "audioframerate": "167.67", "bitrate": "192.02", "time": " :05:00" ], "requestid": "9C31856F-386D-4DB3-BE79-A0AA493D702A" 17

25 第 4 章拉流 4.1 添加拉流 功能描述 根据源流 url 和拉流的目标通道 ( 应用标识和流名称 ) 开始时间 结束时间创 建直播拉流频道, 创建完成降后按照开始 / 结束时间执行任务 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 sourceurl 源流 String 用户的直播流所在的源站 是 starttime 拉流开始时间 String endtime 拉流结束时间 String 返回参数 时间格式 :yyyy-mm-dd HH:mm:ss 时间格式 :yyyy-mm-dd HH:mm:ss 拉流结束时间和开始时间间隔在 2 天内, 且结束时间要大于开始时间 是 是 参数含义格式说明 taskid 任务 id String 该条任务请求 ID 请求示例 域名 ]/pull/addlivepullstreaminfoconfig?appname=1231&streamname=34556&sour ceurl=sourceurl 返回示例 "message": "", "data": taskid : 572c2e3bb5e78548dcb4f1fe, 18

26 "requestid": "572c2e3bb5e78548dcb4f1fe" 4.2 删除拉流 功能描述 根据应用标识 流名称及任务 ID 删除拉流信息, 删除后将停止拉流 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 taskid 任务 id String 该条任务请求 ID 是 返回参数 参数 含义 格式 说明 taskid 任务 id String 该条任务请求 ID 请求示例 域 名 ]/pull/deletelivepullstreaminfoconfig?appname=1231&streamname=34556& taskid= 返回示例 "message": "", "data": taskid : 572c2e3bb5e78548dcb4f1fe, "requestid": "572c2e3bb5e78548dcb4f1fe" 19

27 4.3 查询拉流信息 功能描述 根据应用标识 流名称, 查询该用户下所有或者某一个直播频道内的拉流信息, 支持按照顺序 / 倒序排序, 支持分页大小 分页页数设置 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 否 order 排序 String 排序,asc: 升序,desc: 降序, 默认 :asc pagesize 分页大小 Long 分页大小, 默认 3000, 最大 3000, 取值 :1~3000 之前的任意 整数 否 否 pagenumber 当前页数 long 展示出的页数编号, 默认 1 否 返回参数 参数 含义 格式 说明 liveapprecordlist 拉流信息 liveapprecord pagesize 每页大小 Integer order 排序 String numtotal 符合条件的 总个数 Integer pagenum 当前页 Integer liveapprecord 数据类型 参数 含义 格式 说明 appname 应用标识 String 用户唯一标识 streamname 流名称 String 唯一的随机数 sourceurl 源流地址 String starttime 开始时间 String 时间格式 :yyyy-mm-dd HH:mm:ss endtime 结束时间 String 时间格式 :yyyy-mm-dd HH:mm:ss taskid 任务 id String 该条任务 Id 20

28 4.3.4 请求示例 域名 ]/pull/describelivepullstreamconfig?appname=dnc19d 返回示例 "message": "", "data": "requestid": "572c2e3bb5e78548dcb4f1fe", "liveapprecordlist": "liveapprecord": [ "appname": "dnc19d", "streamname": "zo38n7", "starttime": " T06:58:04Z", "endtime": " T06:58:04Z", "sourceurl": "taskid": "23572c2e3bb5e78548dcb4f1fe23" ], "pagenum": 1, "pagesize": 10, "order": "asc", "numtotal": 20 21

29 第 5 章直播转码 5.1 添加转码配置 功能描述 根据应用标识 流名称和转码模板 ID 水印参数添加转码配置信息, 支持在直 播转码的过程中添加图片及文字水印, 支持多水印叠加 创建成功后, 该直播频 道中的流数据将按照设置进行直播转码, 断流后停止直播转码 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 template 模板 id String 标准 : 是 ld: 流畅 640*360 sd: 标清 960*540 hd: 高清 1280*720 uhd: 超清 1920*1080 感知增强 : jld: 流畅 640*360 jsd: 标清 960*540 jhd: 高清 1280*720 juhd: 超清 1920*1080 多个模板间用半角逗号分隔 注 : 暂不支持纯音频转码 watermark 水印参数 String[] 水印设置, 支持图片 文字水印, 多水印时不同水印间使用半角逗号分隔, 参数见 watermark 参数详情 否 注 :wtermark 参数中的水印大小及位置参数均以输入流的画面分辨率为基准, 转码后, 水印与输出画面间的相对位置与基准状态相同 watermark 参数详情 22

30 参数格式说明必填 type String 水印类型, 支持 Text Logo 两种类型 是 输入 Text 时为文字水印, 输入 Logo 时为图片 水印 template String 转码配置中选择的转码模板 id, 设置后会将该水印添加至对应规格的直播转码输出画面中 logourl String 图片水印字段, 指图片文件 URL, 当 type 为 Logo 时必传此参数, 支持输入 JPG PNG 格式 文件 logowidth Int 图片水印必填字段, 指以输入流分辨率为基准的 水印图片的宽度, 单位 px, 当 type 为 Logo 时 必传此参数, 范围 (0,4096], 支持整数 logoheight Int 图片水印必填字段, 指以输入流分辨率为基准的 水印图片的高度, 单位 px, 当 type 为 Logo 时 必传此参数, 范围 (0,4096], 支持整数 logox Int 图片水印字段, 指以输入流分辨率为基准的图片 水印位置的水平偏移量, 以画面左上顶点为原 点, 单位 px, 范围 [0,4096], 支持整数, 默认 为 0 logoy Int 图片水印字段, 指以输入流分辨率为基准的图片 水印位置的竖直偏移量, 以画面左上顶点为原 点, 单位 px, 范围 [0,4096], 支持整数, 默认 为 0 text String 文字水印字段, 指水印显示的文本内容, 当 type 为 Text 时必传此参数, 支持中文及常用特 殊字符 fontname String 文字水印字段, 指文本水印的字体, 输入内容为 字体名称, 支持宋体 黑体 新宋 隶书 楷 体, 默认为宋体 fontsize Int 文字水印字段, 指文本水印的字号大小 范围 [1,72], 支持整数 默认为 16 fontcolor String 文字水印字段, 指文本水印的颜色 可输入 16 进制颜色码, 如 0F0ADC, 默认为 FFFFFF( 白 色 ) textx Int 文字水印字段, 指以输入流分辨率为基准的图片 水印位置的水平偏移量, 以画面左上顶点为原 是否否否否否否否否否否 23

31 点, 单位 px, 范围 [0, 4096], 支持整数, 默认 为 0 texty Int 文字水印字段, 指以输入流分辨率为基准的图片水印位置的竖直偏移量, 以画面左上顶点为原点, 单位 px, 范围 [0, 4096], 支持整数, 默认为 0 texttransparent Int 文字水印字段, 指文字水印的不透明度, 范围 (0,100], 支持整数, 数值越低, 文字水印越透 明, 默认为 100 starttime Int 指水印在时间线上的起始时间, 单位毫秒, 默认 为 0 endtime Int 指水印在时间线上的取消时间, 单位毫秒, 默认 水印不消失 否否否否 返回参数参数 含义 格式 说明 cdnurls 播放地址 String[] 转码后播放地址 taskid 任务 id String 请求示例 域名 ] /transcode/addlivestreamtranscode?appname=232323&template=hd&strea mname=232323&watermark=["type":"text","template":"hd","text":" 一二三四五 ","starttime":10000,"endtime":20000,"texttransparent":80,"type":"logo","tem plate":"hd","logourl":" ight":400,"logowidth":400,"logox":120,"logoy":120,"starttime":10000,"endtime ":20000] 返回示例 "message": "", "data": "cdnurls": [ "https: // 域名 /121233/121233_ld.m3u8", "https: // 域名 /121233/121233_hd.m3u8" 24

32 ], "requestid": "572c2e3bb5e78548dcb4f1fe", taskid : taskid 5.2 删除转码配置 功能描述 根据应用标识 流名称及任务 ID 删除转码配置信息, 删除成功后该直播频道将 停止直播转码 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 taskid 任务 id String 是 请求示例 域 名 ]/transcode/deletelivestreamtranscode?appname=dnc19d&streamname=1223 &taskid=taskid 返回示例 "message": "", "data": "requestid": "572c2e3bb5e78548dcb4f1fe" 5.3 查询转码配置信息 功能描述根据应用标识 流名称查询该用户下所有或者某一个直播频道内所有转码配置 25

33 信息, 支持按照顺序 / 倒序排序, 支持分页大小 分页页数设置 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 否 order 排序 String 排序,asc: 升序,desc: 降序, 默认 :asc pagesize 分页大小 Long 分页大小, 默认 3000, 最大 3000, 取值 :1~3000 之前的 任意整数 否 否 pagenumber 当前页数 long 展示出的页数编号, 默认 1 否 返回参数参数 含义 格式 说明 appnametranscodelist 记录 appnametranscodeinfo[] 转码配置信息 pagesize 每页大小 Integer order 排序 String numtotal 符合条件 的总个数 Integer pagenum 当前页 Integer appnametranscodeinfo 数据类型 参数 含义 格式 说明 appname 应用标识 String 用户唯一标识 transcodetemplate String 转码模版 transcodestreamname String 流名称 taskid 任务 id String 该条任务 Id watermark 水印参数 String[] 任务的水印信息 请求示例 域 名 ]/transcode/describelivestreamtranscodeinfo?appname=dnc19d&streamname =

34 5.3.5 返回示例 "message": "success", "data": "numtotal": 1, "requestid": k5s51y8wn915cur1926, "appnametranscodelist": "appnametranscodeinfo": [ "transcodestreamname": "2xju23", "transcodetemplate": "hd", "appname": "23wux3", "watermark": [ "type": "Text", "template": "hd", "text": " 一二三四五 ", "starttime": 10000, "endtime": 20000, "fontname": " 黑体 ", "fontsize": 36, "fontcolor": "AAAAAA" ], "taskid": "5b92490s7w354a4c51e24" ], "pagesize": 3000, "pagenum": 1 27

35 第 6 章收录 6.1 开始直播录制 功能描述 按照应用标识 流名称 回调地址 开始时间 结束时间创建直播录制任务, 创 建成功后将按照开始 / 结束时间执行录制任务 若设置回调地址, 录制完成后会对该地址返回录指文件信息 单一直播录制任务的最小时间周期为 30 秒, 最长为 6 小时 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 starttime 开始时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 是 endtime 结束时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 是 callbackurl 回调地址 String 录制完成对该地址返回录制文件 否 返回参数参数 含义 格式 说明 taskid 任务 id String 该条任务请求 ID 请求示例 域 名 ]/record/createlivestreamrecordindexfiles?appname=1231&streamname=345 56&startTime= :25:00&endTime= :50:00&callBackUrl=url 返回示例 "message": "", "data": "taskid":"taskid", "requestid": "572c2e3bb5e78548dcb4f1fe" 28

36 6.1.6 回调示例 直播录制完成或者停止录制后会开始生成录制文件, 文件生成后的回调参数为 属性 含义 类型 说明 taskid 任务 id String 该条任务请求 ID appname 应用标识 String streamname 流名称 String recordurl 文件 String 录制产生的文件, 格式为 mp4 回调示例 recordurl= 域名 /huaweigateway/onsite/5b598de84c6bdc095a/440d4116b54e021c357c831d.mp4& appname=t8c71s&streamname=5d3ncc&taskid=5b71379a4c6bd27e123dcfe2 6.2 创建直播录制同步任务 功能描述 按照应用标识 流名称 开始时间 结束时间创建直播录制任务, 创建成功后将 实时拼接当前时间下该时间段内该频道下的直播内容生成 m3u8 文件, 以同步 返回模式收录文件结果 同步任务不支持跨天创建 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 starttime 开始时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 是 endtime 结束时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 是 返回参数参数 含义 格式 说明 taskid 任务 id String 该条任务请求 ID recordurl 文件 String 录制生成的文件, 格式为 M3U 请求示例 域名 ]/record/createlivestreamrecordtask?appname=1231&streamname= 29

37 34556&startTime= :25:00&endTime= :50: 返回示例 "message": "success", "data": "requestid": 8g6m27xb50m0g63bc, "recordurl": " hwyoss.yunshicloud.com/onair/record/onsite/2xx5dx/ /xs3x8x_3e5b FA99E7D7.m3u8", "taskid": "5b9a1cf92b76037db6b57287" 6.3 停止直播录制 功能描述 按照应用标识 流名称及任务 ID 停止直播录制任务, 停止成功后将结束直播内 容录制 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 taskid 任务 id String 该条任务请求 ID 是 返回参数参数 含义 格式 说明 taskid 任务 id String 该条任务请求 ID 请求示例 域 名 ]/record/deleteliverecord?appname=1231&streamname=34556&taskid=572c2e3 bb5e78548dcb4f1fe 30

38 6.3.5 返回示例 "message": "", "data": "taskid":"taskid", "requestid": "572c2e3bb5e78548dcb4f1fe" 6.4 查询录制任务 功能描述 根据应用标识 流名称查询该用户下某一个直播频道的直播录制任务 id, 返回任 务 id 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 返回参数 参数 含义 格式 说明 taskid 任务 id String 任务唯一标识 请求示例 域名 ]/record/describelivetaskid?appname=sd84qe&streamname=c 返回示例 "message": "success", "data": "taskid": "ac003f44ed1b4bddbb371f5cf927ef4d", "requestid": "faffff1" 31

39 6.5 查询录制内容 功能描述 根据应用标识 流名称 时间周期查询该用户下所有或者某一个直播频道的直播 流录制内容或者内容列表, 返回内容包括录制文件 url 录制时间 开始录制和 结束录制时间 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 starttime 开始时间 String 时间格式 :yyyy-mm-dd HH:mm:ss endtime 结束时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 是 是 返回参数参数 含义 格式 说明 recordcontentinfolist recordcontentinfo 录制内容列表 recordcontentinfo 数据类型 参数 含义 格式 说明 recordurl 录制地址 String starttime 开始时间 String 时间格式 :yyyy-mm-dd HH:mm:ss endtime 结束时间 String 时间格式 :yyyy-mm-dd HH:mm:ss duration 录制时长 Float taskid 任务 id String 该条任务 Id 请求示例 域 名 ]/record/describelivestreamrecordcontent?appname=dnc19d&streamname=d1c 17d&startTime=StartTime&endTime=EndTime 返回示例 32

40 "message": "", "data": "requestid": "572c2e3bb5e78548dcb4f1fe", "recordcontentinfolist": "recordcontentinfo": [ "recordurl": " "starttime": " :58:04", "endtime": " :58:04" "duration": " ", "taskid": "23572c2e3bb5e78548dcb4f1fe23" ] 33

41 第 7 章直播截图 7.1 添加截图配置 功能描述 根据应用标识 流名称及截图周期创建直播截图任务, 支持 5~3600 秒内任意配 置, 配置成功后将即时生效 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 timeinterval 截图周期, 范 Integer 截图周期, 范围 :5~3600, 单 是 围 :5~3600, 位秒 单位秒 返回参数 参数含义格式说明 taskid 任务 id String 任务唯一标识 请求示例 域名 ]/snapshot/addliveappsnapshotconfig?appname=dnc19d&timeinterval= 返回示例 "message": "", "data": "taskid": "572c2e3bb5e78548dcb4f1fe", "requestid": "572c2e3bb5e78548dcb4f1fe" 34

42 7.2 删除截图配置 功能描述根据应用标识 流名称及任务 ID 删除该频道下的截图设置, 删除成功后将即时生效, 停止该用户的直播截图任务 请求参数属性含义类型说明必填 streamname 流名称 String 是 taskid 任务 id String 任务唯一标识是 请求示例 域名 ]/snapshot/deleteliveappsnapshotconfig?appname=dnc19d&streamname=d 1c17d&taskId=taskId 返回示例 "message": "", "data": "requestid": "572c2e3bb5e78548dcb4f1fe" 7.3 查询应用下的截图配置 功能描述 根据应用标识 流名称查询该用户下所有或者某个直播频道的截图配置信息, 支 持按照顺序 / 倒序排序, 支持分页大小 分页页数设置 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 35

43 order 排序 String 排序,asc: 升序,desc: 降序, 默认 :asc pagesize 分页大小 Long 分页大小, 默认 3000, 最大 3000, 取值 :1~3000 之前的任意 整数 否 否 pagenumber 当前页数 long 展示出的页数编号, 默认 1 否 返回参数 参数含义格式说明 livestreamsnaps hotconfiglist 截图配置 LiveStreamSnapshotConfig[] pagesize 每页大小 Integer order 排序 String numtotal 符合条件的总个数 Integer pagenum 当前页 Integer LiveStreamSnapshotConfig 数据类型 参数 含义 格式 说明 createtime 创建时间 String 时间格式 :yyyy-mm-dd HH:mm:ss appname 应用名称 String timeinterval 截图周期 String streamname 流名称 String taskid 任务 id String 该条任务 Id 请求示例 域名 ]/snapshot/describelivesnapshotconfig?appname=dnc19d 返回示例 "message": "", "data": "requestid": "A3136B CA-B A0", "livestreamsnapshotconfiglist": "livestreamsnapshotconfig": [ 36

44 "createtime": " T01:33:38Z", "appname": "xxx", "timeinterval": 10, "taskid": "23572c2e3bb5e78548dcb4f1fe23" ], "pagenum": 1, "pagesize": 10, "order": "asc", "numtotal": 更新截图配置 功能描述 根据应用标识 流名称 任务 ID 及截图周期更新该直播频道的截图配置, 更新 成功后将即时生效 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 taskid 任务 id String 任务唯一标识 是 timeinterval Int 截图周期, 范围 :5~3600, 单位秒 是 返回参数 参数 含义 格式 说明 taskid 任务 id String 任务唯一标识 请求示例 域 名 ]/snapshot/updateliveappsnapshotconfig?appname=dnc19d&timeinterval=300 &taskid=taskid 37

45 7.4.5 返回示例 "message": "", "data": taskid : taskid "requestid": "A3136B CA-B A0" 7.5 查询截图信息 功能描述根据应用标识 流名称及时间周期查询该用户下某个直播频道的截图内容, 返回截图信息列表 38

46 7.5.2 请求参数属性 含义 类型 说明 必填 streamname 流名称 String 是 starttime 开始时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 是 endtime 结束时间 String 时间格式 :yyyy-mm-dd HH:mm:ss 是 结束时间, 格式 : :36:00,EndTime 和 StartTime 之间的间隔不能超过 1 天 返回参数 参数含义格式说明 livestreamsnapshotinfo 截图信息 livestreamsnapsho 截图内容列表, 没有则返 List tinfo[] 回空数组 livestreamsnapshotconfig 数据类型参数含义格式说明 createtime 创建时间 String 时间格式 :yyyy-mm-dd HH:mm:ss imageurl 图片地址 String 请求示例 域名 ]/snapshot/describelivestreamsnapshotinfo?appname=dnc19d&streamname=3 00&startTime=startTime&endTime=endTime 返回示例 "message": "", "data": "livestreamsnapshotinfolist": "livestreamsnapshotinfo": [ "createtime": " : 41: 09", "imageurl": "3.jpg" 39

47 ], "requestid": "A3136B CA-B A0" 第 8 章直播鉴权 8.1 鉴权 URL 描述 URL 鉴权功能旨在保护用户站点的内容及通道资源不被非法站点盗用 URL 鉴权功能是通过视频云直播服务与客户资源站点配合实现的一种更为安全可靠的资源防盗方法 由客户站点提供给用户加密 URL( 包含权限验证信息 ), 用户使用加密后的 URL 向加速节点发起请求, 加速节点对加密 URL 中的权限信息进行验证以判断请求的合法性, 对合法请求给予正常响应, 拒绝非法请求, 从而有效保护客户资源 目前仅支持对推流通道的 URL 鉴权保护服务 8.2 鉴权 URL 组成 组成部分 : 直播推流地址 + 验证串, 验证串是根据鉴权 key 通过 md5 算法计算出的大写 32 位加密字符串的前 8 位 该地址适用于 PC 端 移动端及第三方推流工具 MD5: appname/streamname-key 鉴权 KEY: 用户可以自行设置, 不超过 20 个英文字符 加密推流 URL 构成 : rtmp://domainname/appname/streamname?k=md5hash 其中,md5hash 中的英文字母为大写字母, 加密推流 URL 中的 md5hash 仅取值的前 8 位 鉴权字段描述字段含义类型说明 md5hash 鉴权密钥 String 通过 md5 算法计算出的 32 位验证串, 由数字和大写英文字母 0-9,A-Z 组合而成 URL 中需写入验证串的前 8 位 40

48 Md5 前的源字符串组合方式为 : appname/streamname-key 8.3 添加直播鉴权 功能描述 根据应用标识 流名称及鉴权秘钥为该用户下某个直播频道添加直播鉴权信息 添加成功后鉴权验证默认开启, 该直播通道将不会被非法站点随意盗推使用 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 key 鉴权密钥 String 用户自定义的鉴权秘钥, 支持 数字与英文字母, 长度不超过 20 字符 是 请求示例 域名 ]/auth/addliveauthentication?appname=dnc19d&streamname=streamname& key= 返回示例 "message": "", "data": "requestid": "572c2e3bb5e78548dcb4f1fe" 8.4 关闭直播鉴权 功能描述根据应用标识及流名称删除该用户下某一个直播频道的鉴权信息并关闭鉴权验证 41

49 8.4.2 请求参数属性 含义 类型 说明 必填 streamname 流名称 String 是 请求示例 域 名 ]/auth/deleteliveauthentication?appname=dnc19d&streamname=streamname 返回示例 "message": "", "data": "requestid": "572c2e3bb5e78548dcb4f1fe" 8.5 更新直播鉴权 功能描述 根据应用标识 流名称 鉴权秘钥和失效时间的时间戳更新该用户下某一个直播 频道的鉴权信息 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 key 鉴权密钥 String 是 请求示例 域 名 ]/auth/updateliveauthentication?appname=dnc19d&streamname=streamnam e 返回示例 42

50 "message": "", "data": "requestid": "572c2e3bb5e78548dcb4f1fe" 第 9 章直播鉴黄 9.1 添加鉴黄配置 功能描述 根据应用标识 流名称 鉴黄周期及回调地址创建直播鉴黄任务, 鉴黄周期支持 5~3600 秒内任意整数配置, 配置成功后将即时生效 鉴黄任务开启中, 会实时将当前鉴黄结果进行回调 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 timeinterval 鉴黄周期, 范围 : Integer 鉴黄周期, 范围 :5~3600, 单 是 5~3600, 单位秒 位秒 callbackurl 回调地址 String 根据回调地址, 回调鉴黄结果 是 返回参数 参数 含义 格式 说明 taskid 任务 id String 任务唯一标识 请求示例 域 名 ]/detectporn/addlivesnapshotdetectporn?appname=dnc19d&streamname=we e12&timeinterval=4&callbackurl= 43

51 9.1.5 返回示例 "message": "", "data": "taskid": "572c2e3bb5e78548dcb4f1fe", "requestid": "572c2e3bb5e78548dcb4f1fe" 下发鉴黄后, 回调鉴黄结果, 返回参数为 json 属性 含义 类型 说明 sourceurl 流地址 String imageurl 图片地址 String result 鉴黄结果 result 鉴黄结果集合 result 集合 属性 含义 类型 说明 scene String 风险场景 suggestion String 取值范围 :[ pass, review, block ], pass: 图片正常,review: 需要人工审核,block: 图片违规 label String 该文本的分类 normal: 正常,sexy: 性感图片,porn: 色情 rate String 结果为该分类的概率 ; 值越高, 越趋于该分类 ; 取值为 [ ] 回调示例 "imageurl": " "sourceurl": "rtmp://hwzbout.yunshicloud.com/aaa6/123", "result": "rate": 99.95, "scene": "porn", "suggestion": "pass", 44

52 "label": "normal" 9.2 查询鉴黄任务 功能描述 根据应用标识 流名称查询该用户下某一个通道的鉴黄设置, 返回任务 id 请求参数 属性 含义 类型 说明 必填 streamname 流名称 String 是 返回参数参数 含义 格式 说明 taskid 任务 id String 任务唯一标识 请求示例 域名 ]/detectporn/describelivesnapshottaskid?appname=7n7dzk&strea mname=60i4k 返回示例 "message": "", "data": "requestid": "572c2e3bb5e78548dcb4f1fe" 9.3 删除鉴黄配置 功能描述根据应用标识 流名称 任务 ID 删除该用户下截图设置, 删除成功后将即时生效, 该用户的直播内容将停止截图 请求参数属性含义类型说明必填 45

53 streamname 流名称 String 是 taskid 任务 id String 任务唯一标识是 请求示例 域名 ]/snapshot/deletelivesnapshotdetectporn?appname=dnc19d&streamname=d 1c17d&taskId=taskId 返回示例 "message": "", "data": "requestid": "572c2e3bb5e78548dcb4f1fe" 第 10 章直播错误码 错误码 描述 状态码 说明 failure 处理失败 1 Input Parameter Invalid 输入参数不合法 fuwuqierror 服务内部异常 failurenotchannle 不存在该通道 inpouttlday 开始和结束时间不能超过 30 天 failurealready 已经禁止 failureforbit 直播流被禁止 failurenowpull 直播流正在进行拉流或已经预定 failurenotpulltaskid 不存在任务 failurepull 下发拉流失败 failurestoppull 停止拉流失败 failurepulltime 结束时间和开始时间间隔在 2 天 内, 且结束时间要大于开始时间 failurepullnowtime 结束时间不能小于当前时间

54 failurerecordtime 最小周期时间 15 分钟最多 6 小 时 failurenowrecord 直播流正在进行收录或已经预定 failurerecord 下发收录失败 failurestoprecord 停止收录失败 failurenotrecordtaskid 不存在任务 id failurerecordnow 该直播流已存在截图配置 failurerecordendtime 结束时间不能小于当前时间 failureusetanscode 已经存在转码配置 failurebtanscode 下发转码失败, failurenotauthchannle 该通道没有鉴权无法关闭 failuresnapshottime 截图周期超过范围 failuresnapshot 下发截图失败 failuresnapshotdetele 删除截图配置失败 failuresnapshotupte 更新截图配置失败 failuresnapshotnow 该直播流已存在截图配置 failuresnapshotonetime 结束时间和开始时间间隔在 1 天 内 failuretime 时间格式错误 failuredetecttime 审核周期超过范围 failuredetectnow 该直播流已存在审核配置 failuredetect 添加鉴黄失败 failurestreamname 流名称错误 failurechannelexist 通道已存在 failureappname 应用名称错误 ExistAppName 应用名称已经存在