查询知识库词条
街机捕鱼大富翁破解版 www.ywfxb.tw 若您初次使用智齿客服开放平台接口-机器人&知识库接口,请在使用前阅读说明文档。
接口说明
- 接口类型:主动调用接口
- 接口作用:可通过调用该接口来查询某个知识条目的详细信息。
请求方法
- 请求方式:POST
- 请求地址:
https://open.sobot.com/open/platform/api.json
请求参数(Request Body)
参数名 |
类型 |
必填 |
说明 |
action |
字符串 |
是 |
传值为"query_doc_detail" |
access_token |
字符串 |
是 |
调用接口凭据 |
data |
对象 |
是 |
详见下文 |
请求data
参数名 |
类型 |
必填 |
说明 |
docId |
字符串 |
是 |
词条Id |
robotFlag |
整型 |
是 |
知识库所属机器人:0公共知识库,1机器人一 |
返回数据
参数名 |
类型 |
说明 |
code |
字符串 |
执行结果码,1000代表成功 |
data |
对象 |
详见下文 |
返回data
参数名 |
类型 |
说明 |
item |
对象 |
详见下文 |
retCode |
字符串 |
状态码 |
retMsg |
字符串 |
状态描述 |
返回item
参数名 |
类型 |
说明 |
answerDesc |
字符串 |
答案内容 |
answerFlag |
整型 |
答案类型:1文本,2图片,3图文,4视频 |
answerId |
字符串 |
答案ID |
answerImg |
字符串 |
图文类型的缩略图 |
answerTxt |
字符串 |
答案纯文本信息 |
answerSummary |
字符串 |
图文类型摘要 |
auditStatus |
整型 |
审核状态:0待审核,1永久有效,2指定时间有效 |
companyId |
字符串 |
公司id |
docId |
字符串 |
词条ID |
createTime |
字符串 |
创建时间 |
effectTime |
长整型 |
生效时间 |
linkQuestionList |
数组 |
关联问题列表,详见下文 |
linkQuestionNum |
整型 |
关联问题个数 |
linkedFlag |
整型 |
是否被其他问题关联,1是,0无 |
matchFlag |
整型 |
匹配模式:0智能匹配,1完全匹配,2包含匹配,3欢迎语匹配 |
questionId |
字符串 |
问题ID |
questionTitle |
字符串 |
问题标题 |
questionTypeId |
字符串 |
问题类型ID |
questionTypeName |
字符串 |
问题类型名 |
robotFlag |
整型 |
知识库所属机器人:0公共知识库,1机器人一 |
smailQuestionNum |
整型 |
相似问法个数 |
updateId |
字符串 |
更新人ID |
updateTime |
长整型 |
更新时间 |
usedFlag |
整型 |
词条状态,0启用,1手动停用,2系统停用,3过期停用 |
返回linkQuestionList
参数名 |
类型 |
说明 |
docId |
字符串 |
关联问题词条Id |
linkName |
字符串 |
显示名称 |
linkQuestionTitle |
字符串 |
知识库本身名称 |
请求示例
curl https://open.sobot.com/open/platform/api.json \
-X POST \
-H 'content-type: application/json' \
-d '
{
"action" : "query_doc_detail",
"access_token" : "xx",//获取access_token
"data" : {
"docId":"xx",
"robotFlag":1
}
}
返回示例
{
"code" : "1000",
"data" : {
"item" : {
"answerDesc" : "xx",
"answerFlag" : 1,
"answerId" : "xx",
"answerImg" : "xx",
"answerTxt" : "xx",
"answerSummary" : "xx",
"auditStatus" : 1,
"companyId" : "xx",
"docId" : "xx",
"createTime" : "2017-01-01 08:00:00",
"effectTime" : "2017-01-01",
"linkQuestionList" : [
{
"docId" : "xx",
"linkName" : "xx",
"linkQuestionTitle" : "xx"
}
],
"linkQuestionNum" : 2,
"linkedFlag" : 1,
"matchFlag" : 0,
"questionId" : "xx",
"questionTitle" : "xx",
"questionTypeId" : "xx",
"questionTypeName" : "xx",
"robotFlag" : 1,
"smailQuestionNum" : 0,
"updateId" : "xx",
"updateTime" : "2017-01-01 08:00:00",
"usedFlag" : 0,
},
"items": [],
"retCode": "000000",
"retMsg": "查询成功!"
}
}