目录
通过分组管理接口,可操作企业管理后台-微信客服-机器人-知识库的分组数据。
相关的约束条件跟管理后台一致:
100
权限说明:
调用的应用需要满足如下的权限
应用类型 | 权限要求 |
---|---|
自建应用 | 配置到「 微信客服- 可调用接口的应用」中 |
第三方应用 | 暂不支持 |
代开发自建应用 | 暂不支持 |
注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情
可通过此接口创建新的知识库分组。
请求方式: POST (HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/add_group?access_token=ACCESS_TOKEN
请求示例:
{
"name": "分组名"
}
参数说明:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
name | stirng | 是 | 分组名。不超过12个字 |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"group_id" "GROUP_ID"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码 |
errmsg | string | 错误码描述 |
group_id | string | 分组ID |
可通过此接口删除已有的知识库分组,但不能删除系统创建的默认分组。
请求方式: POST (HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/del_group?access_token=ACCESS_TOKEN
请求示例:
{
"group_id": "GROUP_ID"
}
参数说明:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
group_id | string | 是 | 分组ID |
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码 |
errmsg | string | 错误码描述 |
可通过此接口修改已有的知识库分组,但不能修改系统创建的默认分组。
请求方式: POST (HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/mod_group?access_token=ACCESS_TOKEN
请求示例:
{
"group_id": "GROUP_ID",
"name": "分组名"
}
参数说明:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
group_id | string | 是 | 分组ID |
name | stirng | 是 | 分组名。不超过12个字 |
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码 |
errmsg | string | 错误码描述 |
group_id | string | 分组ID |
可通过此接口分页获取所有的知识库分组。
请求方式: POST (HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/list_group?access_token=ACCESS_TOKEN
请求示例:
{
"cursor": "CURSOR",
"limit": 100,
"group_id": "GROUP_ID"
}
参数说明:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
cursor | string | 否 | 上一次调用时返回的next_cursor ,第一次拉取可以不填 |
limit | uint32 | 否 | 每次拉取的数据量,默认值500,最大值为1000 |
group_id | string | 否 | 分组ID。可指定拉取特定的分组 |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"next_cursor": "NEXT_CURSOR",
"has_more":1,
"group_list": [
{
"group_id": "GROUP_ID",
"name": "NAME",
"is_default": 1
}, {
"group_id": "GROUP_ID",
"name": "NAME",
"is_default": 0
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码 |
errmsg | string | 错误码描述 |
next_cursor | string | 分页游标,再下次请求时填写以获取之后分页的记录 |
has_more | uint32 | 是否还有更多数据。0-没有 1-有 |
group_list | obj[] | 分组列表 |
group_list[].group_id | string | 分组ID |
group_list[].name | string | 分组名 |
group_list[].is_default | uint32 | 是否为默认分组。0-否 1-是。默认分组为系统自动创建,不可修改/删除 |