tencentcloud-sdk-nodejs-essbasic 4.0.718 → 4.0.720

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.
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateFlowApproversRequest, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
2
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, ChannelCreateBatchQuickSignUrlResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateFlowApproversRequest, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
3
3
  /**
4
4
  * essbasic client
5
5
  * @class
@@ -18,6 +18,36 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
18
18
  发起审核:通过接口ChannelCreatePrepareFlow指定发起后需要审核,则可以通过调用此接口,指定operate=CreateReview,提交企业内部审批结果,可多次提交,当通过后,后续提交结果无效
19
19
  */
20
20
  ChannelCreateFlowSignReview(req: ChannelCreateFlowSignReviewRequest, cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void): Promise<ChannelCreateFlowSignReviewResponse>;
21
+ /**
22
+ * 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人。
23
+
24
+ 跳转小程序的几种方式:主要是设置不同的EndPoint
25
+ 1. 通过链接Url直接跳转到小程序,不需要返回
26
+ 设置EndPoint为WEIXINAPP,得到链接打开即可。
27
+
28
+ 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
29
+ 跳转到小程序的实现,参考官方文档
30
+ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
31
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
32
+ 设置EndPoint为APP,得到path。
33
+
34
+ 4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
35
+ 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
36
+ 全屏方式:
37
+ (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
38
+ 半屏方式:
39
+ (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
40
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
41
+ 设置EndPoint为APP,得到path。
42
+
43
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
44
+
45
+ | 小程序 | AppID | 原始ID |
46
+ | ------------ | ------------ | ------------ |
47
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
48
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
49
+ */
50
+ ModifyExtendedService(req: ModifyExtendedServiceRequest, cb?: (error: string, rep: ModifyExtendedServiceResponse) => void): Promise<ModifyExtendedServiceResponse>;
21
51
  /**
22
52
  * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
23
53
  适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
@@ -133,38 +163,20 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
133
163
  */
134
164
  DescribeExtendedServiceAuthInfo(req: DescribeExtendedServiceAuthInfoRequest, cb?: (error: string, rep: DescribeExtendedServiceAuthInfoResponse) => void): Promise<DescribeExtendedServiceAuthInfoResponse>;
135
165
  /**
136
- * 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人。
137
-
138
- 跳转小程序的几种方式:主要是设置不同的EndPoint
139
- 1. 通过链接Url直接跳转到小程序,不需要返回
140
- 设置EndPoint为WEIXINAPP,得到链接打开即可。
141
-
142
- 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
143
- 跳转到小程序的实现,参考官方文档
144
- https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
145
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
146
- 设置EndPoint为APP,得到path。
147
-
148
- 4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
149
- 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
150
- 全屏方式:
151
- (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
152
- 半屏方式:
153
- (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
154
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
155
- 设置EndPoint为APP,得到path。
156
-
157
- 其中小程序的原始Id如下,或者查看小程序信息自助获取。
158
-
159
- | 小程序 | AppID | 原始ID |
160
- | ------------ | ------------ | ------------ |
161
- | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
162
- | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
166
+ * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列。
167
+ 相关系统默认角色说明可参考文档:https://cloud.tencent.com/document/product/1323/61355
163
168
  */
164
- ModifyExtendedService(req: ModifyExtendedServiceRequest, cb?: (error: string, rep: ModifyExtendedServiceResponse) => void): Promise<ModifyExtendedServiceResponse>;
169
+ ChannelDescribeRoles(req: ChannelDescribeRolesRequest, cb?: (error: string, rep: ChannelDescribeRolesResponse) => void): Promise<ChannelDescribeRolesResponse>;
165
170
  /**
166
- * 上传了word、excel、图片文件后,通过该接口发起文件转换任务,将wordexcel、图片文件转换为pdf文件。
167
- */
171
+ * 此接口(ChannelCreateConvertTaskApi)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
172
+ 前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
173
+ 适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
174
+ 适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
175
+ 转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
176
+ 注:
177
+ 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
178
+ 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
179
+ */
168
180
  ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse>;
169
181
  /**
170
182
  * 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
@@ -196,13 +208,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
196
208
  */
197
209
  ChannelCreateSealPolicy(req: ChannelCreateSealPolicyRequest, cb?: (error: string, rep: ChannelCreateSealPolicyResponse) => void): Promise<ChannelCreateSealPolicyResponse>;
198
210
  /**
199
- * 此接口(ChannelCreateRole)用来创建企业自定义角色。
200
-
201
- 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
202
-
203
- 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
211
+ * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
212
+ `注意:`<br/>
213
+ `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
214
+ `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
215
+ `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
216
+ `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
217
+ `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
218
+ 跳转到小程序的实现,参考微信官方文档(分为<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>
204
219
  */
205
- ChannelCreateRole(req: ChannelCreateRoleRequest, cb?: (error: string, rep: ChannelCreateRoleResponse) => void): Promise<ChannelCreateRoleResponse>;
220
+ ChannelCreateBatchQuickSignUrl(req: ChannelCreateBatchQuickSignUrlRequest, cb?: (error: string, rep: ChannelCreateBatchQuickSignUrlResponse) => void): Promise<ChannelCreateBatchQuickSignUrlResponse>;
206
221
  /**
207
222
  * 接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。
208
223
  如若在模板中配置了动态表格, 上传的附件必须为A4大小
@@ -291,6 +306,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
291
306
  >- 填写控件 Components
292
307
  >- 签署控件 SignComponents
293
308
  >- 生成模板的文件基础信息 FileInfos
309
+
310
+ 注意:
311
+
312
+ >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在,即可查询同时满足这些条件的模板。
313
+ >2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
294
314
  */
295
315
  DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
296
316
  /**
@@ -381,8 +401,12 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
381
401
  */
382
402
  ChannelDeleteRole(req: ChannelDeleteRoleRequest, cb?: (error: string, rep: ChannelDeleteRoleResponse) => void): Promise<ChannelDeleteRoleResponse>;
383
403
  /**
384
- * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
385
- 注意:大文件转换所需的时间可能会比较长。
404
+ * 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
405
+ 前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
406
+
407
+ 适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />
408
+ 注:
409
+ 1. `大文件转换所需的时间可能会比较长`
386
410
  */
387
411
  ChannelGetTaskResultApi(req: ChannelGetTaskResultApiRequest, cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void): Promise<ChannelGetTaskResultApiResponse>;
388
412
  /**
@@ -442,14 +466,12 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
442
466
  */
443
467
  ChannelCreateWebThemeConfig(req: ChannelCreateWebThemeConfigRequest, cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void): Promise<ChannelCreateWebThemeConfigResponse>;
444
468
  /**
445
- * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
446
-
447
- 1. 合同中当前状态为“待签署”的签署人是催办的对象
448
- 2. 每个合同只能催办一次
449
-
450
- 注意:该接口无法直接调用,请联系客户经理申请使用。
469
+ * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
470
+ 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
471
+ 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
472
+ 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
451
473
  */
452
- ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
474
+ ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
453
475
  /**
454
476
  * 发起解除协议,主要应用场景为:基于一份已经签署的合同,进行解除操作。
455
477
  合同发起人必须在电子签已经进行实名。
@@ -481,7 +503,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
481
503
  /**
482
504
  * 该接口 (PrepareFlows) 用于创建待发起文件
483
505
  用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
484
- 目前该接口只支持B2C,不建议使用,将会废弃。
506
+ 目前该接口只支持B2C,不建议使用,将会**废弃**。
485
507
  */
486
508
  PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
487
509
  /**
@@ -505,10 +527,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
505
527
  */
506
528
  ChannelCreateFlowApprovers(req: ChannelCreateFlowApproversRequest, cb?: (error: string, rep: ChannelCreateFlowApproversResponse) => void): Promise<ChannelCreateFlowApproversResponse>;
507
529
  /**
508
- * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列。
509
- 相关系统默认角色说明可参考文档:https://cloud.tencent.com/document/product/1323/61355
530
+ * 此接口(ChannelCreateRole)用来创建企业自定义角色。
531
+
532
+ 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
533
+
534
+ 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
510
535
  */
511
- ChannelDescribeRoles(req: ChannelDescribeRolesRequest, cb?: (error: string, rep: ChannelDescribeRolesResponse) => void): Promise<ChannelDescribeRolesResponse>;
536
+ ChannelCreateRole(req: ChannelCreateRoleRequest, cb?: (error: string, rep: ChannelCreateRoleResponse) => void): Promise<ChannelCreateRoleResponse>;
512
537
  /**
513
538
  * 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同
514
539
 
@@ -549,12 +574,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
549
574
  */
550
575
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
551
576
  /**
552
- * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
553
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
554
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
555
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
577
+ * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
578
+
579
+ 1. 合同中当前状态为“待签署”的签署人是催办的对象
580
+ 2. 每个合同只能催办一次
581
+
582
+ 注意:该接口无法直接调用,请联系客户经理申请使用。
556
583
  */
557
- ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
584
+ ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
558
585
  /**
559
586
  * 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称,企业营业执照,企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意:
560
587
  1. 需要在子客企业激活前调用该接口,如果您的企业已经提交企业信息或者企业已经激活,同步的企业信息将不会生效。
@@ -43,6 +43,38 @@ class Client extends TencentCloudCommon.AbstractClient {
43
43
  async ChannelCreateFlowSignReview(req, cb) {
44
44
  return this.request("ChannelCreateFlowSignReview", req, cb);
45
45
  }
46
+ /**
47
+ * 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人。
48
+
49
+ 跳转小程序的几种方式:主要是设置不同的EndPoint
50
+ 1. 通过链接Url直接跳转到小程序,不需要返回
51
+ 设置EndPoint为WEIXINAPP,得到链接打开即可。
52
+
53
+ 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
54
+ 跳转到小程序的实现,参考官方文档
55
+ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
56
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
57
+ 设置EndPoint为APP,得到path。
58
+
59
+ 4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
60
+ 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
61
+ 全屏方式:
62
+ (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
63
+ 半屏方式:
64
+ (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
65
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
66
+ 设置EndPoint为APP,得到path。
67
+
68
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
69
+
70
+ | 小程序 | AppID | 原始ID |
71
+ | ------------ | ------------ | ------------ |
72
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
73
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
74
+ */
75
+ async ModifyExtendedService(req, cb) {
76
+ return this.request("ModifyExtendedService", req, cb);
77
+ }
46
78
  /**
47
79
  * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
48
80
  适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
@@ -170,40 +202,22 @@ class Client extends TencentCloudCommon.AbstractClient {
170
202
  return this.request("DescribeExtendedServiceAuthInfo", req, cb);
171
203
  }
172
204
  /**
173
- * 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人。
174
-
175
- 跳转小程序的几种方式:主要是设置不同的EndPoint
176
- 1. 通过链接Url直接跳转到小程序,不需要返回
177
- 设置EndPoint为WEIXINAPP,得到链接打开即可。
178
-
179
- 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
180
- 跳转到小程序的实现,参考官方文档
181
- https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
182
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
183
- 设置EndPoint为APP,得到path。
184
-
185
- 4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
186
- 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
187
- 全屏方式:
188
- (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
189
- 半屏方式:
190
- (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
191
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
192
- 设置EndPoint为APP,得到path。
193
-
194
- 其中小程序的原始Id如下,或者查看小程序信息自助获取。
195
-
196
- | 小程序 | AppID | 原始ID |
197
- | ------------ | ------------ | ------------ |
198
- | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
199
- | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
205
+ * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列。
206
+ 相关系统默认角色说明可参考文档:https://cloud.tencent.com/document/product/1323/61355
200
207
  */
201
- async ModifyExtendedService(req, cb) {
202
- return this.request("ModifyExtendedService", req, cb);
208
+ async ChannelDescribeRoles(req, cb) {
209
+ return this.request("ChannelDescribeRoles", req, cb);
203
210
  }
204
211
  /**
205
- * 上传了word、excel、图片文件后,通过该接口发起文件转换任务,将wordexcel、图片文件转换为pdf文件。
206
- */
212
+ * 此接口(ChannelCreateConvertTaskApi)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
213
+ 前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
214
+ 适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
215
+ 适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
216
+ 转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
217
+ 注:
218
+ 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
219
+ 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
220
+ */
207
221
  async ChannelCreateConvertTaskApi(req, cb) {
208
222
  return this.request("ChannelCreateConvertTaskApi", req, cb);
209
223
  }
@@ -245,14 +259,17 @@ class Client extends TencentCloudCommon.AbstractClient {
245
259
  return this.request("ChannelCreateSealPolicy", req, cb);
246
260
  }
247
261
  /**
248
- * 此接口(ChannelCreateRole)用来创建企业自定义角色。
249
-
250
- 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
251
-
252
- 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
262
+ * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
263
+ `注意:`<br/>
264
+ `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
265
+ `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
266
+ `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
267
+ `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
268
+ `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
269
+ 跳转到小程序的实现,参考微信官方文档(分为<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>
253
270
  */
254
- async ChannelCreateRole(req, cb) {
255
- return this.request("ChannelCreateRole", req, cb);
271
+ async ChannelCreateBatchQuickSignUrl(req, cb) {
272
+ return this.request("ChannelCreateBatchQuickSignUrl", req, cb);
256
273
  }
257
274
  /**
258
275
  * 接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。
@@ -350,6 +367,11 @@ class Client extends TencentCloudCommon.AbstractClient {
350
367
  >- 填写控件 Components
351
368
  >- 签署控件 SignComponents
352
369
  >- 生成模板的文件基础信息 FileInfos
370
+
371
+ 注意:
372
+
373
+ >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在,即可查询同时满足这些条件的模板。
374
+ >2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
353
375
  */
354
376
  async DescribeTemplates(req, cb) {
355
377
  return this.request("DescribeTemplates", req, cb);
@@ -454,8 +476,12 @@ class Client extends TencentCloudCommon.AbstractClient {
454
476
  return this.request("ChannelDeleteRole", req, cb);
455
477
  }
456
478
  /**
457
- * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
458
- 注意:大文件转换所需的时间可能会比较长。
479
+ * 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
480
+ 前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
481
+
482
+ 适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />
483
+ 注:
484
+ 1. `大文件转换所需的时间可能会比较长`
459
485
  */
460
486
  async ChannelGetTaskResultApi(req, cb) {
461
487
  return this.request("ChannelGetTaskResultApi", req, cb);
@@ -533,15 +559,13 @@ class Client extends TencentCloudCommon.AbstractClient {
533
559
  return this.request("ChannelCreateWebThemeConfig", req, cb);
534
560
  }
535
561
  /**
536
- * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
537
-
538
- 1. 合同中当前状态为“待签署”的签署人是催办的对象
539
- 2. 每个合同只能催办一次
540
-
541
- 注意:该接口无法直接调用,请联系客户经理申请使用。
562
+ * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
563
+ 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
564
+ 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
565
+ 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
542
566
  */
543
- async ChannelCreateFlowReminds(req, cb) {
544
- return this.request("ChannelCreateFlowReminds", req, cb);
567
+ async ChannelCreateFlowSignUrl(req, cb) {
568
+ return this.request("ChannelCreateFlowSignUrl", req, cb);
545
569
  }
546
570
  /**
547
571
  * 发起解除协议,主要应用场景为:基于一份已经签署的合同,进行解除操作。
@@ -580,7 +604,7 @@ class Client extends TencentCloudCommon.AbstractClient {
580
604
  /**
581
605
  * 该接口 (PrepareFlows) 用于创建待发起文件
582
606
  用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
583
- 目前该接口只支持B2C,不建议使用,将会废弃。
607
+ 目前该接口只支持B2C,不建议使用,将会**废弃**。
584
608
  */
585
609
  async PrepareFlows(req, cb) {
586
610
  return this.request("PrepareFlows", req, cb);
@@ -610,11 +634,14 @@ class Client extends TencentCloudCommon.AbstractClient {
610
634
  return this.request("ChannelCreateFlowApprovers", req, cb);
611
635
  }
612
636
  /**
613
- * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列。
614
- 相关系统默认角色说明可参考文档:https://cloud.tencent.com/document/product/1323/61355
637
+ * 此接口(ChannelCreateRole)用来创建企业自定义角色。
638
+
639
+ 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
640
+
641
+ 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
615
642
  */
616
- async ChannelDescribeRoles(req, cb) {
617
- return this.request("ChannelDescribeRoles", req, cb);
643
+ async ChannelCreateRole(req, cb) {
644
+ return this.request("ChannelCreateRole", req, cb);
618
645
  }
619
646
  /**
620
647
  * 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同
@@ -664,13 +691,15 @@ class Client extends TencentCloudCommon.AbstractClient {
664
691
  return this.request("UploadFiles", req, cb);
665
692
  }
666
693
  /**
667
- * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
668
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
669
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
670
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
694
+ * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
695
+
696
+ 1. 合同中当前状态为“待签署”的签署人是催办的对象
697
+ 2. 每个合同只能催办一次
698
+
699
+ 注意:该接口无法直接调用,请联系客户经理申请使用。
671
700
  */
672
- async ChannelCreateFlowSignUrl(req, cb) {
673
- return this.request("ChannelCreateFlowSignUrl", req, cb);
701
+ async ChannelCreateFlowReminds(req, cb) {
702
+ return this.request("ChannelCreateFlowReminds", req, cb);
674
703
  }
675
704
  /**
676
705
  * 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称,企业营业执照,企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意: