com.tencentcloudapi.ess.v20201111

Class EssClient

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

签署人类别 需要提前准备的信息 自己企业的员工签署（未认证加入或已认证加入） 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 自己企业的员工签署（已认证加入） 签署企业的名字、员工在电子签平台的ID（UserId） 其他企业的员工签署 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 个人（自然人）签署 个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传） 注：配合创建电子文档和发起签署流程接口使用。整体的逻辑如下图  注：**静默（自动）签署不支持合同签署方存在填写**功能 签署人类别 需要提前准备的信息 自己企业的员工签署（未认证加入或已认证加入） 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 自己企业的员工签署（已认证加入） 签署企业的名字、员工在电子签平台的ID（UserId） 其他企业的员工签署 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 个人（自然人）签署 个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传） 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）
 注： - 不同类型的签署方传参不同, 可以参考开发者中心的ApproverInfo结构体说明 - 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**） - **静默（自动）签署不支持合同签署方存在填写**功能

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不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回。
CreateBatchQuickSignUrlResponse	CreateBatchQuickSignUrl(CreateBatchQuickSignUrlRequest req) 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署。 注意：** 1.
CreateBatchSignUrlResponse	CreateBatchSignUrl(CreateBatchSignUrlRequest req) 通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。 注： - 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。 - 参与人点击链接后需短信验证码才能查看合同内容。 - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。 - 个人批量签署，签名区`仅支持手写签名`。
CreateConvertTaskApiResponse	CreateConvertTaskApi(CreateConvertTaskApiRequest req) 此接口（CreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。 前提条件：源文件已经通过 文件上传接口完成上传，并得到了源文件的资源Id。 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同 适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同 转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过查询转换任务状态接口获取任务状态。 注: 1.
CreateDocumentResponse	CreateDocument(CreateDocumentRequest req) 创建签署流程电子文档 注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置创建签署流程和发起签署流程接口使用。具体逻辑可以参考下图: 
CreateEmbedWebUrlResponse	CreateEmbedWebUrl(CreateEmbedWebUrlRequest req) 本接口（CreateEmbedWebUrl）用于创建嵌入Web的链接，支持以下类型的Web链接创建： 1.
CreateExtendedServiceAuthInfosResponse	CreateExtendedServiceAuthInfos(CreateExtendedServiceAuthInfosRequest req) 创建企业扩展服务授权，当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口授权给企业员工。 注：“企业自动签授权”支持集团代子企业操作，请联系运营开通此功能。
CreateFlowResponse	CreateFlow(CreateFlowRequest req) 通过模板创建签署流程 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
CreateFlowApproversResponse	CreateFlowApprovers(CreateFlowApproversRequest req) 适用场景： 当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。 限制条件： 1.
CreateFlowByFilesResponse	CreateFlowByFiles(CreateFlowByFilesRequest req) 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。 适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
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）可用于通过多个模板创建合同组签署流程。 适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。 注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
CreateFlowGroupSignReviewResponse	CreateFlowGroupSignReview(CreateFlowGroupSignReviewRequest req) 提交合同组签署流程审批结果的适用场景包括： 1.
CreateFlowRemindsResponse	CreateFlowReminds(CreateFlowRemindsRequest req) 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： 1.
CreateFlowSignReviewResponse	CreateFlowSignReview(CreateFlowSignReviewRequest req) 提交企业流程审批结果 当前存在两种审核操作：** 签署审核 在通过接口 CreateFlowByFiles CreateFlow CreateFlowGroupByTemplates CreateFlowGroupByFiles CreatePrepareFlow 发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果 在通过接口 CreateFlowByFiles CreateFlow CreateFlowGroupByTemplates CreateFlowGroupByFiles 发起签署流程时，通过指定签署人ApproverNeedSignReview为true，则可以调用此接口，并指定operate=SignReview，并指定RecipientId，以提交企业内部签署审批结果 发起审核 通过接口CreatePrepareFlow指定发起后需要审核，那么可以调用此接口，并指定operate=CreateReview，以提交企业内部审批结果。可以多次提交审批结果，但一旦审批通过，后续提交的结果将无效
CreateFlowSignUrlResponse	CreateFlowSignUrl(CreateFlowSignUrlRequest req) 该接口用于发起合同后，生成用户的签署链接 注意** 1.
CreateIntegrationDepartmentResponse	CreateIntegrationDepartment(CreateIntegrationDepartmentRequest req) 此接口（CreateIntegrationDepartment）用于创建企业的部门信息，支持绑定客户系统部门ID。
CreateIntegrationEmployeesResponse	CreateIntegrationEmployees(CreateIntegrationEmployeesRequest req) 此接口（CreateIntegrationEmployees）用于创建企业员工。 支持以下场景 生成端 入参 提醒方式 普通saas员工 不需要传递 InvitationNotifyType 短信 企微员工 不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内 企微内部实名消息 H5端 saas员工 传递 InvitationNotifyType = H5，不支持企微 生成H5链接 注意： - 若通过手机号发现员工已经创建，则不会重复创建，但会发送短信或者生成链接提醒员工实名。 - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。 CreateIntegrationRoleResponse CreateIntegrationRole(CreateIntegrationRoleRequest req) 此接口（CreateIntegrationRole）用来创建企业自定义的SaaS角色或集团角色。 适用场景1：创建当前企业的自定义SaaS角色或集团角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。 适用场景2：创建当前企业的自定义SaaS角色或集团角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 适用场景3：创建集团角色时可同时设置角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。 适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。 注意事项：SaaS角色和集团角色对应的权限树是不一样的。 CreateIntegrationUserRolesResponse CreateIntegrationUserRoles(CreateIntegrationUserRolesRequest req) 此接口用于赋予员工指定的角色权限，如需解绑请使用 DeleteIntegrationRoleUsers 接口。 CreateMultiFlowSignQRCodeResponse CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req) 此接口（CreateMultiFlowSignQRCode）用于创建一码多签签署码。 适用场景**: 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。 注意**: 1. CreateOrganizationBatchSignUrlResponse CreateOrganizationBatchSignUrl(CreateOrganizationBatchSignUrlRequest req) 使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。 附注： - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。 - 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。 CreateOrganizationInfoChangeUrlResponse CreateOrganizationInfoChangeUrl(CreateOrganizationInfoChangeUrlRequest req) 此接口（CreateOrganizationInfoChangeUrl）用于创建企业信息变更链接，支持创建企业超管变更链接或企业基础信息变更链接，通过入参ChangeType指定。 1. CreatePersonAuthCertificateImageResponse CreatePersonAuthCertificateImage(CreatePersonAuthCertificateImageRequest req) 获取个人用户认证证书图片下载URL 个人用户认证证书图片样式如下图  注: 只能获取个人用户证明图片, 企业员工的暂不支持 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。 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）用于创建企业电子印章，支持创建企业公章，合同章，财务专用章和人事专用章创建。 1. CreateSealPolicyResponse CreateSealPolicy(CreateSealPolicyRequest req) 本接口（CreateSealPolicy）用于对企业员工进行印章授权 CreateUserAutoSignEnableUrlResponse CreateUserAutoSignEnableUrl(CreateUserAutoSignEnableUrlRequest req) 获取个人用户自动签的开通链接。 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。` CreateUserAutoSignSealUrlResponse CreateUserAutoSignSealUrl(CreateUserAutoSignSealUrlRequest req) 获取设置自动签印章小程序链接。 注意： 需要企业开通自动签后使用。 仅支持已经开通了自动签的个人更换自动签印章。 链接有效期默认7天，最多30天。 该接口的链接适用于小程序端。 该接口不会扣除您的合同套餐，暂不参与计费。 CreateWebThemeConfigResponse CreateWebThemeConfig(CreateWebThemeConfigRequest req) 用来设置本企业嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），设置后获取的web签署界面都会使用此配置进行展示。 如果多次调用，会以最后一次的配置为准 DeleteExtendedServiceAuthInfosResponse DeleteExtendedServiceAuthInfos(DeleteExtendedServiceAuthInfosRequest req) 删除企业扩展服务授权，当前仅支持 “企业自动签” 和“批量签署” 的取消授权。 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口取消企业员工授权。 注：支持集团代子企业操作，请联系运营开通此功能。 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）用于撤销企业员工持有的印章权限 DescribeBillUsageDetailResponse DescribeBillUsageDetail(DescribeBillUsageDetailRequest req) 通过此接口（DescribeBillUsageDetail）查询该企业的套餐消耗详情。 DescribeExtendedServiceAuthDetailResponse DescribeExtendedServiceAuthDetail(DescribeExtendedServiceAuthDetailRequest req) 查询企业扩展服务的授权详情（列表），当前支持查询以下内容： 1. 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）用于查询本企业模板列表信息。 适用场景** 该接口常用来配合模板发起合同-创建电子文档接口，作为创建电子文档的前置接口使用。 通过此接口查询到模板信息后，再通过调用创建电子文档接口，指定模板ID，指定模板中需要的填写控件内容等，完成电子文档的创建。 一个模板通常会包含以下结构信息** - 模板模板ID, 模板名字等基本信息 - 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方 - 发起方和签署方的填写控件 Components - 签署方的签署控件 SignComponents  模板中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)  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则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。 DescribePersonCertificateResponse DescribePersonCertificate(DescribePersonCertificateRequest req) 此接口（DescribePersonCertificate）用于查询个人数字证书信息。 注：`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。` `2.调用此接口需要开通白名单，使用前请联系相关人员开通白名单。` DescribeThirdPartyAuthCodeResponse DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req) 通过AuthCode查询个人用户是否实名 注意: 此接口为合作引流场景使用，使用`有白名单限制`，使用前请联系对接的客户经理沟通。 `AuthCode 只能使用一次`，查询一次再次查询会返回错误 DescribeUserAutoSignStatusResponse DescribeUserAutoSignStatus(DescribeUserAutoSignStatusRequest req) 通过此接口获取个人用户自动签的开通状态。 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。` DisableUserAutoSignResponse DisableUserAutoSign(DisableUserAutoSignRequest req) 通过此接口可以关闭个人用户自动签功能。 无需对应的用户刷脸等方式同意即可关闭。 注意: 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。 如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。 GetTaskResultApiResponse GetTaskResultApi(GetTaskResultApiRequest req) 此接口（GetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作 前提条件：已调用 创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。 适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。 注： 1. ModifyApplicationCallbackInfoResponse ModifyApplicationCallbackInfo(ModifyApplicationCallbackInfoRequest req) 新增/删除企业应用集成中的回调配置。 新增回调配置只会增加不存在的CallbackUrl；删除操作将针对找到的相同CallbackUrl的配置进行删除。 请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2) ModifyExtendedServiceResponse ModifyExtendedService(ModifyExtendedServiceRequest req) 管理企业扩展服务 ，企业经办人需要是企业超管或者法人。 跳转小程序的几种方式：主要是设置不同的EndPoint 1. ModifyIntegrationDepartmentResponse ModifyIntegrationDepartment(ModifyIntegrationDepartmentRequest req) 此接口（ModifyIntegrationDepartment）用于更新企业的部门信息，支持更新部门名称、客户系统部门ID和部门序号等信息。 ModifyIntegrationRoleResponse ModifyIntegrationRole(ModifyIntegrationRoleRequest req) 此接口（ModifyIntegrationRole）用来更新企业自定义的SaaS角色或集团角色。 适用场景1：更新当前企业的自定义SaaS角色或集团角色，并且更新时不进行角色中权限的更新（PermissionGroups 参数不传）。 适用场景2：更新当前企业的自定义SaaS角色或集团角色，并且更新时进行角色中权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 适用场景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) 此接口（UpdateIntegrationEmployees）用于修改未实名企业员工信息(姓名，手机号，邮件、部门)。 修改手机号的时候,支持以下场景进行提醒通知 生成端 入参 提醒方式 普通saas员工 不需要传递 InvitationNotifyType 短信 企微员工 不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内 企微内部实名消息 H5端 saas员工 传递 InvitationNotifyType = H5，不支持企微 生成H5链接 注意： - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。 UploadFilesResponse UploadFiles(UploadFilesRequest req) 此接口（UploadFiles）文件上传。 适用场景：用于合同，印章的文件上传。文件上传以后， 如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起 如果是其他类型可以配合创建文件转换任务接口转换成PDF文件 注: 1. VerifyPdfResponse VerifyPdf(VerifyPdfRequest req) 对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。 Methods inherited from class com.tencentcloudapi.common.AbstractClient call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, 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 CreateBatchQuickSignUrl public CreateBatchQuickSignUrlResponse CreateBatchQuickSignUrl(CreateBatchQuickSignUrlRequest req) throws TencentCloudSDKException 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署。 注意：** 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**，**不支持填写控件** 。 3. 请确保C端签署人在批量签署合同中**为待签署状态**，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。 4. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。 5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。 跳转到小程序的实现，参考微信官方文档(分为全屏、半屏两种方式)，如何配置也可以请参考: 跳转电子签小程序配置。 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此App嵌入H5签署合同需要按照慧眼提供的慧眼人脸核身兼容性文档做兼容性适配。 Parameters: req - CreateBatchQuickSignUrlRequest Returns: CreateBatchQuickSignUrlResponse 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、html、图片、txt类型文件转换为PDF文件。 前提条件：源文件已经通过 文件上传接口完成上传，并得到了源文件的资源Id。 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同 适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同 转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过查询转换任务状态接口获取任务状态。 注: 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt` 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果` Parameters: req - CreateConvertTaskApiRequest Returns: CreateConvertTaskApiResponse Throws: TencentCloudSDKException CreateDocument public CreateDocumentResponse CreateDocument(CreateDocumentRequest req) throws TencentCloudSDKException 创建签署流程电子文档 注：该接口需要给对应的流程指定一个模板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 CreateExtendedServiceAuthInfos public CreateExtendedServiceAuthInfosResponse CreateExtendedServiceAuthInfos(CreateExtendedServiceAuthInfosRequest req) throws TencentCloudSDKException 创建企业扩展服务授权，当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口授权给企业员工。 注：“企业自动签授权”支持集团代子企业操作，请联系运营开通此功能。 Parameters: req - CreateExtendedServiceAuthInfosRequest Returns: CreateExtendedServiceAuthInfosResponse Throws: TencentCloudSDKException CreateFlow public CreateFlowResponse CreateFlow(CreateFlowRequest req) throws TencentCloudSDKException 通过模板创建签署流程 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。 签署人类别 需要提前准备的信息 自己企业的员工签署（未认证加入或已认证加入） 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 自己企业的员工签署（已认证加入） 签署企业的名字、员工在电子签平台的ID（UserId） 其他企业的员工签署 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 个人（自然人）签署 个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传） 注：配合创建电子文档和发起签署流程接口使用。整体的逻辑如下图  注：**静默（自动）签署不支持合同签署方存在填写**功能 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资源编号来创建待签署的合同流程。 适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。 签署人类别 需要提前准备的信息 自己企业的员工签署（未认证加入或已认证加入） 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 自己企业的员工签署（已认证加入） 签署企业的名字、员工在电子签平台的ID（UserId） 其他企业的员工签署 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 个人（自然人）签署 个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传） 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）  注： - 不同类型的签署方传参不同, 可以参考开发者中心的ApproverInfo结构体说明 - 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**） - **静默（自动）签署不支持合同签署方存在填写**功能 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 CreateFlowGroupSignReview public CreateFlowGroupSignReviewResponse CreateFlowGroupSignReview(CreateFlowGroupSignReviewRequest req) throws TencentCloudSDKException 提交合同组签署流程审批结果的适用场景包括： 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时，若指定了以下参数 为true，则可以调用此接口提交企业内部签署审批结果。即使是自动签署也需要进行审核通过才会进行签署。 - [FlowGroupInfo.NeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#flowgroupinfo) - [ApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#approverinfo) 2. 同一合同组，同一签署人可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。 Parameters: req - CreateFlowGroupSignReviewRequest Returns: CreateFlowGroupSignReviewResponse 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 提交企业流程审批结果 当前存在两种审核操作：** 签署审核 在通过接口 CreateFlowByFiles CreateFlow CreateFlowGroupByTemplates CreateFlowGroupByFiles CreatePrepareFlow 发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果 在通过接口 CreateFlowByFiles CreateFlow CreateFlowGroupByTemplates CreateFlowGroupByFiles 发起签署流程时，通过指定签署人ApproverNeedSignReview为true，则可以调用此接口，并指定operate=SignReview，并指定RecipientId，以提交企业内部签署审批结果 发起审核 通过接口CreatePrepareFlow指定发起后需要审核，那么可以调用此接口，并指定operate=CreateReview，以提交企业内部审批结果。可以多次提交审批结果，但一旦审批通过，后续提交的结果将无效 Parameters: req - CreateFlowSignReviewRequest Returns: CreateFlowSignReviewResponse Throws: TencentCloudSDKException CreateFlowSignUrl public CreateFlowSignUrlResponse CreateFlowSignUrl(CreateFlowSignUrlRequest req) throws TencentCloudSDKException 该接口用于发起合同后，生成用户的签署链接 注意** 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件，**不支持填写控件** 。 2. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。 3. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。 跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置。 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此App嵌入H5签署合同需要按照慧眼提供的慧眼人脸核身兼容性文档做兼容性适配。 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）用于创建企业员工。 支持以下场景 生成端 入参 提醒方式 普通saas员工 不需要传递 InvitationNotifyType 短信 企微员工 不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内 企微内部实名消息 H5端 saas员工 传递 InvitationNotifyType = H5，不支持企微 生成H5链接 注意： - 若通过手机号发现员工已经创建，则不会重复创建，但会发送短信或者生成链接提醒员工实名。 - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。 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 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 适用场景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）用于创建一码多签签署码。 适用场景**: 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。 注意**: 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件 - 模板中配置的签署顺序是无序 - B端企业的签署方式是静默签署 - B端企业是非首位签署 2. 通过一码多签签署码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调 ]( https://qian.tencent.com/developers/company/callback_types_contracts_sign) 3. 用户通过一码多签签署码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](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 CreateOrganizationInfoChangeUrl public CreateOrganizationInfoChangeUrlResponse CreateOrganizationInfoChangeUrl(CreateOrganizationInfoChangeUrlRequest req) throws TencentCloudSDKException 此接口（CreateOrganizationInfoChangeUrl）用于创建企业信息变更链接，支持创建企业超管变更链接或企业基础信息变更链接，通过入参ChangeType指定。 1. 企业超管变更 换成企业的其他员工来当超管 2. 企业基础信息变更 可以变动 企业名称 法定代表人姓名(新法人有邀请链接) 企业地址和所在地 不可变动 统一社会信用代码 企业主体类型 如果企业名称变动会引起下面的变动 合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署 印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理 证书: 企业证书会重新请求CA机构用新企业名称生成新的证书 Parameters: req - CreateOrganizationInfoChangeUrlRequest Returns: CreateOrganizationInfoChangeUrlResponse Throws: TencentCloudSDKException CreatePersonAuthCertificateImage public CreatePersonAuthCertificateImageResponse CreatePersonAuthCertificateImage(CreatePersonAuthCertificateImageRequest req) throws TencentCloudSDKException 获取个人用户认证证书图片下载URL 个人用户认证证书图片样式如下图  注: 只能获取个人用户证明图片, 企业员工的暂不支持 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。 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天，超过有效期链接不可用 3. 如果需跳转详情页（即PathType值为1）进行填写或签署合同，需指定签署方信息:姓名、手机号码、企业名称等，才能生成正确的跳转链接 4. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误） 其中小程序的原始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）用于创建企业电子印章，支持创建企业公章，合同章，财务专用章和人事专用章创建。 1. 可以**通过图片**创建印章，图片最大5MB 2. 可以**系统创建**创建印章, 系统创建的印章样子下图(样式可以调整)  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 CreateUserAutoSignSealUrl public CreateUserAutoSignSealUrlResponse CreateUserAutoSignSealUrl(CreateUserAutoSignSealUrlRequest req) throws TencentCloudSDKException 获取设置自动签印章小程序链接。 注意： 需要企业开通自动签后使用。 仅支持已经开通了自动签的个人更换自动签印章。 链接有效期默认7天，最多30天。 该接口的链接适用于小程序端。 该接口不会扣除您的合同套餐，暂不参与计费。 Parameters: req - CreateUserAutoSignSealUrlRequest Returns: CreateUserAutoSignSealUrlResponse Throws: TencentCloudSDKException CreateWebThemeConfig public CreateWebThemeConfigResponse CreateWebThemeConfig(CreateWebThemeConfigRequest req) throws TencentCloudSDKException 用来设置本企业嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），设置后获取的web签署界面都会使用此配置进行展示。 如果多次调用，会以最后一次的配置为准 Parameters: req - CreateWebThemeConfigRequest Returns: CreateWebThemeConfigResponse Throws: TencentCloudSDKException DeleteExtendedServiceAuthInfos public DeleteExtendedServiceAuthInfosResponse DeleteExtendedServiceAuthInfos(DeleteExtendedServiceAuthInfosRequest req) throws TencentCloudSDKException 删除企业扩展服务授权，当前仅支持 “企业自动签” 和“批量签署” 的取消授权。 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口取消企业员工授权。 注：支持集团代子企业操作，请联系运营开通此功能。 Parameters: req - DeleteExtendedServiceAuthInfosRequest Returns: DeleteExtendedServiceAuthInfosResponse 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 DescribeBillUsageDetail public DescribeBillUsageDetailResponse DescribeBillUsageDetail(DescribeBillUsageDetailRequest req) throws TencentCloudSDKException 通过此接口（DescribeBillUsageDetail）查询该企业的套餐消耗详情。 Parameters: req - DescribeBillUsageDetailRequest Returns: DescribeBillUsageDetailResponse Throws: TencentCloudSDKException DescribeExtendedServiceAuthDetail public DescribeExtendedServiceAuthDetailResponse DescribeExtendedServiceAuthDetail(DescribeExtendedServiceAuthDetailRequest req) throws TencentCloudSDKException 查询企业扩展服务的授权详情（列表），当前支持查询以下内容： 1. 企业自动签（本企业授权、集团企业授权、合作企业授权） 2. 批量签署能力 注: 所在企业的超管、法人才有权限调用此接口(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId) Parameters: req - DescribeExtendedServiceAuthDetailRequest Returns: DescribeExtendedServiceAuthDetailResponse Throws: TencentCloudSDKException DescribeExtendedServiceAuthInfos public DescribeExtendedServiceAuthInfosResponse DescribeExtendedServiceAuthInfos(DescribeExtendedServiceAuthInfosRequest req) throws TencentCloudSDKException 查询企业扩展服务的开通和授权情况，当前支持查询以下内容： 1. **企业自动签署** 2. **批量签署授权** 3. **企业与港澳台居民签署合同** 4. **拓宽签署方年龄限制** 5. **个人签署方仅校验手机号** 6. **隐藏合同经办人姓名** 7. **正楷临摹签名失败后更换其他签名类型** 8. **短信通知签署方** 9. **个人签署方手动签字** 10. **骑缝章** 11. **签署密码开通引导** 对应能力开通页面在Web控制台-更多-企业设置-拓展服务，如下图所示:  注: 所在企业的超管、法人才有权限调用此接口(Operator.UserId需要传递超管或者法人的UserId) 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）用于查询本企业模板列表信息。 适用场景** 该接口常用来配合模板发起合同-创建电子文档接口，作为创建电子文档的前置接口使用。 通过此接口查询到模板信息后，再通过调用创建电子文档接口，指定模板ID，指定模板中需要的填写控件内容等，完成电子文档的创建。 一个模板通常会包含以下结构信息** - 模板模板ID, 模板名字等基本信息 - 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方 - 发起方和签署方的填写控件 Components - 签署方的签署控件 SignComponents  模板中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)  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 DescribePersonCertificate public DescribePersonCertificateResponse DescribePersonCertificate(DescribePersonCertificateRequest req) throws TencentCloudSDKException 此接口（DescribePersonCertificate）用于查询个人数字证书信息。 注：`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。` `2.调用此接口需要开通白名单，使用前请联系相关人员开通白名单。` Parameters: req - DescribePersonCertificateRequest Returns: DescribePersonCertificateResponse 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 此接口（GetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作 前提条件：已调用 创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。 适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。 注： 1. `大文件转换所需的时间可能会比较长` 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 ModifyExtendedService public ModifyExtendedServiceResponse ModifyExtendedService(ModifyExtendedServiceRequest req) throws TencentCloudSDKException 管理企业扩展服务 ，企业经办人需要是企业超管或者法人。 跳转小程序的几种方式：主要是设置不同的EndPoint 1. 通过链接Url直接跳转到小程序，不需要返回 设置EndPoint为WEIXINAPP，得到链接打开即可。 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App 跳转到小程序的实现，参考官方文档打开 App 设置EndPoint为APP，得到path。 3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序 跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置 设置EndPoint为APP，得到path。 4.其中小程序的原始Id如下，或者查看小程序信息自助获取。 | 小程序 | AppID | 原始ID | | ------------ | ------------ | ------------ | | 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa | Parameters: req - ModifyExtendedServiceRequest Returns: ModifyExtendedServiceResponse 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 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 适用场景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 此接口（UpdateIntegrationEmployees）用于修改未实名企业员工信息(姓名，手机号，邮件、部门)。 修改手机号的时候,支持以下场景进行提醒通知 生成端 入参 提醒方式 普通saas员工 不需要传递 InvitationNotifyType 短信 企微员工 不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内 企微内部实名消息 H5端 saas员工 传递 InvitationNotifyType = H5，不支持企微 生成H5链接 注意： - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。 Parameters: req - UpdateIntegrationEmployeesRequest Returns: UpdateIntegrationEmployeesResponse Throws: TencentCloudSDKException UploadFiles public UploadFilesResponse UploadFiles(UploadFilesRequest req) throws TencentCloudSDKException 此接口（UploadFiles）文件上传。 适用场景：用于合同，印章的文件上传。文件上传以后， 如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起 如果是其他类型可以配合创建文件转换任务接口转换成PDF文件 注: 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下 2. 调用此接口时需要设置单独的Domain请求域名，联调开发环境为: file.test.ess.tencent.cn，正式环境需要设置为: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 Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method Copyright © 2024. All rights reserved.