Web自定义UI接入

基础组件库，对服务端API进行封装，提供智能客服基础服务，不包含界面，需要开发者自己实现UI界面，相对较轻量，适用于对UI有较高订制需求的开发者。

接入步骤:

1.获取AccessKey

完成机器人设置后，点击左侧菜单“接入管理”->“Web接入”进入Web接入页面会获取AccessKey, 作为SDK的初始化参数传入。

2.JS引入,初始化模块

在您要自定义机器人UI的页面插入以下代码:

<script type="text/javascript" src="https://bot.4paradigm.com/web/assets/ics-web-sdk.js"></script>
<script type="text/javascript">
    window.onload = function() {
        IcsWebSdk.init(AccessKey, userId, userData); 
        // Access Key为Web接入页面获取的值, userId您系统中的用户ID可选(用于打通系统间ID), userData为初始化参数
        // 调用的方法实现具体功能(具体参考方法调用部分)
    }
</script>

init方法

参数

userData

方法调用

获取提示信息

根据输入字符返回提示输入列表。

IcsWebSdk.similarQuestion(function(data){ // data为返回的提示信息文本列表
    // 自定义处理方式
})

转人工方法

IcsWebSdk.transferToHuman(function (msg) { // msg为转人工失败时的提示

})

msg返回格式

发送消息

发送文本消息

IcsWebSdk.sendText(str); // str为要发送的文本

发送菜单消息

发送选中的菜单项

IcsWebSdk.sendSelectRecommend(id, 'MENU'); // id 为选中菜单项的id

发送选中推荐问题

发送选中的推荐问题

IcsWebSdk.sendSelectRecommend(id, 'RECOMMEND', data); // id 为选中反馈问题项的id, data为选择的反馈问题的对象

发送选中的提示项

发送选中的提示项

IcsWebSdk.sendText(str); // str为选中的提示文本信息

监听处理机器人返回信息

IcsWebSdk.listFunction(function(data){ // data为机器人返回的信息
    // 自定义处理方式
};)

返回信息格式

文本

参数

例子:

{
    "answerContentType":"TEXT",
    "answer":"您好，有什么可以帮到您的？",
  }

菜单

参数

item参数

例子

{
    "answerType":"MENU",
    "answer":"菜单",
    "items":[
        {
            "id":"04937d9b-173d-4f4b-8ce0-fd3db88857e4",
            "content":"第四范式智能客服系统的优势是什么",
            "type":"TEXT"
        },
        {
            "id":"ac504c5c-e52c-43f8-99d4-daaa63264adc",
            "content":"第四范式的吉祥物是什么",
            "type":"IMAGE",
         },
        {
            "id":"7300f68f-1edd-4369-afd0-c5b802099504",
            "content":"第四范式智能客服系统是一个这样的产品",
            "type":"RICH_TEXT"
        },
        {
            "id":"2aa39ee9-7038-41db-8848-e426945d88c2",
            "content":"有哪些方法接入第四范式智能客服系统",
            "type":"MENU"
        }
    ]
}

图文

参数

data参数

例子:

{
    "answerContentType":"RICH_TEXT",
    "data": {
        "materialId":"a679cde4-0728-4bfb-90e7-0bc7f88d9cf0",
        "tenantId":91,
        "robotId":"ae5e71b3-71b7-47a6-92ed-68d96e734f4f",
        "materialTitle":"图文标题",
        "materialAuthor":"",
        "materialContent":"<p>图文内容</p>",
        "materialDigest":"图文摘要",
        "materialCover":"https://bot.4paradigm.com/v1/tesendSelectRecommendnants/91/robots/ae5e71b3-71b7-47a6-92ed-68d96e734f4f/public_material/file/IMAGE/6709ae90-8aea-4f23-bc10-f0f8951fc09a",
        "materialUrl":"https://bot.4paradigm.com/web/imagetext/91/ae5e71b3-71b7-47a6-92ed-68d96e734f4f/a679cde4-0728-4bfb-90e7-0bc7f88d9cf0",
        "createTime":1524543528000,
        "updateTime":1525838807000}
}

图片

参数

例子:

{
    "answerContentType":"IMAGE",
    "answer":"http://bot.4paradigm.com/v1/tenants/91/robots/ae5e71b3-71b7-47a6-92ed-68d96e734f4f/public_material/file/IMAGE/41698f22-13ab-4921-aab4-eb3af036d3c9"
}

语音

参数

例子:

{
    "answerContentType":"AUDIO",
    "answer":"http://bot.4paradigm.com/v1/tenants/91/robots/ae5e71b3-71b7-47a6-92ed-68d96e734f4f/public_material/file/AUDIO/012448f0-4b84-4fc4-a066-0f5bd3251631"
}

提示信息

当用户转人工成功是, 会返回提示信息

参数

推荐问题

当用户的输入比较模糊时, 会返回一个引导用户提问的问题列表。

参数

items参数

banner消息

一些状态转换的提醒, 如: 客服 某某某 正在为您服务

参数

获取历史消息

每次拉取一个会话在lastTime之前的消息

IcsWebSdk.getConversation(lastTime, function (msg) {

},)

传参

返回参数:

message参数

示例代码

下载接入示例代码