调用该接口向定向分组里导入定向卡。

使用说明

定向卡是指仅能访问指定地址的物联网卡。可以调用接口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"
}