批量获取组织下的SIM卡信息
GET
/sims适用场景
- 根据查询条件批量获取组织下的SIM卡数据。
必要条件
- 仅支持对所用API key归属企业下的卡片进行操作。
- OTA、非OTA(包括多IMSI)卡片均支持操作。
注意事项
- 接口支持分页,每页最大返回100条数据。
- 默认查询第1页,100条数据。
- 返回参数sim_service.contract.end_at为null时,代表结束时间为无限期。
业务规则
- 查询条件支持同时输入多个,但返回数据需要同时满足每一个查询条件,当某一条件不满足时该SIM卡数据将不返回。
- 若输入两个相同的sim_id,则返回数据中只有一条数据。
- sim_ids可选,最大输入个数<=100个,否则返回错误。
- order_id可选,特指通过POST /orders 接口下单时的order_id。
- status可选,为空时默认为全部状态,可输入某一状态值查询指定状态数据。
- 10,Pre-active,静默期
- 23,Active-live,使用期,可入网,正式Bundle使用中。
- 30,Paused,暂停期,不可入网,需resume后恢复。
- 40,Expired,停机保期,不可入网。
- 50,Terminated,废弃期,不可入网。
SDK API 调用方式
PartnerClient client = new PartnerClient(accessKey,privateKey)
client.v2().sim().batchQuerySim(BatchQuerySim.builder(5).currentLifecycle(status).pageNo(1).pageSize(10).build())
或
client.v2().sim().batchQuerySim(BatchQuerySim.builder(5).status(status).pageNo(1).pageSize(10).build())
SDK 版本 1.0.5 及以上 支持order_id 及sim_ids 查询
client.v2().sim().batchQuerySim(BatchQuerySim.builder(5).simIds(new String[]{"89852202306300021263", "89852202306300023202"}).orderId("OL-6XB9HIBHNYY2").pageNo(1).pageSize(pageSize).build());
请求参数
Query 参数
status
integer
可选
选填,每次填充一个,为空时默认全部SIM卡状态,具体状态值可参见描述
示例值:
23
page_no
integer
选填,默认1
示例值:
1
page_size
integer
可选
选填,1-100,默认100
示例值:
100
order_id
string
销售订单号
示例值:
OL-6HPXQUXQFV4Y
sim_ids
string
可选
sim_id 多个以英文逗号隔开,最多支持100个设备号
示例值:
89852202112100405650,89852202108230405172
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
No schema defined
示例
{
"status": {
"code": "CB-00-0000",
"message": "成功",
"detail": null
},
"data": [
{
"sim_id": "89852202508034252912",
"status": 30,
"sim_service": {
"contract": {
"start_at": 1661757216000,
"expire_at": 1685548799000,
"end_at": 1685548799000
},
"bundles": [
{
"id": "LP20220830003867",
"status": 1,
"type": 1,
"use": 3,
"data_limit": 31457280,
"period_unit": 2,
"period_number": 1,
"cycles": 1,
"current_cycle": 1,
"current_cycle_start_at": 1667372568000,
"current_cycle_end_at": 1669823999000,
"current_cycle_usage": 0,
"added_at": 1667359994000,
"start_at": 1667372568000,
"end_at": 1669823999000
}
]
}
},
{
"sim_id": "89852202508034252910",
"status": 40,
"sim_service": {
"contract": {
"start_at": 1681270727000,
"end_at": 1711900799000
},
"bundles": []
}
}
],
"total_count": 45
}
最后修改时间: 1 年前