BizMail OpenApi 协议 ——面向企业邮用户 目录 目录 .................................................................................................................................................. 2 一、开放协议介绍 .......................................................................................................................... 3 1.1 功能简介 .... ........................................................................................................................ 3 1.2 协议格式 ............................................................................................................................ 3 1.3 安全机制 ............................................................................................................................ 3 1.4 协议编码 ............................................................................................................................ 3 二、接入流程 .................................................................................................................................. 3 2.1 管理端申请 ........................................................................................................................ 4 2.2 获取接口 key ..................................................................................................................... 4 2.3 OAuth 验证授权 ................................................................................................................. 5 2.4 调用接口 Api（客户端请求） ......................................................................................... 7 三、调用接口 API 说明 .................................................................................................................. 7 3.1 单点登录 ............................................................................................................................. 7 3.1.1 获取 Authkey ....................................................... 7 3.1.2 一键登录 .......................................................... 8 3.2 邮件提醒 ............................................................................................................................ 9 3.2.1 客户端维持长连接 .................................................. 9 3.2.2 下发数据 ........................................................ 10 3.3 数据同步 ........................................................................................................................... 11 3.3.1 获取成员资料 ..................................................... 11 3.3.2 同步成员帐号资料 ................................................. 13 3.3.3 获取某个版本号后的用户更新列表 .................................... 14 3.3.4 获取未读邮件数 ................................................... 15 3.3.5 同步部门 ......................................................... 16 3.3.6 获取子部门列表 ................................................... 17 3.3.7 获取部门下成员列表................................................ 17 3.3.8 检查邮件帐号是否可用 .............................................. 18 3.3.9 获取邮件列表 ..................................................... 19 四、附录：名词解释 .................................................................................................................... 21 ........................................................................................................................ 3 1.2 协议格式 ............................................................................................................................ 3 1.3 安全机制 ............................................................................................................................ 3 1.4 协议编码 ............................................................................................................................ 3 二、接入流程 .................................................................................................................................. 3 2.1 管理端申请 ........................................................................................................................ 4 2.2 获取接口 key ..................................................................................................................... 4 2.3 OAuth 验证授权 ................................................................................................................. 5 2.4 调用接口 Api（客户端请求） ......................................................................................... 7 三、调用接口 API 说明 .................................................................................................................. 7 3.1 单点登录 ............................................................................................................................. 7 3.1.1 获取 Authkey ....................................................... 7 3.1.2 一键登录 .......................................................... 8 3.2 邮件提醒 ............................................................................................................................ 9 3.2.1 客户端维持长连接 .................................................. 9 3.2.2 下发数据 ........................................................ 10 3.3 数据同步 ........................................................................................................................... 11 3.3.1 获取成员资料 ..................................................... 11 3.3.2 同步成员帐号资料 ................................................. 13 3.3.3 获取某个版本号后的用户更新列表 .................................... 14 3.3.4 获取未读邮件数 ................................................... 15 3.3.5 同步部门 ......................................................... 16 3.3.6 获取子部门列表 ................................................... 17 3.3.7 获取部门下成员列表................................................ 17 3.3.8 检查邮件帐号是否可用 .............................................. 18 3.3.9 获取邮件列表 ..................................................... 19 四、附录：名词解释 .................................................................................................................... 21