tencentcloud-sdk-nodejs-ess 4.0.431 → 4.0.434
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 +251 -1
- package/SERVICE_CHANGELOG.md +162 -62
- package/package.json +1 -1
- package/products.md +11 -11
- package/src/services/ess/index.ts +4 -7
- package/src/services/ess/v20201111/ess_client.ts +194 -144
- package/src/services/ess/v20201111/ess_models.ts +1221 -1276
- package/src/services/ess/v20201111/index.ts +3 -3
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +60 -60
- package/tencentcloud/services/ess/v20201111/ess_client.js +60 -60
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +659 -659
- package/tencentcloud/services/ess/v20201111/index.js +1 -1
|
@@ -7,41 +7,41 @@ import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, Des
|
|
|
7
7
|
export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
8
8
|
constructor(clientConfig: TencentCloudCommon.ClientConfig);
|
|
9
9
|
/**
|
|
10
|
-
|
|
11
|
-
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
12
|
-
|
|
10
|
+
* 查询文件下载URL
|
|
11
|
+
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
12
|
+
*/
|
|
13
13
|
DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
|
|
14
14
|
/**
|
|
15
|
-
|
|
16
|
-
适用场景:见创建签署流程接口。
|
|
17
|
-
注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
|
|
18
|
-
|
|
15
|
+
* 此接口用于发起流程
|
|
16
|
+
适用场景:见创建签署流程接口。
|
|
17
|
+
注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
|
|
18
|
+
*/
|
|
19
19
|
StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
|
|
20
20
|
/**
|
|
21
|
-
|
|
22
|
-
适用场景:
|
|
23
|
-
在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
24
|
-
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
25
|
-
|
|
26
|
-
|
|
21
|
+
* 提交企业签署流程审批结果
|
|
22
|
+
适用场景:
|
|
23
|
+
在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
24
|
+
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
25
|
+
|
|
26
|
+
*/
|
|
27
27
|
CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
|
|
28
28
|
/**
|
|
29
|
-
|
|
30
|
-
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
31
|
-
注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
|
|
32
|
-
|
|
29
|
+
* 用于撤销签署流程
|
|
30
|
+
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
31
|
+
注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
|
|
32
|
+
*/
|
|
33
33
|
CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
|
|
34
34
|
/**
|
|
35
|
-
|
|
36
|
-
适用场景:见创建签署流程接口。
|
|
37
|
-
注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
|
|
38
|
-
|
|
35
|
+
* 创建签署流程电子文档
|
|
36
|
+
适用场景:见创建签署流程接口。
|
|
37
|
+
注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
|
|
38
|
+
*/
|
|
39
39
|
CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
|
|
40
40
|
/**
|
|
41
|
-
|
|
42
|
-
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
43
|
-
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
44
|
-
|
|
41
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
42
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
43
|
+
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
44
|
+
*/
|
|
45
45
|
CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
|
|
46
46
|
/**
|
|
47
47
|
* 通过AuthCode查询用户是否实名
|
|
@@ -52,28 +52,28 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
52
52
|
*/
|
|
53
53
|
CreateFlowEvidenceReport(req: CreateFlowEvidenceReportRequest, cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void): Promise<CreateFlowEvidenceReportResponse>;
|
|
54
54
|
/**
|
|
55
|
-
|
|
56
|
-
适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
|
|
57
|
-
注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
|
|
58
|
-
|
|
55
|
+
* 创建签署流程
|
|
56
|
+
适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
|
|
57
|
+
注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
|
|
58
|
+
*/
|
|
59
59
|
CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
|
|
60
60
|
/**
|
|
61
61
|
* 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
|
|
62
62
|
*/
|
|
63
63
|
CancelMultiFlowSignQRCode(req: CancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void): Promise<CancelMultiFlowSignQRCodeResponse>;
|
|
64
64
|
/**
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
68
|
-
|
|
69
|
-
注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
跳转到小程序的实现,参考官方文档(分为<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>两种方式)
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
|
|
76
|
-
|
|
65
|
+
* 获取小程序跳转链接
|
|
66
|
+
|
|
67
|
+
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
68
|
+
|
|
69
|
+
注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
跳转到小程序的实现,参考官方文档(分为<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>两种方式)
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
|
|
76
|
+
*/
|
|
77
77
|
CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
|
|
78
78
|
/**
|
|
79
79
|
* 查询转换任务状态
|
|
@@ -84,32 +84,32 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
84
84
|
*/
|
|
85
85
|
CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
|
|
86
86
|
/**
|
|
87
|
-
|
|
88
|
-
适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
|
|
89
|
-
|
|
87
|
+
* 二期接口-查询模板
|
|
88
|
+
适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
|
|
89
|
+
*/
|
|
90
90
|
DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
|
|
91
91
|
/**
|
|
92
|
-
|
|
93
|
-
客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
|
94
|
-
|
|
92
|
+
* 电子签企业版:指定需要批量撤回的签署流程Id,获取批量撤销链接
|
|
93
|
+
客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
|
94
|
+
*/
|
|
95
95
|
CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
|
|
96
96
|
/**
|
|
97
|
-
|
|
98
|
-
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
99
|
-
日调用量默认10W
|
|
100
|
-
|
|
97
|
+
* 查询流程摘要
|
|
98
|
+
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
99
|
+
日调用量默认10W
|
|
100
|
+
*/
|
|
101
101
|
DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
|
|
102
102
|
/**
|
|
103
|
-
|
|
104
|
-
适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
|
|
105
|
-
适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
|
|
106
|
-
注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
|
|
107
|
-
|
|
103
|
+
* 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
|
|
104
|
+
适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
|
|
105
|
+
适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
|
|
106
|
+
注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
|
|
107
|
+
*/
|
|
108
108
|
CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
|
|
109
109
|
/**
|
|
110
|
-
|
|
111
|
-
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
|
|
112
|
-
调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
|
|
113
|
-
|
|
110
|
+
* 此接口(UploadFiles)用于文件上传。
|
|
111
|
+
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
|
|
112
|
+
调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
|
|
113
|
+
*/
|
|
114
114
|
UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
|
|
115
115
|
}
|
|
@@ -28,51 +28,51 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
28
28
|
super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
|
-
|
|
32
|
-
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
33
|
-
|
|
31
|
+
* 查询文件下载URL
|
|
32
|
+
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
33
|
+
*/
|
|
34
34
|
async DescribeFileUrls(req, cb) {
|
|
35
35
|
return this.request("DescribeFileUrls", req, cb);
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
|
|
39
|
-
适用场景:见创建签署流程接口。
|
|
40
|
-
注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
|
|
41
|
-
|
|
38
|
+
* 此接口用于发起流程
|
|
39
|
+
适用场景:见创建签署流程接口。
|
|
40
|
+
注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
|
|
41
|
+
*/
|
|
42
42
|
async StartFlow(req, cb) {
|
|
43
43
|
return this.request("StartFlow", req, cb);
|
|
44
44
|
}
|
|
45
45
|
/**
|
|
46
|
-
|
|
47
|
-
适用场景:
|
|
48
|
-
在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
49
|
-
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
50
|
-
|
|
51
|
-
|
|
46
|
+
* 提交企业签署流程审批结果
|
|
47
|
+
适用场景:
|
|
48
|
+
在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
49
|
+
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
50
|
+
|
|
51
|
+
*/
|
|
52
52
|
async CreateFlowSignReview(req, cb) {
|
|
53
53
|
return this.request("CreateFlowSignReview", req, cb);
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
|
-
|
|
57
|
-
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
58
|
-
注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
|
|
59
|
-
|
|
56
|
+
* 用于撤销签署流程
|
|
57
|
+
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
58
|
+
注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
|
|
59
|
+
*/
|
|
60
60
|
async CancelFlow(req, cb) {
|
|
61
61
|
return this.request("CancelFlow", req, cb);
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
|
|
65
|
-
适用场景:见创建签署流程接口。
|
|
66
|
-
注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
|
|
67
|
-
|
|
64
|
+
* 创建签署流程电子文档
|
|
65
|
+
适用场景:见创建签署流程接口。
|
|
66
|
+
注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
|
|
67
|
+
*/
|
|
68
68
|
async CreateDocument(req, cb) {
|
|
69
69
|
return this.request("CreateDocument", req, cb);
|
|
70
70
|
}
|
|
71
71
|
/**
|
|
72
|
-
|
|
73
|
-
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
74
|
-
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
75
|
-
|
|
72
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
73
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
74
|
+
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
75
|
+
*/
|
|
76
76
|
async CreateMultiFlowSignQRCode(req, cb) {
|
|
77
77
|
return this.request("CreateMultiFlowSignQRCode", req, cb);
|
|
78
78
|
}
|
|
@@ -89,10 +89,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
89
89
|
return this.request("CreateFlowEvidenceReport", req, cb);
|
|
90
90
|
}
|
|
91
91
|
/**
|
|
92
|
-
|
|
93
|
-
适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
|
|
94
|
-
注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
|
|
95
|
-
|
|
92
|
+
* 创建签署流程
|
|
93
|
+
适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
|
|
94
|
+
注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
|
|
95
|
+
*/
|
|
96
96
|
async CreateFlow(req, cb) {
|
|
97
97
|
return this.request("CreateFlow", req, cb);
|
|
98
98
|
}
|
|
@@ -103,18 +103,18 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
103
103
|
return this.request("CancelMultiFlowSignQRCode", req, cb);
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
109
|
-
|
|
110
|
-
注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
跳转到小程序的实现,参考官方文档(分为<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>两种方式)
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
|
|
117
|
-
|
|
106
|
+
* 获取小程序跳转链接
|
|
107
|
+
|
|
108
|
+
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
109
|
+
|
|
110
|
+
注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
跳转到小程序的实现,参考官方文档(分为<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>两种方式)
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
|
|
117
|
+
*/
|
|
118
118
|
async CreateSchemeUrl(req, cb) {
|
|
119
119
|
return this.request("CreateSchemeUrl", req, cb);
|
|
120
120
|
}
|
|
@@ -131,41 +131,41 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
131
131
|
return this.request("CreateConvertTaskApi", req, cb);
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
|
|
135
|
-
适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
|
|
136
|
-
|
|
134
|
+
* 二期接口-查询模板
|
|
135
|
+
适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
|
|
136
|
+
*/
|
|
137
137
|
async DescribeFlowTemplates(req, cb) {
|
|
138
138
|
return this.request("DescribeFlowTemplates", req, cb);
|
|
139
139
|
}
|
|
140
140
|
/**
|
|
141
|
-
|
|
142
|
-
客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
|
143
|
-
|
|
141
|
+
* 电子签企业版:指定需要批量撤回的签署流程Id,获取批量撤销链接
|
|
142
|
+
客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
|
143
|
+
*/
|
|
144
144
|
async CreateBatchCancelFlowUrl(req, cb) {
|
|
145
145
|
return this.request("CreateBatchCancelFlowUrl", req, cb);
|
|
146
146
|
}
|
|
147
147
|
/**
|
|
148
|
-
|
|
149
|
-
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
150
|
-
日调用量默认10W
|
|
151
|
-
|
|
148
|
+
* 查询流程摘要
|
|
149
|
+
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
150
|
+
日调用量默认10W
|
|
151
|
+
*/
|
|
152
152
|
async DescribeFlowBriefs(req, cb) {
|
|
153
153
|
return this.request("DescribeFlowBriefs", req, cb);
|
|
154
154
|
}
|
|
155
155
|
/**
|
|
156
|
-
|
|
157
|
-
适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
|
|
158
|
-
适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
|
|
159
|
-
注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
|
|
160
|
-
|
|
156
|
+
* 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
|
|
157
|
+
适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
|
|
158
|
+
适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
|
|
159
|
+
注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
|
|
160
|
+
*/
|
|
161
161
|
async CreateFlowByFiles(req, cb) {
|
|
162
162
|
return this.request("CreateFlowByFiles", req, cb);
|
|
163
163
|
}
|
|
164
164
|
/**
|
|
165
|
-
|
|
166
|
-
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
|
|
167
|
-
调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
|
|
168
|
-
|
|
165
|
+
* 此接口(UploadFiles)用于文件上传。
|
|
166
|
+
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
|
|
167
|
+
调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
|
|
168
|
+
*/
|
|
169
169
|
async UploadFiles(req, cb) {
|
|
170
170
|
return this.request("UploadFiles", req, cb);
|
|
171
171
|
}
|