tencentcloud-sdk-nodejs-ess 4.1.222 → 4.1.225

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1336,6 +1336,23 @@ export interface CreateFlowByFilesRequest {
1336
1336
  */
1337
1337
  FlowOperateLimit?: FlowOperateLimit;
1338
1338
  }
1339
+ /**
1340
+ * DescribeContractReviewChecklist请求参数结构体
1341
+ */
1342
+ export interface DescribeContractReviewChecklistRequest {
1343
+ /**
1344
+ * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
1345
+ */
1346
+ Operator: UserInfo;
1347
+ /**
1348
+ * <p>需要获取的合同风险审查清单ID</p>
1349
+ */
1350
+ ChecklistId: string;
1351
+ /**
1352
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
1353
+ */
1354
+ Agent?: Agent;
1355
+ }
1339
1356
  /**
1340
1357
  * 电子文档的控件填充信息。按照控件类型进行相应的填充。
1341
1358
 
@@ -3792,6 +3809,19 @@ export interface CreateMiniAppPrepareFlowResponse {
3792
3809
  */
3793
3810
  RequestId?: string;
3794
3811
  }
3812
+ /**
3813
+ * ImportContractReviewChecklist返回参数结构体
3814
+ */
3815
+ export interface ImportContractReviewChecklistResponse {
3816
+ /**
3817
+ * <p>导入成功的合同审查清单ID</p>
3818
+ */
3819
+ ChecklistId?: string;
3820
+ /**
3821
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3822
+ */
3823
+ RequestId?: string;
3824
+ }
3795
3825
  /**
3796
3826
  * CreateConvertTaskApi请求参数结构体
3797
3827
  */
@@ -4795,6 +4825,51 @@ export interface DescribeBatchOrganizationRegistrationTasksRequest {
4795
4825
  */
4796
4826
  TaskIds?: Array<string>;
4797
4827
  }
4828
+ /**
4829
+ * 合同审查清单检查点
4830
+ */
4831
+ export interface ChecklistPoint {
4832
+ /**
4833
+ * <p>合同风险审查清单检查点名称</p>
4834
+ */
4835
+ Summary: string;
4836
+ /**
4837
+ * <p>合同风险审查清单检查点详细描述,说明具体风险信息</p>
4838
+ */
4839
+ Explanation: string;
4840
+ /**
4841
+ * <p>合同风险审查清单检查点对应的风险等级,一般分为 高风险、中风险、一般风险</p>
4842
+ */
4843
+ RiskLevel: string;
4844
+ /**
4845
+ * <p>合同风险审查清单检查点ID,创建清单时无需填写</p>
4846
+ */
4847
+ Id?: string;
4848
+ /**
4849
+ * <p>合同风险审查清单检查点是否不可缺失,若为true,相关条款未出现在内容中,视作风险</p>
4850
+ */
4851
+ IsIndispensable?: boolean;
4852
+ /**
4853
+ * <p>合同风险审查清单检查点是否要求和参考条款一致</p>
4854
+ */
4855
+ IsConsistentWithReferenceItem?: boolean;
4856
+ /**
4857
+ * <p>合同风险审查清单检查点参考条款,用于辅助审查</p>
4858
+ */
4859
+ ReferenceItem?: string;
4860
+ /**
4861
+ * <p>合同风险审查清单检查点固定修改建议,优先级高于AiSuggestion</p>
4862
+ */
4863
+ Suggestion?: string;
4864
+ /**
4865
+ * <p>合同风险审查清单检查点AI修改建议提示,会参考该配置生成对应的修改建议</p>
4866
+ */
4867
+ AiSuggestion?: string;
4868
+ /**
4869
+ * <p>合同风险审查清单检查点表现标签,用于自定义不同的风险类型</p>
4870
+ */
4871
+ RiskPresentation?: Array<string>;
4872
+ }
4798
4873
  /**
4799
4874
  * 用户的三要素:姓名,证件号,证件类型
4800
4875
  */
@@ -4944,6 +5019,19 @@ export interface UserInfo {
4944
5019
  */
4945
5020
  ProxyIp?: string;
4946
5021
  }
5022
+ /**
5023
+ * 合同审查清单大类
5024
+ */
5025
+ export interface ChecklistCategory {
5026
+ /**
5027
+ * <p>合同风险审查清单分组名称,每个分组下可以包含多个检查点</p>
5028
+ */
5029
+ Name: string;
5030
+ /**
5031
+ * <p>合同风险审查清单检查点列表,每个检查点定义了一个具体的风险项</p>
5032
+ */
5033
+ Points?: Array<ChecklistPoint>;
5034
+ }
4947
5035
  /**
4948
5036
  * 授权企业列表(目前仅用于“企业自动签 -> 合作企业授权”)
4949
5037
  */
@@ -5907,142 +5995,485 @@ export interface DescribeFileCounterSignResultResponse {
5907
5995
  RequestId?: string;
5908
5996
  }
5909
5997
  /**
5910
- * 意愿核身点头确认模式结果
5911
- */
5912
- export interface IntentionActionResult {
5913
- /**
5914
- * 意愿核身结果详细数据,与每段点头确认过程一一对应
5915
- */
5916
- Details?: Array<IntentionActionResultDetail>;
5917
- }
5918
- /**
5919
- * CreateBatchSignUrl请求参数结构体
5998
+ * 此结构体 (Component) 用于描述控件属性。
5999
+
6000
+ 在通过文件发起合同时,对应的component有三种定位方式
6001
+ 1. 绝对定位方式 (可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标)
6002
+ 2. 表单域(FIELD)定位方式
6003
+ 3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找
5920
6004
  */
5921
- export interface CreateBatchSignUrlRequest {
5922
- /**
5923
- * 执行本接口操作的员工信息。
5924
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5925
- */
5926
- Operator: UserInfo;
6005
+ export interface Component {
5927
6006
  /**
5928
- * 签署方经办人的姓名。
5929
- 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
6007
+ * **如果是Component填写控件类型,则可选的字段为**:
5930
6008
 
5931
- 注:
5932
- <ul>
5933
- <li>请确保和合同中填入的一致。</li>
5934
- <li>在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</li>
5935
- </ul>
5936
- */
5937
- Name?: string;
5938
- /**
5939
- * 手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注:<ul><li>请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li></ul>
5940
- */
5941
- Mobile?: string;
5942
- /**
5943
- * 代理企业和员工的信息。
5944
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6009
+ <ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>
6010
+ <li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>
6011
+ <li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>
6012
+ <li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>
6013
+ <li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>
6014
+ <li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>
6015
+ <li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>
6016
+ <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
6017
+ <li> <b>WATERMARK</b> : 水印控件;只能分配给发起方,必须设置ComponentExtra;</li>
6018
+ <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li>
6019
+ <li> <b>VIRTUAL_COMBINATION</b> : 虚拟控件,内部特定控件(CHECK_BOX),本身不填充任何文字内容</li></ul>
6020
+
6021
+ **如果是SignComponent签署控件类型,
6022
+ 需要根据签署人的类型可选的字段为**
6023
+ * 企业方
6024
+ <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
6025
+ <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
6026
+ <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
6027
+ <li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
6028
+ <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
6029
+ <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
6030
+ <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
6031
+ <li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
6032
+ <li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
6033
+ <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
6034
+
6035
+ * 个人方
6036
+ <ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
6037
+ <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
6038
+ <li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;</li>
6039
+ <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
6040
+ <li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
6041
+ <li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
6042
+ <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li></ul>
6043
+
6044
+ 注:` 表单域的控件不能作为印章和签名控件`
5945
6045
  */
5946
- Agent?: Agent;
6046
+ ComponentType: string;
5947
6047
  /**
5948
- * 证件类型,支持以下类型
5949
- <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
5950
- <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
5951
- <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
6048
+ * **在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
5952
6049
 
5953
- 注:
5954
- 1. `请确保和合同中填入的一致`。
5955
- 2. `在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。`
5956
6050
  */
5957
- IdCardType?: string;
6051
+ ComponentHeight: number;
5958
6052
  /**
5959
- * 指定批量签署合同的签名类型,可传递以下值:<ul><li>**0**:手写签名</li><li>**1**:OCR楷体</li><li>**2**:姓名印章</li><li>**3**:图片印章</li><li>**4**:系统签名</li><li>**5**:长效手写签名(包含手写签名)</li></ul>注:<ul><li>不传值的情况则计算所有合同中个人签署区的签名类型,规则如下:<ul><li>1.如果所有合同中所有的个人签署区方式包含多种则是手写</li><li>2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式(例如合同1有多个签署区都是指定OCR楷体,合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体)</li></ul></li><li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li></ul>
6053
+ * **在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
6054
+
5960
6055
  */
5961
- SignatureTypes?: Array<number | bigint>;
6056
+ ComponentWidth: number;
5962
6057
  /**
5963
- * 证件号码,应符合以下规则
5964
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
5965
- <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
5966
- <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
6058
+ * **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
6059
+ **在使用文件发起的情况下**,绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码,使用负数时,页码从最后一页开始。例如:ComponentPage设置为-1,即代表在PDF文件的最后一页,以此类推。
5967
6060
 
5968
6061
  注:
5969
- 1. `请确保和合同中填入的一致`。
5970
- 2. `在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
5971
- */
5972
- IdCardNumber?: string;
5973
- /**
5974
- * 通知用户方式:
5975
- <ul>
5976
- <li>**NONE** : 不通知(默认)</li>
5977
- <li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li>
5978
- </ul>
6062
+ 1. 页码编号是从<font color="red">1</font>开始编号的。
6063
+ 2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
5979
6064
  */
5980
- NotifyType?: string;
6065
+ ComponentPage: number;
5981
6066
  /**
5982
- * 批量签署的合同流程ID数组,<font color="red">此参数必传。</font>
5983
- 注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
6067
+ * **在绝对定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。
5984
6068
  */
5985
- FlowIds?: Array<string>;
6069
+ ComponentPosX: number;
5986
6070
  /**
5987
- * 目标签署人的企业名称,签署人如果是企业员工身份,需要传此参数。
5988
-
5989
- 注:
5990
- <ul>
5991
- <li>请确认该名称与企业营业执照中注册的名称一致。</li>
5992
- <li>如果名称中包含英文括号(),请使用中文括号()代替。</li>
5993
- </ul>
6071
+ * **在绝对定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。
5994
6072
  */
5995
- OrganizationName?: string;
6073
+ ComponentPosY: number;
5996
6074
  /**
5997
- * 是否直接跳转至合同内容页面进行签署
5998
- <ul>
5999
- <li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>
6000
- <li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
6001
- </ul>
6075
+ * <font color="red">【暂未使用】</font>控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
6002
6076
  */
6003
- JumpToDetail?: boolean;
6077
+ FileIndex: number;
6004
6078
  /**
6005
- * 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
6079
+ * 控件生成的方式:
6080
+ <ul><li> <b>NORMAL</b> : 绝对定位控件</li>
6081
+ <li> <b>FIELD</b> : 表单域</li>
6082
+ <li> <b>KEYWORD</b> : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)</li></ul>
6006
6083
  */
6007
- FlowBatchUrlInfo?: FlowBatchUrlInfo;
6084
+ GenerateMode?: string;
6008
6085
  /**
6009
- * 签署完成后是否自动回跳
6010
- <ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>
6086
+ * 控件唯一ID。
6011
6087
 
6012
- 注:
6013
- 1. 该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效
6014
- 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
6015
- 3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必须用户手动点击完成按钮(微信的限制)</font>
6016
- */
6017
- AutoJumpBack?: boolean;
6018
- /**
6019
- * <font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
6088
+ **在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
6089
+
6090
+ **在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
6091
+
6092
+ 例:
6093
+
6094
+ - 如传入的关键字<font color="red">"^甲方签署^"</font >,则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符</font >)进行对应操作。
6095
+ - 如传入的关键字为<font color="red">"甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符</font >)都会执行相应操作。
6096
+
6097
+
6098
+ 注:`控件ID可以在一个PDF中不可重复`
6099
+
6100
+ <a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentId在模板编辑页面的位置</a>
6020
6101
 
6021
- 参考 [公众号 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%E8%BD%AC)。
6022
6102
  */
6023
- UrlUseEnv?: string;
6103
+ ComponentId?: string;
6024
6104
  /**
6025
- * 是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>
6026
- 注:`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页(JumpToDetail参数为true),也不支持批量拒签功能`
6105
+ * **在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
6106
+
6107
+ **在表单域定位方式下**,ComponentName不仅为控件名,也是表单域名称。
6108
+
6109
+ 注:`控件名可以在一个PDF中可以重复`
6110
+
6111
+ <a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentName在模板页面的位置</a>
6027
6112
  */
6028
- CanBatchReject?: boolean;
6113
+ ComponentName?: string;
6029
6114
  /**
6030
- * 是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>
6031
- 注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。`
6115
+ * 如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填
6116
+ <ul><li>false(默认):可以不填写</li>
6117
+ <li>true :必须填写此填写控件</li></ul>
6118
+ 如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
6032
6119
  */
6033
- CanSkipReadFlow?: boolean;
6034
- }
6035
- /**
6036
- * CreateBatchInformationExtractionTask返回参数结构体
6037
- */
6038
- export interface CreateBatchInformationExtractionTaskResponse {
6120
+ ComponentRequired?: boolean;
6039
6121
  /**
6040
- * <p>合同智能提取的任务ID列表,每个任务ID为32位字符串。<br>建议开发者保存此任务ID,后续查询合同智能提取详情需要此任务ID。</p><p>注意:<code>返回的索引和ResourceIds数组一致</code></p>
6122
+ * **在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**
6041
6123
  */
6042
- TaskIds?: Array<string>;
6124
+ ComponentRecipientId?: string;
6043
6125
  /**
6044
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6045
- */
6126
+ * **在所有的定位方式下**,控件的扩展参数,为<font color="red">JSON格式</font>,不同类型的控件会有部分非通用参数。
6127
+
6128
+ <font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:
6129
+ <ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>
6130
+ <li> <b>FontSize</b>: 范围6 :72</li>
6131
+ <li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>
6132
+ <li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li>
6133
+ <li> <b>Bold</b>是否加粗:true/false</li>
6134
+ </ul>
6135
+ <b>参数样例</b>:`{"FontColor":"255,0,0","FontSize":12,"Bold":false}`
6136
+
6137
+ <font color="red">ComponentType为DATE时</font>,支持以下参数:
6138
+ <ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>
6139
+ <li> <b>FontSize</b>: 范围6 :72</li></ul>
6140
+ <b>参数样例</b>:`{"FontColor":"255,0,0","FontSize":12}`
6141
+
6142
+ <font color="red">ComponentType为WATERMARK时</font>,支持以下参数:
6143
+ <ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>
6144
+ <li> <b>FontSize</b>: 范围6 :72</li>
6145
+ <li> <b>Opacity</b>: 透明度,范围0 :1</li>
6146
+ <li> <b>Rotate</b>: 水印旋转角度,范围0 :359</li>
6147
+ <li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>
6148
+ <li> <b>Position</b>: 水印位置,None-平铺(默认值),LeftTop-左上,LeftBottom-左下,RightTop-右上,RightBottom-右下,Center-居中</li>
6149
+ <li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul>
6150
+ <b>参数样例</b>:`"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"`
6151
+
6152
+ <font color="red">ComponentType为FILL_IMAGE时</font>,支持以下参数:
6153
+ <ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
6154
+ <li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
6155
+
6156
+ <font color="red">ComponentType为SELECTOR时</font>,支持以下参数:
6157
+ <ul><li> <b>WordWrap</b>:bool。是否支持选择控件内容自动折行合成。false:不支持(默认)。 true : 支持自动折行合成</li>
6158
+ </ul>
6159
+
6160
+ <font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以通过**ComponentTypeLimit**参数控制签名方式
6161
+ <ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>
6162
+ <li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
6163
+ <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
6164
+ <li> <b>ESIGN</b> : 个人印章类型</li>
6165
+ <li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>
6166
+ <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
6167
+ <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
6168
+ 印章的对应关系参考下图
6169
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>
6170
+
6171
+ <font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型
6172
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
6173
+ <li> <b>CONTRACT</b> : 合同专用章</li>
6174
+ <li> <b>FINANCE</b> : 财务专用章</li>
6175
+ <li> <b>PERSONNEL</b> : 人事专用章</li>
6176
+ <li> <b>OTHER</b> : 其他</li>
6177
+ </ul>
6178
+ <b>参考样例</b>:`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
6179
+
6180
+ <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
6181
+ <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、"仿宋",如果不填默认为"黑体"</li>
6182
+ <li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>
6183
+ <li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>
6184
+ <li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>
6185
+ <li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
6186
+ 如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
6187
+ 特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
6188
+ <b>参数样例</b>: ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
6189
+
6190
+ <font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:
6191
+ <ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>
6192
+ <b>参数样例</b>:` "{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"`
6193
+
6194
+ <font color="red">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:
6195
+ <ul><li> <b>Opacity</b>:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>
6196
+ <b>参数样例</b>:`{"Opacity":0.7}`
6197
+
6198
+ <font color="red">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:
6199
+ <ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>
6200
+ <b>参数样例</b>:`{"UseSealSize":true}`
6201
+
6202
+ <font color="red">签署意见功能设置,</font>当ComponentType为SIGN_OPINION时,可以通过以下参数设置签署意见的相关内容:
6203
+ <ul><li> <b>Values</b>:签署意见预设的需要用户填写的文本</li>
6204
+ <li> <b>ValuesArray</b>:签署意见需要用户按顺序点击的分词(组合后应和Values内容一致)</li></ul>
6205
+ <b>参数样例</b>:`{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}`
6206
+
6207
+ <font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
6208
+ <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
6209
+ 场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
6210
+ <b>参数样例</b>:` "{"IgnoreKeywordError":1}"`
6211
+
6212
+ <font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>,支持以下参数:
6213
+ <ul>
6214
+ <li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>
6215
+ <b>参数样例</b>:<br>`{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}`
6216
+ <li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>
6217
+ ChildrenComponent结构体定义:
6218
+ <table border="1"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语<tr> <td>ComponentValue</td> <td>string</td> <td>子控件值(签署方不可设置)</td> </tr> </td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>
6219
+ <b>参数样例</b>:
6220
+
6221
+ 输入:
6222
+ <pre>
6223
+ {
6224
+ ChildrenComponents: [
6225
+ {
6226
+ ComponentType: SIGN_SIGNATURE,
6227
+ ComponentName: 个人签名,
6228
+ Placeholder: 请签名,
6229
+ ComponentOffsetX: 10,
6230
+ ComponentOffsetY: 30,
6231
+ ComponentWidth: 119,
6232
+ ComponentHeight: 43,
6233
+ ComponentExtra: {\ComponentTypeLimit\:[\SYSTEM_ESIGN\]}
6234
+ },
6235
+ {
6236
+ ComponentType: SIGN_SELECTOR,
6237
+ ComponentName: 是否同意此协议,
6238
+ Placeholder: ,
6239
+ ComponentOffsetX: 50,
6240
+ ComponentOffsetY: 130,
6241
+ ComponentWidth: 120,
6242
+ ComponentHeight: 43,
6243
+ ComponentExtra: {\Values\:[\同意\,\不同意\,\再想想\],\FontSize\:12,\FontAlign\:\Left\,\Font\:\黑体\,\MultiSelect\:false}
6244
+ },
6245
+ {
6246
+ ComponentType: SIGN_MULTI_LINE_TEXT,
6247
+ ComponentName: 批注附言,
6248
+ Placeholder: ,
6249
+ ComponentOffsetX: 150,
6250
+ ComponentOffsetY: 300,
6251
+ ComponentWidth: 200,
6252
+ ComponentHeight: 86,
6253
+ ComponentExtra:
6254
+ }
6255
+ ]
6256
+ }
6257
+ </pre>
6258
+ </ul>
6259
+
6260
+ */
6261
+ ComponentExtra?: string;
6262
+ /**
6263
+ * **在通过接口拉取控件信息场景下**,为出参参数,此控件是否通过表单域定位方式生成,默认false-不是,**发起合同时候不要填写此字段留空即可**
6264
+ */
6265
+ IsFormType?: boolean;
6266
+ /**
6267
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
6268
+ <ul><li> <b>TEXT</b> : 文本内容</li>
6269
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容,可以用 \n 来控制换行位置 </li>
6270
+ <li> <b>CHECK_BOX</b> : true/false</li>
6271
+ <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
6272
+ <li> <b>SELECTOR</b> : 选项值</li>
6273
+ <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
6274
+ <li> <b>DATE</b> : 格式化为:xxxx年xx月xx日(例如2024年05年28日)</li>
6275
+ <li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li>
6276
+ <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li></ul>
6277
+
6278
+
6279
+ <b>控件值约束说明</b>:
6280
+ <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>
6281
+ 注: `部分特殊控件需要在控制台配置模板形式创建`
6282
+ */
6283
+ ComponentValue?: string;
6284
+ /**
6285
+ * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
6286
+ 注意: `向左调整设置为负数, 向右调整设置成正数`
6287
+ */
6288
+ OffsetX?: number;
6289
+ /**
6290
+ * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
6291
+ 注意: `向上调整设置为负数, 向下调整设置成正数`
6292
+ */
6293
+ OffsetY?: number;
6294
+ /**
6295
+ * **如果控件是关键字定位方式**,指定关键字排序规则时,可以选择Positive或Reverse两种排序方式。
6296
+ <ul><li> <b>Positive</b> :表示正序,即根据关键字在PDF文件内的顺序进行排列</li>
6297
+ <li> <b>Reverse</b> :表示倒序,即根据关键字在PDF文件内的反序进行排列</li></ul>
6298
+
6299
+ 在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。
6300
+ */
6301
+ KeywordOrder?: string;
6302
+ /**
6303
+ * **如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
6304
+ */
6305
+ KeywordPage?: number;
6306
+ /**
6307
+ * **如果控件是关键字定位方式**,关键字生成的区域的对齐方式, 可以设置下面的值
6308
+ <ul><li> <b>Middle</b> :居中</li>
6309
+ <li> <b>Below</b> :正下方</li>
6310
+ <li> <b>Right</b> :正右方</li>
6311
+ <li> <b>LowerRight</b> :右下角</li>
6312
+ <li> <b>UpperRight</b> :右上角。</li></ul>
6313
+ 示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
6314
+ */
6315
+ RelativeLocation?: string;
6316
+ /**
6317
+ * **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
6318
+
6319
+ 注意:关键字索引是从0开始计数的
6320
+ */
6321
+ KeywordIndexes?: Array<number | bigint>;
6322
+ /**
6323
+ * **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
6324
+ <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
6325
+ <li>true:锁定控件值,在页面无法编辑控件值</li></ul>
6326
+ */
6327
+ LockComponentValue?: boolean;
6328
+ /**
6329
+ * **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
6330
+ <ul><li> <b>false(默认)</b> :可以移动和删除控件</li>
6331
+ <li> <b>true</b> : 禁止移动和删除控件</li></ul>
6332
+ */
6333
+ ForbidMoveAndDelete?: boolean;
6334
+ /**
6335
+ * <font color="red">【暂未使用】</font>日期签署控件的字号,默认为 12
6336
+ */
6337
+ ComponentDateFontSize?: number;
6338
+ /**
6339
+ * <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
6340
+ */
6341
+ ChannelComponentId?: string;
6342
+ /**
6343
+ * <font color="red">【暂未使用】</font>第三方应用集成中子客企业控件来源。
6344
+ <ul><li> <b>0</b> :平台指定;</li>
6345
+ <li> <b>1</b> :用户自定义</li></ul>
6346
+ */
6347
+ ChannelComponentSource?: number;
6348
+ }
6349
+ /**
6350
+ * CreateBatchSignUrl请求参数结构体
6351
+ */
6352
+ export interface CreateBatchSignUrlRequest {
6353
+ /**
6354
+ * 执行本接口操作的员工信息。
6355
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6356
+ */
6357
+ Operator: UserInfo;
6358
+ /**
6359
+ * 签署方经办人的姓名。
6360
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
6361
+
6362
+ 注:
6363
+ <ul>
6364
+ <li>请确保和合同中填入的一致。</li>
6365
+ <li>在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</li>
6366
+ </ul>
6367
+ */
6368
+ Name?: string;
6369
+ /**
6370
+ * 手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注:<ul><li>请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li></ul>
6371
+ */
6372
+ Mobile?: string;
6373
+ /**
6374
+ * 代理企业和员工的信息。
6375
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6376
+ */
6377
+ Agent?: Agent;
6378
+ /**
6379
+ * 证件类型,支持以下类型
6380
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
6381
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
6382
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
6383
+
6384
+ 注:
6385
+ 1. `请确保和合同中填入的一致`。
6386
+ 2. `在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。`
6387
+ */
6388
+ IdCardType?: string;
6389
+ /**
6390
+ * 指定批量签署合同的签名类型,可传递以下值:<ul><li>**0**:手写签名</li><li>**1**:OCR楷体</li><li>**2**:姓名印章</li><li>**3**:图片印章</li><li>**4**:系统签名</li><li>**5**:长效手写签名(包含手写签名)</li></ul>注:<ul><li>不传值的情况则计算所有合同中个人签署区的签名类型,规则如下:<ul><li>1.如果所有合同中所有的个人签署区方式包含多种则是手写</li><li>2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式(例如合同1有多个签署区都是指定OCR楷体,合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体)</li></ul></li><li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li></ul>
6391
+ */
6392
+ SignatureTypes?: Array<number | bigint>;
6393
+ /**
6394
+ * 证件号码,应符合以下规则
6395
+ <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
6396
+ <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
6397
+ <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
6398
+
6399
+ 注:
6400
+ 1. `请确保和合同中填入的一致`。
6401
+ 2. `在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
6402
+ */
6403
+ IdCardNumber?: string;
6404
+ /**
6405
+ * 通知用户方式:
6406
+ <ul>
6407
+ <li>**NONE** : 不通知(默认)</li>
6408
+ <li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li>
6409
+ </ul>
6410
+ */
6411
+ NotifyType?: string;
6412
+ /**
6413
+ * 批量签署的合同流程ID数组,<font color="red">此参数必传。</font>
6414
+ 注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
6415
+ */
6416
+ FlowIds?: Array<string>;
6417
+ /**
6418
+ * 目标签署人的企业名称,签署人如果是企业员工身份,需要传此参数。
6419
+
6420
+ 注:
6421
+ <ul>
6422
+ <li>请确认该名称与企业营业执照中注册的名称一致。</li>
6423
+ <li>如果名称中包含英文括号(),请使用中文括号()代替。</li>
6424
+ </ul>
6425
+ */
6426
+ OrganizationName?: string;
6427
+ /**
6428
+ * 是否直接跳转至合同内容页面进行签署
6429
+ <ul>
6430
+ <li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>
6431
+ <li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
6432
+ </ul>
6433
+ */
6434
+ JumpToDetail?: boolean;
6435
+ /**
6436
+ * 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
6437
+ */
6438
+ FlowBatchUrlInfo?: FlowBatchUrlInfo;
6439
+ /**
6440
+ * 签署完成后是否自动回跳
6441
+ <ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>
6442
+
6443
+ 注:
6444
+ 1. 该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效
6445
+ 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
6446
+ 3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必须用户手动点击完成按钮(微信的限制)</font>
6447
+ */
6448
+ AutoJumpBack?: boolean;
6449
+ /**
6450
+ * <font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
6451
+
6452
+ 参考 [公众号 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%E8%BD%AC)。
6453
+ */
6454
+ UrlUseEnv?: string;
6455
+ /**
6456
+ * 是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>
6457
+ 注:`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页(JumpToDetail参数为true),也不支持批量拒签功能`
6458
+ */
6459
+ CanBatchReject?: boolean;
6460
+ /**
6461
+ * 是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>
6462
+ 注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。`
6463
+ */
6464
+ CanSkipReadFlow?: boolean;
6465
+ }
6466
+ /**
6467
+ * CreateBatchInformationExtractionTask返回参数结构体
6468
+ */
6469
+ export interface CreateBatchInformationExtractionTaskResponse {
6470
+ /**
6471
+ * <p>合同智能提取的任务ID列表,每个任务ID为32位字符串。<br>建议开发者保存此任务ID,后续查询合同智能提取详情需要此任务ID。</p><p>注意:<code>返回的索引和ResourceIds数组一致</code></p>
6472
+ */
6473
+ TaskIds?: Array<string>;
6474
+ /**
6475
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6476
+ */
6046
6477
  RequestId?: string;
6047
6478
  }
6048
6479
  /**
@@ -6233,6 +6664,31 @@ export interface ExportContractComparisonTaskResponse {
6233
6664
  */
6234
6665
  RequestId?: string;
6235
6666
  }
6667
+ /**
6668
+ * DescribeContractReviewChecklist返回参数结构体
6669
+ */
6670
+ export interface DescribeContractReviewChecklistResponse {
6671
+ /**
6672
+ * <p>获取的合同风险审查清单ID</p>
6673
+ */
6674
+ ChecklistId?: string;
6675
+ /**
6676
+ * <p>获取的合同风险审查清单名称</p>
6677
+ */
6678
+ Name?: string;
6679
+ /**
6680
+ * <p>获取的合同风险审查清单是否启用</p>
6681
+ */
6682
+ Enabled?: boolean;
6683
+ /**
6684
+ * <p>获取的合同风险审查清单审查点列表</p>
6685
+ */
6686
+ Categories?: Array<ChecklistCategory>;
6687
+ /**
6688
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6689
+ */
6690
+ RequestId?: string;
6691
+ }
6236
6692
  /**
6237
6693
  * 个性化参数
6238
6694
  */
@@ -9481,766 +9937,452 @@ export interface CreatePrepareFlowRequest {
9481
9937
  Deadline?: number;
9482
9938
  /**
9483
9939
  * 用户自定义合同类型Id
9484
-
9485
- 该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
9486
- 注: `该参数如果和FlowType同时传,以该参数优先生效`
9487
- */
9488
- UserFlowTypeId?: string;
9489
- /**
9490
- * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
9491
- */
9492
- FlowType?: string;
9493
- /**
9494
- * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
9495
-
9496
- 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
9497
- */
9498
- Approvers?: Array<FlowCreateApprover>;
9499
- /**
9500
- * 开启或者关闭智能添加填写区:
9501
- <ul><li> **OPEN**:开启(默认值)</li>
9502
- <li> **CLOSE**:关闭</li></ul>
9503
- */
9504
- IntelligentStatus?: string;
9505
- /**
9506
- * 该字段已不再使用,请使用InitiatorComponents
9507
- */
9508
- Components?: Component;
9509
- /**
9510
- * 发起合同个性化参数
9511
- 用于满足创建及页面操作过程中的个性化要求
9512
- 具体定制化内容详见数据接口说明
9513
- */
9514
- FlowOption?: CreateFlowOption;
9515
- /**
9516
- * 发起方企业签署员工,在进行签署操作前,是否需要先通过企业内部审批流程 (签署审核)
9517
- 1. **false(默认)**: 无需审批,发起方企业签署员工可直接进行签署操作。
9518
- 2. **true**: 需要先走企业内部审批流程。 当流程进展到发起方企业签署员工时,其签署操作会被阻塞,等待企业内部审批结果。
9519
-
9520
- 企业应通过 <a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview" target="_blank">提交签署流程审批结果</a>审批接口,将内部审批结果通知腾讯电子签平台:
9521
- 1. 若通知为“审核通过”,发起方企业签署员工可继续完成签署操作。
9522
- 2. 若通知为“审核未通过”,平台将继续阻塞该签署方的签署操作,直到企业再次通知平台审核通过为止。
9523
-
9524
- 说明: 此能力可用于与企业内部审批流程打通,适用于手动签署和自动签署两种模式。
9525
- */
9526
- NeedSignReview?: boolean;
9527
- /**
9528
- * 发起方在创建合同流程前,是否必须先通过企业内部审批流程 (发起审核)
9529
-
9530
- 当设置为 `true` 时:
9531
- 1. 您需要在企业内部完成审批,并通过接口 <a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview" target="_blank">提交签署流程审批结果</a> 将审批结果回传给腾讯电子签。
9532
- 2. 只有当审核状态为“通过”时,合同流程正常发起。
9533
- 3. 若未通过或未回传审核结果,发起操作将被阻塞,阻止合同流程。
9534
-
9535
- 当设置为 `false` (默认值)时:
9536
- 发起方无需经过企业内部审批,可直接发起合同流程。
9537
- */
9538
- NeedCreateReview?: boolean;
9539
- /**
9540
- * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
9541
-
9542
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
9543
- */
9544
- UserData?: string;
9545
- /**
9546
- * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
9547
-
9548
- */
9549
- CcInfos?: Array<CcInfo>;
9550
- /**
9551
- * 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
9552
- 注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
9553
- */
9554
- FlowId?: string;
9555
- /**
9556
- * 代理企业和员工的信息。
9557
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9558
- */
9559
- Agent?: Agent;
9560
- /**
9561
- * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
9562
-
9563
- */
9564
- InitiatorComponents?: Array<Component>;
9565
- /**
9566
- * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
9567
- */
9568
- FlowDisplayType?: number;
9569
- /**
9570
- * <font color="red">此字段已不再使用,请使用 CreateFlowOption 里面的 SignComponentConfig</font>
9571
- 签署控件的配置信息,用在嵌入式发起的页面配置,
9572
- 包括
9573
-
9574
- - 签署控件 是否默认展示日期.
9575
- * @deprecated
9576
- */
9577
- SignComponentConfig?: SignComponentConfig;
9578
- /**
9579
- * 是否开启嵌入式合同发起时,提交发起审批流,默认:false(不开启),开启后,嵌入式合同发起后,会提交电子签内置审批流
9580
- */
9581
- Workflow?: boolean;
9582
- }
9583
- /**
9584
- * DescribeCancelFlowsTask请求参数结构体
9585
- */
9586
- export interface DescribeCancelFlowsTaskRequest {
9587
- /**
9588
- * 执行本接口操作的员工信息。
9589
- <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
9590
- */
9591
- Operator: UserInfo;
9592
- /**
9593
- * 批量撤销任务编号,为32位字符串,通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
9594
- */
9595
- TaskId: string;
9596
- /**
9597
- * 代理企业和员工的信息。
9598
- <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9599
- */
9600
- Agent?: Agent;
9601
- }
9602
- /**
9603
- * DescribeContractReviewMarkedRiskExportTask返回参数结构体
9604
- */
9605
- export interface DescribeContractReviewMarkedRiskExportTaskResponse {
9606
- /**
9607
- * 导出文件 url。
9608
- */
9609
- Url?: string;
9610
- /**
9611
- * 任务状态。未知 = 0; 创建完成 = 1; 队列中 = 2; 执行中 = 3; 执行成功 = 4; 失败 = 5; 终止 = 6;
9612
- */
9613
- Status?: number;
9614
- /**
9615
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9616
- */
9617
- RequestId?: string;
9618
- }
9619
- /**
9620
- * CreateSealPolicy请求参数结构体
9621
- */
9622
- export interface CreateSealPolicyRequest {
9623
- /**
9624
- * 执行本接口操作的员工信息。
9625
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
9626
- */
9627
- Operator: UserInfo;
9628
- /**
9629
- * 用户在电子文件签署平台标识信息,具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用
9630
- */
9631
- Users: Array<UserInfo>;
9632
- /**
9633
- * 电子印章ID,为32位字符串。
9634
- 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
9635
- 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
9636
- */
9637
- SealId: string;
9638
- /**
9639
- * 授权有效期,时间戳秒级。可以传0,代表有效期到2099年12月12日23点59分59秒。
9640
- */
9641
- Expired: number;
9642
- /**
9643
- * 需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填,跟上面的Users同时起作用
9644
- */
9645
- UserIds?: Array<string>;
9646
- /**
9647
- * 印章授权内容
9648
- */
9649
- Policy?: string;
9650
- /**
9651
- * 代理企业和员工的信息。
9652
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9653
- */
9654
- Agent?: Agent;
9655
- /**
9656
- * 个性化配置字段,默认不传。
9657
- */
9658
- Options?: Array<Option>;
9659
- }
9660
- /**
9661
- * DescribeContractReviewTask返回参数结构体
9662
- */
9663
- export interface DescribeContractReviewTaskResponse {
9664
- /**
9665
- * 该字段已不再使用!
9666
- 用于审查任务的审查清单ID。注意:如果用户没有配置清单时此值可能为空,需要等大模型根据合同内容推荐出可以使用的审查清单。
9667
- */
9668
- ChecklistId?: string;
9669
- /**
9670
- * 用于审查任务的审查清单ID。注意:如果用户没有配置清单时此值可能为空,需要等大模型根据合同内容推荐出可以使用的审查清单。
9671
- */
9672
- ChecklistIds?: Array<string>;
9673
- /**
9674
- * 合同审查任务创建时间。
9675
- */
9676
- CreatedOn?: number;
9677
- /**
9678
- * 合同审查任务完成时间。
9679
- */
9680
- FinishedOn?: number;
9681
- /**
9682
- * 合同审查的审查立场方。
9683
-
9684
- 审查立场方如下:
9685
- <ul>
9686
- <li>**0** - 【严格】以保护己方利益为核心,对合同条款进行严格把控,尽可能争取对己方有利的条款,同时对对方提出的不合理条款可进行坚决修改或删除。</li>
9687
- <li>**1** - 【中立】以公平合理为原则,平衡双方的权利义务,既不过分强调己方利益,也不过度让步,力求达成双方均可接受的条款。</li>
9688
- <li>**2** - 【宽松】以促成交易为核心,对合同条款的修改要求较为宽松,倾向于接受对方提出的条款,以尽快达成合作。</li>
9689
- </ul>
9690
- */
9691
- PolicyType?: number;
9692
- /**
9693
- * 合同审查的PDF、WORD文件资源ID。
9694
- */
9695
- ResourceId?: string;
9696
- /**
9697
- * 合同审查识别出的PDF文件风险信息,如果是空数组表示无风险。
9698
-
9699
- 注意:`审查结果由AI生成,仅供参考。请结合相关法律法规和公司制度要求综合判断。`
9700
- */
9701
- Risks?: Array<OutputRisk>;
9702
- /**
9703
- * 该字段已不再使用!
9704
- 合同审查中的角色信息。注意: `如果用户没有配置审查角色时此值可能为null,需要等大模型根据合同内容推荐出审查角色信息。`
9705
- 注意:此字段可能返回 null,表示取不到有效值。
9706
- */
9707
- Role?: RiskIdentificationRoleInfo;
9708
- /**
9709
- * 合同审查中的角色信息。注意: `如果用户没有配置审查角色时此值可能为null,需要等大模型根据合同内容推荐出审查角色信息。`
9710
- */
9711
- Roles?: Array<RiskIdentificationRoleInfo>;
9712
- /**
9713
- * 合同审查任务状态。
9714
- 状态如下:
9715
- <ul>
9716
- <li>**1** - 合同审查任务创建成功</li>
9717
- <li>**2** - 合同审查任务排队中</li>
9718
- <li>**3** - 合同审查任务执行中</li>
9719
- <li>**4** - 合同审查任务执行成功</li>
9720
- <li>**5** - 合同审查任务执行失败</li>
9721
- </ul>
9722
- */
9723
- Status?: number;
9724
- /**
9725
- * 合同审查任务ID
9726
- */
9727
- TaskId?: string;
9728
- /**
9729
- * 审查任务备注信息,长度不能超过100个字符
9730
- */
9731
- Comment?: string;
9732
- /**
9733
- * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。
9734
-
9735
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
9736
- */
9737
- UserData?: string;
9738
- /**
9739
- * 合同审查出的高风险项数量
9940
+
9941
+ 该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
9942
+ 注: `该参数如果和FlowType同时传,以该参数优先生效`
9740
9943
  */
9741
- HighRiskCount?: number;
9944
+ UserFlowTypeId?: string;
9742
9945
  /**
9743
- * 合同审查出的风险总数
9946
+ * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
9744
9947
  */
9745
- TotalRiskCount?: number;
9948
+ FlowType?: string;
9746
9949
  /**
9747
- * 通过项信息(详细引文信息)
9748
- 注意:此字段可能返回 null,表示取不到有效值。
9950
+ * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
9951
+
9952
+ 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
9749
9953
  */
9750
- ApprovedLists?: Array<OutputReference>;
9954
+ Approvers?: Array<FlowCreateApprover>;
9751
9955
  /**
9752
- * 摘要信息
9956
+ * 开启或者关闭智能添加填写区:
9957
+ <ul><li> **OPEN**:开启(默认值)</li>
9958
+ <li> **CLOSE**:关闭</li></ul>
9753
9959
  */
9754
- Summaries?: Array<ContractSummary>;
9960
+ IntelligentStatus?: string;
9755
9961
  /**
9756
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9962
+ * 该字段已不再使用,请使用InitiatorComponents
9757
9963
  */
9758
- RequestId?: string;
9759
- }
9760
- /**
9761
- * CancelFlow请求参数结构体
9762
- */
9763
- export interface CancelFlowRequest {
9964
+ Components?: Component;
9764
9965
  /**
9765
- * 执行本接口操作的员工信息。
9766
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
9966
+ * 发起合同个性化参数
9967
+ 用于满足创建及页面操作过程中的个性化要求
9968
+ 具体定制化内容详见数据接口说明
9767
9969
  */
9768
- Operator: UserInfo;
9970
+ FlowOption?: CreateFlowOption;
9769
9971
  /**
9770
- * 合同流程ID, 为32位字符串。
9972
+ * 发起方企业签署员工,在进行签署操作前,是否需要先通过企业内部审批流程 (签署审核)
9973
+ 1. **false(默认)**: 无需审批,发起方企业签署员工可直接进行签署操作。
9974
+ 2. **true**: 需要先走企业内部审批流程。 当流程进展到发起方企业签署员工时,其签署操作会被阻塞,等待企业内部审批结果。
9771
9975
 
9772
- 可登录腾讯电子签控制台,[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
9976
+ 企业应通过 <a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview" target="_blank">提交签署流程审批结果</a>审批接口,将内部审批结果通知腾讯电子签平台:
9977
+ 1. 若通知为“审核通过”,发起方企业签署员工可继续完成签署操作。
9978
+ 2. 若通知为“审核未通过”,平台将继续阻塞该签署方的签署操作,直到企业再次通知平台审核通过为止。
9979
+
9980
+ 说明: 此能力可用于与企业内部审批流程打通,适用于手动签署和自动签署两种模式。
9773
9981
  */
9774
- FlowId: string;
9982
+ NeedSignReview?: boolean;
9775
9983
  /**
9776
- * 撤销此合同流程的**撤销理由**,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
9984
+ * 发起方在创建合同流程前,是否必须先通过企业内部审批流程 (发起审核)
9777
9985
 
9778
- ![image](https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png)
9986
+ 当设置为 `true` 时:
9987
+ 1. 您需要在企业内部完成审批,并通过接口 <a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview" target="_blank">提交签署流程审批结果</a> 将审批结果回传给腾讯电子签。
9988
+ 2. 只有当审核状态为“通过”时,合同流程正常发起。
9989
+ 3. 若未通过或未回传审核结果,发起操作将被阻塞,阻止合同流程。
9990
+
9991
+ 当设置为 `false` (默认值)时:
9992
+ 发起方无需经过企业内部审批,可直接发起合同流程。
9779
9993
  */
9780
- CancelMessage: string;
9994
+ NeedCreateReview?: boolean;
9781
9995
  /**
9782
- * 代理企业和员工的信息。
9783
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9996
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
9997
+
9998
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
9784
9999
  */
9785
- Agent?: Agent;
9786
- }
9787
- /**
9788
- * DescribeExtendedServiceAuthInfos请求参数结构体
9789
- */
9790
- export interface DescribeExtendedServiceAuthInfosRequest {
10000
+ UserData?: string;
9791
10001
  /**
9792
- * 执行本接口操作的员工信息。
9793
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10002
+ * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
10003
+
9794
10004
  */
9795
- Operator: UserInfo;
10005
+ CcInfos?: Array<CcInfo>;
9796
10006
  /**
9797
- * 要查询的扩展服务类型。
9798
- 默认为空,即查询当前支持的所有扩展服务信息。
9799
- 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
9800
- <ul><li>OPEN_SERVER_SIGN:企业自动签署</li>
9801
- <li>AUTO_SIGN_CAN_FILL_IN:本企业自动签合同支持签前内容补充</li>
9802
- <li>BATCH_SIGN:批量签署</li>
9803
- <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
9804
- <li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li>
9805
- <li>MOBILE_CHECK_APPROVER:个人签署方仅校验手机号</li>
9806
- <li>HIDE_OPERATOR_DISPLAY:隐藏合同经办人姓名</li>
9807
- <li>ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型</li>
9808
- <li>ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方</li>
9809
- <li>ORGANIZATION_FLOW_EMAIL_NOTIFY:邮件通知签署方</li>
9810
- <li>FLOW_APPROVAL:合同审批强制开启</li>
9811
- <li>ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导</li>
9812
- <li>HIDE_ONE_KEY_SIGN:个人签署方手写签名时需逐个手写</li>
9813
- <li>SIGN_SIGNATURE_DEFAULT_SET_HANDWRITE:个人签署方手动签名</li>
9814
- <li>APP_LOGIN:限制企业员工小程序端登录</li>
9815
- <li>PC_LOGIN:限制企业员工网页端登录</li>
9816
- </ul>
10007
+ * 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
10008
+ 注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
9817
10009
  */
9818
- ExtendServiceType?: string;
10010
+ FlowId?: string;
9819
10011
  /**
9820
10012
  * 代理企业和员工的信息。
9821
10013
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9822
10014
  */
9823
10015
  Agent?: Agent;
9824
- }
9825
- /**
9826
- * UpdateIntegrationEmployees请求参数结构体
9827
- */
9828
- export interface UpdateIntegrationEmployeesRequest {
9829
- /**
9830
- * 执行本接口操作的员工信息,UserId必填。
9831
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
9832
- */
9833
- Operator: UserInfo;
9834
10016
  /**
9835
- * 需要更新的员工信息,最多不超过100个。根据UserId或OpenId更新员工信息,必须填写其中一个,优先使用UserId。
10017
+ * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
9836
10018
 
9837
- 可更新以下字段,其他字段暂不支持
9838
- <table> <thead> <tr> <th>参数</th> <th>含义</th> </tr> </thead> <tbody> <tr> <td>DisplayName</td> <td>用户的真实名字</td> </tr> <tr> <td>Mobile</td> <td>用户手机号码</td> </tr> <tr> <td>Email</td> <td>用户的邮箱</td> </tr> <tr> <td>Department.DepartmentId</td> <td>用户进入后的部门ID</td> </tr> </tbody> </table>
9839
- */
9840
- Employees: Array<Staff>;
9841
- /**
9842
- * 代理企业和员工的信息。
9843
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9844
10019
  */
9845
- Agent?: Agent;
10020
+ InitiatorComponents?: Array<Component>;
9846
10021
  /**
9847
- * 员工邀请方式可通过以下途径进行设置:<ul><li>**SMS(默认)**:邀请将通过短信或企业微信消息发送。若场景非企业微信,则采用企业微信消息;其他情境下则使用短信通知。短信内含链接,点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**:将生成H5链接,用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**:系统会根据Endpoint生成签署链接,业务方需获取链接并通知客户。</li></ul>
10022
+ * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
9848
10023
  */
9849
- InvitationNotifyType?: string;
10024
+ FlowDisplayType?: number;
9850
10025
  /**
9851
- * 回跳地址,为认证成功后页面进行回跳的URL,请确保回跳地址的可用性。注:`只有在员工邀请方式(InvitationNotifyType参数)为H5场景下才生效, 其他方式下设置无效。`
10026
+ * <font color="red">此字段已不再使用,请使用 CreateFlowOption 里面的 SignComponentConfig</font>
10027
+ 签署控件的配置信息,用在嵌入式发起的页面配置,
10028
+ 包括
10029
+
10030
+ - 签署控件 是否默认展示日期.
10031
+ * @deprecated
9852
10032
  */
9853
- JumpUrl?: string;
10033
+ SignComponentConfig?: SignComponentConfig;
9854
10034
  /**
9855
- * 要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**H5**: 第三方移动端浏览器进行嵌入,不支持小程序嵌入,过期时间一个月</li></ul>注意:InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型(InvitationNotifyType)</td><td>Endpoint</td></tr><tr><td>SMS(默认)</td><td>不需要传递,会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递,会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持(HTTP_URL/HTTP_SHORT_URL/H5/APP)默认为HTTP_SHORT_URL</td></tr></tbody></table>
10035
+ * 是否开启嵌入式合同发起时,提交发起审批流,默认:false(不开启),开启后,嵌入式合同发起后,会提交电子签内置审批流
9856
10036
  */
9857
- Endpoint?: string;
10037
+ Workflow?: boolean;
9858
10038
  }
9859
10039
  /**
9860
- * CreateFlowGroupByTemplates请求参数结构体
10040
+ * DescribeCancelFlowsTask请求参数结构体
9861
10041
  */
9862
- export interface CreateFlowGroupByTemplatesRequest {
10042
+ export interface DescribeCancelFlowsTaskRequest {
9863
10043
  /**
9864
10044
  * 执行本接口操作的员工信息。
9865
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10045
+ <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
9866
10046
  */
9867
10047
  Operator: UserInfo;
9868
10048
  /**
9869
- * 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
9870
- */
9871
- FlowGroupName: string;
9872
- /**
9873
- * 合同(流程)组的子合同信息,支持2-50个子合同
10049
+ * 批量撤销任务编号,为32位字符串,通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
9874
10050
  */
9875
- FlowGroupInfos: Array<FlowGroupInfo>;
10051
+ TaskId: string;
9876
10052
  /**
9877
10053
  * 代理企业和员工的信息。
9878
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10054
+ <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9879
10055
  */
9880
10056
  Agent?: Agent;
9881
- /**
9882
- * 合同(流程)组的配置项信息。
9883
- 其中包括:
9884
- <ul>
9885
- <li>是否通知本企业签署方</li>
9886
- <li>是否通知其他签署方</li>
9887
- </ul>
9888
- */
9889
- FlowGroupOptions?: FlowGroupOptions;
9890
- /**
9891
- * 用户自定义合同类型。
9892
- 自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
9893
-
9894
- 注意: 如果传递了自定义合同类型,则每一个子合同对应模板上面的自定义合同类型将会失效,已最外层定义的为准。 例如: 这份合同组有三个子合同,设置合同类型为<font color="blue">人事/劳务</font> 第一份子合同选择的模板的合同自定义合同类型是<font color="blue">采购</font> 第二份和第三份子合同选择的模板的合同自定义合同类型是<font color="blue">人事/劳务</font> 但最终这个合同组的合同类型是<font color="blue">人事/劳务</font>
9895
- */
9896
- UserFlowType?: UserFlowType;
9897
10057
  }
9898
10058
  /**
9899
- * CreateBatchContractReviewTask返回参数结构体
10059
+ * DescribeContractReviewMarkedRiskExportTask返回参数结构体
9900
10060
  */
9901
- export interface CreateBatchContractReviewTaskResponse {
10061
+ export interface DescribeContractReviewMarkedRiskExportTaskResponse {
9902
10062
  /**
9903
- * 合同审查的任务ID列表,每个任务ID为32位字符串。
9904
- 建议开发者保存此任务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/)需要此任务ID。
9905
-
9906
- 注意:`返回的索引和ResourceIds数组一致`
10063
+ * 导出文件 url。
9907
10064
  */
9908
- TaskIds?: Array<string>;
10065
+ Url?: string;
10066
+ /**
10067
+ * 任务状态。未知 = 0; 创建完成 = 1; 队列中 = 2; 执行中 = 3; 执行成功 = 4; 失败 = 5; 终止 = 6;
10068
+ */
10069
+ Status?: number;
9909
10070
  /**
9910
10071
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9911
10072
  */
9912
10073
  RequestId?: string;
9913
10074
  }
9914
10075
  /**
9915
- * DescribeSignFaceVideo请求参数结构体
10076
+ * CreateSealPolicy请求参数结构体
9916
10077
  */
9917
- export interface DescribeSignFaceVideoRequest {
10078
+ export interface CreateSealPolicyRequest {
9918
10079
  /**
9919
- * 执行本接口操作的员工信息。使用此接口时,必须填写userId。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10080
+ * 执行本接口操作的员工信息。
10081
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
9920
10082
  */
9921
10083
  Operator: UserInfo;
9922
10084
  /**
9923
- * 合同流程ID,为32位字符串。
10085
+ * 用户在电子文件签署平台标识信息,具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用
9924
10086
  */
9925
- FlowId: string;
10087
+ Users: Array<UserInfo>;
9926
10088
  /**
9927
- * 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
10089
+ * 电子印章ID,为32位字符串。
10090
+ 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
10091
+ 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
9928
10092
  */
9929
- SignId: string;
10093
+ SealId: string;
10094
+ /**
10095
+ * 授权有效期,时间戳秒级。可以传0,代表有效期到2099年12月12日23点59分59秒。
10096
+ */
10097
+ Expired: number;
10098
+ /**
10099
+ * 需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填,跟上面的Users同时起作用
10100
+ */
10101
+ UserIds?: Array<string>;
10102
+ /**
10103
+ * 印章授权内容
10104
+ */
10105
+ Policy?: string;
9930
10106
  /**
9931
10107
  * 代理企业和员工的信息。
9932
10108
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9933
10109
  */
9934
10110
  Agent?: Agent;
10111
+ /**
10112
+ * 个性化配置字段,默认不传。
10113
+ */
10114
+ Options?: Array<Option>;
9935
10115
  }
9936
10116
  /**
9937
- * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。
9938
- 通过链接,用户可直接访问电子签名小程序并签署合同。
10117
+ * DescribeContractReviewTask返回参数结构体
9939
10118
  */
9940
- export interface SignUrl {
10119
+ export interface DescribeContractReviewTaskResponse {
9941
10120
  /**
9942
- * 跳转至电子签名小程序签署的链接地址。
9943
- 适用于客户端APP及小程序直接唤起电子签名小程序。
10121
+ * 该字段已不再使用!
10122
+ 用于审查任务的审查清单ID。注意:如果用户没有配置清单时此值可能为空,需要等大模型根据合同内容推荐出可以使用的审查清单。
9944
10123
  */
9945
- AppSignUrl?: string;
10124
+ ChecklistId?: string;
9946
10125
  /**
9947
- * 签署链接有效时间,格式类似"2022-08-05 15:55:01"
10126
+ * 用于审查任务的审查清单ID。注意:如果用户没有配置清单时此值可能为空,需要等大模型根据合同内容推荐出可以使用的审查清单。
9948
10127
  */
9949
- EffectiveTime?: string;
10128
+ ChecklistIds?: Array<string>;
9950
10129
  /**
9951
- * 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。
9952
- 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
10130
+ * 合同审查任务创建时间。
9953
10131
  */
9954
- HttpSignUrl?: string;
9955
- }
9956
- /**
9957
- * DescribeOrganizationSeals请求参数结构体
9958
- */
9959
- export interface DescribeOrganizationSealsRequest {
10132
+ CreatedOn?: number;
9960
10133
  /**
9961
- * 执行本接口操作的员工信息。
9962
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10134
+ * 合同审查任务完成时间。
9963
10135
  */
9964
- Operator: UserInfo;
10136
+ FinishedOn?: number;
9965
10137
  /**
9966
- * 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 200。
10138
+ * 合同审查的审查立场方。
10139
+
10140
+ 审查立场方如下:
10141
+ <ul>
10142
+ <li>**0** - 【严格】以保护己方利益为核心,对合同条款进行严格把控,尽可能争取对己方有利的条款,同时对对方提出的不合理条款可进行坚决修改或删除。</li>
10143
+ <li>**1** - 【中立】以公平合理为原则,平衡双方的权利义务,既不过分强调己方利益,也不过度让步,力求达成双方均可接受的条款。</li>
10144
+ <li>**2** - 【宽松】以促成交易为核心,对合同条款的修改要求较为宽松,倾向于接受对方提出的条款,以尽快达成合作。</li>
10145
+ </ul>
9967
10146
  */
9968
- Limit?: number;
10147
+ PolicyType?: number;
9969
10148
  /**
9970
- * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 20000
10149
+ * 合同审查的PDF、WORD文件资源ID
9971
10150
  */
9972
- Offset?: number;
10151
+ ResourceId?: string;
9973
10152
  /**
9974
- * 查询授权用户信息类型,取值如下:
10153
+ * 合同审查识别出的PDF文件风险信息,如果是空数组表示无风险。
9975
10154
 
9976
- <ul> <li><b>0</b>:(默认)不返回授权用户信息</li> <li><b>1</b>:返回授权用户的信息</li> </ul>
9977
- */
9978
- InfoType?: number;
9979
- /**
9980
- * 印章id,是否查询特定的印章(没有输入返回所有)
10155
+ 注意:`审查结果由AI生成,仅供参考。请结合相关法律法规和公司制度要求综合判断。`
9981
10156
  */
9982
- SealId?: string;
10157
+ Risks?: Array<OutputRisk>;
9983
10158
  /**
9984
- * 印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>FINANCE</strong>:财务专用章;</li> <li><strong>PERSONNEL</strong>:人事专用章;</li><li><strong>INVOICE</strong>:发票专用章;</li><li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> <li><strong>EMPLOYEE_QUALIFICATION_SEAL</strong>:员工执业章。</li><li><strong>OTHER</strong>其他类型印章</li> </ul>
10159
+ * 该字段已不再使用!
10160
+ 合同审查中的角色信息。注意: `如果用户没有配置审查角色时此值可能为null,需要等大模型根据合同内容推荐出审查角色信息。`
10161
+ 注意:此字段可能返回 null,表示取不到有效值。
9985
10162
  */
9986
- SealTypes?: Array<string>;
10163
+ Role?: RiskIdentificationRoleInfo;
9987
10164
  /**
9988
- * 代理企业和员工的信息。
9989
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10165
+ * 合同审查中的角色信息。注意: `如果用户没有配置审查角色时此值可能为null,需要等大模型根据合同内容推荐出审查角色信息。`
9990
10166
  */
9991
- Agent?: Agent;
10167
+ Roles?: Array<RiskIdentificationRoleInfo>;
9992
10168
  /**
9993
- * 需查询的印章状态列表。
10169
+ * 合同审查任务状态。
10170
+ 状态如下:
9994
10171
  <ul>
9995
- <li>空:(默认)仅查询启用状态的印章;</li>
9996
- <li><strong>ALL</strong>:查询所有状态的印章;</li>
9997
- <li><strong>CHECKING</strong>:查询待审核的印章;</li>
9998
- <li><strong>SUCCESS</strong>:查询启用状态的印章;</li>
9999
- <li><strong>FAIL</strong>:查询印章审核拒绝的印章;</li>
10000
- <li><strong>DISABLE</strong>:查询已停用的印章;</li>
10001
- <li><strong>STOPPED</strong>:查询已终止的印章;</li>
10002
- <li><strong>VOID</strong>:查询已作废的印章;</li>
10003
- <li><strong>INVALID</strong>:查询已失效的印章。</li>
10172
+ <li>**1** - 合同审查任务创建成功</li>
10173
+ <li>**2** - 合同审查任务排队中</li>
10174
+ <li>**3** - 合同审查任务执行中</li>
10175
+ <li>**4** - 合同审查任务执行成功</li>
10176
+ <li>**5** - 合同审查任务执行失败</li>
10004
10177
  </ul>
10005
10178
  */
10006
- SealStatuses?: Array<string>;
10007
- }
10008
- /**
10009
- * CreateBatchOrganizationAuthorizationUrl请求参数结构体
10010
- */
10011
- export interface CreateBatchOrganizationAuthorizationUrlRequest {
10179
+ Status?: number;
10012
10180
  /**
10013
- * 执行本接口操作的员工信息。
10014
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10181
+ * 合同审查任务ID
10015
10182
  */
10016
- Operator: UserInfo;
10183
+ TaskId?: string;
10017
10184
  /**
10018
- * 组织机构超管姓名。 在注册流程中,必须是超管本人进行操作。
10019
- 此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminName 保持一致。
10185
+ * 审查任务备注信息,长度不能超过100个字符
10020
10186
  */
10021
- AdminName: string;
10187
+ Comment?: string;
10022
10188
  /**
10023
- * 组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks) Admin Mobile保持一致。
10189
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。
10190
+
10191
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
10024
10192
  */
10025
- AdminMobile: string;
10193
+ UserData?: string;
10026
10194
  /**
10027
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
10195
+ * 合同审查出的高风险项数量
10028
10196
  */
10029
- Agent?: Agent;
10197
+ HighRiskCount?: number;
10030
10198
  /**
10031
- * 企业批量认证链接的子任务 SubTaskId,该 SubTaskId 是通过接口 查询企业批量认证链接 DescribeBatchOrganizationRegistrationUrls 获得。此参数需与超管个人三要素(AdminName,AdminMobile,AdminIdCardNumber)配合使用。若 SubTaskId 不属于传入的超级管理员,将进行筛选。
10199
+ * 合同审查出的风险总数
10032
10200
  */
10033
- SubTaskIds?: Array<string>;
10201
+ TotalRiskCount?: number;
10034
10202
  /**
10035
- * 组织机构超管证件类型支持以下类型
10036
- - ID_CARD : 中国大陆居民身份证 (默认值)
10037
- - HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证
10038
- - HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)
10039
- 此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。
10203
+ * 通过项信息(详细引文信息)
10204
+ 注意:此字段可能返回 null,表示取不到有效值。
10040
10205
  */
10041
- AdminIdCardType?: string;
10206
+ ApprovedLists?: Array<OutputReference>;
10042
10207
  /**
10043
- * 组织机构超管证件号。 在注册流程中,必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardNumber保持一致。
10208
+ * 摘要信息
10044
10209
  */
10045
- AdminIdCardNumber?: string;
10210
+ Summaries?: Array<ContractSummary>;
10046
10211
  /**
10047
- * 要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**QR_CODE**: 跳转电子签小程序的http_url的二维码形式, 可以在页面展示适合此类型</li></ul>
10212
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10048
10213
  */
10049
- Endpoint?: string;
10214
+ RequestId?: string;
10050
10215
  }
10051
10216
  /**
10052
- * CreateDigitalDataSign请求参数结构体
10217
+ * CancelFlow请求参数结构体
10053
10218
  */
10054
- export interface CreateDigitalDataSignRequest {
10219
+ export interface CancelFlowRequest {
10055
10220
  /**
10056
- * 执行本接口操作的员工信息。使用此接口时,必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10221
+ * 执行本接口操作的员工信息。
10222
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10057
10223
  */
10058
10224
  Operator: UserInfo;
10059
10225
  /**
10060
- * 代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10226
+ * 合同流程ID, 为32位字符串。
10227
+
10228
+ 可登录腾讯电子签控制台,[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
10061
10229
  */
10062
- Agent?: Agent;
10230
+ FlowId: string;
10063
10231
  /**
10064
- * 数据加签的原文
10232
+ * 撤销此合同流程的**撤销理由**,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
10233
+
10234
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png)
10065
10235
  */
10066
- PlainText?: string;
10236
+ CancelMessage: string;
10237
+ /**
10238
+ * 代理企业和员工的信息。
10239
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10240
+ */
10241
+ Agent?: Agent;
10067
10242
  }
10068
10243
  /**
10069
- * CreateBatchCancelFlowUrl请求参数结构体
10244
+ * DescribeExtendedServiceAuthInfos请求参数结构体
10070
10245
  */
10071
- export interface CreateBatchCancelFlowUrlRequest {
10246
+ export interface DescribeExtendedServiceAuthInfosRequest {
10072
10247
  /**
10073
10248
  * 执行本接口操作的员工信息。
10074
- <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
10249
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10075
10250
  */
10076
10251
  Operator: UserInfo;
10077
10252
  /**
10078
- * 需要执行撤回的流程(合同)的编号列表,最多100个.
10079
- 列表中的流程(合同)编号不要重复.
10253
+ * 要查询的扩展服务类型。
10254
+ 默认为空,即查询当前支持的所有扩展服务信息。
10255
+ 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
10256
+ <ul><li>OPEN_SERVER_SIGN:企业自动签署</li>
10257
+ <li>AUTO_SIGN_CAN_FILL_IN:本企业自动签合同支持签前内容补充</li>
10258
+ <li>BATCH_SIGN:批量签署</li>
10259
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
10260
+ <li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li>
10261
+ <li>MOBILE_CHECK_APPROVER:个人签署方仅校验手机号</li>
10262
+ <li>HIDE_OPERATOR_DISPLAY:隐藏合同经办人姓名</li>
10263
+ <li>ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型</li>
10264
+ <li>ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方</li>
10265
+ <li>ORGANIZATION_FLOW_EMAIL_NOTIFY:邮件通知签署方</li>
10266
+ <li>FLOW_APPROVAL:合同审批强制开启</li>
10267
+ <li>ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导</li>
10268
+ <li>HIDE_ONE_KEY_SIGN:个人签署方手写签名时需逐个手写</li>
10269
+ <li>SIGN_SIGNATURE_DEFAULT_SET_HANDWRITE:个人签署方手动签名</li>
10270
+ <li>APP_LOGIN:限制企业员工小程序端登录</li>
10271
+ <li>PC_LOGIN:限制企业员工网页端登录</li>
10272
+ </ul>
10080
10273
  */
10081
- FlowIds: Array<string>;
10274
+ ExtendServiceType?: string;
10082
10275
  /**
10083
10276
  * 代理企业和员工的信息。
10084
- <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10277
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10085
10278
  */
10086
10279
  Agent?: Agent;
10087
10280
  }
10088
10281
  /**
10089
- * CreateMultiFlowSignQRCode请求参数结构体
10282
+ * UpdateIntegrationEmployees请求参数结构体
10090
10283
  */
10091
- export interface CreateMultiFlowSignQRCodeRequest {
10284
+ export interface UpdateIntegrationEmployeesRequest {
10092
10285
  /**
10093
- * 执行本接口操作的员工信息。
10286
+ * 执行本接口操作的员工信息,UserId必填。
10094
10287
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10095
10288
  */
10096
10289
  Operator: UserInfo;
10097
10290
  /**
10098
- * 合同模板ID,为32位字符串。
10099
- 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
10100
- */
10101
- TemplateId: string;
10102
- /**
10103
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
10104
- 该名称还将用于合同签署完成后的下载文件名。
10105
- */
10106
- FlowName: string;
10107
- /**
10108
- * 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
10109
- 一旦发起流程数超越该限制,该二维码将自动失效。
10110
- */
10111
- MaxFlowNum?: number;
10112
- /**
10113
- * 二维码的有效期限,默认为7天,最高设定不得超过90天。
10114
- 一旦超过二维码的有效期限,该二维码将自动失效。
10115
- * @deprecated
10116
- */
10117
- QrEffectiveDay?: number;
10118
- /**
10119
- * 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
10120
- 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
10121
- 最长设定期限不得超过30天。
10122
- */
10123
- FlowEffectiveDay?: number;
10124
- /**
10125
- * 指定签署人信息。
10126
- 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
10127
- */
10128
- Restrictions?: Array<ApproverRestriction>;
10129
- /**
10130
- * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
10131
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
10132
- 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
10133
- */
10134
- UserData?: string;
10135
- /**
10136
- * 已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
10137
- <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
10138
- <br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
10291
+ * 需要更新的员工信息,最多不超过100个。根据UserId或OpenId更新员工信息,必须填写其中一个,优先使用UserId。
10139
10292
 
10140
- * @deprecated
10293
+ 可更新以下字段,其他字段暂不支持
10294
+ <table> <thead> <tr> <th>参数</th> <th>含义</th> </tr> </thead> <tbody> <tr> <td>DisplayName</td> <td>用户的真实名字</td> </tr> <tr> <td>Mobile</td> <td>用户手机号码</td> </tr> <tr> <td>Email</td> <td>用户的邮箱</td> </tr> <tr> <td>Department.DepartmentId</td> <td>用户进入后的部门ID</td> </tr> </tbody> </table>
10141
10295
  */
10142
- CallbackUrl?: string;
10296
+ Employees: Array<Staff>;
10143
10297
  /**
10144
10298
  * 代理企业和员工的信息。
10145
10299
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10146
10300
  */
10147
10301
  Agent?: Agent;
10148
10302
  /**
10149
- * 限制二维码用户条件(已弃用)
10150
- * @deprecated
10151
- */
10152
- ApproverRestrictions?: ApproverRestriction;
10153
- /**
10154
- * 指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。
10155
- */
10156
- ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>;
10157
- /**
10158
- * 禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。
10159
- */
10160
- ForbidPersonalMultipleSign?: boolean;
10161
- /**
10162
- * 合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。
10163
- 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
10303
+ * 员工邀请方式可通过以下途径进行设置:<ul><li>**SMS(默认)**:邀请将通过短信或企业微信消息发送。若场景非企业微信,则采用企业微信消息;其他情境下则使用短信通知。短信内含链接,点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**:将生成H5链接,用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**:系统会根据Endpoint生成签署链接,业务方需获取链接并通知客户。</li></ul>
10164
10304
  */
10165
- FlowNameAppendScannerInfo?: boolean;
10305
+ InvitationNotifyType?: string;
10166
10306
  /**
10167
- * 签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName
10307
+ * 回跳地址,为认证成功后页面进行回跳的URL,请确保回跳地址的可用性。注:`只有在员工邀请方式(InvitationNotifyType参数)为H5场景下才生效, 其他方式下设置无效。`
10168
10308
  */
10169
- QrCodeName?: string;
10309
+ JumpUrl?: string;
10170
10310
  /**
10171
- * 签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。
10311
+ * 要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**H5**: 第三方移动端浏览器进行嵌入,不支持小程序嵌入,过期时间一个月</li></ul>注意:InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型(InvitationNotifyType)</td><td>Endpoint</td></tr><tr><td>SMS(默认)</td><td>不需要传递,会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递,会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持(HTTP_URL/HTTP_SHORT_URL/H5/APP)默认为HTTP_SHORT_URL</td></tr></tbody></table>
10172
10312
  */
10173
- QrCodeExpiredOn?: number;
10313
+ Endpoint?: string;
10174
10314
  }
10175
10315
  /**
10176
- * DeleteExtendedServiceAuthInfos请求参数结构体
10316
+ * CreateFlowGroupByTemplates请求参数结构体
10177
10317
  */
10178
- export interface DeleteExtendedServiceAuthInfosRequest {
10318
+ export interface CreateFlowGroupByTemplatesRequest {
10179
10319
  /**
10180
10320
  * 执行本接口操作的员工信息。
10181
10321
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10182
10322
  */
10183
10323
  Operator: UserInfo;
10184
10324
  /**
10185
- * 本企业员工的id,需要已实名,正常在职员工
10325
+ * 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
10186
10326
  */
10187
- UserIds: Array<string>;
10327
+ FlowGroupName: string;
10188
10328
  /**
10189
- * 取值如下所示:
10190
- <ul><li>OPEN_SERVER_SIGN:企业自动签</li>
10191
- <li>BATCH_SIGN:批量签署</li>
10192
- </ul>
10329
+ * 合同(流程)组的子合同信息,支持2-50个子合同
10193
10330
  */
10194
- ExtendServiceType?: string;
10331
+ FlowGroupInfos: Array<FlowGroupInfo>;
10195
10332
  /**
10196
10333
  * 代理企业和员工的信息。
10197
10334
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10198
10335
  */
10199
10336
  Agent?: Agent;
10200
- }
10201
- /**
10202
- * DescribeFlowInfo返回参数结构体
10203
- */
10204
- export interface DescribeFlowInfoResponse {
10205
- /**
10206
- * <p>合同流程的详细信息。<br>如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。</p>
10207
- */
10208
- FlowDetailInfos?: Array<FlowDetailInfo>;
10209
10337
  /**
10210
- * <p>合同组ID,只有在查询合同组信息时才会返回。</p>
10338
+ * 合同(流程)组的配置项信息。
10339
+ 其中包括:
10340
+ <ul>
10341
+ <li>是否通知本企业签署方</li>
10342
+ <li>是否通知其他签署方</li>
10343
+ </ul>
10211
10344
  */
10212
- FlowGroupId?: string;
10345
+ FlowGroupOptions?: FlowGroupOptions;
10213
10346
  /**
10214
- * <p>合同组名称,只有在查询合同组信息时才会返回。</p>
10347
+ * 用户自定义合同类型。
10348
+ 自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
10349
+
10350
+ 注意: 如果传递了自定义合同类型,则每一个子合同对应模板上面的自定义合同类型将会失效,已最外层定义的为准。 例如: 这份合同组有三个子合同,设置合同类型为<font color="blue">人事/劳务</font> 第一份子合同选择的模板的合同自定义合同类型是<font color="blue">采购</font> 第二份和第三份子合同选择的模板的合同自定义合同类型是<font color="blue">人事/劳务</font> 但最终这个合同组的合同类型是<font color="blue">人事/劳务</font>
10215
10351
  */
10216
- FlowGroupName?: string;
10352
+ UserFlowType?: UserFlowType;
10353
+ }
10354
+ /**
10355
+ * CreateBatchContractReviewTask返回参数结构体
10356
+ */
10357
+ export interface CreateBatchContractReviewTaskResponse {
10217
10358
  /**
10218
- * <p>合同组合同备注列表</p>
10359
+ * 合同审查的任务ID列表,每个任务ID为32位字符串。
10360
+ 建议开发者保存此任务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/)需要此任务ID。
10361
+
10362
+ 注意:`返回的索引和ResourceIds数组一致`
10219
10363
  */
10220
- FlowGroupRemarks?: Array<string>;
10364
+ TaskIds?: Array<string>;
10221
10365
  /**
10222
10366
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10223
10367
  */
10224
10368
  RequestId?: string;
10225
10369
  }
10226
10370
  /**
10227
- * DescribeUserAutoSignStatus请求参数结构体
10371
+ * DescribeSignFaceVideo请求参数结构体
10228
10372
  */
10229
- export interface DescribeUserAutoSignStatusRequest {
10373
+ export interface DescribeSignFaceVideoRequest {
10230
10374
  /**
10231
- * 执行本接口操作的员工信息。
10232
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10375
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10233
10376
  */
10234
10377
  Operator: UserInfo;
10235
10378
  /**
10236
- * 自动签使用的场景值, 可以选择的场景值如下:
10237
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
10379
+ * 合同流程ID,为32位字符串。
10238
10380
  */
10239
- SceneKey: string;
10381
+ FlowId: string;
10240
10382
  /**
10241
- * 要查询状态的用户信息, 包括名字,身份证等
10383
+ * 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
10242
10384
  */
10243
- UserInfo: UserThreeFactor;
10385
+ SignId: string;
10244
10386
  /**
10245
10387
  * 代理企业和员工的信息。
10246
10388
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
@@ -10248,487 +10390,458 @@ export interface DescribeUserAutoSignStatusRequest {
10248
10390
  Agent?: Agent;
10249
10391
  }
10250
10392
  /**
10251
- * CreateFlowBlockchainEvidenceUrl请求参数结构体
10393
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。
10394
+ 通过链接,用户可直接访问电子签名小程序并签署合同。
10252
10395
  */
10253
- export interface CreateFlowBlockchainEvidenceUrlRequest {
10254
- /**
10255
- * 执行本接口操作的员工信息。
10256
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10257
- */
10258
- Operator: UserInfo;
10396
+ export interface SignUrl {
10259
10397
  /**
10260
- * 合同流程ID,为32位字符串。
10261
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
10262
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
10398
+ * 跳转至电子签名小程序签署的链接地址。
10399
+ 适用于客户端APP及小程序直接唤起电子签名小程序。
10263
10400
  */
10264
- FlowId: string;
10401
+ AppSignUrl?: string;
10265
10402
  /**
10266
- * 代理企业和员工的信息。
10267
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10403
+ * 签署链接有效时间,格式类似"2022-08-05 15:55:01"
10268
10404
  */
10269
- Agent?: Agent;
10405
+ EffectiveTime?: string;
10270
10406
  /**
10271
- * 链接/二维码的有效截止时间,格式为unix时间戳。最长不超过 2099年12月31日(4102415999)。
10272
- 默认值为有效期为当前时间后7天。
10407
+ * 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。
10408
+ 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
10273
10409
  */
10274
- ExpiredOn?: number;
10410
+ HttpSignUrl?: string;
10275
10411
  }
10276
10412
  /**
10277
- * CreateBatchQuickSignUrl请求参数结构体
10413
+ * DescribeOrganizationSeals请求参数结构体
10278
10414
  */
10279
- export interface CreateBatchQuickSignUrlRequest {
10280
- /**
10281
- * <p>批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。</p><ul><li>若为个人参与方:ApproverType=1</li><li>若为企业参与方:ApproverType=0。同时 OrganizationName 参数需传入参与方企业名称。 </li></ul>注:<code>1. 暂不支持签署人拖动签署控件功能,以及签批控件。</code><code>2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。</code>
10282
- */
10283
- FlowApproverInfo: FlowCreateApprover;
10415
+ export interface DescribeOrganizationSealsRequest {
10284
10416
  /**
10285
- * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
10417
+ * 执行本接口操作的员工信息。
10418
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10286
10419
  */
10287
- Agent?: Agent;
10420
+ Operator: UserInfo;
10288
10421
  /**
10289
- * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10422
+ * 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 200。
10290
10423
  */
10291
- Operator?: UserInfo;
10424
+ Limit?: number;
10292
10425
  /**
10293
- * <p>批量签署的合同流程ID数组。<br>注: <code>在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。</code></p>
10426
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 20000。
10294
10427
  */
10295
- FlowIds?: Array<string>;
10428
+ Offset?: number;
10296
10429
  /**
10297
- * <p>合同组编号<br>注:<code>该参数和合同流程ID数组必须二选一</code></p>
10430
+ * 查询授权用户信息类型,取值如下:
10431
+
10432
+ <ul> <li><b>0</b>:(默认)不返回授权用户信息</li> <li><b>1</b>:返回授权用户的信息</li> </ul>
10298
10433
  */
10299
- FlowGroupId?: string;
10434
+ InfoType?: number;
10300
10435
  /**
10301
- * <p>签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)</p>
10436
+ * 印章id,是否查询特定的印章(没有输入返回所有)
10302
10437
  */
10303
- JumpUrl?: string;
10438
+ SealId?: string;
10304
10439
  /**
10305
- * <p>指定批量签署合同的签名类型,可传递以下值:</p><ul><li>**0**:手写签名(默认)</li><li>**1**:OCR楷体</li><li>**2**:姓名印章</li><li>**3**:图片印章</li><li>**4**:系统签名</li><li>**5**:长效手写签名(包含手写签名)</li></ul>注:<ul><li>默认情况下,签名类型为手写签名</li><li>您可以传递多种值,表示可用多种签名类型。</li><li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li><li>若签署方为个人,签名类型“5:长效手写签名”不可用,签名方式将以合同中为准。</li></ul>
10440
+ * 印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>FINANCE</strong>:财务专用章;</li> <li><strong>PERSONNEL</strong>:人事专用章;</li><li><strong>INVOICE</strong>:发票专用章;</li><li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> <li><strong>EMPLOYEE_QUALIFICATION_SEAL</strong>:员工执业章。</li><li><strong>OTHER</strong>其他类型印章</li> </ul>
10306
10441
  */
10307
- SignatureTypes?: Array<number | bigint>;
10442
+ SealTypes?: Array<string>;
10308
10443
  /**
10309
- * <p>指定批量签署合同的认证校验方式,可传递以下值:</p><ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li><li>**2**:密码认证(默认),需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署</li><li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>注:<ul><li>默认情况下,认证校验方式为人脸和密码认证</li><li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
10444
+ * 代理企业和员工的信息。
10445
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10310
10446
  */
10311
- ApproverSignTypes?: Array<number | bigint>;
10447
+ Agent?: Agent;
10312
10448
  /**
10313
- * <p>生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:</p><ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li><li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>注:<code>不指定该值时,默认为签署方自行选择。</code>
10449
+ * 需查询的印章状态列表。
10450
+ <ul>
10451
+ <li>空:(默认)仅查询启用状态的印章;</li>
10452
+ <li><strong>ALL</strong>:查询所有状态的印章;</li>
10453
+ <li><strong>CHECKING</strong>:查询待审核的印章;</li>
10454
+ <li><strong>SUCCESS</strong>:查询启用状态的印章;</li>
10455
+ <li><strong>FAIL</strong>:查询印章审核拒绝的印章;</li>
10456
+ <li><strong>DISABLE</strong>:查询已停用的印章;</li>
10457
+ <li><strong>STOPPED</strong>:查询已终止的印章;</li>
10458
+ <li><strong>VOID</strong>:查询已作废的印章;</li>
10459
+ <li><strong>INVALID</strong>:查询已失效的印章。</li>
10460
+ </ul>
10314
10461
  */
10315
- SignTypeSelector?: number;
10462
+ SealStatuses?: Array<string>;
10463
+ }
10464
+ /**
10465
+ * CreateBatchOrganizationAuthorizationUrl请求参数结构体
10466
+ */
10467
+ export interface CreateBatchOrganizationAuthorizationUrlRequest {
10316
10468
  /**
10317
- * <p>批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。 </p><p>注: <code>若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充</code></p>
10469
+ * 执行本接口操作的员工信息。
10470
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10318
10471
  */
10319
- FlowBatchUrlInfo?: FlowBatchUrlInfo;
10472
+ Operator: UserInfo;
10320
10473
  /**
10321
- * <p><b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。 </p><p> 注意: </p><ol><li>视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。</li><li>使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。 </li><li>签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。</li></ol>
10474
+ * 组织机构超管姓名。 在注册流程中,必须是超管本人进行操作。
10475
+ 此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminName 保持一致。
10322
10476
  */
10323
- Intention?: Intention;
10477
+ AdminName: string;
10324
10478
  /**
10325
- * <p>用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。</p>
10479
+ * 组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 Admin Mobile保持一致。
10326
10480
  */
10327
- VideoVerifyTimesLimit?: number;
10481
+ AdminMobile: string;
10328
10482
  /**
10329
- * <p>缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。</p><p>注: <code>若参与方为企业员工时,暂不支持对参与方信息进行缓存</code></p>
10483
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
10330
10484
  */
10331
- CacheApproverInfo?: boolean;
10485
+ Agent?: Agent;
10332
10486
  /**
10333
- * <p>是否允许此链接中签署方批量拒签。<br> <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul></p><p>注:<code>当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。</code></p>
10487
+ * 企业批量认证链接的子任务 SubTaskId,该 SubTaskId 是通过接口 查询企业批量认证链接 DescribeBatchOrganizationRegistrationUrls 获得。此参数需与超管个人三要素(AdminName,AdminMobile,AdminIdCardNumber)配合使用。若 SubTaskId 不属于传入的超级管理员,将进行筛选。
10334
10488
  */
10335
- CanBatchReject?: boolean;
10489
+ SubTaskIds?: Array<string>;
10336
10490
  /**
10337
- * <p>预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。</p>
10491
+ * 组织机构超管证件类型支持以下类型
10492
+ - ID_CARD : 中国大陆居民身份证 (默认值)
10493
+ - HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证
10494
+ - HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)
10495
+ 此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。
10338
10496
  */
10339
- PresetApproverInfo?: PresetApproverInfo;
10497
+ AdminIdCardType?: string;
10340
10498
  /**
10341
- * <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 若批量签署的合同中第一份待签署合同所选择的印章或者签名无法完全覆盖后续合同要求,或者当前签署人没有指定印章使用权限,则无法使用此功能,会自动退化为逐份确认。</code></p>
10499
+ * 组织机构超管证件号。 在注册流程中,必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardNumber保持一致。
10342
10500
  */
10343
- CanSkipReadFlow?: boolean;
10501
+ AdminIdCardNumber?: string;
10344
10502
  /**
10345
- * <p>链接的有效时间,单位为秒。取值范围为 30分钟(1800)-90天(7776000)。如果不传,默认有效期为30分钟。 </p><p>注意: </p><ol><li><code>出于安全性考虑,若有效期大于30分钟,同设备24小时内点击链接查看合同需要进行手机验证码校验。</code> </li><li><code>动态签署方链接暂不支持修改过期时间。</code></li></ol>
10503
+ * 要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**QR_CODE**: 跳转电子签小程序的http_url的二维码形式, 可以在页面展示适合此类型</li></ul>
10346
10504
  */
10347
- ExpiredOn?: number;
10505
+ Endpoint?: string;
10348
10506
  }
10349
10507
  /**
10350
- * DescribeExtendedServiceAuthInfos返回参数结构体
10508
+ * CreateDigitalDataSign请求参数结构体
10351
10509
  */
10352
- export interface DescribeExtendedServiceAuthInfosResponse {
10510
+ export interface CreateDigitalDataSignRequest {
10353
10511
  /**
10354
- * 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
10512
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10355
10513
  */
10356
- AuthInfoList?: Array<ExtendAuthInfo>;
10514
+ Operator: UserInfo;
10357
10515
  /**
10358
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10516
+ * 代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10359
10517
  */
10360
- RequestId?: string;
10518
+ Agent?: Agent;
10519
+ /**
10520
+ * 数据加签的原文
10521
+ */
10522
+ PlainText?: string;
10361
10523
  }
10362
10524
  /**
10363
- * 发起流程的可嵌入页面操作结果页配置
10525
+ * CreateBatchCancelFlowUrl请求参数结构体
10364
10526
  */
10365
- export interface CreateResultPageConfig {
10527
+ export interface CreateBatchCancelFlowUrlRequest {
10366
10528
  /**
10367
- * <ul>
10368
- <li>0 : 发起审批成功页面(通过接口<a href="https://qian.tencent.com/developers/companyApis/embedPages/CreatePrepareFlow/" target="_blank">创建发起流程web页面</a>发起时设置了NeedCreateReview参数为true)</li>
10369
- </ul>
10529
+ * 执行本接口操作的员工信息。
10530
+ <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
10370
10531
  */
10371
- Type: number;
10532
+ Operator: UserInfo;
10372
10533
  /**
10373
- * 结果页标题,不超过50字
10534
+ * 需要执行撤回的流程(合同)的编号列表,最多100个.
10535
+ 列表中的流程(合同)编号不要重复.
10374
10536
  */
10375
- Title: string;
10537
+ FlowIds: Array<string>;
10376
10538
  /**
10377
- * 结果页描述,不超过200字
10539
+ * 代理企业和员工的信息。
10540
+ <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10378
10541
  */
10379
- Description?: string;
10542
+ Agent?: Agent;
10380
10543
  }
10381
10544
  /**
10382
- * 此结构体 (Component) 用于描述控件属性。
10383
-
10384
- 在通过文件发起合同时,对应的component有三种定位方式
10385
- 1. 绝对定位方式 (可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标)
10386
- 2. 表单域(FIELD)定位方式
10387
- 3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找
10545
+ * CreateMultiFlowSignQRCode请求参数结构体
10388
10546
  */
10389
- export interface Component {
10547
+ export interface CreateMultiFlowSignQRCodeRequest {
10390
10548
  /**
10391
- * **如果是Component填写控件类型,则可选的字段为**:
10392
-
10393
- <ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>
10394
- <li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>
10395
- <li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>
10396
- <li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>
10397
- <li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>
10398
- <li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>
10399
- <li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>
10400
- <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
10401
- <li> <b>WATERMARK</b> : 水印控件;只能分配给发起方,必须设置ComponentExtra;</li>
10402
- <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li>
10403
- <li> <b>VIRTUAL_COMBINATION</b> : 虚拟控件,内部特定控件(CHECK_BOX),本身不填充任何文字内容</li></ul>
10404
-
10405
- **如果是SignComponent签署控件类型,
10406
- 需要根据签署人的类型可选的字段为**
10407
- * 企业方
10408
- <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
10409
- <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
10410
- <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
10411
- <li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
10412
- <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
10413
- <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
10414
- <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
10415
- <li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
10416
- <li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
10417
- <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
10418
-
10419
- * 个人方
10420
- <ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
10421
- <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
10422
- <li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;</li>
10423
- <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
10424
- <li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
10425
- <li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
10426
- <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li></ul>
10427
-
10428
- 注:` 表单域的控件不能作为印章和签名控件`
10549
+ * 执行本接口操作的员工信息。
10550
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10429
10551
  */
10430
- ComponentType: string;
10552
+ Operator: UserInfo;
10431
10553
  /**
10432
- * **在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
10433
-
10554
+ * 合同模板ID,为32位字符串。
10555
+ 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
10434
10556
  */
10435
- ComponentHeight: number;
10557
+ TemplateId: string;
10436
10558
  /**
10437
- * **在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
10438
-
10559
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
10560
+ 该名称还将用于合同签署完成后的下载文件名。
10439
10561
  */
10440
- ComponentWidth: number;
10562
+ FlowName: string;
10441
10563
  /**
10442
- * **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
10443
- **在使用文件发起的情况下**,绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码,使用负数时,页码从最后一页开始。例如:ComponentPage设置为-1,即代表在PDF文件的最后一页,以此类推。
10444
-
10445
- 注:
10446
- 1. 页码编号是从<font color="red">1</font>开始编号的。
10447
- 2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
10564
+ * 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
10565
+ 一旦发起流程数超越该限制,该二维码将自动失效。
10448
10566
  */
10449
- ComponentPage: number;
10567
+ MaxFlowNum?: number;
10450
10568
  /**
10451
- * **在绝对定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。
10569
+ * 二维码的有效期限,默认为7天,最高设定不得超过90天。
10570
+ 一旦超过二维码的有效期限,该二维码将自动失效。
10571
+ * @deprecated
10452
10572
  */
10453
- ComponentPosX: number;
10573
+ QrEffectiveDay?: number;
10454
10574
  /**
10455
- * **在绝对定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。
10575
+ * 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
10576
+ 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
10577
+ 最长设定期限不得超过30天。
10456
10578
  */
10457
- ComponentPosY: number;
10579
+ FlowEffectiveDay?: number;
10458
10580
  /**
10459
- * <font color="red">【暂未使用】</font>控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
10581
+ * 指定签署人信息。
10582
+ 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
10460
10583
  */
10461
- FileIndex: number;
10584
+ Restrictions?: Array<ApproverRestriction>;
10462
10585
  /**
10463
- * 控件生成的方式:
10464
- <ul><li> <b>NORMAL</b> : 绝对定位控件</li>
10465
- <li> <b>FIELD</b> : 表单域</li>
10466
- <li> <b>KEYWORD</b> : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)</li></ul>
10586
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
10587
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
10588
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
10467
10589
  */
10468
- GenerateMode?: string;
10590
+ UserData?: string;
10469
10591
  /**
10470
- * 控件唯一ID。
10471
-
10472
- **在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
10473
-
10474
- **在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
10475
-
10476
- 例:
10477
-
10478
- - 如传入的关键字<font color="red">"^甲方签署^"</font >,则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符</font >)进行对应操作。
10479
- - 如传入的关键字为<font color="red">"甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符</font >)都会执行相应操作。
10480
-
10481
-
10482
- 注:`控件ID可以在一个PDF中不可重复`
10483
-
10484
- <a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentId在模板编辑页面的位置</a>
10592
+ * 已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
10593
+ <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
10594
+ <br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
10485
10595
 
10596
+ * @deprecated
10486
10597
  */
10487
- ComponentId?: string;
10598
+ CallbackUrl?: string;
10488
10599
  /**
10489
- * **在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
10490
-
10491
- **在表单域定位方式下**,ComponentName不仅为控件名,也是表单域名称。
10492
-
10493
- 注:`控件名可以在一个PDF中可以重复`
10494
-
10495
- <a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentName在模板页面的位置</a>
10600
+ * 代理企业和员工的信息。
10601
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10496
10602
  */
10497
- ComponentName?: string;
10603
+ Agent?: Agent;
10498
10604
  /**
10499
- * 如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填
10500
- <ul><li>false(默认):可以不填写</li>
10501
- <li>true :必须填写此填写控件</li></ul>
10502
- 如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
10605
+ * 限制二维码用户条件(已弃用)
10606
+ * @deprecated
10503
10607
  */
10504
- ComponentRequired?: boolean;
10608
+ ApproverRestrictions?: ApproverRestriction;
10505
10609
  /**
10506
- * **在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**
10610
+ * 指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。
10507
10611
  */
10508
- ComponentRecipientId?: string;
10612
+ ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>;
10509
10613
  /**
10510
- * **在所有的定位方式下**,控件的扩展参数,为<font color="red">JSON格式</font>,不同类型的控件会有部分非通用参数。
10511
-
10512
- <font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:
10513
- <ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>
10514
- <li> <b>FontSize</b>: 范围6 :72</li>
10515
- <li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>
10516
- <li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li>
10517
- <li> <b>Bold</b>是否加粗:true/false</li>
10518
- </ul>
10519
- <b>参数样例</b>:`{"FontColor":"255,0,0","FontSize":12,"Bold":false}`
10520
-
10521
- <font color="red">ComponentType为DATE时</font>,支持以下参数:
10522
- <ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>
10523
- <li> <b>FontSize</b>: 范围6 :72</li></ul>
10524
- <b>参数样例</b>:`{"FontColor":"255,0,0","FontSize":12}`
10525
-
10526
- <font color="red">ComponentType为WATERMARK时</font>,支持以下参数:
10527
- <ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>
10528
- <li> <b>FontSize</b>: 范围6 :72</li>
10529
- <li> <b>Opacity</b>: 透明度,范围0 :1</li>
10530
- <li> <b>Rotate</b>: 水印旋转角度,范围0 :359</li>
10531
- <li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>
10532
- <li> <b>Position</b>: 水印位置,None-平铺(默认值),LeftTop-左上,LeftBottom-左下,RightTop-右上,RightBottom-右下,Center-居中</li>
10533
- <li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul>
10534
- <b>参数样例</b>:`"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"`
10535
-
10536
- <font color="red">ComponentType为FILL_IMAGE时</font>,支持以下参数:
10537
- <ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
10538
- <li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
10539
-
10540
- <font color="red">ComponentType为SELECTOR时</font>,支持以下参数:
10541
- <ul><li> <b>WordWrap</b>:bool。是否支持选择控件内容自动折行合成。false:不支持(默认)。 true : 支持自动折行合成</li>
10542
- </ul>
10543
-
10544
- <font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以通过**ComponentTypeLimit**参数控制签名方式
10545
- <ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>
10546
- <li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
10547
- <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
10548
- <li> <b>ESIGN</b> : 个人印章类型</li>
10549
- <li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>
10550
- <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
10551
- <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
10552
- 印章的对应关系参考下图
10553
- ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>
10554
-
10555
- <font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型
10556
- <ul><li> <b>OFFICIAL</b> : 企业公章</li>
10557
- <li> <b>CONTRACT</b> : 合同专用章</li>
10558
- <li> <b>FINANCE</b> : 财务专用章</li>
10559
- <li> <b>PERSONNEL</b> : 人事专用章</li>
10560
- <li> <b>OTHER</b> : 其他</li>
10561
- </ul>
10562
- <b>参考样例</b>:`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
10563
-
10564
- <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
10565
- <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、"仿宋",如果不填默认为"黑体"</li>
10566
- <li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>
10567
- <li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>
10568
- <li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>
10569
- <li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
10570
- 如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
10571
- 特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
10572
- <b>参数样例</b>: ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
10573
-
10574
- <font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:
10575
- <ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>
10576
- <b>参数样例</b>:` "{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"`
10577
-
10578
- <font color="red">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:
10579
- <ul><li> <b>Opacity</b>:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>
10580
- <b>参数样例</b>:`{"Opacity":0.7}`
10581
-
10582
- <font color="red">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:
10583
- <ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>
10584
- <b>参数样例</b>:`{"UseSealSize":true}`
10585
-
10586
- <font color="red">签署意见功能设置,</font>当ComponentType为SIGN_OPINION时,可以通过以下参数设置签署意见的相关内容:
10587
- <ul><li> <b>Values</b>:签署意见预设的需要用户填写的文本</li>
10588
- <li> <b>ValuesArray</b>:签署意见需要用户按顺序点击的分词(组合后应和Values内容一致)</li></ul>
10589
- <b>参数样例</b>:`{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}`
10590
-
10591
- <font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
10592
- <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
10593
- 场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
10594
- <b>参数样例</b>:` "{"IgnoreKeywordError":1}"`
10595
-
10596
- <font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>,支持以下参数:
10597
- <ul>
10598
- <li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>
10599
- <b>参数样例</b>:<br>`{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}`
10600
- <li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>
10601
- ChildrenComponent结构体定义:
10602
- <table border="1"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语<tr> <td>ComponentValue</td> <td>string</td> <td>子控件值(签署方不可设置)</td> </tr> </td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>
10603
- <b>参数样例</b>:
10604
-
10605
- 输入:
10606
- <pre>
10607
- {
10608
- ChildrenComponents: [
10609
- {
10610
- ComponentType: SIGN_SIGNATURE,
10611
- ComponentName: 个人签名,
10612
- Placeholder: 请签名,
10613
- ComponentOffsetX: 10,
10614
- ComponentOffsetY: 30,
10615
- ComponentWidth: 119,
10616
- ComponentHeight: 43,
10617
- ComponentExtra: {\ComponentTypeLimit\:[\SYSTEM_ESIGN\]}
10618
- },
10619
- {
10620
- ComponentType: SIGN_SELECTOR,
10621
- ComponentName: 是否同意此协议,
10622
- Placeholder: ,
10623
- ComponentOffsetX: 50,
10624
- ComponentOffsetY: 130,
10625
- ComponentWidth: 120,
10626
- ComponentHeight: 43,
10627
- ComponentExtra: {\Values\:[\同意\,\不同意\,\再想想\],\FontSize\:12,\FontAlign\:\Left\,\Font\:\黑体\,\MultiSelect\:false}
10628
- },
10629
- {
10630
- ComponentType: SIGN_MULTI_LINE_TEXT,
10631
- ComponentName: 批注附言,
10632
- Placeholder: ,
10633
- ComponentOffsetX: 150,
10634
- ComponentOffsetY: 300,
10635
- ComponentWidth: 200,
10636
- ComponentHeight: 86,
10637
- ComponentExtra:
10638
- }
10639
- ]
10640
- }
10641
- </pre>
10614
+ * 禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。
10615
+ */
10616
+ ForbidPersonalMultipleSign?: boolean;
10617
+ /**
10618
+ * 合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。
10619
+ 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
10620
+ */
10621
+ FlowNameAppendScannerInfo?: boolean;
10622
+ /**
10623
+ * 签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName
10624
+ */
10625
+ QrCodeName?: string;
10626
+ /**
10627
+ * 签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。
10628
+ */
10629
+ QrCodeExpiredOn?: number;
10630
+ }
10631
+ /**
10632
+ * DeleteExtendedServiceAuthInfos请求参数结构体
10633
+ */
10634
+ export interface DeleteExtendedServiceAuthInfosRequest {
10635
+ /**
10636
+ * 执行本接口操作的员工信息。
10637
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10638
+ */
10639
+ Operator: UserInfo;
10640
+ /**
10641
+ * 本企业员工的id,需要已实名,正常在职员工
10642
+ */
10643
+ UserIds: Array<string>;
10644
+ /**
10645
+ * 取值如下所示:
10646
+ <ul><li>OPEN_SERVER_SIGN:企业自动签</li>
10647
+ <li>BATCH_SIGN:批量签署</li>
10642
10648
  </ul>
10643
-
10644
10649
  */
10645
- ComponentExtra?: string;
10650
+ ExtendServiceType?: string;
10646
10651
  /**
10647
- * **在通过接口拉取控件信息场景下**,为出参参数,此控件是否通过表单域定位方式生成,默认false-不是,**发起合同时候不要填写此字段留空即可**
10652
+ * 代理企业和员工的信息。
10653
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10648
10654
  */
10649
- IsFormType?: boolean;
10655
+ Agent?: Agent;
10656
+ }
10657
+ /**
10658
+ * DescribeFlowInfo返回参数结构体
10659
+ */
10660
+ export interface DescribeFlowInfoResponse {
10650
10661
  /**
10651
- * 控件填充vaule,ComponentType和传入值类型对应关系:
10652
- <ul><li> <b>TEXT</b> : 文本内容</li>
10653
- <li> <b>MULTI_LINE_TEXT</b> : 文本内容,可以用 \n 来控制换行位置 </li>
10654
- <li> <b>CHECK_BOX</b> : true/false</li>
10655
- <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
10656
- <li> <b>SELECTOR</b> : 选项值</li>
10657
- <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
10658
- <li> <b>DATE</b> : 格式化为:xxxx年xx月xx日(例如2024年05年28日)</li>
10659
- <li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li>
10660
- <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li></ul>
10661
-
10662
-
10663
- <b>控件值约束说明</b>:
10664
- <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>
10665
- 注: `部分特殊控件需要在控制台配置模板形式创建`
10662
+ * <p>合同流程的详细信息。<br>如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。</p>
10666
10663
  */
10667
- ComponentValue?: string;
10664
+ FlowDetailInfos?: Array<FlowDetailInfo>;
10668
10665
  /**
10669
- * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
10670
- 注意: `向左调整设置为负数, 向右调整设置成正数`
10666
+ * <p>合同组ID,只有在查询合同组信息时才会返回。</p>
10671
10667
  */
10672
- OffsetX?: number;
10668
+ FlowGroupId?: string;
10673
10669
  /**
10674
- * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
10675
- 注意: `向上调整设置为负数, 向下调整设置成正数`
10670
+ * <p>合同组名称,只有在查询合同组信息时才会返回。</p>
10676
10671
  */
10677
- OffsetY?: number;
10672
+ FlowGroupName?: string;
10678
10673
  /**
10679
- * **如果控件是关键字定位方式**,指定关键字排序规则时,可以选择Positive或Reverse两种排序方式。
10680
- <ul><li> <b>Positive</b> :表示正序,即根据关键字在PDF文件内的顺序进行排列</li>
10681
- <li> <b>Reverse</b> :表示倒序,即根据关键字在PDF文件内的反序进行排列</li></ul>
10682
-
10683
- 在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。
10674
+ * <p>合同组合同备注列表</p>
10684
10675
  */
10685
- KeywordOrder?: string;
10676
+ FlowGroupRemarks?: Array<string>;
10686
10677
  /**
10687
- * **如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
10678
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10688
10679
  */
10689
- KeywordPage?: number;
10680
+ RequestId?: string;
10681
+ }
10682
+ /**
10683
+ * DescribeUserAutoSignStatus请求参数结构体
10684
+ */
10685
+ export interface DescribeUserAutoSignStatusRequest {
10690
10686
  /**
10691
- * **如果控件是关键字定位方式**,关键字生成的区域的对齐方式, 可以设置下面的值
10692
- <ul><li> <b>Middle</b> :居中</li>
10693
- <li> <b>Below</b> :正下方</li>
10694
- <li> <b>Right</b> :正右方</li>
10695
- <li> <b>LowerRight</b> :右下角</li>
10696
- <li> <b>UpperRight</b> :右上角。</li></ul>
10697
- 示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
10687
+ * 执行本接口操作的员工信息。
10688
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10698
10689
  */
10699
- RelativeLocation?: string;
10690
+ Operator: UserInfo;
10700
10691
  /**
10701
- * **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
10702
-
10703
- 注意:关键字索引是从0开始计数的
10692
+ * 自动签使用的场景值, 可以选择的场景值如下:
10693
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
10704
10694
  */
10705
- KeywordIndexes?: Array<number | bigint>;
10695
+ SceneKey: string;
10706
10696
  /**
10707
- * **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
10708
- <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
10709
- <li>true:锁定控件值,在页面无法编辑控件值</li></ul>
10697
+ * 要查询状态的用户信息, 包括名字,身份证等
10710
10698
  */
10711
- LockComponentValue?: boolean;
10699
+ UserInfo: UserThreeFactor;
10712
10700
  /**
10713
- * **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
10714
- <ul><li> <b>false(默认)</b> :可以移动和删除控件</li>
10715
- <li> <b>true</b> : 禁止移动和删除控件</li></ul>
10701
+ * 代理企业和员工的信息。
10702
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10716
10703
  */
10717
- ForbidMoveAndDelete?: boolean;
10704
+ Agent?: Agent;
10705
+ }
10706
+ /**
10707
+ * CreateFlowBlockchainEvidenceUrl请求参数结构体
10708
+ */
10709
+ export interface CreateFlowBlockchainEvidenceUrlRequest {
10718
10710
  /**
10719
- * <font color="red">【暂未使用】</font>日期签署控件的字号,默认为 12
10711
+ * 执行本接口操作的员工信息。
10712
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10720
10713
  */
10721
- ComponentDateFontSize?: number;
10714
+ Operator: UserInfo;
10722
10715
  /**
10723
- * <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
10716
+ * 合同流程ID,为32位字符串。
10717
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
10718
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
10724
10719
  */
10725
- ChannelComponentId?: string;
10720
+ FlowId: string;
10726
10721
  /**
10727
- * <font color="red">【暂未使用】</font>第三方应用集成中子客企业控件来源。
10728
- <ul><li> <b>0</b> :平台指定;</li>
10729
- <li> <b>1</b> :用户自定义</li></ul>
10722
+ * 代理企业和员工的信息。
10723
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10730
10724
  */
10731
- ChannelComponentSource?: number;
10725
+ Agent?: Agent;
10726
+ /**
10727
+ * 链接/二维码的有效截止时间,格式为unix时间戳。最长不超过 2099年12月31日(4102415999)。
10728
+ 默认值为有效期为当前时间后7天。
10729
+ */
10730
+ ExpiredOn?: number;
10731
+ }
10732
+ /**
10733
+ * CreateBatchQuickSignUrl请求参数结构体
10734
+ */
10735
+ export interface CreateBatchQuickSignUrlRequest {
10736
+ /**
10737
+ * <p>批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。</p><ul><li>若为个人参与方:ApproverType=1</li><li>若为企业参与方:ApproverType=0。同时 OrganizationName 参数需传入参与方企业名称。 </li></ul>注:<code>1. 暂不支持签署人拖动签署控件功能,以及签批控件。</code><code>2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。</code>
10738
+ */
10739
+ FlowApproverInfo: FlowCreateApprover;
10740
+ /**
10741
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
10742
+ */
10743
+ Agent?: Agent;
10744
+ /**
10745
+ * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10746
+ */
10747
+ Operator?: UserInfo;
10748
+ /**
10749
+ * <p>批量签署的合同流程ID数组。<br>注: <code>在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。</code></p>
10750
+ */
10751
+ FlowIds?: Array<string>;
10752
+ /**
10753
+ * <p>合同组编号<br>注:<code>该参数和合同流程ID数组必须二选一</code></p>
10754
+ */
10755
+ FlowGroupId?: string;
10756
+ /**
10757
+ * <p>签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)</p>
10758
+ */
10759
+ JumpUrl?: string;
10760
+ /**
10761
+ * <p>指定批量签署合同的签名类型,可传递以下值:</p><ul><li>**0**:手写签名(默认)</li><li>**1**:OCR楷体</li><li>**2**:姓名印章</li><li>**3**:图片印章</li><li>**4**:系统签名</li><li>**5**:长效手写签名(包含手写签名)</li></ul>注:<ul><li>默认情况下,签名类型为手写签名</li><li>您可以传递多种值,表示可用多种签名类型。</li><li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li><li>若签署方为个人,签名类型“5:长效手写签名”不可用,签名方式将以合同中为准。</li></ul>
10762
+ */
10763
+ SignatureTypes?: Array<number | bigint>;
10764
+ /**
10765
+ * <p>指定批量签署合同的认证校验方式,可传递以下值:</p><ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li><li>**2**:密码认证(默认),需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署</li><li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>注:<ul><li>默认情况下,认证校验方式为人脸和密码认证</li><li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
10766
+ */
10767
+ ApproverSignTypes?: Array<number | bigint>;
10768
+ /**
10769
+ * <p>生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:</p><ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li><li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>注:<code>不指定该值时,默认为签署方自行选择。</code>
10770
+ */
10771
+ SignTypeSelector?: number;
10772
+ /**
10773
+ * <p>批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。 </p><p>注: <code>若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充</code></p>
10774
+ */
10775
+ FlowBatchUrlInfo?: FlowBatchUrlInfo;
10776
+ /**
10777
+ * <p><b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。 </p><p> 注意: </p><ol><li>视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。</li><li>使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。 </li><li>签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。</li></ol>
10778
+ */
10779
+ Intention?: Intention;
10780
+ /**
10781
+ * <p>用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。</p>
10782
+ */
10783
+ VideoVerifyTimesLimit?: number;
10784
+ /**
10785
+ * <p>缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。</p><p>注: <code>若参与方为企业员工时,暂不支持对参与方信息进行缓存</code></p>
10786
+ */
10787
+ CacheApproverInfo?: boolean;
10788
+ /**
10789
+ * <p>是否允许此链接中签署方批量拒签。<br> <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul></p><p>注:<code>当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。</code></p>
10790
+ */
10791
+ CanBatchReject?: boolean;
10792
+ /**
10793
+ * <p>预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。</p>
10794
+ */
10795
+ PresetApproverInfo?: PresetApproverInfo;
10796
+ /**
10797
+ * <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 若批量签署的合同中第一份待签署合同所选择的印章或者签名无法完全覆盖后续合同要求,或者当前签署人没有指定印章使用权限,则无法使用此功能,会自动退化为逐份确认。</code></p>
10798
+ */
10799
+ CanSkipReadFlow?: boolean;
10800
+ /**
10801
+ * <p>链接的有效时间,单位为秒。取值范围为 30分钟(1800)-90天(7776000)。如果不传,默认有效期为30分钟。 </p><p>注意: </p><ol><li><code>出于安全性考虑,若有效期大于30分钟,同设备24小时内点击链接查看合同需要进行手机验证码校验。</code> </li><li><code>动态签署方链接暂不支持修改过期时间。</code></li></ol>
10802
+ */
10803
+ ExpiredOn?: number;
10804
+ }
10805
+ /**
10806
+ * DescribeExtendedServiceAuthInfos返回参数结构体
10807
+ */
10808
+ export interface DescribeExtendedServiceAuthInfosResponse {
10809
+ /**
10810
+ * 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
10811
+ */
10812
+ AuthInfoList?: Array<ExtendAuthInfo>;
10813
+ /**
10814
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10815
+ */
10816
+ RequestId?: string;
10817
+ }
10818
+ /**
10819
+ * 发起流程的可嵌入页面操作结果页配置
10820
+ */
10821
+ export interface CreateResultPageConfig {
10822
+ /**
10823
+ * <ul>
10824
+ <li>0 : 发起审批成功页面(通过接口<a href="https://qian.tencent.com/developers/companyApis/embedPages/CreatePrepareFlow/" target="_blank">创建发起流程web页面</a>发起时设置了NeedCreateReview参数为true)</li>
10825
+ </ul>
10826
+ */
10827
+ Type: number;
10828
+ /**
10829
+ * 结果页标题,不超过50字
10830
+ */
10831
+ Title: string;
10832
+ /**
10833
+ * 结果页描述,不超过200字
10834
+ */
10835
+ Description?: string;
10836
+ }
10837
+ /**
10838
+ * 意愿核身点头确认模式结果
10839
+ */
10840
+ export interface IntentionActionResult {
10841
+ /**
10842
+ * 意愿核身结果详细数据,与每段点头确认过程一一对应
10843
+ */
10844
+ Details?: Array<IntentionActionResultDetail>;
10732
10845
  }
10733
10846
  /**
10734
10847
  * 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
@@ -12193,6 +12306,35 @@ export interface CreatePreparedPersonalEsignRequest {
12193
12306
  */
12194
12307
  SceneKey?: string;
12195
12308
  }
12309
+ /**
12310
+ * ImportContractReviewChecklist请求参数结构体
12311
+ */
12312
+ export interface ImportContractReviewChecklistRequest {
12313
+ /**
12314
+ * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
12315
+ */
12316
+ Operator: UserInfo;
12317
+ /**
12318
+ * <p>导入的合同审查清单名称</p>
12319
+ */
12320
+ Name: string;
12321
+ /**
12322
+ * <p>导入的合同审查清单审查点列表</p>
12323
+ */
12324
+ Categories: Array<ChecklistCategory>;
12325
+ /**
12326
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
12327
+ */
12328
+ Agent?: Agent;
12329
+ /**
12330
+ * <p>如果传值,则更新对应的合同审查清单,否则创建新的合同审查清单</p>
12331
+ */
12332
+ ChecklistID?: string;
12333
+ /**
12334
+ * <p>设置为true则启动清单,否则禁用清单</p>
12335
+ */
12336
+ Enabled?: boolean;
12337
+ }
12196
12338
  /**
12197
12339
  * CreateMiniAppPrepareFlow请求参数结构体
12198
12340
  */