BizMail OpenApi 协议
-——面向企业邮用户
1. 开放协议简介..............................................................................................................................3 2. 接入流程......................................................................................................................................3 3. 协议框架......................................................................................................................................3
客户端通过长连接维持在线状态，服务端通过检查用户的在线状态，实时推送消息；同时客 户端根据同一个连接，获取请求数据。
3. 协议框架
3.1 协议格式
协议采用 HTTP+JSON 格式，请求采用 GET/POST 方式。
3.2 安全机制
1. 管理员在管理端可以随时启用/关闭同步选项。
2. 在管理端的“操作记录”可以查询同步日志，方便观察异常。
3.1 协议格式...........................................................................................................................3 3.2 安全机制...........................................................................................................................3 3.3 其它约定...........................................................................................................................4 4. OAuth 验证授权...........................................................................................................................5 5. 同步 Api 接口：客户端请求......................................................................................................5 5.1 客户端维持长连接............................................................................................................6 5.2 获取成员资料....................................................................................................................7 5.3 同步成员帐号资料............................................................................................................8 5.4 获取某个版本号后的用户更新列表................................................................................9 5.5 获取新邮件数..................................................................................................................10 5.6 获取登陆/读信 Key.........................................................................................................10 5.7 同步部门.......................................................................................................................... 11 5.8 获取子部门列表..............................................................................................................12 5.9 获取部门下成员列表......................................................................................................13 5. 同步 Api 接口：服务器推送.................................................................................................14 6.1 版本更新...........................................................................................................................14 6.2 新邮件提醒......................................................................................................................14 6.3 未读数更新......................................................................................................................15 7. 邮箱一键登陆和读信................................................................................................................15
grant_type=client_credentials
如果验证通过，返回： {
"access_token":"jIFA9ju6v5XP", "token_type":"Bearer", "expires_in":86400, "refresh_token":"" }
5. 同步 Api 接口：客户端请求
ver=1332934486046
返回： {
"Ret": 0 }
5.2 获取成员资料
openapi/user/get
请求字段： 字段 Alias
含义 帐号名
返回 data 包含字段：
1. 开放协议简介
腾讯企业邮箱开放协议，包括面向第三方合作应用和面向企业邮用户两类。其中，面向 企业邮用户的开放协议，将提供给企业邮用户丰富的应用接口，用户可以根据这些接口定制 自己统一的企业解决方案。
通过协议接口，企业用户可以实现： 1. 同步成员帐号信息 2. 新邮件提醒 3. 单点登陆
2. 接入流程
3.3 其它约定
1) 涉及到的字符均用 UTF-8 编码
4. OAuth 验证授权
目前，腾讯企业邮箱采用 OAuth2.0 协议对第三方进行授权，关于 OAuth2.0 的详细介绍，请 参考 OAuth 协议标准。 根据申请到的 client_id 和 client_secret，采用 ClientCredentials 方式获取 access_token。 其中 client_id 为管理员帐号，client_secret 为管理端开放接口申请到的 key。 假设 client_id 为 biz0876xa，client_secret 为 yuw_0dfuxUa。
接入流程如下：
管理端申请 接入
分配id和secret
OAuth验证授权
图 1 申请接入腾讯企业邮开放协议流程图
同步
1. 用户以管理员身份登陆，在管理端的“增值服务”申请分配 client_id 和 client_secret。 其中 client_id 用于唯一标识用户（默认为当前管理员帐号）。
2. 根据 client_id 和 client_secret 进行身份验证，得到 access_token。 3. 根据 access_token，长连接接入平台，同步和接收数据。
alias=bob@gzdev.com
5.1 客户端维持长连接
openapi/listen
用于维持客户端与服务器的长连接，同时上传 ver 表示监控接收服务器该版本号后的变更提 醒下发。
请求字段： 字段 Ver
含义 本地维护的最新版本号
返回 data 包含字段：
字段
含义
Ret
返回值Leabharlann Baidu
请求示例如下：
POST http://openapi.exmail.qq.com:12211/openapi/listen HTTP /1.1 Host: openapi.exmail.qq.com Authorization: Bearer jIFA9ju6v5XP Content-Length: 19
同步接口需要先经过 OAuth 验证，获取到 access_token。调用的接口需要把参数 access_token 传过来。 有两种方式，一种是在 HTTP HEAD 加上 Authorization，另外一种是在 GET/POST 请求加上 access_token。
请求示例如下： POST http://openapi.exmail.qq.com:12211/openapi/user/get HTTP /1.1 Host: openapi.exmail.qq.com Content-Length: 45
请求示例如下： POST https://exmail.qq.com/cgi-bin/token HTTP /1.1 Host: exmail.qq.com Content-Length: 75
grant_type=client_credentials&client_id=biz0876xa&client_secret=yuw_0dfuxUa 或者： POST https://exmail.qq.com/cgi-bin/token HTTP /1.1 Host: exmail.qq.com Authorization: Basic Yml6MDg3NnhhOnl1d18wZGZ1eFVh Content-Length: 29
access_token=jIFA9ju6v5XP&alias=bob@gzdev.com 或者： POST http://openapi.exmail.qq.com:12211/openapi/user/get HTTP /1.1 Host: openapi.exmail.qq.com Authorization: Bearer jIFA9ju6v5XP Content-Length: 19