tencentcloud-sdk-nodejs 4.0.719 → 4.0.721

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.
Files changed (93) hide show
  1. package/CHANGELOG.md +298 -0
  2. package/SERVICE_CHANGELOG.md +401 -6
  3. package/package.json +1 -1
  4. package/products.md +16 -16
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/btoe/index.ts +2 -2
  7. package/src/services/ccc/v20200210/ccc_models.ts +13 -0
  8. package/src/services/cdb/v20170320/cdb_models.ts +1 -1
  9. package/src/services/csip/v20221121/csip_models.ts +15 -0
  10. package/src/services/dbbrain/index.ts +2 -2
  11. package/src/services/dnspod/v20210323/dnspod_client.ts +97 -48
  12. package/src/services/dnspod/v20210323/dnspod_models.ts +292 -138
  13. package/src/services/drm/v20181115/drm_client.ts +13 -0
  14. package/src/services/drm/v20181115/drm_models.ts +40 -0
  15. package/src/services/dts/index.ts +2 -2
  16. package/src/services/ess/v20201111/ess_client.ts +32 -13
  17. package/src/services/ess/v20201111/ess_models.ts +70 -3
  18. package/src/services/essbasic/index.ts +2 -2
  19. package/src/services/essbasic/v20210526/essbasic_client.ts +162 -114
  20. package/src/services/essbasic/v20210526/essbasic_models.ts +356 -129
  21. package/src/services/facefusion/v20181201/facefusion_models.ts +5 -4
  22. package/src/services/ims/index.ts +2 -2
  23. package/src/services/iotvideo/index.ts +2 -2
  24. package/src/services/sms/index.ts +2 -2
  25. package/src/services/tdmq/v20200217/tdmq_client.ts +54 -16
  26. package/src/services/tdmq/v20200217/tdmq_models.ts +312 -116
  27. package/src/services/tem/index.ts +2 -2
  28. package/src/services/teo/index.ts +2 -2
  29. package/src/services/teo/v20220901/teo_models.ts +1 -1
  30. package/src/services/tione/v20211111/tione_client.ts +1 -0
  31. package/src/services/tione/v20211111/tione_models.ts +30 -9
  32. package/src/services/tms/index.ts +2 -2
  33. package/src/services/tsw/index.ts +2 -2
  34. package/src/services/vm/index.ts +2 -2
  35. package/src/services/vpc/v20170312/vpc_models.ts +11 -5
  36. package/src/services/vrs/v20200824/vrs_models.ts +10 -1
  37. package/src/services/waf/v20180125/waf_client.ts +8 -4
  38. package/tencentcloud/common/sdk_version.d.ts +1 -1
  39. package/tencentcloud/common/sdk_version.js +1 -1
  40. package/tencentcloud/services/btoe/index.d.ts +4 -4
  41. package/tencentcloud/services/btoe/index.js +2 -2
  42. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +13 -0
  43. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +1 -1
  44. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +15 -0
  45. package/tencentcloud/services/dbbrain/index.d.ts +4 -4
  46. package/tencentcloud/services/dbbrain/index.js +2 -2
  47. package/tencentcloud/services/dnspod/v20210323/dnspod_client.d.ts +31 -15
  48. package/tencentcloud/services/dnspod/v20210323/dnspod_client.js +45 -21
  49. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +282 -137
  50. package/tencentcloud/services/drm/v20181115/drm_client.d.ts +6 -1
  51. package/tencentcloud/services/drm/v20181115/drm_client.js +7 -0
  52. package/tencentcloud/services/drm/v20181115/drm_models.d.ts +38 -0
  53. package/tencentcloud/services/dts/index.d.ts +4 -4
  54. package/tencentcloud/services/dts/index.js +2 -2
  55. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +21 -10
  56. package/tencentcloud/services/ess/v20201111/ess_client.js +23 -10
  57. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +68 -3
  58. package/tencentcloud/services/essbasic/index.d.ts +4 -4
  59. package/tencentcloud/services/essbasic/index.js +2 -2
  60. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +132 -92
  61. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +138 -96
  62. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +354 -129
  63. package/tencentcloud/services/facefusion/v20181201/facefusion_models.d.ts +5 -4
  64. package/tencentcloud/services/ims/index.d.ts +4 -4
  65. package/tencentcloud/services/ims/index.js +2 -2
  66. package/tencentcloud/services/iotvideo/index.d.ts +4 -4
  67. package/tencentcloud/services/iotvideo/index.js +2 -2
  68. package/tencentcloud/services/sms/index.d.ts +4 -4
  69. package/tencentcloud/services/sms/index.js +2 -2
  70. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +17 -5
  71. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +23 -5
  72. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +304 -116
  73. package/tencentcloud/services/tem/index.d.ts +4 -4
  74. package/tencentcloud/services/tem/index.js +2 -2
  75. package/tencentcloud/services/teo/index.d.ts +4 -4
  76. package/tencentcloud/services/teo/index.js +2 -2
  77. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +1 -1
  78. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +29 -9
  79. package/tencentcloud/services/tms/index.d.ts +4 -4
  80. package/tencentcloud/services/tms/index.js +2 -2
  81. package/tencentcloud/services/tsw/index.d.ts +4 -4
  82. package/tencentcloud/services/tsw/index.js +2 -2
  83. package/tencentcloud/services/vm/index.d.ts +4 -4
  84. package/tencentcloud/services/vm/index.js +2 -2
  85. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +11 -5
  86. package/tencentcloud/services/vrs/v20200824/vrs_models.d.ts +10 -1
  87. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +6 -2
  88. package/tencentcloud/services/waf/v20180125/waf_client.js +6 -2
  89. package/test/dnspod.v20210323.test.js +60 -20
  90. package/test/drm.v20181115.test.js +10 -0
  91. package/test/ess.v20201111.test.js +12 -2
  92. package/test/essbasic.v20210526.test.js +20 -10
  93. package/test/tdmq.v20200217.test.js +32 -2
@@ -49,6 +49,7 @@ import {
49
49
  StartFlowResponse,
50
50
  SealInfo,
51
51
  StaffRole,
52
+ CreateBatchQuickSignUrlResponse,
52
53
  CreateIntegrationRoleRequest,
53
54
  DeleteIntegrationRoleUsersResponse,
54
55
  CreateConvertTaskApiRequest,
@@ -212,6 +213,7 @@ import {
212
213
  CreateFlowResponse,
213
214
  DescribeUserAutoSignStatusRequest,
214
215
  FilledComponent,
216
+ CreateBatchQuickSignUrlRequest,
215
217
  FileUrl,
216
218
  CreateOrganizationInfoChangeUrlRequest,
217
219
  DescribeOrganizationGroupOrganizationsResponse,
@@ -229,20 +231,20 @@ export class Client extends AbstractClient {
229
231
  }
230
232
 
231
233
  /**
232
- * 获取设置自动签印章小程序链接。
233
-
234
- 注意:
235
- <ul><li>需要<code>企业开通自动签</code>后使用。</li>
236
- <li>仅支持<code>已经开通了自动签的个人</code>更换自动签印章。</li>
237
- <li>链接有效期默认7天,<code>最多30天</code>。</li>
238
- <li>该接口的链接适用于<code>小程序</code>端。</li>
239
- <li>该接口不会扣除您的合同套餐,暂不参与计费。</li></ul>
234
+ * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
235
+ `注意:`<br/>
236
+ `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=1)。` <br/>
237
+ `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
238
+ `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
239
+ `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
240
+ `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
241
+ 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
240
242
  */
241
- async CreateUserAutoSignSealUrl(
242
- req: CreateUserAutoSignSealUrlRequest,
243
- cb?: (error: string, rep: CreateUserAutoSignSealUrlResponse) => void
244
- ): Promise<CreateUserAutoSignSealUrlResponse> {
245
- return this.request("CreateUserAutoSignSealUrl", req, cb)
243
+ async CreateBatchQuickSignUrl(
244
+ req: CreateBatchQuickSignUrlRequest,
245
+ cb?: (error: string, rep: CreateBatchQuickSignUrlResponse) => void
246
+ ): Promise<CreateBatchQuickSignUrlResponse> {
247
+ return this.request("CreateBatchQuickSignUrl", req, cb)
246
248
  }
247
249
 
248
250
  /**
@@ -340,6 +342,23 @@ export class Client extends AbstractClient {
340
342
  return this.request("DescribeFileUrls", req, cb)
341
343
  }
342
344
 
345
+ /**
346
+ * 获取设置自动签印章小程序链接。
347
+
348
+ 注意:
349
+ <ul><li>需要<code>企业开通自动签</code>后使用。</li>
350
+ <li>仅支持<code>已经开通了自动签的个人</code>更换自动签印章。</li>
351
+ <li>链接有效期默认7天,<code>最多30天</code>。</li>
352
+ <li>该接口的链接适用于<code>小程序</code>端。</li>
353
+ <li>该接口不会扣除您的合同套餐,暂不参与计费。</li></ul>
354
+ */
355
+ async CreateUserAutoSignSealUrl(
356
+ req: CreateUserAutoSignSealUrlRequest,
357
+ cb?: (error: string, rep: CreateUserAutoSignSealUrlResponse) => void
358
+ ): Promise<CreateUserAutoSignSealUrlResponse> {
359
+ return this.request("CreateUserAutoSignSealUrl", req, cb)
360
+ }
361
+
343
362
  /**
344
363
  * 获取个人用户自动签的开通链接。
345
364
 
@@ -831,6 +831,20 @@ export interface StaffRole {
831
831
  RoleName?: string
832
832
  }
833
833
 
834
+ /**
835
+ * CreateBatchQuickSignUrl返回参数结构体
836
+ */
837
+ export interface CreateBatchQuickSignUrlResponse {
838
+ /**
839
+ * 签署人签署链接信息
840
+ */
841
+ FlowApproverUrlInfo?: FlowApproverUrlInfo
842
+ /**
843
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
844
+ */
845
+ RequestId?: string
846
+ }
847
+
834
848
  /**
835
849
  * CreateIntegrationRole请求参数结构体
836
850
  */
@@ -3447,7 +3461,7 @@ export interface FlowCreateApprover {
3447
3461
  </li></ul>
3448
3462
  注:
3449
3463
  <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
3450
- <li>此字段不可传多个校验方式</li></ul>
3464
+ <li>此字段可传多个校验方式</li></ul>
3451
3465
 
3452
3466
  `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
3453
3467
 
@@ -4680,7 +4694,9 @@ export interface ApproverInfo {
4680
4694
  */
4681
4695
  ApproverRole?: number
4682
4696
  /**
4683
- * 自定义签署人角色名:收款人、开具人、见证人
4697
+ * 可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。
4698
+
4699
+ 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
4684
4700
  */
4685
4701
  ApproverRoleName?: string
4686
4702
  /**
@@ -4727,7 +4743,7 @@ export interface ApproverInfo {
4727
4743
  </li></ul>
4728
4744
  注:
4729
4745
  <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
4730
- <li>此字段不可传多个校验方式</li></ul>
4746
+ <li>此字段可传多个校验方式</li></ul>
4731
4747
  */
4732
4748
  ApproverVerifyTypes?: Array<number | bigint>
4733
4749
  /**
@@ -6774,6 +6790,57 @@ export interface FilledComponent {
6774
6790
  ImageUrl?: string
6775
6791
  }
6776
6792
 
6793
+ /**
6794
+ * CreateBatchQuickSignUrl请求参数结构体
6795
+ */
6796
+ export interface CreateBatchQuickSignUrlRequest {
6797
+ /**
6798
+ * 批量签署的合同流程ID数组。
6799
+ 注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
6800
+ */
6801
+ FlowIds: Array<string>
6802
+ /**
6803
+ * 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
6804
+ 注:
6805
+ `1. ApproverType目前只支持个人类型的签署人。`
6806
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
6807
+ `3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
6808
+ */
6809
+ FlowApproverInfo: FlowCreateApprover
6810
+ /**
6811
+ * 代理企业和员工的信息。
6812
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6813
+ */
6814
+ Agent?: Agent
6815
+ /**
6816
+ * 执行本接口操作的员工信息。
6817
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6818
+ */
6819
+ Operator?: UserInfo
6820
+ /**
6821
+ * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
6822
+ */
6823
+ JumpUrl?: string
6824
+ /**
6825
+ * 指定批量签署合同的签名类型,可传递以下值:
6826
+ <ul><li>**0**:手写签名(默认)</li>
6827
+ <li>**1**:OCR楷体</li></ul>
6828
+ 注:
6829
+ <ul><li>默认情况下,签名类型为手写签名</li>
6830
+ <li>您可以传递多种值,表示可用多种签名类型。</li></ul>
6831
+ */
6832
+ SignatureTypes?: Array<number | bigint>
6833
+ /**
6834
+ * 指定批量签署合同的认证校验方式,可传递以下值:
6835
+ <ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li>
6836
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
6837
+ 注:
6838
+ <ul><li>默认情况下,认证校验方式为人脸认证</li>
6839
+ <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
6840
+ */
6841
+ ApproverSignTypes?: Array<number | bigint>
6842
+ }
6843
+
6777
6844
  /**
6778
6845
  * 下载文件的URL信息
6779
6846
  */
@@ -1,7 +1,7 @@
1
- import { v20210526 } from "./v20210526"
2
1
  import { v20201222 } from "./v20201222"
2
+ import { v20210526 } from "./v20210526"
3
3
 
4
4
  export const essbasic = {
5
- v20210526: v20210526,
6
5
  v20201222: v20201222,
6
+ v20210526: v20210526,
7
7
  }
@@ -59,6 +59,7 @@ import {
59
59
  ChannelCreateWebThemeConfigRequest,
60
60
  ChannelCreateConvertTaskApiRequest,
61
61
  ChannelCreateFlowByFilesRequest,
62
+ UploadFilesResponse,
62
63
  Agent,
63
64
  ChannelCreatePreparedPersonalEsignResponse,
64
65
  FlowApproverDetail,
@@ -107,6 +108,7 @@ import {
107
108
  ChannelCreateUserAutoSignSealUrlResponse,
108
109
  ApproverComponentLimitType,
109
110
  ResourceUrlInfo,
111
+ ChannelCreateBatchQuickSignUrlRequest,
110
112
  ChannelCreateBoundFlowsRequest,
111
113
  ChannelDescribeEmployeesRequest,
112
114
  AuthorizedUser,
@@ -137,7 +139,7 @@ import {
137
139
  FlowApproverItem,
138
140
  CreateSignUrlsResponse,
139
141
  ChannelDeleteRoleRequest,
140
- UploadFilesResponse,
142
+ ChannelCreateBatchQuickSignUrlResponse,
141
143
  ChannelCreateBatchCancelFlowUrlRequest,
142
144
  ApproverRestriction,
143
145
  PrepareFlowsRequest,
@@ -232,6 +234,42 @@ export class Client extends AbstractClient {
232
234
  return this.request("ChannelCreateFlowSignReview", req, cb)
233
235
  }
234
236
 
237
+ /**
238
+ * 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人。
239
+
240
+ 跳转小程序的几种方式:主要是设置不同的EndPoint
241
+ 1. 通过链接Url直接跳转到小程序,不需要返回
242
+ 设置EndPoint为WEIXINAPP,得到链接打开即可。
243
+
244
+ 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
245
+ 跳转到小程序的实现,参考官方文档
246
+ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
247
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
248
+ 设置EndPoint为APP,得到path。
249
+
250
+ 4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
251
+ 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
252
+ 全屏方式:
253
+ (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
254
+ 半屏方式:
255
+ (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
256
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
257
+ 设置EndPoint为APP,得到path。
258
+
259
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
260
+
261
+ | 小程序 | AppID | 原始ID |
262
+ | ------------ | ------------ | ------------ |
263
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
264
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
265
+ */
266
+ async ModifyExtendedService(
267
+ req: ModifyExtendedServiceRequest,
268
+ cb?: (error: string, rep: ModifyExtendedServiceResponse) => void
269
+ ): Promise<ModifyExtendedServiceResponse> {
270
+ return this.request("ModifyExtendedService", req, cb)
271
+ }
272
+
235
273
  /**
236
274
  * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
237
275
  适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
@@ -383,44 +421,26 @@ export class Client extends AbstractClient {
383
421
  }
384
422
 
385
423
  /**
386
- * 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人。
387
-
388
- 跳转小程序的几种方式:主要是设置不同的EndPoint
389
- 1. 通过链接Url直接跳转到小程序,不需要返回
390
- 设置EndPoint为WEIXINAPP,得到链接打开即可。
391
-
392
- 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
393
- 跳转到小程序的实现,参考官方文档
394
- https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
395
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
396
- 设置EndPoint为APP,得到path。
397
-
398
- 4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
399
- 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
400
- 全屏方式:
401
- (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
402
- 半屏方式:
403
- (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
404
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
405
- 设置EndPoint为APP,得到path。
406
-
407
- 其中小程序的原始Id如下,或者查看小程序信息自助获取。
408
-
409
- | 小程序 | AppID | 原始ID |
410
- | ------------ | ------------ | ------------ |
411
- | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
412
- | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
424
+ * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列。
425
+ 相关系统默认角色说明可参考文档:https://cloud.tencent.com/document/product/1323/61355
413
426
  */
414
- async ModifyExtendedService(
415
- req: ModifyExtendedServiceRequest,
416
- cb?: (error: string, rep: ModifyExtendedServiceResponse) => void
417
- ): Promise<ModifyExtendedServiceResponse> {
418
- return this.request("ModifyExtendedService", req, cb)
427
+ async ChannelDescribeRoles(
428
+ req: ChannelDescribeRolesRequest,
429
+ cb?: (error: string, rep: ChannelDescribeRolesResponse) => void
430
+ ): Promise<ChannelDescribeRolesResponse> {
431
+ return this.request("ChannelDescribeRoles", req, cb)
419
432
  }
420
433
 
421
434
  /**
422
- * 上传了word、excel、图片文件后,通过该接口发起文件转换任务,将wordexcel、图片文件转换为pdf文件。
423
- */
435
+ * 此接口(ChannelCreateConvertTaskApi)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
436
+ 前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
437
+ 适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
438
+ 适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
439
+ 转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
440
+ 注:
441
+ 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
442
+ 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
443
+ */
424
444
  async ChannelCreateConvertTaskApi(
425
445
  req: ChannelCreateConvertTaskApiRequest,
426
446
  cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void
@@ -443,11 +463,13 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
443
463
  * 撤销签署流程接口
444
464
 
445
465
  适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
446
- <ul><li> `可撤回合同状态` :未全部签署完成</li>
447
- <li> `不撤回合同状态` :已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。</li></ul>
466
+
467
+ - **可撤回合同状态**:未全部签署完成
468
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
469
+
448
470
  注:
449
- <ul><li>能撤回合同的只能是 `合同的发起人或者发起方企业的超管、法人` </li>
450
- <li>签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>。</li></ul>
471
+ - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
472
+ - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
451
473
  */
452
474
  async ChannelCancelFlow(
453
475
  req: ChannelCancelFlowRequest,
@@ -482,17 +504,20 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
482
504
  }
483
505
 
484
506
  /**
485
- * 此接口(ChannelCreateRole)用来创建企业自定义角色。
486
-
487
- 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
488
-
489
- 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
507
+ * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
508
+ `注意:`<br/>
509
+ `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
510
+ `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
511
+ `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
512
+ `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
513
+ `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
514
+ 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
490
515
  */
491
- async ChannelCreateRole(
492
- req: ChannelCreateRoleRequest,
493
- cb?: (error: string, rep: ChannelCreateRoleResponse) => void
494
- ): Promise<ChannelCreateRoleResponse> {
495
- return this.request("ChannelCreateRole", req, cb)
516
+ async ChannelCreateBatchQuickSignUrl(
517
+ req: ChannelCreateBatchQuickSignUrlRequest,
518
+ cb?: (error: string, rep: ChannelCreateBatchQuickSignUrlResponse) => void
519
+ ): Promise<ChannelCreateBatchQuickSignUrlResponse> {
520
+ return this.request("ChannelCreateBatchQuickSignUrl", req, cb)
496
521
  }
497
522
 
498
523
  /**
@@ -598,15 +623,27 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
598
623
  /**
599
624
  * 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
600
625
 
601
- > **适用场景**
602
- >
603
- > 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。
604
- > 一个模板通常会包含以下结构信息
605
- >- 模板基本信息
606
- >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
607
- >- 填写控件 Components
608
- >- 签署控件 SignComponents
609
- >- 生成模板的文件基础信息 FileInfos
626
+ **一个模板通常会包含以下结构信息**
627
+
628
+ - 模板模版ID, 模板名字等基本信息
629
+ - 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
630
+ - 发起方和签署方的填写控件 Components
631
+ - 签署方的签署控件 SignComponents
632
+
633
+ **适用场景**
634
+ 该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口,作为创建合同的前置接口使用。
635
+ 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
636
+
637
+ **模版的来源**
638
+ 子客企业的模板有两种途径获取
639
+ - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
640
+ - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
641
+
642
+
643
+ **注意**
644
+
645
+ >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在,即可查询同时满足这些条件的模板。
646
+ >2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
610
647
  */
611
648
  async DescribeTemplates(
612
649
  req: DescribeTemplatesRequest,
@@ -709,15 +746,15 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
709
746
  }
710
747
 
711
748
  /**
712
- * 指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows
713
- 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
714
- 接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;
749
+ * 通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
715
750
 
716
- 可以撤回:未全部签署完成
717
- 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
751
+ 适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
718
752
 
719
- 注意:
720
- 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
753
+ - **可撤回合同状态**:未全部签署完成
754
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
755
+
756
+ 注:
757
+ - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
721
758
  */
722
759
  async ChannelCreateBatchCancelFlowUrl(
723
760
  req: ChannelCreateBatchCancelFlowUrlRequest,
@@ -739,8 +776,12 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
739
776
  }
740
777
 
741
778
  /**
742
- * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
743
- 注意:大文件转换所需的时间可能会比较长。
779
+ * 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
780
+ 前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
781
+
782
+ 适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />
783
+ 注:
784
+ 1. `大文件转换所需的时间可能会比较长`
744
785
  */
745
786
  async ChannelGetTaskResultApi(
746
787
  req: ChannelGetTaskResultApiRequest,
@@ -854,23 +895,29 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
854
895
  }
855
896
 
856
897
  /**
857
- * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
858
-
859
- 1. 合同中当前状态为“待签署”的签署人是催办的对象
860
- 2. 每个合同只能催办一次
861
-
862
- 注意:该接口无法直接调用,请联系客户经理申请使用。
898
+ * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
899
+ 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
900
+ 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
901
+ 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
863
902
  */
864
- async ChannelCreateFlowReminds(
865
- req: ChannelCreateFlowRemindsRequest,
866
- cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void
867
- ): Promise<ChannelCreateFlowRemindsResponse> {
868
- return this.request("ChannelCreateFlowReminds", req, cb)
903
+ async ChannelCreateFlowSignUrl(
904
+ req: ChannelCreateFlowSignUrlRequest,
905
+ cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void
906
+ ): Promise<ChannelCreateFlowSignUrlResponse> {
907
+ return this.request("ChannelCreateFlowSignUrl", req, cb)
869
908
  }
870
909
 
871
910
  /**
872
- * 发起解除协议,主要应用场景为:基于一份已经签署的合同,进行解除操作。
873
- 合同发起人必须在电子签已经进行实名。
911
+ * 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
912
+ 解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。
913
+
914
+ 注意:
915
+ <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
916
+ <li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>
917
+ <li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>
918
+ <li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
919
+ <li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
920
+ <li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li></ul>
874
921
  */
875
922
  async ChannelCreateReleaseFlow(
876
923
  req: ChannelCreateReleaseFlowRequest,
@@ -890,22 +937,16 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
890
937
  }
891
938
 
892
939
  /**
893
- * 用于批量撤销合同流程<br/>
894
- 适用场景:
895
- 如果某些合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
896
- 通过签署流程编号批量撤销合同,单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是,若合同处于以下已终止状态,则不可撤销:<br/>
897
- - 已全部签署完成
898
- - 已拒签
899
- - 已过期
900
- - 已撤回
901
- - 拒绝填写
902
- - 已解除
903
-
904
- <br/>
905
- 满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
906
- <br/><br/>
940
+ * 通过合同编号批量撤销合同,单次最多支持撤销100份合同。
941
+
942
+ 适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
943
+
944
+ - **可撤回合同状态**:未全部签署完成
945
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
946
+
907
947
  注:
908
- `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
948
+ - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
949
+ - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
909
950
  */
910
951
  async ChannelBatchCancelFlows(
911
952
  req: ChannelBatchCancelFlowsRequest,
@@ -917,7 +958,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
917
958
  /**
918
959
  * 该接口 (PrepareFlows) 用于创建待发起文件
919
960
  用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
920
- 目前该接口只支持B2C,不建议使用,将会废弃。
961
+ 目前该接口只支持B2C,<font color='red'> **不建议使用,将会废弃**</font>。
921
962
  */
922
963
  async PrepareFlows(
923
964
  req: PrepareFlowsRequest,
@@ -959,14 +1000,17 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
959
1000
  }
960
1001
 
961
1002
  /**
962
- * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列。
963
- 相关系统默认角色说明可参考文档:https://cloud.tencent.com/document/product/1323/61355
1003
+ * 此接口(ChannelCreateRole)用来创建企业自定义角色。
1004
+
1005
+ 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
1006
+
1007
+ 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
964
1008
  */
965
- async ChannelDescribeRoles(
966
- req: ChannelDescribeRolesRequest,
967
- cb?: (error: string, rep: ChannelDescribeRolesResponse) => void
968
- ): Promise<ChannelDescribeRolesResponse> {
969
- return this.request("ChannelDescribeRoles", req, cb)
1009
+ async ChannelCreateRole(
1010
+ req: ChannelCreateRoleRequest,
1011
+ cb?: (error: string, rep: ChannelCreateRoleResponse) => void
1012
+ ): Promise<ChannelCreateRoleResponse> {
1013
+ return this.request("ChannelCreateRole", req, cb)
970
1014
  }
971
1015
 
972
1016
  /**
@@ -1033,16 +1077,18 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1033
1077
  }
1034
1078
 
1035
1079
  /**
1036
- * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
1037
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
1038
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
1039
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
1080
+ * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
1081
+
1082
+ 1. 合同中当前状态为“待签署”的签署人是催办的对象
1083
+ 2. 每个合同只能催办一次
1084
+
1085
+ 注意:该接口无法直接调用,请联系客户经理申请使用。
1040
1086
  */
1041
- async ChannelCreateFlowSignUrl(
1042
- req: ChannelCreateFlowSignUrlRequest,
1043
- cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void
1044
- ): Promise<ChannelCreateFlowSignUrlResponse> {
1045
- return this.request("ChannelCreateFlowSignUrl", req, cb)
1087
+ async ChannelCreateFlowReminds(
1088
+ req: ChannelCreateFlowRemindsRequest,
1089
+ cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void
1090
+ ): Promise<ChannelCreateFlowRemindsResponse> {
1091
+ return this.request("ChannelCreateFlowReminds", req, cb)
1046
1092
  }
1047
1093
 
1048
1094
  /**
@@ -1319,8 +1365,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1319
1365
  }
1320
1366
 
1321
1367
  /**
1322
- * 企业方可以通过此接口获取个人用户开启自动签的跳转链接
1323
- */
1368
+ * 获取个人用户自动签的开通链接。
1369
+
1370
+ 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
1371
+ */
1324
1372
  async ChannelCreateUserAutoSignEnableUrl(
1325
1373
  req: ChannelCreateUserAutoSignEnableUrlRequest,
1326
1374
  cb?: (error: string, rep: ChannelCreateUserAutoSignEnableUrlResponse) => void