接口列表

本节包含直播地址相关接口等。使用逻辑为：开通直播工单—获取直播地址—不使用时关闭直播功能。未开通直播功能的设备无法获取直播地址。

接口列表如下：

获取用户下直播视频列表

• 接口功能

  该接口适用于已经开通过直播的用户，用以获取账号下的视频地址列表。（绑定地址）

• 请求地址

  https://open.ys7.com/api/lapp/live/video/list

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Get" "Resource":"Cam:序列号:通道号"

• 请求参数

• HTTP请求报文

POST /api/lapp/live/video/list HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&pageStart=0&pageSize=3

• 返回数据

{
    "page": {
        "total": 3,
        "page": 0,
        "size": 3
    },
    "data": [
        {
            "deviceSerial": "427734444",
            "channelNo": 1,
            "deviceName":"萤小石",
            "liveAddress": "http://hls.open.ys7.com/openlive/ed98eeead4c843f898fef1c203313364.m3u8",
            "hdAddress": "http://hls.open.ys7.com/openlive/ed98eeead4c843f898fef1c203313364.hd.m3u8",
            "rtmp": "rtmp://rtmp.open.ys7.com/openlive/ed98eeead4c843f898fef1c203313364",
            "rtmpHd": "rtmp://rtmp.open.ys7.com/openlive/ed98eeead4c843f898fef1c203313364.hd",
            "beginTime": 1462427319000,
            "endTime": 1464077565000,
            "status": 1,
            "exception": 0
        },
        {
            "deviceSerial": "502608888",
            "channelNo": 1,
            "deviceName":"萤小石",
            "liveAddress": null,
            "hdAddress": null,
            "rtmp": null,
            "rtmpHd": null,
            "beginTime": 1459267200000,
            "endTime": 1490803200000,
            "status": 1,
            "exception": 3
        },
        {
            "deviceSerial": "519261888",
            "channelNo": 1,
            "deviceName":"萤小石",
            "liveAddress": null,
            "hdAddress": null,
            "rtmp": null,
            "rtmpHd": null,
            "beginTime": 1459267200000,
            "endTime": 1490803200000,
            "status": 1,
            "exception": 3
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段

注：status表示地址的状态，而exception表示地址相关的设备或者服务状态等异常状态。

• 返回码

获取指定有效期的直播地址

• 接口功能：

  该接口适用于已经开通过直播的用户，用以根据设备序列号和通道号获取指定有效期的直播地址，可用于防盗链。（绑定地址）

• 请求地址

  https://open.ys7.com/api/lapp/live/address/limited

• 请求方式

  POST

• 子账户token请求所需最小权限

  `"Permission":"Get"`     `"Resource":"Cam:序列号:通道号"`
  

• 请求参数

• HTTP请求报文

POST /api/lapp/live/address/limited HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734888&channelNo=1&expireTime=300

• 返回数据

{
    "data": {
        "deviceSerial": "440912222",
        "channelNo": 1,
        "deviceName":"萤小石",
        "liveAddress": "http://open.ys7.com/openlive/temp.m3u8?t=8Yh6jnVwyq6-RU33oaX3nEogqryuNBU2P1Qqce-dT6V-TsLRWj-7kPVukT8lIlvm",
        "hdAddress": "http://open.ys7.com/openlive/temp.hd.m3u8?t=8Yh6jnVwyq6-RU33oaX3nEogqryuNBU2P1Qqce-dT6V-TsLRWj-7kPVukT8lIlvm",
        "rtmp": null,
        "rtmpHd": null,
        "status": 1,
        "exception": 0,
        "beginTime": 1484038680939,
        "endTime": 1484038980939
    },
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段：

注：status表示地址的状态，而exception表示地址相关的设备或者服务状态等异常状态。

• 返回码

开通直播功能

• 接口功能：

  该接口用于根据序列号和通道号批量开通直播功能（只支持可观看视频的设备）。

• 请求地址

  https://open.ys7.com/api/lapp/live/video/open

• 请求方式

  POST

• 子账户token请求所需最小权限

  `"Permission":"Config"`     `"Resource":"Cam:序列号:通道号"`
  

• 请求参数

• HTTP请求报文

POST /api/lapp/live/video/open HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&source=427734222%3A1%2C423344555%3A3

• 返回数据

{
    "code": "200",
    "msg": "操作成功",
    "data": [
        {
            "deviceSerial": "427734222",
            "channelNo": 1,
            "ret": "200",
            "desc": "开通成功!"
        },
        {
            "deviceSerial": "423344555",
            "channelNo": 3,
            "ret": "200",
            "desc": "开通成功!"
        }
    ]
}

• 返回字段：

注意：该接口请求时先解析code属性，如果返回200即表示成功，方可继续解析data属性的内容。

• 返回码

获取直播地址

• 接口功能：

  该接口用于根据序列号和通道号批量获取设备的直播地址信息，开通直播后才可获取直播地址 该接口获取直播地址固定不变,永久有效。

• 请求地址

  https://open.ys7.com/api/lapp/live/address/get

• 请求方式

  POST

• 子账户token请求所需最小权限

  `"Permission":"Get"`     `"Resource":"Cam:序列号:通道号"`
  

• 请求参数

• HTTP请求报文

POST /api/lapp/live/address/get HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&source=427734222%3A1%2C423344555%3A3

• 返回数据

{
    "data": [
        {
            "deviceSerial": "427734203",
            "channelNo": 1,
            "deviceName": "C1(427734203)",
            "hls": "http://test.ys7.com:66/openlive/b475942b03544a5aa35b651670d8712c.m3u8",
            "hlsHd": "http://test.ys7.com:66/openlive/b475942b03544a5aa35b651670d8712c.hd.m3u8",
            "rtmp": "rtmp://10.82.0.190:1935/openlive/b475942b03544a5aa35b651670d8712c",
            "rtmpHd": "rtmp://10.82.0.190:1935/openlive/b475942b03544a5aa35b651670d8712c.hd",
            "status": 1,
            "exception": 0,
            "ret": "200",
            "desc": "获取成功!"
        },
        {
            "deviceSerial": "464575688",
            "channelNo": 1,
            "deviceName": null,
            "hls": null,
            "hlsHd": null,
            "rtmp": null,
            "rtmpHd": null,
            "status": -1,
            "exception": -1,
            "ret": "60020",
            "desc": "不支持该命令"
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段：

注意：该接口请求时先解析code属性，如果返回200即表示成功，可继续解析data属性的内容，每一个地址对象中先解析ret属性，如果返回200表示成功，再根据status属性和exception属性判断是否存在异常。

• 返回码

关闭直播功能

• 接口功能：

  该接口用于根据序列号和通道号批量关闭直播功能。

• 请求地址

  https://open.ys7.com/api/lapp/live/video/close

• 请求方式

  POST

• 子账户token请求所需最小权限

  `"Permission":"Config"`     `"Resource":"Cam:序列号:通道号"`
  

• 请求参数

• HTTP请求报文

POST /api/lapp/live/video/close HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&source=427734222%3A1%2C423344555%3A3

• 返回数据

{
    "code": "200",
    "msg": "操作成功",
    "data": [
        {
            "deviceSerial": "427734222",
            "channelNo": 1,
            "ret": "200",
            "desc": "操作成功!"
        },
        {
            "deviceSerial": "423344555",
            "channelNo": 3,
            "ret": "200",
            "desc": "操作成功!"
        }
    ]
}

• 返回字段：

注意：该接口请求时先解析code属性，如果返回200即表示成功，方可继续解析data属性的内容。

• 返回码