Package com.tencentcloudapi.essbasic.v20210526

Class EssbasicClient

    • Method Detail

      • ChannelBatchCancelFlows

        public ChannelBatchCancelFlowsResponse ChannelBatchCancelFlows​(ChannelBatchCancelFlowsRequest req)
                                                        throws TencentCloudSDKException
        指定需要批量撤销的签署流程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)** 注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
        Parameters:
        req - ChannelBatchCancelFlowsRequest
        Returns:
        ChannelBatchCancelFlowsResponse
        Throws:
        TencentCloudSDKException

      • ChannelCancelFlow

        public ChannelCancelFlowResponse ChannelCancelFlow​(ChannelCancelFlowRequest req)
                                            throws TencentCloudSDKException
        撤销签署流程接口，可以撤回：未全部签署完成；不可以撤回（终态）：已全部签署完成、已拒签、已过期、已撤回。 注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
        Parameters:
        req - ChannelCancelFlowRequest
        Returns:
        ChannelCancelFlowResponse
        Throws:
        TencentCloudSDKException

      • ChannelCreateBatchCancelFlowUrl

        public ChannelCreateBatchCancelFlowUrlResponse ChannelCreateBatchCancelFlowUrl​(ChannelCreateBatchCancelFlowUrlRequest req)
                                                                        throws TencentCloudSDKException
        指定需要批量撤销的签署流程Id，获取批量撤销链接 - 不建议使用此接口，可使用ChannelBatchCancelFlows 客户指定需要撤销的签署流程Id，最多100个，超过100不处理； 接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销; 可以撤回：未全部签署完成 不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
        Parameters:
        req - ChannelCreateBatchCancelFlowUrlRequest
        Returns:
        ChannelCreateBatchCancelFlowUrlResponse
        Throws:
        TencentCloudSDKException

      • ChannelCreateBatchSignUrl

        public ChannelCreateBatchSignUrlResponse ChannelCreateBatchSignUrl​(ChannelCreateBatchSignUrlRequest req)
                                                            throws TencentCloudSDKException
        通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。 注： - 参与人点击链接后需短信验证码才能查看合同内容。 - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。 - 个人批量签署，签名区`仅支持手写签名`。
        Parameters:
        req - ChannelCreateBatchSignUrlRequest
        Returns:
        ChannelCreateBatchSignUrlResponse
        Throws:
        TencentCloudSDKException

      • ChannelCreateFlowReminds

        public ChannelCreateFlowRemindsResponse ChannelCreateFlowReminds​(ChannelCreateFlowRemindsRequest req)
                                                          throws TencentCloudSDKException
        指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息 注意: 该接口不可直接调用，请联系客户经理申请使用 仅能催办当前状态为“待签署”的签署人，且只能催办一次
        Parameters:
        req - ChannelCreateFlowRemindsRequest
        Returns:
        ChannelCreateFlowRemindsResponse
        Throws:
        TencentCloudSDKException

      • ChannelCreateFlowSignReview

        public ChannelCreateFlowSignReviewResponse ChannelCreateFlowSignReview​(ChannelCreateFlowSignReviewRequest req)
                                                                throws TencentCloudSDKException
        提交企业流程审批结果 目前存在两种审核操作，签署审核，发起审核 签署审核：通过接口（CreateFlowsByTemplates或ChannelCreateFlowByFiles或ChannelCreatePrepareFlow）发起签署流程后，若指定了参数 NeedSignReview 为true,则可以调用此接口，指定operate=SignReview，提交企业内部签署审批结果；若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效 发起审核：通过接口ChannelCreatePrepareFlow指定发起后需要审核，则可以通过调用此接口，指定operate=CreateReview，提交企业内部审批结果，可多次提交，当通过后，后续提交结果无效
        Parameters:
        req - ChannelCreateFlowSignReviewRequest
        Returns:
        ChannelCreateFlowSignReviewResponse
        Throws:
        TencentCloudSDKException

      • ChannelCreateFlowSignUrl

        public ChannelCreateFlowSignUrlResponse ChannelCreateFlowSignUrl​(ChannelCreateFlowSignUrlRequest req)
                                                          throws TencentCloudSDKException
        创建个人签署H5签署链接，请联系客户经理申请使用
        该接口用于发起合同后，生成C端签署人的签署链接
        注意：该接口目前签署人类型仅支持个人签署方（PERSON）
        注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
        注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
        Parameters:
        req - ChannelCreateFlowSignUrlRequest
        Returns:
        ChannelCreateFlowSignUrlResponse
        Throws:
        TencentCloudSDKException

      • ChannelCreateMultiFlowSignQRCode

        public ChannelCreateMultiFlowSignQRCodeResponse ChannelCreateMultiFlowSignQRCode​(ChannelCreateMultiFlowSignQRCodeRequest req)
                                                                          throws TencentCloudSDKException
        此接口（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)
        Parameters:
        req - ChannelCreateMultiFlowSignQRCodeRequest
        Returns:
        ChannelCreateMultiFlowSignQRCodeResponse
        Throws:
        TencentCloudSDKException

      • ChannelCreatePrepareFlow

        public ChannelCreatePrepareFlowResponse ChannelCreatePrepareFlow​(ChannelCreatePrepareFlowRequest req)
                                                          throws TencentCloudSDKException
        创建预发起合同 通过此接口指定：合同，签署人，填写控件信息，生成预创建合同链接，点击后跳转到web页面完成合同创建并发起 可指定合同信息不可更改，签署人信息不可更改 合同发起后，填写及签署流程与现有操作流程一致 注意：目前仅支持模板发起
        Parameters:
        req - ChannelCreatePrepareFlowRequest
        Returns:
        ChannelCreatePrepareFlowResponse
        Throws:
        TencentCloudSDKException

      • ChannelCreateRole

        public ChannelCreateRoleResponse ChannelCreateRole​(ChannelCreateRoleRequest req)
                                            throws TencentCloudSDKException
        此接口（ChannelCreateRole）用来创建企业自定义角色。 适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。 适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
        Parameters:
        req - ChannelCreateRoleRequest
        Returns:
        ChannelCreateRoleResponse
        Throws:
        TencentCloudSDKException

      • ChannelDescribeFlowComponents

        public ChannelDescribeFlowComponentsResponse ChannelDescribeFlowComponents​(ChannelDescribeFlowComponentsRequest req)
                                                                    throws TencentCloudSDKException
        查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
        Parameters:
        req - ChannelDescribeFlowComponentsRequest
        Returns:
        ChannelDescribeFlowComponentsResponse
        Throws:
        TencentCloudSDKException

      • ChannelDescribeOrganizationSeals

        public ChannelDescribeOrganizationSealsResponse ChannelDescribeOrganizationSeals​(ChannelDescribeOrganizationSealsRequest req)
                                                                          throws TencentCloudSDKException
        查询子客企业电子印章，需要操作者具有管理印章权限 客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数，只返回启用的印章。
        Parameters:
        req - ChannelDescribeOrganizationSealsRequest
        Returns:
        ChannelDescribeOrganizationSealsResponse
        Throws:
        TencentCloudSDKException

      • ChannelModifyRole

        public ChannelModifyRoleResponse ChannelModifyRole​(ChannelModifyRoleRequest req)
                                            throws TencentCloudSDKException
        此接口（ChannelModifyRole）用来更新企业自定义角色。 适用场景1：更新当前企业的自定义角色的名称或描述等其他信息，更新时不进行权限的设置（PermissionGroups 参数不传）。 适用场景2：更新当前企业的自定义角色的权限信息，更新时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
        Parameters:
        req - ChannelModifyRoleRequest
        Returns:
        ChannelModifyRoleResponse
        Throws:
        TencentCloudSDKException

      • CreateConsoleLoginUrl

        public CreateConsoleLoginUrlResponse CreateConsoleLoginUrl​(CreateConsoleLoginUrlRequest req)
                                                    throws TencentCloudSDKException
        此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客控制台的唯一入口。 链接访问后，会根据企业的和员工的状态（企业根据ProxyOrganizationOpenId参数，员工根据OpenId参数判断），进入不同的流程，主要情况分类如下： 1. 若子客企业未激活，会进入企业激活流程，首次参与激活流程的经办人会成为超管。 2. 若子客企业已激活，员工未激活，则会进入经办人激活流程。 3. 若子客企业、经办人均已完成认证，则会直接进入子客Web控制台。 如果是企业激活流程，需要注意如下情况： 1. 若在激活过程中，更换用户OpenID重新生成链接，之前的认证会被清理。因此不要在认证过程中多人同时操作，导致认证过程互相影响。 2. 若您认证中发现信息有误需要重新认证，可以通过更换OpenID重新生成链接的方式，来清理掉已有的流程。
        Parameters:
        req - CreateConsoleLoginUrlRequest
        Returns:
        CreateConsoleLoginUrlResponse
        Throws:
        TencentCloudSDKException

      • CreateFlowsByTemplates

        public CreateFlowsByTemplatesResponse CreateFlowsByTemplates​(CreateFlowsByTemplatesRequest req)
                                                      throws TencentCloudSDKException
        接口（CreateFlowsByTemplates）用于使用模板批量创建签署流程。当前可批量发起合同（签署流程）数量为1-20个。 如若在模板中配置了动态表格, 上传的附件必须为A4大小 合同发起人必须在电子签已经进行实名。
        Parameters:
        req - CreateFlowsByTemplatesRequest
        Returns:
        CreateFlowsByTemplatesResponse
        Throws:
        TencentCloudSDKException

      • CreateSignUrls

        public CreateSignUrlsResponse CreateSignUrls​(CreateSignUrlsRequest req)
                                      throws TencentCloudSDKException
        创建跳转小程序查看或签署的链接。 跳转小程序的几种方式：主要是设置不同的EndPoint 1. 通过链接Url直接跳转到小程序，不需要返回 设置EndPoint为WEIXINAPP，得到链接打开即可。（与短信提醒用户签署形式一样）。 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl 设置EndPoint为CHANNEL，指定JumpUrl，得到链接打开即可。 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App 跳转到小程序的实现，参考官方文档 https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html 其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 使用CreateSignUrls，设置EndPoint为APP，得到path。 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序 跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式） 全屏方式： （https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html） 半屏方式： （https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html） 其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 使用CreateSignUrls，设置EndPoint为APP，得到path。 其中小程序的原始Id如下，或者查看小程序信息自助获取。 | 小程序 | AppID | 原始ID | | ------------ | ------------ | ------------ | | 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
        Parameters:
        req - CreateSignUrlsRequest
        Returns:
        CreateSignUrlsResponse
        Throws:
        TencentCloudSDKException

      • DescribeTemplates

        public DescribeTemplatesResponse DescribeTemplates​(DescribeTemplatesRequest req)
                                            throws TencentCloudSDKException
        通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。 > **适用场景** > > 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。 > 一个模板通常会包含以下结构信息 >- 模板基本信息 >- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方 >- 填写控件 Components >- 签署控件 SignComponents >- 生成模板的文件基础信息 FileInfos
        Parameters:
        req - DescribeTemplatesRequest
        Returns:
        DescribeTemplatesResponse
        Throws:
        TencentCloudSDKException

      • GetDownloadFlowUrl

        public GetDownloadFlowUrlResponse GetDownloadFlowUrl​(GetDownloadFlowUrlRequest req)
                                              throws TencentCloudSDKException
        此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式 分类下载。 当前接口限制最多合同（流程）50个. 返回的链接只能使用一次
        Parameters:
        req - GetDownloadFlowUrlRequest
        Returns:
        GetDownloadFlowUrlResponse
        Throws:
        TencentCloudSDKException

      • OperateChannelTemplate

        public OperateChannelTemplateResponse OperateChannelTemplate​(OperateChannelTemplateRequest req)
                                                      throws TencentCloudSDKException
        此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。 > **使用场景** > > 1：查询 OperateType=SELECT > - 查询第三方应用平台模板库的可见性以及授权的子客列表。 > > 2：修改部分子客授权 OperateType=UPDATE > - 对子客企业进行模板库中模板可见性的进行修改操作。 >- 当模板未发布时，可以修改可见性AuthTag（part/all），当模板发布后，不可做此修改 > - 若模板已发布且可见性AuthTag是part，可以通过ProxyOrganizationOpenIds增加子客的授权范围。如果是自动领取的模板，增加授权范围后会自动下发。 > > 3：取消部分子客授权 OperateType=DELETE > - 对子客企业进行模板库中模板可见性的进行删除操作。 > - 主要对于手动领取的模板，去除授权后子客在模板库中看不到，就无法再领取了。但是已经领取过成为自有模板的不会同步删除。 > - 对于自动领取的模板，由于已经下发，更改授权不会影响。 > - 如果要同步删除子客自有模板库中的模板，请使用OperateType=UPDATE+Available参数处理。
        Parameters:
        req - OperateChannelTemplateRequest
        Returns:
        OperateChannelTemplateResponse
        Throws:
        TencentCloudSDKException

      • PrepareFlows

        public PrepareFlowsResponse PrepareFlows​(PrepareFlowsRequest req)
                                  throws TencentCloudSDKException
        该接口 (PrepareFlows) 用于创建待发起文件 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。 目前该接口只支持B2C，不建议使用，将会废弃。
        Parameters:
        req - PrepareFlowsRequest
        Returns:
        PrepareFlowsResponse
        Throws:
        TencentCloudSDKException

      • SyncProxyOrganization

        public SyncProxyOrganizationResponse SyncProxyOrganization​(SyncProxyOrganizationRequest req)
                                                    throws TencentCloudSDKException
        此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称，企业营业执照，企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意： 1. 需要在子客企业激活前调用该接口，如果您的企业已经提交企业信息或者企业已经激活，同步的企业信息将不会生效。 2. 如果您同时传递了营业执照信息和企业名称等信息，在认证过程中将以营业执照中的企业信息为准，请注意企业信息需要和营业执照信息对应。
        Parameters:
        req - SyncProxyOrganizationRequest
        Returns:
        SyncProxyOrganizationResponse
        Throws:
        TencentCloudSDKException

      • SyncProxyOrganizationOperators

        public SyncProxyOrganizationOperatorsResponse SyncProxyOrganizationOperators​(SyncProxyOrganizationOperatorsRequest req)
                                                                      throws TencentCloudSDKException
        此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。 若经办人信息有误，或者需要修改，也可以先将之前的经办人做离职操作，然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
        Parameters:
        req - SyncProxyOrganizationOperatorsRequest
        Returns:
        SyncProxyOrganizationOperatorsResponse
        Throws:
        TencentCloudSDKException

      • UploadFiles

        public UploadFilesResponse UploadFiles​(UploadFilesRequest req)
                                throws TencentCloudSDKException
        此接口（UploadFiles）用于文件上传。 其中上传的文件，图片类型(png/jpg/jpeg)大小限制为5M，其他大小限制为60M。 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。 代码示例： HttpProfile httpProfile = new HttpProfile(); httpProfile.setEndpoint("file.test.ess.tencent.cn");
        Parameters:
        req - UploadFilesRequest
        Returns:
        UploadFilesResponse
        Throws:
        TencentCloudSDKException