腾讯企业邮箱openapi协议v12.pdfVIP

BizMail OpenApi 协议 -——面向企业邮用户 1. 开放协议简介3 2. 接入流程3 3. 协议框架3 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 11 5.7 同步部门 11 5.8 获取子部门列表 12 5.9 获取部门下成员列表 13 5. 同步Api 接口：服务器推送 16 6.1 版本更新 16 6.2 新邮件提醒 17 6.3 未读数更新 17 7. 邮箱一键登陆和读信 18 1. 开放协议简介 腾讯企业邮箱开放协议，包括面向第三方合作应用和面向企业邮用户两类。其中，面向 企业邮用户的开放协议，将提供给企业邮用户丰富的应用接口，用户可以根据这些接口定制 自己统一的企业解决方案。 通过协议接口，企业用户可以实现： 1. 同步成员帐号信息 2. 新邮件提醒 3. 单点登陆 2. 接入流程 接入流程如下： 管理端申请 分配id和secret OAuth验证授权 同步 接入 图1 申请接入腾讯企业邮开放协议流程图 1. 用户以管理员身份登陆，在管理端的“增值服务”申请分配client_id 和client_secret 。 其中client_id 用于唯一标识用户 （默认为当前管理员帐号）。 2. 根据client_id 和client_secret 进行身份验证，得到access_token 。 3. 根据access_token，长连接接入平台，同步和接收数据。 客户端通过长连接维持在线状态，服务端通过检查用户的在线状态，实时推送消息；同时客 户端根据同一个连接，获取请求数据。 3. 协议框架 3.1 协议格式 协议采用HTTP+JSON 格式，请求采用GET/POST 方式。 3.2 安全机制 1. 管理员在管理端可以随时启用/关闭同步选项。 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 。 请求示例如下： POST /cgi-bin/token HTTP /1.1 Host: Content-Length: 75 grant_type=client_credentialsclient_id=biz0876xaclient_secret=yuw_0dfuxUa 或者： POST /cgi-bin/token HTTP /1.1 Host: Authorization: Basic Yml6MDg3NnhhOnl1d18wZGZ1eFVh Content-Length: 29 grant_type=client_credentials 如果验证通过，返回： { access_token:jIFA9ju6v5XP, token_type:Bearer, expires_in:86400, refresh_token: } 5. 同步Api 接口：客户端请求 同步接口需要先经过OAuth 验证，获取到access_token 。调用的接口需要把参数access_to