This section describes the process and APIs for purchasing LinkVisual video cloud storage services. The APIs cover both free and paid plans and allow you to query and claim free plans, query lists of paid plans, check plan purchase eligibility, purchase plans, and query order details and lists.
- Query the details of a free cloud storage plan
- Claim a free cloud storage plan
- Query the list of video cloud storage plans
- Check if a cloud storage plan can be purchased
- Purchase a cloud storage plan
- Query the order details of a cloud storage plan
- Query the order list of cloud storage plans
- Activate a free cloud storage plan immediately
- Activate a cloud storage plan immediately
- Transfer a cloud storage plan
- Deactivate a cloud storage plan
Query the details of a free cloud storage plan
Description
| Path | Version | Description | cloudToken required |
| /vision/customer/freecloudstorage/get | 1.0.1 | Queries the details of a free cloud storage plan. | Optional |
Request parameters
| Parameter | Type | Required | Default value | Description |
| iotId | String | Yes | - | The device ID. |
Response parameters
| Parameter | Type | Required | Description |
| type | int | Yes | The type of the cloud storage plan. 1: continuous recording. 2: event-based recording. |
| lifecycle | int | Yes | The storage period in days. |
| months | int | Yes | The service period in months. |
| consumed | int | Yes | Indicates whether the plan has been claimed. 0: not claimed. 1: claimed. |
| startTime | String | Yes | The start time. Format: yyyy-MM-dd HH:mm:ss. |
| endTime | String | Yes | The end time. Format: yyyy-MM-dd HH:mm:ss. |
| startTimeUTC | String | Yes | The start time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
| endTimeUTC | String | Yes | The end time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
| expired | int | Yes | Indicates whether the plan has expired. |
| remainQuota | int | Yes | The remaining quota of the complimentary cloud storage in months. |
Claim a free cloud storage plan
Description
| Path | Version | Description | cloudToken required |
| /vision/customer/freecloudstorage/consume | 1.0.3 | Claims a free cloud storage plan. | Optional |
Request parameters
| Parameter | Type | Required | Default value | Description |
| iotId | String | Yes | - | The device ID. |
| enableDefaultPlan | boolean | No | false | Specifies whether to set the default 24/7 continuous recording plan and event-based recording plan. |
| immediateUse | boolean | No | false | Specifies whether to use the plan immediately. If you set this parameter to true, the newly claimed free plan takes effect immediately. If you set this parameter to false, the newly claimed free plan takes effect after the previous plan expires. |
| preRecordDuration | int | No | 5 | The pre-recording duration for event-based recording. Valid values: 0 to 5 seconds. |
| recordDuration | int | No | 10 | The total duration of an event-based recording. Valid values: 0 to 30 seconds. |
| quota | int | No | 1 | The complimentary cloud storage quota to use. Valid values: 1 to 3 months. |
Response parameters
| Parameter | Type | Required | Description |
| type | int | Yes | The type of the cloud storage plan. 1: continuous recording. 2: event-based recording. |
| lifecycle | int | Yes | The storage period in days. |
| months | int | Yes | The service period in months. |
| consumed | int | Yes | Indicates whether the plan has been claimed. 0: not claimed. 1: claimed. |
| startTime | String | Yes | The start time. Format: yyyy-MM-dd HH:mm:ss. |
| endTime | String | Yes | The end time. Format: yyyy-MM-dd HH:mm:ss. |
| startTimeUTC | String | Yes | The start time in UTC. Format: yyyy-MM-dd HH:mm:ssZ. |
| endTimeUTC | String | Yes | The end time in UTC. Format: yyyy-MM-dd HH:mm:ssZ. |
| expired | int | Yes | Indicates whether the plan has expired. |
| remainQuota | int | Yes | The remaining quota of the complimentary cloud storage in months. |
Query the list of video cloud storage plans
Description
| Path | Version | Description | cloudToken required |
| /vision/customer/cloudstorage/commodity/query | 1.0.3 | Queries the list of video cloud storage plans. | Optional |
Request parameters
| Parameter | Type | Required | Default value | Description |
| category | String | No | CAMERA | The product category. Valid values: CAMERA and DOORBELL. CAMERA: camera. DOORBELL: doorbell. |
Response parameters
| Parameter | Type | Required | Description |
| cloudStorageCommodityList | List | Yes | The list of cloud storage plans. |
cloudStorageCommodityList
| Parameter | Type | Required | Description |
| commodityName | String | Yes | The name of the cloud storage plan. |
| commodityCode | String | Yes | Cloud Storage Plan Code |
| specification | String | Yes | The specifications of the cloud storage plan. |
| type | int | Yes | The type of the cloud storage plan. 1: continuous recording. 2: event-based recording. |
| price | String | Yes | The price of the cloud storage plan in CNY. |
| lifecycle | int | Yes | The storage period in days. |
| months | int | Yes | The service period in months. |
| description | String | No | The description of the cloud storage plan. |
| icon | String | No | The URL of the cloud storage plan icon. |
Check if a cloud storage plan can be purchased
Description
| path | Version | Description | cloudToken required |
| /vision/customer/cloudstorage/commodity/check | 1.0.2 | Checks if a cloud storage plan can be purchased. | Optional |
Request parameters
| Parameter | Type | Required | Description |
| iotId | String | Yes | The device ID. |
| commodityCode | String | Yes | Cloud Storage Plan Code |
| specification | String | Yes | The specifications of the cloud storage plan. |
Response parameters
| Parameter | Type | Required | Description |
| available | boolean | Yes | Available for purchase |
Purchase a cloud storage plan
Description
| Path | Version | Description | cloudToken required |
| /vision/customer/cloudstorage/commodity/buy | 1.0.5 | Purchases a cloud storage plan. | Optional |
Request parameters
| Parameter | Type | Required | Default value | Description |
| iotId | String | Yes | - | The device ID. |
| userName | String | Yes | - | The username. |
| commodityCode | String | Yes | - | Cloud Storage Package ID |
| specification | String | Yes | - | The specifications of the cloud storage plan. |
| copies | int | Yes | - | The quantity to purchase. |
| enableDefaultPlan | boolean | No | false | Specifies whether to set the default 24/7 continuous recording plan and event-based recording plan. |
| immediateUse | boolean | No | false | Specifies whether to use the plan immediately. If you set this parameter to true, the newly purchased plan takes effect immediately. If you set this parameter to false, the newly purchased plan takes effect after the previous plan expires. |
| preRecordDuration | int | No | 5 | The pre-recording duration for event-based recording. Valid values: 0 to 5 seconds. |
| recordDuration | int | No | 10 | The duration of an event-based recording. Valid values: 0 to 30 seconds. |
Response parameters
| Parameter | Type | Required | Description |
| orderId | String | Yes | The order ID. |
Get the order details of a cloud storage plan
Description
| Path | Version | Description | cloudToken required |
| /vision/customer/cloudstorage/order/get | 1.0.3 | Gets the order details of a cloud storage plan. | Optional |
Request parameters
| Parameter | Type | Required | Description |
| iotId | String | Yes | The device ID. |
| orderId | String | Yes | The order ID. |
Response parameters
| Parameter | Type | Required | Description |
| orderId | String | Yes | The order ID. |
| commodityCode | String | Yes | Cloud Storage Plan Code |
| specification | String | Yes | Cloud Storage Specifications |
| copies | int | Yes | The purchased quantity. |
| startTime | String | Yes | The start time. Format: yyyy-MM-dd HH:mm:ss. |
| endTime | String | Yes | The end time. Format: yyyy-MM-dd HH:mm:ss. |
| expired | int | Yes | Expiration status |
| paymentStatus | int | Yes | The payment status. 1: paid. 0: unpaid. |
| price | String | Yes | The price of the cloud storage plan in CNY. |
| commodityType | int | Yes | The type of the cloud storage plan. 1: continuous recording. 2: event-based recording. |
| startTimeUTC | String | Yes | The start time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
| endTimeUTC | String | Yes | The end time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
Query the order list of cloud storage plans
Description
| Path | Version | Description | cloudToken required |
| /vision/customer/cloudstorage/order/query | 1.0.3 | Queries the order list of cloud storage plans. | Optional |
Request parameters
| Parameter | Type | Required | Default value | Description |
| iotId | String | Yes | None | The device ID. |
| pageStart | int | No | 0 | The starting page number. Default value: 0. |
| pageSize | int | No | 20 | The number of entries per page. Maximum value: 50. |
Response parameters
| Parameter name | Type | Required | Description |
| pageNo | int | Yes | The current page number. |
| pageSize | int | Yes | Page size |
| pageCount | int | Yes | The total number of pages. |
| total | int | Yes | The total number of records. |
| orderList | JSON | Yes | The list of orders. |
orderList
| Parameter | Type | Required | Description |
| orderId | String | Yes | The order ID. |
| commodityCode | String | Yes | Cloud Storage Package Code |
| specification | String | Yes | The specifications of the cloud storage plan. |
| copies | int | Yes | The purchased quantity. |
| startTime | String | Yes | The start time. Format: yyyy-MM-dd HH:mm:ss. |
| endTime | String | Yes | The end time. Format: yyyy-MM-dd HH:mm:ss. |
| expired | int | Yes | Indicates whether the plan has expired. |
| paymentStatus | int | Yes | The payment status. 1: paid. 0: unpaid. |
| price | String | Yes | The price of the cloud storage plan in CNY. |
| commodityType | int | Yes | The type of the cloud storage plan. 1: continuous recording. 2: event-based recording. |
| startTimeUTC | String | Yes | The start time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
| endTimeUTC | String | Yes | The end time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
Activate a free cloud storage plan immediately
Description
| Path | Version | Description | cloudToken required |
| /vision/customer/freecloudstorage/enable | 1.0.0 | Activates a free cloud storage plan immediately. | Optional |
Request parameters
| Parameter | Type | Required | Default value | Description |
| iotId | String | Yes | - | The device ID. |
Response parameters
| Parameter | Type | Required | Description |
| type | int | Yes | The type of the cloud storage plan. 1: continuous recording. 2: event-based recording. |
| lifecycle | int | Yes | The storage period in days. |
| months | int | Yes | The service period in months. |
| consumed | int | Yes | Indicates whether the plan has been claimed. 0: not claimed. 1: claimed. |
| startTime | String | Yes | The start time. Format: yyyy-MM-dd HH:mm:ss. |
| endTime | String | Yes | The end time. Format: yyyy-MM-dd HH:mm:ss. |
| expired | int | Yes | Indicates whether the plan has expired. |
| startTimeUTC | String | Yes | The start time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
| endTimeUTC | String | Yes | The end time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
Activate a cloud storage plan immediately
Description
| Path | Version | Description | cloudToken required |
| /vision/customer/cloudstorage/commodity/enable | 1.0.0 | Activates a cloud storage plan immediately. | Optional |
Request parameters
| Parameter | Type | Required | Default value | Description |
| iotId | String | Yes | - | The device ID. |
| orderId | String | Yes | - | The order ID. |
Response parameters
| Parameter | Type | Required | Description |
| orderId | String | Yes | The order ID. |
| commodityCode | String | Yes | Cloud Storage Package Code |
| specification | String | Yes | The specifications of the cloud storage plan. |
| copies | int | Yes | The purchased quantity. |
| startTime | String | Yes | The start time. Format: yyyy-MM-dd HH:mm:ss. |
| endTime | String | Yes | The end time. Format: yyyy-MM-dd HH:mm:ss. |
| expired | int | Yes | The order status. 0: not expired. 1: expired. 2: frozen. |
| paymentStatus | int | Yes | The payment status. 0: unpaid. 1: paid. |
| price | String | Yes | The price of the cloud storage plan in CNY. |
| commodityType | int | Yes | The type of the cloud storage plan. 1: continuous recording. 2: event-based recording. |
| startTimeUTC | String | Yes | The start time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
| endTimeUTC | String | Yes | The end time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
Transfer a cloud storage plan
Description
| Path | Version | Description | cloudToken required |
| /vision/customer/cloudstorage/transfer | 1.0.0 | Transfers a user's cloud storage plan. You can only transfer a cloud storage plan between devices that are under the same administrator account. | Optional |
Request parameters
| Parameter | Type | Required | Default value | Description |
| srcIotId | String | Yes | Device ID | |
| srcOrderId | String | Yes | Order ID | |
| dstIotId | String | Yes | The destination device ID. | |
| enableDefaultPlan | boolean | No | false | Specifies whether to set the default 24/7 continuous recording plan and event-based recording plan. |
| immediateUse | boolean | No | false | Specifies whether the new package takes effect immediately. A value of true indicates that the package takes effect immediately, while a value of false indicates that the package takes effect after the current package expires. |
Response parameters
| Parameter | Type | Required | Description |
| orderId | String | Yes | The order ID. |
| commodityCode | String | Yes | Cloud Storage Plan ID |
| specification | String | Yes | The specifications of the cloud storage plan. |
| copies | int | Yes | The purchased quantity. |
| startTime | String | Yes | The start time. Format: yyyy-MM-dd HH:mm:ss. |
| endTime | String | Yes | The end time. Format: yyyy-MM-dd HH:mm:ss. |
| expired | int | Yes | The order status. 0: not expired. 1: expired. 2: frozen. |
| paymentStatus | int | Yes | The payment status. 0: unpaid. 1: paid. |
| price | String | Yes | The price of the cloud storage plan in CNY. |
| commodityType | String | Yes | The type of the cloud storage plan. 1: continuous recording. 2: event-based recording. |
| startTimeUTC | String | Yes | The start time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
| endTimeUTC | String | Yes | The end time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
Deactivate a cloud storage plan
Description
| Path | Version | Description | cloudToken required |
| /vision/customer/cloudstorage/status/set | 1.0.0 | Sets the status of a cloud storage plan for a user's device. | Optional |
Request parameters
| Parameter | Type | Required | Default value | Description |
| iotId | String | Yes | The device ID. | |
| orderId | String | Yes | The order ID. | |
| status | int | Yes | The status of the cloud storage order. 2: freeze and deactivate. |
Response parameters
| Parameter | Type | Required | Description |
| orderId | String | Yes | The order ID. |
| commodityCode | String | Yes | Cloud Storage Plan Code |
| specification | String | Yes | The specifications of the cloud storage plan. |
| copies | int | Yes | The purchased quantity. |
| startTime | String | Yes | The start time. Format: yyyy-MM-dd HH:mm:ss. |
| endTime | String | Yes | The end time. Format: yyyy-MM-dd HH:mm:ss. |
| expired | int | Yes | The order status. 0: not expired. 1: expired. 2: frozen. |
| paymentStatus | int | Yes | The payment status. 0: unpaid. 1: paid. |
| price | String | Yes | The price of the cloud storage plan in CNY. |
| commodityType | int | Yes | The type of the cloud storage plan. 1: continuous recording. 2: event-based recording. |
| startTimeUTC | String | Yes | The start time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
| endTimeUTC | String | Yes | The end time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. |
该文章对您有帮助吗？