通过模版发送邮件
在使用此API之前,请在控制台中准备以下内容:
- 创建可用的模板。
- 设置自定义域名并验证通过。
- 设置发件人信息。
请求参数
字段名 | 参数类型 | 描述 | 必需 |
---|---|---|---|
Action | string | 值:SendEmailTemplate | 是 |
AccountId | int | 项目ID。获取AccountId | 是 |
TemplateId | string | 要发送的电子邮件模板的ID | 是 |
SenderEmail | string | 在控制台的发件人设置中配置的电子邮件地址 | 是 |
EmailContent | []TargetEmail | 电子邮件接收地址。TargetEmail结构数组,长度在1到100之间。 | 是 |
TargetEmail结构
字段名 | 参数类型 | 描述 | 必需 |
---|---|---|---|
EmailAddress | string | 电子邮件接收地址 | 是 |
TemplateVariableParams | []string | 模板变量参数。字符串由变量名称、{##}和变量值拼接而成。例如:{number}{##}Jane | 否 |
响应参数
字段名 | 参数类型 | 描述 | 必须 |
---|---|---|---|
RetCode | int | 当 RetCode 不为 0 时,在 Message 中显示具体的错误描述。如果 RetCode 为 0,则不返回 Message。 | 是 |
Message | string | 返回状态码描述。如果操作成功,默认返回为空。 | 是 |
SessionNo | string | 此发送任务的唯一 ID。您可以根据该值查询发送的电子邮件列表。注意:仅当成功提交的电子邮件数量大于 0 时才返回该字段。 | 否 |
SuccessCount | int | 成功提交的电子邮件数量。 | 否 |
FailContent | []FailedTargetEmail | 未成功发送的详细信息,可根据该字段重新发送。 | 否 |
FailedTargetEmail 结构体
字段名 | 参数类型 | 描述 |
---|---|---|
EmailAddress | string | 电子邮件接收地址 |
TemplateVariableParams | []string | 模板变量参数 |
FailureReason | string | 提交失败的原因。注意:如果模板/域名/发件人检查失败,则该字段为空。 |
请求示例
curl 'https://api.uspeedo.com/api' \
--header 'X-AccessToken: eyJxxxxxxxxx1RI' \
--header 'Content-Type: text/plain' \
--data-raw '{
"Action": "SendEmailTemplate",
"SendEmail": "example@example.com",
"TemplateId": "UETXXXXXXXXXXX",
"EmailContent": [
{
"EmailAddress": "example@example.com",
"TemplateVariableParams": [
"{1}{##}Params1",
"{2}{##}Params2"
]
}
]
}'
返回示例
{
"Action": "SendEmailTemplateResponse",
"FailContent": [
{
"EmailAddress": "example@example.com",
"TemplateVariableParams": [
"{1}{##}Params1",
"{2}{##}Params2"
],
"FailureReason": "reason"
}
],
"Message": "Success",
"RequestUuid": "bb7ee377-fa16-4df4-945a-0e624fc1316b",
"RetCode": 0,
"SessionNo": "6977469d-d6fc-47e1-ad46-67d866f80655",
"SuccessCount": 0
}