取消（异步）

简要描述

版本：

v4

适用场景

场景1：提前结束SIM卡下所有套餐。

场景2：根据order_id提前结束指定套餐。（添加套餐接口响应参数中的order_id）

场景3：通过order_id提前结束指定套餐，并立即启用（时间上）最近下一个未启用套餐（通过keep_alive参数控制）。

必要条件

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

仅支持非OTA卡操作。

业务规则

场景1：未传order_id时：

SIM卡状态使用期时操作成功后，使用中套餐（含补充套餐/加油包）将提前结束。SIM卡最终状态为停机保。

SIM卡状态暂停期时操作成功后，暂停中套餐将被提前结束。SIM卡最终状态为停机保。

任何状态下的SIM操作成功后，未启用套餐将被提前结束。

场景2：传入order_id时：

仅结束对应的套餐。

场景3：传入order_id且keep_alive为true时：

结束指定order_id的套餐。

若无使用中套餐但有未启用套餐，则启用最近未启用套餐。

注意事项

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

获取操作异步处理结果的方式：
1.使用接口响应中的request_id通过GET/sims/async_result/{request_id}进行处理结果查询。
2.通过notification api回调获取结果 pending

当操作异步处理结束前，卡片处于锁定状态，此时禁止对同一SIM进行激活、停机、复机、重置等操作。

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

异步操作处理结果为失败时，用户可再次发起操作。

SDK API 调用方式

场景1：取消全部套餐。支持SDK最低版本：1.0.10

场景2：根据order_id取消指定套餐。支持SDK最低版本：1.0.13

场景3：根据orde_id取消指定套餐，并将keep_alive参数设置为true。支持SDK最低版本：1.0.14

请求参数

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

order_id

string | null

可选

添加套餐时的业务标识，可作为后续发起指定取消的输入参数

keep_alive

boolean

可选

是否自动启用，默认false

示例

{
  "order_id": null,
  "keep_alive": false
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

data

必需

Any of

status

null

code

string

必需

message

string | null

必需

detail

必需

status

object (status)

必需

示例

{
  "data": {
    "code": "CB-00-0099",
    "message": "Request received, asynchronous processing."
  },
  "status": {
    "code": "CB-00-0000",
    "message": "成功",
    "detail": "https://apidoc-en.iotcube.link/"
  }
}

🟢200success

简要描述#

版本：#

适用场景#

必要条件#

业务规则#

注意事项#

SDK API 调用方式#

请求参数

示例代码

返回响应

简要描述

版本：

适用场景

必要条件

业务规则

注意事项

SDK API 调用方式