机器人会话接口

初始化会话

请求地址

请求参数

Request fields

Path Type Optional Description
robotId Integer false 机器人id:此次会话对应的机器人的标识id.
channelId Integer false 场景id:此次会话对应的场景标识id.
modelKey String true 常见问题模板ID,在’km-机器人-知识库管理-推荐-ID’查看.
accessKeyId String true 对接设置的应用的应用ID,对应获取应用的appID字段,在’km-管理-应用管理-应用ID’查看.
platform Integer true 渠道PLATFORM_WEB(0),PLATFORM_WEB(1),PLATFORM_WEB(2),PLATFORM_WEB(3),PLATFORM_WEB(4),PLATFORM_WEB(5),PLATFORM_WEB(6),PLATFORM_WEB(7),PLATFORM_WEB(8)
customer Map true 客户信息.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Object true

data

Path Type Optional Description
sessionId Integer true 会话id.
logId Integer true 机器人返回的id.
welcomeMessage String true 欢迎语.
leadingWord String true 引导语.
commonQuestionModel Object true 常见问题.

commonQuestionModel

Path Type Optional Description
id Integer true id.
robotId Integer true 机器人id.
name String true 模板名称.
channelId Integer true 场景id.
description String true 描述.
modelKey String true modelKey.
commonQuestionCategoryList Array true 常见问题分类(里面包含分类下常见问题列表).

commonQuestionCategoryList

Path Type Optional Description
id Integer true id.
modelId Integer true 常见问题模板id.
name String true 目录名.
sorts Integer true 预留排序字段.
questionList Array true 分类下常见问题列表.

questionList

Path Type Optional Description
id Integer true 问题的标识id.
content String true 问题的内容.
type Integer true 类型 1:普通问题 4:闲聊问题.
answer Object true 答案.
answer.content String true
answer.type Integer true
answer.id Integer true

示例

$ curl 'https://km.udesk.cn/api/v1/initClient?email=admin@udesk.cn&timestamp=1529402445&sign=fbe02e2b9f76179da49ea619cbabdde909b73a2f' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "robotId" : 103,
  "channelId" : 106,
  "modelKey" : "0",
  "accessKeyId" : "/+7772AKE6kv8AVNjWqP",
  "platform" : 5,
  "customer" : null
}'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "sessionId": 451724,
        "logId": 793020,
        "welcomeMessage": "你好,很高兴为您服务!",
        "leadingWord": "常见问题",
        "commonQuestionList": [],
        "commonQuestionModel": {
            "id": 108,
            "name": "默认常见问题",
            "description": "常见问题",
            "commonQuestionCategoryList": [
                {
                    "id": 76,
                    "modelId": 108,
                    "name": "111",
                    "questionList": [
                        {
                            "id": 8645,
                            "content": "社保怎么办理主引导选择啊",
                            "type": 1,
                            "answer": {
                                "content": "<p>打电话12345</p>",
                                "type": 2,
                                "id": 4436
                            }
                        },
                        {
                            "id": 8647,
                            "content": "社保如何办理",
                            "type": 1,
                            "answer": {
                                "content": "<p>网上查询</p>",
                                "type": 2,
                                "id": 4437
                            }
                        }
                    ]
                }
            ]
        }
    },
    "extra": null
}

点击流程接口

请求地址

请求参数

Request fields

Path Type Optional Description
sessionId Integer false 会话id:此次会话的标识id,在初始化会话(/api/initClient)返回时获取.
logId Integer true 流程点击所在的log的标识id,在机器人返回时提供.
flowId Integer true 流程标识id,在机器人返回流程内容(flowContent)中提供.
flowContent String true 流程具体内容.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Object true
data.sessionId Integer true 会话id.
data.logId Integer true 机器人返回的log的标识id.
data.flowId Integer true 流程id,返回流程时有效.
data.flowTitle String true 流程标题,返回流程时有效.
data.flowContent String true 流程内容,返回流程时有效.内容中只有带有data-type和data-id属性的html元素是可点击的,并且所有的data-*属性的值都是String类型的

示例

$ curl 'https://km.udesk.cn/api/v1/flow?email=admin@udesk.cn&timestamp=1529402444&sign=17dfc106671e1cd2442ba6e61c778aac86bb3035' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 450285,
  "logId" : 785709,
  "flowId" : 42,
  "flowContent" : "<p>11111</p><p>22222</p><p>33333</p>"
}'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "sessionId": 28905,
        "logId": 793020,
        "flowId": 285,
        "flowTitle": "流程问题",
        "flowContent": "<p>1111</p>"
    }
}

点击问题行为接口

请求地址

请求参数

Request fields

Path Type Optional Description
sessionId Integer false 此次会话的标识id.
queryType Integer true 用户点击类型 枚举 6:常见问题点击 7:建议问题点击 8:流程中的问题点击 9:智能提示点击.
logId Integer true 用户点击行为所在log的标识id(当queryType为9时,该字段不填).
questionId Integer true 问题id(点击问题的id).
questionContent String true 问题内容(点击问题的内容).
contentType String true 枚举:text ,rich 如果是text,会把ansContent富文本转换成普通文本

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Object true
data.sessionId Integer true 会话id.
data.logId Integer true 机器人返回的log的标识id.
data.ansContent Var true 返回对应的答案的内容.
data.ansType Integer true
data.flowId Integer true 流程id,返回流程时有效.
data.flowTitle String true 流程标题,返回流程时有效.
data.flowContent String true 流程内容,返回流程时有效.内容中只有带有data-type和data-id属性的html元素是可点击的,并且所有的data-*属性的值都是String类型的
data.hitQuestion String true 返回召回的问题,.
data.msgType String true 答案的文本类型.
data.switchStaffType Integer true 1.微信渠道显示引导语 2.满足条件转人工.
data.switchStaffTips String true 转人工提示.
data.suggestQuestionList Array true 建议列表.
data.suggestQuestionList[].id Integer true 问题的标识id.
data.suggestQuestionList[].content String true 问题的内容.
data.suggestQuestionList[].type Integer true
data.suggestQuestionList[].answer Object true 答案.
data.suggestQuestionList[].answer.content String true
data.suggestQuestionList[].answer.type Integer true
data.suggestQuestionList[].answer.questionId Integer true
data.suggestQuestionList[].answer.id Integer true
data.restrictionState Object true 交互量限制状态.
data.restrictionState.exceededFlag Integer true
data.restrictionState.usedCount Integer true
data.restrictionState.totalCount Integer true
data.aid Integer true 返回对应的答案的id.

示例

$ curl 'https://km.udesk.cn/api/v1/hit?email=admin@udesk.cn&timestamp=1529402439&sign=2c8f96911159fae72a493365a9692ce66c5c2b5d' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 450283,
  "queryType" : 7,
  "logId" : 785703,
  "questionId" : 232,
  "questionContent" : "谁的风扇"
}'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "sessionId": 451727,
        "logId": 793031,
        "ansContent": "<p>不和平</p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>",
        "attachmentList": [],
        "suggestQuestionList": [
            {
                "id": 8657,
                "content": "世界哪里和平了",
                "type": 1,
                "answer": {
                    "content": "<p>没有</p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>",
                    "type": 2,
                    "id": 4442,
                    "deleteFlag": 0
                }
            },
            {
                "id": 9259,
                "content": "你想去哪儿",
                "type": 1,
                "answer": {
                    "content": "<p>北海</p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>",
                    "type": 2,
                    "id": 5009,
                    "deleteFlag": 0
                }
            }
        ],
        "aid": 4441
    },
    "extra": null
}

获取会话窗口-常见问题列表

请求地址

请求参数

Request fields

Path Type Optional Description
robotId Integer false 机器人id.
channelId Integer false 场景ID.
modelKey String false 常见问题ID.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Array true
data[].id Integer true 分类id.
data[].modelId Integer true 常见问题模板id.
data[].name String true 分类名称.
data[].questionList Array true 分类下常见问题列表.
data[].questionList[].id Integer true 问题的标识id.
data[].questionList[].content String true 问题的内容.
data[].questionList[].type Integer true 类型 1:普通问题 4:闲聊问题.
data[].questionList[].answer Object true 答案.
data[].questionList[].answer.content String true 答案内容
data[].questionList[].answer.type Integer true 答案类型
data[].questionList[].answer.id Integer true 答案ID

示例

$ curl 'https://km.udesk.cn/api/v1/chat/commonQuestions?email=admin@udesk.cn&timestamp=1529569037&sign=4bc33f53e473d6db70e900fb07b947a9ee18f905' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "robotId" : 112,
  "channelId" : 118,
  "modelKey" : "aaa"
}'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": {
        "pageNum": 1,
        "pageSize": 1,
        "total": 1
    },
    "data": [
        {
            "id": 76,
            "modelId": 108,
            "name": "111",
            "questionList": [
                {
                    "id": 8645,
                    "content": "社保怎么办理主引导选择啊",
                    "type": 1,
                    "answer": {
                        "content": "<p>打电话12345</p>",
                        "type": 2,
                        "id": 4436
                    }
                },
                {
                    "id": 8647,
                    "content": "社保如何办理",
                    "type": 1,
                    "answer": {
                        "content": "<p>网上查询</p>",
                        "type": 2,
                        "id": 4437
                    }
                }
            ]
        }
    ],
    "extra": null
}

获取会话窗口-热点问题列表

请求地址

请求参数

Request fields

Path Type Optional Description
limitDayNum Integer false 最近多少天(不超过100).
limitResultNum Integer false 最多返回多少记录(不超过50).
robotId Integer false 机器人ID

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Array true 问题列表
data[].id Integer true 问题的标识id.
data[].content String true 问题的内容.
data[].type Integer true
data[].answer Object true 答案.
data[].answer.content String true 答案内容
data[].answer.type Integer true
data[].answer.id Integer true 答案ID
data[].matchCount Integer true 匹配数量.

示例

$ curl 'https://km.udesk.cn/api/v1/chat/hotQuestions?email=admin@udesk.cn&timestamp=1529569036&sign=27bfe3f1ece19e13b03ff669d30830322ae4cfa3' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "limitDayNum" : 100,
  "limitResultNum" : 2,
  "robotId" : 83
}'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": {
        "pageNum": 1,
        "pageSize": 2,
        "total": 2
    },
    "data": [
        {
            "id": 844,
            "content": "你是谁?",
            "type": 1,
            "answer": {
                "content": "我是robot机器人啊",
                "type": 2,
                "id": 552
            },
            "matchCount": 24
        },
        {
            "id": 9426,
            "content": "谁的范德萨分",
            "type": 3,
            "answer": {
                "content": "123",
                "type": 1,
                "id": 5124
            },
            "matchCount": 13
        }
    ],
    "extra": null
}

评价机器人返回的答案

请求地址

请求参数

Request fields

Path Type Optional Description
sessionId Integer false 会话Id.
questionSurveyOptionId Integer false 评价选项 1:满意 2:不满意.
logId Integer true 被评价答案所在记录的Id,在机器人返回中获取.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Object true
data.switchStaffType Integer true 1.微信渠道显示引导语 2.满足条件转人工.
data.switchStaffTips String true 转人工提示.

示例

$ curl 'https://km.udesk.cn/api/v1/surveyQuestion?email=admin%40udesk.cn&timestamp=1529402453&sign=de8f53541749eb530fc006941d6af1af4e917067' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 450289,
  "questionSurveyOptionId" : 1,
  "logId" : 785716
}'
返回
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : null
}

评价当次会话

请求地址

请求参数

Request fields

Path Type Optional Description
sessionId Integer false 会话id.
sessionSurveyOptionId Integer true 评价选项 1:未评价 2:满意 3:一般 4:不满意.
surveyContent String true 评价内容.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Object true
data.switchStaffType Integer true 1.微信渠道显示引导语 2.满足条件转人工.
data.switchStaffTips String true 转人工提示.

示例

$ curl 'https://km.udesk.cn/api/v1/surveySession?email=admin@udesk.cn&timestamp=1529402455&sign=d4be213127c62bb5b53dea5f5e52eaad06b2362f' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 450290,
  "sessionSurveyOptionId" : 4,
  "surveyContent" : "hehe"
}'
返回
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : null
}

普通对话

请求地址

请求参数

Request fields

Path Type Optional Description
sessionId Integer false 会话id:此次会话的标识id,在初始化会话(/api/initClient)时获取.
robotId Integer false 机器人id:此次会话对应的机器人标识id.
queryContent String false 用户问话内容.
channel_id Integer true 知识库场景ID
weixin_openid String true
contentType String true 文本类型 如果值为"text",会把ansContent富文本转换成普通文本
chatMode Integer true 会话模式 1.智能模式 2.任务式会话 3.FAQ 4.资料库

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Object true
data.sessionId Integer true 会话id.
data.logId Integer true 机器人返回的log的标识id.
data.ansContent Var true 返回对应的答案的内容.
data.ansType Integer true 返回答案类型
data.flowId Integer true 流程id,返回流程时有效.
data.flowTitle String true 流程标题,返回流程时有效.
data.flowContent String true 流程内容,返回流程时有效.
data.hitQuestion String true 返回召回的问题,.
data.msgType String true 答案的文本类型.
data.switchStaffType Integer true 1.微信渠道显示引导语 2.满足条件转人工.
data.switchStaffTips String true 转人工提示.
data.suggestQuestionList Array true 建议列表.
data.suggestQuestionList[].id Integer true 问题的标识id.
data.suggestQuestionList[].content String true 问题的内容.
data.suggestQuestionList[].type Integer true 问题类型
data.suggestQuestionList[].answer Object true 答案.
data.suggestQuestionList[].answer.content String true
data.suggestQuestionList[].answer.type Integer true
data.suggestQuestionList[].answer.questionId Integer true
data.suggestQuestionList[].answer.id Integer true
data.restrictionState Object true 交互量限制状态.
data.restrictionState.exceededFlag Integer true
data.restrictionState.usedCount Integer true
data.restrictionState.totalCount Integer true
data.aid Integer true 返回对应的答案的id.
data.taskChatReturnCommands Array true 任务式对话返回指令集.
data.attachmentList Array true FAQ问题的附件列表.
data.attachmentList[].name String true 附件名称
data.attachmentList[].address String true 附件地址
data.attachmentList[].size Integer true 附件大小

data.msgType对应的data.ansContent结构

枚举值 说明 结构 哪些模式会返回
plain 普通文本 String 智能模式、FAQ、任务式会话、资料库
rich 富文本 带标签的String 智能模式、FAQ、任务式会话、资料库
selective_table 选择表格 ans_selective_table 智能模式、任务式会话
selective_list 选择列表 ans_selective_list 智能模式、任务式会话
show_product 展示商品 ans_show_product 智能模式、任务式会话
selective_product 选择商品 ans_show_product 智能模式、任务式会话
wechat_image 微信图文消息 ans_wechat_image 智能模式、FAQ
audio 语音 String 语音的播放链接地址 智能模式、FAQ
link 链接 ans_link 智能模式、FAQ
image 图片 String 图片的链接地址 智能模式、FAQ

ans_selective_table

Path Type Optional Description
title String true 标题
rowNumber Integer true 行数
columnNumber Integer true 列数
optionList Array true 表格内容
optionList[].id Integer true
optionList[].value String true

ans_selective_list

Path Type Optional Description
title String true 标题
optionList Array true 列表内容
optionList[].id Integer true
optionList[].value String true

ans_show_product

Path Type Optional Description
title String true 标题
showSize Integer true 默认展示数量
turnFlag Integer true turnFlag(0或者1)
productList Array true 表格内容
productList[].id Integer true
productList[].name String true 商品名称
productList[].image String true 商品图片
productList[].url String true 商品链接
productList[].infoList Array true 商品信息
productList[].infoList[].info String true 文本
productList[].infoList[].boldFlag Integer true 加粗标识(0或者1)
productList[].infoList[].color String true 颜色

ans_wechat_image

Path Type Optional Description
content String true 标准问题内容
coverUrl String true 封面图片路径
description String true 描述
answerUrl String true 答案路径
Path Type Optional Description
faviconUrl String true 头图的地址,
title String true 网站标题
answerUrl String true 答案本身配置的地址

示例

$ curl 'https://km.udesk.cn/api/v1/chat?email=admin@udesk.cn&timestamp=1529402441&sign=08bea0badd00d36c432320fc3760fc419154b40d' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 451714,
  "robotId" : 54,
  "queryContent" : "手机的价格",
  "contentType" : null,
  "chatMode" : null,
  "channel_id" : null,
  "weixin_openid" : null
}'
返回
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "sessionId" : 451714,
    "logId" : 793005,
    "ansContent" : "您的问题我会继续努力学习,期待下次为您更好的服务",
    "ansType" : 6,
    "msgType" : "plain",
    "suggestQuestionList" : [ ]
  }
}

不同data.ansType返回的示例(ansType仅对FAQ有效)

ansType:1

1.命中普通问题,返回问题的答案
sessionId:451521,
logId:792031,
aId:123,
ansContent:"<p>液晶的</p>",
ansType:1,
hitQuestion:"电视机",
msgType:"rich",
attachmentList:[],
switchStaffTips:"转人工",    //如果该问题开启了转人工推荐
switchStaffType:1,     //如果该问题开启了转人工推荐
suggestQuestionList:[ //如果该问题手动添加了建议列表
    {
        id:8086,
        content:"电视机品牌",
        type: 1,
        answer:{
            content:"xxxx",
            id:4422,
            type:1
        }
    },
    {
        id:8087,
        content:"电视机牌子",
        type: 1,
        answer:{
            content:"xxxx2",
            id:4423,
            type:1
        }
    }
]

2.命中流程问题,返回流程内容
sessionId:451521,
logId:792031,
ansType:1,
flowContent:"<p>测试流程A:&nbsp;</p><p>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <b data-type="1" class="flow-item" data-id="810" data-robotid="83">1、测试1</b></p><p>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<b data-type=1 class="flow-item" data-id=812 data-robotid=83>2、测试2</b></p>",
flowId:156,
flowTitle:"测试流程A1",
hitQuestion:"测试流程A",
attachmentList:[],
msgType:"rich",
switchStaffTips:"转人工", //如果该流程问题开启了转人工推荐
switchStaffType:1 //如果该流程问题开启了转人工推荐

ansType:3

1.返回问题建议列表
sessionId:451521,
logId:792031,
ansType:3,
msgType:"plain",
suggestQuestionList:[
    {
        id:8086,
        content:"电视机品牌",
        type: 1,
        answer:{
            content:"xxxx",
            id:4422,
            type:1
        }
    },
    {
        id:8087,
        content:"电视机牌子",
        type: 1,
        answer:{
            content:"xxxx2",
            id:4423,
            type:1
        }
    }
]

ansType:4

1.返回寒暄
sessionId:451521,
logId:792031,
ansType:4,
msgType:"plain",
ansContent:"不客气,这是我应该做的。"

ansType:5

1.返回忽略
sessionId:451521,
logId:792031,
ansType:5,
msgType:"plain",
ansContent:"不客气,这是我应该做的。",
answerScore:0,
switchStaffTips:"转人工",    //如果匹配转人工条件
switchStaffType:1     //如果匹配转人工条件

ansType:6

1.返回未知说辞
sessionId:451521,
logId:792031,
ansType:6,
msgType:"plain",
ansContent:"<p>不客气,这是我应该做的。</p>",
answerScore:0,
switchStaffTips:"转人工",    //如果匹配转人工条件
switchStaffType:1    //如果匹配转人工条件

ansType:8

1.输入敏感词
"code": 6400,
"message": "发送失败!您的问题中包含敏感词汇,请重新输入!"

ansType:9

1.返回三方调用结果
sessionId:451521,
logId:792031,
ansContent:"这个webhook返回的结果"

ansType:10

1.返回知识图谱
sessionId:451521,
logId:792031,
ansType:10,
msgType:"plain",
ansContent:"中山市区可以缴纳,参保截点为每月"

智能辅助

请求地址

请求参数

Request fields

Path Type Optional Description
robotId Integer false 机器人id.
channelId Integer false 场景id.
queryContent String true 问话内容.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Object true
data.sessionId Integer true 会话id.
data.logId Integer true 机器人返回的log的标识id.
data.ansContent Var true 返回对应的答案的内容.
data.ansType Integer true
data.flowId Integer true 流程id,返回流程时有效.
data.flowTitle String true 流程标题,返回流程时有效.
data.flowContent String true 流程内容,返回流程时有效.
data.hitQuestion String true 返回召回的问题,.
data.msgType String true 答案的文本类型.
data.switchStaffType Integer true 1.微信渠道显示引导语 2.满足条件转人工.
data.switchStaffTips String true 转人工提示.
data.suggestQuestionList Array true 建议列表.
data.suggestQuestionList[].id Integer true 问题的标识id.
data.suggestQuestionList[].content String true 问题的内容.
data.suggestQuestionList[].type Integer true
data.suggestQuestionList[].answer Object true 答案.
data.suggestQuestionList[].answer.content String true
data.suggestQuestionList[].answer.type Integer true
data.suggestQuestionList[].answer.questionId Integer true
data.suggestQuestionList[].answer.id Integer true
data.restrictionState Object true 交互量限制状态.
data.restrictionState.exceededFlag Integer true
data.restrictionState.usedCount Integer true
data.restrictionState.totalCount Integer true
data.aid Integer true 返回对应的答案的id.

示例

$ curl 'https://km.udesk.cn/api/v1/assist?email=admin@udesk.cn&timestamp=1529402447&sign=c3168ff8ee9db4208d3a6f8a49d4bea7d4058ab3' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "robotId" : 83,
  "channelId" : 83,
  "queryContent" : "你好"
}'
返回
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "ansContent" : "我是robot机器人啊",
    "attachmentList" : [ ],
    "hitQuestion" : "你是谁?",
    "msgType" : "rich",
    "suggestQuestionList" : [ ],
    "aid" : 552
  }
}

智能提示接口

请求地址

请求参数

Request fields

Path Type Optional Description
sessionId Integer false 会话id.
keyword String true keyword.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Object true
data.smartTipList Array true 智能提示问题列表.
data.smartTipList[].id Integer true 问题的标识id.
data.smartTipList[].content String true 问题的内容.
data.smartTipList[].type Integer true
data.smartTipList[].answer Object true 答案.
data.smartTipList[].answer.content String true
data.smartTipList[].answer.type Integer true
data.smartTipList[].answer.questionId Integer true
data.smartTipList[].answer.id Integer true

示例

$ curl 'https://km.udesk.cn/api/v1/smartHint?email=admin@udesk.cn&timestamp=1529402446&sign=a685c1c3881aebe59c79306ef6d288c25fab077b' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 450287,
  "keyword" : "社保"
}'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "smartTipList": [
            {
                "id": 8645,
                "content": "社保怎么办理主引导选择啊",
                "type": 1,
                "answer": {
                    "content": "<p>打电话12345</p>",
                    "type": 2,
                    "id": 4436
                }
            }
        ]
    },
    "extra": null
}

转人工通知接口

请求地址

请求参数

Path parameters

Parameter Type Optional Description
id int false 该次会话的会话id(sessionId).

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data null true

示例

$ curl 'https://km.udesk.cn/api/v1/sessions/451718/switchStaff?email=admin@udesk.cn&timestamp=1529402455&sign=d4be213127c62bb5b53dea5f5e52eaad06b2362f' -i -X PUT -H 'Accept: application/json'
返回
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : null
}