阿里云 DysmsApi 模块
阿里云 DysmsApi 模块
DysmsApi 模块用于通过阿里云短信服务(Dysmsapi)发送短信。 支持单条或批量手机号发送,并返回结构化响应结果。
安装与使用
在 Vino 项目中:
import {DysmsApi} from "aliyun"
const client = new DysmsApi({
endpoint: "dysmsapi.aliyuncs.com",
accessKeyId: "your-accessKeyId", // 可选
accessKeySecret: "your-accessKeySecret" // 可选
})
若未提供 accessKeyId / accessKeySecret,将使用默认凭据链(环境变量、配置文件等)。
DysmsApi 构造参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| endpoint | string | 是 | 阿里云短信服务终端节点 |
| accessKeyId | string | 否 | 阿里云 AccessKeyId |
| accessKeySecret | string | 否 | 阿里云 AccessKeySecret |
API 列表
| 名称 | 类型 | 参数 | 返回值 | 说明 |
|---|---|---|---|---|
| sendSms | 方法 | phoneNumbers, signName, templateCode, templateParam | object | 发送短信 |
sendSms
发送短信到指定手机号。
语法
client.sendSms(
phoneNumbers: string,
signName: string,
templateCode: string,
templateParam: object
)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| phoneNumbers | string | 手机号,多个号码用英文逗号 , 分隔 |
| signName | string | 短信签名名称 |
| templateCode | string | 短信模板 CODE |
| templateParam | object | 模板变量对象,会自动转换为 JSON 字符串 |
返回值
返回一个对象,包含以下字段:
| 字段 | 类型 | 说明 |
|---|---|---|
| bizId | string | 发送回执 ID |
| code | string | 响应状态码 |
| message | string | 响应消息 |
| requestId | string | 请求 ID |
示例
import {DysmsApi} from "aliyun"
// 发送单条短信
try {
const client = new DysmsApi({
endpoint: "dysmsapi.aliyuncs.com",
accessKeyId: "xxx",
accessKeySecret: "xxx"
})
const result = client.sendSms(
"18088888888",
"签名名称",
"SMS_501925302",
{code: "3121"}
)
console.log(result)
} catch (e) {
console.log("发送失败:", e)
}
// 批量发送短信
const result = client.sendSms(
"18088888888,18099999999",
"签名名称",
"SMS_501925302",
{code: "8888"}
)
console.log(result)
