EssbasicClient (tencentcloud-sdk-java 3.1.654 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不处理；接口失败后返回错误信息注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
`ChannelCancelFlowResponse`	`ChannelCancelFlow(ChannelCancelFlowRequest req)` 渠道版撤销签署流程接口，可以撤回：未全部签署完成；不可以撤回（终态）：已全部签署完成、已拒签、已过期、已撤回。注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
`ChannelCancelMultiFlowSignQRCodeResponse`	`ChannelCancelMultiFlowSignQRCode(ChannelCancelMultiFlowSignQRCodeRequest req)` 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
`ChannelCreateBatchCancelFlowUrlResponse`	`ChannelCreateBatchCancelFlowUrl(ChannelCreateBatchCancelFlowUrlRequest req)` 指定需要批量撤销的签署流程Id，获取批量撤销链接客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销; 可以撤回：未全部签署完成；不可以撤回（终态）：已全部签署完成、已拒签、已过期、已撤回。注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
`ChannelCreateBoundFlowsResponse`	`ChannelCreateBoundFlows(ChannelCreateBoundFlowsRequest req)` 此接口（ChannelCreateBoundFlows）用于渠道子客领取合同，经办人需要有相应的角色，领取后的合同不能重复领取。
`ChannelCreateConvertTaskApiResponse`	`ChannelCreateConvertTaskApi(ChannelCreateConvertTaskApiRequest req)` 渠道创建文件转换任务
`ChannelCreateFlowByFilesResponse`	`ChannelCreateFlowByFiles(ChannelCreateFlowByFilesRequest req)` 接口（ChannelCreateFlowByFiles）用于渠道版通过文件创建签署流程。此接口静默签能力不可直接使用，需要运营申请
`ChannelCreateFlowGroupByFilesResponse`	`ChannelCreateFlowGroupByFiles(ChannelCreateFlowGroupByFilesRequest req)` 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
`ChannelCreateFlowSignReviewResponse`	`ChannelCreateFlowSignReview(ChannelCreateFlowSignReviewRequest req)` 提交企业签署流程审批结果在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时，若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
`ChannelCreateMultiFlowSignQRCodeResponse`	`ChannelCreateMultiFlowSignQRCode(ChannelCreateMultiFlowSignQRCodeRequest req)` 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫签署流程二维码。适用的模版仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模版，且模版中发起方没有填写控件。
`ChannelCreateReleaseFlowResponse`	`ChannelCreateReleaseFlow(ChannelCreateReleaseFlowRequest req)` 渠道版发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。合同发起人必须在电子签已经进行实名。
`ChannelDescribeEmployeesResponse`	`ChannelDescribeEmployees(ChannelDescribeEmployeesRequest req)` 查询企业员工列表
`ChannelDescribeOrganizationSealsResponse`	`ChannelDescribeOrganizationSeals(ChannelDescribeOrganizationSealsRequest req)` 查询渠道子客企业电子印章，需要操作者具有管理印章权限客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
`ChannelGetTaskResultApiResponse`	`ChannelGetTaskResultApi(ChannelGetTaskResultApiRequest req)` 渠道版查询转换任务状态
`ChannelVerifyPdfResponse`	`ChannelVerifyPdf(ChannelVerifyPdfRequest req)` 合同文件验签
`CreateChannelFlowEvidenceReportResponse`	`CreateChannelFlowEvidenceReport(CreateChannelFlowEvidenceReportRequest req)` 创建出证报告，返回报告 ID
`CreateConsoleLoginUrlResponse`	`CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req)` 此接口（CreateConsoleLoginUrl）用于创建渠道子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。若子客企业未激活，会进入企业激活流程，首次参与激活流程的经办人会成为超管。（若企业激活过程中填写信息有误，需要重置激活流程，可以换一个经办人OpenId获取新的链接进入。）若子客企业已激活，使用了新的经办人OpenId进入，则会进入经办人的实名流程。若子客企业、经办人均已完成认证，则会直接进入子客Web控制台。
`CreateFlowsByTemplatesResponse`	`CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req)` 接口（CreateFlowsByTemplates）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。如若在模板中配置了动态表格, 上传的附件必须为A4大小合同发起人必须在电子签已经进行实名。
`CreateSealByImageResponse`	`CreateSealByImage(CreateSealByImageRequest req)` 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，请联系运营/客服咨询相关流程
`CreateSignUrlsResponse`	`CreateSignUrls(CreateSignUrlsRequest req)` 创建跳转小程序查看或签署的链接。跳转小程序的几种方式：主要是设置不同的EndPoint 1.
`DescribeChannelFlowEvidenceReportResponse`	`DescribeChannelFlowEvidenceReport(DescribeChannelFlowEvidenceReportRequest req)` 查询出证报告，返回报告 URL。
`DescribeFlowDetailInfoResponse`	`DescribeFlowDetailInfo(DescribeFlowDetailInfoRequest req)` 此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
`DescribeResourceUrlsByFlowsResponse`	`DescribeResourceUrlsByFlows(DescribeResourceUrlsByFlowsRequest req)` 根据签署流程信息批量获取资源下载链接，可以下载签署中、签署完的合同，需合作企业先进行授权。此接口直接返回下载的资源的url，与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
`DescribeTemplatesResponse`	`DescribeTemplates(DescribeTemplatesRequest req)` 通过此接口（DescribeTemplates）查询该子客企业在电子签拥有的有效模板，不包括渠道模板
`DescribeUsageResponse`	`DescribeUsage(DescribeUsageRequest req)` 此接口（DescribeUsage）用于获取渠道所有合作企业流量消耗情况。注: 此接口每日限频2次，若要扩大限制次数,请提前与客服经理或邮件至[email protected]进行联系。
`GetDownloadFlowUrlResponse`	`GetDownloadFlowUrl(GetDownloadFlowUrlRequest req)` 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式分类下载。当前接口限制最多合同（流程）50个.
`OperateChannelTemplateResponse`	`OperateChannelTemplate(OperateChannelTemplateRequest req)` 此接口（OperateChannelTemplate）用于针对渠道模板库中的模板对子客企业可见性的查询和设置，不会直接分配渠道模板给子客企业。 1、OperateType=select时：查询渠道模板库 2、OperateType=update或者delete时：对子客企业进行模板库中模板可见性的修改、删除操作。
`PrepareFlowsResponse`	`PrepareFlows(PrepareFlowsRequest req)` 该接口 (PrepareFlows) 用于创建待发起文件用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认，如果确认则进行正常发起。目前该接口只支持B2C，不建议使用，将会废弃。
`SyncProxyOrganizationResponse`	`SyncProxyOrganization(SyncProxyOrganizationRequest req)` 此接口（SyncProxyOrganization）用于同步渠道子客企业信息，主要是子客企业的营业执照，便于子客企业开通过程中不用手动上传。若有需要调用此接口，需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
`SyncProxyOrganizationOperatorsResponse`	`SyncProxyOrganizationOperators(SyncProxyOrganizationOperatorsRequest req)` 此接口（SyncProxyOrganizationOperators）用于同步渠道子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于渠道平台的，无法针对员工做新增/更新/离职等操作。若经办人信息有误，或者需要修改，也可以先将之前的经办人做离职操作，然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
`UploadFilesResponse`	`UploadFiles(UploadFilesRequest req)` 此接口（UploadFiles）用于文件上传。调用时需要设置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, internalRequest, retry, setClientProfile, setCredential, setRegion

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不处理；接口失败后返回错误信息注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
    
    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
  - ChannelCreateBatchCancelFlowUrl
```
public ChannelCreateBatchCancelFlowUrlResponse ChannelCreateBatchCancelFlowUrl(ChannelCreateBatchCancelFlowUrlRequest req)
                                                                        throws TencentCloudSDKException
```
    指定需要批量撤销的签署流程Id，获取批量撤销链接客户指定需要撤销的签署流程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
```
    渠道创建文件转换任务
    
    Parameters:
    
    req - ChannelCreateConvertTaskApiRequest
    
    Returns:
    
    ChannelCreateConvertTaskApiResponse
    
    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
  - ChannelCreateFlowSignReview
```
public ChannelCreateFlowSignReviewResponse ChannelCreateFlowSignReview(ChannelCreateFlowSignReviewRequest req)
                                                                throws TencentCloudSDKException
```
    提交企业签署流程审批结果在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时，若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
    
    Parameters:
    
    req - ChannelCreateFlowSignReviewRequest
    
    Returns:
    
    ChannelCreateFlowSignReviewResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateMultiFlowSignQRCode
```
public ChannelCreateMultiFlowSignQRCodeResponse ChannelCreateMultiFlowSignQRCode(ChannelCreateMultiFlowSignQRCodeRequest req)
                                                                          throws TencentCloudSDKException
```
    此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫签署流程二维码。适用的模版仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模版，且模版中发起方没有填写控件。
    
    Parameters:
    
    req - ChannelCreateMultiFlowSignQRCodeRequest
    
    Returns:
    
    ChannelCreateMultiFlowSignQRCodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelCreateReleaseFlow
```
public ChannelCreateReleaseFlowResponse ChannelCreateReleaseFlow(ChannelCreateReleaseFlowRequest req)
                                                          throws TencentCloudSDKException
```
    渠道版发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。合同发起人必须在电子签已经进行实名。
    
    Parameters:
    
    req - ChannelCreateReleaseFlowRequest
    
    Returns:
    
    ChannelCreateReleaseFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelDescribeEmployees
```
public ChannelDescribeEmployeesResponse ChannelDescribeEmployees(ChannelDescribeEmployeesRequest req)
                                                          throws TencentCloudSDKException
```
    查询企业员工列表
    
    Parameters:
    
    req - ChannelDescribeEmployeesRequest
    
    Returns:
    
    ChannelDescribeEmployeesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelDescribeOrganizationSeals
```
public ChannelDescribeOrganizationSealsResponse ChannelDescribeOrganizationSeals(ChannelDescribeOrganizationSealsRequest req)
                                                                          throws TencentCloudSDKException
```
    查询渠道子客企业电子印章，需要操作者具有管理印章权限客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
    
    Parameters:
    
    req - ChannelDescribeOrganizationSealsRequest
    
    Returns:
    
    ChannelDescribeOrganizationSealsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChannelGetTaskResultApi
```
public ChannelGetTaskResultApiResponse ChannelGetTaskResultApi(ChannelGetTaskResultApiRequest req)
                                                        throws TencentCloudSDKException
```
    渠道版查询转换任务状态
    
    Parameters:
    
    req - ChannelGetTaskResultApiRequest
    
    Returns:
    
    ChannelGetTaskResultApiResponse
    
    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
    
    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）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。如若在模板中配置了动态表格, 上传的附件必须为A4大小合同发起人必须在电子签已经进行实名。
    
    Parameters:
    
    req - CreateFlowsByTemplatesRequest
    
    Returns:
    
    CreateFlowsByTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSealByImage
```
public CreateSealByImageResponse CreateSealByImage(CreateSealByImageRequest req)
                                            throws TencentCloudSDKException
```
    渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，请联系运营/客服咨询相关流程
    
    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/api/navigate/wx.navigateToMiniProgram.html）半屏方式：（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html）其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。使用CreateSignUrls，设置EndPoint为APP，得到path。 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序实现方式同App跳小程序。
    
    Parameters:
    
    req - CreateSignUrlsRequest
    
    Returns:
    
    CreateSignUrlsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeChannelFlowEvidenceReport
```
public DescribeChannelFlowEvidenceReportResponse DescribeChannelFlowEvidenceReport(DescribeChannelFlowEvidenceReportRequest req)
                                                                            throws TencentCloudSDKException
```
    查询出证报告，返回报告 URL。
    
    Parameters:
    
    req - DescribeChannelFlowEvidenceReportRequest
    
    Returns:
    
    DescribeChannelFlowEvidenceReportResponse
    
    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）查询该子客企业在电子签拥有的有效模板，不包括渠道模板
    
    Parameters:
    
    req - DescribeTemplatesRequest
    
    Returns:
    
    DescribeTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUsage
```
public DescribeUsageResponse DescribeUsage(DescribeUsageRequest req)
                                    throws TencentCloudSDKException
```
    此接口（DescribeUsage）用于获取渠道所有合作企业流量消耗情况。注: 此接口每日限频2次，若要扩大限制次数,请提前与客服经理或邮件至[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
  - OperateChannelTemplate
```
public OperateChannelTemplateResponse OperateChannelTemplate(OperateChannelTemplateRequest req)
                                                      throws TencentCloudSDKException
```
    此接口（OperateChannelTemplate）用于针对渠道模板库中的模板对子客企业可见性的查询和设置，不会直接分配渠道模板给子客企业。 1、OperateType=select时：查询渠道模板库 2、OperateType=update或者delete时：对子客企业进行模板库中模板可见性的修改、删除操作。
    
    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）用于文件上传。调用时需要设置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

ChannelCreateBatchCancelFlowUrl

ChannelCreateBoundFlows

ChannelCreateConvertTaskApi

ChannelCreateFlowByFiles

ChannelCreateFlowGroupByFiles

ChannelCreateFlowSignReview

ChannelCreateMultiFlowSignQRCode

ChannelCreateReleaseFlow

ChannelDescribeEmployees

ChannelDescribeOrganizationSeals

ChannelGetTaskResultApi

ChannelVerifyPdf

CreateChannelFlowEvidenceReport

CreateConsoleLoginUrl

CreateFlowsByTemplates

CreateSealByImage

CreateSignUrls

DescribeChannelFlowEvidenceReport

DescribeFlowDetailInfo

DescribeResourceUrlsByFlows

DescribeTemplates

DescribeUsage

GetDownloadFlowUrl

OperateChannelTemplate

PrepareFlows

SyncProxyOrganization

SyncProxyOrganizationOperators

UploadFiles