腾讯电子签查询模板信息

1. 接口描述

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

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

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

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

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFlowTemplates。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
ContentType	否	Integer	查询内容控制 0：模板列表及详情（默认） 1：仅模板列表示例值：1
Filters.N	否	Array of Filter	搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。模板 ID：Key设置为 `template-id` ，Values为您想要查询的模板 ID 列表。主企业模板 ID：Key设置为 `share-template-id` ，Values为您想要查询的主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 Agent.ProxyOrganizationId（子企业的组织ID）为必填项。模板名称：Key设置为 `template-name` ，Values为您想要查询的模板名称列表。模板的用户合同类型：Key设置为 `user-flow-type-id` ，Values为您想要查询的用户模版类型id列表。示例值：Filters
Offset	否	Integer	查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。` 示例值：0
Limit	否	Integer	指定每页返回的数据条数，和Offset参数配合使用。注：`1.默认值为20，单页做大值为200。` 示例值：20
ApplicationId	否	String	通过指定第三方应用的应用号（ApplicationId），您可以查询【应用模板库管理】中某个第三方应用下的模板。注意事项：当 ApplicationId 为空时（默认），系统将查询平台企业的所有模板（自建应用使用的模板）。当 ApplicationId 不为空时，系统将从【应用模板库管理】中查询该特定应用下的模板（分享给第三方应用子企业的模板）。示例值：yDw6yUUgyg3caowzUx4GQptRKfMnJqX8
WithPreviewUrl	否	Boolean	是否获取模板预览链接。 false：不获取（默认） true：需要获取设置为true之后，返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。示例值：false

3. 输出参数

参数名称	类型	描述
Templates	Array of TemplateInfo	模板详情列表数据
TotalCount	Integer	查询到的模板总数示例值：10
RequestId	String	唯一请求 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": {
        "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": "{{\"RecipientEnterpriseType\":1,\"SameWithPromoter\":true}}",
                        "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": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "Offset": 0,
    "Limit": 20,
    "ApplicationId": "",
    "Filters": [
        {
            "Key": "template-id",
            "Values": [
                "yDRS4UUgygqdcjjhUuO4zjEBpXdcsHWw"
            ]
        }
    ]
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
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	未知参数错误。

近期搜索热词

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

私有网络

云函数

API 网关

专线接入

批量计算

对象存储

微服务平台 TSF

文件存储

消息队列 CKafka 版

全站加速网络

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

数据传输服务

全球应用加速

腾讯云区块链服务平台 TBaaS

云拨测

访问管理

主机安全

标签

DDoS 防护

密钥管理系统

Web 应用防火墙

操作审计

域名注册

SSL 证书

短信

数据万象

NLP 技术

云点播

云市场

云加密机

云安全中心

云开发 CloudBase

人脸识别

流计算 Oceanus

腾讯云数据仓库 TCHouse-P

Elasticsearch Service

集团账号管理

图像识别

文字识别

口语评测（基础版）

媒体处理

云直播

云联络中心

机器翻译

物联网通信

人脸融合

弹性 MapReduce

游戏数据库 TcaplusDB

腾讯云 BI

游戏多媒体引擎

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

腾讯云数据仓库 TCHouse-D

数据加速器 GooseFS

知识引擎原子能力

统一 Catalog 服务

声音复刻

文旅客情大数据

实时互动-工业能源版

腾讯健康组学平台

大模型图像创作引擎

云压测

腾讯云微搭低代码