查询卡片列表

最近更新时间:2019-06-26 14:54:54

说明:

请求采用 HTTPS 传输,使用 POST 方法。请求包体采用 x-www-form-urlencoded,应答包体采用 JSON 格式,SDKAppID 由腾讯物联卡平台分配,random 为随机整数,不要添加零前缀。如您需在内测阶段调用接口进行测试,请向腾讯云物联卡技术支持(物联卡小助手 QQ:3513545165)申请 SDKAppID 和 appkey。

接口描述

用于查询应用关联的物联卡片列表的接口为 getcardlist,当前版本号为 v1。

接口域名

https://cloud.tim.qq.com/v1/iotlink/getcardlist?sdkappid=1400000000&random=234198

输入参数

参数名称 描述 类型 必选
Teleoperator 运营商代码,0为全部运营商,1为移动,2为联通,3为电信 整数
Limit 一页返回最大条目数量,最大为50 整数
Offset 查找时使用偏移 整数
Token 鉴权 TOKEN 字符串
Time 请求时间,UNIX 时间戳 整数
Echo 服务端按原样带回 字符串

注意:

Token 计算方式:
Token = sha256("Action=getcardlist&Appkey=xxxxxxxx&Random=xxxxxxxx&Time=xxxxxxxx");

输出参数

参数名称 描述 类型 必选
ActionStatus 请求处理的结果,OK 表示处理成功,FAIL 表示失败。 字符串
ErrorCode 错误码,0为成功,其他为失败 整数
ErrorInfo 如果出错,这里有错误信息 字符串
Echo 服务端按原样带回,最大为128个英文字符 字符串
Data 应答数据 对象

Data 对象定义如下:

参数名称 描述 类型 必选
CardBriefInfos 物联卡信息 数组

CardBriefInfos 数组定义如下:

参数名称 描述 类型 必选
Iccid 物联卡 iccid 字符串
Msisdn 物联卡电话号码 字符串
Teleoperator 物联卡运营商代码,1为移动,2为联通,3为电信 整数
Type 物联卡服务类型,1为单卡,2为流量池 整数
CardStatus 物联卡状态,1为未激活,2为已激活,3为已停用 整数
NetworkStatus 物联卡网络状态, 1为关闭,2为打开 整数
DataUsedInPeriod 物联卡当期已使用流量,单位 MB 浮点数
DataTotalInPeriod 物联卡当期可用流量,单位 MB 浮点数

示例

输入:

Teleoperator=0&Limit=50&Offset=0&Token=3641B750C92DE671877B2ED2F8E5C30570D753911A82515FF40CFA573FB9087A&Time=1511499840

输出:

    {
        "ActionStatus": "OK",
        "ErrorCode": 0,
        "ErrorInfo": "OK",
        "Echo": "",
        "Data": {
            "CardBriefInfos": [
                {
                     "Iccid": "898602B7091701054333",
                     "Msisdn": "1064878384333",
                     "Teleoperator": 1,
                     "Type": 1,
                     "CardStatus": 1,
                     "NetworkStatus": 1,
                     "DataUsedInPeriod": 14.970,
                     "DataTotalInPeriod": 30.000
                },
                {
                     "Iccid": "898607B0101730318875",
                     "Msisdn": "1064706584079",
                     "Teleoperator": 1,
                     "Type": 1,
                     "CardStatus": 1,
                     "NetworkStatus": 0,
                     "DataUsedInPeriod": 14.170,
                     "DataTotalInPeriod": 30.000
                },
                {
                     "Iccid": "898607B0101730321069",
                     "Msisdn": "1064706586274",
                     "Teleoperator": 1,
                     "Type": 1,
                     "CardStatus": 1,
                     "NetworkStatus": 0,
                     "DataUsedInPeriod": 12.170,
                     "DataTotalInPeriod": 30.000
                }
            ]
        }
    }