调用该接口创建直播分享套餐订单。
路径 | /vision/customer/streaming/order/create |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 可选 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 是 | bZGD54swRg******FkEs000101 | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
commodityCode | String | 是 | streamingResource_20_10 | 直播分享套餐代码。参考查询直播分享套餐列表返回的结果。 |
copies | Int | 是 | 1 | 购买数量。最小值1,最大值60。 |
userName | String | 否 | 158****8558 | 用户昵称。 |
userId | String | 否 | 50e5op6412259c0f11*****0f57cd9326da8409 | 用户ID。可以使用生活物联网平台的用户身份ID,也可以用厂商自有账号体系的ID。 |
immediateUse | Boolean | 否 | false | 是否立即使用。true:表示新购套餐立即生效开始使用;false:表示新购套餐在之前套餐到期后才开始生效使用。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误信息。 |
|
data | JSON |
响应的结果。 |
|
identityId | String |
管理员用户身份ID。 |
|
orderId | String |
订单ID。 |
|
outOrderNo | String |
阿里云订单号。 |
|
commodityName | String |
直播分享套餐名称。 |
|
commodityCode | String |
直播分享套餐代码。 |
|
copies | Int |
购买数量。 |
|
startTime | String |
开始时间。 |
|
endTime | String |
结束时间。 |
|
startTimeUTC | String |
开始时间UTC。 |
|
endTimeUTC | String |
结束时间UTC。 |
|
status | Int |
订单状态。0(订单有效),1(订单已到期),2(订单已冻结停用)。 |
|
paymentStatus | Int |
订单支付状态。0(未支付),1(已支付),2(支付中)。 |
|
price | String |
订单价格。单位:元。 |
|
userName | String |
用户昵称。 |
|
userId | String |
用户ID。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0"
},
"params":{
"iotId": "bZGD54swRg******FkEs000101",
"commodityCode": "streamingResource_20_10",
"copies":1,
"userName": "158****8558",
"userId": "50e5op6412259c0f11*****0f57cd9326da8409",
"immediateUse":false
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"identityId": "50e5op6412259c0f117********7cd9326da8409",
"orderId": "2020110413431****0196",
"outOrderNo": "20736951****674",
"commodityName": "视频设备分享增值服务(20人分享10人同时可看)月套餐",
"commodityCode": "streamingResource_20_10",
"copies": 1,
"startTime": "2020-11-04 09:01:00",
"endTime": "2020-11-04 09:01:00",
"startTimeUTC": "2020-11-04T01:01:00Z",
"endTimeUTC": "2020-11-04T01:01:00Z",
"status": 0,
"paymentStatus": 0,
"price": "140",
"userName": "152****8578",
"userId": "50e5op6412259c0f117********7cd9326da8409",
"months": 1
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}