腾讯电子签补充动态签署合同的签署方-控制签署流程相关接口-API 中心-腾讯云

1. 接口描述

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

此接口（CreateDynamicFlowApprover）接口主要用于补充动态签署方2.0合同的签署方信息，包括但不限于名字、手机号和签署区域等信息。

功能开通
动态签署方2.0功能的使用需要先联系产品经理开通模块化计费功能，然后到控制台中打开此功能。详细的使用说明请参考动态签署方2.0文档。

使用条件

在发起合同时，必须将OpenDynamicSignFlow参数设置为true，以确保合同以动态签署方2.0的方式处理，否则默认处理为普通合同。
此接口只能在合同处于非终态时调用。一旦合同进入终态（例如：过期、拒签或撤销），将无法通过此接口添加新的签署方。

动态签署方2.0合同不会自动结束（整个合同变为签署完成），需要通过调用结束动态签署合同来手动结束签署流程。整体的流程如下图

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateDynamicFlowApprover。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。使用此接口时，必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
FlowId	是	String	合同流程ID，为32位字符串示例值：yDt1JUUckp77a2omUyEmko88eg49PTsN
Approvers.N	是	Array of ApproverInfo	合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
AutoSignScene	否	String	个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签） OTHER : 通用场景注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。` 示例值：E_PRESCRIPTION_AUTO_SIGN

3. 输出参数

参数名称	类型	描述
FlowId	String	合同流程ID，为32位字符串示例值：yDt1JUUckp77a2omUyEmko88eg49PTsN
DynamicFlowApproverList	Array of DynamicFlowApproverResult	补充动态合同签署人的结果数组
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 补充企业自动签签署人

补充企业自动签签署人

输入示例

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

{
    "Operator": {
        "UserId": "操作人id"
    },
    "FlowId": "合同id",
    "AutoSignScene": "",
    "Approvers": [
        {
            "ApproverType": 3,
            "OrganizationName": "发起方企业",
            "PreReadTime": 3,
            "SignComponents": [
                {
                    "ComponentPosX": 160,
                    "ComponentPosY": 160,
                    "ComponentWidth": 100,
                    "ComponentHeight": 100,
                    "FileIndex": 0,
                    "ComponentType": "SIGN_SEAL",
                    "ComponentValue": "yDCHZUUckpa9v4i1UuSIlP8KougrzLuQ",
                    "ComponentPage": 1
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DynamicFlowApproverList": [
            {
                "ApproverStatus": 1,
                "RecipientId": "yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR",
                "SignId": "yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB"
            }
        ],
        "FlowId": "yDCjFUUckp48f680Uyh7ukYy5JFb80ux",
        "RequestId": "s1728544317709049372"
    }
}

示例2 二要素形式补充企业签署人

二要素形式补充签署人

输入示例

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

{
    "Operator": {
        "UserId": "操作人id"
    },
    "FlowId": "合同id",
    "Approvers": [
        {
            "ApproverType": 0,
            "OrganizationName": "企业名称",
            "ApproverName": "签署人姓名",
            "ApproverMobile": "签署人手机号",
            "PreReadTime": 3,
            "SignComponents": [
                {
                    "ComponentPosX": 260,
                    "ComponentPosY": 260,
                    "ComponentWidth": 100,
                    "ComponentHeight": 100,
                    "FileIndex": 0,
                    "ComponentType": "SIGN_SEAL",
                    "ComponentPage": 1
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DynamicFlowApproverList": [
            {
                "ApproverStatus": 1,
                "RecipientId": "yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR",
                "SignId": "yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB"
            }
        ],
        "FlowId": "yDCjFUUckp48f680Uyh7ukYy5JFb80ux",
        "RequestId": "s1728544317709049372"
    }
}

示例3 二要素补充个人签署人

二要素补充个人签署人

输入示例

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

{
    "Operator": {
        "UserId": "操作人id"
    },
    "FlowId": "合同id",
    "Approvers": [
        {
            "ApproverType": 1,
            "ApproverName": "签署人姓名",
            "ApproverMobile": "签署人手机号",
            "PreReadTime": 3,
            "SignComponents": [
                {
                    "ComponentPosX": 260,
                    "ComponentPosY": 260,
                    "ComponentWidth": 100,
                    "ComponentHeight": 100,
                    "FileIndex": 0,
                    "ComponentType": "SIGN_SEAL",
                    "ComponentPage": 1
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DynamicFlowApproverList": [
            {
                "ApproverStatus": 1,
                "RecipientId": "yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR",
                "SignId": "yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB"
            }
        ],
        "FlowId": "合同id",
        "RequestId": "s1728544317709049372"
    }
}

示例4 补充个人自动签签署人

补充个人自动签签署人

输入示例

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

{
    "Operator": {
        "UserId": "操作人id"
    },
    "FlowId": "合同id",
    "AutoSignScene": "E_PRESCRIPTION_AUTO_SIGN",
    "Approvers": [
        {
            "ApproverType": 7,
            "ApproverName": "签署人姓名",
            "ApproverMobile": "签署人手机号",
            "PreReadTime": 3,
            "SignComponents": [
                {
                    "ComponentPosX": 360,
                    "ComponentPosY": 360,
                    "ComponentWidth": 100,
                    "ComponentHeight": 100,
                    "FileIndex": 0,
                    "ComponentType": "SIGN_SIGNATURE",
                    "ComponentPage": 1
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DynamicFlowApproverList": [
            {
                "ApproverStatus": 1,
                "RecipientId": "yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR",
                "SignId": "yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB"
            }
        ],
        "FlowId": "合同id",
        "RequestId": "s1728544317709049372"
    }
}

示例5 补充或签签署人

补充或签签署人

输入示例

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

{
    "Operator": {
        "UserId": "操作人id"
    },
    "FlowId": "合同id",
    "AutoSignScene": "",
    "Approvers": [
        {
            "ApproverType": 0,
            "OrganizationName": "企业名称",
            "CustomApproverTag": "唯一标志",
            "PreReadTime": 3,
            "SignComponents": [
                {
                    "ComponentPosX": 333,
                    "ComponentPosY": 333,
                    "ComponentWidth": 100,
                    "ComponentHeight": 100,
                    "FileIndex": 0,
                    "ComponentType": "SIGN_SEAL",
                    "ComponentPage": 1
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DynamicFlowApproverList": [
            {
                "ApproverStatus": 1,
                "RecipientId": "yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR",
                "SignId": "yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB"
            }
        ],
        "FlowId": "合同id",
        "RequestId": "s1728544317709049372"
    }
}

示例6 补充动态签署人

补充动态签署人

输入示例

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

{
    "Operator": {
        "UserId": "操作人id"
    },
    "FlowId": "合同id",
    "AutoSignScene": "",
    "Approvers": [
        {
            "ApproverType": 0,
            "ApproverOption": {
                "FillType": 1
            },
            "PreReadTime": 3,
            "SignComponents": [
                {
                    "ComponentPosX": 60,
                    "ComponentPosY": 360,
                    "ComponentWidth": 100,
                    "ComponentHeight": 100,
                    "FileIndex": 0,
                    "ComponentType": "SIGN_SEAL",
                    "ComponentPage": 1
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DynamicFlowApproverList": [
            {
                "ApproverStatus": 1,
                "RecipientId": "yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR",
                "SignId": "yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB"
            }
        ],
        "FlowId": "合同id",
        "RequestId": "s1728544317709049372"
    }
}

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	操作失败。
InvalidParameter.ApproverType	不合法的签署人类型，请检查后重试。
InvalidParameter.FlowApproverDeadline	不合法的合同过期时间
InvalidParameter.ParamError	参数错误。
InvalidParameter.PreReadTime	不合法的阅读时长限制，请联系客服了解阅读时长设置规则，修改后重试。
InvalidParameter.VerifyChannel	不合法的认证渠道，请联系客户了解电子签支持的认证渠道，并在修改后重试。
InvalidParameterValue	参数取值错误。
OperationDenied	操作被拒绝。
OperationDenied.InvalidApproverAge	签署人年龄限制无法使用电子签服务。
OperationDenied.NoFlowPermission	无权限操作签署流程，请联系客服了解权限，并在修改后重试。
OperationDenied.NoOpenServerSign	未开通静默签功能，请联系签署方企业开通后重试。
OperationDenied.OverSeaForbid	当前不支持境外用户，请联系客服咨询处理。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

补充动态签署合同的签署方

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 补充企业自动签签署人

输入示例

输出示例

示例2 二要素形式补充企业签署人

输入示例

输出示例

示例3 二要素补充个人签署人

输入示例

输出示例

示例4 补充个人自动签签署人

输入示例

输出示例

示例5 补充或签签署人

输入示例

输出示例

示例6 补充动态签署人

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码