{
  "name": "essbasic",
  "display_name": "腾讯电子签（基础版）",
  "description": "使用API接口发起电子签名流程, 对流程进行管理, 电子印章管理,数字证书管理, 角色组织架构机构帐号管理,文档管理, 日志及统计等功能",
  "domain": "other",
  "api_version": "2021-05-26",
  "endpoint": "essbasic.tencentcloudapi.com",
  "actions": [
    {
      "name": "ArchiveDynamicFlow",
      "description": "该接口用于结束动态签署方2.0的合同流程。 **功能开通** - 动态签署方2.0功能的使用需要先联系产品经理开通模块化计费功能，然后到控制台中打开此功能。详细的使用说明请参考动态签署方2.0文档。 **使用条件** - 此接口只能在合同处于非终态且所有的签署方都已经完成签署。一旦合同进入终态（例如：过期、拒签、撤销或者调用过此接口成功过），将无法通过此接口结束合\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID",
          "example": "\"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\""
        }
      ],
      "required": [
        "Agent",
        "FlowId"
      ]
    },
    {
      "name": "ChannelBatchCancelFlows",
      "description": "通过合同编号批量撤销合同，单次最多支持撤销100份合同。 适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。 - **可撤回合同状态**：未全部签署完成 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 批量撤销结果可以通过接口返回的...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": true,
          "description": "要撤销的合同流程ID列表，最多100个，超过100不处理",
          "example": "[\"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\"]",
          "item_type": "string"
        },
        {
          "name": "CancelMessage",
          "type": "string",
          "required": false,
          "description": "撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。 备注:`如果不传递撤回原因，那么默认撤回原因是 \"自动撤销（通过接口实现）\"`",
          "example": "合同里边支付的加个写错了"
        },
        {
          "name": "CancelMessageFormat",
          "type": "integer",
          "required": false,
          "description": "撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式： **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同 **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同 **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同 **3** : 保留企业...",
          "example": "1"
        }
      ],
      "required": [
        "Agent",
        "FlowIds"
      ]
    },
    {
      "name": "ChannelCancelFlow",
      "description": "撤销签署流程接口 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。 - **可撤回合同状态**：未全部签署完成 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 注: - 有对应合同撤销权限的人: **合同的发起人（并已经授予撤销权限）\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "要撤销的合同流程ID",
          "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "CancelMessage",
          "type": "string",
          "required": false,
          "description": "撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。",
          "example": "合同里边支付的价格写错了"
        },
        {
          "name": "CancelMessageFormat",
          "type": "integer",
          "required": false,
          "description": "撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式： **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同 **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同 **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同 **3** : 保留企业...",
          "example": "1"
        }
      ],
      "required": [
        "FlowId"
      ]
    },
    {
      "name": "ChannelCancelMultiFlowSignQRCode",
      "description": "此接口（CancelMultiFlowSignQRCode）用于废除取消一码多签签署码。 该接口所需的二维码ID，源自[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。 如果该签署码尚处于有效期内，可通过本接口将其设置为失效状态。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "QrCodeId",
          "type": "string",
          "required": true,
          "description": "需要取消的签署码ID，为32位字符串。由[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回",
          "example": "yDSLZUUckpooi1ltUxCsD3RSTG9BEWhR"
        }
      ],
      "required": [
        "Agent",
        "QrCodeId"
      ]
    },
    {
      "name": "ChannelCancelUserAutoSignEnableUrl",
      "description": "此接口（ChannelCancelUserAutoSignEnableUrl）用来撤销发送给个人用户的自动签开通链接，撤销后对应的个人用户开通链接失效。若个人用户已经完成开通，将无法撤销。（处方单场景专用，使用此接口请与客户经理确认）",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "渠道应用相关信息",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "操作人信息",
          "example": "无",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
              "example": "n9527"
            }
          ]
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": true,
          "description": "自动签使用的场景值, 可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        },
        {
          "name": "UserInfo",
          "type": "object",
          "required": true,
          "description": "指定撤销链接的用户信息，包含姓名、证件类型、证件号码。",
          "example": "无",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "小明"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": true,
              "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": true,
              "description": "证件号码，应符合以下规则 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "Operator",
        "SceneKey",
        "UserInfo"
      ]
    },
    {
      "name": "ChannelCreateBatchCancelFlowUrl",
      "description": "通过合同编号生成批量撤销合同的链接，单次最多支持撤销100份合同, 返回的链接需要有此权限的人**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**在**手机端**打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同 适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": true,
          "description": "要撤销的合同流程ID列表，最多100个，超过100不处理",
          "example": "[\"yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent",
        "FlowIds"
      ]
    },
    {
      "name": "ChannelCreateBatchQuickSignUrl",
      "description": "该接口用于发起合同后，生成个人/企业用户的批量待办链接。 **注意：** 1. 该接口可生成签署人的批量、合同组签署/查看链接 。 2. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。 4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。 跳转到小程序的实现，参考微信官方文档(分为全屏\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "FlowApproverInfo",
          "type": "object",
          "required": true,
          "description": "批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。 若为个人参与方：ApproverType:\"PERSON\" 若为企业参与方：ApproverType:\"ORGANIZATION\"。同时若签署方为saas企业员工， OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工，除了 OrganizationName 还需要传 OpenId\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "张三"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "110101192008317114"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)， 不支持海外手机号。 请确认手机号所有方为此合同签署方。",
              "example": "13888888888"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
              "example": "典子谦示例企业"
            },
            {
              "name": "NotChannelOrganization",
              "type": "boolean",
              "required": false,
              "description": "指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工",
              "example": "false"
            },
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成 当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程 注： 如果传进来的OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）",
              "example": "userdianziqian"
            },
            {
              "name": "OrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符",
              "example": "orgtencent"
            },
            {
              "name": "ApproverType",
              "type": "string",
              "required": false,
              "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **PERSON** :个人/自然人 **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景 **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签） **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签） 注: `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功...",
              "example": "PERSON"
            },
            {
              "name": "RecipientId",
              "type": "string",
              "required": false,
              "description": "签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；",
              "example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
              "example": "1689688460"
            },
            {
              "name": "SignComponents",
              "type": "array",
              "required": false,
              "description": "使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID:注意：(如果模板里面指定了印章，默认使用模板里面配置的印章，不能进行变更) 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                  "example": "ComponentId"
                },
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": false,
                  "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                  "example": "ComponentName"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "false"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                  "example": "ComponentRecipientId"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentHeight",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": false,
                  "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentExtra",
                  "type": "string",
                  "required": false,
                  "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                  "example": "ComponentExtra"
                },
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": false,
                  "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                  "example": "ComponentValue"
                },
                {
                  "name": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "DocumentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                  "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                },
                {
                  "name": "ComponentDescription",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                  "example": "Desc"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "componentId1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "0"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "Middle"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                  "example": "[0]",
                  "item_type": "integer"
                },
                {
                  "name": "Placeholder",
                  "type": "string",
                  "required": false,
                  "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                  "example": "请签名"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                  "example": "false"
                },
                {
                  "name": "ForbidMoveAndDelete",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "ComponentLimitType",
              "type": "array",
              "required": false,
              "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
              "example": "[\"OCR_ESIGN\"]",
              "item_type": "string"
            },
            {
              "name": "PreReadTime",
              "type": "integer",
              "required": false,
              "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
              "example": "3"
            },
            {
              "name": "JumpUrl",
              "type": "string",
              "required": false,
              "description": "签署完前端跳转的url，此字段的用法场景请联系客户经理确认",
              "example": "https://www.qq.com/success"
            },
            {
              "name": "ApproverOption",
              "type": "object",
              "required": false,
              "description": "可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。 详细操作可以参考开发者中心的ApproverOption结构体。",
              "example": "无",
              "children": [
                {
                  "name": "NoRefuse",
                  "type": "boolean",
                  "required": false,
                  "description": "是否可以拒签 默认false-可以拒签 true-不可以拒签",
                  "example": "true"
                },
                {
                  "name": "NoTransfer",
                  "type": "boolean",
                  "required": false,
                  "description": "是否可以转发 默认false-可以转发 true-不可以转发",
                  "example": "true"
                },
                {
                  "name": "HideOneKeySign",
                  "type": "boolean",
                  "required": false,
                  "description": "当签署方有多个签署区时候，是否隐藏一键所有的签署区false：（默认）不隐藏true：隐藏，每个签署区要单独选择印章或者签名",
                  "example": "true"
                },
                {
                  "name": "FillType",
                  "type": "integer",
                  "required": false,
                  "description": "签署人信息补充类型，默认无需补充。 1 : 动态签署人（可发起合同后再补充签署人信息）注：企业自动签不支持动态补充注：使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关枚举值：1： 动态签署人",
                  "example": "1"
                },
                {
                  "name": "FlowReadLimit",
                  "type": "string",
                  "required": false,
                  "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                  "example": "LimitBottom"
                },
                {
                  "name": "ForbidAddSignDate",
                  "type": "boolean",
                  "required": false,
                  "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "ApproverNeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "此签署人（员工或者个人）签署前，是否需要发起方企业进行审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待发起方企业内部审批完成。 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 \ufffd...",
              "example": "false"
            },
            {
              "name": "ApproverVerifyTypes",
              "type": "array",
              "required": false,
              "description": "指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式 此字段可传\ufffd\ufffd...",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "name": "ApproverSignTypes",
              "type": "array",
              "required": false,
              "description": "签署人签署合同时的认证方式 **1** :人脸认证 **2** :签署密码 **3** :运营商三要素（如果是港澳台客户，建议不要选择这个） **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式） **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式） 默...",
              "example": "[1,2,3]",
              "item_type": "integer"
            },
            {
              "name": "SignId",
              "type": "string",
              "required": false,
              "description": "签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息",
              "example": "06f2bc0f1772d8deac2f92b5df61a5ac"
            },
            {
              "name": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **SMS** :(默认)短信 **NONE** : 不通知 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`",
              "example": "SMS"
            },
            {
              "name": "AddSignComponentsLimits",
              "type": "array",
              "required": false,
              "description": "[通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递Compon...",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "description": "控件类型，支持以下类型 SIGN_SEAL : 印章控件 SIGN_PAGING_SEAL : 骑缝章控件 SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件 SIGN_SIGNATURE : 用户签名控件",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentValue",
                  "type": "array",
                  "required": false,
                  "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人\ufffd...",
                  "example": "[\"HANDWRITE\", \"ESIGN\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "ApproverRoleName",
              "type": "string",
              "required": false,
              "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
              "example": "乙方"
            },
            {
              "name": "SignTypeSelector",
              "type": "integer",
              "required": false,
              "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
              "example": "0"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 数据表格等填写控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件) 注：`此参数仅在通过文件发起合同或者合同组时生效` ![image](http...",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                  "example": "ComponentId"
                },
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": false,
                  "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                  "example": "ComponentName"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "false"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                  "example": "ComponentRecipientId"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentHeight",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": false,
                  "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentExtra",
                  "type": "string",
                  "required": false,
                  "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                  "example": "ComponentExtra"
                },
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": false,
                  "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                  "example": "ComponentValue"
                },
                {
                  "name": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "DocumentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                  "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                },
                {
                  "name": "ComponentDescription",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                  "example": "Desc"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "componentId1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "0"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "Middle"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                  "example": "[0]",
                  "item_type": "integer"
                },
                {
                  "name": "Placeholder",
                  "type": "string",
                  "required": false,
                  "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                  "example": "请签名"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                  "example": "false"
                },
                {
                  "name": "ForbidMoveAndDelete",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "Intention",
              "type": "object",
              "required": false,
              "description": "只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。 2. 使用视频认证时，生成H5签署链接的时候必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。 3. 签\ufffd\ufffd...",
              "example": "无",
              "children": [
                {
                  "name": "IntentionType",
                  "type": "integer",
                  "required": false,
                  "description": "视频认证类型，支持以下类型 1 : 问答模式 2 : 点头模式 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "1"
                },
                {
                  "name": "IntentionQuestions",
                  "type": "array",
                  "required": false,
                  "description": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。 注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Question",
                      "type": "string",
                      "required": false,
                      "description": "当选择语音问答模式时，系统自动播报的问题文本，最大长度为250个字符。",
                      "example": "请问您本次业务是本人自愿办理吗？如是，请回复“我同意”。"
                    },
                    {
                      "name": "Answers",
                      "type": "array",
                      "required": false,
                      "description": "当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。",
                      "example": "“同意”，“我同意”，“确认”，“我确认”",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "IntentionActions",
                  "type": "array",
                  "required": false,
                  "description": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。 注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Text",
                      "type": "string",
                      "required": false,
                      "description": "点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。",
                      "example": "请问您本次业务是本人自愿办理吗？如是，请点头确认。"
                    }
                  ]
                },
                {
                  "name": "RuleIdConfig",
                  "type": "object",
                  "required": false,
                  "description": "视频核身相关配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "Speed",
                      "type": "integer",
                      "required": false,
                      "description": "意愿核身语音播报速度，配置后问答模式和点头模式的语音播报环节都会生效，默认值为0： 0-智能语速（根据播报文案的长度自动调整语音播报速度） 1-固定1倍速 2-固定1.2倍速 3-固定1.5倍速",
                      "example": "0"
                    }
                  ]
                }
              ]
            },
            {
              "name": "SignEndpoints",
              "type": "array",
              "required": false,
              "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
              "example": "[\"link\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "批量签署的合同流程ID数组。 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`",
          "example": "[\"yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E\"]",
          "item_type": "string"
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": false,
          "description": "合同组编号 注：`该参数和合同流程ID数组必须二选一`",
          "example": "yDwFdUUckpsveo27UEQPEVo14KnASuGI"
        },
        {
          "name": "JumpUrl",
          "type": "string",
          "required": false,
          "description": "签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)",
          "example": "https://YOUR_CUSTOM_URL/xxxx"
        },
        {
          "name": "SignatureTypes",
          "type": "array",
          "required": false,
          "description": "指定批量签署合同的签名类型，可传递以下值： **0**：手写签名(默认) **1**：OCR楷体 **2**：姓名印章 **3**：图片印章 **4**：系统签名 **5**：长效手写签名（包含手写签名） 注： 默认情况下，签名类型为手写签名 您可以传递多种值，表示可用多种签名类型。 该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型...",
          "example": "[0, 1, 2, 3, 4]",
          "item_type": "integer"
        },
        {
          "name": "ApproverSignTypes",
          "type": "array",
          "required": false,
          "description": "指定批量签署合同的认证校验方式，可传递以下值： **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同 **2**：密码认证(默认)，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署 **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。 注： 默认情况下，认证校验方式为人脸和密码认证 您\ufffd\ufffd...",
          "example": "[1, 2, 3]",
          "item_type": "integer"
        },
        {
          "name": "SignTypeSelector",
          "type": "integer",
          "required": false,
          "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
          "example": "0"
        },
        {
          "name": "FlowBatchUrlInfo",
          "type": "object",
          "required": false,
          "description": "批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。 注: `若签署方为企业员工，暂不支持通过H5端进行动态签署人的补充`",
          "example": "无",
          "children": [
            {
              "name": "FlowBatchApproverInfos",
              "type": "array",
              "required": false,
              "description": "批量签署合同和签署方的信息，用于补充动态签署人。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "FlowId",
                  "type": "string",
                  "required": false,
                  "description": "合同流程ID。",
                  "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
                },
                {
                  "name": "RecipientId",
                  "type": "string",
                  "required": false,
                  "description": "签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`",
                  "example": "yDt1iUUckp7xb05iUuWfBtZwW5IdVzLn"
                }
              ]
            }
          ]
        },
        {
          "name": "Intention",
          "type": "object",
          "required": false,
          "description": "只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。 2. 使用视频认证时，生成H5签署链接的时候必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。 3. 签\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "IntentionType",
              "type": "integer",
              "required": false,
              "description": "视频认证类型，支持以下类型 1 : 问答模式 2 : 点头模式 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`",
              "example": "1"
            },
            {
              "name": "IntentionQuestions",
              "type": "array",
              "required": false,
              "description": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。 注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Question",
                  "type": "string",
                  "required": false,
                  "description": "当选择语音问答模式时，系统自动播报的问题文本，最大长度为250个字符。",
                  "example": "请问您本次业务是本人自愿办理吗？如是，请回复“我同意”。"
                },
                {
                  "name": "Answers",
                  "type": "array",
                  "required": false,
                  "description": "当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。",
                  "example": "“同意”，“我同意”，“确认”，“我确认”",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "IntentionActions",
              "type": "array",
              "required": false,
              "description": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。 注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Text",
                  "type": "string",
                  "required": false,
                  "description": "点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。",
                  "example": "请问您本次业务是本人自愿办理吗？如是，请点头确认。"
                }
              ]
            },
            {
              "name": "RuleIdConfig",
              "type": "object",
              "required": false,
              "description": "视频核身相关配置",
              "example": "无",
              "children": [
                {
                  "name": "Speed",
                  "type": "integer",
                  "required": false,
                  "description": "意愿核身语音播报速度，配置后问答模式和点头模式的语音播报环节都会生效，默认值为0： 0-智能语速（根据播报文案的长度自动调整语音播报速度） 1-固定1倍速 2-固定1.2倍速 3-固定1.5倍速",
                  "example": "0"
                }
              ]
            }
          ]
        },
        {
          "name": "VideoVerifyTimesLimit",
          "type": "integer",
          "required": false,
          "description": "用于指定进入视频签署的限制次数，次数取值范围：1 - 10，不设置则默认为5次，仅视频签署时生效。",
          "example": "5"
        },
        {
          "name": "CacheApproverInfo",
          "type": "boolean",
          "required": false,
          "description": "缓存签署人信息。在H5签署链接动态领取场景，首次填写后，选择缓存签署人信息，在下次签署人点击领取链接时，会自动将个人信息（姓名、身份证号、手机号）填入，否则需要每次手动填写。 注: `若参与方为企业员工时，暂不支持对参与方信息进行缓存`",
          "example": "false"
        },
        {
          "name": "CanBatchReject",
          "type": "boolean",
          "required": false,
          "description": "是否允许此链接中签署方批量拒签。 false (默认): 不允许批量拒签 true : 允许批量拒签。注：`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。`",
          "example": "false"
        },
        {
          "name": "PresetApproverInfo",
          "type": "object",
          "required": false,
          "description": "预设的动态签署方的补充信息，仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。",
          "example": "无",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "预设参与方姓名。",
              "example": "张三"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "预设参与方手机号。",
              "example": "18888888888"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": false,
              "description": "预设参与方证件号，需要和IdCardType同时传入。 证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。",
              "example": "430000000000000000"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": false,
              "description": "预设参与方的证件类型，需要与IdCardNumber同时传入。 证件类型，支持以下类型 ID_CARD: 居民身份证",
              "example": "ID_CARD"
            }
          ]
        },
        {
          "name": "CanSkipReadFlow",
          "type": "boolean",
          "required": false,
          "description": "是否允许此链接中签署方批量确认已读文件。 false (默认): 不允许批量确认已读文件。 true : 允许批量确认已读文件。注：`1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 若批量签署的合同中第一份待签署合同所选择的印章或者签名无法完全覆盖后续合同要求，或者当前签署人没有指定印章使用权限，则无法使用此功能，会自动退化为逐份确认。`",
          "example": "false"
        }
      ],
      "required": [
        "FlowApproverInfo"
      ]
    },
    {
      "name": "ChannelCreateBatchSignUrl",
      "description": "通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。 注： - 使用此接口生成链接，需要提前开通 `个人签署方仅校验手机号` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。 - 个人参与方点击链接后需短信验证码才能查看合同内容。 - 个人用户批量\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注： 请确保和合同中填入的一致。 在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。",
          "example": "真实姓名"
        },
        {
          "name": "Mobile",
          "type": "string",
          "required": false,
          "description": "手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此业务通知方。 注： 请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功\ufffd...",
          "example": "187****9829"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
              "example": "n9527"
            }
          ]
        },
        {
          "name": "IdCardType",
          "type": "string",
          "required": false,
          "description": "证件类型，支持以下类型 **ID_CARD** : 中国大陆居民身份证 (默认值) **HONGKONG_AND_MACAO** : 中国港澳居民来往内地通行证 **HONGKONG_MACAO_AND_TAIWAN** : 中国港澳台居民居住证(格式同中国大陆居民身份证) 注： 1. `请确保和合同中填入的一致`。 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参\ufffd...",
          "example": "ID_CARD"
        },
        {
          "name": "IdCardNumber",
          "type": "string",
          "required": false,
          "description": "证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。 注： 1. `请确保和合同中填入的一致...",
          "example": "421049****8749"
        },
        {
          "name": "NotifyType",
          "type": "string",
          "required": false,
          "description": "通知用户方式： **NONE** : 不通知（默认） **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）",
          "example": "SMS"
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "批量签署的合同流程ID数组。此参数必传。 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`",
          "example": "[\"yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E\"]",
          "item_type": "string"
        },
        {
          "name": "OrganizationName",
          "type": "string",
          "required": false,
          "description": "SaaS平台企业员工签署方的企业名称。目标签署人如果为saas应用企业员工身份，此参数必填。 注： 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 请确保此企业已完成腾讯电子签企业认证。 **若为子客企业员工，请使用OpenId，OrganizationOpenId参数。如果此子客企业未认证，则此参数需要传子客企业名称**",
          "example": "企业名称"
        },
        {
          "name": "SignatureTypes",
          "type": "array",
          "required": false,
          "description": "指定批量签署合同的签名类型，可传递以下值：**0**：手写签名**1**：OCR楷体**2**：姓名印章**3**：图片印章**4**：系统签名**5**：长效手写签名（包含手写签名）注：不传值的情况则计算所有合同中个人签署区的签名类型，规则如下：1.如果所有合同中所有的个人签署区方式包含多种则是手写2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式（例如合同1有...",
          "example": "[0, 1, 2, 3, 4]",
          "item_type": "integer"
        },
        {
          "name": "JumpToDetail",
          "type": "boolean",
          "required": false,
          "description": "是否直接跳转至合同内容页面进行签署 **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认) **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署",
          "example": "false"
        },
        {
          "name": "FlowBatchUrlInfo",
          "type": "object",
          "required": false,
          "description": "批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。",
          "example": "无",
          "children": [
            {
              "name": "FlowBatchApproverInfos",
              "type": "array",
              "required": false,
              "description": "批量签署合同和签署方的信息，用于补充动态签署人。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "FlowId",
                  "type": "string",
                  "required": false,
                  "description": "合同流程ID。",
                  "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
                },
                {
                  "name": "RecipientId",
                  "type": "string",
                  "required": false,
                  "description": "签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`",
                  "example": "yDt1iUUckp7xb05iUuWfBtZwW5IdVzLn"
                }
              ]
            }
          ]
        },
        {
          "name": "OpenId",
          "type": "string",
          "required": false,
          "description": "第三方平台子客企业员工的标识OpenId，批签合同经办人为子客员工的情况下为必填。 注： 传入的OpenId对应员工在此子客企业下必须已经实名 传递了此参数可以无需传递Name，Mobile，IdCardNumber，IdCardType参数。系统会根据员工OpenId自动拉取实名信息。",
          "example": "openid_1"
        },
        {
          "name": "OrganizationOpenId",
          "type": "string",
          "required": false,
          "description": "第三方平台子客企业的企业的标识, 即OrganizationOpenId，批签合同经办人为子客企业员工是为必填。",
          "example": "orgopenid_1"
        },
        {
          "name": "AutoJumpBack",
          "type": "boolean",
          "required": false,
          "description": "签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认)true：是, 签署完成会自动跳转回来 注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景 的签署链接有效 2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方...",
          "example": "false"
        },
        {
          "name": "UrlUseEnv",
          "type": "string",
          "required": false,
          "description": "仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%...",
          "example": "WeChatOfficialAccounts"
        },
        {
          "name": "CanBatchReject",
          "type": "boolean",
          "required": false,
          "description": "是否允许此链接中签署方批量拒签。 false (默认): 不允许批量拒签 true : 允许批量拒签。 注：`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页（JumpToDetail参数为true），也不支持批量拒签功能`",
          "example": "false"
        },
        {
          "name": "CanSkipReadFlow",
          "type": "boolean",
          "required": false,
          "description": "是否允许此链接中签署方批量确认已读文件。 false (默认): 不允许批量确认已读文件。 true : 允许批量确认已读文件。 注：`1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果对印章/签名控件有限制要求，需要保证所有印章/签名控件的限制要求(印章id或印章/签名类型限制)一致，否则无法使用此功能。`",
          "example": "false"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "ChannelCreateBoundFlows",
      "description": "此接口（ChannelCreateBoundFlows）用于子客企业领取未归属给员工的合同，将合同领取给当前员工，合同不能重复领取。 **未归属合同发起方式** 指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等), 则合同进入待领取状态, 示例代码如下 ``` FlowApprovers: []*essbasic.FlowApproverInfo{ { ApproverType: common.StringPtr(\"ORGANIZATION\"), OrganizationOpenId: common.StringPtr(\"org_dianz...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "需要领取的合同流程的ID列表",
          "example": "[\"yDSxWUUckptu4clgUuLlo0OwJKbYCO48\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "ChannelCreateConvertTaskApi",
      "description": "此接口（ChannelCreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。 前提条件：源文件已经通过 文件上传接口完成上传，并得到了源文件的资源Id。 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同 适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同 转换文件是一个耗时操作，若想查看转换\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "ResourceType",
          "type": "string",
          "required": true,
          "description": "需要进行转换的资源文件类型 支持的文件类型如下： doc docx xls xlsx jpg jpeg png bmp html txt",
          "example": "docx"
        },
        {
          "name": "ResourceName",
          "type": "string",
          "required": true,
          "description": "需要进行转换操作的文件资源名称，带资源后缀名。 注: `资源名称长度限制为256个字符`",
          "example": "员工劳动合同.docx"
        },
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "需要进行转换操作的文件资源Id，通过UploadFiles接口获取文件资源Id。 注: `目前，此接口仅支持单个文件进行转换。`",
          "example": "yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT"
        }
      ],
      "required": [
        "Agent",
        "ResourceType",
        "ResourceName",
        "ResourceId"
      ]
    },
    {
      "name": "ChannelCreateDynamicFlowApprover",
      "description": "接口（ChannelCreateDynamicFlowApprover）用来补充用PDF文件创建签署流程发起的动态合同的签署人信息 **注**: 此接口需要保证：渠道应用已开启：动态签署人2.0能力 此接口需要保证：合同发起时指定开启了动态合同 此接口补充的动态签署人传参规则，请参考接口：用PDF文件创建签署流程的签署人传参规则 此接口补充的动态签署人暂不支持他方企业自动签署。",
      "status": "online",
      "parameters": [
        {
          "name": "FillDynamicFlowList",
          "type": "array",
          "required": true,
          "description": "动态合同信息",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FlowId",
              "type": "string",
              "required": true,
              "description": "合同流程ID，为32位字符串。 - FlowId 在通过[ChannelCreateFlowByFiles](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles) 发起，可以在返回参数FlowId中获取。 - 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 - 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
              "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
            },
            {
              "name": "FlowApprovers",
              "type": "array",
              "required": true,
              "description": "合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。 如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "张三"
                },
                {
                  "name": "IdCardType",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "ID_CARD"
                },
                {
                  "name": "IdCardNumber",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "110101192008317114"
                },
                {
                  "name": "Mobile",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)， 不支持海外手机号。 请确认手机号所有方为此合同签署方。",
                  "example": "13888888888"
                },
                {
                  "name": "OrganizationName",
                  "type": "string",
                  "required": false,
                  "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
                  "example": "典子谦示例企业"
                },
                {
                  "name": "NotChannelOrganization",
                  "type": "boolean",
                  "required": false,
                  "description": "指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工",
                  "example": "false"
                },
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成 当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程 注： 如果传进来的OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）",
                  "example": "userdianziqian"
                },
                {
                  "name": "OrganizationOpenId",
                  "type": "string",
                  "required": false,
                  "description": "同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符",
                  "example": "orgtencent"
                },
                {
                  "name": "ApproverType",
                  "type": "string",
                  "required": false,
                  "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **PERSON** :个人/自然人 **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景 **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签） **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签） 注: `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功...",
                  "example": "PERSON"
                },
                {
                  "name": "RecipientId",
                  "type": "string",
                  "required": false,
                  "description": "签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；",
                  "example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
                },
                {
                  "name": "Deadline",
                  "type": "integer",
                  "required": false,
                  "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
                  "example": "1689688460"
                },
                {
                  "name": "SignComponents",
                  "type": "array",
                  "required": false,
                  "description": "使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID:注意：(如果模板里面指定了印章，默认使用模板里面配置的印章，不能进行变更) 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ComponentLimitType",
                  "type": "array",
                  "required": false,
                  "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
                  "example": "[\"OCR_ESIGN\"]",
                  "item_type": "string"
                },
                {
                  "name": "PreReadTime",
                  "type": "integer",
                  "required": false,
                  "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
                  "example": "3"
                },
                {
                  "name": "JumpUrl",
                  "type": "string",
                  "required": false,
                  "description": "签署完前端跳转的url，此字段的用法场景请联系客户经理确认",
                  "example": "https://www.qq.com/success"
                },
                {
                  "name": "ApproverOption",
                  "type": "object",
                  "required": false,
                  "description": "可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。 详细操作可以参考开发者中心的ApproverOption结构体。",
                  "example": "无",
                  "children": [
                    {
                      "name": "NoRefuse",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以拒签 默认false-可以拒签 true-不可以拒签",
                      "example": "true"
                    },
                    {
                      "name": "NoTransfer",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以转发 默认false-可以转发 true-不可以转发",
                      "example": "true"
                    },
                    {
                      "name": "HideOneKeySign",
                      "type": "boolean",
                      "required": false,
                      "description": "当签署方有多个签署区时候，是否隐藏一键所有的签署区false：（默认）不隐藏true：隐藏，每个签署区要单独选择印章或者签名",
                      "example": "true"
                    },
                    {
                      "name": "FillType",
                      "type": "integer",
                      "required": false,
                      "description": "签署人信息补充类型，默认无需补充。 1 : 动态签署人（可发起合同后再补充签署人信息）注：企业自动签不支持动态补充注：使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关枚举值：1： 动态签署人",
                      "example": "1"
                    },
                    {
                      "name": "FlowReadLimit",
                      "type": "string",
                      "required": false,
                      "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                      "example": "LimitBottom"
                    },
                    {
                      "name": "ForbidAddSignDate",
                      "type": "boolean",
                      "required": false,
                      "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ApproverNeedSignReview",
                  "type": "boolean",
                  "required": false,
                  "description": "此签署人（员工或者个人）签署前，是否需要发起方企业进行审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待发起方企业内部审批完成。 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 \ufffd...",
                  "example": "false"
                },
                {
                  "name": "ApproverVerifyTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式 此字段可传\ufffd\ufffd...",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "ApproverSignTypes",
                  "type": "array",
                  "required": false,
                  "description": "签署人签署合同时的认证方式 **1** :人脸认证 **2** :签署密码 **3** :运营商三要素（如果是港澳台客户，建议不要选择这个） **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式） **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式） 默...",
                  "example": "[1,2,3]",
                  "item_type": "integer"
                },
                {
                  "name": "SignId",
                  "type": "string",
                  "required": false,
                  "description": "签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息",
                  "example": "06f2bc0f1772d8deac2f92b5df61a5ac"
                },
                {
                  "name": "NotifyType",
                  "type": "string",
                  "required": false,
                  "description": "通知签署方经办人的方式, 有以下途径: **SMS** :(默认)短信 **NONE** : 不通知 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`",
                  "example": "SMS"
                },
                {
                  "name": "AddSignComponentsLimits",
                  "type": "array",
                  "required": false,
                  "description": "[通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递Compon...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "description": "控件类型，支持以下类型 SIGN_SEAL : 印章控件 SIGN_PAGING_SEAL : 骑缝章控件 SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件 SIGN_SIGNATURE : 用户签名控件",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "array",
                      "required": false,
                      "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人\ufffd...",
                      "example": "[\"HANDWRITE\", \"ESIGN\"]",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "ApproverRoleName",
                  "type": "string",
                  "required": false,
                  "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
                  "example": "乙方"
                },
                {
                  "name": "SignTypeSelector",
                  "type": "integer",
                  "required": false,
                  "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
                  "example": "0"
                },
                {
                  "name": "Components",
                  "type": "array",
                  "required": false,
                  "description": "签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 数据表格等填写控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件) 注：`此参数仅在通过文件发起合同或者合同组时生效` ![image](http...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "Intention",
                  "type": "object",
                  "required": false,
                  "description": "只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。 2. 使用视频认证时，生成H5签署链接的时候必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。 3. 签\ufffd\ufffd...",
                  "example": "无",
                  "children": [
                    {
                      "name": "IntentionType",
                      "type": "integer",
                      "required": false,
                      "description": "视频认证类型，支持以下类型 1 : 问答模式 2 : 点头模式 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`",
                      "example": "1"
                    },
                    {
                      "name": "IntentionQuestions",
                      "type": "array",
                      "required": false,
                      "description": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。 注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "IntentionActions",
                      "type": "array",
                      "required": false,
                      "description": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。 注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "RuleIdConfig",
                      "type": "object",
                      "required": false,
                      "description": "视频核身相关配置",
                      "example": "无"
                    }
                  ]
                },
                {
                  "name": "SignEndpoints",
                  "type": "array",
                  "required": false,
                  "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
                  "example": "[\"link\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "AutoSignScene",
              "type": "string",
              "required": false,
              "description": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） **OTHER** : 通用场景 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`",
              "example": "E_PRESCRIPTION_AUTO_SIGN\t"
            },
            {
              "name": "ApproverVerifyType",
              "type": "string",
              "required": false,
              "description": "签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于...",
              "example": "VerifyCheck"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        }
      ],
      "required": [
        "FillDynamicFlowList"
      ]
    },
    {
      "name": "ChannelCreateEmbedWebUrl",
      "description": "本接口（ChannelCreateEmbedWebUrl）用于创建可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中），支持以下类型的Web链接创建： 1. 创建印章 2. 创建模板 3. 修改模板 4. 预览模板 5. 预览合同流程 预览模板的嵌入页面长相如下： ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png) 预览合同流程的嵌入页面长相如下： ![image](https://qcloudimg.tencent-cloud.cn...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "EmbedType",
          "type": "string",
          "required": true,
          "description": "要生成WEB嵌入界面的类型, 可以选择的值如下: CREATE_SEAL: 生成创建印章的嵌入页面 CREATE_TEMPLATE：生成创建模板的嵌入页面 MODIFY_TEMPLATE：生成修改模板的嵌入页面 PREVIEW_TEMPLATE：生成预览模板的嵌入页面 PREVIEW_FLOW：生成预览合同文档的嵌入页面（H5链接，支持移动端的浏览器中打开） PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面（仅支持PC的浏览器中打开） PREVIEW_SEAL_LIST：生成\ufffd...",
          "example": "MODIFY_TEMPLATE"
        },
        {
          "name": "BusinessId",
          "type": "string",
          "required": false,
          "description": "WEB嵌入的业务资源ID 当EmbedType取值 为MODIFY_TEMPLATE，PREVIEW_TEMPLATE必填，取值为模板id 为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)* 为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL必填，取值为合同id 为PREVIEW_SEAL_DETAIL必填，取值为印章id 注意： 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使\ufffd\ufffd...",
          "example": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc"
        },
        {
          "name": "HiddenComponents",
          "type": "boolean",
          "required": false,
          "description": "是否隐藏控件，只有预览模板时生效",
          "example": "false"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "用户自定义参数 目前仅支持EmbedType=CREATE_TEMPLATE时传入 指定后，创建，编辑，删除模板时，回调都会携带该userData 支持的格式：json字符串的BASE64编码字符串 示例： json字符串：{\"ComeFrom\":\"xxx\"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9 eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式",
          "example": "eyJDb21lRnJvbSI6Inh4eCJ9"
        },
        {
          "name": "Option",
          "type": "object",
          "required": false,
          "description": "个性化参数，用于控制页面展示内容",
          "example": "无",
          "children": [
            {
              "name": "ShowFlowDetailComponent",
              "type": "boolean",
              "required": false,
              "description": "合同详情预览，允许展示控件信息 true：允许在合同详情页展示控件 false：（默认）不允许在合同详情页展示控件",
              "example": "true"
            },
            {
              "name": "ShowTemplateComponent",
              "type": "boolean",
              "required": false,
              "description": "模板预览，允许展示模板控件信息 true :允许在模板预览页展示控件 false :（默认）不允许在模板预览页展示控件",
              "example": "true"
            },
            {
              "name": "SkipUploadFile",
              "type": "boolean",
              "required": false,
              "description": "跳过上传文件，默认为false(展示上传文件页)![image](https://qcloudimg.tencent-cloud.cn/raw/8ca33745cf772e79831dbe5a70e82400.png) - false: 展示上传文件页 - true: 不展示上传文件页 注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**，",
              "example": "true"
            },
            {
              "name": "SkipDownloadFile",
              "type": "boolean",
              "required": false,
              "description": "隐藏下载文件按钮，默认为false(展示下载文件按钮) - false: 展示下载文件按钮 - true: 不展示下载文件按钮 注意: 此参数仅针对**EmbedType=PREVIEW_FLOW_DETAIL(查看合同详情)**有效",
              "example": "true"
            },
            {
              "name": "ForbidEditWatermark",
              "type": "boolean",
              "required": false,
              "description": "是否禁止编辑（展示）水印控件属性 （默认） false -否 true - 禁止编辑",
              "example": "true"
            },
            {
              "name": "SealDescription",
              "type": "string",
              "required": false,
              "description": "印章描述",
              "example": "合同章"
            },
            {
              "name": "ForbidEditSealDescription",
              "type": "boolean",
              "required": false,
              "description": "是否禁止编辑印章描述内容 （默认） false -否 true - 禁止编辑",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "EmbedType"
      ]
    },
    {
      "name": "ChannelCreateFlowApprovers",
      "description": "**适用场景**： 当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口动态补充签署人。同一签署人只允许补充一人，最终实际签署人取决于谁先领取合同完成签署。 **接口使用说明**： 1.本接口现已支持批量补充签署人 2.当补充签署人结构体中指定需要补充的FlowId时，可以对指定合同补充签署人；可以指定多个相同发起方的不同合同在完成批量补充 3.当补\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Approvers",
          "type": "array",
          "required": true,
          "description": "补充企业签署人信息。 - 如果发起方指定的补充签署人是企业签署人，则需要提供企业名称或者企业OpenId； - 如果不指定，则使用姓名和手机号进行补充。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "RecipientId",
              "type": "string",
              "required": true,
              "description": "签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。",
              "example": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR"
            },
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "指定企业经办签署人OpenId 注: `签署人OpenId未实名时，需要传入签署人姓名以及手机号码。`",
              "example": "n9527"
            },
            {
              "name": "ApproverName",
              "type": "string",
              "required": false,
              "description": "签署人姓名",
              "example": "张三"
            },
            {
              "name": "ApproverMobile",
              "type": "string",
              "required": false,
              "description": "签署人手机号码",
              "example": "18888888888"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "企业名称",
              "example": "张三示例公司"
            },
            {
              "name": "OrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "企业OpenId",
              "example": "org_dianziqian"
            },
            {
              "name": "NotChannelOrganization",
              "type": "boolean",
              "required": false,
              "description": "签署企业非渠道子客，默认为false，即表示同一渠道下的企业；如果为true，则目前表示接收方企业为SaaS企业, 为渠道子客时，OrganizationOpenId 必传",
              "example": "false"
            },
            {
              "name": "ApproverIdCardType",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件类型，支持以下类型 ID_CARD 中国大陆居民身份证 HONGKONG_AND_MACAO 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE 其他证件 注: `1.其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。` `2.补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成...",
              "example": "ID_CARD"
            },
            {
              "name": "ApproverIdCardNumber",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。 注：`补充个人签署\ufffd...",
              "example": "620000198802020000"
            },
            {
              "name": "FlowId",
              "type": "string",
              "required": false,
              "description": "合同流程ID - 补充合同组子合同动态签署人时必传。 - 补充正常合同，请阅读：补充签署人接口接口使用说明",
              "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": false,
          "description": "合同流程ID，为32位字符串。 - 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 - 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。 - 不建议继续使用，请使用补充签署人结构体中的FlowId指定合同",
          "example": "yDCZHUUnitvronUuNTdBrElW0gOVqCfy"
        },
        {
          "name": "FillApproverType",
          "type": "integer",
          "required": false,
          "description": "签署人信息补充方式 **1**: 表示往未指定签署人的节点，添加一个明确的签署人，支持企业或个人签署方。",
          "example": "1"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "操作人信息",
          "example": "无",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
              "example": "n9527"
            }
          ]
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": false,
          "description": "合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值",
          "example": "yDR1AUUgygjazuesUuO4zjESPW4PkfNi"
        }
      ],
      "required": [
        "Agent",
        "Approvers"
      ]
    },
    {
      "name": "ChannelCreateFlowByFiles",
      "description": "接口（ChannelCreateFlowByFiles）用PDF文件创建签署流程。 适用场景：适用非制式的合同文件签署，开发者有每个签署流程的PDF，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。 **注**: 此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。 此接口需要依赖文件上传接口生成pdf资源编号（FileIds）进行使用。整体的逻辑如下图 ![image](h...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置此接口下面信息必填。渠道应用标识: Agent.AppId第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowName",
          "type": "string",
          "required": false,
          "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
          "example": "张三的入职合同"
        },
        {
          "name": "FlowDescription",
          "type": "string",
          "required": false,
          "description": "合同流程描述信息(可自定义此描述)，最大长度1000个字符。",
          "example": "张三2023年入职市场部的合同"
        },
        {
          "name": "FlowApprovers",
          "type": "array",
          "required": false,
          "description": "合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "张三"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "110101192008317114"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)， 不支持海外手机号。 请确认手机号所有方为此合同签署方。",
              "example": "13888888888"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
              "example": "典子谦示例企业"
            },
            {
              "name": "NotChannelOrganization",
              "type": "boolean",
              "required": false,
              "description": "指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工",
              "example": "false"
            },
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成 当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程 注： 如果传进来的OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）",
              "example": "userdianziqian"
            },
            {
              "name": "OrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符",
              "example": "orgtencent"
            },
            {
              "name": "ApproverType",
              "type": "string",
              "required": false,
              "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **PERSON** :个人/自然人 **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景 **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签） **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签） 注: `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功...",
              "example": "PERSON"
            },
            {
              "name": "RecipientId",
              "type": "string",
              "required": false,
              "description": "签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；",
              "example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
              "example": "1689688460"
            },
            {
              "name": "SignComponents",
              "type": "array",
              "required": false,
              "description": "使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID:注意：(如果模板里面指定了印章，默认使用模板里面配置的印章，不能进行变更) 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                  "example": "ComponentId"
                },
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": false,
                  "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                  "example": "ComponentName"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "false"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                  "example": "ComponentRecipientId"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentHeight",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": false,
                  "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentExtra",
                  "type": "string",
                  "required": false,
                  "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                  "example": "ComponentExtra"
                },
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": false,
                  "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                  "example": "ComponentValue"
                },
                {
                  "name": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "DocumentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                  "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                },
                {
                  "name": "ComponentDescription",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                  "example": "Desc"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "componentId1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "0"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "Middle"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                  "example": "[0]",
                  "item_type": "integer"
                },
                {
                  "name": "Placeholder",
                  "type": "string",
                  "required": false,
                  "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                  "example": "请签名"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                  "example": "false"
                },
                {
                  "name": "ForbidMoveAndDelete",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "ComponentLimitType",
              "type": "array",
              "required": false,
              "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
              "example": "[\"OCR_ESIGN\"]",
              "item_type": "string"
            },
            {
              "name": "PreReadTime",
              "type": "integer",
              "required": false,
              "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
              "example": "3"
            },
            {
              "name": "JumpUrl",
              "type": "string",
              "required": false,
              "description": "签署完前端跳转的url，此字段的用法场景请联系客户经理确认",
              "example": "https://www.qq.com/success"
            },
            {
              "name": "ApproverOption",
              "type": "object",
              "required": false,
              "description": "可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。 详细操作可以参考开发者中心的ApproverOption结构体。",
              "example": "无",
              "children": [
                {
                  "name": "NoRefuse",
                  "type": "boolean",
                  "required": false,
                  "description": "是否可以拒签 默认false-可以拒签 true-不可以拒签",
                  "example": "true"
                },
                {
                  "name": "NoTransfer",
                  "type": "boolean",
                  "required": false,
                  "description": "是否可以转发 默认false-可以转发 true-不可以转发",
                  "example": "true"
                },
                {
                  "name": "HideOneKeySign",
                  "type": "boolean",
                  "required": false,
                  "description": "当签署方有多个签署区时候，是否隐藏一键所有的签署区false：（默认）不隐藏true：隐藏，每个签署区要单独选择印章或者签名",
                  "example": "true"
                },
                {
                  "name": "FillType",
                  "type": "integer",
                  "required": false,
                  "description": "签署人信息补充类型，默认无需补充。 1 : 动态签署人（可发起合同后再补充签署人信息）注：企业自动签不支持动态补充注：使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关枚举值：1： 动态签署人",
                  "example": "1"
                },
                {
                  "name": "FlowReadLimit",
                  "type": "string",
                  "required": false,
                  "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                  "example": "LimitBottom"
                },
                {
                  "name": "ForbidAddSignDate",
                  "type": "boolean",
                  "required": false,
                  "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "ApproverNeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "此签署人（员工或者个人）签署前，是否需要发起方企业进行审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待发起方企业内部审批完成。 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 \ufffd...",
              "example": "false"
            },
            {
              "name": "ApproverVerifyTypes",
              "type": "array",
              "required": false,
              "description": "指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式 此字段可传\ufffd\ufffd...",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "name": "ApproverSignTypes",
              "type": "array",
              "required": false,
              "description": "签署人签署合同时的认证方式 **1** :人脸认证 **2** :签署密码 **3** :运营商三要素（如果是港澳台客户，建议不要选择这个） **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式） **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式） 默...",
              "example": "[1,2,3]",
              "item_type": "integer"
            },
            {
              "name": "SignId",
              "type": "string",
              "required": false,
              "description": "签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息",
              "example": "06f2bc0f1772d8deac2f92b5df61a5ac"
            },
            {
              "name": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **SMS** :(默认)短信 **NONE** : 不通知 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`",
              "example": "SMS"
            },
            {
              "name": "AddSignComponentsLimits",
              "type": "array",
              "required": false,
              "description": "[通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递Compon...",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "description": "控件类型，支持以下类型 SIGN_SEAL : 印章控件 SIGN_PAGING_SEAL : 骑缝章控件 SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件 SIGN_SIGNATURE : 用户签名控件",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentValue",
                  "type": "array",
                  "required": false,
                  "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人\ufffd...",
                  "example": "[\"HANDWRITE\", \"ESIGN\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "ApproverRoleName",
              "type": "string",
              "required": false,
              "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
              "example": "乙方"
            },
            {
              "name": "SignTypeSelector",
              "type": "integer",
              "required": false,
              "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
              "example": "0"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 数据表格等填写控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件) 注：`此参数仅在通过文件发起合同或者合同组时生效` ![image](http...",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                  "example": "ComponentId"
                },
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": false,
                  "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                  "example": "ComponentName"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "false"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                  "example": "ComponentRecipientId"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentHeight",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": false,
                  "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentExtra",
                  "type": "string",
                  "required": false,
                  "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                  "example": "ComponentExtra"
                },
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": false,
                  "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                  "example": "ComponentValue"
                },
                {
                  "name": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "DocumentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                  "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                },
                {
                  "name": "ComponentDescription",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                  "example": "Desc"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "componentId1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "0"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "Middle"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                  "example": "[0]",
                  "item_type": "integer"
                },
                {
                  "name": "Placeholder",
                  "type": "string",
                  "required": false,
                  "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                  "example": "请签名"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                  "example": "false"
                },
                {
                  "name": "ForbidMoveAndDelete",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "Intention",
              "type": "object",
              "required": false,
              "description": "只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。 2. 使用视频认证时，生成H5签署链接的时候必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。 3. 签\ufffd\ufffd...",
              "example": "无",
              "children": [
                {
                  "name": "IntentionType",
                  "type": "integer",
                  "required": false,
                  "description": "视频认证类型，支持以下类型 1 : 问答模式 2 : 点头模式 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "1"
                },
                {
                  "name": "IntentionQuestions",
                  "type": "array",
                  "required": false,
                  "description": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。 注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Question",
                      "type": "string",
                      "required": false,
                      "description": "当选择语音问答模式时，系统自动播报的问题文本，最大长度为250个字符。",
                      "example": "请问您本次业务是本人自愿办理吗？如是，请回复“我同意”。"
                    },
                    {
                      "name": "Answers",
                      "type": "array",
                      "required": false,
                      "description": "当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。",
                      "example": "“同意”，“我同意”，“确认”，“我确认”",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "IntentionActions",
                  "type": "array",
                  "required": false,
                  "description": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。 注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Text",
                      "type": "string",
                      "required": false,
                      "description": "点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。",
                      "example": "请问您本次业务是本人自愿办理吗？如是，请点头确认。"
                    }
                  ]
                },
                {
                  "name": "RuleIdConfig",
                  "type": "object",
                  "required": false,
                  "description": "视频核身相关配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "Speed",
                      "type": "integer",
                      "required": false,
                      "description": "意愿核身语音播报速度，配置后问答模式和点头模式的语音播报环节都会生效，默认值为0： 0-智能语速（根据播报文案的长度自动调整语音播报速度） 1-固定1倍速 2-固定1.2倍速 3-固定1.5倍速",
                      "example": "0"
                    }
                  ]
                }
              ]
            },
            {
              "name": "SignEndpoints",
              "type": "array",
              "required": false,
              "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
              "example": "[\"link\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "FileIds",
          "type": "array",
          "required": false,
          "description": "本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。注: 目前，此接口仅支持单个文件发起。",
          "example": "[\"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\"]",
          "item_type": "string"
        },
        {
          "name": "Components",
          "type": "array",
          "required": false,
          "description": "模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体单行文本控件多行文本控件勾选框控件数字控件图片控件数据表格等填写控件",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ComponentId",
              "type": "string",
              "required": false,
              "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
              "example": "ComponentId"
            },
            {
              "name": "ComponentType",
              "type": "string",
              "required": false,
              "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
              "example": "SIGN_SEAL"
            },
            {
              "name": "ComponentName",
              "type": "string",
              "required": false,
              "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
              "example": "ComponentName"
            },
            {
              "name": "ComponentRequired",
              "type": "boolean",
              "required": false,
              "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
              "example": "false"
            },
            {
              "name": "ComponentRecipientId",
              "type": "string",
              "required": false,
              "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
              "example": "ComponentRecipientId"
            },
            {
              "name": "FileIndex",
              "type": "integer",
              "required": false,
              "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
              "example": "0"
            },
            {
              "name": "GenerateMode",
              "type": "string",
              "required": false,
              "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
              "example": "NORMAL"
            },
            {
              "name": "ComponentWidth",
              "type": "float",
              "required": false,
              "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
              "example": "10.0"
            },
            {
              "name": "ComponentHeight",
              "type": "float",
              "required": false,
              "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
              "example": "10.0"
            },
            {
              "name": "ComponentPage",
              "type": "integer",
              "required": false,
              "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
              "example": "1"
            },
            {
              "name": "ComponentPosX",
              "type": "float",
              "required": false,
              "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
              "example": "10.0"
            },
            {
              "name": "ComponentPosY",
              "type": "float",
              "required": false,
              "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
              "example": "10.0"
            },
            {
              "name": "ComponentExtra",
              "type": "string",
              "required": false,
              "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
              "example": "ComponentExtra"
            },
            {
              "name": "ComponentValue",
              "type": "string",
              "required": false,
              "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
              "example": "ComponentValue"
            },
            {
              "name": "ComponentDateFontSize",
              "type": "integer",
              "required": false,
              "description": "【暂未使用】日期签署控件的字号，默认为 12",
              "example": "12"
            },
            {
              "name": "DocumentId",
              "type": "string",
              "required": false,
              "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
              "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
            },
            {
              "name": "ComponentDescription",
              "type": "string",
              "required": false,
              "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
              "example": "Desc"
            },
            {
              "name": "OffsetX",
              "type": "float",
              "required": false,
              "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
              "example": "100.5"
            },
            {
              "name": "OffsetY",
              "type": "float",
              "required": false,
              "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
              "example": "100.5"
            },
            {
              "name": "ChannelComponentId",
              "type": "string",
              "required": false,
              "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
              "example": "componentId1"
            },
            {
              "name": "KeywordOrder",
              "type": "string",
              "required": false,
              "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
              "example": "Positive\\Reverse"
            },
            {
              "name": "KeywordPage",
              "type": "integer",
              "required": false,
              "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
              "example": "0"
            },
            {
              "name": "RelativeLocation",
              "type": "string",
              "required": false,
              "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
              "example": "Middle"
            },
            {
              "name": "KeywordIndexes",
              "type": "array",
              "required": false,
              "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
              "example": "[0]",
              "item_type": "integer"
            },
            {
              "name": "Placeholder",
              "type": "string",
              "required": false,
              "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
              "example": "请签名"
            },
            {
              "name": "LockComponentValue",
              "type": "boolean",
              "required": false,
              "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
              "example": "false"
            },
            {
              "name": "ForbidMoveAndDelete",
              "type": "boolean",
              "required": false,
              "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
              "example": "false"
            }
          ]
        },
        {
          "name": "Deadline",
          "type": "integer",
          "required": false,
          "description": "合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。",
          "example": "1691574041"
        },
        {
          "name": "Unordered",
          "type": "boolean",
          "required": false,
          "description": "合同流程的签署顺序类型： **false**：(默认)有序签署, 本合同多个参与人需要依次签署 **true**：无序签署, 本合同多个参与人没有先后签署限制**注**: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序",
          "example": "false"
        },
        {
          "name": "FlowType",
          "type": "string",
          "required": false,
          "description": "合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。",
          "example": "入职合同"
        },
        {
          "name": "CustomShowMap",
          "type": "string",
          "required": false,
          "description": "您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：{合同名称} {发起方企业} {发起方姓名} {签署方N企业}{签署方N姓名}其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署...",
          "example": "合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}"
        },
        {
          "name": "CustomerData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
          "example": "eyJpZCI6ImNvbWVmIiwibmFtZSI6IuWRseWRseWPqyJ9"
        },
        {
          "name": "NeedSignReview",
          "type": "boolean",
          "required": false,
          "description": "发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果\ufffd\ufffd...",
          "example": "false"
        },
        {
          "name": "ApproverVerifyType",
          "type": "string",
          "required": false,
          "description": "签署人校验方式VerifyCheck: 人脸识别（默认）MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个...",
          "example": "VerifyCheck"
        },
        {
          "name": "SignBeanTag",
          "type": "integer",
          "required": false,
          "description": "签署方签署控件（印章/签名等）的生成方式： **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。 **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。注:1.发起后添加控件功能不支持添加签批控件2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5",
          "example": "0"
        },
        {
          "name": "CcInfos",
          "type": "array",
          "required": false,
          "description": "合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。注抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。请确保抄送人列表中的成员不与任何签署人重复。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "被抄送方手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此业务通知方。",
              "example": "13200000000"
            },
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "被抄送方姓名。 抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。",
              "example": "典子谦"
            },
            {
              "name": "CcType",
              "type": "integer",
              "required": false,
              "description": "被抄送方类型, 可设置以下类型: **0** :个人抄送方 **1** :企业员工抄送方",
              "example": "1"
            },
            {
              "name": "CcPermission",
              "type": "integer",
              "required": false,
              "description": "被抄送方权限, 可设置如下权限: **0** :可查看合同内容 **1** :可查看合同内容也可下载原文",
              "example": "1"
            }
          ]
        },
        {
          "name": "CcNotifyType",
          "type": "integer",
          "required": false,
          "description": "可以设置以下时间节点来给抄送人发送短信通知来查看合同内容： **0**：合同发起时通知（默认值） **1**：签署完成后通知",
          "example": "0"
        },
        {
          "name": "AutoSignScene",
          "type": "string",
          "required": false,
          "description": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） **OTHER** : 通用场景注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        },
        {
          "name": "FlowDisplayType",
          "type": "integer",
          "required": false,
          "description": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下:",
          "example": "1"
        },
        {
          "name": "NeedPreview",
          "type": "boolean",
          "required": false,
          "description": "是否为预览模式，取值如下： false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。 true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。",
          "example": "true"
        },
        {
          "name": "PreviewType",
          "type": "integer",
          "required": false,
          "description": "预览模式下产生的预览链接类型 **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 **1** :H5链接 ,点开后在浏览器中展示合同的样子注: 此参数在NeedPreview 为true时有效",
          "example": "0"
        },
        {
          "name": "OpenDynamicSignFlow",
          "type": "boolean",
          "required": false,
          "description": "是否开启动态合同（动态签署人2.0） false :(默认) 不开启动态合同（动态签署人2.0） true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人",
          "example": "false"
        }
      ],
      "required": []
    },
    {
      "name": "ChannelCreateFlowGroupByFiles",
      "description": "接口（ChannelCreateFlowGroupByFiles）用于使用 PDF 文件创建合同组签署流程。 - 该接口允许通过选择多个模板一次性创建多个合同，这些合同被组织在一个合同组中。 - 每个签署方将收到一个签署链接，通过这个链接可以访问并签署合同组中的所有合同。 - 合同组中的合同必须作为一个整体进行签署，不能将合同组拆分成单独的合同进行逐一签署。 ### 2. 适用场景 该接口适用于需要\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "FlowFileInfos",
          "type": "array",
          "required": true,
          "description": "合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FileIds",
              "type": "array",
              "required": true,
              "description": "签署文件资源Id列表，目前仅支持单个文件",
              "example": "[\"yDt1iUUckp7xb05iUuWfBtZwW5IdVzLn\"]",
              "item_type": "string"
            },
            {
              "name": "FlowName",
              "type": "string",
              "required": true,
              "description": "签署流程名称，长度不超过200个字符",
              "example": "张三的入职合同"
            },
            {
              "name": "FlowApprovers",
              "type": "array",
              "required": true,
              "description": "签署流程签约方列表，最多不超过5个参与方",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "张三"
                },
                {
                  "name": "IdCardType",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "ID_CARD"
                },
                {
                  "name": "IdCardNumber",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "110101192008317114"
                },
                {
                  "name": "Mobile",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)， 不支持海外手机号。 请确认手机号所有方为此合同签署方。",
                  "example": "13888888888"
                },
                {
                  "name": "OrganizationName",
                  "type": "string",
                  "required": false,
                  "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
                  "example": "典子谦示例企业"
                },
                {
                  "name": "NotChannelOrganization",
                  "type": "boolean",
                  "required": false,
                  "description": "指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工",
                  "example": "false"
                },
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成 当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程 注： 如果传进来的OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）",
                  "example": "userdianziqian"
                },
                {
                  "name": "OrganizationOpenId",
                  "type": "string",
                  "required": false,
                  "description": "同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符",
                  "example": "orgtencent"
                },
                {
                  "name": "ApproverType",
                  "type": "string",
                  "required": false,
                  "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **PERSON** :个人/自然人 **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景 **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签） **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签） 注: `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功...",
                  "example": "PERSON"
                },
                {
                  "name": "RecipientId",
                  "type": "string",
                  "required": false,
                  "description": "签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；",
                  "example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
                },
                {
                  "name": "Deadline",
                  "type": "integer",
                  "required": false,
                  "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
                  "example": "1689688460"
                },
                {
                  "name": "SignComponents",
                  "type": "array",
                  "required": false,
                  "description": "使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID:注意：(如果模板里面指定了印章，默认使用模板里面配置的印章，不能进行变更) 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ComponentLimitType",
                  "type": "array",
                  "required": false,
                  "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
                  "example": "[\"OCR_ESIGN\"]",
                  "item_type": "string"
                },
                {
                  "name": "PreReadTime",
                  "type": "integer",
                  "required": false,
                  "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
                  "example": "3"
                },
                {
                  "name": "JumpUrl",
                  "type": "string",
                  "required": false,
                  "description": "签署完前端跳转的url，此字段的用法场景请联系客户经理确认",
                  "example": "https://www.qq.com/success"
                },
                {
                  "name": "ApproverOption",
                  "type": "object",
                  "required": false,
                  "description": "可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。 详细操作可以参考开发者中心的ApproverOption结构体。",
                  "example": "无",
                  "children": [
                    {
                      "name": "NoRefuse",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以拒签 默认false-可以拒签 true-不可以拒签",
                      "example": "true"
                    },
                    {
                      "name": "NoTransfer",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以转发 默认false-可以转发 true-不可以转发",
                      "example": "true"
                    },
                    {
                      "name": "HideOneKeySign",
                      "type": "boolean",
                      "required": false,
                      "description": "当签署方有多个签署区时候，是否隐藏一键所有的签署区false：（默认）不隐藏true：隐藏，每个签署区要单独选择印章或者签名",
                      "example": "true"
                    },
                    {
                      "name": "FillType",
                      "type": "integer",
                      "required": false,
                      "description": "签署人信息补充类型，默认无需补充。 1 : 动态签署人（可发起合同后再补充签署人信息）注：企业自动签不支持动态补充注：使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关枚举值：1： 动态签署人",
                      "example": "1"
                    },
                    {
                      "name": "FlowReadLimit",
                      "type": "string",
                      "required": false,
                      "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                      "example": "LimitBottom"
                    },
                    {
                      "name": "ForbidAddSignDate",
                      "type": "boolean",
                      "required": false,
                      "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ApproverNeedSignReview",
                  "type": "boolean",
                  "required": false,
                  "description": "此签署人（员工或者个人）签署前，是否需要发起方企业进行审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待发起方企业内部审批完成。 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 \ufffd...",
                  "example": "false"
                },
                {
                  "name": "ApproverVerifyTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式 此字段可传\ufffd\ufffd...",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "ApproverSignTypes",
                  "type": "array",
                  "required": false,
                  "description": "签署人签署合同时的认证方式 **1** :人脸认证 **2** :签署密码 **3** :运营商三要素（如果是港澳台客户，建议不要选择这个） **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式） **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式） 默...",
                  "example": "[1,2,3]",
                  "item_type": "integer"
                },
                {
                  "name": "SignId",
                  "type": "string",
                  "required": false,
                  "description": "签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息",
                  "example": "06f2bc0f1772d8deac2f92b5df61a5ac"
                },
                {
                  "name": "NotifyType",
                  "type": "string",
                  "required": false,
                  "description": "通知签署方经办人的方式, 有以下途径: **SMS** :(默认)短信 **NONE** : 不通知 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`",
                  "example": "SMS"
                },
                {
                  "name": "AddSignComponentsLimits",
                  "type": "array",
                  "required": false,
                  "description": "[通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递Compon...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "description": "控件类型，支持以下类型 SIGN_SEAL : 印章控件 SIGN_PAGING_SEAL : 骑缝章控件 SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件 SIGN_SIGNATURE : 用户签名控件",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "array",
                      "required": false,
                      "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人\ufffd...",
                      "example": "[\"HANDWRITE\", \"ESIGN\"]",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "ApproverRoleName",
                  "type": "string",
                  "required": false,
                  "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
                  "example": "乙方"
                },
                {
                  "name": "SignTypeSelector",
                  "type": "integer",
                  "required": false,
                  "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
                  "example": "0"
                },
                {
                  "name": "Components",
                  "type": "array",
                  "required": false,
                  "description": "签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 数据表格等填写控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件) 注：`此参数仅在通过文件发起合同或者合同组时生效` ![image](http...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "Intention",
                  "type": "object",
                  "required": false,
                  "description": "只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。 2. 使用视频认证时，生成H5签署链接的时候必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。 3. 签\ufffd\ufffd...",
                  "example": "无",
                  "children": [
                    {
                      "name": "IntentionType",
                      "type": "integer",
                      "required": false,
                      "description": "视频认证类型，支持以下类型 1 : 问答模式 2 : 点头模式 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`",
                      "example": "1"
                    },
                    {
                      "name": "IntentionQuestions",
                      "type": "array",
                      "required": false,
                      "description": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。 注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "IntentionActions",
                      "type": "array",
                      "required": false,
                      "description": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。 注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "RuleIdConfig",
                      "type": "object",
                      "required": false,
                      "description": "视频核身相关配置",
                      "example": "无"
                    }
                  ]
                },
                {
                  "name": "SignEndpoints",
                  "type": "array",
                  "required": false,
                  "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
                  "example": "[\"link\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年",
              "example": "1662110622"
            },
            {
              "name": "FlowDescription",
              "type": "string",
              "required": false,
              "description": "签署流程的描述，长度不超过1000个字符",
              "example": "张三的入职合同（2025）"
            },
            {
              "name": "FlowType",
              "type": "string",
              "required": false,
              "description": "签署流程的类型，长度不超过255个字符枚举值：入职合同： 入职合同劳动合同： 劳动合同",
              "example": "入职合同"
            },
            {
              "name": "CustomerData",
              "type": "string",
              "required": false,
              "description": "第三方应用的业务信息，最大长度1000个字符。",
              "example": "56ys5LiJ5pa55bqU55So55qE5Lia5Yqh5L+h5oGv77yM5pyA5aSn6ZW/5bqmMTAwMOS4quWtl+espuOAgg=="
            },
            {
              "name": "Unordered",
              "type": "boolean",
              "required": false,
              "description": "合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署",
              "example": "false"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "签署文件中的发起方的填写控件，需要在发起的时候进行填充",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                  "example": "ComponentId"
                },
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": false,
                  "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                  "example": "ComponentName"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "false"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                  "example": "ComponentRecipientId"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentHeight",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": false,
                  "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentExtra",
                  "type": "string",
                  "required": false,
                  "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                  "example": "ComponentExtra"
                },
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": false,
                  "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                  "example": "ComponentValue"
                },
                {
                  "name": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "DocumentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                  "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                },
                {
                  "name": "ComponentDescription",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                  "example": "Desc"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "componentId1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "0"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "Middle"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                  "example": "[0]",
                  "item_type": "integer"
                },
                {
                  "name": "Placeholder",
                  "type": "string",
                  "required": false,
                  "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                  "example": "请签名"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                  "example": "false"
                },
                {
                  "name": "ForbidMoveAndDelete",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "CustomShowMap",
              "type": "string",
              "required": false,
              "description": "合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始",
              "example": "合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬！;净重: 100吨;品类: 铁矿石"
            },
            {
              "name": "NeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "本企业(发起方企业)是否需要签署审批",
              "example": "true"
            },
            {
              "name": "FlowDisplayType",
              "type": "integer",
              "required": false,
              "description": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下:",
              "example": "1"
            }
          ]
        },
        {
          "name": "FlowGroupName",
          "type": "string",
          "required": true,
          "description": "合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
          "example": "\"2023年采购合同们\""
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业） 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人） 合同的发起企业和发起人必需已经完成实名，并加入企业",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "ApproverVerifyType",
          "type": "string",
          "required": false,
          "description": "合同组中签署人校验和认证的方式： **VerifyCheck**：人脸识别（默认） **MobileCheck**：手机号验证 注意： `1. MobileCheck 方式，未实名的个人/自然人签署方无需进行人脸识别实名认证即可查看合同（但签署合同时仍然需要人脸实名），企业签署方需经过人脸认证。` `2. 合同组的校验和认证的方式会优先使用，会覆盖合同组中单个合同和合同签署方认证方式的限制配置。`",
          "example": "VerifyCheck"
        },
        {
          "name": "FlowGroupOptions",
          "type": "object",
          "required": false,
          "description": "合同组的签署配置项信息，例如在合同组签署过程中，是否需要对每个子合同进行独立的意愿确认。",
          "example": "无",
          "children": [
            {
              "name": "SelfOrganizationApproverSignEach",
              "type": "boolean",
              "required": false,
              "description": "发起方企业经办人（即签署人为发起方企业员工）是否需要对子合同进行独立的意愿确认 **false**（默认）：发起方企业经办人签署时对所有子合同进行统一的意愿确认。 **true**：发起方企业经办人签署时需要对子合同进行独立的意愿确认。",
              "example": "fasle"
            },
            {
              "name": "OtherApproverSignEach",
              "type": "boolean",
              "required": false,
              "description": "非发起方企业经办人（即：签署人为个人或者不为发起方企业的员工）是否需要对子合同进行独立的意愿确认 **false**（默认）：非发起方企业经办人签署时对所有子合同进行统一的意愿确认。 **true**：非发起方企业经办人签署时需要对子合同进行独立的意愿确认。",
              "example": "fasle"
            }
          ]
        }
      ],
      "required": [
        "FlowFileInfos",
        "FlowGroupName"
      ]
    },
    {
      "name": "ChannelCreateFlowGroupByTemplates",
      "description": "接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。 - 该接口允许通过选择多个模板一次性创建多个合同，这些合同被组织在一个合同组中。 - 每个签署方将收到一个签署链接，通过这个链接可以访问并签署合同组中的所有合同。 - 合同组中的合同必须作为一个整体进行签署，不能将合同组拆分成单独的合同进行逐一签署。 ### 2. 适用场景 该接口适用于需\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业） 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人） 合同的发起企业和发起人必需已经完成实名，并加入企业",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowInfos",
          "type": "array",
          "required": true,
          "description": "合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FlowName",
              "type": "string",
              "required": true,
              "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
              "example": "张三的入职合同"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": true,
              "description": "合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。 示例值：1604912664",
              "example": "1698827057"
            },
            {
              "name": "TemplateId",
              "type": "string",
              "required": false,
              "description": "用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 如果使用模板发起接口，此参数为必填。 可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。 [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)",
              "example": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc"
            },
            {
              "name": "FlowApprovers",
              "type": "array",
              "required": false,
              "description": "合同流程的参与方列表，最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver) 注: 在发起流程时，需要保证 FlowApprovers中的顺序与模板定义顺序一致，否则会发起失败。 例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二...",
              "example": "签署人信息",
              "item_type": "object",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "张三"
                },
                {
                  "name": "IdCardType",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "ID_CARD"
                },
                {
                  "name": "IdCardNumber",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "110101192008317114"
                },
                {
                  "name": "Mobile",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)， 不支持海外手机号。 请确认手机号所有方为此合同签署方。",
                  "example": "13888888888"
                },
                {
                  "name": "OrganizationName",
                  "type": "string",
                  "required": false,
                  "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
                  "example": "典子谦示例企业"
                },
                {
                  "name": "NotChannelOrganization",
                  "type": "boolean",
                  "required": false,
                  "description": "指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工",
                  "example": "false"
                },
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成 当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程 注： 如果传进来的OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）",
                  "example": "userdianziqian"
                },
                {
                  "name": "OrganizationOpenId",
                  "type": "string",
                  "required": false,
                  "description": "同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符",
                  "example": "orgtencent"
                },
                {
                  "name": "ApproverType",
                  "type": "string",
                  "required": false,
                  "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **PERSON** :个人/自然人 **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景 **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签） **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签） 注: `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功...",
                  "example": "PERSON"
                },
                {
                  "name": "RecipientId",
                  "type": "string",
                  "required": false,
                  "description": "签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；",
                  "example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
                },
                {
                  "name": "Deadline",
                  "type": "integer",
                  "required": false,
                  "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
                  "example": "1689688460"
                },
                {
                  "name": "SignComponents",
                  "type": "array",
                  "required": false,
                  "description": "使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID:注意：(如果模板里面指定了印章，默认使用模板里面配置的印章，不能进行变更) 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ComponentLimitType",
                  "type": "array",
                  "required": false,
                  "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
                  "example": "[\"OCR_ESIGN\"]",
                  "item_type": "string"
                },
                {
                  "name": "PreReadTime",
                  "type": "integer",
                  "required": false,
                  "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
                  "example": "3"
                },
                {
                  "name": "JumpUrl",
                  "type": "string",
                  "required": false,
                  "description": "签署完前端跳转的url，此字段的用法场景请联系客户经理确认",
                  "example": "https://www.qq.com/success"
                },
                {
                  "name": "ApproverOption",
                  "type": "object",
                  "required": false,
                  "description": "可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。 详细操作可以参考开发者中心的ApproverOption结构体。",
                  "example": "无",
                  "children": [
                    {
                      "name": "NoRefuse",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以拒签 默认false-可以拒签 true-不可以拒签",
                      "example": "true"
                    },
                    {
                      "name": "NoTransfer",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以转发 默认false-可以转发 true-不可以转发",
                      "example": "true"
                    },
                    {
                      "name": "HideOneKeySign",
                      "type": "boolean",
                      "required": false,
                      "description": "当签署方有多个签署区时候，是否隐藏一键所有的签署区false：（默认）不隐藏true：隐藏，每个签署区要单独选择印章或者签名",
                      "example": "true"
                    },
                    {
                      "name": "FillType",
                      "type": "integer",
                      "required": false,
                      "description": "签署人信息补充类型，默认无需补充。 1 : 动态签署人（可发起合同后再补充签署人信息）注：企业自动签不支持动态补充注：使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关枚举值：1： 动态签署人",
                      "example": "1"
                    },
                    {
                      "name": "FlowReadLimit",
                      "type": "string",
                      "required": false,
                      "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                      "example": "LimitBottom"
                    },
                    {
                      "name": "ForbidAddSignDate",
                      "type": "boolean",
                      "required": false,
                      "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ApproverNeedSignReview",
                  "type": "boolean",
                  "required": false,
                  "description": "此签署人（员工或者个人）签署前，是否需要发起方企业进行审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待发起方企业内部审批完成。 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 \ufffd...",
                  "example": "false"
                },
                {
                  "name": "ApproverVerifyTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式 此字段可传\ufffd\ufffd...",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "ApproverSignTypes",
                  "type": "array",
                  "required": false,
                  "description": "签署人签署合同时的认证方式 **1** :人脸认证 **2** :签署密码 **3** :运营商三要素（如果是港澳台客户，建议不要选择这个） **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式） **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式） 默...",
                  "example": "[1,2,3]",
                  "item_type": "integer"
                },
                {
                  "name": "SignId",
                  "type": "string",
                  "required": false,
                  "description": "签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息",
                  "example": "06f2bc0f1772d8deac2f92b5df61a5ac"
                },
                {
                  "name": "NotifyType",
                  "type": "string",
                  "required": false,
                  "description": "通知签署方经办人的方式, 有以下途径: **SMS** :(默认)短信 **NONE** : 不通知 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`",
                  "example": "SMS"
                },
                {
                  "name": "AddSignComponentsLimits",
                  "type": "array",
                  "required": false,
                  "description": "[通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递Compon...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "description": "控件类型，支持以下类型 SIGN_SEAL : 印章控件 SIGN_PAGING_SEAL : 骑缝章控件 SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件 SIGN_SIGNATURE : 用户签名控件",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "array",
                      "required": false,
                      "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人\ufffd...",
                      "example": "[\"HANDWRITE\", \"ESIGN\"]",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "ApproverRoleName",
                  "type": "string",
                  "required": false,
                  "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
                  "example": "乙方"
                },
                {
                  "name": "SignTypeSelector",
                  "type": "integer",
                  "required": false,
                  "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
                  "example": "0"
                },
                {
                  "name": "Components",
                  "type": "array",
                  "required": false,
                  "description": "签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 数据表格等填写控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件) 注：`此参数仅在通过文件发起合同或者合同组时生效` ![image](http...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "Intention",
                  "type": "object",
                  "required": false,
                  "description": "只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。 2. 使用视频认证时，生成H5签署链接的时候必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。 3. 签\ufffd\ufffd...",
                  "example": "无",
                  "children": [
                    {
                      "name": "IntentionType",
                      "type": "integer",
                      "required": false,
                      "description": "视频认证类型，支持以下类型 1 : 问答模式 2 : 点头模式 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`",
                      "example": "1"
                    },
                    {
                      "name": "IntentionQuestions",
                      "type": "array",
                      "required": false,
                      "description": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。 注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "IntentionActions",
                      "type": "array",
                      "required": false,
                      "description": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。 注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "RuleIdConfig",
                      "type": "object",
                      "required": false,
                      "description": "视频核身相关配置",
                      "example": "无"
                    }
                  ]
                },
                {
                  "name": "SignEndpoints",
                  "type": "array",
                  "required": false,
                  "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
                  "example": "[\"link\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "FormFields",
              "type": "array",
              "required": false,
              "description": "发起方角色的填写控件的填充内容。 注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通，否则模板编辑时无法将填写控件分配给发起方)。 ![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)",
              "example": "表单K-V对列表",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": true,
                  "description": "控件填充值，ComponentType和传入值格式对应关系如下： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） DI...",
                  "example": "Name"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 点击此处查看模板上控件ID的获取方式",
                  "example": "391963b9d3cb2de35dedc6eb0a60e535"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "控件的名字，跟ComponentId二选一，不能全为空 点击此处查看模板上控件名字的获取方式",
                  "example": "住房地址"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定",
                  "example": "false"
                }
              ]
            },
            {
              "name": "FlowType",
              "type": "string",
              "required": false,
              "description": "合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。",
              "example": "入职合同"
            },
            {
              "name": "FlowDescription",
              "type": "string",
              "required": false,
              "description": "合同流程描述信息(可自定义此描述)，最大长度1000个字符。",
              "example": "张三2023年的入职公司财务部的合同"
            },
            {
              "name": "CustomerData",
              "type": "string",
              "required": false,
              "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
              "example": "QmFzZTY05YaF5a65"
            },
            {
              "name": "CustomShowMap",
              "type": "string",
              "required": false,
              "description": "您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。 例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{\ufffd...",
              "example": "合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬！;净重: 100吨;品类: 铁矿石"
            },
            {
              "name": "CcInfos",
              "type": "array",
              "required": false,
              "description": "合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。 注 1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。 2. 请确保抄送人列表中的成员不与任何签署人重复。",
              "example": " ",
              "item_type": "object",
              "children": [
                {
                  "name": "Mobile",
                  "type": "string",
                  "required": false,
                  "description": "被抄送方手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此业务通知方。",
                  "example": "13200000000"
                },
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "被抄送方姓名。 抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。",
                  "example": "典子谦"
                },
                {
                  "name": "CcType",
                  "type": "integer",
                  "required": false,
                  "description": "被抄送方类型, 可设置以下类型: **0** :个人抄送方 **1** :企业员工抄送方",
                  "example": "1"
                },
                {
                  "name": "CcPermission",
                  "type": "integer",
                  "required": false,
                  "description": "被抄送方权限, 可设置如下权限: **0** :可查看合同内容 **1** :可查看合同内容也可下载原文",
                  "example": "1"
                }
              ]
            },
            {
              "name": "NeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业\ufffd\ufffd...",
              "example": "true"
            },
            {
              "name": "CcNotifyType",
              "type": "integer",
              "required": false,
              "description": "若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型： **0** :合同发起时通知通知对方来查看合同（默认） **1** : 签署完成后通知对方来查看合同",
              "example": "0"
            },
            {
              "name": "AutoSignScene",
              "type": "string",
              "required": false,
              "description": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） **OTHER** : 通用场景 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`",
              "example": "E_PRESCRIPTION_AUTO_SIGN"
            },
            {
              "name": "FlowDisplayType",
              "type": "integer",
              "required": false,
              "description": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)",
              "example": "1"
            }
          ]
        },
        {
          "name": "FlowGroupName",
          "type": "string",
          "required": true,
          "description": "合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
          "example": "\"2023年采购合同们\""
        }
      ],
      "required": [
        "Agent",
        "FlowInfos",
        "FlowGroupName"
      ]
    },
    {
      "name": "ChannelCreateFlowReminds",
      "description": "指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办 1. 合同中当前状态为 **待签署** 的签署人是催办的对象 2. **每个合同只能催办一次** **催办的效果**: 对方会收到如下的短信通知 ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png) **注**：`合同催办是白名单功能，请联系客户经理申请开白后使用`",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": true,
          "description": "需执行催办的合同流程ID数组，最多支持100个。",
          "example": "[\"yDSL5UUckpok9bd0UvwoHnxmejhdsSKL\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent",
        "FlowIds"
      ]
    },
    {
      "name": "ChannelCreateFlowSignReview",
      "description": "提交企业流程审批结果 **当前存在两种审核操作：** 签署审核 在通过接口CreateFlowsByTemplatesChannelCreateFlowByFilesChannelCreateFlowGroupByTemplatesChannelCreateFlowGroupByFilesChannelCreatePrepareFlow 发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果 在通过接口CreateFlowsByTemplatesChannelCreateFlowByFilesChannelCreateFlowGroupByTemplatesChannelCreateFlowGr...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。",
          "example": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc"
        },
        {
          "name": "ReviewType",
          "type": "string",
          "required": true,
          "description": "企业内部审核结果 PASS: 审核通过（流程可以继续签署或者发起） REJECT: 审核拒绝（流程状态不变，可以继续调用审核接口通过审核） SIGN_REJECT:拒签(流程终止，流程状态变为拒签状态)",
          "example": "REJECT"
        },
        {
          "name": "ReviewMessage",
          "type": "string",
          "required": false,
          "description": "审核结果原因 字符串长度不超过200 当ReviewType 是拒绝（REJECT） 时此字段必填。 当ReviewType 是拒绝（SIGN_REJECT） 时此字段必填。",
          "example": "合同里边的价格写错了"
        },
        {
          "name": "RecipientId",
          "type": "string",
          "required": false,
          "description": "审核节点的签署人标志，用于指定当前审核的签署方。 注意：以下情况必须传递RecipientId **发起签署流程时，指定签署人需要审批（即签署人需要审批 ApproverNeedSignReview为true），则必须指定RecipientId****如果签署审核节点是个人， 此参数必填**。",
          "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
        },
        {
          "name": "OperateType",
          "type": "string",
          "required": false,
          "description": "流程审核操作类型，取值如下： **SignReview**：（默认）签署审核 **CreateReview**：发起审核 注意：`该字段不传或者为空，则默认为SignReview签署审核，走签署审核流程`",
          "example": "CreateReview"
        }
      ],
      "required": [
        "Agent",
        "FlowId",
        "ReviewType"
      ]
    },
    {
      "name": "ChannelCreateFlowSignUrl",
      "description": "该接口用于发起合同后，生成用户的签署链接 ⚠️ **注意** 1. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。 2. 该接口返回的签署链接适用于APP集成的场景，支持在支付宝、APP打开、浏览器直接打开，**不支持微信小程序嵌入**。配置方式请参考：跳转电子签H5。 如需跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
          "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
        },
        {
          "name": "FlowApproverInfos",
          "type": "array",
          "required": false,
          "description": "流程签署人列表，其中结构体的ApproverType必传。 若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。 若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName， 其他可不传。（如果对应OrganizationOpenId 子客已经认证激活了，则可以省去OrganizationName） 此结构体和发起接口参与方结构体复用，除了上述参数外，可传递的参数有： 1. RecipientId: \ufffd...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "张三"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "110101192008317114"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)， 不支持海外手机号。 请确认手机号所有方为此合同签署方。",
              "example": "13888888888"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
              "example": "典子谦示例企业"
            },
            {
              "name": "NotChannelOrganization",
              "type": "boolean",
              "required": false,
              "description": "指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工",
              "example": "false"
            },
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成 当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程 注： 如果传进来的OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）",
              "example": "userdianziqian"
            },
            {
              "name": "OrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符",
              "example": "orgtencent"
            },
            {
              "name": "ApproverType",
              "type": "string",
              "required": false,
              "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **PERSON** :个人/自然人 **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景 **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签） **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签） 注: `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功...",
              "example": "PERSON"
            },
            {
              "name": "RecipientId",
              "type": "string",
              "required": false,
              "description": "签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；",
              "example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
              "example": "1689688460"
            },
            {
              "name": "SignComponents",
              "type": "array",
              "required": false,
              "description": "使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID:注意：(如果模板里面指定了印章，默认使用模板里面配置的印章，不能进行变更) 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                  "example": "ComponentId"
                },
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": false,
                  "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                  "example": "ComponentName"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "false"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                  "example": "ComponentRecipientId"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentHeight",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": false,
                  "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentExtra",
                  "type": "string",
                  "required": false,
                  "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                  "example": "ComponentExtra"
                },
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": false,
                  "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                  "example": "ComponentValue"
                },
                {
                  "name": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "DocumentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                  "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                },
                {
                  "name": "ComponentDescription",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                  "example": "Desc"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "componentId1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "0"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "Middle"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                  "example": "[0]",
                  "item_type": "integer"
                },
                {
                  "name": "Placeholder",
                  "type": "string",
                  "required": false,
                  "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                  "example": "请签名"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                  "example": "false"
                },
                {
                  "name": "ForbidMoveAndDelete",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "ComponentLimitType",
              "type": "array",
              "required": false,
              "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
              "example": "[\"OCR_ESIGN\"]",
              "item_type": "string"
            },
            {
              "name": "PreReadTime",
              "type": "integer",
              "required": false,
              "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
              "example": "3"
            },
            {
              "name": "JumpUrl",
              "type": "string",
              "required": false,
              "description": "签署完前端跳转的url，此字段的用法场景请联系客户经理确认",
              "example": "https://www.qq.com/success"
            },
            {
              "name": "ApproverOption",
              "type": "object",
              "required": false,
              "description": "可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。 详细操作可以参考开发者中心的ApproverOption结构体。",
              "example": "无",
              "children": [
                {
                  "name": "NoRefuse",
                  "type": "boolean",
                  "required": false,
                  "description": "是否可以拒签 默认false-可以拒签 true-不可以拒签",
                  "example": "true"
                },
                {
                  "name": "NoTransfer",
                  "type": "boolean",
                  "required": false,
                  "description": "是否可以转发 默认false-可以转发 true-不可以转发",
                  "example": "true"
                },
                {
                  "name": "HideOneKeySign",
                  "type": "boolean",
                  "required": false,
                  "description": "当签署方有多个签署区时候，是否隐藏一键所有的签署区false：（默认）不隐藏true：隐藏，每个签署区要单独选择印章或者签名",
                  "example": "true"
                },
                {
                  "name": "FillType",
                  "type": "integer",
                  "required": false,
                  "description": "签署人信息补充类型，默认无需补充。 1 : 动态签署人（可发起合同后再补充签署人信息）注：企业自动签不支持动态补充注：使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关枚举值：1： 动态签署人",
                  "example": "1"
                },
                {
                  "name": "FlowReadLimit",
                  "type": "string",
                  "required": false,
                  "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                  "example": "LimitBottom"
                },
                {
                  "name": "ForbidAddSignDate",
                  "type": "boolean",
                  "required": false,
                  "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "ApproverNeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "此签署人（员工或者个人）签署前，是否需要发起方企业进行审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待发起方企业内部审批完成。 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 \ufffd...",
              "example": "false"
            },
            {
              "name": "ApproverVerifyTypes",
              "type": "array",
              "required": false,
              "description": "指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式 此字段可传\ufffd\ufffd...",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "name": "ApproverSignTypes",
              "type": "array",
              "required": false,
              "description": "签署人签署合同时的认证方式 **1** :人脸认证 **2** :签署密码 **3** :运营商三要素（如果是港澳台客户，建议不要选择这个） **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式） **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式） 默...",
              "example": "[1,2,3]",
              "item_type": "integer"
            },
            {
              "name": "SignId",
              "type": "string",
              "required": false,
              "description": "签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息",
              "example": "06f2bc0f1772d8deac2f92b5df61a5ac"
            },
            {
              "name": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **SMS** :(默认)短信 **NONE** : 不通知 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`",
              "example": "SMS"
            },
            {
              "name": "AddSignComponentsLimits",
              "type": "array",
              "required": false,
              "description": "[通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递Compon...",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "description": "控件类型，支持以下类型 SIGN_SEAL : 印章控件 SIGN_PAGING_SEAL : 骑缝章控件 SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件 SIGN_SIGNATURE : 用户签名控件",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentValue",
                  "type": "array",
                  "required": false,
                  "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人\ufffd...",
                  "example": "[\"HANDWRITE\", \"ESIGN\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "ApproverRoleName",
              "type": "string",
              "required": false,
              "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
              "example": "乙方"
            },
            {
              "name": "SignTypeSelector",
              "type": "integer",
              "required": false,
              "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
              "example": "0"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 数据表格等填写控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件) 注：`此参数仅在通过文件发起合同或者合同组时生效` ![image](http...",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                  "example": "ComponentId"
                },
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": false,
                  "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                  "example": "ComponentName"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "false"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                  "example": "ComponentRecipientId"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentHeight",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": false,
                  "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentExtra",
                  "type": "string",
                  "required": false,
                  "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                  "example": "ComponentExtra"
                },
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": false,
                  "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                  "example": "ComponentValue"
                },
                {
                  "name": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "DocumentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                  "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                },
                {
                  "name": "ComponentDescription",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                  "example": "Desc"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "componentId1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "0"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "Middle"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                  "example": "[0]",
                  "item_type": "integer"
                },
                {
                  "name": "Placeholder",
                  "type": "string",
                  "required": false,
                  "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                  "example": "请签名"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                  "example": "false"
                },
                {
                  "name": "ForbidMoveAndDelete",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "Intention",
              "type": "object",
              "required": false,
              "description": "只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。 2. 使用视频认证时，生成H5签署链接的时候必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。 3. 签\ufffd\ufffd...",
              "example": "无",
              "children": [
                {
                  "name": "IntentionType",
                  "type": "integer",
                  "required": false,
                  "description": "视频认证类型，支持以下类型 1 : 问答模式 2 : 点头模式 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "1"
                },
                {
                  "name": "IntentionQuestions",
                  "type": "array",
                  "required": false,
                  "description": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。 注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Question",
                      "type": "string",
                      "required": false,
                      "description": "当选择语音问答模式时，系统自动播报的问题文本，最大长度为250个字符。",
                      "example": "请问您本次业务是本人自愿办理吗？如是，请回复“我同意”。"
                    },
                    {
                      "name": "Answers",
                      "type": "array",
                      "required": false,
                      "description": "当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。",
                      "example": "“同意”，“我同意”，“确认”，“我确认”",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "IntentionActions",
                  "type": "array",
                  "required": false,
                  "description": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。 注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Text",
                      "type": "string",
                      "required": false,
                      "description": "点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。",
                      "example": "请问您本次业务是本人自愿办理吗？如是，请点头确认。"
                    }
                  ]
                },
                {
                  "name": "RuleIdConfig",
                  "type": "object",
                  "required": false,
                  "description": "视频核身相关配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "Speed",
                      "type": "integer",
                      "required": false,
                      "description": "意愿核身语音播报速度，配置后问答模式和点头模式的语音播报环节都会生效，默认值为0： 0-智能语速（根据播报文案的长度自动调整语音播报速度） 1-固定1倍速 2-固定1.2倍速 3-固定1.5倍速",
                      "example": "0"
                    }
                  ]
                }
              ]
            },
            {
              "name": "SignEndpoints",
              "type": "array",
              "required": false,
              "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
              "example": "[\"link\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "VideoVerifyTimesLimit",
          "type": "integer",
          "required": false,
          "description": "用于指定进入视频签署的限制次数，次数取值范围：1 - 10，不设置则默认为5次，仅视频签署时生效。",
          "example": "5"
        },
        {
          "name": "JumpUrl",
          "type": "string",
          "required": false,
          "description": "签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 跳转电子签H5",
          "example": "https://YOUR_CUSTOM_URL/xxxx"
        },
        {
          "name": "UrlType",
          "type": "integer",
          "required": false,
          "description": "链接类型，支持指定以下类型 0 : 签署链接 (默认值) 1 : 预览链接 注: `1. 当指定链接类型为1时，链接为预览链接，打开链接无法签署仅支持预览以及查看当前合同状态。` `2. 如需生成发起方预览链接，则签署方信息传空，即FlowApproverInfos传空或者不传。`",
          "example": "1"
        }
      ],
      "required": [
        "Agent",
        "FlowId"
      ]
    },
    {
      "name": "ChannelCreateMultiFlowSignQRCode",
      "description": "此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多签签署码。 **适用场景**: 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。 **注意**: 1.满足以下条件的模板支持创建签署码： - 签署对象：企业与个人（无序签署）、企业与个人（顺序签署\u0026企业非首位）、 仅个人签署。 - 其发起方没...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "TemplateId",
          "type": "string",
          "required": true,
          "description": "合同模板ID，为32位字符串。",
          "example": "yDRS4UxxxuO4zjEC0osCOsHS"
        },
        {
          "name": "FlowName",
          "type": "string",
          "required": true,
          "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。",
          "example": "测试合同"
        },
        {
          "name": "MaxFlowNum",
          "type": "integer",
          "required": false,
          "description": "通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。 一旦发起流程数超越该限制，该二维码将自动失效。",
          "example": "100"
        },
        {
          "name": "FlowEffectiveDay",
          "type": "integer",
          "required": false,
          "description": "合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。 若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。 最长设定期限不得超过30天。",
          "example": "7"
        },
        {
          "name": "Restrictions",
          "type": "array",
          "required": false,
          "description": "指定签署人信息。 在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "指定签署人姓名",
              "example": "张三"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "指定签署人手机号，11位数字",
              "example": "13000000000"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": false,
              "description": "指定签署人证件类型，ID_CARD-身份证，HONGKONG_AND_MACAO-港澳居民来往内地通行证，HONGKONG_MACAO_AND_TAIWAN-港澳台居民居住证",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": false,
              "description": "指定签署人证件号码，其中字母大写",
              "example": "4500000000000000000"
            }
          ]
        },
        {
          "name": "ApproverComponentLimitTypes",
          "type": "array",
          "required": false,
          "description": "指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "RecipientId",
              "type": "string",
              "required": true,
              "description": "签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。",
              "example": "yDRscUUgyg3zr9vfUyJ8QKwCN7z9YcOh"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。 签名方式： HANDWRITE-手写签名 ESIGN-个人印章类型 OCR_ESIGN-AI智能识别手写签名 SYSTEM_ESIGN-系统签名",
              "example": "[\"HANDWRITE\", \"SYSTEM_ESIGN\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "ForbidPersonalMultipleSign",
          "type": "boolean",
          "required": false,
          "description": "禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。",
          "example": "true"
        },
        {
          "name": "FlowNameAppendScannerInfo",
          "type": "boolean",
          "required": false,
          "description": "合同流程名称是否应包含扫码签署人的信息，且遵循特定格式（flowname-姓名-手机号后四位）。 例如，通过参数FlowName设定的扫码发起合同名称为“员工入职合同”，当扫码人张三（手机号18800009527）扫码签署时，合同名称将自动生成为“员工入职合同-张三-9527”。",
          "example": "true"
        },
        {
          "name": "QrCodeName",
          "type": "string",
          "required": false,
          "description": "签署二维码的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示，若为空，则使用FlowName",
          "example": "测试签署码"
        },
        {
          "name": "QrCodeExpiredOn",
          "type": "integer",
          "required": false,
          "description": "签署二维码截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为签署二维码创建后的7天时截止，最长可设置为签署二维码创建后的365天时截止。",
          "example": "1757416261"
        }
      ],
      "required": [
        "Agent",
        "TemplateId",
        "FlowName"
      ]
    },
    {
      "name": "ChannelCreateOrganizationBatchSignUrl",
      "description": "通过此接口，可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。 注： - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方或者领取方。 - 仅支持传入待签署或者待领取的合同，待填写暂不支持。 - 员工批量签署，支持多种签名方式，包括手写签名、临摹签名、系统签名、个人印章、签批控件等。 签署的嵌入页面长相如下： ![image]...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括子客企业及应用编、号等详细内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "请指定需执行批量签署的流程ID，数量范围为1-100。 您可登录腾讯电子签控制台，浏览 \"合同\"-\u003e\"合同中心\" 以查阅某一合同的FlowId（在页面中显示为合同ID）。 用户将利用链接对这些合同实施批量操作。",
          "example": "[\"yDxxxxxxxxxxxxxxxxxxxxxxxx\"]",
          "item_type": "string"
        },
        {
          "name": "OpenId",
          "type": "string",
          "required": false,
          "description": "第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 \"更多能力\"-\u003e\"组织管理\" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。 1. 若OpenId为空，Name和Mobile 必须提供。 2. 若OpenId 与 Name，Mobile均存在，将优先采用OpenId对应的员工。",
          "example": "user_open_id"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注：`请确保和合同中填入的一致`",
          "example": "张三"
        },
        {
          "name": "Mobile",
          "type": "string",
          "required": false,
          "description": "员工手机号，必须与姓名一起使用。 如果OpenId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。",
          "example": "13800000000"
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": false,
          "description": "合同组Id，传入此参数则可以不传FlowIds",
          "example": "yDttAUUckpxbczx6UySqdD5wIcNyCCQW"
        },
        {
          "name": "CanBatchReject",
          "type": "boolean",
          "required": false,
          "description": "是否允许此链接中签署方批量拒签。 false (默认): 不允许批量拒签 true : 允许批量拒签。注：`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。`",
          "example": "false"
        },
        {
          "name": "DynamicSignOption",
          "type": "object",
          "required": false,
          "description": "动态签署方领取链接配置。",
          "example": "无",
          "children": [
            {
              "name": "DynamicReceiveType",
              "type": "integer",
              "required": false,
              "description": "多份合同批量签署时，动态签署领取要求：0（默认值）: 可以领取部分合同进入签署。1 : 必须全部领取进入签署，生成链接的所有合同必须相同经办人完成合同的领取签署。",
              "example": "1"
            },
            {
              "name": "OrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "动态签署方时，预设的企业OpenId，预设企业OpenId后，只允许对应的企业员工进行领取签署。",
              "example": "ess_online_org_1"
            }
          ]
        },
        {
          "name": "RecipientIds",
          "type": "array",
          "required": false,
          "description": "为签署方经办人在签署合同中的参与方ID，必须与参数FlowIds数组一一对应。 注：生成动态签署方领取时此参数必传。",
          "example": "[\"yDtK2UUckpfmgindUyHCZxCEZrJgOW8c\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "ChannelCreateOrganizationModifyQrCode",
      "description": "生成渠道子客编辑企业信息二维码",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "ChannelCreatePrepareFlow",
      "description": "通过此接口指定合同、签署人、填写控件等信息，生成嵌入式链接，此链接可以嵌入到其他网页或者直接打开，打开后进入发起页面。在此页面上，合同信息和签署人信息均不可更改。 注意： 1. 仅支持在PC浏览器上进行操作和使用。 2. 在使用模板发起合同时，需指定RecipientId以明确参与方在模板中所扮演的角色。 **嵌入式签署人-各种场景传参说明**: 场景编号 可作为签署方的\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceType",
          "type": "integer",
          "required": true,
          "description": "资源类型，取值有： **1**：模板 **2**：文件（默认值） **3**：草稿",
          "example": "2"
        },
        {
          "name": "FlowInfo",
          "type": "object",
          "required": true,
          "description": "要创建的合同信息",
          "example": "无",
          "children": [
            {
              "name": "FlowName",
              "type": "string",
              "required": true,
              "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
              "example": "张三的入职合同"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": true,
              "description": "合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。",
              "example": "1604912664"
            },
            {
              "name": "FlowType",
              "type": "string",
              "required": false,
              "description": "合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。",
              "example": "销售合同"
            },
            {
              "name": "FlowDescription",
              "type": "string",
              "required": false,
              "description": "合同流程描述信息(可自定义此描述)，最大长度1000个字符。",
              "example": "张三2023年的入职公司财务部的合同"
            },
            {
              "name": "Unordered",
              "type": "boolean",
              "required": false,
              "description": "合同流程的签署顺序类型： **false**：(默认)有序签署, 本合同多个参与人需要依次签署 **true**：无序签署, 本合同多个参与人没有先后签署限制",
              "example": "true"
            },
            {
              "name": "IntelligentStatus",
              "type": "string",
              "required": false,
              "description": "是否打开智能添加填写区(默认开启，打开:\"OPEN\" 关闭：\"CLOSE\")",
              "example": "CLOSE"
            },
            {
              "name": "FormFields",
              "type": "array",
              "required": false,
              "description": "填写控件内容， 填写的控制的ID-填写的内容对列表",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": true,
                  "description": "控件填充值，ComponentType和传入值格式对应关系如下： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） DI...",
                  "example": "Name"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 点击此处查看模板上控件ID的获取方式",
                  "example": "391963b9d3cb2de35dedc6eb0a60e535"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "控件的名字，跟ComponentId二选一，不能全为空 点击此处查看模板上控件名字的获取方式",
                  "example": "住房地址"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定",
                  "example": "false"
                }
              ]
            },
            {
              "name": "NeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业\ufffd\ufffd...",
              "example": "false"
            },
            {
              "name": "UserData",
              "type": "string",
              "required": false,
              "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
              "example": "QmFzZTY05YaF5a65"
            },
            {
              "name": "CcInfos",
              "type": "array",
              "required": false,
              "description": "合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。 注 1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。 2. 请确保抄送人列表中的成员不与任何签署人重复。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Mobile",
                  "type": "string",
                  "required": false,
                  "description": "被抄送方手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此业务通知方。",
                  "example": "13200000000"
                },
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "被抄送方姓名。 抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。",
                  "example": "典子谦"
                },
                {
                  "name": "CcType",
                  "type": "integer",
                  "required": false,
                  "description": "被抄送方类型, 可设置以下类型: **0** :个人抄送方 **1** :企业员工抄送方",
                  "example": "1"
                },
                {
                  "name": "CcPermission",
                  "type": "integer",
                  "required": false,
                  "description": "被抄送方权限, 可设置如下权限: **0** :可查看合同内容 **1** :可查看合同内容也可下载原文",
                  "example": "1"
                }
              ]
            },
            {
              "name": "NeedCreateReview",
              "type": "boolean",
              "required": false,
              "description": "发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。",
              "example": "false"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "填写控件：文件发起使用",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                  "example": "ComponentId"
                },
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": false,
                  "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                  "example": "ComponentName"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "false"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                  "example": "ComponentRecipientId"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentHeight",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": false,
                  "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentExtra",
                  "type": "string",
                  "required": false,
                  "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                  "example": "ComponentExtra"
                },
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": false,
                  "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                  "example": "ComponentValue"
                },
                {
                  "name": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "DocumentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                  "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                },
                {
                  "name": "ComponentDescription",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                  "example": "Desc"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "componentId1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "0"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "Middle"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                  "example": "[0]",
                  "item_type": "integer"
                },
                {
                  "name": "Placeholder",
                  "type": "string",
                  "required": false,
                  "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                  "example": "请签名"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                  "example": "false"
                },
                {
                  "name": "ForbidMoveAndDelete",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "FlowDisplayType",
              "type": "integer",
              "required": false,
              "description": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)",
              "example": "1"
            },
            {
              "name": "FileIds",
              "type": "array",
              "required": false,
              "description": "签署文件资源Id列表，目前仅支持单个文件",
              "example": "yDCWiUUckpv6iggyUyuqIrwyppQV",
              "item_type": "string"
            },
            {
              "name": "Approvers",
              "type": "array",
              "required": false,
              "description": "合同签署人信息",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "NotChannelOrganization",
                  "type": "boolean",
                  "required": false,
                  "description": "指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工",
                  "example": "true"
                },
                {
                  "name": "ApproverType",
                  "type": "integer",
                  "required": false,
                  "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **0** :企业/企业员工（企业签署方或模板发起时的企业静默签） **1** :个人/自然人 **3** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签） 注：类型为3（企业/企业员工自动签）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。 使用自动签\ufffd...",
                  "example": "1"
                },
                {
                  "name": "OrganizationId",
                  "type": "string",
                  "required": false,
                  "description": "电子签平台给企业生成的企业id",
                  "example": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
                },
                {
                  "name": "OrganizationOpenId",
                  "type": "string",
                  "required": false,
                  "description": "企业OpenId，第三方应用集成非静默签子客企业签署人发起合同必传",
                  "example": "org_diziqian"
                },
                {
                  "name": "OrganizationName",
                  "type": "string",
                  "required": false,
                  "description": "企业名称，第三方应用集成非静默签子客企业签署人必传，saas企业签署人必传",
                  "example": "典子谦示例企业"
                },
                {
                  "name": "UserId",
                  "type": "string",
                  "required": false,
                  "description": "电子签平台给企业员工或者自热人生成的用户id",
                  "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
                },
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方平台子客企业员工的唯一标识",
                  "example": "n9527"
                },
                {
                  "name": "ApproverName",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "典子谦"
                },
                {
                  "name": "ApproverMobile",
                  "type": "string",
                  "required": false,
                  "description": "签署人手机号，saas企业签署人，个人签署人必传",
                  "example": "13888888888"
                },
                {
                  "name": "ApproverIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "ID_CARD "
                },
                {
                  "name": "ApproverIdCardNumber",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "110101192008317114"
                },
                {
                  "name": "RecipientId",
                  "type": "string",
                  "required": false,
                  "description": "签署人Id，使用模板发起是，对应模板配置中的签署人RecipientId 注意：模板发起时该字段必填",
                  "example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
                },
                {
                  "name": "PreReadTime",
                  "type": "integer",
                  "required": false,
                  "description": "签署前置条件：阅读时长限制，不传默认10s,最大300s，最小3s",
                  "example": "5"
                },
                {
                  "name": "IsFullText",
                  "type": "boolean",
                  "required": false,
                  "description": "签署前置条件：阅读全文限制",
                  "example": "true"
                },
                {
                  "name": "NotifyType",
                  "type": "string",
                  "required": false,
                  "description": "通知签署方经办人的方式, 有以下途径: **SMS** :(默认)短信 **NONE** : 不通知 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`",
                  "example": "NONE"
                },
                {
                  "name": "ApproverOption",
                  "type": "object",
                  "required": false,
                  "description": "签署人配置，用于控制签署人相关属性",
                  "example": "无",
                  "children": [
                    {
                      "name": "CanEditApprover",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许修改签署人信息",
                      "example": "true"
                    },
                    {
                      "name": "NoRefuse",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以拒签 默认false-可以拒签 true-不可以拒签",
                      "example": "true"
                    },
                    {
                      "name": "NoTransfer",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以转发 默认false-可以转发 true-不可以转发",
                      "example": "true"
                    },
                    {
                      "name": "HideOneKeySign",
                      "type": "boolean",
                      "required": false,
                      "description": "当签署方有多个签署区时候，是否隐藏一键所有的签署区 false：（默认）不隐藏 true：隐藏，每个签署区要单独选择印章或者签名",
                      "example": "true"
                    },
                    {
                      "name": "FlowReadLimit",
                      "type": "string",
                      "required": false,
                      "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                      "example": "LimitBottom"
                    },
                    {
                      "name": "ForbidAddSignDate",
                      "type": "boolean",
                      "required": false,
                      "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                      "example": "true"
                    }
                  ]
                },
                {
                  "name": "SignComponents",
                  "type": "array",
                  "required": false,
                  "description": "使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID: 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ApproverVerifyTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式 此字段可传\ufffd\ufffd...",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "ApproverSignTypes",
                  "type": "array",
                  "required": false,
                  "description": "签署人签署合同时的认证方式 **1** :人脸认证 **2** :签署密码 **3** :运营商三要素 **5** :设备指纹识别 **6** :设备面容识别 默认为1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别) 注: 1. 用模板创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在创建合同重新指定无效 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持...",
                  "example": "[1,2,3]\t",
                  "item_type": "integer"
                }
              ]
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "ResourceId",
          "type": "string",
          "required": false,
          "description": "资源id，与ResourceType相对应，取值范围： 文件Id（通过UploadFiles获取文件资源Id） 模板Id（通过控制台创建模板后获取模板Id） 草稿Id（通过嵌入页面保存草稿后获取草稿Id） 注意：需要同时设置 ResourceType 参数指定资源类型",
          "example": "yDwqFUUckp3em41rUwWPgIBjsYgG5bba"
        },
        {
          "name": "FlowOption",
          "type": "object",
          "required": false,
          "description": "合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑",
          "example": "无",
          "children": [
            {
              "name": "CanEditFlow",
              "type": "boolean",
              "required": false,
              "description": "是否允许修改合同信息， **true**：可以 **false**：（默认）不可以",
              "example": "true"
            },
            {
              "name": "HideShowFlowName",
              "type": "boolean",
              "required": false,
              "description": "是否允许发起合同弹窗隐藏合同名称 **true**：允许 **false**：（默认）不允许",
              "example": "false"
            },
            {
              "name": "HideShowFlowType",
              "type": "boolean",
              "required": false,
              "description": "是否允许发起合同弹窗隐藏合同类型， **true**：允许 **false**：（默认）不允许",
              "example": "true"
            },
            {
              "name": "HideShowDeadline",
              "type": "boolean",
              "required": false,
              "description": "是否允许发起合同弹窗隐藏合同到期时间 **true**：允许 **false**：（默认）不允许",
              "example": "true"
            },
            {
              "name": "CanSkipAddApprover",
              "type": "boolean",
              "required": false,
              "description": "是否允许发起合同步骤跳过指定签署方步骤 **true**：允许 **false**：（默认）不允许",
              "example": "false"
            },
            {
              "name": "ForbidEditApprover",
              "type": "boolean",
              "required": false,
              "description": "是否可以编辑签署人包括新增，修改，删除 （默认） false -可以编辑签署人 true - 禁止编辑签署人 注意： * 如果设置参数为 true， 则 参数签署人 [FlowApproverList](https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow) 不能为空 * 此参数对子客和自动签无效，不允许进行修改。",
              "example": "false"
            },
            {
              "name": "CustomCreateFlowDescription",
              "type": "string",
              "required": false,
              "description": "定制化发起合同弹窗的描述信息，长度不能超过500，只能由中文、字母、数字和标点组成。",
              "example": "本合同已经经过法务评估"
            },
            {
              "name": "ForbidEditFillComponent",
              "type": "boolean",
              "required": false,
              "description": "禁止编辑填写控件 **true**：禁止编辑填写控件 **false**：（默认）允许编辑填写控件",
              "example": "false"
            },
            {
              "name": "SkipUploadFile",
              "type": "boolean",
              "required": false,
              "description": "跳过上传文件步骤 **true**：跳过 **false**：（默认）不跳过，需要传ResourceId",
              "example": "false"
            },
            {
              "name": "SignComponentConfig",
              "type": "object",
              "required": false,
              "description": "签署控件的配置信息，用在嵌入式发起的页面配置，包括 - 签署控件 是否默认展示日期.",
              "example": "无",
              "children": [
                {
                  "name": "HideDate",
                  "type": "boolean",
                  "required": false,
                  "description": "签署控件默认属性配置，是否默认展示签署日期， 在页面中可以进行修改。 - false 展示签署日期（默认） - true 不展示签署日期 ![image](https://qcloudimg.tencent-cloud.cn/raw/448514412e2f69f6129425beda4ff568.png)。",
                  "example": "false"
                }
              ]
            },
            {
              "name": "ForbidEditWatermark",
              "type": "boolean",
              "required": false,
              "description": "是否禁止编辑（展示）水印控件属性 （默认） false -否 true - 禁止编辑",
              "example": "true"
            },
            {
              "name": "PreviewAfterStart",
              "type": "boolean",
              "required": false,
              "description": "发起成功后是否预览合同 （默认） false -否 true - 展示预览按钮",
              "example": "false"
            },
            {
              "name": "SignAfterStart",
              "type": "boolean",
              "required": false,
              "description": "发起成功之后是否签署合同，仅当前经办人作为签署人时生效 （默认） false -否 true - 展示签署按钮",
              "example": "false"
            },
            {
              "name": "HideOperationSteps",
              "type": "array",
              "required": false,
              "description": "隐藏操作步骤: 具体的控件类型如下 1 : 选择文件及签署方 2 : 补充文件内容 4 : 发起前合同信息与设置确认 注：仅对新版页面生效",
              "example": "[1,2,4]",
              "item_type": "integer"
            },
            {
              "name": "SelfName",
              "type": "string",
              "required": false,
              "description": "本企业简称，注：仅对新版页面生效",
              "example": "典子签企业"
            },
            {
              "name": "HideSignCodeAfterStart",
              "type": "boolean",
              "required": false,
              "description": "发起后签署码隐藏，默认false，注：仅对新版页面生效",
              "example": "false"
            },
            {
              "name": "NeedFlowDraft",
              "type": "boolean",
              "required": false,
              "description": "发起过程中是否保存草稿",
              "example": "false"
            },
            {
              "name": "HideComponentTypes",
              "type": "array",
              "required": false,
              "description": "在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数 只能二选一使用（注: 空数组代表未指定），具体的控件类型如下 SIGN_SIGNATURE : 个人签名/印章 SIGN_SEAL : 企业印章 SIGN_PAGING_SEAL : 骑缝章 SIGN_LEGAL_PERSON_SEAL : 法定代表人章 SIGN_APPROVE : 签批 SIGN_OPINION : 签署意见 SIGN_PAGING_SIGNATURE : 手写签名骑缝控件 BUSI-FULL-NAME : 企业全称 BUSI-CREDIT-CODE : 统一社会信用代码 BUSI-LEGAL-NAME...",
              "example": "[\"MULTI_LINE_TEXT\"]",
              "item_type": "string"
            },
            {
              "name": "ShowComponentTypes",
              "type": "array",
              "required": false,
              "description": "在发起流程的可嵌入页面要显示的控件列表，和 HideComponentTypes 参数 只能二选一使用（注: 空数组代表未指定），具体的控件类型如下 SIGN_SIGNATURE : 个人签名/印章 SIGN_SEAL : 企业印章 SIGN_PAGING_SEAL : 骑缝章 SIGN_LEGAL_PERSON_SEAL : 法定代表人章 SIGN_APPROVE : 签批 SIGN_OPINION : 签署意见 SIGN_PAGING_SIGNATURE : 手写签名骑缝控件 BUSI-FULL-NAME : 企业全称 BUSI-CREDIT-CODE : 统一社会信用代码 BUSI-LEGAL-NAME...",
              "example": "[\"MULTI_LINE_TEXT\"]",
              "item_type": "string"
            },
            {
              "name": "ForbidAddApprover",
              "type": "boolean",
              "required": false,
              "description": "禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”",
              "example": "true"
            },
            {
              "name": "ForbidEditFlowProperties",
              "type": "boolean",
              "required": false,
              "description": "禁止设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板",
              "example": "true"
            },
            {
              "name": "ResultPageConfig",
              "type": "object",
              "required": false,
              "description": "发起流程的可嵌入页面结果页配置",
              "example": "无",
              "children": [
                {
                  "name": "Type",
                  "type": "integer",
                  "required": true,
                  "description": "0 : 发起审批成功页面（通过接口创建发起流程web页面发起时设置了NeedCreateReview参数为true）"
                },
                {
                  "name": "Title",
                  "type": "string",
                  "required": true,
                  "description": "结果页标题，不超过50字"
                },
                {
                  "name": "Description",
                  "type": "string",
                  "required": false,
                  "description": "结果页描述，不超过200字"
                }
              ]
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": false,
          "description": "合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接 注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`",
          "example": "yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT"
        }
      ],
      "required": [
        "ResourceType",
        "FlowInfo"
      ]
    },
    {
      "name": "ChannelCreatePrepareFlowGroup",
      "description": "接口（ChannelCreatePrepareFlowGroup）用于创建嵌入式合同组签署流程。 - 该接口当前仅支持文件发起 - 该接口能力和ChannelCreateFlowGroupByFiles，~~ChannelCreateFlowGroupByTemplates~~保持一致。 - 返回的FlowGroupId 为临时id，只有在页面内成功发起后FlowGroupId才会有效。",
      "status": "online",
      "parameters": [
        {
          "name": "BaseFlowInfos",
          "type": "array",
          "required": true,
          "description": "合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FlowName",
              "type": "string",
              "required": true,
              "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
              "example": "张三的入职合同"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": true,
              "description": "合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。",
              "example": "1604912664"
            },
            {
              "name": "FlowType",
              "type": "string",
              "required": false,
              "description": "合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。",
              "example": "销售合同"
            },
            {
              "name": "FlowDescription",
              "type": "string",
              "required": false,
              "description": "合同流程描述信息(可自定义此描述)，最大长度1000个字符。",
              "example": "张三2023年的入职公司财务部的合同"
            },
            {
              "name": "Unordered",
              "type": "boolean",
              "required": false,
              "description": "合同流程的签署顺序类型： **false**：(默认)有序签署, 本合同多个参与人需要依次签署 **true**：无序签署, 本合同多个参与人没有先后签署限制",
              "example": "true"
            },
            {
              "name": "IntelligentStatus",
              "type": "string",
              "required": false,
              "description": "是否打开智能添加填写区(默认开启，打开:\"OPEN\" 关闭：\"CLOSE\")",
              "example": "CLOSE"
            },
            {
              "name": "FormFields",
              "type": "array",
              "required": false,
              "description": "填写控件内容， 填写的控制的ID-填写的内容对列表",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": true,
                  "description": "控件填充值，ComponentType和传入值格式对应关系如下： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） DI...",
                  "example": "Name"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 点击此处查看模板上控件ID的获取方式",
                  "example": "391963b9d3cb2de35dedc6eb0a60e535"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "控件的名字，跟ComponentId二选一，不能全为空 点击此处查看模板上控件名字的获取方式",
                  "example": "住房地址"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定",
                  "example": "false"
                }
              ]
            },
            {
              "name": "NeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业\ufffd\ufffd...",
              "example": "false"
            },
            {
              "name": "UserData",
              "type": "string",
              "required": false,
              "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
              "example": "QmFzZTY05YaF5a65"
            },
            {
              "name": "CcInfos",
              "type": "array",
              "required": false,
              "description": "合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。 注 1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。 2. 请确保抄送人列表中的成员不与任何签署人重复。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Mobile",
                  "type": "string",
                  "required": false,
                  "description": "被抄送方手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此业务通知方。",
                  "example": "13200000000"
                },
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "被抄送方姓名。 抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。",
                  "example": "典子谦"
                },
                {
                  "name": "CcType",
                  "type": "integer",
                  "required": false,
                  "description": "被抄送方类型, 可设置以下类型: **0** :个人抄送方 **1** :企业员工抄送方",
                  "example": "1"
                },
                {
                  "name": "CcPermission",
                  "type": "integer",
                  "required": false,
                  "description": "被抄送方权限, 可设置如下权限: **0** :可查看合同内容 **1** :可查看合同内容也可下载原文",
                  "example": "1"
                }
              ]
            },
            {
              "name": "NeedCreateReview",
              "type": "boolean",
              "required": false,
              "description": "发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。",
              "example": "false"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "填写控件：文件发起使用",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                  "example": "ComponentId"
                },
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": false,
                  "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                  "example": "SIGN_SEAL"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                  "example": "ComponentName"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "false"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                  "example": "ComponentRecipientId"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentHeight",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": false,
                  "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": false,
                  "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "10.0"
                },
                {
                  "name": "ComponentExtra",
                  "type": "string",
                  "required": false,
                  "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                  "example": "ComponentExtra"
                },
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": false,
                  "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                  "example": "ComponentValue"
                },
                {
                  "name": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "DocumentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                  "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                },
                {
                  "name": "ComponentDescription",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                  "example": "Desc"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                  "example": "100.5"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "componentId1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "0"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "Middle"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                  "example": "[0]",
                  "item_type": "integer"
                },
                {
                  "name": "Placeholder",
                  "type": "string",
                  "required": false,
                  "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                  "example": "请签名"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                  "example": "false"
                },
                {
                  "name": "ForbidMoveAndDelete",
                  "type": "boolean",
                  "required": false,
                  "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "FlowDisplayType",
              "type": "integer",
              "required": false,
              "description": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)",
              "example": "1"
            },
            {
              "name": "FileIds",
              "type": "array",
              "required": false,
              "description": "签署文件资源Id列表，目前仅支持单个文件",
              "example": "yDCWiUUckpv6iggyUyuqIrwyppQV",
              "item_type": "string"
            },
            {
              "name": "Approvers",
              "type": "array",
              "required": false,
              "description": "合同签署人信息",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "NotChannelOrganization",
                  "type": "boolean",
                  "required": false,
                  "description": "指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工",
                  "example": "true"
                },
                {
                  "name": "ApproverType",
                  "type": "integer",
                  "required": false,
                  "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **0** :企业/企业员工（企业签署方或模板发起时的企业静默签） **1** :个人/自然人 **3** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签） 注：类型为3（企业/企业员工自动签）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。 使用自动签\ufffd...",
                  "example": "1"
                },
                {
                  "name": "OrganizationId",
                  "type": "string",
                  "required": false,
                  "description": "电子签平台给企业生成的企业id",
                  "example": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
                },
                {
                  "name": "OrganizationOpenId",
                  "type": "string",
                  "required": false,
                  "description": "企业OpenId，第三方应用集成非静默签子客企业签署人发起合同必传",
                  "example": "org_diziqian"
                },
                {
                  "name": "OrganizationName",
                  "type": "string",
                  "required": false,
                  "description": "企业名称，第三方应用集成非静默签子客企业签署人必传，saas企业签署人必传",
                  "example": "典子谦示例企业"
                },
                {
                  "name": "UserId",
                  "type": "string",
                  "required": false,
                  "description": "电子签平台给企业员工或者自热人生成的用户id",
                  "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
                },
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方平台子客企业员工的唯一标识",
                  "example": "n9527"
                },
                {
                  "name": "ApproverName",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "典子谦"
                },
                {
                  "name": "ApproverMobile",
                  "type": "string",
                  "required": false,
                  "description": "签署人手机号，saas企业签署人，个人签署人必传",
                  "example": "13888888888"
                },
                {
                  "name": "ApproverIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "ID_CARD "
                },
                {
                  "name": "ApproverIdCardNumber",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "110101192008317114"
                },
                {
                  "name": "RecipientId",
                  "type": "string",
                  "required": false,
                  "description": "签署人Id，使用模板发起是，对应模板配置中的签署人RecipientId 注意：模板发起时该字段必填",
                  "example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
                },
                {
                  "name": "PreReadTime",
                  "type": "integer",
                  "required": false,
                  "description": "签署前置条件：阅读时长限制，不传默认10s,最大300s，最小3s",
                  "example": "5"
                },
                {
                  "name": "IsFullText",
                  "type": "boolean",
                  "required": false,
                  "description": "签署前置条件：阅读全文限制",
                  "example": "true"
                },
                {
                  "name": "NotifyType",
                  "type": "string",
                  "required": false,
                  "description": "通知签署方经办人的方式, 有以下途径: **SMS** :(默认)短信 **NONE** : 不通知 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`",
                  "example": "NONE"
                },
                {
                  "name": "ApproverOption",
                  "type": "object",
                  "required": false,
                  "description": "签署人配置，用于控制签署人相关属性",
                  "example": "无",
                  "children": [
                    {
                      "name": "CanEditApprover",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许修改签署人信息",
                      "example": "true"
                    },
                    {
                      "name": "NoRefuse",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以拒签 默认false-可以拒签 true-不可以拒签",
                      "example": "true"
                    },
                    {
                      "name": "NoTransfer",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以转发 默认false-可以转发 true-不可以转发",
                      "example": "true"
                    },
                    {
                      "name": "HideOneKeySign",
                      "type": "boolean",
                      "required": false,
                      "description": "当签署方有多个签署区时候，是否隐藏一键所有的签署区 false：（默认）不隐藏 true：隐藏，每个签署区要单独选择印章或者签名",
                      "example": "true"
                    },
                    {
                      "name": "FlowReadLimit",
                      "type": "string",
                      "required": false,
                      "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                      "example": "LimitBottom"
                    },
                    {
                      "name": "ForbidAddSignDate",
                      "type": "boolean",
                      "required": false,
                      "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                      "example": "true"
                    }
                  ]
                },
                {
                  "name": "SignComponents",
                  "type": "array",
                  "required": false,
                  "description": "使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID: 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ApproverVerifyTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式 此字段可传\ufffd\ufffd...",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "ApproverSignTypes",
                  "type": "array",
                  "required": false,
                  "description": "签署人签署合同时的认证方式 **1** :人脸认证 **2** :签署密码 **3** :运营商三要素 **5** :设备指纹识别 **6** :设备面容识别 默认为1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别) 注: 1. 用模板创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在创建合同重新指定无效 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持...",
                  "example": "[1,2,3]\t",
                  "item_type": "integer"
                }
              ]
            }
          ]
        },
        {
          "name": "FlowGroupName",
          "type": "string",
          "required": true,
          "description": "合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
          "example": "\"2023年采购合同们\""
        },
        {
          "name": "ResourceType",
          "type": "integer",
          "required": true,
          "description": "资源类型，取值有： **1**：模板 **2**：文件",
          "example": "2"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业） 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人） 合同的发起企业和发起人必需已经完成实名，并加入企业",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        }
      ],
      "required": [
        "BaseFlowInfos",
        "FlowGroupName",
        "ResourceType"
      ]
    },
    {
      "name": "ChannelCreatePreparedPersonalEsign",
      "description": "本接口（ChannelCreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，使用此接口请与客户经理确认）。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "UserName",
          "type": "string",
          "required": true,
          "description": "个人用户姓名",
          "example": "张三"
        },
        {
          "name": "IdCardNumber",
          "type": "string",
          "required": true,
          "description": "证件号码, 应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
          "example": "620000198802020000"
        },
        {
          "name": "SealName",
          "type": "string",
          "required": true,
          "description": "电子印章名字，1-50个中文字符 注:`同一企业下电子印章名字不能相同`",
          "example": "我的印章名称"
        },
        {
          "name": "SealImage",
          "type": "string",
          "required": false,
          "description": "电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式。",
          "example": "aHR0cHM6Ly9jYXBpLndvYS5jb20vhaWwlM0ZpZCUzRGVzc2Jhc2ljJTI2dGFiJTNEYXBp..图片base64省略"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
              "example": "n9527"
            }
          ]
        },
        {
          "name": "IdCardType",
          "type": "string",
          "required": false,
          "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
          "example": "ID_CARD"
        },
        {
          "name": "SealImageCompress",
          "type": "boolean",
          "required": false,
          "description": "是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。",
          "example": "false"
        },
        {
          "name": "Mobile",
          "type": "string",
          "required": false,
          "description": "手机号码；当需要开通自动签时，该参数必传",
          "example": "18888888888"
        },
        {
          "name": "EnableAutoSign",
          "type": "boolean",
          "required": false,
          "description": "该字段已不再使用",
          "example": "false"
        },
        {
          "name": "LicenseType",
          "type": "integer",
          "required": false,
          "description": "设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减",
          "example": "0"
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": false,
          "description": "**E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        },
        {
          "name": "FileId",
          "type": "string",
          "required": false,
          "description": "印章图片文件 id取值：填写的FileId通过UploadFiles接口上传文件获取。",
          "example": "yDtOJUUckpftturtURxNEFKShAukAd2b"
        }
      ],
      "required": [
        "Agent",
        "UserName",
        "IdCardNumber",
        "SealName"
      ]
    },
    {
      "name": "ChannelCreateReleaseFlow",
      "description": "发起解除协议的主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。 解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。具体用法可以参考文档[合同解除](https://qian.tencent.com/developers/partner/flow_release)。 注意： 原合同必须签署完成后才能发起解除协议。 只有原合同企业类型的参与人才能发起解除协议，个人参与方不能发起解除协议。 原合同\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "NeedRelievedFlowId",
          "type": "string",
          "required": true,
          "description": "待解除的签署流程编号(即原签署流程的编号)。 [点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)",
          "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
        },
        {
          "name": "ReliveInfo",
          "type": "object",
          "required": true,
          "description": "解除协议内容, 包括解除理由等信息。",
          "example": "无",
          "children": [
            {
              "name": "Reason",
              "type": "string",
              "required": true,
              "description": "解除理由，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
              "example": "合同中的金额写错了"
            },
            {
              "name": "RemainInForceItem",
              "type": "string",
              "required": false,
              "description": "解除后仍然有效的条款，保留条款，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
              "example": "买卖小狗的交易地点、小狗的品种"
            },
            {
              "name": "OriginalExpenseSettlement",
              "type": "string",
              "required": false,
              "description": "原合同事项处理-费用结算，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
              "example": "1000元"
            },
            {
              "name": "OriginalOtherSettlement",
              "type": "string",
              "required": false,
              "description": "原合同事项处理-其他事项，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
              "example": "原合同中的补充条款依然生效"
            },
            {
              "name": "OtherDeals",
              "type": "string",
              "required": false,
              "description": "其他约定（如约定的与解除协议存在冲突的，以【其他约定】为准），最大支持200个字，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
              "example": "解除后1天内部签署新的合同"
            }
          ]
        },
        {
          "name": "ReleasedApprovers",
          "type": "array",
          "required": false,
          "description": "替换解除协议的签署人， 如不指定新的签署人，将继续使用原流程的签署人作为本解除协议的参与方。 如需更换原合同中的企业端签署人，可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口DescribeFlowDetailInfo查询签署人的ApproverNumber编号，默认从0开始，顺序递增) 注： 1. 支持更换企业的签署人，不支持更换个人类型的签署人。 2. 己方企\ufffd...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ApproverNumber",
              "type": "integer",
              "required": true,
              "description": "签署人在原合同签署人列表中的顺序序号(从0开始，按顺序依次递增)。 可以通过DescribeFlowDetailInfo接口查看原流程中的签署人列表。",
              "example": "0"
            },
            {
              "name": "ApproverType",
              "type": "string",
              "required": true,
              "description": "指定签署人类型，目前支持 **ORGANIZATION**：企业(默认值) **ENTERPRISESERVER**：企业静默签",
              "example": "ORGANIZATION"
            },
            {
              "name": "ReleasedApproverRecipientId",
              "type": "string",
              "required": false,
              "description": "【已废弃】请用ApproverNumber来指定替换的参与方的位置",
              "example": "yDCb7UUckpwm3x62UEXHVn8B2hB9q8hT"
            },
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "签署人姓名，最大长度50个字。",
              "example": "典子谦"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证(默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": false,
              "description": "证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "签署人手机号。",
              "example": "13200000000"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。",
              "example": "典子谦示例企业"
            },
            {
              "name": "OrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体。 当为子客企业指定经办人时，此OrganizationOpenId必传。",
              "example": "org_dianziqian"
            },
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成。 当签署方为同一第三方平台下的员工时，此OpenId必传。",
              "example": "n9527"
            },
            {
              "name": "ApproverSignComponentType",
              "type": "string",
              "required": false,
              "description": "签署控件类型，支持自定义企业签署方的签署控件类型 **SIGN_SEAL**：默认为印章控件类型(默认值) **SIGN_SIGNATURE**：手写签名控件类型",
              "example": "SIGN_SEAL"
            },
            {
              "name": "ApproverSignRole",
              "type": "string",
              "required": false,
              "description": "参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`，以此类推。 如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。 ![image](https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png)",
              "example": "供应商"
            },
            {
              "name": "ApproverSignSealId",
              "type": "string",
              "required": false,
              "description": "印章Id，签署控件类型为印章时，用于指定本企业签署方在解除协议中使用那个印章进行签署",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Deadline",
          "type": "integer",
          "required": false,
          "description": "合同流程的签署截止时间，格式为Unix标准时间戳(秒)，如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。",
          "example": "1604912664"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。",
          "example": "eyJDb21lRnJvbSI6Inh4eCJ9"
        }
      ],
      "required": [
        "Agent",
        "NeedRelievedFlowId",
        "ReliveInfo"
      ]
    },
    {
      "name": "ChannelCreateRole",
      "description": "此接口（ChannelCreateRole）用来创建企业自定义角色。 适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。 适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/de...",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。",
          "example": "张三"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "角色描述，最大长度为50个字符",
          "example": "这是一个XXXX角色"
        },
        {
          "name": "PermissionGroups",
          "type": "array",
          "required": false,
          "description": "权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "GroupName",
              "type": "string",
              "required": false,
              "description": "权限组名称",
              "example": "费用中心"
            },
            {
              "name": "GroupKey",
              "type": "string",
              "required": false,
              "description": "权限组key",
              "example": "bill"
            },
            {
              "name": "Hide",
              "type": "integer",
              "required": false,
              "description": "是否隐藏分组，0否1是",
              "example": "0"
            },
            {
              "name": "Permissions",
              "type": "array",
              "required": false,
              "description": "权限集合",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "权限名称",
                  "example": "费用管理"
                },
                {
                  "name": "Key",
                  "type": "string",
                  "required": false,
                  "description": "权限key",
                  "example": "BillManagement"
                },
                {
                  "name": "Type",
                  "type": "integer",
                  "required": false,
                  "description": "权限类型 1前端，2后端",
                  "example": "1"
                },
                {
                  "name": "Hide",
                  "type": "integer",
                  "required": false,
                  "description": "是否隐藏",
                  "example": "0"
                },
                {
                  "name": "DataLabel",
                  "type": "integer",
                  "required": false,
                  "description": "数据权限标签 1:表示根节点，2:表示叶子结点",
                  "example": "0"
                },
                {
                  "name": "DataType",
                  "type": "integer",
                  "required": false,
                  "description": "数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权",
                  "example": "0"
                },
                {
                  "name": "DataRange",
                  "type": "integer",
                  "required": false,
                  "description": "数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己",
                  "example": "0"
                },
                {
                  "name": "DataTo",
                  "type": "string",
                  "required": false,
                  "description": "关联权限, 表示这个功能权限要受哪个数据权限管控",
                  "example": "FlowsManagement"
                },
                {
                  "name": "ParentKey",
                  "type": "string",
                  "required": false,
                  "description": "父级权限key",
                  "example": "FlowsManagement"
                },
                {
                  "name": "IsChecked",
                  "type": "boolean",
                  "required": false,
                  "description": "是否选中",
                  "example": "false"
                },
                {
                  "name": "Children",
                  "type": "array",
                  "required": false,
                  "description": "子权限集合",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Name",
                      "type": "string",
                      "required": false,
                      "description": "权限名称",
                      "example": "费用管理"
                    },
                    {
                      "name": "Key",
                      "type": "string",
                      "required": false,
                      "description": "权限key",
                      "example": "BillManagement"
                    },
                    {
                      "name": "Type",
                      "type": "integer",
                      "required": false,
                      "description": "权限类型 1前端，2后端",
                      "example": "1"
                    },
                    {
                      "name": "Hide",
                      "type": "integer",
                      "required": false,
                      "description": "是否隐藏",
                      "example": "0"
                    },
                    {
                      "name": "DataLabel",
                      "type": "integer",
                      "required": false,
                      "description": "数据权限标签 1:表示根节点，2:表示叶子结点",
                      "example": "0"
                    },
                    {
                      "name": "DataType",
                      "type": "integer",
                      "required": false,
                      "description": "数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权",
                      "example": "0"
                    },
                    {
                      "name": "DataRange",
                      "type": "integer",
                      "required": false,
                      "description": "数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己",
                      "example": "0"
                    },
                    {
                      "name": "DataTo",
                      "type": "string",
                      "required": false,
                      "description": "关联权限, 表示这个功能权限要受哪个数据权限管控",
                      "example": "FlowsManagement"
                    },
                    {
                      "name": "ParentKey",
                      "type": "string",
                      "required": false,
                      "description": "父级权限key",
                      "example": "FlowsManagement"
                    },
                    {
                      "name": "IsChecked",
                      "type": "boolean",
                      "required": false,
                      "description": "是否选中",
                      "example": "false"
                    },
                    {
                      "name": "Children",
                      "type": "array",
                      "required": false,
                      "description": "子权限集合",
                      "example": "无",
                      "item_type": "string"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "Name",
        "Agent"
      ]
    },
    {
      "name": "ChannelCreateSealPolicy",
      "description": "将指定印章授权给第三方平台子客企业下的某些员工",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "SealId",
          "type": "string",
          "required": true,
          "description": "电子印章ID，为32位字符串。 建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。 可登录腾讯电子签控制台，在 \"印章\"-\u003e\"印章中心\"选择查看的印章，在\"印章详情\" 中查看某个印章的SealId(在页面中展示为印章ID)。",
          "example": "yDRTZxxxxxJNR"
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": true,
          "description": "员工在腾讯电子签平台的唯一身份标识，为32位字符串。 可登录腾讯电子签控制台，在 \"更多能力\"-\u003e\"组织管理\" 中查看某位员工的UserId(在页面中展示为用户ID)。 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。 指定待授权的用户ID数组,电子签的\ufffd...",
          "example": "[\"yDdzlxxxxxopk\"]",
          "item_type": "string"
        },
        {
          "name": "Options",
          "type": "array",
          "required": false,
          "description": "个性化配置字段，默认不传。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "个性化配置参数Key字段，对应传入字段的字段名",
              "example": "SealOperatorVerify"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "个性化配置参数Value字段，对应传入字段的字段值",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "SealId",
        "UserIds"
      ]
    },
    {
      "name": "ChannelCreateUserAutoSignEnableUrl",
      "description": "获取个人用户自动签的开通链接。 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": true,
          "description": "自动签使用的场景值, 可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
              "example": "n9527"
            }
          ]
        },
        {
          "name": "AutoSignConfig",
          "type": "object",
          "required": false,
          "description": "自动签开通配置信息, 包括开通的人员的信息等",
          "example": "无",
          "children": [
            {
              "name": "UserInfo",
              "type": "object",
              "required": true,
              "description": "自动签开通个人用户信息, 包括名字,身份证等",
              "example": "无",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "小明"
                },
                {
                  "name": "IdCardType",
                  "type": "string",
                  "required": true,
                  "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
                  "example": "ID_CARD"
                },
                {
                  "name": "IdCardNumber",
                  "type": "string",
                  "required": true,
                  "description": "证件号码，应符合以下规则 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "620000198802020000"
                }
              ]
            },
            {
              "name": "CertInfoCallback",
              "type": "boolean",
              "required": false,
              "description": "是否回调证书信息: **false**: 不需要(默认) **true**:需要 注：`该字段已经失效，请勿设置此参数。`",
              "example": "true"
            },
            {
              "name": "UserDefineSeal",
              "type": "boolean",
              "required": false,
              "description": "是否支持用户自定义签名印章: **false**: 不能自己定义(默认) **true**: 可以自己定义",
              "example": "false"
            },
            {
              "name": "SealImgCallback",
              "type": "boolean",
              "required": false,
              "description": "回调中是否需要自动签将要使用的印章（签名）图片的 base64: **false**: 不需要(默认) **true**: 需要",
              "example": "false"
            },
            {
              "name": "VerifyChannels",
              "type": "array",
              "required": false,
              "description": "开通时候的身份验证方式, 取值为： **WEIXINAPP** : 微信人脸识别 **INSIGHT** : 慧眼人脸识别 **TELECOM** : 运营商三要素验证 注： 如果是小程序开通链接，仅支持传 WEIXINAPP。为空默认 WEIXINAPP 如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT",
              "example": "[\"WEIXINAPP\"]",
              "item_type": "string"
            },
            {
              "name": "LicenseType",
              "type": "integer",
              "required": false,
              "description": "设置用户开通自动签时是否绑定个人自动签账号许可。 1: (默认)不绑定自动签账号许可开通，开通后一直有效, 后续使用合同份额进行合同发起 注：`该字段已经失效，请勿设置此参数。`",
              "example": "1"
            },
            {
              "name": "JumpUrl",
              "type": "string",
              "required": false,
              "description": "开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。 注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头` 跳转场景： **贵方H5 -\u003e 腾讯电子签H5 -\u003e 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。 **贵方原生App -\u003e 腾讯电子签H5 -\u003e 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL\ufffd...",
              "example": "https://YOUR_CUSTOM_URL/xxxx"
            }
          ]
        },
        {
          "name": "UrlType",
          "type": "string",
          "required": false,
          "description": "生成的链接类型： 不传(即为空值) 则会生成小程序端开通链接(默认) **H5SIGN** : 生成H5端开通链接",
          "example": "H5SIGN"
        },
        {
          "name": "NotifyType",
          "type": "string",
          "required": false,
          "description": "是否通知开通方，通知类型:默认为不通知开通方**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号",
          "example": "SMS"
        },
        {
          "name": "NotifyAddress",
          "type": "string",
          "required": false,
          "description": "如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项",
          "example": "13200000000"
        },
        {
          "name": "ExpiredTime",
          "type": "integer",
          "required": false,
          "description": "链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`",
          "example": "1693290580"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中，该字段的信息将原封不动地透传给贵方。",
          "example": "MTIzNDU2Nzg5"
        }
      ],
      "required": [
        "Agent",
        "SceneKey"
      ]
    },
    {
      "name": "ChannelCreateUserAutoSignSealUrl",
      "description": "获取设置自动签印章小程序链接。 注意： 需要企业开通自动签后使用。 仅支持已经开通了自动签的个人更换自动签印章。 链接有效期默认7天，最多30天。 该接口的链接适用于小程序端。 该接口不会扣除您的合同套餐，暂不参与计费。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "渠道应用相关信息。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": true,
          "description": "自动签使用的场景值, 可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        },
        {
          "name": "UserInfo",
          "type": "object",
          "required": true,
          "description": "自动签开通个人用户信息，包括名字，身份证等。",
          "example": "无",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "小明"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": true,
              "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": true,
              "description": "证件号码，应符合以下规则 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            }
          ]
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
              "example": "n9527"
            }
          ]
        },
        {
          "name": "ExpiredTime",
          "type": "integer",
          "required": false,
          "description": "链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`",
          "example": "1695783727"
        }
      ],
      "required": [
        "Agent",
        "SceneKey",
        "UserInfo"
      ]
    },
    {
      "name": "ChannelCreateUserRoles",
      "description": "使用此接口，用来绑定企业实名员工的角色， 支持以电子签userId、客户系统openId两种方式进行绑定。 对应控制台的操作如下图 ![image](https://qcloudimg.tencent-cloud.cn/raw/5b41194d3cb3f2058ec0ba0fb5ebc6a6.png)",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "RoleIds",
          "type": "array",
          "required": true,
          "description": "绑定角色的角色id列表，最多 100 个",
          "example": "[ywk9kdki323****k239239]",
          "item_type": "string"
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": false,
          "description": "电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数，最多 100 个",
          "example": "[ywksdkj1001***103kd]",
          "item_type": "string"
        },
        {
          "name": "OpenIds",
          "type": "array",
          "required": false,
          "description": "客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数，最多 100 个",
          "example": "[test_openid]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent",
        "RoleIds"
      ]
    },
    {
      "name": "ChannelCreateWebThemeConfig",
      "description": "用来创建嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），该接口配合其他所有可嵌入页面接口使用 创建配置对当前第三方应用全局生效，如果多次调用，会以最后一次的配置为准",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "ThemeType",
          "type": "string",
          "required": true,
          "description": "主题类型EMBED_WEB_THEME：嵌入式主题 EMBED_WEB_THEME，web页面嵌入的主题风格配置 COMPANY_AUTHENTICATE，子客认证主题配置， 对当前第三方应用号生效， 目前支持的有，背景图替换，隐藏企业认证页面导航栏和隐藏企业认证顶部logo",
          "example": "EMBED_WEB_THEME"
        },
        {
          "name": "WebThemeConfig",
          "type": "object",
          "required": true,
          "description": "主题配置",
          "example": "无",
          "children": [
            {
              "name": "DisplaySignBrandLogo",
              "type": "boolean",
              "required": false,
              "description": "是否显示页面底部电子签logo，取值如下： **true**：页面底部显示电子签logo **false**：页面底部不显示电子签logo（默认）",
              "example": "true"
            },
            {
              "name": "WebEmbedThemeColor",
              "type": "string",
              "required": false,
              "description": "主题颜色： 支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)",
              "example": "#D54941"
            },
            {
              "name": "AuthenticateBackground",
              "type": "string",
              "required": false,
              "description": "企业认证页背景图（base64图片）",
              "example": "5LyB5Lia6K6k6K+B6aG16IOM5pmv5Zu+77yIYmFzZTY05Zu+54mH77yJ"
            },
            {
              "name": "HideAuthenticateNavigationBar",
              "type": "boolean",
              "required": false,
              "description": "隐藏企业认证页面导航栏，取值如下： **true**：隐藏企业认证页面导航栏 **false**：显示企业认证页面导航栏（默认）",
              "example": "true"
            },
            {
              "name": "HideAuthenticateTopLogo",
              "type": "boolean",
              "required": false,
              "description": "隐藏企业认证顶部logo，取值如下： **true**：隐藏企业认证顶部logo **false**：显示企业认证顶部logo（默认）",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "ThemeType",
        "WebThemeConfig"
      ]
    },
    {
      "name": "ChannelDeleteRole",
      "description": "此接口（ChannelDeleteRole）用来删除企业自定义角色。 注：**系统角色不可删除。**",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "RoleIds",
          "type": "array",
          "required": true,
          "description": "角色id，最多20个",
          "example": "[yDxZ1UyKQDSIMfUuO4zjEw2TyqzKEs16]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent",
        "RoleIds"
      ]
    },
    {
      "name": "ChannelDeleteRoleUsers",
      "description": "通过此接口，删除员工绑定的角色，支持以电子签userId、客户系统userId两种方式调用。 对应控制台的操作如下图 ![image](https://qcloudimg.tencent-cloud.cn/raw/5b41194d3cb3f2058ec0ba0fb5ebc6a6.png)",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "代理信息此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "RoleId",
          "type": "string",
          "required": true,
          "description": "角色Id（非超管或法人角色Id）",
          "example": "ywkdkfd****sdkljfks"
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": false,
          "description": "电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数，最多两百",
          "example": "[ywd8k13jkds****39kdf]",
          "item_type": "string"
        },
        {
          "name": "OpenIds",
          "type": "array",
          "required": false,
          "description": "客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数，最多两百",
          "example": "[test_openid1, test_openid2]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent",
        "RoleId"
      ]
    },
    {
      "name": "ChannelDeleteSealPolicies",
      "description": "此接口（ChannelDeleteSealPolicies）用于删除已指定员工印章授权信息，删除员工的印章授权后，该员工使用印章进行盖章时，将需要提交印章授权申请且通过审核后才能使用该印章进行签署。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "SealId",
          "type": "string",
          "required": true,
          "description": "操作的印章ID",
          "example": "yDRSRUUgygj******uO4zjEuBzwyiofZ"
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": true,
          "description": "需要删除授权的用户ID数组，可以传入电子签系统用户ID或OpenId。 注: 1. `填写OpenId时，系统会通过组织+渠道+OpenId查询得到对应的UserId进行授权取消操作`",
          "example": "[yDxbWUyKQDx7OZUuO4zjESvEkRMHc55R]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent",
        "SealId",
        "UserIds"
      ]
    },
    {
      "name": "ChannelDescribeAccountBillDetail",
      "description": "通过此接口（ChannelDescribeAccountBillDetail）查询该第三方平台子客账号绑定中、剩余可绑定账号等套餐使用情况。 对于渠道客户企业的查询，通过指定渠道企业的唯一标识(Agent.ProxyOrganizationId)来查询“子客账号”套餐消耗详情",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业必须已经经过实名认证",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "ChannelDescribeBillUsageDetail",
      "description": "通过此接口（ChannelDescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。可以支持单个子客和整个应用下所有子客的查询。 对于单个子客企业的查询，通过指定子客的唯一标识(Agent.ProxyOrganizationOpenId)来查询该子客消耗详情 对于整个应用下所有企业的查询，不需要指定子客的唯一标识，只需要传入渠道应用标识(Agent.AppId)直接查询整个应用下所有子客企业消耗详情",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业必须已经经过实名认证",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": true,
          "description": "查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天",
          "example": "20231101"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天",
          "example": "20231108"
        },
        {
          "name": "QuotaType",
          "type": "string",
          "required": false,
          "description": "查询的套餐类型 （选填 ）不传则查询所有套餐； 目前支持: **CloudEnterprise**: 企业版合同 **SingleSignature**: 单方签章 **CloudProve**: 签署报告 **CloudOnlineSign**: 腾讯会议在线签约 **ChannelWeCard**: 微工卡 **SignFlow**: 合同套餐 **SignFace**: 签署意愿（人脸识别） **SignPassword**: 签署意愿（密码） **SignSMS**: 签署意愿（短信） **PersonalEssAuth**: 签署人实名（腾讯电子签认证） **PersonalThirdAuth**: 签\ufffd\ufffd...",
          "example": "CloudEnterprise"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。",
          "example": "20"
        }
      ],
      "required": [
        "Agent",
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "ChannelDescribeEmployees",
      "description": "获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息，支持设置过滤条件以筛选员工查询结果。 **注**:通过企业员工新增或离职接口增加的新员工或者离职的员工也会在列表中。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "指定分页每页返回的数据条数，单页最大支持 20。",
          "example": "10"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "查询的关键字段，支持Key-Values查询。可选键值如下： Key:**\"Status\"**，Values: **[\"IsVerified\"]**, 查询已实名的员工 Key:**\"Status\"**，Values: **[\"NotVerified\"]**, 查询未实名的员工 Key:**\"Status\"**，Values: **[\"QuiteJob\"]**, 查询离职员工 Key:**\"ExcludeQuiteJob\"**，Values: **[\"true\"]**, 查询排除离职员工 Key:**\"StaffOpenId\"**，Values: **[\"OpenId1\",\"OpenId2\",...]**, 根据第三方系统用户OpenId查询员工 注: `同名字的Key的过滤条件...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "查询过滤条件的Key",
              "example": "IsReturnPermissionGroup"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "查询过滤条件的Value列表",
              "example": "[\"0\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量:从 0 开始，最大20000。",
          "example": "0"
        }
      ],
      "required": [
        "Agent",
        "Limit"
      ]
    },
    {
      "name": "ChannelDescribeFlowComponents",
      "description": "您可以通过合同流程ID查询相关的填写控件信息及其内容。这包括控件的归属方、控件的填写状态（是否已填写）以及具体的填写内容。 无论是发起方还是签署方填写的控件，均包含在查询结果中。 ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png) ### 2. 哪些控件会出现在结果里边？ **A.不返回的控件类型：** - 动态表格 - 附件控件 - 水印控件 **B.返回的控件类型\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "需要获取填写控件填写内容的合同流程ID",
          "example": "yDSLZUUckpotjxzmUuyfZGu1pDwX4bPk"
        }
      ],
      "required": [
        "Agent",
        "FlowId"
      ]
    },
    {
      "name": "ChannelDescribeOrganizationSeals",
      "description": "此接口查询子企业电子印章。 注： 1. 此操作要求操作者具备印章查询权限（若调用者尚无此权限，请联系超级管理员前往Web控制台【组织管理】-\u003e【角色管理】添加相应权限）。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定分页每页返回的数据条数，单页最大支持 100。默认值为20",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页查询偏移量，默认为0，最大为20000",
          "example": "0"
        },
        {
          "name": "InfoType",
          "type": "integer",
          "required": false,
          "description": "查询授权用户信息类型，取值如下： 0：（默认）不返回授权用户信息 1：返回授权用户的信息",
          "example": "1"
        },
        {
          "name": "SealId",
          "type": "string",
          "required": false,
          "description": "印章id，是否查询特定的印章（没有输入返回所有） 注: `没有输入返回所有记录，最大返回100条。`",
          "example": "yDSxWUUckptu4clgUuLlo0OwJKbYCO48"
        },
        {
          "name": "SealTypes",
          "type": "array",
          "required": false,
          "description": "电子印章类型 , 可选类型如下: **OFFICIAL**: 公章**CONTRACT**: 合同专用章;**FINANCE**: 财务专用章;**PERSONNEL**: 人事专用章**INVOICE**: 发票专用章**LEGAL_PERSON_SEAL**: 法定代表人章;**EMPLOYEE_QUALIFICATION_SEAL**: 员工执业章**OTHER**: 其他类型印章注: `1.为空时查询所有类型的印章。`",
          "example": "INVOICE",
          "item_type": "string"
        },
        {
          "name": "SealStatuses",
          "type": "array",
          "required": false,
          "description": "需查询的印章状态列表。 空，()仅查询启用状态的印章； ALL，查询所有状态的印章； CHECKING，查询待审核的印章； SUCCESS，查询启用状态的印章； FAIL，查询印章审核拒绝的印章； DISABLE，查询已停用的印章； STOPPED，查询已终止的印章； VOID，查询已作废的印章； INVALID，查询已失效的印章。",
          "example": "ALL",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "ChannelDescribeRoles",
      "description": "分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。 系统默认角色说明可参考下表 | 角色名称| 建议授予对象 | 角色描述 | | --- | --- | --- | | **超级管理员** |电子签业务最高权限，可以授权给法务/企业法人/业务负责人等 | 所有功能和数据管理权限，只能设置一位超管。 | | **业务管理员**|IT 系统负责人，可以授权给CTO等 | 企业合同模块\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "string",
          "required": true,
          "description": "指定每页返回的数据条数，和Offset参数配合使用，单页最大200。 注: `因为历史原因, 此字段为字符串类型`",
          "example": "10"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "查询的关键字段: Key:\"**RoleType**\",Values:[\"**1**\"]查询系统角色， Key:\"**RoleType**\",Values:[\"**2**\"]查询自定义角色 Key:\"**RoleStatus**\",Values:[\"**1**\"]查询启用角色 Key:\"**RoleStatus**\",Values:[\"**2**\"]查询禁用角色 Key:\"**IsReturnPermissionGroup**\"，Values:[\"**0**\"]表示接口不返回角色对应的权限树字段 Key:\"**IsReturnPermissionGroup**\"，Values:[\"**1**\"]表示接口返回角色对应的权限树字段 注: `同名字的Key的过滤条件会冲突,...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "查询过滤条件的Key",
              "example": "IsReturnPermissionGroup"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "查询过滤条件的Value列表",
              "example": "[\"0\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。 注： 1.`offset从0开始，即第一页为0。` 2.`默认从第一页返回。`",
          "example": "0"
        }
      ],
      "required": [
        "Agent",
        "Limit"
      ]
    },
    {
      "name": "ChannelDescribeSignFaceVideo",
      "description": "该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。 1. 该接口**仅适用于在H5端签署**的合同，**在通过视频认证后**获取认证的视频内容。 2. 该接口**不支持小程序端**的签署认证的视频获取。 3. 请在**签署完成后的24小时内**获取视频，**过期后将无法获取**。 **注意：该接口需要开通白名单，请联系客户经理开通后使用。**",
      "status": "online",
      "parameters": [
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。建议开发者妥善保存此流程ID，以便于顺利进行后续操作。可登录腾讯电子签控制台，在 \u0026quot;合同\u0026quot;-\u0026gt;\u0026quot;合同中心\u0026quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。",
          "example": "yDCNsUUckpvqwg3kUyIemOrwQm9ltij5"
        },
        {
          "name": "SignId",
          "type": "string",
          "required": true,
          "description": "签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。",
          "example": "yDxjNUUgydjfeklxUuO4zjEBgCqAHMKu"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId第三方平台子客企业标识: Agent.ProxyOrganizationOpenId第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId第三方平台子客企业和员工必须已经经过实名认...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        }
      ],
      "required": [
        "FlowId",
        "SignId",
        "Agent"
      ]
    },
    {
      "name": "ChannelDescribeUserAutoSignStatus",
      "description": "通过此接口获取个人用户自动签的开通状态。 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": true,
          "description": "自动签使用的场景值, 可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        },
        {
          "name": "UserInfo",
          "type": "object",
          "required": true,
          "description": "要查询状态的用户信息, 包括名字,身份证等",
          "example": "无",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "小明"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": true,
              "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": true,
              "description": "证件号码，应符合以下规则 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            }
          ]
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
              "example": "n9527"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "SceneKey",
        "UserInfo"
      ]
    },
    {
      "name": "ChannelDisableUserAutoSign",
      "description": "通过此接口可以关闭个人用户自动签功能。 无需对应的用户刷脸等方式同意即可关闭。 注意: 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。 如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": true,
          "description": "自动签使用的场景值, 可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        },
        {
          "name": "UserInfo",
          "type": "object",
          "required": true,
          "description": "需要关闭自动签的个人的信息，如姓名，证件信息等。",
          "example": "无",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "小明"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": true,
              "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": true,
              "description": "证件号码，应符合以下规则 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            }
          ]
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
              "example": "n9527"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "SceneKey",
        "UserInfo"
      ]
    },
    {
      "name": "ChannelGetTaskResultApi",
      "description": "此接口（ChannelGetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作 前提条件：已调用 创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。 适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源ID。 注： 1. `大文件转换所需的时间可能会比较长。` 2. `本接口\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "转换任务Id，通过接口创建文件转换任务接口得到的转换任务id",
          "example": "20250113111955261408"
        }
      ],
      "required": [
        "Agent",
        "TaskId"
      ]
    },
    {
      "name": "ChannelModifyRole",
      "description": "此接口（ChannelModifyRole）用来更新企业自定义角色。 适用场景1：更新当前企业的自定义角色的名称或描述等其他信息，更新时不进行权限的设置（PermissionGroups 参数不传）。 适用场景2：更新当前企业的自定义角色的权限信息，更新时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/Channel...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "代理企业和员工的信息。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。",
          "example": "资料管理员"
        },
        {
          "name": "RoleId",
          "type": "string",
          "required": true,
          "description": "角色Id，可通过接口 ChannelDescribeRoles 查询获取",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "角色描述，最大长度为50个字符",
          "example": "管理资料的角色"
        },
        {
          "name": "PermissionGroups",
          "type": "array",
          "required": false,
          "description": "权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "GroupName",
              "type": "string",
              "required": false,
              "description": "权限组名称",
              "example": "费用中心"
            },
            {
              "name": "GroupKey",
              "type": "string",
              "required": false,
              "description": "权限组key",
              "example": "bill"
            },
            {
              "name": "Hide",
              "type": "integer",
              "required": false,
              "description": "是否隐藏分组，0否1是",
              "example": "0"
            },
            {
              "name": "Permissions",
              "type": "array",
              "required": false,
              "description": "权限集合",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "权限名称",
                  "example": "费用管理"
                },
                {
                  "name": "Key",
                  "type": "string",
                  "required": false,
                  "description": "权限key",
                  "example": "BillManagement"
                },
                {
                  "name": "Type",
                  "type": "integer",
                  "required": false,
                  "description": "权限类型 1前端，2后端",
                  "example": "1"
                },
                {
                  "name": "Hide",
                  "type": "integer",
                  "required": false,
                  "description": "是否隐藏",
                  "example": "0"
                },
                {
                  "name": "DataLabel",
                  "type": "integer",
                  "required": false,
                  "description": "数据权限标签 1:表示根节点，2:表示叶子结点",
                  "example": "0"
                },
                {
                  "name": "DataType",
                  "type": "integer",
                  "required": false,
                  "description": "数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权",
                  "example": "0"
                },
                {
                  "name": "DataRange",
                  "type": "integer",
                  "required": false,
                  "description": "数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己",
                  "example": "0"
                },
                {
                  "name": "DataTo",
                  "type": "string",
                  "required": false,
                  "description": "关联权限, 表示这个功能权限要受哪个数据权限管控",
                  "example": "FlowsManagement"
                },
                {
                  "name": "ParentKey",
                  "type": "string",
                  "required": false,
                  "description": "父级权限key",
                  "example": "FlowsManagement"
                },
                {
                  "name": "IsChecked",
                  "type": "boolean",
                  "required": false,
                  "description": "是否选中",
                  "example": "false"
                },
                {
                  "name": "Children",
                  "type": "array",
                  "required": false,
                  "description": "子权限集合",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Name",
                      "type": "string",
                      "required": false,
                      "description": "权限名称",
                      "example": "费用管理"
                    },
                    {
                      "name": "Key",
                      "type": "string",
                      "required": false,
                      "description": "权限key",
                      "example": "BillManagement"
                    },
                    {
                      "name": "Type",
                      "type": "integer",
                      "required": false,
                      "description": "权限类型 1前端，2后端",
                      "example": "1"
                    },
                    {
                      "name": "Hide",
                      "type": "integer",
                      "required": false,
                      "description": "是否隐藏",
                      "example": "0"
                    },
                    {
                      "name": "DataLabel",
                      "type": "integer",
                      "required": false,
                      "description": "数据权限标签 1:表示根节点，2:表示叶子结点",
                      "example": "0"
                    },
                    {
                      "name": "DataType",
                      "type": "integer",
                      "required": false,
                      "description": "数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权",
                      "example": "0"
                    },
                    {
                      "name": "DataRange",
                      "type": "integer",
                      "required": false,
                      "description": "数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己",
                      "example": "0"
                    },
                    {
                      "name": "DataTo",
                      "type": "string",
                      "required": false,
                      "description": "关联权限, 表示这个功能权限要受哪个数据权限管控",
                      "example": "FlowsManagement"
                    },
                    {
                      "name": "ParentKey",
                      "type": "string",
                      "required": false,
                      "description": "父级权限key",
                      "example": "FlowsManagement"
                    },
                    {
                      "name": "IsChecked",
                      "type": "boolean",
                      "required": false,
                      "description": "是否选中",
                      "example": "false"
                    },
                    {
                      "name": "Children",
                      "type": "array",
                      "required": false,
                      "description": "子权限集合",
                      "example": "无",
                      "item_type": "string"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "Name",
        "RoleId"
      ]
    },
    {
      "name": "ChannelRenewAutoSignLicense",
      "description": "已经不再使用 给医疗个人自动签许可续期。续期成功后，可对医疗自动签许可追加一年有效期，只可续期一次。 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`",
      "status": "deprecated",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": true,
          "description": "自动签使用的场景值, 可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        },
        {
          "name": "UserInfo",
          "type": "object",
          "required": true,
          "description": "要查询状态的用户信息, 包括名字,身份证等",
          "example": "无",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "小明"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": true,
              "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": true,
              "description": "证件号码，应符合以下规则 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            }
          ]
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
              "example": "n9527"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "SceneKey",
        "UserInfo"
      ]
    },
    {
      "name": "ChannelUpdateSealStatus",
      "description": "此接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Status",
          "type": "string",
          "required": true,
          "description": "印章状态，目前支持传入以下类型： DISABLE-停用印章",
          "example": "DISABLE"
        },
        {
          "name": "SealId",
          "type": "string",
          "required": true,
          "description": "印章ID",
          "example": "yDRTZxxxxxJNR"
        },
        {
          "name": "Reason",
          "type": "string",
          "required": false,
          "description": "更新印章状态原因说明",
          "example": "更新原因-停用印章"
        },
        {
          "name": "Options",
          "type": "array",
          "required": false,
          "description": "个性化配置字段，默认不传。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "个性化配置参数Key字段，对应传入字段的字段名",
              "example": "SealOperatorVerify"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "个性化配置参数Value字段，对应传入字段的字段值",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "Status",
        "SealId"
      ]
    },
    {
      "name": "ChannelVerifyPdf",
      "description": "对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。 **补充**： 可以到控制台[合同验签](https://qian.tencent.com/verifySign)体验验签功能，界面如下 ![image](https://qcloudimg.tencent-cloud.cn/raw/81c333ccb07f0c5fbaf840d9cee61333.png)",
      "status": "online",
      "parameters": [
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。",
          "example": "yDSLWUUckposmpkvUyb9xvpEQeni94od"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        }
      ],
      "required": [
        "FlowId"
      ]
    },
    {
      "name": "CreateBatchInitOrganizationUrl",
      "description": "支持企业进行批量初始化操作： 此接口存在以下限制： 1. 批量操作的企业需要已经完成电子签的认证流程。 2. 通过此接口生成的链接在小程序端进行操作时，操作人需要是所有企业的超管或法人。 3. 批量操作的企业，需要是本方第三方应用下的企业。 4. 操作链接过期时间默认为生成链接后7天。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "应用相关信息。 此接口Agent.AppId 必填。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "OperateTypes",
          "type": "array",
          "required": true,
          "description": "初始化操作类型 CREATE_SEAL : 创建印章 OPEN_AUTO_SIGN :开通企业自动签署 PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权自动签",
          "example": "[OPEN_AUTO_SIGN, AUTH_JOIN_ORGANIZATION_GROUP,  CREATE_SEAL]",
          "item_type": "string"
        },
        {
          "name": "ProxyOrganizationOpenIds",
          "type": "array",
          "required": true,
          "description": "批量操作的企业列表在第三方平台的企业Id列表，即ProxyOrganizationOpenId列表,最大支持50个",
          "example": "[tencent-testorg-cd, tencent-testorg-ca]",
          "item_type": "string"
        },
        {
          "name": "IsAuthorizePlatformApplication",
          "type": "boolean",
          "required": false,
          "description": "当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权自动签时传true。 ![image](https://qcloudimg.tencent-cloud.cn/raw/f9aba7c999a6d79ada20b4384520e120.png)",
          "example": "false"
        },
        {
          "name": "AuthorizedProxyOrganizationOpenId",
          "type": "string",
          "required": false,
          "description": "被授权的合作方企业在第三方平台子客企业标识，即ProxyOrganizationOpenId，当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权自动签时必传。",
          "example": "org_dianziqian"
        }
      ],
      "required": [
        "Agent",
        "OperateTypes",
        "ProxyOrganizationOpenIds"
      ]
    },
    {
      "name": "CreateBatchOrganizationAuthorizationUrl",
      "description": "此接口用于获取企业批量认证链接-单链接包含多条认证流。 前提条件：已调用 [CreateBatchOrganizationRegistrationTasks创建子企业批量认证链接任务接口](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks) 和[查询子企业批量认证链接DescribeBatchOrganizationRegistrationUrls](https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls) 确保认证任务已经完\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "应用相关信息。 此接口Agent.AppId 必填。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "AdminName",
          "type": "string",
          "required": false,
          "description": "组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 AdminName 保持一致。",
          "example": "典子谦"
        },
        {
          "name": "AdminMobile",
          "type": "string",
          "required": false,
          "description": "组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 Admin Mobile保持一致。",
          "example": "13200000000"
        },
        {
          "name": "SubTaskIds",
          "type": "array",
          "required": false,
          "description": "企业批量认证链接的子任务 SubTaskId，该 SubTaskId 是通过接口 查询企业批量认证链接 DescribeBatchOrganizationRegistrationUrls 获得。此参数需与超管个人三要素（AdminName，AdminMobile，AdminIdCardNumber）配合使用。若 SubTaskId 不属于传入的超级管理员，将进行筛选。",
          "example": "[\"yDRS4UUgygqdcj56UuO4zjExBQcOiB68\",\"yDRS4UUgygqdcj5pUuO4zjEu602GFIe6\"]",
          "item_type": "string"
        },
        {
          "name": "AdminIdCardType",
          "type": "string",
          "required": false,
          "description": "组织机构超管证件类型支持以下类型 - ID_CARD : 居民身份证 (默认值) - HONGKONG_AND_MACAO : 港澳居民来往内地通行证 - HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证) 此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。",
          "example": "ID_CARD"
        },
        {
          "name": "AdminIdCardNumber",
          "type": "string",
          "required": false,
          "description": "组织机构超管证件号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardNumber保持一致。",
          "example": "620000198802020000"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "要跳转的链接类型 **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链**APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型**QR_CODE**： 跳转电子签小程序的http_url的二维码形式, 可以在页面展示适合此类型",
          "example": "HTTP"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "CreateBatchOrganizationRegistrationTasks",
      "description": "该接口用于批量创建企业认证链接， 可以支持PC浏览器，H5和小程序三种途径。 此接口为异步提交任务接口，需要与[查询子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationTasks)配合使用，整体流程如下图。 ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png) **注意** 1. 单次最多创建10个子企业。 2. 一天内，同一家企业最\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId",
          "example": "{         \"ProxyOperator\": {             \"OpenId\": \"wangxiaoxiong_20250725001\"         },         \"ProxyOrganizationOpenId\": \"ess_open_organization_20250725001\",         \"AppId\": \"yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2\"     }",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "RegistrationOrganizations",
          "type": "array",
          "required": true,
          "description": "当前应用下子企业的组织机构注册信息。最多支持查询10子企业。",
          "example": "\"无\"",
          "item_type": "object",
          "children": [
            {
              "name": "OrganizationName",
              "type": "string",
              "required": true,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
              "example": "张三示例企业"
            },
            {
              "name": "OrganizationOpenId",
              "type": "string",
              "required": true,
              "description": "机构在贵司业务系统中的唯一标识，用于与腾讯电子签企业账号进行映射，确保在同一应用内不会出现重复。 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。",
              "example": "org_zhangsan"
            },
            {
              "name": "OpenId",
              "type": "string",
              "required": true,
              "description": "员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一应用内不会出现重复。 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。",
              "example": "zhangsan"
            },
            {
              "name": "UniformSocialCreditCode",
              "type": "string",
              "required": true,
              "description": "组织机构企业统一社会信用代码。 请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。",
              "example": "91110108772551611J"
            },
            {
              "name": "LegalName",
              "type": "string",
              "required": true,
              "description": "组织机构法人的姓名。 请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。",
              "example": "张三"
            },
            {
              "name": "Address",
              "type": "string",
              "required": false,
              "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
              "example": "深圳市南山区高新区科技中一路腾讯大厦35层"
            },
            {
              "name": "AdminName",
              "type": "string",
              "required": false,
              "description": "组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。 如果法人作为超管管理组织机构,超管姓名就是法人姓名",
              "example": "张三"
            },
            {
              "name": "AdminMobile",
              "type": "string",
              "required": false,
              "description": "组织机构超管手机号。 在注册流程中，这个手机号必须跟操作人在电子签注册的个人手机号一致。",
              "example": "18888888888"
            },
            {
              "name": "AuthorizationTypes",
              "type": "array",
              "required": false,
              "description": "可选的此企业允许的授权方式, 可以设置的方式有: 1：上传授权书 2：法人授权超管 5：授权书+对公打款 注: `1. 当前仅支持一种认证方式` `2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款` `3. 如果当前操作人是法人,则是法人认证`",
              "example": "[1]",
              "item_type": "integer"
            },
            {
              "name": "AdminIdCardType",
              "type": "string",
              "required": false,
              "description": "经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "AdminIdCardNumber",
              "type": "string",
              "required": false,
              "description": "经办人的证件号",
              "example": "37000019890303000X"
            },
            {
              "name": "BusinessLicense",
              "type": "string",
              "required": false,
              "description": "营业执照正面照(PNG或JPG) base64格式, 大小不超过5M",
              "example": "ykgYmFzZTY05qC85byPLCDlpKflsI/kuI3otoXov4c1TQ=="
            },
            {
              "name": "PowerOfAttorneys",
              "type": "array",
              "required": false,
              "description": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。 p.s. 如果上传授权书 ，需遵循以下条件 1. 超管的信息（超管姓名，超管身份证，超管手机号）必须为必填参数。 2. 超管的个人身份必须在电子签已经实名。 2. 认证方式AuthorizationTypes必须只能是上传授权书方式",
              "example": "[\"5o6I5p2D5LmmKFBOR+aIlkpQR+aIllBERikgYmFzZTY05qC85byP\"]",
              "item_type": "string"
            },
            {
              "name": "AutoJumpUrl",
              "type": "string",
              "required": false,
              "description": "认证完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 [跳转电子签H5](https://qian.tencent.com/developers/company/openqianh5/)",
              "example": "https://jump.cn/jump"
            }
          ]
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "生成链接的类型： **PC**：(默认)web控制台链接, 需要在PC浏览器中打开 **CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 **SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 **APP**：第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后\ufffd\ufffd...",
          "example": "PC"
        },
        {
          "name": "BatchAuthMethod",
          "type": "integer",
          "required": false,
          "description": "认证链接使用单链接还是多链接模式0 - 多链接(默认)，指批量生成链接， 每一个企业会拥有一个认证链接，然后分别认证1 - 单链接 ， 指批量生成链接，然后会将多个链接聚合成一个链接，进行认证p.s.请注意， 如果使用单链接的模式并且认证方式是授权书方式的时候，必须在接口中传递超管授权书。",
          "example": "0"
        }
      ],
      "required": [
        "Agent",
        "RegistrationOrganizations"
      ]
    },
    {
      "name": "CreateChannelFlowEvidenceReport",
      "description": "提交申请出证报告任务并返回报告ID。 出证报告的示例样式可以参考 [出证报告.PDF](https://qcloudimg.tencent-cloud.cn/raw/a55214fcddaebbd1582cc9c57cc6cf1b.pdf) 注意： - 使用此功能**需搭配出证套餐** ，使用前请联系对接的客户经理沟通。 - 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。 - 合同流程必须**所有参与方已经签署完成**。 - 出证过程需一定时间，建议在**\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": " ",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。",
          "example": "yDwFdUUckpsw******yQ0af8bHosXQtb"
        },
        {
          "name": "ReportType",
          "type": "integer",
          "required": false,
          "description": "指定申请的报告类型，可选类型如下： **0** :合同签署报告（默认） **1** :公证处核验报告",
          "example": "0"
        }
      ],
      "required": [
        "Agent",
        "FlowId"
      ]
    },
    {
      "name": "CreateChannelOrganizationInfoChangeUrl",
      "description": "此接口（CreateChannelOrganizationInfoChangeUrl）用于创建子客企业信息变更链接。 支持变更链接类型，通过入参 Endpoint 指定，默认为WEIXINAPP。 WEIXINAPP 创建变更短链。需要在移动端打开，会跳转到微信腾讯电子签小程序进行更换。 APP 创建变更小程序链接，可从第三方App跳转到微信腾讯电子签小程序进行更换。 支持创建企业超管变更链接或企业基础信息变更链接，通过入参 ChangeType \ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "ChangeType",
          "type": "integer",
          "required": true,
          "description": "企业信息变更类型，可选类型如下： **1**：企业超管变更, 可以将超管换成同企业的其他员工 **2**：企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息",
          "example": "1"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "变更链接类型： **WEIXINAPP** : 创建变更短链。需要在移动端打开，会跳转到微信腾讯电子签小程序进行更换。（默认） **APP** : 创建变更小程序链接，可从第三方App或者小程序跳转到微信腾讯电子签小程序进行更换。",
          "example": "APP"
        }
      ],
      "required": [
        "Agent",
        "ChangeType"
      ]
    },
    {
      "name": "CreateChannelSubOrganizationActive",
      "description": "激活或续期子客企业， 在激活状态下，企业可以正常发起合同；在非激活状态下，企业仅能查看和签署合同。 **1. 激活**：使用一个许可证将子客企业从未激活状态转变为激活状态。**激活状态的有效期为一年，一年后将自动回到未激活状态**。 **2. 续期**：使用一个许可证将已激活的子客企业的有效期延长一年。只有处于激活状态的子企业才能进行续期操作（**若处于非激活状...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "SubOrganizationOpenIds",
          "type": "array",
          "required": false,
          "description": "要进行激活或者续期的子客企业OrganizationOpenId列表，请确保所有列出的子客企业均已完成认证。",
          "example": "[org_zhangsan, org_lisi]",
          "item_type": "string"
        },
        {
          "name": "Renew",
          "type": "boolean",
          "required": false,
          "description": "操作类型，可以选择如下： **false**：（默认）激活子客企业 **true**：续期子客企业",
          "example": "true"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "CreateCloseOrganizationUrl",
      "description": "创建企业注销链接 系统将返回操作链接。贵方需要主动联系并通知企业的超级管理员（超管）或法人。由他们点击该链接，完成企业的注销操作。 注意： `在调用此接口以管理企业扩展服务时，操作者（ Agent.ProxyOperator.OpenId）必须是企业的超级管理员（超管）或法人。`",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "CreateConsoleLoginUrl",
      "description": "此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。 Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态，进入不同的流程，主要情况分类如下： 子客企业状态 子客企业员工状态 点击链接进入的流程 企业未激活 \ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 注: `1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业Pro...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "ProxyOrganizationName",
          "type": "string",
          "required": true,
          "description": "第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。 在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。 企业名称请使用以下名称, 以下名称可以不用走收录。 **子客测试专用企业1 - 子客测试专用企业9** 注: `1. 如果名称中包含英文括号()，请使用中文括号（）代替。` `2、该名称\ufffd\ufffd...",
          "example": "典子谦示例企业测试"
        },
        {
          "name": "UniformSocialCreditCode",
          "type": "string",
          "required": false,
          "description": "子客企业统一社会信用代码，最大长度200个字符 注意：`如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效`。",
          "example": "9XXXXXXXXXXXXXXXX1"
        },
        {
          "name": "ProxyOperatorName",
          "type": "string",
          "required": false,
          "description": "子客企业员工的姓名，最大长度50个字符, 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`",
          "example": "典子谦"
        },
        {
          "name": "ProxyOperatorMobile",
          "type": "string",
          "required": false,
          "description": "子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`",
          "example": "18888888888"
        },
        {
          "name": "Module",
          "type": "string",
          "required": false,
          "description": "Web控制台登录后进入的功能模块, 支持的模块包括： **空值** :(默认)企业中心模块 **DOCUMENT** :合同管理模块 **TEMPLATE** :企业模板管理模块 **SEAL** :印章管理模块 **OPERATOR** :组织管理模块 注意： 1、如果EndPoint选择\"CHANNEL\"或\"APP\"，该参数仅支持传递\"SEAL\"，进入印章管理模块 2、该参数**仅在企业和员工激活已经完成，登录控制台场景才生效**。",
          "example": "SEAL"
        },
        {
          "name": "ModuleId",
          "type": "string",
          "required": false,
          "description": "该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持： Module传值 ModuleId传值 进入的目标页面 SEAL 印章ID 查看指定印章的详情页面 TEMPLATE 合同模板ID 指定模板的详情页面 DOCUMENT 合同ID 指定合同的详情页面 注意：该参数**仅在\ufffd...",
          "example": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
        },
        {
          "name": "MenuStatus",
          "type": "string",
          "required": false,
          "description": "是否展示左侧菜单栏 **ENABLE** : (默认)进入web控制台展示左侧菜单栏 **DISABLE** : 进入web控制台不展示左侧菜单栏 注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。",
          "example": "ENABLE"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "生成链接的类型： **PC**：(默认)web控制台链接, 需要在PC浏览器中打开 **CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 **SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 **WEIXIN_QRCODE_URL**：直接跳转至电子签小程序的二维码链接，无需通过中转页。您需要自行将其转\ufffd...",
          "example": "PC"
        },
        {
          "name": "AutoJumpBackEvent",
          "type": "string",
          "required": false,
          "description": "已废弃 请使用 JumpEvents 参数，进行替换。 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括： **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序",
          "example": "VERIFIED"
        },
        {
          "name": "AuthorizationTypes",
          "type": "array",
          "required": false,
          "description": "可选的此企业允许的授权方式, 可以设置的方式有: 2：转法定代表人授权 5：授权书+对公打款",
          "example": "[2, 5]",
          "item_type": "integer"
        },
        {
          "name": "ProxyOperatorIdCardNumber",
          "type": "string",
          "required": false,
          "description": "子客经办人身份证 注意：`如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持中国大陆居民身份证类型`。",
          "example": "620000198802020000"
        },
        {
          "name": "AutoJumpUrl",
          "type": "string",
          "required": false,
          "description": "已废弃 请使用 JumpEvents 参数，进行替换。 认证完成跳转链接。 注意：`此功能仅在Endpoint参数设置成 H5 或 PC时才有效`。",
          "example": "https://qian.tencent.com/"
        },
        {
          "name": "TopNavigationStatus",
          "type": "string",
          "required": false,
          "description": "是否展示头顶导航栏 **ENABLE** : (默认)进入web控制台展示头顶导航栏 **DISABLE** : 进入web控制台不展示头顶导航栏 注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。 点击查看头顶导航栏位置",
          "example": "ENABLE"
        },
        {
          "name": "AutoActive",
          "type": "boolean",
          "required": false,
          "description": "是否自动激活子客企业，有下面两种选项： **false（默认设置）**：不自动激活子客户。您需要通过控制台或调用[激活或者续期子企业](https://qian.tencent.com/developers/partnerApis/accounts/CreateChannelSubOrganizationActive)接口手动完成激活过程。 **true**：若持有的许可证充足，子客户企业注册完成后将自动激活，无需手动操作或访问控制台。 注：如果应用扩展服务中的自动激活子客企业为打\ufffd...",
          "example": "false"
        },
        {
          "name": "BusinessLicense",
          "type": "string",
          "required": false,
          "description": "营业执照正面照（支持PNG或JPG格式）需以base64格式提供，且文件大小不得超过5MB。",
          "example": "aHR0cHM6Ly9jYXBpLndvYS5jb20vhaWwlM0ZpZCUzRGVzc2Jhc2ljJTI2dGFiJTNEYXBp..图片base64省略"
        },
        {
          "name": "ProxyAddress",
          "type": "string",
          "required": false,
          "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
          "example": "深圳市南山区高新区科技中一路腾讯大厦"
        },
        {
          "name": "ProxyLegalName",
          "type": "string",
          "required": false,
          "description": "组织机构法人的姓名。 请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。",
          "example": "典子谦"
        },
        {
          "name": "PowerOfAttorneys",
          "type": "array",
          "required": false,
          "description": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。 p.s. 如果上传授权书 ，需遵循以下条件 1. 超管的信息（超管姓名，超管手机号）必须为必填参数。 2. 认证方式AuthorizationTypes必须只能是上传授权书方式",
          "example": "[\"/9j/4A5IWWEAgABA*********\"]",
          "item_type": "string"
        },
        {
          "name": "OrganizationAuthorizationOptions",
          "type": "object",
          "required": false,
          "description": "企业认证时个性化能力信息",
          "example": "无",
          "children": [
            {
              "name": "UniformSocialCreditCodeSame",
              "type": "boolean",
              "required": false,
              "description": "对方打开链接认证时，对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。true：启用状态，实际认证时必须与接口传递的信息完全相符。",
              "example": "false"
            },
            {
              "name": "OrganizationNameSame",
              "type": "boolean",
              "required": false,
              "description": "对方打开链接认证时，企业名称是否要与接口传递上来的保持一致。false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。true：启用状态，实际认证时必须与接口传递的信息完全相符。p.s. 仅在企业名称不为空时有效",
              "example": "false"
            },
            {
              "name": "LegalNameSame",
              "type": "boolean",
              "required": false,
              "description": "对方打开链接认证时，法人姓名是否要与接口传递上来的保持一致。false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。true：启用状态，实际认证时必须与接口传递的信息完全相符。p.s. 仅在法人姓名不为空时有效",
              "example": "false"
            },
            {
              "name": "BankAccountNumberSame",
              "type": "boolean",
              "required": false,
              "description": "对方打开链接认证时，对公打款账号是否要与接口传递上来的保持一致。false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。true：启用状态，实际认证时必须与接口传递的信息完全相符。p.s. 仅在对公打款账号不为空时有效",
              "example": "false"
            }
          ]
        },
        {
          "name": "BankAccountNumber",
          "type": "string",
          "required": false,
          "description": "组织机构对公打款 账号，账户名跟企业名称一致。 p.s. 只有认证方式是授权书+对公打款时才生效。",
          "example": "6222024060740816912"
        },
        {
          "name": "JumpEvents",
          "type": "array",
          "required": false,
          "description": "跳转事件，其中包括认证期间收录，授权书审核，企业认证的回跳事件。 p.s.Endpoint如果是APP 类型，请传递JumpUrl为\"true\" 如果 Endpoint 是 H5 类型，请参考文档跳转电子签H5 p.s. 如果Endpoint是 APP，传递的跳转地址无效，不会进行跳转，仅会进行回跳。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "JumpEventType",
              "type": "integer",
              "required": false,
              "description": "跳转事件枚举， * 1 - 企业收录。 * 2 - 超管授权书审核。 * 3 - 认证完成。",
              "example": "1"
            },
            {
              "name": "JumpUrl",
              "type": "string",
              "required": false,
              "description": "为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。 Endpoint如果是APP 类型，请传递\"true\" 如果 Endpoint 是 H5 类型，请参考文档[跳转电子签H5](https://qian.tencent.com/developers/partner/openqianh5) p.s. 如果Endpoint是 APP，传递的跳转地址无效，不会进行跳转，仅会进行回跳。",
              "example": "https://qian.tencent.com/"
            }
          ]
        },
        {
          "name": "ProxyOrganizationIdCardType",
          "type": "string",
          "required": false,
          "description": "企业证照类型： **USCC** :(默认)工商组织营业执照 **PRACTICELICENSEOFMEDICALINSTITUTION** :医疗机构执业许可证",
          "example": "USCC"
        }
      ],
      "required": [
        "Agent",
        "ProxyOrganizationName"
      ]
    },
    {
      "name": "CreateEmployeeChangeUrl",
      "description": "生成员工信息变更链接，当前仅支持变更手机号 注: 1. 目前仅支持修改员工手机号，待修改员工必须已经实名且在职 2. 仅支持返回小程序链接",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "OpenId",
          "type": "string",
          "required": false,
          "description": "待修改的员工OpenId",
          "example": "user_open_id"
        },
        {
          "name": "NewMobile",
          "type": "string",
          "required": false,
          "description": "待修改的员工手机号，支持海外格式",
          "example": "+12 12345721"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "CreateEmployeeQualificationSealQrCode",
      "description": "该接口用于获取个人授权执业章给企业的二维码，需要个人用户通过微信扫码。 扫描后将跳转到腾讯电子签小程序，进入到授权执业章的流程。 个人用户授权成功后，企业印章管理员需对印章进行审核，审核通过后，即可使用个人授权的执业章进行盖章操作。 **注意** 1. 该二维码**有效期为7天**，过期后将失效，可重新创建。 整体流程入下图 ![image](https://qcloudimg.tencent-cloud.cn/...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId第三方平台子客企业标识: Agent.ProxyOrganizationOpenId第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId第三方平台子客企业和员工必须已经经过实名认\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "HintText",
          "type": "string",
          "required": false,
          "description": "提示信息，扫码后此信息会展示给扫描用户，用来提示用户授权操作的目的，会在授权界面下面的位置展示。 ![image](https://qcloudimg.tencent-cloud.cn/raw/8436ffd78c20605e6b133ff4bc4d2ac7.png)",
          "example": "请授权注册消防工程师执业印章"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 2000长度。在执业章授权完成后的回调场景，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
          "example": "QmFzZTYOIEJhc2U2NCA="
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "CreateFlowBlockchainEvidenceUrl",
      "description": "获取区块链存证证书查看链接/二维码接口 适用场景：企业员工可以通过此接口生成合同区块链存证证书的查看链接/二维码，以供他人扫码打开腾讯电子签小程序查看。 [点击查看区块链存证证书样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg) 注： 1. 二维码下载链接过期时间为5分钟，请尽快下载保存。二维码/短链的过期时间为7天，超过有效期则不可用。 2. 合...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。建议开发者妥善保存此流程ID，以便于顺利进行后续操作。可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
          "example": "yDCANUUc************SI8fHrn0LCd"
        },
        {
          "name": "ExpiredOn",
          "type": "integer",
          "required": false,
          "description": "链接/二维码的有效截止时间，格式为unix时间戳。最长不超过 2099年12月31日（4102415999）。 默认值为有效期为当前时间后7天。",
          "example": "1719463451"
        }
      ],
      "required": [
        "Agent",
        "FlowId"
      ]
    },
    {
      "name": "CreateFlowForwards",
      "description": "该接口用于将合同中本企业当前经办人转为本企业其他员工进行操作。 注意： 1. 转交的目标经办人需要已经加入企业，且完成实名。 2. 仅企业拥有`超管`或`法人角色`的员工才有调用本接口的权限。 3. 仅支持当前经办人为待签署或待填写状态时进行转交操作。 4. 若原合同有填写控件，且当前经办人已经完成填写，则不支持进行转交。 5. 若当前经办人已签署完成，或者处于签\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "TargetOpenId",
          "type": "string",
          "required": true,
          "description": "合同对应参与方需要修改的目标经办人对应的OpenId。 注意：`需要保证目标经办人已经加入企业且已实名`",
          "example": "test_user_open_id"
        },
        {
          "name": "FlowForwardInfos",
          "type": "array",
          "required": true,
          "description": "企业签署方的合同及对应签署方",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FlowId",
              "type": "string",
              "required": true,
              "description": "合同流程ID，为32位字符串。此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。",
              "example": "yDCVNUUckpw3nnnyUVScgTvSA1IaZgM7"
            },
            {
              "name": "RecipientId",
              "type": "string",
              "required": true,
              "description": "签署方经办人在合同中的参与方ID，为32位字符串。",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId第三方平台子客企业标识: Agent.ProxyOrganizationOpenId第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId第三方平台子客企业和员工必须已经经过实名认...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        }
      ],
      "required": [
        "TargetOpenId",
        "FlowForwardInfos",
        "Agent"
      ]
    },
    {
      "name": "CreateFlowGroupSignReview",
      "description": "1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时，若指定了参数以下参数为true,则可以调用此接口提交企业内部签署审批结果,即使是自动签署也需要进行审核通过才会进行签署。 - [FlowInfo...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": true,
          "description": "合同(流程)组的合同组Id，为32位字符串，通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时返回。",
          "example": "yDSxIUUckpt1ea9hUx5oXYkSgVNJaxOE"
        },
        {
          "name": "ReviewType",
          "type": "string",
          "required": true,
          "description": "提交的审核结果，审核结果有下面三种情况 PASS: 审核通过，合同流程可以继续执行签署等操作 REJECT: 审核拒绝，合同流程不会变动 SIGN_REJECT:拒签，合同流程直接结束，合同状态变为**合同拒签**",
          "example": "PASS"
        },
        {
          "name": "ApproverInfo",
          "type": "object",
          "required": true,
          "description": "需要进行签署审核的签署人的个人信息或企业信息，签署方的匹配方式按照以下规则: 个人：二选一（选择其中任意信息组合即可） 姓名+证件类型+证件号 姓名+手机号 企业：二选一 （选择其中任意信息组合即可） 企业名+姓名+证件类型+证件号 企业名+姓名+手机号",
          "example": "无",
          "children": [
            {
              "name": "ApproverType",
              "type": "string",
              "required": true,
              "description": "签署方经办人的类型，支持以下类型 ORGANIZATION 企业（含企业自动签） PERSON 个人（含个人自动签）",
              "example": "ORGANIZATION "
            },
            {
              "name": "ApproverName",
              "type": "string",
              "required": true,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "张三"
            },
            {
              "name": "ApproverMobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。",
              "example": "18888888888"
            },
            {
              "name": "ApproverIdCardType",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件类型，支持以下类型 ID_CARD 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
              "example": "ID_CARD"
            },
            {
              "name": "ApproverIdCardNumber",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。",
              "example": "张三示例企业"
            }
          ]
        },
        {
          "name": "ReviewMessage",
          "type": "string",
          "required": false,
          "description": "审核不通过的原因，该字段的字符串长度不超过200个字符。 注：`当审核类型（ReviewType）为审核拒绝（REJECT）或拒签（SIGN_REJECT）时，审核结果原因字段必须填写`",
          "example": "这个合同里边的价格写错了"
        }
      ],
      "required": [
        "Agent",
        "FlowGroupId",
        "ReviewType",
        "ApproverInfo"
      ]
    },
    {
      "name": "CreateFlowsByTemplates",
      "description": "接口（CreateFlowsByTemplates）用于使用模板批量创建签署流程。当前可批量发起合同（签署流程）数量为1-20个。 如若在模板中配置了动态表格, 上传的附件必须为A4大小 合同发起人必须在电子签已经进行实名。 ### 一. 整体的逻辑如下 ![image](https://qcloudimg.tencent-cloud.cn/raw/e193519d4383fa74782a9e19147ef01a/CreateFlowsByTemplates.png) ### 二. 可以作为发起方和签署方的角色列表 场景编号 发起方 签署...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业） 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowInfos",
          "type": "array",
          "required": true,
          "description": "要创建的合同信息列表，最多支持一次创建20个合同",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FlowName",
              "type": "string",
              "required": true,
              "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
              "example": "张三的入职合同"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": true,
              "description": "合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。 示例值：1604912664",
              "example": "1698827057"
            },
            {
              "name": "TemplateId",
              "type": "string",
              "required": false,
              "description": "用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 如果使用模板发起接口，此参数为必填。 可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。 [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)",
              "example": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc"
            },
            {
              "name": "FlowApprovers",
              "type": "array",
              "required": false,
              "description": "合同流程的参与方列表，最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver) 注: 在发起流程时，需要保证 FlowApprovers中的顺序与模板定义顺序一致，否则会发起失败。 例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二...",
              "example": "签署人信息",
              "item_type": "object",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "张三"
                },
                {
                  "name": "IdCardType",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "ID_CARD"
                },
                {
                  "name": "IdCardNumber",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "110101192008317114"
                },
                {
                  "name": "Mobile",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)， 不支持海外手机号。 请确认手机号所有方为此合同签署方。",
                  "example": "13888888888"
                },
                {
                  "name": "OrganizationName",
                  "type": "string",
                  "required": false,
                  "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
                  "example": "典子谦示例企业"
                },
                {
                  "name": "NotChannelOrganization",
                  "type": "boolean",
                  "required": false,
                  "description": "指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工",
                  "example": "false"
                },
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成 当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程 注： 如果传进来的OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）",
                  "example": "userdianziqian"
                },
                {
                  "name": "OrganizationOpenId",
                  "type": "string",
                  "required": false,
                  "description": "同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符",
                  "example": "orgtencent"
                },
                {
                  "name": "ApproverType",
                  "type": "string",
                  "required": false,
                  "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **PERSON** :个人/自然人 **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景 **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签） **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签） 注: `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功...",
                  "example": "PERSON"
                },
                {
                  "name": "RecipientId",
                  "type": "string",
                  "required": false,
                  "description": "签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；",
                  "example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
                },
                {
                  "name": "Deadline",
                  "type": "integer",
                  "required": false,
                  "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
                  "example": "1689688460"
                },
                {
                  "name": "SignComponents",
                  "type": "array",
                  "required": false,
                  "description": "使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID:注意：(如果模板里面指定了印章，默认使用模板里面配置的印章，不能进行变更) 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ComponentLimitType",
                  "type": "array",
                  "required": false,
                  "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
                  "example": "[\"OCR_ESIGN\"]",
                  "item_type": "string"
                },
                {
                  "name": "PreReadTime",
                  "type": "integer",
                  "required": false,
                  "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
                  "example": "3"
                },
                {
                  "name": "JumpUrl",
                  "type": "string",
                  "required": false,
                  "description": "签署完前端跳转的url，此字段的用法场景请联系客户经理确认",
                  "example": "https://www.qq.com/success"
                },
                {
                  "name": "ApproverOption",
                  "type": "object",
                  "required": false,
                  "description": "可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。 详细操作可以参考开发者中心的ApproverOption结构体。",
                  "example": "无",
                  "children": [
                    {
                      "name": "NoRefuse",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以拒签 默认false-可以拒签 true-不可以拒签",
                      "example": "true"
                    },
                    {
                      "name": "NoTransfer",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以转发 默认false-可以转发 true-不可以转发",
                      "example": "true"
                    },
                    {
                      "name": "HideOneKeySign",
                      "type": "boolean",
                      "required": false,
                      "description": "当签署方有多个签署区时候，是否隐藏一键所有的签署区false：（默认）不隐藏true：隐藏，每个签署区要单独选择印章或者签名",
                      "example": "true"
                    },
                    {
                      "name": "FillType",
                      "type": "integer",
                      "required": false,
                      "description": "签署人信息补充类型，默认无需补充。 1 : 动态签署人（可发起合同后再补充签署人信息）注：企业自动签不支持动态补充注：使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关枚举值：1： 动态签署人",
                      "example": "1"
                    },
                    {
                      "name": "FlowReadLimit",
                      "type": "string",
                      "required": false,
                      "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                      "example": "LimitBottom"
                    },
                    {
                      "name": "ForbidAddSignDate",
                      "type": "boolean",
                      "required": false,
                      "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ApproverNeedSignReview",
                  "type": "boolean",
                  "required": false,
                  "description": "此签署人（员工或者个人）签署前，是否需要发起方企业进行审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待发起方企业内部审批完成。 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 \ufffd...",
                  "example": "false"
                },
                {
                  "name": "ApproverVerifyTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式 此字段可传\ufffd\ufffd...",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "ApproverSignTypes",
                  "type": "array",
                  "required": false,
                  "description": "签署人签署合同时的认证方式 **1** :人脸认证 **2** :签署密码 **3** :运营商三要素（如果是港澳台客户，建议不要选择这个） **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式） **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式） 默...",
                  "example": "[1,2,3]",
                  "item_type": "integer"
                },
                {
                  "name": "SignId",
                  "type": "string",
                  "required": false,
                  "description": "签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息",
                  "example": "06f2bc0f1772d8deac2f92b5df61a5ac"
                },
                {
                  "name": "NotifyType",
                  "type": "string",
                  "required": false,
                  "description": "通知签署方经办人的方式, 有以下途径: **SMS** :(默认)短信 **NONE** : 不通知 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`",
                  "example": "SMS"
                },
                {
                  "name": "AddSignComponentsLimits",
                  "type": "array",
                  "required": false,
                  "description": "[通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递Compon...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "description": "控件类型，支持以下类型 SIGN_SEAL : 印章控件 SIGN_PAGING_SEAL : 骑缝章控件 SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件 SIGN_SIGNATURE : 用户签名控件",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "array",
                      "required": false,
                      "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人\ufffd...",
                      "example": "[\"HANDWRITE\", \"ESIGN\"]",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "ApproverRoleName",
                  "type": "string",
                  "required": false,
                  "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
                  "example": "乙方"
                },
                {
                  "name": "SignTypeSelector",
                  "type": "integer",
                  "required": false,
                  "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
                  "example": "0"
                },
                {
                  "name": "Components",
                  "type": "array",
                  "required": false,
                  "description": "签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 数据表格等填写控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件) 注：`此参数仅在通过文件发起合同或者合同组时生效` ![image](http...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "Intention",
                  "type": "object",
                  "required": false,
                  "description": "只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。 2. 使用视频认证时，生成H5签署链接的时候必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。 3. 签\ufffd\ufffd...",
                  "example": "无",
                  "children": [
                    {
                      "name": "IntentionType",
                      "type": "integer",
                      "required": false,
                      "description": "视频认证类型，支持以下类型 1 : 问答模式 2 : 点头模式 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`",
                      "example": "1"
                    },
                    {
                      "name": "IntentionQuestions",
                      "type": "array",
                      "required": false,
                      "description": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。 注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "IntentionActions",
                      "type": "array",
                      "required": false,
                      "description": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。 注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "RuleIdConfig",
                      "type": "object",
                      "required": false,
                      "description": "视频核身相关配置",
                      "example": "无"
                    }
                  ]
                },
                {
                  "name": "SignEndpoints",
                  "type": "array",
                  "required": false,
                  "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
                  "example": "[\"link\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "FormFields",
              "type": "array",
              "required": false,
              "description": "发起方角色的填写控件的填充内容。 注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通，否则模板编辑时无法将填写控件分配给发起方)。 ![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)",
              "example": "表单K-V对列表",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": true,
                  "description": "控件填充值，ComponentType和传入值格式对应关系如下： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） DI...",
                  "example": "Name"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 点击此处查看模板上控件ID的获取方式",
                  "example": "391963b9d3cb2de35dedc6eb0a60e535"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "控件的名字，跟ComponentId二选一，不能全为空 点击此处查看模板上控件名字的获取方式",
                  "example": "住房地址"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定",
                  "example": "false"
                }
              ]
            },
            {
              "name": "FlowType",
              "type": "string",
              "required": false,
              "description": "合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。",
              "example": "入职合同"
            },
            {
              "name": "FlowDescription",
              "type": "string",
              "required": false,
              "description": "合同流程描述信息(可自定义此描述)，最大长度1000个字符。",
              "example": "张三2023年的入职公司财务部的合同"
            },
            {
              "name": "CustomerData",
              "type": "string",
              "required": false,
              "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
              "example": "QmFzZTY05YaF5a65"
            },
            {
              "name": "CustomShowMap",
              "type": "string",
              "required": false,
              "description": "您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。 例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{\ufffd...",
              "example": "合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬！;净重: 100吨;品类: 铁矿石"
            },
            {
              "name": "CcInfos",
              "type": "array",
              "required": false,
              "description": "合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。 注 1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。 2. 请确保抄送人列表中的成员不与任何签署人重复。",
              "example": " ",
              "item_type": "object",
              "children": [
                {
                  "name": "Mobile",
                  "type": "string",
                  "required": false,
                  "description": "被抄送方手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此业务通知方。",
                  "example": "13200000000"
                },
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "被抄送方姓名。 抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。",
                  "example": "典子谦"
                },
                {
                  "name": "CcType",
                  "type": "integer",
                  "required": false,
                  "description": "被抄送方类型, 可设置以下类型: **0** :个人抄送方 **1** :企业员工抄送方",
                  "example": "1"
                },
                {
                  "name": "CcPermission",
                  "type": "integer",
                  "required": false,
                  "description": "被抄送方权限, 可设置如下权限: **0** :可查看合同内容 **1** :可查看合同内容也可下载原文",
                  "example": "1"
                }
              ]
            },
            {
              "name": "NeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业\ufffd\ufffd...",
              "example": "true"
            },
            {
              "name": "CcNotifyType",
              "type": "integer",
              "required": false,
              "description": "若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型： **0** :合同发起时通知通知对方来查看合同（默认） **1** : 签署完成后通知对方来查看合同",
              "example": "0"
            },
            {
              "name": "AutoSignScene",
              "type": "string",
              "required": false,
              "description": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） **OTHER** : 通用场景 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`",
              "example": "E_PRESCRIPTION_AUTO_SIGN"
            },
            {
              "name": "FlowDisplayType",
              "type": "integer",
              "required": false,
              "description": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)",
              "example": "1"
            }
          ]
        },
        {
          "name": "NeedPreview",
          "type": "boolean",
          "required": false,
          "description": "是否为预览模式，取值如下： **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。 **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 以预览模式创建的合同仅供查看，因此参与方无法进行签署操作 注: `如果预览的文件中指定了动态表格控件，此时此接口...",
          "example": "false"
        },
        {
          "name": "PreviewType",
          "type": "integer",
          "required": false,
          "description": "预览模式下产生的预览链接类型 **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 **1** :H5链接 ,点开后在浏览器中展示合同的样子 注: `此参数在NeedPreview 为true时有效`",
          "example": "0"
        }
      ],
      "required": [
        "Agent",
        "FlowInfos"
      ]
    },
    {
      "name": "CreateLegalSealQrCode",
      "description": "该接口用于获取创建法人章的二维码，需要通过微信扫描。扫描后将跳转到腾讯电子签署，进入到创建法人章的流程。 **注意** 1. 该二维码**有效期为7天**，过期后将失效，可重新创建 。 2. 每个公司**只能有1个法人章**，无法重复创建或者创建多个 法人章的样式可以参考下图索引（也可以自己上传法人印章图片）： ![image](https://qcloudimg.tencent-cloud.cn/raw/36a0a090750c45bb5cac5047ac461b2c....",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 注: `1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业Pro...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "CreateModifyAdminAuthorizationUrl",
      "description": "本接口（CreateModifyAdminAuthorizationUrl）用于重新上传超管授权书。 注意: 1. 重新上传超管授权书，必须是审核失败的情况下才能重新上传,可以通过回调[!授权书失效回调](https://qian.tencent.com/developers/partner/callback_types_staffs#%E5%9B%9B-%E6%8E%88%E6%9D%83%E4%B9%A6%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)得到",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "AuthorizationId",
          "type": "string",
          "required": false,
          "description": "企业认证流Id，可以通过回调[授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AD-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)得到",
          "example": "\"yDRS4UUgygqdcj5pUuO4zjEu602GFIe6\""
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "要跳转的链接类型 **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链**APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型**PC**： 跳转电子签web 端控制台的链接。",
          "example": "HTTP"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "CreateOrganizationAuthFile",
      "description": "生成合成后的各类企业授权书，包括： - 企业认证超管授权书 - 超管变更授权书 - 企业注销授权书 注: 需自行保证传入真实的企业/法人/超管信息，否则后续的审核将会拒绝。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "OrganizationCommonInfo",
          "type": "object",
          "required": false,
          "description": "企业授权书信息参数， 需要自行保证这些参数跟营业执照中的信息一致。",
          "example": "无",
          "children": [
            {
              "name": "OrganizationName",
              "type": "string",
              "required": true,
              "description": "组织机构名称。请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。",
              "example": "张三示例企业"
            },
            {
              "name": "UniformSocialCreditCode",
              "type": "string",
              "required": true,
              "description": "组织机构企业统一社会信用代码。请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。",
              "example": "37000019890303000X"
            },
            {
              "name": "LegalName",
              "type": "string",
              "required": true,
              "description": "组织机构法人的姓名。请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。",
              "example": "张三"
            },
            {
              "name": "LegalIdCardType",
              "type": "string",
              "required": false,
              "description": "组织机构法人的证件类型枚举值：居民身份证： 中国大陆居民身份证",
              "example": "居民身份证"
            },
            {
              "name": "LegalIdCardNumber",
              "type": "string",
              "required": false,
              "description": "组织机构法人的证件号码",
              "example": "37000019890303000X"
            },
            {
              "name": "AdminName",
              "type": "string",
              "required": false,
              "description": "组织机构超管姓名。",
              "example": "张三"
            },
            {
              "name": "AdminMobile",
              "type": "string",
              "required": false,
              "description": "组织机构超管手机号。",
              "example": "18888888888"
            },
            {
              "name": "AdminIdCardType",
              "type": "string",
              "required": false,
              "description": "组织机构超管证件类型枚举值：居民身份证： 中国大陆居民身份证",
              "example": "居民身份证"
            },
            {
              "name": "AdminIdCardNumber",
              "type": "string",
              "required": false,
              "description": "组织机构超管证件号码",
              "example": "37000019890303000X"
            },
            {
              "name": "OldAdminName",
              "type": "string",
              "required": false,
              "description": "原超管姓名",
              "example": "李四"
            },
            {
              "name": "OldAdminMobile",
              "type": "string",
              "required": false,
              "description": "原超管手机号",
              "example": "15100000000"
            },
            {
              "name": "OldAdminIdCardType",
              "type": "string",
              "required": false,
              "description": "原超管证件类型枚举值：居民身份证： 中国大陆居民身份证",
              "example": "居民身份证"
            },
            {
              "name": "OldAdminIdCardNumber",
              "type": "string",
              "required": false,
              "description": "原超管证件号码",
              "example": "65000019870404000X"
            }
          ]
        },
        {
          "name": "Type",
          "type": "integer",
          "required": false,
          "description": "授权书类型： 0: 企业认证超管授权书1: 超管变更授权书2: 企业注销授权书",
          "example": "1"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "CreatePartnerAutoSignAuthUrl",
      "description": "创建一个用于他方自动签授权的链接（可选择他方授权或我方授权）。通过这个链接，合作方企业可以直接进入小程序，进行自动签授权操作。 如果授权企业尚未开通企业自动签功能，该链接还将引导他们首先开通本企业的自动签服务 注: 1. 所在企业的超管、法人才有权限调用此接口(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId) 2. 已经在授权中或者授权成功的企业，无\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "PlatformAppAuthorization",
          "type": "boolean",
          "required": false,
          "description": "是否给平台应用授权 true: 表示是，授权平台应用。在此情况下，无需设置AuthorizedOrganizationIds和AuthorizedOrganizationNames。 false: （默认）表示否，不是授权平台应用。 注：授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单，请联系运营经理开通。",
          "example": "false"
        },
        {
          "name": "SealTypes",
          "type": "array",
          "required": false,
          "description": "在设置印章授权时，可以指定特定的印章类型，以确保在授权过程中只使用相应类型的印章。支持的印章类型包括： OFFICIAL：企业公章，用于代表企业对外的正式文件和重要事务的认证。 CONTRACT：合同专用章，专门用于签署各类合同。 FINANCE：财务专用章，用于企业的财务相关文件，如发票、收据等财务凭证的认证。 PERSONNEL：人事专用章，用于人事管理相关文件，如劳动合同\ufffd\ufffd...",
          "example": "[\"OFFICIAL\", \"FINANCE\"]",
          "item_type": "string"
        },
        {
          "name": "AuthToMe",
          "type": "boolean",
          "required": false,
          "description": "在处理授权关系时，授权的方向 false（默认值）：表示我方授权他方。在这种情况下，AuthorizedOrganizationNames 代表的是【被授权方】的企业名称，即接收授权的企业。 true：表示他方授权我方。在这种情况下，AuthorizedOrganizationNames 代表的是【授权方】的企业名称，即提供授权的企业。此场景下不支持批量",
          "example": "false"
        },
        {
          "name": "AuthorizedOrganizationIds",
          "type": "array",
          "required": false,
          "description": "被授企业id/授权方企业id（即OrganizationId），如果是企业之间授权和AuthorizedOrganizationNames二选一传入，最大支持50个，注：`被授权企业必须和当前企业在同一应用号下`",
          "example": "[\"yDwFdUUckxxxxxxxxxxxxxXbsvN43W6Kax\"]",
          "item_type": "string"
        },
        {
          "name": "AuthorizedOrganizationNames",
          "type": "array",
          "required": false,
          "description": "被授企业名称/授权方企业的名字，如果是企业之间授权和AuthorizedOrganizationIds二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。注: 1. 如果名称中包含英文括号()，请使用中文括号（）代替。2. 被授权企业必须和当前企业在同一应用号下 3. 数组最大长度50",
          "example": "[\"王五示例企业\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "CreatePersonAuthCertificateImage",
      "description": "获取个人用户认证证书图片下载URL 个人用户认证证书图片样式如下图 ![image](https://qcloudimg.tencent-cloud.cn/raw/d568bc0f101bef582f7af2cb5ab7a715.png) 注: 只能获取个人用户证明图片, 企业员工的暂不支持 专为电子处方单（医疗自动签）特定场景使用。在使用前，请务必与您的客户经理联系以确认已经开通电子处方单功能",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "UserName",
          "type": "string",
          "required": true,
          "description": "个人用户名称",
          "example": "典子谦"
        },
        {
          "name": "IdCardType",
          "type": "string",
          "required": true,
          "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
          "example": "ID_CARD"
        },
        {
          "name": "IdCardNumber",
          "type": "string",
          "required": true,
          "description": "证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
          "example": "620000198802020000"
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": false,
          "description": "自动签使用的场景值, 可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        }
      ],
      "required": [
        "Agent",
        "UserName",
        "IdCardType",
        "IdCardNumber"
      ]
    },
    {
      "name": "CreateSealByImage",
      "description": "1. 可以**通过图片**为子客企业代创建印章，图片最大5MB 2. 可以使用**系统生成印章**为子客企业代创建印章, 系统创建的印章样子下图(样式可以调整) ![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage.png)",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "SealName",
          "type": "string",
          "required": true,
          "description": "电子印章名字，1-50个中文字符 注:`同一企业下电子印章名字不能相同`",
          "example": "合同专用章"
        },
        {
          "name": "SealImage",
          "type": "string",
          "required": false,
          "description": "电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式 注: `通过图片创建的电子印章，需电子签平台人工审核`",
          "example": "iVBORw0KGgoAAAANSUhEUgAAAGwAAABuCAYAAADCrvbGAAABW2lDZXE15yz3uZ6TErkJggg....(图片base64省略)"
        },
        {
          "name": "GenerateSource",
          "type": "string",
          "required": false,
          "description": "电子印章生成方式 空值:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片 SealGenerateSourceSystem: 系统生成印章, 无需上传SealImage图片",
          "example": "SealGenerateSourceSystem"
        },
        {
          "name": "SealType",
          "type": "string",
          "required": false,
          "description": "电子印章类型 , 可选类型如下: **OFFICIAL**: (默认)公章**CONTRACT**: 合同专用章;**FINANCE**: 财务专用章;**PERSONNEL**: 人事专用章**INVOICE**: 发票专用章**OTHER**: 其他注: 同企业下只能有一个公章, 重复创建会报错",
          "example": "OFFICIAL"
        },
        {
          "name": "SealHorizontalText",
          "type": "string",
          "required": false,
          "description": "企业印章横向文字，最多可填15个汉字 (若超过印章最大宽度，优先压缩字间距，其次缩小字号) 横向文字的位置如下图中的\"印章横向文字在这里\" ![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage2.png)",
          "example": "横向文字"
        },
        {
          "name": "SealStyle",
          "type": "string",
          "required": false,
          "description": "印章样式, 可以选择的样式如下: **circle**:(默认)圆形印章 **ellipse**:椭圆印章",
          "example": "cycle"
        },
        {
          "name": "SealSize",
          "type": "string",
          "required": false,
          "description": "印章尺寸取值描述, 可以选择的尺寸如下: **38_38**: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效 **40_40**: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效 **42_42**（默认）: 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效 **45_45**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效 **50_50**: 圆形企业印章直径50mm, 当SealStyle是圆形的时候才有效 **58_58**: 圆形企业印\ufffd\ufffd...",
          "example": "42_42"
        },
        {
          "name": "TaxIdentifyCode",
          "type": "string",
          "required": false,
          "description": "企业税号 注: 1.印章类型SealType是INVOICE类型时，此参数才会生效 2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号（如果是通过授权书授权方式认证的企业，此参数必传不能为空）",
          "example": "91278105MA09226546"
        },
        {
          "name": "SealDescription",
          "type": "string",
          "required": false,
          "description": "印章描述内容",
          "example": "印章描述说明"
        },
        {
          "name": "Options",
          "type": "array",
          "required": false,
          "description": "个性化配置字段，默认不传。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "个性化配置参数Key字段，对应传入字段的字段名",
              "example": "SealOperatorVerify"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "个性化配置参数Value字段，对应传入字段的字段值",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "SealName"
      ]
    },
    {
      "name": "CreateSignUrls",
      "description": "创建跳转小程序查看或签署的链接 **腾讯电子签小程序的AppID 和 原始Id如下:** | 小程序 | AppID | 原始ID | | ------------ | ------------ | ------------ | | 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa | **主要使用场景EndPoint分类** |EndPoint| 场景| 说明和示例| | ---- | ---- | --- | | WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "合同流程ID数组，最多支持100个。 注: 1. 必须选择提供此参数或合同组编号中的一个。 2. 当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。",
          "example": "[\"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\"]",
          "item_type": "string"
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": false,
          "description": "合同组编号 注：`该参数和合同流程ID数组必须二选一`",
          "example": "yDCVAUUckpwa592pUxoLjOlRVS9Zgusf"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "签署链接类型,可以设置的参数如下 **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回短链 **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(GenerateType非ALL时候不能设置成CHANNEL) **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型 **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链 **注...",
          "example": "”WEIXINAPP“"
        },
        {
          "name": "GenerateType",
          "type": "string",
          "required": false,
          "description": "签署链接生成类型，可以选择的类型如下 ALL：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：此中类型不支持多个合同ID（FlowIds）。 CHANNEL：适用于第三方子企业的员工签署方。 NOT_CHANNEL：适用于SaaS平台企业的员工签署方。 PERSON：适用于个人或自然人签署方。 FOLLOWER：适用于关注方，目前指合同的抄送方。 RECIPIENT：根据RecipientId生成对...",
          "example": "CHANNEL"
        },
        {
          "name": "OrganizationName",
          "type": "string",
          "required": false,
          "description": "SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。 注: `1.GenerateType为\"NOT_CHANNEL\"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`",
          "example": "典子谦示例企业"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "合同流程里边参与方的姓名。 注: 1. `GenerateType为\"PERSON\"(即个人签署方)时必填`。 2. `在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`",
          "example": "典子谦"
        },
        {
          "name": "Mobile",
          "type": "string",
          "required": false,
          "description": "合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 注: 1. `GenerateType为\"PERSON\"或\"FOLLOWER\"时必填。` 2. `在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`",
          "example": "13200000000"
        },
        {
          "name": "IdCardType",
          "type": "string",
          "required": false,
          "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件\ufffd\ufffd...",
          "example": "ID_CARD"
        },
        {
          "name": "IdCardNumber",
          "type": "string",
          "required": false,
          "description": "证件号码，应符合以下规则 居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。 `注：在动态签署人补充链接场景中，可以通过传入此值\ufffd\ufffd...",
          "example": "620000198802020000"
        },
        {
          "name": "OrganizationOpenId",
          "type": "string",
          "required": false,
          "description": "第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: `1.GenerateType为\"CHANNEL\"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`",
          "example": "org_dianziqian"
        },
        {
          "name": "OpenId",
          "type": "string",
          "required": false,
          "description": "第三方平台子客企业员工的标识OpenId，GenerateType为\"CHANNEL\"时可用，指定到具体参与人, 仅展示已经实名的经办人信息 注： 如果传进来的OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）",
          "example": "n9527"
        },
        {
          "name": "AutoJumpBack",
          "type": "boolean",
          "required": false,
          "description": "签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认)true：是, 签署完成会自动跳转回来 注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景 的签署链接有效 2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方...",
          "example": "false"
        },
        {
          "name": "JumpUrl",
          "type": "string",
          "required": false,
          "description": "签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。",
          "example": "https://qq.com"
        },
        {
          "name": "Hides",
          "type": "array",
          "required": false,
          "description": "生成的签署链接在签署页面隐藏的按钮列表，可设置如下： **0** :合同签署页面更多操作按钮 **1** :合同签署页面更多操作的拒绝签署按钮 **2** :合同签署页面更多操作的转他人处理按钮 **3** :签署成功页的查看详情按钮 **4** :合同签署页面更多操作的查看合同基本信息按钮 **5** :合同签署页面更多操作的撤销按钮 注: `字段为数组, 可以传值隐藏多个按钮`",
          "example": "[0, 1, 2]",
          "item_type": "integer"
        },
        {
          "name": "RecipientIds",
          "type": "array",
          "required": false,
          "description": "参与方角色ID，用于生成动态签署人链接完成领取。 注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，",
          "example": "[\"yDCVAUUckpwa59riUxoLjOluu9cf6B3s\"]",
          "item_type": "string"
        },
        {
          "name": "FlowGroupUrlInfo",
          "type": "object",
          "required": false,
          "description": "合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。",
          "example": "无",
          "children": [
            {
              "name": "FlowGroupApproverInfos",
              "type": "array",
              "required": false,
              "description": "合同组子合同和签署方的信息，用于补充动态签署人。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "FlowId",
                  "type": "string",
                  "required": false,
                  "description": "合同流程ID。",
                  "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
                },
                {
                  "name": "RecipientId",
                  "type": "string",
                  "required": false,
                  "description": "签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`",
                  "example": "yDt1JUUckp77a2tqUyEmko8RVpCEHoNA"
                }
              ]
            }
          ]
        },
        {
          "name": "UrlUseEnv",
          "type": "string",
          "required": false,
          "description": "仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%...",
          "example": "WeChatOfficialAccounts"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "DeleteOrganizationAuthorizations",
      "description": "批量清理未认证的企业认证流程。 此接口用来清除企业方认证信息填写错误，批量清理认证中的认证流信息。 为接口[提交子企业批量认证链接创建任务](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks) 和[查询子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls) 接口的扩展接口。即在批量认证过程中，当\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "AuthorizationIds",
          "type": "array",
          "required": false,
          "description": "认证流Ids数组 认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。",
          "example": "[\"yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY\"]\t",
          "item_type": "string"
        },
        {
          "name": "AdminName",
          "type": "string",
          "required": false,
          "description": "认证人姓名，组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。",
          "example": "张三"
        },
        {
          "name": "AdminMobile",
          "type": "string",
          "required": false,
          "description": "认证人手机号，组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。",
          "example": "18888888888"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "DescribeBatchOrganizationRegistrationTasks",
      "description": "本接口（DescribeBatchOrganizationRegistrationTasks）用于查询企业批量认证任务状态。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "TaskIds",
          "type": "array",
          "required": false,
          "description": "企业批量认证链接的子任务 SubTaskId，该 SubTaskId 是通过接口[查询企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls)可以得到。",
          "example": "[\"yDRS4UUgygqdcj56UuO4zjExBQcOiB68\",\"yDRS4UUgygqdcj5pUuO4zjEu602GFIe6\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "DescribeBatchOrganizationRegistrationUrls",
      "description": "此接口用于获取企业批量认证异步任务的状态及结果。需要先调用接口提交子企业批量认证链接创建任务获取到任务ID，然后再调用此接口获取到各个子企业的注册认证链接。整体流程如下图。 ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png) 注： `异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "通过接口提交子企业批量认证链接创建任务调用得到的任务ID。",
          "example": "yDSxSUUxxxxxxxx21JXBlJZsaj"
        }
      ],
      "required": [
        "Agent",
        "TaskId"
      ]
    },
    {
      "name": "DescribeCancelFlowsTask",
      "description": "通过接口[批量撤销合同流程](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows)或者[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl)发起批量撤销任务后，可通过此接口查询批量撤销任务的结果。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "批量撤销任务编号，为32位字符串，通过接口[批量撤销合同流程](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows)或者[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl)获得。",
          "example": "yDCVWUUckpwkjgiuUWGW8cRAzd84BVQa"
        }
      ],
      "required": [
        "Agent",
        "TaskId"
      ]
    },
    {
      "name": "DescribeChannelFlowEvidenceReport",
      "description": "获取出证报告任务执行结果，返回报告 URL。 注意： - 使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。 - 需调用创建并返回出证报告接口提交申请出证报告任务获取报告编号后调用当前接口获取报告链接。 ![image](https://qcloudimg.tencent-cloud.cn/raw/1b4307ed143a992940c41d61192d3a0f/channel_CreateChannelFlowEvidenceReport.png)",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "ReportId",
          "type": "string",
          "required": true,
          "description": "签署报告编号, 由提交申请出证报告任务产生",
          "example": "yDSLVUUckpo3nva8UEnf33kvzHQ19GcL"
        },
        {
          "name": "ReportType",
          "type": "integer",
          "required": false,
          "description": "指定申请的报告类型，可选类型如下： **0** :合同签署报告（默认） **1** :公证处核验报告",
          "example": "0"
        }
      ],
      "required": [
        "Agent",
        "ReportId"
      ]
    },
    {
      "name": "DescribeChannelOrganizations",
      "description": "查询渠道子客企业信息时，可以支持单个子客和整个应用下所有子客的查询。返回的信息包括超管、法人的信息以及当前企业的认证状态等信息。 - 对于单个企业的查询，通过**指定子客的唯一标识**来查询该子客的企业信息 - 对于整个应用下所有企业的查询，**不需要指定子客的唯一标识**，直接查询整个应用下所有子客企业的企业信息",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "指定分页每页返回的数据条数，单页最大支持 200。",
          "example": "100"
        },
        {
          "name": "OrganizationOpenId",
          "type": "string",
          "required": false,
          "description": "该字段是指第三方平台子客企业的唯一标识，用于查询单独某个子客的企业数据。 **注**：`如果需要批量查询本应用下的所有企业的信息，则该字段不需要赋值`",
          "example": "OrganizationOpenId_1"
        },
        {
          "name": "AuthorizationStatusList",
          "type": "array",
          "required": false,
          "description": "可以按照当前企业的认证状态进行过滤。可值如下： **\"UNVERIFIED\"**： 未认证的企业 **\"VERIFYINGLEGALPENDINGAUTHORIZATION\"**： 认证中待法人授权的企业 **\"VERIFYINGAUTHORIZATIONFILEPENDING\"**： 认证中授权书审核中的企业 **\"VERIFYINGAUTHORIZATIONFILEREJECT\"**： 认证中授权书已驳回的企业 **\"VERIFYING\"**： 认证进行中的企业 **\"VERIFIED\"**： 已认证完成的企业",
          "example": "UNVERIFIED",
          "item_type": "string"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "指定分页返回第几页的数据，如果不传默认返回第一页。 页码从 0 开始，即首页为 0，最大20000。",
          "example": "20"
        }
      ],
      "required": [
        "Agent",
        "Limit"
      ]
    },
    {
      "name": "DescribeChannelSealPolicyWorkflowUrl",
      "description": "生成用印申请审批链接，审批人可以通过此链接进入小程序进行审批。 p.s. Agent参数中的OpenId 必须为审批者的openId，且链接必须由审批人打开。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "WorkflowInstanceId",
          "type": "string",
          "required": true,
          "description": "用印审批单的ID，可通过用印[申请回调](https://qian.tencent.com/developers/partner/callback_types_seals#%E4%B8%89-%E7%94%A8%E5%8D%B0%E7%94%B3%E8%AF%B7%E5%AE%A1%E6%89%B9%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5)获取。",
          "example": "yDCYyUU5v4h32uUEp5vIWRaloaz5mYuu"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "生成链接的类型： 生成链接的类型 **LongLink**：(默认)长链接，H5跳转到电子签小程序链接，链接有效期为1年 **ShortLink**：H5跳转到电子签小程序链接，一般用于发送短信中带的链接，打开后进入腾讯电子签小程序，链接有效期为7天 **App**：第三方APP或小程序跳转电子签小程序链接，一般用于贵方小程序或者APP跳转过来，打开后进入腾讯电子签小程序，链接有效期为1年",
          "example": "LongLink"
        }
      ],
      "required": [
        "Agent",
        "WorkflowInstanceId"
      ]
    },
    {
      "name": "DescribeExtendedServiceAuthDetail",
      "description": "查询企业扩展服务的授权详情（列表），当前支持查询以下内容： 1. **企业自动签** 2. **批量签署** 注: 所在企业的超管、法人才有权限调用此接口(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "ExtendServiceType",
          "type": "string",
          "required": true,
          "description": "要查询的扩展服务类型。 如下所示： AUTO_SIGN：企业静默签署 BATCH_SIGN：批量签署",
          "example": "AUTO_SIGN"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为200。`",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`",
          "example": "0"
        }
      ],
      "required": [
        "Agent",
        "ExtendServiceType"
      ]
    },
    {
      "name": "DescribeExtendedServiceAuthInfo",
      "description": "查询企业扩展服务的开通和授权情况，当前支持查询以下内容： 1. **企业自动签** 2. **企业与港澳台居民签署合同** 3. **使用手机号验证签署方身份** 4. **拓宽签署方年龄限制** 5. **下载企业合同/文件** 6. **隐藏合同经办人姓名** 对应能力开通页面在子客控制台-企业中心-拓展服务，如下图所示: ![image](https://qcloudimg.tencent-cloud.cn/raw/931a1e02955ab36e5cc69a489af10352.jpg) 注: 所在企业的超管\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "DescribeFlowDetailInfo",
      "description": "此接口用于查询合同或者合同组的详情信息，支持查询多个（数量不能超过100）。 适用场景：可用于主动查询某个合同或者合同组的详情信息。 注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "需要查询的流程ID列表，最多可传入100个ID。 如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。",
          "example": "[\"yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw\"]",
          "item_type": "string"
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": false,
          "description": "需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。 合同组由通过多模板创建合同组签署流程和通过多文件创建合同组签署流程等接口创建。",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "DescribeResourceUrlsByFlows",
      "description": "获取合同流程PDF的下载链接，可以下载签署中、签署完的此子企业创建的合同。 ### 2. 确保合同的PDF已经合成后，再调用本接口。 用户创建合同或者提交签署动作后，后台需要1~3秒的时间就进行合同PDF合成或者签名，为了确保您下载的是签署完成的完整合同文件，我们建议采取下面两种方式的一种来确保PDF已经合成完成，然后在调用本接口。 **第一种**：请确保您的系统配置了...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "需要下载的合同流程的ID, 至少需要1个, 做多50个",
          "example": "[\"yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "DescribeTemplates",
      "description": "通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。 **适用场景** 该接口常用来配合用模板创建签署流程和通过多模板创建合同组签署流程接口，作为创建合同的前置接口使用。 通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的创建。 **模板的来...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "TemplateId",
          "type": "string",
          "required": false,
          "description": "合同模板ID，为32位字符串。 可以通过生成子客登录链接登录企业控制台, 在企业模板中得到合同模板ID。 [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)",
          "example": "yDxZBURlR5VUy0fKyKS3wFGsowVtMwKQ"
        },
        {
          "name": "ContentType",
          "type": "integer",
          "required": false,
          "description": "查询模板的内容 **0**：（默认）模板列表及详情 **1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息",
          "example": "0"
        },
        {
          "name": "TemplateIds",
          "type": "array",
          "required": false,
          "description": "合同模板ID数组，每一个合同模板ID为32位字符串, 最多支持100个模板的批量查询。 注意: 1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。` 2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。` 4. `若传递此参数，分页参数(Limit,Offset)无效` [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.p...",
          "example": "[\"yDxZBURlR5VUy0fKyKS3wFGsowVtMwKQ\"]",
          "item_type": "string"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为100。`",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`",
          "example": "0"
        },
        {
          "name": "TemplateName",
          "type": "string",
          "required": false,
          "description": "模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。",
          "example": "模板名称1"
        },
        {
          "name": "ChannelTemplateId",
          "type": "string",
          "required": false,
          "description": "对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。",
          "example": "yDCYyUU5v4h32uUEp5vIWRaloaz5mYuu"
        },
        {
          "name": "QueryAllComponents",
          "type": "boolean",
          "required": false,
          "description": "返回控件的范围, 是只返回发起方自己的还是所有参与方的 **false**：（默认）只返回发起方控件 **true**：返回所有参与方(包括发起方和签署方)控件",
          "example": "false"
        },
        {
          "name": "WithPreviewUrl",
          "type": "boolean",
          "required": false,
          "description": "是否获取模板预览链接。 **false**：不获取（默认） **true**：获取 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。",
          "example": "false"
        },
        {
          "name": "WithPdfUrl",
          "type": "boolean",
          "required": false,
          "description": "是否获取模板的PDF文件链接。 **false**：不获取（默认） **true**：获取 设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地 注: `此功能需要开通功能白名单【第三方应用集成企业获取模板PDF下载链接】，使用前请联系对接的客户经理沟通。`",
          "example": "false"
        },
        {
          "name": "UserFlowTypeId",
          "type": "string",
          "required": false,
          "description": "用户合同类型id",
          "example": "yDwXXUUckp19hvn8URxp4X6wVwCLodx"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "DescribeUsage",
      "description": "此接口（DescribeUsage）用于获取此应用下子客企业的合同消耗数量。 此接口于 2026 年 2 月 3 日下线， 请使用新接口:查询渠道计费消耗情况 注: 此接口**每日限频50次**，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "StartDate",
          "type": "string",
          "required": true,
          "description": "查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-03-21) 注: `查询日期范围区间长度大于90天`。",
          "example": "2021-03-21"
        },
        {
          "name": "EndDate",
          "type": "string",
          "required": true,
          "description": "查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-04-21) 注: `查询日期范围区间长度大于90天`。",
          "example": "2021-04-22"
        },
        {
          "name": "NeedAggregate",
          "type": "boolean",
          "required": false,
          "description": "是否汇总数据，默认不汇总。 **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加 **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)",
          "example": "true"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定每页返回的数据条数，和Offset参数配合使用。 注: `默认值为1000，单页做大值为1000`",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`offset从0开始，即第一页为0。`",
          "example": "0"
        }
      ],
      "required": [
        "Agent",
        "StartDate",
        "EndDate"
      ]
    },
    {
      "name": "DescribeUserFlowType",
      "description": "查询用户模板类型，分为两种模式： QueryBindTemplate:false，查询用户合同模板类型，返回用户合同模板类型ID，用户合同模板类型名称，用户合同模板类型描述信息 QueryBindTemplate:false，查询用户合同模板类型，返回用户合同模板类型ID，用户合同模板类型名称，用户合同模板类型描述信息，被绑定的模板数量",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。 模板的用户合同类型：Key设置为 user-flow-type-id ，Values为您想要查询的用户模板类型id列表。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "查询过滤条件的Key",
              "example": "IsReturnPermissionGroup"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "查询过滤条件的Value列表",
              "example": "[\"0\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "QueryBindTemplate",
          "type": "boolean",
          "required": false,
          "description": "查询绑定了模板的用户合同类型false（默认值），查询用户合同类型true，查询绑定了模板的用户合同类型",
          "example": "true"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "GetDownloadFlowUrl",
      "description": "此接口（GetDownloadFlowUrl）用户获取合同控制台下载页面链接, 点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击**下载**按钮后就会下载传入的合同列表, 下载页面如下图 ![image](https://dyn.ess.tencent.cn/guide/capi/channel_GetDownloadFlowUrl.png) 注: 仅支持下载 本企业 下合同，链接会 登录企业控制台 链接仅可使用一次，不可重复使用",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "DownLoadFlows",
          "type": "array",
          "required": false,
          "description": "程合同ID列表, 可将这些流程ID组织成合同组的形式, 下载时候每个文件夹会是一个zip压缩包, 每个文件夹最多20个合同, 所有文件夹最多50个合同 如下列组织形式, 控制台下载页面点击下载按钮后, 会生成**2023采购合同.zip**和**2023入职合同.zip** 两个下载任务(注:`部分浏览器需要授权或不支持创建多下载任务`) **2023采购合同.zip**压缩包会有`yDwivUUckpor6wtoUuogwQHCAB0ES0pQ`和`yDwi8UUckpo5fz9cUqI6...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FileName",
              "type": "string",
              "required": true,
              "description": "文件夹名称",
              "example": "测试合同文件夹"
            },
            {
              "name": "FlowIdList",
              "type": "array",
              "required": true,
              "description": "签署流程的标识数组",
              "example": "[\"FlowId1\",\"FlowId2\"]",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "ModifyExtendedService",
      "description": "管理企业扩展服务 - **直接开通的情形：** 若在操作过程中接口没有返回跳转链接，这表明无需进行任何跳转操作。此时，相应的企业拓展服务将会直接被开通或关闭。 - **需要法人或者超管签署开通协议的情形：** 当需要开通以下企业拓展服务时， 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员（超管）或法人。由他们点击该链接，完成服务的开通操作...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "ServiceType",
          "type": "string",
          "required": true,
          "description": "扩展服务类型 AUTO_SIGN 企业自动签（自动签署） OVERSEA_SIGN 企业与港澳台居民签署合同 MOBILE_CHECK_APPROVER 使用手机号验证签署方身份 DOWNLOAD_FLOW 授权渠道下载合同 AGE_LIMIT_EXPANSION 拓宽签署方年龄限制 HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名",
          "example": "AUTO_SIGN"
        },
        {
          "name": "Operate",
          "type": "string",
          "required": true,
          "description": "操作类型 OPEN : 开通 CLOSE : 关闭",
          "example": "OPEN"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "链接跳转类型，支持以下类型 WEIXINAPP : 短链直接跳转到电子签小程序 (默认值) APP : 第三方APP或小程序跳转电子签小程序 WEIXIN_QRCODE_URL：直接跳转至电子签小程序的二维码链接，无需通过中转页。您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。",
          "example": "APP"
        }
      ],
      "required": [
        "Agent",
        "ServiceType",
        "Operate"
      ]
    },
    {
      "name": "ModifyFlowDeadline",
      "description": "在已启动的签署流程中，可对签署截止日期进行延期操作，主要分为以下两个层面： 1. 合同（流程）层面：仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。 2. 签署人层面 ：需提供流程ID和签署人ID。此操作针对特定签署人进行延期，特别是对于有序合同（流程），签署截止时间不得超过后续签署人的流程截止时间。 此接口存在\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
          "example": "yDCNtUUckpvrcvf4UELZnZDvMStFgT7K"
        },
        {
          "name": "Deadline",
          "type": "integer",
          "required": true,
          "description": "签署流程或签署人新的签署截止时间，格式为Unix标准时间戳（秒）",
          "example": "1705992543"
        },
        {
          "name": "RecipientId",
          "type": "string",
          "required": false,
          "description": "签署方角色编号，为32位字符串 若指定了此参数，则只调整签署流程中此签署人的签署截止时间，否则调整合同整体的签署截止时间（合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间） 通过[用PDF文件创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)发起合同，或通过[用模板创建签署流程](https://test.qian.tencent.cn/developers/partner...",
          "example": "yDwhyUUckp1cmuh4Uu2bfpvRH38OvSw7"
        }
      ],
      "required": [
        "Agent",
        "FlowId",
        "Deadline"
      ]
    },
    {
      "name": "ModifyPartnerAutoSignAuthUrl",
      "description": "创建一个用于更新他方自动签授权的链接（可选择他方授权或我方授权）。通过这个链接，合作方企业可以直接进入小程序，进行自动签更新授权（印章）操作。 如果授权企业尚未开通企业自动签功能，该链接还将引导他们首先开通本企业的自动签服务 注: 1. 所在企业的超管、法人才有权限调用此接口(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId) 2. 2. 只能更新授权的印\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "AuthorizedOrganizationId",
          "type": "string",
          "required": false,
          "description": "被授企业id/授权方企业id（即OrganizationId），如果是企业之间授权和AuthorizedOrganizationName二选一传入。 注：`被授权企业必须和当前企业在同一应用号下`",
          "example": "yDwFdUUckxxxxxxxxxxxxxXbsvN43W6Kax"
        },
        {
          "name": "AuthorizedOrganizationName",
          "type": "string",
          "required": false,
          "description": "被授企业名称/授权方企业的名字，如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。 注: 1. 如果名称中包含英文括号()，请使用中文括号（）代替。 2. 被授权企业必须和当前企业在同一应用号下",
          "example": "王五示例企业"
        },
        {
          "name": "PlatformAppAuthorization",
          "type": "boolean",
          "required": false,
          "description": "是否给平台应用授权 true: 表示是，授权平台应用。在此情况下，无需设置AuthorizedOrganizationId和AuthorizedOrganizationName。 false: （默认）表示否，不是授权平台应用。 注：授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单，请联系运营经理开通。",
          "example": "false"
        },
        {
          "name": "AuthToMe",
          "type": "boolean",
          "required": false,
          "description": "在处理授权关系时，授权的方向 false（默认值）：表示我方授权他方。在这种情况下，AuthorizedOrganizationName 代表的是【被授权方】的企业名称，即接收授权的企业。 true：表示他方授权我方。在这种情况下，AuthorizedOrganizationName 代表的是【授权方】的企业名称，即提供授权的企业。",
          "example": "false"
        }
      ],
      "required": [
        "Agent"
      ]
    },
    {
      "name": "OperateChannelTemplate",
      "description": "此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业发布授权的查询和设置。 平台模板库中的模板的位置在控制台 企业应用管理 中下面的应用模板库管理目录, 可以参照下图位置 ![image](https://qcloudimg.tencent-cloud.cn/raw/7f2b6c94164b3e931efc9a037e0400f7.png) # 支持的操作 ## 1. 查询模板的子客企业授权 (OperateType=SELECT) - 查询模板的授权子企业列表 ## 2. 修改模板的\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "OperateType",
          "type": "string",
          "required": true,
          "description": "操作类型，可取值如下: SELECT: 查询 DELETE: 删除 UPDATE: 更新",
          "example": "SELECT"
        },
        {
          "name": "TemplateId",
          "type": "string",
          "required": true,
          "description": "合同模板ID，为32位字符串。 注: ` 此处为第三方应用平台模板库模板ID，非子客模板ID`",
          "example": "yDSLZUUckpot5i01UydF1AEvOMQiKaBG"
        },
        {
          "name": "ProxyOrganizationOpenIds",
          "type": "string",
          "required": false,
          "description": "第三方平台子客企业的唯一标识，支持批量(用,分割) 一次批量操作最多支持100个第三方平台子客",
          "example": "org_dianziqian,org_zhangsan"
        },
        {
          "name": "AuthTag",
          "type": "string",
          "required": false,
          "description": "模板可见范围, 可以设置的值如下: **all**: 所有本第三方应用合作企业可见 **part**: 指定的本第三方应用合作企业 对应控制台的位置 ![image](https://qcloudimg.tencent-cloud.cn/raw/68b97812c68d6af77a5991e3bff5c790.png)",
          "example": "part"
        },
        {
          "name": "Available",
          "type": "integer",
          "required": false,
          "description": "当OperateType=UPDATE时，可以通过设置此字段对模板启停用状态进行操作。 0: 不修改模板可用状态 1: 启用模板 2: 停用模板 启用后模板可以正常领取。 停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。 如果Available更新失败，会直接返回错误。",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定分页每页返回的数据条数，单页最大支持 100。 不传默认值为 20",
          "example": "20"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页查询偏移量，默认为0",
          "example": "0"
        }
      ],
      "required": [
        "Agent",
        "OperateType",
        "TemplateId"
      ]
    },
    {
      "name": "OperateTemplate",
      "description": "此接口（OperateTemplate）用于对企业自有模板进行管理操作，所有操作都会有对应的回调触发，具体参考回调文档 模板操作相关回调 # 支持的操作 ## 1. 删除模板 (OperateType=DELETE) 此操作会将模板从企业自有模板中彻底删除，若要保留模板而不删除，可将模板停用。 ## 2. 启用模板 (OperateType=ENABLE) 此操作是将已停用的模板启用，操作幂等，若模板已启用，接口不报错。 ## 3. 停用模\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（模板的归属企业） 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （操作人）",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "TemplateId",
          "type": "string",
          "required": true,
          "description": "模板ID，为32位字符串。",
          "example": "yDSLZUUckpot5i01UydF1AEvOMQiKaBG"
        },
        {
          "name": "OperateType",
          "type": "string",
          "required": true,
          "description": "操作类型，可取值如下: DELETE: 删除 ENABLE: 启用 DISABLE: 停用 COPY: 复制新建",
          "example": "DELETE"
        },
        {
          "name": "TemplateName",
          "type": "string",
          "required": false,
          "description": "模板名称，长度不超过64字符。 模板复制时指定有效，若为空，则复制后模板名称为 **原模板名称_副本**。",
          "example": "入职合同"
        }
      ],
      "required": [
        "Agent",
        "TemplateId",
        "OperateType"
      ]
    },
    {
      "name": "PrepareFlows",
      "description": "已经不再使用 该接口 (PrepareFlows) 用于创建待发起文件 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。 目前该接口只支持B2C， **不建议使用**。",
      "status": "deprecated",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "FlowInfos",
          "type": "array",
          "required": true,
          "description": "多个合同（签署流程）信息，最大支持20个签署流程。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FlowName",
              "type": "string",
              "required": true,
              "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
              "example": "张三的入职合同"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": true,
              "description": "合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。 示例值：1604912664",
              "example": "1698827057"
            },
            {
              "name": "TemplateId",
              "type": "string",
              "required": false,
              "description": "用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 如果使用模板发起接口，此参数为必填。 可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。 [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)",
              "example": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc"
            },
            {
              "name": "FlowApprovers",
              "type": "array",
              "required": false,
              "description": "合同流程的参与方列表，最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver) 注: 在发起流程时，需要保证 FlowApprovers中的顺序与模板定义顺序一致，否则会发起失败。 例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二...",
              "example": "签署人信息",
              "item_type": "object",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "张三"
                },
                {
                  "name": "IdCardType",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) OTHER_CARD_TYPE : 其他证件 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "ID_CARD"
                },
                {
                  "name": "IdCardNumber",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "110101192008317114"
                },
                {
                  "name": "Mobile",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)， 不支持海外手机号。 请确认手机号所有方为此合同签署方。",
                  "example": "13888888888"
                },
                {
                  "name": "OrganizationName",
                  "type": "string",
                  "required": false,
                  "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
                  "example": "典子谦示例企业"
                },
                {
                  "name": "NotChannelOrganization",
                  "type": "boolean",
                  "required": false,
                  "description": "指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工",
                  "example": "false"
                },
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成 当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程 注： 如果传进来的OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）",
                  "example": "userdianziqian"
                },
                {
                  "name": "OrganizationOpenId",
                  "type": "string",
                  "required": false,
                  "description": "同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符",
                  "example": "orgtencent"
                },
                {
                  "name": "ApproverType",
                  "type": "string",
                  "required": false,
                  "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **PERSON** :个人/自然人 **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景 **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签） **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签） 注: `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功...",
                  "example": "PERSON"
                },
                {
                  "name": "RecipientId",
                  "type": "string",
                  "required": false,
                  "description": "签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；",
                  "example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
                },
                {
                  "name": "Deadline",
                  "type": "integer",
                  "required": false,
                  "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
                  "example": "1689688460"
                },
                {
                  "name": "SignComponents",
                  "type": "array",
                  "required": false,
                  "description": "使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID:注意：(如果模板里面指定了印章，默认使用模板里面配置的印章，不能进行变更) 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ComponentLimitType",
                  "type": "array",
                  "required": false,
                  "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
                  "example": "[\"OCR_ESIGN\"]",
                  "item_type": "string"
                },
                {
                  "name": "PreReadTime",
                  "type": "integer",
                  "required": false,
                  "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
                  "example": "3"
                },
                {
                  "name": "JumpUrl",
                  "type": "string",
                  "required": false,
                  "description": "签署完前端跳转的url，此字段的用法场景请联系客户经理确认",
                  "example": "https://www.qq.com/success"
                },
                {
                  "name": "ApproverOption",
                  "type": "object",
                  "required": false,
                  "description": "可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。 详细操作可以参考开发者中心的ApproverOption结构体。",
                  "example": "无",
                  "children": [
                    {
                      "name": "NoRefuse",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以拒签 默认false-可以拒签 true-不可以拒签",
                      "example": "true"
                    },
                    {
                      "name": "NoTransfer",
                      "type": "boolean",
                      "required": false,
                      "description": "是否可以转发 默认false-可以转发 true-不可以转发",
                      "example": "true"
                    },
                    {
                      "name": "HideOneKeySign",
                      "type": "boolean",
                      "required": false,
                      "description": "当签署方有多个签署区时候，是否隐藏一键所有的签署区false：（默认）不隐藏true：隐藏，每个签署区要单独选择印章或者签名",
                      "example": "true"
                    },
                    {
                      "name": "FillType",
                      "type": "integer",
                      "required": false,
                      "description": "签署人信息补充类型，默认无需补充。 1 : 动态签署人（可发起合同后再补充签署人信息）注：企业自动签不支持动态补充注：使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关枚举值：1： 动态签署人",
                      "example": "1"
                    },
                    {
                      "name": "FlowReadLimit",
                      "type": "string",
                      "required": false,
                      "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                      "example": "LimitBottom"
                    },
                    {
                      "name": "ForbidAddSignDate",
                      "type": "boolean",
                      "required": false,
                      "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "ApproverNeedSignReview",
                  "type": "boolean",
                  "required": false,
                  "description": "此签署人（员工或者个人）签署前，是否需要发起方企业进行审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待发起方企业内部审批完成。 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 \ufffd...",
                  "example": "false"
                },
                {
                  "name": "ApproverVerifyTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式 此字段可传\ufffd\ufffd...",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "ApproverSignTypes",
                  "type": "array",
                  "required": false,
                  "description": "签署人签署合同时的认证方式 **1** :人脸认证 **2** :签署密码 **3** :运营商三要素（如果是港澳台客户，建议不要选择这个） **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式） **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式） 默...",
                  "example": "[1,2,3]",
                  "item_type": "integer"
                },
                {
                  "name": "SignId",
                  "type": "string",
                  "required": false,
                  "description": "签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息",
                  "example": "06f2bc0f1772d8deac2f92b5df61a5ac"
                },
                {
                  "name": "NotifyType",
                  "type": "string",
                  "required": false,
                  "description": "通知签署方经办人的方式, 有以下途径: **SMS** :(默认)短信 **NONE** : 不通知 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`",
                  "example": "SMS"
                },
                {
                  "name": "AddSignComponentsLimits",
                  "type": "array",
                  "required": false,
                  "description": "[通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递Compon...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "description": "控件类型，支持以下类型 SIGN_SEAL : 印章控件 SIGN_PAGING_SEAL : 骑缝章控件 SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件 SIGN_SIGNATURE : 用户签名控件",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "array",
                      "required": false,
                      "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人\ufffd...",
                      "example": "[\"HANDWRITE\", \"ESIGN\"]",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "ApproverRoleName",
                  "type": "string",
                  "required": false,
                  "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
                  "example": "乙方"
                },
                {
                  "name": "SignTypeSelector",
                  "type": "integer",
                  "required": false,
                  "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
                  "example": "0"
                },
                {
                  "name": "Components",
                  "type": "array",
                  "required": false,
                  "description": "签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 数据表格等填写控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件) 注：`此参数仅在通过文件发起合同或者合同组时生效` ![image](http...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\u0026quot;^\u0026quot;来决定是否使用关键字整词匹配能力。例：如传入的关键字\u0026lt;font color=\u0026quot;red\u0026quot;\u0026gt;\u0026quot;^甲方签署^\u0026quot;，则会在PDF文件\ufffd...",
                      "example": "ComponentId"
                    },
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": false,
                      "description": "如果是Component填写控件类型，则可选的字段为： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选...",
                      "example": "SIGN_SEAL"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：控件名可以在一个PDF中可以重复点击查看ComponentName在模板页面的位置",
                      "example": "ComponentName"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "false"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可",
                      "example": "ComponentRecipientId"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentHeight",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": false,
                      "description": "在绝对定位方式方式下，指定控件所在PDF文件上的页码在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：页码编号是从1开始编号的。页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": false,
                      "description": "在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "10.0"
                    },
                    {
                      "name": "ComponentExtra",
                      "type": "string",
                      "required": false,
                      "description": "在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：{\u0026quot;FontColor\u0026quot;:\u0026quot;255,0,0\u0026quot;,\u0026quot;FontSize\u0026quot;:12,\u0026quot;Bold\u0026quot;...",
                      "example": "ComponentExtra"
                    },
                    {
                      "name": "ComponentValue",
                      "type": "string",
                      "required": false,
                      "description": "控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） SIGN_S...",
                      "example": "ComponentValue"
                    },
                    {
                      "name": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "DocumentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可",
                      "example": "c17bdf9c2a7bdcb32611f4d0200fee3d"
                    },
                    {
                      "name": "ComponentDescription",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】控件描述，用户自定义，不影响合同发起流程",
                      "example": "Desc"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： 向左调整设置为负数， 向右调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： 向上调整设置为负数， 向下调整设置成正数",
                      "example": "100.5"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "componentId1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "0"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "Middle"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的",
                      "example": "[0]",
                      "item_type": "integer"
                    },
                    {
                      "name": "Placeholder",
                      "type": "string",
                      "required": false,
                      "description": "填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。注：签署控件设置此字段无效",
                      "example": "请签名"
                    },
                    {
                      "name": "LockComponentValue",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值",
                      "example": "false"
                    },
                    {
                      "name": "ForbidMoveAndDelete",
                      "type": "boolean",
                      "required": false,
                      "description": "web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件",
                      "example": "false"
                    }
                  ]
                },
                {
                  "name": "Intention",
                  "type": "object",
                  "required": false,
                  "description": "只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。 2. 使用视频认证时，生成H5签署链接的时候必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。 3. 签\ufffd\ufffd...",
                  "example": "无",
                  "children": [
                    {
                      "name": "IntentionType",
                      "type": "integer",
                      "required": false,
                      "description": "视频认证类型，支持以下类型 1 : 问答模式 2 : 点头模式 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`",
                      "example": "1"
                    },
                    {
                      "name": "IntentionQuestions",
                      "type": "array",
                      "required": false,
                      "description": "意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。 注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "IntentionActions",
                      "type": "array",
                      "required": false,
                      "description": "意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。 注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "RuleIdConfig",
                      "type": "object",
                      "required": false,
                      "description": "视频核身相关配置",
                      "example": "无"
                    }
                  ]
                },
                {
                  "name": "SignEndpoints",
                  "type": "array",
                  "required": false,
                  "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
                  "example": "[\"link\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "FormFields",
              "type": "array",
              "required": false,
              "description": "发起方角色的填写控件的填充内容。 注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通，否则模板编辑时无法将填写控件分配给发起方)。 ![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)",
              "example": "表单K-V对列表",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentValue",
                  "type": "string",
                  "required": true,
                  "description": "控件填充值，ComponentType和传入值格式对应关系如下： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容， 可以用 \\n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table) DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日） DI...",
                  "example": "Name"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 点击此处查看模板上控件ID的获取方式",
                  "example": "391963b9d3cb2de35dedc6eb0a60e535"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "控件的名字，跟ComponentId二选一，不能全为空 点击此处查看模板上控件名字的获取方式",
                  "example": "住房地址"
                },
                {
                  "name": "LockComponentValue",
                  "type": "boolean",
                  "required": false,
                  "description": "是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定",
                  "example": "false"
                }
              ]
            },
            {
              "name": "FlowType",
              "type": "string",
              "required": false,
              "description": "合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。",
              "example": "入职合同"
            },
            {
              "name": "FlowDescription",
              "type": "string",
              "required": false,
              "description": "合同流程描述信息(可自定义此描述)，最大长度1000个字符。",
              "example": "张三2023年的入职公司财务部的合同"
            },
            {
              "name": "CustomerData",
              "type": "string",
              "required": false,
              "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
              "example": "QmFzZTY05YaF5a65"
            },
            {
              "name": "CustomShowMap",
              "type": "string",
              "required": false,
              "description": "您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。 例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{\ufffd...",
              "example": "合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬！;净重: 100吨;品类: 铁矿石"
            },
            {
              "name": "CcInfos",
              "type": "array",
              "required": false,
              "description": "合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。 注 1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。 2. 请确保抄送人列表中的成员不与任何签署人重复。",
              "example": " ",
              "item_type": "object",
              "children": [
                {
                  "name": "Mobile",
                  "type": "string",
                  "required": false,
                  "description": "被抄送方手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此业务通知方。",
                  "example": "13200000000"
                },
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "被抄送方姓名。 抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。",
                  "example": "典子谦"
                },
                {
                  "name": "CcType",
                  "type": "integer",
                  "required": false,
                  "description": "被抄送方类型, 可设置以下类型: **0** :个人抄送方 **1** :企业员工抄送方",
                  "example": "1"
                },
                {
                  "name": "CcPermission",
                  "type": "integer",
                  "required": false,
                  "description": "被抄送方权限, 可设置如下权限: **0** :可查看合同内容 **1** :可查看合同内容也可下载原文",
                  "example": "1"
                }
              ]
            },
            {
              "name": "NeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业\ufffd\ufffd...",
              "example": "true"
            },
            {
              "name": "CcNotifyType",
              "type": "integer",
              "required": false,
              "description": "若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型： **0** :合同发起时通知通知对方来查看合同（默认） **1** : 签署完成后通知对方来查看合同",
              "example": "0"
            },
            {
              "name": "AutoSignScene",
              "type": "string",
              "required": false,
              "description": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） **OTHER** : 通用场景 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`",
              "example": "E_PRESCRIPTION_AUTO_SIGN"
            },
            {
              "name": "FlowDisplayType",
              "type": "integer",
              "required": false,
              "description": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)",
              "example": "1"
            }
          ]
        },
        {
          "name": "JumpUrl",
          "type": "string",
          "required": true,
          "description": "操作完成后的跳转地址，最大长度200",
          "example": "https://ess.tencent.com"
        }
      ],
      "required": [
        "Agent",
        "FlowInfos",
        "JumpUrl"
      ]
    },
    {
      "name": "SyncProxyOrganization",
      "description": "此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。 注意： - **需要在生成子客登录链接前同步的企业信息**, 否则会出现信息同步没有用的情形 - **企业信息需要和营业执照信息对应**, 否则会出现激活过程验证不通过的问题 ...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "ProxyOrganizationName",
          "type": "string",
          "required": true,
          "description": "第三方平台子客企业名称，请确认该名称与企业营业执照中注册的名称一致。 注: `如果名称中包含英文括号()，请使用中文括号（）代替。`",
          "example": "张三示例企业"
        },
        {
          "name": "BusinessLicense",
          "type": "string",
          "required": false,
          "description": "营业执照正面照(PNG或JPG) base64格式, 大小不超过5M",
          "example": "aHR0cHM6Ly9jYXBpLndvYS5jb20vhaWwlM0ZpZCUzRGVzc2Jhc2ljJTI2dGFiJTNEYXBp..图片base64省略"
        },
        {
          "name": "UniformSocialCreditCode",
          "type": "string",
          "required": false,
          "description": "第三方平台子客企业统一社会信用代码，最大长度200个字符",
          "example": "BOLIU101304662708A"
        },
        {
          "name": "ProxyLegalName",
          "type": "string",
          "required": false,
          "description": "第三方平台子客企业法定代表人的名字",
          "example": "张三"
        },
        {
          "name": "ProxyLegalIdCardType",
          "type": "string",
          "required": false,
          "description": "第三方平台子客企业法定代表人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) 注: `现在仅支持ID_CARD中国大陆居民身份证类型`",
          "example": "ID_CARD"
        },
        {
          "name": "ProxyLegalIdCardNumber",
          "type": "string",
          "required": false,
          "description": "第三方平台子客企业法定代表人的证件号码, 应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。",
          "example": "620000198802020000"
        },
        {
          "name": "ProxyAddress",
          "type": "string",
          "required": false,
          "description": "第三方平台子客企业详细住所，最大长度500个字符 注：`需要符合省市区详情的格式例如： XX省XX市XX区街道具体地址`",
          "example": "深圳市南山区高新区科技中一路腾讯大厦35层"
        }
      ],
      "required": [
        "Agent",
        "ProxyOrganizationName"
      ]
    },
    {
      "name": "SyncProxyOrganizationOperators",
      "description": "此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。 子客Web控制台的组织架构管理，依赖于第三方应用平台的，无法在页面针对员工做新增/更新/离职等操作， 必须通过 API 来操作。 - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用生成子客登录链接分享给对应的员工进行实名, 新增员工后员工的状态为**未\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业必须已经经过实名认证",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "OperatorType",
          "type": "string",
          "required": true,
          "description": "操作类型，对应的操作 **CREATE** :新增员工 **UPDATE** :修改员工（仅支持修改未实名员工的信息，如果已经实名并加入企业的员工基础信息修改需要到小程序中进行） **RESIGN** :离职员工",
          "example": "RESIGN"
        },
        {
          "name": "ProxyOrganizationOperators",
          "type": "array",
          "required": true,
          "description": "员工信息列表，最多支持200个",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Id",
              "type": "string",
              "required": true,
              "description": "员工的唯一标识(即OpenId), 定义Agent中的OpenId一样, 可以参考Agent结构体",
              "example": "n9527"
            },
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "员工的姓名，最大长度50个字符 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为真实姓名，而非昵称等代名。",
              "example": "张三"
            },
            {
              "name": "IdCardType",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
              "example": "ID_CARD "
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": false,
              "description": "经办人证件号",
              "example": "37000019890303000X"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "员工的手机号，支持国内手机号11位数字(无需加+86前缀或其他字符)，不支持海外手机号。",
              "example": "1850000000"
            },
            {
              "name": "DefaultRole",
              "type": "string",
              "required": false,
              "description": "预先分配员工的角色, 可以分配的角色如下: 可以分配的角色 角色名称 角色描述 admin 业务管理员（IT 系统负责人，e.g. CTO） 有企业合同模块、印章模块、模板模块等全量功能及数据权限。 channel-normal-operator 经办人（企业法务负责人） 有发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。 channel-sales-man 业务员（一般为销售员、\ufffd...",
              "example": "channel-normal-operator"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "OperatorType",
        "ProxyOrganizationOperators"
      ]
    },
    {
      "name": "UploadFiles",
      "description": "此接口（UploadFiles）文件上传。 适用场景：用于合同，印章的文件上传。文件上传以后， 如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起 如果是其他类型可以配合创建文件转换任务接口转换成PDF文件 注: 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下 2. 此接口调用时需要单独设置Domain请求域名 , 联调开发环境为 file.tes...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": true,
          "description": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "AppId",
              "type": "string",
              "required": true,
              "description": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
              "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
            },
            {
              "name": "ProxyOrganizationOpenId",
              "type": "string",
              "required": false,
              "description": "第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串",
              "example": "org_dianziqian"
            },
            {
              "name": "ProxyOperator",
              "type": "object",
              "required": false,
              "description": "第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。",
              "example": "无",
              "children": [
                {
                  "name": "OpenId",
                  "type": "string",
                  "required": false,
                  "description": "第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 注意: 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. **员工加入企业后**, 可以通过生成子客登录链接登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图 ![image](https://qcloudimg.ten...",
                  "example": "n9527"
                }
              ]
            },
            {
              "name": "ProxyAppId",
              "type": "string",
              "required": false,
              "description": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
              "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
            }
          ]
        },
        {
          "name": "BusinessType",
          "type": "string",
          "required": true,
          "description": "文件对应业务类型,可以选择的类型如下 **TEMPLATE** : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过创建文件转换任务转换后才能使用 **DOCUMENT** : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过创建文件转换任务转换后得到的pdf文件才能用于发起合同接口...",
          "example": "TEMPLATE"
        },
        {
          "name": "FileInfos",
          "type": "array",
          "required": false,
          "description": "上传文件内容数组，一次最多可上传20个文件。 若上传多个文件，所有文件必须为相同类型，例如全部为PDF或全部为Word文件。不支持混合文件类型的上传。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FileBody",
              "type": "string",
              "required": true,
              "description": "Base64编码后的文件内容",
              "example": "QmFzZTY057yW56CB5ZCO55qE5paH5Lu25YaF5a65"
            },
            {
              "name": "FileName",
              "type": "string",
              "required": false,
              "description": "文件的名字。 文件名的最大长度应不超过200个字符，并且文件名的后缀必须反映其文件类型。 例如，PDF文件应以“.pdf”结尾，如“XXX.pdf”，而Word文件应以“.doc”或“.docx”结尾，如“XXX.doc”或“XXX.docx”。",
              "example": "入职合同.PDF"
            }
          ]
        }
      ],
      "required": [
        "Agent",
        "BusinessType"
      ]
    }
  ]
}