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

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

## 请求

```text
POST https://open.cli.im/api/v2/rpc/forms/previewDelete
```

| 项目 | 要求 |
|---|---|
| 最低权限 | 完全，见[权限档位](https://cli.im/open-api/openapi/v2/auth.md#org-policy) |
| 需要的 scope | `templates.write`、`content.delete` |
| 组织 Key | 不能调用，返回 403 `credential_type_not_allowed`，见[历史组织 Key](https://cli.im/open-api/openapi/v2/auth.md#org-key) |

相关调用流程：[修改和删除码、表单](https://cli.im/open-api/openapi/v2/scenarios/edit-and-delete.md)。

## 请求参数

请求体为 JSON。

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `form_ids` | string[] | 是 | 要删除的表单 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` 里。失败时的返回见[错误码与调用额度](https://cli.im/open-api/openapi/v2/error-codes.md)和[业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md)。

| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
| `data.count` | integer | 是 | 将被删除的数量 |
| `data.items` | object[] | 是 | 将被删除的内容 |
| `data.items[].form_id` | string | 是 | 表单 ID |
| `data.items[].name` | string | 是 | 表单名称 |
| `data.items[].ai_created` | boolean | 是 | 是否是通过接口创建的内容 |
| `data.expires_at` | integer | 是 | confirm_token 的过期时间（Unix 秒） |
| `data.confirm_token` | string | 是 | 确认令牌，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`。含义和处理方式见[业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md)。

---

本页由 [openapi.json](https://cli.im/open-api/openapi/v2/overview.md#%E6%8E%A5%E5%8F%A3%E8%A7%84%E8%8C%83-openapi-json) 生成。全部接口见[接口清单](https://cli.im/open-api/openapi/v2/api-index.md)。
