tencentcloud-sdk-nodejs-essbasic 4.0.716 → 4.0.717

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-essbasic",
3
- "version": "4.0.716",
3
+ "version": "4.0.717",
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-10-23 00:01:27 |
18
18
  | apm | [应用性能监控](https://cloud.tencent.com/document/product/1463) | 2023-10-27 01:10:12 |
19
19
  | as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2023-10-25 01:06:52 |
20
- | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2023-10-26 01:06:40 |
20
+ | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2023-10-31 01:09:42 |
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-10-27 01:11:09 |
@@ -56,7 +56,7 @@
56
56
  | cim | [](https://cloud.tencent.com/document/product) | 2019-05-16 17:21:18 |
57
57
  | cis | [](https://cloud.tencent.com/document/product) | 2018-06-07 15:01:42 |
58
58
  | ckafka | [消息队列 CKafka 版](https://cloud.tencent.com/document/product/597) | 2023-10-27 01:21:10 |
59
- | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2023-10-27 01:22:04 |
59
+ | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2023-10-31 01:23:38 |
60
60
  | cloudaudit | [云审计](https://cloud.tencent.com/document/product/629) | 2023-05-18 01:13:28 |
61
61
  | cloudhsm | [云加密机](https://cloud.tencent.com/document/product/639) | 2023-08-17 01:57:08 |
62
62
  | cloudstudio | [Cloud Studio(云端 IDE)](https://cloud.tencent.com/document/product/1039) | 2023-08-03 01:03:28 |
@@ -66,7 +66,7 @@
66
66
  | cms | [内容安全](https://cloud.tencent.com/document/product/669) | 2023-08-24 01:10:10 |
67
67
  | cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2023-09-21 02:09:54 |
68
68
  | cr | [金融联络机器人](https://cloud.tencent.com/document/product/656) | 2021-02-24 08:03:24 |
69
- | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2023-10-30 00:24:02 |
69
+ | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2023-10-31 01:30:05 |
70
70
  | csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2023-05-19 11:26:14 |
71
71
  | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2023-10-30 00:24:37 |
72
72
  | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2023-10-27 01:29:35 |
@@ -87,16 +87,16 @@
87
87
  | dsgc | [数据安全治理中心](https://cloud.tencent.com/document/product/1087) | 2023-10-17 01:15:42 |
88
88
  | dtf | [分布式事务](https://cloud.tencent.com/document/product/1224) | 2022-04-04 06:38:57 |
89
89
  | dts | [数据传输服务](https://cloud.tencent.com/document/product/571) | 2023-10-23 15:36:37 |
90
- | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2023-10-17 01:16:13 |
90
+ | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2023-10-31 01:45:32 |
91
91
  | ecc | [英文作文批改](https://cloud.tencent.com/document/product/1076) | 2023-09-13 01:42:58 |
92
92
  | ecdn | [全站加速网络](https://cloud.tencent.com/document/product/570) | 2023-08-17 03:03:04 |
93
- | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-10-26 01:14:34 |
93
+ | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-10-31 01:46:23 |
94
94
  | eiam | [数字身份管控平台(员工版)](https://cloud.tencent.com/document/product/1442) | 2023-05-18 01:25:40 |
95
95
  | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 |
96
96
  | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-10-16 01:15:50 |
97
97
  | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2023-10-30 00:42:05 |
98
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-10-26 16:41:49 |
99
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-10-30 00:43:34 |
98
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-10-31 01:49:17 |
99
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-10-31 01:50:09 |
100
100
  | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-09-18 01:48:33 |
101
101
  | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-10-20 01:16:02 |
102
102
  | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-08-17 03:12:49 |
@@ -121,7 +121,7 @@
121
121
  | iotcloud | [物联网通信](https://cloud.tencent.com/document/product/634) | 2023-08-09 01:29:39 |
122
122
  | iotexplorer | [物联网开发平台](https://cloud.tencent.com/document/product/1081) | 2023-10-16 01:17:51 |
123
123
  | iottid | [物联网设备身份认证](https://cloud.tencent.com/document/product/1086) | 2023-05-18 01:33:02 |
124
- | iotvideo | [物联网智能视频服务](https://cloud.tencent.com/document/product/1131) | 2023-10-25 01:19:12 |
124
+ | iotvideo | [物联网智能视频服务](https://cloud.tencent.com/document/product/1131) | 2023-10-31 01:58:13 |
125
125
  | iotvideoindustry | [物联网智能视频服务(行业版)](https://cloud.tencent.com/document/product/1361) | 2023-08-17 03:44:44 |
126
126
  | irp | [智能推荐平台](https://cloud.tencent.com/document/product/1541) | 2023-09-22 02:00:51 |
127
127
  | iss | [智能视图计算平台](https://cloud.tencent.com/document/product/1344) | 2023-10-27 01:53:51 |
@@ -150,7 +150,7 @@
150
150
  | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2023-09-15 02:14:19 |
151
151
  | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 |
152
152
  | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2023-10-24 01:20:07 |
153
- | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2023-10-30 01:04:20 |
153
+ | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2023-10-31 02:11:36 |
154
154
  | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2023-10-27 16:07:10 |
155
155
  | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2023-10-27 02:04:21 |
156
156
  | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2023-08-17 04:23:46 |
@@ -158,13 +158,13 @@
158
158
  | postgres | [云数据库 PostgreSQL](https://cloud.tencent.com/document/product/409) | 2023-10-09 01:20:54 |
159
159
  | privatedns | [私有域解析 Private DNS](https://cloud.tencent.com/document/product/1338) | 2023-10-13 01:22:04 |
160
160
  | pts | [云压测](https://cloud.tencent.com/document/product/1484) | 2023-08-24 01:24:59 |
161
- | rce | [全栈式风控引擎](https://cloud.tencent.com/document/product/1343) | 2023-10-19 16:13:58 |
161
+ | rce | [全栈式风控引擎](https://cloud.tencent.com/document/product/1343) | 2023-10-31 02:15:24 |
162
162
  | redis | [云数据库Redis](https://cloud.tencent.com/document/product/239) | 2023-10-30 01:08:20 |
163
163
  | region | [地域管理系统](https://cloud.tencent.com/document/product/1596) | 2023-10-13 01:22:28 |
164
164
  | rkp | [风险探针](https://cloud.tencent.com/document/product/1169) | 2023-08-17 04:33:51 |
165
165
  | rp | [注册保护](https://cloud.tencent.com/document/product/1191) | 2022-04-04 07:04:06 |
166
166
  | rum | [前端性能监控](https://cloud.tencent.com/document/product/1464) | 2023-10-13 01:22:31 |
167
- | scf | [云函数](https://cloud.tencent.com/document/product/583) | 2023-10-19 16:14:22 |
167
+ | scf | [云函数](https://cloud.tencent.com/document/product/583) | 2023-10-31 02:17:15 |
168
168
  | ses | [邮件推送](https://cloud.tencent.com/document/product/1288) | 2023-10-30 01:10:42 |
169
169
  | smh | [智能媒资托管](https://cloud.tencent.com/document/product/1339) | 2023-07-11 01:37:49 |
170
170
  | smop | [腾讯安心用户运营平台](https://cloud.tencent.com/document/product/1310) | 2023-05-18 01:47:59 |
@@ -179,7 +179,7 @@
179
179
  | ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2023-08-17 04:46:36 |
180
180
  | sts | [安全凭证服务](https://cloud.tencent.com/document/product/1312) | 2023-10-27 02:11:56 |
181
181
  | taf | [流量反欺诈](https://cloud.tencent.com/document/product/1031) | 2023-08-17 04:47:19 |
182
- | tag | [标签](https://cloud.tencent.com/document/product/651) | 2023-09-21 05:27:30 |
182
+ | tag | [标签](https://cloud.tencent.com/document/product/651) | 2023-10-31 02:21:34 |
183
183
  | tan | [碳引擎](https://cloud.tencent.com/document/product/1498) | 2023-05-18 01:50:16 |
184
184
  | tat | [自动化助手](https://cloud.tencent.com/document/product/1340) | 2023-10-25 01:24:40 |
185
185
  | tav | [文件检测](https://cloud.tencent.com/document/product) | 2019-11-28 22:10:04 |
@@ -194,13 +194,13 @@
194
194
  | tci | [腾讯智学课堂分析](https://cloud.tencent.com/document/product) | 2020-08-24 08:06:03 |
195
195
  | tcm | [服务网格](https://cloud.tencent.com/document/product/1261) | 2023-10-09 01:23:14 |
196
196
  | tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2023-09-11 02:43:38 |
197
- | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2023-10-27 02:15:26 |
197
+ | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2023-10-31 02:25:36 |
198
198
  | tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2023-06-21 01:36:25 |
199
199
  | tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2023-07-24 01:49:20 |
200
- | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-10-30 01:21:37 |
200
+ | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-10-31 02:29:08 |
201
201
  | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2023-05-18 01:55:50 |
202
202
  | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2023-08-30 01:25:15 |
203
- | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-10-27 10:26:11 |
203
+ | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-10-31 02:31:17 |
204
204
  | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2023-09-21 06:17:00 |
205
205
  | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
206
206
  | tic | [资源编排 TIC](https://cloud.tencent.com/document/product/1213) | 2023-08-17 05:26:08 |
@@ -209,17 +209,17 @@
209
209
  | tiems | [腾讯云 TI 平台 TI-EMS ](https://cloud.tencent.com/document/product/1120) | 2022-07-19 06:19:39 |
210
210
  | tiia | [图像分析](https://cloud.tencent.com/document/product/865) | 2023-09-01 01:23:47 |
211
211
  | tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2023-10-20 01:25:11 |
212
- | tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2023-09-22 02:39:13 |
213
- | tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2023-10-27 02:23:24 |
212
+ | tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2023-10-31 02:34:57 |
213
+ | tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2023-10-31 02:35:43 |
214
214
  | tkgdq | [腾讯知识图谱数据查询](https://cloud.tencent.com/document/product) | 2020-03-10 00:51:44 |
215
215
  | tms | [文本内容安全](https://cloud.tencent.com/document/product/1124) | 2023-10-25 01:27:42 |
216
216
  | tmt | [机器翻译](https://cloud.tencent.com/document/product/551) | 2023-09-27 01:26:36 |
217
217
  | tourism | [文旅客情大数据](https://cloud.tencent.com/document/product/1684) | 2023-08-10 01:43:37 |
218
218
  | trdp | [流量风险决策平台](https://cloud.tencent.com/document/product/1604) | 2023-05-18 02:01:19 |
219
- | trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2023-10-24 01:25:58 |
219
+ | trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2023-10-31 02:38:03 |
220
220
  | trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2023-10-26 14:46:10 |
221
221
  | trro | [远程实时操控](https://cloud.tencent.com/document/product/1584) | 2023-07-18 01:53:24 |
222
- | trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2023-10-26 01:26:53 |
222
+ | trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2023-10-31 02:39:19 |
223
223
  | tse | [微服务引擎 TSE](https://cloud.tencent.com/document/product/1364) | 2023-10-20 01:26:31 |
224
224
  | tsf | [微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2023-10-11 02:39:14 |
225
225
  | tsw | [微服务观测平台 TSW](https://cloud.tencent.com/document/product/1311) | 2023-05-18 02:04:00 |
@@ -228,11 +228,11 @@
228
228
  | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-05-18 02:04:19 |
229
229
  | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2023-08-17 05:50:56 |
230
230
  | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-10-30 01:34:07 |
231
- | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-10-30 01:36:36 |
231
+ | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-10-31 02:45:47 |
232
232
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-07-18 01:58:58 |
233
233
  | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-10-27 02:33:14 |
234
234
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-07-18 01:59:28 |
235
- | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-10-30 01:41:20 |
235
+ | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-10-31 02:51:22 |
236
236
  | weilingwith | [微瓴同业开放平台](https://cloud.tencent.com/document/product/1693) | 2023-09-12 09:30:48 |
237
237
  | wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 |
238
238
  | yinsuda | [音速达直播音乐版权引擎](https://cloud.tencent.com/document/product/1592) | 2023-08-10 01:50:27 |
@@ -558,8 +558,14 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
558
558
  }
559
559
 
560
560
  /**
561
- * 企业方可以通过此接口关闭个人的自动签功能
562
- */
561
+ * 通过此接口可以关闭个人用户自动签功能。
562
+ 无需对应的用户刷脸等方式同意即可关闭。
563
+
564
+ 注意:
565
+
566
+ <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
567
+ <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
568
+ */
563
569
  async ChannelDisableUserAutoSign(
564
570
  req: ChannelDisableUserAutoSignRequest,
565
571
  cb?: (error: string, rep: ChannelDisableUserAutoSignResponse) => void
@@ -814,8 +820,10 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
814
820
  }
815
821
 
816
822
  /**
817
- * 企业方可以通过此接口查询个人用户自动签开启状态
818
- */
823
+ * 通过此接口获取个人用户自动签的开通状态。
824
+
825
+ 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
826
+ */
819
827
  async ChannelDescribeUserAutoSignStatus(
820
828
  req: ChannelDescribeUserAutoSignStatusRequest,
821
829
  cb?: (error: string, rep: ChannelDescribeUserAutoSignStatusResponse) => void
@@ -881,18 +889,22 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
881
889
  }
882
890
 
883
891
  /**
884
- * 指定需要批量撤销的签署流程Id,批量撤销合同
885
- 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
886
-
887
- 可以撤回:未全部签署完成
888
- 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
889
-
890
- **满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。**
891
-
892
- **合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
893
-
894
- **注意:
895
- 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
892
+ * 用于批量撤销合同流程<br/>
893
+ 适用场景:
894
+ 如果某些合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
895
+ 通过签署流程编号批量撤销合同,单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是,若合同处于以下已终止状态,则不可撤销:<br/>
896
+ - 已全部签署完成
897
+ - 已拒签
898
+ - 已过期
899
+ - 已撤回
900
+ - 拒绝填写
901
+ - 已解除
902
+
903
+ <br/>
904
+ 满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
905
+ <br/><br/>
906
+ 注:
907
+ `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
896
908
  */
897
909
  async ChannelBatchCancelFlows(
898
910
  req: ChannelBatchCancelFlowsRequest,
@@ -1020,8 +1032,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1020
1032
  }
1021
1033
 
1022
1034
  /**
1023
- * 创建个人签署H5签署链接,请联系客户经理申请使用<br/>
1024
- 该接口用于发起合同后,生成C端签署人的签署链接<br/>
1035
+ * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
1025
1036
  注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
1026
1037
  注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
1027
1038
  注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
@@ -431,7 +431,7 @@ export interface ChannelCreateFlowGroupByTemplatesResponse {
431
431
  * 合同组中每个合同流程ID,每个ID均为32位字符串。
432
432
 
433
433
  注:
434
- `此数组的顺序和入参中的FlowInfos顺序回不一致`
434
+ `此数组的顺序和入参中的FlowInfos顺序一致`
435
435
  */
436
436
  FlowIds?: Array<string>
437
437
  /**
@@ -2715,18 +2715,22 @@ export interface PdfVerifyResult {
2715
2715
  */
2716
2716
  export interface UserThreeFactor {
2717
2717
  /**
2718
- * 姓名
2718
+ * 签署方经办人的姓名。
2719
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2719
2720
  */
2720
2721
  Name: string
2721
2722
  /**
2722
- * 证件类型:
2723
- ID_CARD 身份证
2724
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
2725
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
2723
+ * 证件类型,支持以下类型
2724
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
2725
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
2726
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
2726
2727
  */
2727
2728
  IdCardType: string
2728
2729
  /**
2729
- * 证件号,如果有 X 请大写
2730
+ * 证件号码,应符合以下规则
2731
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
2732
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
2733
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
2730
2734
  */
2731
2735
  IdCardNumber: string
2732
2736
  }
@@ -4234,20 +4238,23 @@ export interface FailedCreateRoleData {
4234
4238
  */
4235
4239
  export interface ChannelDescribeUserAutoSignStatusRequest {
4236
4240
  /**
4237
- * 渠道应用相关信息
4241
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4238
4242
  */
4239
4243
  Agent: Agent
4240
4244
  /**
4241
- * 自动签场景:
4242
- E_PRESCRIPTION_AUTO_SIGN 电子处方
4245
+ * 自动签使用的场景值, 可以选择的场景值如下:
4246
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
4247
+
4248
+ 注: `现在仅支持电子处方场景`
4243
4249
  */
4244
4250
  SceneKey: string
4245
4251
  /**
4246
- * 查询开启状态的用户信息
4252
+ * 要查询状态的用户信息, 包括名字,身份证等
4247
4253
  */
4248
4254
  UserInfo: UserThreeFactor
4249
4255
  /**
4250
- * 操作人信息
4256
+ * 执行本接口操作的员工信息。
4257
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4251
4258
  */
4252
4259
  Operator?: UserInfo
4253
4260
  }
@@ -4554,20 +4561,21 @@ export interface ChannelCreateFlowSignReviewResponse {
4554
4561
  */
4555
4562
  export interface ChannelDisableUserAutoSignRequest {
4556
4563
  /**
4557
- * 渠道应用相关信息
4564
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4558
4565
  */
4559
4566
  Agent: Agent
4560
4567
  /**
4561
- * 自动签场景:
4562
- E_PRESCRIPTION_AUTO_SIGN 电子处方
4568
+ * 自动签使用的场景值, 可以选择的场景值如下:
4569
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
4563
4570
  */
4564
4571
  SceneKey: string
4565
4572
  /**
4566
- * 关闭自动签的个人的三要素
4573
+ * 需要关闭自动签的个人的信息,如姓名,证件信息等。
4567
4574
  */
4568
4575
  UserInfo: UserThreeFactor
4569
4576
  /**
4570
- * 操作人信息
4577
+ * 执行本接口操作的员工信息。
4578
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4571
4579
  */
4572
4580
  Operator?: UserInfo
4573
4581
  }
@@ -4718,7 +4726,7 @@ export interface ChannelCreateFlowGroupByFilesResponse {
4718
4726
  * 合同组中每个合同流程ID,每个ID均为32位字符串。
4719
4727
 
4720
4728
  注:
4721
- `此数组的顺序和入参中的FlowGroupInfos顺序回不一致`
4729
+ `此数组的顺序和入参中的FlowGroupInfos顺序一致`
4722
4730
  注意:此字段可能返回 null,表示取不到有效值。
4723
4731
  */
4724
4732
  FlowIds?: Array<string>
@@ -5109,12 +5117,19 @@ export interface ChannelBatchCancelFlowsRequest {
5109
5117
  */
5110
5118
  CancelMessage?: string
5111
5119
  /**
5112
- * 撤销理由自定义格式;选项:
5120
+ * 撤销理由自定义格式,支持以下格式
5121
+ <ul><li>0 : 默认值</li>
5122
+ <li>1 : 只保留身份信息</li>
5123
+ <li>2 : 保留身份信息+企业名称</li>
5124
+ <li>3 : 保留身份信息+企业名称+经办人名称</li></ul>
5125
+ 例如,假设合同的发起方是典子谦示例企业的经办人张三,撤销理由是"合同内容错误,需要修正",合同撤销后,各签署方看到的撤销理由是会是
5113
5126
 
5114
- - 0 默认格式
5115
- - 1 只保留身份信息:展示为【发起方】
5116
- - 2 保留身份信息+企业名称:展示为【发起方xxx公司】
5117
- - 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
5127
+ 0: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同
5128
+ 1: 发起方以"合同内容错误,需要修正"的理由撤销当前合同
5129
+ 2: 发起方-典子谦示例企业以"合同内容错误,需要修正"的理由撤销当前合同
5130
+ 3: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同</br>
5131
+
5132
+ 备注:`如果不传递撤销理由,那么默认撤销理由是 "自动撤销(通过接口实现)"`
5118
5133
  */
5119
5134
  CancelMessageFormat?: number
5120
5135
  /**
@@ -5917,19 +5932,25 @@ export interface CreateSealByImageRequest {
5917
5932
  */
5918
5933
  export interface ChannelDescribeUserAutoSignStatusResponse {
5919
5934
  /**
5920
- * 是否开通
5935
+ * 查询用户是否已开通自动签
5921
5936
  */
5922
5937
  IsOpen?: boolean
5923
5938
  /**
5924
- * 自动签许可生效时间。当且仅当已开通自动签时有值。
5939
+ * 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
5940
+
5941
+ 值为unix时间戳,单位为秒。
5925
5942
  */
5926
5943
  LicenseFrom?: number
5927
5944
  /**
5928
- * 自动签许可到期时间。当且仅当已开通自动签时有值。
5945
+ * 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
5946
+
5947
+ 值为unix时间戳,单位为秒。
5929
5948
  */
5930
5949
  LicenseTo?: number
5931
5950
  /**
5932
- * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
5951
+ * 设置用户开通自动签时是否绑定个人自动签账号许可。
5952
+
5953
+ <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
5933
5954
  */
5934
5955
  LicenseType?: number
5935
5956
  /**
@@ -261,8 +261,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
261
261
  */
262
262
  CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
263
263
  /**
264
- * 企业方可以通过此接口关闭个人的自动签功能
265
- */
264
+ * 通过此接口可以关闭个人用户自动签功能。
265
+ 无需对应的用户刷脸等方式同意即可关闭。
266
+
267
+ 注意:
268
+
269
+ <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
270
+ <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
271
+ */
266
272
  ChannelDisableUserAutoSign(req: ChannelDisableUserAutoSignRequest, cb?: (error: string, rep: ChannelDisableUserAutoSignResponse) => void): Promise<ChannelDisableUserAutoSignResponse>;
267
273
  /**
268
274
  * 查询子客企业电子印章,需要操作者具有管理印章权限
@@ -421,8 +427,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
421
427
  */
422
428
  ChannelCreateUserAutoSignSealUrl(req: ChannelCreateUserAutoSignSealUrlRequest, cb?: (error: string, rep: ChannelCreateUserAutoSignSealUrlResponse) => void): Promise<ChannelCreateUserAutoSignSealUrlResponse>;
423
429
  /**
424
- * 企业方可以通过此接口查询个人用户自动签开启状态
425
- */
430
+ * 通过此接口获取个人用户自动签的开通状态。
431
+
432
+ 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
433
+ */
426
434
  ChannelDescribeUserAutoSignStatus(req: ChannelDescribeUserAutoSignStatusRequest, cb?: (error: string, rep: ChannelDescribeUserAutoSignStatusResponse) => void): Promise<ChannelDescribeUserAutoSignStatusResponse>;
427
435
  /**
428
436
  * 对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
@@ -452,18 +460,22 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
452
460
  */
453
461
  ChannelDescribeEmployees(req: ChannelDescribeEmployeesRequest, cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void): Promise<ChannelDescribeEmployeesResponse>;
454
462
  /**
455
- * 指定需要批量撤销的签署流程Id,批量撤销合同
456
- 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
457
-
458
- 可以撤回:未全部签署完成
459
- 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
460
-
461
- **满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。**
462
-
463
- **合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
464
-
465
- **注意:
466
- 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
463
+ * 用于批量撤销合同流程<br/>
464
+ 适用场景:
465
+ 如果某些合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
466
+ 通过签署流程编号批量撤销合同,单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是,若合同处于以下已终止状态,则不可撤销:<br/>
467
+ - 已全部签署完成
468
+ - 已拒签
469
+ - 已过期
470
+ - 已撤回
471
+ - 拒绝填写
472
+ - 已解除
473
+
474
+ <br/>
475
+ 满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
476
+ <br/><br/>
477
+ 注:
478
+ `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
467
479
  */
468
480
  ChannelBatchCancelFlows(req: ChannelBatchCancelFlowsRequest, cb?: (error: string, rep: ChannelBatchCancelFlowsResponse) => void): Promise<ChannelBatchCancelFlowsResponse>;
469
481
  /**
@@ -537,8 +549,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
537
549
  */
538
550
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
539
551
  /**
540
- * 创建个人签署H5签署链接,请联系客户经理申请使用<br/>
541
- 该接口用于发起合同后,生成C端签署人的签署链接<br/>
552
+ * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
542
553
  注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
543
554
  注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
544
555
  注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
@@ -314,8 +314,14 @@ class Client extends TencentCloudCommon.AbstractClient {
314
314
  return this.request("CreateFlowsByTemplates", req, cb);
315
315
  }
316
316
  /**
317
- * 企业方可以通过此接口关闭个人的自动签功能
318
- */
317
+ * 通过此接口可以关闭个人用户自动签功能。
318
+ 无需对应的用户刷脸等方式同意即可关闭。
319
+
320
+ 注意:
321
+
322
+ <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
323
+ <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
324
+ */
319
325
  async ChannelDisableUserAutoSign(req, cb) {
320
326
  return this.request("ChannelDisableUserAutoSign", req, cb);
321
327
  }
@@ -506,8 +512,10 @@ class Client extends TencentCloudCommon.AbstractClient {
506
512
  return this.request("ChannelCreateUserAutoSignSealUrl", req, cb);
507
513
  }
508
514
  /**
509
- * 企业方可以通过此接口查询个人用户自动签开启状态
510
- */
515
+ * 通过此接口获取个人用户自动签的开通状态。
516
+
517
+ 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
518
+ */
511
519
  async ChannelDescribeUserAutoSignStatus(req, cb) {
512
520
  return this.request("ChannelDescribeUserAutoSignStatus", req, cb);
513
521
  }
@@ -549,18 +557,22 @@ class Client extends TencentCloudCommon.AbstractClient {
549
557
  return this.request("ChannelDescribeEmployees", req, cb);
550
558
  }
551
559
  /**
552
- * 指定需要批量撤销的签署流程Id,批量撤销合同
553
- 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
554
-
555
- 可以撤回:未全部签署完成
556
- 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
557
-
558
- **满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。**
559
-
560
- **合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
561
-
562
- **注意:
563
- 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
560
+ * 用于批量撤销合同流程<br/>
561
+ 适用场景:
562
+ 如果某些合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
563
+ 通过签署流程编号批量撤销合同,单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是,若合同处于以下已终止状态,则不可撤销:<br/>
564
+ - 已全部签署完成
565
+ - 已拒签
566
+ - 已过期
567
+ - 已撤回
568
+ - 拒绝填写
569
+ - 已解除
570
+
571
+ <br/>
572
+ 满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
573
+ <br/><br/>
574
+ 注:
575
+ `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
564
576
  */
565
577
  async ChannelBatchCancelFlows(req, cb) {
566
578
  return this.request("ChannelBatchCancelFlows", req, cb);
@@ -652,8 +664,7 @@ class Client extends TencentCloudCommon.AbstractClient {
652
664
  return this.request("UploadFiles", req, cb);
653
665
  }
654
666
  /**
655
- * 创建个人签署H5签署链接,请联系客户经理申请使用<br/>
656
- 该接口用于发起合同后,生成C端签署人的签署链接<br/>
667
+ * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
657
668
  注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
658
669
  注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
659
670
  注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>