# Alibaba Cloud Iot LinkCard API

> Alibaba Cloud Iot LinkCard API on Apizie: 30 endpoints (Adds cards to a specified group, Adds a destination address to a targeted group, Imports directional cards into a directional group, Creates a directional group, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-linkcard`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/linkcard
- Page: https://zieapi.vercel.app/api/cloud/aliyun-linkcard
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-linkcard/openapi.json

Alibaba Cloud OpenAPI for Iot LinkCard (linkcard, version 2021-05-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds cards to a specified group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/add-card-to-directional-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| IccidList | string | yes | The collection of ICCID values for the cards. The maximum number of ICCIDs is 200 (JSON-encoded) |
| GroupId | string | yes | The group ID |
| SerialNo | string | yes | The request number. Supports idempotence |
| AddType | string | yes | The method used to add cards. Valid values: NEW: imports only the cards that are not assigned to any group. TRANSFER: imports all cards.… |
| MsgNotify | string | no | Specifies whether to push a notification through MQ after successful execution. Default value: false. Valid values: false: does not push a… |
| ApiProduct | string | no | Linkcard |

### Adds a destination address to a targeted group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/add-directional-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| GroupId | string | yes | The group ID |
| Source | string | yes | The address type. Valid values: user_defined: user-defined configuration. aliyun_defined: Alibaba Cloud predefined configuration |
| AddressType | string | yes | The destination address type. Valid values: Ip: IP address. Domain: domain name |
| Address | string | yes | The destination address |
| SerialNo | string | no | The request number. This parameter supports idempotence |
| MsgNotify | string | no | Specifies whether to push a notification through MQ after successful execution. Default value: false. Valid values: false: does not push a… |
| UrlInsecurityForce | string | no | Specifies whether to forcibly add a detected high-risk domain name. By default, the domain name is blocked and not added |

### Imports directional cards into a directional group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/add-directional-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| GroupId | string | yes | The ID of the directional group. You can call the https://help.aliyun.com/document_detail/374328.html operation and view the directional… |
| UploadType | string | yes | The import type. Valid values: NO_GROUP: imports only directional cards that have not been assigned to a group. ALL: imports all… |
| UploadMethod | string | yes | The import method. Valid values: TAG: imports directional cards with the specified tags. ORDER: imports directional cards from the… |
| TagList | string | no | The list of tag IDs. This parameter is required when the import method is set to TAG (JSON-encoded) |
| OrderList | string | no | The list of order IDs. This parameter is required when the import method is set to ORDER (JSON-encoded) |
| FileUri | string | no | The OSS path of the batch file. This parameter is required when the import method is set to FILE |
| GroupName | string | no | The name of the directional group |

### Creates a directional group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/add-directional-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| GroupName | string | yes | The name of the directional group. The group name supports Chinese characters, English letters, digits, and underscores (_), with a… |

### Add Tags to IoT Card
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/add-tags-to-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console |
| TagNameList | string | no | The tag names (JSON-encoded) |

### Adds access addresses to a directional group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/batch-add-directional-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| GroupId | integer | yes | The ID of the directional group. You can call the https://help.aliyun.com/document_detail/374328.html operation to obtain the directional… |
| Source | string | yes | The address source. Valid values: user_defined: user-defined. aliyun_defined: Alibaba Cloud predefined |
| AddressType | string | yes | The address type. Valid values: Ip: IP address. Domain: domain name |
| ListAddress | string | yes | The directional addresses (JSON-encoded) |

### Delete a target address from a directional group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/delete-directional-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| GroupId | string | yes | The group ID |
| Address | string | yes | The target address |
| SerialNo | string | no | The serial number of the request, which supports idempotency |
| MsgNotify | string | no | Specifies whether to send a notification through MQ after successful execution. Default value: false. false: The notification is not sent.… |

### Deletes a targeted group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/delete-directional-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| GroupId | string | yes | The group ID |

### Forcibly activates a card with the same-tier plan to expand the shared traffic pool
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/force-activation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console… |
| DateType | string | no | The plan type. Valid values: sameflowcard: same-tier general traffic plan. directional_sameflowcard: same-tier directional traffic plan |

### Query card detail information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/get-card-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can find the ICCID on the IoT card, or view it on the Card Management page in the IoT SIM Service console… |
| ShowPsim | string | no | Specifies whether to display the detail information of sub-cards. Default value: false. true: Yes. false: No |
| InstanceId | string | no | The instance ID of the IoT card. This parameter is required only when the queried IoT card has been canceled (i.e., DestroyCard is true).… |
| DestroyCard | string | no | Specifies whether the queried IoT card has been canceled. Default value: false. true: Yes. false: No |

### Queries the traffic information of a card
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/get-card-flow-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console… |
| DateList | string | no | The months to query. You can query up to 6 months. If this parameter is left empty, data of the most recent 2 months is returned… |

### This API is used to query the real-time cycle usage of an IoT card
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/get-card-latest-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can view the ICCID on the IoT card, or on the Card Management page of the IoT SIM Service console… |

### Queries the status of an IoT card on the carrier side through intelligent diagnostics
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/get-card-real-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | no | The ICCID of the IoT card. You can find the ICCID on the IoT card itself or on the Card Management page of the IoT SIM Service console |
| Msisdn | string | no | The MSISDN of the IoT card |
| SerialNo | string | no | The unique identifier for polling query results (JSON-encoded) |

### Queries risk alerts on the overview page
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/get-card-status-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |

### Queries the pool information associated with a plan credential
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/get-credential-pool-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Date | string | yes | The month for which to query the plan data usage details |
| CredentialNO | string | yes | The plan credential. You can obtain the plan credential by using one of the following methods: On the Plan Credential page of the IoT SIM… |

### Queries the personal real-name verification status of an IoT card
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/get-real-name-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can find the ICCID on the IoT card, or view it on the Card Management page of the IoT SIM Service console… |
| ListMsisdns | string | no | The MSISDNs of sub-cards for multi-network cards (JSON-encoded) |

### Retrieves the card status distribution
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/get-sim-card-state-distribution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| CredentialNO | string | no | The credential number of the plan. You can view this on the Credential Management page in the IoT SIM Service console… |
| Date | string | yes | The date to query. Format: yyyyMM |

### Query the card list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/list-card-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| ActiveTimeEnd | string | no | The end time of the IoT card activation time range. Format: `yyyy-MM-dd HH:mm:ss` |
| PageSize | integer | yes | The number of entries per page. Valid values: 10, 15, 25, and 40 |
| Iccid | string | no | The ICCID of the IoT card. You can view the ICCID on the IoT card, or on the Card Management page of the IoT SIM Service console… |
| CredentialNo | string | no | The plan credential |
| Vendor | string | no | The carrier. CMCC: China Mobile. CUCC: China Unicom. CTCC: China Telecom. VNO: Virtual network operator |
| PageNo | integer | yes | The page number. This parameter must be used together with the PageSize parameter |
| Msisdn | string | no | The MSISDN of the IoT card |
| AliyunOrderId | string | no | The order ID associated with the IoT card |
| AliFee | string | no | The billing version |
| Period | string | no | The plan billing cycle. 1101: Monthly. 1103: Quarterly. 1106: Semi-annually. 1112: Annually |
| DataType | string | no | The data type. singlecard: Single-card general data. directionalcard: Single-card directional data. sameflowcard: Same-tier pool shared… |
| ActiveTimeStart | string | no | The start time of the IoT card activation time range. Format: `yyyy-MM-dd HH:mm:ss` |
| SimType | string | no | The SIM card type. nano: Triple-cut plug-in card (consumer-grade). micro: Dual-cut plug-in card (consumer-grade). normal: Standard plug-in… |
| ExpireTimeEnd | string | no | The plan expiration end time of the IoT card. Format: `yyyy-MM-dd HH:mm:ss` |
| IsAutoRecharge | string | no | Indicates whether the plan is automatically renewed. true: Yes. false: No |
| ExpireTimeStart | string | no | The plan expiration start time of the IoT card. Format: `yyyy-MM-dd HH:mm:ss` |
| OsStatus | string | no | The detailed status of the IoT card. 10: Test period. 20: Silent period. 100: In use. 150: Partially in use. 200: Manually deactivated.… |
| NotifyId | string | no | The notification ID of the automation rule |
| DataLevel | string | no | The data plan tier |
| Status | string | no | The status of the IoT card. 10: Testable. 20: Unused. 30: In use. 35: Deactivated. 40: Suspended. 50: Canceled |
| TagName | string | no | The tag name |
| CertifyType | string | no | The authentication method. Only enterprise is supported: Enterprise authentication |
| DirectionalGroupId | string | no | The directional group ID |
| ApnName | string | no | The APN name |
| Imsi | string | no | The IMSI of the IoT card |
| PoolId | string | no | The pool ID |
| MinFlow | string | no | The minimum usage for filtering by periodic usage range. Unit: MB |
| MaxFlow | string | no | The maximum usage for filtering by periodic usage range. Unit: MB |
| MaxRestFlowPercentage | number | no | The remaining data percentage for a single card in the billing cycle. Only the following three values are supported: 0.1: 10% remaining… |
| NetworkType | string | no | The network type: 4G or 5G |

### Queries the list of access addresses for a directional group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/list-directional-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| PageSize | integer | yes | The number of entries per page. Valid values: 10, 15, 25, and 40 |
| PageNo | integer | yes | The page number. Use this parameter together with the PageSize parameter |
| GroupId | string | yes | The directional group ID. You can call the https://help.aliyun.com/document_detail/374328.html operation to obtain the directional group… |

### Queries the directional group and access address list of an IoT card
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/list-directional-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console |
| PageNo | integer | yes | The page number to query. The value cannot be 0 |
| PageSize | integer | yes | The number of entries per page. Valid values: 10, 15, 25, and 40 |

### Queries a list of orders
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/list-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| OrderId | string | no | The order ID |
| StartDate | string | no | The start date of the order purchase time range. Format: `YYYY-MM-dd` |
| EndDate | string | no | The end date of the order purchase time range. Format: `YYYY-MM-dd` |
| OrderType | string | no | The order type. Valid values: NEW: new purchase. ADD_FLOW: pool expansion. ADD_CARD: card replacement. FUNCTION: monthly feature fee… |
| OrderStatus | string | no | The order status. Valid values: processing: being processed. failure: failed. completed: completed. unpaid: pending payment. refunded:… |
| PageNo | integer | yes | The page number. Use this parameter together with the `PageSize` parameter |
| PageSize | integer | yes | The number of entries per page. Valid values: 10, 15, 25, and 40 |
| CredentialNo | string | no | The plan credential |

### Changes the status of a card from "rebind deactivated" to "rebind reactivated"
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/rebind-resume-single-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can find the ICCID on the IoT card, or view it on the Card Management page of the IoT SIM Service console… |
| OptMsisdns | string | no | Specifies whether to perform the operation on a sub-card. Set this parameter to the MSISDN of the sub-card. This parameter is not required… |

### Renews plan subscriptions and purchases add-on packages for IoT cards. This operation applies only to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/renew` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| ApiProduct | string | no | The API code |
| ApiRevision | string | no | The API version |
| Iccid | string | no | The ICCID of the IoT card. You can find the ICCID on the IoT card itself, or on the Card Management page of the IoT SIM Service console |
| RechargeType | string | no | The recharge type. Valid values: STANDARD: renews a plan subscription. OVERLAY: purchases an add-on package |
| SerialNo | string | no | The custom order number. The number must be unique and idempotent. If your recharge involves order management on your own platform, such… |
| OfferCode | string | no | This parameter is required when the recharge type is set to add-on package purchase. Contact your technical support representative for the… |
| BuyNum | integer | no | The number of units to purchase. Select the number based on the plan type of the IoT card. Valid values: Renew a monthly plan: 1, 2, 3, 6,… |

### Resume a single card that is in the "Voluntarily Deactivated" or "Mass Deactivated" status to the "Reuse"…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/resume-single-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can find the ICCID on the IoT card, or view the ICCID on the Card Management page of the IoT SIM Service… |
| OptMsisdns | string | no | Specifies whether to perform the operation on sub-cards by entering the MSISDN of the sub-cards. This parameter is not required for… |

### Sends an SMS message from the platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/send-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| TaskName | string | yes | The custom task name. The name cannot contain special characters and can be up to 40 characters in length |
| MessageTemplateId | integer | yes | The ID of the SMS template. You can view the template ID in the console |
| MessageVariableParam | string | no | The replacement dynamic parameter for an SMS message, in the format {1}{2} |
| MessageSendTime | integer | yes | The timestamp, in seconds. If the specified time is earlier than the current time, the message is sent immediately. If the specified time… |
| Msisdns | string | no | The list of destination MSISDNs to which the SMS message is sent (JSON-encoded) |
| ApiProduct | string | no | Linkcard |

### Sets the data cap suspension rule for a card. Only same-tier pool plans and unified payment pool plans are…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/set-card-stop-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console… |
| FlowLimit | integer | yes | The data cap threshold for suspension. Only positive integers are supported. Unit: MB. When the monthly data usage reaches this value, the… |
| AutoRestore | string | yes | Specifies whether to automatically resume the card in the following month after it is suspended due to reaching the data cap. true… |

### Proactively deactivates a single card that is in the "In Use" state
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/stop-single-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can view the ICCID on the IoT card, or on the Card Management page of the IoT SIM Service console… |
| OptMsisdns | string | no | Specifies whether to perform the operation on a sub-card. Set this parameter to the MSISDN of the sub-card. This parameter is not required… |

### Enables or disables the auto-renewal feature for a card. This operation applies only to single-card plans…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/update-auto-recharge-switch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console… |
| Open | string | yes | The auto-renewal switch. true: Enables auto-renewal. false: Disables auto-renewal |

### Queries whether an IoT card is a directional card
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/verify-iot-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |
| Iccid | string | yes | The ICCID of the IoT card. You can view the ICCID on the IoT card, or on the Card Management page of the IoT SIM Service console |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkcard.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/add-card-to-directional-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Iot LinkCard API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-linkcard/add-card-to-directional-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Iot LinkCard API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Iot LinkCard itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Iot LinkCard API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-linkcard.

### What is the status of the Alibaba Cloud Iot LinkCard API?
Needs your own provider key (bring your own key)