open.shopweb.device.startPlayRecReq （Start video play）Sandbox debugging
Start video playing (Before accessing this interface, please visit the NVR daily video recording information interface to obtain the video information in which period of the day)
Interface description#
| The environment | Interface method | Submission method | Do you need a signature | HTTP request routing |
|---|---|---|---|---|
| Formal environment | open.shopweb.device.startPlayRecReq | POST | true | http://openapi.opretail.com/m.api |
Common request parameters#
| Parameters | Types of | Is required | The maximum length | Description | Example values |
|---|---|---|---|---|---|
| _aid | String | True | 20 | Open platform system number, fixed to S107 | S107 |
| _akey | String | True | 20 | Opretail open platform assigns developer keys to third parties | Obtained after certification of platform developer |
| _mt | String | True | 100 | Interface name | open.shopweb.device.startPlayRecReq |
| _sm | String | True | 100 | Signature algorithm md5,sha1 | md5 |
| _requestMode | String | True | 100 | Request method post,get | POST |
| _version | String | True | 100 | Version number | v1 |
| _timestamp | String | True | 100 | Timestamp | yyyyMMddHHmmss format |
| _sig | String | True | 32 | Signature token | Generated according to the signature algorithm, see the signature algorithm rules for details |
| _format | String | False | 10 | Format type | Currently only supports json by default |
Business request parameters#
| Parameters | Types of | Is required | The maximum length | Description | Example values |
|---|---|---|---|---|---|
| id | string | √ | Device ID(The Video Device ID obtained by the Get Device List interface) | 1 | |
| startTime | string | √ | Start Time | 2018-09-18 00:00:00 | |
| endTime | string | √ | End Time | 2018-09-18 00:00:00 | |
| playRate | int | × | Multiply speed playback (1,2,4,8), no pass default normal playback | 2 |
Common response parameters#
| Parameters | Types of | The maximum length | Description | Example values |
|---|---|---|---|---|
| stat | JSON | - | Gateway status (specific parameters are described below :) | View |
| stat.cid | String | 100 | Http request identifier | |
| stat.code | String | 100 | Gateway return code | |
| stat.codename | String | 100 | Gateway return code name | |
| stat.systime | String | Long | The current time of the interface call | |
| result | String | 100 | Interface returns prompt information | |
| data | JSON | - | Business information returned by the interface call (generally json format data, the specific data format will be defined in the business return parameters) | View |
Business return parameters#
| Parameter | Types of | Whether to return | Returns the maximum length | Description | Example values |
|---|---|---|---|---|---|
| result | int | × | 11 | Check the success or fail | 0:查询成功 |
| flv | string | × | 100 | Video url | http://118.31.174.18:5581/rtsp/26a85850-1e1e-4a2a-8a4a-af77c54cf4fa/live.flv |
| relStartTime | string | × | 100 | Video recording start time (timestamp) | 1591574400 |
| rtsp | string | × | 100 | rtmp Streaming Address | rtsp://118.31.174.18:5555/rtsp/4e8230c2-3651-48f8-8f85-47466cf03a18 |
| tlshls | string | × | 100 | https hls stream address(.m3u8 format) | https://dataswitch-test-001.ovopark.com:6682/rtsp/4e8230c2-3651-48f8-8f85-47466cf03a18/index.m3u8 |
| hls | string | × | 100 | hls stream address (.m3u8 format) | http://118.31.174.18:6681/rtsp/4e8230c2-3651-48f8-8f85-47466cf03a18/index.m3u8 |
| tlsflv | string | × | 100 | https flv stream address | https://dataswitch-test-001.ovopark.com:5582/rtsp/4e8230c2-3651-48f8-8f85-47466cf03a18/live.flv |
| vencodingname | string | × | 100 | Video encoding format [H264] (tlsflv,flv,rtmp exists only under H264) | H264 |
| url | string | × | 100 | same as flv parameter(Compatible with interface fields of earlier versions) | |
| tls_url | string | × | 100 | same as tlsflv parameter(Compatible with interface fields of earlier versions) |
Public return code#
| Return code name | Return code | Return code description | Solution |
|---|---|---|---|
| SUCCESS | 0 | Call success | |
| KEY_NOTNULL | 1 | _akey can not be empty | Input the _akey parameter when the interface is called |
| KEY_UNLAWFUL | 2 | _akey is illegal | key is illegal, input in the correct key |
| KEY_HAS_EXPIRED | 3 | _akey has expired | Please renew the service or contact the platform administrator |
| SIGN_METHOD_NOTNULL | 4 | _sm parameter cannot be empty | Input the _sm parameter when the interface is called |
| SIGN_TYPE_NOTEXIST | 5 | _sm type does not exist | Currently only supports md5, sha1 |
| SIGN_NOTNULL | 6 | _sig parameter cannot be empty | Input the _sig parameter when the interface is called |
| SIGN_WRONG | 7 | Invalid signature, please check parameters and signature format | _sig value is generated according to the signature algorithm |
| METHOD_NOTNULL | 8 | _mt parameter cannot be empty | Input the _mt parameter when the interface is called |
| METHOD_NOTEXIST_CODE | 9 | The method name corresponding to _mt does not exist or is not registered in the service | Check if the method corresponding to _mt method name and _version version number is passed in error |
| REQUESTMODE_NOTNULL | 10 | _requestMode parameter cannot be empty | Input the _requestMode parameter when the interface is called |
| APPLICATIONID_NOTNULL | 11 | _aid parameter cannot be empty | Input the _aid parameter when the interface is called |
| APPLICATIONID_NOTSAME | 12 | _aid does not match the current key | _aid and _akey must correspond one-to-one |
| VERSION_NOTNULL | 13 | _version version number cannot be empty | Input the _version parameter when the interface is called |
| TIMESTAMP_NOTNULL | 14 | _timestamp timestamp cannot be empty | Input the _timestamp parameter when the interface is called |
| TIMESTAMP_FORMAT_ERROR | 15 | _timestamp timestamp formatting error | According to yyyyMMddHHmmss format |
| TIMESTAMP_OVERTIME | 16 | _timestamp has expired | _timestamp is regenerated every time the interface is called |
| FORMAT_TYPE_NOTEXIST | 17 | _format type does not exist | Currently only supports json (default), xml |
| API_CALL_REPEAT | -100 | The interface is called repeatedly | Interface platform call exception |
| API_SYSTEM_CALL_ERROR | -500 | API call failed, system exception occurred | Interface platform call exception |
| UNKNOWN_ERROR | -999 | Open platform system exception | Reissue request |
Business return code#
| Return code name | Return code | Return code description |
|---|---|---|
| BUSINESS_PLATFORM_UNBOUND | 103001 | 业务平台未做绑定,请联系客服 |
| DATA_NOT_NULL | 103002 | 必填字段不能为空 |
| PARAMETER_VALIDATE_ERROR | 103004 | 参数效验异常 |
| IDENTITY_INFORMATION_WRONG | 103005 | 身份信息有误,_akey与企业id不匹配 |
| SERVICE_TIMEOUT | 103066 | 服务请求超时 |
| API_SYSTEM_ERROR | 103999 | api服务未知异常 |
| NO_AUTH_USER | 103064 | 没有用户权限 |
| NO_DEVICE | 103092 | 没有设备 |