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 |
---|---|
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)
|
CreateDocumentResponse |
CreateDocument(CreateDocumentRequest req)
创建签署流程电子文档
适用场景:见创建签署流程接口。 点击查看通过模板创建签署流程 用PDF文件创建签署流程。 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置创建签署流程和发起签署流程接口使用。具体逻辑可以参考下图: |
CreateEmbedWebUrlResponse |
CreateEmbedWebUrl(CreateEmbedWebUrlRequest req)
本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
1.
|
CreateExtendedServiceAuthInfosResponse |
CreateExtendedServiceAuthInfos(CreateExtendedServiceAuthInfosRequest req)
创建企业扩展服务授权,当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。
该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同,可通过该接口授权给企业员工。
注:“企业自动签授权”支持集团代子企业操作,请联系运营开通此功能。
|
CreateFlowResponse |
CreateFlow(CreateFlowRequest req)
|
CreateFlowApproversResponse |
CreateFlowApprovers(CreateFlowApproversRequest req)
适用场景:
当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。
限制条件:
1.
|
CreateFlowByFilesResponse |
CreateFlowByFiles(CreateFlowByFilesRequest req)
此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。 适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。 |
CreateFlowEvidenceReportResponse |
CreateFlowEvidenceReport(CreateFlowEvidenceReportRequest req)
提交申请出证报告任务并返回报告ID。
注意:
使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。
操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。
合同流程必须所有参与方`已经签署完成`。
出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过获取出证报告任务执行结果接口进行查询执行结果和出证报告的下载URL。
|
CreateFlowGroupByFilesResponse |
CreateFlowGroupByFiles(CreateFlowGroupByFilesRequest req)
此接口(CreateFlowGroupByFiles)可用于通过多个文件创建合同组签署流程。
适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
注意事项:使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
|
CreateFlowGroupByTemplatesResponse |
CreateFlowGroupByTemplates(CreateFlowGroupByTemplatesRequest req)
此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
|
CreateFlowRemindsResponse |
CreateFlowReminds(CreateFlowRemindsRequest req)
指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
1.
|
CreateFlowSignReviewResponse |
CreateFlowSignReview(CreateFlowSignReviewRequest req)
提交签署流程审批结果的适用场景包括:
1.
|
CreateFlowSignUrlResponse |
CreateFlowSignUrl(CreateFlowSignUrlRequest req)
该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署
注意** 1. |
CreateIntegrationDepartmentResponse |
CreateIntegrationDepartment(CreateIntegrationDepartmentRequest req)
此接口(CreateIntegrationDepartment)用于创建企业的部门信息,支持绑定客户系统部门ID。
|
CreateIntegrationEmployeesResponse |
CreateIntegrationEmployees(CreateIntegrationEmployeesRequest req)
此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
|
CreateIntegrationRoleResponse |
CreateIntegrationRole(CreateIntegrationRoleRequest req)
此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 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)查询该企业的套餐消耗详情。
|
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)
|
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)
更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
可进行批量操作,Employees中的userID与openID二选一必填
|
UploadFilesResponse |
UploadFiles(UploadFilesRequest req)
此接口(UploadFiles)文件上传。
适用场景:用于合同,印章的文件上传。文件上传以后, 如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起 如果是其他类型可以配合创建文件转换任务接口转换成PDF文件 注: 1. |
VerifyPdfResponse |
VerifyPdf(VerifyPdfRequest req)
对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
|
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker
public EssClient(Credential credential, String region)
public EssClient(Credential credential, String region, ClientProfile profile)
public BindEmployeeUserIdWithClientOpenIdResponse BindEmployeeUserIdWithClientOpenId(BindEmployeeUserIdWithClientOpenIdRequest req) throws TencentCloudSDKException
req
- BindEmployeeUserIdWithClientOpenIdRequestTencentCloudSDKException
public CancelFlowResponse CancelFlow(CancelFlowRequest req) throws TencentCloudSDKException
req
- CancelFlowRequestTencentCloudSDKException
public CancelMultiFlowSignQRCodeResponse CancelMultiFlowSignQRCode(CancelMultiFlowSignQRCodeRequest req) throws TencentCloudSDKException
req
- CancelMultiFlowSignQRCodeRequestTencentCloudSDKException
public CancelUserAutoSignEnableUrlResponse CancelUserAutoSignEnableUrl(CancelUserAutoSignEnableUrlRequest req) throws TencentCloudSDKException
req
- CancelUserAutoSignEnableUrlRequestTencentCloudSDKException
public CreateBatchCancelFlowUrlResponse CreateBatchCancelFlowUrl(CreateBatchCancelFlowUrlRequest req) throws TencentCloudSDKException
req
- CreateBatchCancelFlowUrlRequestTencentCloudSDKException
public CreateBatchQuickSignUrlResponse CreateBatchQuickSignUrl(CreateBatchQuickSignUrlRequest req) throws TencentCloudSDKException
req
- CreateBatchQuickSignUrlRequestTencentCloudSDKException
public CreateBatchSignUrlResponse CreateBatchSignUrl(CreateBatchSignUrlRequest req) throws TencentCloudSDKException
req
- CreateBatchSignUrlRequestTencentCloudSDKException
public CreateConvertTaskApiResponse CreateConvertTaskApi(CreateConvertTaskApiRequest req) throws TencentCloudSDKException
req
- CreateConvertTaskApiRequestTencentCloudSDKException
public CreateDocumentResponse CreateDocument(CreateDocumentRequest req) throws TencentCloudSDKException
req
- CreateDocumentRequestTencentCloudSDKException
public CreateEmbedWebUrlResponse CreateEmbedWebUrl(CreateEmbedWebUrlRequest req) throws TencentCloudSDKException
req
- CreateEmbedWebUrlRequestTencentCloudSDKException
public CreateExtendedServiceAuthInfosResponse CreateExtendedServiceAuthInfos(CreateExtendedServiceAuthInfosRequest req) throws TencentCloudSDKException
req
- CreateExtendedServiceAuthInfosRequestTencentCloudSDKException
public CreateFlowResponse CreateFlow(CreateFlowRequest req) throws TencentCloudSDKException
req
- CreateFlowRequestTencentCloudSDKException
public CreateFlowApproversResponse CreateFlowApprovers(CreateFlowApproversRequest req) throws TencentCloudSDKException
req
- CreateFlowApproversRequestTencentCloudSDKException
public CreateFlowByFilesResponse CreateFlowByFiles(CreateFlowByFilesRequest req) throws TencentCloudSDKException
req
- CreateFlowByFilesRequestTencentCloudSDKException
public CreateFlowEvidenceReportResponse CreateFlowEvidenceReport(CreateFlowEvidenceReportRequest req) throws TencentCloudSDKException
req
- CreateFlowEvidenceReportRequestTencentCloudSDKException
public CreateFlowGroupByFilesResponse CreateFlowGroupByFiles(CreateFlowGroupByFilesRequest req) throws TencentCloudSDKException
req
- CreateFlowGroupByFilesRequestTencentCloudSDKException
public CreateFlowGroupByTemplatesResponse CreateFlowGroupByTemplates(CreateFlowGroupByTemplatesRequest req) throws TencentCloudSDKException
req
- CreateFlowGroupByTemplatesRequestTencentCloudSDKException
public CreateFlowRemindsResponse CreateFlowReminds(CreateFlowRemindsRequest req) throws TencentCloudSDKException
req
- CreateFlowRemindsRequestTencentCloudSDKException
public CreateFlowSignReviewResponse CreateFlowSignReview(CreateFlowSignReviewRequest req) throws TencentCloudSDKException
req
- CreateFlowSignReviewRequestTencentCloudSDKException
public CreateFlowSignUrlResponse CreateFlowSignUrl(CreateFlowSignUrlRequest req) throws TencentCloudSDKException
req
- CreateFlowSignUrlRequestTencentCloudSDKException
public CreateIntegrationDepartmentResponse CreateIntegrationDepartment(CreateIntegrationDepartmentRequest req) throws TencentCloudSDKException
req
- CreateIntegrationDepartmentRequestTencentCloudSDKException
public CreateIntegrationEmployeesResponse CreateIntegrationEmployees(CreateIntegrationEmployeesRequest req) throws TencentCloudSDKException
req
- CreateIntegrationEmployeesRequestTencentCloudSDKException
public CreateIntegrationRoleResponse CreateIntegrationRole(CreateIntegrationRoleRequest req) throws TencentCloudSDKException
req
- CreateIntegrationRoleRequestTencentCloudSDKException
public CreateIntegrationUserRolesResponse CreateIntegrationUserRoles(CreateIntegrationUserRolesRequest req) throws TencentCloudSDKException
req
- CreateIntegrationUserRolesRequestTencentCloudSDKException
public CreateMultiFlowSignQRCodeResponse CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req) throws TencentCloudSDKException
req
- CreateMultiFlowSignQRCodeRequestTencentCloudSDKException
public CreateOrganizationBatchSignUrlResponse CreateOrganizationBatchSignUrl(CreateOrganizationBatchSignUrlRequest req) throws TencentCloudSDKException
req
- CreateOrganizationBatchSignUrlRequestTencentCloudSDKException
public CreateOrganizationInfoChangeUrlResponse CreateOrganizationInfoChangeUrl(CreateOrganizationInfoChangeUrlRequest req) throws TencentCloudSDKException
换成企业的其他员工来当超管
如果企业名称变动会引起下面的变动
req
- CreateOrganizationInfoChangeUrlRequestTencentCloudSDKException
public CreatePersonAuthCertificateImageResponse CreatePersonAuthCertificateImage(CreatePersonAuthCertificateImageRequest req) throws TencentCloudSDKException
req
- CreatePersonAuthCertificateImageRequestTencentCloudSDKException
public CreatePrepareFlowResponse CreatePrepareFlow(CreatePrepareFlowRequest req) throws TencentCloudSDKException
req
- CreatePrepareFlowRequestTencentCloudSDKException
public CreatePreparedPersonalEsignResponse CreatePreparedPersonalEsign(CreatePreparedPersonalEsignRequest req) throws TencentCloudSDKException
req
- CreatePreparedPersonalEsignRequestTencentCloudSDKException
public CreateReleaseFlowResponse CreateReleaseFlow(CreateReleaseFlowRequest req) throws TencentCloudSDKException
原合同必须签署完
成后才能发起解除协议。个人参与方不能发起解除协议
。不能更换其他第三方个人
参与解除协议。企业员工代为处理
。扣费
,扣费标准同其他类型合同。req
- CreateReleaseFlowRequestTencentCloudSDKException
public CreateSchemeUrlResponse CreateSchemeUrl(CreateSchemeUrlRequest req) throws TencentCloudSDKException
req
- CreateSchemeUrlRequestTencentCloudSDKException
public CreateSealResponse CreateSeal(CreateSealRequest req) throws TencentCloudSDKException
req
- CreateSealRequestTencentCloudSDKException
public CreateSealPolicyResponse CreateSealPolicy(CreateSealPolicyRequest req) throws TencentCloudSDKException
req
- CreateSealPolicyRequestTencentCloudSDKException
public CreateUserAutoSignEnableUrlResponse CreateUserAutoSignEnableUrl(CreateUserAutoSignEnableUrlRequest req) throws TencentCloudSDKException
req
- CreateUserAutoSignEnableUrlRequestTencentCloudSDKException
public CreateUserAutoSignSealUrlResponse CreateUserAutoSignSealUrl(CreateUserAutoSignSealUrlRequest req) throws TencentCloudSDKException
企业开通自动签
后使用。已经开通了自动签的个人
更换自动签印章。最多30天
。小程序
端。req
- CreateUserAutoSignSealUrlRequestTencentCloudSDKException
public CreateWebThemeConfigResponse CreateWebThemeConfig(CreateWebThemeConfigRequest req) throws TencentCloudSDKException
req
- CreateWebThemeConfigRequestTencentCloudSDKException
public DeleteExtendedServiceAuthInfosResponse DeleteExtendedServiceAuthInfos(DeleteExtendedServiceAuthInfosRequest req) throws TencentCloudSDKException
req
- DeleteExtendedServiceAuthInfosRequestTencentCloudSDKException
public DeleteIntegrationDepartmentResponse DeleteIntegrationDepartment(DeleteIntegrationDepartmentRequest req) throws TencentCloudSDKException
req
- DeleteIntegrationDepartmentRequestTencentCloudSDKException
public DeleteIntegrationEmployeesResponse DeleteIntegrationEmployees(DeleteIntegrationEmployeesRequest req) throws TencentCloudSDKException
req
- DeleteIntegrationEmployeesRequestTencentCloudSDKException
public DeleteIntegrationRoleUsersResponse DeleteIntegrationRoleUsers(DeleteIntegrationRoleUsersRequest req) throws TencentCloudSDKException
req
- DeleteIntegrationRoleUsersRequestTencentCloudSDKException
public DeleteSealPoliciesResponse DeleteSealPolicies(DeleteSealPoliciesRequest req) throws TencentCloudSDKException
req
- DeleteSealPoliciesRequestTencentCloudSDKException
public DescribeBillUsageDetailResponse DescribeBillUsageDetail(DescribeBillUsageDetailRequest req) throws TencentCloudSDKException
req
- DescribeBillUsageDetailRequestTencentCloudSDKException
public DescribeExtendedServiceAuthInfosResponse DescribeExtendedServiceAuthInfos(DescribeExtendedServiceAuthInfosRequest req) throws TencentCloudSDKException
req
- DescribeExtendedServiceAuthInfosRequestTencentCloudSDKException
public DescribeFileUrlsResponse DescribeFileUrls(DescribeFileUrlsRequest req) throws TencentCloudSDKException
req
- DescribeFileUrlsRequestTencentCloudSDKException
public DescribeFlowBriefsResponse DescribeFlowBriefs(DescribeFlowBriefsRequest req) throws TencentCloudSDKException
req
- DescribeFlowBriefsRequestTencentCloudSDKException
public DescribeFlowComponentsResponse DescribeFlowComponents(DescribeFlowComponentsRequest req) throws TencentCloudSDKException
req
- DescribeFlowComponentsRequestTencentCloudSDKException
public DescribeFlowEvidenceReportResponse DescribeFlowEvidenceReport(DescribeFlowEvidenceReportRequest req) throws TencentCloudSDKException
req
- DescribeFlowEvidenceReportRequestTencentCloudSDKException
public DescribeFlowInfoResponse DescribeFlowInfo(DescribeFlowInfoRequest req) throws TencentCloudSDKException
req
- DescribeFlowInfoRequestTencentCloudSDKException
public DescribeFlowTemplatesResponse DescribeFlowTemplates(DescribeFlowTemplatesRequest req) throws TencentCloudSDKException
req
- DescribeFlowTemplatesRequestTencentCloudSDKException
public DescribeIntegrationDepartmentsResponse DescribeIntegrationDepartments(DescribeIntegrationDepartmentsRequest req) throws TencentCloudSDKException
req
- DescribeIntegrationDepartmentsRequestTencentCloudSDKException
public DescribeIntegrationEmployeesResponse DescribeIntegrationEmployees(DescribeIntegrationEmployeesRequest req) throws TencentCloudSDKException
req
- DescribeIntegrationEmployeesRequestTencentCloudSDKException
public DescribeIntegrationRolesResponse DescribeIntegrationRoles(DescribeIntegrationRolesRequest req) throws TencentCloudSDKException
req
- DescribeIntegrationRolesRequestTencentCloudSDKException
public DescribeOrganizationGroupOrganizationsResponse DescribeOrganizationGroupOrganizations(DescribeOrganizationGroupOrganizationsRequest req) throws TencentCloudSDKException
req
- DescribeOrganizationGroupOrganizationsRequestTencentCloudSDKException
public DescribeOrganizationSealsResponse DescribeOrganizationSeals(DescribeOrganizationSealsRequest req) throws TencentCloudSDKException
req
- DescribeOrganizationSealsRequestTencentCloudSDKException
public DescribePersonCertificateResponse DescribePersonCertificate(DescribePersonCertificateRequest req) throws TencentCloudSDKException
req
- DescribePersonCertificateRequestTencentCloudSDKException
public DescribeThirdPartyAuthCodeResponse DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req) throws TencentCloudSDKException
req
- DescribeThirdPartyAuthCodeRequestTencentCloudSDKException
public DescribeUserAutoSignStatusResponse DescribeUserAutoSignStatus(DescribeUserAutoSignStatusRequest req) throws TencentCloudSDKException
req
- DescribeUserAutoSignStatusRequestTencentCloudSDKException
public DisableUserAutoSignResponse DisableUserAutoSign(DisableUserAutoSignRequest req) throws TencentCloudSDKException
req
- DisableUserAutoSignRequestTencentCloudSDKException
public GetTaskResultApiResponse GetTaskResultApi(GetTaskResultApiRequest req) throws TencentCloudSDKException
req
- GetTaskResultApiRequestTencentCloudSDKException
public ModifyApplicationCallbackInfoResponse ModifyApplicationCallbackInfo(ModifyApplicationCallbackInfoRequest req) throws TencentCloudSDKException
req
- ModifyApplicationCallbackInfoRequestTencentCloudSDKException
public ModifyIntegrationDepartmentResponse ModifyIntegrationDepartment(ModifyIntegrationDepartmentRequest req) throws TencentCloudSDKException
req
- ModifyIntegrationDepartmentRequestTencentCloudSDKException
public ModifyIntegrationRoleResponse ModifyIntegrationRole(ModifyIntegrationRoleRequest req) throws TencentCloudSDKException
req
- ModifyIntegrationRoleRequestTencentCloudSDKException
public StartFlowResponse StartFlow(StartFlowRequest req) throws TencentCloudSDKException
req
- StartFlowRequestTencentCloudSDKException
public UnbindEmployeeUserIdWithClientOpenIdResponse UnbindEmployeeUserIdWithClientOpenId(UnbindEmployeeUserIdWithClientOpenIdRequest req) throws TencentCloudSDKException
req
- UnbindEmployeeUserIdWithClientOpenIdRequestTencentCloudSDKException
public UpdateIntegrationEmployeesResponse UpdateIntegrationEmployees(UpdateIntegrationEmployeesRequest req) throws TencentCloudSDKException
req
- UpdateIntegrationEmployeesRequestTencentCloudSDKException
public UploadFilesResponse UploadFiles(UploadFilesRequest req) throws TencentCloudSDKException
req
- UploadFilesRequestTencentCloudSDKException
public VerifyPdfResponse VerifyPdf(VerifyPdfRequest req) throws TencentCloudSDKException
req
- VerifyPdfRequestTencentCloudSDKException
Copyright © 2023. All rights reserved.