非OTA更换套餐

适用场景

SIM卡当前绑定的套餐不符合使用需求，需要更换为特定套餐并立即启用新套餐。

必要条件

仅支持对所用API key归属企业下的卡片进行操作。

仅非OTA（包括多IMSI)卡片均支持操作。

SIM卡状态必须为Active-live/23（有使用中的副号套餐）。更多关于 SIM生命周期

SIM卡当前没有补充套餐。

SIM卡不在任一流量池中。（若订购的SIM类型为后付费共享套餐时允许更换）

不允许变更SIM的付费类型，如预付费不能更换为后付费产品。

注意事项

更换套餐操作为异步处理，接口同步响应成功代表领科系统接收请求成功。

获取操作异步处理结果的方式：

使用接口响应中的request_id通过GET/sims/async_result/{request_id}进行处理结果查询。

通过notification api回调获取结果 pending

异步处理结束完成前，卡片处于锁定状态，此时禁止对同一SIM进行激活、停机、复机、重置等操作。同理，因其他操作被锁定时，卡片将无法更换套餐，请稍后重试。

异步处理过程通常可在几秒内结束，若运营商系统发生网络拥塞等异常，处理时长可达几十分甚至更长。

异步处理结果可能会失败，当结果为失败时，用户可再次发起更换套餐的操作。

业务规则

若更换的新套餐与原套餐一致，则不执行更换。

更换的新套餐周期类型可与原套餐周期类型不一致。

更换的新套餐支持设置独立的订购周期数，可与原套餐不一致。

更换套餐成功后，SIM卡原使用中套餐将被提前结束，新更换的套餐立即启用。

返回码

主要描述本接口中data.code中的返回码及对应的错误原因

Cdoe	message	建议操作
CB-01-0124	SIM卡要更换的套餐不能与当前使用中套餐一致	更换一个新套餐
CB-01-0125	已经加入流量池的SIM卡不能进行该操作	将SIM卡移出流量池
CB-01-0126	添加了补充套餐的SIM卡不能进行该操作	待补充套餐结束后再进行更换
CB-01-0121	SIM卡必须有使用中的副号套餐订单	激活SIM卡未启用套餐或订购并激活套餐
CB-02-0003	该套餐不存在	套餐ID错误或不存在，请更换正确的套餐ID

SDK API 调用方式

请求参数

Path 参数

sim_id

string

必需

Header 参数

Accept-Language

string

可选

默认，当header中无语言要求时，默认返回简体中文。当前支持zh-CN（简体中文）、en-US（英文）。/ Support : zh-CN 、 en-US

默认值:

zh-CN

Content-Type

string

可选

默认值:

application/json

Authorization

string

必需

LF {lfAccessKeyId}/{sign} 必填项

默认值:

X-LF-Api-Version

string

可选

默认值: 此最新版本。如最新版本为2.0，则默认1.0

X-LF-Signature-Type

string

1.0、2.0

可选

timestamp

string

必需

毫秒时间戳；只接受10分钟之内请求

nonce

integer

必需

随机正整数，取值范围：0-2147483647

Body 参数application/json

bundle_id

string

套餐ID

可选

cycles

integer | null

添加周期数

可选

默认值:

示例

{
  "bundle_id": "LP09823222320",
  "cycles": 3
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

data

object | null

必需

data

string

可选

message

string

可选

detail

string | null

可选

status

object (status)

必需

code

string

必需

message

string | null

必需

detail

必需

示例

{
  "data": null,
  "status": {
    "code": "CB-00-0000",
    "message": "Success",
    "detail": null
  }
}

🟢200success

适用场景#

必要条件#

注意事项#

业务规则#

返回码#

SDK API 调用方式#

请求参数

示例代码

返回响应

适用场景

必要条件

注意事项

业务规则

返回码

SDK API 调用方式