# 创建基础信息模板

创建基础信息模板，字段支持 text/textarea/number/date/image/file，可带正文图文组件并绑定已有表单。需要幂等键 idempotency_key，重试复用原键；返回 partial_success 时保留已建的模板 ID，不要重新创建。

## 请求

```text
POST https://open.cli.im/api/v2/rpc/templates/create
```

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

## 请求参数

请求体为 JSON。

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `idempotency_key` | string | 是 | 幂等键，由调用方生成，1 到 128 位，只能包含字母、数字和 _ . : -。同一个键重复提交会返回第一次的结果，不会重复创建；请求超时或结果不明时用原键和原参数重试，新的请求换一个新键。最长 128 个字符 |
| `name` | string | 是 | 模板名称。最长 100 个字符 |
| `project_id` | integer | 否 | 分区 ID，0 为默认分区（不代表全部分区）。可用的分区用 qrcodes/listCreateTargets 查询。默认 `0` |
| `category_id` | integer | 否 | 模板存放的目录 ID，通常不用传。实际存放位置以返回的 category_id 为准。默认 `0` |
| `groups` | object[] | 是 | 基础信息分组，1 到 20 个。至少 1 项。最多 20 项 |
| `groups[].group_id` | string | 是 | 分组标识。新分组由调用方自定；已有分组用 templates/getSchema 返回的 group_id。最长 128 个字符 |
| `groups[].name` | string | 是 | 分组名称，可以是空字符串。最长 200 个字符 |
| `groups[].fields` | object[] | 是 | 分组内的字段，1 到 100 个。至少 1 项。最多 100 项 |
| `groups[].fields[].field_id` | string | 是 | 字段标识。新字段由调用方自定（字母、数字、下划线、短横线），保存后的字段 ID 见返回的 field_mapping；已有字段用 templates/getSchema 返回的 field_id。最长 128 个字符 |
| `groups[].fields[].name` | string | 是 | 字段名称。最长 100 个字符 |
| `groups[].fields[].type` | string | 是 | 字段类型：text 单行文本、textarea 多行文本、number 数字、date 日期（YYYY-MM-DD）、image 图片、file 附件。可选值：`text`、`textarea`、`number`、`date`、`image`、`file` |
| `groups[].fields[].required` | boolean | 否 | 是否必填，默认 false。默认 `false` |
| `groups[].fields[].variable` | boolean | 否 | true（默认）表示每个子码各自填写；false 表示公共字段，所有子码共用 public_value 的内容。默认 `true` |
| `groups[].fields[].public_value` | any | 否 | 公共字段的内容，仅 variable 为 false 时使用。图片、附件传 [{"file_key": ...}]，file_key 取自 assets/requestUpload |
| `name_rule` | any[] | 否 | 子码命名规则，按顺序拼接固定文字和字段值，如 [{"type":"cmpId","value":"employee_no"},{"type":"text","value":"-"},{"type":"cmpId","value":"employee_name"}]；cmpId 的 value 是本次 groups 里的 field_id，不是字段名称。最多 100 项 |
| `forms` | object[] | 否 | 要绑定的已有表单，最多 10 个；子码沿用模板的表单和周期。最多 10 项 |
| `forms[].form_id` | string | 是 | 要绑定的表单 ID，取自 forms/create 或 record/getFormList |
| `forms[].title` | string | 是 | 页面上填写按钮的文字。最长 100 个字符 |
| `components` | object[] | 否 | 模板正文的图文内容，按顺序排列富文本、图片、图集、文件和按钮，所有子码共用；用 basic_info 标出基础信息的位置，不标时基础信息在最前。最多 50 项 |

### components 中 type 为 `rich_text` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `components[].type` | 固定值 "rich_text" | 是 | 固定为 rich_text，富文本 |
| `components[].blocks` | object[] | 是 | 内容块，按顺序排列：标题、段落或列表。至少 1 项。最多 100 项 |

### components[].blocks 的一种写法（DisplayTextBlock）

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `components[].blocks[].type` | string | 是 | heading 标题；paragraph 段落。可选值：`heading`、`paragraph` |
| `components[].blocks[].text` | string | 是 | 纯文本，不解析 HTML 或 Markdown。最长 10000 个字符 |

### components[].blocks 的一种写法（DisplayListBlock）

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `components[].blocks[].type` | string | 是 | bullet_list 无序列表；numbered_list 有序列表。可选值：`bullet_list`、`numbered_list` |
| `components[].blocks[].items` | string[] | 是 | 列表项，纯文本。至少 1 项。最多 100 项 |

### components 中 type 为 `image` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `components[].file_key` | string | 是 | 图片的 file_key，取自 assets/requestUpload，并已由 assets/getUpload 确认状态为 temporary_available。不接受外部网址。最长 512 个字符 |
| `components[].type` | 固定值 "image" | 是 | 固定为 image，单张图片 |

### components 中 type 为 `file` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `components[].file_key` | string | 是 | 文件的 file_key，取自 assets/requestUpload，并已确认状态为 temporary_available。页面上显示上传时的文件名，默认允许下载；不接受外部网址。最长 512 个字符 |
| `components[].type` | 固定值 "file" | 是 | 固定为 file，文件 |

### components 中 type 为 `gallery` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `components[].type` | 固定值 "gallery" | 是 | 固定为 gallery，图集 |
| `components[].items` | object[] | 是 | 图片，1 到 10 张。至少 1 项。最多 10 项 |
| `components[].items[].file_key` | string | 是 | 图片的 file_key，取自 assets/requestUpload，并已由 assets/getUpload 确认状态为 temporary_available。不接受外部网址。最长 512 个字符 |

### components 中 type 为 `button` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `components[].type` | 固定值 "button" | 是 | 固定为 button，链接按钮 |
| `components[].text` | string | 是 | 按钮文字。最长 100 个字符 |
| `components[].url` | string | 是 | 按钮跳转的地址，须为绝对 HTTP(S) 地址且只含 ASCII 字符：中文域名用 punycode，中文路径和参数用百分号编码；不能带登录凭证。最长 2048 个字符 |

### components 中 type 为 `basic_info` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `components[].type` | 固定值 "basic_info" | 是 | 固定为 basic_info，标出基础信息（groups）在页面上的位置；最多一个，且 groups 不能为空 |

## 请求示例

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

```bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/templates/create' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "idempotency_key": "tpl-equipment-001",
  "name": "设备档案",
  "project_id": 0,
  "groups": [
    {
      "group_id": "info",
      "name": "设备信息",
      "fields": [
        {
          "field_id": "device_name",
          "name": "设备名称",
          "type": "text",
          "required": true
        },
        {
          "field_id": "device_photo",
          "name": "设备照片",
          "type": "image"
        },
        {
          "field_id": "vendor",
          "name": "维保单位",
          "type": "text",
          "variable": false,
          "public_value": "示例维保公司"
        }
      ]
    }
  ],
  "name_rule": [
    {
      "type": "cmpId",
      "value": "device_name"
    }
  ]
}'
```

## 响应

成功时 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.template_id` | string | 是 | 模板 ID |
| `data.coding` | string | 是 | 模板的短编号 |
| `data.web_url` | string | 是 | 模板的扫码地址 |
| `data.project_id` | integer | 是 | 模板所在分区 ID，0 为默认分区 |
| `data.category_id` | integer | 是 | 模板所在目录 ID |
| `data.name` | string | 是 | 模板名称 |
| `data.template_version` | string | 是 | 模板版本。预校验、提交和修改时原样传回；模板变化后需要重新读取 |
| `data.groups` | object[] | 是 | 字段分组 |
| `data.groups[].group_id` | string | 是 | 分组 ID |
| `data.groups[].name` | string | 是 | 分组名称 |
| `data.groups[].fields` | object[] | 是 | 分组内的字段 |
| `data.groups[].fields[].field_id` | string | 是 | 字段 ID，填值时作为 values 的键 |
| `data.groups[].fields[].name` | string | 是 | 字段名称 |
| `data.groups[].fields[].type` | string | 是 | 字段类型：text 单行文本、textarea 多行文本、number 数字、date 日期、image 图片、file 附件 |
| `data.groups[].fields[].variable` | boolean | 是 | true 表示每个码各自填写；false 表示所有码共用同一内容（公共字段） |
| `data.groups[].fields[].required` | boolean | 是 | 是否必填 |
| `data.groups[].fields[].max_length` | integer | 否 | 文本类字段的最大长度 |
| `data.groups[].fields[].max_count` | integer | 否 | 图片、附件字段最多可放的文件数 |
| `data.groups[].fields[].example` | any | 否 | 该类型字段的取值示例 |
| `data.groups[].fields[].public_value` | any | 否 | 公共字段的当前内容；图片、附件以 [{"existing_resource_id": ...}] 引用已有文件，修改时原样传回即保留 |
| `data.name_rule` | any[] | 是 | 子码命名规则，按顺序拼接；没有规则时为空数组 |
| `data.unsupported_fields` | object[] | 是 | 模板里不能通过接口填写的字段 |
| `data.unsupported_fields[].field_id` | string | 是 | 字段 ID |
| `data.unsupported_fields[].name` | string | 是 | 字段名称 |
| `data.unsupported_fields[].type` | string | 是 | 字段类型 |
| `data.unsupported_fields[].variable` | boolean | 是 | 是否每个码各自填写 |
| `data.unsupported_fields[].required` | boolean | 是 | 是否必填 |
| `data.capabilities` | object | 是 | 这个模板支持的操作 |
| `data.capabilities.types` | string[] | 是 | 可填写的字段类型 |
| `data.capabilities.delete_field` | boolean | 是 | 是否可以删除字段，目前固定为 false |
| `data.capabilities.change_type` | boolean | 是 | 是否可以修改字段类型，目前固定为 false |
| `data.capabilities.edit` | boolean | 是 | 是否可以通过 templates/edit 修改名称和字段 |
| `data.capabilities.create_children` | boolean | 是 | 是否可以用它批量建码 |
| `data.capabilities.replace_components` | boolean | 是 | 是否可以通过 templates/edit 的 patch.components 修改正文图文组件 |
| `data.capabilities.unsupported_reasons` | string[] | 是 | 不支持某些操作的原因 |
| `data.capabilities.blockers` | object[] | 是 | 阻止批量建码的问题；为空表示可以建码 |
| `data.capabilities.blockers[].code` | string | 是 | 错误码，含义见规范顶层的 x-error-catalog |
| `data.capabilities.blockers[].path` | string | 否 | 出错字段在请求体中的位置，如 items.0.values.12345；没有具体位置时为空字符串 |
| `data.capabilities.blockers[].item_key` | string | 否 | 批量数据中出错那一项的 item_key；不针对某一项时为空字符串 |
| `data.capabilities.blockers[].retryable` | boolean | 否 | 原样重试是否可能成功 |
| `data.capabilities.blockers[].next_action` | string | 否 | 建议的下一步：correct_input 修正入参；retry_later 稍后重试；retry_same_idempotency_key 用原幂等键重试；inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对 |
| `data.capabilities.blockers[].message` | string | 否 | 补充说明，部分错误才有 |
| `data.components` | object[] | 是 | 页面上可通过接口管理的图文组件，按页面顺序 |
| `data.components[].ref` | string | 否 | 组件引用，如 c_123。修改时用 {"type":"keep","ref":...} 保留该组件，或在新内容上带 ref 原地替换 |
| `data.components[].type` | string | 是 | 组件类型：basic_info 基础信息；rich_text 富文本；gallery 图片或图集；file 文件；button 链接按钮。可选值：`basic_info`、`rich_text`、`gallery`、`file`、`button` |
| `data.components[].html` | string | 否 | rich_text：保存后的富文本 HTML |
| `data.components[].items` | object[] | 否 | gallery：图片列表 |
| `data.components[].items[].url` | string | 是 | 图片地址 |
| `data.components[].url` | string | 否 | file：文件地址；button：跳转地址 |
| `data.components[].name` | string | 否 | file：文件名 |
| `data.components[].text` | string | 否 | button：按钮文字 |
| `data.field_mapping` | object | 是 | 请求中的 field_id 到保存后字段 ID 的对应关系，后续填值和修改都用保存后的字段 ID |
| `data.warnings` | object[] | 否 | 不影响结果的提示；没有时为空数组 |
| `data.warnings[].code` | string | 是 | 提示码 |
| `data.warnings[].message` | string | 否 | 提示说明 |
| `data.warnings[].path` | string | 否 | 相关字段在请求体中的位置 |
| `data.warnings[].next_action` | string | 否 | 建议的下一步 |
| `data.status` | string | 否 | 处理结果：succeeded 全部成功；partial_success 主体已保存，但有未确认的部分，见 errors。可选值：`succeeded`、`partial_success` |
| `data.errors` | object[] | 否 | 未成功或未确认的部分；全部成功时为空数组 |
| `data.errors[].code` | string | 是 | 错误码，含义见规范顶层的 x-error-catalog |
| `data.errors[].path` | string | 否 | 出错字段在请求体中的位置，如 items.0.values.12345；没有具体位置时为空字符串 |
| `data.errors[].item_key` | string | 否 | 批量数据中出错那一项的 item_key；不针对某一项时为空字符串 |
| `data.errors[].retryable` | boolean | 否 | 原样重试是否可能成功 |
| `data.errors[].next_action` | string | 否 | 建议的下一步：correct_input 修正入参；retry_later 稍后重试；retry_same_idempotency_key 用原幂等键重试；inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对 |
| `data.errors[].message` | string | 否 | 补充说明，部分错误才有 |
| `data.forms` | object[] | 否 | 已绑定的表单；请求里传了 forms 时返回 |
| `data.forms[].form_id` | string | 是 | 表单 ID |
| `data.forms[].title` | string | 是 | 填写按钮标题 |

### 响应示例

```json
{
  "code": 0,
  "message": "ok",
  "data": {
    "template_id": "6801234",
    "coding": "qTpl001",
    "web_url": "https://qr61.cn/oAbCdE/qTpl001",
    "project_id": 0,
    "category_id": 120045,
    "name": "设备档案",
    "template_version": "v_7c1e0f5a9b3d4e6f8a0b2c4d6e8f0a1b3c5d7e9f1a2b4c6d8e0f1a3b5c7d9e0f",
    "groups": [
      {
        "group_id": "g_901_0",
        "name": "设备信息",
        "fields": [
          {
            "field_id": "71399639089153",
            "name": "设备名称",
            "type": "text",
            "variable": true,
            "required": true,
            "max_length": 2000,
            "max_count": 10,
            "example": "001"
          },
          {
            "field_id": "71399639089154",
            "name": "设备照片",
            "type": "image",
            "variable": true,
            "required": false,
            "max_length": 20000,
            "max_count": 10,
            "example": []
          }
        ]
      }
    ],
    "name_rule": [
      {
        "type": "cmpId",
        "value": "71399639089153"
      }
    ],
    "unsupported_fields": [],
    "capabilities": {
      "types": [
        "text",
        "textarea",
        "number",
        "date",
        "image",
        "file"
      ],
      "delete_field": false,
      "change_type": false,
      "edit": true,
      "create_children": true,
      "unsupported_reasons": [],
      "blockers": [],
      "replace_components": true
    },
    "components": [
      {
        "ref": "c_901",
        "type": "basic_info"
      }
    ],
    "field_mapping": {
      "device_name": "71399639089153",
      "device_photo": "71399639089154",
      "vendor": "public_901_0_2"
    }
  }
}
```

## 常见错误

`PERMISSION_DENIED`、`ACCESS_LEVEL_READ_ONLY`、`quota_exceeded`、`IDEMPOTENCY_CONFLICT`、`IDEMPOTENCY_IN_PROGRESS`、`IDEMPOTENCY_OUTCOME_UNKNOWN`、`CATEGORY_DENIED`、`URL_BLOCKED`、`ASSET_UNAVAILABLE`、`FORM_BINDING_UNCONFIRMED`、`CATEGORY_PLACEMENT_ADJUSTED`、`AI_ORIGIN_MARK_FAILED`。含义和处理方式见[业务错误码](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)。
