tencentcloud-sdk-nodejs-essbasic 4.0.706 → 4.0.708

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.706",
3
+ "version": "4.0.708",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -14,7 +14,7 @@
14
14
  | apcas | [汽车精准获客服务](https://cloud.tencent.com/document/product/1244) | 2022-04-04 06:05:36 |
15
15
  | ape | [正版图库直通车](https://cloud.tencent.com/document/product/1181) | 2022-04-04 06:05:40 |
16
16
  | api | [云 API](https://cloud.tencent.com/document/product/1278) | 2023-01-05 01:02:52 |
17
- | apigateway | [API 网关](https://cloud.tencent.com/document/product/628) | 2023-10-12 01:07:58 |
17
+ | apigateway | [API 网关](https://cloud.tencent.com/document/product/628) | 2023-10-18 01:09:16 |
18
18
  | apm | [应用性能监控](https://cloud.tencent.com/document/product/1463) | 2023-09-25 01:06:12 |
19
19
  | as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2023-10-10 01:07:51 |
20
20
  | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2023-09-27 01:07:00 |
@@ -23,25 +23,25 @@
23
23
  | batch | [批量计算](https://cloud.tencent.com/document/product/599) | 2023-10-16 01:07:03 |
24
24
  | bda | [人体分析](https://cloud.tencent.com/document/product/1208) | 2023-10-11 01:10:01 |
25
25
  | bi | [商业智能分析 BI](https://cloud.tencent.com/document/product/590) | 2023-09-27 01:07:14 |
26
- | billing | [费用中心](https://cloud.tencent.com/document/product/555) | 2023-10-13 01:07:25 |
26
+ | billing | [费用中心](https://cloud.tencent.com/document/product/555) | 2023-10-18 01:13:22 |
27
27
  | bizlive | [商业直播](https://cloud.tencent.com/document/product) | 2020-03-10 01:08:07 |
28
- | bm | [黑石物理服务器CPM](https://cloud.tencent.com/document/product/386) | 2023-08-17 01:20:19 |
28
+ | bm | [黑石物理服务器CPM](https://cloud.tencent.com/document/product/386) | 2023-10-18 01:14:30 |
29
29
  | bma | [品牌经营管家](https://cloud.tencent.com/document/product/1296) | 2023-08-31 01:07:17 |
30
- | bmeip | [黑石弹性公网IP](https://cloud.tencent.com/document/product/1028) | 2023-08-17 01:21:42 |
31
- | bmlb | [黑石负载均衡](https://cloud.tencent.com/document/product/1027) | 2023-08-17 01:21:57 |
30
+ | bmeip | [黑石弹性公网IP](https://cloud.tencent.com/document/product/1028) | 2023-10-17 01:08:08 |
31
+ | bmlb | [黑石负载均衡](https://cloud.tencent.com/document/product/1027) | 2023-10-17 01:08:12 |
32
32
  | bmvpc | [黑石私有网络](https://cloud.tencent.com/document/product/1024) | 2023-10-12 01:13:46 |
33
33
  | bpaas | [商业流程服务](https://cloud.tencent.com/document/product/1083) | 2023-06-14 01:09:11 |
34
34
  | bri | [业务风险情报](https://cloud.tencent.com/document/product/1064) | 2023-08-17 01:22:35 |
35
- | bsca | [二进制软件成分分析](https://cloud.tencent.com/document/product/1483) | 2023-05-18 01:06:40 |
35
+ | bsca | [二进制软件成分分析](https://cloud.tencent.com/document/product/1483) | 2023-10-17 01:08:28 |
36
36
  | btoe | [区块链可信取证](https://cloud.tencent.com/document/product/1259) | 2023-05-18 01:06:44 |
37
37
  | cam | [访问管理](https://cloud.tencent.com/document/product/598) | 2023-09-21 01:23:47 |
38
38
  | captcha | [验证码](https://cloud.tencent.com/document/product/1110) | 2023-08-24 10:06:50 |
39
- | car | [应用云渲染](https://cloud.tencent.com/document/product/1547) | 2023-09-21 01:28:16 |
39
+ | car | [应用云渲染](https://cloud.tencent.com/document/product/1547) | 2023-10-17 01:08:50 |
40
40
  | casb | [云访问安全代理](https://cloud.tencent.com/document/product/1303) | 2022-12-26 10:53:16 |
41
41
  | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2023-05-18 01:07:39 |
42
42
  | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-09-20 01:08:08 |
43
43
  | ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2023-10-16 01:08:23 |
44
- | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-09-21 01:31:18 |
44
+ | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-10-18 01:20:48 |
45
45
  | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2023-09-12 01:18:51 |
46
46
  | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2023-10-09 01:08:48 |
47
47
  | cds | [T-Sec-数据安全审计(DSA)](https://cloud.tencent.com/document/product/856) | 2023-08-17 01:43:06 |
@@ -69,7 +69,7 @@
69
69
  | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2023-10-16 01:11:35 |
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-16 01:11:44 |
72
- | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2023-10-12 01:38:16 |
72
+ | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2023-10-18 01:38:58 |
73
73
  | cws | [漏洞扫描服务](https://cloud.tencent.com/document/product) | 2019-11-22 12:16:15 |
74
74
  | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2023-10-13 01:13:55 |
75
75
  | dasb | [T-Sec-堡垒机(BH)](https://cloud.tencent.com/document/product/1025) | 2023-10-12 01:46:01 |
@@ -79,30 +79,30 @@
79
79
  | dbdc | [云数据库独享集群](https://cloud.tencent.com/document/product/1322) | 2023-08-22 01:11:33 |
80
80
  | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2023-08-17 02:50:46 |
81
81
  | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2023-09-25 01:13:09 |
82
- | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-10-16 01:14:08 |
82
+ | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-10-18 01:49:18 |
83
83
  | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-09-12 01:43:38 |
84
- | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2023-09-20 01:34:26 |
84
+ | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2023-10-18 01:53:41 |
85
85
  | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2023-08-17 02:59:36 |
86
86
  | ds | [文档服务](https://cloud.tencent.com/document/product/869) | 2023-08-17 02:59:40 |
87
- | dsgc | [数据安全中心](https://cloud.tencent.com/document/product/1087) | 2023-09-19 01:13:28 |
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-10 01:36:36 |
90
- | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2023-10-16 01:15:14 |
90
+ | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2023-10-17 01:16:13 |
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-09-05 10:56:15 |
93
+ | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-10-17 01:16:27 |
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-12 01:57:01 |
98
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-10-16 01:16:11 |
99
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-10-16 01:16:28 |
98
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-10-18 02:01:09 |
99
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-10-18 02:03:31 |
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-09-19 01:15:41 |
102
102
  | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-08-17 03:12:49 |
103
103
  | ft | [人像变换](https://cloud.tencent.com/document/product/1202) | 2023-08-17 03:12:58 |
104
104
  | gaap | [全球应用加速](https://cloud.tencent.com/document/product/608) | 2023-09-22 01:52:02 |
105
- | gme | [游戏多媒体引擎](https://cloud.tencent.com/document/product/607) | 2023-08-24 01:19:31 |
105
+ | gme | [游戏多媒体引擎](https://cloud.tencent.com/document/product/607) | 2023-10-18 02:07:09 |
106
106
  | goosefs | [数据加速器 GooseFS](https://cloud.tencent.com/document/product/1424) | 2023-10-12 02:01:46 |
107
107
  | gpm | [游戏玩家匹配](https://cloud.tencent.com/document/product/1294) | 2022-07-11 06:12:36 |
108
108
  | gs | [云游戏](https://cloud.tencent.com/document/product/1162) | 2023-05-18 01:29:42 |
@@ -129,8 +129,8 @@
129
129
  | keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2023-07-19 01:29:34 |
130
130
  | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2023-08-17 03:51:31 |
131
131
  | lcic | [低代码互动课堂](https://cloud.tencent.com/document/product/1639) | 2023-10-12 02:11:22 |
132
- | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-10-11 02:02:31 |
133
- | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2023-10-13 01:19:37 |
132
+ | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-10-18 02:19:03 |
133
+ | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2023-10-18 02:20:12 |
134
134
  | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 |
135
135
  | lp | [登录保护](https://cloud.tencent.com/document/product/1190) | 2022-04-04 06:56:52 |
136
136
  | mall | [商场客留大数据](https://cloud.tencent.com/document/product/1707) | 2023-07-17 10:16:02 |
@@ -139,17 +139,17 @@
139
139
  | memcached | [云数据库Memcached](https://cloud.tencent.com/document/product/241) | 2023-08-29 01:18:58 |
140
140
  | mgobe | [游戏联机对战引擎](https://cloud.tencent.com/document/product/1038) | 2022-07-08 06:11:32 |
141
141
  | mmps | [小程序安全](https://cloud.tencent.com/document/product/1223) | 2023-05-18 01:39:20 |
142
- | mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2023-08-30 01:19:09 |
142
+ | mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2023-10-18 02:23:34 |
143
143
  | mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2023-09-15 02:08:53 |
144
- | monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2023-10-12 02:16:26 |
144
+ | monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2023-10-18 02:24:32 |
145
145
  | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2023-10-11 02:08:20 |
146
146
  | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2023-09-13 02:09:08 |
147
- | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2023-08-30 01:19:55 |
147
+ | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2023-10-17 01:22:38 |
148
148
  | msp | [迁移服务平台](https://cloud.tencent.com/document/product/659) | 2023-08-17 04:18:22 |
149
149
  | mvj | [营销价值判断](https://cloud.tencent.com/document/product) | 2020-03-19 08:11:44 |
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
- | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2023-10-12 02:20:57 |
152
+ | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2023-10-18 02:29:23 |
153
153
  | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2023-10-13 01:21:21 |
154
154
  | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2023-09-18 02:11:06 |
155
155
  | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2023-09-22 02:15:37 |
@@ -165,7 +165,7 @@
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
167
  | scf | [云函数](https://cloud.tencent.com/document/product/583) | 2023-10-16 01:22:37 |
168
- | ses | [邮件推送](https://cloud.tencent.com/document/product/1288) | 2023-10-13 01:22:51 |
168
+ | ses | [邮件推送](https://cloud.tencent.com/document/product/1288) | 2023-10-18 02:37:31 |
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 |
171
171
  | smpn | [营销号码安全](https://cloud.tencent.com/document/product/1127) | 2023-08-17 04:38:34 |
@@ -194,10 +194,10 @@
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-09-22 02:29:25 |
197
+ | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2023-10-18 02:46:59 |
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-16 01:25:24 |
200
+ | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-10-18 02:51:11 |
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
203
  | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-10-11 02:31:17 |
@@ -220,7 +220,7 @@
220
220
  | trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2023-10-09 11:35:49 |
221
221
  | trro | [远程实时操控](https://cloud.tencent.com/document/product/1584) | 2023-07-18 01:53:24 |
222
222
  | trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2023-09-27 10:40:48 |
223
- | tse | [微服务引擎 TSE](https://cloud.tencent.com/document/product/1364) | 2023-10-13 01:27:15 |
223
+ | tse | [微服务引擎 TSE](https://cloud.tencent.com/document/product/1364) | 2023-10-17 01:29:39 |
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 |
226
226
  | tts | [语音合成](https://cloud.tencent.com/document/product/1073) | 2023-09-19 01:29:02 |
@@ -230,9 +230,9 @@
230
230
  | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-10-09 01:26:55 |
231
231
  | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-10-12 02:55:40 |
232
232
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-07-18 01:58:58 |
233
- | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-10-13 01:29:06 |
233
+ | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-10-17 01:32: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-16 01:29:53 |
235
+ | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-10-18 03:15:04 |
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 |
@@ -269,8 +269,10 @@ export class Client extends TencentCloudCommon.AbstractClient {
269
269
  }
270
270
 
271
271
  /**
272
- * 接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,请联系客户经理申请使用
273
- */
272
+ * 接口(ChannelCreateFlowByFiles)用PDF文件创建签署流程。
273
+
274
+ 注: `此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。`
275
+ */
274
276
  async ChannelCreateFlowByFiles(
275
277
  req: ChannelCreateFlowByFilesRequest,
276
278
  cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void
@@ -677,7 +679,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
677
679
  }
678
680
 
679
681
  /**
680
- * 对流程的合同文件进行数字签名验证,判断文件是否被篡改。
682
+ * 对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
681
683
  */
682
684
  async ChannelVerifyPdf(
683
685
  req: ChannelVerifyPdfRequest,
@@ -158,13 +158,7 @@ ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
158
158
  2 FontSize: 范围12-72
159
159
  3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
160
160
  4 FontColor:字符串类型,格式为RGB颜色数字
161
- 参数样例: "ComponentExtra": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
162
-
163
- TEXT/MULTI_LINE_TEXT控件可以指定
164
- 1 Font:目前只支持黑体、宋体
165
- 2 FontSize: 范围12-72
166
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
167
- 例如:{"FontSize":12}
161
+ 参数样例:{\"FontColor\":\"255,0,0\",\"FontSize\":12}
168
162
 
169
163
  ComponentType为FILL_IMAGE时,支持以下参数:
170
164
  NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
@@ -1279,62 +1273,105 @@ export interface ChannelCreateConvertTaskApiRequest {
1279
1273
  */
1280
1274
  export interface ChannelCreateFlowByFilesRequest {
1281
1275
  /**
1282
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
1276
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1277
+
1278
+ 此接口下面信息必填。
1279
+ <ul>
1280
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1281
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1282
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1283
+ </ul>
1283
1284
  */
1284
1285
  Agent?: Agent
1285
1286
  /**
1286
- * 签署流程名称,长度不超过200个字符
1287
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1287
1288
  */
1288
1289
  FlowName?: string
1289
1290
  /**
1290
- * 签署流程的描述,长度不超过1000个字符
1291
+ * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
1291
1292
  */
1292
1293
  FlowDescription?: string
1293
1294
  /**
1294
- * 签署流程签约方列表,最多不超过50个参与方
1295
+ * 合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo" target="_blank">FlowApproverInfo结构体</a>。
1296
+
1297
+ 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
1295
1298
  */
1296
1299
  FlowApprovers?: Array<FlowApproverInfo>
1297
1300
  /**
1298
- * 签署文件资源Id列表,目前仅支持单个文件
1301
+ * 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
1302
+
1303
+ 注: `目前,此接口仅支持单个文件发起。`
1299
1304
  */
1300
1305
  FileIds?: Array<string>
1301
1306
  /**
1302
- * 签署文件中的发起方的填写控件,需要在发起的时候进行填充
1307
+ * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
1308
+ <ul><li>单行文本控件</li>
1309
+ <li>多行文本控件</li>
1310
+ <li>勾选框控件</li>
1311
+ <li>数字控件</li>
1312
+ <li>图片控件</li>
1313
+ <li>数据表格等填写控件</li></ul>
1303
1314
  */
1304
1315
  Components?: Array<Component>
1305
1316
  /**
1306
- * 签署流程的签署截止时间。
1307
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
1308
- 不能早于当前时间
1317
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
1318
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
1309
1319
  */
1310
1320
  Deadline?: number
1311
1321
  /**
1312
- * 签署流程回调地址,长度不超过255个字符
1313
- 如果不传递回调地址, 则默认是配置应用号时候使用的回调地址
1322
+ * 执行结果的回调URL,长度不超过255个字符,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。
1323
+ 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
1324
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_data_types" target="_blank">回调通知</a>模块。
1325
+
1326
+ 注:
1327
+ `如果不传递回调地址, 则默认是配置应用号时候使用的回调地址`
1314
1328
  */
1315
1329
  CallbackUrl?: string
1316
1330
  /**
1317
- * 合同签署顺序类型
1318
- true - 无序签,
1319
- false - 顺序签,
1320
- 默认为false,即有序签署。
1321
- 有序签署时以传入FlowApprovers数组的顺序作为签署顺序
1331
+ * 合同流程的签署顺序类型:
1332
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
1333
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
1334
+
1335
+
1336
+ `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
1322
1337
  */
1323
1338
  Unordered?: boolean
1324
1339
  /**
1325
- * 签署流程的类型,长度不超过255个字符
1340
+ * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为255个字符,仅限中文、字母、数字和下划线组成。
1326
1341
  */
1327
1342
  FlowType?: string
1328
1343
  /**
1329
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1344
+ * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
1345
+ <ul><li>{合同名称} </li>
1346
+ <li>{发起方企业} </li>
1347
+ <li>{发起方姓名} </li>
1348
+ <li>{签署方N企业}</li>
1349
+ <li>{签署方N姓名}</li></ul>
1350
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
1351
+
1352
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
1353
+
1354
+ 合同名称:租房合同
1355
+ 发起方:腾讯公司(张三)
1356
+ 签署方:李四
1357
+
1358
+
1330
1359
  */
1331
1360
  CustomShowMap?: string
1332
1361
  /**
1333
- * 业务信息,最大长度1000个字符。
1362
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1000长度。
1363
+
1364
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">回调通知</a>模块。
1334
1365
  */
1335
1366
  CustomerData?: string
1336
1367
  /**
1337
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1368
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
1369
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
1370
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
1371
+ 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
1372
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
1373
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
1374
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
1338
1375
  */
1339
1376
  NeedSignReview?: boolean
1340
1377
  /**
@@ -1345,24 +1382,28 @@ MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverM
1345
1382
  */
1346
1383
  ApproverVerifyType?: string
1347
1384
  /**
1348
- * 标识是否允许发起后添加控件。
1349
- 0为不允许
1350
- 1为允许。
1351
- 如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
1385
+ * 签署方签署控件(印章/签名等)的生成方式:
1386
+ <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
1387
+ <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
1388
+
1389
+ 注:
1390
+ `发起后添加控件功能不支持添加签批控件`
1352
1391
  */
1353
1392
  SignBeanTag?: number
1354
1393
  /**
1355
- * 被抄送人信息列表
1394
+ * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
1356
1395
  */
1357
1396
  CcInfos?: Array<CcInfo>
1358
1397
  /**
1359
- * 给关注人发送短信通知的类型,
1360
- 0-合同发起时通知
1361
- 1-签署完成后通知
1398
+ * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
1399
+ <ul><li> **0**:合同发起时通知(默认值)</li>
1400
+ <li> **1**:签署完成后通知</li></ul>
1362
1401
  */
1363
1402
  CcNotifyType?: number
1364
1403
  /**
1365
- * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1404
+ * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
1405
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
1406
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
1366
1407
  */
1367
1408
  AutoSignScene?: string
1368
1409
  /**
@@ -1972,11 +2013,13 @@ export interface StaffRole {
1972
2013
  */
1973
2014
  export interface ChannelVerifyPdfRequest {
1974
2015
  /**
1975
- * 流程ID
2016
+ * 合同流程ID,为32位字符串。
2017
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
1976
2018
  */
1977
2019
  FlowId: string
1978
2020
  /**
1979
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
2021
+ * 代理企业和员工的信息。
2022
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1980
2023
  */
1981
2024
  Agent?: Agent
1982
2025
  /**
@@ -2176,13 +2219,32 @@ export interface ComponentLimit {
2176
2219
  */
2177
2220
  export interface ChannelVerifyPdfResponse {
2178
2221
  /**
2179
- * 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
2222
+ * 验签结果代码,代码的含义如下:
2223
+
2224
+ <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
2225
+ <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
2226
+ <li>**3**:文件被篡改。</li>
2227
+ <li>**4**:异常:文件内没有签名域。</li>
2228
+ <li>**5**:异常:文件签名格式错误。</li></ul>
2180
2229
  */
2181
2230
  VerifyResult?: number
2182
2231
  /**
2183
- * 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
2232
+ * 验签结果详情,每个签名域对应的验签结果。状态值如下
2233
+ <ul><li> **1** :验签成功,在电子签签署</li>
2234
+ <li> **2** :验签成功,在其他平台签署</li>
2235
+ <li> **3** :验签失败</li>
2236
+ <li> **4** :pdf文件没有签名域</li>
2237
+ <li> **5** :文件签名格式错误</li></ul>
2184
2238
  */
2185
2239
  PdfVerifyResults?: Array<PdfVerifyResult>
2240
+ /**
2241
+ * 验签序列号, 为11为数组组成的字符串
2242
+ */
2243
+ VerifySerialNo?: string
2244
+ /**
2245
+ * 合同文件MD5哈希值
2246
+ */
2247
+ PdfResourceMd5?: string
2186
2248
  /**
2187
2249
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2188
2250
  */
@@ -3574,67 +3636,82 @@ export interface SignQrCode {
3574
3636
  其中签署方FlowApproverInfo需要传递的参数
3575
3637
  非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。
3576
3638
 
3577
- 其他身份标识
3639
+ 其他身份标识,注:`如果发起的是动态签署方(即ApproverOption.FillType指定为1),可以不指定具体签署人信息`
3578
3640
 
3579
3641
  <ul><li>1-个人:Name、Mobile必传</li>
3580
3642
  <li>2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;</li>
3581
3643
  <li>3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;</li>
3582
- <li>4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。</li></ul>
3644
+ <li>4-非第三方平台子客企业(平台企业):Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。</li></ul>
3583
3645
 
3584
3646
  RecipientId参数:
3585
3647
  从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。
3586
3648
  */
3587
3649
  export interface FlowApproverInfo {
3588
3650
  /**
3589
- * 签署人姓名,最大长度50个字符
3651
+ * 签署方经办人的姓名。
3652
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
3590
3653
  */
3591
3654
  Name?: string
3592
3655
  /**
3593
- * 签署人的证件类型
3594
- 1.ID_CARD 居民身份证
3595
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
3596
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
3597
- 4.OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
3656
+ * 签署方经办人的证件类型,支持以下类型
3657
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
3658
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
3659
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
3660
+ <li>OTHER_CARD_TYPE : 其他证件</li></ul>
3661
+
3662
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
3598
3663
  */
3599
3664
  IdCardType?: string
3600
3665
  /**
3601
- * 签署人证件号(长度不超过18位)
3666
+ * 签署方经办人的证件号码,应符合以下规则
3667
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
3668
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
3669
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
3602
3670
  */
3603
3671
  IdCardNumber?: string
3604
3672
  /**
3605
- * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
3673
+ * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符), 不支持海外手机号。
3674
+ 请确认手机号所有方为此合同签署方。
3606
3675
  */
3607
3676
  Mobile?: string
3608
3677
  /**
3609
- * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
3678
+ * 组织机构名称。
3679
+ 请确认该名称与企业营业执照中注册的名称一致。
3680
+ 如果名称中包含英文括号(),请使用中文括号()代替。
3610
3681
  */
3611
3682
  OrganizationName?: string
3612
3683
  /**
3613
- * 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
3614
- 默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
3684
+ * 指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。
3685
+ <ul>
3686
+ <li>false: 默认值,第三方平台子客企业下员工</li>
3687
+ <li>true: SaaS平台企业下的员工</li>
3688
+ </ul>
3689
+
3615
3690
  */
3616
3691
  NotChannelOrganization?: boolean
3617
3692
  /**
3618
- * 用户侧第三方id,最大长度64个字符
3693
+ * 第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成
3694
+
3619
3695
  当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
3620
3696
  */
3621
3697
  OpenId?: string
3622
3698
  /**
3623
- * 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
3699
+ * 同应用下第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样,签署方为非发起方企业场景下必传,最大长度64个字符
3624
3700
  */
3625
3701
  OrganizationOpenId?: string
3626
3702
  /**
3627
- * 签署人类型
3628
- PERSON-个人/自然人;
3629
- PERSON_AUTO_SIGN-个人自动签署,适用于个人自动签场景
3630
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
3631
- ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
3632
- ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的本方企业自动签)
3703
+ * 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
3704
+ <ul><li> **PERSON** :个人/自然人</li>
3705
+ <li> **PERSON_AUTO_SIGN** :个人/自然人自动签署,适用于个人自动签场景</li>
3706
+ <li> **ORGANIZATION** :企业/企业员工(企业签署方或模板发起时的企业静默签)</li>
3707
+ <li> **ENTERPRISESERVER** :企业/企业员自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul>
3633
3708
 
3634
- 若要实现他方企业(同一应用下)自动签,需要满足3个条件:
3635
- 条件1:ApproverType 设置为ENTERPRISESERVER
3636
- 条件2:子客之间完成授权
3637
- 条件3:联系对接的客户经理沟通
3709
+ 注:
3710
+ `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。`
3711
+ `2. 若要实现他方企业(同一应用下)自动签,需要满足3个条件:`
3712
+ <ul><li>条件1:ApproverType 设置为ENTERPRISESERVER</li>
3713
+ <li>条件2:子客之间完成授权</li>
3714
+ <li>条件3:联系对接的客户经理沟通如何使用</li></ul>
3638
3715
  */
3639
3716
  ApproverType?: string
3640
3717
  /**
@@ -3642,7 +3719,8 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3642
3719
  */
3643
3720
  RecipientId?: string
3644
3721
  /**
3645
- * 签署截止时间戳,默认一年
3722
+ * 本签署人在此合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
3723
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3646
3724
  */
3647
3725
  Deadline?: number
3648
3726
  /**
@@ -3663,7 +3741,14 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3663
3741
  */
3664
3742
  ComponentLimitType?: Array<string>
3665
3743
  /**
3666
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
3744
+ * 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
3745
+
3746
+ 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
3747
+ <ul>
3748
+ <li>合同页数少于等于2页,阅读时间为3秒;</li>
3749
+ <li>合同页数为3到5页,阅读时间为5秒;</li>
3750
+ <li>合同页数大于等于6页,阅读时间为10秒。</li>
3751
+ </ul>
3667
3752
  */
3668
3753
  PreReadTime?: number
3669
3754
  /**
@@ -3671,7 +3756,8 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3671
3756
  */
3672
3757
  JumpUrl?: string
3673
3758
  /**
3674
- * 签署人个性化能力值
3759
+ * 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
3760
+ 详细操作可以参考开发者中心的ApproverOption结构体。
3675
3761
  */
3676
3762
  ApproverOption?: ApproverOption
3677
3763
  /**
@@ -3696,8 +3782,11 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3696
3782
  */
3697
3783
  SignId?: string
3698
3784
  /**
3699
- * SMS: 短信(需确保“电子签短信通知签署方”功能是开启状态才能生效); NONE: 不发信息
3700
- 默认为SMS(签署方为子客时该字段不生效)
3785
+ * 通知签署方经办人的方式, 有以下途径:
3786
+ <ul><li> **SMS** :(默认)短信</li>
3787
+ <li> **NONE** : 不通知</li></ul>
3788
+
3789
+ 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
3701
3790
  */
3702
3791
  NotifyType?: string
3703
3792
  /**
@@ -3707,7 +3796,7 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3707
3796
  */
3708
3797
  AddSignComponentsLimits?: Array<ComponentLimit>
3709
3798
  /**
3710
- * 自定义签署方角色名称
3799
+ * 自定义签署人角色名,如收款人、开具人、见证人等
3711
3800
  */
3712
3801
  ApproverRoleName?: string
3713
3802
  }
@@ -4292,6 +4381,8 @@ export interface PrepareFlowsRequest {
4292
4381
  export interface ApproverItem {
4293
4382
  /**
4294
4383
  * 签署方唯一编号
4384
+
4385
+ 在动态签署人场景下,可以用此编号确定参与方
4295
4386
  注意:此字段可能返回 null,表示取不到有效值。
4296
4387
  */
4297
4388
  SignId?: string