《腾讯企业邮箱OpenApi协议v1.0》由会员分享，可在线阅读，更多相关《腾讯企业邮箱OpenApi协议v1.0（19页珍藏版）》请在金锄头文库上搜索。
1、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 客户端维持长
2、连接 . 9 3.2.2 版本号更新 . 10 3.2.3 新邮件提醒 . 10 3.2.4 实时更新未读邮件数 . 11 3.3 数据同步 . 11 3.3.1 获取成员资料 . 12 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 四、附录：名词解释四、附录：名词解释 . 19 一、一、开放协议介绍开放协议介绍 1.1 功能简介功能简介 腾讯企业邮箱开放协
3、议，包括面向第三方合作应用和面向企业邮用户两类。其中，面向 企业邮用户的开放协议， 将提供给企业邮用户丰富的应用接口， 用户可以根据这些接口定制 自己统一的企业解决方案。 通过协议接口，企业用户可以实现： 1) 单点登录 可以从公司 OA 系统、网站一键进入企业邮箱，免去登录过程。 2) 新邮件提醒 新邮件将即时在 OA 等办公系统提醒你。 3) 数据同步 数据同步可以帮助你同步部门成员信息， 你还可以创建、 删除、 修改帐号， 同步部门信息等。 1.2 协议格式协议格式 协议采用 HTTP+JSON 格式，请求采用 GET/POST 方式。 1.3 安全机制安全机制 1) 管理员在管理端可以
4、随时启用/关闭同步选项。 2) 在管理端的“操作记录”可以查询同步日志，方便观察异常。 1.4 协议编码协议编码 均用 UTF-8 编码。 二、二、接入流程接入流程 接入腾讯企业邮开放接口的全流程图如下： 2.1 管理端申请管理端申请 从链接 http:/ 进入，使用管理员账号登录进入管理页面，打开“工具箱-开放 协议” ，点击“立即申请” 。 2.2 获取接口获取接口 key 接口 key，是作为下一步 OAuth 验证授权传递的参数，需要查看明文。 （1）点击“查看明文” ： （2）输入管理员密码，点击“确定” （3）可查看接口 key 截图中的接口 key 为 563a8c6a89d23
5、68194c1c7889c508b34 2.3 OAuth 验证授权验证授权 接口说明： 目前，腾讯企业邮箱采用 OAuth2.0 协议对第三方进行授权，关于 OAuth2.0 的详细介绍，请 参考 OAuth 协议标准。 客户端通过长连接维持在线状态，服务端通过检查用户的在线状态，实时推送消息；同时客 户端根据同一个连接，获取请求数据。 调用的方式有两种方式： 一种是在 GET/POST 请求加上 access_token； 另一种是在 HTTP HEAD 加上 Authorization，将 client_id 和 client_secret 以 BASE64 加密方式加密，即 base64(client_id: client_secret)，将密文发送到请求信息中。 1、 URL
