INCESOFT机器人平台WEB机器人使用指南.docx

INCESOFT机器人平台WEB机器人使用指南.docx

《INCESOFT机器人平台WEB机器人使用指南.docx》由会员分享，可在线阅读，更多相关《INCESOFT机器人平台WEB机器人使用指南.docx（15页珍藏版）》请在冰豆网上搜索。

INCESOFT机器人平台WEB机器人使用指南

INCESOFT机器人平台WEB机器人使用指南

目录

INCESOFT机器人平台WEB机器人使用指南目录1

目录2

1获取帮助3

1.1客服支持3

1.2论坛支持3

2架构概览4

3关键特性5

3.1兼容MSN机器人SDK5

3.2支持头像、图释、闪屏等MSN特有特性5

3.3支持WEB机器人默认表现层配色方案的定制5

3.4支持WEB机器人表现层的自主开发5

3.5支持会话持有期间的主动下发消息5

3.6跨浏览器支持5

3.7国际化支持5

3.8消息内容支持UBB代码5

4实现流程6

4.1直接引用6

4.2嵌入引用6

4.3定制配色方案7

5表现层自主实现9

5.1ScriptAPI9

5.2最小实现11

6UBB语法说明13

1获取帮助

1.1客服支持

您可以通过联系我们的客服人员来获得直接的产品或技术支持

客服电话

86-21-52162122

E-MAIL

xiaoisupport@

MSN

xiaoisupport@

QQ/TM

404539607

联系地址

中国上海市天山西路799号3楼

邮政编码

200335

1.2论坛支持

您可以在我们开发者论坛的相应版块提出您的疑问，我们的相关人员会在短时间内对您的问题做出反馈。

论坛地址：

2架构概览

IncesoftBOTPlatformServers

ServiceProvider

RobotServers

（implementssdk）

INCESOFT机器人平台的网络架构，如图１所示，服务商、机器人平台、WEB服务器和WEB客户端之间的关系是比较简单的，服务商的Server通过与INCESOFT机器人平台的Server相连，为用户提供服务。

而终端用户通过WEB浏览器，就能享受服务商提供的服务。

服务提供商可以通过我们提供的SDK来开发自己的机器人服务器，当服务商用户流量过大时，可以将机器人服务器并行部署在多台机器上，由INCESOFT来保证负载均衡等网络集群问题（参见SDK开发指南）。

WEB机器人的表现层既可以使用Incesoft的默认实现，也可以是SP自己的实现。

3关键特性

3.1兼容MSN机器人SDK

使用IncesoftBotplatformSDK开发的MSN机器人服务器仍然适用于WEB机器人。

在IncesoftBotplatform上的配置（）仍然生效于WEB机器人。

当然，由于WEB机器人和MSN机器人在表现上有不同之处，若需要开发特色的WEB机器人需要定制开发。

3.2支持头像、图释、闪屏等MSN特有特性

3.3支持WEB机器人默认表现层配色方案的定制

参见4.3定制配色方案

3.4支持WEB机器人表现层的自主开发

参见5表现层自主开发

3.5支持会话持有期间的主动下发消息

3.6跨浏览器支持

IE5.5以上,，Firefox1.0以上，Opera7.0以上

3.7国际化支持

表现层默认实现支持语言：

zh_CN、en_US…

3.8消息内容支持UBB代码

参见6UBB语法说明

4实现流程

4.1直接引用

引用地址：

:

8100/engine/{SPID}/webbot.htm

引用地址中{SPID}为用户在Incesoft申请的服务提供商标识

方式一：

SP可通过链接引导用户直接访问此页面

8100/engine/{SPID}/webbot.htm”>

方式二：

SP可通过iframe嵌入自己页面

8100/engine/{SPID}/webbot.htm”>

方式三：

SP可通过弹出窗口形式展现

window.open（“:

8100/engine/{SPID}/webbot.htm”）;

4.2嵌入引用

引用地址：

:

8100/engine/{SPID}/embedbot.js

引用地址中{SPID}为用户在Incesoft申请的服务提供商标识

SP可以将此js远程包含进自己页面的body部分，webbot就会浮动于页面上。

…

…...

……

8100/engine/{SPID}/embedbot.js”>

4.3定制配色方案

在引用webbot的地址时，SP可以将配色方案通过url参数的形式传给webbot。

参数：

panel_color------面板颜色

line_color--------线条和字体颜色

body_color------背景颜色

参数值为16进制颜色值，为6字符长，比如红色：

FF0000，蓝色：

0000FF

例：

:

8100/engine/{SPID}/webbot.htm?

body_color=FCF5F8&panel_color=FAEBF1&line_color=A04F6B

:

8100/engine/{SPID}/embedbot.js?

body_color=FCF5F8&panel_color=FAEBF1&line_color=A04F6B

5表现层自主实现

若SP对默认的表现层实现不满意，可以自主开发表现层，以配合自己的网页。

自定义开发表现层需要通过javascript远程引入开发接口。

接口地址：

:

8100/engine/{SPID}/webbot.js

引入方式：

8100/engine/{SPID}/webbot.js”>

5.1ScriptAPI

对象Conversation：

此对象包装了web机器人的所有操作。

此对象必须在自主开发的机器人页面的顶层实例化，且仅能实例化一次。

方法:

InitializeTranscriptDiv（transcriptDiv）

此方法初始化聊天消息显示区块。

此区块中将用来显示由SDK下发的机器人消息。

开发规定此区块必须存在于web机器人的某个iframe页面。

方法:

InitializeDisplayPictureDiv（dpDiv）

此方法初始化头像显示区块。

若SP无显示头像需求，可不初始化。

方法:

InitializeDisplayNameDiv（dpDiv）

此方法初始化友好名称显示区块。

若SP无显示友好名称需求，可不初始化。

方法:

InitializePersonalMessageDiv（dpDiv）

此方法初始化个人消息显示区块。

若SP无显示个人消息需求，可不初始化。

方法:

SetFont（fontName）

设置用户发消息的字体名称。

方法:

SetColor（color）

设置用户发消息的字体颜色。

方法:

SetSize（size）

设置用户发消息的字体大小。

方法:

ToggleStyle（styleCode）

修改用户发消息的字体样式,参数styleCode为“B”、”I”、”U”或”S”，分别代表粗体、斜体、下划线和删除线。

若styleCode和消息字体原有样式一样返回false，否则返回true。

方法:

SetDisplayName（name）

设置用户发消息的显示名称（preface），相当于SDK中的setSignature。

方法:

SendMessage（msg）

发送消息。

方法:

SendNudge（color）

发送闪屏震动。

方法：

GetFormat（）

返回当前用户的消息格式，参见MessageFormat对象说明。

对象MessageFormat:

此对象包装了用户发送消息的格式。

一般无须开发者实例化，而是通过Conversation对象的GetFormat方法获取。

属性：

font

字体名称

属性：

size

字体大小

属性：

styleCode

字体样式---为“B”、”I”、”U”、”S”的组合

属性：

color

字体颜色

方法：

ToggleStyle（styleCode）

修改用户发消息的字体样式,参数styleCode为“B”、”I”、”U”或”S”，分别代表粗体、斜体、下划线和删除线。

若styleCode和消息字体原有样式一样返回false，否则返回true。

方法：

IsBold（）

若字体样式为粗体返回true，否则返回false。

方法：

IsItalic（）

若字体样式为粗体返回true，否则返回false。

方法：

IsStrikethrough（）

若字体样式为粗体返回true，否则返回false。

方法：

IsUnderline（）

若字体样式为粗体返回true，否则返回false。

方法：

ApplyStyle（obj）

该方法将对象现有属性应用于html的元素。

参数obj为html元素引用。

该方法无返回值。

5.2最小实现

WEB机器人主页面：

webbot.htm

8100/engine/{SPID}/webbot.js">

varconversation=newConversation（）;

functionSendMessage（）{

varinputBox=document.getElementById（"inputBox"）;

conversation.SendMessage（inputBox.value）;

inputBox.value="";

}

100%">

WEB机器人显示消息页面：

transcript.htm

functionOnLoad（）

{

varconv=window.parent.conversation;

conv.InitializeTranscriptDiv（document.getElementById（"transcriptDiv"））;

}