跳到主要内容

渠道版补充动态合同签署人接口

1. 接口描述​

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

接口（ChannelCreateDynamicFlowApprover）用来补充用PDF文件创建签署流程发起的动态合同的签署人信息 注:

  • 此接口需要保证：渠道企业已开启：模块化计费能力，
  • 此接口需要保证：渠道应用已开启：动态签署人2.0能力
  • 此接口需要保证：合同发起时指定开启了动态合同
  • 此接口补充的动态签署人传参规则，请参考接口：用PDF文件创建签署流程的签署人传参规则

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelCreateDynamicFlowApprover。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
FillDynamicFlowList.N是Array of DynamicFlowInfo动态合同信息
Agent否Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证

3. 输出参数​

参数名称类型描述
DynamicFlowResultListArray of DynamicFlowResult动态合同补充结果列表
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 添加渠道本企业静默签以及企业签署人​

添加渠道本企业静默签以及企业签署人

输入示例​

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "6*****************314"
        },
        "ProxyOrganizationOpenId": "channel-org_openId",
        "AppId": "channel-appId"
    },
    "FillDynamicFlowList": [
        {
            "FlowId": "dynamicFlowIds",
            "FlowApprovers": [
                {
                    "OrganizationName": "渠道子公司企业",
                    "OrganizationOpenId": "channel-org_openId",
                    "OpenId": "员工openId",
                    "ApproverType": "ENTERPRISESERVER",
                    "SignComponents": [
                        {
                            "ComponentPosY": 260,
                            "ComponentWidth": 100,
                            "FileIndex": 0,
                            "ComponentType": "SIGN_SEAL",
                            "ComponentPage": 1,
                            "ComponentPosX": 260,
                            "ComponentHeight": 100,
                            "ComponentValue": ""
                        }
                    ]
                },
                {
                    "OrganizationName": "渠道子公司企业",
                    "OrganizationOpenId": "channel-org_openId",
                    "OpenId": "员工openId",
                    "ApproverType": "ORGANIZATION",
                    "SignComponents": [
                        {
                            "ComponentPosY": 260,
                            "ComponentWidth": 100,
                            "FileIndex": 0,
                            "ComponentType": "SIGN_SEAL",
                            "ComponentPage": 1,
                            "ComponentPosX": 260,
                            "ComponentHeight": 100,
                            "ComponentValue": ""
                        }
                    ]
                }
            ]
        }
    ]
}

输出示例​

{
    "Response": {
        "DynamicFlowResultList": [
            {
                "DynamicFlowApproverList": [
                    {
                        "ApproverStatus": 2,
                        "RecipientId": "yDCYrUUckp7wh61iUugjySLvo742CmF8",
                        "SignId": "yDCYrUUckp7wh61fUugjySLSpPqQKwDk"
                    },
                    {
                        "ApproverStatus": 2,
                        "RecipientId": "yDCYrUUckp7wh61eUugjySLEuY1q4EvS",
                        "SignId": "yDCYrUUckp7wh61xUugjySLvLvRTpIG6"
                    }
                ],
                "FlowId": "dynamicFlowId"
            }
        ],
        "RequestId": "s1735021464414022010"
    }
}

示例2 添加自建应用企业签署人​

添加自建应用企业签署人

输入示例​

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "6*****************314"
        },
        "ProxyOrganizationOpenId": "channel-org_openId",
        "AppId": "channel-appId"
    },
    "FillDynamicFlowList": [
        {
            "FlowId": "dynamicFlowIds",
            "FlowApprovers": [
                {
                    "NotChannelOrganization": true,
                    "OrganizationName": "渠道子公司企业",
                    "ApproverType": "ORGANIZATION",
                    "Name": "员工姓名",
                    "Mobile": "员工手机号",
                    "SignComponents": [
                        {
                            "ComponentPosY": 260,
                            "ComponentWidth": 100,
                            "FileIndex": 0,
                            "ComponentType": "SIGN_SEAL",
                            "ComponentPage": 1,
                            "ComponentPosX": 260,
                            "ComponentHeight": 100,
                            "ComponentValue": ""
                        }
                    ]
                },
                {
                    "NotChannelOrganization": true,
                    "OrganizationName": "渠道子公司企业",
                    "Name": "员工姓名",
                    "Mobile": "员工手机号",
                    "ApproverType": "ORGANIZATION",
                    "SignComponents": [
                        {
                            "ComponentPosY": 260,
                            "ComponentWidth": 100,
                            "FileIndex": 0,
                            "ComponentType": "SIGN_SEAL",
                            "ComponentPage": 1,
                            "ComponentPosX": 260,
                            "ComponentHeight": 100,
                            "ComponentValue": ""
                        }
                    ]
                }
            ]
        }
    ]
}

输出示例​

{
    "Response": {
        "DynamicFlowResultList": [
            {
                "DynamicFlowApproverList": [
                    {
                        "ApproverStatus": 2,
                        "RecipientId": "yDCYrUUckp7wh61iUugjySLvo742CmF8",
                        "SignId": "yDCYrUUckp7wh61fUugjySLSpPqQKwDk"
                    },
                    {
                        "ApproverStatus": 2,
                        "RecipientId": "yDCYrUUckp7wh61eUugjySLEuY1q4EvS",
                        "SignId": "yDCYrUUckp7wh61xUugjySLvLvRTpIG6"
                    }
                ],
                "FlowId": "dynamicFlowId"
            }
        ],
        "RequestId": "s1735021464414022010"
    }
}

示例3 添加渠道方企业签署人,渠道企业可领取签署人和个人签署人​

添加渠道方企业签署人,渠道企业可领取签署人和个人签署人

输入示例​

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "6*****************314"
        },
        "ProxyOrganizationOpenId": "channel-org_openId",
        "AppId": "channel-appId"
    },
    "FillDynamicFlowList": [
        {
            "FlowId": "dynamicFlowIds",
            "FlowApprovers": [
                {
                    "OrganizationName": "渠道子公司企业",
                    "OrganizationOpenId": "channel-org_openId",
                    "OpenId": "员工openId",
                    "ApproverType": "ENTERPRISESERVER",
                    "SignComponents": [
                        {
                            "ComponentPosY": 260,
                            "ComponentWidth": 100,
                            "FileIndex": 0,
                            "ComponentType": "SIGN_SEAL",
                            "ComponentPage": 1,
                            "ComponentPosX": 260,
                            "ComponentHeight": 100,
                            "ComponentValue": ""
                        }
                    ]
                },
                {
                    "OrganizationName": "渠道子公司企业",
                    "OrganizationOpenId": "channel-org_openId",
                    "ApproverType": "ENTERPRISESERVER",
                    "SignComponents": [
                        {
                            "ComponentPosY": 260,
                            "ComponentWidth": 100,
                            "FileIndex": 0,
                            "ComponentType": "SIGN_SEAL",
                            "ComponentPage": 1,
                            "ComponentPosX": 260,
                            "ComponentHeight": 100,
                            "ComponentValue": ""
                        }
                    ]
                },
                {
                    "Name": "员工姓名",
                    "Mobile": "员工手机号",
                    "ApproverType": "PERSON",
                    "SignComponents": [
                        {
                            "ComponentPosY": 260,
                            "ComponentWidth": 100,
                            "FileIndex": 0,
                            "ComponentType": "SIGN_SEAL",
                            "ComponentPage": 1,
                            "ComponentPosX": 260,
                            "ComponentHeight": 100,
                            "ComponentValue": ""
                        }
                    ]
                }
            ]
        }
    ]
}

输出示例​

{
    "Response": {
        "DynamicFlowResultList": [
            {
                "DynamicFlowApproverList": [
                    {
                        "ApproverStatus": 2,
                        "RecipientId": "yDCYrUUckp7wh61iUugjySLvo742CmF8",
                        "SignId": "yDCYrUUckp7wh61fUugjySLSpPqQKwDk"
                    },
                    {
                        "ApproverStatus": 2,
                        "RecipientId": "yDCYrUUckp7wh61eUugjySLEuY1q4EvS",
                        "SignId": "yDCYrUUckp7wh61xUugjySLvLvRTpIG6"
                    },
                    {
                        "ApproverStatus": 2,
                        "RecipientId": "yDCYrUUckp7wh61eUugjySLEurtyhjgh",
                        "SignId": "yDCYrUUckp7wh61xUugjySLvLrtghkl7"
                    }
                ],
                "FlowId": "dynamicFlowId"
            }
        ],
        "RequestId": "s1735021464414022010"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InvalidParameter参数错误。
InvalidParameter.ApproverVerifyTypeApproverVerifyType参数值非法
InvalidParameter.OrganizationName企业名称不合法。
InvalidParameter.UnsupportedComponentType参数错误，不支持的控件类型，请检查后重试。
InvalidParameterValue参数取值错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
OperationDenied.ByFilesServerSignForbid文件发起静默签未开通白名单。
OperationDenied.NoApproverMobileCheckPermission企业暂未开通手机号验证身份的服务，请在企业中心开通再使用
OperationDenied.OverseaAbilityNotOpen当前企业员工没有开通境外签署能力。
更多开发者交流反馈
购买咨询
联系销售
预约咨询
购买热线
售后反馈