帮助中心
首页
产品与服务
智能客服
知识库管理
客户案例
关于我们
免费试用
语言
简体中文
English
所有文章
默认版本
默认版本
钉钉版
飞书版
内部版本
三分钟上手帮助中心
公司介绍
了解更多
接入、集成和迁移
知识库Open API使用说明
技术对接方案v1.1
支持多种迁移方式，降低迁移成本
多版本文档同步规则
企业微信打通，文档权限管理&数据统计
帮助中心嵌入APP或小程序说明文档
客户案例
功能概览
常见F&Q
了解更多
接入、集成和迁移
知识库Open API使用说明
知识库Open API使用说明
最后更新于 2025/02/23  

前置条件：请求Open API所有接口均需要发送Token参数，请联系官方客服来索取Token

获取知识库所有版本

如果在知识库中创建了多个版本，可通过此接口获取所有版本。

请求URL

  • https://hapi.moyincloud.com/open/kb/version/list

请求方式

  • GET

参数

参数名

必选

类型

说明

websiteId

是

string

站点ID

token

是

string

token值

返回示例
{
    "code": 0,
    "data": [{
        "id": 106,
        "lan": "zh-CHS",
        "lanName": "中文",
        "name": "默认版本",
        "slug": "",
        "websiteDomain": "doc.xxx.com"
    }],
    "desc": "成功",
    "reqId": "725cae0f-3ed2-4ba0-a9ce-9ca83a0f81e4"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
json
返回数据说明

参数名

类型

说明

code

int

0表示获取成功

id

int

版本ID

lan

String

版本语言

lanName

String

版本语言中文

name

String

版本名称

slug

String

版本在知识库站点中的路径

websiteDomain

String

知识库域名

获取知识库目录

获取管理后台中知识库的目录树结构。

请求URL

  • https://hapi.moyincloud.com/open/kb/catalog/list

请求方式

  • GET

参数

参数名

必选

类型

说明

websiteId

是

string

站点ID

versionId

是

int

版本ID

token

是

string

token值

返回示例
{
    "code": 0,
    "data": [{
        "id": "1528968012287295489",
        "docId": "1528968012274712577",
        "catalogName": "三分钟上手知识库",
        "isDirectory": 0,
        "children": [],
        "updateTime": "2025-01-01 00:00:00"
    }, {
        "id": "1526491228970950658",
        "docId": "0",
        "catalogName": "公司介绍",
        "isDirectory": 1,
        "children":[{
            "id": "1544155355129319425",
            "docId": "1544155355108347905",
            "catalogName": "一分钟玩转文档编辑",
            "isDirectory": 0,
            "children": [],
            "updateTime": "2025-01-01 00:00:00"  
        }],
        "updateTime": "2025-01-01 00:00:00"
    }],
    "desc": "成功",
    "reqId": "725cae0f-3ed2-4ba0-a9ce-9ca83a0f81e4"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
json
返回数据说明

参数名

类型

说明

code

int

0表示获取成功

id

String

目录树节点ID

docId

String

如果节点是文档，此处为文档ID；否则为0

catalogName

String

目录树节点标题

isDirectory

int

1代表目录，0代表为文档

children

String

子目录，子目录节点结构与当前节点相同

updateTime

String

更新时间

获取已发布的知识库目录

获取已发布到知识库站点的目录树结构。

请求URL

  • https://hapi.moyincloud.com/open/kb/catalog/release/list

请求方式

  • GET

参数

参数名

必选

类型

说明

websiteId

是

string

站点ID

versionId

是

int

版本ID

token

是

string

token值

返回示例
{
    "code": 0,
    "data": [{
        "id": "1528968012287295489",
        "docId": "1528968012274712577",
        "catalogName": "三分钟上手知识库",
        "isDirectory": 0,
        "children": [],
        "updateTime": "2025-01-01 00:00:00"
    }, {
        "id": "1526491228970950658",
        "docId": "0",
        "catalogName": "公司介绍",
        "isDirectory": 1,
        "children":[{
            "id": "1544155355129319425",
            "docId": "1544155355108347905",
            "catalogName": "一分钟玩转文档编辑",
            "isDirectory": 0,
            "children": [],
            "updateTime": "2025-01-01 00:00:00"  
        }],
        "updateTime": "2025-01-01 00:00:00"
    }],
    "desc": "成功",
    "reqId": "725cae0f-3ed2-4ba0-a9ce-9ca83a0f81e4"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
json
返回数据说明

参数名

类型

说明

code

int

0表示获取成功

id

String

目录树节点ID

docId

String

如果节点是文档，此处为文档ID；否则为0

catalogName

String

目录树节点标题

isDirectory

int

1代表目录，0代表为文档

children

String

子目录，子目录节点结构与当前节点相同

updateTime

String

更新时间

获取文档详情

获取最新的文档详情。

请求URL

  • https://hapi.moyincloud.com/open/kb/doc/detail

请求方式

  • GET

参数

参数名

必选

类型

说明

websiteId

是

string

站点ID

docId

是

int

文档ID

token

是

string

token值

返回示例
{
    "code": 0,
    "data": {
        "id": "1528968012287295489",
        "title": "三分钟上手知识库",
        "content": "文档内容",
        "updateTime": "2025-01-01 00:00:00"
    },
    "desc": "成功",
    "reqId": "725cae0f-3ed2-4ba0-a9ce-9ca83a0f81e4"
}
1
2
3
4
5
6
7
8
9
10
11
12
json
返回数据说明

参数名

类型

说明

code

int

0表示获取成功

id

String

文档ID

title

String

文档标题

content

String

文档内容，是HTML格式

updateTime

String

更新时间

获取已发布的文档详情

获取已发布到知识库站点的文档详情。

请求URL

  • https://hapi.moyincloud.com/open/kb/doc/release/detail

请求方式

  • GET

参数

参数名

必选

类型

说明

websiteId

是

string

站点ID

docId

是

int

文档ID

token

是

string

token值

返回示例
{
    "code": 0,
    "data": {
        "id": "1528968012287295489",
        "title": "三分钟上手知识库",
        "content": "文档内容",
        "updateTime": "2025-01-01 00:00:00"
    },
    "desc": "成功",
    "reqId": "725cae0f-3ed2-4ba0-a9ce-9ca83a0f81e4"
}
1
2
3
4
5
6
7
8
9
10
11
12
json
返回数据说明

参数名

类型

说明

code

int

0表示获取成功

id

String

文档ID

title

String

文档标题

content

String

文档内容，是HTML格式

updateTime

String

更新时间

上一篇
公司价值观 - 始终坚持客户至上
下一篇
技术对接方案v1.1
未能解决您的问题？请联系
在线客服
本篇目录

获取知识库所有版本

请求URL

请求方式

参数

返回示例

返回数据说明

获取知识库目录

请求URL

请求方式

参数

返回示例

返回数据说明

获取已发布的知识库目录

请求URL

请求方式

参数

返回示例

返回数据说明

获取文档详情

请求URL

请求方式

参数

返回示例

返回数据说明

获取已发布的文档详情

请求URL

请求方式

参数

返回示例

返回数据说明