Skip to content

凭确认令牌删除表单 ​

删除未关联任何码的表单。必须传 forms/previewDelete 返回的 confirm_token(只能删预览过的同一批目标)和幂等键 idempotency_key。

请求 ​

text
POST https://open.cli.im/api/v2/rpc/forms/delete
项目要求
最低权限完全,见权限档位
需要的 scopetemplates.write、content.delete
组织 Key不能调用,返回 403 credential_type_not_allowed,见历史组织 Key

相关调用流程:修改和删除码、表单。

请求参数 ​

请求体为 JSON。

字段类型必填说明
form_idsstring[]是要删除的表单 ID,一次最多 5 个,不能重复;已关联码的表单不能删除。至少 1 项。最多 5 项
confirm_tokenstring是forms/previewDelete 返回的 confirm_token,10 分钟内有效,只能用于预览过的同一批表单。最长 256 个字符
idempotency_keystring是幂等键,由调用方生成,1 到 128 位,只能包含字母、数字和 _ . : -。同一个键重复提交会返回第一次的结果,不会重复创建;请求超时或结果不明时用原键和原参数重试,新的请求换一个新键。最长 128 个字符

请求示例 ​

示例里的 ID、幂等键等换成实际值。

bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/forms/delete' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "form_ids": [
    "122507"
  ],
  "confirm_token": "1795000600.7d3f1b9e5c2a4e6f8a0b1c3d5e7f9a0b2c4d6e8f0a1b3c5d7e9f1a2b4c6d8e0f",
  "idempotency_key": "form-delete-001"
}'

响应 ​

成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。

字段类型一定返回说明
data.statusstring是处理结果:succeeded 全部成功;partial_success 主体已保存,但有未确认的部分,见 errors。可选值:succeeded、partial_success
data.deletedstring[]是已删除的 ID
data.errorsobject[]是删除失败的项;全部成功时为空数组
data.errors[].form_idstring是删除失败的 ID
data.errors[].codestring是错误码
data.errors[].retryableboolean是原样重试是否可能成功
data.warningsobject[]是不影响结果的提示;没有时为空数组
data.warnings[].codestring是提示码
data.warnings[].messagestring否提示说明
data.warnings[].pathstring否相关字段在请求体中的位置
data.warnings[].next_actionstring否建议的下一步

响应示例 ​

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "status": "succeeded",
    "deleted": [
      "122507"
    ],
    "errors": [],
    "warnings": []
  }
}

常见错误 ​

AI_DELETE_DISABLED、DELETE_CONFIRMATION_REQUIRED、PERMISSION_DENIED、FORM_NOT_FOUND、FORM_IN_USE、IDEMPOTENCY_CONFLICT、IDEMPOTENCY_IN_PROGRESS、IDEMPOTENCY_OUTCOME_UNKNOWN。含义和处理方式见业务错误码。


本页由 openapi.json 生成。全部接口见接口清单。