api:client

企业QQ客户端接口文档

企业QQ桌面客户端(含Windows版、Mac版)也提供了接口,允许合作开发商、用户开发者,将业务功能内嵌到企业QQ的面板之上,直接触达用户,为企业用户提供快捷的功能入口。

术语和定义

  • 客户端 指企业QQ桌面版客户端软件
  • 服务器 指企业QQ后台服务器
  • 聊天窗口 指企业QQ单人会话聊天窗口
  • 迷你资料卡 指鼠标悬浮在组织架构成员图标上时,出现的成员资料浮窗

功能概述

为了方便合作伙伴开发商,将提供的服务触达企业QQ用户,企业QQ客户端开放了相应的客户端面板位置,让合作伙伴开发商能将自己的服务的图标和功能快速嵌入到企业QQ客户端面板,实现快速触达,提供无缝的使用体验。

目前开放的位置有:

  • 主面板服务图标栏
  • 聊天窗口工具栏
  • 迷你资料卡快捷按钮栏
  • 组织成员右键菜单

下面给出各个部位的示意图和说明:

主面板服务图标栏

主面板服务图标栏

可以在企业QQ主面板服务图标栏,添加合作开发商的服务入口图标,点击图标可以跳转到合作开发商的Web服务(可以校验跳转用户的身份,参考文档企业QQ带登录态跳转到第三方应用,如果有多个目标页面需要跳转的,可以使用下拉菜单的形式,下拉菜单可以N级菜单嵌套。点击菜单项,可以跳转到合作方Web服务入口,或者弹出客户端面板,内嵌合作方Web页面(一般建议轻量级的Web业务,如简单报表、简单表单等,可以使用内嵌窗口的形式,可以提升用户的体验)。

聊天窗口工具栏

聊天窗口工具栏

可以在聊天窗口工具栏,添加合作开发商的服务入口图标,点击图标可以跳转到合作开发商的Web服务,或者弹出下拉菜单,下拉菜单可以N级菜单嵌套。点击菜单项,可以跳转到合作方Web服务入口,或者弹出客户端面板,内嵌合作方Web页面。

一般,在两个员工号码对话聊天场景中发生的业务,建议在聊天窗口添加工具按钮,比如短信类、呼叫类、请求审批、任务下发等一对一场景的业务。

迷你资料卡快捷按钮栏

迷你资料卡快捷按钮栏

迷你资料卡快捷图标栏,添加合作开发商的服务入口图标,点击图标可以跳转到合作开发商的Web服务。

一般,建议一对一场景的业务,在此位置添加图标入口。一般场景是,从组织架构树中,直接找到某个同事,对其发起某个功能请求或业务,才需要在此位置加入按钮,在目前接入案例中看来,此种场景较少。

组织成员右键菜单

组织成员右键菜单栏

在主面板组织架构tab,组织成员的右键菜单上,可以添加合作开发商服务入口图标,可以设置多级菜单,点击菜单项,可以跳转到合作开发商的服务入口,或者打开客户端窗体,内嵌合作方Web页面。

该位置功能,跟迷你资料卡的业务场景类似。

接入说明

接入前提条件,首先要求申请接入者,已经调试完成了企业授权流程,并成功在应用管理界面开通了之前提交的App。

上图为接入流程的顺序图,本文档描述的功能,位于最右端上面的方块中的内容。申请此功能之前,应完成该功能左侧所有方块中的步骤。左侧步骤实现方法,参考文档

如您已经完成了上述步骤,请参阅企业QQ客户端视觉设计规范来准备好您申请加入的图标。

并如下表格,一并发给

申请的图标位置 图标名字 鼠标悬浮图标时的提示文案 returnurl 用途说明
主面板服务图标栏
聊天窗口工具栏
迷你资料卡快捷按钮栏
组织成员右键菜单

表格填写范例Example1:

申请的图标位置 图标名字 鼠标悬浮图标时的提示文案 returnurl 用途说明
主面板服务图标栏 卡尔OA 卡尔OA Dashboard index 企业内部OA系统入口
聊天窗口工具栏 发任务 点击发送任务给对方 mission 一对一聊天场景下功能
迷你资料卡快捷按钮栏 他的名片 点击展示二维码名片 card 对接内部系统,展示员工二维码
组织成员右键菜单 发邮件 点击发送邮件给他 email 从组织架构上直接给某个同事发邮件

表格填写范例Example2:

申请的图标位置 图标名字 鼠标悬浮图标时的提示文案 returnurl 用途说明
主面板服务图标栏 18_18.png 卡尔OA Dashboard //
主面板服务下拉框位置1 / 卡尔OA OA系统 1 企业内部OA系统入口
主面板服务下拉框位置2 / 卡尔OA 申请硬件 2 企业内部申请硬件入口
主面板服务下拉框位置3 / 卡尔OA 注册 3 企业内部注册入口
主面板服务下拉框位置4 / 卡尔OA 信息查看 4 企业内部信息查看入口

申请注意事项:

  1. 申请前提是,申请的App已经为已开启状态,否则直接拒绝;
  2. 主面板服务图标的位置,只能申请一个,多个入口的,都采用下拉菜单处理;
  3. 请按需申请,不要不分青红皂白地每个位置都申请,否则不会通过;
  4. 请按照企业QQ客户端视觉设计规范来准备图标;
  5. 请认真填写表格,不要胡乱拷贝上面的范例,胡乱拷贝不会通过;
  6. 用户点击客户端上的功能时候,会跳转到【开发者模式】的“单点登录跳转入口”字段填写的URL上;
  7. 用户点击跳转后,会携带参数(上表中returnurl的含义也参见后面的文档),参见文档用户点击客户端面板上第三方插入的按钮或者菜单项时,跳转携带参数说明
api/client.txt · 最后更改: 2016/04/22 16:55 (外部编辑)