createDeviceFlvLive (createDeviceFlvLive: Create device FLV live (real-time and playback))
createDeviceFlvLive: createDeviceFlvLive: Create device FLV live (real-time and playback)
Function details
Create an FLV live URL for a device channel. Supports real-time (realTime) and recorded playback (playback).
Request address
https://openapi-[DataCenter].easy4ip.com/openapi/createDeviceFlvLive
Request format
HTTP POST. JSON body layout: Request conventions. Sign with Signature.
Incoming parameter description
| Parameter name | Parameter type | Required or not | Default value | Legal value | Parameter description |
|---|---|---|---|---|---|
| token | String | Yes | Administrator accessToken | ||
| deviceId | String | Yes | Device serial number | ||
| channelId | String | Yes | Channel ID | ||
| type | String | No | realTime | realTime, playback | realTime live view; playback recorded segment |
| beginTime | String | No | Required when type is playback; start time yyyy-MM-dd HH:mm:ss; max 24 h span with endTime, may cross midnight | ||
| endTime | String | No | Required when type is playback; end time yyyy-MM-dd HH:mm:ss | ||
| recordType | String | No | localRecord, cloudRecord | Required when type is playback | |
| speed | Integer | No | 1 | Cloud: 2/4/8/16; local: 2/4/8 | Playback speed; only when type is playback |
Request root fields
| Field | Type | Description |
|---|---|---|
| system | Object | Auth and version |
| id | String | Request ID |
| params | Object | Business parameters; see table above |
Sample input
{
"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
}
}
Return data field description
| Field | Type | Description |
|---|---|---|
| deviceId | String | Device serial number |
| channelId | String | Device channel number |
| flv | String | FLV SD URL |
| flvHD | String | FLV HD URL |
Response root fields
| Field | Type | Description |
|---|---|---|
| result | Object | Result payload |
| id | String | Request ID |
Sample output
{
"result":{
"msg":"The operation was successful.",
"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"
}
Error codes
This method may return the codes below. See Return codes and Capability errors for the full catalog.
Gateway and auth (SN / TK / OP)
| Code | Meaning | Next step |
|---|---|---|
SN1001 | Signature error | Check sign per Development specification |
TK1002 | Token invalid or expired | Refresh accessToken |
OP1002 | Missing required parameter | Add required fields |
OP1003 | Invalid parameter | Match this page’s parameter table |
OP1009 | Permission denied | Check token and device bind/share grants |
OP1013 | Total call limit exceeded | Reduce call rate |
OP1014 | Daily per-interface limit exceeded | See Interface call limits |
DV1007 | Device offline | Wait until the device is online |
See Return codes · OP/SN/TK for the full catalog.
Sub-accounts (SUB)
| Code | Meaning | Next step |
|---|---|---|
SUB1001–SUB1002 | Sub-account lacks API permission | Update policy via addPolicy |
SUB1005 | Sub-account token expired | Refresh subAccountToken |
SUB1006 | No device grant for sub-account | Check Resource and device serial |
SUB1008 | Sub-account not bound to app | Create and bind the sub-account first |
See Return codes · SUB.
Device access and channels (DV10xx)
| Code | Meaning | Next step |
|---|---|---|
DV1007 | Device offline or timeout | Wait for the device to come online |
DV1009 | Device busy | Retry later |
DV1012 | Insufficient share/grant permission | Check sub-account Permission / Resource |
DV1019 | Capability not supported | Confirm model and capability list |
DV1020 | Channel offline | Check channel status |
DV1026 | Function not supported | Use another API or upgrade firmware |
DV1028 | Not bound or channel missing | Verify deviceId / channelId |
See Return codes · DV.
Live binding (LV)
| Code | Meaning | Next step |
|---|---|---|
LV1001 | Live already exists | Unbind via unbindLive or use another source |
| :--- | :--- | :--- |
LV1002 | Live does not exist | Create the live plan first |
| :--- | :--- | :--- |
LV1005 | Live info does not exist | Verify live id |
| :--- | :--- | :--- |
LV1006 | Same RTSP source can bind only once per day | Retry the next day |
| :--- | :--- | :--- |
LV1008 | Real-name verification required | Complete profile in the Open Platform console |
| :--- | :--- | :--- |
LV1020 | Live is bound and cannot be deleted | Unbind first |
| :--- | :--- | :--- |
OP1021 | Failed to get playback URL | Check live status and plan |
| :--- | :--- | :--- |
OP1022 | Cloud decode authorization required | Authorize in the app as described in the response |