文档

ListCategory - 获取类目列表

更新时间:

获取类目列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
KnowledgeTypeinteger

知识类型,FAQ 类目:1,文档类目:3,默认 1

1
ParentCategoryIdlong

父类目 ID

-1
AgentKeystring

业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取

ac627989eb4f8a98ed05fd098bbae5_p_beebot_public

返回参数

名称类型描述示例值
object

返回值

Categoriesobject []

类目 list 结果

CategoryIdlong

类目 ID

231001028593
BizCodestring

业务代码

bizcode123
Namestring

类⽬名称

类目名称
ParentCategoryIdlong

⽗类⽬ID

-1
Statusinteger

类目状态,-1:已删除未发布状态,0:正常

0
RequestIdstring

请求 ID

9C5F8186-2D22-433E-9545-606D344F30B5

示例

正常返回示例

JSON格式

{
  "Categories": [
    {
      "CategoryId": 231001028593,
      "BizCode": "bizcode123",
      "Name": "类目名称",
      "ParentCategoryId": -1,
      "Status": 0
    }
  ],
  "RequestId": "9C5F8186-2D22-433E-9545-606D344F30B5"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-22OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:KnowledgeType
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈