卡的套餐續訂和疊加包訂購,僅適用于單卡套餐和同檔位池套餐(統付池套餐請通過控制臺進行擴池和購功能費)。
使用限制
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為20。
說明 RAM用戶共享阿里云賬號配額。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | Renew | 系統規定參數。取值:Renew。 |
ApiProduct | String | 否 | linkcard | 接口Code。 |
ApiRevision | String | 否 | 2021-05-20 | 接口版本。 |
Iccid | String | 是 | 89860321******15668 | 物聯網卡的ICCID。 您可在物聯網卡上查看ICCID,或者在物聯網SIM服務控制臺的卡管理頁面,查看ICCID。 |
RechargeType | String | 是 | STANDARD | 充值類型。
|
SerialNo | String | 是 | 12345678 | 自定義的訂單編號,編號需唯一且保持冪等性。 如果您的充值,涉及自有平臺的訂單管理,如給下游客戶充值等,您可填入自有平臺已生成的外部訂單編號,該接口調用成功后,會生成一個訂單編號(OrderNo)。該參數可以方便您將生成的訂單編號與外部訂單號關聯起來。如果非此場景,你可填入任意正整數,例如0。 |
OfferCode | String | 否 | COM***0203 | 充值類型為訂購疊加包時需填寫。 具體Code請咨詢技術對接人員。 |
BuyNum | Integer | 是 | 12 | 訂購份數。根據物聯網卡本身的套餐類型選擇訂購份數。
|
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | E4F94B97-1D64-4080-BFD2-67461667AA43 | 請求ID,阿里云為該請求生成的標識符。 |
Code | String | 200 | 接口返回碼。
|
ErrorMessage | String | 系統異常 | 調用失敗時,返回的錯誤信息。 |
LocalizedMessage | String | InstanceId cannot be empty. | 根據當前所在地展示對應語言的錯誤提示。 |
Success | Boolean | true | 是否調用成功。
|
Data | Object | 返回的訂單編號數據。 |
|
OrderNo | String | 21450******0275 | 接口調用成功后生成的訂單編號。 |
SerialNo | String | 12345678 | 自定義的訂單編號(SerialNo)。 |
示例
請求示例
http(s)://linkcard.aliyuncs.com/?Action=Renew
&ApiProduct=linkcard
&ApiRevision=2021-05-20
&Iccid=89860321******15668
&RechargeType=STANDARD
&SerialNo=12345678
&OfferCode=COM***0203
&BuyNum=12
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RenewResponse>
<RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
<Code>200</Code>
<Success>true</Success>
<Data>
<OrderNo>21450******0275</OrderNo>
<SerialNo>12345678</SerialNo>
</Data>
</RenewResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
"Code" : "200",
"Success" : true,
"Data" : {
"OrderNo" : "21450******0275",
"SerialNo" : "12345678"
}
}