查询知识库词条列表

街机捕鱼大富翁破解版 www.ywfxb.tw 若您初次使用智齿客服开放平台接口-机器人&知识库接口,请在使用前阅读说明文档

接口说明

  • 接口类型:主动调用接口
  • 接口作用:可通过调用该接口来查询某个知识库所有知识条目的列表。

请求方法

  • 请求方式:POST

  • 请求地址: https://open.sobot.com/open/platform/api.json

请求参数(Request Body)

参数名 类型 必填 说明
action 字符串 传值为"search_doc_list"
access_token 字符串 调用接口凭据
data 对象 详见下文

请求data

参数名 类型 必填 说明
keyFlag 整型 1问题,2答案
questionTypeId 字符串 词条类型(传-1)
robotFlag 整型 知识库所属机器人:0公共知识库,1机器人一
questionTypeFlag 整型 问题类型,1-全部问题,2-标准问题,3-相似问题
pageNo 字符串 当前页码
keyWords 字符串 搜索关键字
usedFlag 整型 词条状态,0启用,1手动停用,2系统停用,3过期停用
linkFlag 整型 是否有关联问题,0是,1否
answerFlag 整型 答案类型:1文本,2图片,3图文,4视频
createId 字符串 词条创建人ID
createStartTime 字符串 创建开始时间
createEndTime 字符串 创建结束时间
updateId 字符串 词条最后更新人ID
updateStartDate 字符串 更新开始时间
updateEndDate 字符串 更新结束时间
effectStartDate 字符串 生效开始时间
effectEndDate 字符串 生效结束时间
invalidStartDate 字符串 失效开始时间
invalidEndDate 字符串 失效结束时间

返回数据

参数名 类型 说明
code 字符串 执行结果码,1000代表成功
data 对象 详见下文

返回data

参数名 类型 说明
items 数组 详见下文
pageCount 整型 总页数
pageNo 整型 当前页码
pageSize 整型 每页条数
retCode 字符串 状态码
retMsg 字符串 状态描述
totalCount 整型 总条数

返回items

参数名 类型 说明
allTypeName 字符串 分类全路径
answerDesc 字符串 答案内容
answerFlag 整型 答案类型:1文本,2图片,3图文,4视频
answerId 字符串 答案ID
answerImg 字符串 图文类型的缩略图
answerTxt 字符串 答案纯文本信息
auditStatus 整型 审核状态:0待审核,1永久有效,2指定时间有效
companyId 字符串 公司id
docId 字符串 词条ID
effectTime 长整型 生效时间
invalidTime 长整型 失效时间
linkFlag 整型 是否有关联问题,0是,1无
matchFlag 整型 匹配模式:0智能匹配,1完全匹配,2包含匹配,3欢迎语匹配
questionId 字符串 问题ID
questionTitle 字符串 问题标题
questionTypeId 字符串 问题类型ID
questionTypeName 字符串 问题类型名
robotFlag 整型 知识库所属机器人:0公共知识库,1机器人一
smailQuestionNum 整型 相似问法个数
updateId 字符串 更新人ID
updateTime 长整型 更新时间
usedFlag 整型 词条状态,0启用,1手动停用,2系统停用,3过期停用

请求示例

curl https://open.sobot.com/open/platform/api.json \
-X POST \
-H 'content-type: application/json' \
-d '
{
    "action": "search_doc_list",
    "access_token": "xx",//获取access_token
    "data": {
        "keyFlag": 1,
        "questionTypeId": -1,
        "robotFlag": 1,
        "pageNo": 1,
        "keyWords": "xx",
        "usedFlag": 0,
        "linkFlag": 1,
        "answerFlag": 1,
        "createId": "xx",
        "createStartTime": "yyyy-MM-dd",
        "createEndTime": "yyyy-MM-dd",
        "updateId": "xx",
        "updateStartDate": "yyyy-MM-dd",
        "updateEndDate": "yyyy-MM-dd",
        "effectStartDate": "yyyy-MM-dd",
        "effectEndDate": "yyyy-MM-dd",
        "invalidStartDate": "yyyy-MM-dd",
        "invalidEndDate": "yyyy-MM-dd"
    }
}'

返回示例

{
    "code" : "1000",
    "data" : {
       "items" : [
        {
          "allTypeName" : "xx",
          "answerDesc" : "xx",
          "answerFlag" : 1,
          "answerId" : "xx",
          "answerImg" : "xx",
          "answerTxt" : "xx",
          "auditStatus" : 1,
          "companyId" : "xx",
          "docId" : "xx",
          "effectTime" : 1481731200,
          "invalidTime" : 4102415999,
          "linkFlag" : 1,
          "matchFlag" : 0,
          "questionId" : "xx",
          "questionTitle" : "xx",
          "questionTypeId" : "xx",
          "questionTypeName" : "xx",
          "robotFlag" : 1,
          "smailQuestionNum" : 0,
          "updateId" : "xx",
          "updateTime" : 1481789852,
          "usedFlag" : 0
        } 
      ],
      "pageCount" : 3,
      "pageNo" : 1,
      "pageSize" : 15,
      "retCode" : "000000",
      "retMsg" : "操作成功!",
      "totalCount" : 40
    }
}


results matching ""

    No results matching ""