提示

本页参数中 deviceId与serialNumber均为二选一

开始直播

接口地址:/openapi/video/startStream

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
deviceId deviceId query true integer(int64)
serialNumber 序列号 query true String
force 强制播放（播放中，再次发起播放） query false boolean
voice 声音开关 query false boolean
resolution 清晰度0为标清1为高清 query false integer(int32)

响应状态:

状态码 说明 schema
200 OK R«VideoUrlVo»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data VideoUrlVo VideoUrlVo
  flv string
  flvs string
  rtmp string
message string
successful boolean

响应示例:

{
    "code": 200,
    "message": "成功",
    "data": {
        "rtmp": "rtmp://test-pingos.mokan.cn/live/xxx?mokantoken=30092cd922764075a0012fb6e6653281&userId=c59a5d6c-713e-49fe-a9ac-18968023507b&env=test",
        "flv": "http://test-pingos.mokan.cn/flv/xxx?app=live&mokantoken=30092cd922764075a0012fb6e6653281&userId=c59a5d6c-713e-49fe-a9ac-18968023507b&env=test",
        "flvs": "https://test-pingos.mokan.cn/flv/xxx?app=live&mokantoken=30092cd922764075a0012fb6e6653281&userId=c59a5d6c-713e-49fe-a9ac-18968023507b&env=test",
        "warnMes": ""
    },
    "successful": true
}

停止推流

接口地址:/openapi/video/stopStreaming

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
deviceId deviceId query false integer(int64)
serialNumber 序列号 query false String

响应状态:

状态码 说明 schema
200 OK R«boolean»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data boolean
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": true,
    "message": "",
    "successful": true
}

获取回放列表

接口地址:/openapi/video/getPlayBackList

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
deviceId deviceId query false integer(int64)
serialNumber 序列号 query false String
startTime 开始时间戳（毫秒） query true integer(int64)
endTime 结束时间戳毫秒 query true integer(int64)

响应状态:

状态码 说明 schema
200 OK R«JSONObject»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data object
message string
successful boolean

响应示例:

{
    "code": 200,
    "message": "成功",
    "data": {
        "sequence": "server-side-736c7d395d3b",
        "times": [
            {
                "start": "1654639741000",
                "name":"fileName",
                "end": "1654639859000"
            },
            {
                "start": "1654639858000",
                "name":"fileName",
                "end": "1654639924000"
            },
            {
                "start": "1654639958000",
                "name":"fileName",
                "end": "1654640075000"
            }
        ],
        "status": "succes"
    },
    "successful": true
}

开始回放

接口地址:/openapi/video/startPlayBack

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
deviceId deviceId query false integer(int64)
serialNumber 序列号 query false String
startTime 开始时间毫秒 query true integer(int64)
name 文件名 query true String
speed 播放倍速 query false integer
voice 声音开关 query false boolean
force 强制播放 query false boolean

响应状态:

状态码 说明 schema
200 OK R«VideoUrlVo»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data VideoUrlVo VideoUrlVo
  flv string
  flvs string
  rtmp string
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": {
        "flv": "",
        "flvs": "",
        "rtmp": ""
    },
    "message": "",
    "successful": true
}

云台控制

接口地址:/openapi/video/cloudDeckControl

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "cmd": "",
  "deviceId": 0
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
directionControlParam DirectionControlParam body true DirectionControlParam DirectionControlParam
  cmd 方向，cloud_deck_up,cloud_deck_down,cloud_deck_left,cloud_deck_right false string
  deviceId 设备号 false integer(int64)
  serialNumber 序列号 false String

响应状态:

状态码 说明 schema
200 OK R«JSONObject»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data object
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": {},
    "message": "",
    "successful": true
}

语音对讲

web端录音组件：https://xiangyuecn.github.io/Recorder/
推荐比特率 8bit，采样率8000hz

接口地址:/openapi/video/playAudioFile

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
deviceId deviceId query true integer(int64)
serialNumber 序列号 query false String
file mp3格式文件，50KB以下 query true file

响应状态:

状态码 说明 schema
200 OK R«boolean»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data boolean
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": true,
    "message": "",
    "successful": true
}

开始转动云台

接口地址:/openapi/video/startOpDirection

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "cmd": "cloud_deck_left",
  "deviceId": 0,
  "serialNumber": ""
}

请求参数:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
directionControlParam DirectionControlParam body true DirectionControlParam DirectionControlParam
  cmd 方向，cloud_deck_up,cloud_deck_down,cloud_deck_left,cloud_deck_right false string
  deviceId 设备id false integer(int64)
  serialNumber 设备序列号 false string

响应状态:

状态码 说明 schema
200 OK R«boolean»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data boolean
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": true,
    "message": "",
    "successful": true
}

停止转动云台

接口地址:/openapi/video/stopOpDirection

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "cmd": "cloud_deck_left",
  "deviceId": 0,
  "serialNumber": ""
}

请求参数:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
directionControlParam DirectionControlParam body true DirectionControlParam DirectionControlParam
  cmd 方向，cloud_deck_up,cloud_deck_down,cloud_deck_left,cloud_deck_right false string
  deviceId 设备id false integer(int64)
  serialNumber 设备序列号 false string

响应状态:

状态码 说明 schema
200 OK R«boolean»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data boolean
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": true,
    "message": "",
    "successful": true
}

主动拍照

接口地址:/openapi/video/takePhoto

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
serialNumber serialNumber query true string

响应状态:

状态码 说明 schema
200 OK R«string»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data string
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": "",
    "message": "",
    "successful": true
}
作者：admin  创建时间：2021-07-06 11:19
最后编辑：admin  更新时间：2026-01-29 21:48