iotLCM

Appearance

查询类 ​

单卡基本信息查询 ​

http
POST /openapi/v3/query/sim-info

请求头：

http
X-Access-Token: {accessToken}

请求体：

字段类型说明
appIdstring客户组织编码
iccidstringICCID，iccid、msisdn、imsi 至少传一个
msisdnstringMSISDN
imsistringIMSI

请求示例：

json
{
    "appId": "CUS-202601-0001",
    "iccid": "89860400000000005474"
}

响应结构：

字段类型说明
data.iccidstringICCID
data.msisdnstringMSISDN
data.imsistringIMSI
data.imeistringIMEI
data.usernamestring当前归属客户/组织名称
data.locationstring归属地
data.planCategorystring套餐分类
data.currentPlanNamestring当前套餐名称
data.plangroupstring套餐分组，未配置时为空字符串
data.planidstring当前套餐编码
data.appidstring归属客户组织编码
data.allowPlanChangenumber是否允许改套餐，未启用时返回 0
data.lastSyncTimestring状态最后同步时间
data.accessTypestring接入方式
data.cardStatusstring卡状态
data.cardTypeany卡类型
data.networkTypeany网络类型
data.activationDatestring出库/激活相关日期
data.activeDatestring当前套餐生效日期
data.validityPeriodnumber有效期，按月份计算
data.expiryDatestring当前套餐到期日期
data.testPeriodnumber测试期，未启用时返回 0
data.testPeriodExpiryDateany测试期到期时间，未启用时返回 null
data.silentPeriodnumber沉默期，未启用时返回 0
data.silentPeriodExpiryDateany沉默期到期时间，未启用时返回 null
data.dataServicenumber数据服务状态，1 启用，0 禁用
data.planDatanumber套餐总流量，单位 MB
data.usedDatanumber已用流量，单位 MB
data.remainingDatastring剩余流量，单位 MB
data.smsServicenumber短信服务状态
data.planSMSnumber套餐短信总量
data.usedSMSnumber已用短信数
data.remainingSMSstring剩余短信数
data.voiceServicenumber语音服务状态
data.planMinutesnumber套餐语音分钟数
data.usedMinutesnumber已用语音分钟数
data.remainingMinutesstring剩余语音分钟数
data.internationalRoamingServicenumber国际漫游服务状态
data.planInternationalDatanumber国际漫游套餐流量
data.usedInternationalDatanumber已用国际漫游流量
data.remainingInternationalDatastring剩余国际漫游流量
data.descriptionany备注描述，未填写时返回 null

响应示例：

json
{
    "code": 0,
    "message": "",
    "data": {
        "iccid": "89860400000000005474",
        "imei": "",
        "username": "示例企业",
        "location": "370100000000",
        "planCategory": "移动小流量",
        "currentPlanName": "每月100m3年",
        "plangroup": "",
        "planid": "yd-100m-3y",
        "appid": "CUS-202601-0001",
        "allowPlanChange": 0,
        "lastSyncTime": "2026-06-24 00:03:19",
        "accessType": "",
        "cardStatus": "已激活",
        "cardType": "",
        "networkType": "",
        "activationDate": "2026-06-01",
        "activeDate": "2026-06-01",
        "validityPeriod": 32,
        "expiryDate": "2029-01-31",
        "testPeriod": 0,
        "testPeriodExpiryDate": null,
        "silentPeriod": 0,
        "silentPeriodExpiryDate": null,
        "dataService": 1,
        "planData": 100,
        "usedData": 0.875,
        "remainingData": "99.1",
        "smsService": 1,
        "planSMS": 0,
        "usedSMS": 0,
        "remainingSMS": "0",
        "voiceService": 1,
        "planMinutes": 0,
        "usedMinutes": 0,
        "remainingMinutes": "0",
        "internationalRoamingService": 0,
        "planInternationalData": 0,
        "usedInternationalData": 0,
        "remainingInternationalData": "0.0",
        "description": null
    },
    "error": null
}

单卡状态信息查询 ​

http
POST /openapi/v3/query/sim-status

请求头：

http
X-Access-Token: {accessToken}

请求体：

字段类型说明
appIdstringtoken 返回的客户组织编码
iccidstringICCID；与 msisdn、imsi 至少传一个
msisdnstringMSISDN
imsistringIMSI

请求示例：

json
{
    "appId": "CUS-202601-0001",
    "iccid": "89860400000000005474"
}

响应结构：

字段类型说明
codenumber业务状态码，成功为 0
messagestring错误或提示信息
data.iccidstringICCID，查询命中时返回
data.lifeCyclenumber卡生命周期状态编码
data.lifeCycleNamestring卡生命周期状态文字
errorany错误信息字段

响应示例（查询命中）：

json
{
    "code": 0,
    "message": "",
    "data": {
        "iccid": "89860400000000005474",
        "lifeCycle": 2,
        "lifeCycleName": "已激活"
    },
    "error": null
}

响应示例（未命中）：

json
{
    "code": 50,
    "message": "查询sim卡信息失败，请确认ICCID，MSISDN，IMSI是否正确",
    "data": {},
    "error": null
}

lifeCycleName 为状态文字；lifeCycle 是此接口的状态编码，不要与其他接口或字典中的状态编码混用。

单卡流量限额查询 ​

http
POST /openapi/v3/query/sim-limit

请求体：

字段类型说明
appIdstring客户组织编码
iccidstringICCID
msisdnstringMSISDN
imsistringIMSI

请求示例：

json
{
    "appId": "CUS-202601-0001",
    "iccid": "89860400000000005474"
}

响应字段：

字段类型说明
data.trafficCutoffStatusinteger达量断网状态：0 未配置、1 已开启、2 已关闭
data.trafficCutoffNamestring状态名称，返回 未配置、已开启 或 已关闭
data.trafficCutoffThresholdnumber达量断网阈值，单位 MB

响应示例：

json
{
    "code": 0,
    "message": "",
    "data": {
        "trafficCutoffStatus": 1,
        "trafficCutoffName": "已开启",
        "trafficCutoffThreshold": 1024
    },
    "error": null
}

单卡实时终端 IMEI 查询 ​

http
POST /openapi/v3/query/sim-imei

请求体：

字段类型说明
appIdstring客户组织编码
iccidstringICCID
msisdnstringMSISDN
imsistringIMSI

请求示例：

json
{
    "appId": "CUS-202601-0001",
    "iccid": "89860400000000005474"
}

响应结构：

字段类型说明
data.imeistringIMEI

响应示例：

json
{
    "code": 0,
    "message": "",
    "data": {
        "imei": ""
    },
    "error": null
}

单卡本月流量使用量查询 ​

http
POST /openapi/v3/query/sim-usage

请求体：

字段类型说明
appIdstring客户组织编码
iccidstringICCID
msisdnstringMSISDN
imsistringIMSI

请求示例：

json
{
    "appId": "CUS-202601-0001",
    "iccid": "89860400000000005474"
}

响应结构：

字段类型说明
data.useUnitstring流量单位，固定为 MB
data.useAmountnumber当前周期已用流量

响应示例：

json
{
    "code": 0,
    "message": "",
    "data": {
        "useUnit": "MB",
        "useAmount": 0.875
    },
    "error": null
}

物联网卡批量状态信息查询 ​

http
POST /openapi/v3/query/sim-status-batch

单次最多查询 1000 张卡。每张卡至少提供 iccid、msisdn、imsi 中的一个；同一条记录提供多个标识时，必须对应同一张卡。

请求头：

http
X-Access-Token: {accessToken}

请求体：

字段类型说明
appIdstringtoken 返回的客户组织编码，示例为 CUS-202601-0001
cardsarray卡片标识列表；示例包含 3 张卡，单次最多 1000 项
cards[].iccidstringICCID；示例中每项均使用 ICCID，实际调用时与 msisdn、imsi 至少传一个
cards[].msisdnstringMSISDN，可代替 ICCID 标识卡片
cards[].imsistringIMSI，可代替 ICCID 标识卡片

请求示例：

json
{
    "appId": "CUS-202601-0001",
    "cards": [
        {
            "iccid": "89860400000000005473"
        },
        {
            "iccid": "89860400000000005474"
        },
        {
            "iccid": "8986110000000004371"
        }
    ]
}

响应结构：

字段类型说明
codenumber业务状态码，成功为 0
messagestring错误或提示信息
data.totalinteger本次请求的卡片总数；示例为 3
data.matchedCountinteger匹配成功的卡片数量；示例为 3
data.notFoundCountinteger未匹配成功的卡片数量；示例为 0
data.itemsarray每张卡的查询结果；示例依次对应请求中的 3 张卡
data.items[].matchedboolean是否匹配成功；示例中均为 true
data.items[].iccidstring匹配成功时返回的 ICCID
data.items[].lifeCyclenumber匹配成功时返回的卡生命周期状态编码；示例中 2 为已激活
data.items[].lifeCycleNamestring匹配成功时返回的卡生命周期状态文字
data.items[].errorCodestring匹配失败时返回的错误码；示例均匹配成功，因此未返回
data.items[].errorMessagestring匹配失败时返回的错误说明；示例均匹配成功，因此未返回
errorany错误信息字段

响应示例：

json
{
    "code": 0,
    "message": "",
    "data": {
        "total": 3,
        "matchedCount": 3,
        "notFoundCount": 0,
        "items": [
            {
                "matched": true,
                "iccid": "89860400000000005473",
                "lifeCycle": 2,
                "lifeCycleName": "已激活"
            },
            {
                "matched": true,
                "iccid": "89860400000000005474",
                "lifeCycle": 2,
                "lifeCycleName": "已激活"
            },
            {
                "matched": true,
                "iccid": "8986110000000004371",
                "lifeCycle": 2,
                "lifeCycleName": "已激活"
            }
        ]
    },
    "error": null
}

物联网卡批量流量信息查询 ​

http
POST /openapi/v3/query/sim-usage-batch

单次最多查询 1000 张卡。请求体需传入 appId 和 cards 数组；数组中的每张卡至少提供 iccid、msisdn、imsi 中的一个。同一条记录提供多个标识时，必须对应同一张卡。

请求头：

http
X-Access-Token: {accessToken}

请求体：

字段类型说明
appIdstringtoken 返回的客户组织编码
cardsarray卡片标识列表，单次最多 1000 项
cards[].iccidstringICCID；每项与 msisdn、imsi 至少传一个
cards[].msisdnstringMSISDN，可代替 ICCID 标识卡片
cards[].imsistringIMSI，可代替 ICCID 标识卡片

请求示例：

json
{
    "appId": "CUS-202601-0001",
    "cards": [
        {
            "iccid": "89860400000000005474"
        },
        {
            "iccid": "89860400000000005473"
        },
        {
            "iccid": "8986110000000004371"
        }
    ]
}

响应结构（流量单位为 MB）：

字段类型说明
codenumber业务状态码，成功为 0
messagestring错误或提示信息
data.totalinteger本次请求的卡片总数
data.matchedCountinteger匹配成功的卡片数量
data.notFoundCountinteger未匹配成功的卡片数量
data.itemsarray每张卡的查询结果
data.items[].matchedboolean是否匹配成功
data.items[].iccidstring匹配成功时返回的 ICCID
data.items[].useUnitstring流量单位，示例为 MB
data.items[].useAmountnumber流量使用量
data.items[].errorCodestring匹配失败时返回的错误码；匹配成功时不返回
data.items[].errorMessagestring匹配失败时返回的错误说明；匹配成功时不返回
errorany错误信息字段

响应示例：

json
{
    "code": 0,
    "message": "",
    "data": {
        "total": 3,
        "matchedCount": 3,
        "notFoundCount": 0,
        "items": [
            {
                "matched": true,
                "iccid": "89860400000000005474",
                "useUnit": "MB",
                "useAmount": 0.875
            },
            {
                "matched": true,
                "iccid": "89860400000000005473",
                "useUnit": "MB",
                "useAmount": 12.5
            },
            {
                "matched": true,
                "iccid": "8986110000000004371",
                "useUnit": "MB",
                "useAmount": 36.25
            }
        ]
    },
    "error": null
}

物联网卡批量 IMEI 查询 ​

http
POST /openapi/v3/query/sim-imei-batch

单次最多查询 1000 张卡。每张卡至少提供 iccid、msisdn、imsi 中的一个；同一条记录提供多个标识时，必须对应同一张卡。

请求头：

http
X-Access-Token: {accessToken}

请求体：

字段类型说明
appIdstringtoken 返回的客户组织编码
cardsarray卡片标识列表，单次最多 1000 项
cards[].iccidstringICCID；每项与 msisdn、imsi 至少传一个
cards[].msisdnstringMSISDN，可代替 ICCID 标识卡片
cards[].imsistringIMSI，可代替 ICCID 标识卡片

请求示例：

json
{
    "appId": "CUS-202601-0001",
    "cards": [
        {
            "iccid": "89860400000000005474"
        },
        {
            "iccid": "89860400000000005473"
        },
        {
            "msisdn": "1441543605474"
        }
    ]
}

响应结构：

字段类型说明
codenumber业务状态码，成功为 0
messagestring错误或提示信息
data.totalinteger本次请求的卡片总数
data.matchedCountinteger匹配成功的卡片数量
data.notFoundCountinteger未匹配成功的卡片数量
data.itemsarray每张卡的查询结果，顺序与请求中的 cards 一致
data.items[].matchedboolean是否匹配成功
data.items[].iccidstring匹配成功时返回的 ICCID
data.items[].imeistringIMEI；尚未采集到该卡 IMEI 时为空字符串
data.items[].errorCodestring匹配失败时返回的错误码；匹配成功时不返回
data.items[].errorMessagestring匹配失败时返回的错误说明；匹配成功时不返回
errorany错误信息字段

响应示例：

json
{
    "code": 0,
    "message": "",
    "data": {
        "total": 3,
        "matchedCount": 2,
        "notFoundCount": 1,
        "items": [
            {
                "matched": true,
                "iccid": "89860400000000005474",
                "imei": ""
            },
            {
                "matched": true,
                "iccid": "89860400000000005473",
                "imei": "865466070817587"
            },
            {
                "matched": false,
                "imei": "",
                "errorCode": "CARD_NOT_FOUND",
                "errorMessage": "卡片不存在或无权限"
            }
        ]
    },
    "error": null
}

物联网卡批量限额信息查询 ​

http
POST /openapi/v3/query/traffic-cutoff-config

根据卡片标识批量查询当前达量断网配置。cards[] 中的 iccid、msisdn、imsi 三码至少传一个。

请求体：

字段类型说明
appIdstring客户组织编码
cardsarray卡片标识列表
cards[].iccidstringICCID
cards[].msisdnstringMSISDN
cards[].imsistringIMSI
includeUsageboolean是否返回套餐和流量使用信息

请求示例：

json
{
    "appId": "CUS-202601-0001",
    "cards": [
        {
            "iccid": "89860400000000005474"
        },
        {
            "iccid": "89860400000000005475"
        },
        {
            "iccid": "89860400000000005476"
        }
    ],
    "includeUsage": true
}

响应结构：

字段类型说明
data.totalinteger请求中的卡片数量
data.matchedCountinteger匹配成功的卡片数量
data.notFoundCountinteger未匹配成功的卡片数量
data.itemsarray每张卡的查询结果
data.items[].matchedboolean是否匹配成功
data.items[].iccidstring平台返回的 ICCID
data.items[].trafficCutoffStatusinteger达量断网状态：0 未配置、1 已开启、2 已关闭
data.items[].trafficCutoffStatusNamestring达量断网状态名称
data.items[].trafficCutoffThresholdnumber达量断网阈值，单位 MB
data.items[].trafficCutoffThresholdUnitstring阈值单位，固定为 MB
data.items[].packageTotalFlowMbnumber套餐总流量;includeUsage=true 时返回
data.items[].usedFlowMbnumber已用流量;includeUsage=true 时返回
data.items[].remainingFlowMbnumber剩余流量;includeUsage=true 时返回
data.items[].errorCodestring匹配失败时返回
data.items[].errorMessagestring匹配失败时返回

响应示例：

以下状态、阈值和流量数值用于展示批量响应结构，实际结果以接口查询为准。

json
{
    "code": 0,
    "message": "",
    "data": {
        "total": 3,
        "matchedCount": 3,
        "notFoundCount": 0,
        "items": [
            {
                "matched": true,
                "iccid": "89860400000000005474",
                "trafficCutoffStatus": 0,
                "trafficCutoffStatusName": "未配置",
                "trafficCutoffThreshold": 0,
                "trafficCutoffThresholdUnit": "MB",
                "packageTotalFlowMb": 0,
                "usedFlowMb": 18,
                "remainingFlowMb": 0
            },
            {
                "matched": true,
                "iccid": "89860400000000005475",
                "trafficCutoffStatus": 1,
                "trafficCutoffStatusName": "已开启",
                "trafficCutoffThreshold": 100,
                "trafficCutoffThresholdUnit": "MB",
                "packageTotalFlowMb": 200,
                "usedFlowMb": 80,
                "remainingFlowMb": 120
            },
            {
                "matched": true,
                "iccid": "89860400000000005476",
                "trafficCutoffStatus": 2,
                "trafficCutoffStatusName": "已关闭",
                "trafficCutoffThreshold": 50,
                "trafficCutoffThresholdUnit": "MB",
                "packageTotalFlowMb": 100,
                "usedFlowMb": 30,
                "remainingFlowMb": 70
            }
        ]
    },
    "error": null
}

批次状态查询 ​

http
POST /openapi/v3/query/batch-status

根据指定批次号查询异步处理状态，支持续费、达量断网等异步批次。

请求参数：

字段类型说明
appIdstring客户组织编码
batchNostring异步 API 返回的批次号

请求示例：

json
{
    "appId": "CUS-202601-0001",
    "batchNo": "REN20260910153546001000001"
}

响应结构：

字段类型说明
data.batchNostring请求中的批次号
data.batchAsyncStatusinteger异步状态：0 已创建、1 待处理、2 处理中、3 成功、4 失败、5 部分成功

响应示例：

json
{
    "code": 0,
    "message": "",
    "data": {
        "batchNo": "REN20260910153546001000001",
        "batchAsyncStatus": 3
    },
    "error": null
}

iotLCM 文档中心