public class EssbasicClient extends AbstractClient
gson, HTTP_RSP_OK, SDK_VERSION| Constructor and Description |
|---|
EssbasicClient(Credential credential,
String region) |
EssbasicClient(Credential credential,
String region,
ClientProfile profile) |
| Modifier and Type | Method and Description |
|---|---|
ChannelBatchCancelFlowsResponse |
ChannelBatchCancelFlows(ChannelBatchCancelFlowsRequest req)
指定需要批量撤销的签署流程Id，批量撤销合同
客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
可以撤回：未全部签署完成
不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
满足撤销条件的合同会发起异步撤销流程，不满足撤销条件的合同返回失败原因。**
合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
注意:
能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
|
ChannelCancelFlowResponse |
ChannelCancelFlow(ChannelCancelFlowRequest req)
撤销签署流程接口
适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
`可撤回合同状态` ：未全部签署完成
`不撤回合同状态` ：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
注:
能撤回合同的只能是 `合同的发起人或者发起方企业的超管、法人`
签署完毕的合同需要双方走解除流程将合同作废，可以参考发起解除合同流程接口。
|
ChannelCancelMultiFlowSignQRCodeResponse |
ChannelCancelMultiFlowSignQRCode(ChannelCancelMultiFlowSignQRCodeRequest req)
此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
|
ChannelCancelUserAutoSignEnableUrlResponse |
ChannelCancelUserAutoSignEnableUrl(ChannelCancelUserAutoSignEnableUrlRequest req)
此接口（ChannelCancelUserAutoSignEnableUrl）用来撤销发送给个人用户的自动签开通链接，撤销后对应的个人用户开通链接失效。若个人用户已经完成开通，将无法撤销。（处方单场景专用，使用此接口请与客户经理确认）
|
ChannelCreateBatchCancelFlowUrlResponse |
ChannelCreateBatchCancelFlowUrl(ChannelCreateBatchCancelFlowUrlRequest req)
指定需要批量撤销的签署流程Id，获取批量撤销链接 - 不建议使用此接口，可使用ChannelBatchCancelFlows
客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销;
可以撤回：未全部签署完成
不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
注意:
能撤回合同的只能是合同的发起人或者发起企业的超管、法人
|
ChannelCreateBatchSignUrlResponse |
ChannelCreateBatchSignUrl(ChannelCreateBatchSignUrlRequest req)
通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。
请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
注：
- 参与人点击链接后需短信验证码才能查看合同内容。
- 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。
- 个人批量签署，签名区`仅支持手写签名`。
|
ChannelCreateBoundFlowsResponse |
ChannelCreateBoundFlows(ChannelCreateBoundFlowsRequest req)
此接口（ChannelCreateBoundFlows）用于子客领取合同，经办人需要有相应的角色，合同不能重复领取。
|
ChannelCreateConvertTaskApiResponse |
ChannelCreateConvertTaskApi(ChannelCreateConvertTaskApiRequest req)
上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
|
ChannelCreateEmbedWebUrlResponse |
ChannelCreateEmbedWebUrl(ChannelCreateEmbedWebUrlRequest req)
本接口（ChannelCreateEmbedWebUrl）用于创建常规模块嵌入web的链接
本接口支持创建：创建印章，创建模板，修改模板，预览模板，预览合同流程的web链接
进入web连接后与当前控制台操作保持一致
|
ChannelCreateFlowApproversResponse |
ChannelCreateFlowApprovers(ChannelCreateFlowApproversRequest req)
适用场景：
当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口动态补充签署人。同一签署人只允许补充一人，最终实际签署人取决于谁先领取合同完成签署。
限制条件：
1.
|
ChannelCreateFlowByFilesResponse |
ChannelCreateFlowByFiles(ChannelCreateFlowByFilesRequest req)
接口（ChannelCreateFlowByFiles）用PDF文件创建签署流程。
适用场景：适用非制式的合同文件签署，开发者有每个签署流程的PDF，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
注**:
此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。
此接口需要依赖文件上传接口生成pdf资源编号（FileIds）进行使用。整体的逻辑如下图
可以作为发起方和签署方的角色列表**
场景编号
可作为发起方类型
可作为签署方的类型
场景一
第三方子企业A员工
第三方子企业A员工
场景二
第三方子企业A员工
第三方子企业B(不指定经办人)
场景三
第三方子企业A员工
第三方子企业B员工
场景四
第三方子企业A员工
个人/自然人
场景五
第三方子企业A员工
SaaS平台企业员工
注**:
`1.
|
ChannelCreateFlowGroupByFilesResponse |
ChannelCreateFlowGroupByFiles(ChannelCreateFlowGroupByFilesRequest req)
接口（ChannelCreateFlowGroupByFiles）用于使用 PDF 文件创建合同组签署流程。
合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
注**:
此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。
合同组暂不支持抄送功能
此接口需要依赖文件上传接口生成pdf资源编号（FileIds）进行使用。
可以作为发起方和签署方的角色列表**
场景编号
可作为发起方类型
可作为签署方的类型
场景一
第三方子企业A员工
第三方子企业A员工
场景二
第三方子企业A员工
第三方子企业B(不指定经办人)
场景三
第三方子企业A员工
第三方子企业B员工
场景四
第三方子企业A员工
个人/自然人
场景五
第三方子企业A员工
SaaS平台企业员工
注**:
`1.
|
ChannelCreateFlowGroupByTemplatesResponse |
ChannelCreateFlowGroupByTemplates(ChannelCreateFlowGroupByTemplatesRequest req)
接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
注**:
此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。
合同组暂不支持抄送功能
可以作为发起方和签署方的角色列表**
场景编号
可作为发起方类型
可作为签署方的类型
场景一
第三方子企业A员工
第三方子企业A员工
场景二
第三方子企业A员工
第三方子企业B(不指定经办人)
场景三
第三方子企业A员工
第三方子企业B员工
场景四
第三方子企业A员工
个人/自然人
场景五
第三方子企业A员工
SaaS平台企业员工
注**:
`1.
|
ChannelCreateFlowRemindsResponse |
ChannelCreateFlowReminds(ChannelCreateFlowRemindsRequest req)
指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
1.
|
ChannelCreateFlowSignReviewResponse |
ChannelCreateFlowSignReview(ChannelCreateFlowSignReviewRequest req)
提交企业流程审批结果
目前存在两种审核操作，签署审核，发起审核
签署审核：通过接口（CreateFlowsByTemplates或ChannelCreateFlowByFiles或ChannelCreatePrepareFlow）发起签署流程后，若指定了参数 NeedSignReview 为true,则可以调用此接口，指定operate=SignReview，提交企业内部签署审批结果；若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效
发起审核：通过接口ChannelCreatePrepareFlow指定发起后需要审核，则可以通过调用此接口，指定operate=CreateReview，提交企业内部审批结果，可多次提交，当通过后，后续提交结果无效
|
ChannelCreateFlowSignUrlResponse |
ChannelCreateFlowSignUrl(ChannelCreateFlowSignUrlRequest req)
创建个人签署H5签署链接，请联系客户经理申请使用
该接口用于发起合同后，生成C端签署人的签署链接 注意：该接口目前签署人类型仅支持个人签署方（PERSON） 注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件 注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式 |
ChannelCreateMultiFlowSignQRCodeResponse |
ChannelCreateMultiFlowSignQRCode(ChannelCreateMultiFlowSignQRCodeRequest req)
此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
本接口适用于发起方没有填写控件的 B2C或者单C模板**
若是B2C模板,还要满足以下任意一个条件**
- 模板中配置的签署顺序是无序
- B端企业的签署方式是静默签署
- B端企业是非首位签署
通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/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)
|
ChannelCreateOrganizationBatchSignUrlResponse |
ChannelCreateOrganizationBatchSignUrl(ChannelCreateOrganizationBatchSignUrlRequest req)
通过此接口，创建小程序批量签署链接，可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
注：
- 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方或者领取方。
- 仅支持传入待签署或者待领取的合同，待填写暂不支持。
- 员工批量签署，支持多种签名方式，包括手写签名、临摹签名、系统签名、个人印章，暂不支持签批控件
|
ChannelCreateOrganizationModifyQrCodeResponse |
ChannelCreateOrganizationModifyQrCode(ChannelCreateOrganizationModifyQrCodeRequest req)
生成渠道子客编辑企业信息二维码
|
ChannelCreatePreparedPersonalEsignResponse |
ChannelCreatePreparedPersonalEsign(ChannelCreatePreparedPersonalEsignRequest req)
本接口（ChannelCreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，使用此接口请与客户经理确认）。
|
ChannelCreatePrepareFlowResponse |
ChannelCreatePrepareFlow(ChannelCreatePrepareFlowRequest req)
创建预发起合同
通过此接口指定：合同，签署人，填写控件信息，生成预创建合同链接，点击后跳转到web页面完成合同创建并发起
可指定合同信息不可更改，签署人信息不可更改
合同发起后，填写及签署流程与现有操作流程一致
注意：目前仅支持模板发起
|
ChannelCreateReleaseFlowResponse |
ChannelCreateReleaseFlow(ChannelCreateReleaseFlowRequest req)
发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。
合同发起人必须在电子签已经进行实名。
|
ChannelCreateRoleResponse |
ChannelCreateRole(ChannelCreateRoleRequest req)
此接口（ChannelCreateRole）用来创建企业自定义角色。
适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
ChannelCreateSealPolicyResponse |
ChannelCreateSealPolicy(ChannelCreateSealPolicyRequest req)
将指定印章授权给第三方平台子客企业下的某些员工
|
ChannelCreateUserAutoSignEnableUrlResponse |
ChannelCreateUserAutoSignEnableUrl(ChannelCreateUserAutoSignEnableUrlRequest req)
企业方可以通过此接口获取个人用户开启自动签的跳转链接
|
ChannelCreateUserAutoSignSealUrlResponse |
ChannelCreateUserAutoSignSealUrl(ChannelCreateUserAutoSignSealUrlRequest req)
获取设置自动签印章小程序链接。
注意：
需要
企业开通自动签后使用。
仅支持已经开通了自动签的个人更换自动签印章。
链接有效期默认7天，最多30天。
该接口的链接适用于小程序端。
该接口不会扣除您的合同套餐，暂不参与计费。 |
ChannelCreateUserRolesResponse |
ChannelCreateUserRoles(ChannelCreateUserRolesRequest req)
通过此接口，绑定员工角色，支持以电子签userId、客户系统userId两种方式调用。
|
ChannelCreateWebThemeConfigResponse |
ChannelCreateWebThemeConfig(ChannelCreateWebThemeConfigRequest req)
用来创建嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），该接口配合其他所有可嵌入页面接口使用
创建配置对当前第三方应用全局生效，如果多次调用，会以最后一次的配置为准
|
ChannelDeleteRoleResponse |
ChannelDeleteRole(ChannelDeleteRoleRequest req)
此接口（ChannelDeleteRole）用来删除企业自定义角色。
注意：系统角色不可删除。
|
ChannelDeleteRoleUsersResponse |
ChannelDeleteRoleUsers(ChannelDeleteRoleUsersRequest req)
通过此接口，删除员工绑定的角色，支持以电子签userId、客户系统userId两种方式调用。
|
ChannelDeleteSealPoliciesResponse |
ChannelDeleteSealPolicies(ChannelDeleteSealPoliciesRequest req)
删除指定印章下多个授权信息
|
ChannelDescribeEmployeesResponse |
ChannelDescribeEmployees(ChannelDescribeEmployeesRequest req)
查询企业员工列表
|
ChannelDescribeFlowComponentsResponse |
ChannelDescribeFlowComponents(ChannelDescribeFlowComponentsRequest req)
查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
|
ChannelDescribeOrganizationSealsResponse |
ChannelDescribeOrganizationSeals(ChannelDescribeOrganizationSealsRequest req)
查询子客企业电子印章，需要操作者具有管理印章权限
客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数，只返回启用的印章。
|
ChannelDescribeRolesResponse |
ChannelDescribeRoles(ChannelDescribeRolesRequest req)
分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。
相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355
|
ChannelDescribeUserAutoSignStatusResponse |
ChannelDescribeUserAutoSignStatus(ChannelDescribeUserAutoSignStatusRequest req)
企业方可以通过此接口查询个人用户自动签开启状态
|
ChannelDisableUserAutoSignResponse |
ChannelDisableUserAutoSign(ChannelDisableUserAutoSignRequest req)
企业方可以通过此接口关闭个人的自动签功能
|
ChannelGetTaskResultApiResponse |
ChannelGetTaskResultApi(ChannelGetTaskResultApiRequest req)
查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。
注意：大文件转换所需的时间可能会比较长。
|
ChannelModifyRoleResponse |
ChannelModifyRole(ChannelModifyRoleRequest req)
此接口（ChannelModifyRole）用来更新企业自定义角色。
适用场景1：更新当前企业的自定义角色的名称或描述等其他信息，更新时不进行权限的设置（PermissionGroups 参数不传）。
适用场景2：更新当前企业的自定义角色的权限信息，更新时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
ChannelUpdateSealStatusResponse |
ChannelUpdateSealStatus(ChannelUpdateSealStatusRequest req)
本接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态
|
ChannelVerifyPdfResponse |
ChannelVerifyPdf(ChannelVerifyPdfRequest req)
对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。
|
CreateChannelFlowEvidenceReportResponse |
CreateChannelFlowEvidenceReport(CreateChannelFlowEvidenceReportRequest req)
提交申请出证报告任务并返回报告ID。
注意：
使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。
操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。
合同流程必须所有参与方`已经签署完成`。
出证过程需一定时间，建议在`提交出证任务后的24小时之后`，通过获取出证报告任务执行结果接口进行查询执行结果和出证报告的下载URL。
|
CreateChannelOrganizationInfoChangeUrlResponse |
CreateChannelOrganizationInfoChangeUrl(CreateChannelOrganizationInfoChangeUrlRequest req)
此接口（CreateChannelOrganizationInfoChangeUrl）用于创建子客企业信息变更链接（需要在移动端打开，会跳转到微信小程序），支持创建企业超管变更链接或企业基础信息变更链接，通过入参 ChangeType 指定。
1. |
CreateConsoleLoginUrlResponse |
CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req)
此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。
Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态，进入不同的流程，主要情况分类如下：
子客企业状态
子客企业员工状态
点击链接进入的流程
企业未激活
员工未认证
进入企业激活流程，首次完成企业激活流程的员工会成为超管
企业已激活
员工未认证
进入员认证并加入企业流程
企业已激活
员工已认证
进入子客企业Web控制台
如果是企业激活流程，需要注意如下情况：
1.
|
CreateFlowsByTemplatesResponse |
CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req)
接口（CreateFlowsByTemplates）用于使用模板批量创建签署流程。当前可批量发起合同（签署流程）数量为1-20个。
如若在模板中配置了动态表格, 上传的附件必须为A4大小
合同发起人必须在电子签已经进行实名。
整体的逻辑如下**
可以作为发起方和签署方的角色列表**
场景编号
可作为发起方类型
可作为签署方的类型
场景一
第三方子企业A员工
第三方子企业A员工
场景二
第三方子企业A员工
第三方子企业B(不指定经办人)
场景三
第三方子企业A员工
第三方子企业B员工
场景四
第三方子企业A员工
个人/自然人
场景五
第三方子企业A员工
SaaS平台企业员工
注**:
`1.
|
CreateSealByImageResponse |
CreateSealByImage(CreateSealByImageRequest req)
1.
|
CreateSignUrlsResponse |
CreateSignUrls(CreateSignUrlsRequest req)
创建跳转小程序查看或签署的链接
腾讯电子签小程序的的AppID 和 原始Id如下:**
| 小程序 | AppID | 原始ID |
| ------------ | ------------ | ------------ |
| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
主要使用场景可以更加EndPoint分类如下**
|EndPoint| 场景| 说明和示例|
| ---- | ---- | --- |
| WEIXINAPP | 短链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序（与腾讯电子签官方短信提醒用户签署形式一样）
示例: https://essurl.cn/x9nvWU8fTg| | LONGURL2WEIXINAPP | 长链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链| | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl 示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd | |APP| 贵方APP跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景 跳转到腾讯电子签小程序的实现可以参考微信的官方文档:开放能力/打开 App 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 | |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景 跳转到腾讯电子签小程序的实现可以参考微信官方文档全屏方式和半屏方式 此时返回的SignUrl就是官方文档中的path 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 | |
DescribeChannelFlowEvidenceReportResponse |
DescribeChannelFlowEvidenceReport(DescribeChannelFlowEvidenceReportRequest req)
查询出证报告，返回报告 URL。
|
DescribeExtendedServiceAuthInfoResponse |
DescribeExtendedServiceAuthInfo(DescribeExtendedServiceAuthInfoRequest req)
查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
1.
|
DescribeFlowDetailInfoResponse |
DescribeFlowDetailInfo(DescribeFlowDetailInfoRequest req)
此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
|
DescribeResourceUrlsByFlowsResponse |
DescribeResourceUrlsByFlows(DescribeResourceUrlsByFlowsRequest req)
获取合同流程PDF的下载链接，可以下载签署中、签署完的此子企业创建的合同
注意**:
有两种开通权限的途径
第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
|
DescribeTemplatesResponse |
DescribeTemplates(DescribeTemplatesRequest req)
通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。
> **适用场景**
>
> 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。
> 一个模板通常会包含以下结构信息
>- 模板基本信息
>- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
>- 填写控件 Components
>- 签署控件 SignComponents
>- 生成模板的文件基础信息 FileInfos
|
DescribeUsageResponse |
DescribeUsage(DescribeUsageRequest req)
此接口（DescribeUsage）用于获取第三方平台所有合作企业流量消耗情况。
注: 此接口每日限频50次，若要扩大限制次数,请提前与客服经理或邮件至[email protected]进行联系。
|
GetDownloadFlowUrlResponse |
GetDownloadFlowUrl(GetDownloadFlowUrlRequest req)
此接口（GetDownloadFlowUrl）用户获取合同控制台下载页面链接, 点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击**下载**按钮后就会下载传入的合同列表, 下载页面如下图
注:
仅支持下载 **本企业** 下合同，链接会 **登录企业控制台**
**链接仅可使用一次**，不可重复使用
|
ModifyExtendedServiceResponse |
ModifyExtendedService(ModifyExtendedServiceRequest req)
修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。
跳转小程序的几种方式：主要是设置不同的EndPoint
1.
|
OperateChannelTemplateResponse |
OperateChannelTemplate(OperateChannelTemplateRequest req)
此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。
> **使用场景**
>
> 1：查询 OperateType=SELECT
> - 查询第三方应用平台模板库的可见性以及授权的子客列表。
>
> 2：修改部分子客授权 OperateType=UPDATE
> - 对子客企业进行模板库中模板可见性的进行修改操作。
>- 当模板未发布时，可以修改可见性AuthTag（part/all），当模板发布后，不可做此修改
> - 若模板已发布且可见性AuthTag是part，可以通过ProxyOrganizationOpenIds增加子客的授权范围。如果是自动领取的模板，增加授权范围后会自动下发。
>
> 3：取消部分子客授权 OperateType=DELETE
> - 对子客企业进行模板库中模板可见性的进行删除操作。
> - 主要对于手动领取的模板，去除授权后子客在模板库中看不到，就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
> - 对于自动领取的模板，由于已经下发，更改授权不会影响。
> - 如果要同步删除子客自有模板库中的模板，请使用OperateType=UPDATE+Available参数处理。
|
PrepareFlowsResponse |
PrepareFlows(PrepareFlowsRequest req)
该接口 (PrepareFlows) 用于创建待发起文件
用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
目前该接口只支持B2C，不建议使用，将会废弃。
|
SyncProxyOrganizationResponse |
SyncProxyOrganization(SyncProxyOrganizationRequest req)
此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称，企业营业执照，企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意：
1.
|
SyncProxyOrganizationOperatorsResponse |
SyncProxyOrganizationOperators(SyncProxyOrganizationOperatorsRequest req)
此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。
若经办人信息有误，或者需要修改，也可以先将之前的经办人做离职操作，然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
|
UploadFilesResponse |
UploadFiles(UploadFilesRequest req)
此接口（UploadFiles）文件上传。
适用场景：用于合同，印章的文件上传。文件上传以后， 如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起 如果是其他类型可以配合创建文件转换任务接口转换成PDF文件 注: 1. |
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreakerpublic EssbasicClient(Credential credential, String region)
public EssbasicClient(Credential credential, String region, ClientProfile profile)
public ChannelBatchCancelFlowsResponse ChannelBatchCancelFlows(ChannelBatchCancelFlowsRequest req) throws TencentCloudSDKException
req - ChannelBatchCancelFlowsRequestTencentCloudSDKExceptionpublic ChannelCancelFlowResponse ChannelCancelFlow(ChannelCancelFlowRequest req) throws TencentCloudSDKException
req - ChannelCancelFlowRequestTencentCloudSDKExceptionpublic ChannelCancelMultiFlowSignQRCodeResponse ChannelCancelMultiFlowSignQRCode(ChannelCancelMultiFlowSignQRCodeRequest req) throws TencentCloudSDKException
req - ChannelCancelMultiFlowSignQRCodeRequestTencentCloudSDKExceptionpublic ChannelCancelUserAutoSignEnableUrlResponse ChannelCancelUserAutoSignEnableUrl(ChannelCancelUserAutoSignEnableUrlRequest req) throws TencentCloudSDKException
req - ChannelCancelUserAutoSignEnableUrlRequestTencentCloudSDKExceptionpublic ChannelCreateBatchCancelFlowUrlResponse ChannelCreateBatchCancelFlowUrl(ChannelCreateBatchCancelFlowUrlRequest req) throws TencentCloudSDKException
req - ChannelCreateBatchCancelFlowUrlRequestTencentCloudSDKExceptionpublic ChannelCreateBatchSignUrlResponse ChannelCreateBatchSignUrl(ChannelCreateBatchSignUrlRequest req) throws TencentCloudSDKException
req - ChannelCreateBatchSignUrlRequestTencentCloudSDKExceptionpublic ChannelCreateBoundFlowsResponse ChannelCreateBoundFlows(ChannelCreateBoundFlowsRequest req) throws TencentCloudSDKException
req - ChannelCreateBoundFlowsRequestTencentCloudSDKExceptionpublic ChannelCreateConvertTaskApiResponse ChannelCreateConvertTaskApi(ChannelCreateConvertTaskApiRequest req) throws TencentCloudSDKException
req - ChannelCreateConvertTaskApiRequestTencentCloudSDKExceptionpublic ChannelCreateEmbedWebUrlResponse ChannelCreateEmbedWebUrl(ChannelCreateEmbedWebUrlRequest req) throws TencentCloudSDKException
req - ChannelCreateEmbedWebUrlRequestTencentCloudSDKExceptionpublic ChannelCreateFlowApproversResponse ChannelCreateFlowApprovers(ChannelCreateFlowApproversRequest req) throws TencentCloudSDKException
req - ChannelCreateFlowApproversRequestTencentCloudSDKExceptionpublic ChannelCreateFlowByFilesResponse ChannelCreateFlowByFiles(ChannelCreateFlowByFilesRequest req) throws TencentCloudSDKException
| 场景编号 | 可作为发起方类型 | 可作为签署方的类型 |
|---|---|---|
| 场景一 | 第三方子企业A员工 | 第三方子企业A员工 |
| 场景二 | 第三方子企业A员工 | 第三方子企业B(不指定经办人) |
| 场景三 | 第三方子企业A员工 | 第三方子企业B员工 |
| 场景四 | 第三方子企业A员工 | 个人/自然人 |
| 场景五 | 第三方子企业A员工 | SaaS平台企业员工 |
req - ChannelCreateFlowByFilesRequestTencentCloudSDKExceptionpublic ChannelCreateFlowGroupByFilesResponse ChannelCreateFlowGroupByFiles(ChannelCreateFlowGroupByFilesRequest req) throws TencentCloudSDKException
| 场景编号 | 可作为发起方类型 | 可作为签署方的类型 |
|---|---|---|
| 场景一 | 第三方子企业A员工 | 第三方子企业A员工 |
| 场景二 | 第三方子企业A员工 | 第三方子企业B(不指定经办人) |
| 场景三 | 第三方子企业A员工 | 第三方子企业B员工 |
| 场景四 | 第三方子企业A员工 | 个人/自然人 |
| 场景五 | 第三方子企业A员工 | SaaS平台企业员工 |
req - ChannelCreateFlowGroupByFilesRequestTencentCloudSDKExceptionpublic ChannelCreateFlowGroupByTemplatesResponse ChannelCreateFlowGroupByTemplates(ChannelCreateFlowGroupByTemplatesRequest req) throws TencentCloudSDKException
| 场景编号 | 可作为发起方类型 | 可作为签署方的类型 |
|---|---|---|
| 场景一 | 第三方子企业A员工 | 第三方子企业A员工 |
| 场景二 | 第三方子企业A员工 | 第三方子企业B(不指定经办人) |
| 场景三 | 第三方子企业A员工 | 第三方子企业B员工 |
| 场景四 | 第三方子企业A员工 | 个人/自然人 |
| 场景五 | 第三方子企业A员工 | SaaS平台企业员工 |
req - ChannelCreateFlowGroupByTemplatesRequestTencentCloudSDKExceptionpublic ChannelCreateFlowRemindsResponse ChannelCreateFlowReminds(ChannelCreateFlowRemindsRequest req) throws TencentCloudSDKException
req - ChannelCreateFlowRemindsRequestTencentCloudSDKExceptionpublic ChannelCreateFlowSignReviewResponse ChannelCreateFlowSignReview(ChannelCreateFlowSignReviewRequest req) throws TencentCloudSDKException
req - ChannelCreateFlowSignReviewRequestTencentCloudSDKExceptionpublic ChannelCreateFlowSignUrlResponse ChannelCreateFlowSignUrl(ChannelCreateFlowSignUrlRequest req) throws TencentCloudSDKException
req - ChannelCreateFlowSignUrlRequestTencentCloudSDKExceptionpublic ChannelCreateMultiFlowSignQRCodeResponse ChannelCreateMultiFlowSignQRCode(ChannelCreateMultiFlowSignQRCodeRequest req) throws TencentCloudSDKException
req - ChannelCreateMultiFlowSignQRCodeRequestTencentCloudSDKExceptionpublic ChannelCreateOrganizationBatchSignUrlResponse ChannelCreateOrganizationBatchSignUrl(ChannelCreateOrganizationBatchSignUrlRequest req) throws TencentCloudSDKException
req - ChannelCreateOrganizationBatchSignUrlRequestTencentCloudSDKExceptionpublic ChannelCreateOrganizationModifyQrCodeResponse ChannelCreateOrganizationModifyQrCode(ChannelCreateOrganizationModifyQrCodeRequest req) throws TencentCloudSDKException
req - ChannelCreateOrganizationModifyQrCodeRequestTencentCloudSDKExceptionpublic ChannelCreatePrepareFlowResponse ChannelCreatePrepareFlow(ChannelCreatePrepareFlowRequest req) throws TencentCloudSDKException
req - ChannelCreatePrepareFlowRequestTencentCloudSDKExceptionpublic ChannelCreatePreparedPersonalEsignResponse ChannelCreatePreparedPersonalEsign(ChannelCreatePreparedPersonalEsignRequest req) throws TencentCloudSDKException
req - ChannelCreatePreparedPersonalEsignRequestTencentCloudSDKExceptionpublic ChannelCreateReleaseFlowResponse ChannelCreateReleaseFlow(ChannelCreateReleaseFlowRequest req) throws TencentCloudSDKException
req - ChannelCreateReleaseFlowRequestTencentCloudSDKExceptionpublic ChannelCreateRoleResponse ChannelCreateRole(ChannelCreateRoleRequest req) throws TencentCloudSDKException
req - ChannelCreateRoleRequestTencentCloudSDKExceptionpublic ChannelCreateSealPolicyResponse ChannelCreateSealPolicy(ChannelCreateSealPolicyRequest req) throws TencentCloudSDKException
req - ChannelCreateSealPolicyRequestTencentCloudSDKExceptionpublic ChannelCreateUserAutoSignEnableUrlResponse ChannelCreateUserAutoSignEnableUrl(ChannelCreateUserAutoSignEnableUrlRequest req) throws TencentCloudSDKException
req - ChannelCreateUserAutoSignEnableUrlRequestTencentCloudSDKExceptionpublic ChannelCreateUserAutoSignSealUrlResponse ChannelCreateUserAutoSignSealUrl(ChannelCreateUserAutoSignSealUrlRequest req) throws TencentCloudSDKException
企业开通自动签后使用。已经开通了自动签的个人更换自动签印章。最多30天。小程序端。req - ChannelCreateUserAutoSignSealUrlRequestTencentCloudSDKExceptionpublic ChannelCreateUserRolesResponse ChannelCreateUserRoles(ChannelCreateUserRolesRequest req) throws TencentCloudSDKException
req - ChannelCreateUserRolesRequestTencentCloudSDKExceptionpublic ChannelCreateWebThemeConfigResponse ChannelCreateWebThemeConfig(ChannelCreateWebThemeConfigRequest req) throws TencentCloudSDKException
req - ChannelCreateWebThemeConfigRequestTencentCloudSDKExceptionpublic ChannelDeleteRoleResponse ChannelDeleteRole(ChannelDeleteRoleRequest req) throws TencentCloudSDKException
req - ChannelDeleteRoleRequestTencentCloudSDKExceptionpublic ChannelDeleteRoleUsersResponse ChannelDeleteRoleUsers(ChannelDeleteRoleUsersRequest req) throws TencentCloudSDKException
req - ChannelDeleteRoleUsersRequestTencentCloudSDKExceptionpublic ChannelDeleteSealPoliciesResponse ChannelDeleteSealPolicies(ChannelDeleteSealPoliciesRequest req) throws TencentCloudSDKException
req - ChannelDeleteSealPoliciesRequestTencentCloudSDKExceptionpublic ChannelDescribeEmployeesResponse ChannelDescribeEmployees(ChannelDescribeEmployeesRequest req) throws TencentCloudSDKException
req - ChannelDescribeEmployeesRequestTencentCloudSDKExceptionpublic ChannelDescribeFlowComponentsResponse ChannelDescribeFlowComponents(ChannelDescribeFlowComponentsRequest req) throws TencentCloudSDKException
req - ChannelDescribeFlowComponentsRequestTencentCloudSDKExceptionpublic ChannelDescribeOrganizationSealsResponse ChannelDescribeOrganizationSeals(ChannelDescribeOrganizationSealsRequest req) throws TencentCloudSDKException
req - ChannelDescribeOrganizationSealsRequestTencentCloudSDKExceptionpublic ChannelDescribeRolesResponse ChannelDescribeRoles(ChannelDescribeRolesRequest req) throws TencentCloudSDKException
req - ChannelDescribeRolesRequestTencentCloudSDKExceptionpublic ChannelDescribeUserAutoSignStatusResponse ChannelDescribeUserAutoSignStatus(ChannelDescribeUserAutoSignStatusRequest req) throws TencentCloudSDKException
req - ChannelDescribeUserAutoSignStatusRequestTencentCloudSDKExceptionpublic ChannelDisableUserAutoSignResponse ChannelDisableUserAutoSign(ChannelDisableUserAutoSignRequest req) throws TencentCloudSDKException
req - ChannelDisableUserAutoSignRequestTencentCloudSDKExceptionpublic ChannelGetTaskResultApiResponse ChannelGetTaskResultApi(ChannelGetTaskResultApiRequest req) throws TencentCloudSDKException
req - ChannelGetTaskResultApiRequestTencentCloudSDKExceptionpublic ChannelModifyRoleResponse ChannelModifyRole(ChannelModifyRoleRequest req) throws TencentCloudSDKException
req - ChannelModifyRoleRequestTencentCloudSDKExceptionpublic ChannelUpdateSealStatusResponse ChannelUpdateSealStatus(ChannelUpdateSealStatusRequest req) throws TencentCloudSDKException
req - ChannelUpdateSealStatusRequestTencentCloudSDKExceptionpublic ChannelVerifyPdfResponse ChannelVerifyPdf(ChannelVerifyPdfRequest req) throws TencentCloudSDKException
req - ChannelVerifyPdfRequestTencentCloudSDKExceptionpublic CreateChannelFlowEvidenceReportResponse CreateChannelFlowEvidenceReport(CreateChannelFlowEvidenceReportRequest req) throws TencentCloudSDKException
req - CreateChannelFlowEvidenceReportRequestTencentCloudSDKExceptionpublic CreateChannelOrganizationInfoChangeUrlResponse CreateChannelOrganizationInfoChangeUrl(CreateChannelOrganizationInfoChangeUrlRequest req) throws TencentCloudSDKException
换成企业的其他员工来当超管
如果企业名称变动会引起下面的变动
req - CreateChannelOrganizationInfoChangeUrlRequestTencentCloudSDKExceptionpublic CreateConsoleLoginUrlResponse CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req) throws TencentCloudSDKException
| 子客企业状态 | 子客企业员工状态 | 点击链接进入的流程 |
|---|---|---|
| 企业未激活 | 员工未认证 | 进入企业激活流程，首次完成企业激活流程的员工会成为超管 |
| 企业已激活 | 员工未认证 | 进入员认证并加入企业流程 |
| 企业已激活 | 员工已认证 | 进入子客企业Web控制台 |
req - CreateConsoleLoginUrlRequestTencentCloudSDKExceptionpublic CreateFlowsByTemplatesResponse CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req) throws TencentCloudSDKException
| 场景编号 | 可作为发起方类型 | 可作为签署方的类型 |
|---|---|---|
| 场景一 | 第三方子企业A员工 | 第三方子企业A员工 |
| 场景二 | 第三方子企业A员工 | 第三方子企业B(不指定经办人) |
| 场景三 | 第三方子企业A员工 | 第三方子企业B员工 |
| 场景四 | 第三方子企业A员工 | 个人/自然人 |
| 场景五 | 第三方子企业A员工 | SaaS平台企业员工 |
req - CreateFlowsByTemplatesRequestTencentCloudSDKExceptionpublic CreateSealByImageResponse CreateSealByImage(CreateSealByImageRequest req) throws TencentCloudSDKException
req - CreateSealByImageRequestTencentCloudSDKExceptionpublic CreateSignUrlsResponse CreateSignUrls(CreateSignUrlsRequest req) throws TencentCloudSDKException
req - CreateSignUrlsRequestTencentCloudSDKExceptionpublic DescribeChannelFlowEvidenceReportResponse DescribeChannelFlowEvidenceReport(DescribeChannelFlowEvidenceReportRequest req) throws TencentCloudSDKException
req - DescribeChannelFlowEvidenceReportRequestTencentCloudSDKExceptionpublic DescribeExtendedServiceAuthInfoResponse DescribeExtendedServiceAuthInfo(DescribeExtendedServiceAuthInfoRequest req) throws TencentCloudSDKException
req - DescribeExtendedServiceAuthInfoRequestTencentCloudSDKExceptionpublic DescribeFlowDetailInfoResponse DescribeFlowDetailInfo(DescribeFlowDetailInfoRequest req) throws TencentCloudSDKException
req - DescribeFlowDetailInfoRequestTencentCloudSDKExceptionpublic DescribeResourceUrlsByFlowsResponse DescribeResourceUrlsByFlows(DescribeResourceUrlsByFlowsRequest req) throws TencentCloudSDKException
req - DescribeResourceUrlsByFlowsRequestTencentCloudSDKExceptionpublic DescribeTemplatesResponse DescribeTemplates(DescribeTemplatesRequest req) throws TencentCloudSDKException
req - DescribeTemplatesRequestTencentCloudSDKExceptionpublic DescribeUsageResponse DescribeUsage(DescribeUsageRequest req) throws TencentCloudSDKException
req - DescribeUsageRequestTencentCloudSDKExceptionpublic GetDownloadFlowUrlResponse GetDownloadFlowUrl(GetDownloadFlowUrlRequest req) throws TencentCloudSDKException
req - GetDownloadFlowUrlRequestTencentCloudSDKExceptionpublic ModifyExtendedServiceResponse ModifyExtendedService(ModifyExtendedServiceRequest req) throws TencentCloudSDKException
req - ModifyExtendedServiceRequestTencentCloudSDKExceptionpublic OperateChannelTemplateResponse OperateChannelTemplate(OperateChannelTemplateRequest req) throws TencentCloudSDKException
req - OperateChannelTemplateRequestTencentCloudSDKExceptionpublic PrepareFlowsResponse PrepareFlows(PrepareFlowsRequest req) throws TencentCloudSDKException
req - PrepareFlowsRequestTencentCloudSDKExceptionpublic SyncProxyOrganizationResponse SyncProxyOrganization(SyncProxyOrganizationRequest req) throws TencentCloudSDKException
req - SyncProxyOrganizationRequestTencentCloudSDKExceptionpublic SyncProxyOrganizationOperatorsResponse SyncProxyOrganizationOperators(SyncProxyOrganizationOperatorsRequest req) throws TencentCloudSDKException
req - SyncProxyOrganizationOperatorsRequestTencentCloudSDKExceptionpublic UploadFilesResponse UploadFiles(UploadFilesRequest req) throws TencentCloudSDKException
req - UploadFilesRequestTencentCloudSDKExceptionCopyright © 2023. All rights reserved.