跳到主要内容

查询模板信息

1. 接口描述

接口请求域名: ess.tencentcloudapi.com 。

此接口(DescribeFlowTemplates)用于查询本企业模板列表信息。

适用场景 该接口常用来配合模板发起合同-创建电子文档接口,作为创建电子文档的前置接口使用。 通过此接口查询到模板信息后,再通过调用创建电子文档接口,指定模板ID,指定模板中需要的填写控件内容等,完成电子文档的创建。

一个模板通常会包含以下结构信息

  • 模板模板ID, 模板名字等基本信息
  • 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
  • 发起方和签署方的填写控件 Components
  • 签署方的签署控件 SignComponents

image

模板中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联) image

默认接口请求频率限制:300次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称必选类型描述
ActionString公共参数,本接口取值:DescribeFlowTemplates。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
AgentAgent代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
ContentTypeInteger查询内容控制

  • 0:模板列表及详情(默认)
  • 1:仅模板列表
Filters.NArray of Filter搜索条件,本字段用于指定模板Id进行查询。
Key:template-id Values:需要查询的模板Id列表
示例值:Filters
OffsetInteger查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。

注:1.offset从0开始,即第一页为0。
2.默认从第一页返回。
示例值:0
LimitInteger指定每页返回的数据条数,和Offset参数配合使用。

注:1.默认值为20,单页做大值为200。
示例值:20
ApplicationIdString指定查询的应用号,指定后查询该应用号下的模板列表。

注:1.ApplicationId为空时,查询所有应用下的模板列表。
WithPreviewUrlBoolean是否获取模板预览链接

3. 输出参数

参数名称类型描述
TemplatesArray of TemplateInfo模板详情列表数据
TotalCountInteger查询到的模板总数
示例值:10
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 模板查询接口-指定模板Id查询模板信息

1.指定Filters中的Key通过template-id过滤 2.指定Filter中的Value为yDRS4UUgygqdcjjhUuO4zjEBpXdcsHWX 3.指定Limit为最多返回20条数据

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFlowTemplates
<公共请求参数>

{
"Operator": {
"Channel": "YUFU",
"ClientIp": "8.8.8.8",
"OpenId": "",
"UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
},
"Offset": 0,
"Limit": 20,
"ApplicationId": "",
"Filters": [
{
"Key": "template-id",
"Values": [
"yDRS4UUgygqdcjjhUuO4zjEBpXdcsHWX"
]
}
]
}

输出示例

{
"Response": {
"RequestId": "s16951208061xxxx3957",
"Templates": [
{
"AttachmentResourceIds": [],
"Available": 2,
"Components": [],
"CreatedOn": 1693967458,
"Creator": "测试人",
"CreatorId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
"Description": "",
"DocumentResourceIds": [
"yDwJ0UUckpk2079mUxgm9jJ8EZp3aAc0"
],
"FileInfos": [
{
"CreatedOn": 1693967456,
"FileId": "yDwJ0UUckpk2079mUxgm9jJ8EZp3aAc0",
"FileName": "test.pdf",
"FileSize": 65259
}
],
"OrganizationId": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
"PreviewUrl": "",
"Promoter": {
"ApproverSignTypes": [],
"ApproverVerifyTypes": [],
"DeliveryMethod": "EMAIL",
"Description": "",
"Email": "",
"Mobile": "",
"RecipientExtra": "",
"RecipientId": "yDwJBUUckpk5469kUu9cFsf1x6ZYgfu5",
"RecipientType": "PROMOTER",
"RequireDelivery": false,
"RequireSign": false,
"RequireValidation": false,
"RoleName": "发起人",
"RoutingOrder": 0,
"UserId": ""
},
"Published": true,
"Recipients": [
{
"ApproverSignTypes": [
1,
2
],
"ApproverVerifyTypes": [
1
],
"DeliveryMethod": "EMAIL",
"Description": "",
"Email": "",
"Mobile": "",
"RecipientExtra": "{\"RecipientEnterpriseType\":1,\"SameWithPromoter\":true}",
"RecipientId": "yDwJ0UUckpk2077lUxgm9jJ9eZgZChJe",
"RecipientType": "ENTERPRISE",
"RequireDelivery": false,
"RequireSign": false,
"RequireValidation": false,
"RoleName": "张三示例企业",
"RoutingOrder": 1,
"UserId": ""
},
{
"ApproverSignTypes": [
1,
2
],
"ApproverVerifyTypes": [
1
],
"DeliveryMethod": "EMAIL",
"Description": "",
"Email": "",
"Mobile": "",
"RecipientExtra": "{}",
"RecipientId": "yDxZzUyKQDKuihUuO4zjEy09jfapyHjn",
"RecipientType": "INDIVIDUAL",
"RequireDelivery": false,
"RequireSign": false,
"RequireValidation": false,
"RoleName": "乙方",
"RoutingOrder": 2,
"UserId": ""
}
],
"Seals": [],
"ShareTemplateId": "",
"SignComponents": [
{
"ChannelComponentId": "",
"ChannelComponentSource": 0,
"ComponentDateFontSize": 0,
"ComponentExtra": "{\"Date\":true,\"isAfterCut\":false}",
"ComponentHeight": 43,
"ComponentId": "ComponentId_4",
"ComponentName": "个人签名/印章",
"ComponentPage": 1,
"ComponentPosX": 10.5,
"ComponentPosY": 27,
"ComponentRecipientId": "yDxZzUyKQDKuihUuO4zjEy09jfapyHjn",
"ComponentRequired": true,
"ComponentType": "SIGN_SIGNATURE",
"ComponentValue": "",
"ComponentWidth": 119,
"FileIndex": 0,
"ForbidMoveAndDelete": false,
"GenerateMode": "",
"KeywordIndexes": [],
"KeywordOrder": "",
"KeywordPage": 0,
"LockComponentValue": false,
"OffsetX": 0,
"OffsetY": 0,
"RelativeLocation": "",
"IsFormType": false
},
{
"ChannelComponentId": "",
"ChannelComponentSource": 0,
"ComponentDateFontSize": 0,
"ComponentExtra": "{\"Format\":\"yyyy年m月d日\",\"Gaps\":\"2,2\",\"FontSize\":12,\"FontAlign\":\"Center\",\"Font\":\"黑体\",\"isAfterCut\":false}",
"ComponentHeight": 20,
"ComponentId": "ComponentId_5",
"ComponentName": "签署日期",
"ComponentPage": 1,
"ComponentPosX": 10.5,
"ComponentPosY": 70,
"ComponentRecipientId": "yDxZzUyKQDKuihUuO4zjEy09jfapyHjn",
"ComponentRequired": true,
"ComponentType": "SIGN_DATE",
"ComponentValue": "",
"ComponentWidth": 119,
"FileIndex": 0,
"ForbidMoveAndDelete": false,
"GenerateMode": "",
"KeywordIndexes": [],
"KeywordOrder": "",
"KeywordPage": 0,
"LockComponentValue": false,
"OffsetX": 0,
"OffsetY": 0,
"RelativeLocation": "",
"IsFormType": false
},
{
"ChannelComponentId": "",
"ChannelComponentSource": 0,
"ComponentDateFontSize": 0,
"ComponentExtra": "{\"Date\":true,\"isAfterCut\":false,\"PageRanges\":[]}",
"ComponentHeight": 119,
"ComponentId": "ComponentId_7",
"ComponentName": "企业印章",
"ComponentPage": 1,
"ComponentPosX": 140.5,
"ComponentPosY": 27,
"ComponentRecipientId": "yDwJ0UUckpk2077lUxgm9jJ9eZgZChJe",
"ComponentRequired": true,
"ComponentType": "SIGN_SEAL",
"ComponentValue": "",
"ComponentWidth": 119,
"FileIndex": 0,
"ForbidMoveAndDelete": false,
"GenerateMode": "",
"KeywordIndexes": [],
"KeywordOrder": "",
"KeywordPage": 0,
"LockComponentValue": false,
"OffsetX": 0,
"OffsetY": 0,
"RelativeLocation": "",
"IsFormType": false
},
{
"ChannelComponentId": "",
"ChannelComponentSource": 0,
"ComponentDateFontSize": 0,
"ComponentExtra": "{\"Format\":\"yyyy年m月d日\",\"Gaps\":\"2,2\",\"FontSize\":12,\"FontAlign\":\"Center\",\"Font\":\"黑体\",\"isAfterCut\":false}",
"ComponentHeight": 20,
"ComponentId": "ComponentId_8",
"ComponentName": "签署日期1",
"ComponentPage": 1,
"ComponentPosX": 140.5,
"ComponentPosY": 146,
"ComponentRecipientId": "yDwJ0UUckpk2077lUxgm9jJ9eZgZChJe",
"ComponentRequired": true,
"ComponentType": "SIGN_DATE",
"ComponentValue": "",
"ComponentWidth": 119,
"FileIndex": 0,
"ForbidMoveAndDelete": false,
"GenerateMode": "",
"KeywordIndexes": [],
"KeywordOrder": "",
"KeywordPage": 0,
"LockComponentValue": false,
"OffsetX": 0,
"OffsetY": 0,
"RelativeLocation": "",
"IsFormType": false
}
],
"SignOrder": [
-1
],
"Status": 1,
"TemplateId": "yDRS4UUgygqdcjjhUuO4zjEBpXdcsHWX",
"TemplateName": "e2eTest-启停用模板_88433",
"TemplateSeals": [],
"TemplateType": 3,
"TemplateVersion": "20230906002",
"UserFlowType": {
"Description": "",
"Name": "未分类",
"UserFlowTypeId": ""
}
}
],
"TotalCount": 1
}
}

示例2 模板查询接口-通过不存在的模板Id查询模板信息

1.指定一个不存在的模板ID进行查询

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFlowTemplates
<公共请求参数>

{
"Operator": {
"Channel": "YUFU",
"ClientIp": "8.8.8.8",
"OpenId": "",
"UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
},
"Offset": 0,
"Limit": 20,
"ApplicationId": "",
"Filters": [
{
"Key": "template-id",
"Values": [
"yDRS4UUgygqdcjjhUuO4zjEBpXdcsHWw"
]
}
]
}

输出示例

{
"Response": {
"RequestId": "s1695125479063466836",
"Templates": [],
"TotalCount": 0
}
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码描述
FailedOperation操作失败。
FailedOperation.NotFoundShadowUser未找到集团子企业相关用户信息,请检查用户相关参数
InternalError内部错误。
InternalError.Db数据库异常。
InternalError.DependsApi依赖的第三方API返回错误。
InternalError.DependsDb数据库执行错误。
InternalError.System系统错误,请稍后重试。
InvalidParameter参数错误。
InvalidParameter.ContentType不合法的模板查询类型,请检查后重试。
InvalidParameter.ParamError参数错误。
InvalidParameterValue参数取值错误。
MissingParameter缺少参数错误。
MissingParameter.UserId缺少用户id,请检查后重试。
OperationDenied操作被拒绝。
OperationDenied.ErrNoResourceAccess此企业无该资源使用权限。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoIdentityVerify未通过个人实名认证。
OperationDenied.SubOrgNotJoin子企业暂未加入。
ResourceNotFound.Application应用号不存在或已删除。
ResourceNotFound.Template模板不存在,请检查模板参数,模板配置,并稍后重试。
ResourceUnavailable资源不可用。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062