public class EssClient extends AbstractClient
gson, HTTP_RSP_OK, SDK_VERSION| Constructor and Description |
|---|
EssClient(Credential credential,
String region) |
EssClient(Credential credential,
String region,
ClientProfile profile) |
| Modifier and Type | Method and Description | |
|---|---|---|
ArchiveDynamicFlowResponse |
ArchiveDynamicFlow(ArchiveDynamicFlowRequest req)
该接口用于结束动态签署流程，若当前合同还存在签署方未签署，无法结束。
|
|
BindEmployeeUserIdWithClientOpenIdResponse |
BindEmployeeUserIdWithClientOpenId(BindEmployeeUserIdWithClientOpenIdRequest req)
此接口（BindEmployeeUserIdWithClientOpenId）用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
此OpenId只在 [更新企业员工信息 ](https://qian.tencent.com/developers/companyApis/staffs/UpdateIntegrationEmployees)、[移除企业员工](https://qian.tencent.com/developers/companyApis/staffs/DeleteIntegrationEmployees) 等场景下可以使用
|
|
CancelFlowResponse |
CancelFlow(CancelFlowRequest req)
用于撤销合同流程
适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。 - **可撤回合同状态**：未全部签署完成 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 注: 1. |
|
CancelMultiFlowSignQRCodeResponse |
CancelMultiFlowSignQRCode(CancelMultiFlowSignQRCodeRequest req)
此接口（CancelMultiFlowSignQRCode）用于废除一码多签签署码。
该接口所需的二维码ID，源自[创建一码多签签署码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
如果该签署码尚处于有效期内，可通过本接口将其设置为失效状态。
|
|
CancelUserAutoSignEnableUrlResponse |
CancelUserAutoSignEnableUrl(CancelUserAutoSignEnableUrlRequest req)
用来撤销获取个人用户自动签的开通状态生成的开通链接，撤销生成的链接失效。
注:
若个人用户已经用生成的完成自动签署的开通，撤销链接无效不会对开通结果产生影响(此情况接口会报错)。
处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。
|
|
CreateBatchCancelFlowUrlResponse |
CreateBatchCancelFlowUrl(CreateBatchCancelFlowUrlRequest req)
指定需要批量撤回的签署流程Id，以获取批量撤销链接。
客户需指定要撤回的签署流程Id，最多可指定100个，超过100则不处理。
接口调用成功后，将返回批量撤回合同的链接。通过点击链接，可跳转至电子签小程序完成批量撤回操作。
- **可撤回合同状态**：未全部签署完成
- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)
注：
1.
|
|
CreateBatchInitOrganizationUrlResponse |
CreateBatchInitOrganizationUrl(CreateBatchInitOrganizationUrlRequest req)
支持企业进行批量初始化操作：
此接口存在以下限制：
1.
|
|
CreateBatchOrganizationAuthorizationUrlResponse |
CreateBatchOrganizationAuthorizationUrl(CreateBatchOrganizationAuthorizationUrlRequest req)
此接口用于获取企业批量认证链接-单链接包含多条认证流。
前提条件：已调用 [CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks) 和[查询企业批量认证链接DescribeBatchOrganizationRegistrationUrls](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls) 确保认证任务已经完成。
异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也可能需要更长的时间。
此链接包含多条认证流程，使用该链接可以批量的对企业进行认证。
|
|
CreateBatchOrganizationRegistrationTasksResponse |
CreateBatchOrganizationRegistrationTasks(CreateBatchOrganizationRegistrationTasksRequest req)
本接口（CreateBatchOrganizationRegistrationTasks）用于批量创建企业认证链接
该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
|
|
CreateBatchQuickSignUrlResponse |
CreateBatchQuickSignUrl(CreateBatchQuickSignUrlRequest req)
该接口用于发起合同后，生成个人用户的批量待办链接, 暂时不支持企业端签署。
注意：**
1.
|
|
CreateBatchSignUrlResponse |
CreateBatchSignUrl(CreateBatchSignUrlRequest req)
通过此接口，可以创建小程序批量签署链接，个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。
注意事项：
- 使用此接口生成链接，需要贵企业先开通 个人签署方仅校验手机号 功能。您可以在 【腾讯电子签网页端】->【企业设置】->【拓展服务】中找到该功能。
- 生成批量签署链接时，合同目标参与方的状态必须为待签署状态。签署人点击链接后需要输入短信验证码才能查看合同内容。
- 企业员工批量签署链接：需要传入签署方所在企业名称，用户名字和手机号（或者身份证件信息）参数来生成签署链接。该签署方企业必须已完成腾讯电子签企业认证
- 个人批量签署链接：需要传入签署方用户名字和手机号（或者身份证件信息）参数来生成签署链接。个人批量签署进行的合同的签名区， 全部变成手写签名（不管合同里边设置的签名限制）来进行。
|
|
CreateConvertTaskApiResponse |
CreateConvertTaskApi(CreateConvertTaskApiRequest req)
|
|
CreateDocumentResponse |
CreateDocument(CreateDocumentRequest req)
创建签署流程电子文档
### 调用流程 该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置创建签署流程和发起签署流程接口使用。具体逻辑可以参考下图:  ### 填充模板中定义的填写控件 模板中配置的发起人填充控件可以通过本接口的**FormFields数组**字段填充  填充的传参示例如下 ``` request.FormFields = [{ "ComponentName": "项目的名字", "ComponentValue": "休闲山庄" }, { "ComponentName": "项目的地址", "ComponentValue": "凤凰山北侧", }, { "ComponentName": "范围", "ComponentValue": "凤凰山至107国道", }, { "ComponentName": "面积", "ComponentValue": "100亩", }, { "ComponentName": "基本情况", "ComponentValue": "完好", }, , { "ComponentName": "用途", "ComponentValue": "经营农家乐", } ] ``` 合成后合同样子示例  |
|
CreateDynamicFlowApproverResponse |
CreateDynamicFlowApprover(CreateDynamicFlowApproverRequest req)
此接口（CreateDynamicFlowApprover）用来补充动态合同的签署人信息。
适用场景：使用CreateFlowByFiles指定：OpenDynamicSignFlow=true发起的合同，可以使用该接口补充后续签署人。 |
|
CreateEmbedWebUrlResponse |
CreateEmbedWebUrl(CreateEmbedWebUrlRequest req)
本接口（CreateEmbedWebUrl）用于创建可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中），支持以下类型的Web链接创建：
1.
|
|
CreateEmployeeQualificationSealQrCodeResponse |
CreateEmployeeQualificationSealQrCode(CreateEmployeeQualificationSealQrCodeRequest req)
该接口用于获取个人授权执业章给企业的微信二维码，需要个人用户通过微信扫码。
扫描后将跳转到腾讯电子签小程序，进入到授权执业章的流程。
个人用户授权成功后，企业印章管理员需对印章进行审核，审核通过后，即可使用个人授权的执业章进行盖章操作。
注意**
1.
|
|
CreateExtendedServiceAuthInfosResponse |
CreateExtendedServiceAuthInfos(CreateExtendedServiceAuthInfosRequest req)
创建企业扩展服务授权，当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。
该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口授权给企业员工。
注：“企业自动签授权”支持集团代子企业操作，请联系运营开通此功能。
|
|
CreateFlowResponse |
CreateFlow(CreateFlowRequest req)
通过模板创建签署流程
适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。 签署人类别 需要提前准备的信息 自己企业的员工签署（未认证加入或已认证加入） 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 自己企业的员工签署（已认证加入） 签署企业的名字、员工在电子签平台的ID（UserId） 其他企业的员工签署 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 个人（自然人）签署 个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传） 注：配合创建电子文档和发起签署流程接口使用。整体的逻辑如下图  注：**静默（自动）签署不支持合同签署方存在填写**功能 相关视频指引 1. |
|
CreateFlowApproversResponse |
CreateFlowApprovers(CreateFlowApproversRequest req)
适用场景 ：**
当通过模板或文件发起合同时， 签署人不制定， 等合同发起后再指定 可以用下面2种方案
1.
|
|
CreateFlowBlockchainEvidenceUrlResponse |
CreateFlowBlockchainEvidenceUrl(CreateFlowBlockchainEvidenceUrlRequest req)
获取区块链存证证书查看链接/二维码接口
适用场景：企业员工可以通过此接口生成合同区块链存证证书的查看链接/二维码，以供他人扫码打开腾讯电子签小程序查看。
[点击查看区块链存证证书样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)
注：
1.
|
|
CreateFlowByFilesResponse |
CreateFlowByFiles(CreateFlowByFilesRequest req)
此接口（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资源）  注： - 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**） - **静默（自动）签署不支持合同签署方存在填写**功能 相关视频指引 1. |
|
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员工
将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号
发送短信通知员工（短信中带有认证加入企业的链接）
企微员工
将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，需确保该企微员工在应用的可见范围内
企微内部实名消息
H5端 saas员工
传递 InvitationNotifyType = H5，将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号，此场景不支持企微
生成认证加入企业的H5链接，贵方可以通过自己的渠道触达到此员工
注意：
- 新增员工的手机号、OpenId不能与已加入员工重复， 不管已加入员工的手机号、OpenId是否已经实名
- 若通过手机号发现员工已经创建且信息一致（名字，openId等），则不会重复创建，但会发送短信或者生成链接提醒员工实名。
- 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角色和集团角色对应的权限树是不一样的。
|
|
CreateIntegrationSubOrganizationActiveRecordResponse |
CreateIntegrationSubOrganizationActiveRecord(CreateIntegrationSubOrganizationActiveRecordRequest req)
使用此接口，可创建子企业激活记录。集团企业管理员可以针对尚未激活的成员企业进行激活操作。
这个操作与页面端激活成员企业操作类似
注意：
1.
|
|
CreateIntegrationUserRolesResponse |
CreateIntegrationUserRoles(CreateIntegrationUserRolesRequest req)
此接口用于赋予员工指定的角色权限，如需解绑请使用 DeleteIntegrationRoleUsers 接口。
|
|
CreateLegalSealQrCodeResponse |
CreateLegalSealQrCode(CreateLegalSealQrCodeRequest req)
该接口用于获取创建法人章的二维码，需要通过微信扫描。扫描后将跳转到腾讯电子签署，进入到创建法人章的流程。
注意**
1.
|
|
CreateMultiFlowSignQRCodeResponse |
CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req)
此接口（CreateMultiFlowSignQRCode）用于创建一码多签签署码。
适用场景**:
签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
注意**:
1.
|
|
CreateOrganizationAuthUrlResponse |
CreateOrganizationAuthUrl(CreateOrganizationAuthUrlRequest req)
本接口（CreateOrganizationAuthUrl）的主要功能是生成合作企业的认证链接。
在生成链接的过程中，可以提供一部分已知信息，以便为对方进行认证流程提供便利。
- **企业统一社会信用代码**: 对应上图中的**1**
- **企业名称**: 对应上图中的**2**
- **企业法定代表人的名字**:对应上图中的**3**
- **企业详细住所**:对应上图中的**4**
注：此接口需要 购买单独的实名套餐包方可调用，如有需求请联系对接人员评估
|
|
CreateOrganizationBatchSignUrlResponse |
CreateOrganizationBatchSignUrl(CreateOrganizationBatchSignUrlRequest req)
使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
注： 员工必须需作为批量签署合同的签署方，或者是或签合同的候选人之一。 本方企业签署链接：如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。 他方企业签署链接：传RecipientIds，且必须是合同发起方调用此接口。打开链接后需要他方签署人登录电子签系统。（如果签署人没有加入对方企业则会引导加入；如果对方企业还没有注册认证，会引导企业注册和认证） 只支持待签署、待填写状态的合同生成签署链接。 签署的嵌入页面长相如下：  |
|
CreateOrganizationGroupInvitationLinkResponse |
CreateOrganizationGroupInvitationLink(CreateOrganizationGroupInvitationLinkRequest req)
生成集团加入链接，分享至子企业超管或者法人，子企业管理员可通过链接加入集团。
注意:调用当前接口的企业 必须为集团企业。如何成为集团企业可以参考下面的文档[集团操作文档](https://qian.tencent.com/document/86707)
|
|
CreateOrganizationInfoChangeUrlResponse |
CreateOrganizationInfoChangeUrl(CreateOrganizationInfoChangeUrlRequest req)
此接口（CreateOrganizationInfoChangeUrl）用于创建企业信息变更链接，支持创建企业超管变更链接或企业基础信息变更链接，通过入参ChangeType指定。
1. |
|
CreatePartnerAutoSignAuthUrlResponse |
CreatePartnerAutoSignAuthUrl(CreatePartnerAutoSignAuthUrlRequest req)
创建他方自动签授权链接（他方授权/我方授权），通过该链接可进入小程序进行合作方企业的自动签授权，若授权企业未开通企业自动签，通过该链接会先引导开通本企业自动签。
该接口效果同控制台： 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
注:
1.
|
|
CreatePersonAuthCertificateImageResponse |
CreatePersonAuthCertificateImage(CreatePersonAuthCertificateImageRequest req)
获取个人用户认证证书图片下载URL
个人用户认证证书图片样式如下图
注:
只能获取个人用户证明图片, 企业员工的暂不支持
处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。
|
|
CreatePreparedPersonalEsignResponse |
CreatePreparedPersonalEsign(CreatePreparedPersonalEsignRequest req)
本接口（CreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，使用此接口请与客户经理确认）。
|
|
CreatePrepareFlowResponse |
CreatePrepareFlow(CreatePrepareFlowRequest req)
创建发起流程Web页面，通过该接口可以获取发起流程的可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。在页面上完成签署控件等信息的编辑与确认后，可快速发起流程。
注意：调用接口后，流程不会立即发起，需在嵌入页面上点击【发起合同】按钮来发起流程。 嵌入页面长相如下:  |
|
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天。
该接口的链接适用于小程序端。
该接口不会扣除您的合同套餐，暂不参与计费。 |
|
CreateUserMobileChangeUrlResponse |
CreateUserMobileChangeUrl(CreateUserMobileChangeUrlRequest req)
该接口会生成一个手机号变更的链接，用户可以通过该链接进入电子签系统进行手机号的变更。
该接口支持员工和个人端手机号的变更。
|
|
CreateUserVerifyUrlResponse |
CreateUserVerifyUrl(CreateUserVerifyUrlRequest req)
生成个人用户实名认证链接，个人用户点击此链接进入实名流程（若用户已完成实名认证，则直接进入成功页面）。
注： 调用此接口需要购买单独的实名套餐包。使用前请联系对接的客户经理沟通。
|
|
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）用于撤销企业员工持有的印章权限
|
|
DescribeBatchOrganizationRegistrationUrlsResponse |
DescribeBatchOrganizationRegistrationUrls(DescribeBatchOrganizationRegistrationUrlsRequest req)
此接口用于获取企业批量认证异步任务的状态及结果。
前提条件：已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口，并得到了任务Id。
异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也可能需要更长的时间
|
|
DescribeBillUsageResponse |
DescribeBillUsage(DescribeBillUsageRequest req)
通过此接口（DescribeBillUsage）查询该企业的套餐套餐使用情况。
|
|
DescribeBillUsageDetailResponse |
DescribeBillUsageDetail(DescribeBillUsageDetailRequest req)
通过此接口（DescribeBillUsageDetail）查询该企业的套餐消耗详情。
|
|
DescribeCancelFlowsTaskResponse |
DescribeCancelFlowsTask(DescribeCancelFlowsTaskRequest req)
通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后，可通过此接口查询批量撤销任务的结果。
|
|
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）用于分页查询企业角色列表，列表按照角色创建时间升序排列。
|
|
DescribeOrganizationAuthStatusResponse |
DescribeOrganizationAuthStatus(DescribeOrganizationAuthStatusRequest req)
查询企业认证状态- 仅通过[CreateOrganizationAuthUrl](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl) 和[CreateBatchOrganizationRegistrationTasks](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)这两个接口进行引导认证的企业，调用方企业可以依据这个接口，查询认证状态。
|
|
DescribeOrganizationGroupOrganizationsResponse |
DescribeOrganizationGroupOrganizations(DescribeOrganizationGroupOrganizationsRequest req)
此API接口用来查询加入集团的成员企业信息
适用场景：子企业在加入集团后，主企业可能通过此接口获取到所有的子企业列表，方便进行展示和统计
|
|
DescribeOrganizationSealsResponse |
DescribeOrganizationSeals(DescribeOrganizationSealsRequest req)
查询企业印章列表。
注：
1.
|
|
DescribePersonCertificateResponse |
DescribePersonCertificate(DescribePersonCertificateRequest req)
此接口（DescribePersonCertificate）用于查询个人数字证书信息。
注：`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。` `2.调用此接口需要开通白名单，使用前请联系相关人员开通白名单。` |
|
DescribeSignFaceVideoResponse |
DescribeSignFaceVideo(DescribeSignFaceVideoRequest req)
该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。
1.
|
|
DescribeThirdPartyAuthCodeResponse |
DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req)
通过AuthCode查询个人用户是否实名
注意:
此接口为合作引流场景使用，使用有白名单限制，使用前请联系对接的客户经理沟通。
AuthCode 只能使用一次，查询一次再次查询会返回错误
|
|
DescribeUserAutoSignStatusResponse |
DescribeUserAutoSignStatus(DescribeUserAutoSignStatusRequest req)
通过此接口获取个人用户自动签的开通状态。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
|
|
DescribeUserVerifyStatusResponse |
DescribeUserVerifyStatus(DescribeUserVerifyStatusRequest req)
用于客户企业在调用生成[C端用户实名链接（CreateUserVerifyUrl）](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口之前判断C端用户是否实名，如果已经实名，就不需要再次调用生成C端链接接口去实名
注意：此接口仅会返回当前员工是否通过[C端用户实名链接（CreateUserVerifyUrl）](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)所实名的员工是否实名，并不会返回个人用户自己在电子签进行实名的状况
|
|
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.
|
|
ModifyFlowDeadlineResponse |
ModifyFlowDeadline(ModifyFlowDeadlineRequest req)
在已启动的签署流程中，可对签署截止日期进行延期操作，主要分为以下两个层面：
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角色和集团角色对应的权限树是不一样的。
|
|
RenewAutoSignLicenseResponse |
RenewAutoSignLicense(RenewAutoSignLicenseRequest req)
给医疗个人自动签许可续期。续期成功后，可对医疗自动签许可追加一年有效期，只可续期一次。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
|
|
StartFlowResponse |
StartFlow(StartFlowRequest req)
此接口用于启动流程。它是模板发起合同的最后一步。
在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
注：
1.合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
2.静默（自动）签署不支持非本企业合同签署方存在填写功能
3.在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_file_resources)，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
|
|
UnbindEmployeeUserIdWithClientOpenIdResponse |
UnbindEmployeeUserIdWithClientOpenId(UnbindEmployeeUserIdWithClientOpenIdRequest req)
此接口（UnbindEmployeeUserIdWithClientOpenId）用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。
注：`在调用此接口时，需确保OpenId已通过调用`BindEmployeeUserIdWithClientOpenId`接口与电子签系统的UserId绑定过。若OpenId未经过绑定，则无法使用此接口进行解绑操作。`
|
|
UpdateIntegrationEmployeesResponse |
UpdateIntegrationEmployees(UpdateIntegrationEmployeesRequest req)
此接口（UpdateIntegrationEmployees）用于修改未实名企业员工信息(姓名，手机号，邮件、部门)。
如果企业员工已经实名， 姓名，手机号，邮件等需要企业员工到小程序或者控制台自己修改， 部门则需要超管到控制台分配
修改手机号的时候,支持以下场景进行提醒通知
生成端
入参
提醒方式
普通saas员工
将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号
发送短信通知员工（短信中带有认证加入企业的链接）
企微员工
将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，需确保该企微员工在应用的可见范围内
企微内部实名消息
H5端 saas员工
传递 InvitationNotifyType = H5，将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号，此场景不支持企微
生成认证加入企业的H5链接，贵方可以通过自己的渠道触达到此员工
注意：
- 若通过手机号发现员工已经创建，则不会重复创建，但会发送短信或者生成链接提醒员工实名。
- jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。
|
|
UploadFilesResponse |
UploadFiles(UploadFilesRequest req)
此接口（UploadFiles）文件上传。
适用场景：用于合同，印章的文件上传。文件上传以后， 如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起 如果是其他类型可以配合创建文件转换任务接口转换成PDF文件 注: 1. |
|
VerifyPdfResponse |
VerifyPdf(VerifyPdfRequest req)
对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。
补充**： 可以到控制台[合同验签](https://qian.tencent.com/verifySign)体验验签功能，界面如下
|
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreakerpublic EssClient(Credential credential, String region)
public EssClient(Credential credential, String region, ClientProfile profile)
public ArchiveDynamicFlowResponse ArchiveDynamicFlow(ArchiveDynamicFlowRequest req) throws TencentCloudSDKException
req - ArchiveDynamicFlowRequestTencentCloudSDKExceptionpublic BindEmployeeUserIdWithClientOpenIdResponse BindEmployeeUserIdWithClientOpenId(BindEmployeeUserIdWithClientOpenIdRequest req) throws TencentCloudSDKException
req - BindEmployeeUserIdWithClientOpenIdRequestTencentCloudSDKExceptionpublic CancelFlowResponse CancelFlow(CancelFlowRequest req) throws TencentCloudSDKException
req - CancelFlowRequestTencentCloudSDKExceptionpublic CancelMultiFlowSignQRCodeResponse CancelMultiFlowSignQRCode(CancelMultiFlowSignQRCodeRequest req) throws TencentCloudSDKException
req - CancelMultiFlowSignQRCodeRequestTencentCloudSDKExceptionpublic CancelUserAutoSignEnableUrlResponse CancelUserAutoSignEnableUrl(CancelUserAutoSignEnableUrlRequest req) throws TencentCloudSDKException
req - CancelUserAutoSignEnableUrlRequestTencentCloudSDKExceptionpublic CreateBatchCancelFlowUrlResponse CreateBatchCancelFlowUrl(CreateBatchCancelFlowUrlRequest req) throws TencentCloudSDKException
req - CreateBatchCancelFlowUrlRequestTencentCloudSDKExceptionpublic CreateBatchInitOrganizationUrlResponse CreateBatchInitOrganizationUrl(CreateBatchInitOrganizationUrlRequest req) throws TencentCloudSDKException
req - CreateBatchInitOrganizationUrlRequestTencentCloudSDKExceptionpublic CreateBatchOrganizationAuthorizationUrlResponse CreateBatchOrganizationAuthorizationUrl(CreateBatchOrganizationAuthorizationUrlRequest req) throws TencentCloudSDKException
req - CreateBatchOrganizationAuthorizationUrlRequestTencentCloudSDKExceptionpublic CreateBatchOrganizationRegistrationTasksResponse CreateBatchOrganizationRegistrationTasks(CreateBatchOrganizationRegistrationTasksRequest req) throws TencentCloudSDKException
req - CreateBatchOrganizationRegistrationTasksRequestTencentCloudSDKExceptionpublic CreateBatchQuickSignUrlResponse CreateBatchQuickSignUrl(CreateBatchQuickSignUrlRequest req) throws TencentCloudSDKException
req - CreateBatchQuickSignUrlRequestTencentCloudSDKExceptionpublic CreateBatchSignUrlResponse CreateBatchSignUrl(CreateBatchSignUrlRequest req) throws TencentCloudSDKException
req - CreateBatchSignUrlRequestTencentCloudSDKExceptionpublic CreateConvertTaskApiResponse CreateConvertTaskApi(CreateConvertTaskApiRequest req) throws TencentCloudSDKException
req - CreateConvertTaskApiRequestTencentCloudSDKExceptionpublic CreateDocumentResponse CreateDocument(CreateDocumentRequest req) throws TencentCloudSDKException
req - CreateDocumentRequestTencentCloudSDKExceptionpublic CreateDynamicFlowApproverResponse CreateDynamicFlowApprover(CreateDynamicFlowApproverRequest req) throws TencentCloudSDKException
req - CreateDynamicFlowApproverRequestTencentCloudSDKExceptionpublic CreateEmbedWebUrlResponse CreateEmbedWebUrl(CreateEmbedWebUrlRequest req) throws TencentCloudSDKException
req - CreateEmbedWebUrlRequestTencentCloudSDKExceptionpublic CreateEmployeeQualificationSealQrCodeResponse CreateEmployeeQualificationSealQrCode(CreateEmployeeQualificationSealQrCodeRequest req) throws TencentCloudSDKException
req - CreateEmployeeQualificationSealQrCodeRequestTencentCloudSDKExceptionpublic CreateExtendedServiceAuthInfosResponse CreateExtendedServiceAuthInfos(CreateExtendedServiceAuthInfosRequest req) throws TencentCloudSDKException
req - CreateExtendedServiceAuthInfosRequestTencentCloudSDKExceptionpublic CreateFlowResponse CreateFlow(CreateFlowRequest req) throws TencentCloudSDKException
| 签署人类别 | 需要提前准备的信息 |
|---|---|
| 自己企业的员工签署（未认证加入或已认证加入） | 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） |
| 自己企业的员工签署（已认证加入） | 签署企业的名字、员工在电子签平台的ID（UserId） |
| 其他企业的员工签署 | 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） |
| 个人（自然人）签署 | 个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传） |
req - CreateFlowRequestTencentCloudSDKExceptionpublic CreateFlowApproversResponse CreateFlowApprovers(CreateFlowApproversRequest req) throws TencentCloudSDKException
req - CreateFlowApproversRequestTencentCloudSDKExceptionpublic CreateFlowBlockchainEvidenceUrlResponse CreateFlowBlockchainEvidenceUrl(CreateFlowBlockchainEvidenceUrlRequest req) throws TencentCloudSDKException
req - CreateFlowBlockchainEvidenceUrlRequestTencentCloudSDKExceptionpublic CreateFlowByFilesResponse CreateFlowByFiles(CreateFlowByFilesRequest req) throws TencentCloudSDKException
| 签署人类别 | 需要提前准备的信息 |
|---|---|
| 自己企业的员工签署（未认证加入或已认证加入） | 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） |
| 自己企业的员工签署（已认证加入） | 签署企业的名字、员工在电子签平台的ID（UserId） |
| 其他企业的员工签署 | 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） |
| 个人（自然人）签署 | 个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传） |
req - CreateFlowByFilesRequestTencentCloudSDKExceptionpublic CreateFlowEvidenceReportResponse CreateFlowEvidenceReport(CreateFlowEvidenceReportRequest req) throws TencentCloudSDKException
req - CreateFlowEvidenceReportRequestTencentCloudSDKExceptionpublic CreateFlowGroupByFilesResponse CreateFlowGroupByFiles(CreateFlowGroupByFilesRequest req) throws TencentCloudSDKException
req - CreateFlowGroupByFilesRequestTencentCloudSDKExceptionpublic CreateFlowGroupByTemplatesResponse CreateFlowGroupByTemplates(CreateFlowGroupByTemplatesRequest req) throws TencentCloudSDKException
req - CreateFlowGroupByTemplatesRequestTencentCloudSDKExceptionpublic CreateFlowGroupSignReviewResponse CreateFlowGroupSignReview(CreateFlowGroupSignReviewRequest req) throws TencentCloudSDKException
req - CreateFlowGroupSignReviewRequestTencentCloudSDKExceptionpublic CreateFlowRemindsResponse CreateFlowReminds(CreateFlowRemindsRequest req) throws TencentCloudSDKException
req - CreateFlowRemindsRequestTencentCloudSDKExceptionpublic CreateFlowSignReviewResponse CreateFlowSignReview(CreateFlowSignReviewRequest req) throws TencentCloudSDKException
req - CreateFlowSignReviewRequestTencentCloudSDKExceptionpublic CreateFlowSignUrlResponse CreateFlowSignUrl(CreateFlowSignUrlRequest req) throws TencentCloudSDKException
req - CreateFlowSignUrlRequestTencentCloudSDKExceptionpublic CreateIntegrationDepartmentResponse CreateIntegrationDepartment(CreateIntegrationDepartmentRequest req) throws TencentCloudSDKException
req - CreateIntegrationDepartmentRequestTencentCloudSDKExceptionpublic CreateIntegrationEmployeesResponse CreateIntegrationEmployees(CreateIntegrationEmployeesRequest req) throws TencentCloudSDKException
| 生成端 | 入参 | 提醒方式 |
| 普通saas员工 | 将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号 | 发送短信通知员工（短信中带有认证加入企业的链接） |
| 企微员工 | 将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，需确保该企微员工在应用的可见范围内 | 企微内部实名消息 |
| H5端 saas员工 | 传递 InvitationNotifyType = H5，将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号，此场景不支持企微 | 生成认证加入企业的H5链接，贵方可以通过自己的渠道触达到此员工 |
req - CreateIntegrationEmployeesRequestTencentCloudSDKExceptionpublic CreateIntegrationRoleResponse CreateIntegrationRole(CreateIntegrationRoleRequest req) throws TencentCloudSDKException
req - CreateIntegrationRoleRequestTencentCloudSDKExceptionpublic CreateIntegrationSubOrganizationActiveRecordResponse CreateIntegrationSubOrganizationActiveRecord(CreateIntegrationSubOrganizationActiveRecordRequest req) throws TencentCloudSDKException
req - CreateIntegrationSubOrganizationActiveRecordRequestTencentCloudSDKExceptionpublic CreateIntegrationUserRolesResponse CreateIntegrationUserRoles(CreateIntegrationUserRolesRequest req) throws TencentCloudSDKException
req - CreateIntegrationUserRolesRequestTencentCloudSDKExceptionpublic CreateLegalSealQrCodeResponse CreateLegalSealQrCode(CreateLegalSealQrCodeRequest req) throws TencentCloudSDKException
req - CreateLegalSealQrCodeRequestTencentCloudSDKExceptionpublic CreateMultiFlowSignQRCodeResponse CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req) throws TencentCloudSDKException
req - CreateMultiFlowSignQRCodeRequestTencentCloudSDKExceptionpublic CreateOrganizationAuthUrlResponse CreateOrganizationAuthUrl(CreateOrganizationAuthUrlRequest req) throws TencentCloudSDKException
req - CreateOrganizationAuthUrlRequestTencentCloudSDKExceptionpublic CreateOrganizationBatchSignUrlResponse CreateOrganizationBatchSignUrl(CreateOrganizationBatchSignUrlRequest req) throws TencentCloudSDKException
req - CreateOrganizationBatchSignUrlRequestTencentCloudSDKExceptionpublic CreateOrganizationGroupInvitationLinkResponse CreateOrganizationGroupInvitationLink(CreateOrganizationGroupInvitationLinkRequest req) throws TencentCloudSDKException
req - CreateOrganizationGroupInvitationLinkRequestTencentCloudSDKExceptionpublic CreateOrganizationInfoChangeUrlResponse CreateOrganizationInfoChangeUrl(CreateOrganizationInfoChangeUrlRequest req) throws TencentCloudSDKException
换成企业的其他员工来当超管
如果企业名称变动会引起下面的变动
req - CreateOrganizationInfoChangeUrlRequestTencentCloudSDKExceptionpublic CreatePartnerAutoSignAuthUrlResponse CreatePartnerAutoSignAuthUrl(CreatePartnerAutoSignAuthUrlRequest req) throws TencentCloudSDKException
req - CreatePartnerAutoSignAuthUrlRequestTencentCloudSDKExceptionpublic CreatePersonAuthCertificateImageResponse CreatePersonAuthCertificateImage(CreatePersonAuthCertificateImageRequest req) throws TencentCloudSDKException
req - CreatePersonAuthCertificateImageRequestTencentCloudSDKExceptionpublic CreatePrepareFlowResponse CreatePrepareFlow(CreatePrepareFlowRequest req) throws TencentCloudSDKException
req - CreatePrepareFlowRequestTencentCloudSDKExceptionpublic CreatePreparedPersonalEsignResponse CreatePreparedPersonalEsign(CreatePreparedPersonalEsignRequest req) throws TencentCloudSDKException
req - CreatePreparedPersonalEsignRequestTencentCloudSDKExceptionpublic CreateReleaseFlowResponse CreateReleaseFlow(CreateReleaseFlowRequest req) throws TencentCloudSDKException
原合同必须签署完成后才能发起解除协议。个人参与方不能发起解除协议。不能更换其他第三方个人参与解除协议。企业员工代为处理。扣费，扣费标准同其他类型合同。解除合同的权限。req - CreateReleaseFlowRequestTencentCloudSDKExceptionpublic CreateSchemeUrlResponse CreateSchemeUrl(CreateSchemeUrlRequest req) throws TencentCloudSDKException
req - CreateSchemeUrlRequestTencentCloudSDKExceptionpublic CreateSealResponse CreateSeal(CreateSealRequest req) throws TencentCloudSDKException
req - CreateSealRequestTencentCloudSDKExceptionpublic CreateSealPolicyResponse CreateSealPolicy(CreateSealPolicyRequest req) throws TencentCloudSDKException
req - CreateSealPolicyRequestTencentCloudSDKExceptionpublic CreateUserAutoSignEnableUrlResponse CreateUserAutoSignEnableUrl(CreateUserAutoSignEnableUrlRequest req) throws TencentCloudSDKException
req - CreateUserAutoSignEnableUrlRequestTencentCloudSDKExceptionpublic CreateUserAutoSignSealUrlResponse CreateUserAutoSignSealUrl(CreateUserAutoSignSealUrlRequest req) throws TencentCloudSDKException
企业开通自动签后使用。已经开通了自动签的个人更换自动签印章。最多30天。小程序端。req - CreateUserAutoSignSealUrlRequestTencentCloudSDKExceptionpublic CreateUserMobileChangeUrlResponse CreateUserMobileChangeUrl(CreateUserMobileChangeUrlRequest req) throws TencentCloudSDKException
req - CreateUserMobileChangeUrlRequestTencentCloudSDKExceptionpublic CreateUserVerifyUrlResponse CreateUserVerifyUrl(CreateUserVerifyUrlRequest req) throws TencentCloudSDKException
req - CreateUserVerifyUrlRequestTencentCloudSDKExceptionpublic CreateWebThemeConfigResponse CreateWebThemeConfig(CreateWebThemeConfigRequest req) throws TencentCloudSDKException
req - CreateWebThemeConfigRequestTencentCloudSDKExceptionpublic DeleteExtendedServiceAuthInfosResponse DeleteExtendedServiceAuthInfos(DeleteExtendedServiceAuthInfosRequest req) throws TencentCloudSDKException
req - DeleteExtendedServiceAuthInfosRequestTencentCloudSDKExceptionpublic DeleteIntegrationDepartmentResponse DeleteIntegrationDepartment(DeleteIntegrationDepartmentRequest req) throws TencentCloudSDKException
req - DeleteIntegrationDepartmentRequestTencentCloudSDKExceptionpublic DeleteIntegrationEmployeesResponse DeleteIntegrationEmployees(DeleteIntegrationEmployeesRequest req) throws TencentCloudSDKException
req - DeleteIntegrationEmployeesRequestTencentCloudSDKExceptionpublic DeleteIntegrationRoleUsersResponse DeleteIntegrationRoleUsers(DeleteIntegrationRoleUsersRequest req) throws TencentCloudSDKException
req - DeleteIntegrationRoleUsersRequestTencentCloudSDKExceptionpublic DeleteSealPoliciesResponse DeleteSealPolicies(DeleteSealPoliciesRequest req) throws TencentCloudSDKException
req - DeleteSealPoliciesRequestTencentCloudSDKExceptionpublic DescribeBatchOrganizationRegistrationUrlsResponse DescribeBatchOrganizationRegistrationUrls(DescribeBatchOrganizationRegistrationUrlsRequest req) throws TencentCloudSDKException
req - DescribeBatchOrganizationRegistrationUrlsRequestTencentCloudSDKExceptionpublic DescribeBillUsageResponse DescribeBillUsage(DescribeBillUsageRequest req) throws TencentCloudSDKException
req - DescribeBillUsageRequestTencentCloudSDKExceptionpublic DescribeBillUsageDetailResponse DescribeBillUsageDetail(DescribeBillUsageDetailRequest req) throws TencentCloudSDKException
req - DescribeBillUsageDetailRequestTencentCloudSDKExceptionpublic DescribeCancelFlowsTaskResponse DescribeCancelFlowsTask(DescribeCancelFlowsTaskRequest req) throws TencentCloudSDKException
req - DescribeCancelFlowsTaskRequestTencentCloudSDKExceptionpublic DescribeExtendedServiceAuthDetailResponse DescribeExtendedServiceAuthDetail(DescribeExtendedServiceAuthDetailRequest req) throws TencentCloudSDKException
req - DescribeExtendedServiceAuthDetailRequestTencentCloudSDKExceptionpublic DescribeExtendedServiceAuthInfosResponse DescribeExtendedServiceAuthInfos(DescribeExtendedServiceAuthInfosRequest req) throws TencentCloudSDKException
req - DescribeExtendedServiceAuthInfosRequestTencentCloudSDKExceptionpublic DescribeFileUrlsResponse DescribeFileUrls(DescribeFileUrlsRequest req) throws TencentCloudSDKException
req - DescribeFileUrlsRequestTencentCloudSDKExceptionpublic DescribeFlowBriefsResponse DescribeFlowBriefs(DescribeFlowBriefsRequest req) throws TencentCloudSDKException
req - DescribeFlowBriefsRequestTencentCloudSDKExceptionpublic DescribeFlowComponentsResponse DescribeFlowComponents(DescribeFlowComponentsRequest req) throws TencentCloudSDKException
req - DescribeFlowComponentsRequestTencentCloudSDKExceptionpublic DescribeFlowEvidenceReportResponse DescribeFlowEvidenceReport(DescribeFlowEvidenceReportRequest req) throws TencentCloudSDKException
req - DescribeFlowEvidenceReportRequestTencentCloudSDKExceptionpublic DescribeFlowInfoResponse DescribeFlowInfo(DescribeFlowInfoRequest req) throws TencentCloudSDKException
req - DescribeFlowInfoRequestTencentCloudSDKExceptionpublic DescribeFlowTemplatesResponse DescribeFlowTemplates(DescribeFlowTemplatesRequest req) throws TencentCloudSDKException
req - DescribeFlowTemplatesRequestTencentCloudSDKExceptionpublic DescribeIntegrationDepartmentsResponse DescribeIntegrationDepartments(DescribeIntegrationDepartmentsRequest req) throws TencentCloudSDKException
req - DescribeIntegrationDepartmentsRequestTencentCloudSDKExceptionpublic DescribeIntegrationEmployeesResponse DescribeIntegrationEmployees(DescribeIntegrationEmployeesRequest req) throws TencentCloudSDKException
req - DescribeIntegrationEmployeesRequestTencentCloudSDKExceptionpublic DescribeIntegrationRolesResponse DescribeIntegrationRoles(DescribeIntegrationRolesRequest req) throws TencentCloudSDKException
req - DescribeIntegrationRolesRequestTencentCloudSDKExceptionpublic DescribeOrganizationAuthStatusResponse DescribeOrganizationAuthStatus(DescribeOrganizationAuthStatusRequest req) throws TencentCloudSDKException
req - DescribeOrganizationAuthStatusRequestTencentCloudSDKExceptionpublic DescribeOrganizationGroupOrganizationsResponse DescribeOrganizationGroupOrganizations(DescribeOrganizationGroupOrganizationsRequest req) throws TencentCloudSDKException
req - DescribeOrganizationGroupOrganizationsRequestTencentCloudSDKExceptionpublic DescribeOrganizationSealsResponse DescribeOrganizationSeals(DescribeOrganizationSealsRequest req) throws TencentCloudSDKException
req - DescribeOrganizationSealsRequestTencentCloudSDKExceptionpublic DescribePersonCertificateResponse DescribePersonCertificate(DescribePersonCertificateRequest req) throws TencentCloudSDKException
req - DescribePersonCertificateRequestTencentCloudSDKExceptionpublic DescribeSignFaceVideoResponse DescribeSignFaceVideo(DescribeSignFaceVideoRequest req) throws TencentCloudSDKException
req - DescribeSignFaceVideoRequestTencentCloudSDKExceptionpublic DescribeThirdPartyAuthCodeResponse DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req) throws TencentCloudSDKException
req - DescribeThirdPartyAuthCodeRequestTencentCloudSDKExceptionpublic DescribeUserAutoSignStatusResponse DescribeUserAutoSignStatus(DescribeUserAutoSignStatusRequest req) throws TencentCloudSDKException
req - DescribeUserAutoSignStatusRequestTencentCloudSDKExceptionpublic DescribeUserVerifyStatusResponse DescribeUserVerifyStatus(DescribeUserVerifyStatusRequest req) throws TencentCloudSDKException
req - DescribeUserVerifyStatusRequestTencentCloudSDKExceptionpublic DisableUserAutoSignResponse DisableUserAutoSign(DisableUserAutoSignRequest req) throws TencentCloudSDKException
req - DisableUserAutoSignRequestTencentCloudSDKExceptionpublic GetTaskResultApiResponse GetTaskResultApi(GetTaskResultApiRequest req) throws TencentCloudSDKException
req - GetTaskResultApiRequestTencentCloudSDKExceptionpublic ModifyApplicationCallbackInfoResponse ModifyApplicationCallbackInfo(ModifyApplicationCallbackInfoRequest req) throws TencentCloudSDKException
req - ModifyApplicationCallbackInfoRequestTencentCloudSDKExceptionpublic ModifyExtendedServiceResponse ModifyExtendedService(ModifyExtendedServiceRequest req) throws TencentCloudSDKException
req - ModifyExtendedServiceRequestTencentCloudSDKExceptionpublic ModifyFlowDeadlineResponse ModifyFlowDeadline(ModifyFlowDeadlineRequest req) throws TencentCloudSDKException
req - ModifyFlowDeadlineRequestTencentCloudSDKExceptionpublic ModifyIntegrationDepartmentResponse ModifyIntegrationDepartment(ModifyIntegrationDepartmentRequest req) throws TencentCloudSDKException
req - ModifyIntegrationDepartmentRequestTencentCloudSDKExceptionpublic ModifyIntegrationRoleResponse ModifyIntegrationRole(ModifyIntegrationRoleRequest req) throws TencentCloudSDKException
req - ModifyIntegrationRoleRequestTencentCloudSDKExceptionpublic RenewAutoSignLicenseResponse RenewAutoSignLicense(RenewAutoSignLicenseRequest req) throws TencentCloudSDKException
req - RenewAutoSignLicenseRequestTencentCloudSDKExceptionpublic StartFlowResponse StartFlow(StartFlowRequest req) throws TencentCloudSDKException
req - StartFlowRequestTencentCloudSDKExceptionpublic UnbindEmployeeUserIdWithClientOpenIdResponse UnbindEmployeeUserIdWithClientOpenId(UnbindEmployeeUserIdWithClientOpenIdRequest req) throws TencentCloudSDKException
req - UnbindEmployeeUserIdWithClientOpenIdRequestTencentCloudSDKExceptionpublic UpdateIntegrationEmployeesResponse UpdateIntegrationEmployees(UpdateIntegrationEmployeesRequest req) throws TencentCloudSDKException
| 生成端 | 入参 | 提醒方式 |
| 普通saas员工 | 将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号 | 发送短信通知员工（短信中带有认证加入企业的链接） |
| 企微员工 | 将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，需确保该企微员工在应用的可见范围内 | 企微内部实名消息 |
| H5端 saas员工 | 传递 InvitationNotifyType = H5，将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号，此场景不支持企微 | 生成认证加入企业的H5链接，贵方可以通过自己的渠道触达到此员工 |
req - UpdateIntegrationEmployeesRequestTencentCloudSDKExceptionpublic UploadFilesResponse UploadFiles(UploadFilesRequest req) throws TencentCloudSDKException
req - UploadFilesRequestTencentCloudSDKExceptionpublic VerifyPdfResponse VerifyPdf(VerifyPdfRequest req) throws TencentCloudSDKException
req - VerifyPdfRequestTencentCloudSDKExceptionCopyright © 2024. All rights reserved.