开放中心
提供大蚂蚁即时通讯的:产品文档、用户指南、管理员指南、开发者文档等。
免费试用

插件概述

即时通讯支持将第三方业务系统集成到即时通讯客户端中,以使让用户能快速打开应用,并支持单点登录,以免重复输入帐号。

插件类型

即时通讯支持在不同的位置嵌入插件,主要有:

  • [1] 启动插件: 在客户端启动时,自动启动插件
  • [2] 提醒插件:在人员信息下面,主要提示类的应用,如新的邮件
  • [3] 应用插件:在即时通讯面版的最下面,主要是快速打开第三方应用,如OA系统






插件目标类型

  • [1] 内置浏览器

    用内置的浏览器打开,并可以调置高宽

  • [2] 默认浏览器

    直接打开默认浏览器

地址变量说明

名称 备注
[webserver] 动态获取消息服务地址
在内外网情况下使用,如果WEB服务器与ANTSERVER服务器分开部署,有问题
[ssid] 企业ID
[uid] 当前登录的用户ID
[uname] 当前登录的用户姓名
[token] 令牌统一由web产生

插件管理相关页面

单点登录

即时通讯的客户端中打开你的应用程序,如OA等,可以通过token认证的方式做单点登录

第一步:注册一个应用

由于第三步验证中需要企业的应用ID,与应用密钥,所有的接入程序需要在MS管理台登记。

第二步:添加一个插件

由于第三步验证中需要ssid,uid,uname,token,所有插件的地址中必须包含变量 [ssid] [uid] [uname] [token]
示例插件地址:
http://192.168.0.2/oa/index.html?ssid=[ssid]&uid=[uid]&uname=[uname]&token=[token]
示例插件生成地址:
http://192.168.0.2/oa/index.html?ssid=5DA295C5-149B-3623-953D-BBBE129ABC43&uid=108&uname=金存&token=DB425ABD-E4D6-1EA2-B3AD-CA6775EB3F81

第三步:验证令牌

第三方程序获取根据参到到即时通讯服务端通过Rest接口验证token是否有效。

协议启动

应用于网页上打开即时通讯客户端

请求参数

名称 必选 类型及范围 说明
server true string 即时通讯服务器,没填为客户端默认的服务器地址(记住登录有效)
port true string 即时通讯服务器端口,没填为客户端默认的端口(记住登录有效)
ssname true string 企业的域名:如 aipu
loginname true string 登录的帐号
valid_type false int 0 明文密码; 1 MD5密码; -2 令牌验证
valid_code true string 验证码 密码/令牌
receiver false string 消息接收者,带域名 ,启动消息发送界面
receiver_type false int 1 单聊 2 群聊 3 语音 4 视频

启动客户端(账号密码)

imstart://login/?server=192.168.0.148&port=6661&ssname=std&loginname=yqb&valid_type=0&valid_code=123

启动客户端(token方式)

imstart://login/?server=192.168.0.148&port=6661&ssname=std&loginname=zar&valid_type=-2&valid_code=49B7D451-D069-70AA-1245-139EBB6D4856

启动单聊界面(账号密码)

imstart://sendmsg/?receiver=zcz&receiver_type=1&ssname=std&server=192.168.0.148&port=6661&loginname=lyy&valid_type=0&valid_code=123

启动单聊界面(token方式)

imstart://sendmsg/?receiver=zcz&receiver_type=1&ssname=std&server=192.168.0.148&port=6661&loginname=lyy&valid_type=-2&valid_code=2EF2A485-4E32-263B-B986-3EE677BF2592

客户端如何验证已经安装即时通讯客户端

如果客户端没有安装即时通讯客户端,那边协议启动,浏览器会提示地址不存在。所有我们可以在页面中加入检测客户端安装的判断。代码如下

js查看
                    
                    
                  

发送消息

即时通讯提供消息发送接口,第三方系统可将消息发送到即时通讯客户端,以便即时处理。如OA系统中的审批信息等

消息内容格式说明

content_type:支持Text/Text、Text/Btf

类型 效果图
Text/Text 文本消息

Text/Btf 自定义消息格式 <custom_data> <app_code></app_code> <app_name></app_name> <title>公告通知</title> <desc>于2月3日下午大会议室开会</desc> <icon>http://www.bigant.cn/img/qrcode.png</icon> <target>http://www.bigant.cn</target> <target_type>1</target_type> <ext></ext> </custom_data>
Text/Btf 应用消息格式 <app_data> <app_code></app_code> <app_name></app_name> <title>公告通知</title> <desc>于2月3日下午大会议室开会</desc> <icon>http://www.bigant.cn/img/qrcode.png</icon> <url>http://www.bigant.cn</url> <url_mobile>http://www.bigant.cn</url_mobile> <url_pc>http://www.bigant.cn</url_pc> <target_type>1</target_type> <ext></ext> </app_data>

系统集成常用场景案例

OA审批即时提醒

在以前的系统中,当有新的审批任务到达时,只有登录网页才能发现或需要电话通知审批者,与即时通讯集成后,通知可以在桌面或手机上立即收到。

开发步骤
  1. 注册应用
  2. 调用发送消息接口

用户单点登录

第三方应用系统(如OA系统...)通过大蚂蚁自动登录,无需输入密码,点击打开第三方应用系统。

开发步骤
  1. 注册应用
  2. 注册插件
  3. 调用令牌验证接口

网页调用即时聊天

在以前的系统中,当有新的审批任务到达时,只有登录网页才能发现或需要电话通知审批者,与即时通讯集成后,通知可以在桌面或手机上立即收到。

开发步骤
  1. 调用获取令牌接口
  2. 查看令牌启动的规则

协议启动令牌方式时序图

免费试用,体验更多大蚂蚁即时通讯产品功能

在线咨询
免费试用
联系电话

电话咨询

0571-28312298

回到顶部