openCloudRecord (Enable Device Cloud Storage for Network Cameras - Imou Open Platform)

openCloudRecord: Enable Device Cloud Storage for Network Cameras - Imou Open Platform

Function details

When the number of times returned by calling the queryCloudRecordCallNum interface is greater than 0, the developer can call this interface to enable the cloud storage function for his own device, and each call is a channel of a device to enable the cloud storage service .

At this time, if you request queryCloudRecordCallNum to query the remaining number of calls to the specified cloud storage, the returned number of remaining calls will be reduced by 1 accordingly;

When calling the unUsedCloudList interface to return that there are remaining unused cloud storage services under the developer's account, the developer can also call this interface to enable the cloud storage function for their own devices.

Parameter name	Parameter type	Required or not	Legal value	Parameter description
token	String	Yes		Administrator accessToken
deviceId	String	Yes		Device serial number
channelId	String	Yes		Channel ID
strategyId	String	Yes	For details, please see: Cloud storage package introduction	Cloud Storage Package ID
deviceCloudId	String	No		The unique id of cloud storage. If the activated cloud storage is under the developer account, the deviceCloudId can be obtained by calling unUsedCloudList

Sample input

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1599031074,
 "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
 },
 "params":{
 "token":"At_12345678901234567890123456789012",
 "deviceId":"TESTQWERXXXX",
 "channelId":"0",
 "strategyId":"3"
 }
}

Return data field description

No data returned

Sample output

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "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.

Cloud storage plans (ST)

Code	Meaning	Next step
`ST1004`	Cloud storage not enabled	openCloudRecord
`ST1005`	Cloud storage expired	Renew or change plan
`ST1006`	Plan does not exist	Verify strategyId
`ST1009`	Paid plan still active	Handle existing plan first
`ST1010`	Device does not support plan	Choose a supported plan

See Return codes · ST.