运营商反向通知接口-按需订购 - reverseOrder
功能介绍
运营商反向通知接口-按需订购
授权信息
当前API调用无需身份策略权限。
URI
POST /koodrive/ose/v1/carrier/operation/reverseOrder
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 该字段存储的是 Access Token。 调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。 约束限制: 格式参考:Bearer+/access token} 取值范围: Access Token的获取请参考对应的开发手册 默认取值: 不涉及 |
| X-Date | 是 | String | 参数解释: 签名时间,用于appId鉴权 约束限制: 距当前时间15分钟以内,不能晚于当前时间 取值范围: yyyMMdd'T'HHmmss'Z',例:20251103T070140Z 默认取值: 不涉及 |
| X-User-Id | 是 | String | 参数解释: koodrive侧用户id,用于appId鉴权 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| x-traceid | 否 | String | 参数解释: 业务跟踪id(必须58位) 约束限制: 不涉及 取值范围: 长度为58位 默认值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| operationList | 是 | Array of ReverseOperationAllPropertiesInfo objects | 参数解释: 操作列表 约束限制: 限制50个元素 取值范围: 不涉及 默认取值: 不涉及 |
| batchSN | 是 | String | 参数解释: 批量操作流水号 约束限制: 长度限制64个字符 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| packageChangeList | 否 | Array of PackageChangeInfo objects | 参数解释: 套餐修改动作集 约束限制: 限制1个元素 取值范围: 不涉及 默认取值: 不涉及 |
| operationSN | 是 | String | 参数解释: 操作流水号 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| carrierUserId | 是 | String | 参数解释: 运营商用户id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| changeType | 是 | Integer | 参数解释: 变更类型 约束限制: 不涉及 取值范围: 1:订购 默认取值: 不涉及 |
| packageId | 是 | String | 参数解释: 运营商套餐id,运营商保证唯一 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| packageType | 是 | Integer | 参数解释: 套餐类型 约束限制: 当packageId字段传入时,该字段必传 取值范围: -2:连续包月基础套餐 -3:连续包年基础套餐 -4:基于基础套餐的扩容包 -5:单独的扩容包 默认取值: 不涉及 |
| capacity | 是 | Integer | 参数解释: 套餐容量 约束限制: 当packageId字段传入时,该字段必传 取值范围: 单位KB 默认取值: 不涉及 |
| activateTime | 否 | String | 参数解释: 激活时间, ISO 标准时间格式 约束限制: changeType=1时候必填,需要在当前计费周期内;changeType=0时非必填 取值范围: 不涉及 默认取值: 不涉及 |
| packageName | 否 | String | 参数解释: 套餐名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| status | 是 | String | 参数解释: 套餐状态 约束限制: 不涉及 取值范围: 0-下线;1-发布 默认取值: 不涉及 |
| price | 否 | String | 参数解释: 套餐价格 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| promotionPrice | 否 | String | 参数解释: 套餐折扣价 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| countryCode | 否 | String | 参数解释: 国家/地区代码,参照ISO 3166-1 alpha-3 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| currencyCode | 否 | String | 参数解释: 货币代码,参照ISO 4217标准 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| count | 否 | Integer | 参数解释: 订购数量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1 |
| channel | 否 | String | 参数解释: 渠道字段, 约束限制: 不涉及 取值范围: 要求以 00、01、02 或 03 开头,后跟任意6个字符(总共8个字符) 默认取值: 不涉及 |
| unlimit | 否 | Integer | 参数解释: 不限量套餐 约束限制: 不涉及 取值范围: 0-非不限量 1-不限量 默认取值: 不涉及 |
| properties | 否 | Object | 参数解释: 扩展字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| basePackageId | 否 | String | 参数解释: 对应基础包id 约束限制: 当packageType为4或5时,需要填,其余不填 取值范围: 不涉及 默认取值: 不涉及 |
| orderNumber | 否 | String | 参数解释: 运营商侧订单 约束限制: 要求全局唯一 取值范围: 1-64位字符串 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 状态码 |
| msg | String | 状态描述 |
| data | Array of BatchOperationInfo objects | 反向通知响应数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| batchSN | String | 批量操作流水号 |
| operationList | Array of OperationResultInfo objects | 批量操作数据(当前list限制最多50个元素,可配置) |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| operationSN | String | 操作流水号 |
| carrierUserId | String | 运营商用户id |
| kdUserId | String | koodrive内部用户Id |
| packageChangeList | Array of PackageChangeInfo objects | 套餐修改动作集,限制1个元素 |
| status | Integer | 操作结果 -0:操作中; -1:成功 -2:失败 |
| errorCode | String | 错误码,当操作失败时返回 |
| errorMsg | String | 错误信息,当操作失败时返回 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| changeType | Integer | 参数解释: 变更类型 约束限制: 不涉及 取值范围: 1:订购 默认取值: 不涉及 |
| packageId | String | 参数解释: 运营商套餐id,运营商保证唯一 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| packageType | Integer | 参数解释: 套餐类型 约束限制: 当packageId字段传入时,该字段必传 取值范围: -2:连续包月基础套餐 -3:连续包年基础套餐 -4:基于基础套餐的扩容包 -5:单独的扩容包 默认取值: 不涉及 |
| capacity | Integer | 参数解释: 套餐容量 约束限制: 当packageId字段传入时,该字段必传 取值范围: 单位KB 默认取值: 不涉及 |
| activateTime | String | 参数解释: 激活时间, ISO 标准时间格式 约束限制: changeType=1时候必填,需要在当前计费周期内;changeType=0时非必填 取值范围: 不涉及 默认取值: 不涉及 |
| packageName | String | 参数解释: 套餐名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| status | String | 参数解释: 套餐状态 约束限制: 不涉及 取值范围: 0-下线;1-发布 默认取值: 不涉及 |
| price | String | 参数解释: 套餐价格 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| promotionPrice | String | 参数解释: 套餐折扣价 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| countryCode | String | 参数解释: 国家/地区代码,参照ISO 3166-1 alpha-3 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| currencyCode | String | 参数解释: 货币代码,参照ISO 4217标准 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| count | Integer | 参数解释: 订购数量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1 |
| channel | String | 参数解释: 渠道字段, 约束限制: 不涉及 取值范围: 要求以 00、01、02 或 03 开头,后跟任意6个字符(总共8个字符) 默认取值: 不涉及 |
| unlimit | Integer | 参数解释: 不限量套餐 约束限制: 不涉及 取值范围: 0-非不限量 1-不限量 默认取值: 不涉及 |
| properties | Object | 参数解释: 扩展字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| basePackageId | String | 参数解释: 对应基础包id 约束限制: 当packageType为4或5时,需要填,其余不填 取值范围: 不涉及 默认取值: 不涉及 |
| orderNumber | String | 参数解释: 运营商侧订单 约束限制: 要求全局唯一 取值范围: 1-64位字符串 默认取值: 不涉及 |
请求示例
反向通知请求参数
{
"operationList": [
{
"operationSN": "string",
"carrierUserId": "string",
"packageChangeList": [
{
"changeType": 0,
"packageId": "string",
"packageType": 0,
"capacity": 0,
"count": 0,
"channel": "string",
"unlimit": 0,
"properties": {},
"activateTime": "2025-09-18T06:14:54.620Z",
"endTime": "2025-09-18T06:14:54.620Z",
"packageName": "string",
"basePackageId": "string",
"status": "string",
"price": "string",
"promotionPrice": "string",
"countryCode": "string",
"currencyCode": "string"
"orderNumber":"string"
}
]
}
],
"batchSN": "string",
"assetClearPolicy": 0
} 响应示例
状态码:200
运营商反向通知响应体
{
"code" : "stringst",
"msg" : "string",
"data" : [ {
"batchSN" : "string",
"operationList" : [ {
"operationSN" : "string",
"carrierUserId" : "string",
"packageChangeList" : [ {
"changeType" : 0,
"packageId" : "string",
"packageType" : 0,
"capacity" : 0,
"count" : 0,
"channel" : "string",
"unlimit" : 0,
"properties" : { },
"activateTime" : "2025-09-18T06:37:17.549Z",
"endTime" : "2025-09-18T06:37:17.549Z",
"packageName" : "string",
"basePackageId" : "string",
"status" : "string",
"price" : "string",
"promotionPrice" : "string",
"countryCode" : "string",
"currencyCode" : "string"
} ],
"kdUserId" : "string",
"status" : 0,
"errorCode" : "string",
"errorMsg" : "string"
} ]
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 运营商反向通知响应体 |