Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
  • API reference
    • Public conventions
    • Development specification
    • accessToken: Get administrator token
    • API request example
    • Return codes
    • Interface call limits
    • Account docking
    • Device APIs
    • Device live broadcast
      • batchModifyLivePlan
      • bindDeviceLive
      • createDeviceFlvLive
      • createDeviceRecordHls
      • createDeviceRtmpLive
      • deleteDeviceFlvLive
      • deleteDeviceRtmpLive
      • getLiveStreamInfo
      • liveList
      • modifyLivePlan
      • modifyLivePlanStatus
      • queryDeviceFlvLive
      • queryDeviceRtmpLive
      • queryLiveStatus
      • unbindLive
    • Push configuration
    • Cloud storage service
    • Resource pool quota
    • Legacy APIs (deprecated)
  • SDK and tools
  • Solutions
  • Platform and support
On this page
Function details
Request address
Request format
Incoming parameter description
Sample input
Return data field description
Sample output
Error codes
Related

modifyLivePlan (modifyLivePlan: Modify the live plan time)

modifyLivePlan: modifyLivePlan: Modify the live plan time

Function details

Modify the live broadcast schedule.

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/modifyLivePlan

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

Incoming parameter description

Parameter nameParameter typeRequired or notDefault valueLegal valueParameter description
tokenStringYesAdministrator accessToken
liveTokenStringYesLive Token
periodStringYesLive broadcast period, always: permanent, once: specify a certain day, everyday: every day
beginTimeStringNoStart time, when "period" is "always", it can be empty; when "period" is "once", the time format is "yyyy-MM-dd HH:mm:ss"; When "period" is "everyday", the time format is "HH:mm:ss"; when the platform is saved, the second place is saved by default as 00
endTimeStringNoEnd time, when "period" is "always", it can be empty; when "period" is "once", the time format is "yyyy-MM-dd HH:mm:ss", And greater than the current time; when "period" is "everyday", the time format is "HH:mm:ss"; when the platform is saved, the second place is saved by default as 00

Sample input

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603367565,
 "nonce":"df09e2b0-1c1b-4342-bda3-58266b4e5694"
 },
 "id":"63cfb7d3-0d42-4744-b802-ac5af746c2cb",
 "params":{
 "period":"always",
 "liveToken":"57877dd6774f4cbeb657568be0b7a621",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

Return data field description

No data returned

Sample output

{
 "id":"63cfb7d3-0d42-4744-b802-ac5af746c2cb",
 "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)

CodeMeaningNext step
SN1001Signature errorCheck sign per Development specification
TK1002Token invalid or expiredRefresh accessToken
OP1002Missing required parameterAdd required fields
OP1003Invalid parameterMatch this page’s parameter table
OP1009Permission deniedCheck token and device bind/share grants
OP1013Total call limit exceededReduce call rate
OP1014Daily per-interface limit exceededSee Interface call limits
DV1007Device offlineWait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

CodeMeaningNext step
SUB1001–SUB1002Sub-account lacks API permissionUpdate policy via addPolicy
SUB1005Sub-account token expiredRefresh subAccountToken
SUB1006No device grant for sub-accountCheck Resource and device serial
SUB1008Sub-account not bound to appCreate and bind the sub-account first

See Return codes · SUB.

Device access and channels (DV10xx)

CodeMeaningNext step
DV1007Device offline or timeoutWait for the device to come online
DV1009Device busyRetry later
DV1012Insufficient share/grant permissionCheck sub-account Permission / Resource
DV1019Capability not supportedConfirm model and capability list
DV1020Channel offlineCheck channel status
DV1026Function not supportedUse another API or upgrade firmware
DV1028Not bound or channel missingVerify deviceId / channelId

See Return codes · DV.

Live binding (LV)

CodeMeaningNext step
LV1001Live already existsUnbind via unbindLive or use another source
:---:---:---
LV1002Live does not existCreate the live plan first
:---:---:---
LV1005Live info does not existVerify live id
:---:---:---
LV1006Same RTSP source can bind only once per dayRetry the next day
:---:---:---
LV1008Real-name verification requiredComplete profile in the Open Platform console
:---:---:---
LV1020Live is bound and cannot be deletedUnbind first
:---:---:---
OP1021Failed to get playback URLCheck live status and plan
:---:---:---
OP1022Cloud decode authorization requiredAuthorize in the app as described in the response

See Return codes · catalog.

Related

  • Development specification
  • API conventions
  • Module index
liveList
modifyLivePlanStatus