批量发送邮件

首页

帮助中心

API

说明： 可以通过此API批量发送TEXT或者HTML邮件，适用于营销类、通知类邮件。批量发送之前，需先创建收件人列表、发信地址、邮件模板。

请求参数说明：

参数	说明	是否必填	类型
appId	应用id（邮件-邮件应用）	是	String
fromEmailAddress	在buka平台配置的发信地址，例如：noreply@mail.buka.com	是	String
receiverId	在buka平台配置的收件人列表ID，如果有变量，发送的时候会取模板中的变量值	是	String
subject	发送邮件，需要设置一个主题，可以是一次性的发送主题或者可重复使用的模板主题。至少需要设置一种主题，字数限制（1~100个字符）	否	String
templateID	在buka平台配置的审核通过的模板ID	是	String
url	回调地址	是	String
language	语言枚举，如：en、zh，不传使用默认模板；其他语言参见模板语言表	否	String
adFlag	是否添加广告标识 0:不添加， 1:添加到subject前面，2:添加到subject后面	否	Int
emailtype	枚举mkt，notify 默认为notify(mkt营销、notify通知)	否	String

请求URL：

                      
                        https://api.onbuka.com/v3/email/batchSendEmail

GET请求示例发送“hello world”主题邮件，选择模板ID：

                      
                        Request URL:
                            https://api.onbuka.com/v3/email/batchSendEmail?appId=fKFtblIy&fromEmailAddress=test%40mailpush.tyh9.cn&receiverId=1000&subject=hello+world&templateID=1&url=https%3A%2F%2FYOUR_IP%3AYOUR_PORT%2Ftask%2Femail%2Fnotice&language=en&adFlag=1&emailtype=mkt
                        Request Method:
                            GET
                        Request Headers:
                            Content-Type: application/json;charset=UTF-8
                            Sign: 05d7a50893e22a5c4bb3216ae3396c7c
                            Timestamp: 1630468800
                            Api-Key: bDqJFiq9

POST请求示例发送“hello world”内容：

                      
                        Request URL:
                            https://api.onbuka.com/v3/email/batchSendEmail
                        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",
                                "receiverId":"1000",
                                "subject":"hello world",
                                "templateID":"1",
                                "url":"https://YOUR_IP:YOUR_PORT/task/email/notice",
                                "language":"en",
                                "adFlag":1,
                                "emailtype":"mkt" 
                            }

响应参数说明：

参数	说明	类型
status	状态码，0提交成功，其他失败参见邮件状态码说明	String
reason	失败原因说明	String
taskId	任务ID	String

注：提交发送邮件成功后，系统会给一个任务ID，根据回调地址程序会进行发送信息的推送。

响应示例：

                    
                        {
                            "status": "0",
                            "reason": null,
                            "taskId": "630361b19ef86e51f4de07f1"
                        }

批量发送回调API（bathWebhook）：

参数	说明	类型
taskId	任务ID	String
emailId	提交邮件对应平台emailId	String
toAddress	提交收件人地址	String
emailState	提交状态：失败、成功	String
remark	成功/失败描述	String