垃圾举报

最新更新:2023-08-10

用户举报的垃圾邮件, 此用户的地址会进入垃圾举报列表。

在此列表中的邮件地址在达到过期时间之前, 都不会再被发送邮件。

你可以对此列表进行查询、删除操作。

查询

URL

https://email.api.engagelab.cc/v1/complaints
          https://email.api.engagelab.cc/v1/complaints

        
此代码块在浮窗中显示

HTTP 请求方式

GET
          GET

        
此代码块在浮窗中显示

查询参数说明

参数 类型 是否必需 说明
start_date string * 开始日期(格式:yyyy-MM-dd)
end_date string * 结束日期(格式:yyyy-MM-dd)
email string * 邮件地址,例如,22@gmail.com
offset int 起始位置 [0-],默认为 0
limit int 数量 [0-100],默认为 100

请求示例:

curl -X GET -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/complaints?offset=0&limit=90'
          curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/complaints?offset=0&limit=90' 

        
此代码块在浮窗中显示

返回值描述

参数 描述
email 查询该地址在举报列表中的详情
reason 举报原因
complaint_time 举报发生时间
expire_time 举报到期时间

返回值示例

{ "result": [ { "email": "9978977@qq.com", "reason": "from softbounce", "complaint_time": "2016-02-01T14:53:20+0800", "expire_time": "2017-02-01T14:53:20+0800" } ], "count": 1, "total": 1 }
          {
  "result": [
    {
      "email": "9978977@qq.com",
      "reason": "from softbounce",
      "complaint_time": "2016-02-01T14:53:20+0800",
      "expire_time": "2017-02-01T14:53:20+0800"
    }
  ],
  "count": 1,
  "total": 1
}

        
此代码块在浮窗中显示

删除

URL

https://email.api.engagelab.cc/v1/complaints
          https://email.api.engagelab.cc/v1/complaints

        
此代码块在浮窗中显示

HTTP 请求方式

DELETE
          DELETE

        
此代码块在浮窗中显示

请求参数说明

参数 类型 是否必需 描述
start_date string * 开始日期(格式:yyyy-MM-dd)
end_date string * 结束日期(格式:yyyy-MM-dd)
email string * 删除指定邮件

请求示例

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' --data '{"email": "x@example.com"}' 'https://email.api.engagelab.cc/v1/complaints' curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' --data '{"start_date": "2023-04-01 08:00:00", "end_date": "2023-07-01 08:00:00"}' 'https://email.api.engagelab.cc/v1/complaints'
          curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"email": "x@example.com"}'
     'https://email.api.engagelab.cc/v1/complaints' 

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"start_date": "2023-04-01 08:00:00", "end_date": "2023-07-01 08:00:00"}'
     'https://email.api.engagelab.cc/v1/complaints' 

        
此代码块在浮窗中显示

返回值说明

返回值示例

{ "count": 2 }
          {
  "count": 2
}

        
此代码块在浮窗中显示
在文档中心打开