api:start

企业QQ开放平台API文档

企业QQ业务API

OAuth2.0 企业授权 API

接入企业QQ开放平台的第一步是需要通过API获得企业的授权。

企业QQ是通过OAuth2.0获得企业授权的。企业QQ使用OAuth2.0协议授权第三方App包括用户自研App访问企业QQ的后台数据,与一般的OAuth流程不同的是,企业QQ的授权流程中,需要区分员工帐号以个人身份进行授权,和企业管理员以企业身份进行授权。

企业QQ是以企业单位进行购买的,每个企业都有一个代表企业的QQ号码,我们称之为企业主号,每个员工也拥有一个企业QQ号码,称之为员工帐号。调用企业QQ开放平台提供的API获取企业的数据时,需要以企业主号的身份进行授权,否则将无法通过API接口的权限认证。

关于OAuth认证的相关流程,还可以参考《OAuth开发文档

授权类型 API 说明
员工授权 /oauth2/authorize 获取员工授权
/oauth2/token 获取员工access_token
企业授权 /oauth2/companyToken 获取企业授权company_token
/oauth2/companyRefresh 刷新企业授权的company_token

:API的调用,都需要获取到企业授权才能够调用

员工安全注销

此接口用于员工使用企业QQ授权后安全退出;一个典型的应用场景为:当第三方网站实现了“使用企业QQ登录”的功能,在授权成功以后会在用户浏览器种上企业QQ的登录态便于员工下次自动登录,如果员工想安全注销,需要调用此接口清除企业QQ的登录态。

说明 API
员工安全注销 api详情

单点登录 API

让企业员工能够一键跳转到其他系统,免去输入账号和密码的繁琐步骤。

成功接入单点登录API后,可以把信息系统的图标嵌入在企业QQ客户端的多处位置(具体见客户端菜单)。以客户端主面板为例,可在面板上部加入一个系统的图标,点击后直接进入第三方系统页面。

API 说明
/api/login/verifyhashskey 检验企业QQ跳转到第三方页面的有效性
/api/login/check 检验company_token的是否正确
/api/login/checkAccessToken 检验access_token的是否正确

消息推送 API

让第三方系统能把提醒或待办事项发送到员工的企业QQ客户端上。

消息推送是企业QQ作为企业信息系统入口最大的优势之一。企业QQ作为一款客户端产品,天生常驻在员工的桌面上,企业QQ的消息能直接推送到员工面前,比其他产品的提醒作用要强大很多。

企业QQ提供多种消息推送方式:

  • Tips: 右下角弹窗,可控制向谁推送,推送内容,以及是否自动消息。

  • 广播: 企业QQ独有的通知渠道,可输入大量的文字和链接。右下角出现预览弹窗,点击后查看更丰富内容。

  • 未读消息数字提醒: 客户端的图标旁边可以显示第三方系统推送过来的未读消息或待办事项数据的提醒。此时点击图标与平时效果一样,跳转到第三方系统。效果图如下:

  • 短信: 第三方系统可直接调用企业QQ的短信通道给员工发送提醒短信。
API 说明
/api/tips/send 给员工帐号发送客户端提醒
/api/broadcast/send 给员工帐号发送广播通知消息
/api/clientpush/notifycenter 客户端主面板通知中心消息
/api/sms/send 给员工帐号登记的手机发送手机短信(需消费短信)

表示此种API还需要额外的开发定制,并非直接就可以实现,比如,notifycenter需要定制客户端主面板图标展现等

企业基本资料 API

API 说明
/api/corporation/get 获取企业的基本资料
/api/corporations/info 批量获取企业的基本资料(供开发商使用)

员工帐号基本资料 API

API 说明
/api/user/list 全量获取员工列表
/api/user/info 单个或批量获取员工基本资料
/api/user/face 批量获取员工头像
/api/user/email 获取用户Email地址(敏感)
/api/user/mobile 获取用户手机号码(敏感)
/api/user/qq 获取用户企业QQ号码(敏感)
/api/user/online 获取用户企业QQ在线状态(敏感)
/api/user/mobileContacts 获取用户手机联系人(敏感)

帐号同步与组织架构同步 API

让企业QQ与其他系统的账号做到增删改的同步。

系统间的账号同步可以同步账号、姓名、性别、手机号码四个字段,并指定该账号所在的组织。

当企业QQ侧有账号信息变化时,企业QQ会通知第三方系统有信息变更,第三方可以选择到企业QQ侧查询账号信息变化的情况,也可以选择不做任何动作。

第三方有账号信息变化时,可通过API接口将信息直接同步到企业QQ中。新增员工成功后企业QQ会返回一个openid,这个openid是与企业QQ账号一一对应的。

API 说明
/api/dept/list 获取组织架构列表
/api/dept/info 单个或者批量获取组织架构节点的信息
/api/dept/adduser 新增普通员工
/api/dept/moduser 修改普通员工
/api/dept/deluser 删除普通员工
/api/dept/setuserstatus 修改员工状态
/api/dept/adddept 新增组织
/api/dept/moddept 修改组织
/api/dept/deldept 删除组织
/api/dept/movuser 移动员工

直属上下级关系 API

员工上下级关系的增/删/改/查操作。

在上下级关系链中,每个员工最多只能有一个直属上级,可以有多个直属下级。

API 说明
/api/relation/getsuperior 获取某个员工直属上级
/api/relation/setsuperior 设置某个员工直属上级
/api/relation/delsuperior 删除某个员工直属上级
/api/relation/getsubordinates 获取某个员工直属下级
/api/relation/delsubordinates 清空某个员工直属下级

权限与角色 API

API 说明
/api/permission/roles 获取角色列表
/api/permission/list 获取某个角色的员工open_id列表
/api/permission/user 查询某个员工open_id是否具有某种权限

与企业QQ交谈按钮 API

API 说明
/api/wpa/generate 获取带有富文本上下文信息的“与企业QQ交谈”按钮

事件回调接口

企业QQ的一些业务发生改变时,会通过第三方在企业QQ开放平台登记的接口,回调通知第三方业务发生的变化。 如果第三方业务展开需要用到,可以登记相关回调地址,在下列事件发生时,会收到企业QQ的调用。

如何在企业QQ客户端嵌入第三方应用的入口,请参考《客户端接口文档

说明:组织架构变更通知,开通关闭App通知,从企业QQ客户端或者账户中心跳转到第三方的入口网址,这三个都被统一成一个“事件通知和跳转进入”回调,将三者统一起来,可以减少维护成本。

接口访问频次权限

API调用范例代码

PHP范例代码:

PHP范例代码说明文档:

调试工具:

注意:如果您刚申请了企业QQ的开放平台API调用权限,还摸不着头脑,建议可以尝试申请免费的SAE,部署测试企业QQ的API。但是如果您已经申请API并成功开通应用,就无法同时部署并使用testapi的代码来测试API。

api/start.txt · 最后更改: 2016/04/22 16:55 (外部编辑)