文档首页/ 全球SIM联接 GSL/ API参考/ API列表/ SIM卡管理/ SIM卡达量断网/取消达量断网
更新时间：2024-10-14 GMT+08:00
查看PDF
分享

SIM卡达量断网/取消达量断网

功能介绍

SIM卡达量断网/取消达量断网，接口仅支持中国电信的卡以及中国联通、中国移动的组池卡调用。注：由于运营商侧业务限制，建议您同一张SIM卡不要同时执行多种不同业务的操作。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/sim-cards/{sim_card_id}/exceed-cut-net

表1 路径参数

参数

是否必选

参数类型

描述

sim_card_id

是

Long

SIM卡标识，如果SIM卡标识传0则表示需要根据iccid处理。可通过查询SIM卡列表接口获取

最小值：0

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。
表3 请求Body参数

参数

是否必选

参数类型

描述

action

是

Integer

操作类型(1:设置达量断网域值，2：取消达量断网域值)

最小值：1

最大值：2

quota

否

String

阈值,只能是0,-1,正整数，-1表示无限制，0表示有上网流量产生就会立即断网，取消达量断网功能时可不传，单位MB

iccid

否

String

iccid，传入的sim_card_id为0,则根据iccid进行处理

最小长度：19

最大长度：20

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

work_order_id

Long

业务受理单号

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

  • 创建SIM卡达量断网/取消达量断网的申请。例如：设置指定sim_card_id卡片的达量断网阈值为10

    POST https://{endpoint}/v1/sim-cards/{sim_card_id}/exceed-cut-net

{
  "action" : 1,
  "quota" : 10
}

  • 创建SIM卡达量断网/取消达量断网的申请。例如：参数sim_card_id为最小值，设置卡标识iccid为“898600xxxxxxxxxx”的达量断网阈值为10。

    POST https://{endpoint}/v1/sim-cards/{sim_card_id}/cut-net

{
  "action" : 1,
  "quota" : 10,
  "iccid" : "898600xxxxxxxxxx"
}

响应示例

状态码： 200

OK

{
  "work_order_id" : 1000001
}

状态码： 400

Parameter Invalid

{
  "error_code" : "GSL.00010004",
  "error_msg" : "参数异常"
}

状态码： 500

Internal Server Error

{
  "error_code" : "GSL.00010003",
  "error_msg" : "系统繁忙，请稍后重试。"
}

状态码

状态码

描述

200

OK

400

Parameter Invalid

500

Internal Server Error

错误码

请参见错误码。

父主题： SIM卡管理

相关文档