INCESOFT机器人平台SDK程序员指南
INCESOFT机器人平台WEB机器人使用指南目录INCESOFT机器人平台WEB机器人使用指南目录1目录21获取帮助31.1客服支持31.2论坛支持32架构概览43关键特性53.1兼容MSN机器人SDK53.2支持头像、图释、闪屏等MSN特有特性53.3支持WEB机器人默认表现层配色方案的定制53.4支持WEB机器人表现层的自主开发53.5支持会话持有期间的主动下发消息53.6跨浏览器支持53.7国际化支持53.8消息内容支持UBB代码54实现流程64.1直接引用64.2嵌入引用64.3定制配色方案75表现层自主实现95.1Script API95.2最小实现116UBB语法说明131 获取帮助1.1 客服支持您可以通过联系我们的客服人员来获得直接的产品或技术支持客服电话86-21-52162122E-MAILxiaoisupportMSNxiaoisupportQQ/TM404539607联系地址中国上海市天山西路799号3楼邮政编码2003351.2 论坛支持您可以在我们开发者论坛的相应版块提出您的疑问，我们的相关人员会在短时间内对您的问题做出反馈。论坛地址：2 架构概览 Incesoft BOT Platform Servers Service ProviderRobot Servers(implements sdk) end userend userINCESOFT机器人平台的网络架构，如图所示，服务商、机器人平台、WEB服务器和WEB客户端之间的关系是比较简单的，服务商的Server通过与INCESOFT机器人平台的Server相连，为用户提供服务。而终端用户通过WEB浏览器，就能享受服务商提供的服务。服务提供商可以通过我们提供的SDK来开发自己的机器人服务器，当服务商用户流量过大时，可以将机器人服务器并行部署在多台机器上，由INCESOFT来保证负载均衡等网络集群问题（参见SDK开发指南）。WEB机器人的表现层既可以使用Incesoft的默认实现，也可以是SP自己的实现。3 关键特性3.1 兼容MSN机器人SDK使用Incesoft Botplatform SDK开发的MSN机器人服务器仍然适用于WEB机器人。在Incesoft Botplatform上的配置（）仍然生效于WEB机器人。当然，由于WEB机器人和MSN机器人在表现上有不同之处，若需要开发特色的WEB机器人需要定制开发。3.2 支持头像、图释、闪屏等MSN特有特性3.3 支持WEB机器人默认表现层配色方案的定制参见 4.3 定制配色方案3.4 支持WEB机器人表现层的自主开发参见 5 表现层自主开发3.5 支持会话持有期间的主动下发消息3.6 跨浏览器支持IE 5.5 以上,，Firefox 1.0以上，Opera7.0以上3.7 国际化支持表现层默认实现支持语言： zh_CN、en_US 3.8 消息内容支持UBB代码参见 6 UBB语法说明4 实现流程4.1 直接引用引用地址：:8100/engine/SPID/webbot.htm引用地址中 SPID为用户在Incesoft申请的服务提供商标识方式一：SP可通过链接引导用户直接访问此页面 <a href=” :8100/engine/SPID/webbot.htm”></a>方式二：SP可通过iframe嵌入自己页面<iframe src=” :8100/engine/SPID/webbot.htm”></iframe>方式三：SP可通过弹出窗口形式展现window.open(“:8100/engine/SPID/webbot.htm”);4.2 嵌入引用引用地址：:8100/engine/SPID/embedbot.js引用地址中 SPID为用户在Incesoft申请的服务提供商标识SP可以将此js远程包含进自己页面的body部分，webbot就会浮动于页面上。<html><head></head><body>.<script type=”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?body_color=FCF5F8&panel_color=FAEBF1&line_color=A04F6B5 表现层自主实现若SP对默认的表现层实现不满意，可以自主开发表现层，以配合自己的网页。自定义开发表现层需要通过javascript远程引入开发接口。接口地址：:8100/engine/SPID/webbot.js引入方式：<script type=”text/javascript” src=” :8100/engine/SPID/webbot.js”></script>5.1 Script API对象 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<html><head><script src=":8100/engine/SPID/webbot.js"></script><script language="javascript" type="text/javascript">var conversation = new Conversation();function SendMessage() var inputBox = document.getElementById("inputBox");conversation.SendMessage(inputBox.value);inputBox.value = ""</script></head><body><table><tr><td colspan="2"><iframe width="100%" height="100%" src="transcript.htm"></iframe></td></tr><tr><td width="100%"><input id="inputBox" type="text" style="width:100%"></td><td><input type="button" value="Send" onclick="SendMessage()"></td></tr></table></body></html>WEB机器人显示消息页面：transcript.htm<html><head><script language="javascript" type="text/javascript">function OnLoad()var conv = window.parent.conversation;conv.InitializeTranscriptDiv(document.getElementById("transcriptDiv");</script><style>.messageTextcolor: #525552;font-size:12px;</style></head><body onload="OnLoad();"><div id="transcriptDiv"></div></body></html>6 UBB语法说明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=Botplatform SP HOME/URL：有两种方法可以加入超级连接，可以连接具体地址或者文字连接。 EMAILwebmaster/EMAIL EMAIL=webmasterincesoft/EMAIL：有两种方法可以加入邮件连接，可以连接具体地址或者文字连接。 IMGimages/logo.gif/IMG ：在标签的中间插入图片地址可以实现插图效果。 QUOTE引用/QUOTE：在标签的中间插入文字可以实现HTML中引用文字效果。
个人主页