liveList(获取直播列表)
liveList:获取直播列表
要点:https://openapi.lechange.cn/openapi/liveList · 见 错误码
获取开发者当前账号下创建的直播详情列表,包含直播地址、直播状态、直播计划等详细信息。
备注:需先通过bindDeviceLive创建直播地址,否则无法获取直播信息。
请求参数
| 参数名 | 参数类型 | 是否必填 | 默认值 | 合法值 | 参数说明 |
|---|---|---|---|---|---|
| token | String | 是 | 管理员accessToken | ||
| queryRange | String | 是 | 查询范围 数字取值范围为:[1,N] (N为正整数,且N>1);差值范围为:[0,99] |
请求示例
{
"system":{
"ver":"1.0",
"appId":"lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"time":1603367402,
"nonce":"10ba3958-b861-4284-acfe-28cf5f3955dd"
},
"id":"1cd43fdb-810b-44f4-8652-9d232dd95f1b",
"params":{
"token": "<yourAccessToken>",
"queryRange":"1-10"
}
}
响应字段
| 字段名 | 字段类型 | 字段说明 | ||
|---|---|---|---|---|
| count | Integer | 本响应 `lives` 数组条数(过滤后),非账号直播总数 | ||
| lives | liveToken | String | 直播token,设备通道直播的唯一标识 | |
| liveStatus | Integer | 直播状态:`1` 开启;`2` 暂停;`3` 流量不足暂停(关播且变更原因为流量不足)。`4` 等内部态可能不出现在列表 | ||
| liveType | Integer | 直播源类型,1:设备源 | ||
| deviceId | String | 设备序列号 | ||
| channelId | Integer | 通道号 | ||
| coverUpdate | Integer | 视频封面更新频率(单位:s) | ||
| streams | hls | String | 直播流hls访问地址 | |
| coverUrl | String | 视频封面url | ||
| streamId | Integer | 码流类型,0:高清主码流,1:标清辅码流 | ||
| job | status | Boolean | 直播计划状态(true:开;false:关) | |
| period | String | 直播计划周期,通过modifyLivePlan或batchModifyLivePlan进行设置 | ||
| beginTime | String | 直播计划开始时间,通过modifyLivePlan或batchModifyLivePlan进行设置 | ||
| endTime | String | 直播计划结束时间,通过modifyLivePlan或batchModifyLivePlan进行设置 | ||
响应示例
{
"result":{
"msg":"操作成功。",
"code":"0",
"data":{
"lives":[
{
"liveType":1,
"coverUpdate":90,
"streams":[
{
"coverUrl":"http://livecloudpic.lechange.cn/LCO/XXXXX000000XXXX/0/0/20200907T032254/dev_XXXXX000000XXXX_20200907T032254.jpg",
"streamId":0,
"hls":"https://cmgw-vpc.lechange.com:8890/LCO/XXXXX000000XXXX/0/0/20200907T032254/dev_XXXXX000000XXXX_20200907T032254.m3u8?proto=https"
},
{
"coverUrl":"http://livecloudpic.lechange.cn/LCO/XXXXX000000XXXX/0/0/20200907T032254/dev_XXXXX000000XXXX_20200907T032254.jpg",
"streamId":1,
"hls":"https://cmgw-vpc.lechange.com:8890/LCO/XXXXX000000XXXX/0/1/20200907T032254/dev_XXXXX000000XXXX_20200907T032254.m3u8?proto=https"
},
{
"coverUrl":"http://livecloudpic.lechange.cn/LCO/XXXXX000000XXXX/0/0/20200907T032254/dev_XXXXX000000XXXX_20200907T032254.jpg",
"streamId":0,
"hls":"http://cmgw-vpc.lechange.com:8888/LCO/XXXXX000000XXXX/0/0/20200907T032254/dev_XXXXX000000XXXX_20200907T032254.m3u8"
},
{
"coverUrl":"http://livecloudpic.lechange.cn/LCO/XXXXX000000XXXX/0/0/20200907T032254/dev_XXXXX000000XXXX_20200907T032254.jpg",
"streamId":1,
"hls":"http://cmgw-vpc.lechange.com:8888/LCO/XXXXX000000XXXX/0/1/20200907T032254/dev_XXXXX000000XXXX_20200907T032254.m3u8"
}
],
"liveToken":"63813c4aa4b442069748437c1bd0b749",
"job":[
{
"period":"always",
"status":true
}
],
"deviceId":"XXXXX000000XXXX",
"liveStatus":1,
"channelId":"0"
}
],
"count":1
}
},
"id":"1cd43fdb-810b-44f4-8652-9d232dd95f1b"
}
错误码
本接口可能返回下列码;完整分组见 错误码。
网关与鉴权(SN / TK / OP)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SN1001 | 签名异常 | 按 签名 核对 sign |
TK1002 | token 无效或过期 | 重新获取 token |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1039 | 分钟级限流 | 等到下一分钟再试 |
OP1040 | 调用超限 | 降低频率 |
DV1007 | 设备离线或超时 | 等设备上线 |
子账号(SUB)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SUB1001 | 子账号无指定权限 | 在 子账号策略 中补权限 |
SUB1002 | 子账号无任何设备权限 | 授权设备或调整策略 |
SUB1005 | 子账号 token 过期 | 重新 获取子账号 token |
SUB1006 | 子账号与设备无授权关系 | 核对 Resource 与设备序列号 |
SUB1008 | 子账号未绑定当前应用 | 先创建并绑定子账号 |
SUB1007 | 创建子账号失败 | 核对参数后重试 |
SUB1009 | 子账号创建失败,账号格式错误 | account 须为手机号或邮箱 |
SUB1010 | 子账号创建失败,账号已存在 | 勿重复绑定同一子账号到应用 |
更多见 错误码 · SUB。
设备访问与通道(DV10xx)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV1007 | 设备离线或超时 | 等设备上线;低电休眠先 唤醒 |
DV1009 | 设备正忙 | 稍后重试 |
DV1012 | 分享/授权设备权限不足 | 核对子账号 Permission / Resource |
DV1019 | 能力集不支持 | 确认型号与 设备能力 |
DV1020 | 通道离线 | 检查通道与设备状态 |
DV1026 | 不支持此功能 | 换接口或升级固件 |
DV1028 | 未绑定或通道不存在 | 核对 deviceId / channelId |
DV1030 | 设备休眠 | 唤醒后再调 |
DV1057 | 通道不存在 | 核对通道号 |
DV1061 | 设备响应超时 | 检查设备网络 |
DV1062 | 需先唤醒设备 | 调用唤醒接口 |
DV1069 | 不满足操作条件 | 见 msg |
直播绑定(LV)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
LV1001 | 直播已存在 | 先 解绑 或换源 |
LV1002 | 直播不存在 | 先创建直播 |
LV1005 | 直播信息不存在 | 核对直播 id |
LV1006 | 同 rtsp 源当日仅可绑一次 | 次日再绑 |
LV1008 | 需实名认证 | 在开放平台完善主体信息 |
LV1020 | 已绑定直播无法删除 | 先解绑 |
OP1021 | 获取播放地址失败 | 检查直播状态与套餐 |
OP1022 | 需开启云解码授权 | 按返回说明在 App 中授权 |
更多见 错误码 · LV。
说明
仅支持管理员 accessToken;子账号不可调用本接口。liveStatus 与单路 streams.status(queryLiveStatus)及 job.status(计划开关)为三套字段,勿混用。