简体中文
发布知识条目
约 661 字大约 2 分钟
2026-09-14
描述
发布指定知识条目。发布为同步操作:接口调用成功后条目立即变为「已发布」(public_status=1),对外可见。
请求说明
请求方式 :POST + application/json
请求路径 :https://${填入所在云的域名}/cgi/crm/v2/knowledge/publish?thirdTraceId=${随机字符串}
请求头填写 :参考公共参数填写
请求参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| data | Map | 是 | 数据 |
| objectDataId | String | 否 | 单条发布的知识条目 ID |
| dataIds | List[String] | 否 | 批量发布的知识条目 ID 列表。与 objectDataId 二选一,至少传一个 |
请求示例
{
"data": {
"objectDataId": "68c1a0f0abcd0001"
}
}返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| traceId | string | 请求唯一ID |
| errorDescription | string | 错误描述 |
| errorMessage | string | 错误信息 |
| errorCode | Int | 查看错误码 |
| data | object | 返回数据 |
| result | Boolean | true 表示发布成功,条目已处于「已发布」状态 |
返回示例
{
"traceId": "E-O.fktest4234.1000-20260914103000-xxxxxx",
"errorDescription": "success",
"errorMessage": "success",
"errorCode": 0,
"data": {
"result": true
}
}注意事项
发布状态(public_status)取值说明:
| 值 | 含义 | 说明 |
|---|---|---|
| 1 | 已发布 | 对外可见的终态;本接口发布成功后置为该值 |
| 2 | 未发布 | 新建后的初始状态;本接口下架成功后回到该值 |
| 3 | 发布中 | 知识库入库/发布检查流程的中间状态,本接口不会置为该值 |
| 4 | 发布失败 | 发布检查未通过或超时时的状态(由发布检查流程回写) |
| 5 | 已下架 | 知识库内部流程的展示态,本接口下架成功后为 2 而非 5 |
- 本接口发布为同步操作:调用成功即
public_status=1,无需轮询终态;返回result=true即发布完成。 - 接口对条目当前状态不做前置校验:重复发布、对已发布条目再次调用均成功(幂等)。
- 当前操作用户(
currentOpenUserId)须具备知识条目对象的「发布」功能权限,并对该条数据拥有数据权限,否则返回无权限失败。 3发布中、4发布失败、5已下架出现在知识库入库/发布检查等流程中,最终状态请以知识条目列表查询结果为准。objectDataId与dataIds均不传时,本接口返回成功但不会变更任何条目(空操作),请至少传入其一。- 批量发布(
dataIds)逐条执行,任一条失败(记录不存在或更新失败)即整体报错;失败前已成功的条目不会回滚,请拆分重试。 - 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
