API概览

本产品(邮件推送/2015-11-23)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

账户

API标题API概述
DescAccountSummary获取账户信息获取账户信息。

白名单

API标题API概述
AddIpfilter添加IP白名单添加IP白名单。
DeleteIpfilterByEdmId删除IP白名单删除IP保护信息。

IP防护

API标题API概述
UpdateIpProtection开启或者关闭IP保护功能开启或者关闭IP保护功能。
GetIpProtection获取IP防护功能是否开启获取IP防护功能是否开启。
GetIpfilterList获取 IP 筛选器列表获取 IP 筛选器列表。

任务

API标题API概述
QueryTaskByParam查询任务查询任务。

邮件

API标题API概述
统计统计
SenderStatisticsByTagNameAndBatchID获取指定条件下的发送数据获取指定条件下的发送数据。
SenderStatisticsDetailByParam获取发送详情获取发送详情。
GetTrackList邮件跟踪获取发送数据邮件跟踪获取发送数据。
GetTrackListByMailFromAndTagName根据发信地址和标签获取邮件跟踪发送数据邮件跟踪获取指定条件下的发送数据。
SingleSendMail发送单条邮件发送单条邮件。
BatchSendMail批量发送邮件批量发送邮件。
SendTestByTemplate发送测试邮件发送测试邮件。

域名

API标题API概述
CreateDomain创建域名创建域名。
DeleteDomain删除域名删除域名。
ModifyPWByDomain设置域名的 SMTP 的密码设置域名的SMTP的密码。
QueryDomainByParam查询域名列表信息查询域名列表信息。
CheckDomain验证域名验证域名。
DescDomain配置域名配置域名。

地址

API标题API概述
CreateMailAddress创建发信地址创建发信地址。
DeleteMailAddress删除发信地址删除发信地址。
ModifyMailAddress设置发信地址SMTP密码和回信地址设置发信地址SMTP密码和回信地址。
QueryInvalidAddress获取无效地址信息获取无效地址信息。
QueryMailAddressByParam查询发信地址列表查询发信地址列表。
ApproveReplyMailAddress验证回信地址验证回信地址。
CheckReplyToMailAddress验证回信地址发送邮件验证回信地址发送邮件。
DeleteInvalidAddress删除无效地址从全局无效地址库移除无效地址。

收件人

API标题API概述
CreateReceiver创建收件人列表创建收件人列表。
DeleteReceiver删除收件人列表删除收件人列表。
DeleteReceiverDetail删除单个收件人删除单个收件人。
QueryReceiverByParam查询收件人列表查询收件人列表。
QueryReceiverDetail查询某个收件人列表详情查询某个收件人列表详情。
SaveReceiverDetail创建单个收件人创建单个收件人。

标签

API标题API概述
CreateTag创建标签创建标签。
DeleteTag删除标签删除标签。
ModifyTag修改标签修改标签。
QueryTagByParam获取标签获取标签。

其他

API标题API概述
ListUserSuppression列出个人和系统无效地址列出用户手动录入和系统判别的无效地址。
UpdateUser更新用户信息更新用户相关的信息,包括设置等信息。
GetUser获取用户信息获取用户相关的信息,包含设置等信息。
CreateUserSuppression创建无效地址或域名创建无效地址或域名。