跳转到主要内容
POST
通知成员

限制说明

使用说明

  • 仅可使用 AI SRE 会话凭据调用;使用其他凭据调用会返回 AccessDenied。
  • 邮件投递是异步的——accepted 表示邮件已入队,并不代表已送达。
  • 不是调用方账户内活跃成员、或没有邮箱地址的收件人会被跳过,不会导致整个请求失败。
  • 是否发送邮件取决于每个收件人针对此类消息的通知偏好设置;未设置偏好的收件人默认会收到邮件。
  • 收件人收到的邮件正文就是清洗后的 html,平台不会在其前后添加任何内容;发件人名称显示为调用方姓名加“(via AI SRE)”。
  • 发送前,服务端会检查提交的 html,如果其中包含移除后会改变收件人所见内容的构造(<style>、<svg>、<iframe>、<object>、<embed>、<form>、<input>、<button>、src 缺失或不是 https 的 <img>,或 href 不属于 http/https/mailto 的 <a>),会返回 400 / InvalidParameter 并拒绝请求;错误消息会逐一列出触发的构造及需要如何修改,且不会入队——不占用每小时限额,也不占用同轮次去重。不影响渲染效果的标签(<script>、<meta>、<link>、<base>、on* 事件属性)仍会被静默清洗,不会触发拒绝。
  • 同一收件人通过该接口每小时最多收到 20 封邮件;超出后同一窗口内该收件人的后续投递会被跳过并返回 rate_limited。
  • 在同一个 AI SRE 会话轮次内重复调用,不会向已收到邮件的收件人重复发送;重复的收件人会被跳过并返回 duplicate。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

邮件通知成员请求

subject
string
必填

邮件主题,按原样使用。必填,1–200 个字符;换行会被替换为空格,首尾空白会被去除。

Required string length: 1 - 200
html
string
必填

邮件正文,HTML 片段(无需 <html>/<head>/<body> 包裹),即收件人看到的完整邮件正文。必填,原始 UTF-8 内容不超过 102,400 字节(更大的正文会被常见邮件客户端截断),且清洗后不能为空。<script>、<meta>、<link>、<base> 标签及所有 on* 事件处理属性会在发送前被静默移除——邮件客户端本就不会执行它们;内联 style 属性按原样保留。<style>、<svg>、<iframe>、<object>、<embed>、<form>、<input>、<button> 标签,src 缺失或不是 https(包括 data:)的 <img>,以及 href 不属于 http、https、mailto 的 <a>,会被直接拒绝而非静默清洗:请求会返回 400,而不是悄悄改变收件人看到的内容。

Maximum string length: 102400
person_ids
integer<int64>[]

收件人成员 ID 列表。可选,最多 20 个,不可重复;省略或为空时仅发送给调用方本人。

Maximum array length: 20

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

邮件通知成员响应