第三方应用开发 服务端API 邮件 获取接收的邮件 获取收件箱邮件列表
获取收件箱邮件列表
最后更新:2022/12/01
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获取收件箱邮件列表
最后更新:2022/12/01

由于用户可向应用所绑定的邮箱回复邮件,故支持应用获取应用收件箱的邮件列表。
该接口用于分页获取收件箱下,指定时间范围内的邮件id列表。

请求方式: POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/exmail/app/get_mail_list?access_token=ACCESS_TOKEN

请求包体

{
  "begin_time": 1668441600,
  "end_time": 1668527999,
  "cursor": "CURSOR",
  "limit": 100
}

参数说明

参数必须类型说明
access_tokenstring调用接口凭证
begin_timeuint32开始时间,unix时间戳
end_timeuint32结束时间,unix时间戳
cursorstring上一次调用时返回的next_cursor,第一次拉取可以不填
limituint32期望请求的数据量,默认值为100,最大值为1000

 

权限说明

  • 自建应用需配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用(accesstoken如何获取?
  • 第三方应用需具有“邮件”权限
  • 代开发自建应用需具有“邮件”权限

 

返回示例

{
   "errcode": 0,
   "errmsg": "ok",
   "next_cursor": "NEXT_CURSOR",
   "has_more": 0,
   "mail_list": [
     {
        "mail_id": "MAIL_ID"
     }
   ]
}

参数说明

参数类型说明
errcodeint32返回码
errmsgstring对返回码的文本描述内容
next_cursorstring应用邮箱账号中邮件未读数
has_moreuint32是否还有更多数据。0-没有 1-有
mail_listobj[]邮件列表
mail_list[].mail_idstring邮件id
上一篇
发送会议邮件
下一篇
获取邮件内容