tencentcloud-sdk-nodejs-ess 4.1.211 → 4.1.215
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.
package/package.json
CHANGED
|
@@ -822,7 +822,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
822
822
|
* 该接口用于发起合同后,生成用户的签署链接 <br/>
|
|
823
823
|
|
|
824
824
|
**注意**
|
|
825
|
-
1.
|
|
825
|
+
1. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接。
|
|
826
826
|
2. 该接口返回的签署链接适用于APP集成的场景,支持APP、支付宝打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
|
|
827
827
|
如需跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
828
828
|
3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
@@ -1328,7 +1328,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
1328
1328
|
* 该接口用于发起合同后,生成个人/企业用户的批量待办链接。
|
|
1329
1329
|
**注意:**
|
|
1330
1330
|
1. 该接口可生成签署人的批量、合同组签署/查看链接 。
|
|
1331
|
-
2.
|
|
1331
|
+
2. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
|
|
1332
1332
|
3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
1333
1333
|
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
1334
1334
|
4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
@@ -980,7 +980,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
980
980
|
* 该接口用于发起合同后,生成用户的签署链接 <br/>
|
|
981
981
|
|
|
982
982
|
**注意**
|
|
983
|
-
1.
|
|
983
|
+
1. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接。
|
|
984
984
|
2. 该接口返回的签署链接适用于APP集成的场景,支持APP、支付宝打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
|
|
985
985
|
如需跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
986
986
|
3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
@@ -1576,7 +1576,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
1576
1576
|
* 该接口用于发起合同后,生成个人/企业用户的批量待办链接。
|
|
1577
1577
|
**注意:**
|
|
1578
1578
|
1. 该接口可生成签署人的批量、合同组签署/查看链接 。
|
|
1579
|
-
2.
|
|
1579
|
+
2. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
|
|
1580
1580
|
3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
1581
1581
|
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
1582
1582
|
4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
@@ -1147,32 +1147,23 @@ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
|
|
|
1147
1147
|
*/
|
|
1148
1148
|
export interface CreateBatchInformationExtractionTaskRequest {
|
|
1149
1149
|
/**
|
|
1150
|
-
*
|
|
1151
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
1150
|
+
* <p>执行合同智能提取的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
1152
1151
|
*/
|
|
1153
1152
|
Operator: UserInfo;
|
|
1154
1153
|
/**
|
|
1155
|
-
*
|
|
1156
|
-
|
|
1157
|
-
注: `目前,此接口仅支持5个文件发起。每个文件限制在10M以下`
|
|
1154
|
+
* <p>合同智能提取的文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获取PDF、WORD、PNG、JPEG文件资源编号。</p><p>注意:</p><ul><li>此接口仅支持5个文件发起</li><li>PDF、WORD文件限制在10M以内</li><li>PNG、JPEG文件限制在5M以内</li></ul>
|
|
1158
1155
|
*/
|
|
1159
1156
|
ResourceIds: Array<string>;
|
|
1160
1157
|
/**
|
|
1161
|
-
*
|
|
1162
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
1158
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
1163
1159
|
*/
|
|
1164
1160
|
Agent?: Agent;
|
|
1165
1161
|
/**
|
|
1166
|
-
*
|
|
1167
|
-
[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/99008608577532423ea437c7fdbedca1.png)
|
|
1168
|
-
|
|
1169
|
-
注: `此配置优先级最高,设置了模板ID后Fields配置就会无效`
|
|
1162
|
+
* <p>用户配置的合同智能提取字段模板ID,会基于此模板批量创建合同智能提取任务,为32位字符串。<br><a href="https://qcloudimg.tencent-cloud.cn/raw/99008608577532423ea437c7fdbedca1.png">点击查看模板Id在控制台上的位置</a></p><p>注: <code>此配置优先级最高,设置了模板ID后Fields配置就会无效</code></p>
|
|
1170
1163
|
*/
|
|
1171
1164
|
FieldTemplateId?: string;
|
|
1172
1165
|
/**
|
|
1173
|
-
*
|
|
1174
|
-
|
|
1175
|
-
注意:`字段模板优先级最高,如果设置了FieldTemplateId值,此配置就无效`
|
|
1166
|
+
* <p>用于合同智能提取的字段信息。</p><p>注意:<code>字段模板优先级最高,如果设置了FieldTemplateId值,此配置就无效</code></p>
|
|
1176
1167
|
*/
|
|
1177
1168
|
Fields?: Array<ExtractionField>;
|
|
1178
1169
|
}
|
|
@@ -3886,7 +3877,7 @@ export interface OperateTemplateRequest {
|
|
|
3886
3877
|
*/
|
|
3887
3878
|
export interface CreateBatchQuickSignUrlResponse {
|
|
3888
3879
|
/**
|
|
3889
|
-
*
|
|
3880
|
+
* <p>签署人签署链接信息</p>
|
|
3890
3881
|
*/
|
|
3891
3882
|
FlowApproverUrlInfo?: FlowApproverUrlInfo;
|
|
3892
3883
|
/**
|
|
@@ -3899,260 +3890,130 @@ export interface CreateBatchQuickSignUrlResponse {
|
|
|
3899
3890
|
*/
|
|
3900
3891
|
export interface FlowCreateApprover {
|
|
3901
3892
|
/**
|
|
3902
|
-
*
|
|
3903
|
-
|
|
3904
|
-
<ul><li> <b>0</b> :企业B端。</li>
|
|
3905
|
-
<li> <b>1</b> :个人C端。</li>
|
|
3906
|
-
<li> <b>3</b> :企业B端静默(自动)签署,无需签署人参与,自动签署可以参考<a href="https://qian.tencent.com/developers/company/autosign_guide" target="_blank" rel="noopener noreferrer">自动签署使用说明</a>文档。</li>
|
|
3907
|
-
<li> <b>7</b> :个人C端自动签署,适用于个人自动签场景。注: <b>个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。</b> </li></ul>
|
|
3893
|
+
* <p>在指定签署方时,可以选择企业B端或个人C端等不同的参与者类型,可选类型如下:</p><ul><li> <b>0</b> :企业B端。</li><li> <b>1</b> :个人C端。</li><li> <b>3</b> :企业B端静默(自动)签署,无需签署人参与,自动签署可以参考<a href="https://qian.tencent.com/developers/company/autosign_guide" target="_blank" rel="noopener noreferrer">自动签署使用说明</a>文档。</li><li> <b>7</b> :个人C端自动签署,适用于个人自动签场景。注: <b>个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。</b> </li></ul>
|
|
3908
3894
|
*/
|
|
3909
3895
|
ApproverType: number;
|
|
3910
3896
|
/**
|
|
3911
|
-
*
|
|
3912
|
-
请确认该名称与企业营业执照中注册的名称一致。
|
|
3913
|
-
如果名称中包含英文括号(),请使用中文括号()代替。
|
|
3914
|
-
|
|
3915
|
-
注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时,必须指定`
|
|
3916
|
-
|
|
3917
|
-
|
|
3897
|
+
* <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。</p><p>注: <code>当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时,必须指定</code></p>
|
|
3918
3898
|
*/
|
|
3919
3899
|
OrganizationName?: string;
|
|
3920
3900
|
/**
|
|
3921
|
-
*
|
|
3922
|
-
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
3923
|
-
|
|
3924
|
-
在未指定签署人电子签UserId情况下,为必填参数
|
|
3901
|
+
* <p>签署方经办人的姓名。<br>经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p><p>在未指定签署人电子签UserId情况下,为必填参数</p>
|
|
3925
3902
|
*/
|
|
3926
3903
|
ApproverName?: string;
|
|
3927
3904
|
/**
|
|
3928
|
-
*
|
|
3929
|
-
|
|
3930
|
-
注:`在未指定签署人电子签UserId情况下,为必填参数`
|
|
3931
|
-
|
|
3905
|
+
* <p>签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。</p><p>注:<code>在未指定签署人电子签UserId情况下,为必填参数</code></p>
|
|
3932
3906
|
*/
|
|
3933
3907
|
ApproverMobile?: string;
|
|
3934
3908
|
/**
|
|
3935
|
-
*
|
|
3936
|
-
<ul><li><b>ID_CARD</b>: 居民身份证 (默认值)</li>
|
|
3937
|
-
<li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>
|
|
3938
|
-
<li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
3909
|
+
* <p>证件类型,支持以下类型</p><ul><li><b>ID_CARD</b>: 居民身份证 (默认值)</li><li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li><li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
3939
3910
|
*/
|
|
3940
3911
|
ApproverIdCardType?: string;
|
|
3941
3912
|
/**
|
|
3942
|
-
*
|
|
3943
|
-
<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
3944
|
-
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
|
|
3945
|
-
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
3913
|
+
* <p>证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
3946
3914
|
*/
|
|
3947
3915
|
ApproverIdCardNumber?: string;
|
|
3948
3916
|
/**
|
|
3949
|
-
*
|
|
3950
|
-
|
|
3951
|
-
<b>模板发起合同时,该参数为必填项,可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>
|
|
3952
|
-
<b>文件发起合同时,该参数无需传值。</b>
|
|
3953
|
-
|
|
3954
|
-
如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
|
|
3917
|
+
* <p>签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。</p><p><b>模板发起合同时,该参数为必填项,可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates">查询模板信息接口</a>获得。</b><br><b>文件发起合同时,该参数无需传值。</b></p><p>如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。</p>
|
|
3955
3918
|
*/
|
|
3956
3919
|
RecipientId?: string;
|
|
3957
3920
|
/**
|
|
3958
|
-
*
|
|
3959
|
-
|
|
3960
|
-
注: <font color="red">不再使用</font >, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`
|
|
3921
|
+
* <p>签署意愿确认渠道,默认为WEIXINAPP:人脸识别</p><p>注: <font color="red">不再使用, <code>用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置</code></p>
|
|
3961
3922
|
*/
|
|
3962
3923
|
VerifyChannel?: Array<string>;
|
|
3963
3924
|
/**
|
|
3964
|
-
*
|
|
3965
|
-
<ul><li> **sms** : (默认)短信</li>
|
|
3966
|
-
<li> **none** : 不通知</li></ul>
|
|
3967
|
-
|
|
3968
|
-
注: `既是发起方又是签署方时,不给此签署方发送短信`
|
|
3925
|
+
* <p>通知签署方经办人的方式, 有以下途径:</p><ul><li> **sms** : (默认)短信</li><li> **email** : 邮件</li><li> **all** : 邮件+短信</li><li> **none** : 不通知</li></ul><p>注: <code>既是发起方又是签署方时,不给此签署方发送短信</code></p><p>枚举值:</p><ul><li>sms: 短信通知</li><li>email: 邮件通知</li><li>all: 邮件通知+短信通知</li><li>none: 不做任何形式的通知</li></ul>
|
|
3969
3926
|
*/
|
|
3970
3927
|
NotifyType?: string;
|
|
3971
3928
|
/**
|
|
3972
|
-
*
|
|
3929
|
+
* <p>合同强制需要阅读全文,无需传此参数</p>
|
|
3973
3930
|
*/
|
|
3974
3931
|
IsFullText?: boolean;
|
|
3975
3932
|
/**
|
|
3976
|
-
*
|
|
3977
|
-
|
|
3978
|
-
若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
|
|
3979
|
-
<ul>
|
|
3980
|
-
<li>合同页数少于等于2页,阅读时间为3秒;</li>
|
|
3981
|
-
<li>合同页数为3到5页,阅读时间为5秒;</li>
|
|
3982
|
-
<li>合同页数大于等于6页,阅读时间为10秒。</li>
|
|
3983
|
-
</ul>
|
|
3933
|
+
* <p>签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。</p><p>若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:</p><ul><li>合同页数少于等于2页,阅读时间为3秒;</li><li>合同页数为3到5页,阅读时间为5秒;</li><li>合同页数大于等于6页,阅读时间为10秒。</li></ul>
|
|
3984
3934
|
*/
|
|
3985
3935
|
PreReadTime?: number;
|
|
3986
3936
|
/**
|
|
3987
|
-
*
|
|
3988
|
-
|
|
3989
|
-
注:
|
|
3990
|
-
如果传进来的<font color="red">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)
|
|
3937
|
+
* <p>签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得</p><p>注:<br>如果传进来的<font color="red">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)</p>
|
|
3991
3938
|
*/
|
|
3992
3939
|
UserId?: string;
|
|
3993
3940
|
/**
|
|
3994
|
-
* <font color="red">字段不再使用</font>,当前只支持true,默认为true
|
|
3941
|
+
* <p><font color="red">字段不再使用</font>,当前只支持true,默认为true</p>
|
|
3995
3942
|
*/
|
|
3996
3943
|
Required?: boolean;
|
|
3997
3944
|
/**
|
|
3998
|
-
*
|
|
3945
|
+
* <p>在企微场景下使用,需设置参数为<strong>WEWORKAPP</strong>,以表明合同来源于企微。</p>
|
|
3999
3946
|
*/
|
|
4000
3947
|
ApproverSource?: string;
|
|
4001
3948
|
/**
|
|
4002
|
-
*
|
|
4003
|
-
所有参与或签的人员均需具备该标识。
|
|
4004
|
-
注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
|
|
4005
|
-
如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
|
|
3949
|
+
* <p>在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。<br>所有参与或签的人员均需具备该标识。<br>注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。<br>如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。</p>
|
|
4006
3950
|
*/
|
|
4007
3951
|
CustomApproverTag?: string;
|
|
4008
3952
|
/**
|
|
4009
|
-
*
|
|
3953
|
+
* <p>快速注册相关信息</p>
|
|
4010
3954
|
*/
|
|
4011
3955
|
RegisterInfo?: RegisterInfo;
|
|
4012
3956
|
/**
|
|
4013
|
-
*
|
|
3957
|
+
* <p>签署人个性化能力值,如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。</p>
|
|
4014
3958
|
*/
|
|
4015
3959
|
ApproverOption?: ApproverOption;
|
|
4016
3960
|
/**
|
|
4017
|
-
*
|
|
3961
|
+
* <p>签署完前端跳转的url,暂未使用</p>
|
|
4018
3962
|
* @deprecated
|
|
4019
3963
|
*/
|
|
4020
3964
|
JumpUrl?: string;
|
|
4021
3965
|
/**
|
|
4022
|
-
*
|
|
4023
|
-
|
|
4024
|
-
<ul>
|
|
4025
|
-
<li>在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数,电子签后台系统会自动生成。</li>
|
|
4026
|
-
<li>在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时,可以通过查询详情接口获取签署人的SignId,然后可以将此值传入,为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。</li>
|
|
4027
|
-
</ul>
|
|
3966
|
+
* <p>签署人的签署ID</p><ul><li>在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数,电子签后台系统会自动生成。</li><li>在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时,可以通过查询详情接口获取签署人的SignId,然后可以将此值传入,为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。</li></ul>
|
|
4028
3967
|
*/
|
|
4029
3968
|
SignId?: string;
|
|
4030
3969
|
/**
|
|
4031
|
-
*
|
|
4032
|
-
<ul><li>**false**:(默认)不需要审批,直接签署。</li>
|
|
4033
|
-
<li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
4034
|
-
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
4035
|
-
<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
4036
|
-
<li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
4037
|
-
|
|
4038
|
-
注:`此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
4039
|
-
|
|
4040
|
-

|
|
3970
|
+
* <p>此签署人(员工或者个人)签署时,是否需要发起方企业审批,取值如下:</p><ul><li>**false**:(默认)不需要审批,直接签署。</li><li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul><p>注:<code>此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png" alt="image"></p>
|
|
4041
3971
|
*/
|
|
4042
3972
|
ApproverNeedSignReview?: boolean;
|
|
4043
3973
|
/**
|
|
4044
|
-
*
|
|
4045
|
-
|
|
4046
|
-
合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
|
|
4047
|
-
<ul><li> 个人签名/印章</li>
|
|
4048
|
-
<li> 企业印章</li>
|
|
4049
|
-
<li> 骑缝章等签署控件</li></ul>
|
|
4050
|
-
|
|
4051
|
-
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
3974
|
+
* <p>签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效</p><p>合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li> 个人签名/印章</li><li> 企业印章</li><li> 骑缝章等签署控件</li></ul><p><code>此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主</code></p>
|
|
4052
3975
|
*/
|
|
4053
3976
|
SignComponents?: Array<Component>;
|
|
4054
3977
|
/**
|
|
4055
|
-
*
|
|
4056
|
-
|
|
4057
|
-
合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
|
4058
|
-
<ul><li>单行文本控件</li>
|
|
4059
|
-
<li>多行文本控件</li>
|
|
4060
|
-
<li>勾选框控件</li>
|
|
4061
|
-
<li>数字控件</li>
|
|
4062
|
-
<li>图片控件</li>
|
|
4063
|
-
<li>动态表格等填写控件</li></ul>
|
|
4064
|
-
|
|
4065
|
-
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
3978
|
+
* <p>签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效</p><p>合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li>单行文本控件</li><li>多行文本控件</li><li>勾选框控件</li><li>数字控件</li><li>图片控件</li><li>动态表格等填写控件</li></ul><p><code>此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主</code></p>
|
|
4066
3979
|
*/
|
|
4067
3980
|
Components?: Array<Component>;
|
|
4068
3981
|
/**
|
|
4069
|
-
*
|
|
4070
|
-
|
|
4071
|
-
<ul><li> <b>HANDWRITE</b> :需要实时手写的手写签名。</li>
|
|
4072
|
-
<li> <b>HANDWRITTEN_ESIGN</b> :长效手写签名, 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)</li>
|
|
4073
|
-
<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>
|
|
4074
|
-
<li> <b>ESIGN</b> :个人印章类型。</li>
|
|
4075
|
-
<li> <b>IMG_ESIGN</b> : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>
|
|
4076
|
-
<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>
|
|
4077
|
-
|
|
4078
|
-
各种签名的样式可以参考下图:
|
|
4079
|
-

|
|
3982
|
+
* <p>当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时,可以指定签署方签名方式。如果不指定,签署人可以使用所有的签名类型,可指定的签名类型包括:</p><ul><li> <b>HANDWRITE</b> :需要实时手写的手写签名。</li><li> <b>HANDWRITTEN_ESIGN</b> :长效手写签名, 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li><li> <b>ESIGN</b> :个人印章类型。</li><li> <b>IMG_ESIGN</b> : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li><li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul><p>各种签名的样式可以参考下图:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg" alt="image"></p>
|
|
4080
3983
|
*/
|
|
4081
3984
|
ComponentLimitType?: Array<string>;
|
|
4082
3985
|
/**
|
|
4083
|
-
*
|
|
4084
|
-
<ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
|
|
4085
|
-
<li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
|
|
4086
|
-
</li></ul>
|
|
4087
|
-
注:
|
|
4088
|
-
<ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
|
|
4089
|
-
<li>此字段可传多个校验方式</li></ul>
|
|
4090
|
-
|
|
4091
|
-
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
4092
|
-
|
|
4093
|
-
.
|
|
3986
|
+
* <p>指定个人签署方查看合同的校验方式,可以传值如下:</p><ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li><li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>注: <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li><li>此字段可传多个校验方式</li></ul><p><code>此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主</code></p><p>.</p>
|
|
4094
3987
|
*/
|
|
4095
3988
|
ApproverVerifyTypes?: Array<number | bigint>;
|
|
4096
3989
|
/**
|
|
4097
|
-
*
|
|
4098
|
-
<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
|
|
4099
|
-
<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
|
|
4100
|
-
<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li>
|
|
4101
|
-
<li>**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)</li>
|
|
4102
|
-
<li>**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)</li></ul>
|
|
4103
|
-
|
|
4104
|
-
注:
|
|
4105
|
-
<ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
|
|
4106
|
-
<li>您可以传递多种值,表示可用多种认证校验方式。</li>
|
|
4107
|
-
<li>校验方式不允许只包含设备指纹识别和设备面容识别,至少需要再增加一种其他校验方式。</li>
|
|
4108
|
-
<li>设备指纹识别和设备面容识别只支持小程序使用,其他端暂不支持。</li></ul>
|
|
4109
|
-
|
|
4110
|
-
注:
|
|
4111
|
-
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
3990
|
+
* <p>您可以指定签署方签署合同的认证校验方式,可传递以下值:</p><ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li><li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li><li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li><li>**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)</li><li>**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)</li></ul><p>注:</p><ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li><li>您可以传递多种值,表示可用多种认证校验方式。</li><li>校验方式不允许只包含设备指纹识别和设备面容识别,至少需要再增加一种其他校验方式。</li><li>设备指纹识别和设备面容识别只支持小程序使用,其他端暂不支持。</li></ul><p>注:<br><code>此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主</code></p>
|
|
4112
3991
|
*/
|
|
4113
3992
|
ApproverSignTypes?: Array<number | bigint>;
|
|
4114
3993
|
/**
|
|
4115
|
-
*
|
|
4116
|
-
<ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>
|
|
4117
|
-
<li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>
|
|
4118
|
-
注:
|
|
4119
|
-
`不指定该值时,默认为签署方自行选择。`
|
|
3994
|
+
* <p>生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:</p><ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li><li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>注:<code>不指定该值时,默认为签署方自行选择。</code>
|
|
4120
3995
|
*/
|
|
4121
3996
|
SignTypeSelector?: number;
|
|
4122
3997
|
/**
|
|
4123
|
-
*
|
|
4124
|
-
|
|
4125
|
-
注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`
|
|
3998
|
+
* <p>签署人的签署截止时间,格式为Unix标准时间戳(秒), 超过此时间未签署的合同变成已过期状态,不能在继续签署</p><p>注: <code>若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同</code></p>
|
|
4126
3999
|
*/
|
|
4127
4000
|
Deadline?: number;
|
|
4128
4001
|
/**
|
|
4129
|
-
* <b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a
|
|
4130
|
-
|
|
4131
|
-
您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。
|
|
4132
|
-
|
|
4133
|
-
注意:
|
|
4134
|
-
1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。
|
|
4135
|
-
2. 使用视频认证时,<b>生成H5签署链接必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。
|
|
4136
|
-
3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
|
|
4002
|
+
* <p><b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。</p><p>您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。</p><p>注意:</p><ol><li>视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。</li><li>使用视频认证时,<b>生成H5签署链接必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。</li><li>签署完成后,可以通过<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。</li></ol>
|
|
4137
4003
|
*/
|
|
4138
4004
|
Intention?: Intention;
|
|
4139
4005
|
/**
|
|
4140
|
-
*
|
|
4141
|
-
<ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
|
|
4006
|
+
* <p>进入签署流程的限制,目前支持以下选项:</p><ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
|
|
4142
4007
|
*/
|
|
4143
4008
|
SignEndpoints?: Array<string>;
|
|
4144
4009
|
/**
|
|
4145
|
-
*
|
|
4146
|
-
默认 false 保存联系人 true 不保存联系人
|
|
4147
|
-
|
|
4148
|
-
设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。
|
|
4149
|
-
联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。
|
|
4150
|
-
如下图位置:
|
|
4151
|
-

|
|
4152
|
-
|
|
4153
|
-
|
|
4010
|
+
* <p>是否不保存联系人<br>默认 false 保存联系人 true 不保存联系人</p><p>设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。<br>联系人查看可登录<a href="https://test.qian.tencent.cn/console/">电子签控制台</a> 进行查看。<br>如下图位置:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png" alt=""></p>
|
|
4154
4011
|
*/
|
|
4155
4012
|
NotSaveContact?: boolean;
|
|
4013
|
+
/**
|
|
4014
|
+
* <p>客户指定的邮箱信息</p>
|
|
4015
|
+
*/
|
|
4016
|
+
ApproverEmail?: string;
|
|
4156
4017
|
}
|
|
4157
4018
|
/**
|
|
4158
4019
|
* DeleteSingleSignOnEmployees返回参数结构体
|
|
@@ -5030,7 +4891,7 @@ export interface CreateSchemeUrlResponse {
|
|
|
5030
4891
|
*/
|
|
5031
4892
|
export interface CreateFlowSignUrlResponse {
|
|
5032
4893
|
/**
|
|
5033
|
-
*
|
|
4894
|
+
* <p>签署人签署链接信息</p>
|
|
5034
4895
|
*/
|
|
5035
4896
|
FlowApproverUrlInfos?: Array<FlowApproverUrlInfo>;
|
|
5036
4897
|
/**
|
|
@@ -6189,10 +6050,7 @@ export interface CreateBatchSignUrlRequest {
|
|
|
6189
6050
|
*/
|
|
6190
6051
|
export interface CreateBatchInformationExtractionTaskResponse {
|
|
6191
6052
|
/**
|
|
6192
|
-
*
|
|
6193
|
-
建议开发者保存此任务ID,后续查询合同智能提取详情需要此任务ID。
|
|
6194
|
-
|
|
6195
|
-
注意:`返回的索引和ResourceIds数组一致`
|
|
6053
|
+
* <p>合同智能提取的任务ID列表,每个任务ID为32位字符串。<br>建议开发者保存此任务ID,后续查询合同智能提取详情需要此任务ID。</p><p>注意:<code>返回的索引和ResourceIds数组一致</code></p>
|
|
6196
6054
|
*/
|
|
6197
6055
|
TaskIds?: Array<string>;
|
|
6198
6056
|
/**
|
|
@@ -10404,115 +10262,73 @@ export interface CreateFlowBlockchainEvidenceUrlRequest {
|
|
|
10404
10262
|
*/
|
|
10405
10263
|
export interface CreateBatchQuickSignUrlRequest {
|
|
10406
10264
|
/**
|
|
10407
|
-
*
|
|
10408
|
-
<ul>
|
|
10409
|
-
<li>若为个人参与方:ApproverType=1</li>
|
|
10410
|
-
<li>若为企业参与方:ApproverType=0。同时 OrganizationName 参数需传入参与方企业名称。 </li>
|
|
10411
|
-
</ul>
|
|
10412
|
-
注:
|
|
10413
|
-
`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`
|
|
10414
|
-
`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
|
|
10265
|
+
* <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>
|
|
10415
10266
|
*/
|
|
10416
10267
|
FlowApproverInfo: FlowCreateApprover;
|
|
10417
10268
|
/**
|
|
10418
|
-
*
|
|
10419
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
10269
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
10420
10270
|
*/
|
|
10421
10271
|
Agent?: Agent;
|
|
10422
10272
|
/**
|
|
10423
|
-
*
|
|
10424
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
10273
|
+
* <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
10425
10274
|
*/
|
|
10426
10275
|
Operator?: UserInfo;
|
|
10427
10276
|
/**
|
|
10428
|
-
*
|
|
10429
|
-
注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
|
|
10277
|
+
* <p>批量签署的合同流程ID数组。<br>注: <code>在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。</code></p>
|
|
10430
10278
|
*/
|
|
10431
10279
|
FlowIds?: Array<string>;
|
|
10432
10280
|
/**
|
|
10433
|
-
*
|
|
10434
|
-
注:`该参数和合同流程ID数组必须二选一`
|
|
10281
|
+
* <p>合同组编号<br>注:<code>该参数和合同流程ID数组必须二选一</code></p>
|
|
10435
10282
|
*/
|
|
10436
10283
|
FlowGroupId?: string;
|
|
10437
10284
|
/**
|
|
10438
|
-
*
|
|
10285
|
+
* <p>签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)</p>
|
|
10439
10286
|
*/
|
|
10440
10287
|
JumpUrl?: string;
|
|
10441
10288
|
/**
|
|
10442
|
-
*
|
|
10443
|
-
<ul><li>**0**:手写签名(默认)</li>
|
|
10444
|
-
<li>**1**:OCR楷体</li>
|
|
10445
|
-
<li>**2**:姓名印章</li>
|
|
10446
|
-
<li>**3**:图片印章</li>
|
|
10447
|
-
<li>**4**:系统签名</li>
|
|
10448
|
-
<li>**5**:长效手写签名(包含手写签名)</li></ul>
|
|
10449
|
-
注:
|
|
10450
|
-
<ul><li>默认情况下,签名类型为手写签名</li>
|
|
10451
|
-
<li>您可以传递多种值,表示可用多种签名类型。</li>
|
|
10452
|
-
<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>
|
|
10453
|
-
<li>若签署方为个人,签名类型“5:长效手写签名”不可用,签名方式将以合同中为准。</li>
|
|
10454
|
-
</ul>
|
|
10289
|
+
* <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>
|
|
10455
10290
|
*/
|
|
10456
10291
|
SignatureTypes?: Array<number | bigint>;
|
|
10457
10292
|
/**
|
|
10458
|
-
*
|
|
10459
|
-
<ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li>
|
|
10460
|
-
<li>**2**:密码认证(默认),需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署</li>
|
|
10461
|
-
<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
|
|
10462
|
-
注:
|
|
10463
|
-
<ul><li>默认情况下,认证校验方式为人脸和密码认证</li>
|
|
10464
|
-
<li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
|
|
10293
|
+
* <p>指定批量签署合同的认证校验方式,可传递以下值:</p><ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li><li>**2**:密码认证(默认),需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署</li><li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>注:<ul><li>默认情况下,认证校验方式为人脸和密码认证</li><li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
|
|
10465
10294
|
*/
|
|
10466
10295
|
ApproverSignTypes?: Array<number | bigint>;
|
|
10467
10296
|
/**
|
|
10468
|
-
*
|
|
10469
|
-
<ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>
|
|
10470
|
-
<li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>
|
|
10471
|
-
注:
|
|
10472
|
-
`不指定该值时,默认为签署方自行选择。`
|
|
10297
|
+
* <p>生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:</p><ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li><li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>注:<code>不指定该值时,默认为签署方自行选择。</code>
|
|
10473
10298
|
*/
|
|
10474
10299
|
SignTypeSelector?: number;
|
|
10475
10300
|
/**
|
|
10476
|
-
*
|
|
10477
|
-
|
|
10478
|
-
注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`
|
|
10301
|
+
* <p>批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。 </p><p>注: <code>若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充</code></p>
|
|
10479
10302
|
*/
|
|
10480
10303
|
FlowBatchUrlInfo?: FlowBatchUrlInfo;
|
|
10481
10304
|
/**
|
|
10482
|
-
* <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签署视频核身的意图配置,选择问答模式或点头模式的语音文本。
|
|
10483
|
-
|
|
10484
|
-
注意:
|
|
10485
|
-
1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。
|
|
10486
|
-
2. 使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。
|
|
10487
|
-
3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
|
|
10305
|
+
* <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>
|
|
10488
10306
|
*/
|
|
10489
10307
|
Intention?: Intention;
|
|
10490
10308
|
/**
|
|
10491
|
-
*
|
|
10309
|
+
* <p>用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。</p>
|
|
10492
10310
|
*/
|
|
10493
10311
|
VideoVerifyTimesLimit?: number;
|
|
10494
10312
|
/**
|
|
10495
|
-
*
|
|
10496
|
-
|
|
10497
|
-
注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`
|
|
10313
|
+
* <p>缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。</p><p>注: <code>若参与方为企业员工时,暂不支持对参与方信息进行缓存</code></p>
|
|
10498
10314
|
*/
|
|
10499
10315
|
CacheApproverInfo?: boolean;
|
|
10500
10316
|
/**
|
|
10501
|
-
*
|
|
10502
|
-
<ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>
|
|
10503
|
-
|
|
10504
|
-
注:`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。`
|
|
10505
|
-
|
|
10317
|
+
* <p>是否允许此链接中签署方批量拒签。<br> <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul></p><p>注:<code>当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。</code></p>
|
|
10506
10318
|
*/
|
|
10507
10319
|
CanBatchReject?: boolean;
|
|
10508
10320
|
/**
|
|
10509
|
-
*
|
|
10321
|
+
* <p>预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。</p>
|
|
10510
10322
|
*/
|
|
10511
10323
|
PresetApproverInfo?: PresetApproverInfo;
|
|
10512
10324
|
/**
|
|
10513
|
-
*
|
|
10325
|
+
* <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 若批量签署的合同中第一份待签署合同所选择的印章或者签名无法完全覆盖后续合同要求,或者当前签署人没有指定印章使用权限,则无法使用此功能,会自动退化为逐份确认。</code></p>
|
|
10514
10326
|
*/
|
|
10515
10327
|
CanSkipReadFlow?: boolean;
|
|
10328
|
+
/**
|
|
10329
|
+
* <p>链接的有效时间,单位为秒。取值范围为 30分钟(1800)-90天(7776000)。如果不传,默认有效期为30分钟。 </p><p>注意: </p><ol><li><code>出于安全性考虑,若有效期大于30分钟,同设备24小时内点击链接查看合同需要进行手机验证码校验。</code> </li><li><code>动态签署方链接暂不支持修改过期时间。</code></li></ol>
|
|
10330
|
+
*/
|
|
10331
|
+
ExpiredOn?: number;
|
|
10516
10332
|
}
|
|
10517
10333
|
/**
|
|
10518
10334
|
* DescribeExtendedServiceAuthInfos返回参数结构体
|
|
@@ -12818,63 +12634,42 @@ export interface DeleteIntegrationRoleUsersRequest {
|
|
|
12818
12634
|
*/
|
|
12819
12635
|
export interface CreateFlowSignUrlRequest {
|
|
12820
12636
|
/**
|
|
12821
|
-
*
|
|
12822
|
-
|
|
12823
|
-
您可以登录腾讯电子签控制台,在 "合同" -> "合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
|
|
12824
|
-
|
|
12637
|
+
* <p>合同流程ID为32位字符串。</p><p>您可以登录腾讯电子签控制台,在 "合同" -> "合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。<a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a>。</p>
|
|
12825
12638
|
*/
|
|
12826
12639
|
FlowId: string;
|
|
12827
12640
|
/**
|
|
12828
|
-
*
|
|
12829
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
12641
|
+
* <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
12830
12642
|
*/
|
|
12831
12643
|
Operator?: UserInfo;
|
|
12832
12644
|
/**
|
|
12833
|
-
*
|
|
12834
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
12645
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
12835
12646
|
*/
|
|
12836
12647
|
Agent?: Agent;
|
|
12837
12648
|
/**
|
|
12838
|
-
*
|
|
12839
|
-
|
|
12840
|
-
此结构体和CreateFlow发起接口参与方结构体复用,除了上述参数外,可传递的参数有:
|
|
12841
|
-
1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。
|
|
12842
|
-
2. ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。
|
|
12843
|
-
3. SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。
|
|
12844
|
-
4. Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。
|
|
12845
|
-
|
|
12846
|
-
注:
|
|
12847
|
-
1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。
|
|
12848
|
-
2. 生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。
|
|
12849
|
-
|
|
12850
|
-
|
|
12649
|
+
* <p>流程签署人列表中,结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人,还需传递OrganizationName。</p><p>此结构体和CreateFlow发起接口参与方结构体复用,除了上述参数外,可传递的参数有:</p><ol><li>RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。</li></ol><p>注:</p><ol><li>签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。</li><li>生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。</li></ol>
|
|
12851
12650
|
*/
|
|
12852
12651
|
FlowApproverInfos?: Array<FlowCreateApprover>;
|
|
12853
12652
|
/**
|
|
12854
|
-
*
|
|
12653
|
+
* <p>用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。</p>
|
|
12855
12654
|
*/
|
|
12856
12655
|
VideoVerifyTimesLimit?: number;
|
|
12857
12656
|
/**
|
|
12858
|
-
*
|
|
12657
|
+
* <p>机构信息,暂未开放</p>
|
|
12859
12658
|
* @deprecated
|
|
12860
12659
|
*/
|
|
12861
12660
|
Organization?: OrganizationInfo;
|
|
12862
12661
|
/**
|
|
12863
|
-
*
|
|
12864
|
-
|
|
12662
|
+
* <p>签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a></p>
|
|
12865
12663
|
*/
|
|
12866
12664
|
JumpUrl?: string;
|
|
12867
12665
|
/**
|
|
12868
|
-
*
|
|
12869
|
-
|
|
12870
|
-
<ul><li><b>0</b>: 签署链接(默认值),进入后可以填写或签署合同。</li><li><b>1 </b>: 预览链接,进入后可以预览合同当前的样子。</li></ul>
|
|
12871
|
-
|
|
12872
|
-
注:
|
|
12873
|
-
|
|
12874
|
-
1. 当指定链接类型为1时,链接为预览链接,打开链接后无法进行签署操作,仅支持预览和查看当前合同状态。
|
|
12875
|
-
2. 如需生成发起方预览链接,则签署方信息应传空,即FlowApproverInfos传空或者不传。
|
|
12666
|
+
* <p>链接类型支持以下指定类型:</p><ul><li><b>0</b>: 签署链接(默认值),进入后可以填写或签署合同。</li><li><b>1 </b>: 预览链接,进入后可以预览合同当前的样子。</li></ul><p>注:</p><ol><li>当指定链接类型为1时,链接为预览链接,打开链接后无法进行签署操作,仅支持预览和查看当前合同状态。</li><li>如需生成发起方预览链接,则签署方信息应传空,即FlowApproverInfos传空或者不传。</li></ol>
|
|
12876
12667
|
*/
|
|
12877
12668
|
UrlType?: number;
|
|
12669
|
+
/**
|
|
12670
|
+
* <p>链接的有效时间,单位为秒。取值范围为 30分钟(1800)-90天(7776000)。如果不传,默认有效期为30分钟。</p><p>注意:</p><ol><li><code>出于安全性考虑,若有效期大于30分钟,同设备24小时内点击链接查看合同需要进行手机验证码校验。</code></li><li><code>若生成合同发起方预览链接,有效期大于30分钟,则需要进行验证码校验的手机号为发起方账号绑定的手机号。</code></li></ol>
|
|
12671
|
+
*/
|
|
12672
|
+
ExpiredOn?: number;
|
|
12878
12673
|
}
|
|
12879
12674
|
/**
|
|
12880
12675
|
* CreateIntegrationEmployees返回参数结构体
|
|
@@ -13559,55 +13354,33 @@ export interface AdminChangeInvitationInfo {
|
|
|
13559
13354
|
*/
|
|
13560
13355
|
export interface ApproverOption {
|
|
13561
13356
|
/**
|
|
13562
|
-
*
|
|
13563
|
-
|
|
13564
|
-
<ul><li> **false** : ( 默认)可以拒签</li>
|
|
13565
|
-
<li> **true** :不可以拒签</li></ul>
|
|
13357
|
+
* <p>签署方是否可以拒签</p><ul><li> **false** : ( 默认)可以拒签</li><li> **true** :不可以拒签</li></ul>
|
|
13566
13358
|
*/
|
|
13567
13359
|
NoRefuse?: boolean;
|
|
13568
13360
|
/**
|
|
13569
|
-
*
|
|
13570
|
-
|
|
13571
|
-
<ul><li> **false** : ( 默认)可以转他人处理</li>
|
|
13572
|
-
<li> **true** :不可以转他人处理</li></ul>
|
|
13361
|
+
* <p>签署方是否可以转他人处理</p><ul><li> **false** : ( 默认)可以转他人处理</li><li> **true** :不可以转他人处理</li></ul>
|
|
13573
13362
|
*/
|
|
13574
13363
|
NoTransfer?: boolean;
|
|
13575
13364
|
/**
|
|
13576
|
-
*
|
|
13365
|
+
* <p>允许编辑签署人信息(嵌入式使用) 默认true-可以编辑 false-不可以编辑</p>
|
|
13577
13366
|
*/
|
|
13578
13367
|
CanEditApprover?: boolean;
|
|
13579
13368
|
/**
|
|
13580
|
-
*
|
|
13581
|
-
|
|
13582
|
-
<ul><li> **1** : 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>
|
|
13583
|
-
|
|
13584
|
-
|
|
13585
|
-
|
|
13586
|
-
注:
|
|
13587
|
-
1. `使用动态签署人能力前,需登录腾讯电子签控制台打开服务开关`
|
|
13588
|
-
2. 此参数在嵌入式场景下无效。
|
|
13369
|
+
* <p>签署人信息补充类型,默认无需补充。</p><ul><li> **1** : 动态签署人(可发起合同后再补充签署人信息)注:<code>企业自动签不支持动态补充</code></li></ul><p>注:</p><ol><li><code>使用动态签署人能力前,需登录腾讯电子签控制台打开服务开关</code></li><li>此参数在嵌入式场景下无效。</li></ol>
|
|
13589
13370
|
*/
|
|
13590
13371
|
FillType?: number;
|
|
13591
13372
|
/**
|
|
13592
|
-
*
|
|
13593
|
-
<br/>取值:
|
|
13594
|
-
<ul>
|
|
13595
|
-
<li> LimitReadTimeAndBottom,阅读合同必须限制阅读时长并且必须阅读到底</li>
|
|
13596
|
-
<li> LimitReadTime,阅读合同仅限制阅读时长</li>
|
|
13597
|
-
<li> LimitBottom,阅读合同仅限制必须阅读到底</li>
|
|
13598
|
-
<li> NoReadTimeAndBottom,阅读合同不限制阅读时长且不限制阅读到底(白名单功能,请联系客户经理开白使用)</li>
|
|
13599
|
-
</ul>
|
|
13373
|
+
* <p>签署人阅读合同限制参数<br> <br>取值:</p><ul><li> LimitReadTimeAndBottom,阅读合同必须限制阅读时长并且必须阅读到底</li><li> LimitReadTime,阅读合同仅限制阅读时长</li><li> LimitBottom,阅读合同仅限制必须阅读到底</li><li> NoReadTimeAndBottom,阅读合同不限制阅读时长且不限制阅读到底(白名单功能,请联系客户经理开白使用)</li></ul>
|
|
13600
13374
|
*/
|
|
13601
13375
|
FlowReadLimit?: string;
|
|
13602
13376
|
/**
|
|
13603
|
-
*
|
|
13604
|
-
<br/>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):
|
|
13605
|
-
<ul>
|
|
13606
|
-
<li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li>
|
|
13607
|
-
<li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li>
|
|
13608
|
-
</ul>
|
|
13377
|
+
* <p>禁止在签署过程中添加签署日期控件<br> <br>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):</p><ul><li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li><li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li></ul>
|
|
13609
13378
|
*/
|
|
13610
13379
|
ForbidAddSignDate?: boolean;
|
|
13380
|
+
/**
|
|
13381
|
+
* <p>签署人手机号传参模式</p><p>枚举值:</p><ul><li>REPLACE: 接受已有认证手机号并替换</li><li>GIVEN: 以客户入参输入手机号为主</li><li>VALIDATE: 若与认证手机号不一致则报错</li></ul><p>默认值:REPLACE</p><p>会触发手机号传参模式的前提是:签署人是指定了具体身份信息的</p><ul><li>在指定签署人姓名,证件号的情况下会触发</li></ul>
|
|
13382
|
+
*/
|
|
13383
|
+
ApproverMobileMode?: string;
|
|
13611
13384
|
}
|
|
13612
13385
|
/**
|
|
13613
13386
|
* DeleteIntegrationEmployees返回参数结构体
|