获取知识库列表

最近更新时间:2019-08-30 14:58:19

功能描述

第三方获取指定机器人的知识库列表数据。

请求

请求 URL

https://yun.tim.qq.com/v3/prophet/query_question_list?
appid=$appid
&sdkappid=$sdkappid
&identifier=$identifier
&usersig=$usersig
&random=999999
&contenttype=json

URL 详细字段说明请参阅 URL 字段说明 文档。

请求参数

字段名称 描述 类型 必填
botid 机器人唯一标识,由用户指定 String
auth 第三方帐号认证信息,用作回调验证第三方帐号合法性 String
page_size 支持分页展示,此参数声明每页拉取条数 Int
page_index 此参数声明拉取第几页的 qa,下标由 0 开始,默认 0 Int
keyword 检索关键词,为空时顺序拉取 String
cid 按照分类 ID 过滤,不带此参数则不过滤返回全部 qa,参数值为“0”则仅返回未分类 qa String

响应

响应参数

字段名称 描述 类型
ActionStatus 处理状态 String
ErrorCode 错误码 Int
ErrorInfo 错误信息 String
total_count 总结果数 String
count 返回结果条数 String
total_page 共计多少页 String
qa_list 知识库列表 String
same_question 相似问题列表 String
question 问题 String
answer 答案列表 String
qaid 知识库中问题答案对的唯一标识 String

示例

请求示例

https://yun.tim.qq.com/v3/prophet/query_question_list?
appid=$appid
&sdkappid=$sdkappid
&identifier=$identifier
&usersig=$usersig
&random=999999
&contenttype=json

{
    "botid": "bot_identifier",
    "auth": "",
    "page_size": 50,
    "page_index": 0,
    "keyword": "发消息"
}

响应示例

{
    "ActionStatus": "ok",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "count": 2,
    "total_count": 4,
    "total_page": 1,
    "qa_list":
    [
        {
            "same_question": ["question1", "question2"],
            "question": "问题",
            "answer": ["answer1"],
            "qaid": "Qeewe32"
        },
        {
            "same_question": ["question1", "question2"],
            "question": "问题",
            "answer": ["answer1"],
            "qaid": "Qeewe32"
        }
    ]
}