modifyLivePlanStatus (modifyLivePlanStatus: Set the live broadcast plan switch)
modifyLivePlanStatus: modifyLivePlanStatus: Set the live broadcast plan switch
Function details
Enable or disable the currently set live broadcast plan.
Request address
https://openapi-[DataCenter].easy4ip.com/openapi/modifyLivePlanStatus
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 | ||
| liveToken | String | Yes | live token | ||
| status | String | Yes | status, on: on, off: off |
Sample input
{
"system":{
"ver":"1.0",
"appId":"lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"time":1603367735,
"nonce":"79b55638-5e05-4b33-bb0c-ffd57b3fe566"
},
"id":"47aef44c-592c-4a21-9ad0-132626cf826a",
"params":{
"liveToken":"57877dd6774f4cbeb657568be0b7a621",
"token":"At_00000ad9e6e87f0142eb92e207aec46a",
"status":"on"
}
}
Return data field description
No data returned
Sample output
{
"id":"47aef44c-592c-4a21-9ad0-132626cf826a",
"result":{
"code":"0",
"msg":"The operation was successful"
}
}
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 |