tencentcloud-sdk-nodejs-ess 4.0.762 → 4.0.763

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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-ess",
3
- "version": "4.0.762",
3
+ "version": "4.0.763",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -17,7 +17,7 @@
17
17
  | apigateway | [API 网关](https://cloud.tencent.com/document/product/628) | 2023-11-16 01:06:33 |
18
18
  | apm | [应用性能监控](https://cloud.tencent.com/document/product/1463) | 2023-12-15 18:59:23 |
19
19
  | as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2023-11-20 00:01:45 |
20
- | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2023-12-20 01:08:48 |
20
+ | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2023-12-21 01:08:50 |
21
21
  | asw | [应用与服务编排工作流](https://cloud.tencent.com/document/product/1272) | 2023-05-18 01:04:02 |
22
22
  | ba | [ICP备案](https://cloud.tencent.com/document/product/243) | 2023-10-13 01:07:08 |
23
23
  | batch | [批量计算](https://cloud.tencent.com/document/product/599) | 2023-12-15 19:00:41 |
@@ -80,7 +80,7 @@
80
80
  | dbdc | [云数据库独享集群](https://cloud.tencent.com/document/product/1322) | 2023-08-22 01:11:33 |
81
81
  | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2023-12-20 01:30:30 |
82
82
  | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2023-10-30 00:33:47 |
83
- | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-12-15 19:29:56 |
83
+ | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-12-21 01:31:01 |
84
84
  | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-11-15 01:33:00 |
85
85
  | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2023-12-15 01:10:52 |
86
86
  | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2023-11-10 01:14:28 |
@@ -96,8 +96,8 @@
96
96
  | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 |
97
97
  | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-12-19 01:39:39 |
98
98
  | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2023-12-05 01:46:13 |
99
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-12-20 01:38:18 |
100
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-12-20 01:39:27 |
99
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-12-21 01:37:51 |
100
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-12-21 01:38:43 |
101
101
  | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-12-15 19:41:44 |
102
102
  | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-12-06 01:49:35 |
103
103
  | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-08-17 03:12:49 |
@@ -132,7 +132,7 @@
132
132
  | ivld | [媒体智能标签](https://cloud.tencent.com/document/product/1509) | 2023-05-18 01:35:21 |
133
133
  | keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2023-11-30 04:52:16 |
134
134
  | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2023-08-17 03:51:31 |
135
- | lcic | [实时互动-教育版](https://cloud.tencent.com/document/product/1639) | 2023-12-14 02:03:05 |
135
+ | lcic | [实时互动-教育版](https://cloud.tencent.com/document/product/1639) | 2023-12-21 01:48:52 |
136
136
  | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-12-20 01:50:09 |
137
137
  | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2023-12-19 01:53:39 |
138
138
  | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 |
@@ -154,7 +154,7 @@
154
154
  | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2023-09-15 02:14:19 |
155
155
  | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 |
156
156
  | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2023-12-20 01:57:04 |
157
- | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2023-12-08 02:12:05 |
157
+ | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2023-12-21 01:56:34 |
158
158
  | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2023-12-13 02:14:02 |
159
159
  | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2023-11-08 02:00:11 |
160
160
  | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2023-08-17 04:23:46 |
@@ -201,10 +201,10 @@
201
201
  | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2023-11-29 02:03:30 |
202
202
  | tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2023-06-21 01:36:25 |
203
203
  | tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2023-07-24 01:49:20 |
204
- | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-12-19 02:14:52 |
204
+ | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-12-21 02:11:13 |
205
205
  | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2023-11-15 02:26:59 |
206
206
  | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2023-12-20 02:13:36 |
207
- | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-12-20 02:14:14 |
207
+ | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-12-21 02:13:02 |
208
208
  | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2023-11-27 00:20:12 |
209
209
  | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
210
210
  | tic | [资源编排 TIC](https://cloud.tencent.com/document/product/1213) | 2023-08-17 05:26:08 |
@@ -212,7 +212,7 @@
212
212
  | tics | [威胁情报云查服务](https://cloud.tencent.com/document/product/1013) | 2023-08-17 05:26:12 |
213
213
  | tiems | [腾讯云 TI 平台 TI-EMS ](https://cloud.tencent.com/document/product/1120) | 2022-07-19 06:19:39 |
214
214
  | tiia | [图像分析](https://cloud.tencent.com/document/product/865) | 2023-09-01 01:23:47 |
215
- | tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2023-12-20 02:15:59 |
215
+ | tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2023-12-21 02:14:50 |
216
216
  | tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2023-12-01 01:26:06 |
217
217
  | tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2023-12-13 02:38:08 |
218
218
  | tkgdq | [腾讯知识图谱数据查询](https://cloud.tencent.com/document/product) | 2020-03-10 00:51:44 |
@@ -231,7 +231,7 @@
231
231
  | ump | [客流数字化平台](https://cloud.tencent.com/document/product/1320) | 2023-08-17 05:50:27 |
232
232
  | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-11-15 02:36:58 |
233
233
  | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2023-08-17 05:50:56 |
234
- | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-12-08 02:44:40 |
234
+ | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-12-21 02:21:45 |
235
235
  | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-12-19 02:27:19 |
236
236
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-11-27 00:23:42 |
237
237
  | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-12-20 02:27:15 |
@@ -608,6 +608,33 @@ export class Client extends TencentCloudCommon.AbstractClient {
608
608
  /**
609
609
  * 通过模板创建签署流程<br/>
610
610
  适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
611
+ <table>
612
+ <thead>
613
+ <tr>
614
+ <th>签署人类别</th>
615
+ <th>需要提前准备的信息</th>
616
+ </tr>
617
+ </thead>
618
+ <tbody>
619
+ <tr>
620
+ <td>自己企业的员工签署(未认证加入或已认证加入)</td>
621
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
622
+ </tr>
623
+ <tr>
624
+ <td>自己企业的员工签署(已认证加入)</td>
625
+ <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
626
+ </tr>
627
+ <tr>
628
+ <td>其他企业的员工签署</td>
629
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
630
+ </tr>
631
+ <tr>
632
+ <td>个人(自然人)签署</td>
633
+ <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
634
+ </tr>
635
+ </tbody>
636
+ </table>
637
+
611
638
 
612
639
  注:配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
613
640
 
@@ -755,8 +782,38 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
755
782
  * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
756
783
  适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
757
784
 
785
+ <table>
786
+ <thead>
787
+ <tr>
788
+ <th>签署人类别</th>
789
+ <th>需要提前准备的信息</th>
790
+ </tr>
791
+ </thead>
792
+ <tbody>
793
+ <tr>
794
+ <td>自己企业的员工签署(未认证加入或已认证加入)</td>
795
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
796
+ </tr>
797
+ <tr>
798
+ <td>自己企业的员工签署(已认证加入)</td>
799
+ <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
800
+ </tr>
801
+ <tr>
802
+ <td>其他企业的员工签署</td>
803
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
804
+ </tr>
805
+ <tr>
806
+ <td>个人(自然人)签署</td>
807
+ <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
808
+ </tr>
809
+ </tbody>
810
+ </table>
811
+
812
+
813
+
758
814
  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>
759
815
 
816
+
760
817
  ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
761
818
 
762
819
  注:
@@ -1002,11 +1059,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1002
1059
  /**
1003
1060
  * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
1004
1061
 
1005
- 1. 发起合同时,签署人的NotifyType需设置为sms
1006
- 2. 合同中当前状态为“待签署”的签署人是催办的对象
1007
- 3. 每个合同只能催办一次
1062
+ 1. 发起合同时,**签署人的NotifyType需设置为sms**
1063
+ 2. 合同中当前状态为 **待签署** 的签署人是催办的对象
1064
+ 3. **每个合同只能催办一次**
1065
+
1066
+ **催办的效果**: 对方会收到如下的短信通知
1067
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
1008
1068
 
1009
- 注意:该接口无法直接调用,请联系客户经理申请使用。
1069
+ 注:`合同催办是白名单功能,请联系客户经理申请开白后使用`
1010
1070
  */
1011
1071
  async CreateFlowReminds(
1012
1072
  req: CreateFlowRemindsRequest,
@@ -2970,6 +2970,18 @@ export interface CreateFlowByFilesRequest {
2970
2970
  如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
2971
2971
  */
2972
2972
  Deadline?: number
2973
+ /**
2974
+ * 合同流程的签署顺序类型:
2975
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
2976
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
2977
+ */
2978
+ Unordered?: boolean
2979
+ /**
2980
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
2981
+
2982
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
2983
+ */
2984
+ UserData?: string
2973
2985
  /**
2974
2986
  * 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
2975
2987
 
@@ -2977,11 +2989,17 @@ export interface CreateFlowByFilesRequest {
2977
2989
  */
2978
2990
  RemindedOn?: number
2979
2991
  /**
2980
- * 合同流程的签署顺序类型:
2981
- <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
2982
- <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
2992
+ * 指定个人签署方查看合同的校验方式
2993
+ <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
2994
+ <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
2983
2995
  */
2984
- Unordered?: boolean
2996
+ ApproverVerifyType?: string
2997
+ /**
2998
+ * 签署方签署控件(印章/签名等)的生成方式:
2999
+ <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
3000
+ <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
3001
+ */
3002
+ SignBeanTag?: number
2985
3003
  /**
2986
3004
  * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
2987
3005
  <ul><li>{合同名称} </li>
@@ -3000,34 +3018,6 @@ export interface CreateFlowByFilesRequest {
3000
3018
 
3001
3019
  */
3002
3020
  CustomShowMap?: string
3003
- /**
3004
- * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3005
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
3006
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
3007
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
3008
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
3009
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
3010
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
3011
- */
3012
- NeedSignReview?: boolean
3013
- /**
3014
- * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
3015
-
3016
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
3017
- */
3018
- UserData?: string
3019
- /**
3020
- * 指定个人签署方查看合同的校验方式
3021
- <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
3022
- <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
3023
- */
3024
- ApproverVerifyType?: string
3025
- /**
3026
- * 签署方签署控件(印章/签名等)的生成方式:
3027
- <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
3028
- <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
3029
- */
3030
- SignBeanTag?: number
3031
3021
  /**
3032
3022
  * 代理企业和员工的信息。
3033
3023
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
@@ -3039,6 +3029,16 @@ export interface CreateFlowByFilesRequest {
3039
3029
  注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
3040
3030
  */
3041
3031
  AutoSignScene?: string
3032
+ /**
3033
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3034
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
3035
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
3036
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
3037
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
3038
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
3039
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
3040
+ */
3041
+ NeedSignReview?: boolean
3042
3042
  }
3043
3043
 
3044
3044
  /**
@@ -222,6 +222,33 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
222
222
  /**
223
223
  * 通过模板创建签署流程<br/>
224
224
  适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
225
+ <table>
226
+ <thead>
227
+ <tr>
228
+ <th>签署人类别</th>
229
+ <th>需要提前准备的信息</th>
230
+ </tr>
231
+ </thead>
232
+ <tbody>
233
+ <tr>
234
+ <td>自己企业的员工签署(未认证加入或已认证加入)</td>
235
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
236
+ </tr>
237
+ <tr>
238
+ <td>自己企业的员工签署(已认证加入)</td>
239
+ <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
240
+ </tr>
241
+ <tr>
242
+ <td>其他企业的员工签署</td>
243
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
244
+ </tr>
245
+ <tr>
246
+ <td>个人(自然人)签署</td>
247
+ <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
248
+ </tr>
249
+ </tbody>
250
+ </table>
251
+
225
252
 
226
253
  注:配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
227
254
 
@@ -321,8 +348,38 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
321
348
  * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
322
349
  适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
323
350
 
351
+ <table>
352
+ <thead>
353
+ <tr>
354
+ <th>签署人类别</th>
355
+ <th>需要提前准备的信息</th>
356
+ </tr>
357
+ </thead>
358
+ <tbody>
359
+ <tr>
360
+ <td>自己企业的员工签署(未认证加入或已认证加入)</td>
361
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
362
+ </tr>
363
+ <tr>
364
+ <td>自己企业的员工签署(已认证加入)</td>
365
+ <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
366
+ </tr>
367
+ <tr>
368
+ <td>其他企业的员工签署</td>
369
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
370
+ </tr>
371
+ <tr>
372
+ <td>个人(自然人)签署</td>
373
+ <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
374
+ </tr>
375
+ </tbody>
376
+ </table>
377
+
378
+
379
+
324
380
  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>
325
381
 
382
+
326
383
  ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
327
384
 
328
385
  注:
@@ -466,11 +523,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
466
523
  /**
467
524
  * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
468
525
 
469
- 1. 发起合同时,签署人的NotifyType需设置为sms
470
- 2. 合同中当前状态为“待签署”的签署人是催办的对象
471
- 3. 每个合同只能催办一次
526
+ 1. 发起合同时,**签署人的NotifyType需设置为sms**
527
+ 2. 合同中当前状态为 **待签署** 的签署人是催办的对象
528
+ 3. **每个合同只能催办一次**
529
+
530
+ **催办的效果**: 对方会收到如下的短信通知
531
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
472
532
 
473
- 注意:该接口无法直接调用,请联系客户经理申请使用。
533
+ 注:`合同催办是白名单功能,请联系客户经理申请开白后使用`
474
534
  */
475
535
  CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
476
536
  /**
@@ -295,6 +295,33 @@ class Client extends TencentCloudCommon.AbstractClient {
295
295
  /**
296
296
  * 通过模板创建签署流程<br/>
297
297
  适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
298
+ <table>
299
+ <thead>
300
+ <tr>
301
+ <th>签署人类别</th>
302
+ <th>需要提前准备的信息</th>
303
+ </tr>
304
+ </thead>
305
+ <tbody>
306
+ <tr>
307
+ <td>自己企业的员工签署(未认证加入或已认证加入)</td>
308
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
309
+ </tr>
310
+ <tr>
311
+ <td>自己企业的员工签署(已认证加入)</td>
312
+ <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
313
+ </tr>
314
+ <tr>
315
+ <td>其他企业的员工签署</td>
316
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
317
+ </tr>
318
+ <tr>
319
+ <td>个人(自然人)签署</td>
320
+ <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
321
+ </tr>
322
+ </tbody>
323
+ </table>
324
+
298
325
 
299
326
  注:配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
300
327
 
@@ -410,8 +437,38 @@ class Client extends TencentCloudCommon.AbstractClient {
410
437
  * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
411
438
  适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
412
439
 
440
+ <table>
441
+ <thead>
442
+ <tr>
443
+ <th>签署人类别</th>
444
+ <th>需要提前准备的信息</th>
445
+ </tr>
446
+ </thead>
447
+ <tbody>
448
+ <tr>
449
+ <td>自己企业的员工签署(未认证加入或已认证加入)</td>
450
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
451
+ </tr>
452
+ <tr>
453
+ <td>自己企业的员工签署(已认证加入)</td>
454
+ <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
455
+ </tr>
456
+ <tr>
457
+ <td>其他企业的员工签署</td>
458
+ <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
459
+ </tr>
460
+ <tr>
461
+ <td>个人(自然人)签署</td>
462
+ <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
463
+ </tr>
464
+ </tbody>
465
+ </table>
466
+
467
+
468
+
413
469
  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>
414
470
 
471
+
415
472
  ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
416
473
 
417
474
  注:
@@ -589,11 +646,14 @@ class Client extends TencentCloudCommon.AbstractClient {
589
646
  /**
590
647
  * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
591
648
 
592
- 1. 发起合同时,签署人的NotifyType需设置为sms
593
- 2. 合同中当前状态为“待签署”的签署人是催办的对象
594
- 3. 每个合同只能催办一次
649
+ 1. 发起合同时,**签署人的NotifyType需设置为sms**
650
+ 2. 合同中当前状态为 **待签署** 的签署人是催办的对象
651
+ 3. **每个合同只能催办一次**
652
+
653
+ **催办的效果**: 对方会收到如下的短信通知
654
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
595
655
 
596
- 注意:该接口无法直接调用,请联系客户经理申请使用。
656
+ 注:`合同催办是白名单功能,请联系客户经理申请开白后使用`
597
657
  */
598
658
  async CreateFlowReminds(req, cb) {
599
659
  return this.request("CreateFlowReminds", req, cb);
@@ -2864,6 +2864,18 @@ export interface CreateFlowByFilesRequest {
2864
2864
  如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
2865
2865
  */
2866
2866
  Deadline?: number;
2867
+ /**
2868
+ * 合同流程的签署顺序类型:
2869
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
2870
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
2871
+ */
2872
+ Unordered?: boolean;
2873
+ /**
2874
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
2875
+
2876
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
2877
+ */
2878
+ UserData?: string;
2867
2879
  /**
2868
2880
  * 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
2869
2881
 
@@ -2871,11 +2883,17 @@ export interface CreateFlowByFilesRequest {
2871
2883
  */
2872
2884
  RemindedOn?: number;
2873
2885
  /**
2874
- * 合同流程的签署顺序类型:
2875
- <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
2876
- <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
2886
+ * 指定个人签署方查看合同的校验方式
2887
+ <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
2888
+ <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
2877
2889
  */
2878
- Unordered?: boolean;
2890
+ ApproverVerifyType?: string;
2891
+ /**
2892
+ * 签署方签署控件(印章/签名等)的生成方式:
2893
+ <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
2894
+ <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
2895
+ */
2896
+ SignBeanTag?: number;
2879
2897
  /**
2880
2898
  * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
2881
2899
  <ul><li>{合同名称} </li>
@@ -2894,34 +2912,6 @@ export interface CreateFlowByFilesRequest {
2894
2912
 
2895
2913
  */
2896
2914
  CustomShowMap?: string;
2897
- /**
2898
- * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
2899
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
2900
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
2901
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
2902
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
2903
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
2904
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
2905
- */
2906
- NeedSignReview?: boolean;
2907
- /**
2908
- * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
2909
-
2910
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
2911
- */
2912
- UserData?: string;
2913
- /**
2914
- * 指定个人签署方查看合同的校验方式
2915
- <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
2916
- <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
2917
- */
2918
- ApproverVerifyType?: string;
2919
- /**
2920
- * 签署方签署控件(印章/签名等)的生成方式:
2921
- <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
2922
- <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
2923
- */
2924
- SignBeanTag?: number;
2925
2915
  /**
2926
2916
  * 代理企业和员工的信息。
2927
2917
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
@@ -2933,6 +2923,16 @@ export interface CreateFlowByFilesRequest {
2933
2923
  注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
2934
2924
  */
2935
2925
  AutoSignScene?: string;
2926
+ /**
2927
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
2928
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
2929
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
2930
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
2931
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
2932
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
2933
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
2934
+ */
2935
+ NeedSignReview?: boolean;
2936
2936
  }
2937
2937
  /**
2938
2938
  * 此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息