Skip to content

发布知识条目

约 661 字大约 2 分钟

2026-09-14

描述

发布指定知识条目。发布为同步操作:接口调用成功后条目立即变为「已发布」(public_status=1),对外可见。

请求说明

请求方式 :POST + application/json

请求路径 :https://${填入所在云的域名}/cgi/crm/v2/knowledge/publish?thirdTraceId=${随机字符串}

请求头填写 :参考公共参数填写

请求参数

参数类型是否必填说明
dataMap数据
  objectDataIdString单条发布的知识条目 ID
  dataIdsList[String]批量发布的知识条目 ID 列表。与 objectDataId 二选一,至少传一个

请求示例

{
  "data": {
    "objectDataId": "68c1a0f0abcd0001"
  }
}

返回参数

参数类型说明
traceIdstring请求唯一ID
errorDescriptionstring错误描述
errorMessagestring错误信息
errorCodeInt查看错误码
dataobject返回数据
  resultBooleantrue 表示发布成功,条目已处于「已发布」状态

返回示例

{
  "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 已下架出现在知识库入库/发布检查等流程中,最终状态请以知识条目列表查询结果为准。
  • objectDataIddataIds 均不传时,本接口返回成功但不会变更任何条目(空操作),请至少传入其一。
  • 批量发布(dataIds)逐条执行,任一条失败(记录不存在或更新失败)即整体报错;失败前已成功的条目不会回滚,请拆分重试。
  • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;