INCESOFT机器人平台WEB机器人使用指南文档格式.docx
《INCESOFT机器人平台WEB机器人使用指南文档格式.docx》由会员分享，可在线阅读，更多相关《INCESOFT机器人平台WEB机器人使用指南文档格式.docx（15页珍藏版）》请在冰豆网上搜索。
客服电话
86-21-52162122
E-MAIL
xiaoisupport@
MSN
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可通过链接引导用户直接访问此页面
<
ahref=”:
8100/engine/{SPID}/webbot.htm”>
<
/a>
方式二：
SP可通过iframe嵌入自己页面
iframesrc=”:
/iframe>
方式三：
SP可通过弹出窗口形式展现
window.open（“:
8100/engine/{SPID}/webbot.htm”）;
4.2嵌入引用
8100/engine/{SPID}/embedbot.js
SP可以将此js远程包含进自己页面的body部分，webbot就会浮动于页面上。
html>
head>
…<
/head>
body>
…...
……
scripttype=”text/javascript”src=”:
8100/engine/{SPID}/embedbot.js”>
/script>
/body>
/html>
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?
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）
IsBold（）
若字体样式为粗体返回true，否则返回false。
IsItalic（）
IsStrikethrough（）
IsUnderline（）
若字体样式为粗体返回true，否则返回false。
ApplyStyle（obj）
该方法将对象现有属性应用于html的元素。
参数obj为html元素引用。
该方法无返回值。
5.2最小实现
WEB机器人主页面：
webbot.htm
<
scriptsrc="
8100/engine/{SPID}/webbot.js"
>
scriptlanguage="
javascript"
type="
text/javascript"
varconversation=newConversation（）;
functionSendMessage（）{
varinputBox=document.getElementById（"
inputBox"
）;
conversation.SendMessage（inputBox.value）;
inputBox.value="
"
;
}
table>
tr>
tdcolspan="
2"
<
iframewidth="
100%"
height="
src="
transcript.htm"
/td>
/tr>
tdwidth="
inputid="
text"
style="
width:
td>
inputtype="
button"
value="
Send"
onclick="
SendMessage（）"
/table>
WEB机器人显示消息页面：
transcript.htm
functionOnLoad（）
{
varconv=window.parent.conversation;
conv.InitializeTranscriptDiv（document.getElementById（"
transcriptDiv"
））;
}
style>
.messageText
{
color:
#525552;
font-size:
12px;
/style>
bodyonload="
OnLoad（）;
divid="
/div>
6UBB语法说明
[B]文字[/B]：
在文字的位置可以任意加入您需要的字符，显示为粗体效果。
[I]文字[/I]：
在文字的位置可以任意加入您需要的字符，显示为斜体效果。
[U]文字[/U]：
在文字的位置可以任意加入您需要的字符，显示为下划线效果。
[ALIGN=center]文字[/ALIGN]：
在文字的位置可以任意加入您需要的字符，center位置center表示居中，left表示居左，right表示居右。
[COLOR=颜色代码]文字[/COLOR]：
输入您的颜色代码，在标签的中间插入文字可以实现文字颜色改变。
[SIZE=数字]文字[/SIZE]：
输入您的字体大小，在标签的中间插入文字可以实现文字大小改变。
[FACE=字体]文字[/FACE]：
输入您需要的字体，在标签的中间插入文字可以实现文字字体转换。
[FLY]飞翔的文字[/FLY]：
在标签的中间插入文字可以实现文字飞翔效果，类似跑马灯。
[MOVE]移动的文字[/MOVE]：
在标签的中间插入文字可以实现文字移动效果，为来回飘动。
[GLOW=255,red,2]文字[/GLOW]：
在标签的中间插入文字可以实现文字发光特效，glow内属性依次为宽度、颜色和边界大小。
[SHADOW=255,red,2]文字[/SHADOW]：
在标签的中间插入文字可以实现文字阴影特效，shadow内属性依次为宽度、颜色和边界大小。
[URL][/URL]
[URL=]BotplatformSPHOME[/URL]：
有两种方法可以加入超级连接，可以连接具体地址或者文字连接。
[EMAIL]webmaster@[/EMAIL]
[EMAIL=webmaster@]incesoft[/EMAIL]：
有两种方法可以加入邮件连接，可以连接具体地址或者文字连接。
[IMG]images/logo.gif[/IMG]：
在标签的中间插入图片地址可以实现插图效果。
[QUOTE]引用[/QUOTE]：
在标签的中间插入文字可以实现HTML中引用文字效果。
升级会员 