跳到主要内容

使用邮件模板发送邮件

接口说明

使用已创建的邮件模板发送邮件,支持批量发送给多个收件人,每个收件人可以使用不同的模板变量参数。

请求信息

请求参数

参数名类型必填说明示例值
SendEmailstring发件人邮箱地址"sender@example.com"
TemplateIdstring邮件模板ID"template_123"
EmailContentarray邮件内容数组,每个元素包含收件人信息和模板变量见下方说明
FromNamestring发件人昵称"USpeedo"

EmailContent 数组元素说明

每个元素包含以下字段:

参数名类型必填说明示例值
EmailAddressstring收件人邮箱地址"recipient@example.com"
TemplateVariableParamsarray模板变量参数列表,格式:variableName{##}variableValue["name{##}张三", "code{##}123456"]

注意事项

  • TemplateVariableParams 中的变量格式为 变量名{##}变量值,多个变量用数组元素分隔。

请求示例

curl -X POST "https://api.uspeedo.com/api/v1/email/SendEmailTemplate" \
-H "Content-Type: application/json" \
-H "Authorization: Basic $(echo -n 'ACCESSKEY_ID:ACCESSKEY_SECRET' | base64)" \
-d '{
"SendEmail": "sender@example.com",
"TemplateId": "template_123",
"FromName": "USpeedo",
"EmailContent": [
{
"EmailAddress": "recipient@example.com",
"TemplateVariableParams": [
"name{##}张三",
"code{##}123456"
]
}
]
}'

响应格式

成功响应

{
"RetCode": 0,
"Message": "success",
"SessionNo": "session_1234567890",
"FailedTargetEmails": []
}

响应字段说明

字段名类型说明
RetCodeint返回码,0表示成功
Messagestring返回消息
SessionNostring会话编号,用于查询发送状态
FailedTargetEmailsarray发送失败的收件人列表,每个元素包含:EmailAddress(邮箱地址)、TemplateVariableParams(模板变量参数)、FailureReason(失败原因)

失败响应

{
"RetCode": 215392,
"Message": "Invalid parameter [SendEmail]"
}

常见错误码

错误码说明
0成功
215392参数错误
215397缺少必填参数
215400服务器错误