EssbasicClient (tencentcloud-sdk-java 3.1.831 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.essbasic.v20210526.EssbasicClient

public class EssbasicClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`EssbasicClient(Credential credential, String region)`
`EssbasicClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChannelBatchCancelFlowsResponse`	`ChannelBatchCancelFlows(ChannelBatchCancelFlowsRequest req)` 指定需要批量撤销的签署流程Id，批量撤销合同客户指定需要撤销的签署流程Id，最多100个，超过100不处理；可以撤回：未全部签署完成不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。满足撤销条件的合同会发起异步撤销流程，不满足撤销条件的合同返回失败原因。合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange) 注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
`ChannelCancelFlowResponse`	`ChannelCancelFlow(ChannelCancelFlowRequest req)` 撤销签署流程接口，可以撤回：未全部签署完成；不可以撤回（终态）：已全部签署完成、已拒签、已过期、已撤回。注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
`ChannelCancelMultiFlowSignQRCodeResponse`	`ChannelCancelMultiFlowSignQRCode(ChannelCancelMultiFlowSignQRCodeRequest req)` 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
`ChannelCancelUserAutoSignEnableUrlResponse`	`ChannelCancelUserAutoSignEnableUrl(ChannelCancelUserAutoSignEnableUrlRequest req)` 此接口（ChannelCancelUserAutoSignEnableUrl）用来撤销发送给个人用户的自动签开通链接，撤销后对应的个人用户开通链接失效。若个人用户已经完成开通，将无法撤销。（处方单场景专用，使用此接口请与客户经理确认）
`ChannelCreateBatchCancelFlowUrlResponse`	`ChannelCreateBatchCancelFlowUrl(ChannelCreateBatchCancelFlowUrlRequest req)` 指定需要批量撤销的签署流程Id，获取批量撤销链接 - 不建议使用此接口，可使用ChannelBatchCancelFlows 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销; 可以撤回：未全部签署完成不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
`ChannelCreateBoundFlowsResponse`	`ChannelCreateBoundFlows(ChannelCreateBoundFlowsRequest req)` 此接口（ChannelCreateBoundFlows）用于子客领取合同，经办人需要有相应的角色，合同不能重复领取。
`ChannelCreateConvertTaskApiResponse`	`ChannelCreateConvertTaskApi(ChannelCreateConvertTaskApiRequest req)` 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
`ChannelCreateEmbedWebUrlResponse`	`ChannelCreateEmbedWebUrl(ChannelCreateEmbedWebUrlRequest req)` 本接口（ChannelCreateEmbedWebUrl）用于创建常规模块嵌入web的链接本接口支持创建：创建印章，创建模板，修改模板，预览模板，预览合同流程的web链接进入web连接后与当前控制台操作保持一致
`ChannelCreateFlowByFilesResponse`	`ChannelCreateFlowByFiles(ChannelCreateFlowByFilesRequest req)` 接口（ChannelCreateFlowByFiles）用于通过文件创建签署流程。此接口静默签能力不可直接使用，请联系客户经理申请使用
`ChannelCreateFlowGroupByFilesResponse`	`ChannelCreateFlowGroupByFiles(ChannelCreateFlowGroupByFilesRequest req)` 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
`ChannelCreateFlowGroupByTemplatesResponse`	`ChannelCreateFlowGroupByTemplates(ChannelCreateFlowGroupByTemplatesRequest req)` 接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
`ChannelCreateFlowRemindsResponse`	`ChannelCreateFlowReminds(ChannelCreateFlowRemindsRequest req)` 指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息注意: 该接口不可直接调用，请联系客户经理申请使用仅能催办当前状态为“待签署”的签署人，且只能催办一次
`ChannelCreateFlowSignReviewResponse`	`ChannelCreateFlowSignReview(ChannelCreateFlowSignReviewRequest req)` 提交企业流程审批结果目前存在两种审核操作，签署审核，发起审核签署审核：通过接口（CreateFlowsByTemplates或ChannelCreateFlowByFiles或ChannelCreatePrepareFlow）发起签署流程后，若指定了参数 NeedSignReview 为true,则可以调用此接口，指定operate=SignReview，提交企业内部签署审批结果；若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效发起审核：通过接口ChannelCreatePrepareFlow指定发起后需要审核，则可以通过调用此接口，指定operate=CreateReview，提交企业内部审批结果，可多次提交，当通过后，后续提交结果无效
`ChannelCreateFlowSignUrlResponse`	`ChannelCreateFlowSignUrl(ChannelCreateFlowSignUrlRequest req)` 创建个人签署H5签署链接，请联系客户经理申请使用该接口用于发起合同后，生成C端签署人的签署链接注意：该接口目前签署人类型仅支持个人签署方（PERSON）注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
`ChannelCreateMultiFlowSignQRCodeResponse`	`ChannelCreateMultiFlowSignQRCode(ChannelCreateMultiFlowSignQRCodeRequest req)` 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。本接口适用于发起方没有填写控件的 B2C或者单C模板若是B2C模板,还要满足以下任意一个条件 - 模板中配置的签署顺序是无序 - B端企业的签署方式是静默签署 - B端企业是非首位签署
`ChannelCreateOrganizationModifyQrCodeResponse`	`ChannelCreateOrganizationModifyQrCode(ChannelCreateOrganizationModifyQrCodeRequest req)` 生成渠道子客编辑企业信息二维码
`ChannelCreatePreparedPersonalEsignResponse`	`ChannelCreatePreparedPersonalEsign(ChannelCreatePreparedPersonalEsignRequest req)` 本接口（ChannelCreatePreparedPersonalEsign）用于创建导入个人印章
`ChannelCreatePrepareFlowResponse`	`ChannelCreatePrepareFlow(ChannelCreatePrepareFlowRequest req)` 创建预发起合同通过此接口指定：合同，签署人，填写控件信息，生成预创建合同链接，点击后跳转到web页面完成合同创建并发起可指定合同信息不可更改，签署人信息不可更改合同发起后，填写及签署流程与现有操作流程一致注意：目前仅支持模板发起
`ChannelCreateReleaseFlowResponse`	`ChannelCreateReleaseFlow(ChannelCreateReleaseFlowRequest req)` 发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。合同发起人必须在电子签已经进行实名。
`ChannelCreateSealPolicyResponse`	`ChannelCreateSealPolicy(ChannelCreateSealPolicyRequest req)` 将指定印章授权给第三方平台子客企业下的某些员工
`ChannelCreateUserAutoSignEnableUrlResponse`	`ChannelCreateUserAutoSignEnableUrl(ChannelCreateUserAutoSignEnableUrlRequest req)` 企业方可以通过此接口获取个人用户开启自动签的跳转链接
`ChannelCreateUserRolesResponse`	`ChannelCreateUserRoles(ChannelCreateUserRolesRequest req)` 通过此接口，绑定员工角色，支持以电子签userId、客户系统userId两种方式调用。
`ChannelCreateWebThemeConfigResponse`	`ChannelCreateWebThemeConfig(ChannelCreateWebThemeConfigRequest req)` 生成页面主题配置
`ChannelDeleteRoleUsersResponse`	`ChannelDeleteRoleUsers(ChannelDeleteRoleUsersRequest req)` 通过此接口，删除员工绑定的角色，支持以电子签userId、客户系统userId两种方式调用。
`ChannelDeleteSealPoliciesResponse`	`ChannelDeleteSealPolicies(ChannelDeleteSealPoliciesRequest req)` 删除指定印章下多个授权信息
`ChannelDescribeEmployeesResponse`	`ChannelDescribeEmployees(ChannelDescribeEmployeesRequest req)` 查询企业员工列表
`ChannelDescribeFlowComponentsResponse`	`ChannelDescribeFlowComponents(ChannelDescribeFlowComponentsRequest req)` 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
`ChannelDescribeOrganizationSealsResponse`	`ChannelDescribeOrganizationSeals(ChannelDescribeOrganizationSealsRequest req)` 查询子客企业电子印章，需要操作者具有管理印章权限客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数，只返回启用的印章。
`ChannelDescribeRolesResponse`	`ChannelDescribeRoles(ChannelDescribeRolesRequest req)` 查询角色列表，支持根据类型和状态过滤角色列表
`ChannelDescribeUserAutoSignStatusResponse`	`ChannelDescribeUserAutoSignStatus(ChannelDescribeUserAutoSignStatusRequest req)` 企业方可以通过此接口查询个人用户自动签开启状态
`ChannelDisableUserAutoSignResponse`	`ChannelDisableUserAutoSign(ChannelDisableUserAutoSignRequest req)` 企业方可以通过此接口关闭个人的自动签功能
`ChannelGetTaskResultApiResponse`	`ChannelGetTaskResultApi(ChannelGetTaskResultApiRequest req)` 查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。注意：大文件转换所需的时间可能会比较长。
`ChannelUpdateSealStatusResponse`	`ChannelUpdateSealStatus(ChannelUpdateSealStatusRequest req)` 本接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态
`ChannelVerifyPdfResponse`	`ChannelVerifyPdf(ChannelVerifyPdfRequest req)` 对流程的合同文件进行数字签名验证，判断文件是否被篡改。
`CreateChannelFlowEvidenceReportResponse`	`CreateChannelFlowEvidenceReport(CreateChannelFlowEvidenceReportRequest req)` 创建出证报告，返回报告 ID。需要配合出证套餐才能调用。出证需要一定时间，建议调用创建出证24小时之后再通过DescribeChannelFlowEvidenceReport进行查询。
`CreateConsoleLoginUrlResponse`	`CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req)` 此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。若子客企业未激活，会进入企业激活流程，首次参与激活流程的经办人会成为超管。（若企业激活过程中填写信息有误，需要重置激活流程，可以换一个经办人OpenId获取新的链接进入。）若子客企业已激活，使用了新的经办人OpenId进入，则会进入经办人的实名流程。若子客企业、经办人均已完成认证，则会直接进入子客Web控制台。
`CreateFlowsByTemplatesResponse`	`CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req)` 接口（CreateFlowsByTemplates）用于使用模板批量创建签署流程。当前可批量发起合同（签署流程）数量为1-20个。如若在模板中配置了动态表格, 上传的附件必须为A4大小合同发起人必须在电子签已经进行实名。
`CreateSealByImageResponse`	`CreateSealByImage(CreateSealByImageRequest req)` 通过图片为子客企业代创建印章，图片最大5MB
`CreateSignUrlsResponse`	`CreateSignUrls(CreateSignUrlsRequest req)` 创建跳转小程序查看或签署的链接。跳转小程序的几种方式：主要是设置不同的EndPoint 1.
`DescribeChannelFlowEvidenceReportResponse`	`DescribeChannelFlowEvidenceReport(DescribeChannelFlowEvidenceReportRequest req)` 查询出证报告，返回报告 URL。
`DescribeExtendedServiceAuthInfoResponse`	`DescribeExtendedServiceAuthInfo(DescribeExtendedServiceAuthInfoRequest req)` 查询企业扩展服务授权信息，企业经办人需要是企业超管或者法人
`DescribeFlowDetailInfoResponse`	`DescribeFlowDetailInfo(DescribeFlowDetailInfoRequest req)` 此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
`DescribeResourceUrlsByFlowsResponse`	`DescribeResourceUrlsByFlows(DescribeResourceUrlsByFlowsRequest req)` 根据签署流程信息批量获取资源下载链接，可以下载签署中、签署完的合同，需合作企业先进行授权。此接口直接返回下载的资源的url，与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
`DescribeTemplatesResponse`	`DescribeTemplates(DescribeTemplatesRequest req)` 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。 > 适用场景 > > 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。 > 一个模板通常会包含以下结构信息 >- 模板基本信息 >- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方 >- 填写控件 Components >- 签署控件 SignComponents >- 生成模板的文件基础信息 FileInfos
`DescribeUsageResponse`	`DescribeUsage(DescribeUsageRequest req)` 此接口（DescribeUsage）用于获取第三方平台所有合作企业流量消耗情况。注: 此接口每日限频50次，若要扩大限制次数,请提前与客服经理或邮件至[email protected]进行联系。
`GetDownloadFlowUrlResponse`	`GetDownloadFlowUrl(GetDownloadFlowUrlRequest req)` 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式分类下载。当前接口限制最多合同（流程）50个.
`ModifyExtendedServiceResponse`	`ModifyExtendedService(ModifyExtendedServiceRequest req)` 修改（操作）企业扩展服务，企业经办人需要是企业超管或者法人
`OperateChannelTemplateResponse`	`OperateChannelTemplate(OperateChannelTemplateRequest req)` 此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。 > 使用场景 > > 1：查询 OperateType=SELECT > - 查询第三方应用平台模板库的可见性以及授权的子客列表。 > > 2：修改部分子客授权 OperateType=UPDATE > - 对子客企业进行模板库中模板可见性的进行修改操作。 >- 当模板未发布时，可以修改可见性AuthTag（part/all），当模板发布后，不可做此修改 > - 若模板已发布且可见性AuthTag是part，可以通过ProxyOrganizationOpenIds增加子客的授权范围。如果是自动领取的模板，增加授权范围后会自动下发。 > > 3：取消部分子客授权 OperateType=DELETE > - 对子客企业进行模板库中模板可见性的进行删除操作。 > - 主要对于手动领取的模板，去除授权后子客在模板库中看不到，就无法再领取了。但是已经领取过成为自有模板的不会同步删除。 > - 对于自动领取的模板，由于已经下发，更改授权不会影响。 > - 如果要同步删除子客自有模板库中的模板，请使用OperateType=UPDATE+Available参数处理。
`PrepareFlowsResponse`	`PrepareFlows(PrepareFlowsRequest req)` 该接口 (PrepareFlows) 用于创建待发起文件用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认，如果确认则进行正常发起。目前该接口只支持B2C，不建议使用，将会废弃。
`SyncProxyOrganizationResponse`	`SyncProxyOrganization(SyncProxyOrganizationRequest req)` 此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，主要是子客企业的营业执照，便于子客企业开通过程中不用手动上传。若有需要调用此接口，需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
`SyncProxyOrganizationOperatorsResponse`	`SyncProxyOrganizationOperators(SyncProxyOrganizationOperatorsRequest req)` 此接口（SyncProxyOrganizationOperators）用于同步第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。若经办人信息有误，或者需要修改，也可以先将之前的经办人做离职操作，然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
`UploadFilesResponse`	`UploadFiles(UploadFilesRequest req)` 此接口（UploadFiles）用于文件上传。其中上传的文件，图片类型(png/jpg/jpeg)大小限制为5M，其他大小限制为60M。调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。代码示例： HttpProfile httpProfile = new HttpProfile(); httpProfile.setEndpoint("file.test.ess.tencent.cn");

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EssbasicClient
```
public EssbasicClient(Credential credential,
                      String region)
```
  - EssbasicClient
```
public EssbasicClient(Credential credential,
                      String region,
                      ClientProfile profile)
```
- Method Detail
  - ChannelBatchCancelFlows
```
public ChannelBatchCancelFlowsResponse ChannelBatchCancelFlows(ChannelBatchCancelFlowsRequest req)
                                                        throws TencentCloudSDKException
```
    指定需要批量撤销的签署流程Id，批量撤销合同客户指定需要撤销的签署流程Id，最多100个，超过100不处理；可以撤回：未全部签署完成不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。满足撤销条件的合同会发起异步撤销流程，不满足撤销条件的合同返回失败原因。** 合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)** 注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
    
    Parameters:
    
    req - ChannelBatchCancelFlowsRequest
    
    Returns:
    
    ChannelBatchCancelFlowsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCancelFlow
```
public ChannelCancelFlowResponse ChannelCancelFlow(ChannelCancelFlowRequest req)
                                            throws TencentCloudSDKException
```
    撤销签署流程接口，可以撤回：未全部签署完成；不可以撤回（终态）：已全部签署完成、已拒签、已过期、已撤回。注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
    
    Parameters:
    
    req - ChannelCancelFlowRequest
    
    Returns:
    
    ChannelCancelFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCancelMultiFlowSignQRCode
```
public ChannelCancelMultiFlowSignQRCodeResponse ChannelCancelMultiFlowSignQRCode(ChannelCancelMultiFlowSignQRCodeRequest req)
                                                                          throws TencentCloudSDKException
```
    此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
    
    Parameters:
    
    req - ChannelCancelMultiFlowSignQRCodeRequest
    
    Returns:
    
    ChannelCancelMultiFlowSignQRCodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCancelUserAutoSignEnableUrl
```
public ChannelCancelUserAutoSignEnableUrlResponse ChannelCancelUserAutoSignEnableUrl(ChannelCancelUserAutoSignEnableUrlRequest req)
                                                                              throws TencentCloudSDKException
```
    此接口（ChannelCancelUserAutoSignEnableUrl）用来撤销发送给个人用户的自动签开通链接，撤销后对应的个人用户开通链接失效。若个人用户已经完成开通，将无法撤销。（处方单场景专用，使用此接口请与客户经理确认）
    
    Parameters:
    
    req - ChannelCancelUserAutoSignEnableUrlRequest
    
    Returns:
    
    ChannelCancelUserAutoSignEnableUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateBatchCancelFlowUrl
```
public ChannelCreateBatchCancelFlowUrlResponse ChannelCreateBatchCancelFlowUrl(ChannelCreateBatchCancelFlowUrlRequest req)
                                                                        throws TencentCloudSDKException
```
    指定需要批量撤销的签署流程Id，获取批量撤销链接 - 不建议使用此接口，可使用ChannelBatchCancelFlows 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销; 可以撤回：未全部签署完成不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
    
    Parameters:
    
    req - ChannelCreateBatchCancelFlowUrlRequest
    
    Returns:
    
    ChannelCreateBatchCancelFlowUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateBoundFlows
```
public ChannelCreateBoundFlowsResponse ChannelCreateBoundFlows(ChannelCreateBoundFlowsRequest req)
                                                        throws TencentCloudSDKException
```
    此接口（ChannelCreateBoundFlows）用于子客领取合同，经办人需要有相应的角色，合同不能重复领取。
    
    Parameters:
    
    req - ChannelCreateBoundFlowsRequest
    
    Returns:
    
    ChannelCreateBoundFlowsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateConvertTaskApi
```
public ChannelCreateConvertTaskApiResponse ChannelCreateConvertTaskApi(ChannelCreateConvertTaskApiRequest req)
                                                                throws TencentCloudSDKException
```
    上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
    
    Parameters:
    
    req - ChannelCreateConvertTaskApiRequest
    
    Returns:
    
    ChannelCreateConvertTaskApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateEmbedWebUrl
```
public ChannelCreateEmbedWebUrlResponse ChannelCreateEmbedWebUrl(ChannelCreateEmbedWebUrlRequest req)
                                                          throws TencentCloudSDKException
```
    本接口（ChannelCreateEmbedWebUrl）用于创建常规模块嵌入web的链接本接口支持创建：创建印章，创建模板，修改模板，预览模板，预览合同流程的web链接进入web连接后与当前控制台操作保持一致
    
    Parameters:
    
    req - ChannelCreateEmbedWebUrlRequest
    
    Returns:
    
    ChannelCreateEmbedWebUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateFlowByFiles
```
public ChannelCreateFlowByFilesResponse ChannelCreateFlowByFiles(ChannelCreateFlowByFilesRequest req)
                                                          throws TencentCloudSDKException
```
    接口（ChannelCreateFlowByFiles）用于通过文件创建签署流程。此接口静默签能力不可直接使用，请联系客户经理申请使用
    
    Parameters:
    
    req - ChannelCreateFlowByFilesRequest
    
    Returns:
    
    ChannelCreateFlowByFilesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateFlowGroupByFiles
```
public ChannelCreateFlowGroupByFilesResponse ChannelCreateFlowGroupByFiles(ChannelCreateFlowGroupByFilesRequest req)
                                                                    throws TencentCloudSDKException
```
    接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
    
    Parameters:
    
    req - ChannelCreateFlowGroupByFilesRequest
    
    Returns:
    
    ChannelCreateFlowGroupByFilesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateFlowGroupByTemplates
```
public ChannelCreateFlowGroupByTemplatesResponse ChannelCreateFlowGroupByTemplates(ChannelCreateFlowGroupByTemplatesRequest req)
                                                                            throws TencentCloudSDKException
```
    接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
    
    Parameters:
    
    req - ChannelCreateFlowGroupByTemplatesRequest
    
    Returns:
    
    ChannelCreateFlowGroupByTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateFlowReminds
```
public ChannelCreateFlowRemindsResponse ChannelCreateFlowReminds(ChannelCreateFlowRemindsRequest req)
                                                          throws TencentCloudSDKException
```
    指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息注意: 该接口不可直接调用，请联系客户经理申请使用仅能催办当前状态为“待签署”的签署人，且只能催办一次
    
    Parameters:
    
    req - ChannelCreateFlowRemindsRequest
    
    Returns:
    
    ChannelCreateFlowRemindsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateFlowSignReview
```
public ChannelCreateFlowSignReviewResponse ChannelCreateFlowSignReview(ChannelCreateFlowSignReviewRequest req)
                                                                throws TencentCloudSDKException
```
    提交企业流程审批结果目前存在两种审核操作，签署审核，发起审核签署审核：通过接口（CreateFlowsByTemplates或ChannelCreateFlowByFiles或ChannelCreatePrepareFlow）发起签署流程后，若指定了参数 NeedSignReview 为true,则可以调用此接口，指定operate=SignReview，提交企业内部签署审批结果；若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效发起审核：通过接口ChannelCreatePrepareFlow指定发起后需要审核，则可以通过调用此接口，指定operate=CreateReview，提交企业内部审批结果，可多次提交，当通过后，后续提交结果无效
    
    Parameters:
    
    req - ChannelCreateFlowSignReviewRequest
    
    Returns:
    
    ChannelCreateFlowSignReviewResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateFlowSignUrl
```
public ChannelCreateFlowSignUrlResponse ChannelCreateFlowSignUrl(ChannelCreateFlowSignUrlRequest req)
                                                          throws TencentCloudSDKException
```
    创建个人签署H5签署链接，请联系客户经理申请使用
    该接口用于发起合同后，生成C端签署人的签署链接
    注意：该接口目前签署人类型仅支持个人签署方（PERSON）
    注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
    注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
    
    Parameters:
    
    req - ChannelCreateFlowSignUrlRequest
    
    Returns:
    
    ChannelCreateFlowSignUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateMultiFlowSignQRCode
```
public ChannelCreateMultiFlowSignQRCodeResponse ChannelCreateMultiFlowSignQRCode(ChannelCreateMultiFlowSignQRCodeRequest req)
                                                                          throws TencentCloudSDKException
```
    此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。本接口适用于发起方没有填写控件的 B2C或者单C模板** 若是B2C模板,还要满足以下任意一个条件** - 模板中配置的签署顺序是无序 - B端企业的签署方式是静默签署 - B端企业是非首位签署
    
    Parameters:
    
    req - ChannelCreateMultiFlowSignQRCodeRequest
    
    Returns:
    
    ChannelCreateMultiFlowSignQRCodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateOrganizationModifyQrCode
```
public ChannelCreateOrganizationModifyQrCodeResponse ChannelCreateOrganizationModifyQrCode(ChannelCreateOrganizationModifyQrCodeRequest req)
                                                                                    throws TencentCloudSDKException
```
    生成渠道子客编辑企业信息二维码
    
    Parameters:
    
    req - ChannelCreateOrganizationModifyQrCodeRequest
    
    Returns:
    
    ChannelCreateOrganizationModifyQrCodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreatePrepareFlow
```
public ChannelCreatePrepareFlowResponse ChannelCreatePrepareFlow(ChannelCreatePrepareFlowRequest req)
                                                          throws TencentCloudSDKException
```
    创建预发起合同通过此接口指定：合同，签署人，填写控件信息，生成预创建合同链接，点击后跳转到web页面完成合同创建并发起可指定合同信息不可更改，签署人信息不可更改合同发起后，填写及签署流程与现有操作流程一致注意：目前仅支持模板发起
    
    Parameters:
    
    req - ChannelCreatePrepareFlowRequest
    
    Returns:
    
    ChannelCreatePrepareFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreatePreparedPersonalEsign
```
public ChannelCreatePreparedPersonalEsignResponse ChannelCreatePreparedPersonalEsign(ChannelCreatePreparedPersonalEsignRequest req)
                                                                              throws TencentCloudSDKException
```
    本接口（ChannelCreatePreparedPersonalEsign）用于创建导入个人印章
    
    Parameters:
    
    req - ChannelCreatePreparedPersonalEsignRequest
    
    Returns:
    
    ChannelCreatePreparedPersonalEsignResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateReleaseFlow
```
public ChannelCreateReleaseFlowResponse ChannelCreateReleaseFlow(ChannelCreateReleaseFlowRequest req)
                                                          throws TencentCloudSDKException
```
    发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。合同发起人必须在电子签已经进行实名。
    
    Parameters:
    
    req - ChannelCreateReleaseFlowRequest
    
    Returns:
    
    ChannelCreateReleaseFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateSealPolicy
```
public ChannelCreateSealPolicyResponse ChannelCreateSealPolicy(ChannelCreateSealPolicyRequest req)
                                                        throws TencentCloudSDKException
```
    将指定印章授权给第三方平台子客企业下的某些员工
    
    Parameters:
    
    req - ChannelCreateSealPolicyRequest
    
    Returns:
    
    ChannelCreateSealPolicyResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateUserAutoSignEnableUrl
```
public ChannelCreateUserAutoSignEnableUrlResponse ChannelCreateUserAutoSignEnableUrl(ChannelCreateUserAutoSignEnableUrlRequest req)
                                                                              throws TencentCloudSDKException
```
    企业方可以通过此接口获取个人用户开启自动签的跳转链接
    
    Parameters:
    
    req - ChannelCreateUserAutoSignEnableUrlRequest
    
    Returns:
    
    ChannelCreateUserAutoSignEnableUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateUserRoles
```
public ChannelCreateUserRolesResponse ChannelCreateUserRoles(ChannelCreateUserRolesRequest req)
                                                      throws TencentCloudSDKException
```
    通过此接口，绑定员工角色，支持以电子签userId、客户系统userId两种方式调用。
    
    Parameters:
    
    req - ChannelCreateUserRolesRequest
    
    Returns:
    
    ChannelCreateUserRolesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateWebThemeConfig
```
public ChannelCreateWebThemeConfigResponse ChannelCreateWebThemeConfig(ChannelCreateWebThemeConfigRequest req)
                                                                throws TencentCloudSDKException
```
    生成页面主题配置
    
    Parameters:
    
    req - ChannelCreateWebThemeConfigRequest
    
    Returns:
    
    ChannelCreateWebThemeConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelDeleteRoleUsers
```
public ChannelDeleteRoleUsersResponse ChannelDeleteRoleUsers(ChannelDeleteRoleUsersRequest req)
                                                      throws TencentCloudSDKException
```
    通过此接口，删除员工绑定的角色，支持以电子签userId、客户系统userId两种方式调用。
    
    Parameters:
    
    req - ChannelDeleteRoleUsersRequest
    
    Returns:
    
    ChannelDeleteRoleUsersResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelDeleteSealPolicies
```
public ChannelDeleteSealPoliciesResponse ChannelDeleteSealPolicies(ChannelDeleteSealPoliciesRequest req)
                                                            throws TencentCloudSDKException
```
    删除指定印章下多个授权信息
    
    Parameters:
    
    req - ChannelDeleteSealPoliciesRequest
    
    Returns:
    
    ChannelDeleteSealPoliciesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelDescribeEmployees
```
public ChannelDescribeEmployeesResponse ChannelDescribeEmployees(ChannelDescribeEmployeesRequest req)
                                                          throws TencentCloudSDKException
```
    查询企业员工列表
    
    Parameters:
    
    req - ChannelDescribeEmployeesRequest
    
    Returns:
    
    ChannelDescribeEmployeesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelDescribeFlowComponents
```
public ChannelDescribeFlowComponentsResponse ChannelDescribeFlowComponents(ChannelDescribeFlowComponentsRequest req)
                                                                    throws TencentCloudSDKException
```
    查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
    
    Parameters:
    
    req - ChannelDescribeFlowComponentsRequest
    
    Returns:
    
    ChannelDescribeFlowComponentsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelDescribeOrganizationSeals
```
public ChannelDescribeOrganizationSealsResponse ChannelDescribeOrganizationSeals(ChannelDescribeOrganizationSealsRequest req)
                                                                          throws TencentCloudSDKException
```
    查询子客企业电子印章，需要操作者具有管理印章权限客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数，只返回启用的印章。
    
    Parameters:
    
    req - ChannelDescribeOrganizationSealsRequest
    
    Returns:
    
    ChannelDescribeOrganizationSealsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelDescribeRoles
```
public ChannelDescribeRolesResponse ChannelDescribeRoles(ChannelDescribeRolesRequest req)
                                                  throws TencentCloudSDKException
```
    查询角色列表，支持根据类型和状态过滤角色列表
    
    Parameters:
    
    req - ChannelDescribeRolesRequest
    
    Returns:
    
    ChannelDescribeRolesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelDescribeUserAutoSignStatus
```
public ChannelDescribeUserAutoSignStatusResponse ChannelDescribeUserAutoSignStatus(ChannelDescribeUserAutoSignStatusRequest req)
                                                                            throws TencentCloudSDKException
```
    企业方可以通过此接口查询个人用户自动签开启状态
    
    Parameters:
    
    req - ChannelDescribeUserAutoSignStatusRequest
    
    Returns:
    
    ChannelDescribeUserAutoSignStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelDisableUserAutoSign
```
public ChannelDisableUserAutoSignResponse ChannelDisableUserAutoSign(ChannelDisableUserAutoSignRequest req)
                                                              throws TencentCloudSDKException
```
    企业方可以通过此接口关闭个人的自动签功能
    
    Parameters:
    
    req - ChannelDisableUserAutoSignRequest
    
    Returns:
    
    ChannelDisableUserAutoSignResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelGetTaskResultApi
```
public ChannelGetTaskResultApiResponse ChannelGetTaskResultApi(ChannelGetTaskResultApiRequest req)
                                                        throws TencentCloudSDKException
```
    查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。注意：大文件转换所需的时间可能会比较长。
    
    Parameters:
    
    req - ChannelGetTaskResultApiRequest
    
    Returns:
    
    ChannelGetTaskResultApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelUpdateSealStatus
```
public ChannelUpdateSealStatusResponse ChannelUpdateSealStatus(ChannelUpdateSealStatusRequest req)
                                                        throws TencentCloudSDKException
```
    本接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态
    
    Parameters:
    
    req - ChannelUpdateSealStatusRequest
    
    Returns:
    
    ChannelUpdateSealStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelVerifyPdf
```
public ChannelVerifyPdfResponse ChannelVerifyPdf(ChannelVerifyPdfRequest req)
                                          throws TencentCloudSDKException
```
    对流程的合同文件进行数字签名验证，判断文件是否被篡改。
    
    Parameters:
    
    req - ChannelVerifyPdfRequest
    
    Returns:
    
    ChannelVerifyPdfResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateChannelFlowEvidenceReport
```
public CreateChannelFlowEvidenceReportResponse CreateChannelFlowEvidenceReport(CreateChannelFlowEvidenceReportRequest req)
                                                                        throws TencentCloudSDKException
```
    创建出证报告，返回报告 ID。需要配合出证套餐才能调用。出证需要一定时间，建议调用创建出证24小时之后再通过DescribeChannelFlowEvidenceReport进行查询。
    
    Parameters:
    
    req - CreateChannelFlowEvidenceReportRequest
    
    Returns:
    
    CreateChannelFlowEvidenceReportResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateConsoleLoginUrl
```
public CreateConsoleLoginUrlResponse CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req)
                                                    throws TencentCloudSDKException
```
    此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。若子客企业未激活，会进入企业激活流程，首次参与激活流程的经办人会成为超管。（若企业激活过程中填写信息有误，需要重置激活流程，可以换一个经办人OpenId获取新的链接进入。）若子客企业已激活，使用了新的经办人OpenId进入，则会进入经办人的实名流程。若子客企业、经办人均已完成认证，则会直接进入子客Web控制台。
    
    Parameters:
    
    req - CreateConsoleLoginUrlRequest
    
    Returns:
    
    CreateConsoleLoginUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowsByTemplates
```
public CreateFlowsByTemplatesResponse CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req)
                                                      throws TencentCloudSDKException
```
    接口（CreateFlowsByTemplates）用于使用模板批量创建签署流程。当前可批量发起合同（签署流程）数量为1-20个。如若在模板中配置了动态表格, 上传的附件必须为A4大小合同发起人必须在电子签已经进行实名。
    
    Parameters:
    
    req - CreateFlowsByTemplatesRequest
    
    Returns:
    
    CreateFlowsByTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSealByImage
```
public CreateSealByImageResponse CreateSealByImage(CreateSealByImageRequest req)
                                            throws TencentCloudSDKException
```
    通过图片为子客企业代创建印章，图片最大5MB
    
    Parameters:
    
    req - CreateSealByImageRequest
    
    Returns:
    
    CreateSealByImageResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSignUrls
```
public CreateSignUrlsResponse CreateSignUrls(CreateSignUrlsRequest req)
                                      throws TencentCloudSDKException
```
    创建跳转小程序查看或签署的链接。跳转小程序的几种方式：主要是设置不同的EndPoint 1. 通过链接Url直接跳转到小程序，不需要返回设置EndPoint为WEIXINAPP，得到链接打开即可。（与短信提醒用户签署形式一样）。 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl 设置EndPoint为CHANNEL，指定JumpUrl，得到链接打开即可。 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App 跳转到小程序的实现，参考官方文档 https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html 其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。使用CreateSignUrls，设置EndPoint为APP，得到path。 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）全屏方式：（https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html）半屏方式：（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html）其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。使用CreateSignUrls，设置EndPoint为APP，得到path。
    
    Parameters:
    
    req - CreateSignUrlsRequest
    
    Returns:
    
    CreateSignUrlsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeChannelFlowEvidenceReport
```
public DescribeChannelFlowEvidenceReportResponse DescribeChannelFlowEvidenceReport(DescribeChannelFlowEvidenceReportRequest req)
                                                                            throws TencentCloudSDKException
```
    查询出证报告，返回报告 URL。
    
    Parameters:
    
    req - DescribeChannelFlowEvidenceReportRequest
    
    Returns:
    
    DescribeChannelFlowEvidenceReportResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeExtendedServiceAuthInfo
```
public DescribeExtendedServiceAuthInfoResponse DescribeExtendedServiceAuthInfo(DescribeExtendedServiceAuthInfoRequest req)
                                                                        throws TencentCloudSDKException
```
    查询企业扩展服务授权信息，企业经办人需要是企业超管或者法人
    
    Parameters:
    
    req - DescribeExtendedServiceAuthInfoRequest
    
    Returns:
    
    DescribeExtendedServiceAuthInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlowDetailInfo
```
public DescribeFlowDetailInfoResponse DescribeFlowDetailInfo(DescribeFlowDetailInfoRequest req)
                                                      throws TencentCloudSDKException
```
    此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
    
    Parameters:
    
    req - DescribeFlowDetailInfoRequest
    
    Returns:
    
    DescribeFlowDetailInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeResourceUrlsByFlows
```
public DescribeResourceUrlsByFlowsResponse DescribeResourceUrlsByFlows(DescribeResourceUrlsByFlowsRequest req)
                                                                throws TencentCloudSDKException
```
    根据签署流程信息批量获取资源下载链接，可以下载签署中、签署完的合同，需合作企业先进行授权。此接口直接返回下载的资源的url，与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
    
    Parameters:
    
    req - DescribeResourceUrlsByFlowsRequest
    
    Returns:
    
    DescribeResourceUrlsByFlowsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTemplates
```
public DescribeTemplatesResponse DescribeTemplates(DescribeTemplatesRequest req)
                                            throws TencentCloudSDKException
```
    通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。 > **适用场景** > > 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。 > 一个模板通常会包含以下结构信息 >- 模板基本信息 >- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方 >- 填写控件 Components >- 签署控件 SignComponents >- 生成模板的文件基础信息 FileInfos
    
    Parameters:
    
    req - DescribeTemplatesRequest
    
    Returns:
    
    DescribeTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUsage
```
public DescribeUsageResponse DescribeUsage(DescribeUsageRequest req)
                                    throws TencentCloudSDKException
```
    此接口（DescribeUsage）用于获取第三方平台所有合作企业流量消耗情况。注: 此接口每日限频50次，若要扩大限制次数,请提前与客服经理或邮件至[email protected]进行联系。
    
    Parameters:
    
    req - DescribeUsageRequest
    
    Returns:
    
    DescribeUsageResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetDownloadFlowUrl
```
public GetDownloadFlowUrlResponse GetDownloadFlowUrl(GetDownloadFlowUrlRequest req)
                                              throws TencentCloudSDKException
```
    此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式分类下载。当前接口限制最多合同（流程）50个. 返回的链接只能使用一次
    
    Parameters:
    
    req - GetDownloadFlowUrlRequest
    
    Returns:
    
    GetDownloadFlowUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyExtendedService
```
public ModifyExtendedServiceResponse ModifyExtendedService(ModifyExtendedServiceRequest req)
                                                    throws TencentCloudSDKException
```
    修改（操作）企业扩展服务，企业经办人需要是企业超管或者法人
    
    Parameters:
    
    req - ModifyExtendedServiceRequest
    
    Returns:
    
    ModifyExtendedServiceResponse
    
    Throws:
    
    TencentCloudSDKException
  - OperateChannelTemplate
```
public OperateChannelTemplateResponse OperateChannelTemplate(OperateChannelTemplateRequest req)
                                                      throws TencentCloudSDKException
```
    此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。 > **使用场景** > > 1：查询 OperateType=SELECT > - 查询第三方应用平台模板库的可见性以及授权的子客列表。 > > 2：修改部分子客授权 OperateType=UPDATE > - 对子客企业进行模板库中模板可见性的进行修改操作。 >- 当模板未发布时，可以修改可见性AuthTag（part/all），当模板发布后，不可做此修改 > - 若模板已发布且可见性AuthTag是part，可以通过ProxyOrganizationOpenIds增加子客的授权范围。如果是自动领取的模板，增加授权范围后会自动下发。 > > 3：取消部分子客授权 OperateType=DELETE > - 对子客企业进行模板库中模板可见性的进行删除操作。 > - 主要对于手动领取的模板，去除授权后子客在模板库中看不到，就无法再领取了。但是已经领取过成为自有模板的不会同步删除。 > - 对于自动领取的模板，由于已经下发，更改授权不会影响。 > - 如果要同步删除子客自有模板库中的模板，请使用OperateType=UPDATE+Available参数处理。
    
    Parameters:
    
    req - OperateChannelTemplateRequest
    
    Returns:
    
    OperateChannelTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - PrepareFlows
```
public PrepareFlowsResponse PrepareFlows(PrepareFlowsRequest req)
                                  throws TencentCloudSDKException
```
    该接口 (PrepareFlows) 用于创建待发起文件用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认，如果确认则进行正常发起。目前该接口只支持B2C，不建议使用，将会废弃。
    
    Parameters:
    
    req - PrepareFlowsRequest
    
    Returns:
    
    PrepareFlowsResponse
    
    Throws:
    
    TencentCloudSDKException
  - SyncProxyOrganization
```
public SyncProxyOrganizationResponse SyncProxyOrganization(SyncProxyOrganizationRequest req)
                                                    throws TencentCloudSDKException
```
    此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，主要是子客企业的营业执照，便于子客企业开通过程中不用手动上传。若有需要调用此接口，需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
    
    Parameters:
    
    req - SyncProxyOrganizationRequest
    
    Returns:
    
    SyncProxyOrganizationResponse
    
    Throws:
    
    TencentCloudSDKException
  - SyncProxyOrganizationOperators
```
public SyncProxyOrganizationOperatorsResponse SyncProxyOrganizationOperators(SyncProxyOrganizationOperatorsRequest req)
                                                                      throws TencentCloudSDKException
```
    此接口（SyncProxyOrganizationOperators）用于同步第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。若经办人信息有误，或者需要修改，也可以先将之前的经办人做离职操作，然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
    
    Parameters:
    
    req - SyncProxyOrganizationOperatorsRequest
    
    Returns:
    
    SyncProxyOrganizationOperatorsResponse
    
    Throws:
    
    TencentCloudSDKException
  - UploadFiles
```
public UploadFilesResponse UploadFiles(UploadFilesRequest req)
                                throws TencentCloudSDKException
```
    此接口（UploadFiles）用于文件上传。其中上传的文件，图片类型(png/jpg/jpeg)大小限制为5M，其他大小限制为60M。调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。代码示例： HttpProfile httpProfile = new HttpProfile(); httpProfile.setEndpoint("file.test.ess.tencent.cn");
    
    Parameters:
    
    req - UploadFilesRequest
    
    Returns:
    
    UploadFilesResponse
    
    Throws:
    
    TencentCloudSDKException

Class EssbasicClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

EssbasicClient

EssbasicClient

Method Detail

ChannelBatchCancelFlows

ChannelCancelFlow

ChannelCancelMultiFlowSignQRCode

ChannelCancelUserAutoSignEnableUrl

ChannelCreateBatchCancelFlowUrl

ChannelCreateBoundFlows

ChannelCreateConvertTaskApi

ChannelCreateEmbedWebUrl

ChannelCreateFlowByFiles

ChannelCreateFlowGroupByFiles

ChannelCreateFlowGroupByTemplates

ChannelCreateFlowReminds

ChannelCreateFlowSignReview

ChannelCreateFlowSignUrl

ChannelCreateMultiFlowSignQRCode

ChannelCreateOrganizationModifyQrCode

ChannelCreatePrepareFlow

ChannelCreatePreparedPersonalEsign

ChannelCreateReleaseFlow

ChannelCreateSealPolicy

ChannelCreateUserAutoSignEnableUrl

ChannelCreateUserRoles

ChannelCreateWebThemeConfig

ChannelDeleteRoleUsers

ChannelDeleteSealPolicies

ChannelDescribeEmployees

ChannelDescribeFlowComponents

ChannelDescribeOrganizationSeals

ChannelDescribeRoles

ChannelDescribeUserAutoSignStatus

ChannelDisableUserAutoSign

ChannelGetTaskResultApi

ChannelUpdateSealStatus

ChannelVerifyPdf

CreateChannelFlowEvidenceReport

CreateConsoleLoginUrl

CreateFlowsByTemplates

CreateSealByImage

CreateSignUrls

DescribeChannelFlowEvidenceReport

DescribeExtendedServiceAuthInfo

DescribeFlowDetailInfo

DescribeResourceUrlsByFlows

DescribeTemplates

DescribeUsage

GetDownloadFlowUrl

ModifyExtendedService

OperateChannelTemplate

PrepareFlows

SyncProxyOrganization

SyncProxyOrganizationOperators

UploadFiles