SIM卡单卡复机
功能介绍
创建复机申请,返回业务受理单号。该受理单将在10分钟内完成,如遇运营商系统繁忙可能存在延时,若超30分钟未完成可再次重试。注:由于运营商侧业务限制,建议您同一张SIM卡不要同时执行多种不同业务的操作。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/sim-cards/{sim_card_id}/reset
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sim_card_id |
是 |
Long |
SIM卡标识,如果SIM卡标识传0则表示需要根据iccid处理。可通过查询SIM卡列表接口获取 最小值:0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
down_up_switch |
否 |
Integer |
启用停用开关 最小值:0 最大值:9 |
iccid |
否 |
String |
iccid,传入的sim_card_id为0,则根据iccid进行处理 最小长度:19 最大长度:20 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
work_order_id |
Long |
业务受理单号 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
-
创建SIM卡复机申请,将sim_card_id对应的卡片操作为复用。
POST https://{endpoint}/v1/sim-cards/{sim_card_id}/reset { "down_up_switch" : 2 }
-
创建SIM卡复机申请。当参数sim_card_id为最小值时,根据iccid,复用卡标识为“8986xxxxxxx”的SIM卡。
POST https://{endpoint}/v1/sim-cards/{sim_card_id}/reset { "down_up_switch" : 2, "iccid" : "8986xxxxxxx" }
响应示例
状态码: 200
OK
{ "work_order_id" : 1000001 }
状态码: 400
Parameter Invalid
{ "error_code" : "GSL.00010004", "error_msg" : "参数异常" }
状态码: 403
Forbidden
{ "error_code" : "GSL.00016010", "error_msg" : "您操作的卡仍有未完成的停机受理单,请勿重复操作。" }
状态码: 500
Internal Server Error
{ "error_code" : "GSL.00010003", "error_msg" : "系统繁忙,请稍后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Parameter Invalid |
403 |
Forbidden |
500 |
Internal Server Error |
错误码
请参见错误码。