tencentcloud-sdk-nodejs-ess 4.0.453 → 4.0.455
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 +256 -0
- package/SERVICE_CHANGELOG.md +295 -55
- package/package.json +1 -1
- package/products.md +19 -19
- package/src/services/ess/v20201111/ess_client.ts +166 -122
- package/src/services/ess/v20201111/ess_models.ts +500 -175
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +72 -61
- package/tencentcloud/services/ess/v20201111/ess_client.js +93 -76
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +408 -130
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, CreateFlowApproversResponse, DescribeFlowInfoRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, VerifyPdfRequest, VerifyPdfResponse,
|
|
2
|
+
import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, DeleteIntegrationEmployeesResponse, DeleteIntegrationEmployeesRequest, DescribeIntegrationEmployeesResponse, CreateFlowApproversResponse, DescribeFlowInfoRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, CreateIntegrationEmployeesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, VerifyPdfRequest, VerifyPdfResponse, CreateIntegrationEmployeesRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateFlowEvidenceReportRequest, CreateBatchCancelFlowUrlResponse, UploadFilesRequest, DescribeFileUrlsRequest, StartFlowResponse, GetTaskResultApiRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, DescribeFlowInfoResponse, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse, CreateFlowApproversRequest } from "./ess_models";
|
|
3
3
|
/**
|
|
4
4
|
* ess client
|
|
5
5
|
* @class
|
|
@@ -7,25 +7,44 @@ import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, Des
|
|
|
7
7
|
export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
8
8
|
constructor(clientConfig: TencentCloudCommon.ClientConfig);
|
|
9
9
|
/**
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
* 此接口用于发起流程
|
|
11
|
+
适用场景:见创建签署流程接口。
|
|
12
|
+
注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
|
|
13
|
+
*/
|
|
14
|
+
StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* 用于撤销签署流程
|
|
17
|
+
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
18
|
+
注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
|
|
19
|
+
*/
|
|
20
|
+
CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
|
|
21
|
+
/**
|
|
22
|
+
* 二期接口-查询模板
|
|
23
|
+
适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
|
|
24
|
+
*/
|
|
25
|
+
DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
|
|
13
26
|
/**
|
|
14
27
|
* 查询文件下载URL
|
|
15
28
|
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
16
29
|
*/
|
|
17
30
|
DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
|
|
18
31
|
/**
|
|
19
|
-
|
|
20
|
-
|
|
32
|
+
* 验证合同文件
|
|
33
|
+
*/
|
|
34
|
+
VerifyPdf(req: VerifyPdfRequest, cb?: (error: string, rep: VerifyPdfResponse) => void): Promise<VerifyPdfResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* 电子签企业版:指定需要批量撤回的签署流程Id,获取批量撤销链接
|
|
37
|
+
客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
|
21
38
|
*/
|
|
22
|
-
|
|
39
|
+
CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
|
|
23
40
|
/**
|
|
24
|
-
*
|
|
25
|
-
|
|
26
|
-
|
|
41
|
+
* 补充签署流程本企业签署人信息
|
|
42
|
+
适用场景:在通过模板或者文件发起合同时,若未指定本企业签署人信息,则流程发起后,可以调用此接口补充签署人。
|
|
43
|
+
同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
|
|
44
|
+
|
|
45
|
+
注:目前暂时只支持补充来源于企业微信的员工作为候选签署人
|
|
27
46
|
*/
|
|
28
|
-
|
|
47
|
+
CreateFlowApprovers(req: CreateFlowApproversRequest, cb?: (error: string, rep: CreateFlowApproversResponse) => void): Promise<CreateFlowApproversResponse>;
|
|
29
48
|
/**
|
|
30
49
|
* 提交企业签署流程审批结果
|
|
31
50
|
适用场景:
|
|
@@ -34,12 +53,6 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
34
53
|
|
|
35
54
|
*/
|
|
36
55
|
CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
|
|
37
|
-
/**
|
|
38
|
-
* 用于撤销签署流程
|
|
39
|
-
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
40
|
-
注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
|
|
41
|
-
*/
|
|
42
|
-
CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
|
|
43
56
|
/**
|
|
44
57
|
* 创建签署流程电子文档
|
|
45
58
|
适用场景:见创建签署流程接口。
|
|
@@ -47,19 +60,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
47
60
|
*/
|
|
48
61
|
CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
|
|
49
62
|
/**
|
|
50
|
-
*
|
|
51
|
-
|
|
52
|
-
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
63
|
+
* 查询合同详情
|
|
64
|
+
适用场景:可用于主动查询某个合同详情信息。
|
|
53
65
|
*/
|
|
54
|
-
|
|
66
|
+
DescribeFlowInfo(req: DescribeFlowInfoRequest, cb?: (error: string, rep: DescribeFlowInfoResponse) => void): Promise<DescribeFlowInfoResponse>;
|
|
55
67
|
/**
|
|
56
|
-
*
|
|
68
|
+
* 创建出证报告,返回报告 URL。此接口暂未开放,有问题请联系运营人员。
|
|
57
69
|
*/
|
|
58
|
-
DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
|
|
59
|
-
/**
|
|
60
|
-
* 【描述】:创建出证报告,返回报告 URL
|
|
61
|
-
【注意】:此接口需要通过添加白名单获取调用权限,请联系运营人员加白
|
|
62
|
-
*/
|
|
63
70
|
CreateFlowEvidenceReport(req: CreateFlowEvidenceReportRequest, cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void): Promise<CreateFlowEvidenceReportResponse>;
|
|
64
71
|
/**
|
|
65
72
|
* 创建签署流程
|
|
@@ -75,59 +82,63 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
75
82
|
*/
|
|
76
83
|
CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
|
|
77
84
|
/**
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* 获取小程序跳转链接
|
|
83
|
-
|
|
84
|
-
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
85
|
-
|
|
86
|
-
注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
跳转到小程序的实现,参考官方文档(分为<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>两种方式)
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
|
|
85
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
86
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
87
|
+
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
93
88
|
*/
|
|
94
|
-
|
|
89
|
+
CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
|
|
95
90
|
/**
|
|
96
91
|
* 查询转换任务状态
|
|
97
92
|
*/
|
|
98
93
|
GetTaskResultApi(req: GetTaskResultApiRequest, cb?: (error: string, rep: GetTaskResultApiResponse) => void): Promise<GetTaskResultApiResponse>;
|
|
99
94
|
/**
|
|
100
|
-
*
|
|
95
|
+
* 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
|
|
101
96
|
*/
|
|
102
|
-
|
|
97
|
+
CancelMultiFlowSignQRCode(req: CancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void): Promise<CancelMultiFlowSignQRCodeResponse>;
|
|
103
98
|
/**
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
|
|
99
|
+
* 查询员工信息,每次返回的数据量最大为20
|
|
100
|
+
*/
|
|
101
|
+
DescribeIntegrationEmployees(req: DescribeIntegrationEmployeesRequest, cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void): Promise<DescribeIntegrationEmployeesResponse>;
|
|
108
102
|
/**
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
|
|
103
|
+
* 创建文件转换任务
|
|
104
|
+
*/
|
|
105
|
+
CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
|
|
113
106
|
/**
|
|
114
107
|
* 查询流程摘要
|
|
115
108
|
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
116
109
|
日调用量默认10W
|
|
117
110
|
*/
|
|
118
111
|
DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
|
|
119
|
-
/**
|
|
120
|
-
* 补充签署流程本企业签署人信息
|
|
121
|
-
适用场景:在通过模板或者文件发起合同时,若未指定本企业签署人信息,则流程发起后,可以调用此接口补充签署人。
|
|
122
|
-
同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
|
|
123
|
-
|
|
124
|
-
注:目前暂时只支持补充来源于企业微信的员工作为候选签署人
|
|
125
|
-
*/
|
|
126
|
-
CreateFlowApprovers(req: CreateFlowApproversRequest, cb?: (error: string, rep: CreateFlowApproversResponse) => void): Promise<CreateFlowApproversResponse>;
|
|
127
112
|
/**
|
|
128
113
|
* 此接口(UploadFiles)用于文件上传。
|
|
129
114
|
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
|
|
130
115
|
调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
|
|
131
116
|
*/
|
|
132
117
|
UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
|
|
118
|
+
/**
|
|
119
|
+
* 通过AuthCode查询用户是否实名
|
|
120
|
+
*/
|
|
121
|
+
DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
|
|
122
|
+
/**
|
|
123
|
+
* 移除员工
|
|
124
|
+
*/
|
|
125
|
+
DeleteIntegrationEmployees(req: DeleteIntegrationEmployeesRequest, cb?: (error: string, rep: DeleteIntegrationEmployeesResponse) => void): Promise<DeleteIntegrationEmployeesResponse>;
|
|
126
|
+
/**
|
|
127
|
+
* 获取小程序跳转链接
|
|
128
|
+
|
|
129
|
+
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
130
|
+
|
|
131
|
+
注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
跳转到小程序的实现,参考官方文档(分为<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>两种方式)
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
|
|
138
|
+
*/
|
|
139
|
+
CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
|
|
140
|
+
/**
|
|
141
|
+
* 创建员工
|
|
142
|
+
*/
|
|
143
|
+
CreateIntegrationEmployees(req: CreateIntegrationEmployeesRequest, cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void): Promise<CreateIntegrationEmployeesResponse>;
|
|
133
144
|
}
|
|
@@ -28,10 +28,27 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
28
28
|
super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
31
|
+
* 此接口用于发起流程
|
|
32
|
+
适用场景:见创建签署流程接口。
|
|
33
|
+
注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
|
|
34
|
+
*/
|
|
35
|
+
async StartFlow(req, cb) {
|
|
36
|
+
return this.request("StartFlow", req, cb);
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* 用于撤销签署流程
|
|
40
|
+
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
41
|
+
注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
|
|
42
|
+
*/
|
|
43
|
+
async CancelFlow(req, cb) {
|
|
44
|
+
return this.request("CancelFlow", req, cb);
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* 二期接口-查询模板
|
|
48
|
+
适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
|
|
49
|
+
*/
|
|
50
|
+
async DescribeFlowTemplates(req, cb) {
|
|
51
|
+
return this.request("DescribeFlowTemplates", req, cb);
|
|
35
52
|
}
|
|
36
53
|
/**
|
|
37
54
|
* 查询文件下载URL
|
|
@@ -41,19 +58,27 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
41
58
|
return this.request("DescribeFileUrls", req, cb);
|
|
42
59
|
}
|
|
43
60
|
/**
|
|
44
|
-
|
|
45
|
-
|
|
61
|
+
* 验证合同文件
|
|
62
|
+
*/
|
|
63
|
+
async VerifyPdf(req, cb) {
|
|
64
|
+
return this.request("VerifyPdf", req, cb);
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* 电子签企业版:指定需要批量撤回的签署流程Id,获取批量撤销链接
|
|
68
|
+
客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
|
46
69
|
*/
|
|
47
|
-
async
|
|
48
|
-
return this.request("
|
|
70
|
+
async CreateBatchCancelFlowUrl(req, cb) {
|
|
71
|
+
return this.request("CreateBatchCancelFlowUrl", req, cb);
|
|
49
72
|
}
|
|
50
73
|
/**
|
|
51
|
-
*
|
|
52
|
-
|
|
53
|
-
|
|
74
|
+
* 补充签署流程本企业签署人信息
|
|
75
|
+
适用场景:在通过模板或者文件发起合同时,若未指定本企业签署人信息,则流程发起后,可以调用此接口补充签署人。
|
|
76
|
+
同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
|
|
77
|
+
|
|
78
|
+
注:目前暂时只支持补充来源于企业微信的员工作为候选签署人
|
|
54
79
|
*/
|
|
55
|
-
async
|
|
56
|
-
return this.request("
|
|
80
|
+
async CreateFlowApprovers(req, cb) {
|
|
81
|
+
return this.request("CreateFlowApprovers", req, cb);
|
|
57
82
|
}
|
|
58
83
|
/**
|
|
59
84
|
* 提交企业签署流程审批结果
|
|
@@ -65,14 +90,6 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
65
90
|
async CreateFlowSignReview(req, cb) {
|
|
66
91
|
return this.request("CreateFlowSignReview", req, cb);
|
|
67
92
|
}
|
|
68
|
-
/**
|
|
69
|
-
* 用于撤销签署流程
|
|
70
|
-
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
71
|
-
注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
|
|
72
|
-
*/
|
|
73
|
-
async CancelFlow(req, cb) {
|
|
74
|
-
return this.request("CancelFlow", req, cb);
|
|
75
|
-
}
|
|
76
93
|
/**
|
|
77
94
|
* 创建签署流程电子文档
|
|
78
95
|
适用场景:见创建签署流程接口。
|
|
@@ -82,23 +99,15 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
82
99
|
return this.request("CreateDocument", req, cb);
|
|
83
100
|
}
|
|
84
101
|
/**
|
|
85
|
-
*
|
|
86
|
-
|
|
87
|
-
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
102
|
+
* 查询合同详情
|
|
103
|
+
适用场景:可用于主动查询某个合同详情信息。
|
|
88
104
|
*/
|
|
89
|
-
async
|
|
90
|
-
return this.request("
|
|
105
|
+
async DescribeFlowInfo(req, cb) {
|
|
106
|
+
return this.request("DescribeFlowInfo", req, cb);
|
|
91
107
|
}
|
|
92
108
|
/**
|
|
93
|
-
*
|
|
109
|
+
* 创建出证报告,返回报告 URL。此接口暂未开放,有问题请联系运营人员。
|
|
94
110
|
*/
|
|
95
|
-
async DescribeThirdPartyAuthCode(req, cb) {
|
|
96
|
-
return this.request("DescribeThirdPartyAuthCode", req, cb);
|
|
97
|
-
}
|
|
98
|
-
/**
|
|
99
|
-
* 【描述】:创建出证报告,返回报告 URL
|
|
100
|
-
【注意】:此接口需要通过添加白名单获取调用权限,请联系运营人员加白
|
|
101
|
-
*/
|
|
102
111
|
async CreateFlowEvidenceReport(req, cb) {
|
|
103
112
|
return this.request("CreateFlowEvidenceReport", req, cb);
|
|
104
113
|
}
|
|
@@ -120,26 +129,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
120
129
|
return this.request("CreateFlowByFiles", req, cb);
|
|
121
130
|
}
|
|
122
131
|
/**
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
return this.request("CancelMultiFlowSignQRCode", req, cb);
|
|
127
|
-
}
|
|
128
|
-
/**
|
|
129
|
-
* 获取小程序跳转链接
|
|
130
|
-
|
|
131
|
-
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
132
|
-
|
|
133
|
-
注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
跳转到小程序的实现,参考官方文档(分为<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>两种方式)
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
|
|
132
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
133
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
134
|
+
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
140
135
|
*/
|
|
141
|
-
async
|
|
142
|
-
return this.request("
|
|
136
|
+
async CreateMultiFlowSignQRCode(req, cb) {
|
|
137
|
+
return this.request("CreateMultiFlowSignQRCode", req, cb);
|
|
143
138
|
}
|
|
144
139
|
/**
|
|
145
140
|
* 查询转换任务状态
|
|
@@ -148,24 +143,22 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
148
143
|
return this.request("GetTaskResultApi", req, cb);
|
|
149
144
|
}
|
|
150
145
|
/**
|
|
151
|
-
*
|
|
146
|
+
* 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
|
|
152
147
|
*/
|
|
153
|
-
async
|
|
154
|
-
return this.request("
|
|
148
|
+
async CancelMultiFlowSignQRCode(req, cb) {
|
|
149
|
+
return this.request("CancelMultiFlowSignQRCode", req, cb);
|
|
155
150
|
}
|
|
156
151
|
/**
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
return this.request("DescribeFlowTemplates", req, cb);
|
|
152
|
+
* 查询员工信息,每次返回的数据量最大为20
|
|
153
|
+
*/
|
|
154
|
+
async DescribeIntegrationEmployees(req, cb) {
|
|
155
|
+
return this.request("DescribeIntegrationEmployees", req, cb);
|
|
162
156
|
}
|
|
163
157
|
/**
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
return this.request("CreateBatchCancelFlowUrl", req, cb);
|
|
158
|
+
* 创建文件转换任务
|
|
159
|
+
*/
|
|
160
|
+
async CreateConvertTaskApi(req, cb) {
|
|
161
|
+
return this.request("CreateConvertTaskApi", req, cb);
|
|
169
162
|
}
|
|
170
163
|
/**
|
|
171
164
|
* 查询流程摘要
|
|
@@ -175,16 +168,6 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
175
168
|
async DescribeFlowBriefs(req, cb) {
|
|
176
169
|
return this.request("DescribeFlowBriefs", req, cb);
|
|
177
170
|
}
|
|
178
|
-
/**
|
|
179
|
-
* 补充签署流程本企业签署人信息
|
|
180
|
-
适用场景:在通过模板或者文件发起合同时,若未指定本企业签署人信息,则流程发起后,可以调用此接口补充签署人。
|
|
181
|
-
同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
|
|
182
|
-
|
|
183
|
-
注:目前暂时只支持补充来源于企业微信的员工作为候选签署人
|
|
184
|
-
*/
|
|
185
|
-
async CreateFlowApprovers(req, cb) {
|
|
186
|
-
return this.request("CreateFlowApprovers", req, cb);
|
|
187
|
-
}
|
|
188
171
|
/**
|
|
189
172
|
* 此接口(UploadFiles)用于文件上传。
|
|
190
173
|
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
|
|
@@ -193,5 +176,39 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
193
176
|
async UploadFiles(req, cb) {
|
|
194
177
|
return this.request("UploadFiles", req, cb);
|
|
195
178
|
}
|
|
179
|
+
/**
|
|
180
|
+
* 通过AuthCode查询用户是否实名
|
|
181
|
+
*/
|
|
182
|
+
async DescribeThirdPartyAuthCode(req, cb) {
|
|
183
|
+
return this.request("DescribeThirdPartyAuthCode", req, cb);
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* 移除员工
|
|
187
|
+
*/
|
|
188
|
+
async DeleteIntegrationEmployees(req, cb) {
|
|
189
|
+
return this.request("DeleteIntegrationEmployees", req, cb);
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* 获取小程序跳转链接
|
|
193
|
+
|
|
194
|
+
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
195
|
+
|
|
196
|
+
注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
跳转到小程序的实现,参考官方文档(分为<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>两种方式)
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
|
|
203
|
+
*/
|
|
204
|
+
async CreateSchemeUrl(req, cb) {
|
|
205
|
+
return this.request("CreateSchemeUrl", req, cb);
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* 创建员工
|
|
209
|
+
*/
|
|
210
|
+
async CreateIntegrationEmployees(req, cb) {
|
|
211
|
+
return this.request("CreateIntegrationEmployees", req, cb);
|
|
212
|
+
}
|
|
196
213
|
}
|
|
197
214
|
exports.Client = Client;
|