Skip to content

下架知识条目

约 540 字大约 2 分钟

2026-09-14

描述

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

请求说明

请求方式 :POST + application/json

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

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

请求参数

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

请求示例

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

返回参数

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

返回示例

{
  "traceId": "E-O.fktest4234.1000-20260914104000-xxxxxx",
  "errorDescription": "success",
  "errorMessage": "success",
  "errorCode": 0,
  "data": {
    "result": true
  }
}

注意事项

  • 下架成功后 public_status 变更为 2 未发布(而非 55 已下架是知识库内部流程的展示态),状态取值详见发布知识条目
  • 接口对条目当前状态不做前置校验:重复下架、对未发布条目下架均成功(幂等)。
  • 当前操作用户(currentOpenUserId)须具备知识条目对象的「取消发布」功能权限,并对该条数据拥有数据权限,否则返回无权限失败。
  • 下架的条目可再次调用发布知识条目重新发布。
  • objectDataIddataIds 均不传时,本接口返回「数据不存在或不可用」类错误(与发布接口的空操作行为不同),请至少传入其一。
  • 批量下架(dataIds)逐条执行:条目不存在或更新未生效会被静默跳过(接口仍返回 result=true),仅底层异常才整体报错;已成功条目不会回滚。如需确认每条的下架结果,请以列表/详情查询的 public_status 为准。
  • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;