Skip to content

预览要删除的表单并取得确认令牌,不删除 ​

删除表单之前必须先调用:复核权限并确认表单未关联任何码、不是系统表单,返回 items 和 10 分钟内有效的 confirm_token,不做任何修改。还有码在使用这张表单时返回 FORM_IN_USE。

请求 ​

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

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

请求参数 ​

请求体为 JSON。

字段类型必填说明
form_idsstring[]是要删除的表单 ID,一次最多 5 个,不能重复;已关联码的表单不能删除。至少 1 项。最多 5 项

请求示例 ​

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

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

响应 ​

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

字段类型一定返回说明
data.countinteger是将被删除的数量
data.itemsobject[]是将被删除的内容
data.items[].form_idstring是表单 ID
data.items[].namestring是表单名称
data.items[].ai_createdboolean是是否是通过接口创建的内容
data.expires_atinteger是confirm_token 的过期时间(Unix 秒)
data.confirm_tokenstring是确认令牌,10 分钟内有效,只能用于删除这一批目标

响应示例 ​

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "count": 1,
    "items": [
      {
        "form_id": "122507",
        "name": "设备巡检",
        "ai_created": true
      }
    ],
    "expires_at": 1795000600,
    "confirm_token": "1795000600.7d3f1b9e5c2a4e6f8a0b1c3d5e7f9a0b2c4d6e8f0a1b3c5d7e9f1a2b4c6d8e0f"
  }
}

常见错误 ​

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


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