腾讯OpenApi调⽤说明
⼀、开放协议介绍
1.1 功能简介
腾讯开放协议，包括⾯向第三⽅合作应⽤和⾯向企业邮⽤户两类。其中，⾯向
企业邮⽤户的开放协议，将提供给企业邮⽤户丰富的应⽤接⼝，⽤户可以根据这些接⼝定制⼰统⼀的企业解决⽅案。
通过协议接⼝，企业⽤户可以实现：
1. 单点登录
可以从公司OA 系统、⽹站⼀键进⼊，免去登录过程。
2. 新邮件提醒
新邮件将即时在OA 等办公系统提醒你。
3. 数据同步
数据同步可以帮助你同步部门成员信息，你还可以创建、删除、修改帐号，同步部门信息等。
1.2 协议格式
协议采⽤HTTP+JSON 格式，请求采⽤GET/POST ⽅式。
1.3 安全机制
1. 管理员在管理端可以随时启⽤/关闭同步选项。
2. 在管理端的“操作记录”可以查询同步⽇志，⽅便观察异常。
1.4 协议编码
均⽤UTF-8 编码。
⼆、接⼊流程
接⼊腾讯企业邮开放接⼝的全流程图如下：
2.1 管理端申请
2.2 获取接⼝key
接⼝key，是作为下⼀步OAuth 验证授权传递的参数，需要查看明⽂。
（1）点击“查看明⽂”：
（2）输⼊管理员密码，点击“确定”
（3）可查看接⼝key
截图中的接⼝key 为563a8c6a89d2368194c1c7889c508b34
2.3 OAuth 验证授权
接⼝说明：
⽬前，腾讯采⽤OAuth2.0 协议对第三⽅进⾏授权，关于OAuth2.0 的详细介绍，请考OAuth 协议标准。
客户端通过长连接维持在线状态，服务端通过检查⽤户的在线状态，实时推送消息；同时客端根据同⼀个连接，获取请求数据。
调⽤的⽅式有两种⽅式：
POST ⽅式：在POST 请求加上access_token；
GET 或者其他⽅式：在HTTP HEAD 加上Authorization，将client_id 和client_secret 以
液晶显示器维修教程BASE64 加密⽅式加密，即base64(client_id: client_secret)，将密⽂发送到请求信息中。
2、格式：JSON
3、HTTP 请求⽅式：GET/POST
4、输⼊参数说明：
参数名称类型描述
client_id string 当前管理员帐号
client_secret string 接⼝key
6、返回参数说明：
参数名称描述
access_token
token_type
expires_in access_token 的有效使⽤期，失效后请重新获取
refresh_token
7、正确返回⽰例：
{
“access_token”:“GHUSH-4qIXPScxa_OY0CbPS31W1OM24L_Ys9FCc7LtJyxjHD5OZafLh3Y8
gM7gzDtp-GdQEY4dwFXk2qgnkwJA “,
“token_type”:“Bearer”,
“expires_in”:86400,
“refresh_token”:””
}
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/mail/authkey
2、格式：JSON
3、HTTP 请求⽅式：GET/POST
4、输⼊参数说明：
参数名称类型描述
Alias string 帐号名
6、返回参数说明：
参数名称描述
AuthKey 登陆/读信验证Key
7、正确返回⽰例：
{
“AuthKey”:
"077FFF01B4D6A28A07A21682C3C0D4FE04221261CE2E3FAFA9E8432937DCF57290EA36BAD 05815167251FF690134EDE4F40055B1B7B68C1D "
}
3.1.2 ⼀键登录
接⼝说明：
1、URL：
2、格式：JSON
3、HTTP 请求⽅式：GET/POST
4、输⼊参数说明：
参数名称类型描述
ticket string 调⽤“获取Authkey”获
取的Authkey
agent string 管理员帐号
6、返回参数说明：
参数名称描述
mailid 服务器推送新邮件时的mailid 字段
7、正确返回⽰例
3.2 邮件提醒
新邮件将即时在OA 等办公系统提醒你。接⼊的流程图如下：
3.2.1 客户端维持长连接
调⽤说明：
调⽤此api 是⽤于维持客户端与服务器的长连接。
1、URL：openapi/listen
2、格式：JSON
3、HTTP 请求⽅式：GET/POST
4、输⼊参数说明：
参数名称类型描述
Ver string 本地维护的最新版本号
6、返回参数说明：
如果当前客户端长连接在线，会返回参数“Ret”，当服务端检查到服务器版本号数据变更时，发最新版本号“ver”。参数名称描述
Ret 返回值
7、正确返回⽰例：
{
“Ret”: 0
}
3.2.2 下发数据
如果当前客户端长连接在线，当服务端检查到数据变更时，将会下发数据：版本号更新；新邮件提醒；实时更新未读邮件数。
（1）版本号更新
1、下发字段：
参数名称类型描述
Ver string 服务器最新版本号
2、下发⽰例：
{
“Ver”: “1364460338051”,
}
（2）新邮件提醒
1、下发字段：
参数名称描述
UserName 帐号名
MailId 邮件Id
Sender 发件⼈
Receiver 收件⼈
Subject 标题
Summary 摘要
NewCount 新邮件数
2、下发⽰例：
{
“UserName”: ",
“MailId”: “ZC4028-FPiX_oOG5HUh4XorwyhAY33”,
“Sender”: ““Test” ”,
“Receiver”: ",
“Subject”: “TestMail”,
“Summary”: "TestMail Content ",
“NewCount”: 549
}
（3）实时更新未读邮件数
1、下发字段：
参数名称描述
UserName 帐号
NewCount 未读邮件数
2、下发⽰例：
{
李咏身高" UserName": ",
" NewCount ": 550,
}
3.3 数据同步
数据同步可以帮助你同步部门成员信息，你还可以创建、删除、修改帐号，同步部门信息等。接⼊的流程图如下：
3.3.1 获取成员资料
接⼝说明：
1、URL：openapi/user/get
2、格式：JSON
3、HTTP 请求⽅式：GET/POST
4、输⼊参数说明：
参数名称类型描述
有什么好的网络游戏Alias string 当前管理员帐号
6、返回参数说明：
参数名称描述
Alias 帐号名
Name 姓名
Gender 性别：0=未设置，1=男，2=⼥
SlaveList 别名列表，⽤逗号分隔
Position 职位
Tel
Mobile ⼿机
ExtId 编号
PartyList 部门列表，部门的根结点不包括在路径⾥⾯。⽐如部门所属：腾讯/⼴州研发中⼼/，Value 为：⼴州研发中⼼/OpenType 成员状态：1=启⽤，2=禁⽤普普结局
7、正确返回⽰例：
{
“Alias”: " ",
斛珠夫人里海市的结局“Name”: “鲍勃”,
“Gender”: 1,
“SlaveList”: ",
“Position”: “⼯程师”,
“Tel”: “62394”,
“Mobile”: “”,
“ExtId”: “100”,
“PartyList”: {
“Count”: 3,
“List”: [{ “Value”: “部门a” }
,{ “Value”: “部门B/部门b” }
,{“Value”: “部门c” }
]
}
}
3.3.2 同步成员帐号资料
接⼝说明：
1、URL：openapi/user/sync
2、格式：JSON
3、HTTP 请求⽅式：GET/POST