全部产品
云市场

物联卡流量查询(QueryCardFlowInfo)---PHP

更新时间:2019-07-24 09:40:30

物联卡流量查询接口

步骤 1 创建阿里云账号

为了访问服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:

  1. 访问阿里云 官方网站,单击页面上的 免费注册 按钮。
  2. 按照屏幕提示完成注册流程并进行实名认证,该服务只支持实名认证用户使用。为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。具体实名认证流程,请参考 这里

步骤 2 获取阿里云访问密钥

为了使用物联卡 SDK,您必须申请阿里云的访问密钥。

阿里云访问秘钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。

该访问秘钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问秘钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对。

您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对,且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险,建议及时删除该秘钥对并生成新的替代秘钥对。

步骤 3 在控制台完成购卡行为后,且卡被用户正常激活后,获得调用接口必备的参数

ICCID

请到阿里云控制台下的物联网无线服务下的卡管理页面,获取已经正常激活的卡对应的iccid值

参数
请求参数
名称 类型 是否必须 描述
Iccid String 必须 需要查询的物联卡对应的Iccid编码

其他请求参数请参见 公共请求参数

出参列表
出参名称 出参类型 样例取值 参数说明
RequestId String 8906582E-6722 请求ID
Code String OK 状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message String 请求成功 状态码的描述
CardFlowInfos Object - 该对象为一个list,list元素请参考下面的CardFlowInfo样例
CardFlowInfo样例
出参名称 出参类型 样例取值 参数说明
ResourceType String 6700001 资源类型编码: 6700001代表流量
ResName String 物联网-联通-Internet-自定义流量包 资源名称(提醒:物联网-测试期套餐仅在api可以查询,控制台仅在转为正式套餐后展现剩余流量)
FlowResource Number 1048576 资源总量 (流量单位为KB)
RestOfFlow Number 1048576 资源剩余量 (流量单位为KB)
FlowUsed Number 0 资源使用量 (流量单位为KB)
ValidDate String 20171106174912 资源生效日期
ExpireDate String 20180504235959 资源失效日期
SmsUsed Number 389 短信使用量 单位(条)
VoiceUsed Number 25 语音使用量 单位(分钟)
VoiceTotal Number 60 语音套餐总量(如果有语音套餐包) 单位(分钟)

公共返回参数,详见 公共请求参数

技术对接步骤

1:下载SDK工具包

SDK&DEMO[下载地址]

2: 编写样例程序

注:有备注无需修改的位置请勿改动。

  1. // 代码节选,详见aliyun-dyiot-php-sdk/api_demo/IotDemo.php
  2. ...
  3. class IotDemo
  4. {
  5. ...
  6. /**
  7. * 物联网卡流量查询
  8. *
  9. * @return stdClass
  10. * @throws ClientException
  11. */
  12. public static function queryCardFlowInfo() {
  13. $request = new QueryCardFlowInfoRequest();
  14. //填入你要查询的iccid值
  15. $request->setIccid('yourIccid');
  16. //hint 此处可能会抛出异常,注意catch
  17. $response = static::getAcsClient()->getAcsResponse($request);
  18. return $response;
  19. }
  20. }

返回示例

JSON示例

  1. {
  2. /* 请求标签,用于追踪错误 */
  3. "RequestId": "1C63F16F-D376-4065-816E-3E56CDD13FEB",
  4. /* 请求codeOK代表正常 */
  5. "Code": "OK",
  6. /* 异常描述 */
  7. "Message": "ServiceUnavailable"
  8. "CardFlowInfos": [
  9. {
  10. /* 资源类型编码 */
  11. "ResourceType": "6700001",
  12. /* 资源名*/
  13. "ResName": "物联网-联通-Internet-自定义流量包",
  14. /* 资源总量 KB*/
  15. "FlowResource": 1048576,
  16. /* 资源余量 KB*/
  17. "RestOfFlow": 1048576,
  18. /* 资源使用量 KB*/
  19. "FlowUsed": 0,
  20. /* 生效时间*/
  21. "ValidDate": "20171106174912",
  22. /* 失效时间*/
  23. "ExpireDate": "20180504235959",
  24. /* 生效时间 预留字段可忽略*/
  25. "ValidDate": "20171106174912",
  26. /* 失效时间 预留字段可忽略*/
  27. "ExpireDate": "20180504235959",
  28. /* 短信使用量 单位(条)*/
  29. "SmsUsed": 389,
  30. /* 语音使用量 单位(分钟)*/
  31. "VoiceUsed": 25,
  32. /* 语音套餐总量(如果有语音套餐包) 单位(分钟)*/
  33. "VoiceTotal": 60
  34. }
  35. ]
  36. }

错误码

错误代码 描述 Http状态码 语义
isv.RES_OWNER_ID_UNKNOWN Can’t found of the card owner. 400 卡资源归属无效
isv.PRODUCT_UN_SUBSCRIPT The Product need to order,before invoke the API. 400 未开通物联卡产品
isv.IOT_RES_NOT_EXIST Can’t found the card by the iccid number. 400 IccId对应的卡资源不存在
isv.QUERY_ASSETS_ERROR Query user infomation of the card response is error. 400 卡对应的用户资料异常
isv.RAM_PERMISSION_DENY The invoker is permission invoke the API for the card. 400 当前调用者无权对该卡发起请求
isv.SYSTEM_ERROR System error. 404 系统异常