EssbasicClient (tencentcloud-sdk-java 3.1.594 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不处理；接口失败后返回错误信息
`ChannelCancelMultiFlowSignQRCodeResponse`	`ChannelCancelMultiFlowSignQRCode(ChannelCancelMultiFlowSignQRCodeRequest req)` 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
`ChannelCreateBatchCancelFlowUrlResponse`	`ChannelCreateBatchCancelFlowUrl(ChannelCreateBatchCancelFlowUrlRequest req)` 指定需要批量撤销的签署流程Id，获取批量撤销链接客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销
`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的模版，且模版中发起方没有填写控件。
`ChannelGetTaskResultApiResponse`	`ChannelGetTaskResultApi(ChannelGetTaskResultApiRequest req)` 渠道版查询转换任务状态
`CreateChannelFlowEvidenceReportResponse`	`CreateChannelFlowEvidenceReport(CreateChannelFlowEvidenceReportRequest req)` 【描述】：创建出证报告，返回报告 URL 【注意】：此接口需要通过添加白名单获取调用权限，请联系运营人员加白
`CreateConsoleLoginUrlResponse`	`CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req)` 此接口（CreateConsoleLoginUrl）用于创建电子签控制台登录链接。若企业未激活，调用同步企业信息、同步经办人信息
`CreateFlowsByTemplatesResponse`	`CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req)` 接口（CreateFlowsByTemplates）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。
`CreateSealByImageResponse`	`CreateSealByImage(CreateSealByImageRequest req)` 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，需要运营申请
`CreateSignUrlsResponse`	`CreateSignUrls(CreateSignUrlsRequest req)` 创建跳转小程序查看或签署的链接；自动签署的签署方不创建签署链接；
`DescribeFlowDetailInfoResponse`	`DescribeFlowDetailInfo(DescribeFlowDetailInfoRequest req)` 此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
`DescribeResourceUrlsByFlowsResponse`	`DescribeResourceUrlsByFlows(DescribeResourceUrlsByFlowsRequest req)` 根据签署流程信息批量获取资源下载链接，需合作企业先进行授权
`DescribeTemplatesResponse`	`DescribeTemplates(DescribeTemplatesRequest req)` 通过此接口（DescribeTemplates）查询该企业在电子签渠道版中配置的有效模板列表
`DescribeUsageResponse`	`DescribeUsage(DescribeUsageRequest req)` 此接口（DescribeUsage）用于获取渠道所有合作企业流量消耗情况。注: 此接口每日限频2次，若要扩大限制次数,请提前与客服经理或邮件至[email protected]进行联系。
`GetDownloadFlowUrlResponse`	`GetDownloadFlowUrl(GetDownloadFlowUrlRequest req)` 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式分类下载。当前接口限制最多合同（流程）50个.
`OperateChannelTemplateResponse`	`OperateChannelTemplate(OperateChannelTemplateRequest req)` 此接口（OperateChannelTemplate）用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
`PrepareFlowsResponse`	`PrepareFlows(PrepareFlowsRequest req)` 该接口 (PrepareFlows) 用于创建待发起文件用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认，如果确认则进行正常发起。目前该接口只支持B2C，不建议使用。
`SyncProxyOrganizationResponse`	`SyncProxyOrganization(SyncProxyOrganizationRequest req)` 此接口（SyncProxyOrganization）用于同步渠道侧企业信息
`SyncProxyOrganizationOperatorsResponse`	`SyncProxyOrganizationOperators(SyncProxyOrganizationOperatorsRequest req)` 此接口（SyncProxyOrganizationOperators）用于同步渠道合作企业经办人列表
`UploadFilesResponse`	`UploadFiles(UploadFilesRequest req)` 此接口（UploadFiles）用于文件上传。调用时需要设置Domain 为 file.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
  - 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
  - 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
  - ChannelGetTaskResultApi
```
public ChannelGetTaskResultApiResponse ChannelGetTaskResultApi(ChannelGetTaskResultApiRequest req)
                                                        throws TencentCloudSDKException
```
    渠道版查询转换任务状态
    
    Parameters:
    
    req - ChannelGetTaskResultApiRequest
    
    Returns:
    
    ChannelGetTaskResultApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateChannelFlowEvidenceReport
```
public CreateChannelFlowEvidenceReportResponse CreateChannelFlowEvidenceReport(CreateChannelFlowEvidenceReportRequest req)
                                                                        throws TencentCloudSDKException
```
    【描述】：创建出证报告，返回报告 URL 【注意】：此接口需要通过添加白名单获取调用权限，请联系运营人员加白
    
    Parameters:
    
    req - CreateChannelFlowEvidenceReportRequest
    
    Returns:
    
    CreateChannelFlowEvidenceReportResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateConsoleLoginUrl
```
public CreateConsoleLoginUrlResponse CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req)
                                                    throws TencentCloudSDKException
```
    此接口（CreateConsoleLoginUrl）用于创建电子签控制台登录链接。若企业未激活，调用同步企业信息、同步经办人信息
    
    Parameters:
    
    req - CreateConsoleLoginUrlRequest
    
    Returns:
    
    CreateConsoleLoginUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowsByTemplates
```
public CreateFlowsByTemplatesResponse CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req)
                                                      throws TencentCloudSDKException
```
    接口（CreateFlowsByTemplates）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。
    
    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
```
    创建跳转小程序查看或签署的链接；自动签署的签署方不创建签署链接；
    
    Parameters:
    
    req - CreateSignUrlsRequest
    
    Returns:
    
    CreateSignUrlsResponse
    
    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
```
    根据签署流程信息批量获取资源下载链接，需合作企业先进行授权
    
    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、同步标识=select时：返回渠道侧模板库当前模板的属性. 2、同步标识=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）用于同步渠道侧企业信息
    
    Parameters:
    
    req - SyncProxyOrganizationRequest
    
    Returns:
    
    SyncProxyOrganizationResponse
    
    Throws:
    
    TencentCloudSDKException
  - SyncProxyOrganizationOperators
```
public SyncProxyOrganizationOperatorsResponse SyncProxyOrganizationOperators(SyncProxyOrganizationOperatorsRequest req)
                                                                      throws TencentCloudSDKException
```
    此接口（SyncProxyOrganizationOperators）用于同步渠道合作企业经办人列表
    
    Parameters:
    
    req - SyncProxyOrganizationOperatorsRequest
    
    Returns:
    
    SyncProxyOrganizationOperatorsResponse
    
    Throws:
    
    TencentCloudSDKException
  - UploadFiles
```
public UploadFilesResponse UploadFiles(UploadFilesRequest req)
                                throws TencentCloudSDKException
```
    此接口（UploadFiles）用于文件上传。调用时需要设置Domain 为 file.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

ChannelCancelMultiFlowSignQRCode

ChannelCreateBatchCancelFlowUrl

ChannelCreateConvertTaskApi

ChannelCreateFlowByFiles

ChannelCreateFlowGroupByFiles

ChannelCreateFlowSignReview

ChannelCreateMultiFlowSignQRCode

ChannelGetTaskResultApi

CreateChannelFlowEvidenceReport

CreateConsoleLoginUrl

CreateFlowsByTemplates

CreateSealByImage

CreateSignUrls

DescribeFlowDetailInfo

DescribeResourceUrlsByFlows

DescribeTemplates

DescribeUsage

GetDownloadFlowUrl

OperateChannelTemplate

PrepareFlows

SyncProxyOrganization

SyncProxyOrganizationOperators

UploadFiles