腾讯企业邮箱OpenApi协议v1.0

1、腾讯企业邮箱openapi协议v1.0bizmail 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.2.3 新邮件提示 (

2、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) 管理员在管理端可以随时启用/关闭同步选项。2) 在管理端的“操作记录可以查询同步日志，便利观看异样。1.4 协议编码均用utf-8编码。二、接入流程接入腾讯企业邮开放接口的全流程图如下：2.1 管理端申请从链接http:/.doczj/d

4、oc/d46c3b50bb68a98271fefaee.html 进入，用法管理员账号登录进入管理页面，翻开“工具箱->开放协议，点击“马上申请。2.2 猎取接口key接口key，是作为下一步oauth验证受权传递的参数，需要查看明文。1点击“查看明文：2输入管理员密码，点击“确定3可查看接口key截图中的接口key为563a8c6a89d2368194c1c7889c508b342.3 oauth验证受权接口说明：目前，腾讯企业邮箱采纳oauth2.0协议对第三方进展受权，关于oauth2.0的具体介绍，请参考oauth协议标准。客户端通过长连接维持在线状态，效劳端通过检查用户的在线状

5、态，实时推送消息；同时客户端依据同一个连接，猎取恳求数据。调用的方式有两种方式：一种是在get/post恳求加上access_token；另一种是在http head加上authorization，将client_id和client_secret以base64加密方式加密，即base64(client_id: client_secret)，将密文发送到恳求信息中。1、url：https:/http:/.doczj/doc/d46c3b50bb68a98271fefaee.html /cgi-bin/token2、格式：json3、http恳求方式：get/post5、恳求示例：7、正确返回示例

6、：2.4 调用接口api客户端恳求经过oauth受权验证后，猎取到access_token，开发者可以依据实现功能的需要去选择调用的api。以下章节将列出接口api的功能和调用方式。三、调用接口api说明接口api能实现的功能有如下三个：1单点登录：可以从公司oa系统、网站一键进入企业邮箱，免去登录过程。2新邮件提示：新邮件将即时在oa等办公系统提示你。3同步数据同步可以关心你同步部门成员信息，你还可以创立、删除、修改帐号，同步部门信息等。3.1单点登录可以从公司oa系统、网站一键进入企业邮箱，免去登录过程。接入流程图如下所示：3.1.1 猎取authkey接口说明：1、url：openapi

7、/mail/authkey2、格式：json3、http恳求方式：get/post4、输入参数说明：5、恳求示例：3.1.2 一键登录接口说明：1、url：2、格式：json3、http恳求方式：get/post6、返回参数说明：7、正确返回示例：3.2 邮件提示新邮件将即时在oa等办公系统提示你。接入的流程图如下：3.2.1 客户端维持长连接调用说明：调用此api是用于维持客户端与效劳器的长连接。1、url：openapi/listen2、格式：json3、http恳求方式：get/post6、返回参数说明：假如当前客户端长连接在线，会返回参数“ret，当效劳端检查到效劳器版本号数据变更时，

8、下发最新版本号“ver。3.2.2 下发数据假如当前客户端长连接在线，当效劳端检查到数据变更时，将会下发数据：版本号更新；新邮件提示；实时更新未读邮件数。1版本号更新1、下发字段：2新邮件提示3实时更新未读邮件数3.3数据同步数据同步可以关心你同步部门成员信息，你还可以创立、删除、修改帐号，同步部门信息等。接入的流程图如下：3.3.1 猎取成员资料接口说明：1、url：openapi/user/get2、格式：json3、http恳求方式：get/post3.3.2 同步成员帐号资料接口说明：1、url：openapi/user/sync2、格式：json3、http恳求方式：get/post

9、5、恳求示例：6、返回参数说明：返回data为空。通过返回状态码，推断是否调用胜利。3.3.3 猎取某个版本号后的用户更新列表接口说明：1、url：openapi/user/list2、格式：json3、http恳求方式：get/post3.3.4 猎取未读邮件数接口说明：1、url：openapi/mail/newcount2、格式：json3、http恳求方式：get/post3.3.5 同步部门接口说明：1、url：openapi/party/sync2、格式：json3、http恳求方式：get/post1假如del/add，那么只需要传dstpath2假如mod，需要将srcpath，和dstpath传过来5、恳求示例：3.3.6 猎取子部门列表1、url：openapi/party/list2、格式：json3、http恳求方式：get/post3.3.7 猎取部门下成员列表接口说明：1、url：openapi/partyuser/list2、格式：json3、http恳求方式：get/pos、3