Skip to main content
POST
通知成员

限制说明

使用说明

  • 不是调用方账户内活跃成员、或没有邮箱地址的收件人会被跳过,不会导致整个请求失败。
  • 是否发送邮件取决于每个收件人针对此类消息的通知偏好设置;未设置偏好的收件人默认会收到邮件。
  • 收件人收到的邮件正文就是清洗后的 html,平台不会在其前后添加任何内容;发件人名称显示为调用方姓名加“(via AI SRE)”。
  • dry_run 设为 true 可执行全部检查并在 html 中返回将要发送的完整邮件,但不会发送:不会入队,也不占用每小时限额和同轮次去重。
  • 同一收件人通过该接口每小时最多收到 20 封邮件;超出后同一窗口内该收件人的后续投递会被跳过并返回 rate_limited
  • 在同一个 AI SRE 会话轮次内重复调用,不会向已收到邮件的收件人重复发送;重复的收件人会被跳过并返回 duplicate

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

邮件通知成员请求

subject
string
必填

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

Required string length: 1 - 200
html
string
必填

邮件正文,HTML 片段(无需 <html>/<head>/<body> 包裹),即收件人看到的完整邮件正文。必填,原始 UTF-8 内容不超过 102,400 字节(更大的正文会被常见邮件客户端截断),且清洗后不能为空。服务端会进行清洗:<script><style><iframe><object><embed><form><input><button><svg><meta><link><base> 标签及所有 on* 事件处理属性会被移除;图片仅在 srchttps 时保留,其他来源或没有 src 的图片(包括 data:)会被移除;链接仅允许 httphttpsmailto。内联 style 属性按原样保留。

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

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

Maximum array length: 20
dry_run
boolean
默认值:false

仅检查不发送。为 true 时执行全部检查,并在响应的 html 中返回将要发送的完整邮件,但不会入队,也不占用每小时限额和同轮次去重。默认 false

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

邮件通知成员响应