全部产品
云市场

物联网卡流量充值(DoIotRecharge)-PHP

更新时间:2019-07-23 09:11:42

物联网卡流量充值接口

步骤 1 创建阿里云账号

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

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

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

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

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

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

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

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

ICCID

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

offerId

需要给指定的卡充值的套餐编号,同业务对接人处获取

参数
请求参数
名称 类型 是否必须 描述
Iccid String 必须 需要充值的物联卡对应的Iccid编码
Offerids String 必须 充值的套餐编号
EffCode String 必须 套餐生效类型:AUTO_ORD、1000
OutId String 必须 外部流水编码
Amount Number 必须 自定义流量套餐流量数,单位KB;该参数配合自定义档位套餐使用,目前未开放填 0

EffCode 特殊说明

1000:立即生效;

AUTO_ORD:自动在当前套餐失效后,续订上本次套餐,若有多个未生效套餐,则本次续订是从最后一个未生效套餐开始往后续)

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

出参列表
出参名称 出参类型 样例取值 参数说明
RequestId String 8906582E-6722 请求ID
Code String OK 状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message String 请求成功 状态码的描述
IotRecharge Object - 请参考下面的IotRecharge样例
IotRecharge样例
出参名称 出参类型 样例取值 参数说明
OrderNo String P0000000182024044 充值订单号
DoneCode String 1093ys95199815616-1000000083ds46009-792893 处理流水
OrderResult String SUCCESS 结果描述

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

技术对接步骤

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 doIotRecharge() {
  13. $request = new DoIotRechargeRequest();
  14. //填入你要查询的iccid值
  15. $request->setIccid('yourIccid');
  16. $request->setOutId('yourOutId');
  17. $request->setOfferIds('offerId');
  18. $request->setAmount(0);
  19. // AUTO_ORD(续订)或者1000(立即生效)
  20. $request->setEffCode("AUTO_ORD");
  21. //hint 此处可能会抛出异常,注意catch
  22. $response = static::getAcsClient()->getAcsResponse($request);
  23. return $response;
  24. }
  25. }

返回示例

JSON示例

  1. {
  2. /* 请求标签,用于追踪错误 */
  3. "RequestId": "475C4B95-FB6E-4B2A-B0C6-8AAA136B323A",
  4. /* 请求codeOK代表正常 */
  5. "Code": "OK",
  6. /* 异常描述 */
  7. "Message": "ServiceUnavailable",
  8. "IotRecharge": {
  9. "OrderNo": "P0000000182024044",
  10. "DoneCode": "1093ys95199815616-1000000083ds46009-792893",
  11. "OrderResult": "SUCCESS"
  12. }
  13. }

错误码

错误代码 描述 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.INVALID_PARAMETERS The parameters is invalid. 400 请求参数无效,q请核查对应的入参信息
isv.SYSTEM_ERROR System error. 404 系统异常
isv.RECHARGE_OUTID_DUPLICATE The outid is duplicate. 404 外部充值流水号重复
isv.LX_CREATE_TRADE_ORDER_ERR Create trade order is error . 404 交易系统创建订单异常
isv.NOT_SUPPORT_ORDER_PROD This offer is not support . 404 不支持该充值套餐