tencentcloud-sdk-nodejs
Version:
1,319 lines (1,115 loc) • 131 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Client = void 0;
/* eslint-disable @typescript-eslint/no-unused-vars */
/*
* Copyright (c) 2018 Tencent. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
const abstract_client_1 = require("../../../common/abstract_client");
/**
* ess client
* @class
*/
class Client extends abstract_client_1.AbstractClient {
constructor(clientConfig) {
super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
}
/**
* 本接口（DescribeEnterpriseContractReviewChecklists）用于获取企业全部审查要点清单。
*/
async DescribeEnterpriseContractReviewChecklists(req, cb) {
return this.request("DescribeEnterpriseContractReviewChecklists", req, cb);
}
/**
* 此接口（DescribeContractReviewTaskListWebUrl）用来创建合同审查记录列表web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。
适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。
注意: `如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开`
*/
async DescribeContractReviewTaskListWebUrl(req, cb) {
return this.request("DescribeContractReviewTaskListWebUrl", req, cb);
}
/**
* 此接口用于启动流程。它是模板发起合同的最后一步。
在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
注：
1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
2.<font color="red">静默（自动）签署不支持非本企业合同签署方存在填写</font>功能
3.<font color="red">在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)</font>，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
*/
async StartFlow(req, cb) {
return this.request("StartFlow", req, cb);
}
/**
* 此接口（CreateContractComparisonTask）用于创建合同对比任务。
适用场景：对比两份合同中字段（如：金额、日期、甲方名称等）的内容差异。
*/
async CreateContractComparisonTask(req, cb) {
return this.request("CreateContractComparisonTask", req, cb);
}
/**
* 此接口（DescribeContractReviewChecklist）用于获取已有的合同风险审查清单详情。
*/
async DescribeContractReviewChecklist(req, cb) {
return this.request("DescribeContractReviewChecklist", req, cb);
}
/**
* 创建一个用于更新他方自动签授权的链接（可选择他方授权或我方授权）。通过这个链接，合作方企业可以直接进入小程序，进行自动签授权的更新（更新印章）操作。
如果授权企业尚未开通企业自动签功能，该链接还将引导他们首先开通本企业的自动签服务
注:
1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)
2. 只能更新授权的印章，被授权的企业无法更新
3. 授权企业和被授权企业必须都是已认证企业
4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。
*/
async ModifyPartnerAutoSignAuthUrl(req, cb) {
return this.request("ModifyPartnerAutoSignAuthUrl", req, cb);
}
/**
* 获取个人用户自动签的开通链接。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
*/
async CreateUserAutoSignEnableUrl(req, cb) {
return this.request("CreateUserAutoSignEnableUrl", req, cb);
}
/**
* 接口（CreateContractDiffTaskWebUrl）用于创建合同对比的可嵌入web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。
注：
1. 对比仅支持pdf、word格式，限制大小为60M以下
2. 本接口生成的web页面暂不支持<a href="https://qian.tencent.com/developers/companyApis/embedPages/CreateWebThemeConfig" target="_blank">设置本企业嵌入式页面主题配置</a>
未跳过上传确认的嵌入页面长相如下：
跳过上传确认的嵌入页面长相如下：
*/
async CreateContractDiffTaskWebUrl(req, cb) {
return this.request("CreateContractDiffTaskWebUrl", req, cb);
}
/**
* 生成个人用户实名认证链接，个人用户点击此链接进入实名流程（若用户已完成实名认证，则直接进入成功页面）。用户点击此接口生成的链接完成实名认证后，其数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回
注： 调用此接口需要购买<font color="red"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。
*/
async CreateUserVerifyUrl(req, cb) {
return this.request("CreateUserVerifyUrl", req, cb);
}
/**
* 本接口（CreateEmbedWebUrl）用于创建可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中），支持以下类型的Web链接创建：
1. 创建印章
2. 创建模板
3. 修改模板
4. 创建起草合同
5. 预览模板
6. 预览合同流程
预览模板的嵌入页面长相如下：
预览合同流程的嵌入页面长相如下：
*/
async CreateEmbedWebUrl(req, cb) {
return this.request("CreateEmbedWebUrl", req, cb);
}
/**
* 此接口用于获取企业批量认证异步任务的状态及结果。
前提条件：已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口，并得到了任务Id。
异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也可能需要更长的时间
*/
async DescribeBatchOrganizationRegistrationUrls(req, cb) {
return this.request("DescribeBatchOrganizationRegistrationUrls", req, cb);
}
/**
* 本接口（DescribeBatchOrganizationRegistrationTasks）用于查询企业批量认证任务状态。
*/
async DescribeBatchOrganizationRegistrationTasks(req, cb) {
return this.request("DescribeBatchOrganizationRegistrationTasks", req, cb);
}
/**
* 本接口（CreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，使用此接口请与客户经理确认）。
*/
async CreatePreparedPersonalEsign(req, cb) {
return this.request("CreatePreparedPersonalEsign", req, cb);
}
/**
* 此接口（CreateFileConvertTask）用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
<font color="red">原功能接口: </font><a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务（CreateConvertTaskApi）</a><br />
前提条件：源文件已经通过 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">文件上传接口</a>完成上传，并得到了源文件的资源Id。<br />
适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同<br />
转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
注:
1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
*/
async CreateFileConvertTask(req, cb) {
return this.request("CreateFileConvertTask", req, cb);
}
/**
* 提交企业流程审批结果
**当前存在两种审核操作：**
<ul>
<li>签署审核
<ul>
<li>在通过接口<ul>
<li>CreateFlowByFiles</li>
<li>CreateFlow</li>
<li>CreateFlowGroupByTemplates</li>
<li>CreateFlowGroupByFiles</li>
<li>CreatePrepareFlow</li>
</ul>
发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果（<font color="red">审核对象：本企业合同参与方的签署动作</font>）</li>
<li>在通过接口
<ul>
<li>CreateFlowByFiles</li>
<li>CreateFlow</li>
<li>CreateFlowGroupByTemplates</li>
<li>CreateFlowGroupByFiles</li>
</ul>
发起签署流程时，通过指定签署人ApproverNeedSignReview为true，则可以调用此接口，并指定operate=SignReview，并指定RecipientId，以提交企业内部签署审批结果（<font color="red">审核对象：本企业、合同企业、自然人合同参与方的签署动作</font>）</li>
</ul>
</li>
对应签署人在签署页面会看到下面的提示：
<li>发起审核
<ul>
<li>通过接口CreatePrepareFlow指定发起后需要审核，那么可以调用此接口，并指定operate=CreateReview，以提交企业内部审批结果。可以多次提交审批结果，但一旦审批通过，后续提交的结果将无效（<font color="red">审核对象：本企业合同发起方的发起动作</font>）
</li>
</ul>
对应发起人在发起合同的最后环节会有<b>提交审批</b>的按钮：
</li>
</ul>
*/
async CreateFlowSignReview(req, cb) {
return this.request("CreateFlowSignReview", req, cb);
}
/**
* 创建签署流程电子文档<br />
### 调用流程
该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
### 填充模板中定义的填写控件
模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充。
**<font color="red">填充填写控件需要进行Pdf合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83),建议在收到此回调后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口。</font>**
填充的传参示例如下
```
request.FormFields = [{
"ComponentName": "项目的名字",
"ComponentValue": "休闲山庄"
}, {
"ComponentName": "项目的地址",
"ComponentValue": "凤凰山北侧",
}, {
"ComponentName": "范围",
"ComponentValue": "凤凰山至107国道",
}, {
"ComponentName": "面积",
"ComponentValue": "100亩",
}, {
"ComponentName": "基本情况",
"ComponentValue": "完好",
}, , {
"ComponentName": "用途",
"ComponentValue": "经营农家乐",
}
]
```
合成后合同样子示例
*/
async CreateDocument(req, cb) {
return this.request("CreateDocument", req, cb);
}
/**
* 查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
1. **企业自动签署**
2. **批量签署授权**
3. **企业与港澳台居民签署合同**
4. **拓宽签署方年龄限制**
5. **个人签署方仅校验手机号**
6. **隐藏合同经办人姓名**
7. **正楷临摹签名失败后更换其他签名类型**
8. **短信通知签署方**
9. **个人签署方手写签名时需逐个手写**
10. **签署密码开通引导**
11. **个人签署方手动签名**
12. **限制企业员工小程序端登录**
13. **限制企业员工网页端登录**
对应能力开通页面在【Web控制台】-> 【更多】->【高级签署能力】，如下图所示:
注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId需要传递超管或者法人的UserId)
*/
async DescribeExtendedServiceAuthInfos(req, cb) {
return this.request("DescribeExtendedServiceAuthInfos", req, cb);
}
/**
* 此接口（DescribeRiskIdentificationTaskFeedback）用于查询合同审查任务结果反馈信息
*/
async DescribeRiskIdentificationTaskFeedback(req, cb) {
return this.request("DescribeRiskIdentificationTaskFeedback", req, cb);
}
/**
* 此接口（CreateDraftContractByPromptsTask）用于创建智能合同起草任务。
*/
async CreateDraftContractByPromptsTask(req, cb) {
return this.request("CreateDraftContractByPromptsTask", req, cb);
}
/**
* 通过此接口获取个人用户自动签的开通状态。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
*/
async DescribeUserAutoSignStatus(req, cb) {
return this.request("DescribeUserAutoSignStatus", req, cb);
}
/**
* 此接口（CreateFlowGroupByTemplates）可用于通过多个模板创建合同组签署流程。
- 该接口允许通过选择多个模板一次性创建多个合同，这些合同被组织在一个合同组中。
- 每个签署方将收到一个签署链接，通过这个链接可以访问并签署合同组中的所有合同。
- 合同组中的合同必须作为一个整体进行签署，不能将合同组拆分成单独的合同进行逐一签署。
<img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
### 2. 适用场景
该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
### 3. 合同额度的扣减与返还
- **扣减时机**：合同一旦发起，相关的合同额度就会被扣减，合同组下面的每个合同都要扣减一个合同额度。
- **返还条件**：只有在合同被撤销且没有任何签署方签署过，或者只有自动签署的情况下，合同额度才会被返还。
- **不返还的情况**：如果合同已过期、被拒签、签署完成或已解除，合同额度将不会被返还。
### 4.合同组暂不支持抄送功能
*/
async CreateFlowGroupByTemplates(req, cb) {
return this.request("CreateFlowGroupByTemplates", req, cb);
}
/**
* 此接口（ImportRiskIdentificationChecklist）用于创建或更新合同审查清单。
*/
async ImportContractReviewChecklist(req, cb) {
return this.request("ImportContractReviewChecklist", req, cb);
}
/**
* 此接口（DescribeFlowTemplates）用于查询本企业模板列表信息。
**适用场景**
该接口常用来配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">模板发起合同-创建电子文档</a>接口，作为创建电子文档的前置接口使用。
通过此接口查询到模板信息后，再通过调用创建电子文档接口，指定模板ID，指定模板中需要的填写控件内容等，完成电子文档的创建。
**一个模板通常会包含以下结构信息**
- 模板模板ID, 模板名字等基本信息
- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
- 发起方和签署方的填写控件 Components
- 签署方的签署控件 SignComponents
模板中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
*/
async DescribeFlowTemplates(req, cb) {
return this.request("DescribeFlowTemplates", req, cb);
}
/**
* 创建一个用于他方自动签授权的链接（可选择他方授权或我方授权）。通过这个链接，合作方企业可以直接进入小程序，进行自动签授权操作。
如果授权企业尚未开通企业自动签功能，该链接还将引导他们首先开通本企业的自动签服务
注:
1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)
2. 已经在授权中或者授权成功的企业，无法重复授权
3. 授权企业和被授权企业必须都是已认证企业
4. <font color='red'>需要授权企业的超管或者法人打开链接</font>走开通逻辑。
**该接口效果同控制台： 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**
*/
async CreatePartnerAutoSignAuthUrl(req, cb) {
return this.request("CreatePartnerAutoSignAuthUrl", req, cb);
}
/**
* 本接口（DeleteSealPolicies）用于撤销企业员工持有的印章权限
*/
async DeleteSealPolicies(req, cb) {
return this.request("DeleteSealPolicies", req, cb);
}
/**
* 该接口用于将合同中本企业当前经办人转为本企业其他员工进行操作。
注意：
1. 转交的目标经办人需要已经加入企业，且完成实名。
2. 仅企业拥有`超管`、`法人`或者`合同管理员`角色的员工才有调用本接口的权限。如果使用主带子方式调用，请确保您已经加入子企业，且账号在子企业中担任任一上述角色。
3. 仅支持当前经办人为待签署或待填写状态时进行转交操作。
4. 若原合同有填写控件，且当前经办人已经完成填写，则不支持进行转交。
5. 若当前经办人已签署完成，或者处于签署流程中，则不支持进行转交。
*/
async CreateFlowForwards(req, cb) {
return this.request("CreateFlowForwards", req, cb);
}
/**
* 此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。
角色分为系统默认角色与企业自定义角色，其中系统默认角色不可以禁用、删除、编辑权限项，只可往默认角色中添加成员。企业自定义角色为企业根据自身需要新增的角色，可根据企业具体情况设置各个角色的权限，例如新增财务岗、销售岗等角色。
企业版的系统默认角色包含如下角色：
| 角色名称 | 角色描述 |
|------------------------------|--------------------------------------------------------------------------|
| 超级管理员（电子签业务最高权限，e.g.法务/业务负责人） | 所有功能和数据管理权限，只能设置一位超管。 |
| IT信息管理员（IT系统负责人，e.g. CTO） | 组织员工、计费模块、应用模块等权限能力。 |
| 企业合同管理员（企业法务负责人） | 企业全部合同管理、可申请出证等权限能力。 |
| 企业模板管理员 | 企业全部模板管理权限能力。 |
| 企业印章管理员（企业行政负责人） | 管理企业的所有电子印章，如添加印章、启用停用印章、印章授权等。 |
| 用印审批岗（各部门的印章管理岗） | 可对被授权的印章进行日常使用管理，如合同盖章用印的审核及登记。 |
| 部门管理员（部门的合同+印章+模板管理） | 部门级（含子部门）所有合同管理权限能力。 |
| 业务员（销售员、采购员） | 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力。 |
*/
async DescribeIntegrationRoles(req, cb) {
return this.request("DescribeIntegrationRoles", req, cb);
}
/**
* 此接口（DescribeFileConvertTask）用来查询转换任务的状态。如需发起转换任务，请使用<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
<font color="red">原功能接口: </font><a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态（GetTaskResultApi）</a><br />
前提条件：已调用 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>进行文件转换，并得到了返回的转换任务Id。<br />
适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。<br />
注：
1. `大文件转换所需的时间可能会比较长`
2. `本接口返回的文件资源ID就是PDF资源ID，可以直接用于【用PDF文件创建签署流程】接口发起合同。`
*/
async DescribeFileConvertTask(req, cb) {
return this.request("DescribeFileConvertTask", req, cb);
}
/**
* 此接口（DescribeContractReviewChecklistsWebUrl）用来创建审查要点清单列表web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。
适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。
注意: `如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开`
*/
async DescribeContractReviewChecklistsWebUrl(req, cb) {
return this.request("DescribeContractReviewChecklistsWebUrl", req, cb);
}
/**
* 此接口（DescribeIntegrationEmployees）用于分页查询企业员工信息列表，支持设置过滤条件以筛选员工查询结果。
*/
async DescribeIntegrationEmployees(req, cb) {
return this.request("DescribeIntegrationEmployees", req, cb);
}
/**
* 本接口（ExportContractReviewMarkedRisk）用于创建导出任务，可以导出合同审查标注风险项,包括忽略的、标记错误的、人工标注的风险等
*/
async ExportContractReviewMarkedRisk(req, cb) {
return this.request("ExportContractReviewMarkedRisk", req, cb);
}
/**
* 获取个人用户认证证书图片下载URL
个人用户认证证书图片样式如下图
注:
<ul>
<li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
<li>专为电子处方单（医疗自动签）特定场景使用。在使用前，请务必与您的客户经理联系以确认已经开通电子处方单功能 </li>
</ul>
*/
async CreatePersonAuthCertificateImage(req, cb) {
return this.request("CreatePersonAuthCertificateImage", req, cb);
}
/**
* 提交合同组签署流程审批结果的适用场景包括：
1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时，若指定了以下参数 为true，则可以调用此接口提交企业内部签署审批结果。即使是自动签署也需要进行审核通过才会进行签署。
- [FlowGroupInfo.NeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#flowgroupinfo)
- [ApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#approverinfo)
2. 同一合同组，同一签署人可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
*/
async CreateFlowGroupSignReview(req, cb) {
return this.request("CreateFlowGroupSignReview", req, cb);
}
/**
* 此接口用于赋予员工指定的角色权限，如需解绑请使用 DeleteIntegrationRoleUsers 接口。
*/
async CreateIntegrationUserRoles(req, cb) {
return this.request("CreateIntegrationUserRoles", req, cb);
}
/**
* 通过此接口，可以创建小程序批量签署链接，个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。
注意事项：
- 使用此接口生成链接，需要贵企业先开通 <font color="red">个人签署方仅校验手机号 </font>功能。您可以在 <b>【腾讯电子签网页端控制台】->【更多】->【高级签署能力】</b>中找到该功能。
- 生成批量签署链接时，<font color="red">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人点击链接后需要输入短信验证码才能查看合同内容。
- 企业员工批量签署链接：需要传入签署方所在企业名称，用户名字和手机号（或者身份证件信息）参数来生成签署链接。
- 个人批量签署链接：需要传入签署方用户名字和手机号（或者身份证件信息）参数来生成签署链接。
- 不支持签署方含有签批控件，或设置了签署方在签署时自行添加签署控件功能的合同进行批量签署。
- 进行小程序批量签署必须指定待签署的流程id，<font color="red">接口中FlowIds参数必传。</font>
*/
async CreateBatchSignUrl(req, cb) {
return this.request("CreateBatchSignUrl", req, cb);
}
/**
* 本接口（DescribeInformationExtractionTask）用于获取合同智能提取任务详情，包括任务的状态和提取的字段结果信息。
*/
async DescribeInformationExtractionTask(req, cb) {
return this.request("DescribeInformationExtractionTask", req, cb);
}
/**
* 指定需要批量催办的签署流程ID，批量催办合同，最多100个
##### 需要符合以下条件的合同才可被催办：
<ol>
<li>发起合同时，**设置了签署人通知类型：SMS,EMAIL,ALL**</li>
<li>合同中当前状态为 **待签署** 的签署人是催办的对象</li>
<li>**每个合同的每个签署方最多3次*</li>
</ol>
##### 催办的规则和效果：
###### 规则
- 指定RemindTypes，会触发符合签署人NotifyType的通知类型
- 这里EMAIL类型例外，如果指定了RemindEmailInfos，那么就会按照指定的email来通知，不管签署人NotifyType是否设置了EMAIL通知类型
- 如果指定了RemindEmailInfos，那么就会按照指定的email来通知
- 若未指定RemindTypes，则按照发起合同时设置的签署人原始通知类型处理
###### 效果
<li>对方会收到如下的短信通知</li>
<li>对方会收到如下的邮件通知</li>
注：`合同催办是白名单功能，请联系客户经理申请开白后使用`
*/
async CreateFlowReminds(req, cb) {
return this.request("CreateFlowReminds", req, cb);
}
/**
* 此接口（DescribeContractReviewWebUrl）用来创建合同审查web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。
适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。
注意: `如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开`
*/
async DescribeContractReviewWebUrl(req, cb) {
return this.request("DescribeContractReviewWebUrl", req, cb);
}
/**
* 生成个人用户实名更名链接，个人用户点击此链接进入更名流程（若用户未完成实名认证，则直接进入实名页面实名后再进行更名）。此链接为通用链接，任何点击生成链接的用户将会被引导至小程序个人更名页面完成更名。
注： 调用此接口需要购买<font color="red"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。
*/
async CreateUserNameChangeUrl(req, cb) {
return this.request("CreateUserNameChangeUrl", req, cb);
}
/**
* 通过此接口可以关闭个人用户自动签功能。
无需对应的用户刷脸等方式同意即可关闭。
注意:
<ul><li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li>
<li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
*/
async DisableUserAutoSign(req, cb) {
return this.request("DisableUserAutoSign", req, cb);
}
/**
* 接口（DescribeContractDiffTaskWebUrl）用于获取合同对比结果可嵌入的web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。
注：本接口生成的web页面暂不支持<a href="https://qian.tencent.com/developers/companyApis/embedPages/CreateWebThemeConfig" target="_blank">设置本企业嵌入式页面主题配置</a>
嵌入页面长相如下：
*/
async DescribeContractDiffTaskWebUrl(req, cb) {
return this.request("DescribeContractDiffTaskWebUrl", req, cb);
}
/**
* 此接口（DescribePersonCertificate）用于查询个人数字证书信息。<br />注：`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。`<br />`2.调用此接口需要开通白名单，使用前请联系相关人员开通白名单。`
*/
async DescribePersonCertificate(req, cb) {
return this.request("DescribePersonCertificate", req, cb);
}
/**
* 该接口（DeleteIntegrationEmployees）用于离职本企业员工，同时可选择是否进行离职交接。
- 如果该员工没有未处理的合同，可不设置交接人的ReceiveUserId或ReceiveOpenId进行离职操作。
- 如果该员工有未处理的合同，需要设置ReceiveUserId或ReceiveOpenId表示交接的负责人，交接后员工会进行离职操作。
未处理的合同包括以下：
- 待签署的合同（包括顺序签署还没有轮到的合同，此类合同某些情况可能不会出现在用户的列表中）。
- 待填写的合同。
- 待解除的合同等。
注：
1. <font color="red">超管或法人身份的员工不能被离职</font>， 需要在控制台或小程序更换法人和超管后进行离职删除。
2. <font color="red">员工存在待处理合同时必须交接</font>后才能离职无人交接时不能被离职删除。
3. 未实名的员工可以直接离职，不用交接合同
*/
async DeleteIntegrationEmployees(req, cb) {
return this.request("DeleteIntegrationEmployees", req, cb);
}
/**
* 此接口（CreateBatchContractReviewTask）用来通过上传后的PDF资源编号来批量创建合同智能审查任务。
适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。
注:
1. PDF格式限制大小为10M以下
2. 仅支持5份PDF文件批量发起（一份PDF对应一个审查任务）
*/
async CreateBatchContractReviewTask(req, cb) {
return this.request("CreateBatchContractReviewTask", req, cb);
}
/**
* 数据加签验签接口
*/
async VerifyDigitalDataSign(req, cb) {
return this.request("VerifyDigitalDataSign", req, cb);
}
/**
* 获取设置自动签印章小程序链接。
注意：
<ul><li>需要<code>企业开通自动签</code>后使用。</li>
<li>仅支持<code>已经开通了自动签的个人</code>更换自动签印章。</li>
<li>链接有效期默认7天，<code>最多30天</code>。</li>
<li>该接口的链接适用于<code>小程序</code>端。</li>
<li>该接口不会扣除您的合同套餐，暂不参与计费。</li></ul>
*/
async CreateUserAutoSignSealUrl(req, cb) {
return this.request("CreateUserAutoSignSealUrl", req, cb);
}
/**
* 查询企业认证状态- 仅通过[CreateOrganizationAuthUrl](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl) 和[CreateBatchOrganizationRegistrationTasks](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)这两个接口进行引导认证的企业，调用方企业可以依据这个接口，查询认证状态。
*/
async DescribeOrganizationAuthStatus(req, cb) {
return this.request("DescribeOrganizationAuthStatus", req, cb);
}
/**
* 此接口（OperateFlowRemarks）用于对企业合同备注进行管理操作，支持新增，创建和删除。
用户可以通过接口对合同备注进行管理，支持对创建后的备注进行搜索关联的合同流程。
注：
对合同备注进行操作前，操作人需要获取对应权限：合同操作 - 设置合同类型及备注。
没有对应权限的用户，并且不属于超管、法人，该合同的参与方（包含签署方与发起方），将无法对对应合同的备注进行编辑，如果备注内容包含敏感信息，将会对其进行打码显示。
*/
async OperateFlowRemarks(req, cb) {
return this.request("OperateFlowRemarks", req, cb);
}
/**
* 管理企业扩展服务
- **直接开通的情形：** 若在操作过程中接口没有返回跳转链接，这表明无需进行任何跳转操作。此时，相应的企业高级签署能力将会直接被开通或关闭。
- **需要法人或者超管签署开通协议的情形：** 当需要开通以下企业高级签署能力时， 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员（超管）或法人。由他们点击该链接，完成服务的开通操作。
- **OPEN_SERVER_SIGN（企业自动签）**
注意： `在调用此接口以管理企业扩展服务时，操作者（入参中的Operator）必须是企业的超级管理员（超管）或法人`
对应的扩展服务能力可以在控制台的【高级签署能力】中找到
*/
async ModifyExtendedService(req, cb) {
return this.request("ModifyExtendedService", req, cb);
}
/**
* 本接口（DescribeContractReviewTask）用于获取合同审查任务详情，包括任务的状态和识别出的风险信息。
*/
async DescribeContractReviewTask(req, cb) {
return this.request("DescribeContractReviewTask", req, cb);
}
/**
* 已经不再使用
给医疗个人自动签许可续期。续期成功后，可对医疗自动签许可追加一年有效期，只可续期一次。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
*/
async RenewAutoSignLicense(req, cb) {
return this.request("RenewAutoSignLicense", req, cb);
}
/**
* 对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。
**补充**： 可以到控制台[合同验签](https://qian.tencent.com/verifySign)体验验签功能，界面如下
*/
async VerifyPdf(req, cb) {
return this.request("VerifyPdf", req, cb);
}
/**
* 此接口（BindEmployeeUserIdWithClientOpenId）用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
此OpenId只在 [更新企业员工信息 ](https://qian.tencent.com/developers/companyApis/staffs/UpdateIntegrationEmployees)、[移除企业员工](https://qian.tencent.com/developers/companyApis/staffs/DeleteIntegrationEmployees) 等场景下可以使用
*/
async BindEmployeeUserIdWithClientOpenId(req, cb) {
return this.request("BindEmployeeUserIdWithClientOpenId", req, cb);
}
/**
* 生成合成后的各类企业授权书，包括：
- 企业认证超管授权书
- 超管变更授权书
- 企业注销授权书
注: 需自行保证传入真实的企业/法人/超管信息，否则后续的审核将会拒绝。
*/
async CreateOrganizationAuthFile(req, cb) {
return this.request("CreateOrganizationAuthFile", req, cb);
}
/**
* 解绑员工与对应角色的关系，如需绑定请使用 CreateIntegrationUserRoles 接口。
*/
async DeleteIntegrationRoleUsers(req, cb) {
return this.request("DeleteIntegrationRoleUsers", req, cb);
}
/**
* 本接口（ExportContractReviewResult）用于导出和同审查结果。支持选择 1 “带风险批注文件”、 2 “审查结果＆摘要（.xIsx）”
*/
async ExportContractReviewResult(req, cb) {
return this.request("ExportContractReviewResult", req, cb);
}
/**
* 此接口（CreateFlowGroupByFiles）可用于通过多个文件创建合同组签署流程。使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
- 该接口允许通过PDF资源ID一次性创建多个合同，这些合同被组织在一个合同组中。
- 每个签署方将收到一个签署链接，通过这个链接可以访问并签署合同组中的所有合同。
- 合同组中的合同必须作为一个整体进行签署，不能将合同组拆分成单独的合同进行逐一签署。
<img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
### 2. 适用场景
该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
### 3. 合同额度的扣减与返还
- **扣减时机**：合同一旦发起，相关的合同额度就会被扣减，合同组下面的每个合同都要扣减一个合同额度。
- **返还条件**：只有在合同被撤销且没有任何签署方签署过，或者只有自动签署的情况下，合同额度才会被返还。
- **不返还的情况**：如果合同已过期、被拒签、签署完成或已解除，合同额度将不会被返还。
### 4.合同组暂不支持抄送功能
*/
async CreateFlowGroupByFiles(req, cb) {
return this.request("CreateFlowGroupByFiles", req, cb);
}
/**
* 此接口（CreateIntegrationDepartment）用于创建企业的部门信息，支持绑定客户系统部门ID。
*/
async CreateIntegrationDepartment(req, cb) {
return this.request("CreateIntegrationDepartment", req, cb);
}
/**
* 提交申请出证报告任务并返回报告ID。
出证报告的示例样式可以参考 [出证报告.PDF](https://qcloudimg.tencent-cloud.cn/raw/a55214fcddaebbd1582cc9c57cc6cf1b.pdf)
注意：
<ul><li>使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。</li>
<li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
<li>合同流程必须所有参与方`已经签署完成`。</li>
<li>出证过程需一定时间，建议在`提交出证任务后的24小时之后`，通过<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
<svg id="SvgjsSvg1006" width="262" height="229" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1007"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
*/
async CreateFlowEvidenceReport(req, cb) {
return this.request("CreateFlowEvidenceReport", req, cb);
}
/**
* 通过模板创建签署流程<br/>
适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
<table>
<thead>
<tr>
<th>签署人类别</th>
<th>需要提前准备的信息</th>
</tr>
</thead>
<tbody>
<tr>
<td>自己企业的员工签署（未认证加入或已认证加入）</td>
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
</tr>
<tr>
<td>自己企业的员工签署（已认证加入）</td>
<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
</tr>
<tr>
<td>其他企业的员工签署</td>
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
</tr>
<tr>
<td>个人（自然人）签署</td>
<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
</tr>
</tbody>
</table>
注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
注：**静默（自动）签署不支持合同签署方存在填写**功能
<br>
<font color="red">相关视频指引</font> <br>
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/createflow_seversign.mp4" target="_blank">创建静默（自动）签署模板和开通自动签署</a><br>
2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/flow_document_start.mp4" target="_blank">用模板创建发起合同</a><br>
*/
async CreateFlow(req, cb) {
return this.request("CreateFlow", req, cb);
}
/**
* 发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。
解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义，[点击查看解除协议模板示例PDF](https://qcloudimg.tencent-cloud.cn/raw/279b53002cf178ac89ba2c4f31b2dd8a.pdf)。具体用法可以参考文档[合同解除](https://qian.tencent.com/developers/company/flow_release)。
注意：
<ul>
<li><strong>完成原合同签署后方可发起解除协议：</strong>只有在原合同所有签署人完成签署后，才可以启动解除协议的流程。</li>
<li><strong>原合同状态更新：</strong>解除协议一旦签署完毕，原合同状态将更新为“已解除”。</li>
<li><strong>解除协议的个人参与要求：</strong>原合同中的个人参与者必须直接参与解除协议，禁止替换为其他第三方个人。</li>
<li><strong>企业参与人的代理权：</strong>若原合同的企业参与人无法亲自参与解除协议，可指派具有等同权限的企业员工代行。</li>
<li><strong>解除协议的费用问题：</strong>发起解除协议将产生费用，其扣费标准与其他企业合同相同。</li>
<li><strong>解除协议的发起资格：</strong>仅限原合同中的企业类型参与者发起解除协议，个人参与者无此权限。</li>
<li><strong>非原合同企业参与者的权限：</strong>非原合同的企业参与者发起解除协议时，必须具备相应的解除权限。</li>
<li><strong>自动签署：</strong>支持本企业的自动签署，不支持其他企业的自动签署（不能不动声色的把别人参与的合同作废了）</li>
</ul>
*/
async CreateReleaseFlow(req, cb) {
return this.request("CreateReleaseFlow", req, cb);
}
/**
* 此接口（CreateSingleSignOnEmployees）用于创建单点登录企业员工。
创建好的员工，可以通过腾讯电子签提供的链接， 如下图位置，进行登录。
此操作的功能：
1. 可以绑定已经实名的员工，然后 sso 登录实名绑定。
2. 可以提前导入员工，在 sso 登录的时候进行实名。
3. 如果已经绑定过，可以直接通过 sso 链接登录腾讯电子签。
*/
async CreateSingleSignOnEmployees(req, cb) {
return this.request("CreateSingleSignOnEmployees", req, cb);
}
/**
* 此接口（DescribeSingleSignOnEmployees）用于查询单点登录企业员工。
*/
async DescribeSingleSignOnEmployees(req, cb) {
return this.request("DescribeSingleSignOnEmployees", req, cb);
}
/**
* 该接口用于获取创建法人章的二维码，需要通过微信扫描。扫描后将跳转到腾讯电子签署，进入到创建法人章的流程。
**注意**
1. 该二维码**有效期为7天**，过期后将失效，可重新创建 。
2. 每个公司**只能有1个法人章**，无法重复创建或者创建多个
法人章的样式可以参考下图索引（也可以自己上传法人印章图片）：
*/
async CreateLegalSealQrCode(req, cb) {
return this.request("CreateLegalSealQrCode", req, cb);
}
/**
* 本接口（CreateSeal）用于创建企业电子印章，支持创建企业公章，合同章，财务专用章和人事专用章创建。
1. 可以**通过图片**创建印章，图片最大5MB
2. 可以**系统创建**创建印章, 系统创建的印章样子下图(样式可以调整)
*/
async CreateSeal(req, cb) {
return this.request("CreateSeal", req, cb);
}
/**
* 此接口（CreateMultiFlowSignQRCode）用于创建一码多签签署码。
**适用场景**:
签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
**注意**:
1.满足以下条件的模板支持创建签署码：
- 签署对象：企业与个人（无序签署）、企业与个人（顺序签署&企业非首位）、 仅个人签署。
- 其发起方没有填写控件,签署方（B端或C端）可以有填写控件。
- 如签署对象中含企业方，企业方签署区只能由发起方企业签署。
2. 通过一码多签签署码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
]( https://qian.tencent.com/developers/company/callback_types_contracts_sign)
3. 用户通过一码多签签署码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
签署码的样式如下图:
*/
async CreateMultiFlowSignQRCode(req, cb) {
return this.request("CreateMultiFlowSignQRCode", req, cb);
}
/**
* 查询企业扩展服务的授权详情（列表），当前支持查询以下内容：
1. 企业自动签（本企业授权、集团企业授权、合作企业授权）
2. 批量签署能力
注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
*/
async DescribeExtendedServiceAuthDetail(req, cb) {
return this.request("DescribeExtendedServiceAuthDetail", req, cb);
}
/**
* 此接口（CreateOrganizationInfoChangeUrl）用于创建企业信息变更链接，支持创建企业超管变更链接或企业基础信息变更链接，通过入参ChangeType指定。
需要企业的<font color="red">现有的超级管理员、法人来点击</font>链接执行变动操作。
### 2. 企业基础信息
#### A. 可变动的信息
- **企业名称**
- **法定代表人姓名**（新法人将收到邀请链接）
- **企业地址和所在地**
- **企业超级管理员变更** （此变更将企业超级管理员的职责转移给企业的其他员工）
#### B. 不可变动的信息
- **统一社会信用代码**
- **企业主体类型**
### 3.变更影响
如果企业的名字变更将导致下面的影响：
- **合同**：已存在的合同将保持不变。新发起的合同需使用新的企业名称作为签署方，否则无法签署。
- **印章**：所有现有的机构公章和合同专用章将被删除，并将根据新的企业名称重新生成。法人章、财务专用章和人事专用章将不做处理。
- **证书**：企业证书将重新由CA机构使用新的企业名称生成。
*/
async CreateOrganizationInfoChangeUrl(req, cb) {
return this.request("CreateOrganizationInfoChangeUrl", req, cb);
}
/**
* 此接口（CancelMultiFlowSignQRCode）用于废除一码多签签署码。
该接口所需的二维码ID，源自[创建一码多签签署码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
如果该签署码尚处于有效期内，可通过本接口将其设置为失效状态。
*/
async CancelMultiFlowSignQRCode(req, cb) {
return this.request("CancelMultiFlowSignQRCode", req, cb);
}
/**
* 查询流程基础信息，主要用于<font color="red">查询合同的状态</font>信息。可以配合回调通知使用。
注: `每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误`
*/
async DescribeFlowBriefs(req, cb) {
return this.request("DescribeFlowBriefs", req, cb);
}
/**
* 该接口用于结束动态签署方2.0的合同流程。
**功能开通**
- 动态签署方2.0功能的使用需要先<font color="red">联系产品经理开通模块化计费功能</font>，然后到控制台中打开此功能。详细的使用说明请参考<a href="https://qian.tencent.com/developers/company/dynamic_signer_v2" target="_blank">动态签署方2.0</a>文档。
**使用条件**
- 此接口只能在<font color="red">合同处于非终态且<b>所有的签署方都已经完成签署</b></font>。一旦合同进入终态（例如：过期、拒签、撤销或者调用过此接口成功过），将无法通过此接口结束合同流程。
**整体流程**
*/
async ArchiveDynamicFlow(req, cb) {
return this.request("ArchiveDynamicFlow", req, cb);
}
/**
* 该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。
1. 该接口**仅适用于在H5端签署**的合同，**在通过视频认证后**获取人脸视频。
2. 该接口**不支持小程序端**的签署人脸视频获取。
3. 请在**签署完成后的24小时内**获取人脸视频，**过期后将无法获取**。
**注意：该接口需要开通白名单，请联系客户经理开通后使用。**
*/
async DescribeSignFaceVideo(req, cb) {
return this.request("DescribeSignFaceVideo", req, cb);
}
/**
* 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
<table>
<thead>
<tr>
<th>签署人类别</th>
<th>需要提前准备的信息</th>
</tr>
</thead>
<tbody>
<tr>
<td>自己企业的员工签署（未认证加入或已认证加入）</td>
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
</tr>
<tr>
<td>自己企业的员工签署（已认证加入）</td>
<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
</tr>
<tr>
<td>其他企业的员工签署</td>
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
</tr>
<tr>
<td>个人（自然人）签署</td>
<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
</tr>
</tbody>
</table>
该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>
注：
- 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
- **静默（自动）签署不支持合同签署方存在填写**功能
<font color="red">相关视频指引</font> <br>
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/ess_uploadfiles.mp4" target="_blank">上传用于合同发起的PDF文件代码编写示例</a><br>
2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/ess-CreateFlowByFiles.mp4" target="_blank">用PDF文件创建签署流程编写示例</a><br>
*/
async CreateFlowByFiles(req, cb) {
return this.request("CreateFlowByFiles", req, cb);
}
/**
* 此接口用于获取企业批量变更超管链接，包含多条超管变更任务。
一次性最多获取 500 条任务。
前提条件：已调用 [CreateBatchAdminChangeInvitations生成批量变更超管任务接口](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchAdminChangeInvitations) 确保任务提交。
此链接包含多条超管变更流程，使用该链接可以批量的对企业进行超管变更。
*/
async CreateBatchAdminChangeInvitationsUrl(req, cb) {
return this.request("CreateBatchAdminChangeInvitationsUrl", req, cb);
}
/**
* 该接口用于发起合同后，生成用户的签署链接 <br/>
**注意**
1. 该签署链接**默认有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接。
2. 该接口返回的签署链接适用于APP集成的场景，支持APP、支付宝打开或浏览器直接打开，**不支持微信小程序嵌入**。配置方式请参考：<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
如需跳转到小程序的实现，参考微信官方文档（分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式），如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
3. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
4. H5签署现在**仅支持中国大陆身份证、中国港澳台居民居住证**。
*/
async CreateFlowSignUrl(req, cb) {
return this.request("CreateFlowSignUrl", req, cb);
}
/**
* 支持企业进行批量初始化操作：
此接口存在以下限制：
1. 若批量操作中包含<font color="red">加入集团企业</font>操作,则调用此接口的员工须有<font color="red">集团企业管理权限</font>。
2. 批量操作的企业需要已经完成电子签的认证流程。
3. 通过此接口生成的链接在小程序端进行操作时，操作人需要是<font color="red">所有企业的超管或法人</font>。
4. 批量操作的企业，需要是<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl" target="_blank">通过平台方引导认证</a>的企业。
5. <font color="red">操作链接过期时间默认为生成链接后7天。</font>
*/
async CreateBatchInitOrganizationUrl(req, cb) {
return this.request("CreateBatchInitOrganizationUrl", req, cb);
}
/**
* 用来撤销<a href="https://qian.tencent.com/developers/companyApis/users/CreateUserAutoSignEnableUrl" target="_blank">获取个人用户自动签的开通状态</a>生成的开通链接，撤销生成的链接失效。
注:
<ul><li>若个人用户已经用生成的完成自动签署的开通，撤销链接无效不会对开通结果产生影响(此情况接口会报错)。</li>
<li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li></ul>
*/
async CancelUserAutoSignEnableUrl(req, cb) {
return this.request("CancelUserAutoSignEnableUrl", req, cb);
}
/**
* 通过此接口（DescribeBillUsageDetail）查询该企业的套餐消耗详情。
*/
async DescribeBillUsageDetail(req, cb) {
return this.request("DescribeBillUsageDetail", req, cb);
}
/**
* 此接口（DescribeIntegrationDepartments）用于查询企业的部门信息列表，支持查询单个部门节点或单个部门节点及一级子节点部门列表。
*/
async DescribeIntegrationDepartments(req, cb) {
return this.request("DescribeIntegrationDepartments", req, cb);
}
/**
* 本接口（DescribeContractReviewMarkedRiskExportTask）用于查询由 ExportContractReviewMarkedRisk 接口创建的导出任务状态。
*/
async DescribeContractReviewMarkedRiskExportTask(req, cb) {
return this.request("DescribeContractReviewMarkedRiskExportTask", req, cb);
}
/**
* 此API接口用来查询加入集团的成员企业信息
适用场景：子企业在加入集团后，主企业可能通过此接口获取到所有的子企业列表，方便进行展示和统计
*/
async DescribeOrganizationGroupOrganizations(req, cb) {
return this.request("DescribeOrganizationGroupOrganizations", req, cb);
}
/**
* 该接口会生成一个手机号变更的链接，用户可以通过该链接进入电子签系统进行手机号的变更。
该接口支持员工和个人端手机号的变更。
*/
async CreateUserMobileChangeUrl(req, cb) {
return this.request("CreateUserMobileChangeUrl", req, cb);
}
/**
* 本接口（ExportContractComparisonTask）用于导出指定的合同对比任务的结果文件。任务完成后，用户可根据不同的使用场景，选择导出可视化对比报告（PDF）或结构化差异明细（EXCEL）。
*/
async ExportContractComparisonTask(req, cb) {
return this.request("ExportContractComparisonTask", req, cb);
}
/**
* 此接口（DescribeLMInformationExtractionTaskFieldFeedback）用于查询合同智能提取任务字段反馈信息。
*/
async DescribeLMInformationExtractionTaskFieldFeedback(req, cb) {
return this.request("DescribeLMInformationExtractionTaskFieldFeedback", req, cb);
}
/**
* 此接口（CreateBatchInformationExtractionTask）用来通过上传后的PDF资源编号来批量创建合同智能审查任务。<br/>
适用场景：根据合同关键词（字段名称）来提取PDF合同文件的字段结果信息。
注:
1. PDF格式限制大小为10M以下
2. 仅支持5个PDF文件批量发起（一份PDF对应一个合同提取任务）
*/
async CreateBatchInformationExtractionTask(req, cb) {
return this.request("CreateBatchInformationExtractionTask", req, cb);
}
/**
* 本接口（DescribeFileUrls）用于查询文件的下载URL。
适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
### 2. 确保合同的PDF已经合成后，再调用本接口。
用户创建合同或者提交签署动作后，后台需要1~3秒的时间就进行合同PDF合成或者签名，为了确保您下载的是签署完成的完整合同文件，我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成，然后在调用本接口</b></font>。
**第一种**：请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)功能。一旦所有参与方签署完毕，我们的系统将自动向您提供的回调地址发送完成通知。
**第二种**：通过调用我们的[获取合同信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowBriefs)接口来主动检查合同的签署状态。请仅在确认合同状态为“签署完成”后，进行文件的下载操作。
### 3. 链接具有有效期限
<font color="red"><b>生成的链接是有时间限制的，过期后将无法访问</b></font>。您可以在接口返回的信息中查看具体的过期时间。为避免错误，请确保在链接过期之前进行下载操作。
*/
async DescribeFileUrls(req, cb) {
return this.request("DescribeFileUrls", req, cb);
}
/**
* 修改印章状态（停用、启用）
*/
async OperateSeals(req, cb) {
return this.request("OperateSeals", req, cb);
}
/**
* 此接口（CreateIntegrationRole）用来创建企业自定义的SaaS角色或集团角色。
适用场景1：创建当前企业的自定义SaaS角色或集团角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
适用场景2：创建当前企业的自定义SaaS角色或集团角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
适用场景3：创建集团角色时可同时设置角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。
适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。
注意事项：SaaS角色和集团角色对应的权限树是不一样的。
*/
async CreateIntegrationRole(req, cb) {
return this.request("CreateIntegrationRole", req, cb);
}
/**
* 此接口（OperateTemplate）用于对企业自有模板进行管理操作，所有操作都会有对应的回调触发，具体参考回调文档 <a href="https://qian.tencent.com/developers/company/callback_types_templates" target="_blank">模板操作相关回调</a>
# 支持的操作
## 1. 删除模板 (OperateType=DELETE)
此操作会将模板从企业自有模板中彻底删除，若要保留模板而不删除，可将模板停用。
## 2. 启用模板 (OperateType=ENABLE)
此操作是将已停用的模板启用，操作幂等，若模板已启用，接口不报错。
## 3. 停用模板 (OperateType=DISABLE)
此操作是将已启用的模板停用，操作幂等，若模板已停用，接口不报错，停用后，无法通过此模板发起合同，已发起的合同不受影响。
## 4. 复制模板 (OperateType=COPY)
此操作将复制一个完全一样的模板，仅支持修改模板名称，若要修改其他模板内容，需到腾讯电子签控制台操作。
*/
async OperateTemplate(req, cb) {
return this.request("OperateTemplate", req, cb);
}
/**
* 本接口（DescribeContractComparisonTask）用于查询合同对比任务结果详情。
*/
async DescribeContractComparisonTask(req, cb) {
return this.request("DescribeContractComparisonTask", req, cb);
}
/**
* 生成员工信息变更链接，当前仅支持变更手机号
注:
1. 目前仅支持修改员工手机号，待修改员工必须已经实名且在职
2. 仅支持返回小程序链接
*/
async CreateEmployeeChangeUrl(req, cb) {
return this.request("CreateEmployeeChangeUrl", req, cb);
}
/**
* 在已启动的签署流程中，可对签署截止日期进行延期操作，主要分为以下两个层面：
1. <b> 合同（流程）层面</b>：仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。
2. <b> 签署人层面</b> ：需提供流程ID和签署人ID。此操作针对特定签署人进行延期，特别是对于有序合同（流程），签署截止时间不得超过后续签署人的流程截止时间。
此接口存在以下限制：
1. 执行操作的员工须为<font color="red">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。
2. 延长整个签署流程时，<font color="red">应至少有一方尚未签署</font>（即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
3. 延长整个签署流程时，新的签署截止日期应晚于已设定的签署截止日期和当前日期。
4. 延长签署方截止时间时，<font color="red">签署方不能处于流程完结或已终止状态</font>（即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
5. 延长签署方截止时间时，新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同，还需早于或等于下一签署人的截止日期，且早于签署流程整体的截止日期。
6. <font color="red">不支持操作合同组合同</font>。
合同（流程）层面 截止时间控制台展示的位置：
*/
async ModifyFlowDeadline(req, cb) {
return this.request("ModifyFlowDeadline", req, cb);
}
/**
* 获取区块链存证证书查看链接/二维码接口
适用场景：企业员工可以通过此接口生成合同区块链存证证书的查看链接/二维码，以供他人扫码打开腾讯电子签小程序查看。
[点击查看区块链存证证书样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)
注：
<ul><li>1. 二维码下载链接过期时间为5分钟，请尽快下载保存。二维码/短链的过期时间为<font color="red">7天</font>，超过有效期则不可用。</li>
<li>2. 合同状态需为<font color="red">签署完成</font> 、<font color="red">已解除</font>才能生成证书查看二维码/短链。</li>
<li>3. 调用接口时，需确保接口调用身份拥有此合同的访问数据权限或为合同参与方。</li>
<li>4. 通过扫码或者点击链接，用户无需登录或者鉴权即可查看对应合同的区块链存证证书，请妥善保管好二维码或链接。</li></ul>
*/
async CreateFlowBlockchainEvidenceUrl(req, cb) {
return this.request("CreateFlowBlockchainEvidenceUrl", req, cb);
}
/**
* 本接口（CreateBatchOrganizationRegistrationTasks）用于批量创建企业认证链接
该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
批量创建链接有以下限制：
1. 单次最多创建10个企业。
2. 一天同一家企业最多创建8000家企业。
3. 同一批创建的企业不能重复 其中包括 企业名称，企业统一信用代码
4. 跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置
注：
1. 此接口需要 <font color="red"><b>购买单独的实名套餐包</b></font>方可调用，如有需求请联系对接人员评估
2. 如果生成的链接是APP链接，跳转到小程序的实现，参考微信官方文档（分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式），如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
**腾讯电子签小程序的AppID 和 原始Id如下:**
| 小程序 | AppID | 原始ID |
| --- | --- | --- |
| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
*/
async CreateBatchOrganizationRegistrationTasks(req, cb) {
return this.request("CreateBatchOrganizationRegistrationTasks", req, cb);
}
/**
* 此接口（DescribeInformationExtractionWebUrl）用来获取合同信息提取web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。
*/
async DescribeInformationExtractionWebUrl(req, cb) {
return this.request("DescribeInformationExtractionWebUrl", req, cb);
}
/**
* 检测个人用户是否已经实名。
在调用生成C端用户实名链接（[CreateUserVerifyUrl](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)）接口之前，客户企业应首先调用本接口判断C端用户是否已经完成实名认证。如果用户已经实名，那么无需再次调用（[CreateUserVerifyUrl](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)）生成链接并走实名认证流程。
注意：
- 此接口<font color="red">仅用于确认通过本公司生成[C端用户实名链接（CreateUserVerifyUrl）](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口注册认证的用户，不包括其他途径（如主动注册认证、在签署合同中注册认证等）在电子签平台上进行的实名认证</font>。
- 调用此接口需要购买单独的实名套餐包。<font color="red">使用前请联系对接的客户经理沟通</font>。
*/
async DescribeUserVe