荆棘从死亡中来，死亡又包含着新生。
  •  0 回帖  •  2.4K 浏览  •  4 年前
   

oneLink 卡信息查询 (一)

卡信息查询

CMIOT_API23S00- 单卡基本信息查询

查询物联卡码号信息、开卡时间、首次激活时间。

请求 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-basic-info?transid=xxx&token=xxx&msisdn=x
xx - 以 msisdn 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-basic-info?transid=xxx&token=xxx&iccid=xxx
- 以 iccid 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-basic-info?transid=xxx &token=xxx&imsi=xxx
- 以 imsi 进行查询

返回：
参数名称必选默认值类型说明
status是无String错误码。0- 成功 非 0- 失败
message是无String错误信息。错误码对应的错误描述，参考错误码列表
result是无String返回结果集（status 为“0”时，result 包含正确的结果数据；status 为“非 0”时，result 可能为空，也可能包含其他提示数据）

result：

参数名称必选默认值类型说明
msisdn是无String物联卡号码，最长 13 位数字
imsi是无String国际移动用户识别码，其总长度不超过 15 位，使用 0~9 的数字
iccid是无String集成电路卡识别码，IC 卡的唯一识别号码，共有 20 位字符组成
activeDate是无String激活日期（首次）
openDate是无String开卡时间
返回示例

成功：

{
"status": "0"，
"message": "正确",
"result": [
{
"msisdn":"14765004176",
"imsi":"460079650004176",
"iccid":"898600D6991330004146",
"activeDate":"2018-04-22 08:00:00",
"openDate":"2018-04-21 08:00:00" 
} ] 
}

失败：

{
"message": "TOKEN 不存在或已过期，请重新获取",
"result": [],
"status": "12021" 
}
备注

CMIOT_API25S04- 单卡状态查询

通过卡号查询物联卡的状态信息。

请求 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-status?transid=xxx&token=xxx&msisdn=xxx
- 以 msisdn 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-status?transid=xxx&token=xxx&iccid=xxx
- 以 iccid 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-status?transid=xxx &token=xxx&imsi=xxx
- 以 imsi 进行查询

返回：
参数名称必选默认值类型说明
status是无String错误码。0- 成功 非 0- 失败
message是无String错误信息。错误码对应的错误描述，参考错误码列表
result是无String返回结果集（status 为“0”时，result 包含正确的结果数据；status 为“非 0”时，result 可能为空，也可能包含其他提示数据）

result：

参数名称必选默认值类型说明
cardStatus是无String物联卡状态：当开卡平台为 OneLink-PB 时：00- 正常；01- 单向停机；02- 停机；03- 预销号；04- 销号；05- 过户；06- 休眠；07- 待激活；99- 号码不存在当开卡平台为 OneLink-CT 时：1：待激活 2：已激活 4：停机 6：可测试 7：库存 8：预销户 9：已销户
lastChangeDate是无String最后一次变更时间
返回示例

成功：

{
"status":"0"，
"message":"正确",
"result":[ {
"cardStatus":"1",
"lastChangeDate":"2018-04-21 08:00:00" 
} ] 
}

失败：

{
"message":"TOKEN 不存在或已过期，请重新获取",
"result":[],
"status":"12021"
}
备注

CMIOT_API23R00- 资费订购实时查询

根据用户类型（企业、群组、sim 卡）查询已订购的所有资费列表。

请求 URL：
请求方式：
  • GET
参数形式：
  • form-data
参数：
参数名称必选默认值类型说明规则
transid是无String事务编码，由物联卡集团客户按照相应规则自主生成。生成规则：APPID+YYYYMMDDHHMISS+8 位数字序列（此序列由集团客户自主生成，比如从 00000001 开始递增等等），transid 样例：1000599992700000062014101615303080000001
token是无String令牌，通过指定接口获取。
queryType是无Integer查询场景标识类型 1：客户接入类型 2：群组接入类型 3：sim 接入类型
groupId否无String接入群组编号，queryType 取值为 2 时传 入
msisdn否无String物联卡号码，queryType 取值为 3 时传入
请求 URL 举例

http://api.iot.10086.cn/v5/ec/query/ordered-offerings?transid=xxxxxx&token=xxxxxx&
queryType=xxx –以企业客户进行查询
http://api.iot.10086.cn/v5/ec/query/ordered-offerings?transid=xxxxxx&token=xxxxxx&
queryType=xxx&groupId=xxxxxx–以 groupId 进行查询
http://api.iot.10086.cn/v5/ec/query/ordered-offerings?transid=xxxxxx&token=xxxxxx&
queryType=xxx&msisdn=xxxxxx–以 msisdn 进行查询

返回：
参数名称必选默认值类型说明
status是无String错误码。0- 成功 非 0- 失败
message是无String错误信息。错误码对应的错误描述，参考错误码列表
result是无String返回结果集（status 为“0”时，result 包含正确的结果数据；status 为“非 0”时，result 可能为空，也可能包含其他提示数据）

result：

参数名称必选默认值类型说明
offeringInfoList是无String资费列表包含 offeringId、offeringName、effectiveDate、expiriedDate、apnName
offeringId是无String资费 ID
offeringName是无String资费名称
effectiveDate是无String生效时间
expiriedDate是无String失效时间
apnName是无StringAPN 名称
返回示例

成功：

{
"status": "0"，
"message": "正确",
"result": [
{ "offeringInfoList": [
{
"offeringId":"21000397",
"offeringName":"API 服务订购",
"effectiveDate":"2018-09-13 19:58:13",
"expiriedDate":"2099-12-31 23:59:59"， "apnName":"cmiot1"
},
...
] }] 
}

失败：

{
"message": "TOKEN 不存在或已过期，请重新获取",
"result": [],
"status": "12021"
}
备注

CMIOT_API23U06- 单卡本月套餐内短信使用量实时查询

实时查询物联卡本月套餐内短信使用量。

请求 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-sms-margin?transid=xxx&token=xxx&msisdn=
xxx - 以 msisdn 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-sms-margin?transid=xxx&token=xxx&iccid=x
xx - 以 iccid 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-sms-margin?transid=xxx&token=xxx&imsi=xx
x - 以 imsi 进行查询

返回：
参数名称必选默认值类型说明
status是无String错误码。0- 成功 非 0- 失败
message是无String错误信息。错误码对应的错误描述，参考错误码列表
result是无String返回结果集（status 为“0”时，result 包含正确的结果数据；status 为“非 0”时，result 可能为空，也可能包含其他提示数据）

result：

参数名称必选默认值类型说明
accmMarginList是无String资费列表包含 offeringId、offeringName、effectiveDate、expiriedDate、apnName
offeringId是无String资费 Id
offeringName是无String资费名称
totalAmount是无String总量，单位：条
useAmount是无String使用量，单位：条
remainAmount是无String剩余量，单位：条
返回示例

成功：

{
"status": "0"，
"message": "正确",
"result": [
{
"accmMarginList": [
{
"offeringId": "21000024",
"offeringName": "短信 5 元套餐(标准)",
"totalAmount": "100",
"useAmount": "20",
"remainAmount": "80"
},
...
] }] 
}

失败：

{
"message": "TOKEN 不存在或已过期，请重新获取",
"result": [],
"status": "12021"
}
备注

CMIOT_API23U07- 单卡本月套餐内流量使用量实时查询

实时查询物联卡本月套餐内流量使用量。

请求 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-data-margin?transid=xxx&token=xxx&msisdn
=xxx - 以 msisdn 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-data-margin?transid=xxx&token=xxx&iccid=x
xx - 以 iccid 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-data-margin?transid=xxx&token=xxx&imsi=xx
x - 以 imsi 进行查询

返回：
参数名称必选默认值类型说明
status是无String错误码。0- 成功 非 0- 失败
message是无String错误信息。错误码对应的错误描述，参考错误码列表
result是无String返回结果集（status 为“0”时，result 包含正确的结果数据；status 为“非 0”时，result 可能为空，也可能包含其他提示数据）

result：

参数名称必选默认值类型说明
accmMarginList是无String本月套餐内流量使用情况包含 offeringId、totalAmount、useAmount、remainAmount、offeringName
offeringId是无String资费 Id
offeringName是无String资费名称
totalAmount是无String总量，单位：KB
useAmount是无String使用量，单位：KB
remainAmount是无String剩余量，单位：KB
返回示例

成功：

{
"status": "0"，
"message": "正确",
"result": [
{
"accmMarginList": [
{
"offeringId": "21000032",
"offeringName": "全国通用流量 8 元套餐",
"totalAmount": "102400.00",
"useAmount": "15186.00",
"remainAmount": "87214.00"
},
...
] } ] 
}

失败：

{
"message": "TOKEN 不存在或已过期，请重新获取",
"result": [],
"status": "12021"
}
备注

CMIOT_API23M02- 集团客户短信白名单查询

查询企业客户的短信白名单列表。

请求 URL：
请求方式：
  • GET
参数形式：
  • form-data
参数：
参数名称必选默认值类型说明规则
transid是无String事务编码，由物联卡集团客户按照相应规则自主生成。生成规则：APPID+YYYYMMDDHHMISS+8 位数字序列（此序列由集团客户自主生成，比如从 00000001 开始递增等等），transid 样例：1000599992700000062014101615303080000001
token是无String令牌，通过指定接口获取。
pageSize否无Integer每页查询记录数，不超过 50
startNum否无Integer开始页
请求 URL 举例

https://api.iot.10086.cn/v5/ec/query/ec-message-white-list?transid=xxx&token=xxx&pa
geSize=xxx&startNum=xxx

返回：
参数名称必选默认值类型说明
status是无String错误码。0- 成功 非 0- 失败
message是无String错误信息。错误码对应的错误描述，参考错误码列表
result是无String返回结果集（status 为“0”时，result 包含正确的结果数据；status 为“非 0”时，result 可能为空，也可能包含其他提示数据）

result：

参数名称必选默认值类型说明
currenPage是无Integer页码, 即当前页
flag是无String是否最后一页 Y: 是 N: 否
cardList是无String物联卡号码列表 包含 msisdn
msisdn是无String物联卡号码
返回示例

成功：

{
"status": "0"，
"message": "正确",
"result": [
{
"currenPage":"1",
"flag":"Y",
"cardList":[
{
"msisdn":"14765004176"
},
...
] 
}] 
}

失败：

{
"message": "TOKEN 不存在或已过期，请重新获取",
"result": [],
"status": "12021"
}
备注

CMIOT_API23M08- 单卡通信功能开通查询

查询物联卡通信功能开通情况。

请求 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-communication-function-status?transid=xxx&t
oken=xxx&msisdn=xxx - 以 msisdn 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-communication-function-status?transid=xxx&t
oken=xxx&iccid=xxx - 以 iccid 进行查询
https://api.iot.10086.cn/v5/ec/query/sim-communication-function-status?transid=xxx&t
oken=xxx&imsi=xxx - 以 imsi 进行查询

返回：
参数名称必选默认值类型说明
status是无String错误码。0- 成功 非 0- 失败
message是无String错误信息。错误码对应的错误描述，参考错误码列表
result是无String返回结果集（status 为“0”时，result 包含正确的结果数据；status 为“非 0”时，result 可能为空，也可能包含其他提示数据）

result：

参数名称必选默认值类型说明
serviceTypeList是无String通信功能服务列表包含 serviceType、serviceStatus、apnName
serviceType是无String通信功能服务：01 基础语音通信服务 08 短信基础服务 10 国际漫游服务 11 数据通信服务
serviceStatus是无String通信功能服务状态：0：暂停 1：恢复
apnName是无StringAPN 名称
返回示例

成功：

{
"status": "0"，
"message": "正确",
"result": [
{
"serviceTypeList":[
{"serviceType": "01", "serviceStatus": "1", " apnName": "CMIOT"
},...
] 
}] 
}

失败：

{
"message": "TOKEN 不存在或已过期，请重新获取",
"result": [],
"status": "12021"
}
备注

下一篇 oneLink 卡信息查询 (二)