首页
帮助中心
API
说明： 您可以通过此API发送HTML或者TEXT邮件，适用于触发类邮件（验证码、交易类）。
| 参数 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
|
appId |
应用id（邮件-邮件应用） |
是 |
String |
|
fromEmailAddress |
在buka平台配置的发信地址，例如：noreply@mail.buka.com |
是 |
String |
|
toAddress |
收件人地址，多个 email 地址可以用英文逗号分隔，最多50个地址。如果有更多收件人可以用批量发送接口。例如：noreply@smail.buka.com,noreply1@mail.buka.com |
是 |
String |
|
subject |
发送邮件，需要设置一个主题，可以是一次性的发送主题或者可重复使用的模板主题。至少需要设置一种主题，字数限制（1~100个字符） |
否 |
String |
|
templateID |
在buka平台配置的审核通过的模板ID |
是 |
String |
|
templateData |
如果模板中存在变量参数，建议发送的时候传值key-value的： 示例： { "code":"1234" } |
否 |
String |
|
language |
语言枚举，如：en、zh，不传使用默认模板；其他语言参见模板语言表 |
否 |
String |
|
adFlag |
是否添加广告标识 0:不添加， 1:添加到subject前面，2:添加到subject后面 |
否 |
Int |
|
checkEmailAddress |
是否开启邮箱地址有效性检测。true: 开启；false: 不开启；默认false。注：开启邮箱地址有效性检测将收取额外费用，单价为0.0008欧元/个 |
否 |
boolean |
|
emailtype |
枚举mkt，notify 默认为notify(mkt营销、notify通知) |
否 |
String |
https://api.onbuka.com/v3/email/sendEmail
Request URL:
https://api.onbuka.com/v3/email/sendEmail?appId=fKFtblIy&fromEmailAddress=test%40mailpush.tyh9.cn&toAddress=test%40qq.com%2C123%40qq.com%2C1234%40163.com&subject=hello+world&templateID=1&templateData=%7B%22code%22%3A%221234%22%7D&language=en&adFlag=1&checkEmailAddress=false&emailtype=mkt
Request Method:
GET
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request URL:
https://api.onbuka.com/v3/email/sendEmail
Request Method:
POST
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request Body:
{
"appId":"fKFtblIy",
"fromEmailAddress":"test@mailpush.tyh9.cn",
"toAddress":"test@qq.com,123@qq.com,1234@163.com",
"subject":"hello world",
"templateID":"1",
"templateData":'{"code":"1234"}',
"language":"en",
"adFlag":1,
"checkEmailAddress":"false",
"emailtype":"mkt"
}
| 参数 | 说明 | 类型 |
|---|---|---|
|
status |
状态码，0提交成功，其他失败参见邮件状态码说明 |
String |
|
reason |
失败原因说明 |
String |
|
success |
提交成功状态 |
String |
|
fail |
提交失败描述 |
String |
|
emailState |
提交状态：失败、成功 |
String |
|
remark |
成功/失败描述 |
String |
|
array |
找到发送结果的json集合 |
JSONArray |
|
emailId |
提交邮件到平台emailId |
String |
|
toAddress |
提交收件人地址（邮箱地址） |
String |
注：提交发送邮件成功后，系统会给每个提交成功的号码对应生成一个平台emailId，后续客户可以根据这个emailId来查询该邮件的发送结果。
{
"status": "0",
"reason": null,
"success": "Success",
"fail": "Failure to check email address:0; duplicate email address:0;",
"array": [
{
"emailId": "2208061540441000001",
"toAddress": "1ce.12@qq.com"
},
{
"emailId": "2208061540441000002",
"toAddress": "123@qq.com"
},
{
"emailId": "2208061540451000003",
"toAddress": "1234@163.com"
}
],
"emailId": null,
"toAddress": null,
"emailState": "Success",
"remark": "Total 3 sending address, successfully sent:3"
}
意见反馈
