开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
    • 直播地址
      • batchModifyLivePlan(批量修改直播计划时间)
      • bindDeviceLive(创建设备源直播地址)
      • createDeviceFlvLive(创建设备 FLV 直播:实况与录像回放)
      • createDeviceRecordHls(根据设备录像片段生成 HLS 直播地址)
      • createDeviceRtmpLive(创建 RTMP 协议直播地址)
      • deleteDeviceFlvLive(删除设备 FLV 实况直播)
      • deleteDeviceRtmpLive(删除 RTMP 协议直播地址)
      • getLiveStreamInfo(查询设备通道直播地址信息)
      • liveList(获取直播列表)
      • modifyLivePlan(修改直播计划时间)
      • modifyLivePlanStatus(设置直播计划开关)
      • queryDeviceFlvLive(查询设备 FLV 实况直播)
      • queryDeviceRtmpLive(查询 RTMP 协议直播地址)
      • queryLiveStatus(查询直播状态)
      • unbindLive(删除直播地址)
    • 推送配置
    • 云存储
    • 资源池额度管理
    • 旧版接口(不再维护)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能说明
请求地址
请求格式
请求参数
请求体根字段
请求示例
返回 data 字段
响应根字段
响应示例
错误码
说明
相关参考

createDeviceFlvLive(创建设备 FLV 直播:实况与录像回放)

createDeviceFlvLive:创建设备 FLV 直播:实况与录像回放

功能说明

根据设备序列号与通道号创建 FLV 协议直播地址,支持实况(realTime)与录像回放(playback)。

请求地址

https://openapi-[DataCenter].easy4ip.com/openapi/createDeviceFlvLive

请求格式

POST JSON 请求体见 请求约定;签名见 签名。

请求参数

参数名参数类型是否必填默认值合法取值参数说明
tokenString是管理员 accessToken
deviceIdString是设备序列号
channelIdString是通道号
typeString否realTimerealTime、playback直播类型:realTime 实况;playback 录像回放
beginTimeString否type 为 playback 时必填;回放起始时间,格式 yyyy-MM-dd HH:mm:ss;与 endTime 最大跨度 24 小时,可跨自然日
endTimeString否type 为 playback 时必填;回放截止时间,格式 yyyy-MM-dd HH:mm:ss
recordTypeString否localRecord、cloudRecordtype 为 playback 时必填;localRecord 本地录像;cloudRecord 云录像
speedInteger否1云录像 2/4/8/16;本地录像 2/4/8回放倍速,仅 playback 生效

请求体根字段

字段名字段类型字段说明
systemObject鉴权与版本
idString请求 ID
paramsObject业务参数,见上表

请求示例

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603366946,
 "nonce":"2e84717c-0f22-4424-8afe-19bab0d6d606"
 },
 "id":"051824b1-9655-4755-9cc2-adcc9ab5fef1",
 "params":{
 "deviceId":"TESTQWERXXXX",
 "channelId":"0",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a",
 "type": "playback",
 "beginTime": "2022-01-01 10:50:50",
 "endTime": "2022-01-02 10:50:50",
 "recordType": "localRecord",
 "speed": 2
 }
}

返回 data 字段

字段名字段类型字段说明
deviceIdString设备序列号
channelIdString设备通道号
flvString标清 FLV 地址
flvHDString高清 FLV 地址

响应根字段

字段名字段类型字段说明
resultObject返回结果
idString请求 ID

响应示例

{
 "result":{
 "msg":"操作成功.",
 "code":"0",
 "data":{
 "deviceId": "TESTQWERXXXX",
 "channelId": "0",
 "flv": "https://flvproxy-hzpaas-hzaliedge.lechange.com:7088/vod/c4908bc67e190fcd8c4b090bc4f6a099.flv?expire=1645511833&digest=cd7cb066fad01a9c6834f26af796406c",
 "flvHD": "https://flvproxy-hzpaas-hzaliedge.lechange.com:7088/vod/031bafb40770a8c129a9be993f62c79f.flv?expire=1645511833&digest=789d50426fcff6b2bf8959f6c26dc8cc"
 }
 },
 "id":"051824b1-9655-4755-9cc2-adcc9ab5fef1"
}

错误码

本接口可能返回下列码;完整分组见 错误码 与 能力错误码。

网关与鉴权(SN / TK / OP)

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

更多见 错误码 · OP/SN/TK。

子账号(SUB)

错误码错误码说明下一步
SUB1001–SUB1002子账号无接口权限在 addPolicy 中补策略
SUB1005子账号 token 过期重新 subAccountToken
SUB1006子账号与设备无授权核对 Resource 与设备序列号
SUB1008子账号未绑定应用先创建并绑定子账号

更多见 错误码 · SUB。

设备访问与通道(DV10xx)

错误码错误码说明下一步
DV1007设备离线或超时等设备上线
DV1009设备正忙稍后重试
DV1012分享/授权设备权限不足核对子账号 Permission / Resource
DV1019能力集不支持确认型号与能力列表
DV1020通道离线检查通道状态
DV1026不支持此功能换接口或升级固件
DV1028未绑定或通道不存在核对 deviceId / channelId

更多见 错误码 · DV。

直播绑定(LV)

错误码错误码说明下一步
LV1001直播已存在先 unbindLive 或换源
:---:---:---
LV1002直播不存在先创建直播
:---:---:---
LV1005直播信息不存在核对直播 id
:---:---:---
LV1006同 rtsp 源当日仅可绑一次次日再绑
:---:---:---
LV1008需实名认证在开放平台完善主体信息
:---:---:---
LV1020已绑定直播无法删除先解绑
:---:---:---
OP1021获取播放地址失败检查直播状态与套餐
:---:---:---
OP1022需开启云解码授权按返回说明在 App 中授权

更多见 错误码 · LV。

说明

仅支持管理员 accessToken。FLV 按 deviceId+channelId 管理,不需 bindDeviceLive 的 HLS liveToken。

  • type=realTime(默认):实况写入平台,可用 deleteDeviceFlvLive / queryDeviceFlvLive 删查;同通道重复创建可能返回 LV1001。
  • type=playback:一次性点播 URL,不入库;到期失效后勿用 delete/query 清理。localRecord 前请确认时间段内有录像;国标设备本地录像场景下 flv 与 flvHD 可能相同。
  • Ot_ 前缀 OAuth token 创建 realTime 可能返回不支持鉴权操作类错误,请使用管理员 accessToken。

相关参考

  • 开发规范
  • 公共约定
  • 本模块索引
bindDeviceLive(创建设备源直播地址)
createDeviceRecordHls(根据设备录像片段生成 HLS 直播地址)