本产品(
邮件推送/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 | 创建无效地址或域名 | 创建无效地址或域名。 |