# Alibaba Cloud Short Message Service API

> Alibaba Cloud Short Message Service API on Apizie: 7 endpoints (Sends a message to multiple recipients in countries or regions outside the Chinese mainland, Reports the status of an OTP message to Alibaba Cloud SMS, Queries the delivery report of a message, Sends messages to regions outside the Chinese mainland, including Hong Kong (China), Macao (China), Taiwan…, …) 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-dysmsapi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Short Message Service (dysmsapi, version 2018-05-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Sends a message to multiple recipients in countries or regions outside the Chinese mainland
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dysmsapi/batch-send-message-to-globe` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com |
| To | string | yes | The mobile phone number of the recipient. You must add the dialing code to the beginning of each mobile phone number. For more… |
| From | string | no | The mobile phone number of the sender. You can specify the sender ID when you call the API operation. The sender ID can contain only… |
| Message | string | yes | The content of the message |
| Type | string | no | The type of the message. Valid values: NOTIFY: notification MKT: promotional message |
| TaskId | string | no | The ID of the messaging campaign. It must be 1 to 255 characters in length. The ID is the value of the TaskId field in the delivery… |
| ValidityPeriod | integer | no | The validity period of the message. Unit: seconds |
| ChannelId | string | no | The ID of the delivery channel |

### Reports the status of an OTP message to Alibaba Cloud SMS
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dysmsapi/conversion-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com |
| ReportTime | integer | no | Timestamp of the conversion rate observation should be a Unix timestamp, a millisecond-level long integer. If this field is not specified:… |
| ConversionRate | string | yes | Conversion rate monitoring return value. The value of this parameter is of type double, and the value is between [0,1] |

### Queries the delivery report of a message
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dysmsapi/query-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com |
| MessageId | string | yes | The ID of the message |

### Sends messages to regions outside the Chinese mainland, including Hong Kong (China), Macao (China), Taiwan…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dysmsapi/send-message-to-globe` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com |
| To | string | yes | The phone numbers to which the message is sent. Format: `Dialing code + Phone number`. For example, 8521245567\\. For dialing odes, see… |
| From | string | no | The phone number of the sender. You can also specify a sender ID, which can contain letters and digits. An alphanumeric ID can be up to 11… |
| Message | string | yes | The message content |
| Type | string | no | The message type. Valid values: OTP: verification code message. NOTIFY: notification. MKT: marketing message |
| TaskId | string | no | The ID of the task. The ID can be up to 255 characters in length. You can obtain the task ID from the TaskId field in the message receipt |
| ValidityPeriod | integer | no | The validity period of the message, in seconds |
| ChannelId | string | no | The ID of the channel |

### Sends a message to the Chinese mainland by using a message template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dysmsapi/send-message-with-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com |
| To | string | yes | The mobile phone number to which the message is sent. You must add the country code to the beginning of the mobile phone number. Example:… |
| From | string | yes | The signature. To query the signature, log on to the Short Message Service (SMS) console (https://sms-intl.console.aliyun.com/overview)… |
| TemplateCode | string | yes | The code of the message template. To query the code, log on to the SMS console (https://sms-intl.console.aliyun.com/overview) and navigate… |
| TemplateParam | string | no | The value of the variable in the message template. If a variable exists in the template, the parameter is required |
| SmsUpExtendCode | string | no | The extension code of the MO message |
| ValidityPeriod | integer | no | The validity period of the message |
| ChannelId | string | no | The ID of the channel |

### Delivers one-time password (OTP) message statuses to Alibaba Cloud, which calculates and monitors OTP…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dysmsapi/sms-conversion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com |
| MessageId | string | no | The ID of the OTP message |
| Delivered | string | yes | Specifies whether customers replied to the OTP message. Valid values: true and false |
| ConversionTime | integer | no | The time when the OTP message was delivered. The value is a UNIX timestamp. Unit: milliseconds. If you leave the parameter empty, the… |
| To | string | no | The mobile phone number of the recipient. You must add the dialing code to the beginning of the mobile phone number. For more information,… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-dysmsapi/batch-send-message-to-globe" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Short Message Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-dysmsapi/batch-send-message-to-globe with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Short Message Service 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-dysmsapi.

### What is the status of the Alibaba Cloud Short Message Service API?
Needs your own provider key (bring your own key)