{
  "name": "ess",
  "display_name": "腾讯电子签企业版",
  "description": "使用API接口发起电子签名流程, 对流程进行管理, 电子印章管理,数字证书管理, 角色组织架构机构帐号管理,文档管理, 日志及统计等功能",
  "domain": "other",
  "api_version": "2020-11-11",
  "endpoint": "ess.tencentcloudapi.com",
  "actions": [
    {
      "name": "ArchiveDynamicFlow",
      "description": "该接口用于结束动态签署方2.0的合同流程。 **功能开通** - 动态签署方2.0功能的使用需要先联系产品经理开通模块化计费功能，然后到控制台中打开此功能。详细的使用说明请参考动态签署方2.0文档。 **使用条件** - 此接口只能在合同处于非终态且所有的签署方都已经完成签署。一旦合同进入终态（例如：过期、拒签、撤销或者调用过此接口成功过），将无法通过此接口结束合\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID, 为32位字符串。 可登录腾讯电子签控制台，[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
          "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "FlowId"
      ]
    },
    {
      "name": "BindEmployeeUserIdWithClientOpenId",
      "description": "此接口（BindEmployeeUserIdWithClientOpenId）用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。 此OpenId只在 [更新企业员工信息 ](https://qian.tencent.com/developers/companyApis/staffs/UpdateIntegrationEmployees)、[移除企业员工](https://qian.tencent.com/developers/companyApis/staffs/DeleteIntegrationEmployees) 等场景下可以使用",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "员工在腾讯电子签平台的唯一身份标识，为32位字符串。 通过DescribeIntegrationEmployees接口获取，也可登录腾讯电子签控制台查看 ![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)",
          "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
        },
        {
          "name": "OpenId",
          "type": "string",
          "required": true,
          "description": "员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。",
          "example": "n9527"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "UserId",
        "OpenId"
      ]
    },
    {
      "name": "CancelFlow",
      "description": "用于撤销合同流程 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。 - **可撤回合同状态**：未全部签署完成 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 注: 1. 如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID, 为32位字符串。 可登录腾讯电子签控制台，[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
          "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
        },
        {
          "name": "CancelMessage",
          "type": "string",
          "required": true,
          "description": "撤销此合同流程的**撤销理由**，最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成（不支持表情）。 ![image](https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png)",
          "example": "这个合同里边的付款金额写错"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "FlowId",
        "CancelMessage"
      ]
    },
    {
      "name": "CancelMultiFlowSignQRCode",
      "description": "此接口（CancelMultiFlowSignQRCode）用于废除一码多签签署码。 该接口所需的二维码ID，源自[创建一码多签签署码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。 如果该签署码尚处于有效期内，可通过本接口将其设置为失效状态。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "QrCodeId",
          "type": "string",
          "required": true,
          "description": "需要取消的签署码ID，为32位字符串。由[创建一码多签签署码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode/)返回",
          "example": "yDR***********Apl"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "QrCodeId"
      ]
    },
    {
      "name": "CancelUserAutoSignEnableUrl",
      "description": "用来撤销获取个人用户自动签的开通状态生成的开通链接，撤销生成的链接失效。 注: 若个人用户已经用生成的完成自动签署的开通，撤销链接无效不会对开通结果产生影响(此情况接口会报错)。 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "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": "610*************1X"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "SceneKey",
        "UserInfo"
      ]
    },
    {
      "name": "CreateBatchAdminChangeInvitations",
      "description": "本接口（CreateBatchAdminChangeInvitations）用于批量创建企业超管信息变更。 该接口为提交任务接口,如果需要获得链接， 需要使用接口创建超管变更链接(CreateBatchAdminChangeInvitationsUrl)。 批量创建链接有以下限制： 1. 单次最多创建10个企业的超管变更。 2. 同一批创建的企业不能重复,唯一值为企业 Id。 注意： 此接口创建的超管变更企业，必须是以下两种企业。 1. 集团子企业，调用方...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "AdminChangeInvitationInfos",
          "type": "array",
          "required": true,
          "description": "组织机构超管变更信息。 一次最多支持10条超管变更信息。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ChangeAdminOrganizationId",
              "type": "string",
              "required": true,
              "description": "要变更的企业Id。 使用接口进行变更，所支持的企业有两种。 1. 集团主企业替子企业进行超管变更。 子企业的企业 Id 可在更多-组织管理-集团组织管理处获取。如图位置![image](https://qcloudimg.tencent-cloud.cn/raw/3d4469c13ca9e66a847560fc4309c58b.png) 2. 使用接口[创建企业认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl) 创建的企业，企业 Id 可以从回调[企业引导企..."
            },
            {
              "name": "NewAdminName",
              "type": "string",
              "required": true,
              "description": "组织机构要变更的超管姓名。 跟超管变更的操作人保持一致。"
            },
            {
              "name": "AuthFiles",
              "type": "array",
              "required": true,
              "description": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。 p.s. 如果上传授权书 ，需遵循以下条件 1. 超管的信息（超管姓名，超管手机号）必须为必填参数。",
              "item_type": "string"
            },
            {
              "name": "NewAdminMobile",
              "type": "string",
              "required": false,
              "description": "组织机构要变更的超管手机号。 跟超管变更的操作人保持一致。 超管变更的手机号和超管变更的证件号，必须要传递一个。"
            },
            {
              "name": "NewAdminIdCardType",
              "type": "string",
              "required": false,
              "description": "组织机构要变更的超管证件类型支持以下类型 - ID_CARD : 中国大陆居民身份证 (默认值) - HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 - HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) 跟超管变更的操作人保持一致。"
            },
            {
              "name": "NewAdminIdCardNumber",
              "type": "string",
              "required": false,
              "description": "组织机构新超管证件号。 跟超管变更的操作人保持一致。 超管变更的手机号和超管变更的证件号，必须要传递一个。"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "AdminChangeInvitationInfos"
      ]
    },
    {
      "name": "CreateBatchAdminChangeInvitationsUrl",
      "description": "此接口用于获取企业批量变更超管链接，包含多条超管变更任务。 一次性最多获取 500 条任务。 前提条件：已调用 [CreateBatchAdminChangeInvitations生成批量变更超管任务接口](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchAdminChangeInvitations) 确保任务提交。 此链接包含多条超管变更流程，使用该链接可以批量的对企业进行超管变更。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "NewAdminName",
          "type": "string",
          "required": true,
          "description": "组织机构要变更的超管姓名。 在超管变更流程中，必须是超管本人进行操作，需要更当前操作人的姓名保持一致。",
          "example": "典子谦"
        },
        {
          "name": "NewAdminMobile",
          "type": "string",
          "required": false,
          "description": "组织机构要变更的超管手机号。 在超管变更流程中，必须是超管本人进行操作，需要更当前操作人的手机号保持一致。 超管手机号 和超管证件号 二选一 必填。 注意： 1. 如果新超管的个人身份在电子签进行了手机号的变更，之前提交的超管变更任务将无法获取。",
          "example": "1320***007"
        },
        {
          "name": "NewAdminIdCardType",
          "type": "string",
          "required": false,
          "description": "组织机构要变更的超管证件类型支持以下类型 - ID_CARD : 中国大陆居民身份证 (默认值) - HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 - HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) 需要更当前操作人的证件类型保持一致。",
          "example": "ID_CARD"
        },
        {
          "name": "NewAdminIdCardNumber",
          "type": "string",
          "required": false,
          "description": "组织机构要变更的超管证件号。 在超管变更流程中，必须是超管本人进行操作，需要更当前操作人的证件号保持一致。 超管手机号和超管证件号 二选一必填。",
          "example": "640521***113278"
        },
        {
          "name": "NotifyType",
          "type": "string",
          "required": false,
          "description": "通知方式。 NONE（默认） SMS - 如果使用这个方式，则会给即将变更的超管发信息。 注意： 发送信息的手机号，是用户传递的手机号。 如果用户同时传递了证件号，手机号会被用户在电子签注册的手机号进行覆盖。",
          "example": "NONE"
        },
        {
          "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的二维码形式，可以在页面展示适合此类\ufffd...",
          "example": "APP"
        }
      ],
      "required": [
        "Operator",
        "NewAdminName"
      ]
    },
    {
      "name": "CreateBatchCancelFlowUrl",
      "description": "指定需要批量撤回的签署流程Id，以获取批量撤销链接。 客户需指定要撤回的签署流程Id，最多可指定100个，超过100则不处理。 接口调用成功后，将返回批量撤回合同的链接。通过点击链接，可跳转至电子签小程序完成批量撤回操作。 - **可撤回合同状态**：未全部签署完成 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 批\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": true,
          "description": "需要执行撤回的流程(合同)的编号列表，最多100个. 列表中的流程(合同)编号不要重复.",
          "example": "[\"yDt1JUUckp77a2omUyEmko88eg49PTsN\"]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "FlowIds"
      ]
    },
    {
      "name": "CreateBatchContractReviewTask",
      "description": "此接口（CreateBatchContractReviewTask）用来通过上传后的PDF资源编号来批量创建合同智能审查任务。 适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。 注: 1. PDF格式限制大小为10M以下 2. 仅支持5份PDF文件批量发起（一份PDF对应一个审查任务）",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行合同审查任务的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ResourceIds",
          "type": "array",
          "required": true,
          "description": "合同审查的PDF文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。 注: `目前，此接口仅支持5个文件发起。每个文件限制在10M以下，文件必须是PDF格式`",
          "example": "[\"yDRS4UUgygqdcj56UuO4zjExBQcOiB68\",\"yDRS4UUgygqdcj5pUuO4zjEu602GFIe6\"]",
          "item_type": "string"
        },
        {
          "name": "PolicyType",
          "type": "integer",
          "required": false,
          "description": "合同审查的审查尺度。默认为`0`严格尺度 审查尺度如下： **0** - 【严格】以保护己方利益为核心，对合同条款进行严格把控，尽可能争取对己方有利的条款，同时对对方提出的不合理条款可进行坚决修改或删除。 **1** - 【中立】以公平合理为原则，平衡双方的权利义务，既不过分强调己方利益，也不过度让步，力求达成双方均可接受的条款。 **2** - 【宽松】以促成交易为核心\ufffd...",
          "example": "0"
        },
        {
          "name": "Role",
          "type": "object",
          "required": false,
          "description": "合同审查中的角色信息，通过明确入参角色的名称和描述，可以提高合同审查的效率和准确性。用户不做配置时大模型会根据合同内容推荐出风险识别角色的名称和描述信息。",
          "example": "无",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "风险识别角色的名称。用于唯一标识和区分不同的风险识别角色。 注意：`最大长度应不超过200个字符`",
              "example": "甲方（授权方）"
            },
            {
              "name": "Description",
              "type": "string",
              "required": false,
              "description": "风险识别角色的详细说明。 注意： `最大长度应不超过500个字符`",
              "example": "示例授权方公司"
            }
          ]
        },
        {
          "name": "ChecklistId",
          "type": "string",
          "required": false,
          "description": "用户配置的审查清单ID，基于此清单ID批量创建合同审查任务，为32位字符串。 [点击查看审查清单ID在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/2c6588549e28ca49bd8bb7f4a072b19e.png)。如果用户不做此配置大模型会根据合同内容在当前企业下的审查清单和系统默认的清单中选择一个清单进行审查。",
          "example": "yDtCMUUckpx3boo7UysNTh4vx0j0a6Ii"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Comment",
          "type": "string",
          "required": false,
          "description": "备注信息，长度不能超过100个字符",
          "example": "备注信息"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
          "example": "QmFzZTY0IEJhc2U2NCA"
        },
        {
          "name": "EnableGeneralChecklist",
          "type": "integer",
          "required": false,
          "description": "启用附加通用风险审查清单。默认为启用状态 可选值如下： - 1: 启用系统提供的附加通用风险审查清单 - 2:不启用系统提供的附加通用风险审查清单",
          "example": "0"
        }
      ],
      "required": [
        "Operator",
        "ResourceIds"
      ]
    },
    {
      "name": "CreateBatchInformationExtractionTask",
      "description": "此接口（CreateBatchInformationExtractionTask）用来通过上传后的PDF资源编号来批量创建合同智能审查任务。 适用场景：根据合同关键词（字段名称）来提取PDF合同文件的字段结果信息。 注: 1. PDF格式限制大小为10M以下 2. 仅支持5个PDF文件批量发起（一份PDF对应一个合同提取任务）",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行合同智能提取的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ResourceIds",
          "type": "array",
          "required": true,
          "description": "合同智能提取的PDF文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。 注: `目前，此接口仅支持5个文件发起。每个文件限制在10M以下`",
          "example": "[\"yDRS4UUgygqdcj56UuO4zjExBQcOiB68\",\"yDRS4UUgygqdcj5pUuO4zjEu602GFIe6\"]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "FieldTemplateId",
          "type": "string",
          "required": false,
          "description": "用户配置的合同智能提取字段模板ID，会基于此模板批量创建合同智能提取任务，为32位字符串。 [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/99008608577532423ea437c7fdbedca1.png) 注: `此配置优先级最高，设置了模板ID后Fields配置就会无效`",
          "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
        },
        {
          "name": "Fields",
          "type": "array",
          "required": false,
          "description": "用于合同智能提取的字段信息。 注意：`字段模板优先级最高，如果设置了FieldTemplateId值，此配置就无效`",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "用于合同智能提取的字段名称。 注意: `长度不能超过30个字符`",
              "example": "甲方"
            },
            {
              "name": "Type",
              "type": "string",
              "required": true,
              "description": "指定合同智能提取的字段类型，目前仅支持`TEXT`、`DATE`、`NUMBER`、`OPTION`类型。 类型支持如下： 1、TEXT（文本） 2、DATE（日期） 3、NUMBER（数字） 4、OPTION（选项值）",
              "example": "TEXT"
            },
            {
              "name": "Description",
              "type": "string",
              "required": false,
              "description": "用于描述字段信息。 注意： 1、描述字段不能超过100个字符",
              "example": "字段描述"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "提取出合同中的字段信息。",
              "example": "[\"张三\"]",
              "item_type": "string"
            },
            {
              "name": "ChoiceList",
              "type": "array",
              "required": false,
              "description": "当字段类型`Type`为OPTION时为必输项，输入选项值",
              "example": "[\"选项值1\"]",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "ResourceIds"
      ]
    },
    {
      "name": "CreateBatchInitOrganizationUrl",
      "description": "支持企业进行批量初始化操作： 此接口存在以下限制： 1. 若批量操作中包含加入集团企业操作,则调用此接口的员工须有集团企业管理权限。 2. 批量操作的企业需要已经完成电子签的认证流程。 3. 通过此接口生成的链接在小程序端进行操作时，操作人需要是所有企业的超管或法人。 4. 批量操作的企业，需要是通过平台方引导认证的企业。 5. 操作链接过期时间默认为生成链接\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "OperateTypes",
          "type": "array",
          "required": true,
          "description": "初始化操作类型 CREATE_SEAL : 创建印章 AUTH_JOIN_ORGANIZATION_GROUP : 加入集团企业 OPEN_AUTO_SIGN :开通企业自动签署 PARTNER_AUTO_SIGN_AUTH :合作方企业授权自动签 CHANGE_SUB_ORGANIZATION_ADMIN_AUTH :变更子企业超管授权(**授权后，主企业可变更子企业超管，此功能需联系客户经理开通白名单使用**)",
          "example": "[\"CREATE_SEAL \"]",
          "item_type": "string"
        },
        {
          "name": "OrganizationIds",
          "type": "array",
          "required": true,
          "description": "批量操作的企业Id列表，最大支持50个",
          "example": "[\"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "AuthorizedOrganizationId",
          "type": "string",
          "required": false,
          "description": "被授权的合作方企业在电子签的企业电子签账号，当操作类型包含 PARTNER_AUTO_SIGN_AUTH （合作方企业授权自动签）时必传。 企业电子签账号可在[电子签的网页端](https://qian.tencent.com/console/company-settings/company-center) ，于企业设置-企业信息菜单栏下复制获取。 ![企业电子签账号](https://qcloudimg.tencent-cloud.cn/raw/4e6b30ee92f00671f7f1c5bd127c27db.png)",
          "example": "yDt1JUUckp77a2tqUyEmko8RVpCEHoNA"
        },
        {
          "name": "ChangeAdminAuthAutoSign",
          "type": "boolean",
          "required": false,
          "description": "初始化操作类型里含有CHANGE_SUB_ORGANIZATION_ADMIN_AUTH（变更子企业超管授权）操作类型时，授权协议中主企业的签署方是否使用自动签（需操作人有自动签授权）",
          "example": "true"
        }
      ],
      "required": [
        "Operator",
        "OperateTypes",
        "OrganizationIds"
      ]
    },
    {
      "name": "CreateBatchOrganizationAuthorizationUrl",
      "description": "此接口用于获取企业批量认证链接-单链接包含多条认证流。 前提条件：已调用 [CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks) 和[查询企业批量认证链接DescribeBatchOrganizationRegistrationUrls](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls) 确保认证任务已经...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "AdminName",
          "type": "string",
          "required": true,
          "description": "组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。 此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminName 保持一致。",
          "example": "典子谦"
        },
        {
          "name": "AdminMobile",
          "type": "string",
          "required": true,
          "description": "组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 Admin Mobile保持一致。",
          "example": "1320****000"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "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/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。",
          "example": "ID_CARD"
        },
        {
          "name": "AdminIdCardNumber",
          "type": "string",
          "required": false,
          "description": "组织机构超管证件号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/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": [
        "Operator",
        "AdminName",
        "AdminMobile"
      ]
    },
    {
      "name": "CreateBatchOrganizationRegistrationTasks",
      "description": "本接口（CreateBatchOrganizationRegistrationTasks）用于批量创建企业认证链接 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用. 批量创建链接有以下限制： 1. 单次最多创建10个企业。 2. 一天同一家企业最多创建8000家企业。 3. 同一批创建的企业不能重复 其中包括 企业名称，企业统一信用代码 4. 跳转到小程序的实现，参考微信官方文\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "RegistrationOrganizations",
          "type": "array",
          "required": true,
          "description": "组织机构注册信息。 一次最多支持10条认证流",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "OrganizationName",
              "type": "string",
              "required": true,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
              "example": "张三示例企业"
            },
            {
              "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": "组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。 如果法人做为超管管理组织机构,超管姓名就是法人姓名 如果入参中传递超管授权书PowerOfAttorneys，则此参数为必填参数。",
              "example": "张三"
            },
            {
              "name": "AdminMobile",
              "type": "string",
              "required": false,
              "description": "组织机构超管手机号。 在注册流程中，这个手机号必须跟操作人在电子签注册的个人手机号一致。 如果入参中传递超管授权书PowerOfAttorneys，则此参数为必填参数",
              "example": "18888888888"
            },
            {
              "name": "AuthorizationTypes",
              "type": "array",
              "required": false,
              "description": "可选的此企业允许的授权方式, 可以设置的方式有: 1：上传授权书 2：法人授权超管 5：授权书+对公打款 注: `1. 当前仅支持一种认证方式` `2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款` `3. 如果当前操作人是法人,则是法人认证`",
              "example": "[1]",
              "item_type": "integer"
            },
            {
              "name": "AdminIdCardNumber",
              "type": "string",
              "required": false,
              "description": "认证人身份证号，如果入参中传递超管授权书PowerOfAttorneys，则此参数为必填参数",
              "example": "37000019890303000X"
            },
            {
              "name": "AdminIdCardType",
              "type": "string",
              "required": false,
              "description": "认证人证件类型 支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "BusinessLicense",
              "type": "string",
              "required": false,
              "description": "营业执照正面照(PNG或JPG) base64格式, 大小不超过5M",
              "example": "6JCl5Lia5omn54Wn5q2j6Z2i54Wn"
            },
            {
              "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": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "要生成链接的类型, 可以选择的值如下: (默认)PC: 生成PC端的链接 SHORT_URL: H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 APP：生成小程序跳转链接 H5：生成H5跳转长链接 SHORT_H5：生成H5跳转短链",
          "example": "PC"
        },
        {
          "name": "BatchAuthMethod",
          "type": "integer",
          "required": false,
          "description": "认证链接使用单链接还是多链接模式 0 - 多链接(默认)，指批量生成链接， 每一个企业会拥有一个认证链接，然后分别认证 1 - 单链接 ， 指批量生成链接，然后会将多个链接聚合成一个链接，进行认证 p.s. 请注意， 如果使用单链接的模式并且认证方式是授权书方式的时候，必须在接口中传递超管授权书。",
          "example": "0"
        }
      ],
      "required": [
        "Operator",
        "RegistrationOrganizations"
      ]
    },
    {
      "name": "CreateBatchQuickSignUrl",
      "description": "该接口用于发起合同后，生成个人/企业用户的批量待办链接。 **注意：** 1. 该接口可生成签署人的批量、合同组签署/查看链接 。 2. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。 3. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。 跳转到小程序的实现，参考微信官方文档(分为全屏\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "FlowApproverInfo",
          "type": "object",
          "required": true,
          "description": "批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。 若为个人参与方：ApproverType=1 若为企业参与方：ApproverType=0。同时 OrganizationName 参数需传入参与方企业名称。 注: `1. 暂不支持签署人拖动签署控件功能，以及签批控件。` `2. 当需要通过短信验证码签署时，手机号Appr...",
          "example": "无",
          "children": [
            {
              "name": "ApproverType",
              "type": "integer",
              "required": true,
              "description": "在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下： 0 :企业B端。 1 :个人C端。 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。",
              "example": "1"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`",
              "example": "张三示例企业"
            },
            {
              "name": "ApproverName",
              "type": "string",
              "required": false,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 在未指定签署人电子签UserId情况下，为必填参数",
              "example": "张三"
            },
            {
              "name": "ApproverMobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。 注：`在未指定签署人电子签UserId情况下，为必填参数`",
              "example": "18888888888"
            },
            {
              "name": "ApproverIdCardType",
              "type": "string",
              "required": false,
              "description": "证件类型，支持以下类型 ID_CARD: 居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "ApproverIdCardNumber",
              "type": "string",
              "required": false,
              "description": "证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            },
            {
              "name": "RecipientId",
              "type": "string",
              "required": false,
              "description": "签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。 模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。 文件发起合同时，该参数无需传值。 如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "VerifyChannel",
              "type": "array",
              "required": false,
              "description": "签署意愿确认渠道，默认为WEIXINAPP:人脸识别 注: 不再使用, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`",
              "example": "[\"WEIXINAPP\"]",
              "item_type": "string"
            },
            {
              "name": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知 注: `既是发起方又是签署方时，不给此签署方发送短信`",
              "example": "none"
            },
            {
              "name": "IsFullText",
              "type": "boolean",
              "required": false,
              "description": "合同强制需要阅读全文，无需传此参数",
              "example": "true"
            },
            {
              "name": "PreReadTime",
              "type": "integer",
              "required": false,
              "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
              "example": "3"
            },
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得 注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "name": "Required",
              "type": "boolean",
              "required": false,
              "description": "字段不再使用，当前只支持true，默认为true",
              "example": "true"
            },
            {
              "name": "ApproverSource",
              "type": "string",
              "required": false,
              "description": "在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。",
              "example": "WEWORKAPP"
            },
            {
              "name": "CustomApproverTag",
              "type": "string",
              "required": false,
              "description": "在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。 所有参与或签的人员均需具备该标识。 注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。 如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。",
              "example": "n9527"
            },
            {
              "name": "RegisterInfo",
              "type": "object",
              "required": false,
              "description": "快速注册相关信息",
              "example": "无",
              "children": [
                {
                  "name": "LegalName",
                  "type": "string",
                  "required": true,
                  "description": "法人姓名",
                  "example": "张三"
                },
                {
                  "name": "UnifiedSocialCreditCode",
                  "type": "string",
                  "required": false,
                  "description": "社会统一信用代码",
                  "example": "91110108772551611J"
                },
                {
                  "name": "OrganizationAddress",
                  "type": "string",
                  "required": false,
                  "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
                  "example": "深圳市南山区高新区科技中一路腾讯大厦"
                },
                {
                  "name": "AuthorizationTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 2: 法人授权方式 5: 授权书+对公打款方式",
                  "example": "[2,5]",
                  "item_type": "integer"
                },
                {
                  "name": "AuthorizationMethods",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 1: 上传营业执照 2: 腾讯云快速认证 3: 腾讯商户号授权（仅支持小程序端）",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "OrganizationIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "企业证照类型： USCC :(默认)工商组织营业执照 PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证 CLINICFILLINGCERTIFICATE:诊所备案证",
                  "example": "USCC"
                },
                {
                  "name": "RegisterInfoOption",
                  "type": "object",
                  "required": false,
                  "description": "企业创建时候的个性化参数。 其中，包括一下内容： LegalNameSame 是否可以编辑法人。 UnifiedSocialCreditCodeSame 是否可以编辑证件号码。 OrganizationIdCardTypeSame 是否可以更改证照类型。",
                  "example": "无",
                  "children": [
                    {
                      "name": "LegalNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的法人姓名。 true：允许编辑false：不允许编辑（默认值） 注意： RegisterInfo 中的LegalName值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "UnifiedSocialCreditCodeCNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时统一社会信用代码。 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的UnifiedSocialCreditCode值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "OrganizationIdCardTypeSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的证照类型 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的OrganizationIdCardType值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    }
                  ]
                }
              ]
            },
            {
              "name": "ApproverOption",
              "type": "object",
              "required": false,
              "description": "签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。",
              "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": "CanEditApprover",
                  "type": "boolean",
                  "required": false,
                  "description": "允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑",
                  "example": "true"
                },
                {
                  "name": "FillType",
                  "type": "integer",
                  "required": false,
                  "description": "签署人信息补充类型，默认无需补充。 **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充` 注： 1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关` 2. 此参数在嵌入式场景下无效。",
                  "example": "1"
                },
                {
                  "name": "FlowReadLimit",
                  "type": "string",
                  "required": false,
                  "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                  "example": "LimitReadTimeAndBottom"
                },
                {
                  "name": "ForbidAddSignDate",
                  "type": "boolean",
                  "required": false,
                  "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "SignId",
              "type": "string",
              "required": false,
              "description": "签署人的签署ID 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。",
              "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN"
            },
            {
              "name": "ApproverNeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "此签署人(员工或者个人)签署时，是否需要发起方企业审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业通知腾讯电...",
              "example": "true"
            },
            {
              "name": "SignComponents",
              "type": "array",
              "required": false,
              "description": "签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效 合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件 `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效 合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 动态表格等填写控件 `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "ComponentLimitType",
              "type": "array",
              "required": false,
              "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
              "example": "[\"HANDWRITE\"]",
              "item_type": "string"
            },
            {
              "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**：\ufffd\ufffd...",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "name": "SignTypeSelector",
              "type": "integer",
              "required": false,
              "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
              "example": "0"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
              "example": "1604912664"
            },
            {
              "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": "NotSaveContact",
              "type": "boolean",
              "required": false,
              "description": "是否不保存联系人 默认 false 保存联系人 true 不保存联系人 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。 如下图位置： ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)",
              "example": "false"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId(子企业的组织ID)为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "批量签署的合同流程ID数组。 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`",
          "example": "[\"yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH\"]",
          "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://jump.cn/jump"
        },
        {
          "name": "SignatureTypes",
          "type": "array",
          "required": false,
          "description": "指定批量签署合同的签名类型，可传递以下值： **0**：手写签名(默认) **1**：OCR楷体 **2**：姓名印章 **3**：图片印章 **4**：系统签名 **5**：长效手写签名（包含手写签名） 注： 默认情况下，签名类型为手写签名 您可以传递多种值，表示可用多种签名类型。 该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型...",
          "example": "[0, 1, 2, 3, 4, 5]",
          "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": "yDwJWUUcss36hUx8VMjPR4jOb5ugrMSx"
                }
              ]
            }
          ]
        },
        {
          "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": "CreateBatchSignUrl",
      "description": "通过此接口，可以创建小程序批量签署链接，个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。 注意事项： - 使用此接口生成链接，需要贵企业先开通 个人签署方仅校验手机号 功能。您可以在 【腾讯电子签网页端控制台】-\u003e【更多】-\u003e【高级签署能力】中找到该功能。 - 生成批量签署链接时，合同目标\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注： 请确保和合同中填入的一致。 在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。",
          "example": "张三"
        },
        {
          "name": "Mobile",
          "type": "string",
          "required": false,
          "description": "手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息\ufffd...",
          "example": "18888888888"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "IdCardType",
          "type": "string",
          "required": false,
          "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证) 注： 1. `请确保和合同中填入的一致`。 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂\ufffd...",
          "example": "ID_CARD"
        },
        {
          "name": "SignatureTypes",
          "type": "array",
          "required": false,
          "description": "指定批量签署合同的签名类型，可传递以下值：**0**：手写签名**1**：OCR楷体**2**：姓名印章**3**：图片印章**4**：系统签名**5**：长效手写签名（包含手写签名）注：不传值的情况则计算所有合同中个人签署区的签名类型，规则如下：1.如果所有合同中所有的个人签署区方式包含多种则是手写2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式（例如合同1有...",
          "example": "[0, 1, 2, 3, 4, 5]",
          "item_type": "integer"
        },
        {
          "name": "IdCardNumber",
          "type": "string",
          "required": false,
          "description": "证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。 注： 1. `请确保和合同中填入的一致...",
          "example": "37000019890303000X"
        },
        {
          "name": "NotifyType",
          "type": "string",
          "required": false,
          "description": "通知用户方式： **NONE** : 不通知（默认） **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）",
          "example": "SMS"
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "批量签署的合同流程ID数组，此参数必传。 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`",
          "example": "[\"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"]",
          "item_type": "string"
        },
        {
          "name": "OrganizationName",
          "type": "string",
          "required": false,
          "description": "目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。 注： 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
          "example": "张三示例企业"
        },
        {
          "name": "JumpToDetail",
          "type": "boolean",
          "required": false,
          "description": "是否直接跳转至合同内容页面进行签署 **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认) **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署",
          "example": "true"
        },
        {
          "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": "yDwJWUUcss36hUx8VMjPR4jOb5ugrMSx"
                }
              ]
            }
          ]
        },
        {
          "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": "true"
        },
        {
          "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": [
        "Operator"
      ]
    },
    {
      "name": "CreateContractComparisonTask",
      "description": "此接口（CreateContractComparisonTask）用于创建合同对比任务。 适用场景：对比两份合同中字段（如：金额、日期、甲方名称等）的内容差异。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行合同审查任务的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "OriginFileResourceId",
          "type": "string",
          "required": true,
          "description": "原版文件ID，对比基准的旧版本文件唯一标识，通过UploadFiles接口获取文件资源ID。",
          "example": "yD*******************Cj"
        },
        {
          "name": "DiffFileResourceId",
          "type": "string",
          "required": true,
          "description": "新版文件ID，与旧版进行对比的新版本文件唯一标识，通过UploadFiles接口获取文件资源ID。",
          "example": "yD*******************Ed"
        },
        {
          "name": "Comment",
          "type": "string",
          "required": false,
          "description": "对比任务备注，长度不能超过50个字符。",
          "example": "这是一项对比任务"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
          "example": "QmFzZTY0IEJhc2U2NCA"
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "标签列表，用户自定义的键值对（Key-Value），可绑定到资源上，用于资源的分类、管理和访问控制。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签键，最大长度不超过50字符。",
              "example": "Key"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": false,
              "description": "标签值，最大长度不超过50字符。",
              "example": "Value"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "OriginFileResourceId",
        "DiffFileResourceId"
      ]
    },
    {
      "name": "CreateContractDiffTaskWebUrl",
      "description": "接口（CreateContractDiffTaskWebUrl）用于创建合同对比的可嵌入web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。 注： 1. 对比仅支持pdf、word格式，限制大小为60M以下 2. 本接口生成的web页面暂不支持设置本企业嵌入式页面主题配置 未跳过上传确认的嵌入页面长相如下： ![image](https://qcloudimg.tencent-cloud.cn/raw/32f3526ad7152757202a7e4e760356db.jpg) 跳过上传确认的嵌入页面长\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "SkipFileUpload",
          "type": "boolean",
          "required": true,
          "description": "是否跳过文件上传确认页。 当该参数值为`false`时，`OriginalFileResourceId`和`DiffFileResourceId`参数不需要传值，需要在生成的web页面中上传对比文件； 当该参数值为`true`时，`OriginalFileResourceId`和`DiffFileResourceId`参数必填，生成的web页面将跳过上传页面显示对比结果。",
          "example": "false"
        },
        {
          "name": "OriginalFileResourceId",
          "type": "string",
          "required": false,
          "description": "需要对比的原合同文件资源ID，通过UploadFiles接口获取文件资源ID。",
          "example": "yDttXUUckpx90i17UxPpcHHE1VDpNJPW"
        },
        {
          "name": "DiffFileResourceId",
          "type": "string",
          "required": false,
          "description": "需要对比的新合同文件资源ID，通过UploadFiles接口获取文件资源ID。",
          "example": "yDttXUUckpx90i1xUxPpcHHyPdyqVErm"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
          "example": "QmFzZTY0IEJhc2U2NCA"
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "标签列表，用户自定义的键值对（Key-Value），可绑定到资源上，用于资源的分类、管理和访问控制。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签键，最大长度不超过50字符。",
              "example": "Key"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": false,
              "description": "标签值，最大长度不超过50字符。",
              "example": "Value"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "SkipFileUpload"
      ]
    },
    {
      "name": "CreateContractReviewChecklistWebUrl",
      "description": "此接口（CreateContractReviewChecklistWebUrl）用来创建新建审查要点清单web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。 适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。 注意: `如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateContractReviewWebUrl",
      "description": "此接口（CreateContractReviewWebUrl）用来创建合同审查web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。 适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。 注: 1. pdf、word格式限制大小为10M以下 2. 如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ResourceId",
          "type": "string",
          "required": false,
          "description": "需要审查的合同文件资源ID,可通过UploadFiles接口获取文件资源ID。 注: `目前，每个文件限制在10M以下，文件仅支持pdf、doc、docx格式`",
          "example": "yDttXUUckpx90i1xUxPpcHHyPdyqVErm"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
          "example": "QmFzZTY0IEJhc2U2NCA="
        },
        {
          "name": "Option",
          "type": "object",
          "required": false,
          "description": "个性化参数，用于控制页面展示内容",
          "example": "无",
          "children": [
            {
              "name": "DisableTemporaryStore",
              "type": "boolean",
              "required": false,
              "description": "禁用暂存。 默认 false，设置为 true 会隐藏界面上的临时保存按钮",
              "example": "false"
            },
            {
              "name": "DisableExport",
              "type": "boolean",
              "required": false,
              "description": "禁用导出。默认 false，设置为 true 会隐藏界面上的导出按钮",
              "example": "false"
            },
            {
              "name": "DisableReviewAgain",
              "type": "boolean",
              "required": false,
              "description": "禁用重新审查。默认 false，设置为 true 会隐藏界面上的重新审查按钮",
              "example": "false"
            },
            {
              "name": "DisableWxQrcode",
              "type": "boolean",
              "required": false,
              "description": "禁用二维码分享。默认 false，设置为 true 会隐藏界面上的分享二维码",
              "example": "false"
            }
          ]
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateConvertTaskApi",
      "description": "此接口（CreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。 前提条件：源文件已经通过 文件上传接口完成上传，并得到了源文件的资源Id。 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同 适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同 转换文件是一个耗时操作，若想查看转换任务是...",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceType",
          "type": "string",
          "required": true,
          "description": "需要进行转换的资源文件类型 支持的文件类型如下： doc docx xls xlsx jpg jpeg png html bmp txt",
          "example": "docx"
        },
        {
          "name": "ResourceName",
          "type": "string",
          "required": true,
          "description": "需要进行转换操作的文件资源名称，带资源后缀名。 注: `资源名称长度限制为256个字符`",
          "example": "员工劳动合同.docx"
        },
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "需要进行转换操作的文件资源Id，通过UploadFiles接口获取文件资源Id。 注: `目前，此接口仅支持单个文件进行转换。`",
          "example": "yDRSRUUgygj6qnyvUuO4zjE1vLuGdWjL"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "ResourceType",
        "ResourceName",
        "ResourceId"
      ]
    },
    {
      "name": "CreateDocument",
      "description": "创建签署流程电子文档 ### 调用流程 该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置创建签署流程和发起签署流程接口使用。具体逻辑可以参考下图: ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png) ### 填充模板中定义的填写控件 模板中配置的发起人填充控件可以通过本接口的**FormFields数组**字段填充。 **填充填写控件需\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "本合同的发起人，点击查看合同发起人展示的位置 注：支持填入集团子公司经办人 userId代发合同。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TemplateId",
          "type": "string",
          "required": true,
          "description": "用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/253071cc2f7becb063c7cf71b37b7861.png)",
          "example": "yDCj7UUckp4b4ga6UCJQtCwIZllHtJ6B"
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": false,
          "description": "合同流程ID，为32位字符串。 此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。",
          "example": "yDCVNUUckpw3nnnyUVScgTvSA1IaZgM7"
        },
        {
          "name": "FileNames",
          "type": "array",
          "required": false,
          "description": "文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。",
          "example": "[\"入职合同\"]",
          "item_type": "string"
        },
        {
          "name": "FormFields",
          "type": "array",
          "required": false,
          "description": "电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成 附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类\ufffd\ufffd...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ComponentValue",
              "type": "string",
              "required": true,
              "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日） 控件...",
              "example": "ComponentValue"
            },
            {
              "name": "ComponentId",
              "type": "string",
              "required": false,
              "description": "控件id，和ComponentName选择一项传入即可 点击查看在模板中找到控件ID的方式",
              "example": "componentId"
            },
            {
              "name": "ComponentName",
              "type": "string",
              "required": false,
              "description": "控件名字，最大长度不超过30字符，和ComponentId选择一项传入即可 点击查看在模板中找到控件名字的方式",
              "example": "ComponentName"
            }
          ]
        },
        {
          "name": "NeedPreview",
          "type": "boolean",
          "required": false,
          "description": "是否为预览模式，取值如下： **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。 **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无\ufffd\ufffd...",
          "example": "false"
        },
        {
          "name": "PreviewType",
          "type": "integer",
          "required": false,
          "description": "预览模式下产生的预览链接类型 **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 **1** :H5链接 ,点开后在浏览器中展示合同的样子。注: `1.此参数在NeedPreview 为true时有效`",
          "example": "0"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ClientToken",
          "type": "string",
          "required": false,
          "description": "该字段已不再使用",
          "example": "该字段已不再使用"
        }
      ],
      "required": [
        "Operator",
        "TemplateId"
      ]
    },
    {
      "name": "CreateDynamicFlowApprover",
      "description": "此接口（CreateDynamicFlowApprover）接口主要用于补充动态签署方2.0合同的签署方信息，包括但不限于名字、手机号和签署区域等信息。 **使用条件** - 在发起合同时，必须将OpenDynamicSignFlow参数设置为true，以确保合同以动态签署方2.0的方式处理，否则默认处理为普通合同。 - 此接口只能在合同处于非终态时调用。一旦合同进入终态（例如：过期、拒签或撤销），将无法通过此接口添...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串",
          "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN"
        },
        {
          "name": "Approvers",
          "type": "array",
          "required": true,
          "description": "合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ApproverType",
              "type": "integer",
              "required": true,
              "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **0**：企业 **1**：个人 **3**：企业静默签署 注：`类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。` **7**: 个人自动签署，适用于个人自动签场景。 注: `个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。`",
              "example": "0"
            },
            {
              "name": "ApproverName",
              "type": "string",
              "required": false,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "张三"
            },
            {
              "name": "ApproverMobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。",
              "example": "18888888888"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。",
              "example": "张三示例企业"
            },
            {
              "name": "SignComponents",
              "type": "array",
              "required": false,
              "description": "【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "ApproverIdCardType",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件类型，支持以下类型，样式可以参考常见个人证件类型介绍 ID_CARD 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证) OTHER_CARD_TYPE 其他证件 注: 1. 其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。 2. 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人至少\ufffd...",
              "example": "ID_CARD"
            },
            {
              "name": "ApproverIdCardNumber",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "350203180010069855"
            },
            {
              "name": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知 注意： `如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信`",
              "example": "sms"
            },
            {
              "name": "ApproverRole",
              "type": "integer",
              "required": false,
              "description": "收据场景设置签署人角色类型, 可以设置如下类型: **1** :收款人 **2** :开具人 **3** :见证人 注: `收据场景为白名单功能，使用前请联系对接的客户经理沟通。`",
              "example": "1"
            },
            {
              "name": "ApproverRoleName",
              "type": "string",
              "required": false,
              "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
              "example": "收款人"
            },
            {
              "name": "VerifyChannel",
              "type": "array",
              "required": false,
              "description": "【已不再使用】签署意愿确认渠道，默认为WEIXINAPP:人脸识别 注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置",
              "example": "[\"WEIXINAPP\"]",
              "item_type": "string"
            },
            {
              "name": "PreReadTime",
              "type": "integer",
              "required": false,
              "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
              "example": "3"
            },
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得 注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "name": "ApproverSource",
              "type": "string",
              "required": false,
              "description": "在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。",
              "example": "WEWORKAPP"
            },
            {
              "name": "CustomApproverTag",
              "type": "string",
              "required": false,
              "description": "在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。 所有参与或签的人员均需具备该标识。 注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。 如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。",
              "example": "n9527"
            },
            {
              "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": "CanEditApprover",
                  "type": "boolean",
                  "required": false,
                  "description": "允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑",
                  "example": "true"
                },
                {
                  "name": "FillType",
                  "type": "integer",
                  "required": false,
                  "description": "签署人信息补充类型，默认无需补充。 **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充` 注： 1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关` 2. 此参数在嵌入式场景下无效。",
                  "example": "1"
                },
                {
                  "name": "FlowReadLimit",
                  "type": "string",
                  "required": false,
                  "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                  "example": "LimitReadTimeAndBottom"
                },
                {
                  "name": "ForbidAddSignDate",
                  "type": "boolean",
                  "required": false,
                  "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：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**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才\ufffd\ufffd...",
              "example": "[1,2,3]",
              "item_type": "integer"
            },
            {
              "name": "ApproverNeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "此签署人（员工或者个人）签署前，是否需要发起方企业审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业通知腾\ufffd\ufffd...",
              "example": "false"
            },
            {
              "name": "AddSignComponentsLimits",
              "type": "array",
              "required": false,
              "description": "【在用文件发起合同场景下才有效】在调用[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅\ufffd\ufffd...",
              "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_PAGING_SEAL "
                },
                {
                  "name": "ComponentValue",
                  "type": "array",
                  "required": false,
                  "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 **注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署\ufffd\ufffd...",
                  "example": "OFFICIAL",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "SignInstructionContent",
              "type": "string",
              "required": false,
              "description": "签署须知：支持传入富文本，最长字数：500个中文字符",
              "example": "这个合同不能截图转发"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
              "example": "1705977064"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件) 注：`此参数仅...",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "SignEndpoints",
              "type": "array",
              "required": false,
              "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
              "example": "[\"link\"]",
              "item_type": "string"
            },
            {
              "name": "RegisterInfo",
              "type": "object",
              "required": false,
              "description": "快速注册相关信息",
              "example": "无",
              "children": [
                {
                  "name": "LegalName",
                  "type": "string",
                  "required": true,
                  "description": "法人姓名",
                  "example": "张三"
                },
                {
                  "name": "UnifiedSocialCreditCode",
                  "type": "string",
                  "required": false,
                  "description": "社会统一信用代码",
                  "example": "91110108772551611J"
                },
                {
                  "name": "OrganizationAddress",
                  "type": "string",
                  "required": false,
                  "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
                  "example": "深圳市南山区高新区科技中一路腾讯大厦"
                },
                {
                  "name": "AuthorizationTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 2: 法人授权方式 5: 授权书+对公打款方式",
                  "example": "[2,5]",
                  "item_type": "integer"
                },
                {
                  "name": "AuthorizationMethods",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 1: 上传营业执照 2: 腾讯云快速认证 3: 腾讯商户号授权（仅支持小程序端）",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "OrganizationIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "企业证照类型： USCC :(默认)工商组织营业执照 PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证 CLINICFILLINGCERTIFICATE:诊所备案证",
                  "example": "USCC"
                },
                {
                  "name": "RegisterInfoOption",
                  "type": "object",
                  "required": false,
                  "description": "企业创建时候的个性化参数。 其中，包括一下内容： LegalNameSame 是否可以编辑法人。 UnifiedSocialCreditCodeSame 是否可以编辑证件号码。 OrganizationIdCardTypeSame 是否可以更改证照类型。",
                  "example": "无",
                  "children": [
                    {
                      "name": "LegalNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的法人姓名。 true：允许编辑false：不允许编辑（默认值） 注意： RegisterInfo 中的LegalName值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "UnifiedSocialCreditCodeCNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时统一社会信用代码。 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的UnifiedSocialCreditCode值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "OrganizationIdCardTypeSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的证照类型 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的OrganizationIdCardType值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    }
                  ]
                }
              ]
            },
            {
              "name": "NotSaveContact",
              "type": "boolean",
              "required": false,
              "description": "是否不保存联系人 默认 false 保存联系人 true 不保存联系人 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。 如下图位置： ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)",
              "example": "false"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "AutoSignScene",
          "type": "string",
          "required": false,
          "description": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） **OTHER** : 通用场景注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        }
      ],
      "required": [
        "Operator",
        "FlowId",
        "Approvers"
      ]
    },
    {
      "name": "CreateEmbedWebUrl",
      "description": "本接口（CreateEmbedWebUrl）用于创建可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中），支持以下类型的Web链接创建： 1. 创建印章 2. 创建模板 3. 修改模板 4. 创建起草合同 5. 预览模板 6. 预览合同流程 预览模板的嵌入页面长相如下： ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png) 预览合同流程的嵌入页面长相如下： ![image](https://qcloudimg.t...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "EmbedType",
          "type": "string",
          "required": true,
          "description": "WEB嵌入资源类型，支持以下类型 CREATE_SEAL: 生成创建印章的嵌入页面 CREATE_TEMPLATE：生成创建模板的嵌入页面 MODIFY_TEMPLATE：生成编辑模板的嵌入页面 CREATE_CONTRACT_DRAFT_COOPEDIT：生成创建起草合同的嵌入页面 PREVIEW_TEMPLATE：生成预览模板的嵌入页面 PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面 PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面 EXTEND_SERVICE：生成高级签署能力的嵌入页面 P...",
          "example": "PREVIEW_FLOW"
        },
        {
          "name": "BusinessId",
          "type": "string",
          "required": false,
          "description": "WEB嵌入的业务资源ID 当EmbedType取值 为PREVIEW_SEAL_DETAIL，必填，取值为印章id。 为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)* 为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。 为CREATE_CONTRACT_DRAFT_COOPEDIT，非必填，取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/c...",
          "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Reviewer",
          "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": "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(创建模板)和EmbedType=CREATE_CONTRACT_DRAFT_COOPEDIT(创建起草合同)有效**，",
              "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"
            }
          ]
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "目前仅支持EmbedType=CREATE_TEMPLATE时传入 指定后，创建，编辑，删除模板时，回调都会携带该userData 支持的格式：json字符串的BASE64编码字符串 示例： json字符串：{\"ComeFrom\":\"xxx\"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9 eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式",
          "example": "eyJDb21lRnJvbSI6IuadpeiHqnh4eOWFrOWPuOeahOaooeeJiCJ9"
        }
      ],
      "required": [
        "Operator",
        "EmbedType"
      ]
    },
    {
      "name": "CreateEmployeeChangeUrl",
      "description": "生成员工信息变更链接，当前仅支持变更手机号 注: 1. 目前仅支持修改员工手机号，待修改员工必须已经实名且在职 2. 仅支持返回小程序链接",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "待修改的员工UserId",
          "example": "yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2"
        },
        {
          "name": "NewMobile",
          "type": "string",
          "required": false,
          "description": "待修改的员工手机号",
          "example": "13100001111"
        }
      ],
      "required": []
    },
    {
      "name": "CreateEmployeeQualificationSealQrCode",
      "description": "该接口用于获取个人授权执业章给企业的微信二维码，需要个人用户通过微信扫码。 扫描后将跳转到腾讯电子签小程序，进入到授权执业章的流程。 个人用户授权成功后，企业印章管理员需对印章进行审核，审核通过后，即可使用个人授权的执业章进行盖章操作。 **注意** 1. 该二维码**有效期为7天**，过期后将失效，可重新创建。 整体流程入下图 ![image](https://qcloudimg.tencent-clo...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "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": [
        "Operator"
      ]
    },
    {
      "name": "CreateExtendedServiceAuthInfos",
      "description": "创建企业扩展服务授权，当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口授权给企业员工。 注：“企业自动签授权”支持集团代子企业操作，请联系运营开通此功能。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "yD************oimj",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": true,
          "description": "本企业员工的id，需要已实名，正常在职员工",
          "example": "[\"yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH\"]",
          "item_type": "string"
        },
        {
          "name": "ExtendServiceType",
          "type": "string",
          "required": false,
          "description": "取值 OPEN_SERVER_SIGN：企业自动签 BATCH_SIGN：批量签署",
          "example": "OPEN_SERVER_SIGN"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "UserIds"
      ]
    },
    {
      "name": "CreateFileCounterSign",
      "description": "此接口用于发起数字文件CA加签操作。可以使用同步或者异步模式进行。 **注意： 1. 文件类型暂时仅支持PDF类型文件。2. 此接口为『数字文件CA加签服务』白名单功能，使用前请联系对接的客户经理沟通。**",
      "status": "online",
      "parameters": [
        {
          "name": "FileId",
          "type": "string",
          "required": true,
          "description": "需要加签的文件Id。 注: `暂时只支持pdf类型的文件`",
          "example": "yDtwRUUckp7f7e************qq28pI"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "SyncMode",
          "type": "boolean",
          "required": false,
          "description": "是否使用同步模式。 false:异步模式，返回taskId。需要使用taskId轮询结果查询接口。 true: 同步模式，此接口将直接返回taskId和ResultFileId(加签后文件id)。 注： 1. 当加签文件较大的时候，建议使用异步接口进行操作。否则文件加签时间过长会导致接口超时。",
          "example": "false"
        }
      ],
      "required": [
        "FileId"
      ]
    },
    {
      "name": "CreateFlow",
      "description": "通过模板创建签署流程 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。 签署人类别 需要提前准备的信息 自己企业的员工签署（未认证加入或已认证加入） 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 自己企业的员工签署（已认证加入） 签署\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "本合同的发起人，点击查看合同发起人展示的位置 注： 支持填入集团子公司经办人 userId 代发合同。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowName",
          "type": "string",
          "required": true,
          "description": "自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(\u0026)、（+）组成。 该名称还将用于合同签署完成后文件下载的默认文件名称。",
          "example": "张三的入职合同"
        },
        {
          "name": "Approvers",
          "type": "array",
          "required": true,
          "description": "合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。 注: 在发起流程时，需要保证 approver 中的顺序与模板定义顺序一致，否则会发起失败。 例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须\ufffd...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ApproverType",
              "type": "integer",
              "required": true,
              "description": "在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下： 0 :企业B端。 1 :个人C端。 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。",
              "example": "1"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`",
              "example": "张三示例企业"
            },
            {
              "name": "ApproverName",
              "type": "string",
              "required": false,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 在未指定签署人电子签UserId情况下，为必填参数",
              "example": "张三"
            },
            {
              "name": "ApproverMobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。 注：`在未指定签署人电子签UserId情况下，为必填参数`",
              "example": "18888888888"
            },
            {
              "name": "ApproverIdCardType",
              "type": "string",
              "required": false,
              "description": "证件类型，支持以下类型 ID_CARD: 居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "ApproverIdCardNumber",
              "type": "string",
              "required": false,
              "description": "证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            },
            {
              "name": "RecipientId",
              "type": "string",
              "required": false,
              "description": "签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。 模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。 文件发起合同时，该参数无需传值。 如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "VerifyChannel",
              "type": "array",
              "required": false,
              "description": "签署意愿确认渠道，默认为WEIXINAPP:人脸识别 注: 不再使用, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`",
              "example": "[\"WEIXINAPP\"]",
              "item_type": "string"
            },
            {
              "name": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知 注: `既是发起方又是签署方时，不给此签署方发送短信`",
              "example": "none"
            },
            {
              "name": "IsFullText",
              "type": "boolean",
              "required": false,
              "description": "合同强制需要阅读全文，无需传此参数",
              "example": "true"
            },
            {
              "name": "PreReadTime",
              "type": "integer",
              "required": false,
              "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
              "example": "3"
            },
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得 注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "name": "Required",
              "type": "boolean",
              "required": false,
              "description": "字段不再使用，当前只支持true，默认为true",
              "example": "true"
            },
            {
              "name": "ApproverSource",
              "type": "string",
              "required": false,
              "description": "在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。",
              "example": "WEWORKAPP"
            },
            {
              "name": "CustomApproverTag",
              "type": "string",
              "required": false,
              "description": "在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。 所有参与或签的人员均需具备该标识。 注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。 如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。",
              "example": "n9527"
            },
            {
              "name": "RegisterInfo",
              "type": "object",
              "required": false,
              "description": "快速注册相关信息",
              "example": "无",
              "children": [
                {
                  "name": "LegalName",
                  "type": "string",
                  "required": true,
                  "description": "法人姓名",
                  "example": "张三"
                },
                {
                  "name": "UnifiedSocialCreditCode",
                  "type": "string",
                  "required": false,
                  "description": "社会统一信用代码",
                  "example": "91110108772551611J"
                },
                {
                  "name": "OrganizationAddress",
                  "type": "string",
                  "required": false,
                  "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
                  "example": "深圳市南山区高新区科技中一路腾讯大厦"
                },
                {
                  "name": "AuthorizationTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 2: 法人授权方式 5: 授权书+对公打款方式",
                  "example": "[2,5]",
                  "item_type": "integer"
                },
                {
                  "name": "AuthorizationMethods",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 1: 上传营业执照 2: 腾讯云快速认证 3: 腾讯商户号授权（仅支持小程序端）",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "OrganizationIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "企业证照类型： USCC :(默认)工商组织营业执照 PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证 CLINICFILLINGCERTIFICATE:诊所备案证",
                  "example": "USCC"
                },
                {
                  "name": "RegisterInfoOption",
                  "type": "object",
                  "required": false,
                  "description": "企业创建时候的个性化参数。 其中，包括一下内容： LegalNameSame 是否可以编辑法人。 UnifiedSocialCreditCodeSame 是否可以编辑证件号码。 OrganizationIdCardTypeSame 是否可以更改证照类型。",
                  "example": "无",
                  "children": [
                    {
                      "name": "LegalNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的法人姓名。 true：允许编辑false：不允许编辑（默认值） 注意： RegisterInfo 中的LegalName值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "UnifiedSocialCreditCodeCNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时统一社会信用代码。 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的UnifiedSocialCreditCode值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "OrganizationIdCardTypeSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的证照类型 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的OrganizationIdCardType值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    }
                  ]
                }
              ]
            },
            {
              "name": "ApproverOption",
              "type": "object",
              "required": false,
              "description": "签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。",
              "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": "CanEditApprover",
                  "type": "boolean",
                  "required": false,
                  "description": "允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑",
                  "example": "true"
                },
                {
                  "name": "FillType",
                  "type": "integer",
                  "required": false,
                  "description": "签署人信息补充类型，默认无需补充。 **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充` 注： 1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关` 2. 此参数在嵌入式场景下无效。",
                  "example": "1"
                },
                {
                  "name": "FlowReadLimit",
                  "type": "string",
                  "required": false,
                  "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                  "example": "LimitReadTimeAndBottom"
                },
                {
                  "name": "ForbidAddSignDate",
                  "type": "boolean",
                  "required": false,
                  "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "SignId",
              "type": "string",
              "required": false,
              "description": "签署人的签署ID 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。",
              "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN"
            },
            {
              "name": "ApproverNeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "此签署人(员工或者个人)签署时，是否需要发起方企业审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业通知腾讯电...",
              "example": "true"
            },
            {
              "name": "SignComponents",
              "type": "array",
              "required": false,
              "description": "签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效 合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件 `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效 合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 动态表格等填写控件 `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "ComponentLimitType",
              "type": "array",
              "required": false,
              "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
              "example": "[\"HANDWRITE\"]",
              "item_type": "string"
            },
            {
              "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**：\ufffd\ufffd...",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "name": "SignTypeSelector",
              "type": "integer",
              "required": false,
              "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
              "example": "0"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
              "example": "1604912664"
            },
            {
              "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": "NotSaveContact",
              "type": "boolean",
              "required": false,
              "description": "是否不保存联系人 默认 false 保存联系人 true 不保存联系人 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。 如下图位置： ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)",
              "example": "false"
            }
          ]
        },
        {
          "name": "FlowDescription",
          "type": "string",
          "required": false,
          "description": "合同流程描述信息(可自定义此描述)，最大长度1000个字符。",
          "example": "2025年张三劳务合同"
        },
        {
          "name": "FlowType",
          "type": "string",
          "required": false,
          "description": "合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。 此合同类型需要跟模板配置的合同类型保持一致。",
          "example": "劳务合同"
        },
        {
          "name": "ClientToken",
          "type": "string",
          "required": false,
          "description": "该字段已不再使用",
          "example": "该字段已不再使用"
        },
        {
          "name": "DeadLine",
          "type": "integer",
          "required": false,
          "description": "合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。",
          "example": "1604912664"
        },
        {
          "name": "RemindedOn",
          "type": "integer",
          "required": false,
          "description": "合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。 到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。",
          "example": "1604912664"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64格式编码，支持的最大数据大小为 20480长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
          "example": "55So5oi355qE5pWw5o2u"
        },
        {
          "name": "Unordered",
          "type": "boolean",
          "required": false,
          "description": "合同流程的签署顺序类型： **false**：(默认)有序签署, 本合同多个参与人需要依次签署 **true**：无序签署, 本合同多个参与人没有先后签署限制 注：`请和模板中的配置保持一致`",
          "example": "true"
        },
        {
          "name": "CustomShowMap",
          "type": "string",
          "required": false,
          "description": "您可以自定义**腾讯电子签小程序合同列表页**展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。 例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署\ufffd\ufffd...",
          "example": "合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬！;净重: 100吨;品类: 铁矿石"
        },
        {
          "name": "NeedSignReview",
          "type": "boolean",
          "required": false,
          "description": "发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业\ufffd\ufffd...",
          "example": "true"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "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": "1320****000"
            },
            {
              "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": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知",
              "example": "sms"
            }
          ]
        },
        {
          "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": "Workflow",
          "type": "boolean",
          "required": false,
          "description": "是否开启发起合同审批，默认：false（不开启），开启后，发起合同（StartFlow），会提交电子签内置的审批流",
          "example": "true"
        }
      ],
      "required": [
        "Operator",
        "FlowName",
        "Approvers"
      ]
    },
    {
      "name": "CreateFlowApprovers",
      "description": "**适用场景 ：** 当通过模板或文件发起合同时， 签署人不制定， 等合同发起后再指定 可以用下面2种方案 1. 或签合同: 若未指定企业签署人信息（只指定企业的名字），合同变成或签合同（个人签署方不支持或签合同）。需调用此接口补充或添加签署人。或签签署人在控制台上的展示样式如下（会带有或签标识）： ![image](https://qcloudimg.tencent-cloud.cn/raw/b2715f0236faee807cfc0521f93cf01b....",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Approvers",
          "type": "array",
          "required": true,
          "description": "补充签署环节签署候选人信息。 注：` 如果发起方指定的补充签署人是企业微信签署人（ApproverSource=WEWORKAPP），则需要提供企业微信UserId进行补充； 如果不指定，则使用姓名和手机号进行补充。`",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "RecipientId",
              "type": "string",
              "required": true,
              "description": "签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。 模板发起合同时，该参数为必填项。 文件发起合同时，该参数无需传值。 如果开发者后序用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。",
              "example": "yDwhSUUckp3lqxlpUu6Ni3SvjJPoxxxx"
            },
            {
              "name": "ApproverSource",
              "type": "string",
              "required": false,
              "description": "签署人来源 WEWORKAPP: 企业微信 仅【企微或签】时指定WEWORKAPP",
              "example": "WEWORKAPP"
            },
            {
              "name": "CustomUserId",
              "type": "string",
              "required": false,
              "description": "企业微信UserId 当ApproverSource为WEWORKAPP的企微或签场景下，必须指企业自有应用获取企业微信的UserId",
              "example": "zhangsan"
            },
            {
              "name": "ApproverName",
              "type": "string",
              "required": false,
              "description": "企业签署人的员工姓名。除企业微信应用场景（ApproverSource设置为WEWORKAPP）外，本字段为必填。",
              "example": "张三"
            },
            {
              "name": "ApproverMobile",
              "type": "string",
              "required": false,
              "description": "补充企业签署人员工手机号 ApproverSource!=WEWORKAPP时，必传",
              "example": "18800000000"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "补充企业动态签署人时，需要指定对应企业名称",
              "example": "张三示例企业"
            },
            {
              "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": "37000019890303000X"
            },
            {
              "name": "FlowId",
              "type": "string",
              "required": false,
              "description": "合同流程ID - 补充合同组子合同动态签署人时必传。 - 补充普通合同时，请阅读：补充签署人接口的接口使用说明",
              "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
            },
            {
              "name": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知类型： 当FillApproverType =0，或签场景补充签署人时，指定是否发送或签领取短信 SMS：开启或签领取短信通知 NONE：关闭或签领取短信通知 当NotifyType=NONE时，可调用获取跳转至腾讯电子签小程序的签署链接接口生成签署链接来完成或签领取",
              "example": "SMS"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": false,
          "description": "合同流程ID，为32位字符串。 - 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 - 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。 - 不建议继续使用，请使用补充签署人结构体中的FlowId来指定需要补充的合同id",
          "example": "yDtwLUUckp79ltk3UETpdnTykAcZdrFZ"
        },
        {
          "name": "FillApproverType",
          "type": "integer",
          "required": false,
          "description": "签署人信息补充方式 **0**: 或签合同添加签署候选人，或签支持一个节点传多个签署人，不传值默认或签。 注: `或签只支持企业签署方` **1**: 动态签署人合同的添加签署候选人，支持企业或个人签署方。",
          "example": "0"
        },
        {
          "name": "Initiator",
          "type": "string",
          "required": false,
          "description": "在可定制的企业微信通知中，发起人可以根据具体需求进行自定义设置。",
          "example": "总部集团"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": false,
          "description": "合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值",
          "example": "yDR1AUUgygjazuesUuO4zjESPW4PkfNi"
        }
      ],
      "required": [
        "Operator",
        "Approvers"
      ]
    },
    {
      "name": "CreateFlowBlockchainEvidenceUrl",
      "description": "获取区块链存证证书查看链接/二维码接口 适用场景：企业员工可以通过此接口生成合同区块链存证证书的查看链接/二维码，以供他人扫码打开腾讯电子签小程序查看。 [点击查看区块链存证证书样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg) 注： 1. 二维码下载链接过期时间为5分钟，请尽快下载保存。二维码/短链的过期时间为7天，超过有效期则不可用。 2. 合...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
          "example": "yDt1JUUckp77a2tqUyEmko8RVpCEHoNA"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ExpiredOn",
          "type": "integer",
          "required": false,
          "description": "链接/二维码的有效截止时间，格式为unix时间戳。最长不超过 2099年12月31日（4102415999）。 默认值为有效期为当前时间后7天。",
          "example": "1736751627"
        }
      ],
      "required": [
        "Operator",
        "FlowId"
      ]
    },
    {
      "name": "CreateFlowByFiles",
      "description": "此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。 适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。 签署人类别 需要提前准备的信息 自己企业的员工签署（未认证加入或已认证加入） 签署企业的名字、员工的真实名字、员工的触达手机号、员工的\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "本合同的发起人 点击查看合同发起人展示的位置 注： 支持填入集团子公司经办人 userId 代发合同。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowName",
          "type": "string",
          "required": true,
          "description": "自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(\u0026)、（+）组成。 该名称还将用于合同签署完成后文件下载的默认文件名称。",
          "example": "2013年采购西红柿合同"
        },
        {
          "name": "FileIds",
          "type": "array",
          "required": true,
          "description": "本合同流程需包含的PDF文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。 注: `目前，此接口仅支持单个文件发起。`",
          "example": "[\"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\"]",
          "item_type": "string"
        },
        {
          "name": "Approvers",
          "type": "array",
          "required": false,
          "description": "合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。 如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ApproverType",
              "type": "integer",
              "required": true,
              "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **0**：企业 **1**：个人 **3**：企业静默签署 注：`类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。` **7**: 个人自动签署，适用于个人自动签场景。 注: `个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。`",
              "example": "0"
            },
            {
              "name": "ApproverName",
              "type": "string",
              "required": false,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "张三"
            },
            {
              "name": "ApproverMobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。",
              "example": "18888888888"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。",
              "example": "张三示例企业"
            },
            {
              "name": "SignComponents",
              "type": "array",
              "required": false,
              "description": "【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "ApproverIdCardType",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件类型，支持以下类型，样式可以参考常见个人证件类型介绍 ID_CARD 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证) OTHER_CARD_TYPE 其他证件 注: 1. 其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。 2. 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人至少\ufffd...",
              "example": "ID_CARD"
            },
            {
              "name": "ApproverIdCardNumber",
              "type": "string",
              "required": false,
              "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "350203180010069855"
            },
            {
              "name": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知 注意： `如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信`",
              "example": "sms"
            },
            {
              "name": "ApproverRole",
              "type": "integer",
              "required": false,
              "description": "收据场景设置签署人角色类型, 可以设置如下类型: **1** :收款人 **2** :开具人 **3** :见证人 注: `收据场景为白名单功能，使用前请联系对接的客户经理沟通。`",
              "example": "1"
            },
            {
              "name": "ApproverRoleName",
              "type": "string",
              "required": false,
              "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
              "example": "收款人"
            },
            {
              "name": "VerifyChannel",
              "type": "array",
              "required": false,
              "description": "【已不再使用】签署意愿确认渠道，默认为WEIXINAPP:人脸识别 注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置",
              "example": "[\"WEIXINAPP\"]",
              "item_type": "string"
            },
            {
              "name": "PreReadTime",
              "type": "integer",
              "required": false,
              "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
              "example": "3"
            },
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得 注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "name": "ApproverSource",
              "type": "string",
              "required": false,
              "description": "在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。",
              "example": "WEWORKAPP"
            },
            {
              "name": "CustomApproverTag",
              "type": "string",
              "required": false,
              "description": "在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。 所有参与或签的人员均需具备该标识。 注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。 如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。",
              "example": "n9527"
            },
            {
              "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": "CanEditApprover",
                  "type": "boolean",
                  "required": false,
                  "description": "允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑",
                  "example": "true"
                },
                {
                  "name": "FillType",
                  "type": "integer",
                  "required": false,
                  "description": "签署人信息补充类型，默认无需补充。 **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充` 注： 1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关` 2. 此参数在嵌入式场景下无效。",
                  "example": "1"
                },
                {
                  "name": "FlowReadLimit",
                  "type": "string",
                  "required": false,
                  "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                  "example": "LimitReadTimeAndBottom"
                },
                {
                  "name": "ForbidAddSignDate",
                  "type": "boolean",
                  "required": false,
                  "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：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**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才\ufffd\ufffd...",
              "example": "[1,2,3]",
              "item_type": "integer"
            },
            {
              "name": "ApproverNeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "此签署人（员工或者个人）签署前，是否需要发起方企业审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业通知腾\ufffd\ufffd...",
              "example": "false"
            },
            {
              "name": "AddSignComponentsLimits",
              "type": "array",
              "required": false,
              "description": "【在用文件发起合同场景下才有效】在调用[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅\ufffd\ufffd...",
              "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_PAGING_SEAL "
                },
                {
                  "name": "ComponentValue",
                  "type": "array",
                  "required": false,
                  "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 **注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署\ufffd\ufffd...",
                  "example": "OFFICIAL",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "SignInstructionContent",
              "type": "string",
              "required": false,
              "description": "签署须知：支持传入富文本，最长字数：500个中文字符",
              "example": "这个合同不能截图转发"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
              "example": "1705977064"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件) 注：`此参数仅...",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "SignEndpoints",
              "type": "array",
              "required": false,
              "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
              "example": "[\"link\"]",
              "item_type": "string"
            },
            {
              "name": "RegisterInfo",
              "type": "object",
              "required": false,
              "description": "快速注册相关信息",
              "example": "无",
              "children": [
                {
                  "name": "LegalName",
                  "type": "string",
                  "required": true,
                  "description": "法人姓名",
                  "example": "张三"
                },
                {
                  "name": "UnifiedSocialCreditCode",
                  "type": "string",
                  "required": false,
                  "description": "社会统一信用代码",
                  "example": "91110108772551611J"
                },
                {
                  "name": "OrganizationAddress",
                  "type": "string",
                  "required": false,
                  "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
                  "example": "深圳市南山区高新区科技中一路腾讯大厦"
                },
                {
                  "name": "AuthorizationTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 2: 法人授权方式 5: 授权书+对公打款方式",
                  "example": "[2,5]",
                  "item_type": "integer"
                },
                {
                  "name": "AuthorizationMethods",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 1: 上传营业执照 2: 腾讯云快速认证 3: 腾讯商户号授权（仅支持小程序端）",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "OrganizationIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "企业证照类型： USCC :(默认)工商组织营业执照 PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证 CLINICFILLINGCERTIFICATE:诊所备案证",
                  "example": "USCC"
                },
                {
                  "name": "RegisterInfoOption",
                  "type": "object",
                  "required": false,
                  "description": "企业创建时候的个性化参数。 其中，包括一下内容： LegalNameSame 是否可以编辑法人。 UnifiedSocialCreditCodeSame 是否可以编辑证件号码。 OrganizationIdCardTypeSame 是否可以更改证照类型。",
                  "example": "无",
                  "children": [
                    {
                      "name": "LegalNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的法人姓名。 true：允许编辑false：不允许编辑（默认值） 注意： RegisterInfo 中的LegalName值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "UnifiedSocialCreditCodeCNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时统一社会信用代码。 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的UnifiedSocialCreditCode值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "OrganizationIdCardTypeSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的证照类型 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的OrganizationIdCardType值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    }
                  ]
                }
              ]
            },
            {
              "name": "NotSaveContact",
              "type": "boolean",
              "required": false,
              "description": "是否不保存联系人 默认 false 保存联系人 true 不保存联系人 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。 如下图位置： ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)",
              "example": "false"
            }
          ]
        },
        {
          "name": "FlowDescription",
          "type": "string",
          "required": false,
          "description": "合同流程描述信息(可自定义此描述)，最大长度1000个字符。",
          "example": "2013年采购西红柿合同10吨"
        },
        {
          "name": "FlowType",
          "type": "string",
          "required": false,
          "description": "合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。 如果用户已经在控制台创建了自定义合同类型，可以将这里的类型名称传入。 如果没有创建，我们会自动给发起方公司创建此自定义合同类型。 ![image](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)",
          "example": "销售合同"
        },
        {
          "name": "Components",
          "type": "array",
          "required": false,
          "description": "发起的时候合成到PDF上的填写控件（需要提供填写控件的内容） 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 水印控件等 ![image](https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png)",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ComponentType",
              "type": "string",
              "required": true,
              "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": "ComponentHeight",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
              "example": "43.1"
            },
            {
              "name": "ComponentWidth",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
              "example": "119.1"
            },
            {
              "name": "ComponentPage",
              "type": "integer",
              "required": true,
              "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
              "example": "1"
            },
            {
              "name": "ComponentPosX",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
              "example": "100.1"
            },
            {
              "name": "ComponentPosY",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
              "example": "100.1"
            },
            {
              "name": "FileIndex",
              "type": "integer",
              "required": true,
              "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
              "example": "0"
            },
            {
              "name": "GenerateMode",
              "type": "string",
              "required": false,
              "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
              "example": "NORMAL"
            },
            {
              "name": "ComponentId",
              "type": "string",
              "required": false,
              "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
              "example": "ComponentId_01"
            },
            {
              "name": "ComponentName",
              "type": "string",
              "required": false,
              "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
              "example": "price"
            },
            {
              "name": "ComponentRequired",
              "type": "boolean",
              "required": false,
              "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
              "example": "true"
            },
            {
              "name": "ComponentRecipientId",
              "type": "string",
              "required": false,
              "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
              "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
            },
            {
              "name": "IsFormType",
              "type": "boolean",
              "required": false,
              "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
              "example": "false"
            },
            {
              "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_SE...",
              "example": "100元"
            },
            {
              "name": "OffsetX",
              "type": "float",
              "required": false,
              "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
              "example": "10.1"
            },
            {
              "name": "OffsetY",
              "type": "float",
              "required": false,
              "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
              "example": "10.1"
            },
            {
              "name": "KeywordOrder",
              "type": "string",
              "required": false,
              "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
              "example": "Positive\\Reverse"
            },
            {
              "name": "KeywordPage",
              "type": "integer",
              "required": false,
              "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
              "example": "1"
            },
            {
              "name": "RelativeLocation",
              "type": "string",
              "required": false,
              "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
              "example": "LowerRight"
            },
            {
              "name": "KeywordIndexes",
              "type": "array",
              "required": false,
              "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "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": "ComponentDateFontSize",
              "type": "integer",
              "required": false,
              "description": "【暂未使用】日期签署控件的字号，默认为 12",
              "example": "12"
            },
            {
              "name": "ChannelComponentId",
              "type": "string",
              "required": false,
              "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "ChannelComponentSource",
              "type": "integer",
              "required": false,
              "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
              "example": "0"
            }
          ]
        },
        {
          "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": "1320****000"
            },
            {
              "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": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知",
              "example": "sms"
            }
          ]
        },
        {
          "name": "CcNotifyType",
          "type": "integer",
          "required": false,
          "description": "可以设置以下时间节点来给抄送人发送短信通知来查看合同内容： **0**：合同发起时通知（默认值） **1**：签署完成后通知",
          "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"
        },
        {
          "name": "Deadline",
          "type": "integer",
          "required": false,
          "description": "合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。",
          "example": "1703061565"
        },
        {
          "name": "Unordered",
          "type": "boolean",
          "required": false,
          "description": "合同流程的签署顺序类型： **false**：(默认)有序签署, 本合同多个参与人需要依次签署 **true**：无序签署, 本合同多个参与人没有先后签署限制",
          "example": "true"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
          "example": "QmFzZTY0IEJhc2U2NCA="
        },
        {
          "name": "RemindedOn",
          "type": "integer",
          "required": false,
          "description": "合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。 到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。",
          "example": "1703061565"
        },
        {
          "name": "ApproverVerifyType",
          "type": "string",
          "required": false,
          "description": "指定个人签署方查看合同的校验方式 **VerifyCheck** :（默认）人脸识别,人脸识别后才能查看合同内容 **MobileCheck** : 手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）",
          "example": "MobileCheck"
        },
        {
          "name": "SignBeanTag",
          "type": "integer",
          "required": false,
          "description": "签署方签署控件（印章/签名等）的生成方式： **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。 **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。 注：签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5",
          "example": "0"
        },
        {
          "name": "CustomShowMap",
          "type": "string",
          "required": false,
          "description": "您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。 例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{\ufffd...",
          "example": "合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬！;净重: 100吨;品类: 铁矿石"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "AutoSignScene",
          "type": "string",
          "required": false,
          "description": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） **OTHER** : 通用场景 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        },
        {
          "name": "NeedSignReview",
          "type": "boolean",
          "required": false,
          "description": "发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业\ufffd\ufffd...",
          "example": "true"
        },
        {
          "name": "FlowDisplayType",
          "type": "integer",
          "required": false,
          "description": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)",
          "example": "1"
        },
        {
          "name": "OpenDynamicSignFlow",
          "type": "boolean",
          "required": false,
          "description": "是否开启动态签署合同： **true**：开启动态签署合同，可在发起时可以不传签署人，在签署过程中追加签署人（必须满足：1，发起方企业开启了模块化计费能力；2，发起方企业在企业应用管理中开启了动态签署人2.0能力） 。 **false**：不开启动态签署合同。",
          "example": "true"
        },
        {
          "name": "Workflow",
          "type": "boolean",
          "required": false,
          "description": "是否开启发起合同审批，默认：false（不开启），开启后，发起合同（StartFlow），会提交电子签内置的审批流",
          "example": "true"
        }
      ],
      "required": [
        "Operator",
        "FlowName",
        "FileIds"
      ]
    },
    {
      "name": "CreateFlowEvidenceReport",
      "description": "提交申请出证报告任务并返回报告ID。 出证报告的示例样式可以参考 [出证报告.PDF](https://qcloudimg.tencent-cloud.cn/raw/a55214fcddaebbd1582cc9c57cc6cf1b.pdf) 注意： 使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。 操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。 合同流程必须所有参与方`已经签署完成`。 出证过程需一定时间，建议在`提交出证任\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
          "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ReportType",
          "type": "integer",
          "required": false,
          "description": "指定申请的报告类型，可选类型如下： **0** :合同签署报告（默认） **1** :公证处核验报告",
          "example": "0"
        },
        {
          "name": "HybridEvidenceFlowFile",
          "type": "boolean",
          "required": false,
          "description": "混合云模式获取合同文件合并出证，默认：不同意。注：此参数需要联系腾讯电子签运营进行开通后生效",
          "example": "false"
        }
      ],
      "required": [
        "Operator",
        "FlowId"
      ]
    },
    {
      "name": "CreateFlowForwards",
      "description": "该接口用于将合同中本企业当前经办人转为本企业其他员工进行操作。 注意： 1. 转交的目标经办人需要已经加入企业，且完成实名。 2. 仅企业拥有`超管`、`法人`或者`合同管理员`角色的员工才有调用本接口的权限。如果使用主带子方式调用，请确保您已经加入子企业，且账号在子企业中担任任一上述角色。 3. 仅支持当前经办人为待签署或待填写状态时进行转交操作。 4. 若原...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TargetUserId",
          "type": "string",
          "required": true,
          "description": "合同对应参与方需要修改的目标经办人。其UserId可在企业控制台中组织管理里面找到。或者使用获取员工信息接口得到。 注意：`需要保证目标经办人已经加入企业且已实名`",
          "example": "yDwfGUieurag8Uy0AthwPa6bOntYp6x0"
        },
        {
          "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": false,
          "description": "代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "TargetUserId",
        "FlowForwardInfos"
      ]
    },
    {
      "name": "CreateFlowGroupByFiles",
      "description": "此接口（CreateFlowGroupByFiles）可用于通过多个文件创建合同组签署流程。使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。 - 该接口允许通过PDF资源ID一次性创建多个合同，这些合同被组织在一个合同组中。 - 每个签署方将收到一个签署链接，通过这个链接可以访问并签署合同组中的所有合同。 - 合同组中的合同必\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowGroupName",
          "type": "string",
          "required": true,
          "description": "合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
          "example": "入职合同集"
        },
        {
          "name": "FlowGroupInfos",
          "type": "array",
          "required": true,
          "description": "合同（流程）组的子合同信息，支持2-50个子合同",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FlowName",
              "type": "string",
              "required": true,
              "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。",
              "example": "2025入职合同"
            },
            {
              "name": "Approvers",
              "type": "array",
              "required": true,
              "description": "签署流程参与者信息，最大限制50方 注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ApproverType",
                  "type": "integer",
                  "required": true,
                  "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **0**：企业 **1**：个人 **3**：企业静默签署 注：`类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。` **7**: 个人自动签署，适用于个人自动签场景。 注: `个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "0"
                },
                {
                  "name": "ApproverName",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "张三"
                },
                {
                  "name": "ApproverMobile",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。",
                  "example": "18888888888"
                },
                {
                  "name": "OrganizationName",
                  "type": "string",
                  "required": false,
                  "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。",
                  "example": "张三示例企业"
                },
                {
                  "name": "SignComponents",
                  "type": "array",
                  "required": false,
                  "description": "【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "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": "ComponentHeight",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "43.1"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "119.1"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": true,
                      "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": true,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                      "example": "ComponentId_01"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                      "example": "price"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "true"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                      "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                    },
                    {
                      "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                      "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                    },
                    {
                      "name": "IsFormType",
                      "type": "boolean",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                      "example": "false"
                    },
                    {
                      "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_SE...",
                      "example": "100元"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "1"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "LowerRight"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                      "example": "[1,2]",
                      "item_type": "integer"
                    },
                    {
                      "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": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                    },
                    {
                      "name": "ChannelComponentSource",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                      "example": "0"
                    }
                  ]
                },
                {
                  "name": "ApproverIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件类型，支持以下类型，样式可以参考常见个人证件类型介绍 ID_CARD 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证) OTHER_CARD_TYPE 其他证件 注: 1. 其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。 2. 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人至少\ufffd...",
                  "example": "ID_CARD"
                },
                {
                  "name": "ApproverIdCardNumber",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "350203180010069855"
                },
                {
                  "name": "NotifyType",
                  "type": "string",
                  "required": false,
                  "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知 注意： `如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信`",
                  "example": "sms"
                },
                {
                  "name": "ApproverRole",
                  "type": "integer",
                  "required": false,
                  "description": "收据场景设置签署人角色类型, 可以设置如下类型: **1** :收款人 **2** :开具人 **3** :见证人 注: `收据场景为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "1"
                },
                {
                  "name": "ApproverRoleName",
                  "type": "string",
                  "required": false,
                  "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
                  "example": "收款人"
                },
                {
                  "name": "VerifyChannel",
                  "type": "array",
                  "required": false,
                  "description": "【已不再使用】签署意愿确认渠道，默认为WEIXINAPP:人脸识别 注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置",
                  "example": "[\"WEIXINAPP\"]",
                  "item_type": "string"
                },
                {
                  "name": "PreReadTime",
                  "type": "integer",
                  "required": false,
                  "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
                  "example": "3"
                },
                {
                  "name": "UserId",
                  "type": "string",
                  "required": false,
                  "description": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得 注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "name": "ApproverSource",
                  "type": "string",
                  "required": false,
                  "description": "在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。",
                  "example": "WEWORKAPP"
                },
                {
                  "name": "CustomApproverTag",
                  "type": "string",
                  "required": false,
                  "description": "在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。 所有参与或签的人员均需具备该标识。 注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。 如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。",
                  "example": "n9527"
                },
                {
                  "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": "CanEditApprover",
                      "type": "boolean",
                      "required": false,
                      "description": "允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑",
                      "example": "true"
                    },
                    {
                      "name": "FillType",
                      "type": "integer",
                      "required": false,
                      "description": "签署人信息补充类型，默认无需补充。 **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充` 注： 1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关` 2. 此参数在嵌入式场景下无效。",
                      "example": "1"
                    },
                    {
                      "name": "FlowReadLimit",
                      "type": "string",
                      "required": false,
                      "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                      "example": "LimitReadTimeAndBottom"
                    },
                    {
                      "name": "ForbidAddSignDate",
                      "type": "boolean",
                      "required": false,
                      "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：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**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才\ufffd\ufffd...",
                  "example": "[1,2,3]",
                  "item_type": "integer"
                },
                {
                  "name": "ApproverNeedSignReview",
                  "type": "boolean",
                  "required": false,
                  "description": "此签署人（员工或者个人）签署前，是否需要发起方企业审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业通知腾\ufffd\ufffd...",
                  "example": "false"
                },
                {
                  "name": "AddSignComponentsLimits",
                  "type": "array",
                  "required": false,
                  "description": "【在用文件发起合同场景下才有效】在调用[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅\ufffd\ufffd...",
                  "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_PAGING_SEAL "
                    },
                    {
                      "name": "ComponentValue",
                      "type": "array",
                      "required": false,
                      "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 **注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署\ufffd\ufffd...",
                      "example": "OFFICIAL",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "SignInstructionContent",
                  "type": "string",
                  "required": false,
                  "description": "签署须知：支持传入富文本，最长字数：500个中文字符",
                  "example": "这个合同不能截图转发"
                },
                {
                  "name": "Deadline",
                  "type": "integer",
                  "required": false,
                  "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
                  "example": "1705977064"
                },
                {
                  "name": "Components",
                  "type": "array",
                  "required": false,
                  "description": "【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件) 注：`此参数仅...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "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": "ComponentHeight",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "43.1"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "119.1"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": true,
                      "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": true,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                      "example": "ComponentId_01"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                      "example": "price"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "true"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                      "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                    },
                    {
                      "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                      "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                    },
                    {
                      "name": "IsFormType",
                      "type": "boolean",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                      "example": "false"
                    },
                    {
                      "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_SE...",
                      "example": "100元"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "1"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "LowerRight"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                      "example": "[1,2]",
                      "item_type": "integer"
                    },
                    {
                      "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": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                    },
                    {
                      "name": "ChannelComponentSource",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                      "example": "0"
                    }
                  ]
                },
                {
                  "name": "SignEndpoints",
                  "type": "array",
                  "required": false,
                  "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
                  "example": "[\"link\"]",
                  "item_type": "string"
                },
                {
                  "name": "RegisterInfo",
                  "type": "object",
                  "required": false,
                  "description": "快速注册相关信息",
                  "example": "无",
                  "children": [
                    {
                      "name": "LegalName",
                      "type": "string",
                      "required": true,
                      "description": "法人姓名",
                      "example": "张三"
                    },
                    {
                      "name": "UnifiedSocialCreditCode",
                      "type": "string",
                      "required": false,
                      "description": "社会统一信用代码",
                      "example": "91110108772551611J"
                    },
                    {
                      "name": "OrganizationAddress",
                      "type": "string",
                      "required": false,
                      "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
                      "example": "深圳市南山区高新区科技中一路腾讯大厦"
                    },
                    {
                      "name": "AuthorizationTypes",
                      "type": "array",
                      "required": false,
                      "description": "指定企业认证的授权方式 支持多选: 2: 法人授权方式 5: 授权书+对公打款方式",
                      "example": "[2,5]",
                      "item_type": "integer"
                    },
                    {
                      "name": "AuthorizationMethods",
                      "type": "array",
                      "required": false,
                      "description": "指定企业认证的授权方式 支持多选: 1: 上传营业执照 2: 腾讯云快速认证 3: 腾讯商户号授权（仅支持小程序端）",
                      "example": "[1,2]",
                      "item_type": "integer"
                    },
                    {
                      "name": "OrganizationIdCardType",
                      "type": "string",
                      "required": false,
                      "description": "企业证照类型： USCC :(默认)工商组织营业执照 PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证 CLINICFILLINGCERTIFICATE:诊所备案证",
                      "example": "USCC"
                    },
                    {
                      "name": "RegisterInfoOption",
                      "type": "object",
                      "required": false,
                      "description": "企业创建时候的个性化参数。 其中，包括一下内容： LegalNameSame 是否可以编辑法人。 UnifiedSocialCreditCodeSame 是否可以编辑证件号码。 OrganizationIdCardTypeSame 是否可以更改证照类型。",
                      "example": "无"
                    }
                  ]
                },
                {
                  "name": "NotSaveContact",
                  "type": "boolean",
                  "required": false,
                  "description": "是否不保存联系人 默认 false 保存联系人 true 不保存联系人 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。 如下图位置： ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)",
                  "example": "false"
                }
              ]
            },
            {
              "name": "FileIds",
              "type": "array",
              "required": false,
              "description": "文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。 注：此字段定义为数组，但仅支持单个文件",
              "example": "[\"yDt1JUUckp77a2omUyEmko88eg49PTsN\"]",
              "item_type": "string"
            },
            {
              "name": "TemplateId",
              "type": "string",
              "required": false,
              "description": "合同模板ID，为32位字符串。 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。 可登录腾讯电子签控制台，在 \"模板\"-\u003e\"模板中心\"-\u003e\"列表展示设置\"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "FlowType",
              "type": "string",
              "required": false,
              "description": "签署流程的类型(如销售合同/入职合同等)，最大长度200个字符",
              "example": "劳务合同"
            },
            {
              "name": "FlowDescription",
              "type": "string",
              "required": false,
              "description": "签署流程描述,最大长度1000个字符",
              "example": "2025入职合同"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后 示例值：1604912664",
              "example": "1736751627"
            },
            {
              "name": "UserData",
              "type": "string",
              "required": false,
              "description": "调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。",
              "example": "VXNlckRhdGE="
            },
            {
              "name": "Unordered",
              "type": "boolean",
              "required": false,
              "description": "发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致 示例值：true",
              "example": "true"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 动态表格等填写控件",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "NeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、...",
              "example": "true"
            },
            {
              "name": "AutoSignScene",
              "type": "string",
              "required": false,
              "description": "个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN",
              "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": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "FlowGroupOptions",
          "type": "object",
          "required": false,
          "description": "合同（流程）组的配置项信息。 其中包括： 是否通知本企业签署方 是否通知其他签署方",
          "example": "无",
          "children": [
            {
              "name": "ApproverVerifyType",
              "type": "string",
              "required": false,
              "description": "签署人校验方式,支持以下类型 VerifyCheck : 人脸识别 (默认值) MobileCheck : 手机号验证 参数说明：此参数仅在合同组文件发起有效，可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。",
              "example": "VerifyCheck"
            },
            {
              "name": "SelfOrganizationApproverNotifyType",
              "type": "string",
              "required": false,
              "description": "发起合同（流程）组本方企业经办人通知方式 签署通知类型，支持以下类型 sms : 短信 (默认值)none : 不通知",
              "example": "none"
            },
            {
              "name": "OtherApproverNotifyType",
              "type": "string",
              "required": false,
              "description": "发起合同（流程）组他方经办人通知方式 签署通知类型，支持以下类型 sms : 短信 (默认值)none : 不通知",
              "example": "none"
            },
            {
              "name": "FlowGroupNeedWorkflow",
              "type": "boolean",
              "required": false,
              "description": "是否开启发起合同组的发起审批，默认：false(不开启)，开启后，发起合同组会提交电子签内置审批流",
              "example": "true"
            }
          ]
        },
        {
          "name": "UserFlowType",
          "type": "object",
          "required": false,
          "description": "用户自定义合同类型。 自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png) 注意： 如果传递了自定义合同类型，则每一个子合同设置的自定义合同类型将会失效，已最外层定义的为准。 例如： 这份合同组有三个子合同，设置合同类型为人事/劳务 第一份子合同设置的合同自定义合同类型是...",
          "example": "无",
          "children": [
            {
              "name": "UserFlowTypeId",
              "type": "string",
              "required": false,
              "description": "合同类型ID",
              "example": "yDCNsUUg9tk6n6UtJrNd1S1ueFygJh9D"
            },
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "合同类型名称",
              "example": "分销合同"
            },
            {
              "name": "Description",
              "type": "string",
              "required": false,
              "description": "合同类型说明",
              "example": "由主承销人、国际协调人和全体承销商签署的旨在明确承销团成员间权利义务关系的协议"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "FlowGroupName",
        "FlowGroupInfos"
      ]
    },
    {
      "name": "CreateFlowGroupByTemplates",
      "description": "此接口（CreateFlowGroupByTemplates）可用于通过多个模板创建合同组签署流程。 - 该接口允许通过选择多个模板一次性创建多个合同，这些合同被组织在一个合同组中。 - 每个签署方将收到一个签署链接，通过这个链接可以访问并签署合同组中的所有合同。 - 合同组中的合同必须作为一个整体进行签署，不能将合同组拆分成单独的合同进行逐一签署。 ### 2. 适用场景 该接口适用于需...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowGroupName",
          "type": "string",
          "required": true,
          "description": "合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
          "example": "蔬菜采购"
        },
        {
          "name": "FlowGroupInfos",
          "type": "array",
          "required": true,
          "description": "合同（流程）组的子合同信息，支持2-50个子合同",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FlowName",
              "type": "string",
              "required": true,
              "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。",
              "example": "2025入职合同"
            },
            {
              "name": "Approvers",
              "type": "array",
              "required": true,
              "description": "签署流程参与者信息，最大限制50方 注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ApproverType",
                  "type": "integer",
                  "required": true,
                  "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **0**：企业 **1**：个人 **3**：企业静默签署 注：`类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。` **7**: 个人自动签署，适用于个人自动签场景。 注: `个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "0"
                },
                {
                  "name": "ApproverName",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "张三"
                },
                {
                  "name": "ApproverMobile",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。",
                  "example": "18888888888"
                },
                {
                  "name": "OrganizationName",
                  "type": "string",
                  "required": false,
                  "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。",
                  "example": "张三示例企业"
                },
                {
                  "name": "SignComponents",
                  "type": "array",
                  "required": false,
                  "description": "【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "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": "ComponentHeight",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "43.1"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "119.1"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": true,
                      "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": true,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                      "example": "ComponentId_01"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                      "example": "price"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "true"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                      "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                    },
                    {
                      "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                      "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                    },
                    {
                      "name": "IsFormType",
                      "type": "boolean",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                      "example": "false"
                    },
                    {
                      "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_SE...",
                      "example": "100元"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "1"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "LowerRight"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                      "example": "[1,2]",
                      "item_type": "integer"
                    },
                    {
                      "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": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                    },
                    {
                      "name": "ChannelComponentSource",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                      "example": "0"
                    }
                  ]
                },
                {
                  "name": "ApproverIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件类型，支持以下类型，样式可以参考常见个人证件类型介绍 ID_CARD 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证) OTHER_CARD_TYPE 其他证件 注: 1. 其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。 2. 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人至少\ufffd...",
                  "example": "ID_CARD"
                },
                {
                  "name": "ApproverIdCardNumber",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "350203180010069855"
                },
                {
                  "name": "NotifyType",
                  "type": "string",
                  "required": false,
                  "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知 注意： `如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信`",
                  "example": "sms"
                },
                {
                  "name": "ApproverRole",
                  "type": "integer",
                  "required": false,
                  "description": "收据场景设置签署人角色类型, 可以设置如下类型: **1** :收款人 **2** :开具人 **3** :见证人 注: `收据场景为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "1"
                },
                {
                  "name": "ApproverRoleName",
                  "type": "string",
                  "required": false,
                  "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
                  "example": "收款人"
                },
                {
                  "name": "VerifyChannel",
                  "type": "array",
                  "required": false,
                  "description": "【已不再使用】签署意愿确认渠道，默认为WEIXINAPP:人脸识别 注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置",
                  "example": "[\"WEIXINAPP\"]",
                  "item_type": "string"
                },
                {
                  "name": "PreReadTime",
                  "type": "integer",
                  "required": false,
                  "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
                  "example": "3"
                },
                {
                  "name": "UserId",
                  "type": "string",
                  "required": false,
                  "description": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得 注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "name": "ApproverSource",
                  "type": "string",
                  "required": false,
                  "description": "在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。",
                  "example": "WEWORKAPP"
                },
                {
                  "name": "CustomApproverTag",
                  "type": "string",
                  "required": false,
                  "description": "在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。 所有参与或签的人员均需具备该标识。 注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。 如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。",
                  "example": "n9527"
                },
                {
                  "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": "CanEditApprover",
                      "type": "boolean",
                      "required": false,
                      "description": "允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑",
                      "example": "true"
                    },
                    {
                      "name": "FillType",
                      "type": "integer",
                      "required": false,
                      "description": "签署人信息补充类型，默认无需补充。 **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充` 注： 1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关` 2. 此参数在嵌入式场景下无效。",
                      "example": "1"
                    },
                    {
                      "name": "FlowReadLimit",
                      "type": "string",
                      "required": false,
                      "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                      "example": "LimitReadTimeAndBottom"
                    },
                    {
                      "name": "ForbidAddSignDate",
                      "type": "boolean",
                      "required": false,
                      "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：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**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才\ufffd\ufffd...",
                  "example": "[1,2,3]",
                  "item_type": "integer"
                },
                {
                  "name": "ApproverNeedSignReview",
                  "type": "boolean",
                  "required": false,
                  "description": "此签署人（员工或者个人）签署前，是否需要发起方企业审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业通知腾\ufffd\ufffd...",
                  "example": "false"
                },
                {
                  "name": "AddSignComponentsLimits",
                  "type": "array",
                  "required": false,
                  "description": "【在用文件发起合同场景下才有效】在调用[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅\ufffd\ufffd...",
                  "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_PAGING_SEAL "
                    },
                    {
                      "name": "ComponentValue",
                      "type": "array",
                      "required": false,
                      "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 **注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署\ufffd\ufffd...",
                      "example": "OFFICIAL",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "SignInstructionContent",
                  "type": "string",
                  "required": false,
                  "description": "签署须知：支持传入富文本，最长字数：500个中文字符",
                  "example": "这个合同不能截图转发"
                },
                {
                  "name": "Deadline",
                  "type": "integer",
                  "required": false,
                  "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
                  "example": "1705977064"
                },
                {
                  "name": "Components",
                  "type": "array",
                  "required": false,
                  "description": "【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件) 注：`此参数仅...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "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": "ComponentHeight",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "43.1"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "119.1"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": true,
                      "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": true,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                      "example": "ComponentId_01"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                      "example": "price"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "true"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                      "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                    },
                    {
                      "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                      "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                    },
                    {
                      "name": "IsFormType",
                      "type": "boolean",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                      "example": "false"
                    },
                    {
                      "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_SE...",
                      "example": "100元"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "1"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "LowerRight"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                      "example": "[1,2]",
                      "item_type": "integer"
                    },
                    {
                      "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": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                    },
                    {
                      "name": "ChannelComponentSource",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                      "example": "0"
                    }
                  ]
                },
                {
                  "name": "SignEndpoints",
                  "type": "array",
                  "required": false,
                  "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
                  "example": "[\"link\"]",
                  "item_type": "string"
                },
                {
                  "name": "RegisterInfo",
                  "type": "object",
                  "required": false,
                  "description": "快速注册相关信息",
                  "example": "无",
                  "children": [
                    {
                      "name": "LegalName",
                      "type": "string",
                      "required": true,
                      "description": "法人姓名",
                      "example": "张三"
                    },
                    {
                      "name": "UnifiedSocialCreditCode",
                      "type": "string",
                      "required": false,
                      "description": "社会统一信用代码",
                      "example": "91110108772551611J"
                    },
                    {
                      "name": "OrganizationAddress",
                      "type": "string",
                      "required": false,
                      "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
                      "example": "深圳市南山区高新区科技中一路腾讯大厦"
                    },
                    {
                      "name": "AuthorizationTypes",
                      "type": "array",
                      "required": false,
                      "description": "指定企业认证的授权方式 支持多选: 2: 法人授权方式 5: 授权书+对公打款方式",
                      "example": "[2,5]",
                      "item_type": "integer"
                    },
                    {
                      "name": "AuthorizationMethods",
                      "type": "array",
                      "required": false,
                      "description": "指定企业认证的授权方式 支持多选: 1: 上传营业执照 2: 腾讯云快速认证 3: 腾讯商户号授权（仅支持小程序端）",
                      "example": "[1,2]",
                      "item_type": "integer"
                    },
                    {
                      "name": "OrganizationIdCardType",
                      "type": "string",
                      "required": false,
                      "description": "企业证照类型： USCC :(默认)工商组织营业执照 PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证 CLINICFILLINGCERTIFICATE:诊所备案证",
                      "example": "USCC"
                    },
                    {
                      "name": "RegisterInfoOption",
                      "type": "object",
                      "required": false,
                      "description": "企业创建时候的个性化参数。 其中，包括一下内容： LegalNameSame 是否可以编辑法人。 UnifiedSocialCreditCodeSame 是否可以编辑证件号码。 OrganizationIdCardTypeSame 是否可以更改证照类型。",
                      "example": "无"
                    }
                  ]
                },
                {
                  "name": "NotSaveContact",
                  "type": "boolean",
                  "required": false,
                  "description": "是否不保存联系人 默认 false 保存联系人 true 不保存联系人 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。 如下图位置： ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)",
                  "example": "false"
                }
              ]
            },
            {
              "name": "FileIds",
              "type": "array",
              "required": false,
              "description": "文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。 注：此字段定义为数组，但仅支持单个文件",
              "example": "[\"yDt1JUUckp77a2omUyEmko88eg49PTsN\"]",
              "item_type": "string"
            },
            {
              "name": "TemplateId",
              "type": "string",
              "required": false,
              "description": "合同模板ID，为32位字符串。 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。 可登录腾讯电子签控制台，在 \"模板\"-\u003e\"模板中心\"-\u003e\"列表展示设置\"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "FlowType",
              "type": "string",
              "required": false,
              "description": "签署流程的类型(如销售合同/入职合同等)，最大长度200个字符",
              "example": "劳务合同"
            },
            {
              "name": "FlowDescription",
              "type": "string",
              "required": false,
              "description": "签署流程描述,最大长度1000个字符",
              "example": "2025入职合同"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后 示例值：1604912664",
              "example": "1736751627"
            },
            {
              "name": "UserData",
              "type": "string",
              "required": false,
              "description": "调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。",
              "example": "VXNlckRhdGE="
            },
            {
              "name": "Unordered",
              "type": "boolean",
              "required": false,
              "description": "发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致 示例值：true",
              "example": "true"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 动态表格等填写控件",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "NeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、...",
              "example": "true"
            },
            {
              "name": "AutoSignScene",
              "type": "string",
              "required": false,
              "description": "个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN",
              "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": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "FlowGroupOptions",
          "type": "object",
          "required": false,
          "description": "合同（流程）组的配置项信息。 其中包括： 是否通知本企业签署方 是否通知其他签署方",
          "example": "无",
          "children": [
            {
              "name": "ApproverVerifyType",
              "type": "string",
              "required": false,
              "description": "签署人校验方式,支持以下类型 VerifyCheck : 人脸识别 (默认值) MobileCheck : 手机号验证 参数说明：此参数仅在合同组文件发起有效，可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。",
              "example": "VerifyCheck"
            },
            {
              "name": "SelfOrganizationApproverNotifyType",
              "type": "string",
              "required": false,
              "description": "发起合同（流程）组本方企业经办人通知方式 签署通知类型，支持以下类型 sms : 短信 (默认值)none : 不通知",
              "example": "none"
            },
            {
              "name": "OtherApproverNotifyType",
              "type": "string",
              "required": false,
              "description": "发起合同（流程）组他方经办人通知方式 签署通知类型，支持以下类型 sms : 短信 (默认值)none : 不通知",
              "example": "none"
            },
            {
              "name": "FlowGroupNeedWorkflow",
              "type": "boolean",
              "required": false,
              "description": "是否开启发起合同组的发起审批，默认：false(不开启)，开启后，发起合同组会提交电子签内置审批流",
              "example": "true"
            }
          ]
        },
        {
          "name": "UserFlowType",
          "type": "object",
          "required": false,
          "description": "用户自定义合同类型。 自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png) 注意： 如果传递了自定义合同类型，则每一个子合同对应模板上面的自定义合同类型将会失效，已最外层定义的为准。 例如： 这份合同组有三个子合同，设置合同类型为人事/劳务 第一份子合同选择的模板的合同自...",
          "example": "无",
          "children": [
            {
              "name": "UserFlowTypeId",
              "type": "string",
              "required": false,
              "description": "合同类型ID",
              "example": "yDCNsUUg9tk6n6UtJrNd1S1ueFygJh9D"
            },
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "合同类型名称",
              "example": "分销合同"
            },
            {
              "name": "Description",
              "type": "string",
              "required": false,
              "description": "合同类型说明",
              "example": "由主承销人、国际协调人和全体承销商签署的旨在明确承销团成员间权利义务关系的协议"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "FlowGroupName",
        "FlowGroupInfos"
      ]
    },
    {
      "name": "CreateFlowGroupSignReview",
      "description": "提交合同组签署流程审批结果的适用场景包括： 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时，若指定了以下参数 为true，则可以调用此接口提交企业内部签署审批结果。即使是自动签署也需要\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": true,
          "description": "合同(流程)组的合同组Id，为32位字符串，通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时返回。",
          "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": "37000019890303000X"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。",
              "example": "张三示例企业"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ReviewMessage",
          "type": "string",
          "required": false,
          "description": "审核不通过的原因，该字段的字符串长度不超过200个字符。 注：`当审核类型（ReviewType）为审核拒绝（REJECT）或拒签（SIGN_REJECT）时，审核结果原因字段必须填写`",
          "example": "价格写错了"
        }
      ],
      "required": [
        "Operator",
        "FlowGroupId",
        "ReviewType",
        "ApproverInfo"
      ]
    },
    {
      "name": "CreateFlowReminds",
      "description": "指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： 1. 发起合同时，**签署人的NotifyType需设置为sms** 2. 合同中当前状态为 **待签署** 的签署人是催办的对象 3. **每个合同只能催办一次** **催办的效果**: 对方会收到如下的短信通知 ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png) 注：`合同催办是白名单功能，请联系\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "yDR***************oimj",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": true,
          "description": "需执行催办的签署流程ID数组，最多包含100个。",
          "example": "['yDw*************Gm','yDwFmU*******Ot2iQF']",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "FlowIds"
      ]
    },
    {
      "name": "CreateFlowSignReview",
      "description": "提交企业流程审批结果 **当前存在两种审核操作：** 签署审核 在通过接口 CreateFlowByFiles CreateFlow CreateFlowGroupByTemplates CreateFlowGroupByFiles CreatePrepareFlow 发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果（审核对象：本企业合同参与方的签署动作） 在通过接口 CreateFlowByFiles CreateFlow CreateFlowGroupByTemplates CreateFlowGroupB...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
          "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
        },
        {
          "name": "ReviewType",
          "type": "string",
          "required": true,
          "description": "企业内部审核结果 PASS: 审核通过 REJECT: 审核拒绝 SIGN_REJECT:拒签(流程结束)",
          "example": "PASS"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "RecipientId",
          "type": "string",
          "required": false,
          "description": "审核节点的签署人标志，用于指定当前审核的签署方 **如果签署审核节点是个人， 此参数必填**。",
          "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP"
        },
        {
          "name": "OperateType",
          "type": "string",
          "required": false,
          "description": "操作类型：（接口通过该字段区分不同的操作类型） SignReview: 签署审核（默认） CreateReview: 创建审核 如果审核节点是个人，则操作类型只能为SignReview。",
          "example": "SignReview"
        },
        {
          "name": "ReviewMessage",
          "type": "string",
          "required": false,
          "description": "审核结果原因 字符串长度不超过200 当ReviewType 是拒绝（REJECT） 时此字段必填。 当ReviewType 是拒绝（SIGN_REJECT） 时此字段必填。",
          "example": "合同内容错误"
        }
      ],
      "required": [
        "Operator",
        "FlowId",
        "ReviewType"
      ]
    },
    {
      "name": "CreateFlowSignUrl",
      "description": "该接口用于发起合同后，生成用户的签署链接 **注意** 1. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。 2. 该接口返回的签署链接适用于APP集成的场景，支持APP、支付宝打开或浏览器直接打开，**不支持微信小程序嵌入**。配置方式请参考：跳转电子签H5。 如需跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID为32位字符串。 您可以登录腾讯电子签控制台，在 \"合同\" -\u003e \"合同中心\" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。",
          "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "FlowApproverInfos",
          "type": "array",
          "required": false,
          "description": "流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。 此结构体和CreateFlow发起接口参与方结构体复用，除了上述参数外，可传递的参数有： 1. RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。 2. ApproverSignTypes: 指定签署方签署时候的认证方式，仅此链接生效。 3. SignTypeSelector: 可以指定签署\ufffd...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ApproverType",
              "type": "integer",
              "required": true,
              "description": "在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下： 0 :企业B端。 1 :个人C端。 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。",
              "example": "1"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`",
              "example": "张三示例企业"
            },
            {
              "name": "ApproverName",
              "type": "string",
              "required": false,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 在未指定签署人电子签UserId情况下，为必填参数",
              "example": "张三"
            },
            {
              "name": "ApproverMobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。 注：`在未指定签署人电子签UserId情况下，为必填参数`",
              "example": "18888888888"
            },
            {
              "name": "ApproverIdCardType",
              "type": "string",
              "required": false,
              "description": "证件类型，支持以下类型 ID_CARD: 居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "ApproverIdCardNumber",
              "type": "string",
              "required": false,
              "description": "证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            },
            {
              "name": "RecipientId",
              "type": "string",
              "required": false,
              "description": "签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。 模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。 文件发起合同时，该参数无需传值。 如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "VerifyChannel",
              "type": "array",
              "required": false,
              "description": "签署意愿确认渠道，默认为WEIXINAPP:人脸识别 注: 不再使用, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`",
              "example": "[\"WEIXINAPP\"]",
              "item_type": "string"
            },
            {
              "name": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知 注: `既是发起方又是签署方时，不给此签署方发送短信`",
              "example": "none"
            },
            {
              "name": "IsFullText",
              "type": "boolean",
              "required": false,
              "description": "合同强制需要阅读全文，无需传此参数",
              "example": "true"
            },
            {
              "name": "PreReadTime",
              "type": "integer",
              "required": false,
              "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
              "example": "3"
            },
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得 注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "name": "Required",
              "type": "boolean",
              "required": false,
              "description": "字段不再使用，当前只支持true，默认为true",
              "example": "true"
            },
            {
              "name": "ApproverSource",
              "type": "string",
              "required": false,
              "description": "在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。",
              "example": "WEWORKAPP"
            },
            {
              "name": "CustomApproverTag",
              "type": "string",
              "required": false,
              "description": "在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。 所有参与或签的人员均需具备该标识。 注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。 如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。",
              "example": "n9527"
            },
            {
              "name": "RegisterInfo",
              "type": "object",
              "required": false,
              "description": "快速注册相关信息",
              "example": "无",
              "children": [
                {
                  "name": "LegalName",
                  "type": "string",
                  "required": true,
                  "description": "法人姓名",
                  "example": "张三"
                },
                {
                  "name": "UnifiedSocialCreditCode",
                  "type": "string",
                  "required": false,
                  "description": "社会统一信用代码",
                  "example": "91110108772551611J"
                },
                {
                  "name": "OrganizationAddress",
                  "type": "string",
                  "required": false,
                  "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
                  "example": "深圳市南山区高新区科技中一路腾讯大厦"
                },
                {
                  "name": "AuthorizationTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 2: 法人授权方式 5: 授权书+对公打款方式",
                  "example": "[2,5]",
                  "item_type": "integer"
                },
                {
                  "name": "AuthorizationMethods",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 1: 上传营业执照 2: 腾讯云快速认证 3: 腾讯商户号授权（仅支持小程序端）",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "OrganizationIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "企业证照类型： USCC :(默认)工商组织营业执照 PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证 CLINICFILLINGCERTIFICATE:诊所备案证",
                  "example": "USCC"
                },
                {
                  "name": "RegisterInfoOption",
                  "type": "object",
                  "required": false,
                  "description": "企业创建时候的个性化参数。 其中，包括一下内容： LegalNameSame 是否可以编辑法人。 UnifiedSocialCreditCodeSame 是否可以编辑证件号码。 OrganizationIdCardTypeSame 是否可以更改证照类型。",
                  "example": "无",
                  "children": [
                    {
                      "name": "LegalNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的法人姓名。 true：允许编辑false：不允许编辑（默认值） 注意： RegisterInfo 中的LegalName值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "UnifiedSocialCreditCodeCNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时统一社会信用代码。 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的UnifiedSocialCreditCode值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "OrganizationIdCardTypeSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的证照类型 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的OrganizationIdCardType值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    }
                  ]
                }
              ]
            },
            {
              "name": "ApproverOption",
              "type": "object",
              "required": false,
              "description": "签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。",
              "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": "CanEditApprover",
                  "type": "boolean",
                  "required": false,
                  "description": "允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑",
                  "example": "true"
                },
                {
                  "name": "FillType",
                  "type": "integer",
                  "required": false,
                  "description": "签署人信息补充类型，默认无需补充。 **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充` 注： 1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关` 2. 此参数在嵌入式场景下无效。",
                  "example": "1"
                },
                {
                  "name": "FlowReadLimit",
                  "type": "string",
                  "required": false,
                  "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                  "example": "LimitReadTimeAndBottom"
                },
                {
                  "name": "ForbidAddSignDate",
                  "type": "boolean",
                  "required": false,
                  "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "SignId",
              "type": "string",
              "required": false,
              "description": "签署人的签署ID 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。",
              "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN"
            },
            {
              "name": "ApproverNeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "此签署人(员工或者个人)签署时，是否需要发起方企业审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业通知腾讯电...",
              "example": "true"
            },
            {
              "name": "SignComponents",
              "type": "array",
              "required": false,
              "description": "签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效 合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件 `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效 合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 动态表格等填写控件 `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "ComponentLimitType",
              "type": "array",
              "required": false,
              "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
              "example": "[\"HANDWRITE\"]",
              "item_type": "string"
            },
            {
              "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**：\ufffd\ufffd...",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "name": "SignTypeSelector",
              "type": "integer",
              "required": false,
              "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
              "example": "0"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
              "example": "1604912664"
            },
            {
              "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": "NotSaveContact",
              "type": "boolean",
              "required": false,
              "description": "是否不保存联系人 默认 false 保存联系人 true 不保存联系人 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。 如下图位置： ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)",
              "example": "false"
            }
          ]
        },
        {
          "name": "VideoVerifyTimesLimit",
          "type": "integer",
          "required": false,
          "description": "用于指定进入视频签署的限制次数，次数取值范围：1 - 10，不设置则默认为5次，仅视频签署时生效。",
          "example": "5"
        },
        {
          "name": "JumpUrl",
          "type": "string",
          "required": false,
          "description": "签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 跳转电子签H5",
          "example": "https://jump.cn/jump"
        },
        {
          "name": "UrlType",
          "type": "integer",
          "required": false,
          "description": "链接类型支持以下指定类型： 0: 签署链接（默认值），进入后可以填写或签署合同。1 : 预览链接，进入后可以预览合同当前的样子。 注： 1. 当指定链接类型为1时，链接为预览链接，打开链接后无法进行签署操作，仅支持预览和查看当前合同状态。 2. 如需生成发起方预览链接，则签署方信息应传空，即FlowApproverInfos传空或者不传。",
          "example": "0"
        }
      ],
      "required": [
        "FlowId"
      ]
    },
    {
      "name": "CreateInformationExtractionWebUrl",
      "description": "此接口（CreateInformationExtractionWebUrl）用来创建合同信息提取web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。 注: 1. pdf、word格式限制大小为10M以下 2. pdg、jpeg、jpg格式限制大小为5M以下",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ResourceIds",
          "type": "array",
          "required": false,
          "description": "需要提取的合同文件资源ID,可通过UploadFiles接口获取文件资源ID。 注: - `word、pdf文件每个文件限制在10M以下` - `png、jpg、jpeg文件每个限制在5M以下`",
          "example": "[\"yDtGEUUgydz\"]",
          "item_type": "string"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
          "example": "5rWL6K+V5pWw5o2u"
        },
        {
          "name": "Option",
          "type": "object",
          "required": false,
          "description": "个性化参数，用于控制页面展示内容",
          "example": "无",
          "children": [
            {
              "name": "DisableLinkPreview",
              "type": "boolean",
              "required": false,
              "description": "禁用链接预览",
              "example": "false"
            },
            {
              "name": "DisableTaskEditing",
              "type": "boolean",
              "required": false,
              "description": "禁用任务编辑",
              "example": "false"
            },
            {
              "name": "DisableTaskResultEditing",
              "type": "boolean",
              "required": false,
              "description": "禁用任务结果编辑",
              "example": "false"
            }
          ]
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateIntegrationDepartment",
      "description": "此接口（CreateIntegrationDepartment）用于创建企业的部门信息，支持绑定客户系统部门ID。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "DeptName",
          "type": "string",
          "required": true,
          "description": "部门名称，最大长度为50个字符。",
          "example": "销售部门"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ParentDeptId",
          "type": "string",
          "required": false,
          "description": "电子签父部门ID。 注：`如果同时指定了ParentDeptId与ParentDeptOpenId参数，系统将优先使用ParentDeptId。当二者都未指定时，创建的新部门将自动填充至根节点部门下。`",
          "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
        },
        {
          "name": "ParentDeptOpenId",
          "type": "string",
          "required": false,
          "description": "第三方平台中父部门ID。 注：`如果同时指定了ParentDeptId与ParentDeptOpenId参数，系统将优先使用ParentDeptId。当二者都未指定时，创建的新部门将自动填充至根节点部门下。`",
          "example": "456"
        },
        {
          "name": "DeptOpenId",
          "type": "string",
          "required": false,
          "description": "客户系统部门ID，最大长度为64个字符。",
          "example": "789"
        },
        {
          "name": "OrderNo",
          "type": "integer",
          "required": false,
          "description": "排序号，支持设置的数值范围为1~30000。同一父部门下，排序号越大，部门顺序越靠前。",
          "example": "1"
        }
      ],
      "required": [
        "Operator",
        "DeptName"
      ]
    },
    {
      "name": "CreateIntegrationEmployees",
      "description": "此接口（CreateIntegrationEmployees）用于创建企业员工。创建的员工初始化为未实名，如下图所示。 ![image](https://qcloudimg.tencent-cloud.cn/raw/2bdcc0d91ac3146b5e8c28811a78ffe9.png) 支持以下场景 生成端 入参 提醒方式 普通saas员工 将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号 发送短信通知员工（短信中带有认证加入企业的链接） 企微员工 将Employees 中的WeworkOpenId字段设置为企...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Employees",
          "type": "array",
          "required": true,
          "description": "待创建员工的信息最多不超过20个。 **1. 在创建企业微信员工的场景下** : 只需传入下面的参数，其他信息不支持设置。 参数 是否必填 含义 WeworkOpenId 是 企业微信用户账号ID **2. 在其他场景下** : 只需传入下面的参数，其他信息不支持设置。 参数 是否必填 含义 DisplayName 是 用户的真实名字 Mobile 是 用户手机号码 OpenId 否 用户的自定义ID Email 否 用户的邮箱 Department.DepartmentId 否 \ufffd...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "员工在腾讯电子签平台的唯一身份标识，为32位字符串。 注：`创建和更新场景无需填写。`",
              "example": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
            },
            {
              "name": "DisplayName",
              "type": "string",
              "required": false,
              "description": "显示的用户名/昵称。",
              "example": "张三"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "用户手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。",
              "example": "1320****000"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "用户邮箱。",
              "example": "testtest@tencent.com"
            },
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "用户在第三方平台ID。 注：`如需在此接口提醒员工实名，该参数不传。`",
              "example": "open_user1"
            },
            {
              "name": "Roles",
              "type": "array",
              "required": false,
              "description": "员工角色信息。 注：`创建和更新场景无需填写。`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "RoleId",
                  "type": "string",
                  "required": false,
                  "description": "角色ID。",
                  "example": "4dff1******************10b"
                },
                {
                  "name": "RoleName",
                  "type": "string",
                  "required": false,
                  "description": "角色名称。",
                  "example": "业务员"
                }
              ]
            },
            {
              "name": "Department",
              "type": "object",
              "required": false,
              "description": "员工部门信息。",
              "example": "无",
              "children": [
                {
                  "name": "DepartmentId",
                  "type": "string",
                  "required": false,
                  "description": "部门ID。",
                  "example": "dp**********************155f2"
                },
                {
                  "name": "DepartmentName",
                  "type": "string",
                  "required": false,
                  "description": "部门名称。",
                  "example": "测试部门"
                }
              ]
            },
            {
              "name": "Verified",
              "type": "boolean",
              "required": false,
              "description": "员工是否实名。 注：`创建和更新场景无需填写。`",
              "example": "false"
            },
            {
              "name": "CreatedOn",
              "type": "integer",
              "required": false,
              "description": "员工创建时间戳，单位秒。 注：`创建和更新场景无需填写。`",
              "example": "1691563315"
            },
            {
              "name": "VerifiedOn",
              "type": "integer",
              "required": false,
              "description": "员工实名时间戳，单位秒。 注：`创建和更新场景无需填写。`",
              "example": "1691563315"
            },
            {
              "name": "QuiteJob",
              "type": "integer",
              "required": false,
              "description": "员工是否离职： **0**：未离职**1**：离职 注：`创建和更新场景无需填写。`",
              "example": "0"
            },
            {
              "name": "ReceiveUserId",
              "type": "string",
              "required": false,
              "description": "员工离职交接人用户ID。 注：`创建和更新场景无需填写。`",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "name": "ReceiveOpenId",
              "type": "string",
              "required": false,
              "description": "员工离职交接人用户OpenId。 注：`创建和更新场景无需填写。`",
              "example": "open_user2"
            },
            {
              "name": "WeworkOpenId",
              "type": "string",
              "required": false,
              "description": "企业微信用户账号ID。 注：`仅企微类型的企业创建员工接口支持该字段。`",
              "example": "wework_open1"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "InvitationNotifyType",
          "type": "string",
          "required": false,
          "description": "员工邀请方式 可通过以下途径进行设置： **SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。**H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。**NONE**：系统会根据Endpoint生成签署链接，业务方需获取链...",
          "example": "SMS"
        },
        {
          "name": "JumpUrl",
          "type": "string",
          "required": false,
          "description": "回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。 注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`",
          "example": "https://www.qq.com/action-next"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "要跳转的链接类型 **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链**APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型**H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月注意：InvitationNot...",
          "example": "APP"
        }
      ],
      "required": [
        "Operator",
        "Employees"
      ]
    },
    {
      "name": "CreateIntegrationRole",
      "description": "此接口（CreateIntegrationRole）用来创建企业自定义的SaaS角色或集团角色。 适用场景1：创建当前企业的自定义SaaS角色或集团角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。 适用场景2：创建当前企业的自定义SaaS角色或集团角色，并且创建时进行权限的设置（PermissionGroups 参数要传）\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。",
          "example": "销售分部角色"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "角色描述，最大长度为50个字符",
          "example": "销售分部角色"
        },
        {
          "name": "IsGroupRole",
          "type": "integer",
          "required": false,
          "description": "角色类型，0:saas角色，1:集团角色 默认0，saas角色",
          "example": "0"
        },
        {
          "name": "PermissionGroups",
          "type": "array",
          "required": false,
          "description": "权限树",
          "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": "false"
            },
            {
              "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": "BillOrderManagement"
                },
                {
                  "name": "Type",
                  "type": "integer",
                  "required": false,
                  "description": "权限类型 1前端，2后端",
                  "example": "2"
                },
                {
                  "name": "Hide",
                  "type": "integer",
                  "required": false,
                  "description": "是否隐藏",
                  "example": "1"
                },
                {
                  "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": "BillInvoiceManagement"
                },
                {
                  "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": "BillOrderManagement"
                    },
                    {
                      "name": "Type",
                      "type": "integer",
                      "required": false,
                      "description": "权限类型 1前端，2后端",
                      "example": "2"
                    },
                    {
                      "name": "Hide",
                      "type": "integer",
                      "required": false,
                      "description": "是否隐藏",
                      "example": "1"
                    },
                    {
                      "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": "BillInvoiceManagement"
                    },
                    {
                      "name": "IsChecked",
                      "type": "boolean",
                      "required": false,
                      "description": "是否选中",
                      "example": "false"
                    },
                    {
                      "name": "Children",
                      "type": "array",
                      "required": false,
                      "description": "子权限集合",
                      "example": "无",
                      "item_type": "string"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "name": "SubOrganizationIds",
          "type": "array",
          "required": false,
          "description": "集团角色的话，需要传递集团子企业列表，如果是全选，则传1",
          "example": "[\"135\", \"853\"]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Name",
        "Operator"
      ]
    },
    {
      "name": "CreateIntegrationSubOrganizationActiveRecord",
      "description": "使用此接口，可创建子企业激活记录。集团企业管理员可以针对尚未激活的成员企业进行激活操作。 这个操作与页面端激活成员企业操作类似 ![image](https://qcloudimg.tencent-cloud.cn/raw/c4e76fbac92e4ce451a03601c964793b.png) 注意： 1. 此接口只能用于激活，**不能用于续期**。 2. 在激活子企业时，**请确保子企业的许可证数量充足**。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "SubOrganizationIds",
          "type": "array",
          "required": true,
          "description": "待激活成员企业ID集合",
          "example": "[\"yDt1JUUckp77a2tqUyEmko8RVpCEHoNA\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Operator",
        "SubOrganizationIds"
      ]
    },
    {
      "name": "CreateIntegrationUserRoles",
      "description": "此接口用于赋予员工指定的角色权限，如需解绑请使用 DeleteIntegrationRoleUsers 接口。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": true,
          "description": "绑定角色的用户id列表，不能重复，不能大于 100 个",
          "example": "[\"yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH\"]",
          "item_type": "string"
        },
        {
          "name": "RoleIds",
          "type": "array",
          "required": true,
          "description": "绑定角色的角色id列表，不能重复，不能大于 100，可以通过DescribeIntegrationRoles接口获取角色信息",
          "example": "[\"yDt1JUUckp77a2tqUyEmko8RVpCEHoNA\"]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "UserIds",
        "RoleIds"
      ]
    },
    {
      "name": "CreateLMInformationExtractionTaskFieldFeedback",
      "description": "此接口（CreateLMInformationExtractionTaskFieldFeedback）用于创建合同智能提取任务字段结果的反馈。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行合同智能提取任务的员工信息。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Id",
          "type": "string",
          "required": false,
          "description": "合同智能提取任务结果字段ID值。该参数通过调用接口[获取合同智能提取任务详情](https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/DescribeInformationExtractionTask)返回中的Results. ExtractionFieldResults.Id获取。",
          "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
        },
        {
          "name": "Feedback",
          "type": "object",
          "required": false,
          "description": "合同智能提取任务反馈信息",
          "example": "无",
          "children": [
            {
              "name": "Result",
              "type": "integer",
              "required": false,
              "description": "合同信息提取结果反馈。 `值如下`： - 0: 未反馈 - 1: 信息提取正确 - 2: 信息提取有错误",
              "example": "0"
            },
            {
              "name": "Reason",
              "type": "object",
              "required": false,
              "description": "信息提取错误原因，当Result为2时需要填写此信息",
              "example": "无",
              "children": [
                {
                  "name": "ReasonType",
                  "type": "integer",
                  "required": false,
                  "description": "反馈信息提取错误原因。 `值如下`： - 1: 提取错误(提取不精准、提取为空等) - 2: 其他错误",
                  "example": "1"
                },
                {
                  "name": "ReasonContent",
                  "type": "string",
                  "required": false,
                  "description": "反馈提取错误详细错误原因，不能超过500个字符",
                  "example": "提取信息不准确"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateLegalSealQrCode",
      "description": "该接口用于获取创建法人章的二维码，需要通过微信扫描。扫描后将跳转到腾讯电子签署，进入到创建法人章的流程。 **注意** 1. 该二维码**有效期为7天**，过期后将失效，可重新创建 。 2. 每个公司**只能有1个法人章**，无法重复创建或者创建多个 法人章的样式可以参考下图索引（也可以自己上传法人印章图片）： ![image](https://qcloudimg.tencent-cloud.cn/raw/36a0a090750c45bb5cac5047ac461b2c....",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "CreateMiniAppPrepareFlow",
      "description": "创建小程序发起流程链接，在小程序页面上完成签署人等信息的编辑与确认后，可快速发起流程。 适用场景：如果需要签署人在自己的APP、小程序、H5应用中发起合同，可在收集合同信息，签署人等信息后（非必选），通过此接口获取跳转腾讯电子签小程序的合同发起跳转链接，跳转到腾讯电子签小程序继续合同的发起。 跳转到小程序的实现，参考微信官方文档（分为全屏、\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ResourceType",
          "type": "integer",
          "required": true,
          "description": "资源类型，取值有： **1**：模板 **2**：文件",
          "example": "1"
        },
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源id，与ResourceType相对应，取值范围： 文件Id（通过UploadFiles获取文件资源Id） 模板Id（通过控制台创建模板后获取模板Id） 注意：需要同时设置 ResourceType 参数指定资源类型",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        },
        {
          "name": "FlowName",
          "type": "string",
          "required": true,
          "description": "自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(\u0026)、（+）组成。 该名称还将用于合同签署完成后文件下载的默认文件名称。",
          "example": "合同名称"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Approvers",
          "type": "array",
          "required": false,
          "description": "合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ApproverType",
              "type": "integer",
              "required": true,
              "description": "在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下： 0 :企业B端。 1 :个人C端。 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。",
              "example": "1"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`",
              "example": "张三示例企业"
            },
            {
              "name": "ApproverName",
              "type": "string",
              "required": false,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 在未指定签署人电子签UserId情况下，为必填参数",
              "example": "张三"
            },
            {
              "name": "ApproverMobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。 注：`在未指定签署人电子签UserId情况下，为必填参数`",
              "example": "18888888888"
            },
            {
              "name": "ApproverIdCardType",
              "type": "string",
              "required": false,
              "description": "证件类型，支持以下类型 ID_CARD: 居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "ApproverIdCardNumber",
              "type": "string",
              "required": false,
              "description": "证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            },
            {
              "name": "RecipientId",
              "type": "string",
              "required": false,
              "description": "签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。 模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。 文件发起合同时，该参数无需传值。 如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            }
          ]
        },
        {
          "name": "CcInfos",
          "type": "array",
          "required": false,
          "description": "合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。 **注：暂不支持通过NotifyType参数控制抄送人通知方式**",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "被抄送方手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此业务通知方。",
              "example": "1320****000"
            },
            {
              "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": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知",
              "example": "sms"
            }
          ]
        },
        {
          "name": "Unordered",
          "type": "boolean",
          "required": false,
          "description": "合同流程的签署顺序类型： **false**：(默认)有序签署, 本合同多个参与人需要依次签署 **true**：无序签署, 本合同多个参与人没有先后签署限制 **注：仅在文件发起模式下设置有效，模板发起以模板配置为准**",
          "example": "true"
        },
        {
          "name": "DeadlineAfterStartDays",
          "type": "integer",
          "required": false,
          "description": "合同发起后经过多少天截止（1-30天可选），默认7天",
          "example": "3"
        },
        {
          "name": "UserFlowTypeId",
          "type": "string",
          "required": false,
          "description": "用户自定义合同类型Id 该id为电子签企业内的合同类型id， 可以在控制台-合同-自定义合同类型处获取",
          "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84"
        },
        {
          "name": "FlowOption",
          "type": "object",
          "required": false,
          "description": "发起合同个性化参数 用于满足小程序合同创建的个性化要求 具体定制化内容详见数据接口说明",
          "example": "无",
          "children": [
            {
              "name": "RemindedOn",
              "type": "integer",
              "required": false,
              "description": "到期提醒日（linux时间戳） 精确到天",
              "example": "1753286400"
            },
            {
              "name": "NeedCreateReview",
              "type": "boolean",
              "required": false,
              "description": "是否需要发起前进行审批",
              "example": "true"
            },
            {
              "name": "FlowDisplayType",
              "type": "integer",
              "required": false,
              "description": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)",
              "example": "1"
            },
            {
              "name": "ForbidEditFlow",
              "type": "boolean",
              "required": false,
              "description": "小程序集成发起，是否禁止发起时修改合同内容 false：默认值，不禁止发起时修改合同内容 true：禁止发起时修改合同内容（将直接跳过添加/编辑签署人步骤，直接到核对合同信息页面 指定为true，效果如下： 效果如下:![ForbidEditFlow](https://qcloudimg.tencent-cloud.cn/raw/2440eca624f2f6730fecbf69daad0533.jpg)",
              "example": "true"
            }
          ]
        },
        {
          "name": "PageOption",
          "type": "object",
          "required": false,
          "description": "发起合同小程序页面个性化参数 用于满足小程序合同创建页面的个性化要求 具体定制化内容详见数据接口说明",
          "example": "无",
          "children": [
            {
              "name": "HideSignCodeAfterStart",
              "type": "boolean",
              "required": false,
              "description": "发起后隐藏签署码",
              "example": "true"
            }
          ]
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000 长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
          "example": "自定义数据"
        },
        {
          "name": "Hides",
          "type": "array",
          "required": false,
          "description": "生成的签署链接在签署页面隐藏的按钮列表，可设置如下： **0** :合同签署页面更多操作按钮 **1** :合同签署页面更多操作的拒绝签署按钮 **2** :合同签署页面更多操作的转他人处理按钮 **3** :签署成功页的查看详情按钮 **4** :合同签署页面更多操作的查看合同基本信息按钮 **5** :合同签署页面更多操作的撤销按钮 注: `字段为数组, 可以传值隐藏多个按钮`",
          "example": "[0,1,2]",
          "item_type": "integer"
        }
      ],
      "required": [
        "Operator",
        "ResourceType",
        "ResourceId",
        "FlowName"
      ]
    },
    {
      "name": "CreateModifyAdminAuthorizationUrl",
      "description": "本接口（CreateModifyAdminAuthorizationUrl）用于重新上传超管授权书。 注意: 1. 重新上传超管授权书，必须是审核失败的情况下才能重新上传,可以通过回调[!企业认证审核结果回调](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)得到授权书是否审核失败的结果。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "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": [
        "Operator"
      ]
    },
    {
      "name": "CreateMultiFlowSignQRCode",
      "description": "此接口（CreateMultiFlowSignQRCode）用于创建一码多签签署码。 **适用场景**: 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。 **注意**: 1.满足以下条件的模板支持创建签署码： - 签署对象：企业与个人（无序签署）、企业与个人（顺序签署\u0026企业非首位）、 仅个人签署。 - 其发起方没有填\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TemplateId",
          "type": "string",
          "required": true,
          "description": "合同模板ID，为32位字符串。 可登录腾讯电子签控制台，在 \"模板\"-\u003e\"模板中心\"-\u003e\"列表展示设置\"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。",
          "example": "yDRS*******P35Swc"
        },
        {
          "name": "FlowName",
          "type": "string",
          "required": true,
          "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。",
          "example": "签到合同"
        },
        {
          "name": "MaxFlowNum",
          "type": "integer",
          "required": false,
          "description": "通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。 一旦发起流程数超越该限制，该二维码将自动失效。",
          "example": "5"
        },
        {
          "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-身份证",
              "example": "ID_CARD"
            },
            {
              "name": "IdCardNumber",
              "type": "string",
              "required": false,
              "description": "指定签署人证件号码，字母大写",
              "example": "4500000000000000000"
            }
          ]
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。",
          "example": "VXNlckRhdGE="
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "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": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式，可多选 签名方式： HANDWRITE-手写签名 ESIGN-个人印章类型 OCR_ESIGN-AI智能识别手写签名 SYSTEM_ESIGN-系统签名",
              "example": "[\"HANDWRITE\"]",
              "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": [
        "Operator",
        "TemplateId",
        "FlowName"
      ]
    },
    {
      "name": "CreateOrganizationAuthFile",
      "description": "生成合成后的各类企业授权书，包括： - 企业认证超管授权书 - 超管变更授权书 - 企业注销授权书 注: 需自行保证传入真实的企业/法人/超管信息，否则后续的审核将会拒绝。",
      "status": "online",
      "parameters": [
        {
          "name": "OrganizationCommonInfo",
          "type": "object",
          "required": true,
          "description": "企业授权书信息参数， 需要自行保证这些参数跟营业执照中的信息一致。",
          "example": "无",
          "children": [
            {
              "name": "OrganizationName",
              "type": "string",
              "required": true,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
              "example": "张三示例企业"
            },
            {
              "name": "UniformSocialCreditCode",
              "type": "string",
              "required": true,
              "description": "组织机构企业统一社会信用代码。 请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。",
              "example": "370000****0303000X"
            },
            {
              "name": "LegalName",
              "type": "string",
              "required": true,
              "description": "组织机构法人的姓名。 请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。",
              "example": "张三"
            },
            {
              "name": "LegalIdCardType",
              "type": "string",
              "required": false,
              "description": "组织机构法人的证件类型",
              "example": "居民身份证"
            },
            {
              "name": "LegalIdCardNumber",
              "type": "string",
              "required": false,
              "description": "组织机构法人的证件号码",
              "example": "370000****0303000X"
            },
            {
              "name": "AdminName",
              "type": "string",
              "required": false,
              "description": "组织机构超管姓名。",
              "example": "张三"
            },
            {
              "name": "AdminMobile",
              "type": "string",
              "required": false,
              "description": "组织机构超管手机号。",
              "example": "1888****888"
            },
            {
              "name": "AdminIdCardType",
              "type": "string",
              "required": false,
              "description": "组织机构超管证件类型",
              "example": "居民身份证"
            },
            {
              "name": "AdminIdCardNumber",
              "type": "string",
              "required": false,
              "description": "组织机构超管证件号码",
              "example": "370000****0303000X"
            },
            {
              "name": "OldAdminName",
              "type": "string",
              "required": false,
              "description": "原超管姓名",
              "example": "李四"
            },
            {
              "name": "OldAdminMobile",
              "type": "string",
              "required": false,
              "description": "原超管手机号",
              "example": "1510****000"
            },
            {
              "name": "OldAdminIdCardType",
              "type": "string",
              "required": false,
              "description": "原超管证件类型",
              "example": "居民身份证"
            },
            {
              "name": "OldAdminIdCardNumber",
              "type": "string",
              "required": false,
              "description": "原超管证件号码",
              "example": "650000****0404000X"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Type",
          "type": "integer",
          "required": false,
          "description": "授权书类型： - 0: 企业认证超管授权书 - 1: 超管变更授权书 - 2: 企业注销授权书",
          "example": "0"
        }
      ],
      "required": [
        "OrganizationCommonInfo"
      ]
    },
    {
      "name": "CreateOrganizationAuthUrl",
      "description": "本接口（CreateOrganizationAuthUrl）的主要功能是生成合作企业的认证链接。 在生成链接的过程中，可以提供一部分已知信息，以便为对方进行认证流程提供便利。 ![image](https://qcloudimg.tencent-cloud.cn/raw/7ec91b79a0a4860e77c9ff9f4a5f13ad/channel_SyncProxyOrganization2.png) - **企业统一社会信用代码**: 对应上图中的**1** - **企业名称**: 对应上图中的**2** - **企业法定代表人的名字**:对应上图中的**3** - **\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "操作人信息",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "AuthorizationTypes",
          "type": "array",
          "required": false,
          "description": "指定授权方式 支持多选: 2: 法人授权方式 5: 授权书+对公打款方式",
          "example": "[2,5]",
          "item_type": "integer"
        },
        {
          "name": "OrganizationName",
          "type": "string",
          "required": false,
          "description": "认证企业名称，请确认该名称与企业营业执照中注册的名称一致。 注： 1. `如果名称中包含英文括号()，请使用中文括号（）代替。` 2. `EndPointType=“H5”或者\"SHORT_H5\"时，该参数必填`",
          "example": " 腾讯科技（深圳）有限公司"
        },
        {
          "name": "UniformSocialCreditCode",
          "type": "string",
          "required": false,
          "description": "企业统一社会信用代码",
          "example": "9144030071526726XG"
        },
        {
          "name": "LegalName",
          "type": "string",
          "required": false,
          "description": "企业法人的姓名",
          "example": "张三"
        },
        {
          "name": "AutoJumpUrl",
          "type": "string",
          "required": false,
          "description": "即将废弃，入参请使用JumpEvents。 认证完成跳回的链接，最长500个字符。",
          "example": "https://auth.qq.com/action-next?uid=12345"
        },
        {
          "name": "OrganizationAddress",
          "type": "string",
          "required": false,
          "description": "营业执照企业地址",
          "example": " 深圳市南山区高新区科技中一路腾讯大厦"
        },
        {
          "name": "AdminName",
          "type": "string",
          "required": false,
          "description": "认证人姓名",
          "example": "李四"
        },
        {
          "name": "AdminMobile",
          "type": "string",
          "required": false,
          "description": "认证人手机号",
          "example": "13200000000"
        },
        {
          "name": "AdminIdCardNumber",
          "type": "string",
          "required": false,
          "description": "认证人身份证号",
          "example": "620000198802020000"
        },
        {
          "name": "AdminIdCardType",
          "type": "string",
          "required": false,
          "description": "认证人证件类型， 支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
          "example": "ID_CARD "
        },
        {
          "name": "UniformSocialCreditCodeSame",
          "type": "boolean",
          "required": false,
          "description": "对方打开链接认证时，对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。true：启用状态，实际认证时必须与接口传递的信息完全相符。",
          "example": "false"
        },
        {
          "name": "LegalNameSame",
          "type": "boolean",
          "required": false,
          "description": "对方打开链接认证时，法人姓名是否要与接口传递上来的保持一致。false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。true：启用状态，实际认证时必须与接口传递的信息完全相符。 p.s. 仅在法人姓名不为空时有效",
          "example": "false"
        },
        {
          "name": "AdminNameSame",
          "type": "boolean",
          "required": false,
          "description": "对方打开链接认证时，认证人姓名是否要与接口传递上来的保持一致。false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。true：启用状态，实际认证时必须与接口传递的信息完全相符。 p.s. 仅在认证人姓名不为空时有效",
          "example": "false"
        },
        {
          "name": "AdminIdCardNumberSame",
          "type": "boolean",
          "required": false,
          "description": "对方打开链接认证时，认证人居民身份证件号是否要与接口传递上来的保持一致。false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。true：启用状态，实际认证时必须与接口传递的信息完全相符。 p.s. 仅在认证人身份证号不为空时有效",
          "example": "false"
        },
        {
          "name": "AdminMobileSame",
          "type": "boolean",
          "required": false,
          "description": "对方打开链接认证时，认证人手机号是否要与接口传递上来的保持一致。 false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。 true：启用状态，实际认证时必须与接口传递的信息完全相符。 p.s. 仅在认证人手机号不为空时有效",
          "example": "false"
        },
        {
          "name": "OrganizationNameSame",
          "type": "boolean",
          "required": false,
          "description": "对方打开链接认证时，企业名称是否要与接口传递上来的保持一致。false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。true：启用状态，实际认证时必须与接口传递的信息完全相符。 p.s. 仅在企业名称不为空时有效",
          "example": "false"
        },
        {
          "name": "BusinessLicense",
          "type": "string",
          "required": false,
          "description": "营业执照正面照（支持PNG或JPG格式）需以base64格式提供，且文件大小不得超过5MB。",
          "example": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW=="
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "跳转链接类型： PC：适用于PC端的认证链接 APP：用于全屏或半屏跳转的小程序链接 SHORT_URL：跳转小程序的链接的短链形式 H5：适用于H5页面的认证链接 SHORT_H5：H5认证链接的短链形式",
          "example": "PC"
        },
        {
          "name": "Initialization",
          "type": "array",
          "required": false,
          "description": "指定企业初始化引导，现在可以配置如下的选项： 1: 启用此选项后，在企业认证的最终步骤将添加创建印章的引导。如下图的位置 ![image](https://qcloudimg.tencent-cloud.cn/raw/88e0b45095a5c589de8995462ad755dc.jpg)",
          "example": "[1]",
          "item_type": "integer"
        },
        {
          "name": "PowerOfAttorneys",
          "type": "array",
          "required": false,
          "description": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。 授权书可以通过接口[生成企业授权书](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthFile) 来获得。 p.s. 如果上传授权书 ，需遵循以下条件 1. 超管的信息（超管姓名，超管手机号）必须为必填参数。 2. 认证方式AuthorizationTypes必须只能是上传授权书方式",
          "example": "[\"UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW\"]",
          "item_type": "string"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 4096长度。 在. 企业引导企业实名认证后回调中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
          "example": "55So5oi355qE5pWw5o2u"
        },
        {
          "name": "BankAccountNumber",
          "type": "string",
          "required": false,
          "description": "组织机构对公打款账号，账户名跟企业名称一致。 p.s. 只有认证方式是授权书+对公打款时才生效。",
          "example": "6222024060740816912"
        },
        {
          "name": "BankAccountNumberSame",
          "type": "boolean",
          "required": false,
          "description": "对方打开链接认证时，对公打款账号是否要与接口传递上来的保持一致。false（默认值）：关闭状态，实际认证时允许与接口传递的信息存在不一致。true：启用状态，实际认证时必须与接口传递的信息完全相符。 p.s. 仅在对公打款不为空时有效",
          "example": "false"
        },
        {
          "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/company/openqianh5/) p.s. 如果Endpoint是 APP，传递的跳转地址无效，不会进行跳转，仅会进行回跳。",
              "example": "https://qian.tencent.com/"
            }
          ]
        },
        {
          "name": "OrganizationIdCardType",
          "type": "string",
          "required": false,
          "description": "企业证照类型： **USCC** :(默认)工商组织营业执照 **PRACTICELICENSEOFMEDICALINSTITUTION** :医疗机构执业许可证 **CLINICFILLINGCERTIFICATE** :诊所备案证 注意 ： 如果企业证照类型是医疗机构执业许可证或者诊所备案证，则参数设置企业授权方式(AuthorizationTypes)和企业认证方式(AuthorizationMethods)都无效. 医疗机构执业许可证和诊所备案证的企业授权方式 仅有授权书的方式。企业认证仅有上传营业...",
          "example": "USCC"
        },
        {
          "name": "OrganizationIdCardTypeSame",
          "type": "boolean",
          "required": false,
          "description": "是否允许编辑企业注册时的证照类型 true:不允许编辑。 false:允许编辑（默认值）。 注意： 入参中的OrganizationIdCardType值不为空的时候，才可设置为不可编辑。",
          "example": "true"
        },
        {
          "name": "AuthorizationMethod",
          "type": "array",
          "required": false,
          "description": "指定企业认证的授权方式 支持多选: 1: 上传营业执照 2: 腾讯云快速认证 3: 腾讯商户号授权（仅支持小程序端） 注意： 1.如果没有指定，则默认是1,仅有上传营业执照。 2.H5 仅支持上传营业执照。",
          "example": "[1,2]",
          "item_type": "integer"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateOrganizationBatchSignUrl",
      "description": "使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。 注： 员工必须需作为批量签署合同的签署方，或者是或签合同的候选人之一。 本方企业签署链接：如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。 他方企业签署链接：传RecipientIds，且必须是合同发起方调用此接口。打开链接后需要他方签署人登录电...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "请指定需执行批量签署的流程ID，数量范围为1-100。您可登录腾讯电子签控制台，浏览 \"合同\"-\u003e\"合同中心\" 以查阅某一合同的FlowId（在页面中显示为合同ID）。用户将利用链接对这些合同实施批量操作。 注：生成动态签署方领取时此参数必传。",
          "example": "[\"yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw\"]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "员工在腾讯电子签平台的独特身份标识，为32位字符串。 您可登录腾讯电子签控制台，在 \"更多能力\"-\u003e\"组织管理\" 中查阅某位员工的UserId（在页面中显示为用户ID）。 UserId必须是传入合同（FlowId）中的签署人。 1. 若UserId为空，Name和Mobile 必须提供。 2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。",
          "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "员工姓名，必须与手机号码一起使用。 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。",
          "example": "张三"
        },
        {
          "name": "Mobile",
          "type": "string",
          "required": false,
          "description": "员工手机号，必须与姓名一起使用。 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。",
          "example": "187****7192"
        },
        {
          "name": "RecipientIds",
          "type": "array",
          "required": false,
          "description": "为签署方经办人在签署合同中的参与方ID，必须与参数FlowIds数组一一对应。您可以通过查询合同接口（DescribeFlowInfo）查询此参数。若传了此参数，则可以不传 UserId, Name, Mobile等参数 注：生成动态签署方领取时此参数必传。",
          "example": "[\"yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E\"]",
          "item_type": "string"
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": false,
          "description": "合同组Id，传入此参数则可以不传FlowIds",
          "example": "yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E"
        },
        {
          "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": "0"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "动态签署方时，预设的企业名称，预设企业名称后，只允许对应的企业员工进行领取签署。",
              "example": "典子谦有限公司"
            }
          ]
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateOrganizationGroupInvitationLink",
      "description": "生成集团加入链接，分享至子企业超管或者法人，子企业管理员可通过链接加入集团。 注意:调用当前接口的企业 必须为集团企业。如何成为集团企业可以参考下面的文档[集团操作文档](https://qian.tencent.com/document/86707)",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ExpireTime",
          "type": "integer",
          "required": true,
          "description": "到期时间（以秒为单位的时间戳），其上限为30天的有效期限。",
          "example": "1736494983"
        }
      ],
      "required": [
        "Operator",
        "ExpireTime"
      ]
    },
    {
      "name": "CreateOrganizationInfoChangeUrl",
      "description": "此接口（CreateOrganizationInfoChangeUrl）用于创建企业信息变更链接，支持创建企业超管变更链接或企业基础信息变更链接，通过入参ChangeType指定。 需要企业的现有的超级管理员、法人来点击链接执行变动操作。 ### 2. 企业基础信息 #### A. 可变动的信息 - **企业名称** - **法定代表人姓名**（新法人将收到邀请链接） - **企业地址和所在地** - **企业超级管理员变更** （此变更将企业超\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ChangeType",
          "type": "integer",
          "required": true,
          "description": "企业信息变更类型，可选类型如下： **1**：企业超管变更**2**：企业基础信息变更",
          "example": "1"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "ChangeType"
      ]
    },
    {
      "name": "CreatePartnerAutoSignAuthUrl",
      "description": "创建一个用于他方自动签授权的链接（可选择他方授权或我方授权）。通过这个链接，合作方企业可以直接进入小程序，进行自动签授权操作。 如果授权企业尚未开通企业自动签功能，该链接还将引导他们首先开通本企业的自动签服务 注: 1. 所在企业的超管、法人才有权限调用此接口(Operator.UserId 需要传递超管或者法人的UserId) 2. 已经在授权中或者授权成功的企业，无法重复授...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "AuthorizedOrganizationId",
          "type": "string",
          "required": false,
          "description": "被授企业id/授权方企业id（即OrganizationId），和AuthorizedOrganizationName二选一传入",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        },
        {
          "name": "AuthorizedOrganizationName",
          "type": "string",
          "required": false,
          "description": "被授企业名称/授权方企业的名字，和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。 注: `如果名称中包含英文括号()，请使用中文括号（）代替。`",
          "example": "企业名称"
        },
        {
          "name": "SealTypes",
          "type": "array",
          "required": false,
          "description": "在设置印章授权时，可以指定特定的印章类型，以确保在授权过程中只使用相应类型的印章。支持的印章类型包括： OFFICIAL：企业公章，用于代表企业对外的正式文件和重要事务的认证。 CONTRACT：合同专用章，专门用于签署各类合同。 FINANCE：财务专用章，用于企业的财务相关文件，如发票、收据等财务凭证的认证。 PERSONNEL：人事专用章，用于人事管理相关文件，如劳动合同\ufffd\ufffd...",
          "example": "[\"OFFICIAL\"]",
          "item_type": "string"
        },
        {
          "name": "AuthToMe",
          "type": "boolean",
          "required": false,
          "description": "在处理授权关系时，授权的方向 false（默认值）：表示我方授权他方。在这种情况下，AuthorizedOrganizationName 代表的是【被授权方】的企业名称，即接收授权的企业。 true：表示他方授权我方。在这种情况下，AuthorizedOrganizationName 代表的是【授权方】的企业名称，即提供授权的企业。",
          "example": "false"
        }
      ],
      "required": []
    },
    {
      "name": "CreatePersonAuthCertificateImage",
      "description": "获取个人用户认证证书图片下载URL 个人用户认证证书图片样式如下图 ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png) 注: 只能获取个人用户证明图片, 企业员工的暂不支持 专为电子处方单（医疗自动签）特定场景使用。在使用前，请务必与您的客户经理联系以确认已经开通电子处方单功能",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "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": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": false,
          "description": "自动签使用的场景值, 可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景 注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        }
      ],
      "required": [
        "Operator",
        "UserName",
        "IdCardType",
        "IdCardNumber"
      ]
    },
    {
      "name": "CreatePrepareFlow",
      "description": "创建发起流程Web页面，通过该接口可以获取发起流程的可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。在页面上完成签署控件等信息的编辑与确认后，可快速发起流程。 注意：调用接口后，流程不会立即发起，需在嵌入页面上点击【发起合同】按钮来发起流程。 嵌入页面长相如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源id，与ResourceType相对应，取值范围： 文件Id（通过UploadFiles获取文件资源Id） 模板Id（通过控制台创建模板后获取模板Id） 草稿Id（通过嵌入页面保存草稿后获取草稿Id） 注意：需要同时设置 ResourceType 参数指定资源类型",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        },
        {
          "name": "FlowName",
          "type": "string",
          "required": true,
          "description": "自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(\u0026)、（+）组成。 该名称还将用于合同签署完成后文件下载的默认文件名称。",
          "example": "合同名称"
        },
        {
          "name": "ResourceType",
          "type": "integer",
          "required": false,
          "description": "资源类型，取值有： **1**：模板 **2**：文件（默认值） **3**：草稿",
          "example": "1"
        },
        {
          "name": "Unordered",
          "type": "boolean",
          "required": false,
          "description": "合同流程的签署顺序类型： **false**：(默认)有序签署, 本合同多个参与人需要依次签署 **true**：无序签署, 本合同多个参与人没有先后签署限制",
          "example": "true"
        },
        {
          "name": "Deadline",
          "type": "integer",
          "required": false,
          "description": "合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。",
          "example": "1736477282"
        },
        {
          "name": "UserFlowTypeId",
          "type": "string",
          "required": false,
          "description": "用户自定义合同类型Id 该id为电子签企业内的合同类型id， 可以在控制台-合同-自定义合同类型处获取 注: `该参数如果和FlowType同时传，以该参数优先生效`",
          "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84"
        },
        {
          "name": "FlowType",
          "type": "string",
          "required": false,
          "description": "合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。",
          "example": "\"劳动合同\""
        },
        {
          "name": "Approvers",
          "type": "array",
          "required": false,
          "description": "合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。 如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ApproverType",
              "type": "integer",
              "required": true,
              "description": "在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下： 0 :企业B端。 1 :个人C端。 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。",
              "example": "1"
            },
            {
              "name": "OrganizationName",
              "type": "string",
              "required": false,
              "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`",
              "example": "张三示例企业"
            },
            {
              "name": "ApproverName",
              "type": "string",
              "required": false,
              "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 在未指定签署人电子签UserId情况下，为必填参数",
              "example": "张三"
            },
            {
              "name": "ApproverMobile",
              "type": "string",
              "required": false,
              "description": "签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。 注：`在未指定签署人电子签UserId情况下，为必填参数`",
              "example": "18888888888"
            },
            {
              "name": "ApproverIdCardType",
              "type": "string",
              "required": false,
              "description": "证件类型，支持以下类型 ID_CARD: 居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)",
              "example": "ID_CARD"
            },
            {
              "name": "ApproverIdCardNumber",
              "type": "string",
              "required": false,
              "description": "证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
              "example": "620000198802020000"
            },
            {
              "name": "RecipientId",
              "type": "string",
              "required": false,
              "description": "签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。 模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。 文件发起合同时，该参数无需传值。 如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "VerifyChannel",
              "type": "array",
              "required": false,
              "description": "签署意愿确认渠道，默认为WEIXINAPP:人脸识别 注: 不再使用, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`",
              "example": "[\"WEIXINAPP\"]",
              "item_type": "string"
            },
            {
              "name": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知 注: `既是发起方又是签署方时，不给此签署方发送短信`",
              "example": "none"
            },
            {
              "name": "IsFullText",
              "type": "boolean",
              "required": false,
              "description": "合同强制需要阅读全文，无需传此参数",
              "example": "true"
            },
            {
              "name": "PreReadTime",
              "type": "integer",
              "required": false,
              "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
              "example": "3"
            },
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得 注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "name": "Required",
              "type": "boolean",
              "required": false,
              "description": "字段不再使用，当前只支持true，默认为true",
              "example": "true"
            },
            {
              "name": "ApproverSource",
              "type": "string",
              "required": false,
              "description": "在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。",
              "example": "WEWORKAPP"
            },
            {
              "name": "CustomApproverTag",
              "type": "string",
              "required": false,
              "description": "在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。 所有参与或签的人员均需具备该标识。 注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。 如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。",
              "example": "n9527"
            },
            {
              "name": "RegisterInfo",
              "type": "object",
              "required": false,
              "description": "快速注册相关信息",
              "example": "无",
              "children": [
                {
                  "name": "LegalName",
                  "type": "string",
                  "required": true,
                  "description": "法人姓名",
                  "example": "张三"
                },
                {
                  "name": "UnifiedSocialCreditCode",
                  "type": "string",
                  "required": false,
                  "description": "社会统一信用代码",
                  "example": "91110108772551611J"
                },
                {
                  "name": "OrganizationAddress",
                  "type": "string",
                  "required": false,
                  "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
                  "example": "深圳市南山区高新区科技中一路腾讯大厦"
                },
                {
                  "name": "AuthorizationTypes",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 2: 法人授权方式 5: 授权书+对公打款方式",
                  "example": "[2,5]",
                  "item_type": "integer"
                },
                {
                  "name": "AuthorizationMethods",
                  "type": "array",
                  "required": false,
                  "description": "指定企业认证的授权方式 支持多选: 1: 上传营业执照 2: 腾讯云快速认证 3: 腾讯商户号授权（仅支持小程序端）",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "name": "OrganizationIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "企业证照类型： USCC :(默认)工商组织营业执照 PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证 CLINICFILLINGCERTIFICATE:诊所备案证",
                  "example": "USCC"
                },
                {
                  "name": "RegisterInfoOption",
                  "type": "object",
                  "required": false,
                  "description": "企业创建时候的个性化参数。 其中，包括一下内容： LegalNameSame 是否可以编辑法人。 UnifiedSocialCreditCodeSame 是否可以编辑证件号码。 OrganizationIdCardTypeSame 是否可以更改证照类型。",
                  "example": "无",
                  "children": [
                    {
                      "name": "LegalNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的法人姓名。 true：允许编辑false：不允许编辑（默认值） 注意： RegisterInfo 中的LegalName值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "UnifiedSocialCreditCodeCNameSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时统一社会信用代码。 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的UnifiedSocialCreditCode值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    },
                    {
                      "name": "OrganizationIdCardTypeSame",
                      "type": "boolean",
                      "required": false,
                      "description": "是否允许编辑企业注册时的证照类型 true:不允许编辑。 false:允许编辑（默认值）。 注意： RegisterInfo 中的OrganizationIdCardType值不为空的时候，才可设置为不可编辑。",
                      "example": "true"
                    }
                  ]
                }
              ]
            },
            {
              "name": "ApproverOption",
              "type": "object",
              "required": false,
              "description": "签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。",
              "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": "CanEditApprover",
                  "type": "boolean",
                  "required": false,
                  "description": "允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑",
                  "example": "true"
                },
                {
                  "name": "FillType",
                  "type": "integer",
                  "required": false,
                  "description": "签署人信息补充类型，默认无需补充。 **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充` 注： 1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关` 2. 此参数在嵌入式场景下无效。",
                  "example": "1"
                },
                {
                  "name": "FlowReadLimit",
                  "type": "string",
                  "required": false,
                  "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                  "example": "LimitReadTimeAndBottom"
                },
                {
                  "name": "ForbidAddSignDate",
                  "type": "boolean",
                  "required": false,
                  "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件",
                  "example": "false"
                }
              ]
            },
            {
              "name": "SignId",
              "type": "string",
              "required": false,
              "description": "签署人的签署ID 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。",
              "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN"
            },
            {
              "name": "ApproverNeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "此签署人(员工或者个人)签署时，是否需要发起方企业审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业通知腾讯电...",
              "example": "true"
            },
            {
              "name": "SignComponents",
              "type": "array",
              "required": false,
              "description": "签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效 合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件 `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效 合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 动态表格等填写控件 `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "ComponentLimitType",
              "type": "array",
              "required": false,
              "description": "当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG...",
              "example": "[\"HANDWRITE\"]",
              "item_type": "string"
            },
            {
              "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**：\ufffd\ufffd...",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "name": "SignTypeSelector",
              "type": "integer",
              "required": false,
              "description": "生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值： **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择； **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。 注： `不指定该值时，默认为签署方自行选择。`",
              "example": "0"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
              "example": "1604912664"
            },
            {
              "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": "NotSaveContact",
              "type": "boolean",
              "required": false,
              "description": "是否不保存联系人 默认 false 保存联系人 true 不保存联系人 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。 如下图位置： ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)",
              "example": "false"
            }
          ]
        },
        {
          "name": "IntelligentStatus",
          "type": "string",
          "required": false,
          "description": "开启或者关闭智能添加填写区： **OPEN**：开启（默认值） **CLOSE**：关闭",
          "example": "OPEN"
        },
        {
          "name": "Components",
          "type": "object",
          "required": false,
          "description": "该字段已不再使用，请使用InitiatorComponents",
          "example": "无",
          "children": [
            {
              "name": "ComponentType",
              "type": "string",
              "required": true,
              "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": "ComponentHeight",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
              "example": "43.1"
            },
            {
              "name": "ComponentWidth",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
              "example": "119.1"
            },
            {
              "name": "ComponentPage",
              "type": "integer",
              "required": true,
              "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
              "example": "1"
            },
            {
              "name": "ComponentPosX",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
              "example": "100.1"
            },
            {
              "name": "ComponentPosY",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
              "example": "100.1"
            },
            {
              "name": "FileIndex",
              "type": "integer",
              "required": true,
              "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
              "example": "0"
            },
            {
              "name": "GenerateMode",
              "type": "string",
              "required": false,
              "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
              "example": "NORMAL"
            },
            {
              "name": "ComponentId",
              "type": "string",
              "required": false,
              "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
              "example": "ComponentId_01"
            },
            {
              "name": "ComponentName",
              "type": "string",
              "required": false,
              "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
              "example": "price"
            },
            {
              "name": "ComponentRequired",
              "type": "boolean",
              "required": false,
              "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
              "example": "true"
            },
            {
              "name": "ComponentRecipientId",
              "type": "string",
              "required": false,
              "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
              "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
            },
            {
              "name": "IsFormType",
              "type": "boolean",
              "required": false,
              "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
              "example": "false"
            },
            {
              "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_SE...",
              "example": "100元"
            },
            {
              "name": "OffsetX",
              "type": "float",
              "required": false,
              "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
              "example": "10.1"
            },
            {
              "name": "OffsetY",
              "type": "float",
              "required": false,
              "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
              "example": "10.1"
            },
            {
              "name": "KeywordOrder",
              "type": "string",
              "required": false,
              "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
              "example": "Positive\\Reverse"
            },
            {
              "name": "KeywordPage",
              "type": "integer",
              "required": false,
              "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
              "example": "1"
            },
            {
              "name": "RelativeLocation",
              "type": "string",
              "required": false,
              "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
              "example": "LowerRight"
            },
            {
              "name": "KeywordIndexes",
              "type": "array",
              "required": false,
              "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "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": "ComponentDateFontSize",
              "type": "integer",
              "required": false,
              "description": "【暂未使用】日期签署控件的字号，默认为 12",
              "example": "12"
            },
            {
              "name": "ChannelComponentId",
              "type": "string",
              "required": false,
              "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "ChannelComponentSource",
              "type": "integer",
              "required": false,
              "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
              "example": "0"
            }
          ]
        },
        {
          "name": "FlowOption",
          "type": "object",
          "required": false,
          "description": "发起合同个性化参数 用于满足创建及页面操作过程中的个性化要求 具体定制化内容详见数据接口说明",
          "example": "无",
          "children": [
            {
              "name": "CanEditFlow",
              "type": "boolean",
              "required": false,
              "description": "是否允许修改发起合同时确认弹窗的合同信息（合同名称、合同类型、签署截止时间），若不允许编辑，则表单字段将被禁止输入。 true：允许编辑false：不允许编辑（默认值）",
              "example": "true"
            },
            {
              "name": "CanEditFormField",
              "type": "boolean",
              "required": false,
              "description": "是否允许编辑模板控件 true:允许编辑模板控件信息 false:不允许编辑模板控件信息（默认值）",
              "example": "true"
            },
            {
              "name": "HideShowFlowName",
              "type": "boolean",
              "required": false,
              "description": "发起页面隐藏合同名称展示 true:发起页面隐藏合同名称展示 false:发起页面不隐藏合同名称展示（默认值）",
              "example": "true"
            },
            {
              "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": "true"
            },
            {
              "name": "SkipUploadFile",
              "type": "boolean",
              "required": false,
              "description": "文件发起页面跳过文件上传步骤 true:文件发起页面跳过文件上传步骤 false:文件发起页面不跳过文件上传步骤（默认值）",
              "example": "true"
            },
            {
              "name": "ForbidEditFillComponent",
              "type": "boolean",
              "required": false,
              "description": "禁止编辑填写控件 true:禁止编辑填写控件 false:允许编辑填写控件（默认值）",
              "example": "true"
            },
            {
              "name": "CustomCreateFlowDescription",
              "type": "string",
              "required": false,
              "description": "定制化发起合同弹窗的描述信息，描述信息最长500字符",
              "example": "\"合同不能转发和截图\""
            },
            {
              "name": "ForbidAddApprover",
              "type": "boolean",
              "required": false,
              "description": "禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”",
              "example": "true"
            },
            {
              "name": "ForbidEditApprover",
              "type": "boolean",
              "required": false,
              "description": "是否可以编辑签署人包括新增，修改，删除 （默认） false -可以编辑签署人 true - 禁止编辑签署人 注意：如果设置参数为 true， 则 参数签署人 [FlowApproverList](https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow) 不能为空",
              "example": "false"
            },
            {
              "name": "ForbidEditFlowProperties",
              "type": "boolean",
              "required": false,
              "description": "禁止设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板",
              "example": "true"
            },
            {
              "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": "ResultPageConfig",
              "type": "array",
              "required": false,
              "description": "发起流程的可嵌入页面结果页配置",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Type",
                  "type": "integer",
                  "required": true,
                  "description": "0 : 发起审批成功页面（通过接口创建发起流程web页面发起时设置了NeedCreateReview参数为true）",
                  "example": "0"
                },
                {
                  "name": "Title",
                  "type": "string",
                  "required": true,
                  "description": "结果页标题，不超过50字",
                  "example": "发起成功"
                },
                {
                  "name": "Description",
                  "type": "string",
                  "required": false,
                  "description": "结果页描述，不超过200字",
                  "example": "发起成功"
                }
              ]
            },
            {
              "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": "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": "true"
            },
            {
              "name": "PreviewAfterStart",
              "type": "boolean",
              "required": false,
              "description": "发起成功后是否预览合同 （默认） false -否 true - 展示预览按钮",
              "example": "false"
            },
            {
              "name": "SignAfterStart",
              "type": "boolean",
              "required": false,
              "description": "发起成功之后是否签署合同，仅当前经办人作为签署人时生效 （默认） false -否 true - 展示签署按钮",
              "example": "false"
            },
            {
              "name": "NeedFlowDraft",
              "type": "boolean",
              "required": false,
              "description": "发起过程中是否保存草稿",
              "example": "false"
            }
          ]
        },
        {
          "name": "NeedSignReview",
          "type": "boolean",
          "required": false,
          "description": "发起方企业签署员工，在进行签署操作前，是否需要先通过企业内部审批流程 （签署审核） 1. **false（默认）**： 无需审批，发起方企业签署员工可直接进行签署操作。 2. **true**： 需要先走企业内部审批流程。 当流程进展到发起方企业签署员工时，其签署操作会被阻塞，等待企业内部审批结果。 企业应通过 提交签署流程审批结果审批接口，将内部审批结果通知腾讯电子签平\ufffd...",
          "example": "false"
        },
        {
          "name": "NeedCreateReview",
          "type": "boolean",
          "required": false,
          "description": "发起方在创建合同流程前，是否必须先通过企业内部审批流程 （发起审核） 当设置为 `true` 时： 1. 您需要在企业内部完成审批，并通过接口 提交签署流程审批结果 将审批结果回传给腾讯电子签。 2. 只有当审核状态为“通过”时，合同流程正常发起。 3. 若未通过或未回传审核结果，发起操作将被阻塞，阻止合同流程。 当设置为 `false` （默认值）时： 发起方无需经过企业内部...",
          "example": "false"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。",
          "example": "自定义数据"
        },
        {
          "name": "CcInfos",
          "type": "array",
          "required": false,
          "description": "合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "被抄送方手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此业务通知方。",
              "example": "1320****000"
            },
            {
              "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": "NotifyType",
              "type": "string",
              "required": false,
              "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知",
              "example": "sms"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": false,
          "description": "合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接 注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`",
          "example": "yDwcCUUgyg3tgmvhUEVzyNa15Zayy6Sf"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "InitiatorComponents",
          "type": "array",
          "required": false,
          "description": "模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ComponentType",
              "type": "string",
              "required": true,
              "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": "ComponentHeight",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
              "example": "43.1"
            },
            {
              "name": "ComponentWidth",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
              "example": "119.1"
            },
            {
              "name": "ComponentPage",
              "type": "integer",
              "required": true,
              "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
              "example": "1"
            },
            {
              "name": "ComponentPosX",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
              "example": "100.1"
            },
            {
              "name": "ComponentPosY",
              "type": "float",
              "required": true,
              "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
              "example": "100.1"
            },
            {
              "name": "FileIndex",
              "type": "integer",
              "required": true,
              "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
              "example": "0"
            },
            {
              "name": "GenerateMode",
              "type": "string",
              "required": false,
              "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
              "example": "NORMAL"
            },
            {
              "name": "ComponentId",
              "type": "string",
              "required": false,
              "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
              "example": "ComponentId_01"
            },
            {
              "name": "ComponentName",
              "type": "string",
              "required": false,
              "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
              "example": "price"
            },
            {
              "name": "ComponentRequired",
              "type": "boolean",
              "required": false,
              "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
              "example": "true"
            },
            {
              "name": "ComponentRecipientId",
              "type": "string",
              "required": false,
              "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
              "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
            },
            {
              "name": "IsFormType",
              "type": "boolean",
              "required": false,
              "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
              "example": "false"
            },
            {
              "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_SE...",
              "example": "100元"
            },
            {
              "name": "OffsetX",
              "type": "float",
              "required": false,
              "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
              "example": "10.1"
            },
            {
              "name": "OffsetY",
              "type": "float",
              "required": false,
              "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
              "example": "10.1"
            },
            {
              "name": "KeywordOrder",
              "type": "string",
              "required": false,
              "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
              "example": "Positive\\Reverse"
            },
            {
              "name": "KeywordPage",
              "type": "integer",
              "required": false,
              "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
              "example": "1"
            },
            {
              "name": "RelativeLocation",
              "type": "string",
              "required": false,
              "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
              "example": "LowerRight"
            },
            {
              "name": "KeywordIndexes",
              "type": "array",
              "required": false,
              "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
              "example": "[1,2]",
              "item_type": "integer"
            },
            {
              "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": "ComponentDateFontSize",
              "type": "integer",
              "required": false,
              "description": "【暂未使用】日期签署控件的字号，默认为 12",
              "example": "12"
            },
            {
              "name": "ChannelComponentId",
              "type": "string",
              "required": false,
              "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "ChannelComponentSource",
              "type": "integer",
              "required": false,
              "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
              "example": "0"
            }
          ]
        },
        {
          "name": "FlowDisplayType",
          "type": "integer",
          "required": false,
          "description": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 3 :文书效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)",
          "example": "1"
        },
        {
          "name": "Workflow",
          "type": "boolean",
          "required": false,
          "description": "是否开启嵌入式合同发起时，提交发起审批流，默认：false（不开启），开启后，嵌入式合同发起后，会提交电子签内置审批流",
          "example": "false"
        }
      ],
      "required": [
        "Operator",
        "ResourceId",
        "FlowName"
      ]
    },
    {
      "name": "CreatePrepareFlowGroup",
      "description": "接口（CreatePrepareFlowGroup）用于创建嵌入式合同组签署流程。 - 该接口当前仅支持文件发起 - 该接口能力和CreateFlowGroupByFiles，~~CreateFlowGroupByTemplates~~保持一致。 - 返回的FlowGroupId 为临时id，只有在页面内成功发起后FlowGroupId才会有效。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowGroupName",
          "type": "string",
          "required": true,
          "description": "合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。",
          "example": "入职合同集"
        },
        {
          "name": "FlowGroupInfos",
          "type": "array",
          "required": true,
          "description": "合同（流程）组的子合同信息，支持2-50个子合同",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FlowName",
              "type": "string",
              "required": true,
              "description": "合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。",
              "example": "2025入职合同"
            },
            {
              "name": "Approvers",
              "type": "array",
              "required": true,
              "description": "签署流程参与者信息，最大限制50方 注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ApproverType",
                  "type": "integer",
                  "required": true,
                  "description": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: **0**：企业 **1**：个人 **3**：企业静默签署 注：`类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。` **7**: 个人自动签署，适用于个人自动签场景。 注: `个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "0"
                },
                {
                  "name": "ApproverName",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
                  "example": "张三"
                },
                {
                  "name": "ApproverMobile",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。",
                  "example": "18888888888"
                },
                {
                  "name": "OrganizationName",
                  "type": "string",
                  "required": false,
                  "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。",
                  "example": "张三示例企业"
                },
                {
                  "name": "SignComponents",
                  "type": "array",
                  "required": false,
                  "description": "【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件 ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "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": "ComponentHeight",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "43.1"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "119.1"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": true,
                      "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": true,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                      "example": "ComponentId_01"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                      "example": "price"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "true"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                      "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                    },
                    {
                      "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                      "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                    },
                    {
                      "name": "IsFormType",
                      "type": "boolean",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                      "example": "false"
                    },
                    {
                      "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_SE...",
                      "example": "100元"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "1"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "LowerRight"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                      "example": "[1,2]",
                      "item_type": "integer"
                    },
                    {
                      "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": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                    },
                    {
                      "name": "ChannelComponentSource",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                      "example": "0"
                    }
                  ]
                },
                {
                  "name": "ApproverIdCardType",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件类型，支持以下类型，样式可以参考常见个人证件类型介绍 ID_CARD 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证) OTHER_CARD_TYPE 其他证件 注: 1. 其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。 2. 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人至少\ufffd...",
                  "example": "ID_CARD"
                },
                {
                  "name": "ApproverIdCardNumber",
                  "type": "string",
                  "required": false,
                  "description": "签署方经办人的证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
                  "example": "350203180010069855"
                },
                {
                  "name": "NotifyType",
                  "type": "string",
                  "required": false,
                  "description": "通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知 注意： `如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信`",
                  "example": "sms"
                },
                {
                  "name": "ApproverRole",
                  "type": "integer",
                  "required": false,
                  "description": "收据场景设置签署人角色类型, 可以设置如下类型: **1** :收款人 **2** :开具人 **3** :见证人 注: `收据场景为白名单功能，使用前请联系对接的客户经理沟通。`",
                  "example": "1"
                },
                {
                  "name": "ApproverRoleName",
                  "type": "string",
                  "required": false,
                  "description": "可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
                  "example": "收款人"
                },
                {
                  "name": "VerifyChannel",
                  "type": "array",
                  "required": false,
                  "description": "【已不再使用】签署意愿确认渠道，默认为WEIXINAPP:人脸识别 注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置",
                  "example": "[\"WEIXINAPP\"]",
                  "item_type": "string"
                },
                {
                  "name": "PreReadTime",
                  "type": "integer",
                  "required": false,
                  "description": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。 若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下： 合同页数少于等于2页，阅读时间为3秒； 合同页数为3到5页，阅读时间为5秒； 合同页数大于等于6页，阅读时间为10秒。",
                  "example": "3"
                },
                {
                  "name": "UserId",
                  "type": "string",
                  "required": false,
                  "description": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得 注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "name": "ApproverSource",
                  "type": "string",
                  "required": false,
                  "description": "在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。",
                  "example": "WEWORKAPP"
                },
                {
                  "name": "CustomApproverTag",
                  "type": "string",
                  "required": false,
                  "description": "在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。 所有参与或签的人员均需具备该标识。 注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。 如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。",
                  "example": "n9527"
                },
                {
                  "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": "CanEditApprover",
                      "type": "boolean",
                      "required": false,
                      "description": "允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑",
                      "example": "true"
                    },
                    {
                      "name": "FillType",
                      "type": "integer",
                      "required": false,
                      "description": "签署人信息补充类型，默认无需补充。 **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充` 注： 1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关` 2. 此参数在嵌入式场景下无效。",
                      "example": "1"
                    },
                    {
                      "name": "FlowReadLimit",
                      "type": "string",
                      "required": false,
                      "description": "签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）",
                      "example": "LimitReadTimeAndBottom"
                    },
                    {
                      "name": "ForbidAddSignDate",
                      "type": "boolean",
                      "required": false,
                      "description": "禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：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**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才\ufffd\ufffd...",
                  "example": "[1,2,3]",
                  "item_type": "integer"
                },
                {
                  "name": "ApproverNeedSignReview",
                  "type": "boolean",
                  "required": false,
                  "description": "此签署人（员工或者个人）签署前，是否需要发起方企业审批，取值如下： **false**：（默认）不需要审批，直接签署。 **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业通知腾\ufffd\ufffd...",
                  "example": "false"
                },
                {
                  "name": "AddSignComponentsLimits",
                  "type": "array",
                  "required": false,
                  "description": "【在用文件发起合同场景下才有效】在调用[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID或者印章类型）或签名方式。 注：`限制印章控件或骑缝章控件情况下,仅\ufffd\ufffd...",
                  "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_PAGING_SEAL "
                    },
                    {
                      "name": "ComponentValue",
                      "type": "array",
                      "required": false,
                      "description": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他 **注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署\ufffd\ufffd...",
                      "example": "OFFICIAL",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "SignInstructionContent",
                  "type": "string",
                  "required": false,
                  "description": "签署须知：支持传入富文本，最长字数：500个中文字符",
                  "example": "这个合同不能截图转发"
                },
                {
                  "name": "Deadline",
                  "type": "integer",
                  "required": false,
                  "description": "签署人的签署截止时间，格式为Unix标准时间戳（秒） 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
                  "example": "1705977064"
                },
                {
                  "name": "Components",
                  "type": "array",
                  "required": false,
                  "description": "【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件) 注：`此参数仅...",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "ComponentType",
                      "type": "string",
                      "required": true,
                      "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": "ComponentHeight",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                      "example": "43.1"
                    },
                    {
                      "name": "ComponentWidth",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                      "example": "119.1"
                    },
                    {
                      "name": "ComponentPage",
                      "type": "integer",
                      "required": true,
                      "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                      "example": "1"
                    },
                    {
                      "name": "ComponentPosX",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "ComponentPosY",
                      "type": "float",
                      "required": true,
                      "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                      "example": "100.1"
                    },
                    {
                      "name": "FileIndex",
                      "type": "integer",
                      "required": true,
                      "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                      "example": "0"
                    },
                    {
                      "name": "GenerateMode",
                      "type": "string",
                      "required": false,
                      "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                      "example": "NORMAL"
                    },
                    {
                      "name": "ComponentId",
                      "type": "string",
                      "required": false,
                      "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                      "example": "ComponentId_01"
                    },
                    {
                      "name": "ComponentName",
                      "type": "string",
                      "required": false,
                      "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                      "example": "price"
                    },
                    {
                      "name": "ComponentRequired",
                      "type": "boolean",
                      "required": false,
                      "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                      "example": "true"
                    },
                    {
                      "name": "ComponentRecipientId",
                      "type": "string",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                      "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                    },
                    {
                      "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                      "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                    },
                    {
                      "name": "IsFormType",
                      "type": "boolean",
                      "required": false,
                      "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                      "example": "false"
                    },
                    {
                      "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_SE...",
                      "example": "100元"
                    },
                    {
                      "name": "OffsetX",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "OffsetY",
                      "type": "float",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                      "example": "10.1"
                    },
                    {
                      "name": "KeywordOrder",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                      "example": "Positive\\Reverse"
                    },
                    {
                      "name": "KeywordPage",
                      "type": "integer",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                      "example": "1"
                    },
                    {
                      "name": "RelativeLocation",
                      "type": "string",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                      "example": "LowerRight"
                    },
                    {
                      "name": "KeywordIndexes",
                      "type": "array",
                      "required": false,
                      "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                      "example": "[1,2]",
                      "item_type": "integer"
                    },
                    {
                      "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": "ComponentDateFontSize",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】日期签署控件的字号，默认为 12",
                      "example": "12"
                    },
                    {
                      "name": "ChannelComponentId",
                      "type": "string",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                      "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                    },
                    {
                      "name": "ChannelComponentSource",
                      "type": "integer",
                      "required": false,
                      "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                      "example": "0"
                    }
                  ]
                },
                {
                  "name": "SignEndpoints",
                  "type": "array",
                  "required": false,
                  "description": "进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。",
                  "example": "[\"link\"]",
                  "item_type": "string"
                },
                {
                  "name": "RegisterInfo",
                  "type": "object",
                  "required": false,
                  "description": "快速注册相关信息",
                  "example": "无",
                  "children": [
                    {
                      "name": "LegalName",
                      "type": "string",
                      "required": true,
                      "description": "法人姓名",
                      "example": "张三"
                    },
                    {
                      "name": "UnifiedSocialCreditCode",
                      "type": "string",
                      "required": false,
                      "description": "社会统一信用代码",
                      "example": "91110108772551611J"
                    },
                    {
                      "name": "OrganizationAddress",
                      "type": "string",
                      "required": false,
                      "description": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
                      "example": "深圳市南山区高新区科技中一路腾讯大厦"
                    },
                    {
                      "name": "AuthorizationTypes",
                      "type": "array",
                      "required": false,
                      "description": "指定企业认证的授权方式 支持多选: 2: 法人授权方式 5: 授权书+对公打款方式",
                      "example": "[2,5]",
                      "item_type": "integer"
                    },
                    {
                      "name": "AuthorizationMethods",
                      "type": "array",
                      "required": false,
                      "description": "指定企业认证的授权方式 支持多选: 1: 上传营业执照 2: 腾讯云快速认证 3: 腾讯商户号授权（仅支持小程序端）",
                      "example": "[1,2]",
                      "item_type": "integer"
                    },
                    {
                      "name": "OrganizationIdCardType",
                      "type": "string",
                      "required": false,
                      "description": "企业证照类型： USCC :(默认)工商组织营业执照 PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证 CLINICFILLINGCERTIFICATE:诊所备案证",
                      "example": "USCC"
                    },
                    {
                      "name": "RegisterInfoOption",
                      "type": "object",
                      "required": false,
                      "description": "企业创建时候的个性化参数。 其中，包括一下内容： LegalNameSame 是否可以编辑法人。 UnifiedSocialCreditCodeSame 是否可以编辑证件号码。 OrganizationIdCardTypeSame 是否可以更改证照类型。",
                      "example": "无"
                    }
                  ]
                },
                {
                  "name": "NotSaveContact",
                  "type": "boolean",
                  "required": false,
                  "description": "是否不保存联系人 默认 false 保存联系人 true 不保存联系人 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。 如下图位置： ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)",
                  "example": "false"
                }
              ]
            },
            {
              "name": "FileIds",
              "type": "array",
              "required": false,
              "description": "文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。 注：此字段定义为数组，但仅支持单个文件",
              "example": "[\"yDt1JUUckp77a2omUyEmko88eg49PTsN\"]",
              "item_type": "string"
            },
            {
              "name": "TemplateId",
              "type": "string",
              "required": false,
              "description": "合同模板ID，为32位字符串。 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。 可登录腾讯电子签控制台，在 \"模板\"-\u003e\"模板中心\"-\u003e\"列表展示设置\"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。",
              "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "FlowType",
              "type": "string",
              "required": false,
              "description": "签署流程的类型(如销售合同/入职合同等)，最大长度200个字符",
              "example": "劳务合同"
            },
            {
              "name": "FlowDescription",
              "type": "string",
              "required": false,
              "description": "签署流程描述,最大长度1000个字符",
              "example": "2025入职合同"
            },
            {
              "name": "Deadline",
              "type": "integer",
              "required": false,
              "description": "签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后 示例值：1604912664",
              "example": "1736751627"
            },
            {
              "name": "UserData",
              "type": "string",
              "required": false,
              "description": "调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。",
              "example": "VXNlckRhdGE="
            },
            {
              "name": "Unordered",
              "type": "boolean",
              "required": false,
              "description": "发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致 示例值：true",
              "example": "true"
            },
            {
              "name": "Components",
              "type": "array",
              "required": false,
              "description": "模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 单行文本控件 多行文本控件 勾选框控件 数字控件 图片控件 动态表格等填写控件",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "ComponentType",
                  "type": "string",
                  "required": true,
                  "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": "ComponentHeight",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。",
                  "example": "43.1"
                },
                {
                  "name": "ComponentWidth",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。",
                  "example": "119.1"
                },
                {
                  "name": "ComponentPage",
                  "type": "integer",
                  "required": true,
                  "description": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码 **在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。 注： 1. 页码编号是从1开始编号的。 2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF\ufffd...",
                  "example": "1"
                },
                {
                  "name": "ComponentPosX",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "ComponentPosY",
                  "type": "float",
                  "required": true,
                  "description": "**在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。",
                  "example": "100.1"
                },
                {
                  "name": "FileIndex",
                  "type": "integer",
                  "required": true,
                  "description": "【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0",
                  "example": "0"
                },
                {
                  "name": "GenerateMode",
                  "type": "string",
                  "required": false,
                  "description": "控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）",
                  "example": "NORMAL"
                },
                {
                  "name": "ComponentId",
                  "type": "string",
                  "required": false,
                  "description": "控件唯一ID。 **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。 例： - 如传入的关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的...",
                  "example": "ComponentId_01"
                },
                {
                  "name": "ComponentName",
                  "type": "string",
                  "required": false,
                  "description": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。 **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。 注：`控件名可以在一个PDF中可以重复` 点击查看ComponentName在模板页面的位置",
                  "example": "price"
                },
                {
                  "name": "ComponentRequired",
                  "type": "boolean",
                  "required": false,
                  "description": "如果是填写控件，ComponentRequired表示在填写页面此控件是否必填 false（默认）：可以不填写 true ：必须填写此填写控件 如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响",
                  "example": "true"
                },
                {
                  "name": "ComponentRecipientId",
                  "type": "string",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**",
                  "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
                },
                {
                  "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 参数样例：`{\"FontColor\":\"255,0,0\",\"FontSize\":12,\"Bold\":false}` ComponentType为DATE时\ufffd...",
                  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
                },
                {
                  "name": "IsFormType",
                  "type": "boolean",
                  "required": false,
                  "description": "**在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**",
                  "example": "false"
                },
                {
                  "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_SE...",
                  "example": "100元"
                },
                {
                  "name": "OffsetX",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： `向左调整设置为负数， 向右调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "OffsetY",
                  "type": "float",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： `向上调整设置为负数， 向下调整设置成正数`",
                  "example": "10.1"
                },
                {
                  "name": "KeywordOrder",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的\ufffd\ufffd...",
                  "example": "Positive\\Reverse"
                },
                {
                  "name": "KeywordPage",
                  "type": "integer",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
                  "example": "1"
                },
                {
                  "name": "RelativeLocation",
                  "type": "string",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
                  "example": "LowerRight"
                },
                {
                  "name": "KeywordIndexes",
                  "type": "array",
                  "required": false,
                  "description": "**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。 注意：关键字索引是从0开始计数的",
                  "example": "[1,2]",
                  "item_type": "integer"
                },
                {
                  "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": "ComponentDateFontSize",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】日期签署控件的字号，默认为 12",
                  "example": "12"
                },
                {
                  "name": "ChannelComponentId",
                  "type": "string",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成平台模板控件 ID 标识",
                  "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
                },
                {
                  "name": "ChannelComponentSource",
                  "type": "integer",
                  "required": false,
                  "description": "【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义",
                  "example": "0"
                }
              ]
            },
            {
              "name": "NeedSignReview",
              "type": "boolean",
              "required": false,
              "description": "发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、...",
              "example": "true"
            },
            {
              "name": "AutoSignScene",
              "type": "string",
              "required": false,
              "description": "个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN",
              "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": "ResourceType",
          "type": "integer",
          "required": true,
          "description": "资源类型，取值有： **1**：模板 **2**：文件",
          "example": "2"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "FlowGroupOptions",
          "type": "object",
          "required": false,
          "description": "合同组发起控制参数，当前仅支持FlowGroupNeedWorkflow，表示开启嵌入式合同组发起审批",
          "example": "无",
          "children": [
            {
              "name": "ApproverVerifyType",
              "type": "string",
              "required": false,
              "description": "签署人校验方式,支持以下类型 VerifyCheck : 人脸识别 (默认值) MobileCheck : 手机号验证 参数说明：此参数仅在合同组文件发起有效，可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。",
              "example": "VerifyCheck"
            },
            {
              "name": "SelfOrganizationApproverNotifyType",
              "type": "string",
              "required": false,
              "description": "发起合同（流程）组本方企业经办人通知方式 签署通知类型，支持以下类型 sms : 短信 (默认值)none : 不通知",
              "example": "none"
            },
            {
              "name": "OtherApproverNotifyType",
              "type": "string",
              "required": false,
              "description": "发起合同（流程）组他方经办人通知方式 签署通知类型，支持以下类型 sms : 短信 (默认值)none : 不通知",
              "example": "none"
            },
            {
              "name": "FlowGroupNeedWorkflow",
              "type": "boolean",
              "required": false,
              "description": "是否开启发起合同组的发起审批，默认：false(不开启)，开启后，发起合同组会提交电子签内置审批流",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "FlowGroupName",
        "FlowGroupInfos",
        "ResourceType"
      ]
    },
    {
      "name": "CreatePreparedPersonalEsign",
      "description": "本接口（CreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，使用此接口请与客户经理确认）。",
      "status": "online",
      "parameters": [
        {
          "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": "420528****1929"
        },
        {
          "name": "SealName",
          "type": "string",
          "required": true,
          "description": "印章名称，长度1-50个字。",
          "example": "财务章"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "IdCardType",
          "type": "string",
          "required": false,
          "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同 中国大陆居民身份证)",
          "example": "ID_CARD"
        },
        {
          "name": "SealImageCompress",
          "type": "boolean",
          "required": false,
          "description": "是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。",
          "example": "false"
        },
        {
          "name": "Mobile",
          "type": "string",
          "required": false,
          "description": "手机号码；当需要开通自动签时，该参数必传",
          "example": "187****7831"
        },
        {
          "name": "EnableAutoSign",
          "type": "boolean",
          "required": false,
          "description": "该字段已不再使用",
          "example": "false"
        },
        {
          "name": "SealColor",
          "type": "string",
          "required": false,
          "description": "印章颜色（参数ProcessSeal=true时生效） 默认值：BLACK黑色 取值: BLACK 黑色, RED 红色, BLUE 蓝色。",
          "example": "BLACK"
        },
        {
          "name": "ProcessSeal",
          "type": "boolean",
          "required": false,
          "description": "是否处理印章，默认不做印章处理。 取值如下： false：不做任何处理； true：做透明化处理和颜色增强。",
          "example": "false"
        },
        {
          "name": "FileId",
          "type": "string",
          "required": false,
          "description": "印章图片文件 id 取值： 填写的FileId通过UploadFiles接口上传文件获取。",
          "example": "false"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "LicenseType",
          "type": "integer",
          "required": false,
          "description": "设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减",
          "example": "0"
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": false,
          "description": "自动签使用的场景值, 可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景 注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        }
      ],
      "required": [
        "UserName",
        "IdCardNumber",
        "SealName"
      ]
    },
    {
      "name": "CreateReleaseFlow",
      "description": "发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。 解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。具体用法可以参考文档[合同解除](https://qian.tencent.com/developers/company/flow_release)。 注意： 完成原合同签署后方可发起解除协议：只有在原合同所有签署人完成签署后，才可以启动解除协议的流程。 原合同状态更新：解除...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "NeedRelievedFlowId",
          "type": "string",
          "required": true,
          "description": "待解除的签署流程编号（即原签署流程的编号）。",
          "example": "yDwFmUUckpst10i3UubBSat8PWOt2iQF"
        },
        {
          "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": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ReleasedApprovers",
          "type": "array",
          "required": false,
          "description": "替换解除协议的签署人， 如不指定新的签署人，将继续使用原流程的签署人作为本解除协议的参与方。 如需更换原合同中的企业端签署人，可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口DescribeFlowInfo查询签署人的RecipientId编号) 注： 1. 支持更换企业的签署人，不支持更换个人类型的签署人。 2. 己方企业支持自动签署，他方企业不支持自动签署。 3. 仅将\ufffd...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "签署人姓名，最大长度50个字。",
              "example": "典子谦"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": true,
              "description": "签署人手机号。",
              "example": "1320****000"
            },
            {
              "name": "ApproverType",
              "type": "string",
              "required": false,
              "description": "指定签署人类型，目前仅支持 **ORGANIZATION**：企业（默认值） **ENTERPRISESERVER**：企业静默签",
              "example": "ORGANIZATION"
            },
            {
              "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": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH"
            },
            {
              "name": "RelievedApproverRecipientId",
              "type": "string",
              "required": false,
              "description": "要更换的原合同参与人RecipientId编号。(可通过接口DescribeFlowInfo查询签署人的RecipientId编号)",
              "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP"
            }
          ]
        },
        {
          "name": "Deadline",
          "type": "integer",
          "required": false,
          "description": "合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。",
          "example": "1604912664"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。",
          "example": "VXNlckRhdGE="
        }
      ],
      "required": [
        "Operator",
        "NeedRelievedFlowId",
        "ReliveInfo"
      ]
    },
    {
      "name": "CreateRiskIdentificationTaskFeedback",
      "description": "此接口（CreateRiskIdentificationTaskFeedback）用于创建合同审查任务结果反馈。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行合同审查任务的员工信息。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "RiskId",
          "type": "string",
          "required": false,
          "description": "合同审查风险结果ID，取值如下： - 反馈风险项结果。该参数通过调用接口[获取合同审查任务详情](https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/DescribeContractReviewTask)获取（取Risks.RiskId值）。 - 反馈通过项结果。该参数通过调用接口[获取合同审查任务详情](https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B...",
          "example": "yDtzNUUckpf2nfh6UEcTcQVvNxxx"
        },
        {
          "name": "FeedbackResult",
          "type": "integer",
          "required": false,
          "description": "反馈结果 - 1: 其他错误 - 2: 审查错误 - 3: 审查正确",
          "example": "2"
        },
        {
          "name": "Reason",
          "type": "string",
          "required": false,
          "description": "审查反馈原因",
          "example": "审查不准确"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateSchemeUrl",
      "description": "获取跳转至腾讯电子签小程序的签署链接 适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。 跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置 注： 1. 如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息, userId 必填。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "OrganizationName",
          "type": "string",
          "required": false,
          "description": "合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`",
          "example": "典子谦示例企业"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "合同流程里边签署方经办人的姓名。 `注：在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`",
          "example": "典子谦"
        },
        {
          "name": "Mobile",
          "type": "string",
          "required": false,
          "description": "合同流程里边签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。`注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`",
          "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": "EndPoint",
          "type": "string",
          "required": false,
          "description": "要跳转的链接类型 **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型) **HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 **APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型",
          "example": "HTTP"
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": false,
          "description": "合同流程ID 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`",
          "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": false,
          "description": "合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值",
          "example": "yDR1AUUgygjazuesUuO4zjESPW4PkfNi"
        },
        {
          "name": "PathType",
          "type": "integer",
          "required": false,
          "description": "要跳转到的页面类型 **0** : 腾讯电子签小程序个人首页 (默认) 点击查看示例页面 **1** : 腾讯电子签小程序流程合同的详情页,即合同签署页面(注:`仅生成短链或者小程序Path时支持跳转合同详情页,即EndPoint传HTTP_SHORT_URL或者APP`)点击查看示例页面 **2** : 腾讯电子签小程序合同列表页 点击查看示例页面 **3** : 腾讯电子签小程序合同封面页 （注：`生成动态签署人补充链接时，必须指\ufffd...",
          "example": "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. 电子签小程序跳\ufffd...",
          "example": "false"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Hides",
          "type": "array",
          "required": false,
          "description": "生成的签署链接在签署页面隐藏的按钮列表，可设置如下： **0** :合同签署页面更多操作按钮 **1** :合同签署页面更多操作的拒绝签署按钮 **2** :合同签署页面更多操作的转他人处理按钮 **3** :签署成功页的查看详情按钮 **4** :合同签署页面更多操作的查看合同基本信息按钮 **5** :合同签署页面更多操作的撤销按钮 注: `字段为数组, 可以传值隐藏多个按钮`",
          "example": "[1,2]",
          "item_type": "integer"
        },
        {
          "name": "RecipientId",
          "type": "string",
          "required": false,
          "description": "签署节点ID，用于生成动态签署人链接完成领取。 注：`生成动态签署人补充链接时必传。`",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        },
        {
          "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": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP"
                }
              ]
            }
          ]
        },
        {
          "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": "PickUpAfterJoined",
          "type": "boolean",
          "required": false,
          "description": "在动态签署人场景预设了“企业名称”时，可通过该参数控制“已认证身份才可领取”，即在加入了预设的企业后才可领取。默认值：false，无须先加入企业。",
          "example": "false"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateSeal",
      "description": "本接口（CreateSeal）用于创建企业电子印章，支持创建企业公章，合同章，财务专用章和人事专用章创建。 1. 可以**通过图片**创建印章，图片最大5MB 2. 可以**系统创建**创建印章, 系统创建的印章样子下图(样式可以调整) ![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage.png)",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "SealName",
          "type": "string",
          "required": true,
          "description": "电子印章名字，1-50个中文字符 注:`同一企业下电子印章名字不能相同`",
          "example": "公司印章"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "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": "FileName",
          "type": "string",
          "required": false,
          "description": "电子印章图片文件名称，1-50个中文字符。",
          "example": "印章图片.png"
        },
        {
          "name": "Image",
          "type": "string",
          "required": false,
          "description": "电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式 注: `通过图片创建的电子印章，需电子签平台人工审核`",
          "example": "imagecontentbase64"
        },
        {
          "name": "Width",
          "type": "integer",
          "required": false,
          "description": "电子印章宽度,单位px 参数不再启用，系统会设置印章大小为标准尺寸。",
          "example": "10"
        },
        {
          "name": "Height",
          "type": "integer",
          "required": false,
          "description": "电子印章高度,单位px 参数不再启用，系统会设置印章大小为标准尺寸。",
          "example": "20"
        },
        {
          "name": "Color",
          "type": "string",
          "required": false,
          "description": "电子印章印章颜色(默认红色RED),RED-红色 系统目前只支持红色印章创建。",
          "example": "Red"
        },
        {
          "name": "SealHorizontalText",
          "type": "string",
          "required": false,
          "description": "企业印章横向文字，最多可填15个汉字 (若超过印章最大宽度，优先压缩字间距，其次缩小字号) 横向文字的位置如下图中的\"印章横向文字在这里\" ![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage2.png)",
          "example": "横向文字"
        },
        {
          "name": "SealChordText",
          "type": "string",
          "required": false,
          "description": "暂时不支持下弦文字设置",
          "example": "下弦文字"
        },
        {
          "name": "SealCentralType",
          "type": "string",
          "required": false,
          "description": "系统生成的印章只支持STAR",
          "example": "Star"
        },
        {
          "name": "FileToken",
          "type": "string",
          "required": false,
          "description": "通过文件上传时，服务端生成的电子印章上传图片的token",
          "example": "4GQptRKfMnJqX8"
        },
        {
          "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": "lvCCkIZsXxFY"
        },
        {
          "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": [
        "Operator",
        "SealName"
      ]
    },
    {
      "name": "CreateSealPolicy",
      "description": "本接口（CreateSealPolicy）用于对企业员工进行印章授权",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Users",
          "type": "array",
          "required": true,
          "description": "用户在电子文件签署平台标识信息，具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "SealId",
          "type": "string",
          "required": true,
          "description": "电子印章ID，为32位字符串。 建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。 可登录腾讯电子签控制台，在 \"印章\"-\u003e\"印章中心\"选择查看的印章，在\"印章详情\" 中查看某个印章的SealId(在页面中展示为印章ID)。",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        },
        {
          "name": "Expired",
          "type": "integer",
          "required": true,
          "description": "授权有效期，时间戳秒级。可以传0，代表有效期到2099年12月12日23点59分59秒。",
          "example": "1736478409"
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": false,
          "description": "需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填，跟上面的Users同时起作用",
          "example": "[\"yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84\"]",
          "item_type": "string"
        },
        {
          "name": "Policy",
          "type": "string",
          "required": false,
          "description": "印章授权内容",
          "example": "印章授权内容"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "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": [
        "Operator",
        "Users",
        "SealId",
        "Expired"
      ]
    },
    {
      "name": "CreateSingleSignOnEmployees",
      "description": "此接口（CreateSingleSignOnEmployees）用于创建单点登录企业员工。 创建好的员工，可以通过腾讯电子签提供的链接， 如下图位置，进行登录。 此操作的功能： 1. 可以绑定已经实名的员工，然后 sso 登录实名绑定。 2. 可以提前导入员工，在 sso 登录的时候进行实名。 3. 如果已经绑定过，可以直接通过 sso 链接登录腾讯电子签。 ![image](https://qcloudimg.tencent-cloud.cn/raw/0cd98ca2cc49ea1472a2397ce...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Employees",
          "type": "array",
          "required": true,
          "description": "待创建员工的信息最多不超过200个。 注意： 1. 传递的 openId 不能重复， 且字符不能超过64位。 2. 传递的手机号不能重复。 3. 绑定的角色必须存在且不能超过 10 个。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": true,
              "description": "用户在idp分配的唯一值，需要保持跟在电子签应用集成-\u003e单点登录配置-\u003e端点配置中配置的。 如下图配置![image](https://qcloudimg.tencent-cloud.cn/raw/6ff22248c930b2a7684322cac9401a9c.png)。",
              "example": "jO9PmCBpse8R4maF4sYzTNNNddyioonBEseA70z"
            },
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "企业员工姓名。 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "典子谦"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": true,
              "description": "用户手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。",
              "example": "18888888888"
            },
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "员工在腾讯电子签平台的唯一身份标识，为32位字符串。 注：`创建和更新场景无需填写。`",
              "example": "查询企业角色列表"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "用户邮箱。",
              "example": "abc@def.com"
            },
            {
              "name": "RoleIds",
              "type": "array",
              "required": false,
              "description": "员工角色信息。 此处roleId为电子签配置的 RoleId，可通过接口[查询企业角色列表](https://qian.tencent.com/developers/companyApis/roles/DescribeIntegrationRoles) 获取",
              "example": "[\"d2865fec7e498905f95eb1d8f147f972\"]",
              "item_type": "string"
            },
            {
              "name": "IsVerified",
              "type": "boolean",
              "required": false,
              "description": "员工是否实名。",
              "example": "true"
            },
            {
              "name": "CreatedOn",
              "type": "integer",
              "required": false,
              "description": "员工创建时间戳，单位秒。",
              "example": "1758685647"
            }
          ]
        },
        {
          "name": "SsoApplicationId",
          "type": "string",
          "required": true,
          "description": "单点登录应用号的id,获取位置如下图![image](https://qcloudimg.tencent-cloud.cn/raw/9e61aaf390a5f90ea7606fe29b9a65fd.png)",
          "example": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "Employees",
        "SsoApplicationId"
      ]
    },
    {
      "name": "CreateUserAutoSignEnableUrl",
      "description": "获取个人用户自动签的开通链接。 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": true,
          "description": "自动签使用的场景值, 可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        },
        {
          "name": "AutoSignConfig",
          "type": "object",
          "required": true,
          "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": "610*************1X"
                }
              ]
            },
            {
              "name": "CertInfoCallback",
              "type": "boolean",
              "required": false,
              "description": "是否回调证书信息: **false**: 不需要(默认) **true**:需要 注：`该字段已经失效，请勿设置此参数。`",
              "example": "false"
            },
            {
              "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://jump.cn/jump"
            }
          ]
        },
        {
          "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": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中，该字段的信息将原封不动地透传给贵方。",
          "example": "自定义数据"
        }
      ],
      "required": [
        "Operator",
        "SceneKey",
        "AutoSignConfig"
      ]
    },
    {
      "name": "CreateUserAutoSignSealUrl",
      "description": "获取设置自动签印章小程序链接。 注意： 需要企业开通自动签后使用。 仅支持已经开通了自动签的个人更换自动签印章。 链接有效期默认7天，最多30天。 该接口的链接适用于小程序端。 该接口不会扣除您的合同套餐，暂不参与计费。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "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": "610*************1X"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ExpiredTime",
          "type": "integer",
          "required": false,
          "description": "链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`",
          "example": "1693290580"
        }
      ],
      "required": [
        "Operator",
        "SceneKey",
        "UserInfo"
      ]
    },
    {
      "name": "CreateUserMobileChangeUrl",
      "description": "该接口会生成一个手机号变更的链接，用户可以通过该链接进入电子签系统进行手机号的变更。 该接口支持员工和个人端手机号的变更。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "如果您要修改企业员工用户ID，传递此用户ID即可，其他参数（Name，UserAccountType，IdCardType，IdCardNumber）将被忽略。如果不传此用户ID，则会使用其他参数来进行链接生成。 [点击查看用户ID的获取方式](https://res.ess.tencent.cn/cdn/tsign-developer-center/assets/images/%E7%BB%84%E7%BB%87%E6%9E%B6%E6%9E%84-47eb7105dd300e6dc0c502fba22688ae.png)",
          "example": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
        },
        {
          "name": "UserAccountType",
          "type": "integer",
          "required": false,
          "description": "要修改手机号用户的类型。 0：员工 （默认）1：个人 如果是员工类型，只能修改本方员工，而不能修改其他企业的员工。 如果是个人类型，可不指定用户身份，生成的是固定的链接，当前登录电子签小程序的用户可进行换绑。",
          "example": "1"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "要修改手机号用户的姓名，请确保填写的姓名为对方的真实姓名，而非昵称等代名。 如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。",
          "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位字符串。 如果没有传\ufffd\ufffd...",
          "example": "620000198802020000"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "要跳转的链接类型 HTTP：（默认）跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型) HTTP_SHORT_URL：跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链 APP：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型",
          "example": "APP"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "在用户完成实名认证后，其自定义数据将通过[手机号换绑回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%B8%89-%E4%B8%AA%E4%BA%BA%E5%91%98%E5%B7%A5%E6%89%8B%E6%9C%BA%E5%8F%B7%E4%BF%AE%E6%94%B9%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。 请注意： 此参数仅支持通过[获取c端用户实名链接](https:/...",
          "example": "MTIzNDU2Nzg5"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateUserNameChangeUrl",
      "description": "生成个人用户实名更名链接，个人用户点击此链接进入更名流程（若用户未完成实名认证，则直接进入实名页面实名后再进行更名）。此链接为通用链接，任何点击生成链接的用户将会被引导至小程序个人更名页面完成更名。 注： 调用此接口需要购买单独的实名套餐包。使用前请联系对接的客户经理沟通。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "操作人信息",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "要跳转的链接类型 HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接 HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接 APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径 注：如果不传递，默认值是 HTTP",
          "example": "APP"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "在用户完成改名后，其自定义数据将通过[企业引导个人更名后回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AB-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E6%9B%B4%E5%90%8D%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。",
          "example": "MTIzNDU2Nzg5"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateUserVerifyUrl",
      "description": "生成个人用户实名认证链接，个人用户点击此链接进入实名流程（若用户已完成实名认证，则直接进入成功页面）。用户点击此接口生成的链接完成实名认证后，其数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回 注： 调用此...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "操作人信息",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "要实名的姓名",
          "example": "真实姓名"
        },
        {
          "name": "IdCardNumber",
          "type": "string",
          "required": false,
          "description": "要实名的身份证号码， 身份证号码如果有x的话，统一传大写X",
          "example": "420520****8738"
        },
        {
          "name": "IdCardType",
          "type": "string",
          "required": false,
          "description": "证件类型，目前只支持身份证类型：ID_CARD",
          "example": "ID_CARD"
        },
        {
          "name": "Mobile",
          "type": "string",
          "required": false,
          "description": "要实名的手机号，兼容带+86的格式",
          "example": "187****9032"
        },
        {
          "name": "JumpUrl",
          "type": "string",
          "required": false,
          "description": "实名完之后的跳转链接，最大长度1000个字符。 链接类型请参考 跳转电子签H5。 注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递",
          "example": "https://essurl.cn/x9nvWU8fTg"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "要跳转的链接类型 HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接 HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接 APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径 H5：适用于跳转至电子签H5实名页面的长链接 H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接 注：如果不传递，默认值是 APP",
          "example": "APP"
        },
        {
          "name": "AutoJumpBack",
          "type": "boolean",
          "required": false,
          "description": "签署完成后是否自动回跳 false：否, 实名完成不会自动跳转回来(默认)true：是, 实名完成会自动跳转回来 注: 1. 该参数只针对APP类型（第三方APP或小程序跳转电子签小程序）场景 的实名链接有效 2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳...",
          "example": "false"
        },
        {
          "name": "UserData",
          "type": "string",
          "required": false,
          "description": "在用户完成实名认证后，其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。",
          "example": "MTIzNDU2Nzg5"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "CreateWebThemeConfig",
      "description": "用来设置本企业嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），设置后获取的web签署界面都会使用此配置进行展示。 如果多次调用，会以最后一次的配置为准",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ThemeType",
          "type": "string",
          "required": true,
          "description": "主题类型，取值如下： **EMBED_WEB_THEME**：嵌入式主题（默认），web页面嵌入的主题风格配置",
          "example": "EMBED_WEB_THEME"
        },
        {
          "name": "WebThemeConfig",
          "type": "object",
          "required": true,
          "description": "电子签logo是否展示，主体颜色等配置项",
          "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": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "ThemeType",
        "WebThemeConfig"
      ]
    },
    {
      "name": "DeleteExtendedServiceAuthInfos",
      "description": "删除企业扩展服务授权，当前仅支持 “企业自动签” 和“批量签署” 的取消授权。 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口取消企业员工授权。 注：支持集团代子企业操作，请联系运营开通此功能。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "yD************oimj",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": true,
          "description": "本企业员工的id，需要已实名，正常在职员工",
          "example": "yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E",
          "item_type": "string"
        },
        {
          "name": "ExtendServiceType",
          "type": "string",
          "required": false,
          "description": "取值如下所示： OPEN_SERVER_SIGN：企业自动签 BATCH_SIGN：批量签署",
          "example": "OPEN_SERVER_SIGN"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "UserIds"
      ]
    },
    {
      "name": "DeleteIntegrationDepartment",
      "description": "此接口（DeleteIntegrationDepartment）用于删除企业的部门信息。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "DeptId",
          "type": "string",
          "required": true,
          "description": "电子签中的部门ID，通过DescribeIntegrationDepartments接口可获得。",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ReceiveDeptId",
          "type": "string",
          "required": false,
          "description": "交接部门ID。 待删除部门中的合同、印章和模板数据，将会被交接至该部门ID下；若未填写则交接至公司根部门。",
          "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84"
        }
      ],
      "required": [
        "Operator",
        "DeptId"
      ]
    },
    {
      "name": "DeleteIntegrationEmployees",
      "description": "该接口（DeleteIntegrationEmployees）用于离职本企业员工，同时可选择是否进行离职交接。 - 如果该员工没有未处理的合同，可不设置交接人的ReceiveUserId或ReceiveOpenId进行离职操作。 - 如果该员工有未处理的合同，需要设置ReceiveUserId或ReceiveOpenId表示交接的负责人，交接后员工会进行离职操作。 未处理的合同包括以下： - 待签署的合同（包括顺序签署还没有轮到的合同，此类合同某\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Employees",
          "type": "array",
          "required": true,
          "description": "待离职员工的信息最多不超过100个。应符合以下规则： 1. UserId和OpenId不可同时为空，必须填写其中一个，优先使用UserId。 2. **若需要进行离职交接**，交接人信息ReceiveUserId和ReceiveOpenId不可同时为空，必须填写其中一个，优先使用ReceiveUserId。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "员工在腾讯电子签平台的唯一身份标识，为32位字符串。 注：`创建和更新场景无需填写。`",
              "example": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
            },
            {
              "name": "DisplayName",
              "type": "string",
              "required": false,
              "description": "显示的用户名/昵称。",
              "example": "张三"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "用户手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。",
              "example": "1320****000"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "用户邮箱。",
              "example": "testtest@tencent.com"
            },
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "用户在第三方平台ID。 注：`如需在此接口提醒员工实名，该参数不传。`",
              "example": "open_user1"
            },
            {
              "name": "Roles",
              "type": "array",
              "required": false,
              "description": "员工角色信息。 注：`创建和更新场景无需填写。`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "RoleId",
                  "type": "string",
                  "required": false,
                  "description": "角色ID。",
                  "example": "4dff1******************10b"
                },
                {
                  "name": "RoleName",
                  "type": "string",
                  "required": false,
                  "description": "角色名称。",
                  "example": "业务员"
                }
              ]
            },
            {
              "name": "Department",
              "type": "object",
              "required": false,
              "description": "员工部门信息。",
              "example": "无",
              "children": [
                {
                  "name": "DepartmentId",
                  "type": "string",
                  "required": false,
                  "description": "部门ID。",
                  "example": "dp**********************155f2"
                },
                {
                  "name": "DepartmentName",
                  "type": "string",
                  "required": false,
                  "description": "部门名称。",
                  "example": "测试部门"
                }
              ]
            },
            {
              "name": "Verified",
              "type": "boolean",
              "required": false,
              "description": "员工是否实名。 注：`创建和更新场景无需填写。`",
              "example": "false"
            },
            {
              "name": "CreatedOn",
              "type": "integer",
              "required": false,
              "description": "员工创建时间戳，单位秒。 注：`创建和更新场景无需填写。`",
              "example": "1691563315"
            },
            {
              "name": "VerifiedOn",
              "type": "integer",
              "required": false,
              "description": "员工实名时间戳，单位秒。 注：`创建和更新场景无需填写。`",
              "example": "1691563315"
            },
            {
              "name": "QuiteJob",
              "type": "integer",
              "required": false,
              "description": "员工是否离职： **0**：未离职**1**：离职 注：`创建和更新场景无需填写。`",
              "example": "0"
            },
            {
              "name": "ReceiveUserId",
              "type": "string",
              "required": false,
              "description": "员工离职交接人用户ID。 注：`创建和更新场景无需填写。`",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "name": "ReceiveOpenId",
              "type": "string",
              "required": false,
              "description": "员工离职交接人用户OpenId。 注：`创建和更新场景无需填写。`",
              "example": "open_user2"
            },
            {
              "name": "WeworkOpenId",
              "type": "string",
              "required": false,
              "description": "企业微信用户账号ID。 注：`仅企微类型的企业创建员工接口支持该字段。`",
              "example": "wework_open1"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "Employees"
      ]
    },
    {
      "name": "DeleteIntegrationRoleUsers",
      "description": "解绑员工与对应角色的关系，如需绑定请使用 CreateIntegrationUserRoles 接口。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "RoleId",
          "type": "string",
          "required": true,
          "description": "角色id，可以通过DescribeIntegrationRoles接口获取角色信息",
          "example": "yDSxWUUckptu4clgUuLlo0OwJKbYCO48"
        },
        {
          "name": "Users",
          "type": "array",
          "required": true,
          "description": "用户信息,最多 200 个用户，并且 UserId 和 OpenId 二选一，其他字段不需要传",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "RoleId",
        "Users"
      ]
    },
    {
      "name": "DeleteOrganizationAuthorizations",
      "description": "批量清理未认证的企业认证流程。 此接口用来清除企业方认证信息填写错误，批量清理认证中的认证流信息。 为接口[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks) 和[查询企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls) 接口的扩展接口。即在批量认证过程中，当发起认\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息, userId 必填。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "AuthorizationIds",
          "type": "array",
          "required": false,
          "description": "认证流Ids数组 认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。 认证流 Id可以通过回调 [授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E5%9B%9B-%E6%8E%88%E6%9D%83%E4%B...",
          "example": "yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY",
          "item_type": "string"
        },
        {
          "name": "AdminName",
          "type": "string",
          "required": false,
          "description": "认证人姓名，组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。",
          "example": "张三"
        },
        {
          "name": "AdminMobile",
          "type": "string",
          "required": false,
          "description": "认证人手机号，组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。",
          "example": "18888888888"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DeleteSealPolicies",
      "description": "本接口（DeleteSealPolicies）用于撤销企业员工持有的印章权限",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "PolicyIds",
          "type": "array",
          "required": false,
          "description": "印章授权编码数组。这个参数跟下面的SealId其中一个必填，另外一个可选填",
          "example": "yDSxWUUckptu4clgUuLlo0OwJKbYCO48",
          "item_type": "string"
        },
        {
          "name": "SealId",
          "type": "string",
          "required": false,
          "description": "电子印章ID，为32位字符串。 建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。 可登录腾讯电子签控制台，在 \"印章\"-\u003e\"印章中心\"选择查看的印章，在\"印章详情\" 中查看某个印章的SealId(在页面中展示为印章ID)。 注：印章ID。这个参数跟上面的PolicyIds其中一个必填，另外一个可选填。",
          "example": "yDCZHUUnitvronUuNTdBrElW0gOVqCfy"
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": false,
          "description": "待授权的员工ID，员工在腾讯电子签平台的唯一身份标识，为32位字符串。 可登录腾讯电子签控制台，在 \"更多能力\"-\u003e\"组织管理\" 中查看某位员工的UserId(在页面中展示为用户ID)。",
          "example": "yDwcCUUgyg3tgmvhUEVzyNa15Zayy6Sf",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DeleteSingleSignOnEmployees",
      "description": "此接口（DeleteSingleSignOnEmployees）用于删除单点登录企业员工。 注意： 此接口只能删除未跟腾讯电子签绑定的单点登录企业员工， 如果企业员工的单点登录信息已经和腾讯电子签里面的企业员工绑定，需要企业的超级管理员或者组织管理员在腾讯电子签控制台对当前企业员工进行离职操作，如下图操作。 ![image](https://qcloudimg.tencent-cloud.cn/raw/5e69f6e11859972d466900040f68c105.png)",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "SsoApplicationId",
          "type": "string",
          "required": true,
          "description": "单点登录应用号的id,获取位置如下图![image](https://qcloudimg.tencent-cloud.cn/raw/9e61aaf390a5f90ea7606fe29b9a65fd.png)",
          "example": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS"
        },
        {
          "name": "OpenId",
          "type": "string",
          "required": true,
          "description": "需要删除的单点登录员工的唯一Id 值",
          "example": "rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "SsoApplicationId",
        "OpenId"
      ]
    },
    {
      "name": "DescribeBatchOrganizationRegistrationTasks",
      "description": "本接口（DescribeBatchOrganizationRegistrationTasks）用于查询企业批量认证任务状态。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "TaskIds",
          "type": "array",
          "required": false,
          "description": "企业批量认证链接的子任务 SubTaskId，该 SubTaskId 是通过接口[查询企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls)可以得到。",
          "example": "[\"yDRS4UUgygqdcj56UuO4zjExBQcOiB68\",\"yDRS4UUgygqdcj5pUuO4zjEu602GFIe6\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeBatchOrganizationRegistrationUrls",
      "description": "此接口用于获取企业批量认证异步任务的状态及结果。 前提条件：已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口，并得到了任务Id。 异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也可能需要更长的时间",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "通过接口CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任得到的任务Id",
          "example": "yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "TaskId"
      ]
    },
    {
      "name": "DescribeBillUsage",
      "description": "通过此接口（DescribeBillUsage）查询该企业的套餐套餐使用情况。",
      "status": "online",
      "parameters": [
        {
          "name": "StartTime",
          "type": "string",
          "required": true,
          "description": "查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于90天",
          "example": "20230101"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于90天",
          "example": "20230105"
        },
        {
          "name": "QuotaType",
          "type": "string",
          "required": false,
          "description": "查询的套餐类型 （选填 ）不传则查询所有套餐；目前支持:**CloudEnterprise**: 企业版合同**SingleSignature**: 单方签章**CloudProve**: 签署报告**CloudOnlineSign**: 腾讯会议在线签约**ChannelWeCard**: 微工卡**SignFlow**: 合同套餐**SignFace**: 签署意愿（人脸识别）**SignPassword**: 签署意愿（密码）**SignSMS**: 签署意愿（短信）**PersonalEssAuth**: 签署人实名（腾讯电子签认证）**PersonalThirdAuth**: 签署人实名\ufffd\ufffd...",
          "example": "CloudEnterprise"
        },
        {
          "name": "DisplaySubEnterprise",
          "type": "boolean",
          "required": false,
          "description": "是否展示集团子企业的明细，默认否",
          "example": "true"
        }
      ],
      "required": [
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "DescribeBillUsageDetail",
      "description": "通过此接口（DescribeBillUsageDetail）查询该企业的套餐消耗详情。",
      "status": "online",
      "parameters": [
        {
          "name": "StartTime",
          "type": "string",
          "required": true,
          "description": "查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天",
          "example": "20230101"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天",
          "example": "20230105"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。",
          "example": "50"
        },
        {
          "name": "QuotaType",
          "type": "string",
          "required": false,
          "description": "查询的套餐类型 （选填 ）不传则查询所有套餐； 目前支持: **CloudEnterprise**: 企业版合同 **SingleSignature**: 单方签章 **CloudProve**: 签署报告 **CloudOnlineSign**: 腾讯会议在线签约 **ChannelWeCard**: 微工卡 **SignFlow**: 合同套餐 **SignFace**: 签署意愿（人脸识别） **SignPassword**: 签署意愿（密码） **SignSMS**: 签署意愿（短信） **PersonalEssAuth**: 签署人实名（腾讯电子签认证） **PersonalThirdAuth**: 签\ufffd\ufffd...",
          "example": "CloudEnterprise"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "DescribeCancelFlowsTask",
      "description": "通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后，可通过此接口查询批量撤销任务的结果。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "批量撤销任务编号，为32位字符串，通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。",
          "example": "无yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "TaskId"
      ]
    },
    {
      "name": "DescribeContractComparisonTask",
      "description": "本接口（DescribeContractComparisonTask）用于查询合同对比任务结果详情。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行合同审查任务的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "合同对比任务ID，该参数通过调用接口CreateContractComparisonTask获取。",
          "example": "yD*******************ob"
        },
        {
          "name": "ShowDetail",
          "type": "boolean",
          "required": false,
          "description": "是否返回详细的对比结果。为 true时，响应中将包含详细的对比信息，如相似度、文本差异具体内容等；为 false时，仅返回任务基本状态信息。 注：`详细结果数据量可能较大，请按需开启。`",
          "example": "true"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "搜索条件，具体参考Filter结构体。本接口取值： 1. **format-type：** 按照【 合同文本格式类型 】进行过滤； 类型：String； 是否必填项：否； 类型如下： **0**：段落（正文） **1**：标点符号 **2**：页眉页脚 **3**：目录 **4**：印章 **5**：序号 **7**：下划线内容（填写区）",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "查询过滤条件的Key",
              "example": "Name"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "查询过滤条件的Value列表",
              "example": "[\"张三\"]",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "TaskId"
      ]
    },
    {
      "name": "DescribeContractDiffTaskWebUrl",
      "description": "接口（DescribeContractDiffTaskWebUrl）用于获取合同对比结果可嵌入的web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。 注：本接口生成的web页面暂不支持设置本企业嵌入式页面主题配置 嵌入页面长相如下： ![image](https://qcloudimg.tencent-cloud.cn/raw/c68047feddbc106e261870687b6ab89d.jpg)",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "合同对比任务ID，该参数通过调用接口创建合同对比web页面获取。",
          "example": "yDt3wUUckpx9w197UyoAic68BmF35hFu"
        }
      ],
      "required": [
        "Operator",
        "TaskId"
      ]
    },
    {
      "name": "DescribeContractReviewChecklistWebUrl",
      "description": "此接口（DescribeContractReviewChecklistWebUrl）用来创建查看审查要点清单web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。 适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。 注意: `如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Id",
          "type": "string",
          "required": true,
          "description": "清单 id",
          "example": "bxxdfgsdfsdfsdfsd"
        }
      ],
      "required": [
        "Operator",
        "Id"
      ]
    },
    {
      "name": "DescribeContractReviewChecklistsWebUrl",
      "description": "此接口（DescribeContractReviewChecklistsWebUrl）用来创建审查要点清单列表web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。 适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。 注意: `如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Option",
          "type": "object",
          "required": false,
          "description": "合同审查清单个性化参数",
          "example": "无",
          "children": [
            {
              "name": "DisableCreateChecklist",
              "type": "boolean",
              "required": false,
              "description": "禁用新建清单功能。默认 false，设置为 true 会隐藏界面的新建按钮。",
              "example": "false"
            }
          ]
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeContractReviewTask",
      "description": "本接口（DescribeContractReviewTask）用于获取合同审查任务详情，包括任务的状态和识别出的风险信息。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "合同审查任务ID，该参数通过调用接口[批量创建合同审查任务](https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/CreateBatchContractReviewTask)获取。",
          "example": "yDtIFUU2tnsxz7UulGxxx4WkTq"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "TaskId"
      ]
    },
    {
      "name": "DescribeContractReviewTaskListWebUrl",
      "description": "此接口（DescribeContractReviewTaskListWebUrl）用来创建合同审查记录列表web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。 适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。 注意: `如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeContractReviewWebUrl",
      "description": "此接口（DescribeContractReviewWebUrl）用来创建合同审查web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。 适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。 注意: `如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "合同审查任务ID，该参数通过调用接口创建合同审查web页面获取。",
          "example": "yDt4MUUckp9j4zj5UugsjbKvB0vibmas"
        }
      ],
      "required": [
        "Operator",
        "TaskId"
      ]
    },
    {
      "name": "DescribeEnterpriseContractReviewChecklists",
      "description": "本接口（DescribeEnterpriseContractReviewChecklists）用于获取企业全部审查要点清单。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "object",
          "required": false,
          "description": "过滤条件",
          "example": "无",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "查询过滤条件的Key",
              "example": "Name"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "查询过滤条件的Value列表",
              "example": "[\"张三\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定每页返回的数据条数，和Offset参数配合使用。",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。",
          "example": "0"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeExtendedServiceAuthDetail",
      "description": "查询企业扩展服务的授权详情（列表），当前支持查询以下内容： 1. 企业自动签（本企业授权、集团企业授权、合作企业授权） 2. 批量签署能力 注: 所在企业的超管、法人才有权限调用此接口(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "yD************oimj",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ExtendServiceType",
          "type": "string",
          "required": false,
          "description": "要查询的扩展服务类型。 如下所示： OPEN_SERVER_SIGN：企业静默签署 BATCH_SIGN：批量签署",
          "example": "OPEN_SERVER_SIGN"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "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": [
        "Operator"
      ]
    },
    {
      "name": "DescribeExtendedServiceAuthInfos",
      "description": "查询企业扩展服务的开通和授权情况，当前支持查询以下内容： 1. **企业自动签署** 2. **批量签署授权** 3. **企业与港澳台居民签署合同** 4. **拓宽签署方年龄限制** 5. **个人签署方仅校验手机号** 6. **隐藏合同经办人姓名** 7. **正楷临摹签名失败后更换其他签名类型** 8. **短信通知签署方** 9. **个人签署方手写签名时需逐个手写** 10. **签署密码开通引导** 11. **个人签署方手动签名*...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "yD************oimj",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ExtendServiceType",
          "type": "string",
          "required": false,
          "description": "要查询的扩展服务类型。 默认为空，即查询当前支持的所有扩展服务信息。 若需查询单个扩展服务的开通情况，请传递相应的值，如下所示： OPEN_SERVER_SIGN：企业自动签署 AUTO_SIGN_CAN_FILL_IN：本企业自动签合同支持签前内容补充 BATCH_SIGN：批量签署 OVERSEA_SIGN：企业与港澳台居民签署合同 AGE_LIMIT_EXPANSION：拓宽签署方年龄限制 MOBILE_CHECK_APPROVER：个人签署方仅校验手机号 HIDE_OPERATOR_...",
          "example": "OPEN_SERVER_SIGN"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeFileCounterSignResult",
      "description": "文件CA加签任务结果查询接口，用于查询 CreateFileCounterSign接口 发起的异步加签任务。 注意：`此接口为『数字文件CA加签服务』白名单功能，使用前请联系对接的客户经理沟通。`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": false,
          "description": "加签任务Id",
          "example": "yDtwwU****************pfyw8AO"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeFileUrls",
      "description": "本接口（DescribeFileUrls）用于查询文件的下载URL。 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。 ### 2. 确保合同的PDF已经合成后，再调用本接口。 用户创建合同或者提交签署动作后，后台需要1~3秒的时间就进行合同PDF合成或者签名，为了确保您下载的是签署完成的完整合同文件，我们建议采取下面两种方式的一种来确保PDF已经合成完成，然后在调用本接...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "BusinessType",
          "type": "string",
          "required": true,
          "description": "文件对应的业务类型，目前支持：**FLOW ** : 如需下载合同文件请选择此项**TEMPLATE ** : 如需下载模板文件请选择此项**DOCUMENT **: 如需下载文档文件请选择此项**SEAL **: 如需下载印章图片请选择此项**DIGITFILE**: 如需下载加签文件请选择此项",
          "example": "DOCUMENT"
        },
        {
          "name": "BusinessIds",
          "type": "array",
          "required": true,
          "description": "业务编号的数组，取值如下：流程编号模板编号文档编号印章编号加签文件编号如需下载合同文件请传入FlowId，最大支持20个资源",
          "example": "[\"yDRSRUUgygj6rq7wUuO4zjECxndqQApl\",\"yDwFkUUckpstzjhfUugNAWf1KibXqS26\"]",
          "item_type": "string"
        },
        {
          "name": "FileName",
          "type": "string",
          "required": false,
          "description": "下载后的文件命名，只有FileType为zip的时候生效",
          "example": "张三的入职合同"
        },
        {
          "name": "FileType",
          "type": "string",
          "required": false,
          "description": "要下载的文件类型，取值如下： JPG PDF ZIP",
          "example": "PDF"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 1000。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 100。",
          "example": "0"
        },
        {
          "name": "UrlTtl",
          "type": "integer",
          "required": false,
          "description": "下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)",
          "example": "0"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "BusinessType",
        "BusinessIds"
      ]
    },
    {
      "name": "DescribeFlowBriefs",
      "description": "查询流程基础信息，主要用于查询合同的状态信息。可以配合回调通知使用。 注: `每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": true,
          "description": "查询的合同流程ID列表最多支持100个流程ID。 如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
          "example": "[yDRCLUUgygq2xun5UuO4zjEwg0vjoimj]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "FlowIds"
      ]
    },
    {
      "name": "DescribeFlowComponents",
      "description": "您可以通过合同流程ID查询相关的填写控件信息及其内容。这包括控件的归属方、控件的填写状态（是否已填写）以及具体的填写内容。 无论是发起方还是签署方填写的控件，均包含在查询结果中。 ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png) ### 2. 那些控件会出现在结果里边？ **A.不返回的控件类型：** - 动态表格 - 附件控件 - 水印控件 **B.返回的控件类型\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。 [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
          "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "FlowId"
      ]
    },
    {
      "name": "DescribeFlowEvidenceReport",
      "description": "获取出证报告任务执行结果，返回报告 URL。 注意： 使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。 需调用创建并返回出证报告接口提交申请出证报告任务获取报告编号后调用当前接口获取报告链接。 CreateFlowEvidenceReport提交申请出证报告任务DescribeFlowEvidenceReport获取出证报告任务执行结果",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ReportId",
          "type": "string",
          "required": true,
          "description": "签署报告编号, 由提交申请出证报告任务产生",
          "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ReportType",
          "type": "integer",
          "required": false,
          "description": "指定申请的报告类型，可选类型如下： **0** :合同签署报告（默认） **1** :公证处核验报告",
          "example": "0"
        }
      ],
      "required": [
        "Operator",
        "ReportId"
      ]
    },
    {
      "name": "DescribeFlowInfo",
      "description": "此接口用于查询合同流程的详情信息，支持查询多个（数量不能超过100）。 适用场景：可用于主动查询某个合同详情信息。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowIds",
          "type": "array",
          "required": false,
          "description": "需要查询的流程ID列表，最多可传入100个ID。 如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。 [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
          "example": "[\"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "FlowGroupId",
          "type": "string",
          "required": false,
          "description": "需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。该合同组由通过多文件创建合同组签署流程等接口创建。",
          "example": "yDwJKUUckpk3cp9kUybilmdvXgzy4Gv4"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeFlowTemplates",
      "description": "此接口（DescribeFlowTemplates）用于查询本企业模板列表信息。 **适用场景** 该接口常用来配合模板发起合同-创建电子文档接口，作为创建电子文档的前置接口使用。 通过此接口查询到模板信息后，再通过调用创建电子文档接口，指定模板ID，指定模板中需要的填写控件内容等，完成电子文档的创建。 **一个模板通常会包含以下结构信息** - 模板模板ID, 模板名字等基本信息 - 发起\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ContentType",
          "type": "integer",
          "required": false,
          "description": "查询内容控制 **0**：模板列表及详情（默认） **1**：仅模板列表",
          "example": "1"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。模板 ID：Key设置为 template-id ，Values为您想要查询的 模板 ID 列表。 主企业模板 ID：Key设置为 share-template-id ，Values为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 Agent.ProxyOrganizationId（子企业的组织ID）为必填项。 模板名称：Key设置为 ...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "查询过滤条件的Key",
              "example": "Name"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "查询过滤条件的Value列表",
              "example": "[\"张三\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为200。`",
          "example": "20"
        },
        {
          "name": "ApplicationId",
          "type": "string",
          "required": false,
          "description": "通过指定[第三方应用的应用号（ApplicationId）](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png)，您可以查询【应用模板库管理】中某个第三方应用下的模板。 注意事项： 当 ApplicationId 为空时（默认），系统将查询平台企业的所有模板（自建应用使用的模板）。当 ApplicationId 不为空时，系统将从【应用模板库管理】中查询该特定应用下的模板（分享给第三方应用子企\ufffd...",
          "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
        },
        {
          "name": "WithPreviewUrl",
          "type": "boolean",
          "required": false,
          "description": "是否获取模板预览链接。 false：不获取（默认）true：需要获取 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。",
          "example": "false"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeInformationExtractionTask",
      "description": "本接口（DescribeInformationExtractionTask）用于获取合同智能提取任务详情，包括任务的状态和提取的字段结果信息。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": false,
          "description": "合同智能提取任务ID，该参数通过调用接口[批量创建合同智能提取任务接口](https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/CreateBatchInformationExtractionTask)获取。",
          "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeInformationExtractionWebUrl",
      "description": "此接口（DescribeInformationExtractionWebUrl）用来获取合同信息提取web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": false,
          "description": "合同信息提取任务ID，该参数可通过回调事件[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)获取或者从控制台信息提取任务列表获取。 注意：`不填写任务ID时返回信息提取任务列表URL，填写任务ID时返回信息提取任务详情URL`",
          "example": "yDtGEUUgydjcwqRz"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeIntegrationDepartments",
      "description": "此接口（DescribeIntegrationDepartments）用于查询企业的部门信息列表，支持查询单个部门节点或单个部门节点及一级子节点部门列表。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "QueryType",
          "type": "integer",
          "required": true,
          "description": "查询类型，支持以下类型： **0**：查询单个部门节点列表，不包含子节点部门信息 **1**：查询单个部门节点级一级子节点部门信息列表",
          "example": "1"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "DeptId",
          "type": "string",
          "required": false,
          "description": "查询的部门ID。 注：`如果同时指定了DeptId与DeptOpenId参数，系统将优先使用DeptId参数进行查询。当二者都未指定时，系统将返回根节点部门数据。`",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        },
        {
          "name": "DeptOpenId",
          "type": "string",
          "required": false,
          "description": "查询的客户系统部门ID。 注：`如果同时指定了DeptId与DeptOpenId参数，系统将优先使用DeptId参数进行查询。当二者都未指定时，系统将返回根节点部门数据。`",
          "example": "dept_open_id_test"
        }
      ],
      "required": [
        "Operator",
        "QueryType"
      ]
    },
    {
      "name": "DescribeIntegrationEmployees",
      "description": "此接口（DescribeIntegrationEmployees）用于分页查询企业员工信息列表，支持设置过滤条件以筛选员工查询结果。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定分页每页返回的数据条数，单页最大支持 20。",
          "example": "10"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "查询的关键字段，支持Key-Values查询。可选键值如下： Key:**\"Status\"**，根据实名状态查询员工，Values可选： **[\"IsVerified\"]**：查询已实名的员工**[\"NotVerified\"]**：查询未实名的员工 Key:**\"DepartmentId\"**，根据部门ID查询部门下的员工，Values为指定的部门ID：**[\"DepartmentId\"]** Key:**\"UserId\"**，根据用户ID查询员工，Values为指定的用户ID：**[\"UserId\"]** Key:**\"UserWeWorkOpenId\"**，根据用户企微账号ID查询...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "查询过滤条件的Key",
              "example": "Name"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "查询过滤条件的Value列表",
              "example": "[\"张三\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0，最大20000。关于Offset的更进一步介绍请参考 API 简介中的相关小节。",
          "example": "0"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeIntegrationRoles",
      "description": "此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。 角色分为系统默认角色与企业自定义角色，其中系统默认角色不可以禁用、删除、编辑权限项，只可往默认角色中添加成员。企业自定义角色为企业根据自身需要新增的角色，可根据企业具体情况设置各个角色的权限，例如新增财务岗、销售岗等角色。 企业版的系统默认角色包含如下...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "指定分页每页返回的数据条数，单页最大支持 200。",
          "example": "10"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "查询的关键字段，支持Key-Value单值查询。可选键值对如下： Key:\"RoleType\"，查询角色类型，Values可选： **\"1\"**：查询系统角色**\"2\"**：查询自定义角色 Key:\"RoleStatus\"，查询角色状态，Values可选： **\"1\"**：查询启用角色**\"2\"**：查询禁用角色 Key:\"IsGroupRole\"，是否查询集团角色，Values可选： **\"0\"**：查询非集团角色**\"1\"**：查询集团角色 Key:\"IsReturnPermissionGroup\"，是否返回角色对应权限树，Val...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "查询过滤条件的Key",
              "example": "Name"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "查询过滤条件的Value列表",
              "example": "[\"张三\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "OFFSET 用于指定查询结果的偏移量，如果不传默认偏移为0,最大2000。 分页参数, 需要limit, offset 配合使用 例如: 您希望得到第三页的数据, 且每页限制最多10条 您可以使用 LIMIT 10 OFFSET 20",
          "example": "0"
        }
      ],
      "required": [
        "Operator",
        "Limit"
      ]
    },
    {
      "name": "DescribeLMInformationExtractionTaskFieldFeedback",
      "description": "此接口（DescribeLMInformationExtractionTaskFieldFeedback）用于查询合同智能提取任务字段反馈信息。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行合同智能提取任务的员工信息。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": false,
          "description": "合同智能提取任务ID，该参数通过调用接口[批量创建合同智能提取任务](https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/CreateBatchInformationExtractionTask/)获取。",
          "example": "yDRS4UUgygqdcj56Uuxxxx"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeOrganizationAuthStatus",
      "description": "查询企业认证状态- 仅通过[CreateOrganizationAuthUrl](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl) 和[CreateBatchOrganizationRegistrationTasks](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)这两个接口进行引导认证的企业，调用方企业可以依据这个接口，查询认证状态。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "OrganizationName",
          "type": "string",
          "required": false,
          "description": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。",
          "example": "测试企业"
        },
        {
          "name": "UniformSocialCreditCode",
          "type": "string",
          "required": false,
          "description": "企业统一社会信用代码 注意：OrganizationName和UniformSocialCreditCode不能同时为空",
          "example": "JHVSH21******"
        },
        {
          "name": "LegalName",
          "type": "string",
          "required": false,
          "description": "法人姓名",
          "example": "张三"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeOrganizationGroupOrganizations",
      "description": "此API接口用来查询加入集团的成员企业信息 适用场景：子企业在加入集团后，主企业可能通过此接口获取到所有的子企业列表，方便进行展示和统计",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息,userId必填。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "指定分页每页返回的数据条数，单页最大支持 200。",
          "example": "100"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，默认为0，最大20000。关于Offset的更进一步介绍请参考 API 简介中的相关小节。",
          "example": "0"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "成员企业加入集团的当前状态 **1**：待授权 **2**：已授权待激活 **3**：拒绝授权 **4**：已解除 **5**：已加入",
          "example": "5"
        },
        {
          "name": "Export",
          "type": "boolean",
          "required": false,
          "description": "是否导出当前成员企业数据 **false**：不导出（默认值） **true**：导出 p.s. 若传入此参数， LImit参数将无效，导出的为全量数据。",
          "example": "false"
        },
        {
          "name": "Id",
          "type": "string",
          "required": false,
          "description": "成员企业机构 ID，32 位字符串，在PC控制台 集团管理可获取",
          "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
        }
      ],
      "required": [
        "Operator",
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "DescribeOrganizationSeals",
      "description": "查询企业印章列表。 注： 1. 此操作要求操作者具备印章查询权限（若调用者尚无此权限，请联系超级管理员前往Web控制台【组织管理】-\u003e【角色管理】添加相应权限）。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 200。",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 20000。",
          "example": "0"
        },
        {
          "name": "InfoType",
          "type": "integer",
          "required": false,
          "description": "查询授权用户信息类型，取值如下： 0：（默认）不返回授权用户信息 1：返回授权用户的信息",
          "example": "1"
        },
        {
          "name": "SealId",
          "type": "string",
          "required": false,
          "description": "印章id，是否查询特定的印章（没有输入返回所有）",
          "example": "yDSxWUUckptu4clgUuLlo0OwJKbYCO48"
        },
        {
          "name": "SealTypes",
          "type": "array",
          "required": false,
          "description": "印章种类列表（均为组织机构印章）。 若无特定需求，将展示所有类型的印章。 目前支持以下几种： OFFICIAL：企业公章； CONTRACT：合同专用章； FINANCE：财务专用章； PERSONNEL：人事专用章；INVOICE：发票专用章；LEGAL_PERSON_SEAL：法定代表人章。 EMPLOYEE_QUALIFICATION_SEAL：员工执业章。OTHER其他类型印章",
          "example": "[\"OFFICIAL\"]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "SealStatuses",
          "type": "array",
          "required": false,
          "description": "需查询的印章状态列表。 空：（默认）仅查询启用状态的印章； ALL：查询所有状态的印章； CHECKING：查询待审核的印章； SUCCESS：查询启用状态的印章； FAIL：查询印章审核拒绝的印章； DISABLE：查询已停用的印章； STOPPED：查询已终止的印章； VOID：查询已作废的印章； INVALID：查询已失效的印章。",
          "example": "[\"ALL\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeOrganizationVerifyStatus",
      "description": "仅且仅能查询企业本身在电子签的认证状态",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "DescribePersonCertificate",
      "description": "此接口（DescribePersonCertificate）用于查询个人数字证书信息。注：`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。``2.调用此接口需要开通白名单，使用前请联系相关人员开通白名单。`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "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": "610*************1X"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "SceneKey",
          "type": "string",
          "required": false,
          "description": "证书使用场景，可以选择的场景值如下: **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景 **OTHER** : 通用场景",
          "example": "E_PRESCRIPTION_AUTO_SIGN"
        }
      ],
      "required": [
        "Operator",
        "UserInfo"
      ]
    },
    {
      "name": "DescribeRiskIdentificationTaskFeedback",
      "description": "此接口（DescribeRiskIdentificationTaskFeedback）用于查询合同审查任务结果反馈信息",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行合同审查任务的员工信息。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": false,
          "description": "合同审查任务ID，该参数通过调用接口[批量创建合同智能提取任务](https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/CreateBatchInformationExtractionTask)获取。",
          "example": "yDtzlUUckpfqqvp9Uxx"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeSignFaceVideo",
      "description": "该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。 1. 该接口**仅适用于在H5端签署**的合同，**在通过视频认证后**获取人脸视频。 2. 该接口**不支持小程序端**的签署人脸视频获取。 3. 请在**签署完成后的24小时内**获取人脸视频，**过期后将无法获取**。 **注意：该接口需要开通白名单，请联系客户经理开通后使用。**",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。",
          "example": "yDCNsUUckpvqwg3kUyIemOrwQm9ltij5"
        },
        {
          "name": "SignId",
          "type": "string",
          "required": true,
          "description": "签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。",
          "example": "yDxjNUUgydjfeklxUuO4zjEBgCqAHMKu"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "FlowId",
        "SignId"
      ]
    },
    {
      "name": "DescribeSingleSignOnEmployees",
      "description": "此接口（DescribeSingleSignOnEmployees）用于查询单点登录企业员工。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "SsoApplicationId",
          "type": "string",
          "required": true,
          "description": "单点登录应用号的id,获取位置如下图![image](https://qcloudimg.tencent-cloud.cn/raw/9e61aaf390a5f90ea7606fe29b9a65fd.png)",
          "example": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS"
        },
        {
          "name": "OpenIds",
          "type": "array",
          "required": false,
          "description": "需要查询的单点登录员工的唯一Id 值.不能超过 200 个。 如果传递了 openIds，limit 和 offset 参数无效，",
          "example": "[\"rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0\"]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "指定分页每页返回的数据条数，单页最大支持 200。如果不传， 则默认是 20.",
          "example": "200"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "OFFSET 用于指定查询结果的偏移量，如果不传默认偏移为0,最大20000。 分页参数, 需要limit, offset 配合使用 例如: 您希望得到第三页的数据, 且每页限制最多10条 您可以使用 LIMIT 10 OFFSET 20",
          "example": "0"
        }
      ],
      "required": [
        "Operator",
        "SsoApplicationId"
      ]
    },
    {
      "name": "DescribeThirdPartyAuthCode",
      "description": "通过AuthCode查询个人用户是否实名 注意: 此接口为合作引流场景使用，使用有白名单限制，使用前请联系对接的客户经理沟通。 AuthCode 只能使用一次，查询一次再次查询会返回错误",
      "status": "online",
      "parameters": [
        {
          "name": "AuthCode",
          "type": "string",
          "required": true,
          "description": "腾讯电子签小程序跳转客户企业小程序时携带的授权查看码，AuthCode由腾讯电子签小程序生成。",
          "example": "yDxMhUyKQDMFdnUyxgEv8yhSdo0ZFs8I"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "AuthCode"
      ]
    },
    {
      "name": "DescribeUserAutoSignStatus",
      "description": "通过此接口获取个人用户自动签的开通状态。 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "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": "610*************1X"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "SceneKey",
        "UserInfo"
      ]
    },
    {
      "name": "DescribeUserFlowType",
      "description": "查询用户模板类型，分为两种模式： QueryBindTemplate:false，查询用户合同模板类型，返回用户合同模板类型ID，用户合同模板类型名称，用户合同模板类型描述信息 QueryBindTemplate:false，查询用户合同模板类型，返回用户合同模板类型ID，用户合同模板类型名称，用户合同模板类型描述信息，被绑定的模板数量",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。 模板 ID：Key设置为 template-id ，Values为您想要查询的 模板 ID 列表。 主企业模板 ID：Key设置为 share-template-id ，Values为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 Agent.ProxyOrganizationId（子企业的组织ID）为必填项。 模板名称：Key设置为...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "查询过滤条件的Key",
              "example": "Name"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "查询过滤条件的Value列表",
              "example": "[\"张三\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "QueryBindTemplate",
          "type": "boolean",
          "required": false,
          "description": "查询绑定了模板的用户合同类型 false（默认值），查询用户合同类型 true，查询绑定了模板的用户合同类型",
          "example": "false"
        }
      ],
      "required": [
        "Operator"
      ]
    },
    {
      "name": "DescribeUserVerifyStatus",
      "description": "检测个人用户是否已经实名。 在调用生成C端用户实名链接（[CreateUserVerifyUrl](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)）接口之前，客户企业应首先调用本接口判断C端用户是否已经完成实名认证。如果用户已经实名，那么无需再次调用（[CreateUserVerifyUrl](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)）生成链接并走实名认证流程。 注意： - 此接口仅用\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "用户信息",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "姓名",
          "example": "张三"
        },
        {
          "name": "IdCardNumber",
          "type": "string",
          "required": true,
          "description": "证件号码，应符合以下规则 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。",
          "example": "10101******"
        },
        {
          "name": "IdCardType",
          "type": "string",
          "required": true,
          "description": "证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)",
          "example": "ID_CARD"
        }
      ],
      "required": [
        "Operator",
        "Name",
        "IdCardNumber",
        "IdCardType"
      ]
    },
    {
      "name": "DisableUserAutoSign",
      "description": "通过此接口可以关闭个人用户自动签功能。 无需对应的用户刷脸等方式同意即可关闭。 注意: 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。 如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "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": "610*************1X"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "SceneKey",
        "UserInfo"
      ]
    },
    {
      "name": "ExportContractComparisonTask",
      "description": "本接口（ExportContractComparisonTask）用于导出指定的合同对比任务的结果文件。任务完成后，用户可根据不同的使用场景，选择导出可视化对比报告（PDF）或结构化差异明细（EXCEL）。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行合同审查任务的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "合同对比任务ID，该参数通过调用接口CreateContractComparisonTask获取。",
          "example": "yD*******************ob"
        },
        {
          "name": "ExportType",
          "type": "integer",
          "required": false,
          "description": "导出对比结果文件类型。 类型如下： **0**：【PDF】以新合同文件为基础，导出带有可视化对比点标注的PDF文件。 **1**：【EXCEL】导出结构化的对比点明细表格，以列表形式罗列每一个差异点，包含改动位置、类型、标签及修改前后的完整内容。",
          "example": "1"
        },
        {
          "name": "Ignore",
          "type": "boolean",
          "required": false,
          "description": "是否忽略，适用于PDF。 **true**：导出文件标注去掉忽略项。 **false**：导出文件包含所有对比点。",
          "example": "true"
        }
      ],
      "required": [
        "Operator",
        "TaskId"
      ]
    },
    {
      "name": "ExportContractReviewResult",
      "description": "本接口（ExportContractReviewResult）用于导出和同审查结果。支持选择 1 “带风险批注文件”、 2 “审查结果＆摘要（.xIsx）”",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "合同审查任务ID",
          "example": "yDtzKUUckffzxURVliRllhLFtn"
        },
        {
          "name": "FileType",
          "type": "integer",
          "required": true,
          "description": "导出文件类型。1 = 带风险批注文件; 2 = 审查结果＆摘要（.xIsx）; 3 = 不带批注文件",
          "example": "1"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "TaskId",
        "FileType"
      ]
    },
    {
      "name": "GetTaskResultApi",
      "description": "此接口（GetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作 前提条件：已调用 创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。 适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。 注： 1. `大文件转换所需的时间可能会比较长` 2. `本接口返回的文...",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "转换任务Id，通过接口创建文件转换任务接口得到的转换任务id",
          "example": "yDCZHUUnitvronUuNTdBrElW0gOVqCfy"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "ModifyApplicationCallbackInfo",
      "description": "新增/删除企业应用集成中的回调配置。 新增回调配置只会增加不存在的CallbackUrl；删除操作将针对找到的相同CallbackUrl的配置进行删除。 请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "OperateType",
          "type": "integer",
          "required": true,
          "description": "操作类型： 1-新增 2-删除",
          "example": "1"
        },
        {
          "name": "CallbackInfo",
          "type": "object",
          "required": true,
          "description": "企业应用回调信息",
          "example": "无",
          "children": [
            {
              "name": "CallbackUrl",
              "type": "string",
              "required": true,
              "description": "回调url,。请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。",
              "example": "https://tsign.tencent.com/callback"
            },
            {
              "name": "CallbackKey",
              "type": "string",
              "required": false,
              "description": "回调加密key，用于回调消息加解密。",
              "example": "8DD3B29CE10D469D8978393074A767FD"
            },
            {
              "name": "CallbackToken",
              "type": "string",
              "required": false,
              "description": "回调验签token，用于回调通知校验。",
              "example": "5AF866900CA34D1A95382C48C678A085"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "OperateType",
        "CallbackInfo"
      ]
    },
    {
      "name": "ModifyExtendedService",
      "description": "管理企业扩展服务 - **直接开通的情形：** 若在操作过程中接口没有返回跳转链接，这表明无需进行任何跳转操作。此时，相应的企业高级签署能力将会直接被开通或关闭。 - **需要法人或者超管签署开通协议的情形：** 当需要开通以下企业高级签署能力时， 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员（超管）或法人。由他们点击该链接，完成服务的...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "yDAVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "ServiceType",
          "type": "string",
          "required": true,
          "description": "要管理的拓展服务类型。 OPEN_SERVER_SIGN：企业自动签署 AUTO_SIGN_CAN_FILL_IN：本企业自动签合同支持签前内容补充 OVERSEA_SIGN：企业与港澳台居民签署合同 AGE_LIMIT_EXPANSION：拓宽签署方年龄限制 MOBILE_CHECK_APPROVER：个人签署方仅校验手机号 HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名 ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型 ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方 HIDE_ONE_...",
          "example": "MOBILE_CHECK_APPROVER"
        },
        {
          "name": "Operate",
          "type": "string",
          "required": true,
          "description": "操作类型 OPEN : 开通 CLOSE : 关闭",
          "example": "OPEN"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "链接跳转类型，支持以下类型 WEIXINAPP : 短链直接跳转到电子签小程序 (默认值) APP : 第三方APP或小程序跳转电子签小程序 WEIXIN_QRCODE_URL：直接跳转至电子签小程序的二维码链接，无需通过中转页。您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。",
          "example": "APP"
        }
      ],
      "required": [
        "Operator",
        "ServiceType",
        "Operate"
      ]
    },
    {
      "name": "ModifyFlowDeadline",
      "description": "在已启动的签署流程中，可对签署截止日期进行延期操作，主要分为以下两个层面： 1. 合同（流程）层面：仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。 2. 签署人层面 ：需提供流程ID和签署人ID。此操作针对特定签署人进行延期，特别是对于有序合同（流程），签署截止时间不得超过后续签署人的流程截止时间。 此接口存在\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
          "example": "yDw7hUUckpkmkwraUunP4DbSHZaRRhKP"
        },
        {
          "name": "Deadline",
          "type": "integer",
          "required": true,
          "description": "签署流程或签署人新的签署截止时间，格式为Unix标准时间戳（秒）",
          "example": "1705976978"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "RecipientId",
          "type": "string",
          "required": false,
          "description": "签署方角色编号，为32位字符串 若指定了此参数，则只调整签署流程中此签署人的签署截止时间，否则调整合同整体的签署截止时间（合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间） 通过[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)发起合同，或通过[模板发起合同-创建电子文档](https://qian.tencent.com/developers/companyApis/...",
          "example": "yDRvoUUgygqoh324UuO4zjE8OBoGfRNr"
        }
      ],
      "required": [
        "Operator",
        "FlowId",
        "Deadline"
      ]
    },
    {
      "name": "ModifyIntegrationDepartment",
      "description": "此接口（ModifyIntegrationDepartment）用于更新企业的部门信息，支持更新部门名称、客户系统部门ID和部门序号等信息。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "DeptId",
          "type": "string",
          "required": true,
          "description": "电子签部门ID，通过DescribeIntegrationDepartments接口获得。",
          "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "ParentDeptId",
          "type": "string",
          "required": false,
          "description": "电子签父部门ID，通过DescribeIntegrationDepartments接口获得。",
          "example": "732aaefa78c439d726f541b89c49e022"
        },
        {
          "name": "DeptName",
          "type": "string",
          "required": false,
          "description": "部门名称，最大长度为50个字符。",
          "example": "人力资源"
        },
        {
          "name": "DeptOpenId",
          "type": "string",
          "required": false,
          "description": "客户系统部门ID，最大长度为64个字符。",
          "example": "department_hr"
        },
        {
          "name": "OrderNo",
          "type": "integer",
          "required": false,
          "description": "排序号，支持设置的数值范围为1~30000。同一父部门下，排序号越大，部门顺序越靠前。",
          "example": "100"
        }
      ],
      "required": [
        "Operator",
        "DeptId"
      ]
    },
    {
      "name": "ModifyIntegrationRole",
      "description": "此接口（ModifyIntegrationRole）用来更新企业自定义的SaaS角色或集团角色。 适用场景1：更新当前企业的自定义SaaS角色或集团角色，并且更新时不进行角色中权限的更新（PermissionGroups 参数不传）。 适用场景2：更新当前企业的自定义SaaS角色或集团角色，并且更新时进行角色中权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "RoleId",
          "type": "string",
          "required": true,
          "description": "角色Id，可通过接口 DescribeIntegrationRoles 查询获取",
          "example": "yDxD6UxwxNjUy0fKyKBk09rtshL0DBuA"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。",
          "example": "角色_1"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "角色描述，最大长度为50个字符",
          "example": "这是一个角色描述"
        },
        {
          "name": "PermissionGroups",
          "type": "array",
          "required": false,
          "description": "权限树",
          "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": "false"
            },
            {
              "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": "BillOrderManagement"
                },
                {
                  "name": "Type",
                  "type": "integer",
                  "required": false,
                  "description": "权限类型 1前端，2后端",
                  "example": "2"
                },
                {
                  "name": "Hide",
                  "type": "integer",
                  "required": false,
                  "description": "是否隐藏",
                  "example": "1"
                },
                {
                  "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": "BillInvoiceManagement"
                },
                {
                  "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": "BillOrderManagement"
                    },
                    {
                      "name": "Type",
                      "type": "integer",
                      "required": false,
                      "description": "权限类型 1前端，2后端",
                      "example": "2"
                    },
                    {
                      "name": "Hide",
                      "type": "integer",
                      "required": false,
                      "description": "是否隐藏",
                      "example": "1"
                    },
                    {
                      "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": "BillInvoiceManagement"
                    },
                    {
                      "name": "IsChecked",
                      "type": "boolean",
                      "required": false,
                      "description": "是否选中",
                      "example": "false"
                    },
                    {
                      "name": "Children",
                      "type": "array",
                      "required": false,
                      "description": "子权限集合",
                      "example": "无",
                      "item_type": "string"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "name": "SubOrganizationIds",
          "type": "array",
          "required": false,
          "description": "集团角色的话，需要传递集团子企业列表，如果是全选，则传1",
          "example": "732aaefa78c439d726f541b89c49e022",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "RoleId",
        "Name",
        "Operator"
      ]
    },
    {
      "name": "ModifyPartnerAutoSignAuthUrl",
      "description": "创建一个用于更新他方自动签授权的链接（可选择他方授权或我方授权）。通过这个链接，合作方企业可以直接进入小程序，进行自动签授权的更新（更新印章）操作。 如果授权企业尚未开通企业自动签功能，该链接还将引导他们首先开通本企业的自动签服务 注: 1. 所在企业的超管、法人才有权限调用此接口(Operator.UserId 需要传递超管或者法人的UserId) 2. 只能更新授权的印章，...",
      "status": "online",
      "parameters": [
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "AuthorizedOrganizationId",
          "type": "string",
          "required": false,
          "description": "被授企业id/授权方企业id（即OrganizationId），和AuthorizedOrganizationName二选一传入",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        },
        {
          "name": "AuthorizedOrganizationName",
          "type": "string",
          "required": false,
          "description": "被授企业名称/授权方企业的名字，和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。 注: `如果名称中包含英文括号()，请使用中文括号（）代替。`",
          "example": "企业名称"
        },
        {
          "name": "AuthToMe",
          "type": "boolean",
          "required": false,
          "description": "在处理授权关系时，授权的方向 false（默认值）：表示我方授权他方。在这种情况下，AuthorizedOrganizationName 代表的是【被授权方】的企业名称，即接收授权的企业。 true：表示他方授权我方。在这种情况下，AuthorizedOrganizationName 代表的是【授权方】的企业名称，即提供授权的企业。",
          "example": "false"
        }
      ],
      "required": []
    },
    {
      "name": "ModifySingleSignOnEmployees",
      "description": "此接口（ModifySingleSignOnEmployees）用于修改单点登录企业员工。 注意： 此接口只能修改未跟腾讯电子签绑定的单点登录企业员工， 如果企业员工的单点登录信息已经和腾讯电子签里面的企业员工绑定，需要在腾讯电子签小程序进行个人信息变更操作。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "SsoApplicationId",
          "type": "string",
          "required": true,
          "description": "单点登录应用号的id,获取位置如下图![image](https://qcloudimg.tencent-cloud.cn/raw/9e61aaf390a5f90ea7606fe29b9a65fd.png)",
          "example": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS"
        },
        {
          "name": "Employee",
          "type": "object",
          "required": true,
          "description": "待修改员工的信息。",
          "example": "无",
          "children": [
            {
              "name": "OpenId",
              "type": "string",
              "required": true,
              "description": "用户在idp分配的唯一值，需要保持跟在电子签应用集成-\u003e单点登录配置-\u003e端点配置中配置的。 如下图配置![image](https://qcloudimg.tencent-cloud.cn/raw/6ff22248c930b2a7684322cac9401a9c.png)。",
              "example": "jO9PmCBpse8R4maF4sYzTNNNddyioonBEseA70z"
            },
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "企业员工姓名。 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。",
              "example": "典子谦"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": true,
              "description": "用户手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。",
              "example": "18888888888"
            },
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "员工在腾讯电子签平台的唯一身份标识，为32位字符串。 注：`创建和更新场景无需填写。`",
              "example": "查询企业角色列表"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "用户邮箱。",
              "example": "abc@def.com"
            },
            {
              "name": "RoleIds",
              "type": "array",
              "required": false,
              "description": "员工角色信息。 此处roleId为电子签配置的 RoleId，可通过接口[查询企业角色列表](https://qian.tencent.com/developers/companyApis/roles/DescribeIntegrationRoles) 获取",
              "example": "[\"d2865fec7e498905f95eb1d8f147f972\"]",
              "item_type": "string"
            },
            {
              "name": "IsVerified",
              "type": "boolean",
              "required": false,
              "description": "员工是否实名。",
              "example": "true"
            },
            {
              "name": "CreatedOn",
              "type": "integer",
              "required": false,
              "description": "员工创建时间戳，单位秒。",
              "example": "1758685647"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "SsoApplicationId",
        "Employee"
      ]
    },
    {
      "name": "OperateSeals",
      "description": "修改印章状态（停用、启用）",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "Act",
          "type": "integer",
          "required": false,
          "description": "操作类型，int，目前支持传入以下类型： 1：启用印章 2：停用印章",
          "example": "1"
        },
        {
          "name": "SealIds",
          "type": "array",
          "required": false,
          "description": "需要操作的印章ID，数组形式，印章ID可从【web控制台-\u003e印章 】获取。",
          "example": "[\"yDRTZxxxxxJNR\"]",
          "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": []
    },
    {
      "name": "OperateTemplate",
      "description": "此接口（OperateTemplate）用于对企业自有模板进行管理操作，所有操作都会有对应的回调触发，具体参考回调文档 模板操作相关回调 # 支持的操作 ## 1. 删除模板 (OperateType=DELETE) 此操作会将模板从企业自有模板中彻底删除，若要保留模板而不删除，可将模板停用。 ## 2. 启用模板 (OperateType=ENABLE) 此操作是将已停用的模板启用，操作幂等，若模板已启用，接口不报错。 ## 3. 停用模\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "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": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "TemplateName",
          "type": "string",
          "required": false,
          "description": "模板名称，长度不超过64字符。 模板复制时指定有效，若为空，则复制后模板名称为 **原模板名称_副本**。",
          "example": "入职协议"
        }
      ],
      "required": [
        "Operator",
        "TemplateId",
        "OperateType"
      ]
    },
    {
      "name": "RenewAutoSignLicense",
      "description": "已经不再使用 给医疗个人自动签许可续期。续期成功后，可对医疗自动签许可追加一年有效期，只可续期一次。 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`",
      "status": "deprecated",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "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": "610*************1X"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "SceneKey",
        "UserInfo"
      ]
    },
    {
      "name": "StartFlow",
      "description": "此接口用于启动流程。它是模板发起合同的最后一步。 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。 ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png) 注： 1.合同发起后就会扣减合同的额度, 只有撤销没有...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "本合同的发起人，点击查看合同发起人展示的位置",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "FlowId",
          "type": "string",
          "required": true,
          "description": "合同流程ID，为32位字符串。 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。",
          "example": "yDwFk************qS26"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "CcNotifyType",
          "type": "integer",
          "required": false,
          "description": "若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型： **0** :合同发起时通知通知对方来查看合同（默认） **1** : 签署完成后通知对方来查看合同",
          "example": "0"
        }
      ],
      "required": [
        "Operator",
        "FlowId"
      ]
    },
    {
      "name": "UnbindEmployeeUserIdWithClientOpenId",
      "description": "此接口（UnbindEmployeeUserIdWithClientOpenId）用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。 注：`在调用此接口时，需确保OpenId已通过调用`BindEmployeeUserIdWithClientOpenId`接口与电子签系统的UserId绑定过。若OpenId未经过绑定，则无法使用此接口进行解绑操作。`",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息。使用此接口时，必须填写UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "员工在腾讯电子签平台的唯一身份标识，为32位字符串。 通过DescribeIntegrationEmployees接口获取，也可登录腾讯电子签控制台查看 ![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)",
          "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw"
        },
        {
          "name": "OpenId",
          "type": "string",
          "required": true,
          "description": "员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。",
          "example": "obLsS5TwNBM482wtEE7bQDSVoDdk"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "Operator",
        "UserId",
        "OpenId"
      ]
    },
    {
      "name": "UpdateIntegrationEmployees",
      "description": "此接口（UpdateIntegrationEmployees）用于修改未实名企业员工信息(姓名，手机号，邮件、部门)。 如果企业员工已经实名， 姓名，手机号，邮件等需要企业员工到小程序或者控制台自己修改， 部门则需要超管到控制台分配 修改手机号的时候,支持以下场景进行提醒通知 生成端 入参 提醒方式 普通saas员工 将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号 发送短信通\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": true,
          "description": "执行本接口操作的员工信息,UserId必填。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Employees",
          "type": "array",
          "required": true,
          "description": "需要更新的员工信息，最多不超过100个。根据UserId或OpenId更新员工信息，必须填写其中一个，优先使用UserId。 可更新以下字段，其他字段暂不支持 参数 含义 DisplayName 用户的真实名字 Mobile 用户手机号码 Email 用户的邮箱 Department.DepartmentId 用户进入后的部门ID",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "员工在腾讯电子签平台的唯一身份标识，为32位字符串。 注：`创建和更新场景无需填写。`",
              "example": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
            },
            {
              "name": "DisplayName",
              "type": "string",
              "required": false,
              "description": "显示的用户名/昵称。",
              "example": "张三"
            },
            {
              "name": "Mobile",
              "type": "string",
              "required": false,
              "description": "用户手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。",
              "example": "1320****000"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "用户邮箱。",
              "example": "testtest@tencent.com"
            },
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "用户在第三方平台ID。 注：`如需在此接口提醒员工实名，该参数不传。`",
              "example": "open_user1"
            },
            {
              "name": "Roles",
              "type": "array",
              "required": false,
              "description": "员工角色信息。 注：`创建和更新场景无需填写。`",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "RoleId",
                  "type": "string",
                  "required": false,
                  "description": "角色ID。",
                  "example": "4dff1******************10b"
                },
                {
                  "name": "RoleName",
                  "type": "string",
                  "required": false,
                  "description": "角色名称。",
                  "example": "业务员"
                }
              ]
            },
            {
              "name": "Department",
              "type": "object",
              "required": false,
              "description": "员工部门信息。",
              "example": "无",
              "children": [
                {
                  "name": "DepartmentId",
                  "type": "string",
                  "required": false,
                  "description": "部门ID。",
                  "example": "dp**********************155f2"
                },
                {
                  "name": "DepartmentName",
                  "type": "string",
                  "required": false,
                  "description": "部门名称。",
                  "example": "测试部门"
                }
              ]
            },
            {
              "name": "Verified",
              "type": "boolean",
              "required": false,
              "description": "员工是否实名。 注：`创建和更新场景无需填写。`",
              "example": "false"
            },
            {
              "name": "CreatedOn",
              "type": "integer",
              "required": false,
              "description": "员工创建时间戳，单位秒。 注：`创建和更新场景无需填写。`",
              "example": "1691563315"
            },
            {
              "name": "VerifiedOn",
              "type": "integer",
              "required": false,
              "description": "员工实名时间戳，单位秒。 注：`创建和更新场景无需填写。`",
              "example": "1691563315"
            },
            {
              "name": "QuiteJob",
              "type": "integer",
              "required": false,
              "description": "员工是否离职： **0**：未离职**1**：离职 注：`创建和更新场景无需填写。`",
              "example": "0"
            },
            {
              "name": "ReceiveUserId",
              "type": "string",
              "required": false,
              "description": "员工离职交接人用户ID。 注：`创建和更新场景无需填写。`",
              "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            },
            {
              "name": "ReceiveOpenId",
              "type": "string",
              "required": false,
              "description": "员工离职交接人用户OpenId。 注：`创建和更新场景无需填写。`",
              "example": "open_user2"
            },
            {
              "name": "WeworkOpenId",
              "type": "string",
              "required": false,
              "description": "企业微信用户账号ID。 注：`仅企微类型的企业创建员工接口支持该字段。`",
              "example": "wework_open1"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "InvitationNotifyType",
          "type": "string",
          "required": false,
          "description": "员工邀请方式可通过以下途径进行设置：**SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。**H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。**NONE**：系统会根据Endpoint生成签署链接，业务方需获取链\ufffd\ufffd...",
          "example": "SMS"
        },
        {
          "name": "JumpUrl",
          "type": "string",
          "required": false,
          "description": "回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`",
          "example": "https://www.qq.com/action-next"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "要跳转的链接类型 **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链**APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型**H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月注意：InvitationNot...",
          "example": "APP"
        }
      ],
      "required": [
        "Operator",
        "Employees"
      ]
    },
    {
      "name": "UploadFiles",
      "description": "此接口（UploadFiles）文件上传。 适用场景：用于合同，印章的文件上传。文件上传以后， 如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起 如果是其他类型可以配合创建文件转换任务接口转换成PDF文件 注: 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下 2. 调用此接口时需要设置单独的Domain请求域名，联调开发环境为: file...",
      "status": "online",
      "parameters": [
        {
          "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": "DOCUMENT"
        },
        {
          "name": "Caller",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
          "example": "无",
          "children": [
            {
              "name": "OperatorId",
              "type": "string",
              "required": false,
              "description": "经办人的用户ID，同UserId",
              "example": "88fb0c591044be771f60aa382cc5ed0e"
            }
          ]
        },
        {
          "name": "FileInfos",
          "type": "array",
          "required": false,
          "description": "请上传文件内容数组，最多可上传20个文件。 所有文件必须符合FileType指定的文件类型。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FileBody",
              "type": "string",
              "required": true,
              "description": "Base64编码后的文件内容",
              "example": "6KaB5pS+5paH5Lu255qE5YaF5a65"
            },
            {
              "name": "FileName",
              "type": "string",
              "required": false,
              "description": "文件的名字。 文件名的最大长度应不超过200个字符，并且文件名的后缀必须反映其文件类型。 例如，PDF文件应以“.pdf”结尾，如“XXX.pdf”，而Word文件应以“.doc”或“.docx”结尾，如“XXX.doc”或“XXX.docx”。",
              "example": "test.pdf"
            }
          ]
        },
        {
          "name": "FileType",
          "type": "string",
          "required": false,
          "description": "文件类型， 默认通过文件内容和文件后缀一起解析得到文件类型，调用接口时可以显示的指定上传文件的类型。 可支持的指定类型如下: pdf doc docx xls xlsx html jpg jpeg png 如：pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf",
          "example": "PDF"
        },
        {
          "name": "CoverRect",
          "type": "boolean",
          "required": false,
          "description": "此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。 **true**：将灰色矩阵置为白色。 **false**：无需处理，不会将灰色矩阵置为白色（默认）。 注: `该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。`",
          "example": "true"
        },
        {
          "name": "CustomIds",
          "type": "array",
          "required": false,
          "description": "该字段已不再使用",
          "example": "[\"customId1\"]",
          "item_type": "string"
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "BusinessType"
      ]
    },
    {
      "name": "VerifyDigitFile",
      "description": "对加签后的文件进行数字签名验证，判断数字签名是否有效。",
      "status": "online",
      "parameters": [
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        },
        {
          "name": "FileId",
          "type": "string",
          "required": false,
          "description": "加签接口返回的文件Id",
          "example": "yDwcCUUgyg3tgmvhUEVzyNa15Zayy6Sf"
        }
      ],
      "required": []
    },
    {
      "name": "VerifyPdf",
      "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位字符串。 可登录腾讯电子签控制台，在 \"合同\"-\u003e\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
          "example": "yDwcCUUgyg3tgmvhUEVzyNa15Zayy6Sf"
        },
        {
          "name": "Operator",
          "type": "object",
          "required": false,
          "description": "执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户在平台的编号",
              "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
            }
          ]
        },
        {
          "name": "Agent",
          "type": "object",
          "required": false,
          "description": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
          "example": "无",
          "children": [
            {
              "name": "ProxyOrganizationId",
              "type": "string",
              "required": false,
              "description": "被代理机构在电子签平台的机构编号，集团代理下场景必传",
              "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7"
            }
          ]
        }
      ],
      "required": [
        "FlowId"
      ]
    }
  ]
}