com.tencentcloudapi.essbasic.v20210526

Class EssbasicClient

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

Modifier and Type	Method and Description
CreateConsoleLoginUrlResponse	CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req) 此接口（CreateConsoleLoginUrl）用于创建电子签控制台登录链接。若企业未激活，调用同步企业信息、同步经办人信息
CreateFlowsByTemplatesResponse	CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req) 接口（CreateFlowsByTemplates）用于使用多个模板批量创建流程
CreateSignUrlsResponse	CreateSignUrls(CreateSignUrlsRequest req) 根据流程Id批量创建签署参与者签署H5链接
DescribeResourceUrlsByFlowsResponse	DescribeResourceUrlsByFlows(DescribeResourceUrlsByFlowsRequest req) 根据流程信息批量获取资源下载链接
DescribeTemplatesResponse	DescribeTemplates(DescribeTemplatesRequest req) 通过此接口（DescribeTemplates）查询该企业在电子签渠道版中配置的有效模板列表
DescribeUsageResponse	DescribeUsage(DescribeUsageRequest req) 此接口（DescribeUsage）用于获取渠道所有合作企业流量消耗情况。 注: 此接口每日限频2次，若要扩大限制次数,请提前与客服经理或邮件至[email protected]进行联系。
PrepareFlowsResponse	PrepareFlows(PrepareFlowsRequest req) 该接口 (PrepareFlows) 用于创建待发起文件
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）用于使用多个模板批量创建流程

Parameters:

req - CreateFlowsByTemplatesRequest

Returns:

CreateFlowsByTemplatesResponse

Throws:

TencentCloudSDKException

CreateSignUrls

public CreateSignUrlsResponse CreateSignUrls(CreateSignUrlsRequest req)
                                      throws TencentCloudSDKException

根据流程Id批量创建签署参与者签署H5链接

Parameters:

req - CreateSignUrlsRequest

Returns:

CreateSignUrlsResponse

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

PrepareFlows

public PrepareFlowsResponse PrepareFlows(PrepareFlowsRequest req)
                                  throws TencentCloudSDKException

该接口 (PrepareFlows) 用于创建待发起文件

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