EssClient (tencentcloud-sdk-java 3.1.753 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.ess.v20201111.EssClient

public class EssClient
extends AbstractClient

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BindEmployeeUserIdWithClientOpenIdResponse`	`BindEmployeeUserIdWithClientOpenId(BindEmployeeUserIdWithClientOpenIdRequest req)` 将电子签系统员工userId与客户系统员工openId进行绑定
`CancelFlowResponse`	`CancelFlow(CancelFlowRequest req)` 用于撤销签署流程适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
`CancelMultiFlowSignQRCodeResponse`	`CancelMultiFlowSignQRCode(CancelMultiFlowSignQRCodeRequest req)` 此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
`CreateBatchCancelFlowUrlResponse`	`CreateBatchCancelFlowUrl(CreateBatchCancelFlowUrlRequest req)` 注：此接口建会废弃，请使用撤销单个签署流程（CancelFlow）接口。指定需要批量撤回的签署流程Id，获取批量撤销链接。客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回。
`CreateConvertTaskApiResponse`	`CreateConvertTaskApi(CreateConvertTaskApiRequest req)` 上传了word、excel文件后，通过该接口发起文件转换任务，将word、excel文件转换为pdf文件。
`CreateDocumentResponse`	`CreateDocument(CreateDocumentRequest req)` 创建签署流程电子文档适用场景：见创建签署流程接口。注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
`CreateFlowResponse`	`CreateFlow(CreateFlowRequest req)` 创建签署流程适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。注：该接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
`CreateFlowApproversResponse`	`CreateFlowApprovers(CreateFlowApproversRequest req)` 补充签署流程本企业签署人信息适用场景：在通过模板或者文件发起合同时，若未指定本企业签署人信息，则流程发起后，可以调用此接口补充签署人。同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。注：目前暂时只支持补充来源于企业微信的员工作为候选签署人
`CreateFlowByFilesResponse`	`CreateFlowByFiles(CreateFlowByFilesRequest req)` 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。适用场景2：可通过该接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
`CreateFlowEvidenceReportResponse`	`CreateFlowEvidenceReport(CreateFlowEvidenceReportRequest req)` 创建出证报告，返回报告 ID。需要配合出证套餐才能调用。出证需要一定时间，建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
`CreateFlowRemindsResponse`	`CreateFlowReminds(CreateFlowRemindsRequest req)` 指定需要批量催办的签署流程Id，批量催办合同，最多100个; 接口失败后返回错误信息注意: 该接口不可直接调用，请联系客户经理申请使用仅能催办当前状态为“待签署”的签署人，且只能催办一次发起合同时，签署人的NotifyType需设置为sms，否则无法催办
`CreateFlowSignReviewResponse`	`CreateFlowSignReview(CreateFlowSignReviewRequest req)` 提交企业签署流程审批结果适用场景: 在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时，若指定了参数 NeedSignReview 为true，且发起方企业作为签署方参与了流程签署，则可以调用此接口提交企业内部签署审批结果。若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
`CreateFlowSignUrlResponse`	`CreateFlowSignUrl(CreateFlowSignUrlRequest req)` 创建集成页面签署链接，请联系客户经理申请使用
`CreateIntegrationEmployeesResponse`	`CreateIntegrationEmployees(CreateIntegrationEmployeesRequest req)` 创建员工,如需在此接口提醒员工实名，入参Employees的OpenId不传
`CreateIntegrationUserRolesResponse`	`CreateIntegrationUserRoles(CreateIntegrationUserRolesRequest req)` 绑定员工与对应角色
`CreateMultiFlowSignQRCodeResponse`	`CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req)` 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。本接口适用于发起方没有填写控件的 B2C或者单C模板若是B2C模板,还要满足以下任意一个条件 - 模板中配置的签署顺序是无序 - B端企业的签署方式是静默签署 - B端企业是非首位签署
`CreatePreparedPersonalEsignResponse`	`CreatePreparedPersonalEsign(CreatePreparedPersonalEsignRequest req)` 本接口（CreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，在开通个人自动签之后调用，使用此接口请与客户经理确认）。
`CreatePrepareFlowResponse`	`CreatePrepareFlow(CreatePrepareFlowRequest req)` 创建快速发起流程适用场景：用户通过API 合同文件及签署信息，并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认，快速发起合同.
`CreateReleaseFlowResponse`	`CreateReleaseFlow(CreateReleaseFlowRequest req)` 发起解除协议，主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
`CreateSchemeUrlResponse`	`CreateSchemeUrl(CreateSchemeUrlRequest req)` 获取小程序签署链接适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）如您需要自主配置小程序跳转链接，请参考: 跳转小程序链接配置说明
`CreateSealPolicyResponse`	`CreateSealPolicy(CreateSealPolicyRequest req)` 对企业员工进行印章授权
`CreateUserAutoSignEnableUrlResponse`	`CreateUserAutoSignEnableUrl(CreateUserAutoSignEnableUrlRequest req)` 企业方可以通过此接口获取个人用户开启自动签的跳转链接（处方单场景专用，使用此接口请与客户经理确认）
`DeleteIntegrationEmployeesResponse`	`DeleteIntegrationEmployees(DeleteIntegrationEmployeesRequest req)` 移除员工
`DeleteIntegrationRoleUsersResponse`	`DeleteIntegrationRoleUsers(DeleteIntegrationRoleUsersRequest req)` 解绑员工与对应角色关系
`DeleteSealPoliciesResponse`	`DeleteSealPolicies(DeleteSealPoliciesRequest req)` 撤销员工持有的印章权限
`DescribeFileUrlsResponse`	`DescribeFileUrls(DescribeFileUrlsRequest req)` 查询文件下载URL 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
`DescribeFlowBriefsResponse`	`DescribeFlowBriefs(DescribeFlowBriefsRequest req)` 查询流程摘要适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。日调用量默认10W
`DescribeFlowEvidenceReportResponse`	`DescribeFlowEvidenceReport(DescribeFlowEvidenceReportRequest req)` 查询出证报告，返回报告 URL。
`DescribeFlowInfoResponse`	`DescribeFlowInfo(DescribeFlowInfoRequest req)` 查询合同详情适用场景：可用于主动查询某个合同详情信息。
`DescribeFlowTemplatesResponse`	`DescribeFlowTemplates(DescribeFlowTemplatesRequest req)` 当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
`DescribeIntegrationEmployeesResponse`	`DescribeIntegrationEmployees(DescribeIntegrationEmployeesRequest req)` 查询企业员工列表，每次返回的数据量最大为20
`DescribeIntegrationMainOrganizationUserResponse`	`DescribeIntegrationMainOrganizationUser(DescribeIntegrationMainOrganizationUserRequest req)` 通过子企业影子账号查询主企业员工账号
`DescribeIntegrationRolesResponse`	`DescribeIntegrationRoles(DescribeIntegrationRolesRequest req)` 查询企业角色列表
`DescribeOrganizationGroupOrganizationsResponse`	`DescribeOrganizationGroupOrganizations(DescribeOrganizationGroupOrganizationsRequest req)` 此API接口用户查询加入集团的成员企业
`DescribeOrganizationSealsResponse`	`DescribeOrganizationSeals(DescribeOrganizationSealsRequest req)` 查询企业印章的列表，需要操作者具有查询印章权限客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
`DescribeThirdPartyAuthCodeResponse`	`DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req)` 通过AuthCode查询用户是否实名
`DescribeUserAutoSignStatusResponse`	`DescribeUserAutoSignStatus(DescribeUserAutoSignStatusRequest req)` 企业方可以通过此接口查询个人用户自动签开启状态。（处方单场景专用，使用此接口请与客户经理确认）
`DisableUserAutoSignResponse`	`DisableUserAutoSign(DisableUserAutoSignRequest req)` 企业方可以通过此接口关闭个人的自动签功能（处方单场景专用，使用此接口请与客户经理确认）
`GetTaskResultApiResponse`	`GetTaskResultApi(GetTaskResultApiRequest req)` 通过发起转换任务接口（CreateConvertTaskApi）返回的任务Id查询转换任务状态，通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。
`ModifyApplicationCallbackInfoResponse`	`ModifyApplicationCallbackInfo(ModifyApplicationCallbackInfoRequest req)` 新增/删除应用callbackinfo callbackinfo包含：回调地址和签名key 操作：新增/删除
`StartFlowResponse`	`StartFlow(StartFlowRequest req)` 此接口用于发起流程适用场景：见创建签署流程接口。注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
`UnbindEmployeeUserIdWithClientOpenIdResponse`	`UnbindEmployeeUserIdWithClientOpenId(UnbindEmployeeUserIdWithClientOpenIdRequest req)` 将存在绑定关系的电子签系统员工userId与客户系统员工openId进行解绑
`UpdateIntegrationEmployeesResponse`	`UpdateIntegrationEmployees(UpdateIntegrationEmployeesRequest req)` 更新员工信息(姓名，手机号，邮件)，用户实名后无法更改姓名与手机号
`UploadFilesResponse`	`UploadFiles(UploadFilesRequest req)` 此接口（UploadFiles）用于文件上传。适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。其中上传的文件，图片类型(png/jpg/jpeg)大小限制为5M，其他大小限制为60M。调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn，并设置参数Version/版本号为2020-12-22
`VerifyPdfResponse`	`VerifyPdf(VerifyPdfRequest req)` 对流程的合同文件进行验证，判断文件是否合法。

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
  - EssClient
```
public EssClient(Credential credential,
                 String region)
```
  - EssClient
```
public EssClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- Method Detail
  - BindEmployeeUserIdWithClientOpenId
```
public BindEmployeeUserIdWithClientOpenIdResponse BindEmployeeUserIdWithClientOpenId(BindEmployeeUserIdWithClientOpenIdRequest req)
                                                                              throws TencentCloudSDKException
```
    将电子签系统员工userId与客户系统员工openId进行绑定
    
    Parameters:
    
    req - BindEmployeeUserIdWithClientOpenIdRequest
    
    Returns:
    
    BindEmployeeUserIdWithClientOpenIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - CancelFlow
```
public CancelFlowResponse CancelFlow(CancelFlowRequest req)
                              throws TencentCloudSDKException
```
    用于撤销签署流程适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
    
    Parameters:
    
    req - CancelFlowRequest
    
    Returns:
    
    CancelFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - CancelMultiFlowSignQRCode
```
public CancelMultiFlowSignQRCodeResponse CancelMultiFlowSignQRCode(CancelMultiFlowSignQRCodeRequest req)
                                                            throws TencentCloudSDKException
```
    此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
    
    Parameters:
    
    req - CancelMultiFlowSignQRCodeRequest
    
    Returns:
    
    CancelMultiFlowSignQRCodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateBatchCancelFlowUrl
```
public CreateBatchCancelFlowUrlResponse CreateBatchCancelFlowUrl(CreateBatchCancelFlowUrlRequest req)
                                                          throws TencentCloudSDKException
```
    注：此接口建会废弃，请使用撤销单个签署流程（CancelFlow）接口。指定需要批量撤回的签署流程Id，获取批量撤销链接。客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回。
    
    Parameters:
    
    req - CreateBatchCancelFlowUrlRequest
    
    Returns:
    
    CreateBatchCancelFlowUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateConvertTaskApi
```
public CreateConvertTaskApiResponse CreateConvertTaskApi(CreateConvertTaskApiRequest req)
                                                  throws TencentCloudSDKException
```
    上传了word、excel文件后，通过该接口发起文件转换任务，将word、excel文件转换为pdf文件。
    
    Parameters:
    
    req - CreateConvertTaskApiRequest
    
    Returns:
    
    CreateConvertTaskApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateDocument
```
public CreateDocumentResponse CreateDocument(CreateDocumentRequest req)
                                      throws TencentCloudSDKException
```
    创建签署流程电子文档适用场景：见创建签署流程接口。注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
    
    Parameters:
    
    req - CreateDocumentRequest
    
    Returns:
    
    CreateDocumentResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlow
```
public CreateFlowResponse CreateFlow(CreateFlowRequest req)
                              throws TencentCloudSDKException
```
    创建签署流程适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。注：该接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
    
    Parameters:
    
    req - CreateFlowRequest
    
    Returns:
    
    CreateFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowApprovers
```
public CreateFlowApproversResponse CreateFlowApprovers(CreateFlowApproversRequest req)
                                                throws TencentCloudSDKException
```
    补充签署流程本企业签署人信息适用场景：在通过模板或者文件发起合同时，若未指定本企业签署人信息，则流程发起后，可以调用此接口补充签署人。同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。注：目前暂时只支持补充来源于企业微信的员工作为候选签署人
    
    Parameters:
    
    req - CreateFlowApproversRequest
    
    Returns:
    
    CreateFlowApproversResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowByFiles
```
public CreateFlowByFilesResponse CreateFlowByFiles(CreateFlowByFilesRequest req)
                                            throws TencentCloudSDKException
```
    此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。适用场景2：可通过该接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
    
    Parameters:
    
    req - CreateFlowByFilesRequest
    
    Returns:
    
    CreateFlowByFilesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowEvidenceReport
```
public CreateFlowEvidenceReportResponse CreateFlowEvidenceReport(CreateFlowEvidenceReportRequest req)
                                                          throws TencentCloudSDKException
```
    创建出证报告，返回报告 ID。需要配合出证套餐才能调用。出证需要一定时间，建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
    
    Parameters:
    
    req - CreateFlowEvidenceReportRequest
    
    Returns:
    
    CreateFlowEvidenceReportResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowReminds
```
public CreateFlowRemindsResponse CreateFlowReminds(CreateFlowRemindsRequest req)
                                            throws TencentCloudSDKException
```
    指定需要批量催办的签署流程Id，批量催办合同，最多100个; 接口失败后返回错误信息注意: 该接口不可直接调用，请联系客户经理申请使用仅能催办当前状态为“待签署”的签署人，且只能催办一次发起合同时，签署人的NotifyType需设置为sms，否则无法催办
    
    Parameters:
    
    req - CreateFlowRemindsRequest
    
    Returns:
    
    CreateFlowRemindsResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowSignReview
```
public CreateFlowSignReviewResponse CreateFlowSignReview(CreateFlowSignReviewRequest req)
                                                  throws TencentCloudSDKException
```
    提交企业签署流程审批结果适用场景: 在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时，若指定了参数 NeedSignReview 为true，且发起方企业作为签署方参与了流程签署，则可以调用此接口提交企业内部签署审批结果。若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
    
    Parameters:
    
    req - CreateFlowSignReviewRequest
    
    Returns:
    
    CreateFlowSignReviewResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowSignUrl
```
public CreateFlowSignUrlResponse CreateFlowSignUrl(CreateFlowSignUrlRequest req)
                                            throws TencentCloudSDKException
```
    创建集成页面签署链接，请联系客户经理申请使用
    
    Parameters:
    
    req - CreateFlowSignUrlRequest
    
    Returns:
    
    CreateFlowSignUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateIntegrationEmployees
```
public CreateIntegrationEmployeesResponse CreateIntegrationEmployees(CreateIntegrationEmployeesRequest req)
                                                              throws TencentCloudSDKException
```
    创建员工,如需在此接口提醒员工实名，入参Employees的OpenId不传
    
    Parameters:
    
    req - CreateIntegrationEmployeesRequest
    
    Returns:
    
    CreateIntegrationEmployeesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateIntegrationUserRoles
```
public CreateIntegrationUserRolesResponse CreateIntegrationUserRoles(CreateIntegrationUserRolesRequest req)
                                                              throws TencentCloudSDKException
```
    绑定员工与对应角色
    
    Parameters:
    
    req - CreateIntegrationUserRolesRequest
    
    Returns:
    
    CreateIntegrationUserRolesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateMultiFlowSignQRCode
```
public CreateMultiFlowSignQRCodeResponse CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req)
                                                            throws TencentCloudSDKException
```
    此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。本接口适用于发起方没有填写控件的 B2C或者单C模板** 若是B2C模板,还要满足以下任意一个条件** - 模板中配置的签署顺序是无序 - B端企业的签署方式是静默签署 - B端企业是非首位签署
    
    Parameters:
    
    req - CreateMultiFlowSignQRCodeRequest
    
    Returns:
    
    CreateMultiFlowSignQRCodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePrepareFlow
```
public CreatePrepareFlowResponse CreatePrepareFlow(CreatePrepareFlowRequest req)
                                            throws TencentCloudSDKException
```
    创建快速发起流程适用场景：用户通过API 合同文件及签署信息，并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认，快速发起合同. 注：该接口文件的resourceId 是通过上传文件之后获取的。
    
    Parameters:
    
    req - CreatePrepareFlowRequest
    
    Returns:
    
    CreatePrepareFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePreparedPersonalEsign
```
public CreatePreparedPersonalEsignResponse CreatePreparedPersonalEsign(CreatePreparedPersonalEsignRequest req)
                                                                throws TencentCloudSDKException
```
    本接口（CreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，在开通个人自动签之后调用，使用此接口请与客户经理确认）。
    
    Parameters:
    
    req - CreatePreparedPersonalEsignRequest
    
    Returns:
    
    CreatePreparedPersonalEsignResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateReleaseFlow
```
public CreateReleaseFlowResponse CreateReleaseFlow(CreateReleaseFlowRequest req)
                                            throws TencentCloudSDKException
```
    发起解除协议，主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
    
    Parameters:
    
    req - CreateReleaseFlowRequest
    
    Returns:
    
    CreateReleaseFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSchemeUrl
```
public CreateSchemeUrlResponse CreateSchemeUrl(CreateSchemeUrlRequest req)
                                        throws TencentCloudSDKException
```
    获取小程序签署链接适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）如您需要自主配置小程序跳转链接，请参考: 跳转小程序链接配置说明
    
    Parameters:
    
    req - CreateSchemeUrlRequest
    
    Returns:
    
    CreateSchemeUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSealPolicy
```
public CreateSealPolicyResponse CreateSealPolicy(CreateSealPolicyRequest req)
                                          throws TencentCloudSDKException
```
    对企业员工进行印章授权
    
    Parameters:
    
    req - CreateSealPolicyRequest
    
    Returns:
    
    CreateSealPolicyResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateUserAutoSignEnableUrl
```
public CreateUserAutoSignEnableUrlResponse CreateUserAutoSignEnableUrl(CreateUserAutoSignEnableUrlRequest req)
                                                                throws TencentCloudSDKException
```
    企业方可以通过此接口获取个人用户开启自动签的跳转链接（处方单场景专用，使用此接口请与客户经理确认）
    
    Parameters:
    
    req - CreateUserAutoSignEnableUrlRequest
    
    Returns:
    
    CreateUserAutoSignEnableUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteIntegrationEmployees
```
public DeleteIntegrationEmployeesResponse DeleteIntegrationEmployees(DeleteIntegrationEmployeesRequest req)
                                                              throws TencentCloudSDKException
```
    移除员工
    
    Parameters:
    
    req - DeleteIntegrationEmployeesRequest
    
    Returns:
    
    DeleteIntegrationEmployeesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteIntegrationRoleUsers
```
public DeleteIntegrationRoleUsersResponse DeleteIntegrationRoleUsers(DeleteIntegrationRoleUsersRequest req)
                                                              throws TencentCloudSDKException
```
    解绑员工与对应角色关系
    
    Parameters:
    
    req - DeleteIntegrationRoleUsersRequest
    
    Returns:
    
    DeleteIntegrationRoleUsersResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteSealPolicies
```
public DeleteSealPoliciesResponse DeleteSealPolicies(DeleteSealPoliciesRequest req)
                                              throws TencentCloudSDKException
```
    撤销员工持有的印章权限
    
    Parameters:
    
    req - DeleteSealPoliciesRequest
    
    Returns:
    
    DeleteSealPoliciesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFileUrls
```
public DescribeFileUrlsResponse DescribeFileUrls(DescribeFileUrlsRequest req)
                                          throws TencentCloudSDKException
```
    查询文件下载URL 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
    
    Parameters:
    
    req - DescribeFileUrlsRequest
    
    Returns:
    
    DescribeFileUrlsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlowBriefs
```
public DescribeFlowBriefsResponse DescribeFlowBriefs(DescribeFlowBriefsRequest req)
                                              throws TencentCloudSDKException
```
    查询流程摘要适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。日调用量默认10W
    
    Parameters:
    
    req - DescribeFlowBriefsRequest
    
    Returns:
    
    DescribeFlowBriefsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlowEvidenceReport
```
public DescribeFlowEvidenceReportResponse DescribeFlowEvidenceReport(DescribeFlowEvidenceReportRequest req)
                                                              throws TencentCloudSDKException
```
    查询出证报告，返回报告 URL。
    
    Parameters:
    
    req - DescribeFlowEvidenceReportRequest
    
    Returns:
    
    DescribeFlowEvidenceReportResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlowInfo
```
public DescribeFlowInfoResponse DescribeFlowInfo(DescribeFlowInfoRequest req)
                                          throws TencentCloudSDKException
```
    查询合同详情适用场景：可用于主动查询某个合同详情信息。
    
    Parameters:
    
    req - DescribeFlowInfoRequest
    
    Returns:
    
    DescribeFlowInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlowTemplates
```
public DescribeFlowTemplatesResponse DescribeFlowTemplates(DescribeFlowTemplatesRequest req)
                                                    throws TencentCloudSDKException
```
    当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
    
    Parameters:
    
    req - DescribeFlowTemplatesRequest
    
    Returns:
    
    DescribeFlowTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIntegrationEmployees
```
public DescribeIntegrationEmployeesResponse DescribeIntegrationEmployees(DescribeIntegrationEmployeesRequest req)
                                                                  throws TencentCloudSDKException
```
    查询企业员工列表，每次返回的数据量最大为20
    
    Parameters:
    
    req - DescribeIntegrationEmployeesRequest
    
    Returns:
    
    DescribeIntegrationEmployeesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIntegrationMainOrganizationUser
```
public DescribeIntegrationMainOrganizationUserResponse DescribeIntegrationMainOrganizationUser(DescribeIntegrationMainOrganizationUserRequest req)
                                                                                        throws TencentCloudSDKException
```
    通过子企业影子账号查询主企业员工账号
    
    Parameters:
    
    req - DescribeIntegrationMainOrganizationUserRequest
    
    Returns:
    
    DescribeIntegrationMainOrganizationUserResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIntegrationRoles
```
public DescribeIntegrationRolesResponse DescribeIntegrationRoles(DescribeIntegrationRolesRequest req)
                                                          throws TencentCloudSDKException
```
    查询企业角色列表
    
    Parameters:
    
    req - DescribeIntegrationRolesRequest
    
    Returns:
    
    DescribeIntegrationRolesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeOrganizationGroupOrganizations
```
public DescribeOrganizationGroupOrganizationsResponse DescribeOrganizationGroupOrganizations(DescribeOrganizationGroupOrganizationsRequest req)
                                                                                      throws TencentCloudSDKException
```
    此API接口用户查询加入集团的成员企业
    
    Parameters:
    
    req - DescribeOrganizationGroupOrganizationsRequest
    
    Returns:
    
    DescribeOrganizationGroupOrganizationsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeOrganizationSeals
```
public DescribeOrganizationSealsResponse DescribeOrganizationSeals(DescribeOrganizationSealsRequest req)
                                                            throws TencentCloudSDKException
```
    查询企业印章的列表，需要操作者具有查询印章权限客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
    
    Parameters:
    
    req - DescribeOrganizationSealsRequest
    
    Returns:
    
    DescribeOrganizationSealsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeThirdPartyAuthCode
```
public DescribeThirdPartyAuthCodeResponse DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req)
                                                              throws TencentCloudSDKException
```
    通过AuthCode查询用户是否实名
    
    Parameters:
    
    req - DescribeThirdPartyAuthCodeRequest
    
    Returns:
    
    DescribeThirdPartyAuthCodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUserAutoSignStatus
```
public DescribeUserAutoSignStatusResponse DescribeUserAutoSignStatus(DescribeUserAutoSignStatusRequest req)
                                                              throws TencentCloudSDKException
```
    企业方可以通过此接口查询个人用户自动签开启状态。（处方单场景专用，使用此接口请与客户经理确认）
    
    Parameters:
    
    req - DescribeUserAutoSignStatusRequest
    
    Returns:
    
    DescribeUserAutoSignStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableUserAutoSign
```
public DisableUserAutoSignResponse DisableUserAutoSign(DisableUserAutoSignRequest req)
                                                throws TencentCloudSDKException
```
    企业方可以通过此接口关闭个人的自动签功能（处方单场景专用，使用此接口请与客户经理确认）
    
    Parameters:
    
    req - DisableUserAutoSignRequest
    
    Returns:
    
    DisableUserAutoSignResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetTaskResultApi
```
public GetTaskResultApiResponse GetTaskResultApi(GetTaskResultApiRequest req)
                                          throws TencentCloudSDKException
```
    通过发起转换任务接口（CreateConvertTaskApi）返回的任务Id查询转换任务状态，通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。
    
    Parameters:
    
    req - GetTaskResultApiRequest
    
    Returns:
    
    GetTaskResultApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyApplicationCallbackInfo
```
public ModifyApplicationCallbackInfoResponse ModifyApplicationCallbackInfo(ModifyApplicationCallbackInfoRequest req)
                                                                    throws TencentCloudSDKException
```
    新增/删除应用callbackinfo callbackinfo包含：回调地址和签名key 操作：新增/删除
    
    Parameters:
    
    req - ModifyApplicationCallbackInfoRequest
    
    Returns:
    
    ModifyApplicationCallbackInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartFlow
```
public StartFlowResponse StartFlow(StartFlowRequest req)
                            throws TencentCloudSDKException
```
    此接口用于发起流程适用场景：见创建签署流程接口。注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
    
    Parameters:
    
    req - StartFlowRequest
    
    Returns:
    
    StartFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnbindEmployeeUserIdWithClientOpenId
```
public UnbindEmployeeUserIdWithClientOpenIdResponse UnbindEmployeeUserIdWithClientOpenId(UnbindEmployeeUserIdWithClientOpenIdRequest req)
                                                                                  throws TencentCloudSDKException
```
    将存在绑定关系的电子签系统员工userId与客户系统员工openId进行解绑
    
    Parameters:
    
    req - UnbindEmployeeUserIdWithClientOpenIdRequest
    
    Returns:
    
    UnbindEmployeeUserIdWithClientOpenIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateIntegrationEmployees
```
public UpdateIntegrationEmployeesResponse UpdateIntegrationEmployees(UpdateIntegrationEmployeesRequest req)
                                                              throws TencentCloudSDKException
```
    更新员工信息(姓名，手机号，邮件)，用户实名后无法更改姓名与手机号
    
    Parameters:
    
    req - UpdateIntegrationEmployeesRequest
    
    Returns:
    
    UpdateIntegrationEmployeesResponse
    
    Throws:
    
    TencentCloudSDKException
  - UploadFiles
```
public UploadFilesResponse UploadFiles(UploadFilesRequest req)
                                throws TencentCloudSDKException
```
    此接口（UploadFiles）用于文件上传。适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。其中上传的文件，图片类型(png/jpg/jpeg)大小限制为5M，其他大小限制为60M。调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn，并设置参数Version/版本号为2020-12-22
    
    Parameters:
    
    req - UploadFilesRequest
    
    Returns:
    
    UploadFilesResponse
    
    Throws:
    
    TencentCloudSDKException
  - VerifyPdf
```
public VerifyPdfResponse VerifyPdf(VerifyPdfRequest req)
                            throws TencentCloudSDKException
```
    对流程的合同文件进行验证，判断文件是否合法。
    
    Parameters:
    
    req - VerifyPdfRequest
    
    Returns:
    
    VerifyPdfResponse
    
    Throws:
    
    TencentCloudSDKException

Class EssClient

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

EssClient

EssClient

Method Detail

BindEmployeeUserIdWithClientOpenId

CancelFlow

CancelMultiFlowSignQRCode

CreateBatchCancelFlowUrl

CreateConvertTaskApi

CreateDocument

CreateFlow

CreateFlowApprovers

CreateFlowByFiles

CreateFlowEvidenceReport

CreateFlowReminds

CreateFlowSignReview

CreateFlowSignUrl

CreateIntegrationEmployees

CreateIntegrationUserRoles

CreateMultiFlowSignQRCode

CreatePrepareFlow

CreatePreparedPersonalEsign

CreateReleaseFlow

CreateSchemeUrl

CreateSealPolicy

CreateUserAutoSignEnableUrl

DeleteIntegrationEmployees

DeleteIntegrationRoleUsers

DeleteSealPolicies

DescribeFileUrls

DescribeFlowBriefs

DescribeFlowEvidenceReport

DescribeFlowInfo

DescribeFlowTemplates

DescribeIntegrationEmployees

DescribeIntegrationMainOrganizationUser

DescribeIntegrationRoles

DescribeOrganizationGroupOrganizations

DescribeOrganizationSeals

DescribeThirdPartyAuthCode

DescribeUserAutoSignStatus

DisableUserAutoSign

GetTaskResultApi

ModifyApplicationCallbackInfo

StartFlow

UnbindEmployeeUserIdWithClientOpenId

UpdateIntegrationEmployees

UploadFiles

VerifyPdf