直播拉流

通过设备id获取设备可直播的拉流地址

  • 接口名称：http://${host}/open/v1/getdeviceliveaddr
  • 请求方式：GET
  • 请求参数：
字段 类型 必填 说明
device_id string true 设备ID，填写IMEI即可
client_code string false 客户端识别码，用来区分不同的客户端使用者，保证唯一即可
channel int true 需要观看的设备摄像头通道号
prechannel int false 之前观看的设备摄像头通道号，用来在多通道之间切换
appkey string true appkey
  • 返回参数：
字段 类型 必填 说明
device_id string true 设备ID，即imei
live_addr string true 直播地址
channel string true 当前通道号
  • 请求示例：
  • http://localhost:8080/为测试URL，线上URL请联系商务人员
curl http://localhost:8080/open/v1/getdeviceliveaddr?device_id=123456789&client_code=12432&channel=1&prechannel=0&appkey=e0a135db3808ae6bc734a2ab7bda5c31
  • 返回值：
{
    "error":0,                              //错误码，0为成功，非0失败
    "reason":"success",                     //错误描述
    "result": {
        "device_id": "xxxx",                //设备ID，即imei  
        "live_addr": "rtmp://xxxx/xxx",     //直播地址
        "channel":1                         //当前通道号
    }
}

远程抓拍命令

图片指令下发接口，该接口适用于第三方平台抓拍图片

  • 接口名称：http://URL/api/PicCmd
  • 请求方式：POST
  • 请求参数：
字段 类型 必填 说明
userID int false 用户ID，没有可不填
imei string true IMEI号，不能为空
imgMax string true 图片分辨率（1-7）：
1-240 × 320（默认）
2-320 × 480
3-360 × 640
4-480 × 800
5-640 × 960
6-720 × 1280
7-更高分辨率 目前不支持，默认为直播的分辨率
imgCount int true 图片张数 默认为1张，暂不支持多张
photoInterval int true 抓拍间隔 时长（2位）
channel string true 通道号,0为前置,1为后置
callback_url string true 合作方的回调url地址，我司会将拍照结果发送到该地址
  • 返回参数：
字段 类型 必填 说明
serialNumber string false 事件唯一流水，只有成功时才有
  • 请求示例：
  • http://localhost:8080/为测试URL，线上URL请联系商务人员
curl http://localhost:8080/api/PicCmd
-X POST -d "
{
    "userID": "111",
    "IMEI":"121212311121",
    "imgMax": "1",
    "imgCount": "1",
    "photoInterval":"1001",
    "channel": "0",
    "callback_url":"www.test.com"
}
"
  • 返回值：
{
    "error":0,                       //错误码，0为成功，非0失败
    "reason":"",                     //错误描述
    "result": {
        "serialNumber": "12345"      //事件唯一流水  
    }
}

拍照结果回调

我司将拍照结果发送给合作方，合作方提供该接口；

  • 接口名称：http://URL/XXX
  • 请求方式：POST
  • 请求参数：
字段 类型 必填 说明
imei string true 设备imei号
event_type int true 事件类型
101-远程抓拍图片
103-远程抓拍视频
event_time string true 事件触发时间
pos json true 事件发生时的位置信息
key_video_url string true 关键视频云端url
key_thum_url string false 关键视频缩略图的云端url
key_image_url array false 关键图片云端url
serialNumber int true 抓拍事件流水号
processFailState int false 抓拍事件状态
channel int false 设备摄像头通道号
userid int false 抓拍指令附带的userid，如果没有可不填
  • 返回参数：
字段 类型 必填 说明
serialNumber string false 事件唯一流水，只有成功时才有
  • 请求示例：
  • http://localhost:8080/为测试URL，线上URL请联系商务人员
curl http://localhost:8080/api/PicCmd
-X POST -d "
{
    "imei":"11111111",    
    "event_type":101,              
    "event_time":"20160412142332",     
    "pos":{                                  
        "lng":112.33424,
        "lat":23.2434,
        "speed":35,
        "gpstime":"20160412142231",
        "direct":235
    }
    "key_video_url": "关键视频云端url",                
    "key_thum_url":"关键视频缩略图的云端url",
        "key_image_url":["关键图片1云端url","关键图片2云端url", "关键图片3云端url",  ]
       "serialNumber":12345,
       "processFailState":0,
       "channel":0,
       "userid":1
}
"
  • 返回值：
{
    "error":0,                       //错误码，0为成功，非0失败
    "reason":"",                     //错误描述
    "result": {
        "serialNumber": "12345"      //事件唯一流水  
    }
}