調用該接口向定向分組里導入定向卡。

使用說明

定向卡是指僅能訪問指定地址的物聯網卡。可以調用接口VerifyIotCard查詢物聯網卡是否為定向卡。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 AddDirectionalCard

系統規定參數。取值：AddDirectionalCard。

GroupId String 是 5

定向分組ID。

您可調用接口GetCardDetail在返回參數中查看定向分組ID（DirectionalGroupId）。

UploadType String 是 ALL

導入類型。

  • NO_GROUP：僅導入還未分組的定向卡。
  • ALL：全量導入。
UploadMethod String 是 TAG

導入方式。

  • TAG：標簽，導入指定標簽的定向卡。
  • ORDER：訂單，導入指定訂單的定向卡。
  • FILE：批量文件，導入批量文件中的定向卡。
TagList Array of String 是 5

標簽ID。導入方式選擇為標簽時，需填入該參數。

標簽ID可在物聯網無線連接服務控制臺的SIM卡管理 > 標簽管理頁面查看。

OrderList Array of String 否 2172***80589

訂單編號。導入方式選擇為訂單時，需填入該參數。

訂單編號可在物聯網無線連接服務控制臺的訂單統計 > 訂單管理頁面查看。

FileUri String 否 https://linkcard-user-online.oss-cn-zhangjiakou.aliyuncs.com/DIRECTIONAL_GROUP/20220811/xxxx.csv

批量文件的OSS路徑。導入方式選擇為批量文件時，需填入該參數。
GroupName String 否 測試分組

定向分組名稱。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公共請求參數。公共請求參數說明，請參見公共參數文檔。

返回數據

名稱 類型 示例值 描述
Data String true

是否導入成功。

  • true：導入成功。
  • false：導入失敗。
RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

請求ID，阿里云為該請求生成的標識符。
ErrorMessage String InstanceId cannot be empty.

調用失敗時，返回的錯誤信息。
Success Boolean true

是否調用成功。

  • true：調用成功。
  • false：調用失敗。
LocalizedMessage String InstanceId cannot be empty.

根據當前所在地展示對應語言的錯誤提示。
Code String 200

接口返回碼。

  • 200：調用成功。
  • 其他：調用失敗。錯誤碼詳情，請參見錯誤碼。

示例

請求示例

http(s)://linkcard.aliyuncs.com/?Action=AddDirectionalCard
&GroupId=5
&UploadType=ALL
&UploadMethod=TAG
&TagList=["5"]
&OrderList=["2172***80589"]
&FileUri=https://linkcard-user-online.oss-cn-zhangjiakou.aliyuncs.com/DIRECTIONAL_GROUP/20220811/xxxx.csv
&GroupName=測試分組
&公共請求參數

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<AddDirectionalCardResponse>
    <Data>true</Data>
    <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
    <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>
    <Success>true</Success>
    <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>
    <Code>200</Code>
</AddDirectionalCardResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : "true",
  "RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
  "ErrorMessage" : "InstanceId cannot be empty.",
  "Success" : true,
  "LocalizedMessage" : "InstanceId cannot be empty.",
  "Code" : "200"
}