EssClient (tencentcloud-sdk-java 3.1.868 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)` 此接口（BindEmployeeUserIdWithClientOpenId）用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
`CancelFlowResponse`	`CancelFlow(CancelFlowRequest req)` 用于撤销签署流程适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。 `注意：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。`
`CancelMultiFlowSignQRCodeResponse`	`CancelMultiFlowSignQRCode(CancelMultiFlowSignQRCodeRequest req)` 此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
`CancelUserAutoSignEnableUrlResponse`	`CancelUserAutoSignEnableUrl(CancelUserAutoSignEnableUrlRequest req)` 用来撤销获取个人用户自动签的开通状态生成的开通链接，撤销生成的链接失效。注: 若个人用户已经用生成的完成自动签署的开通，撤销链接无效不会对开通结果产生影响(此情况接口会报错)。处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。
`CreateBatchCancelFlowUrlResponse`	`CreateBatchCancelFlowUrl(CreateBatchCancelFlowUrlRequest req)` 注：此接口将会废弃，请使用撤销单个签署流程（CancelFlow）接口。指定需要批量撤回的签署流程Id，获取批量撤销链接。客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回。
`CreateBatchSignUrlResponse`	`CreateBatchSignUrl(CreateBatchSignUrlRequest req)` 通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。注： - 参与人点击链接后需短信验证码才能查看合同内容。 - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。 - 个人批量签署，签名区`仅支持手写签名`。
`CreateConvertTaskApiResponse`	`CreateConvertTaskApi(CreateConvertTaskApiRequest req)` 此接口（CreateConvertTaskApi）用来将word、excel、图片、txt类型文件转换为PDF文件。前提条件：源文件已经通过文件上传接口完成上传，并得到了源文件的资源Id。适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过查询转换任务状态接口获取任务状态。注: 1.
`CreateDocumentResponse`	`CreateDocument(CreateDocumentRequest req)` 创建签署流程电子文档适用场景：见创建签署流程接口。点击查看通过模板创建签署流程用PDF文件创建签署流程。注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置创建签署流程和发起签署流程接口使用。具体逻辑可以参考下图:
`CreateEmbedWebUrlResponse`	`CreateEmbedWebUrl(CreateEmbedWebUrlRequest req)` 本接口（CreateEmbedWebUrl）用于创建嵌入Web的链接，支持以下类型的Web链接创建： 1.
`CreateFlowResponse`	`CreateFlow(CreateFlowRequest req)` 通过模板创建签署流程适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。注：配合创建电子文档和发起签署流程接口使用。整体的逻辑如下图
`CreateFlowApproversResponse`	`CreateFlowApprovers(CreateFlowApproversRequest req)` 适用场景：当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。限制条件： 1.
`CreateFlowByFilesResponse`	`CreateFlowByFiles(CreateFlowByFilesRequest req)` 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。适用场景2：可通过该接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
`CreateFlowEvidenceReportResponse`	`CreateFlowEvidenceReport(CreateFlowEvidenceReportRequest req)` 提交申请出证报告任务并返回报告ID。注意：使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。合同流程必须所有参与方`已经签署完成`。出证过程需一定时间，建议在`提交出证任务后的24小时之后`，通过获取出证报告任务执行结果接口进行查询执行结果和出证报告的下载URL。
`CreateFlowGroupByFilesResponse`	`CreateFlowGroupByFiles(CreateFlowGroupByFilesRequest req)` 此接口（CreateFlowGroupByFiles）可用于通过多个文件创建合同组签署流程。适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。注意事项：使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
`CreateFlowGroupByTemplatesResponse`	`CreateFlowGroupByTemplates(CreateFlowGroupByTemplatesRequest req)` 此接口（CreateFlowGroupByTemplates）可用于通过多个模板创建合同组签署流程。适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
`CreateFlowRemindsResponse`	`CreateFlowReminds(CreateFlowRemindsRequest req)` 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： 1.
`CreateFlowSignReviewResponse`	`CreateFlowSignReview(CreateFlowSignReviewRequest req)` 提交签署流程审批结果的适用场景包括： 1.
`CreateFlowSignUrlResponse`	`CreateFlowSignUrl(CreateFlowSignUrlRequest req)` 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署 `注意：` `1.
`CreateIntegrationDepartmentResponse`	`CreateIntegrationDepartment(CreateIntegrationDepartmentRequest req)` 此接口（CreateIntegrationDepartment）用于创建企业的部门信息，支持绑定客户系统部门ID。
`CreateIntegrationEmployeesResponse`	`CreateIntegrationEmployees(CreateIntegrationEmployeesRequest req)` 此接口（CreateIntegrationEmployees）用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建，则不会重新创建，但会发送短信提醒员工实名。另外，此接口还支持通过企微组织架构的openid 创建员工（将WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内），该场景下，员工会接收到提醒实名的企微消息。
`CreateIntegrationRoleResponse`	`CreateIntegrationRole(CreateIntegrationRoleRequest req)` 此接口（CreateIntegrationRole）用来创建企业自定义的SaaS角色或集团角色。适用场景1：创建当前企业的自定义SaaS角色或集团角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。适用场景2：创建当前企业的自定义SaaS角色或集团角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。适用场景3：创建集团角色时可同时设置角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。注意事项：SaaS角色和集团角色对应的权限树是不一样的。
`CreateIntegrationUserRolesResponse`	`CreateIntegrationUserRoles(CreateIntegrationUserRolesRequest req)` 此接口用于赋予员工指定的角色权限，如需解绑请使用 DeleteIntegrationRoleUsers 接口。
`CreateMultiFlowSignQRCodeResponse`	`CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req)` 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。本接口适用于发起方没有填写控件的 B2C或者单C模板若是B2C模板,还要满足以下任意一个条件 - 模板中配置的签署顺序是无序 - B端企业的签署方式是静默签署 - B端企业是非首位签署通过一码多扫二维码发起的合同，涉及到的合同回调消息可参考文档[合同发起以及签署相关回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign) 用户通过签署二维码发起合同时，因企业额度不足导致失败会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
`CreateOrganizationBatchSignUrlResponse`	`CreateOrganizationBatchSignUrl(CreateOrganizationBatchSignUrlRequest req)` 使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。附注： - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。 - 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
`CreatePersonAuthCertificateImageResponse`	`CreatePersonAuthCertificateImage(CreatePersonAuthCertificateImageRequest req)` 获取个人用户认证证书图片下载URL 个人用户认证证书图片样式如下图 ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png) 注: 只能获取个人用户证明图片, 企业员工的暂不支持处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。
`CreatePreparedPersonalEsignResponse`	`CreatePreparedPersonalEsign(CreatePreparedPersonalEsignRequest req)` 本接口（CreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，使用此接口请与客户经理确认）。
`CreatePrepareFlowResponse`	`CreatePrepareFlow(CreatePrepareFlowRequest req)` 创建发起流程web页面适用场景：通过该接口（CreatePrepareFlow）传入合同文件/模板编号及签署人信息，可获得发起流程的可嵌入页面，在页面完成签署控件等信息的编辑与确认后，快速发起流程。注：该接口包含模板/文件发起流程的全部功能，调用接口后不会立即发起，需在可嵌入页面点击按钮进行发起流程。
`CreateReleaseFlowResponse`	`CreateReleaseFlow(CreateReleaseFlowRequest req)` 发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。注意： `原合同必须签署完`成后才能发起解除协议。只有原合同企业类型的参与人才能发起解除协议，`个人参与方不能发起解除协议`。原合同个人类型参与人必须是解除协议的参与人，`不能更换其他第三方个人`参与解除协议。如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的`企业员工代为处理`。发起解除协议同发起其他企业合同一样，也会参与合同`扣费`，扣费标准同其他类型合同。在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。
`CreateSchemeUrlResponse`	`CreateSchemeUrl(CreateSchemeUrlRequest req)` 获取跳转至腾讯电子签小程序的签署链接适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置注： `1.
`CreateSealResponse`	`CreateSeal(CreateSealRequest req)` 本接口（CreateSeal）用于创建企业电子印章，支持创建企业公章，合同章，财务专用章和人事专用章创建。
`CreateSealPolicyResponse`	`CreateSealPolicy(CreateSealPolicyRequest req)` 本接口（CreateSealPolicy）用于对企业员工进行印章授权
`CreateUserAutoSignEnableUrlResponse`	`CreateUserAutoSignEnableUrl(CreateUserAutoSignEnableUrlRequest req)` 获取个人用户自动签的开通链接。注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
`CreateWebThemeConfigResponse`	`CreateWebThemeConfig(CreateWebThemeConfigRequest req)` 用来设置本企业嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），设置后获取的web签署界面都会使用此配置进行展示。如果多次调用，会以最后一次的配置为准
`DeleteIntegrationDepartmentResponse`	`DeleteIntegrationDepartment(DeleteIntegrationDepartmentRequest req)` 此接口（DeleteIntegrationDepartment）用于删除企业的部门信息。
`DeleteIntegrationEmployeesResponse`	`DeleteIntegrationEmployees(DeleteIntegrationEmployeesRequest req)` 该接口（DeleteIntegrationEmployees）用于移除企业员工，同时可选择是否进行离职交接。 - 如果不设置交接人的ReceiveUserId或ReceiveOpenId，则该员工将被直接移除而不进行交接操作。 - 如果设置了ReceiveUserId或ReceiveOpenId，该员工未处理的合同将会被系统交接给设置的交接人，然后再对该员工进行离职操作。注：`1.
`DeleteIntegrationRoleUsersResponse`	`DeleteIntegrationRoleUsers(DeleteIntegrationRoleUsersRequest req)` 解绑员工与对应角色的关系，如需绑定请使用 CreateIntegrationUserRoles 接口。
`DeleteSealPoliciesResponse`	`DeleteSealPolicies(DeleteSealPoliciesRequest req)` 本接口（DeleteSealPolicies）用于撤销企业员工持有的印章权限
`DescribeExtendedServiceAuthInfosResponse`	`DescribeExtendedServiceAuthInfos(DescribeExtendedServiceAuthInfosRequest req)` 查询企业扩展服务的开通和授权情况，当前支持查询以下内容： 1.
`DescribeFileUrlsResponse`	`DescribeFileUrls(DescribeFileUrlsRequest req)` 本接口（DescribeFileUrls）用于查询文件的下载URL。适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
`DescribeFlowBriefsResponse`	`DescribeFlowBriefs(DescribeFlowBriefsRequest req)` 查询流程基础信息适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。注: `每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误`
`DescribeFlowComponentsResponse`	`DescribeFlowComponents(DescribeFlowComponentsRequest req)` 查询流程填写控件内容，可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
`DescribeFlowEvidenceReportResponse`	`DescribeFlowEvidenceReport(DescribeFlowEvidenceReportRequest req)` 获取出证报告任务执行结果，返回报告 URL。注意：使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。需调用创建并返回出证报告接口提交申请出证报告任务获取报告编号后调用当前接口获取报告链接。
`DescribeFlowInfoResponse`	`DescribeFlowInfo(DescribeFlowInfoRequest req)` 接口用户查询合同流程的详情信息, 支持查询多个(数量不能超过100) 适用场景：可用于主动查询某个合同详情信息。
`DescribeFlowTemplatesResponse`	`DescribeFlowTemplates(DescribeFlowTemplatesRequest req)` 此接口（DescribeFlowTemplates）用于查询本企业模板列表信息。 > 一个模板通常会包含以下结构信息 >- 模板基本信息 >- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方 >- 填写控件 Components >- 签署控件 SignComponents >- 生成模板的文件基础信息 FileInfos 当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取模板列表，以及每个模板内的控件信息。适用场景：该接口常用来配合模板发起合同-创建电子文档接口，作为创建电子文档的前置接口使用。通过此接口查询到模板信息后，再通过调用创建电子文档接口，指定模板ID，指定模板中需要的填写控件内容等，完成电子文档的创建。
`DescribeIntegrationDepartmentsResponse`	`DescribeIntegrationDepartments(DescribeIntegrationDepartmentsRequest req)` 此接口（DescribeIntegrationDepartments）用于查询企业的部门信息列表，支持查询单个部门节点或单个部门节点及一级子节点部门列表。
`DescribeIntegrationEmployeesResponse`	`DescribeIntegrationEmployees(DescribeIntegrationEmployeesRequest req)` 此接口（DescribeIntegrationEmployees）用于分页查询企业员工信息列表，支持设置过滤条件以筛选员工查询结果。
`DescribeIntegrationRolesResponse`	`DescribeIntegrationRoles(DescribeIntegrationRolesRequest req)` 此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。注：`法人角色是系统保留角色，因此返回列表中不含法人角色。`
`DescribeOrganizationGroupOrganizationsResponse`	`DescribeOrganizationGroupOrganizations(DescribeOrganizationGroupOrganizationsRequest req)` 此API接口用来查询加入集团的成员企业信息适用场景：子企业在加入集团后，主企业可能通过此接口获取到所有的子企业列表，方便进行展示和统计
`DescribeOrganizationSealsResponse`	`DescribeOrganizationSeals(DescribeOrganizationSealsRequest req)` 查询企业印章的列表，需要操作者具有查询印章权限客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
`DescribeThirdPartyAuthCodeResponse`	`DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req)` 通过AuthCode查询个人用户是否实名注意: 此接口为合作引流场景使用，使用`有白名单限制`，使用前请联系对接的客户经理沟通。 `AuthCode 只能使用一次`，查询一次再次查询会返回错误
`DescribeUserAutoSignStatusResponse`	`DescribeUserAutoSignStatus(DescribeUserAutoSignStatusRequest req)` 通过此接口获取个人用户自动签的开通状态。注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
`DisableUserAutoSignResponse`	`DisableUserAutoSign(DisableUserAutoSignRequest req)` 通过此接口可以关闭个人用户自动签功能。无需对应的用户刷脸等方式同意即可关闭。注意: 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。
`GetTaskResultApiResponse`	`GetTaskResultApi(GetTaskResultApiRequest req)` 查询转换任务的状态。转换任务Id通过发起转换任务接口（CreateConvertTaskApi）获取。注意：大文件转换所需的时间可能会比较长。
`ModifyApplicationCallbackInfoResponse`	`ModifyApplicationCallbackInfo(ModifyApplicationCallbackInfoRequest req)` 新增/删除企业应用集成中的回调配置。新增回调配置只会增加不存在的CallbackUrl；删除操作将针对找到的相同CallbackUrl的配置进行删除。请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
`ModifyIntegrationDepartmentResponse`	`ModifyIntegrationDepartment(ModifyIntegrationDepartmentRequest req)` 此接口（ModifyIntegrationDepartment）用于更新企业的部门信息，支持更新部门名称、客户系统部门ID和部门序号等信息。
`ModifyIntegrationRoleResponse`	`ModifyIntegrationRole(ModifyIntegrationRoleRequest req)` 此接口（ModifyIntegrationRole）用来更新企业自定义的SaaS角色或集团角色。适用场景1：更新当前企业的自定义SaaS角色或集团角色，并且更新时不进行角色中权限的更新（PermissionGroups 参数不传）。适用场景2：更新当前企业的自定义SaaS角色或集团角色，并且更新时进行角色中权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。适用场景3：更新集团角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。注意事项：SaaS角色和集团角色对应的权限树是不一样的。
`StartFlowResponse`	`StartFlow(StartFlowRequest req)` 此接口用于启动流程。它是模板发起合同的最后一步。在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
`UnbindEmployeeUserIdWithClientOpenIdResponse`	`UnbindEmployeeUserIdWithClientOpenId(UnbindEmployeeUserIdWithClientOpenIdRequest req)` 此接口（UnbindEmployeeUserIdWithClientOpenId）用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。注：`在调用此接口时，需确保OpenId已通过调用`BindEmployeeUserIdWithClientOpenId`接口与电子签系统的UserId绑定过。若OpenId未经过绑定，则无法使用此接口进行解绑操作。`
`UpdateIntegrationEmployeesResponse`	`UpdateIntegrationEmployees(UpdateIntegrationEmployeesRequest req)` 更新员工信息(姓名，手机号，邮件、部门)，用户实名后无法更改姓名与手机号。可进行批量操作，Employees中的userID与openID二选一必填
`UploadFilesResponse`	`UploadFiles(UploadFilesRequest req)` 此接口（UploadFiles）用于文件上传。适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。其中上传的文件，图片类型(png/jpg/jpeg)大小限制为5M，其他大小限制为60M。调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,代码示例： HttpProfile httpProfile = new HttpProfile(); httpProfile.setEndpoint("file.test.ess.tencent.cn");
`VerifyPdfResponse`	`VerifyPdf(VerifyPdfRequest req)` 对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

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
```
    此接口（BindEmployeeUserIdWithClientOpenId）用于将电子签系统员工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，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
    
    Parameters:
    
    req - CancelMultiFlowSignQRCodeRequest
    
    Returns:
    
    CancelMultiFlowSignQRCodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - CancelUserAutoSignEnableUrl
```
public CancelUserAutoSignEnableUrlResponse CancelUserAutoSignEnableUrl(CancelUserAutoSignEnableUrlRequest req)
                                                                throws TencentCloudSDKException
```
    用来撤销获取个人用户自动签的开通状态生成的开通链接，撤销生成的链接失效。注:
    - 若个人用户已经用生成的完成自动签署的开通，撤销链接无效不会对开通结果产生影响(此情况接口会报错)。
    - 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。
    Parameters:
    
    req - CancelUserAutoSignEnableUrlRequest
    
    Returns:
    
    CancelUserAutoSignEnableUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateBatchCancelFlowUrl
```
public CreateBatchCancelFlowUrlResponse CreateBatchCancelFlowUrl(CreateBatchCancelFlowUrlRequest req)
                                                          throws TencentCloudSDKException
```
    注：此接口将会废弃，请使用撤销单个签署流程（CancelFlow）接口。指定需要批量撤回的签署流程Id，获取批量撤销链接。客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回。
    
    Parameters:
    
    req - CreateBatchCancelFlowUrlRequest
    
    Returns:
    
    CreateBatchCancelFlowUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateBatchSignUrl
```
public CreateBatchSignUrlResponse CreateBatchSignUrl(CreateBatchSignUrlRequest req)
                                              throws TencentCloudSDKException
```
    通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。注： - 参与人点击链接后需短信验证码才能查看合同内容。 - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。 - 个人批量签署，签名区`仅支持手写签名`。
    
    Parameters:
    
    req - CreateBatchSignUrlRequest
    
    Returns:
    
    CreateBatchSignUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateConvertTaskApi
```
public CreateConvertTaskApiResponse CreateConvertTaskApi(CreateConvertTaskApiRequest req)
                                                  throws TencentCloudSDKException
```
    此接口（CreateConvertTaskApi）用来将word、excel、图片、txt类型文件转换为PDF文件。
    前提条件：源文件已经通过文件上传接口完成上传，并得到了源文件的资源Id。
    适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同
    转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过查询转换任务状态接口获取任务状态。
    注: 1. `支持的文件类型有doc、docx、xls、xlsx、jpg、jpeg、png、bmp、txt` 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
    
    Parameters:
    
    req - CreateConvertTaskApiRequest
    
    Returns:
    
    CreateConvertTaskApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateDocument
```
public CreateDocumentResponse CreateDocument(CreateDocumentRequest req)
                                      throws TencentCloudSDKException
```
    创建签署流程电子文档
    适用场景：见创建签署流程接口。
    点击查看通过模板创建签署流程用PDF文件创建签署流程。
    注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置创建签署流程和发起签署流程接口使用。具体逻辑可以参考下图:
    
    Parameters:
    
    req - CreateDocumentRequest
    
    Returns:
    
    CreateDocumentResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateEmbedWebUrl
```
public CreateEmbedWebUrlResponse CreateEmbedWebUrl(CreateEmbedWebUrlRequest req)
                                            throws TencentCloudSDKException
```
    本接口（CreateEmbedWebUrl）用于创建嵌入Web的链接，支持以下类型的Web链接创建： 1. 创建印章 2. 创建模板 3. 修改模板 4. 预览模板 5. 预览合同流程用户可以通过这些链接快速将其集成到自己的系统中。
    
    Parameters:
    
    req - CreateEmbedWebUrlRequest
    
    Returns:
    
    CreateEmbedWebUrlResponse
    
    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
```
    适用场景：当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。限制条件： 1. 本企业（发起方企业）企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。 2. 本企业（发起方企业）非企业微信签署人仅支持通过姓名+手机号进行补充。 3. 他方企业仅支持通过姓名+手机号进行补充。
    
    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小时之后`，通过获取出证报告任务执行结果接口进行查询执行结果和出证报告的下载URL。
    Parameters:
    
    req - CreateFlowEvidenceReportRequest
    
    Returns:
    
    CreateFlowEvidenceReportResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowGroupByFiles
```
public CreateFlowGroupByFilesResponse CreateFlowGroupByFiles(CreateFlowGroupByFilesRequest req)
                                                      throws TencentCloudSDKException
```
    此接口（CreateFlowGroupByFiles）可用于通过多个文件创建合同组签署流程。适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。注意事项：使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
    
    Parameters:
    
    req - CreateFlowGroupByFilesRequest
    
    Returns:
    
    CreateFlowGroupByFilesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowGroupByTemplates
```
public CreateFlowGroupByTemplatesResponse CreateFlowGroupByTemplates(CreateFlowGroupByTemplatesRequest req)
                                                              throws TencentCloudSDKException
```
    此接口（CreateFlowGroupByTemplates）可用于通过多个模板创建合同组签署流程。适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
    
    Parameters:
    
    req - CreateFlowGroupByTemplatesRequest
    
    Returns:
    
    CreateFlowGroupByTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowReminds
```
public CreateFlowRemindsResponse CreateFlowReminds(CreateFlowRemindsRequest req)
                                            throws TencentCloudSDKException
```
    指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： 1. 发起合同时，签署人的NotifyType需设置为sms 2. 合同中当前状态为“待签署”的签署人是催办的对象 3. 每个合同只能催办一次注意：该接口无法直接调用，请联系客户经理申请使用。
    
    Parameters:
    
    req - CreateFlowRemindsRequest
    
    Returns:
    
    CreateFlowRemindsResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowSignReview
```
public CreateFlowSignReviewResponse CreateFlowSignReview(CreateFlowSignReviewRequest req)
                                                  throws TencentCloudSDKException
```
    提交签署流程审批结果的适用场景包括： 1. 在使用模板（CreateFlow）或文件（CreateFlowByFiles）创建签署流程时，若指定了参数NeedSignReview为true，且发起方企业作为签署方参与了流程签署，则可以调用此接口提交企业内部签署审批结果。自动签署也需要进行审核通过才会进行签署。 2. 若签署流程状态正常，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
    
    Parameters:
    
    req - CreateFlowSignReviewRequest
    
    Returns:
    
    CreateFlowSignReviewResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowSignUrl
```
public CreateFlowSignUrlResponse CreateFlowSignUrl(CreateFlowSignUrlRequest req)
                                            throws TencentCloudSDKException
```
    该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署
    `注意：`
    `1. 该接口目前仅支持签署人类型是个人签署方的场景（PERSON）。`
    `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件。`
    `3. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建签署链接。`
    `4. 该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入`。
    跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置
    
    Parameters:
    
    req - CreateFlowSignUrlRequest
    
    Returns:
    
    CreateFlowSignUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateIntegrationDepartment
```
public CreateIntegrationDepartmentResponse CreateIntegrationDepartment(CreateIntegrationDepartmentRequest req)
                                                                throws TencentCloudSDKException
```
    此接口（CreateIntegrationDepartment）用于创建企业的部门信息，支持绑定客户系统部门ID。
    
    Parameters:
    
    req - CreateIntegrationDepartmentRequest
    
    Returns:
    
    CreateIntegrationDepartmentResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateIntegrationEmployees
```
public CreateIntegrationEmployeesResponse CreateIntegrationEmployees(CreateIntegrationEmployeesRequest req)
                                                              throws TencentCloudSDKException
```
    此接口（CreateIntegrationEmployees）用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建，则不会重新创建，但会发送短信提醒员工实名。另外，此接口还支持通过企微组织架构的openid 创建员工（将WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内），该场景下，员工会接收到提醒实名的企微消息。
    
    Parameters:
    
    req - CreateIntegrationEmployeesRequest
    
    Returns:
    
    CreateIntegrationEmployeesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateIntegrationRole
```
public CreateIntegrationRoleResponse CreateIntegrationRole(CreateIntegrationRoleRequest req)
                                                    throws TencentCloudSDKException
```
    此接口（CreateIntegrationRole）用来创建企业自定义的SaaS角色或集团角色。适用场景1：创建当前企业的自定义SaaS角色或集团角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。适用场景2：创建当前企业的自定义SaaS角色或集团角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。适用场景3：创建集团角色时可同时设置角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。注意事项：SaaS角色和集团角色对应的权限树是不一样的。
    
    Parameters:
    
    req - CreateIntegrationRoleRequest
    
    Returns:
    
    CreateIntegrationRoleResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateIntegrationUserRoles
```
public CreateIntegrationUserRolesResponse CreateIntegrationUserRoles(CreateIntegrationUserRolesRequest req)
                                                              throws TencentCloudSDKException
```
    此接口用于赋予员工指定的角色权限，如需解绑请使用 DeleteIntegrationRoleUsers 接口。
    
    Parameters:
    
    req - CreateIntegrationUserRolesRequest
    
    Returns:
    
    CreateIntegrationUserRolesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateMultiFlowSignQRCode
```
public CreateMultiFlowSignQRCodeResponse CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req)
                                                            throws TencentCloudSDKException
```
    此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。本接口适用于发起方没有填写控件的 B2C或者单C模板** 若是B2C模板,还要满足以下任意一个条件** - 模板中配置的签署顺序是无序 - B端企业的签署方式是静默签署 - B端企业是非首位签署通过一码多扫二维码发起的合同，涉及到的合同回调消息可参考文档[合同发起以及签署相关回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign) 用户通过签署二维码发起合同时，因企业额度不足导致失败会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
    
    Parameters:
    
    req - CreateMultiFlowSignQRCodeRequest
    
    Returns:
    
    CreateMultiFlowSignQRCodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateOrganizationBatchSignUrl
```
public CreateOrganizationBatchSignUrlResponse CreateOrganizationBatchSignUrl(CreateOrganizationBatchSignUrlRequest req)
                                                                      throws TencentCloudSDKException
```
    使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
    附注： - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。 - 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
    
    Parameters:
    
    req - CreateOrganizationBatchSignUrlRequest
    
    Returns:
    
    CreateOrganizationBatchSignUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePersonAuthCertificateImage
```
public CreatePersonAuthCertificateImageResponse CreatePersonAuthCertificateImage(CreatePersonAuthCertificateImageRequest req)
                                                                          throws TencentCloudSDKException
```
    获取个人用户认证证书图片下载URL 个人用户认证证书图片样式如下图 ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png) 注:
    - 只能获取个人用户证明图片, 企业员工的暂不支持
    - 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。
    Parameters:
    
    req - CreatePersonAuthCertificateImageRequest
    
    Returns:
    
    CreatePersonAuthCertificateImageResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePrepareFlow
```
public CreatePrepareFlowResponse CreatePrepareFlow(CreatePrepareFlowRequest req)
                                            throws TencentCloudSDKException
```
    创建发起流程web页面
    适用场景：通过该接口（CreatePrepareFlow）传入合同文件/模板编号及签署人信息，可获得发起流程的可嵌入页面，在页面完成签署控件等信息的编辑与确认后，快速发起流程。
    注：该接口包含模板/文件发起流程的全部功能，调用接口后不会立即发起，需在可嵌入页面点击按钮进行发起流程。
    
    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应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置注： `1. 如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署` `2. 签署链接的有效期为90天，超过有效期链接不可用` 其中小程序的原始Id如下，或者查看小程序信息自助获取。 | 小程序 | AppID | 原始ID | | ------------ | ------------ | ------------ | | 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
    
    Parameters:
    
    req - CreateSchemeUrlRequest
    
    Returns:
    
    CreateSchemeUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSeal
```
public CreateSealResponse CreateSeal(CreateSealRequest req)
                              throws TencentCloudSDKException
```
    本接口（CreateSeal）用于创建企业电子印章，支持创建企业公章，合同章，财务专用章和人事专用章创建。
    
    Parameters:
    
    req - CreateSealRequest
    
    Returns:
    
    CreateSealResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSealPolicy
```
public CreateSealPolicyResponse CreateSealPolicy(CreateSealPolicyRequest req)
                                          throws TencentCloudSDKException
```
    本接口（CreateSealPolicy）用于对企业员工进行印章授权
    
    Parameters:
    
    req - CreateSealPolicyRequest
    
    Returns:
    
    CreateSealPolicyResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateUserAutoSignEnableUrl
```
public CreateUserAutoSignEnableUrlResponse CreateUserAutoSignEnableUrl(CreateUserAutoSignEnableUrlRequest req)
                                                                throws TencentCloudSDKException
```
    获取个人用户自动签的开通链接。注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
    
    Parameters:
    
    req - CreateUserAutoSignEnableUrlRequest
    
    Returns:
    
    CreateUserAutoSignEnableUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateWebThemeConfig
```
public CreateWebThemeConfigResponse CreateWebThemeConfig(CreateWebThemeConfigRequest req)
                                                  throws TencentCloudSDKException
```
    用来设置本企业嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），设置后获取的web签署界面都会使用此配置进行展示。如果多次调用，会以最后一次的配置为准
    
    Parameters:
    
    req - CreateWebThemeConfigRequest
    
    Returns:
    
    CreateWebThemeConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteIntegrationDepartment
```
public DeleteIntegrationDepartmentResponse DeleteIntegrationDepartment(DeleteIntegrationDepartmentRequest req)
                                                                throws TencentCloudSDKException
```
    此接口（DeleteIntegrationDepartment）用于删除企业的部门信息。
    
    Parameters:
    
    req - DeleteIntegrationDepartmentRequest
    
    Returns:
    
    DeleteIntegrationDepartmentResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteIntegrationEmployees
```
public DeleteIntegrationEmployeesResponse DeleteIntegrationEmployees(DeleteIntegrationEmployeesRequest req)
                                                              throws TencentCloudSDKException
```
    该接口（DeleteIntegrationEmployees）用于移除企业员工，同时可选择是否进行离职交接。 - 如果不设置交接人的ReceiveUserId或ReceiveOpenId，则该员工将被直接移除而不进行交接操作。 - 如果设置了ReceiveUserId或ReceiveOpenId，该员工未处理的合同将会被系统交接给设置的交接人，然后再对该员工进行离职操作。注：`1. 超管或法人身份的员工不能被删除。2. 员工存在待处理合同且无人交接时不能被删除。`
    
    Parameters:
    
    req - DeleteIntegrationEmployeesRequest
    
    Returns:
    
    DeleteIntegrationEmployeesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteIntegrationRoleUsers
```
public DeleteIntegrationRoleUsersResponse DeleteIntegrationRoleUsers(DeleteIntegrationRoleUsersRequest req)
                                                              throws TencentCloudSDKException
```
    解绑员工与对应角色的关系，如需绑定请使用 CreateIntegrationUserRoles 接口。
    
    Parameters:
    
    req - DeleteIntegrationRoleUsersRequest
    
    Returns:
    
    DeleteIntegrationRoleUsersResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteSealPolicies
```
public DeleteSealPoliciesResponse DeleteSealPolicies(DeleteSealPoliciesRequest req)
                                              throws TencentCloudSDKException
```
    本接口（DeleteSealPolicies）用于撤销企业员工持有的印章权限
    
    Parameters:
    
    req - DeleteSealPoliciesRequest
    
    Returns:
    
    DeleteSealPoliciesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeExtendedServiceAuthInfos
```
public DescribeExtendedServiceAuthInfosResponse DescribeExtendedServiceAuthInfos(DescribeExtendedServiceAuthInfosRequest req)
                                                                          throws TencentCloudSDKException
```
    查询企业扩展服务的开通和授权情况，当前支持查询以下内容： 1. 企业静默签 2. 企业与港澳台居民签署合同 3. 使用手机号验证签署方身份 4. 骑缝章 5. 批量签署能力
    
    Parameters:
    
    req - DescribeExtendedServiceAuthInfosRequest
    
    Returns:
    
    DescribeExtendedServiceAuthInfosResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFileUrls
```
public DescribeFileUrlsResponse DescribeFileUrls(DescribeFileUrlsRequest req)
                                          throws TencentCloudSDKException
```
    本接口（DescribeFileUrls）用于查询文件的下载URL。适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
    
    Parameters:
    
    req - DescribeFileUrlsRequest
    
    Returns:
    
    DescribeFileUrlsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlowBriefs
```
public DescribeFlowBriefsResponse DescribeFlowBriefs(DescribeFlowBriefsRequest req)
                                              throws TencentCloudSDKException
```
    查询流程基础信息适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。注: `每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误`
    
    Parameters:
    
    req - DescribeFlowBriefsRequest
    
    Returns:
    
    DescribeFlowBriefsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlowComponents
```
public DescribeFlowComponentsResponse DescribeFlowComponents(DescribeFlowComponentsRequest req)
                                                      throws TencentCloudSDKException
```
    查询流程填写控件内容，可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
    
    Parameters:
    
    req - DescribeFlowComponentsRequest
    
    Returns:
    
    DescribeFlowComponentsResponse
    
    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
```
    接口用户查询合同流程的详情信息, 支持查询多个(数量不能超过100) 适用场景：可用于主动查询某个合同详情信息。
    
    Parameters:
    
    req - DescribeFlowInfoRequest
    
    Returns:
    
    DescribeFlowInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlowTemplates
```
public DescribeFlowTemplatesResponse DescribeFlowTemplates(DescribeFlowTemplatesRequest req)
                                                    throws TencentCloudSDKException
```
    此接口（DescribeFlowTemplates）用于查询本企业模板列表信息。 > 一个模板通常会包含以下结构信息 >- 模板基本信息 >- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方 >- 填写控件 Components >- 签署控件 SignComponents >- 生成模板的文件基础信息 FileInfos 当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取模板列表，以及每个模板内的控件信息。适用场景：该接口常用来配合模板发起合同-创建电子文档接口，作为创建电子文档的前置接口使用。通过此接口查询到模板信息后，再通过调用创建电子文档接口，指定模板ID，指定模板中需要的填写控件内容等，完成电子文档的创建。
    
    Parameters:
    
    req - DescribeFlowTemplatesRequest
    
    Returns:
    
    DescribeFlowTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIntegrationDepartments
```
public DescribeIntegrationDepartmentsResponse DescribeIntegrationDepartments(DescribeIntegrationDepartmentsRequest req)
                                                                      throws TencentCloudSDKException
```
    此接口（DescribeIntegrationDepartments）用于查询企业的部门信息列表，支持查询单个部门节点或单个部门节点及一级子节点部门列表。
    
    Parameters:
    
    req - DescribeIntegrationDepartmentsRequest
    
    Returns:
    
    DescribeIntegrationDepartmentsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIntegrationEmployees
```
public DescribeIntegrationEmployeesResponse DescribeIntegrationEmployees(DescribeIntegrationEmployeesRequest req)
                                                                  throws TencentCloudSDKException
```
    此接口（DescribeIntegrationEmployees）用于分页查询企业员工信息列表，支持设置过滤条件以筛选员工查询结果。
    
    Parameters:
    
    req - DescribeIntegrationEmployeesRequest
    
    Returns:
    
    DescribeIntegrationEmployeesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIntegrationRoles
```
public DescribeIntegrationRolesResponse DescribeIntegrationRoles(DescribeIntegrationRolesRequest req)
                                                          throws TencentCloudSDKException
```
    此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。注：`法人角色是系统保留角色，因此返回列表中不含法人角色。`
    
    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查询个人用户是否实名注意:
    - 此接口为合作引流场景使用，使用`有白名单限制`，使用前请联系对接的客户经理沟通。
    - `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
```
    查询转换任务的状态。转换任务Id通过发起转换任务接口（CreateConvertTaskApi）获取。注意：大文件转换所需的时间可能会比较长。
    
    Parameters:
    
    req - GetTaskResultApiRequest
    
    Returns:
    
    GetTaskResultApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyApplicationCallbackInfo
```
public ModifyApplicationCallbackInfoResponse ModifyApplicationCallbackInfo(ModifyApplicationCallbackInfoRequest req)
                                                                    throws TencentCloudSDKException
```
    新增/删除企业应用集成中的回调配置。新增回调配置只会增加不存在的CallbackUrl；删除操作将针对找到的相同CallbackUrl的配置进行删除。请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
    
    Parameters:
    
    req - ModifyApplicationCallbackInfoRequest
    
    Returns:
    
    ModifyApplicationCallbackInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyIntegrationDepartment
```
public ModifyIntegrationDepartmentResponse ModifyIntegrationDepartment(ModifyIntegrationDepartmentRequest req)
                                                                throws TencentCloudSDKException
```
    此接口（ModifyIntegrationDepartment）用于更新企业的部门信息，支持更新部门名称、客户系统部门ID和部门序号等信息。
    
    Parameters:
    
    req - ModifyIntegrationDepartmentRequest
    
    Returns:
    
    ModifyIntegrationDepartmentResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyIntegrationRole
```
public ModifyIntegrationRoleResponse ModifyIntegrationRole(ModifyIntegrationRoleRequest req)
                                                    throws TencentCloudSDKException
```
    此接口（ModifyIntegrationRole）用来更新企业自定义的SaaS角色或集团角色。适用场景1：更新当前企业的自定义SaaS角色或集团角色，并且更新时不进行角色中权限的更新（PermissionGroups 参数不传）。适用场景2：更新当前企业的自定义SaaS角色或集团角色，并且更新时进行角色中权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。适用场景3：更新集团角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。注意事项：SaaS角色和集团角色对应的权限树是不一样的。
    
    Parameters:
    
    req - ModifyIntegrationRoleRequest
    
    Returns:
    
    ModifyIntegrationRoleResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartFlow
```
public StartFlowResponse StartFlow(StartFlowRequest req)
                            throws TencentCloudSDKException
```
    此接口用于启动流程。它是模板发起合同的最后一步。在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
    
    Parameters:
    
    req - StartFlowRequest
    
    Returns:
    
    StartFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnbindEmployeeUserIdWithClientOpenId
```
public UnbindEmployeeUserIdWithClientOpenIdResponse UnbindEmployeeUserIdWithClientOpenId(UnbindEmployeeUserIdWithClientOpenIdRequest req)
                                                                                  throws TencentCloudSDKException
```
    此接口（UnbindEmployeeUserIdWithClientOpenId）用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。注：`在调用此接口时，需确保OpenId已通过调用`BindEmployeeUserIdWithClientOpenId`接口与电子签系统的UserId绑定过。若OpenId未经过绑定，则无法使用此接口进行解绑操作。`
    
    Parameters:
    
    req - UnbindEmployeeUserIdWithClientOpenIdRequest
    
    Returns:
    
    UnbindEmployeeUserIdWithClientOpenIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateIntegrationEmployees
```
public UpdateIntegrationEmployeesResponse UpdateIntegrationEmployees(UpdateIntegrationEmployeesRequest req)
                                                              throws TencentCloudSDKException
```
    更新员工信息(姓名，手机号，邮件、部门)，用户实名后无法更改姓名与手机号。可进行批量操作，Employees中的userID与openID二选一必填
    
    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,代码示例：
    HttpProfile httpProfile = new HttpProfile();
    httpProfile.setEndpoint("file.test.ess.tencent.cn");
    
    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

CancelUserAutoSignEnableUrl

CreateBatchCancelFlowUrl

CreateBatchSignUrl

CreateConvertTaskApi

CreateDocument

CreateEmbedWebUrl

CreateFlow

CreateFlowApprovers

CreateFlowByFiles

CreateFlowEvidenceReport

CreateFlowGroupByFiles

CreateFlowGroupByTemplates

CreateFlowReminds

CreateFlowSignReview

CreateFlowSignUrl

CreateIntegrationDepartment

CreateIntegrationEmployees

CreateIntegrationRole

CreateIntegrationUserRoles

CreateMultiFlowSignQRCode

CreateOrganizationBatchSignUrl

CreatePersonAuthCertificateImage

CreatePrepareFlow

CreatePreparedPersonalEsign

CreateReleaseFlow

CreateSchemeUrl

CreateSeal

CreateSealPolicy

CreateUserAutoSignEnableUrl

CreateWebThemeConfig

DeleteIntegrationDepartment

DeleteIntegrationEmployees

DeleteIntegrationRoleUsers

DeleteSealPolicies

DescribeExtendedServiceAuthInfos

DescribeFileUrls

DescribeFlowBriefs

DescribeFlowComponents

DescribeFlowEvidenceReport

DescribeFlowInfo

DescribeFlowTemplates

DescribeIntegrationDepartments

DescribeIntegrationEmployees

DescribeIntegrationRoles

DescribeOrganizationGroupOrganizations

DescribeOrganizationSeals

DescribeThirdPartyAuthCode

DescribeUserAutoSignStatus

DisableUserAutoSign

GetTaskResultApi

ModifyApplicationCallbackInfo

ModifyIntegrationDepartment

ModifyIntegrationRole

StartFlow

UnbindEmployeeUserIdWithClientOpenId

UpdateIntegrationEmployees

UploadFiles

VerifyPdf