接口说明:

立即发送指定项目指定报告的邮件或webhook。

基本信息:

属性
API /api/dash/regularMail/send
Method POST

该接口有两种参数传递方式

参数传递方式一

请求参数:

字段名称 参数类型 参数说明
token String 鉴权token,该用户必须是系统里的超管
mail mail 邮件信息

mail字段:

字段名称 参数类型 参数说明
cache String (Optional) 默认为'1'使用缓存,'0'为不使用缓存
resourceId Int 报告id
projectId Int 项目id
title String 邮件标题
receiverList ReceiverList 接收者列表,可以是用户,角色,用户组
tag String(Optional) 邮件签名
sendFailMailRemark Int 0失败不通知;1失败立即通知;2失败重试(至多3次)后通知
id Int(Optional) 系统中推送的id
dataPermission Int(Optional) 默认为0不区分权限,1为区分权限
enableEmail Int 是否发送邮件
enableWebhook Int 是否发送webhook
webhookList Array(Int)(Optional) 当enableWebhook为1时,该项必填。数组中的内容是在系统中配置的webhook的id
image Int(Optional) 1带图片(默认),0带数据表格,2不带图片和数据表格
sendFailMailRemark Int(Optional) 0失败不通知,1失败立即通知,2失败重试后通知
attachment String 携带附件的类型,nothing-不携带附件,excel, pdf, png
dashboardIds Array(Int)(Optional) 推送范围。当该字段不为null时,推送相应报告页,数组内容是报告页的id
widgets Array(widget)(Optional) 推送范围。当该字段不为null时,推送相应组件,数组内容见下面 widgets字段 表

widgets字段: | 字段名称 | 参数类型 | 参数说明 | |-----------------|--------------|----------------------| | dashId | Int | 页面id | | selectIds | Array(String)| 当前页面被选中的组件id |

{
  "token": "1503575355359c4fdea8ec1683ed10edd91ae",
  "mail": {
    "resourceId": 40,
    "projectId": 13,
    "title": "title",
    "receiverList": [
      {
        "id": 122, // 用户id
        "type": "user"
      },
      {
        "id": 1, // 角色id
        "type": "role"
      },
      {
        "id": 1, // 用户组id
        "type": "group"
      },
      {
        "name": "hzlisi@163.com", // 用户的uniqueId
        "type": "user"
      },
      {
        "name": "角色名称", // 默认角色不支持,只能用id发送(项目管理员1,编辑者2,预览者3),角色idname二选一即可
        "type": "role"
      },
      {
        "name": "用户组名称", // 用户组名称
        "type": "group"
      }
    ],
    "cache": 1,
    "tag": "qianming",
    "id" : 2045,
    "dataPermission": 0,
    "enableEmail": 1,
    "enableWebhook": 1,
    "webhookList": [1],
    "image":1,
    "widgets": {"dashId": "140360", "selectIds": ["c-1-130781-140360-keavmgax"]}
  }
}
参数传递方式二

请求参数:

字段名称 参数类型 参数说明
token String 鉴权token,该用户必须是系统里的超管
batchMails Array(Object) 邮件信息

batchMails 字段:

字段名称 参数类型 参数说明
id INT 系统中定时推送或者立即推送的id
{
  "token": "1503575355359c4fdea8ec1683ed10edd91ae",
  "batchMails": [{
    "id": 40
  },
  {
    "id": 41
  }]
}