搜索知识库

POST

/v2.0/storage/workspaces/search

**
接口调用量说明**钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

搜索知识库。

接口功能介绍

调用本接口，根据操作人unionId和关键词信息，搜索知识库信息。示例如下：

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	知识库搜索权限	API Explorer
第三方企业应用	支持	知识库搜索权限	API Explorer
第三方个人应用	暂不支持	知识库搜索权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	paramError	%s	参数错误
400	paramError-keyword	%s	参数错误-keyword
400	paramError.maxResults	%s	参数错误-maxResults
500	systemError	%s	服务繁忙，请稍后重试
500	unknownError	Unknown Error	未知错误
503	operationTimeout	%s	请求超时

请求参数

Query 参数

Header 参数

Body 参数application/json

示例

{
  "keyword" : "String",
  "option" : {
    "nextToken" : "String",
    "maxResults" : Integer
  }
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v2.0/storage/workspaces/search?operatorId=String' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "keyword" : "String",
  "option" : {
    "nextToken" : "String",
    "maxResults" : Integer
  }
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "items": [
        {
            "workspaceId": "string",
            "name": "string",
            "url": "string"
        }
    ],
    "nextToken": "string"
}

修改于 2025-09-08 06:28:05

搜索文件

概述

搜索知识库

接口功能介绍#

权限#

错误码#

请求参数

请求示例代码

返回响应

接口功能介绍

权限

错误码