V2.0开放接口
  1. 物联卡业务
V2.0开放接口
  • 对接前必看
  • 号卡/宽带业务
    • 号卡订单状态码说明
    • 关于下单省市区编码
    • 获取店铺基础配置
      GET
    • 获取在售商品列表
      POST
    • 发送短信验证码
      POST
    • 预选下单号码
      POST
    • 提交申请订单
      POST
    • 订单查询
      POST
    • 获取指定商品详细信息
      POST
    • 上传证件照
      POST
    • 订单回调
      POST
    • IP定位
      GET
  • 靓号业务
    • 获取靓号列表
  • 物联卡业务
    • 物联卡相关状态码说明
    • 批量查询卡板信息(100张)
      POST
    • 批量订阅卡板信息(100张)
      POST
    • 批量查询卡板最新状态(10张)
      POST
    • 批量查询卡板实时流量(10张)
      POST
    • 批量查询卡板指定月流量(10张)
      POST
    • 批量停机(100张)
      POST
    • 批量复机(100张)
      POST
    • 单卡机卡绑定
      POST
    • 单卡限速
      POST
    • 单卡解除限速
      POST
    • 单卡/设备订购套餐包
      POST
    • 获取官方实名链接
      POST
    • 查询卡板操作记录
      POST
    • 查询账户资产
      POST
    • 获取移动流量池Token
      POST
    • 查询设备信息
      POST
    • 查询设备流量
      POST
    • 设备切换网络
      POST
  1. 物联卡业务

批量订阅卡板信息(100张)

POST
/openapi/iot/batchSubscribe
批量订阅/取消订阅卡板信息，单次最多100张。

数据推送条件#

对接方成功订阅卡板信息，且在我方平台轮询检测到卡板数据变动时(流量、卡板状态、实名/激活状态等一系列需要营运关注的数据变动)，会为对接方主动推送最新的卡板数据。我方平均每小时更新一次数据。

数据结构#

订阅推送数据和批量查询卡板信息接口响应参数完全一致，并且请求头中使用了和请求接口签名一致的签名参数和算法，可用于验证签名以确保订单参数的安全性。

回复确认#

对接方收到推送数据并回调成功后，请回复HTTP状态码：200，否则我方将视为推送失败，并在后续的一段时间内重试推送。

重试规则#

推送失败后，我方最大重试推送2次，共计3次。分别是在首次推送失败后的第30分钟、第2小时，超过2次后将不再推送。若后续对接方仍想获取到最新的订单数据可登录我方代理商后台找到需要推送的卡板-【操作】-【数据推送】-【立即推送】；亦或是通过批量查询卡板信息接口进行主动拉取

请求参数

Header 参数
appID
string 
必需
默认值:
1
apiVersion
string 
必需
默认值:
2.0.0
traceID
string 
必需
默认值:
5831f960804c9217ec01e425b8cc76f5
timestamp
string 
必需
默认值:
1703592981
sign
string 
必需
默认值:
65987d12ae39b2c449b495c77c83c8ef
Body 参数application/x-www-form-urlencoded
simNos
string 
必需
卡板卡号，单次最多允许100个
示例值:
["19287697294","19287697293","19287697292","19287697291","19287697290"]
updateStatus
string 
必需
变更状态，1订阅消息，2取消订阅
示例值:
2
subscribeUrl
string 
订阅地址
可选
示例值:
https://www.baidu.com

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1:2000/openapi/iot/batchSubscribe' \
--header 'appID;' \
--header 'apiVersion;' \
--header 'traceID;' \
--header 'timestamp;' \
--header 'sign;' \
--data-urlencode 'simNos=["19287697294","19287697293","19287697292","19287697291","19287697290"]' \
--data-urlencode 'updateStatus=2' \
--data-urlencode 'subscribeUrl=https://www.baidu.com'

返回响应

🟢200成功
application/json
Body
code
integer 
0成功，其他失败
必需
message
string 
状态码描述
必需
data
object 
数据集
必需
items
array [object {25}] 
必需
timestamp
integer 
必需
traceID
string 
必需
示例
{"code":0,"message":"操作成功","data":{"items":[{"gatewayId":4,"packageGroupId":7,"poolId":0,"simNo":"19287697291","iccid":"89861500192430509496","imsi":"","imei":"","simStatus":9999,"activateStatus":1,"authStatus":1,"authPlatformStatus":1,"internetStatus":1,"onlineStatus":3,"cancelStatus":1,"replaceStatus":1,"robinStatus":1,"activateAt":null,"authAt":null,"authPlatformAt":null,"rechargeTimes":0,"totalFlow":0,"useFlow":0,"endAt":null,"lastRobinAt":"2024-11-14 23:26:44","lastSimStatusAt":"2024-11-14 23:26:44"},{"gatewayId":4,"packageGroupId":7,"poolId":0,"simNo":"19287697292","iccid":"89861500192430509497","imsi":"","imei":"","simStatus":9999,"activateStatus":1,"authStatus":1,"authPlatformStatus":1,"internetStatus":1,"onlineStatus":3,"cancelStatus":1,"replaceStatus":1,"robinStatus":1,"activateAt":null,"authAt":null,"authPlatformAt":null,"rechargeTimes":0,"totalFlow":0,"useFlow":0,"endAt":null,"lastRobinAt":"2024-11-14 23:26:45","lastSimStatusAt":"2024-11-14 23:26:44"},{"gatewayId":4,"packageGroupId":7,"poolId":0,"simNo":"19287697293","iccid":"89861500192430509498","imsi":"","imei":"","simStatus":9999,"activateStatus":1,"authStatus":1,"authPlatformStatus":1,"internetStatus":1,"onlineStatus":3,"cancelStatus":1,"replaceStatus":1,"robinStatus":1,"activateAt":null,"authAt":null,"authPlatformAt":null,"rechargeTimes":0,"totalFlow":0,"useFlow":0,"endAt":null,"lastRobinAt":"2024-11-14 23:26:45","lastSimStatusAt":"2024-11-14 23:26:44"},{"gatewayId":4,"packageGroupId":7,"poolId":0,"simNo":"19287697294","iccid":"89861500192430509499","imsi":"","imei":"","simStatus":9999,"activateStatus":1,"authStatus":1,"authPlatformStatus":1,"internetStatus":1,"onlineStatus":3,"cancelStatus":1,"replaceStatus":1,"robinStatus":1,"activateAt":null,"authAt":null,"authPlatformAt":null,"rechargeTimes":4,"totalFlow":20971520,"useFlow":0,"endAt":"2024-11-09 00:00:00","lastRobinAt":"2024-11-14 23:26:46","lastSimStatusAt":"2024-11-14 23:26:44"}]},"timestamp":1731665385,"traceID":"5831f960804c9217ec01e425b8cc76f5"}
上一页
批量查询卡板信息(100张)
下一页
批量查询卡板最新状态(10张)
Built with