oneLink 卡信息查询 (二)
卡信息查询
CMIOT_API23B01- 单卡余额信息实时查询
查询物联卡余额信息。
请求 URL:
请求方式:
- GET
参数形式:
- form-data
参数:
参数名称 | 必选 | 默认值 | 类型 | 说明 | 规则 |
---|---|---|---|---|---|
transid | 是 | 无 | String | 事务编码,由物联卡集团客户按照相应规则自主生成。生成规则:APPID+YYYYMMDDHHMISS+8 位数字序列(此序列由集团客户自主生成,比如从 00000001 开始递增等等),transid 样例:1000599992700000062014101615303080000001 | |
token | 是 | 无 | String | 令牌,通过指定接口获取。 | |
msisdn | 否 | 无 | String | 所查询的物联卡号码,最长 13 位数字,举例:14765004176。 | |
iccid | 否 | 无 | String | 集成电路卡识别码,IC 卡的唯一识别号码,共有 20 位字符组成,举例:898600D6991330004146。 | |
imsi | 否 | 无 | String | 国际移动用户识别码,其总长度不超过 15 位,使用 0~9 的数字,举例:460079650004176。 | msisdn、iccid、imsi 必须有且只有一项 |
请求 URL 举例
https://api.iot.10086.cn/v5/ec/query/balance-info?transid=xxx&token=xxx&msisdn=xxx
- 以 msisdn 进行查询
https://api.iot.10086.cn/v5/ec/query/balance-info?transid=xxx&token=xxx&iccid=xxx
- 以 iccid 进行查询
https://api.iot.10086.cn/v5/ec/query/balance-info?transid=xxx &token=xxx&imsi=xxx
- 以 imsi 进行查询
返回:
参数名称 | 必选 | 默认值 | 类型 | 说明 |
---|---|---|---|---|
status | 是 | 无 | String | 错误码。0- 成功 非 0- 失败 |
message | 是 | 无 | String | 错误信息。错误码对应的错误描述,参考错误码列表 |
result | 是 | 无 | String | 返回结果集(status 为“0”时,result 包含正确的结果数据;status 为“非 0”时,result 可能为空,也可能包含其他提示数据) |
result:
参数名称 | 必选 | 默认值 | 类型 | 说明 |
---|---|---|---|---|
accountId | 是 | 无 | String | 账户 Id |
accountName | 是 | 无 | String | 账户名称 |
amount | 是 | 无 | String | 余额,单位:元余额为负数时表示欠费金额 |
返回示例
成功:
{
"status": "0",
"message": "正确",
"result": [
{ "accountId": "20180305151701",
"accountName": "可口可乐有限公司",
"amount": "0.62" }]
}
失败:
{
"message": "TOKEN 不存在或已过期,请重新获取",
"result": [],
"status": "12021"
}
备注
accountName 获得的是开户的名称,归属地如何获取呢?
CMIOT_API25M01- 单卡在线信息实时查询
查询物联卡的在线信息,区分 APN,返回 APN 信息、IP 地址、会话创建时间。
请求 URL:
请求方式:
- GET
参数形式:
- form-data
参数:
参数名称 | 必选 | 默认值 | 类型 | 说明 | 规则 |
---|---|---|---|---|---|
transid | 是 | 无 | String | 事务编码,由物联卡集团客户按照相应规则自主生成。生成规则:APPID+YYYYMMDDHHMISS+8 位数字序列(此序列由集团客户自主生成,比如从 00000001 开始递增等等),transid 样例:1000599992700000062014101615303080000001 | |
token | 是 | 无 | String | 令牌,通过指定接口获取。 | |
msisdn | 否 | 无 | String | 所查询的物联卡号码,最长 13 位数字,举例:14765004176。 | |
iccid | 否 | 无 | String | 集成电路卡识别码,IC 卡的唯一识别号码,共有 20 位字符组成,举例:898600D6991330004146。 | |
imsi | 否 | 无 | String | 国际移动用户识别码,其总长度不超过 15 位,使用 0~9 的数字,举例:460079650004176。 | msisdn、iccid、imsi 必须有且只有一项 |
请求 URL 举例
https://api.iot.10086.cn/v5/ec/query/sim-session?transid=xxx&token=xxx&msisdn=xxx
- 以 msisdn 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-session?transid=xxx&token=xxx&iccid=xxx
- 以 iccid 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-session?transid=xxx&token=xxx&imsi=xxx
- 以 imsi 进行查询
返回:
参数名称 | 必选 | 默认值 | 类型 | 说明 |
---|---|---|---|---|
status | 是 | 无 | String | 错误码。0- 成功 非 0- 失败 |
message | 是 | 无 | String | 错误信息。错误码对应的错误描述,参考错误码列表 |
result | 是 | 无 | String | 返回结果集(status 为“0”时,result 包含正确的结果数据;status 为“非 0”时,result 可能为空,也可能包含其他提示数据) |
result:
参数名称 | 必选 | 默认值 | 类型 | 说明 |
---|---|---|---|---|
simSessionList | 是 | 无 | String | 会话信息列表 |
apnId | 是 | 无 | String | APN ID |
status | 是 | 无 | String | 在线状态 00: 离线 01:在线 |
ip | 是 | 无 | String | IP 地址 |
createDate | 是 | 无 | String | 会话创建时间 |
rat | 是 | 无 | String | 接入方式:1: 3G 2: 2G 6: 4G 8: NB |
返回示例
成功:
{
"status": "0",
"message": "正确",
"result": [
{
"simSessionList":[
{
"apnId":"CMIOT",
"status":"01",
"ip":"127.0.0.1",
"createDate":"2018-08-23 17:17:27",
"rat":"6"
},
...
]
} ]
}
失败:
{
"message":"TOKEN 不存在或已过期,请重新获取",
"result":[],
"status":"12021"
}
备注
CMIOT_API25S05- 码号信息批量查询
根据 ICCID、IMSI、MSISDN 任意 1 个码号批量查询剩余 2 个码号的信息。
每次查询不超过 100 张卡。 (OneLink-CT 的主 EC 客户查询副 EC 卡数据时,一次查询的卡号必须归属于
同一个 EC,OneLink-PB 的主 EC 客户可以一次查询多个 EC 的卡数据)
请求 URL:
请求方式:
- GET
参数形式:
- form-data
参数:
参数名称 | 必选 | 默认值 | 类型 | 说明 | 规则 |
---|---|---|---|---|---|
transid | 是 | 无 | String | 事务编码,由物联卡集团客户按照相应规则自主生成。生成规则:APPID+YYYYMMDDHHMISS+8 位数字序列(此序列由集团客户自主生成,比如从 00000001 开始递增等等),transid 样例:1000599992700000062014101615303080000001 | |
token | 是 | 无 | String | 令牌,通过指定接口获取。 | |
msisdns | 否 | 无 | String | 所查询的物联卡号码,最长 13 位数字,举例:14765004176,批量查询多个号码用下划线分隔例如:xxxx_xxxx_xxxx;msisdns、iccids、imsis 必须有且只有一项 | |
iccids | 否 | 无 | String | 集成电路卡识别码,IC 卡的唯一识别号码,共有 20 位字符组成,举例:898600D6991330004146,批量查询多个号码用下划线分隔。例如:xxxx_xxxx_xxxx;msisdns、iccids、imsis 必须有且只有一项 | |
imsis | 否 | 无 | String | 国际移动用户识别码,其总长度不超过 15 位,使用 0~9 的数字,举例:460079650004176,批量查询多个号码用下划线分隔。例如:xxxx_xxxx_xxxx;msisdns、iccids、imsis 必须有且只有一项 | msisdn、iccid、imsi 必须有且只有一项 |
请求 URL 举例
https://api.iot.10086.cn/v5/ec/query/sim-card-info/batch?transid=xxx&token=xxx&msis
dns=xxx_xxx_xxx - 以 msisdns 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-card-info/batch?transid=xxx&token=xxx&iccid
s=xxx_xxx_xxx - 以 iccids 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-card-info/batch?transid=xxx&&token=xxx&im
sis=xxx_xxx_xxx - 以 imsis 进行查询
返回:
参数名称 | 必选 | 默认值 | 类型 | 说明 |
---|---|---|---|---|
status | 是 | 无 | String | 错误码。0- 成功 非 0- 失败 |
message | 是 | 无 | String | 错误信息。错误码对应的错误描述,参考错误码列表 |
result | 是 | 无 | String | 返回结果集(status 为“0”时,result 包含正确的结果数据;status 为“非 0”时,result 可能为空,也可能包含其他提示数据) |
result:
参数名称 | 必选 | 默认值 | 类型 | 说明 |
---|---|---|---|---|
status | 是 | 无 | Integer | 查询状态,0- 成功,非 0- 失败 |
message | 是 | 无 | String | 错误信息。错误码对应的错误描述,参考错误码列表 |
imsi | 是 | 无 | String | 国际移动用户识别码,其总长度不超过 15 位,使用 0~9 的数字,举例:460079650004176 |
msisdn | 是 | 无 | String | 所查询的物联卡号码,最长 13 位数字,举例:14765004176 |
iccid | 是 | 无 | String | 集成电路卡识别码,IC 卡的唯一识别号码,共有 20 位字符组成,举例:898600D6991330004146 |
返回示例
成功:
{
"status":"0",
"message":"正确",
"result":[
{ "status":"0",
"message":"正确",
"imsi":"460040260908676",
"msisdn":"1064826090209",
"iccid":"898602B2221430000006"
}, { "status":"0",
"message":"正确",
"imsi":"460040260900788",
"msisdn":"1064826090212",
"iccid":"898602B2221340000878"
},
{
"status":"12009"
"message":" ICCID 号不是所查询的集团下的用户",
"iccid":"89860010011631234571"
},
......
]
}
批量失败:
{
"status":"10001",
"message":"批量操作失败",
"result":[ {
"status":"12009"
"message":" ICCID 号不是所查询的集团下的用户",
"iccid":"89860010011631234571"
},
{
"status":"12009"
"message":" ICCID 号不是所查询的集团下的用户",
"iccid":"89860010011631234572" } ]
}
失败: {
"message":"TOKEN 不存在或已过期,请重新获取",
"result":[],
"status":"12021"
}
备注
号码状态查询公共接口
获取号码状态基本信息公共接口
请求 URL:
请求方式:
- POST
参数形式:
- form-data
参数:
参数名 | 位置 | 类型 | 说明 | 是否必填 |
---|---|---|---|---|
access_token | header | String | 用户 token | 是 |
imsis | url | String | 多个 imsi 逗号分隔 | 否 |
iccids | url | String | 多个 iccid 逗号分隔 | 否 |
msisdns | url | String | 多个 msisdn 逗号分隔 | 否 |
返回:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
数据顺序号 | 是 | String | 序号 |
error | 是 | 是否有误 | |
iccid | 是 | String | iccid |
imsi | 是 | String | imsi |
msisdn | 是 | String | msisdn(号码) |
opentime | 是 | String | 开卡时间 |
billingstatus | 是 | String | 计费状态 {00: 正常;01: 测试期;02: 沉默期;03: 其它;04: 销号; 其它:"未知:"+billingstatus} 或者{1:待激活 2:已激活 4:停机 6:可测试 7:库存 8:预销户 9:已销户 其它:未知} |
gprsstatus | 是 | String | 是否在线 {00: 离线;01: 在线} |
userstatus | 是 | String | 用户状态 {00: 正常;01: 单向停机;02: 停机;03: 预销号;04: 销号;05: 过户;06: 休眠;07: 待激活;99: 号码不存在; 其它:"未知:"+userstatus} |
gprstotal | 是 | 总流量(M) | |
gprsusedflow | 是 | 已使用流量(KB) |
返回示例
备注
获取号码状态详细信息公共接口
请求 URL:
请求方式:
- POST
参数形式:
- form-data
参数:
参数名 | 位置 | 类型 | 说明 | 是否必填 |
---|---|---|---|---|
access_token | header | String | 用户 token | 是 |
iccid | url | String | iccid | 否 |
返回:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
iccid | 是 | String | iccid |
msisdn | 是 | String | msisdn(号码) |
imsi | 是 | String | imsi |
opentime | 是 | String | 开卡时间 |
provinceid | 是 | 归属地 | |
blance | 是 | 余额 | |
prodinfos[0] | 是 | 套餐 1 | |
prodinfos[1] | 是 | 套餐 2 | |
prodinfos[2] | 是 | 套餐 3 | |
prodinfos[3] | 是 | 套餐 4 | |
prodinfos[4] | 是 | 套餐 5 | |
prodinfos[5] | 是 | 套餐 6 | |
gprstotal/gprsusedflow | 是 | 总流量(M)/ 已使用(KB) | |
gprsstatus | 是 | String | 是否在线 {00: 离线;01: 在线} |
userstatus | 是 | String | 用户状态 {00: 正常;01: 单向停机;02: 停机;03: 预销号;04: 销号;05: 过户;06: 休眠;07: 待激活;99: 号码不存在; 其它:"未知:"+userstatus} |
billingstatus | 是 | String | 计费状态 {00: 正常;01: 测试期;02: 沉默期;03: 其它;04: 销号; 其它:"未知:"+billingstatus} 或者{1:待激活 2:已激活 4:停机 6:可测试 7:库存 8:预销户 9:已销户 其它:未知} |
issigncall | 是 | 语音服务 | |
issigngprs | 是 | GPRS 服务 | |
issignsms | 是 | SMS 服务 | |
issignapn | 是 | APN 服务 | |
ip | 是 | 用户 ip 地址 | |
apn | 是 | 用户接入的 APN | |
rat | 是 | 接入网络 接入方式:1: 3G 2: 2G 6: 4G 8: NB |