tencentcloud-sdk-nodejs-essbasic 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.
- package/CHANGELOG.md +298 -0
- package/SERVICE_CHANGELOG.md +401 -6
- package/package.json +1 -1
- package/products.md +16 -16
- package/src/services/essbasic/index.ts +2 -2
- package/src/services/essbasic/v20210526/essbasic_client.ts +162 -114
- package/src/services/essbasic/v20210526/essbasic_models.ts +356 -129
- package/tencentcloud/services/essbasic/index.d.ts +4 -4
- package/tencentcloud/services/essbasic/index.js +2 -2
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +134 -94
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +140 -98
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +354 -129
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export declare const essbasic: {
|
|
2
|
-
v20210526: {
|
|
3
|
-
Client: typeof import("./v20210526/essbasic_client").Client;
|
|
4
|
-
Models: typeof import("./v20210526/essbasic_models");
|
|
5
|
-
};
|
|
6
2
|
v20201222: {
|
|
7
3
|
Client: typeof import("./v20201222/essbasic_client").Client;
|
|
8
4
|
Models: typeof import("./v20201222/essbasic_models");
|
|
9
5
|
};
|
|
6
|
+
v20210526: {
|
|
7
|
+
Client: typeof import("./v20210526/essbasic_client").Client;
|
|
8
|
+
Models: typeof import("./v20210526/essbasic_models");
|
|
9
|
+
};
|
|
10
10
|
};
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.essbasic = void 0;
|
|
4
|
-
const v20210526_1 = require("./v20210526");
|
|
5
4
|
const v20201222_1 = require("./v20201222");
|
|
5
|
+
const v20210526_1 = require("./v20210526");
|
|
6
6
|
exports.essbasic = {
|
|
7
|
-
v20210526: v20210526_1.v20210526,
|
|
8
7
|
v20201222: v20201222_1.v20201222,
|
|
8
|
+
v20210526: v20210526_1.v20210526,
|
|
9
9
|
};
|
|
@@ -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,
|
|
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
|
-
|
|
169
|
+
ChannelDescribeRoles(req: ChannelDescribeRolesRequest, cb?: (error: string, rep: ChannelDescribeRolesResponse) => void): Promise<ChannelDescribeRolesResponse>;
|
|
165
170
|
/**
|
|
166
|
-
|
|
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)用于获取第三方平台所有合作企业流量消耗情况。
|
|
@@ -175,11 +187,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
175
187
|
* 撤销签署流程接口
|
|
176
188
|
|
|
177
189
|
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
178
|
-
|
|
179
|
-
|
|
190
|
+
|
|
191
|
+
- **可撤回合同状态**:未全部签署完成
|
|
192
|
+
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
193
|
+
|
|
180
194
|
注:
|
|
181
|
-
<
|
|
182
|
-
|
|
195
|
+
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
|
|
196
|
+
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
183
197
|
*/
|
|
184
198
|
ChannelCancelFlow(req: ChannelCancelFlowRequest, cb?: (error: string, rep: ChannelCancelFlowResponse) => void): Promise<ChannelCancelFlowResponse>;
|
|
185
199
|
/**
|
|
@@ -196,13 +210,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
196
210
|
*/
|
|
197
211
|
ChannelCreateSealPolicy(req: ChannelCreateSealPolicyRequest, cb?: (error: string, rep: ChannelCreateSealPolicyResponse) => void): Promise<ChannelCreateSealPolicyResponse>;
|
|
198
212
|
/**
|
|
199
|
-
*
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
213
|
+
* 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
|
|
214
|
+
`注意:`<br/>
|
|
215
|
+
`1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
|
|
216
|
+
`2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
|
|
217
|
+
`3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
|
|
218
|
+
`4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
|
|
219
|
+
`5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
|
|
220
|
+
跳转到小程序的实现,参考微信官方文档(分为<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
221
|
*/
|
|
205
|
-
|
|
222
|
+
ChannelCreateBatchQuickSignUrl(req: ChannelCreateBatchQuickSignUrlRequest, cb?: (error: string, rep: ChannelCreateBatchQuickSignUrlResponse) => void): Promise<ChannelCreateBatchQuickSignUrlResponse>;
|
|
206
223
|
/**
|
|
207
224
|
* 接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。
|
|
208
225
|
如若在模板中配置了动态表格, 上传的附件必须为A4大小
|
|
@@ -282,15 +299,27 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
282
299
|
/**
|
|
283
300
|
* 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
|
|
284
301
|
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
302
|
+
**一个模板通常会包含以下结构信息**
|
|
303
|
+
|
|
304
|
+
- 模板模版ID, 模板名字等基本信息
|
|
305
|
+
- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
|
|
306
|
+
- 发起方和签署方的填写控件 Components
|
|
307
|
+
- 签署方的签署控件 SignComponents
|
|
308
|
+
|
|
309
|
+
**适用场景**
|
|
310
|
+
该接口常用来配合<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>接口,作为创建合同的前置接口使用。
|
|
311
|
+
通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
|
|
312
|
+
|
|
313
|
+
**模版的来源**
|
|
314
|
+
子客企业的模板有两种途径获取
|
|
315
|
+
- 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
|
|
316
|
+
- 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
**注意**
|
|
320
|
+
|
|
321
|
+
>1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在,即可查询同时满足这些条件的模板。
|
|
322
|
+
>2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
|
|
294
323
|
*/
|
|
295
324
|
DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
|
|
296
325
|
/**
|
|
@@ -363,15 +392,15 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
363
392
|
*/
|
|
364
393
|
ChannelCreatePrepareFlow(req: ChannelCreatePrepareFlowRequest, cb?: (error: string, rep: ChannelCreatePrepareFlowResponse) => void): Promise<ChannelCreatePrepareFlowResponse>;
|
|
365
394
|
/**
|
|
366
|
-
*
|
|
367
|
-
客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
|
|
368
|
-
接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;
|
|
395
|
+
* 通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
|
|
369
396
|
|
|
370
|
-
|
|
371
|
-
不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
397
|
+
适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
372
398
|
|
|
373
|
-
|
|
374
|
-
|
|
399
|
+
- **可撤回合同状态**:未全部签署完成
|
|
400
|
+
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
401
|
+
|
|
402
|
+
注:
|
|
403
|
+
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
375
404
|
*/
|
|
376
405
|
ChannelCreateBatchCancelFlowUrl(req: ChannelCreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: ChannelCreateBatchCancelFlowUrlResponse) => void): Promise<ChannelCreateBatchCancelFlowUrlResponse>;
|
|
377
406
|
/**
|
|
@@ -381,8 +410,12 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
381
410
|
*/
|
|
382
411
|
ChannelDeleteRole(req: ChannelDeleteRoleRequest, cb?: (error: string, rep: ChannelDeleteRoleResponse) => void): Promise<ChannelDeleteRoleResponse>;
|
|
383
412
|
/**
|
|
384
|
-
*
|
|
385
|
-
|
|
413
|
+
* 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
|
|
414
|
+
前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
|
|
415
|
+
|
|
416
|
+
适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />
|
|
417
|
+
注:
|
|
418
|
+
1. `大文件转换所需的时间可能会比较长`
|
|
386
419
|
*/
|
|
387
420
|
ChannelGetTaskResultApi(req: ChannelGetTaskResultApiRequest, cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void): Promise<ChannelGetTaskResultApiResponse>;
|
|
388
421
|
/**
|
|
@@ -442,17 +475,23 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
442
475
|
*/
|
|
443
476
|
ChannelCreateWebThemeConfig(req: ChannelCreateWebThemeConfigRequest, cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void): Promise<ChannelCreateWebThemeConfigResponse>;
|
|
444
477
|
/**
|
|
445
|
-
*
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
注意:该接口无法直接调用,请联系客户经理申请使用。
|
|
478
|
+
* 该接口用于发起合同后,生成C端签署人的签署链接<br/>
|
|
479
|
+
注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
|
|
480
|
+
注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
|
|
481
|
+
注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
|
|
451
482
|
*/
|
|
452
|
-
|
|
483
|
+
ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
|
|
453
484
|
/**
|
|
454
|
-
*
|
|
455
|
-
|
|
485
|
+
* 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
|
|
486
|
+
解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。
|
|
487
|
+
|
|
488
|
+
注意:
|
|
489
|
+
<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
|
|
490
|
+
<li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>
|
|
491
|
+
<li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>
|
|
492
|
+
<li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
|
|
493
|
+
<li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
|
|
494
|
+
<li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li></ul>
|
|
456
495
|
*/
|
|
457
496
|
ChannelCreateReleaseFlow(req: ChannelCreateReleaseFlowRequest, cb?: (error: string, rep: ChannelCreateReleaseFlowResponse) => void): Promise<ChannelCreateReleaseFlowResponse>;
|
|
458
497
|
/**
|
|
@@ -460,28 +499,22 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
460
499
|
*/
|
|
461
500
|
ChannelDescribeEmployees(req: ChannelDescribeEmployeesRequest, cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void): Promise<ChannelDescribeEmployeesResponse>;
|
|
462
501
|
/**
|
|
463
|
-
*
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
-
|
|
468
|
-
-
|
|
469
|
-
|
|
470
|
-
- 已撤回
|
|
471
|
-
- 拒绝填写
|
|
472
|
-
- 已解除
|
|
473
|
-
|
|
474
|
-
<br/>
|
|
475
|
-
满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
|
|
476
|
-
<br/><br/>
|
|
502
|
+
* 通过合同编号批量撤销合同,单次最多支持撤销100份合同。
|
|
503
|
+
|
|
504
|
+
适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
505
|
+
|
|
506
|
+
- **可撤回合同状态**:未全部签署完成
|
|
507
|
+
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
508
|
+
|
|
477
509
|
注:
|
|
478
|
-
|
|
510
|
+
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
|
|
511
|
+
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
479
512
|
*/
|
|
480
513
|
ChannelBatchCancelFlows(req: ChannelBatchCancelFlowsRequest, cb?: (error: string, rep: ChannelBatchCancelFlowsResponse) => void): Promise<ChannelBatchCancelFlowsResponse>;
|
|
481
514
|
/**
|
|
482
515
|
* 该接口 (PrepareFlows) 用于创建待发起文件
|
|
483
516
|
用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
|
|
484
|
-
目前该接口只支持B2C
|
|
517
|
+
目前该接口只支持B2C,<font color='red'> **不建议使用,将会废弃**</font>。
|
|
485
518
|
*/
|
|
486
519
|
PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
|
|
487
520
|
/**
|
|
@@ -505,10 +538,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
505
538
|
*/
|
|
506
539
|
ChannelCreateFlowApprovers(req: ChannelCreateFlowApproversRequest, cb?: (error: string, rep: ChannelCreateFlowApproversResponse) => void): Promise<ChannelCreateFlowApproversResponse>;
|
|
507
540
|
/**
|
|
508
|
-
*
|
|
509
|
-
|
|
541
|
+
* 此接口(ChannelCreateRole)用来创建企业自定义角色。
|
|
542
|
+
|
|
543
|
+
适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
|
|
544
|
+
|
|
545
|
+
适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
510
546
|
*/
|
|
511
|
-
|
|
547
|
+
ChannelCreateRole(req: ChannelCreateRoleRequest, cb?: (error: string, rep: ChannelCreateRoleResponse) => void): Promise<ChannelCreateRoleResponse>;
|
|
512
548
|
/**
|
|
513
549
|
* 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同
|
|
514
550
|
|
|
@@ -549,12 +585,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
549
585
|
*/
|
|
550
586
|
UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
|
|
551
587
|
/**
|
|
552
|
-
*
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
588
|
+
* 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
|
|
589
|
+
|
|
590
|
+
1. 合同中当前状态为“待签署”的签署人是催办的对象
|
|
591
|
+
2. 每个合同只能催办一次
|
|
592
|
+
|
|
593
|
+
注意:该接口无法直接调用,请联系客户经理申请使用。
|
|
556
594
|
*/
|
|
557
|
-
|
|
595
|
+
ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
|
|
558
596
|
/**
|
|
559
597
|
* 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称,企业营业执照,企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意:
|
|
560
598
|
1. 需要在子客企业激活前调用该接口,如果您的企业已经提交企业信息或者企业已经激活,同步的企业信息将不会生效。
|
|
@@ -769,8 +807,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
769
807
|
*/
|
|
770
808
|
DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
|
|
771
809
|
/**
|
|
772
|
-
|
|
773
|
-
|
|
810
|
+
* 获取个人用户自动签的开通链接。
|
|
811
|
+
|
|
812
|
+
注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
813
|
+
*/
|
|
774
814
|
ChannelCreateUserAutoSignEnableUrl(req: ChannelCreateUserAutoSignEnableUrlRequest, cb?: (error: string, rep: ChannelCreateUserAutoSignEnableUrlResponse) => void): Promise<ChannelCreateUserAutoSignEnableUrlResponse>;
|
|
775
815
|
/**
|
|
776
816
|
* 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
|