播放地址接口
本节包含播放地址相关接口等。使用逻辑为:开通直播工单—获取直播地址—不使用时关闭直播功能。未开通直播功能的设备无法获取直播地址。
接口列表如下:
序号 | 接口功能 | 描述 |
---|---|---|
1 | 获取播放地址 | 批量获取设备的直播地址信息 |
获取播放地址
接口功能:
该接口用于通过设备序列号、通道号获取单台设备的播放地址信息,无法获取永久有效期播放地址。
请求地址
https://open.ys7.com/api/lapp/v2/live/address/get
请求方式
POST
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 直播源,例如427734222,均采用英文符号,限制50个 | Y |
channelNo | Integer | 通道号,,非必选,默认为1 | N |
code | String | ezopen协议地址的设备的视频加密密码 | N |
expireTime | Integer | 过期时长,单位秒;针对hls/rtmp设置有效期,相对时间;30秒-7天 | N |
protocol | Integer | 流播放协议,1-ezopen、2-hls、3-rtmp、4-flv,默认为1 | N |
quality | Integer | 视频清晰度,1-高清(主码流)、2-流畅(子码流) | N |
startTime | String | ezopen协议地址的本地录像/云存储录像回放开始时间,示例:2019-12-01 00:00:00 | N |
stopTime | String | ezopen协议地址的本地录像/云存储录像回放开始时间,示例:2019-12-01 00:00:00 | N |
type | String | ezopen协议地址的类型,1-预览,2-本地录像回放,3-云存储录像回放,非必选,默认为1 | N |
supportH265 | Integer | 是否要求视频为H265编码格式 | N |
gbchannel | String | 国标设备的通道编号 | N |
- HTTP请求报文
POST /api/lapp/live/address/get HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=C78957921&channelNo=1
- 返回数据
{
"msg": "Operation succeeded",
"code": "200",
"data": {
"id": "254708522214232064",
"url": "https://open.ys7.com/v3/openlive/C78957921_1_1.m3u8?expire=1606999273&id=254708522214232064&t=093e5c6668d981e0f0b8d2593d69bdc98060407d1b2f42eaaa17a62b15ee4f99&ev=100",
"expireTime": "2020-12-03 20:41:13"
}
}
- 返回字段:
字段名 | 类型 | 描述 |
---|---|---|
code | String | 状态码,参考下方返回码。优先判断该错误码,返回200即表示成功。 |
msg | String | 状态描述 |
id | String | 状态描述 |
url | String | 直播地址 |
expireTime | long | 直播地址有效期。expireTime参数为空时该字段无效 |
注意:该接口请求时先解析code属性,如果返回200即表示成功,可继续解析data属性的内容,每一个地址对象中先解析ret属性,如果返回200表示成功,再根据status属性和exception属性判断是否存在异常。
- 返回码
返回码 | 返回消息 | 备注 |
---|---|---|
200 | 操作成功,获取指定有效期的直播地址 | 请求成功 |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found | |
403 | 用户不存在 |