5.1 接口描述
直播回放接口是用来查看实时和历史视频数据的接口。
5.2 接口列表
接口名称 | 接口描述 |
---|---|
/media/live/start | 开始远程直播 |
/media/live/stop | 结束远程直播 |
/media/playback/start | 开始远程回放 |
/media/playback/stop | 结束远程回放 |
/media/video/getList | 获取回放视频列表 |
/media/motionDetection/getList | 获取动态侦测视频列表 |
/media/playback/getSnapshot | 获取指定时间的监控图片 |
/media/live/getSnapshot | 获取实时监控图片 |
5.3 接口详情
5.3.1 开始远程直播
接口描述:通过本接口调用,用户可以开始远程直播。
请求链接:/media/live/start
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_shop_no | 否 | string | 商米数字店铺平台的门店组织编号 | 100939020409 |
shop_id | 否 | string | 第三方对接软件中门店的标识,对接的软件提供 (作为门店唯一标识即可,shop_id与sunmi_shop_no可互为替代,使用时传输任意一个即可) | 10087 |
ipc_id | 否 | string | 摄像机设备唯一ID 摄像机SN(与ipc_sn必出现其一, 若同时输入,必须一致 ) | 549755805835 |
ipc_sn | 否 | string | 摄像机SN(与ipc_id必出现其一, 若同时输入,必须一致 ) | C101P98200023 |
resolution | 是 | int | 分辨率 | 0 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/media/live/start",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"app_id": "LMWWQVTW4QGCC",
"ipc_id": "549755805835",
"resolution": 0,
"timestamp": 1581383983,
"random": "5dsf6698",
"sign": "33C18A18282733A71F998BB5A5E4319D"
}
返回值:
{
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed"
"data": {
"url": "https://xxxxxxxx/C101P98200023/1219130724381102080.flv?auth_key=1579501989-729716105000265001016467621435-0-",
"hls_url": "https://xxxxxxxx/C101P98200023/1219130724381102080.m3u8?auth_key=1579501989-729716105000265001016467621435-0-"
}
}
字段描述:resolution
resolution 取值 | 说明 |
---|---|
0 | 超清 |
1 | 高清 |
错误码:
错误码 | 说明 |
---|---|
5000 | 数据库错误 |
5011 | 与设备通讯错误 |
5013 | 未找到数据 |
5501 | ipc设备不存在 |
5510 | 设备未绑定 |
5.3.2 结束直播
接口描述:通过本接口调用,用户可以结束远程直播。
请求链接:/media/live/stop
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_shop_no | 否 | string | 商米数字店铺平台的门店组织编号 | 100939020409 |
shop_id | 否 | string | 第三方对接软件中门店的标识,对接的软件提供 (作为门店唯一标识即可,shop_id与sunmi_shop_no可互为替代,使用时传输任意一个即可) | 10087 |
ipc_id | 否 | string | 摄像机设备唯一ID 摄像机SN(与ipc_sn必出现其一, 若同时输入,必须一致 | 549755805835 |
ipc_sn | 否 | string | 摄像机SN(与ipc_id必出现其一, 若同时输入,必须一致 ) | C101P98200023 |
resolution | 是 | int | 分辨率 | 0 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/media/live/stop",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"app_id": "LMWWQVTW4QGCC",
"ipc_id": "549755805835",
"resolution": 0,
"timestamp": 1581383983,
"random": "5dsf6698",
"sign": "33C18A18282733A71F998BB5A5E4319D"
}
返回值:
{
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed",
"data": {}
}
字段描述:resolution
resolution 取值 | 说明 |
---|---|
0 | 超清 |
1 | 高清 |
错误码:
错误码 | 说明 |
---|---|
5000 | 数据库错误 |
5013 | 未找到数据 |
5011 | 与设备通讯错误 |
5501 | ipc设备不存在 |
5510 | 设备未绑定 |
5.3.4 获取回放视频列表
接口描述:通过本接口调用,用户可以获取回放视频列表。
请求链接:/media/video/getList
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_shop_no | 否 | string | 商米数字店铺平台的门店组织编号 | 100939020409 |
shop_id | 否 | string | 第三方对接软件中门店的标识,对接的软件提供 (作为门店唯一标识即可,shop_id与sunmi_shop_no可互为替代,使用时传输任意一个即可) | 10087 |
ipc_id | 否 | string | 摄像机设备唯一ID 摄像机SN(与ipc_sn必出现其一, 若同时输入,必须一致 ) | 549755805835 |
ipc_sn | 否 | string | 摄像机SN(与ipc_id必出现其一, 若同时输入,必须一致 ) | C101P98200023 |
start_time | 是 | int | 开始查询时间,Unix时间戳,秒级别 | 1578969264 |
end_time | 是 | int | 结束查询时间,Unix时间戳,秒级别 | 1578972864 |
备注:
start_time与end_time时间区间限制为3600s
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/media/video/getList",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"app_id": "LMWWQVTW4QGCC",
"ipc_id": "549755805835",
"start_time": 1578969264,
"end_time": 1578969264,
"timestamp": 1578972864,
"random": "5dsf6698",
"sign": "33C18A18282733A71F998BB5A5E4319D"
}
返回值:
{
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed",
"data": {
"total_count": 1,
"video_list": [{
"ipc_id": "549755812970",
"url": "http: //xxxxxxxx/VIDEO/IPC/SS101D8BS00087/39C1045AF2EA34B0CEA528FB228C8EDA",
"start_time": 1551854897,
"end_time": 1551854958
}]
}
}
错误码:
错误码 | 说明 |
---|---|
5000 | 数据库错误 |
5013 | 未找到数据 |
5021 | 非法参数(时间区间超限) |
5.3.5 获取动态侦测视频列表
接口描述:通过本接口调用,用户可以获取回放视频列表。
请求链接:/media/motionDetection/getList
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_shop_no | 否 | stirng | 商米数字店铺平台的门店组织编号 | 100939020409 |
shop_id | 否 | string | 第三方对接软件中门店的标识,对接的软件提供 (作为门店唯一标识即可,shop_id与sunmi_shop_no可互为替代,使用时传输任意一个即可) | 10087 |
ipc_id | 否 | string | 摄像机设备唯一ID 摄像机SN(与ipc_sn必出现其一, 若同时输入,必须一致 ) | 549755805835 |
ipc_sn | 否 | string | 摄像机SN(与ipc_id必出现其一, 若同时输入,必须一致 ) | C101P98200023 |
start_time | 是 | int | 开始查询时间,Unix时间戳,秒级别 | 1578969264 |
end_time | 是 | int | 结束查询时间,Unix时间戳,秒级别 | 1579055640 |
page_num | 否(默认1) | int | 当前页码 | 1 |
page_size | 否(默认10) | int | 当前页条目数量 (最大条目数量为100) | 10 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/media/motionDetection/getList",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"app_id": "LMWWQVTW4QGCC",
"ipc_id": "549755805835",
"start_time": 1578969264,
"end_time": 1579055640,
"timestamp": 1578972864,
"random": "5dsf6698",
"sign": "33C18A18282733A71F998BB5A5E4319D"
}
返回值:
{
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed",
"data": {
"total_num": 1,
"video_list": [{
"source": "1",
"detect_time": 1551854897,
"url": "http: //xxxxxxxx/VIDEO/IPC/SS101D8BS00087/39C1045AF2EA34B0CEA528FB228C8EDA"
}]
}
}
字段描述:source
source 取值 | 说明 |
---|---|
1 | 画面 |
2 | 声音 |
3 | 声音和画面 |
错误码:
错误码 | 说明 |
---|---|
5000 | 数据库错误 |
5013 | 未找到数据 |
5.3.6 获取指定时间的监控图片
接口描述:通过本接口调用,用户可以获取指定时间的监控图片。
请求链接:/media/playback/getSnapshot
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_shop_no | 否 | string | 商米数字店铺平台的门店组织编号 | 100939020409 |
shop_id | 否 | string | 第三方对接软件中门店的标识,对接的软件提供 (作为门店唯一标识即可,shop_id与sunmi_shop_no可互为替代,使用时传输任意一个即可) | 15220 |
ipc_id | 否 | string | 摄像机设备唯一ID 摄像机SN(与ipc_sn必出现其一, 若同时输入,必须一致 ) | 549755812970 |
ipc_sn | 否 | string | 摄像机SN(与ipc_id必出现其一, 若同时输入,必须一致 ) | C101P98200023 |
time | 是 | int | 截图时间,Unix时间戳,秒级别 | 1579055640 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/media/playback/getSnapshot",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"app_id": "LMWWQVTW4QGCC",
"ipc_id": "549755805835",
"time": 1579055640,
"timestamp": 1578972864,
"random": "5dsf6698",
"sign": "33C18A18282733A71F998BB5A5E4319D"
}
返回值:
{
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed",
"data": {
"snapshot_url":"http://xxxxxxxx/VIDEO/IPC/SS101D8BS00087/39C1045AF2EA34B0CEA528FB228C8EDA"
}
}
错误码:
错误码 | 说明 |
---|---|
5000 | 数据库错误 |
5013 | 未找到数据 |
5.3.7 获取实时监控图片
接口描述:通过本接口调用,用户可以获取实时监控图片, 图片有效期为一天。
请求链接:/media/live/getSnapshot
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_shop_no | 否 | string | 商米数字店铺平台的门店组织编号 | 100939020409 |
shop_id | 否 | string | 第三方对接软件中门店的标识,对接的软件提供 (作为门店唯一标识即可,shop_id与sunmi_shop_no可互为替代,使用时传输任意一个即可) | 10087 |
ipc_id | 否 | string | 摄像机设备唯一ID 摄像机SN(与ipc_sn必出现其一, 若同时输入,必须一致 ) | 549755805835 |
ipc_sn | 否 | string | 摄像机SN(与ipc_id必出现其一, 若同时输入,必须一致 ) | C101P98200023 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/media/live/getSnapshot",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"app_id": "LMWWQVTW4QGCC",
"ipc_id": "549755805835",
"timestamp": 1578972864,
"random": "5dsf6698",
"sign": "33C18A18282733A71F998BB5A5E4319D"
}
返回值:
{
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed",
"data":{
"snapshot_url":"http://xxxxxxxx/VIDEO/IPC/SS101D8BS00087/39C1045AF2EA34B0CEA528FB228C8EDA"
}
}
错误码:
错误码 | 说明 |
---|---|
5000 | 数据库错误 |
5011 | 与设备端通讯错误 |
5013 | 未找到数据 |
5501 | ipc设备不存在 |
5510 | 设备未绑定 |
5515 | 超出截图时常 |
5.3.8 开始远程回放
接口描述: 通过本接口调用,用户可以开始远程回放。
请求链接: /media/playback/start
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_shop_no | 否 | string | 商米数字店铺平台的门店组织编号 | 100939020409 |
shop_id | 否 | string | 第三方对接软件中门店的标识,对接的软件提供 (作为门店唯一标识即可,shop_id与sunmi_shop_no可互为替代,使用时传输任意一个即可) | 10087 |
ipc_id | 否 | string | 摄像机设备唯一ID 摄像机SN(与ipc_sn必出现其一, 若同时输入,必须一致 ) | 549755805835 |
ipc_sn | 否 | string | 摄像机SN(与ipc_id必出现其一, 若同时输入,必须一致) | C101P98200023 |
start_time | 是 | int | 开始查询时间,Unix时间戳,秒级别 | 1578969264 |
end_time | 是 | int | 结束查询时间,Unix时间戳,秒级别 | 1579055640 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/media/playback/start",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"app_id": "LMWWQVTW4QGCC",
"ipc_id": "549755805835",
"start_time": 1578969264,
"end_time": 1579055640,
"timestamp": 1578972864,
"random": "5dsf6698",
"sign": "33C18A18282733A71F998BB5A5E4319D"
}
返回值:
{
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed",
"data": {
"url": "https://xxxxxxxx/SAAS-OpenAPI_1211497245552152576/1577092646.flv?auth_key=1577096246-57626095498907571693914212321441-0-",
"hls_url": "https://xxxxxxxx/SAAS-OpenAPI_1211497245552152576/1577092646.m3u8?auth_key=1577096246-57626095498907571693914212321441-0-",
"client_id": "SAAS-OpenAPI_1211497245552152576"
}
}
错误码:
错误码 | 说明 |
---|---|
5021 | 非法参数(时间区间超限) |
5087 | 无匹配数据 |
5088 | 数据库错误 |
5506 | 未查询到数据 |
5.3.9 结束远程回放
接口描述: 通过本接口调用,用户可以开始远程回放。
请求链接: /media/playback/stop
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
client_id | 是 | string | 用户client id | SAAS-OpenAPI_1211497245552152576 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/media/playback/stop",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"client_id": "SAAS-OpenAPI_1211497245552152576",
"app_id": "LMWWQVTW4QGCC",
"timestamp": 1578972864,
"random": "5dsf6698",
"sign": "33C18A18282733A71F998BB5A5E4319D"
}
返回值:
{
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed",
"data": {}
}
错误码:
错误码 | 说明 |
---|---|
5020 | 无效参数 |