跳到主要内容

补充签署流程签署人信息

1. 接口描述​

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

适用场景： 当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口动态补充签署人。同一签署人只允许补充一人，最终实际签署人取决于谁先领取合同完成签署。

限制条件：

  1. 本企业（发起方企业）企业签署人仅支持通过企业名称+姓名+手机号进行补充。
  2. 个人签署人支持通过姓名+手机号进行补充，补充动态签署人时：若个人用户已完成实名，则可通过姓名+证件号码进行补充。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelCreateFlowApprovers。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId


第三方平台子客企业和员工必须已经经过实名认证
Approvers.N是Array of FillApproverInfo补充企业签署人信息。

- 如果发起方指定的补充签署人是企业签署人，则需要提供企业名称或者企业OpenId；

- 如果不指定，则使用姓名和手机号进行补充。
FlowId否String合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
FillApproverType否Integer签署人信息补充方式

  • 1: 表示往未指定签署人的节点，添加一个明确的签署人，支持企业或个人签署方。
Operator否UserInfo操作人信息
FlowGroupId否String合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
示例值：yDR1AUUgygjazuesUuO4zjESPW4PkfNi

3. 输出参数​

参数名称类型描述
FillErrorArray of FillError批量补充签署人时，补充失败的报错说明
注:目前仅补充动态签署人时会返回补充失败的原因
注意：此字段可能返回 null，表示取不到有效值。
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 B2C签署，批量补充两方动态签署人信息​

在B2C签署中，双方签署方未指定具体签署人时，需要进行补充。 注:补充动态签署人时FillApproverType传值为1

输入示例​

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

{
    "Operator": {
        "OpenId": "",
        "ClientIp": "",
        "CustomUserId": "",
        "ProxyIp": "",
        "Channel": ""
    },
    "Agent": {
        "ProxyAppId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
        "ProxyOrganizationOpenId": "d7c13a8b81340cce9e3968c0ee248f04",
        "ProxyOperator": {
            "OpenId": "00498cc8500be9cxxxxxxx3aff766cac"
        },
        "AppId": "65fb0c591044be8a1f60aa382cc5ed0e"
    },
    "FlowId": "111111***22222",
    "FillApproverType": 1,
    "Approvers": [
        {
            "RecipientId": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR",
            "ApproverName": "典子谦",
            "ApproverMobile": "13200000000",
            "OrganizationName": "***有限公司"
        },
        {
            "RecipientId": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc",
            "ApproverName": "张三",
            "ApproverMobile": "18888888888"
        }
    ]
}

输出示例​

{
    "Response": {
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e"
    }
}

示例2 B2C签署，补充合同组两方动态签署人信息​

在B2C签署中，双方签署方未指定具体签署人时，需要进行补充。 注:补充动态签署人时FillApproverType传值为1

输入示例​

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

{
    "Operator": {
        "OpenId": "",
        "ClientIp": "",
        "CustomUserId": "",
        "ProxyIp": "",
        "Channel": ""
    },
    "Agent": {
        "ProxyAppId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
        "ProxyOrganizationOpenId": "d7c13a8b81340cce9e3968c0ee248f04",
        "ProxyOperator": {
            "OpenId": "00498cc8500be9cxxxxxxx3aff766cac"
        },
        "AppId": "65fb0c591044be8a1f60aa382cc5ed0e"
    },
    "FlowGroupId": "111111***22222",
    "FillApproverType": 1,
    "Approvers": [
        {
            "RecipientId": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR",
            "ApproverName": "典子谦",
            "ApproverMobile": "13200000000",
            "OrganizationName": "***有限公司",
            "FlowId": "yDCVMUUckpwytrk2UE1RW1FSR2BqdoGS"
        },
        {
            "RecipientId": "yDCVMUUckpwytrksUE1RW1FRR08t7Lxf",
            "ApproverName": "典子谦",
            "ApproverMobile": "13200000000",
            "OrganizationName": "***有限公司",
            "FlowId": "yDCVMUUckpwytrk2UE1RW1FSR2BqdoGS"
        }
    ]
}

输出示例​

{
    "Response": {
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e"
    }
}

示例3 B2C签署，批量补充两方动态签署人信息时重复补充报错​

在B2C签署中，双方签署方未指定具体签署人时，需要进行补充。当重复补充同一个签署节点时，会进行部分补充报错。 注:补充动态签署人时FillApproverType传值为1

输入示例​

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

{
    "Operator": {
        "OpenId": "",
        "ClientIp": "",
        "CustomUserId": "",
        "ProxyIp": "",
        "Channel": ""
    },
    "Agent": {
        "ProxyAppId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
        "ProxyOrganizationOpenId": "d7c13a8b81340cce9e3968c0ee248f04",
        "ProxyOperator": {
            "OpenId": "00498cc8500be9cxxxxxxx3aff766cac"
        },
        "AppId": "65fb0c591044be8a1f60aa382cc5ed0e"
    },
    "FlowId": "111111***22222",
    "FillApproverType": 1,
    "Approvers": [
        {
            "RecipientId": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR",
            "ApproverName": "典子谦",
            "ApproverMobile": "13200000000",
            "OrganizationName": "***有限公司"
        },
        {
            "RecipientId": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc",
            "ApproverName": "张三",
            "ApproverMobile": "18888888888"
        }
    ]
}

输出示例​

{
    "Response": {
        "FillError": [
            {
                "ErrMessage": "个人信息已补充，请勿重复补充",
                "RecipientId": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc"
            }
        ],
        "RequestId": "s1696921563375938822"
    }
}

示例4 B2C签署，通过姓名和证件类型、证件号码补充已实名个人用户​

通过姓名和证件类型、证件号码补充已实名个人用户

输入示例​

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

{
    "Operator": {
        "OpenId": "",
        "ClientIp": "",
        "CustomUserId": "",
        "ProxyIp": "",
        "Channel": ""
    },
    "Agent": {
        "ProxyAppId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
        "ProxyOrganizationOpenId": "d7c13a8b81340cce9e3968c0ee248f04",
        "ProxyOperator": {
            "OpenId": "00498cc8500be9cxxxxxxx3aff766cac"
        },
        "AppId": "65fb0c591044be8a1f60aa382cc5ed0e"
    },
    "FlowId": "111111***22222",
    "FillApproverType": 1,
    "Approvers": [
        {
            "RecipientId": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc",
            "ApproverName": "张三",
            "ApproverIdCardType": "ID_CARD",
            "ApproverIdCardNumber": "620000198802020000"
        }
    ]
}

输出示例​

{
    "Response": {
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e"
    }
}

5. 错误码​

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

错误码描述
AuthFailureCAM签名/鉴权错误。
FailedOperation操作失败。
InternalError.Db数据库错误。
InternalError.Encryption加密错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
更多开发者交流反馈
购买咨询
4006-808-062
4006-808-062