EssbasicClient (tencentcloud-sdk-java 3.1.431 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
`CreateConsoleLoginUrlResponse`	`CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req)` 此接口（CreateConsoleLoginUrl）用于创建电子签控制台登录链接。若企业未激活，调用同步企业信息、同步经办人信息
`CreateFlowsByTemplatesResponse`	`CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req)` 接口（CreateFlowsByTemplates）用于使用多个模板批量创建流程。当前可批量发起合同（流程）数量最大为20个。
`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）用于同步渠道合作企业经办人列表

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
  - 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
  - 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

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

CreateConsoleLoginUrl

CreateFlowsByTemplates

CreateSignUrls

DescribeFlowDetailInfo

DescribeResourceUrlsByFlows

DescribeTemplates

DescribeUsage

GetDownloadFlowUrl

OperateChannelTemplate

PrepareFlows

SyncProxyOrganization

SyncProxyOrganizationOperators