What is the Knowledge Base
The Knowledge Base is a professional and efficient enterprise knowledge management platform within DingTalk. It can be used to build an enterprise knowledge management library and enable internal document collaboration. It is simple and convenient to operate. Once an admin adds users, multiple people can share content in real time. Knowledge Base users can record all content produced through internal collaboration.Features
Document management
In the Knowledge Base, you can use folders to categorize documents. Every Knowledge Base presents all its documents in a single tree of contents. You can also create documents or folders directly on the tree. You can also present all documents in the Knowledge Base in a structured way through the Mind Map view. On the Knowledge Base home page, drag and drop directly on the Mind Map to quickly adjust the document structure.Manage permissions
The Knowledge Base supports multi-level permission settings, including Knowledge Base level, folder level, and individual document level. The permission types are: Can manage, Can edit, Can view/download, and View only. You can add, modify, or remove permissions to control access for users, departments, groups, and organizations.Open capabilities overview
API list
The Knowledge Base provides rich open API capabilities. Developers can use these APIs to integrate Knowledge Base features.Knowledge Base management
| API | Description | API version |
|---|---|---|
| Create a Knowledge Base | Create a Knowledge Base under an organization. | New |
| Get a Knowledge Base | Query Knowledge Base information. | New |
| Pin a Knowledge Base | Pin a Knowledge Base based on its ID and the operator’s unionId. | New |
| Get the Knowledge Base list | Get the Knowledge Base list based on the operator’s unionId. | New |
| Get Knowledge Bases in batch | Query Knowledge Base information based on the operator’s unionId and Knowledge Base ID. | New |
| Transfer Knowledge Base ownership | Transfer the ownership of a Knowledge Base to another user. | New |
| Get My Docs Knowledge Base information | Get the operator’s document information based on the operator’s unionId. | New |
Table of contents management
| API | Description | API version |
|---|---|---|
| Copy a document | Copy a node under another node. | New |
| Create a shortcut | Create a shortcut to a Knowledge Base or file. | New |
| Get task status | Query task status by task. Can be used together with Copy a document. | New |
| Create a Knowledge Base document | Create a document or folder in a Knowledge Base. | New |
| Delete a Knowledge Base document | Delete a Team space document or folder. | New |
| Download a file from the Knowledge Base | Get the download information of a file in the Knowledge Base. | New |
| Get a node | Get information about a single node based on the operator’s unionId and node ID. | New |
| Get the node list | Query the list of nodes under a parent node by parent node ID. | New |
| Get a node by link | Get node information based on the operator’s unionId and the document link. | New |
| Get nodes in batch | Query node information in batch based on node IDs and the operator’s unionId. | New |
Callback event list
The Knowledge Base supports multiple callback events, including group creation, group changes, and group user changes:- Create a group in the Document Knowledge Base
- Group changes in the Document Knowledge Base
- Group user changes in the Document Knowledge Base
Tutorials
DingTalk provides examples of the Knowledge Base API integration flow.Glossary
Table of contents
Refers to the tree formed by the Knowledge Base’s directory structure.Node
Refers to a node on the Knowledge Base’s Table of contents. There are two types: folders and files.Permissions
- Use permissions to securely manage documents within a team or organization.
- Permissions are inherited from the parent document or folder by default, improving the efficiency of permission granting.
- Permissions can be added or removed to strengthen team information security management.