批量获取组织下的SIM卡信息

适用场景

根据查询条件批量获取组织下的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-activated，静默期
- 11 Inactive，待激活，SIM卡处于未使用状态，可激活用于测试或商用；
- 21 Active-ready，可激活，SIM卡可正常使用但尚未记录用量。监测到使用后进入测试或活跃状态；
- 22 Active-test，测试中，SIM卡处于测试活跃阶段；
- 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());

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

示例

{
    "data": [
        {
            "sim_id": "89430100000057018392",
            "status": 10,
            "tags": [],
            "org_id": "0000000002",
            "device_name": null
            "sim_service": {
                "contract": {
                    "start_at": 1752080071000,
                    "end_at": null,
                    "expire_at": 1785542399000,
                    "activated_at": null
                },
                "bundles": [
                    {
                        "id": "CP-8081F8000END",
                        "status": 1,
                        "type": 6,
                        "use": 1,
                        "data_limit": 31457280,
                        "period_unit": 2,
                        "period_number": 12,
                        "cycles": 1,
                        "current_cycle": 1,
                        "current_cycle_start_at": 1752080071042,
                        "current_cycle_end_at": 1782863999000,
                        "current_cycle_usage": 59392,
                        "added_at": 1752080071012,
                        "start_at": 1752080071042,
                        "end_at": 1782863999000
                    },
                    {
                        "id": "CP-8081EY9G0000",
                        "status": 0,
                        "type": 1,
                        "use": 1,
                        "data_limit": 31457280,
                        "period_unit": 2,
                        "period_number": 1,
                        "cycles": 1,
                        "current_cycle": null,
                        "current_cycle_start_at": null,
                        "current_cycle_end_at": null,
                        "current_cycle_usage": 0,
                        "added_at": 1752080071014,
                        "start_at": null,
                        "end_at": null
                    }
                ]
            }

        }
    ],
    "status": {
        "code": "CB-00-0000",
        "message": "成功",
        "detail": "https://apidoc-cn.iotcube.link/"
    },
    "total_count": 303

🟢200success

适用场景

必要条件

注意事项

业务规则

SDK API 调用方式

请求参数

请求示例代码

返回响应