tencentcloud-sdk-nodejs 4.1.307 → 4.1.308
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/es/common/sdk_version.js +1 -1
- package/es/services/dlc/v20210125/dlc_client.js +2 -5
- package/es/services/essbasic/v20210526/essbasic_client.js +0 -6
- package/es/services/live/v20180801/live_client.js +9 -0
- package/es/services/mongodb/v20190725/mongodb_client.js +6 -0
- package/es/services/mps/v20190612/mps_client.js +3 -0
- package/package.json +1 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +2 -2
- package/tencentcloud/services/batch/v20170312/batch_models.d.ts +1 -1
- package/tencentcloud/services/bh/v20230418/bh_models.d.ts +9 -1
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +8 -0
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
- package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +3 -7
- package/tencentcloud/services/dlc/v20210125/dlc_client.js +3 -9
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +12 -91
- package/tencentcloud/services/es/v20180416/es_models.d.ts +19 -15
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +2 -2
- package/tencentcloud/services/ess/v20201111/ess_client.js +2 -2
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +7 -7
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +2 -25
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -28
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +32 -187
- package/tencentcloud/services/live/v20180801/live_client.d.ts +13 -1
- package/tencentcloud/services/live/v20180801/live_client.js +18 -0
- package/tencentcloud/services/live/v20180801/live_models.d.ts +265 -50
- package/tencentcloud/services/mna/v20210119/mna_models.d.ts +15 -8
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +9 -1
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +12 -0
- package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +48 -0
- package/tencentcloud/services/mps/v20190612/mps_client.d.ts +7 -1
- package/tencentcloud/services/mps/v20190612/mps_client.js +8 -0
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +60 -0
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +0 -48
- package/tencentcloud/services/ocr/v20181119/ocr_client.js +0 -48
- package/tencentcloud/services/rce/v20260130/rce_models.d.ts +8 -0
- package/tencentcloud/services/redis/v20180412/redis_models.d.ts +2 -2
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +1 -1
- package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +13 -12
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +29 -8
- package/tencentcloud/services/tokenhub/v20260322/tokenhub_models.d.ts +8 -0
|
@@ -842,7 +842,7 @@ export declare class Client extends AbstractClient {
|
|
|
842
842
|
| 个人(自然人) | 1 | 个人真实姓名、个人触达手机号、身份证号(非必传) | ApproverName + ApproverMobile |
|
|
843
843
|
|
|
844
844
|
|
|
845
|
-
该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/
|
|
845
|
+
该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask)接口转换成pdf资源)<br/>
|
|
846
846
|
|
|
847
847
|
## 整体流程图
|
|
848
848
|

|
|
@@ -1360,7 +1360,7 @@ IV:fedcba0987654321
|
|
|
1360
1360
|
|
|
1361
1361
|
适用场景:用于合同,印章的文件上传。文件上传以后,
|
|
1362
1362
|
如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
|
|
1363
|
-
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/
|
|
1363
|
+
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
1364
1364
|
|
|
1365
1365
|
注:
|
|
1366
1366
|
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
@@ -1006,7 +1006,7 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
1006
1006
|
| 个人(自然人) | 1 | 个人真实姓名、个人触达手机号、身份证号(非必传) | ApproverName + ApproverMobile |
|
|
1007
1007
|
|
|
1008
1008
|
|
|
1009
|
-
该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/
|
|
1009
|
+
该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask)接口转换成pdf资源)<br/>
|
|
1010
1010
|
|
|
1011
1011
|
## 整体流程图
|
|
1012
1012
|

|
|
@@ -1598,7 +1598,7 @@ IV:fedcba0987654321
|
|
|
1598
1598
|
|
|
1599
1599
|
适用场景:用于合同,印章的文件上传。文件上传以后,
|
|
1600
1600
|
如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
|
|
1601
|
-
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/
|
|
1601
|
+
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
1602
1602
|
|
|
1603
1603
|
注:
|
|
1604
1604
|
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
@@ -237,7 +237,7 @@ export interface DisableUserAutoSignRequest {
|
|
|
237
237
|
*/
|
|
238
238
|
export interface UploadFilesRequest {
|
|
239
239
|
/**
|
|
240
|
-
* <p>文件对应业务类型,可以选择的类型如下</p><p>枚举值:</p><ul><li>TEMPLATE: 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT: 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件,用来发起流程,还需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/
|
|
240
|
+
* <p>文件对应业务类型,可以选择的类型如下</p><p>枚举值:</p><ul><li>TEMPLATE: 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT: 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件,用来发起流程,还需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同,直接上传后使用返回的文件资源Id即可</li><li>SEAL: 此文件用于印章的生成,文件类型支持.jpg/.jpeg/.png</li><li>ARCHIVE: 此文件用于归档文件夹,文件类型支持.pdf/.zip格式</li><li>BUSINESSLICENSE: 此文件用于上传营业执照,用于后续<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl" target="_blank">创建企业认证链接</a>认证企业的时候提供营业执照,文件类型支持.jpg/.jpeg/.png,限制8M以内</li></ul>
|
|
241
241
|
*/
|
|
242
242
|
BusinessType: string;
|
|
243
243
|
/**
|
|
@@ -10795,13 +10795,13 @@ export interface DescribeRiskIdentificationTaskFeedbackResponse {
|
|
|
10795
10795
|
*/
|
|
10796
10796
|
export interface SignComponentConfig {
|
|
10797
10797
|
/**
|
|
10798
|
-
*
|
|
10799
|
-
|
|
10800
|
-
- false 展示签署日期(默认)
|
|
10801
|
-
- true 不展示签署日期
|
|
10802
|
-
。
|
|
10798
|
+
* <p>签署控件默认属性配置,是否默认展示签署日期, 在页面中可以进行修改。</p><ul><li>false 展示签署日期(默认)</li><li>true 不展示签署日期<br><img src="https://qcloudimg.tencent-cloud.cn/raw/448514412e2f69f6129425beda4ff568.png" alt="image">。</li></ul>
|
|
10803
10799
|
*/
|
|
10804
10800
|
HideDate?: boolean;
|
|
10801
|
+
/**
|
|
10802
|
+
* <p>【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件(SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL)时,「盖章区适配签署方印章尺寸」开关的控制策略</p><p>枚举值:</p><ul><li>0: 默认关闭,可开启。与现网一致</li><li>1: 关闭且置灰——按控件默认的4.2cm尺寸盖章,签署方无法开启开关</li><li>2: 默认开启且可修改——默认按印章实际尺寸盖章,签署方可手动关闭</li><li>3: 开启且置灰——强制按印章实际尺寸盖章,签署方不可修改</li></ul>
|
|
10803
|
+
*/
|
|
10804
|
+
AddSignComponentUseSealSize?: number;
|
|
10805
10805
|
}
|
|
10806
10806
|
/**
|
|
10807
10807
|
* DescribeInformationExtractionWebUrl请求参数结构体
|
|
@@ -12314,7 +12314,7 @@ export interface CreateEmbedWebUrlRequest {
|
|
|
12314
12314
|
*/
|
|
12315
12315
|
EmbedType: string;
|
|
12316
12316
|
/**
|
|
12317
|
-
* <p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为PREVIEW_SEAL_DETAIL,必填,取值为印章id。</li><li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id。</li><li>为CREATE_CONTRACT_DRAFT_COOPEDIT,非必填,取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id。</li></ul><p>注意:</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/
|
|
12317
|
+
* <p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为PREVIEW_SEAL_DETAIL,必填,取值为印章id。</li><li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id。</li><li>为CREATE_CONTRACT_DRAFT_COOPEDIT,非必填,取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id。</li></ul><p>注意:</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask">创建文件转换任务</a> 和<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask">查询转换任务状态</a> 来进行转换成PDF资源。</li><li>CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件,并且大小不能超过 10M。</li></ol>
|
|
12318
12318
|
*/
|
|
12319
12319
|
BusinessId?: string;
|
|
12320
12320
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { SyncProxyOrganizationResponse,
|
|
3
|
+
import { SyncProxyOrganizationResponse, DescribeCancelFlowsTaskResponse, CreateBatchAdminChangeInvitationsResponse, ChannelCreateFlowRemindsResponse, DescribeUserFlowTypeResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDescribeSignFaceVideoRequest, ChannelDisableUserAutoSignResponse, DescribeExtendedServiceAuthDetailResponse, CreateLegalSealQrCodeResponse, CreateEmployeeQualificationSealQrCodeResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, CreateFlowForwardsRequest, DescribeFlowDetailInfoRequest, ChannelCancelFlowResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateFileConvertTaskRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, DescribeFileConvertTaskResponse, ChannelCreateBatchSignUrlResponse, CreateBatchAdminChangeInvitationsUrlRequest, ChannelCreatePrepareFlowResponse, CreateBatchInitOrganizationUrlResponse, OperateChannelTemplateResponse, ChannelCreateDynamicFlowApproverResponse, ChannelCreateRoleRequest, CreateOrganizationAuthFileResponse, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, ChannelCreatePrepareFlowRequest, ChannelCreateFlowSignUrlRequest, ChannelCreateSealPolicyResponse, OperateTemplateRequest, ChannelDescribeSignFaceVideoResponse, ChannelCancelUserAutoSignEnableUrlResponse, ChannelCreateWebThemeConfigRequest, CancelOrganizationFlowsResponse, CreateFlowGroupSignReviewResponse, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, DescribeFileConvertTaskRequest, ChannelCreateOrganizationModifyQrCodeRequest, CreateChannelSubOrganizationActiveRequest, ChannelRenewAutoSignLicenseResponse, ModifyOrganizationBusinessInfoResponse, ChannelDescribeRolesRequest, DescribeBatchOrganizationRegistrationUrlsRequest, PrepareFlowsResponse, CreateRequestWithEncryptionResponse, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, CreateBatchOrganizationRegistrationTasksResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, DeleteOrganizationAuthorizationsResponse, ChannelCreatePrepareFlowGroupRequest, DescribeExtendedServiceAuthDetailRequest, CreateOrganizationAuthFileRequest, ChannelVerifyPdfResponse, ArchiveDynamicFlowResponse, CreateConsoleLoginUrlRequest, CreateLegalSealQrCodeRequest, CreateCloseOrganizationUrlRequest, CreatePersonAuthCertificateImageResponse, ModifyPartnerAutoSignAuthUrlRequest, CreateEmployeeQualificationSealQrCodeRequest, DescribeBatchOrganizationRegistrationTasksRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, CreateRequestWithEncryptionRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, CreateCloseOrganizationUrlResponse, DescribeChannelSealPolicyWorkflowUrlRequest, CreatePartnerAutoSignAuthUrlResponse, ArchiveDynamicFlowRequest, ChannelCreateDynamicFlowApproverRequest, ModifyFlowDeadlineResponse, DescribeFlowDetailInfoResponse, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, OperateTemplateResponse, CreateFlowBlockchainEvidenceUrlResponse, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, CreateBatchAdminChangeInvitationsUrlResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, DescribeChannelOrganizationsRequest, ChannelDescribeBillUsageDetailResponse, CreateEmployeeChangeUrlResponse, ChannelRenewAutoSignLicenseRequest, ChannelCreatePreparedPersonalEsignRequest, CancelOrganizationFlowsRequest, CreatePersonAuthCertificateImageRequest, PrepareFlowsRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, CreateEmployeeChangeUrlRequest, ChannelDescribeUserAutoSignStatusRequest, CreateModifyAdminAuthorizationUrlRequest, ChannelModifyRoleResponse, ModifyOrganizationBusinessInfoRequest, CreateSignUrlsResponse, ChannelDeleteRoleRequest, CreateBatchOrganizationRegistrationTasksRequest, ChannelCreateBatchQuickSignUrlResponse, CreateBatchOrganizationAuthorizationUrlResponse, CreatePartnerAutoSignAuthUrlRequest, DescribeBatchOrganizationRegistrationTasksResponse, ChannelCreateBatchCancelFlowUrlRequest, ChannelDescribeAccountBillDetailResponse, CreateFlowForwardsResponse, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, CreateChannelSubOrganizationActiveResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, DeleteOrganizationAuthorizationsRequest, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreatePrepareFlowGroupResponse, DescribeCancelFlowsTaskRequest, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelCreateBatchSignUrlRequest, ChannelUpdateSealStatusResponse, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ModifyFlowDeadlineRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, CreateBatchInitOrganizationUrlRequest, CreateFlowGroupSignReviewRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateBatchAdminChangeInvitationsRequest, CreateFlowsByTemplatesRequest, DescribeBatchOrganizationRegistrationUrlsResponse, UploadFilesRequest, CreateSealByImageRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, CreateBatchOrganizationAuthorizationUrlRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeAccountBillDetailRequest, ChannelDescribeEmployeesResponse, CreateModifyAdminAuthorizationUrlResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, SyncProxyOrganizationRequest, DescribeChannelFlowEvidenceReportResponse, ModifyPartnerAutoSignAuthUrlResponse, CreateFlowBlockchainEvidenceUrlRequest, DescribeUserFlowTypeRequest, ChannelCreateFlowApproversRequest, ChannelDescribeBillUsageDetailRequest, ChannelCreateFlowRemindsRequest, DescribeExtendedServiceAuthInfoResponse, CreateFileConvertTaskResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
|
|
4
4
|
/**
|
|
5
5
|
* essbasic client
|
|
6
6
|
* @class
|
|
@@ -373,18 +373,6 @@ export declare class Client extends AbstractClient {
|
|
|
373
373
|
注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
|
|
374
374
|
*/
|
|
375
375
|
DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
|
|
376
|
-
/**
|
|
377
|
-
* 此接口(ChannelCreateConvertTaskApi)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
|
|
378
|
-
前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
|
|
379
|
-
适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
|
|
380
|
-
适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
|
|
381
|
-
转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
|
|
382
|
-
<font color="red">此接口于 2026 年 12月 31 日下线</font>,请使用新接口: <a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">新建文件转换任务(CreateFileConvertTask)</a><br />
|
|
383
|
-
注:
|
|
384
|
-
1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
|
|
385
|
-
2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
|
|
386
|
-
*/
|
|
387
|
-
ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse>;
|
|
388
376
|
/**
|
|
389
377
|
* 撤销签署流程接口
|
|
390
378
|
|
|
@@ -936,17 +924,6 @@ IV:fedcba0987654321
|
|
|
936
924
|

|
|
937
925
|
*/
|
|
938
926
|
CreateEmployeeQualificationSealQrCode(req: CreateEmployeeQualificationSealQrCodeRequest, cb?: (error: string, rep: CreateEmployeeQualificationSealQrCodeResponse) => void): Promise<CreateEmployeeQualificationSealQrCodeResponse>;
|
|
939
|
-
/**
|
|
940
|
-
* 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
|
|
941
|
-
前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
|
|
942
|
-
|
|
943
|
-
适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源ID。<br />
|
|
944
|
-
<font color="red">此接口于 2026 年 12月 31 日下线</font>,请使用新接口: <a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask" target="_blank">查询文件转换任务状态(DescribeFileConvertTask)</a><br />
|
|
945
|
-
注:
|
|
946
|
-
1. `大文件转换所需的时间可能会比较长。`
|
|
947
|
-
2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`
|
|
948
|
-
*/
|
|
949
|
-
ChannelGetTaskResultApi(req: ChannelGetTaskResultApiRequest, cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void): Promise<ChannelGetTaskResultApiResponse>;
|
|
950
927
|
/**
|
|
951
928
|
* 获取设置自动签印章小程序链接。
|
|
952
929
|
|
|
@@ -1033,7 +1010,7 @@ IV:fedcba0987654321
|
|
|
1033
1010
|
|
|
1034
1011
|
适用场景:用于合同,印章的文件上传。文件上传以后,
|
|
1035
1012
|
如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
|
|
1036
|
-
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/
|
|
1013
|
+
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
1037
1014
|
|
|
1038
1015
|
注:
|
|
1039
1016
|
1. 图片类型(png/jpg/jpeg)限制大小为8M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
@@ -443,20 +443,6 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
443
443
|
async DescribeUsage(req, cb) {
|
|
444
444
|
return this.request("DescribeUsage", req, cb);
|
|
445
445
|
}
|
|
446
|
-
/**
|
|
447
|
-
* 此接口(ChannelCreateConvertTaskApi)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
|
|
448
|
-
前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
|
|
449
|
-
适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
|
|
450
|
-
适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
|
|
451
|
-
转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
|
|
452
|
-
<font color="red">此接口于 2026 年 12月 31 日下线</font>,请使用新接口: <a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">新建文件转换任务(CreateFileConvertTask)</a><br />
|
|
453
|
-
注:
|
|
454
|
-
1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
|
|
455
|
-
2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
|
|
456
|
-
*/
|
|
457
|
-
async ChannelCreateConvertTaskApi(req, cb) {
|
|
458
|
-
return this.request("ChannelCreateConvertTaskApi", req, cb);
|
|
459
|
-
}
|
|
460
446
|
/**
|
|
461
447
|
* 撤销签署流程接口
|
|
462
448
|
|
|
@@ -1072,19 +1058,6 @@ IV:fedcba0987654321
|
|
|
1072
1058
|
async CreateEmployeeQualificationSealQrCode(req, cb) {
|
|
1073
1059
|
return this.request("CreateEmployeeQualificationSealQrCode", req, cb);
|
|
1074
1060
|
}
|
|
1075
|
-
/**
|
|
1076
|
-
* 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
|
|
1077
|
-
前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
|
|
1078
|
-
|
|
1079
|
-
适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源ID。<br />
|
|
1080
|
-
<font color="red">此接口于 2026 年 12月 31 日下线</font>,请使用新接口: <a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask" target="_blank">查询文件转换任务状态(DescribeFileConvertTask)</a><br />
|
|
1081
|
-
注:
|
|
1082
|
-
1. `大文件转换所需的时间可能会比较长。`
|
|
1083
|
-
2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`
|
|
1084
|
-
*/
|
|
1085
|
-
async ChannelGetTaskResultApi(req, cb) {
|
|
1086
|
-
return this.request("ChannelGetTaskResultApi", req, cb);
|
|
1087
|
-
}
|
|
1088
1061
|
/**
|
|
1089
1062
|
* 获取设置自动签印章小程序链接。
|
|
1090
1063
|
|
|
@@ -1181,7 +1154,7 @@ IV:fedcba0987654321
|
|
|
1181
1154
|
|
|
1182
1155
|
适用场景:用于合同,印章的文件上传。文件上传以后,
|
|
1183
1156
|
如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
|
|
1184
|
-
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/
|
|
1157
|
+
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
1185
1158
|
|
|
1186
1159
|
注:
|
|
1187
1160
|
1. 图片类型(png/jpg/jpeg)限制大小为8M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
@@ -17,13 +17,25 @@ export interface FlowBatchUrlInfo {
|
|
|
17
17
|
FlowBatchApproverInfos?: Array<FlowBatchApproverInfo>;
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* DescribeCancelFlowsTask返回参数结构体
|
|
21
21
|
*/
|
|
22
|
-
export interface
|
|
22
|
+
export interface DescribeCancelFlowsTaskResponse {
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* <p>批量撤销任务编号,为32位字符串。</p>
|
|
25
25
|
*/
|
|
26
26
|
TaskId?: string;
|
|
27
|
+
/**
|
|
28
|
+
* <p>任务状态,需要关注的状态<ul><li><strong>PROCESSING</strong> - 任务执行中</li><li><strong>END</strong> - 任务处理完成</li><li><strong>TIMEOUT</strong> 任务超时未处理完成,用户未在批量撤销链接有效期内操作</li></ul></p>
|
|
29
|
+
*/
|
|
30
|
+
TaskStatus?: string;
|
|
31
|
+
/**
|
|
32
|
+
* <p>批量撤销成功的签署流程编号</p>
|
|
33
|
+
*/
|
|
34
|
+
SuccessFlowIds?: Array<string>;
|
|
35
|
+
/**
|
|
36
|
+
* <p>批量撤销失败的签署流程信息</p>
|
|
37
|
+
*/
|
|
38
|
+
FailureFlows?: Array<CancelFailureFlow>;
|
|
27
39
|
/**
|
|
28
40
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
29
41
|
*/
|
|
@@ -372,31 +384,6 @@ export interface CommonApproverOption {
|
|
|
372
384
|
*/
|
|
373
385
|
ForbidModifySealInfos?: boolean;
|
|
374
386
|
}
|
|
375
|
-
/**
|
|
376
|
-
* DescribeCancelFlowsTask返回参数结构体
|
|
377
|
-
*/
|
|
378
|
-
export interface DescribeCancelFlowsTaskResponse {
|
|
379
|
-
/**
|
|
380
|
-
* <p>批量撤销任务编号,为32位字符串。</p>
|
|
381
|
-
*/
|
|
382
|
-
TaskId?: string;
|
|
383
|
-
/**
|
|
384
|
-
* <p>任务状态,需要关注的状态<ul><li><strong>PROCESSING</strong> - 任务执行中</li><li><strong>END</strong> - 任务处理完成</li><li><strong>TIMEOUT</strong> 任务超时未处理完成,用户未在批量撤销链接有效期内操作</li></ul></p>
|
|
385
|
-
*/
|
|
386
|
-
TaskStatus?: string;
|
|
387
|
-
/**
|
|
388
|
-
* <p>批量撤销成功的签署流程编号</p>
|
|
389
|
-
*/
|
|
390
|
-
SuccessFlowIds?: Array<string>;
|
|
391
|
-
/**
|
|
392
|
-
* <p>批量撤销失败的签署流程信息</p>
|
|
393
|
-
*/
|
|
394
|
-
FailureFlows?: Array<CancelFailureFlow>;
|
|
395
|
-
/**
|
|
396
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
397
|
-
*/
|
|
398
|
-
RequestId?: string;
|
|
399
|
-
}
|
|
400
387
|
/**
|
|
401
388
|
* CreateEmployeeQualificationSealQrCode返回参数结构体
|
|
402
389
|
*/
|
|
@@ -415,24 +402,19 @@ export interface CreateEmployeeQualificationSealQrCodeResponse {
|
|
|
415
402
|
*/
|
|
416
403
|
export interface ChannelCreateFlowGroupByTemplatesResponse {
|
|
417
404
|
/**
|
|
418
|
-
*
|
|
419
|
-
建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。
|
|
405
|
+
* <p>合同组ID,为32位字符串。<br>建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。</p>
|
|
420
406
|
*/
|
|
421
407
|
FlowGroupId?: string;
|
|
422
408
|
/**
|
|
423
|
-
*
|
|
424
|
-
|
|
425
|
-
注:
|
|
426
|
-
`此数组的顺序和入参中的FlowInfos顺序一致`
|
|
409
|
+
* <p>合同组中每个合同流程ID,每个ID均为32位字符串。</p><p>注:<br><code>此数组的顺序和入参中的FlowInfos顺序一致</code></p>
|
|
427
410
|
*/
|
|
428
411
|
FlowIds?: Array<string>;
|
|
429
412
|
/**
|
|
430
|
-
*
|
|
431
|
-
如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
|
|
413
|
+
* <p>复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;<br>如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询任务详情;</p>
|
|
432
414
|
*/
|
|
433
415
|
TaskInfos?: Array<TaskInfo>;
|
|
434
416
|
/**
|
|
435
|
-
*
|
|
417
|
+
* <p>合同组签署方信息</p>
|
|
436
418
|
*/
|
|
437
419
|
Approvers?: Array<FlowGroupApprovers>;
|
|
438
420
|
/**
|
|
@@ -1743,60 +1725,6 @@ export interface CreateFlowGroupSignReviewResponse {
|
|
|
1743
1725
|
*/
|
|
1744
1726
|
RequestId?: string;
|
|
1745
1727
|
}
|
|
1746
|
-
/**
|
|
1747
|
-
* ChannelCreateConvertTaskApi请求参数结构体
|
|
1748
|
-
*/
|
|
1749
|
-
export interface ChannelCreateConvertTaskApiRequest {
|
|
1750
|
-
/**
|
|
1751
|
-
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1752
|
-
|
|
1753
|
-
此接口下面信息必填。
|
|
1754
|
-
<ul>
|
|
1755
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
1756
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
1757
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
1758
|
-
</ul>
|
|
1759
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
1760
|
-
*/
|
|
1761
|
-
Agent: Agent;
|
|
1762
|
-
/**
|
|
1763
|
-
* 需要进行转换的资源文件类型
|
|
1764
|
-
支持的文件类型如下:
|
|
1765
|
-
<ul><li>doc</li>
|
|
1766
|
-
<li>docx</li>
|
|
1767
|
-
<li>xls</li>
|
|
1768
|
-
<li>xlsx</li>
|
|
1769
|
-
<li>jpg</li>
|
|
1770
|
-
<li>jpeg</li>
|
|
1771
|
-
<li>png</li>
|
|
1772
|
-
<li>bmp</li>
|
|
1773
|
-
<li>html</li>
|
|
1774
|
-
<li>txt</li></ul>
|
|
1775
|
-
*/
|
|
1776
|
-
ResourceType: string;
|
|
1777
|
-
/**
|
|
1778
|
-
* 需要进行转换操作的文件资源名称,带资源后缀名。
|
|
1779
|
-
|
|
1780
|
-
注: `资源名称长度限制为256个字符`
|
|
1781
|
-
*/
|
|
1782
|
-
ResourceName: string;
|
|
1783
|
-
/**
|
|
1784
|
-
* 需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
|
|
1785
|
-
|
|
1786
|
-
注: `目前,此接口仅支持单个文件进行转换。`
|
|
1787
|
-
*/
|
|
1788
|
-
ResourceId: string;
|
|
1789
|
-
/**
|
|
1790
|
-
* 调用方用户信息,不用传
|
|
1791
|
-
* @deprecated
|
|
1792
|
-
*/
|
|
1793
|
-
Operator?: UserInfo;
|
|
1794
|
-
/**
|
|
1795
|
-
* 暂未开放
|
|
1796
|
-
* @deprecated
|
|
1797
|
-
*/
|
|
1798
|
-
Organization?: OrganizationInfo;
|
|
1799
|
-
}
|
|
1800
1728
|
/**
|
|
1801
1729
|
* ChannelCreateFlowByFiles请求参数结构体
|
|
1802
1730
|
*/
|
|
@@ -2670,13 +2598,13 @@ export interface DynamicFlowApproverResult {
|
|
|
2670
2598
|
*/
|
|
2671
2599
|
export interface SignComponentConfig {
|
|
2672
2600
|
/**
|
|
2673
|
-
*
|
|
2674
|
-
|
|
2675
|
-
- false 展示签署日期(默认)
|
|
2676
|
-
- true 不展示签署日期
|
|
2677
|
-
。
|
|
2601
|
+
* <p>签署控件默认属性配置,是否默认展示签署日期, 在页面中可以进行修改。</p><ul><li>false 展示签署日期(默认)</li><li>true 不展示签署日期<br><img src="https://qcloudimg.tencent-cloud.cn/raw/448514412e2f69f6129425beda4ff568.png" alt="image">。</li></ul>
|
|
2678
2602
|
*/
|
|
2679
2603
|
HideDate?: boolean;
|
|
2604
|
+
/**
|
|
2605
|
+
* <p>【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件(SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL)时,「盖章区适配签署方印章尺寸」开关的控制策略</p><p>枚举值:</p><ul><li>0: 默认关闭,可开启。与现网一致</li><li>1: 关闭且置灰——按控件默认的4.2cm尺寸盖章,签署方无法开启开关</li><li>2: 默认开启且可修改——默认按印章实际尺寸盖章,签署方可手动关闭</li><li>3: 开启且置灰——强制按印章实际尺寸盖章,签署方不可修改</li></ul><p>默认值:0</p>
|
|
2606
|
+
*/
|
|
2607
|
+
AddSignComponentUseSealSize?: number;
|
|
2680
2608
|
}
|
|
2681
2609
|
/**
|
|
2682
2610
|
* GetDownloadFlowUrl返回参数结构体
|
|
@@ -5403,37 +5331,6 @@ export interface ChannelCreateUserAutoSignEnableUrlResponse {
|
|
|
5403
5331
|
*/
|
|
5404
5332
|
RequestId?: string;
|
|
5405
5333
|
}
|
|
5406
|
-
/**
|
|
5407
|
-
* ChannelGetTaskResultApi请求参数结构体
|
|
5408
|
-
*/
|
|
5409
|
-
export interface ChannelGetTaskResultApiRequest {
|
|
5410
|
-
/**
|
|
5411
|
-
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5412
|
-
|
|
5413
|
-
此接口下面信息必填。
|
|
5414
|
-
<ul>
|
|
5415
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
5416
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
5417
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
5418
|
-
</ul>
|
|
5419
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
5420
|
-
*/
|
|
5421
|
-
Agent: Agent;
|
|
5422
|
-
/**
|
|
5423
|
-
* 转换任务Id,通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
|
|
5424
|
-
*/
|
|
5425
|
-
TaskId: string;
|
|
5426
|
-
/**
|
|
5427
|
-
* 操作者的信息,不用传
|
|
5428
|
-
* @deprecated
|
|
5429
|
-
*/
|
|
5430
|
-
Operator?: UserInfo;
|
|
5431
|
-
/**
|
|
5432
|
-
* 暂未开放
|
|
5433
|
-
* @deprecated
|
|
5434
|
-
*/
|
|
5435
|
-
Organization?: OrganizationInfo;
|
|
5436
|
-
}
|
|
5437
5334
|
/**
|
|
5438
5335
|
* DescribeChannelOrganizations请求参数结构体
|
|
5439
5336
|
*/
|
|
@@ -5775,11 +5672,11 @@ export interface CreateFlowsByTemplatesResponse {
|
|
|
5775
5672
|
*/
|
|
5776
5673
|
ErrorMessages?: Array<string>;
|
|
5777
5674
|
/**
|
|
5778
|
-
* <p>合同预览链接URL数组。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL<br>如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83">合同文档合成完成回调</a>获取或使用返回的TaskInfo中的TaskId通过<a href="https://qian.tencent.com/developers/partnerApis/files/
|
|
5675
|
+
* <p>合同预览链接URL数组。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL<br>如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83">合同文档合成完成回调</a>获取或使用返回的TaskInfo中的TaskId通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询得到</p>
|
|
5779
5676
|
*/
|
|
5780
5677
|
PreviewUrls?: Array<string>;
|
|
5781
5678
|
/**
|
|
5782
|
-
* <p>复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;<br
|
|
5679
|
+
* <p>复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;<br>如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询任务详情;</p>
|
|
5783
5680
|
*/
|
|
5784
5681
|
TaskInfos?: Array<TaskInfo>;
|
|
5785
5682
|
/**
|
|
@@ -7576,49 +7473,6 @@ export interface ChannelCreateUserRolesRequest {
|
|
|
7576
7473
|
*/
|
|
7577
7474
|
Operator?: UserInfo;
|
|
7578
7475
|
}
|
|
7579
|
-
/**
|
|
7580
|
-
* ChannelGetTaskResultApi返回参数结构体
|
|
7581
|
-
*/
|
|
7582
|
-
export interface ChannelGetTaskResultApiResponse {
|
|
7583
|
-
/**
|
|
7584
|
-
* 任务Id
|
|
7585
|
-
*/
|
|
7586
|
-
TaskId?: string;
|
|
7587
|
-
/**
|
|
7588
|
-
* 任务状态,需要关注的状态
|
|
7589
|
-
<ul><li>**0** :NeedTranform - 任务已提交</li>
|
|
7590
|
-
<li>**4** :Processing - 文档转换中</li>
|
|
7591
|
-
<li>**8** :TaskEnd - 任务处理完成</li>
|
|
7592
|
-
<li>**-2** :DownloadFailed - 下载失败</li>
|
|
7593
|
-
<li>**-6** :ProcessFailed - 转换失败</li>
|
|
7594
|
-
<li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
|
|
7595
|
-
*/
|
|
7596
|
-
TaskStatus?: number;
|
|
7597
|
-
/**
|
|
7598
|
-
* 状态描述,需要关注的状态
|
|
7599
|
-
<ul><li> **NeedTranform** : 任务已提交</li>
|
|
7600
|
-
<li> **Processing** : 文档转换中</li>
|
|
7601
|
-
<li> **TaskEnd** : 任务处理完成</li>
|
|
7602
|
-
<li> **DownloadFailed** : 下载失败</li>
|
|
7603
|
-
<li> **ProcessFailed** : 转换失败</li>
|
|
7604
|
-
<li> **ProcessTimeout** : 转换文件超时</li></ul>
|
|
7605
|
-
*/
|
|
7606
|
-
TaskMessage?: string;
|
|
7607
|
-
/**
|
|
7608
|
-
* 资源Id(即FileId),用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)
|
|
7609
|
-
*/
|
|
7610
|
-
ResourceId?: string;
|
|
7611
|
-
/**
|
|
7612
|
-
* 预览文件Url,有效期30分钟
|
|
7613
|
-
当前字段返回为空,发起的时候,将ResourceId 放入发起即可
|
|
7614
|
-
* @deprecated
|
|
7615
|
-
*/
|
|
7616
|
-
PreviewUrl?: string;
|
|
7617
|
-
/**
|
|
7618
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
7619
|
-
*/
|
|
7620
|
-
RequestId?: string;
|
|
7621
|
-
}
|
|
7622
7476
|
/**
|
|
7623
7477
|
* 权限树中的权限组
|
|
7624
7478
|
*/
|
|
@@ -7993,24 +7847,15 @@ export interface ChannelUpdateSealStatusRequest {
|
|
|
7993
7847
|
*/
|
|
7994
7848
|
export interface ChannelCreateFlowGroupByTemplatesRequest {
|
|
7995
7849
|
/**
|
|
7996
|
-
*
|
|
7997
|
-
|
|
7998
|
-
此接口下面信息必填。
|
|
7999
|
-
<ul>
|
|
8000
|
-
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
|
|
8001
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(合同的发起企业)</li>
|
|
8002
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (合同的发起人)</li>
|
|
8003
|
-
</ul>
|
|
8004
|
-
|
|
8005
|
-
合同的发起企业和发起人必需已经完成实名,并加入企业
|
|
7850
|
+
* <p>合同的发起企业和发起人信息,<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a></p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(合同的发起企业)</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (合同的发起人)</li></ul><p>合同的发起企业和发起人必需已经完成实名,并加入企业</p>
|
|
8006
7851
|
*/
|
|
8007
7852
|
Agent: Agent;
|
|
8008
7853
|
/**
|
|
8009
|
-
*
|
|
7854
|
+
* <p>合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。</p>
|
|
8010
7855
|
*/
|
|
8011
7856
|
FlowInfos: Array<FlowInfo>;
|
|
8012
7857
|
/**
|
|
8013
|
-
*
|
|
7858
|
+
* <p>合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
|
|
8014
7859
|
*/
|
|
8015
7860
|
FlowGroupName: string;
|
|
8016
7861
|
}
|
|
@@ -8412,7 +8257,7 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
8412
8257
|
*/
|
|
8413
8258
|
FlowInfos: Array<FlowInfo>;
|
|
8414
8259
|
/**
|
|
8415
|
-
* <p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font></li></ul><p><strong>注1</strong>: 如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId
|
|
8260
|
+
* <p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font></li></ul><p><strong>注1</strong>: 如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询得到</p><p><strong>注2</strong>: 预览服务按照合同份额 1:2的比例赠送预览次数。例如:购买 100 份合同,将赠送 200 次合同预览额度。当赠送的预览额度使用完后,如需继续使用预览服务,则需要单独购买预览服务额度。</p>
|
|
8416
8261
|
*/
|
|
8417
8262
|
NeedPreview?: boolean;
|
|
8418
8263
|
/**
|
|
@@ -8447,7 +8292,7 @@ export interface UploadFilesRequest {
|
|
|
8447
8292
|
*/
|
|
8448
8293
|
Agent: Agent;
|
|
8449
8294
|
/**
|
|
8450
|
-
* <p>文件对应业务类型,可以选择的类型如下</p><p>枚举值:</p><ul><li>TEMPLATE: 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT: 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件,用来发起流程,还需要通过<a href="https://qian.tencent.com/developers/
|
|
8295
|
+
* <p>文件对应业务类型,可以选择的类型如下</p><p>枚举值:</p><ul><li>TEMPLATE: 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT: 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件,用来发起流程,还需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同,直接上传后使用返回的文件资源Id即可</li><li>SEAL: 此文件用于印章的生成,文件类型支持.jpg/.jpeg/.png</li><li>ARCHIVE: 此文件用于归档文件夹,文件类型支持.pdf/.zip格式</li><li>BUSINESSLICENSE: 此文件用于上传营业执照,用于后续<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>认证子客的时候提供营业执照,文件类型支持.jpg/.jpeg/.png,限制8M以内</li></ul>
|
|
8451
8296
|
*/
|
|
8452
8297
|
BusinessType: string;
|
|
8453
8298
|
/**
|
|
@@ -9205,7 +9050,7 @@ export interface ChannelCreateEmbedWebUrlRequest {
|
|
|
9205
9050
|
*/
|
|
9206
9051
|
EmbedType: string;
|
|
9207
9052
|
/**
|
|
9208
|
-
* <p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE必填,取值为模板id</li><li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li><li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL必填,取值为合同id</li><li>为PREVIEW_SEAL_DETAIL必填,取值为印章id</li></ul><p>注意:</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口<a href="https://qian.tencent.com/developers/partnerApis/files/
|
|
9053
|
+
* <p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE必填,取值为模板id</li><li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li><li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL必填,取值为合同id</li><li>为PREVIEW_SEAL_DETAIL必填,取值为印章id</li></ul><p>注意:</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask">创建文件转换任务</a> 和<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a> 来进行转换成PDF资源。</li></ol>
|
|
9209
9054
|
*/
|
|
9210
9055
|
BusinessId?: string;
|
|
9211
9056
|
/**
|