tencentcloud-sdk-nodejs-essbasic 4.0.463 → 4.0.464
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/CHANGELOG.md +491 -0
- package/SERVICE_CHANGELOG.md +828 -72
- package/package.json +1 -1
- package/products.md +15 -15
- package/src/services/essbasic/v20210526/essbasic_client.ts +24 -7
- package/src/services/essbasic/v20210526/essbasic_models.ts +38 -12
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +24 -7
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +24 -7
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +37 -12
package/package.json
CHANGED
package/products.md
CHANGED
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
| billing | [计费相关](https://cloud.tencent.com/document/product/555) | 2022-08-15 06:09:23 |
|
|
25
25
|
| bizlive | [商业直播](https://cloud.tencent.com/document/product) | 2020-03-10 01:08:07 |
|
|
26
26
|
| bm | [黑石物理服务器1.0](https://cloud.tencent.com/document/product/386) | 2022-08-09 11:50:03 |
|
|
27
|
-
| bma | [品牌经营管家](https://cloud.tencent.com/document/product/1296) | 2022-10-19
|
|
27
|
+
| bma | [品牌经营管家](https://cloud.tencent.com/document/product/1296) | 2022-10-19 17:32:07 |
|
|
28
28
|
| bmeip | [黑石弹性公网IP](https://cloud.tencent.com/document/product/1028) | 2022-04-19 06:04:56 |
|
|
29
29
|
| bmlb | [黑石负载均衡](https://cloud.tencent.com/document/product/1027) | 2022-04-04 06:09:37 |
|
|
30
30
|
| bmvpc | [黑石私有网络](https://cloud.tencent.com/document/product/1024) | 2022-04-15 06:02:36 |
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
| cii | [智能保险助手](https://cloud.tencent.com/document/product/1368) | 2022-06-27 06:06:02 |
|
|
52
52
|
| cim | [](https://cloud.tencent.com/document/product) | 2019-05-16 17:21:18 |
|
|
53
53
|
| cis | [](https://cloud.tencent.com/document/product) | 2018-06-07 15:01:42 |
|
|
54
|
-
| ckafka | [消息队列 Ckafka](https://cloud.tencent.com/document/product/597) | 2022-10-
|
|
54
|
+
| ckafka | [消息队列 Ckafka](https://cloud.tencent.com/document/product/597) | 2022-10-20 06:14:29 |
|
|
55
55
|
| clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2022-09-22 06:16:46 |
|
|
56
56
|
| cloudaudit | [云审计](https://cloud.tencent.com/document/product/629) | 2022-07-08 06:05:30 |
|
|
57
57
|
| cloudhsm | [云加密机](https://cloud.tencent.com/document/product/639) | 2022-06-22 06:04:38 |
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
| cme | [多媒体创作引擎](https://cloud.tencent.com/document/product/1156) | 2022-08-24 06:19:05 |
|
|
61
61
|
| cmq | [消息队列 CMQ](https://cloud.tencent.com/document/product/406) | 2022-10-17 06:17:26 |
|
|
62
62
|
| cms | [内容安全](https://cloud.tencent.com/document/product) | 2020-10-29 08:03:08 |
|
|
63
|
-
| cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2022-10-
|
|
63
|
+
| cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2022-10-20 06:16:38 |
|
|
64
64
|
| cr | [金融联络机器人](https://cloud.tencent.com/document/product/656) | 2021-02-24 08:03:24 |
|
|
65
65
|
| cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2022-10-12 06:23:14 |
|
|
66
66
|
| cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2022-10-14 06:21:52 |
|
|
@@ -88,8 +88,8 @@
|
|
|
88
88
|
| eis | [企业集成服务](https://cloud.tencent.com/document/product/1270) | 2022-08-16 06:23:41 |
|
|
89
89
|
| emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2022-09-06 06:30:34 |
|
|
90
90
|
| es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2022-09-28 06:30:23 |
|
|
91
|
-
| ess | [电子签服务](https://cloud.tencent.com/document/product/1323) | 2022-
|
|
92
|
-
| essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2022-10-19
|
|
91
|
+
| ess | [电子签服务](https://cloud.tencent.com/document/product/1323) | 2022-10-20 06:24:19 |
|
|
92
|
+
| essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2022-10-19 20:26:32 |
|
|
93
93
|
| facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2022-06-15 06:09:10 |
|
|
94
94
|
| faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2022-10-17 06:26:28 |
|
|
95
95
|
| fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2022-04-04 06:43:06 |
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
| kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2022-08-05 06:26:44 |
|
|
120
120
|
| lcic | [低代码互动课堂](https://cloud.tencent.com/document/product/1639) | 2022-10-19 06:31:50 |
|
|
121
121
|
| lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2022-09-14 06:27:13 |
|
|
122
|
-
| live | [云直播](https://cloud.tencent.com/document/product/267) | 2022-
|
|
122
|
+
| live | [云直播](https://cloud.tencent.com/document/product/267) | 2022-10-20 06:30:31 |
|
|
123
123
|
| lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 |
|
|
124
124
|
| lp | [登录保护](https://cloud.tencent.com/document/product/1190) | 2022-04-04 06:56:52 |
|
|
125
125
|
| mariadb | [云数据库 MariaDB](https://cloud.tencent.com/document/product/237) | 2022-10-13 06:35:29 |
|
|
@@ -144,7 +144,7 @@
|
|
|
144
144
|
| pds | [私域安全](https://cloud.tencent.com/document/product/1473) | 2022-04-04 07:02:02 |
|
|
145
145
|
| postgres | [云数据库 PostgreSQL](https://cloud.tencent.com/document/product/409) | 2022-09-23 06:42:05 |
|
|
146
146
|
| privatedns | [私有域解析 Private DNS](https://cloud.tencent.com/document/product/1338) | 2022-09-19 06:43:11 |
|
|
147
|
-
| pts | [云压测](https://cloud.tencent.com/document/product/1484) | 2022-
|
|
147
|
+
| pts | [云压测](https://cloud.tencent.com/document/product/1484) | 2022-10-20 06:35:28 |
|
|
148
148
|
| rce | [全栈式风控引擎](https://cloud.tencent.com/document/product/1343) | 2022-09-23 06:43:17 |
|
|
149
149
|
| redis | [云数据库 Redis](https://cloud.tencent.com/document/product/239) | 2022-10-18 06:44:04 |
|
|
150
150
|
| region | [地域管理系统](https://cloud.tencent.com/document/product/1596) | 2022-07-27 21:10:02 |
|
|
@@ -162,7 +162,7 @@
|
|
|
162
162
|
| ssa | [安全运营中心](https://cloud.tencent.com/document/product/664) | 2022-08-16 06:39:20 |
|
|
163
163
|
| ssl | [证书](https://cloud.tencent.com/document/product/400) | 2022-10-18 06:47:25 |
|
|
164
164
|
| sslpod | [SSL 证书监控](https://cloud.tencent.com/document/product/1084) | 2022-04-04 07:07:55 |
|
|
165
|
-
| ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2022-
|
|
165
|
+
| ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2022-10-20 06:38:33 |
|
|
166
166
|
| sts | [安全凭证服务](https://cloud.tencent.com/document/product/1312) | 2022-07-07 06:15:25 |
|
|
167
167
|
| taf | [流量反欺诈](https://cloud.tencent.com/document/product/1031) | 2022-09-12 06:39:19 |
|
|
168
168
|
| tag | [标签](https://cloud.tencent.com/document/product/651) | 2022-09-05 06:46:56 |
|
|
@@ -177,15 +177,15 @@
|
|
|
177
177
|
| tcbr | [云托管 CloudBase Run](https://cloud.tencent.com/document/product/1243) | 2022-08-23 06:50:39 |
|
|
178
178
|
| tcex | [腾讯云释义](https://cloud.tencent.com/document/product/1266) | 2022-07-21 06:17:29 |
|
|
179
179
|
| tci | [腾讯智学课堂分析](https://cloud.tencent.com/document/product) | 2020-08-24 08:06:03 |
|
|
180
|
-
| tcm | [服务网格](https://cloud.tencent.com/document/product/1261) | 2022-10-
|
|
180
|
+
| tcm | [服务网格](https://cloud.tencent.com/document/product/1261) | 2022-10-20 06:40:11 |
|
|
181
181
|
| tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2022-09-26 06:53:07 |
|
|
182
|
-
| tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2022-
|
|
182
|
+
| tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2022-10-20 06:40:56 |
|
|
183
183
|
| tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2022-10-14 06:51:40 |
|
|
184
184
|
| tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2022-04-04 07:15:50 |
|
|
185
185
|
| tdmq | [分布式消息队列](https://cloud.tencent.com/document/product/1179) | 2022-10-17 06:45:52 |
|
|
186
186
|
| tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2022-10-10 06:42:56 |
|
|
187
187
|
| tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2022-09-28 06:54:52 |
|
|
188
|
-
| teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2022-10-
|
|
188
|
+
| teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2022-10-20 06:52:24 |
|
|
189
189
|
| thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2022-06-02 06:15:03 |
|
|
190
190
|
| tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
|
|
191
191
|
| tic | [腾讯云IaC平台](https://cloud.tencent.com/document/product/1213) | 2022-04-04 07:16:52 |
|
|
@@ -195,12 +195,12 @@
|
|
|
195
195
|
| tiia | [图像分析](https://cloud.tencent.com/document/product/865) | 2022-09-20 06:53:40 |
|
|
196
196
|
| tione | [腾讯云 TI 平台 TI-ONE](https://cloud.tencent.com/document/product/851) | 2022-09-30 07:00:21 |
|
|
197
197
|
| tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2022-05-17 06:17:19 |
|
|
198
|
-
| tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2022-10-
|
|
198
|
+
| tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2022-10-20 06:54:45 |
|
|
199
199
|
| tkgdq | [腾讯知识图谱数据查询](https://cloud.tencent.com/document/product) | 2020-03-10 00:51:44 |
|
|
200
200
|
| tms | [文本内容安全](https://cloud.tencent.com/document/product/1124) | 2022-04-04 07:18:11 |
|
|
201
201
|
| tmt | [机器翻译](https://cloud.tencent.com/document/product/551) | 2022-08-31 06:55:53 |
|
|
202
|
-
| trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2022-10-
|
|
203
|
-
| trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2022-10-
|
|
202
|
+
| trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2022-10-20 06:56:09 |
|
|
203
|
+
| trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2022-10-19 15:31:57 |
|
|
204
204
|
| tse | [腾讯云微服务引擎](https://cloud.tencent.com/document/product/1364) | 2022-10-12 07:03:55 |
|
|
205
205
|
| tsf | [腾讯微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2022-10-11 07:02:55 |
|
|
206
206
|
| tsw | [腾讯微服务观测平台 TSW](https://cloud.tencent.com/document/product/1311) | 2022-04-04 07:22:40 |
|
|
@@ -212,7 +212,7 @@
|
|
|
212
212
|
| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2022-10-10 06:50:01 |
|
|
213
213
|
| waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2022-09-15 06:49:04 |
|
|
214
214
|
| wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2022-10-12 07:10:28 |
|
|
215
|
-
| wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2022-10-
|
|
215
|
+
| wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2022-10-20 07:01:15 |
|
|
216
216
|
| wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 |
|
|
217
217
|
| yinsuda | [音速达直播音乐版权引擎](https://cloud.tencent.com/document/product/1592) | 2022-09-16 06:52:09 |
|
|
218
218
|
| youmall | [](https://cloud.tencent.com/document/product) | 2019-01-11 11:24:15 |
|
|
@@ -144,7 +144,7 @@ export class Client extends TencentCloudCommon.AbstractClient {
|
|
|
144
144
|
}
|
|
145
145
|
|
|
146
146
|
/**
|
|
147
|
-
* 渠道通过图片为子客代创建印章,图片最大5m
|
|
147
|
+
* 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,请联系运营/客服咨询相关流程
|
|
148
148
|
*/
|
|
149
149
|
async CreateSealByImage(
|
|
150
150
|
req: CreateSealByImageRequest,
|
|
@@ -186,7 +186,7 @@ export class Client extends TencentCloudCommon.AbstractClient {
|
|
|
186
186
|
|
|
187
187
|
/**
|
|
188
188
|
* 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
|
|
189
|
-
|
|
189
|
+
合同发起人必须在电子签已经进行实名。
|
|
190
190
|
*/
|
|
191
191
|
async CreateFlowsByTemplates(
|
|
192
192
|
req: CreateFlowsByTemplatesRequest,
|
|
@@ -196,8 +196,24 @@ export class Client extends TencentCloudCommon.AbstractClient {
|
|
|
196
196
|
}
|
|
197
197
|
|
|
198
198
|
/**
|
|
199
|
-
|
|
200
|
-
|
|
199
|
+
* 创建跳转小程序查看或签署的链接。
|
|
200
|
+
|
|
201
|
+
跳转小程序的几种方式:主要是设置不同的EndPoint
|
|
202
|
+
1. 通过链接Url直接跳转到小程序,不需要返回
|
|
203
|
+
设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
|
|
204
|
+
2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
|
|
205
|
+
设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
|
|
206
|
+
3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
|
|
207
|
+
跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
|
|
208
|
+
全屏方式:
|
|
209
|
+
(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
|
|
210
|
+
半屏方式:
|
|
211
|
+
(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
|
|
212
|
+
其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
|
213
|
+
使用CreateSignUrls,设置EndPoint为APP,得到path。
|
|
214
|
+
4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
|
|
215
|
+
实现方式同App跳小程序。
|
|
216
|
+
*/
|
|
201
217
|
async CreateSignUrls(
|
|
202
218
|
req: CreateSignUrlsRequest,
|
|
203
219
|
cb?: (error: string, rep: CreateSignUrlsResponse) => void
|
|
@@ -210,7 +226,7 @@ export class Client extends TencentCloudCommon.AbstractClient {
|
|
|
210
226
|
若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
|
|
211
227
|
若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
|
|
212
228
|
若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
|
|
213
|
-
|
|
229
|
+
返回的Url仅支持PC端操作。
|
|
214
230
|
*/
|
|
215
231
|
async CreateConsoleLoginUrl(
|
|
216
232
|
req: CreateConsoleLoginUrlRequest,
|
|
@@ -322,8 +338,9 @@ export class Client extends TencentCloudCommon.AbstractClient {
|
|
|
322
338
|
}
|
|
323
339
|
|
|
324
340
|
/**
|
|
325
|
-
|
|
326
|
-
|
|
341
|
+
* 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。
|
|
342
|
+
此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
|
|
343
|
+
*/
|
|
327
344
|
async DescribeResourceUrlsByFlows(
|
|
328
345
|
req: DescribeResourceUrlsByFlowsRequest,
|
|
329
346
|
cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void
|
|
@@ -114,7 +114,17 @@ export interface PdfVerifyResult {
|
|
|
114
114
|
}
|
|
115
115
|
|
|
116
116
|
/**
|
|
117
|
-
*
|
|
117
|
+
* 创建签署流程签署人入参。
|
|
118
|
+
|
|
119
|
+
其中签署方FlowApproverInfo需要传递的参数
|
|
120
|
+
非单C、单B、B2C合同,ApproverType、RecipientId(模版发起合同时)必传,建议都传。其他身份标识
|
|
121
|
+
1-个人:Name、Mobile必传
|
|
122
|
+
2-渠道子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
|
|
123
|
+
3-渠道合作企业不指定经办人:(暂不支持)
|
|
124
|
+
4-非渠道合作企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
|
|
125
|
+
|
|
126
|
+
RecipientId参数:
|
|
127
|
+
从DescribeTemplates接口中,可以得到模版下的签署方Recipient列表,根据模版自定义的Rolename在此结构体中确定其RecipientId
|
|
118
128
|
*/
|
|
119
129
|
export interface FlowApproverInfo {
|
|
120
130
|
/**
|
|
@@ -628,7 +638,7 @@ export interface CreateSignUrlsRequest {
|
|
|
628
638
|
|
|
629
639
|
/**
|
|
630
640
|
* 签署链接生成类型,默认是 "ALL";
|
|
631
|
-
"ALL"
|
|
641
|
+
"ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
|
|
632
642
|
"CHANNEL":渠道合作企业;
|
|
633
643
|
"NOT_CHANNEL":非渠道合作企业;
|
|
634
644
|
"PERSON":个人;
|
|
@@ -713,6 +723,11 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
713
723
|
*/
|
|
714
724
|
QrEffectiveDay?: number
|
|
715
725
|
|
|
726
|
+
/**
|
|
727
|
+
* 限制二维码用户条件
|
|
728
|
+
*/
|
|
729
|
+
Restrictions?: Array<ApproverRestriction>
|
|
730
|
+
|
|
716
731
|
/**
|
|
717
732
|
* 回调地址,最大长度1000个字符
|
|
718
733
|
不传默认使用渠道应用号配置的回调地址
|
|
@@ -721,14 +736,14 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
721
736
|
CallbackUrl?: string
|
|
722
737
|
|
|
723
738
|
/**
|
|
724
|
-
*
|
|
739
|
+
* 用户信息
|
|
725
740
|
*/
|
|
726
|
-
|
|
741
|
+
Operator?: UserInfo
|
|
727
742
|
|
|
728
743
|
/**
|
|
729
|
-
*
|
|
744
|
+
* 限制二维码用户条件(已弃用)
|
|
730
745
|
*/
|
|
731
|
-
|
|
746
|
+
ApproverRestrictions?: ApproverRestriction
|
|
732
747
|
}
|
|
733
748
|
|
|
734
749
|
/**
|
|
@@ -1002,6 +1017,12 @@ PERSON 自然人
|
|
|
1002
1017
|
/**
|
|
1003
1018
|
* 此结构体 (Component) 用于描述控件属性。
|
|
1004
1019
|
|
|
1020
|
+
在通过文件发起合同时,对应的component有三种定位方式
|
|
1021
|
+
1. 绝对定位方式
|
|
1022
|
+
2. 表单域(FIELD)定位方式
|
|
1023
|
+
3. 关键字(KEYWORD)定位方式
|
|
1024
|
+
可以参考官网说明
|
|
1025
|
+
https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
|
|
1005
1026
|
*/
|
|
1006
1027
|
export interface Component {
|
|
1007
1028
|
/**
|
|
@@ -1096,7 +1117,10 @@ KEYWORD - 关键字
|
|
|
1096
1117
|
/**
|
|
1097
1118
|
* 参数控件样式,json格式表述
|
|
1098
1119
|
不同类型的控件会有部分非通用参数
|
|
1099
|
-
TEXT
|
|
1120
|
+
TEXT/MULTI_LINE_TEXT控件可以指定
|
|
1121
|
+
1 Font:目前只支持黑体、宋体
|
|
1122
|
+
2 FontSize: 范围12-72
|
|
1123
|
+
3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
|
|
1100
1124
|
例如:{"FontSize":12}
|
|
1101
1125
|
*/
|
|
1102
1126
|
ComponentExtra?: string
|
|
@@ -1619,12 +1643,14 @@ export interface SyncProxyOrganizationOperatorsRequest {
|
|
|
1619
1643
|
*/
|
|
1620
1644
|
export interface CreateConsoleLoginUrlResponse {
|
|
1621
1645
|
/**
|
|
1622
|
-
|
|
1623
|
-
|
|
1646
|
+
* 子客Web控制台url,此链接5分钟内有效,且只能访问一次。同时需要注意:
|
|
1647
|
+
1. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接);
|
|
1648
|
+
2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
|
|
1649
|
+
*/
|
|
1624
1650
|
ConsoleUrl: string
|
|
1625
1651
|
|
|
1626
1652
|
/**
|
|
1627
|
-
*
|
|
1653
|
+
* 渠道子客企业是否已开通腾讯电子签
|
|
1628
1654
|
*/
|
|
1629
1655
|
IsActivated: boolean
|
|
1630
1656
|
|
|
@@ -1649,7 +1675,7 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
1649
1675
|
FlowInfos: Array<FlowInfo>
|
|
1650
1676
|
|
|
1651
1677
|
/**
|
|
1652
|
-
* 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds
|
|
1678
|
+
* 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls(此Url返回的是PDF文件流 );
|
|
1653
1679
|
预览链接有效期300秒;
|
|
1654
1680
|
*/
|
|
1655
1681
|
NeedPreview?: boolean
|
|
@@ -1887,7 +1913,7 @@ export interface DescribeResourceUrlsByFlowsRequest {
|
|
|
1887
1913
|
Agent: Agent
|
|
1888
1914
|
|
|
1889
1915
|
/**
|
|
1890
|
-
* 查询资源所对应的签署流程Id,最多支持50
|
|
1916
|
+
* 查询资源所对应的签署流程Id,最多支持50个
|
|
1891
1917
|
*/
|
|
1892
1918
|
FlowIds?: Array<string>
|
|
1893
1919
|
|
|
@@ -23,7 +23,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
23
23
|
*/
|
|
24
24
|
ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse>;
|
|
25
25
|
/**
|
|
26
|
-
* 渠道通过图片为子客代创建印章,图片最大5m
|
|
26
|
+
* 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,请联系运营/客服咨询相关流程
|
|
27
27
|
*/
|
|
28
28
|
CreateSealByImage(req: CreateSealByImageRequest, cb?: (error: string, rep: CreateSealByImageResponse) => void): Promise<CreateSealByImageResponse>;
|
|
29
29
|
/**
|
|
@@ -41,19 +41,35 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
41
41
|
DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
|
|
42
42
|
/**
|
|
43
43
|
* 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
|
|
44
|
-
|
|
44
|
+
合同发起人必须在电子签已经进行实名。
|
|
45
45
|
*/
|
|
46
46
|
CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
|
|
47
47
|
/**
|
|
48
|
-
|
|
49
|
-
|
|
48
|
+
* 创建跳转小程序查看或签署的链接。
|
|
49
|
+
|
|
50
|
+
跳转小程序的几种方式:主要是设置不同的EndPoint
|
|
51
|
+
1. 通过链接Url直接跳转到小程序,不需要返回
|
|
52
|
+
设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
|
|
53
|
+
2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
|
|
54
|
+
设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
|
|
55
|
+
3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
|
|
56
|
+
跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
|
|
57
|
+
全屏方式:
|
|
58
|
+
(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
|
|
59
|
+
半屏方式:
|
|
60
|
+
(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
|
|
61
|
+
其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
|
62
|
+
使用CreateSignUrls,设置EndPoint为APP,得到path。
|
|
63
|
+
4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
|
|
64
|
+
实现方式同App跳小程序。
|
|
65
|
+
*/
|
|
50
66
|
CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
|
|
51
67
|
/**
|
|
52
68
|
* 此接口(CreateConsoleLoginUrl)用于创建渠道子客企业控制台Web端登录链接。Web端登录链接是子客控制台的唯一入口。
|
|
53
69
|
若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
|
|
54
70
|
若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
|
|
55
71
|
若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
|
|
56
|
-
|
|
72
|
+
返回的Url仅支持PC端操作。
|
|
57
73
|
*/
|
|
58
74
|
CreateConsoleLoginUrl(req: CreateConsoleLoginUrlRequest, cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void): Promise<CreateConsoleLoginUrlResponse>;
|
|
59
75
|
/**
|
|
@@ -105,8 +121,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
105
121
|
*/
|
|
106
122
|
PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
|
|
107
123
|
/**
|
|
108
|
-
|
|
109
|
-
|
|
124
|
+
* 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。
|
|
125
|
+
此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
|
|
126
|
+
*/
|
|
110
127
|
DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
|
|
111
128
|
/**
|
|
112
129
|
* 通过此接口(DescribeTemplates)查询该子客企业在电子签拥有的的有效模板,不包括渠道模版
|
|
@@ -50,7 +50,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
50
50
|
return this.request("ChannelCreateFlowByFiles", req, cb);
|
|
51
51
|
}
|
|
52
52
|
/**
|
|
53
|
-
* 渠道通过图片为子客代创建印章,图片最大5m
|
|
53
|
+
* 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,请联系运营/客服咨询相关流程
|
|
54
54
|
*/
|
|
55
55
|
async CreateSealByImage(req, cb) {
|
|
56
56
|
return this.request("CreateSealByImage", req, cb);
|
|
@@ -76,14 +76,30 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
76
76
|
}
|
|
77
77
|
/**
|
|
78
78
|
* 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
|
|
79
|
-
|
|
79
|
+
合同发起人必须在电子签已经进行实名。
|
|
80
80
|
*/
|
|
81
81
|
async CreateFlowsByTemplates(req, cb) {
|
|
82
82
|
return this.request("CreateFlowsByTemplates", req, cb);
|
|
83
83
|
}
|
|
84
84
|
/**
|
|
85
|
-
|
|
86
|
-
|
|
85
|
+
* 创建跳转小程序查看或签署的链接。
|
|
86
|
+
|
|
87
|
+
跳转小程序的几种方式:主要是设置不同的EndPoint
|
|
88
|
+
1. 通过链接Url直接跳转到小程序,不需要返回
|
|
89
|
+
设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
|
|
90
|
+
2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
|
|
91
|
+
设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
|
|
92
|
+
3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
|
|
93
|
+
跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
|
|
94
|
+
全屏方式:
|
|
95
|
+
(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
|
|
96
|
+
半屏方式:
|
|
97
|
+
(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
|
|
98
|
+
其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
|
99
|
+
使用CreateSignUrls,设置EndPoint为APP,得到path。
|
|
100
|
+
4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
|
|
101
|
+
实现方式同App跳小程序。
|
|
102
|
+
*/
|
|
87
103
|
async CreateSignUrls(req, cb) {
|
|
88
104
|
return this.request("CreateSignUrls", req, cb);
|
|
89
105
|
}
|
|
@@ -92,7 +108,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
92
108
|
若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
|
|
93
109
|
若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
|
|
94
110
|
若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
|
|
95
|
-
|
|
111
|
+
返回的Url仅支持PC端操作。
|
|
96
112
|
*/
|
|
97
113
|
async CreateConsoleLoginUrl(req, cb) {
|
|
98
114
|
return this.request("CreateConsoleLoginUrl", req, cb);
|
|
@@ -164,8 +180,9 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
164
180
|
return this.request("PrepareFlows", req, cb);
|
|
165
181
|
}
|
|
166
182
|
/**
|
|
167
|
-
|
|
168
|
-
|
|
183
|
+
* 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。
|
|
184
|
+
此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
|
|
185
|
+
*/
|
|
169
186
|
async DescribeResourceUrlsByFlows(req, cb) {
|
|
170
187
|
return this.request("DescribeResourceUrlsByFlows", req, cb);
|
|
171
188
|
}
|
|
@@ -80,7 +80,17 @@ export interface PdfVerifyResult {
|
|
|
80
80
|
ComponentPage: number;
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
|
-
*
|
|
83
|
+
* 创建签署流程签署人入参。
|
|
84
|
+
|
|
85
|
+
其中签署方FlowApproverInfo需要传递的参数
|
|
86
|
+
非单C、单B、B2C合同,ApproverType、RecipientId(模版发起合同时)必传,建议都传。其他身份标识
|
|
87
|
+
1-个人:Name、Mobile必传
|
|
88
|
+
2-渠道子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
|
|
89
|
+
3-渠道合作企业不指定经办人:(暂不支持)
|
|
90
|
+
4-非渠道合作企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
|
|
91
|
+
|
|
92
|
+
RecipientId参数:
|
|
93
|
+
从DescribeTemplates接口中,可以得到模版下的签署方Recipient列表,根据模版自定义的Rolename在此结构体中确定其RecipientId
|
|
84
94
|
*/
|
|
85
95
|
export interface FlowApproverInfo {
|
|
86
96
|
/**
|
|
@@ -512,7 +522,7 @@ export interface CreateSignUrlsRequest {
|
|
|
512
522
|
Endpoint?: string;
|
|
513
523
|
/**
|
|
514
524
|
* 签署链接生成类型,默认是 "ALL";
|
|
515
|
-
"ALL"
|
|
525
|
+
"ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
|
|
516
526
|
"CHANNEL":渠道合作企业;
|
|
517
527
|
"NOT_CHANNEL":非渠道合作企业;
|
|
518
528
|
"PERSON":个人;
|
|
@@ -582,20 +592,24 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
582
592
|
* 二维码有效天数 默认7天 最高设置不超过90天
|
|
583
593
|
*/
|
|
584
594
|
QrEffectiveDay?: number;
|
|
595
|
+
/**
|
|
596
|
+
* 限制二维码用户条件
|
|
597
|
+
*/
|
|
598
|
+
Restrictions?: Array<ApproverRestriction>;
|
|
585
599
|
/**
|
|
586
600
|
* 回调地址,最大长度1000个字符
|
|
587
601
|
不传默认使用渠道应用号配置的回调地址
|
|
588
602
|
回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
|
589
603
|
*/
|
|
590
604
|
CallbackUrl?: string;
|
|
591
|
-
/**
|
|
592
|
-
* 限制二维码用户条件
|
|
593
|
-
*/
|
|
594
|
-
ApproverRestrictions?: ApproverRestriction;
|
|
595
605
|
/**
|
|
596
606
|
* 用户信息
|
|
597
607
|
*/
|
|
598
608
|
Operator?: UserInfo;
|
|
609
|
+
/**
|
|
610
|
+
* 限制二维码用户条件(已弃用)
|
|
611
|
+
*/
|
|
612
|
+
ApproverRestrictions?: ApproverRestriction;
|
|
599
613
|
}
|
|
600
614
|
/**
|
|
601
615
|
* 授权出错信息
|
|
@@ -829,6 +843,12 @@ export interface SignUrlInfo {
|
|
|
829
843
|
/**
|
|
830
844
|
* 此结构体 (Component) 用于描述控件属性。
|
|
831
845
|
|
|
846
|
+
在通过文件发起合同时,对应的component有三种定位方式
|
|
847
|
+
1. 绝对定位方式
|
|
848
|
+
2. 表单域(FIELD)定位方式
|
|
849
|
+
3. 关键字(KEYWORD)定位方式
|
|
850
|
+
可以参考官网说明
|
|
851
|
+
https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
|
|
832
852
|
*/
|
|
833
853
|
export interface Component {
|
|
834
854
|
/**
|
|
@@ -911,7 +931,10 @@ export interface Component {
|
|
|
911
931
|
/**
|
|
912
932
|
* 参数控件样式,json格式表述
|
|
913
933
|
不同类型的控件会有部分非通用参数
|
|
914
|
-
TEXT
|
|
934
|
+
TEXT/MULTI_LINE_TEXT控件可以指定
|
|
935
|
+
1 Font:目前只支持黑体、宋体
|
|
936
|
+
2 FontSize: 范围12-72
|
|
937
|
+
3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
|
|
915
938
|
例如:{"FontSize":12}
|
|
916
939
|
*/
|
|
917
940
|
ComponentExtra?: string;
|
|
@@ -1351,11 +1374,13 @@ export interface SyncProxyOrganizationOperatorsRequest {
|
|
|
1351
1374
|
*/
|
|
1352
1375
|
export interface CreateConsoleLoginUrlResponse {
|
|
1353
1376
|
/**
|
|
1354
|
-
|
|
1355
|
-
|
|
1377
|
+
* 子客Web控制台url,此链接5分钟内有效,且只能访问一次。同时需要注意:
|
|
1378
|
+
1. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接);
|
|
1379
|
+
2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
|
|
1380
|
+
*/
|
|
1356
1381
|
ConsoleUrl: string;
|
|
1357
1382
|
/**
|
|
1358
|
-
*
|
|
1383
|
+
* 渠道子客企业是否已开通腾讯电子签
|
|
1359
1384
|
*/
|
|
1360
1385
|
IsActivated: boolean;
|
|
1361
1386
|
/**
|
|
@@ -1376,7 +1401,7 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
1376
1401
|
*/
|
|
1377
1402
|
FlowInfos: Array<FlowInfo>;
|
|
1378
1403
|
/**
|
|
1379
|
-
* 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds
|
|
1404
|
+
* 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls(此Url返回的是PDF文件流 );
|
|
1380
1405
|
预览链接有效期300秒;
|
|
1381
1406
|
*/
|
|
1382
1407
|
NeedPreview?: boolean;
|
|
@@ -1578,7 +1603,7 @@ export interface DescribeResourceUrlsByFlowsRequest {
|
|
|
1578
1603
|
*/
|
|
1579
1604
|
Agent: Agent;
|
|
1580
1605
|
/**
|
|
1581
|
-
* 查询资源所对应的签署流程Id,最多支持50
|
|
1606
|
+
* 查询资源所对应的签署流程Id,最多支持50个
|
|
1582
1607
|
*/
|
|
1583
1608
|
FlowIds?: Array<string>;
|
|
1584
1609
|
/**
|