使用邮件模板发送邮件
接口说明
使用已创建的邮件模板发送邮件,支持批量发送给多个收件人,每个收件人可以使用不同的模板变量参数。
请求信息
- 获取公私钥:
ACCESSKEY_ID:ACCESSKEY_SECRET - 请求方法:
POST - 请求路径:
/api/v1/email/SendEmailTemplate - Content-Type:
application/json
请求参数
| 参数名 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| SendEmail | string | 是 | 发件人邮箱地址 | "sender@example.com" |
| TemplateId | string | 是 | 邮件模板ID | "template_123" |
| EmailContent | array | 是 | 邮件内容数组,每个元素包含收件人信息和模板变量 | 见下方说明 |
| FromName | string | 否 | 发件人昵称 | "USpeedo" |
EmailContent 数组元素说明
每个元素包含以下字段:
| 参数名 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| EmailAddress | string | 是 | 收件人邮箱地址 | "recipient@example.com" |
| TemplateVariableParams | array | 否 | 模板变量参数列表,格式: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": []
}
响应字段说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| RetCode | int | 返回码,0表示成功 |
| Message | string | 返回消息 |
| SessionNo | string | 会话编号,用于查询发送状态 |
| FailedTargetEmails | array | 发送失败的收件人列表,每个元素包含:EmailAddress(邮箱地址)、TemplateVariableParams(模板变量参数)、FailureReason(失败原因) |
失败响应
{
"RetCode": 215392,
"Message": "Invalid parameter [SendEmail]"
}
常见错误码
| 错误码 | 说明 |
|---|---|
| 0 | 成功 |
| 215392 | 参数错误 |
| 215397 | 缺少必填参数 |
| 215400 | 服务器错误 |