tencentcloud-sdk-nodejs-essbasic 4.0.714 → 4.0.716

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.
@@ -172,9 +172,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
172
172
  */
173
173
  DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
174
174
  /**
175
- * 撤销签署流程接口,可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。
176
- 注意:
177
- 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
175
+ * 撤销签署流程接口
176
+
177
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
178
+ <ul><li> `可撤回合同状态` :未全部签署完成</li>
179
+ <li> `不撤回合同状态` :已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。</li></ul>
180
+ 注:
181
+ <ul><li>能撤回合同的只能是 `合同的发起人或者发起方企业的超管、法人` </li>
182
+ <li>签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>。</li></ul>
178
183
  */
179
184
  ChannelCancelFlow(req: ChannelCancelFlowRequest, cb?: (error: string, rep: ChannelCancelFlowResponse) => void): Promise<ChannelCancelFlowResponse>;
180
185
  /**
@@ -283,49 +288,60 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
283
288
  */
284
289
  DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
285
290
  /**
286
- * 创建跳转小程序查看或签署的链接。
287
-
288
- 跳转小程序的几种方式:主要是设置不同的EndPoint
289
- 1. 通过链接Url直接跳转到小程序,不需要返回
290
- 设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
291
+ * 创建跳转小程序查看或签署的链接
291
292
 
292
- 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
293
- 设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
294
-
295
- 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
296
- 跳转到小程序的实现,参考官方文档
297
- https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
298
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
299
- 使用CreateSignUrls,设置EndPoint为APP,得到path。
300
-
301
- 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
302
- 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
303
- 全屏方式:
304
- (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html )
305
- 半屏方式:
306
- (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html )
307
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
308
- 使用CreateSignUrls,设置EndPoint为APP,得到path。
309
-
310
- 其中小程序的原始Id如下,或者查看小程序信息自助获取。
293
+ **腾讯电子签小程序的的AppID 和 原始Id如下:**
311
294
 
312
295
  | 小程序 | AppID | 原始ID |
313
296
  | ------------ | ------------ | ------------ |
314
297
  | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
315
298
  | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
299
+
300
+ **主要使用场景可以更加EndPoint分类如下**
301
+
302
+ |EndPoint| 场景| 说明和示例|
303
+ | ---- | ---- | --- |
304
+ | WEIXINAPP | 短链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
305
+ | LONGURL2WEIXINAPP | 长链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
306
+ | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
307
+ |APP| 贵方APP跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
308
+ |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
316
309
  */
317
310
  CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
318
311
  /**
319
- * 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客控制台的唯一入口。
320
- 链接访问后,会根据企业的和员工的状态(企业根据ProxyOrganizationOpenId参数,员工根据OpenId参数判断),进入不同的流程,主要情况分类如下:
321
- 1. 若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。
322
- 2. 若子客企业已激活,员工未激活,则会进入经办人激活流程。
323
- 3. 若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
312
+ * 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。
324
313
 
314
+ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:
315
+ <table>
316
+ <thead>
317
+ <tr>
318
+ <th>子客企业状态</th>
319
+ <th>子客企业员工状态</th>
320
+ <th>点击链接进入的流程</th>
321
+ </tr>
322
+ </thead>
323
+ <tbody>
324
+ <tr>
325
+ <td>企业未激活</td>
326
+ <td>员工未认证</td>
327
+ <td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>
328
+ </tr>
329
+ <tr>
330
+ <td>企业已激活</td>
331
+ <td>员工未认证</td>
332
+ <td>进入员认证并加入企业流程</td>
333
+ </tr>
334
+ <tr>
335
+ <td>企业已激活</td>
336
+ <td>员工已认证</td>
337
+ <td>进入子客企业Web控制台</td>
338
+ </tr>
339
+ </tbody>
340
+ </table>
325
341
  如果是企业激活流程,需要注意如下情况:
326
342
 
327
- 1. 若在激活过程中,更换用户OpenID重新生成链接,之前的认证会被清理。因此不要在认证过程中多人同时操作,导致认证过程互相影响。
328
- 2. 若您认证中发现信息有误需要重新认证,可以通过更换OpenID重新生成链接的方式,来清理掉已有的流程。
343
+ 1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。
344
+ 2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。
329
345
  */
330
346
  CreateConsoleLoginUrl(req: CreateConsoleLoginUrlRequest, cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void): Promise<CreateConsoleLoginUrlResponse>;
331
347
  /**
@@ -457,9 +473,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
457
473
  */
458
474
  PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
459
475
  /**
460
- * 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
461
- 当前接口限制最多合同(流程)50个.
462
- 返回的链接只能使用一次
476
+ * 此接口(GetDownloadFlowUrl)用户获取合同控制台下载页面链接, 点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击**下载**按钮后就会下载传入的合同列表, 下载页面如下图
477
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_GetDownloadFlowUrl.png)
478
+
479
+ 注:
480
+ <ul>
481
+ <li>仅支持下载 **本企业** 下合同,链接会 **登录企业控制台** </li>
482
+ <li> **链接仅可使用一次**,不可重复使用</li>
483
+ </ul>
463
484
  */
464
485
  GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
465
486
  /**
@@ -477,8 +498,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
477
498
  */
478
499
  ChannelDescribeRoles(req: ChannelDescribeRolesRequest, cb?: (error: string, rep: ChannelDescribeRolesResponse) => void): Promise<ChannelDescribeRolesResponse>;
479
500
  /**
480
- * 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。
481
- 此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
501
+ * 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同
502
+
503
+ **注意**:
504
+ 有两种开通权限的途径
505
+
506
+ **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
507
+ 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
508
+
509
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows2.png)
510
+
511
+ **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
512
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows_appilications2.png)
482
513
  */
483
514
  DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
484
515
  /**
@@ -490,12 +521,19 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
490
521
  */
491
522
  ChannelCancelUserAutoSignEnableUrl(req: ChannelCancelUserAutoSignEnableUrlRequest, cb?: (error: string, rep: ChannelCancelUserAutoSignEnableUrlResponse) => void): Promise<ChannelCancelUserAutoSignEnableUrlResponse>;
492
523
  /**
493
- * 此接口(UploadFiles)用于文件上传。
494
- 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。
495
- 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。
496
- 代码示例:
524
+ * 此接口(UploadFiles)文件上传。<br/>
525
+
526
+ 适用场景:用于合同,印章的文件上传。文件上传以后,
527
+ 如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
528
+ 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
529
+
530
+ 注:
531
+ 1. `图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下`
532
+ 2. `联调开发环境调用时需要设置Domain接口请求域名为 file.test.ess.tencent.cn,正式环境需要设置为file.ess.tencent.cn,代码示例`
533
+ ```
497
534
  HttpProfile httpProfile = new HttpProfile();
498
535
  httpProfile.setEndpoint("file.test.ess.tencent.cn");
536
+ ```
499
537
  */
500
538
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
501
539
  /**
@@ -215,9 +215,14 @@ class Client extends TencentCloudCommon.AbstractClient {
215
215
  return this.request("DescribeUsage", req, cb);
216
216
  }
217
217
  /**
218
- * 撤销签署流程接口,可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。
219
- 注意:
220
- 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
218
+ * 撤销签署流程接口
219
+
220
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
221
+ <ul><li> `可撤回合同状态` :未全部签署完成</li>
222
+ <li> `不撤回合同状态` :已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。</li></ul>
223
+ 注:
224
+ <ul><li>能撤回合同的只能是 `合同的发起人或者发起方企业的超管、法人` </li>
225
+ <li>签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>。</li></ul>
221
226
  */
222
227
  async ChannelCancelFlow(req, cb) {
223
228
  return this.request("ChannelCancelFlow", req, cb);
@@ -344,51 +349,62 @@ class Client extends TencentCloudCommon.AbstractClient {
344
349
  return this.request("DescribeTemplates", req, cb);
345
350
  }
346
351
  /**
347
- * 创建跳转小程序查看或签署的链接。
348
-
349
- 跳转小程序的几种方式:主要是设置不同的EndPoint
350
- 1. 通过链接Url直接跳转到小程序,不需要返回
351
- 设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
352
+ * 创建跳转小程序查看或签署的链接
352
353
 
353
- 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
354
- 设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
355
-
356
- 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
357
- 跳转到小程序的实现,参考官方文档
358
- https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
359
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
360
- 使用CreateSignUrls,设置EndPoint为APP,得到path。
361
-
362
- 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
363
- 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
364
- 全屏方式:
365
- (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html )
366
- 半屏方式:
367
- (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html )
368
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
369
- 使用CreateSignUrls,设置EndPoint为APP,得到path。
370
-
371
- 其中小程序的原始Id如下,或者查看小程序信息自助获取。
354
+ **腾讯电子签小程序的的AppID 和 原始Id如下:**
372
355
 
373
356
  | 小程序 | AppID | 原始ID |
374
357
  | ------------ | ------------ | ------------ |
375
358
  | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
376
359
  | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
360
+
361
+ **主要使用场景可以更加EndPoint分类如下**
362
+
363
+ |EndPoint| 场景| 说明和示例|
364
+ | ---- | ---- | --- |
365
+ | WEIXINAPP | 短链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
366
+ | LONGURL2WEIXINAPP | 长链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
367
+ | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
368
+ |APP| 贵方APP跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
369
+ |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
377
370
  */
378
371
  async CreateSignUrls(req, cb) {
379
372
  return this.request("CreateSignUrls", req, cb);
380
373
  }
381
374
  /**
382
- * 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客控制台的唯一入口。
383
- 链接访问后,会根据企业的和员工的状态(企业根据ProxyOrganizationOpenId参数,员工根据OpenId参数判断),进入不同的流程,主要情况分类如下:
384
- 1. 若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。
385
- 2. 若子客企业已激活,员工未激活,则会进入经办人激活流程。
386
- 3. 若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
375
+ * 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。
387
376
 
377
+ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:
378
+ <table>
379
+ <thead>
380
+ <tr>
381
+ <th>子客企业状态</th>
382
+ <th>子客企业员工状态</th>
383
+ <th>点击链接进入的流程</th>
384
+ </tr>
385
+ </thead>
386
+ <tbody>
387
+ <tr>
388
+ <td>企业未激活</td>
389
+ <td>员工未认证</td>
390
+ <td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>
391
+ </tr>
392
+ <tr>
393
+ <td>企业已激活</td>
394
+ <td>员工未认证</td>
395
+ <td>进入员认证并加入企业流程</td>
396
+ </tr>
397
+ <tr>
398
+ <td>企业已激活</td>
399
+ <td>员工已认证</td>
400
+ <td>进入子客企业Web控制台</td>
401
+ </tr>
402
+ </tbody>
403
+ </table>
388
404
  如果是企业激活流程,需要注意如下情况:
389
405
 
390
- 1. 若在激活过程中,更换用户OpenID重新生成链接,之前的认证会被清理。因此不要在认证过程中多人同时操作,导致认证过程互相影响。
391
- 2. 若您认证中发现信息有误需要重新认证,可以通过更换OpenID重新生成链接的方式,来清理掉已有的流程。
406
+ 1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。
407
+ 2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。
392
408
  */
393
409
  async CreateConsoleLoginUrl(req, cb) {
394
410
  return this.request("CreateConsoleLoginUrl", req, cb);
@@ -558,9 +574,14 @@ class Client extends TencentCloudCommon.AbstractClient {
558
574
  return this.request("PrepareFlows", req, cb);
559
575
  }
560
576
  /**
561
- * 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
562
- 当前接口限制最多合同(流程)50个.
563
- 返回的链接只能使用一次
577
+ * 此接口(GetDownloadFlowUrl)用户获取合同控制台下载页面链接, 点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击**下载**按钮后就会下载传入的合同列表, 下载页面如下图
578
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_GetDownloadFlowUrl.png)
579
+
580
+ 注:
581
+ <ul>
582
+ <li>仅支持下载 **本企业** 下合同,链接会 **登录企业控制台** </li>
583
+ <li> **链接仅可使用一次**,不可重复使用</li>
584
+ </ul>
564
585
  */
565
586
  async GetDownloadFlowUrl(req, cb) {
566
587
  return this.request("GetDownloadFlowUrl", req, cb);
@@ -584,8 +605,18 @@ class Client extends TencentCloudCommon.AbstractClient {
584
605
  return this.request("ChannelDescribeRoles", req, cb);
585
606
  }
586
607
  /**
587
- * 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。
588
- 此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
608
+ * 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同
609
+
610
+ **注意**:
611
+ 有两种开通权限的途径
612
+
613
+ **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
614
+ 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
615
+
616
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows2.png)
617
+
618
+ **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
619
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows_appilications2.png)
589
620
  */
590
621
  async DescribeResourceUrlsByFlows(req, cb) {
591
622
  return this.request("DescribeResourceUrlsByFlows", req, cb);
@@ -603,12 +634,19 @@ class Client extends TencentCloudCommon.AbstractClient {
603
634
  return this.request("ChannelCancelUserAutoSignEnableUrl", req, cb);
604
635
  }
605
636
  /**
606
- * 此接口(UploadFiles)用于文件上传。
607
- 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。
608
- 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。
609
- 代码示例:
637
+ * 此接口(UploadFiles)文件上传。<br/>
638
+
639
+ 适用场景:用于合同,印章的文件上传。文件上传以后,
640
+ 如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
641
+ 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
642
+
643
+ 注:
644
+ 1. `图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下`
645
+ 2. `联调开发环境调用时需要设置Domain接口请求域名为 file.test.ess.tencent.cn,正式环境需要设置为file.ess.tencent.cn,代码示例`
646
+ ```
610
647
  HttpProfile httpProfile = new HttpProfile();
611
648
  httpProfile.setEndpoint("file.test.ess.tencent.cn");
649
+ ```
612
650
  */
613
651
  async UploadFiles(req, cb) {
614
652
  return this.request("UploadFiles", req, cb);