阿里云 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 构造参数

名称类型必填说明
endpointstring阿里云短信服务终端节点
accessKeyIdstring阿里云 AccessKeyId
accessKeySecretstring阿里云 AccessKeySecret

API 列表

名称类型参数返回值说明
sendSms方法phoneNumbers, signName, templateCode, templateParamobject发送短信

sendSms

发送短信到指定手机号。

语法

client.sendSms(
    phoneNumbers: string,
    signName: string,
    templateCode: string,
    templateParam: object
)

参数说明

参数类型说明
phoneNumbersstring手机号,多个号码用英文逗号 , 分隔
signNamestring短信签名名称
templateCodestring短信模板 CODE
templateParamobject模板变量对象,会自动转换为 JSON 字符串

返回值

返回一个对象,包含以下字段:

字段类型说明
bizIdstring发送回执 ID
codestring响应状态码
messagestring响应消息
requestIdstring请求 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)
更新时间 3/18/2026, 7:21:33 PM