添加套餐

基础套餐

适用场景

为SIM卡订购套餐

必要条件

SIM未废弃

SIM不在流量池中

注意事项

基础套餐的订购为同步处理。

不允许变更付费类型，比如为预付费SIM订购后付费套餐，将返回失败。

套餐类型为后付费时，默认无期限，cycles值不生效。

业务规则

套餐订购成功默认不启用，需启用可调用激活接口。

同一SIM可订购多个基础套餐，周期延续；每个套餐周期内流量消耗完毕后，需到期后才启用下一个套餐。

增加参数`activa`

仅对非OTA SIM生效。

activate默认值为flase，不立即激活套餐。

当activate设为true时，立即激活套餐；激活为异步处理，可查询异步处理结果。

不同SIM卡状态下activate为true时的业务处理：

操作前SIM卡状态	是否支持设置为true	业务处理	备注
静默期,暂停期,停保期	是	订购并激活
使用期	是	原使用中套餐暂停(3.0)/结束(4.0)；新套餐启用	若希望继续使用原套餐，可将activate设为flase
废弃期（含合约已结束）	否	禁止操作

返回码

code	message	建议操作
CB-00-0000	成功	添加套餐成功
CB-01-0125	已经加入流量池的SIM卡不能进行该操作	联系领科支持人员
CB-01-0111	该SIM卡有请求处理中，不允许同时操作	等待处理结束
CB-02-0003	该套餐不存在	套餐ID错误或不存在

补充套餐 `whitelist_only`

适用场景：

补充流量

必要条件：

SIM卡状态必须为Active-live/23（有使用中的副号套餐）

SIM卡使用中的基础套餐支持补充套餐

SIM不在流量池中

注意事项：

订购补充套餐为异步处理，可查询异步处理结果。

处理订购期间，禁止对同一SIM进行激活、停机、复机、重置等操作。

业务规则：

订购补充套餐成功后立即生效。

不改变基础套餐到期时间，到期后，补充套餐实效。

可订购多个补充套餐

SIM卡被 API 停机v2（异步）后，已绑定的补充套餐将立即失效。

SIM卡被复机（异步）后，无法恢复补充套餐。

SDK API 调用方式

SDK版本1.0.9 以上

无activate参数：

带activate参数：

使用Clinet-token：

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

示例

成功示例异常示例

{
    "data": {
        "order_id": "SO-123456578845"
    },
    "status": {
        "code": "CB-00-0000",
        "message": "Success",
        "detail": "https://apidoc-cn.iotcube.link/"
    }
}

基础套餐

适用场景

必要条件

注意事项

业务规则

增加参数`activa`

返回码

补充套餐 `whitelist_only`

适用场景：

必要条件：

注意事项：

业务规则：

SDK API 调用方式

请求参数

请求示例代码

返回响应

添加套餐

基础套餐#

适用场景#

必要条件#

注意事项#

业务规则#

增加参数activa#

返回码#

补充套餐 whitelist_only#

适用场景：#

必要条件：#

注意事项：#

业务规则：#

SDK API 调用方式#

请求参数

请求示例代码

返回响应

基础套餐

适用场景

必要条件

注意事项

业务规则

增加参数`activa`

返回码

补充套餐 `whitelist_only`

适用场景：

必要条件：

注意事项：

业务规则：

SDK API 调用方式