企业内部开发
基础
连接微信
办公
会议
会议统计管理
企业内部开发
服务端API
微信客服
机器人管理
知识库问答管理
知识库问答管理
最后更新:2024/06/21

目录

  • 添加问答
  • 删除问答
  • 修改问答
  • 获取问答列表
  • 附录-问答附件类型
  •       图片
  •       视频
  •       链接
  •       小程序
  • 通过问答管理接口,可操作企业管理后台-微信客服-机器人-知识库的问答数据。

    相关的约束条件跟管理后台一致:

    • 不同分组的问题不能重复
    • 单个分组的问答数上限为200

     

    权限说明:
    调用的应用需要满足如下的权限

    应用类型权限要求
    自建应用配置到「 微信客服- 可调用接口的应用」中
    第三方应用暂不支持
    代开发自建应用暂不支持

    注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

    添加问答

    可通过此接口创建新的知识库问答。

    请求方式: POST (HTTPS)

    请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/add_intent?access_token=ACCESS_TOKEN

    请求示例:

    {
        "group_id": "GROUP_ID",
        "question": {
            "text": {
                "content": "主问题"
            }
        }, 
        "similar_questions": {
            "items": [
                {
                    "text": {
                        "content": "相似问题1"
                    }
                }, 
                {
                    "text": {
                        "content": "相似问题2"
                    }
                }
            ]
        }, 
        "answers": [
            {
                "text": {
                    "content": "问题的回复"
                }, 
                "attachments": [
                    {
                        "msgtype": "image",
                        "image": {
                            "media_id": "MEDIA_ID"
                        }
                    }
                ]
            }
        ]
    }

     

    参数说明:

    参数类型必须说明
    access_tokenstring调用接口凭证
    group_idstring分组ID
    questionobj主问题
    question.textobj主问题文本
    question.text.contentstring主问题文本内容。不超过200个字
    similar_questionsobj相似问题
    similar_questions.itemsobj[]相似问题列表。最多支持100个
    similar_questions.items[].textobj相似问题文本
    similar_questions.items[].text.contentstring相似问题文本内容。不超过200个字
    answersobj[]回答列表。目前仅支持1个
    answers[].textobj回答文本
    answers[].text.contentstring回答文本内容。不超过500个字
    answers[].attachmentsobj[]回答附件列表。最多支持4个
    answers[].attachments[].*obj回答附件。具体见附录-问答附件类型

     

    返回结果:

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"intent_id": "INTENT_ID"
    }

    参数说明:

    参数类型说明
    errcodeint32返回码
    errmsgstring错误码描述
    intent_idstring问答ID

     

    删除问答

    可通过此接口删除已有的知识库问答。

    请求方式: POST (HTTPS)

    请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/del_intent?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"intent_id": "INTENT_ID"
    }

     

    参数说明:

    参数类型必须说明
    access_tokenstring调用接口凭证
    intent_idstring问答ID

     

    返回结果:

    {
    	"errcode": 0,
    	"errmsg": "ok"
    }

    参数说明:

    参数类型说明
    errcodeint32返回码
    errmsgstring错误码描述

     

    修改问答

    可通过此接口修改已有的知识库问答。
    question/similar_questions/answers这三部分可以按需更新,但更新的每一部分是覆盖写,需要传完整的字段。

    请求方式: POST (HTTPS)

    请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/mod_intent?access_token=ACCESS_TOKEN

    请求示例:

    {
        "intent_id": "INTENT_ID",
        "question": {
            "text": {
                "content": "主问题"
            }
        }, 
        "similar_questions": {
            "items": [
                {
                    "text": {
                        "content": "相似问题1"
                    }
                }, 
                {
                    "text": {
                        "content": "相似问题2"
                    }
                }
            ]
        }, 
        "answers": [
            {
                "text": {
                    "content": "问题的回复"
                }, 
                "attachments": [
                    {
                        "msgtype": "image",
                        "image": {
                            "media_id": "MEDIA_ID"
                        }
                    }
                ]
            }
        ]
    }

    参数说明:

    参数类型必须说明
    access_tokenstring调用接口凭证
    intent_idstring问答ID
    questionobj主问题
    question.textobj主问题文本
    question.text.contentstring主问题文本内容
    similar_questionsobj相似问题
    similar_questions.itemsobj[]相似问题列表。最多支持100个
    similar_questions.items[].textobj相似问题文本
    similar_questions.items[].text.contentstring相似问题文本内容
    answersobj[]回答列表。目前仅支持1个
    answers[].textobj回答文本
    answers[].text.contentstring回答文本内容
    answers[].attachmentsobj[]回答附件列表。最多支持4个
    answers[].attachments[].*obj回答附件。具体见附录-问答附件类型

    返回结果:

    {
    	"errcode": 0,
    	"errmsg": "ok"
    }

    参数说明:

    参数类型说明
    errcodeint32返回码
    errmsgstring错误码描述
    intent_idstring问答ID

     

    获取问答列表

    可通过此接口分页获取的知识库问答详情列表。

    请求方式: POST (HTTPS)

    请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/list_intent?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"cursor": "CURSOR",
    	"limit": 100,
    	"group_id": "GROUP_ID",
    	"intent_id": "INTENT_ID"
    }

    参数说明:

    参数类型必须说明
    access_tokenstring调用接口凭证
    cursorstring上一次调用时返回的next_cursor,第一次拉取可以不填
    limituint32每次拉取的数据量,默认值500,最大值为1000
    group_idstring分组ID。可指定拉取特定分组下的问答
    intent_idstring问答ID。可指定拉取特定的问答

     

    返回结果:

    {
        "errcode": 0, 
        "errmsg": "ok", 
        "next_cursor": "NEXT_CURSOR", 
        "has_more": 1, 
        "intent_list": [
            {
                "group_id": "GROUP_ID", 
                "intent_id": "INTENT_ID", 
                "question": {
                    "text": {
                        "content": "主问题"
                    }, 
                    "similar_questions": {
                        "items": [
                            {
                                "text": {
                                    "content": "相似问题1"
                                }
                            }, 
                            {
                                "text": {
                                    "content": "相似问题2"
                                }
                            }
                        ]
                    }, 
                    "answers": [
                        {
                            "text": {
                                "content": "问题的回复"
                            }, 
                            "attachments": [
                                {
                                    "msgtype": "image", 
                                    "image": {
                                        "name": "图片(仅返回名字).jpg"
                                    }
                                }
                            ]
                        }
                    ]
                }
            }
        ]
    }

    参数说明:

    参数类型说明
    errcodeint32返回码
    errmsgstring错误码描述
    next_cursorstring分页游标,再下次请求时填写以获取之后分页的记录
    has_moreuint32是否还有更多数据。0-没有 1-有
    intent_listobj[]问答摘要列表
    intent_list[].group_idstring分组ID
    intent_list[].intent_idstring问答ID
    intent_list[].questionobj主问题
    intent_list[].question.textobj主问题文本
    intent_list[].question.text.contentstring主问题文本内容
    intent_list[].similar_questionsobj相似问题
    intent_list[].similar_questions.itemsobj[]相似问题列表。最多支持100个
    intent_list[].similar_questions.items[].textobj相似问题文本
    intent_list[].similar_questions.items[].text.contentstring相似问题文本内容
    intent_list[].answersobj[]回答列表。目前仅支持1个
    intent_list[].answers[].textobj回答文本
    intent_list[].answers[].text.contentstring回答文本内容
    intent_list[].answers[].attachmentsobj[]回答附件列表。最多支持4个
    intent_list[].answers[].attachments[].*obj回答附件。具体见附录-问答附件类型

     

    附录-问答附件类型

    图片

    请求示例:

    {
        "msgtype": "image",
        "image": {
            "media_id": "MEDIA_ID"
        }
    }

    返回示例:

    {
        "msgtype": "image", 
        "image": {
            "name": "图片的文件名"
        }
    }

    参数说明:

    参数类型必须说明
    msgtypestring附件类型,此处固定为image
    imageobj图片消息
    image.media_idstring图片的media_id,可通过上传临时素材接口获取
    image.namestring图片的文件名获取问答列表接口才返回该字段)

     

    视频

    请求示例:

    {
        "msgtype": "video", 
        "video": {
            "media_id": "MEDIA_ID"
        }
    }

    返回示例:

    {
        "msgtype": "video", 
        "video": {
            "name": "视频的文件名"
        }
    }

    参数说明:

    参数类型必须说明
    msgtypestring附件类型,此处固定为video
    videoobj视频消息
    video.media_idstring视频的media_id,可通过上传临时素材接口获取
    video.namestring视频的文件名获取问答列表接口才返回该字段)

     

    链接

    示例:

    {
        "msgtype": "link", 
        "link": {
            "title": "消息标题", 
            "pic_url": "https://example.pic.com/path", 
            "desc": "消息描述", 
            "url": "https://example.link.com/path"
        }
    }

    参数说明:

    参数类型必须说明
    msgtypestring附件类型,此处固定为link
    linkobj链接消息
    link.titlestring标题
    link.descstring描述
    link.urlstring点击后跳转的链接
    link.pic_urlstring缩略图链接

    小程序

    请求示例:

    {
        "msgtype": "miniprogram", 
        "miniprogram": {
            "title": "欢迎报名夏令营",
            "thumb_media_id": "THUMB_MEDIA_ID",
            "appid": "wx8bd80126147dfAAA", 
            "pagepath": "/path/index.html"
        }
    }

    返回示例:

    {
        "msgtype": "miniprogram", 
        "miniprogram": {
            "title": "欢迎报名夏令营",
            "appid": "wx8bd80126147dfAAA", 
            "pagepath": "/path/index.html"
        }
    }

    参数说明:

    参数类型必须说明
    msgtypestring附件类型,此处固定为miniprogram
    miniprogramobj小程序消息
    miniprogram.titlestring小程序消息标题。最多64个字节
    miniprogram.thumb_media_idstring小程序消息封面的mediaid。封面图建议尺寸为520*416( 获取问答列表接口不返回该字段)
    miniprogram.appidstring小程序appid。必须是关联到企业的小程序应用appid
    miniprogram.pagepathstring点击消息卡片后进入的小程序页面路径
    上一篇知识库分组管理
    下一篇回调通知
      本节内容
    服务端API
    基础
    连接微信
    办公
    会议
    会议统计管理
    客户端API
    小程序
    基础
    连接微信
    办公
    WECOM-JSSDK
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们