INCESOFT机器人平台SDK程序员指南.doc

INCESOFT 机器人平台机器人平台 WEB 机器人使用指南机器人使用指南 目录目录 INCESOFT 机器人平台机器人平台 WEB 机器人使用指南目录机器人使用指南目录 1 目录目录 2 1获取帮助获取帮助 3 1 1客服支持 3 1 2论坛支持 3 2架构概览架构概览 4 3关键特性关键特性 5 3 1兼容 MSN 机器人 SDK 5 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 1SCRIPT API 9 5 2最小实现 11 6UBB 语法说明语法说明 13 1获取帮助获取帮助 1 1客服支持客服支持 您可以通过联系我们的客服人员来获得直接的产品或技术支持 客服电话 86 21 52162122 E MAILxiaoisupport MSNxiaoisupport QQ TM404539607 联系地址中国上海市天山西路 799 号 3 楼 邮政编码 200335 1 21 2论坛支持论坛支持 您可以在我们开发者论坛的相应版块提出您的疑问 我们的相关人员会在短时间内对 您的问题做出反馈 论坛地址 2架构概览架构概览 INCESOFT 机器人平台的网络架构 如图 所示 服务商 机器人平台 WEB 服务器 和 WEB 客户端之间的关系是比较简单的 服务商的 Server 通过与 INCESOFT 机器人平台 的 Server 相连 为用户提供服务 而终端用户通过 WEB 浏览器 就能享受服务商提供的 服务 服务提供商可以通过我们提供的 SDK 来开发自己的机器人服务器 当服务商用户流量 过大时 可以将机器人服务器并行部署在多台机器上 由 INCESOFT 来保证负载均衡等网络 集群问题 参见 SDK 开发指南 WEB 机器人的表现层既可以使用 Incesoft 的默认实现 也可以是 SP 自己的实现 Incesoft BOT Platform Servers Service Provider Robot Servers implements sdk end user SP WEB Server Incesoft WEB Server Represent Layer end user 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 可通过链接引导用户直接访问此页面 方式二 SP 可通过 iframe 嵌入自己页面 方式三 SP 可通过弹出窗口形式展现 window open 8100 engine SPID webbot htm 4 2嵌入引用嵌入引用 引用地址 8100 engine SPID embedbot js 引用地址中 SPID 为用户在 Incesoft 申请的服务提供商标识 SP 可以将此 js 远程包含进自己页面的 body 部分 webbot 就会浮动于页面上 4 3定制配色方案定制配色方案 在引用 webbot 的地址时 SP 可以将配色方案通过 url 参数的形式传给 webbot 参数 panel color 面板颜色 line color 线条和字体颜色 body color 背景颜色 参数值为 16 进制颜色值 为 6 字符长 比如 红色 FF0000 蓝色 0000FF 例 8100 engine SPID webbot htm body color FCF5F8 function SendMessage var inputBox document getElementById inputBox conversation SendMessage inputBox value inputBox value WEB 机器人显示消息页面 机器人显示消息页面 transcript htm function OnLoad var conv window parent conversation conv InitializeTranscriptDiv document getElementById transcriptDiv messageText color 525552 font size 12px 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 Botplatform SP HOME URL 有两种方法可以加入超级连接 可以连接具体地址或者文字连接 EMAIL we