# 获取电子签模板内容
根据多个模板ID获取电子签模板基本信息和内容列表。
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/signature_templates/search
HTTP Method | GET
接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 获取电子签模板信息(corehr:signature_template:read)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
### 查询参数
名称 | 类型 | 必填 | 描述
---|---|---|---
template_ids | string | 否 | 电子签模板ids，用英文逗号分隔；如果不传 则返回所有电子签模版信息
**示例值**：7223256427270260268,7182520625066475540
select_custom_field | boolean | 否 | 是否需要模板自定义字段，如果不需要，则默认只返回模板的系统字段。
**示例值**：true
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
signature_templates | signature_template\[\] | 返回的电子签模板列表
id | string | 电子签模板id
brief_info | signature_template_brief_info | 模板基本信息
id | string | 电子签模板id
label | i18n\[\] | 模板名称
lang | string | 语言
value | string | 模板名
category | enum | 电子签模板分类，枚举值可通过文档[【飞书人事枚举常量】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)电子签模板类型（signature_template_category）枚举定义部分获得
enum_name | string | 模板类别名称
display | i18n\[\] | 模板类别对应的多语展示
lang | string | 语言
value | string | 中文
usage | enum | 电子签模板用途，枚举值可通过文档[【飞书人事枚举常量】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)电子签模板用途（signature_template_usage）枚举定义部分获得
enum_name | string | 模板用途名称
display | i18n\[\] | 模板用途的多语展示
lang | string | 语言
value | string | 人事合同 / 协议
signatory_labels | signature_signatory_label\[\] | 模版签署对象
template_signatory_type | enum | 电子签模板签署对象类型，枚举值可通过文档[【飞书人事枚举常量】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)电子签模板签署对象类型（signature_template_signatory_type）枚举定义部分获得
enum_name | string | 模板签署对象类型对应的枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言
value | string | 中文
label | i18n\[\] | 字段多语展示
lang | string | 语言
value | string | 文本内容
apiname | string | 模板签署类型名
active | boolean | 是否激活
create_by | string | 创建人的雇佣ID，详细信息可通过[【查询员工信息接口】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)获取
modify_by | string | 修改人的雇佣ID，详细信息可通过[【查询员工信息接口】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)获取
applicability | enum | 电子签模板适用范围，枚举值可通过文档[【飞书人事枚举常量】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)电子签模板适用范围（signature_template_applicability）枚举定义部分
enum_name | string | 模板适用范围枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言
value | string | 文本内容
creation_method | string | 模板创建方式
version | string | 版本
update_time | string | 更新时间
create_time | string | 创建时间
template_setting | signature_template_setting | 模板设置
page_seal_types | string\[\] | 骑缝章类型
template_region_info | signature_template_region_info | 模板适用区域
is_global_scope | string | 是否全球适用
meta_infos | signature_meta_info\[\] | 适用区域名称
api_name | string | 区域名称apiName
wk_id | string | 区域对应的唯一ID
label | i18n\[\] | 多语描述
lang | string | 语言
value | string | 文本内容
template_code | string | 模板编码
template_desc | i18n\[\] | 模板描述 支持多语
lang | string | 语言
value | string | 文本内容
content_info | signature_template_content_info | 模板内容
contents | signature_template_content_item\[\] | 【已废弃，无需关注】
content_type | enum | 电子签模版内容的类型
enum_name | string | 枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言
value | string | 文本内容
filter_apiname | string | 显示规则左值
content | string | 模版内容
label | i18n\[\] | 中英文描述
lang | string | 语言编码（IETF BCP 47）
value | string | 文本内容
content_desc | string | 内容描述
custom_fields | signature_template_custom_field\[\] | 自定义字段列表
label | i18n\[\] | 中英文描述
lang | string | 语言
value | string | 文本内容
apiname | string | 字段名
custom_field_type | enum | 用户自定义字段类型
enum_name | string | 枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言编码（IETF BCP 47）
value | string | 文本内容
used | boolean | 是否使用到
is_required | boolean | 是否需要
custom_desc | string | 自定义描述
common_info | signature_template_common_field_info | 电子签模版公共字段信息
source | enum | 模板字段源类型；枚举值填到enum_name中，如："System" "MainData"
enum_name | string | 枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言编码（IETF BCP 47）
value | string | 文本内容
apiname | string | 主数据apiname
filter_fields | signature_template_filter\[\] | 【已废弃，无需关注】
label | i18n\[\] | 双语描述
lang | string | 语言编码（IETF BCP 47）
value | string | 文本内容
apiname | string | 主数据apiname
filters | signature_template_filter_item\[\] | 过滤条件列表
left | string | 左值
rights | string\[\] | 右值列表
op | enum | 操作符
enum_name | string | 枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言编码（IETF BCP 47）
value | string | 文本内容
logic | enum | 多个生效条件的logic
enum_name | string | 枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言编码（IETF BCP 47）
value | string | 文本内容
is_checked | boolean | 是否被校验
filter_desc | string | 过滤条件描述
criterion_list | string | 过滤条件列表，使用string类型描述list的原因是为了避免循环引用问题，因为该list的item类型就是这个数据类型
using_fields | signature_template_common_field_info\[\] | 【已废弃，无需关注】
source | enum | 模板字段源类型；枚举值填到enum_name中，如："System" "MainData"
enum_name | string | 枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言编码（IETF BCP 47）
value | string | 文本内容
apiname | string | 字段名
system_setting_fields | signature_template_field\[\] | 系统字段列表
field_type | enum | 模板字段值类型枚举
enum_name | string | 枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言
value | string | 文本内容
label | i18n\[\] | 双语描述
lang | string | 语言
value | string | 文本内容
common_info | signature_template_common_field_info | 【无需关注】通用字段信息
source | enum | 模板字段源类型
- System
- MainData
enum_name | string | 枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言
value | string | 文本内容
apiname | string | 字段名称
combination_info | signature_template_combination_field_info | 【无需关注】组合字段信息
total_apiname | string | 【无需关注】组合字段名
apiname | string | 字段名
title | i18n\[\] | 中英文描述
lang | string | 语言
value | string | 文本内容
contents | signature_template_combination_sub_field_info\[\]\[\] | 适用区域名称
source | enum | 【无需关注】电子签模板字段源类型
enum_name | string | 枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言编码（IETF BCP 47）
value | string | 文本内容
children | string | 【无需关注】子模板配置信息列表对应的string，避免循环引用问题
combination_info_v2 | signature_template_combination_field_info_v2 | 弃用，无需关注
total_apiname | string | 弃用，无需关注
apiname | string | 弃用，无需关注
source | enum | 弃用，无需关注
enum_name | string | 枚举值
display | i18n\[\] | 枚举多语展示
lang | string | 语言编码（IETF BCP 47）
value | string | 文本内容
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {
"signature_templates": [
{
"id": "7246307700768902956",
"brief_info": {
"id": "1",
"label": [
{
"lang": "zh-CN",
"value": "合同续约模板"
}
],
"category": {
"enum_name": "contract_agreement",
"display": [
{
"lang": "zh-CN",
"value": "人事合同 / 协议"
}
]
},
"usage": {
"enum_name": "offboarding",
"display": [
{
"lang": "zh-CN",
"value": "离职"
}
]
},
"signatory_labels": [
{
"template_signatory_type": {
"enum_name": "Person",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"label": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"apiname": "status"
}
],
"active": true,
"create_by": "123123123123123123",
"modify_by": "7287500478366090796",
"applicability": {
"enum_name": "signature",
"display": [
{
"lang": "zh-CN",
"value": "电子签"
}
]
},
"creation_method": "online_edit",
"version": "v1",
"update_time": "31231232123",
"create_time": "3123123211",
"template_setting": {
"page_seal_types": [
"page_seal"
]
},
"template_region_info": {
"is_global_scope": "global",
"meta_infos": [
{
"api_name": "7246307700768902956",
"wk_id": "7246307700768902956",
"label": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
}
]
},
"template_code": "7246307700768902956",
"template_desc": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"content_info": {
"contents": [
{
"content_type": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"filter_apiname": "111",
"content": "111",
"label": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"content_desc": "111"
}
],
"custom_fields": [
{
"label": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"apiname": "status",
"custom_field_type": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"used": true,
"is_required": true,
"custom_desc": "desc",
"common_info": {
"source": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"apiname": "status"
}
}
],
"filter_fields": [
{
"label": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"apiname": "status",
"filters": [
{
"left": "aa",
"rights": [
"1"
],
"op": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
}
}
],
"logic": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"is_checked": true,
"filter_desc": "desc",
"criterion_list": "[]"
}
],
"using_fields": [
{
"source": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"apiname": "status"
}
],
"system_setting_fields": [
{
"field_type": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"label": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"common_info": {
"source": {
"enum_name": "System",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"apiname": "status"
},
"combination_info": {
"total_apiname": "status",
"apiname": "status",
"title": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"contents": [
[
{
"field_type": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"info": {
"source": {
"enum_name": "System",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"apiname": "status"
},
"label": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
}
]
],
"source": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
}
},
"children": "无需关注",
"combination_info_v2": {
"total_apiname": "弃用，无需关注",
"apiname": "弃用，无需关注",
"source": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
}
}
}
]
}
}
]
}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1160001 | param is invalid | 请检查请求参数的类型、格式是否与接口要求一致（如template_ids需用英文逗号分隔，select_custom_field为boolean类型），或参考文档确认参数的必填项及示例值