@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,365 lines (2,313 loc) • 254 kB
TypeScript
/**
* DescribePersonCertificate返回参数结构体
*/
export interface DescribePersonCertificateResponse {
/**
* 证书的Base64
*/
Cert?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用户计费使用情况详情
*/
export interface BillUsageDetail {
/**
* 合同流程ID，为32位字符串。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowId?: string;
/**
* 合同经办人名称
如果有多个经办人用分号隔开。
*/
OperatorName?: string;
/**
* 发起方组织机构名称
*/
CreateOrganizationName?: string;
/**
* 合同流程的名称。
*/
FlowName?: string;
/**
* 当前合同状态,如下是状态码对应的状态。
<ul>
<li>**0**: 还没有发起</li>
<li>**1**: 等待签署</li>
<li>**2**: 部分签署 </li>
<li>**3**: 拒签</li>
<li>**4**: 已签署 </li>
<li>**5**: 已过期 </li>
<li>**6**: 已撤销 </li>
<li>**7**: 还没有预发起</li>
<li>**8**: 等待填写</li>
<li>**9**: 部分填写 </li>
<li>**10**: 拒填</li>
<li>**11**: 已解除</li>
</ul>
*/
Status?: number;
/**
* 查询的套餐类型
对应关系如下:
<ul>
<li>**CloudEnterprise**: 企业版合同</li>
<li>**SingleSignature**: 单方签章</li>
<li>**CloudProve**: 签署报告</li>
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
<li>**ChannelWeCard**: 微工卡</li>
<li>**SignFlow**: 合同套餐</li>
<li>**SignFace**: 签署意愿（人脸识别）</li>
<li>**SignPassword**: 签署意愿（密码）</li>
<li>**SignSMS**: 签署意愿（短信）</li>
<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
<li>**OrgEssAuth**: 签署企业实名</li>
<li>**FlowNotify**: 短信通知</li>
<li>**AuthService**: 企业工商信息查询</li>
</ul>
*/
QuotaType?: string;
/**
* 合同使用量
注: `如果消耗类型是撤销返还，此值为负值代表返还的合同数量`
*/
UseCount?: number;
/**
* 消耗的时间戳，格式为Unix标准时间戳（秒）。
*/
CostTime?: number;
/**
* 消耗的套餐名称
*/
QuotaName?: string;
/**
* 消耗类型
**1**.扣费
**2**.撤销返还
*/
CostType?: number;
/**
* 备注
*/
Remark?: string;
}
/**
* CreateSeal请求参数结构体
*/
export interface CreateSealRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 电子印章名字，1-50个中文字符
注:`同一企业下电子印章名字不能相同`
*/
SealName: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 电子印章生成方式
<ul>
<li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li>
<li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li>
</ul>
*/
GenerateSource?: string;
/**
* 电子印章类型 , 可选类型如下:
<ul><li>**OFFICIAL**: (默认)公章</li>
<li>**CONTRACT**: 合同专用章;</li>
<li>**FINANCE**: 财务专用章;</li>
<li>**PERSONNEL**: 人事专用章</li>
<li>**INVOICE**: 发票专用章</li>
</ul>
注: `同企业下只能有一个公章, 重复创建会报错`
*/
SealType?: string;
/**
* 电子印章图片文件名称，1-50个中文字符。
*/
FileName?: string;
/**
* 电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式
注: `通过图片创建的电子印章，需电子签平台人工审核`
*/
Image?: string;
/**
* 电子印章宽度,单位px
参数不再启用，系统会设置印章大小为标准尺寸。
*/
Width?: number;
/**
* 电子印章高度,单位px
参数不再启用，系统会设置印章大小为标准尺寸。
*/
Height?: number;
/**
* 电子印章印章颜色(默认红色RED),RED-红色
系统目前只支持红色印章创建。
*/
Color?: string;
/**
* 企业印章横向文字，最多可填15个汉字 (若超过印章最大宽度，优先压缩字间距，其次缩小字号)
横向文字的位置如下图中的"印章横向文字在这里"
*/
SealHorizontalText?: string;
/**
* 暂时不支持下弦文字设置
*/
SealChordText?: string;
/**
* 系统生成的印章只支持STAR
*/
SealCentralType?: string;
/**
* 通过文件上传时，服务端生成的电子印章上传图片的token
*/
FileToken?: string;
/**
* 印章样式, 可以选择的样式如下:
<ul><li>**circle**:(默认)圆形印章</li>
<li>**ellipse**:椭圆印章</li></ul>
*/
SealStyle?: string;
/**
* 印章尺寸取值描述, 可以选择的尺寸如下:
<ul><li> **42_42**: 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li>
<li> **40_40**: 圆形企业印章直径40mm, 当SealStyle是圆形的时候才有效</li>
<li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li>
<li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li></ul>
*/
SealSize?: string;
/**
* 企业税号
注: `1.印章类型SealType是INVOICE类型时，此参数才会生效`
`2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号`
*/
TaxIdentifyCode?: string;
}
/**
* ModifyIntegrationDepartment返回参数结构体
*/
export interface ModifyIntegrationDepartmentResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelFlow返回参数结构体
*/
export interface CancelFlowResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFlowEvidenceReport请求参数结构体
*/
export interface DescribeFlowEvidenceReportRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
*/
ReportId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* UpdateIntegrationEmployees返回参数结构体
*/
export interface UpdateIntegrationEmployeesResponse {
/**
* 更新成功的用户列表
*/
SuccessEmployeeData?: Array<SuccessUpdateStaffData>;
/**
* 更新失败的用户列表
*/
FailedEmployeeData?: Array<FailedUpdateStaffData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集成版员工部门信息。
*/
export interface Department {
/**
* 部门ID。
*/
DepartmentId?: string;
/**
* 部门名称。
*/
DepartmentName?: string;
}
/**
* CreatePreparedPersonalEsign请求参数结构体
*/
export interface CreatePreparedPersonalEsignRequest {
/**
* 个人用户姓名
*/
UserName: string;
/**
* 证件号码，应符合以下规则
<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
*/
IdCardNumber: string;
/**
* 印章名称，长度1-50个字。
*/
SealName: string;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 证件类型，支持以下类型
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
*/
IdCardType?: string;
/**
* 印章图片的base64
注：已废弃
请先通过UploadFiles接口上传文件，获取 FileId
* @deprecated
*/
SealImage?: string;
/**
* 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
*/
SealImageCompress?: boolean;
/**
* 手机号码；当需要开通自动签时，该参数必传
*/
Mobile?: string;
/**
* 是否开通自动签，该功能需联系运营工作人员开通后使用
*/
EnableAutoSign?: boolean;
/**
* 印章颜色（参数ProcessSeal=true时生效）
默认值：BLACK黑色
取值:
BLACK 黑色,
RED 红色,
BLUE 蓝色。
*/
SealColor?: string;
/**
* 是否处理印章，默认不做印章处理。
取值如下：
<ul>
<li>false：不做任何处理；</li>
<li>true：做透明化处理和颜色增强。</li>
</ul>
*/
ProcessSeal?: boolean;
/**
* 印章图片文件 id
取值：
填写的FileId通过UploadFiles接口上传文件获取。
*/
FileId?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
*/
LicenseType?: number;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
*/
SceneKey?: string;
}
/**
* DescribeIntegrationDepartments返回参数结构体
*/
export interface DescribeIntegrationDepartmentsResponse {
/**
* 部门信息列表。部门信息根据部门排序号OrderNo降序排列，根据部门创建时间升序排列。
*/
Departments?: Array<IntegrationDepartment>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteExtendedServiceAuthInfos返回参数结构体
*/
export interface DeleteExtendedServiceAuthInfosResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowApprovers返回参数结构体
*/
export interface CreateFlowApproversResponse {
/**
* 批量补充签署人时，补充失败的报错说明
注:`目前仅补充动态签署人时会返回补充失败的原因`
注意：此字段可能返回 null，表示取不到有效值。
*/
FillError?: Array<FillError>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFileUrls返回参数结构体
*/
export interface DescribeFileUrlsResponse {
/**
* 文件URL信息；
链接不是永久链接, 过期时间受UrlTtl入参的影响, 默认有效期5分钟后, 到期后链接失效。
*/
FileUrls?: Array<FileUrl>;
/**
* URL数量
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateExtendedServiceAuthInfos请求参数结构体
*/
export interface CreateExtendedServiceAuthInfosRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 本企业员工的id，需要已实名，正常在职员工
*/
UserIds: Array<string>;
/**
* 取值
<ul><li>OPEN_SERVER_SIGN：企业自动签</li>
<li>BATCH_SIGN：批量签署</li>
</ul>
*/
ExtendServiceType?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* ModifyApplicationCallbackInfo返回参数结构体
*/
export interface ModifyApplicationCallbackInfoResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateMultiFlowSignQRCode返回参数结构体
*/
export interface CreateMultiFlowSignQRCodeResponse {
/**
* 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
*/
QrCode?: SignQrCode;
/**
* 流程签署二维码的签署信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。
*/
SignUrls?: SignUrl;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 签署链接信息。
*/
export interface FlowApproverUrlInfo {
/**
* 签署短链接。</br>
注意:
- 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
- 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
注意：此字段可能返回 null，表示取不到有效值。
*/
SignUrl?: string;
/**
* 签署人类型。
- **1**: 个人
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproverType?: number;
/**
* 签署人姓名。
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproverName?: string;
/**
* 签署人手机号。
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproverMobile?: string;
/**
* 签署长链接。</br>
注意:
- 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
- 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
注意：此字段可能返回 null，表示取不到有效值。
*/
LongUrl?: string;
}
/**
* 关注方信息
*/
export interface ReviewerInfo {
/**
* 姓名
*/
Name?: string;
/**
* 手机号
*/
Mobile?: string;
}
/**
* 合同流程的基础信息
*/
export interface FlowBrief {
/**
* 合同流程ID，为32位字符串。
*/
FlowId?: string;
/**
* 合同流程的名称。
*/
FlowName?: string;
/**
* 合同流程描述信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowDescription?: string;
/**
* 合同流程的类别分类（如销售合同/入职合同等）。
*/
FlowType?: string;
/**
* 合同流程当前的签署状态, 会存在下列的状态值
<ul><li> **0** : 未开启流程(合同中不存在填写环节)</li>
<li> **1** : 待签署</li>
<li> **2** : 部分签署</li>
<li> **3** : 已拒签</li>
<li> **4** : 已签署</li>
<li> **5** : 已过期</li>
<li> **6** : 已撤销</li>
<li> **7** : 未开启流程(合同中存在填写环节)</li>
<li> **8** : 等待填写</li>
<li> **9** : 部分填写</li>
<li> **10** : 已拒填</li>
<li> **21** : 已解除</li></ul>
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowStatus?: number;
/**
* 合同流程创建时间，格式为Unix标准时间戳（秒）。
注意：此字段可能返回 null，表示取不到有效值。
*/
CreatedOn?: number;
/**
* 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowMessage?: string;
/**
* 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
注意：此字段可能返回 null，表示取不到有效值。
*/
Creator?: string;
/**
* 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。
注意：此字段可能返回 null，表示取不到有效值。
*/
Deadline?: number;
}
/**
* DescribeThirdPartyAuthCode返回参数结构体
*/
export interface DescribeThirdPartyAuthCodeResponse {
/**
* AuthCode 中对应个人用户是否实名
<ul>
<li> **VERIFIED** : 此个人已实名</li>
<li> **UNVERIFIED**: 此个人未实名</li></ul>
*/
VerifyStatus?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 被授权的用户信息
*/
export interface HasAuthUser {
/**
* 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
注意：此字段可能返回 null，表示取不到有效值。
*/
UserId?: string;
/**
* 当前员工的归属情况，可能值是：
MainOrg：在集团企业的场景下，返回此值代表是归属主企业
CurrentOrg：在普通企业场景下返回此值；或者在集团企业的场景下，返回此值代表归属子企业
注意：此字段可能返回 null，表示取不到有效值。
*/
BelongTo?: string;
/**
* 集团主企业id，当前企业为集团子企业时，该字段有值
注意：此字段可能返回 null，表示取不到有效值。
*/
MainOrganizationId?: string;
}
/**
* DisableUserAutoSign返回参数结构体
*/
export interface DisableUserAutoSignResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelUserAutoSignEnableUrl返回参数结构体
*/
export interface CancelUserAutoSignEnableUrlResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindEmployeeUserIdWithClientOpenId返回参数结构体
*/
export interface BindEmployeeUserIdWithClientOpenIdResponse {
/**
* 绑定是否成功。
<ul><li>**0**：失败</li><li>**1**：成功</li></ul>
*/
Status?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIntegrationEmployees请求参数结构体
*/
export interface CreateIntegrationEmployeesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 待创建员工的信息，最多不超过20个。
其中入参Mobile和DisplayName必填，OpenId、Email和Department.DepartmentId选填，其他字段暂不支持设置。
在创建企微企业员工场景下，只需传入WeworkOpenId，无需再传其他信息。
*/
Employees: Array<Staff>;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 创建合同个性化参数
*/
export interface CreateFlowOption {
/**
* 是否允许修改发起合同时确认弹窗的合同信息（合同名称、合同类型、签署截止时间），若不允许编辑，则表单字段将被禁止输入。
<br/>true：允许编辑<br/>false：不允许编辑（默认值）<br/>
*/
CanEditFlow?: boolean;
/**
* 是否允许编辑模板控件
<br/>true:允许编辑模板控件信息
<br/>false:不允许编辑模板控件信息（默认值）
<br/>
*/
CanEditFormField?: boolean;
/**
* 发起页面隐藏合同名称展示
<br/>true:发起页面隐藏合同名称展示
<br/>false:发起页面不隐藏合同名称展示（默认值）
<br/>
*/
HideShowFlowName?: boolean;
/**
* 发起页面隐藏合同类型展示
<br/>true:发起页面隐藏合同类型展示
<br/>false:发起页面不隐藏合同类型展示（默认值）
<br/>
*/
HideShowFlowType?: boolean;
/**
* 发起页面隐藏合同截止日期展示
<br/>true:发起页面隐藏合同截止日期展示
<br/>false:发起页面不隐藏合同截止日期展示（默认值）
<br/>
*/
HideShowDeadline?: boolean;
/**
* 发起页面允许跳过添加签署人环节
<br/>true:发起页面允许跳过添加签署人环节
<br/>false:发起页面不允许跳过添加签署人环节（默认值）
<br/>
*/
CanSkipAddApprover?: boolean;
/**
* 文件发起页面跳过文件上传步骤
<br/>true:文件发起页面跳过文件上传步骤
<br/>false:文件发起页面不跳过文件上传步骤（默认值）
<br/>
*/
SkipUploadFile?: boolean;
/**
* 禁止编辑填写控件
<br/>true:禁止编辑填写控件
<br/>false:允许编辑填写控件（默认值）
<br/>
*/
ForbidEditFillComponent?: boolean;
/**
* 定制化发起合同弹窗的描述信息，描述信息最长500字符
*/
CustomCreateFlowDescription?: string;
}
/**
* 解除协议的签署人，如不指定，默认使用原流程中的签署人。<br/>
`注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。`<br/>
`注意：目前不支持替换C端（个人身份类型）签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。`<br/>
`注意：当指定C端签署人的签署方自定义控件别名不空时，除RelievedApproverReceiptId参数外，可以只参数ApproverSignRole。`<br/>
*/
export interface ReleasedApprover {
/**
* 签署人姓名，最大长度50个字。
*/
Name: string;
/**
* 签署人手机号。
*/
Mobile: string;
/**
* 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
*/
RelievedApproverReceiptId: string;
/**
* 指定签署人类型，目前仅支持
<ul><li> **ORGANIZATION**：企业（默认值）</li>
<li> **ENTERPRISESERVER**：企业静默签</li></ul>
*/
ApproverType?: string;
/**
* 签署控件类型，支持自定义企业签署方的签署控件类型
<ul><li> **SIGN_SEAL**：默认为印章控件类型（默认值）</li>
<li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul>
*/
ApproverSignComponentType?: string;
/**
* 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`，以此类推。
如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
*/
ApproverSignRole?: string;
}
/**
* DescribeIntegrationRoles请求参数结构体
*/
export interface DescribeIntegrationRolesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 指定分页每页返回的数据条数，单页最大支持 200。
*/
Limit: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 查询的关键字段，支持Key-Value单值查询。可选键值对如下：
<ul>
<li>Key:"RoleType"，查询角色类型，Values可选：
<ul><li>**"1"**：查询系统角色</li><li>**"2"**：查询自定义角色</li></ul>
</li><li>Key:"RoleStatus"，查询角色状态，Values可选：
<ul><li>**"1"**：查询启用角色</li><li>**"2"**：查询禁用角色</li></ul>
</li><li>Key:"IsGroupRole"，是否查询集团角色，Values可选：
<ul><li>**"0"**：查询非集团角色</li><li>**"1"**：查询集团角色</li></ul>
</li><li>Key:"IsReturnPermissionGroup"，是否返回角色对应权限树，Values可选：
<ul><li>**"0"**：接口不返回角色对应的权限树字段</li><li>**"1"**：接口返回角色对应的权限树字段</li></ul>
</li>
</ul>
*/
Filters?: Array<Filter>;
/**
* 指定分页返回第几页的数据，如果不传默认返回第一页。页码从 0 开始，即首页为 0，最大2000。
*/
Offset?: number;
}
/**
* CreateFlowEvidenceReport请求参数结构体
*/
export interface CreateFlowEvidenceReportRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程ID，为32位字符串。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* StartFlow返回参数结构体
*/
export interface StartFlowResponse {
/**
* 发起成功后返回的状态，根据合同流程的不同，返回不同状态：
<ul><li> **START** : 发起成功, 合同进入签署环节</li>
<li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能，使用前请联系对接的客户经理沟通。`</li>
<li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
*/
Status?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 模板中指定的印章信息
*/
export interface SealInfo {
/**
* 印章ID
注意：此字段可能返回 null，表示取不到有效值。
*/
SealId?: string;
/**
* 印章类型。LEGAL_PERSON_SEAL: 法定代表人章；
ORGANIZATIONSEAL：企业印章；
OFFICIAL：企业公章；
CONTRACT：合同专用章
注意：此字段可能返回 null，表示取不到有效值。
*/
SealType?: string;
/**
* 印章名称
注意：此字段可能返回 null，表示取不到有效值。
*/
SealName?: string;
}
/**
* 集成版企业角色信息。
*/
export interface StaffRole {
/**
* 角色ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
RoleId?: string;
/**
* 角色名称。
注意：此字段可能返回 null，表示取不到有效值。
*/
RoleName?: string;
}
/**
* CreateBatchQuickSignUrl返回参数结构体
*/
export interface CreateBatchQuickSignUrlResponse {
/**
* 签署人签署链接信息
*/
FlowApproverUrlInfo?: FlowApproverUrlInfo;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIntegrationRole请求参数结构体
*/
export interface CreateIntegrationRoleRequest {
/**
* 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
*/
Name: string;
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 角色描述，最大长度为50个字符
*/
Description?: string;
/**
* 角色类型，0:saas角色，1:集团角色
默认0，saas角色
*/
IsGroupRole?: number;
/**
* 权限树
*/
PermissionGroups?: Array<PermissionGroup>;
/**
* 集团角色的话，需要传递集团子企业列表，如果是全选，则传1
*/
SubOrganizationIds?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DeleteIntegrationRoleUsers返回参数结构体
*/
export interface DeleteIntegrationRoleUsersResponse {
/**
* 角色id
*/
RoleId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateConvertTaskApi请求参数结构体
*/
export interface CreateConvertTaskApiRequest {
/**
* 需要进行转换的资源文件类型
支持的文件类型如下：
<ul><li>doc</li>
<li>docx</li>
<li>xls</li>
<li>xlsx</li>
<li>jpg</li>
<li>jpeg</li>
<li>png</li>
<li>html</li>
<li>bmp</li>
<li>txt</li></ul>
*/
ResourceType: string;
/**
* 需要进行转换操作的文件资源名称，带资源后缀名。
注: `资源名称长度限制为256个字符`
*/
ResourceName: string;
/**
* 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
注: `目前，此接口仅支持单个文件进行转换。`
*/
ResourceId: string;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 暂未开放
* @deprecated
*/
Organization?: OrganizationInfo;
}
/**
* DeleteIntegrationEmployees返回参数结构体
*/
export interface DeleteIntegrationEmployeesResponse {
/**
* 员工删除结果。包含成功数据与失败数据。
<ul><li>**成功数据**：展示员工姓名、手机号与电子签平台UserId</li>
<li>**失败数据**：展示员工电子签平台UserId、第三方平台OpenId和失败原因</li></ul>
*/
DeleteEmployeeResult?: DeleteStaffsResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateBatchSignUrl返回参数结构体
*/
export interface CreateBatchSignUrlResponse {
/**
* 批量签署链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。
注: `非小程序和APP集成使用`
*/
SignUrl?: string;
/**
* 链接过期时间以 Unix 时间戳格式表示，默认生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
*/
ExpiredTime?: number;
/**
* 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
注: `小程序和APP集成使用`
*/
MiniAppPath?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowReminds返回参数结构体
*/
export interface CreateFlowRemindsResponse {
/**
* 合同催办结果的详细信息列表。
*/
RemindFlowRecords?: Array<RemindFlowRecords>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOrganizationGroupOrganizations请求参数结构体
*/
export interface DescribeOrganizationGroupOrganizationsRequest {
/**
* 执行本接口操作的员工信息,userId必填。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 指定分页每页返回的数据条数，单页最大1000
*/
Limit: number;
/**
* 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
*/
Offset: number;
/**
* 查询成员企业的企业名，模糊匹配
*/
Name?: string;
/**
* 成员企业加入集团的当前状态
<ul><li> **1**：待授权</li>
<li> **2**：已授权待激活</li>
<li> **3**：拒绝授权</li>
<li> **4**：已解除</li>
<li> **5**：已加入</li>
</ul>
*/
Status?: number;
/**
* 是否导出当前成员企业数据
<ul><li> **false**：不导出（默认值）</li>
<li> **true**：导出</li></ul>
*/
Export?: boolean;
/**
* 成员企业机构 ID，32 位字符串，在PC控制台 集团管理可获取
*/
Id?: string;
}
/**
* 代理相关应用信息，如集团主企业代子企业操作
*/
export interface Agent {
/**
* 代理机构的应用编号,32位字符串，一般不用传
* @deprecated
*/
AppId?: string;
/**
* 被代理机构的应用号，一般不用传
* @deprecated
*/
ProxyAppId?: string;
/**
* 被代理机构在电子签平台的机构编号，集团代理下场景必传
*/
ProxyOrganizationId?: string;
/**
* 被代理机构的经办人，一般不用传
* @deprecated
*/
ProxyOperator?: string;
}
/**
* 签署人详情信息
*/
export interface FlowApproverDetail {
/**
* 签署时的相关信息
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproveMessage?: string;
/**
* 签署方姓名
*/
ApproveName?: string;
/**
* 签署方的签署状态
0：还没有发起
1：流程中 没有开始处理
2：待签署
3：已签署
4：已拒绝
5：已过期
6：已撤销
7：还没有预发起
8：待填写
9：因为各种原因而终止
10：填写完成
15：已解除
19：转他人处理
*/
ApproveStatus?: number;
/**
* 模板配置中的参与方ID,与控件绑定
*/
ReceiptId?: string;
/**
* 客户自定义的用户ID
注意：此字段可能返回 null，表示取不到有效值。
*/
CustomUserId?: string;
/**
* 签署人手机号
*/
Mobile?: string;
/**
* 签署顺序，如果是有序签署，签署顺序从小到大
*/
SignOrder?: number;
/**
* 签署人签署时间，时间戳，单位秒
*/
ApproveTime?: number;
/**
* 签署方类型，ORGANIZATION-企业员工，PERSON-个人，ENTERPRISESERVER-企业静默签
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproveType?: string;
/**
* 签署方侧用户来源，如WEWORKAPP-企业微信等
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproverSource?: string;
/**
* 客户自定义签署方标识
注意：此字段可能返回 null，表示取不到有效值。
*/
CustomApproverTag?: string;
/**
* 签署方企业Id
注意：此字段可能返回 null，表示取不到有效值。
*/
OrganizationId?: string;
/**
* 签署方企业名称
注意：此字段可能返回 null，表示取不到有效值。
*/
OrganizationName?: string;
/**
* 签署参与人在本流程中的编号ID（每个流程不同），可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。
注意：此字段可能返回 null，表示取不到有效值。
*/
SignId?: string;
/**
* 自定义签署人角色
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproverRoleName?: string;
}
/**
* CreateFlowGroupByFiles请求参数结构体
*/
export interface CreateFlowGroupByFilesRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
*/
FlowGroupName: string;
/**
* 合同（流程）组的子合同信息，支持2-50个子合同
*/
FlowGroupInfos: Array<FlowGroupInfo>;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 合同（流程）组的配置项信息。
其中包括：
<ul>
<li>是否通知本企业签署方</li>
<li>是否通知其他签署方</li>
</ul>
*/
FlowGroupOptions?: FlowGroupOptions;
}
/**
* DescribeFlowComponents返回参数结构体
*/
export interface DescribeFlowComponentsResponse {
/**
* 合同流程关联的填写控件信息，按照参与方进行分类返回。
注意：此字段可能返回 null，表示取不到有效值。
*/
RecipientComponentInfos?: Array<RecipientComponentInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFlowEvidenceReport返回参数结构体
*/
export interface DescribeFlowEvidenceReportResponse {
/**
* 出证报告PDF的下载 URL，`有效期为5分钟`，超过有效期后将无法再下载。
注意：此字段可能返回 null，表示取不到有效值。
*/
ReportUrl?: string;
/**
* 出证任务执行的状态, 状态含义如下：
<ul><li>**EvidenceStatusExecuting**： 出证任务在执行中</li>
<li>**EvidenceStatusSuccess**： 出证任务执行成功</li>
<li>**EvidenceStatusFailed** ： 出征任务执行失败</li></ul>
*/
Status?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 企业应用回调信息
*/
export interface CallbackInfo {
/**
* 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。
*/
CallbackUrl: string;
/**
* 回调加密key，已废弃
* @deprecated
*/
Token?: string;
/**
* 回调加密key，用于回调消息加解密。
*/
CallbackKey?: string;
/**
* 回调验签token，用于回调通知校验。
*/
CallbackToken?: string;
}
/**
* DeleteSealPolicies请求参数结构体
*/
export interface DeleteSealPoliciesRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 印章授权编码数组。这个参数跟下面的SealId其中一个必填，另外一个可选填
*/
PolicyIds?: Array<string>;
/**
* 电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
注：印章ID。这个参数跟上面的PolicyIds其中一个必填，另外一个可选填。
*/
SealId?: string;
/**
* 待授权的员工ID，员工在腾讯电子签平台的唯一身份标识，为32位字符串。
可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
*/
UserIds?: Array<string>;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateFlowGroupByTemplates返回参数结构体
*/
export interface CreateFlowGroupByTemplatesResponse {
/**
* 合同(流程)组的合同组Id
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowGroupId?: string;
/**
* 合同(流程)组中子合同列表.
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowIds?: Array<string>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 此结构体 (TemplateInfo) 用于描述模板的信息。
> **模板组成**
>
> 一个模板通常会包含以下结构信息
>- 模板基本信息
>- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
>- 填写控件 Components
>- 签署控件 SignComponents
>- 生成模板的文件基础信息 FileInfos
*/
export interface TemplateInfo {
/**
* 模板ID，模板的唯一标识
*/
TemplateId?: string;
/**
* 模板名
*/
TemplateName?: string;
/**
* 模板描述信息
*/
Description?: string;
/**
* 模板关联的资源ID列表
*/
DocumentResourceIds?: Array<string>;
/**
* 生成模板的文件基础信息
*/
FileInfos?: Array<FileInfo>;
/**
* 附件关联的资源ID
*/
AttachmentResourceIds?: Array<string>;
/**
* 签署顺序
无序 -1
有序为序列数字 0,1,2
*/
SignOrder?: Array<number | bigint>;
/**
* 模板中的签署参与方列表
*/
Recipients?: Array<Recipient>;
/**
* 模板的填充控件列表
*/
Components?: Array<Component>;
/**
* 模板中的签署控件列表
*/
SignComponents?: Array<Component>;
/**
* 模板状态
-1:不可用
0:草稿态
1:正式态，可以正常使用
*/
Status?: number;
/**
* 模板的创建者信息，电子签系统用户ID
*/
Creator?: string;
/**
* 模板创建的时间戳，格式为Unix标准时间戳（秒）
*/
CreatedOn?: number;
/**
* 发起方参与信息Promoter
*/
Promoter?: Recipient;
/**
* 模板类型：
1 静默签,
3 普通模板
*/
TemplateType?: number;
/**
* 模板可用状态：
1 启用（默认）
2 停用
*/
Available?: number;
/**
* 创建模板的企业ID，电子签的机构ID
*/
OrganizationId?: string;
/**
* 模板预览链接，有效时间5分钟
注意：此字段可能返回 null，表示取不到有效值。
*/
PreviewUrl?: string;
/**
* 模板版本。默认为空时，全数字字符，初始版本为yyyyMMdd001。
注意：此字段可能返回 null，表示取不到有效值。
*/
TemplateVersion?: string;
/**
* 模板是否已发布：
true-已发布
false-未发布
注意：此字段可能返回 null，表示取不到有效值。
*/
Published?: boolean;
/**
* 分享来源的模板ID。用在集团账号子企业模板里
注意：此字段可能返回 null，表示取不到有效值。
*/
ShareTemplateId?: string;
/**
* 模板内部指定的印章列表
注意：此字段可能返回 null，表示取不到有效值。
*/
TemplateSeals?: Array<SealInfo>;
/**
* 模板内部指定的印章列表
注意：此字段可能返回 null，表示取不到有效值。
* @deprecated
*/
Seals?: Array<SealInfo>;
}
/**
* CreateDocument返回参数结构体
*/
export interface CreateDocumentResponse {
/**
* 合同流程的底层电子文档ID，为32位字符串。
注:
后续需用同样的FlowId再次调用[发起签署流程](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow)，合同才能进入签署环节
*/
DocumentId?: string;
/**
* 合同预览链接URL。
注: `1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL`
`2.当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容`
注意：此字段可能返回 null，表示取不到有效值。
*/
PreviewFileUrl?: string;
/**
* 签署方信息，如角色ID、角色名称等
注意：此字段可能返回 null，表示取不到有效值。
*/
Approvers?: Array<ApproverItem>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIntegrationEmployees请求参数结构体
*/
export interface DescribeIntegrationEmployeesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 指定分页每页返回的数据条数，单页最大支持 20。
*/
Limit: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 查询的关键字段，支持Key-Values查询。可选键值如下：
<ul>
<li>Key:**"Status"**，根据实名状态查询员工，Values可选：
<ul><li>**["IsVerified"]**：查询已实名的员工</li><li>**["NotVerified"]**：查询未实名的员工</li></ul></li>
<li>Key:**"DepartmentId"**，根据部门ID查询部门下的员工，Values为指定的部门ID：**["DepartmentId"]**</li>
<li>Key:**"UserId"**，根据用户ID查询员工，Values为指定的用户ID：**["UserId"]**</li>
<li>Key:**"UserWeWorkOpenId"**，根据用户企微账号ID查询员工，Values为指定用户的企微账号ID：**["UserWeWorkOpenId"]**</li>
<li>Key:**"StaffOpenId"**，根据第三方系统用户OpenId查询员工，Values为第三方系统用户OpenId列表：**["OpenId1","OpenId2",...]**</li>
<li>Key:**"RoleId"**，根据电子签角色ID查询员工，Values为指定的角色ID，满足其中任意一个角色即可：**["RoleId1","RoleId2",...]**</li>
</ul>
*/
Filters?: Array<Filter>;
/**
* 指定分页返回第几页的数据，如果不传默认返回第一页。页码从 0 开始，即首页为 0，最大20000。
*/
Offset?: number;
}
/**
* CreateIntegrationUserRoles返回参数结构体
*/
export interface CreateIntegrationUserRolesResponse {
/**
* 绑定角色失败列表信息
*/
FailedCreateRoleData?: Array<FailedCreateRoleData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlow请求参数结构体
*/
export interface CreateFlowRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
FlowName: string;
/**
* 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
注: `approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效`
*/
Approvers: Array<FlowCreateApprover>;
/**
* 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
*/
FlowDescription?: string;
/**
* 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
*/
FlowType?: string;
/**
* 已经废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
*/
ClientToken?: string;
/**
* 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
DeadLine?: number;
/**
* 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
*/
RemindedOn?: number;
/**
* 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
*/
UserData?: string;
/**
* 合同流程的签署顺序类型：
<ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
<li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
注：`请和模板中的配置保持一致`
*/
Unordered?: boolean;
/**
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
<ul><li>{合同名称} </li>
<li>{发起方企业} </li>
<li>{发起方姓名} </li>
<li>{签署方N企业}</li>
<li>{签署方N姓名}</li></ul>
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
*/
CustomShowMap?: string;
/**
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
<ul><li> **false**：（默认）不需要审批，直接签署。</li>
<li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
<li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
NeedSignReview?: boolean;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
*/
CcInfos?: Array<CcInfo>;
/**
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签） </li></ul>
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
*/
AutoSignScene?: string;
/**
* 暂未开放
* @deprecated
*/
RelatedFlowId?: string;
/**
* 暂未开放
* @deprecated
*/
CallbackUrl?: string;
}
/**
* CreateSchemeUrl请求参数结构体
*/
export interface CreateSchemeUrlRequest {
/**
* 执行本接口操作的员工信息, userId 必填。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程签署方的组织机构名称。
如果名称中包含英文括号()，请使用中文括号（）代替。
*/
OrganizationName?: string;
/**
* 合同流程里边签署方经办人的姓名。
*/
Name?: string;
/**
* 合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
*/
Mobile?: string;
/**
* 证件类型，支持以下类型
<ul><li>ID_CARD : 居民身份证</li>
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
*/
IdCardType?: string;
/**
* 证件号码，应符合以下规则
<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
<li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母(但“I”、“O”除外)，后7位为阿拉伯数字。</li>
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
*/
IdCardNumber?: string;
/**
* 要跳转的链接类型
<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)</li>
<li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li>
<li>**APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li></ul>
*/
EndPoint?: string;
/**
* 合同流程ID
注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
*/
FlowId?: string;
/**
* 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
*/
FlowGroupId?: string;
/**
* 要跳转到的页面类型
<ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
<li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
<li> **2** : 腾讯电子签小程序合同列表页</li><li> **3** : 腾讯电子签小程序合同封面页
注：`生成动态签署人补充链接时，必须指定为封面页`</li></ul>
*/
PathType?: number;
/**
* 签署完成后是否自动回跳
<ul><li>**false**：否, 签署完成不会自动跳转回来(默认)</li><li>**true**：是, 签署完成会自动跳转回来</li></ul>
注: ` 该参数只针对"APP" 类型的签署链接有效`
*/
AutoJumpBack?: boolean;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
<ul><li> **0** :合同签署页面更多操作按钮</li>
<li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
<li> **2** :合同签署页面更多操作的转他人处理按钮</li>
<li> **3** :签署成功页的查看详情按钮</li></ul>
注: `字段为数组, 可以传值隐藏多个按钮`
*/
Hides?: Array<number | bigint>;
/**
* 签署节点ID，用于生成动态签署人链接完成领取。
注：`生成动态签署人补充链接时必传。`
*/
RecipientId?: string;
}
/**
* DeleteIntegrationDepartment返回参数结构体
*/
export interface DeleteIntegrationDepartmentResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自动签开启、签署相关配置
*/
export interface AutoSignConfig {
/**
* 自动签开通个人用户信息, 包括名字,身份证等
*/
UserInfo: UserThreeFactor;
/**
* 是否回调证书信息:
<ul><li>**false**: 不需要(默认)</li>
<li>**true**:需要</li></ul>
*/
CertInfoCallback?: boolean;
/**
* 是否支持用户自定义签名印章:
<ul><li>**false**: 不能自己定义(默认)</li>
<li>**true**: 可以自己定义</li></ul>
*/
UserDefineSeal?: boolean;
/**
* 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
<ul><li>**false**: 不需要(默认)</li>
<li>**true**: 需要</li></ul>
*/
SealImgCallback?: boolean;
/**
* 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。
腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
* @deprecated
*/
CallbackUrl?: string;
/**
* 开通时候的身份验证方式, 取值为：
<ul><li>**WEIXINAPP** : 微信人脸识别</li>
<li>**INSIGHT** : 慧眼人脸认别</li>
<li>**TELECOM** : 运营商三要素验证</li></ul>
注：
<ul><li>如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
<li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
*/
VerifyChannels?: Array<string>;
/**
* 设置用户开通自动签时是否绑定个人自动签账号许可。
<ul><li>**0**: (默认) 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
<li>**1**: 不绑定自动签账号许可开通，后续使用合同份额进行合同发起</li></ul>
*/
LicenseType?: number;
}
/**
* DescribeThirdPartyAuthCode请求参数结构体
*/
export interface DescribeThirdPartyAuthCodeRequest {
/**
* 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码，AuthCode由腾讯电子签小程序生成。
*/
AuthCode: string;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* UnbindEmployeeUserIdWithClientOpenId返回参数结构体
*/
export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
/**
* 解绑是否成功。
<ul><li> **0**：失败 </li>
<li> **1**：成功 </li></ul>
*/
Status?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateReleaseFlow返回参数结构体
*/
export interface CreateReleaseFlowResponse {
/**
* 解除协议流程编号
`注意：这里的流程编号对应的合同是本次发起的解除协议。`
*/
FlowId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateWebThemeConfig返回参数结构体
*/
export interface CreateWebThemeConfigResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindEmployeeUserIdWithClientOpenId请求参数结构体
*/
export interface BindEmployeeUserIdWithClientOpenIdRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)；或者通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取。
*/
UserId: string;
/**
* 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
*/
OpenId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateOrganizationInfoChangeUrl返回参数结构体
*/
export interface CreateOrganizationInfoChangeUrlResponse {
/**
* 创建的企业信息变更链接。
*/
Url?: string;
/**
* 链接过期时间。链接7天有效。
*/
ExpiredTime?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 权限树节点权限
*/
export interface Permission {
/**
* 权限名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 权限key
注意：此字段可能返回 null，表示取不到有效值。
*/
Key?: string;
/**
* 权限类型 1前端，2后端
注意：此字段可能返回 null，表示取不到有效值。
*/
Type?: number;
/**
* 是否隐藏
注意：此字段可能返回 null，表示取不到有效值。
*/
Hide?: number;
/**
* 数据权限标签 1:表示根节点，2:表示叶子结点
注意：此字段可能返回 null，表示取不到有效值。
*/
DataLabel?: number;
/**
* 数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权
注意：此字段可能返回 null，表示取不到有效值。
*/
DataType?: number;
/**
* 数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己
注意：此字段可能返回 null，表示取不到有效值。
*/
DataRange?: number;
/**
* 关联权限, 表示这个功能权限要受哪个数据权限管控
注意：此字段可能返回 null，表示取不到有效值。
*/
DataTo?: string;
/**
* 父级权限key
注意：此字段可能返回 null，表示取不到有效值。
*/
ParentKey?: string;
/**
* 是否选中
注意：此字段可能返回 null，表示取不到有效值。
*/
IsChecked?: boolean;
/**
* 子权限集合
注意：此字段可能返回 null，表示取不到有效值。
*/
Children?: Array<Permission>;
}
/**
* DescribeFlowBriefs返回参数结构体
*/
export interface DescribeFlowBriefsResponse {
/**
* 合同流程基础信息列表，包含流程的名称、状态、创建日期等基本信息。
注：`与入参 FlowIds 的顺序可能存在不一致的情况。`
*/
FlowBriefs?: Array<FlowBrief>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 企业员工信息。
*/
export interface Staff {
/**
* 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
注：`创建和更新场景无需填写。`
*/
UserId?: string;
/**
* 显示的用户名/昵称。
*/
DisplayName?: string;
/**
* 用户手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
*/
Mobile?: string;
/**
* 用户邮箱。
注意：此字段可能返回 null，表示取不到有效值。
*/
Email?: string;
/**
* 用户在第三方平台ID。
注：`如需在此接口提醒员工实名，该参数不传。`
注意：此字段可能返回 null，表示取不到有效值。
*/
OpenId?: string;
/**
* 员工角色信息。
注：`创建和更新场景无需填写。`
注意：此字段可能返回 null，表示取不到有效值。
*/
Roles?: Array<StaffRole>;
/**
* 员工部门信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
Department?: Department;
/**
* 员工是否实名。
注：`创建和更新场景无需填写。`
*/
Verified?: boolean;
/**
* 员工创建时间戳，单位秒。
注：`创建和更新场景无需填写。`
*/
CreatedOn?: number;
/**
* 员工实名时间戳，单位秒。
注：`创建和更新场景无需填写。`
注意：此字段可能返回 null，表示取不到有效值。
*/
VerifiedOn?: number;
/**
* 员工是否离职：
<ul><li>**0**：未离职</li><li>**1**：离职</li></ul>
注：`创建和更新场景无需填写。`
注意：此字段可能返回 null，表示取不到有效值。
*/
QuiteJob?: number;
/**
* 员工离职交接人用户ID。
注：`创建和更新场景无需填写。`
*/
ReceiveUserId?: string;
/**
* 员工离职交接人用户OpenId。
注：`创建和更新场景无需填写。`
*/
ReceiveOpenId?: string;
/**
* 企业微信用户账号ID。
注：`仅企微类型的企业创建员工接口支持该字段。`
注意：此字段可能返回 null，表示取不到有效值。
*/
WeworkOpenId?: string;
}
/**
* 签署控件的类型和范围限制条件，用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
*/
export interface ComponentLimit {
/**
* 控件类型，支持以下类型
<ul><li>SIGN_SEAL : 印章控件</li>
<li>SIGN_PAGING_SEAL : 骑缝章控件</li>
<li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
<li>SIGN_SIGNATURE : 用户签名控件</li></ul>
*/
ComponentType: string;
/**
* 签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围
1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）
2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）
<ul><li>HANDWRITE : 手写签名</li>
<li>OCR_ESIGN : OCR印章（智慧手写签名）</li>
<li>ESIGN : 个人印章</li>
<li>SYSTEM_ESIGN : 系统印章</li></ul>
3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
*/
ComponentValue?: Array<string>;
}
/**
* CreateIntegrationDepartment返回参数结构体
*/
export interface CreateIntegrationDepartmentResponse {
/**
* 电子签部门ID。建议开发者保存此部门ID，方便后续查询或修改部门信息。
*/
DeptId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFlowTemplates请求参数结构体
*/
export interface DescribeFlowTemplatesRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 查询内容控制
<ul><li>**0**：模板列表及详情（默认）</li>
<li>**1**：仅模板列表</li></ul>
*/
ContentType?: number;
/**
* 搜索条件，本字段用于指定模板Id进行查询。
Key：template-id Values：需要查询的模板Id列表
*/
Filters?: Array<Filter>;
/**
* 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
注：`1.offset从0开始，即第一页为0。`
`2.默认从第一页返回。`
*/
Offset?: number;
/**
* 指定每页返回的数据条数，和Offset参数配合使用。
注：`1.默认值为20，单页做大值为200。`
*/
Limit?: number;
/**
* 指定查询的应用号，指定后查询该应用号下的模板列表。
注：`1.ApplicationId为空时，查询所有应用下的模板列表。`
*/
ApplicationId?: string;
/**
* 默认为false，查询SaaS模板库列表；
为true，查询第三方应用集成平台企业模板库管理列表
* @deprecated
*/
IsChannel?: boolean;
/**
* 暂未开放
* @deprecated
*/
Organization?: OrganizationInfo;
/**
* 暂未开放
* @deprecated
*/
GenerateSource?: number;
/**
* 是否获取模板预览链接
*/
WithPreviewUrl?: boolean;
}
/**
* DeleteSealPolicies返回参数结构体
*/
export interface DeleteSealPoliciesResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 机构信息
*/
export interface OrganizationInfo {
/**
* 机构在平台的编号，内部字段，暂未开放
* @deprecated
*/
OrganizationId?: string;
/**
* 用户渠道，内部字段，暂未开放
* @deprecated
*/
Channel?: string;
/**
* 用户在渠道的机构编号，内部字段，暂未开放
* @deprecated
*/
OrganizationOpenId?: string;
/**
* 用户真实的IP，内部字段，暂未开放
* @deprecated
*/
ClientIp?: string;
/**
* 机构的代理IP，内部字段，暂未开放
* @deprecated
*/
ProxyIp?: string;
}
/**
* DescribeUserAutoSignStatus返回参数结构体
*/
export interface DescribeUserAutoSignStatusResponse {
/**
* 查询用户是否已开通自动签
*/
IsOpen?: boolean;
/**
* 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
值为unix时间戳,单位为秒。
*/
LicenseFrom?: number;
/**
* 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
值为unix时间戳,单位为秒。
*/
LicenseTo?: number;
/**
* 设置用户开通自动签时是否绑定个人自动签账号许可。
<ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li></ul>
*/
LicenseType?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateUserAutoSignSealUrl返回参数结构体
*/
export interface CreateUserAutoSignSealUrlResponse {
/**
* 腾讯电子签小程序的AppId，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
*/
AppId?: string;
/**
* 腾讯电子签小程序的原始Id，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
*/
AppOriginalId?: string;
/**
* 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
*/
Url?: string;
/**
* 腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
*/
Path?: string;
/**
* base64格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
*/
QrCode?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 补充签署人信息
- RecipientId 必须指定
- 通过企业微信自定义账号ID补充签署人时，ApproverSource 和 CustomUserId 必填，ApproverSource取值：WEWORKAPP
- 通过二要素（姓名/手机号）补充签署人时，ApproverName 和 ApproverMobile 必填，ApproverSource设置为空
*/
export interface FillApproverInfo {
/**
* 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
模板发起合同时，该参数为必填项。
文件发起合同是，该参数无需传值。
如果开发者后序用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
*/
RecipientId: string;
/**
* 签署人来源
WEWORKAPP: 企业微信
<br/>仅【企微或签】时指定WEWORKAPP
*/
ApproverSource?: string;
/**
* 企业微信UserId
<br/>当ApproverSource为WEWORKAPP的企微或签场景下，必须指企业自有应用获取企业微信的UserId
*/
CustomUserId?: string;
/**
* 补充企业签署人员工姓名
*/
ApproverName?: string;
/**
* 补充企业签署人员工手机号
*/
ApproverMobile?: string;
/**
* 补充企业动态签署人时，需要指定对应企业名称
*/
OrganizationName?: string;
}
/**
* 持有的电子印章信息
*/
export interface OccupiedSeal {
/**
* 电子印章编号
*/
SealId: string;
/**
* 电子印章名称
*/
SealName: string;
/**
* 电子印章授权时间戳，单位秒
*/
CreateOn: number;
/**
* 电子印章授权人的UserId
*/
Creator: string;
/**
* 电子印章策略Id
*/
SealPolicyId: string;
/**
* 印章状态，有以下六种：CHECKING（审核中）SUCCESS（已启用）FAIL（审核拒绝）CHECKING-SADM（待超管审核）DISABLE（已停用）STOPPED（已终止）
*/
SealStatus: string;
/**
* 审核失败原因
注意：此字段可能返回 null，表示取不到有效值。
*/
FailReason: string;
/**
* 印章图片url，5分钟内有效
*/
Url: string;
/**
* 印章类型,OFFICIAL-企业公章, CONTRACT-合同专用章,ORGANIZATIONSEAL-企业印章(本地上传印章类型),LEGAL_PERSON_SEAL-法人印章
*/
SealType: string;
/**
* 用印申请是否为永久授权，true-是，false-否
*/
IsAllTime: boolean;
/**
* 授权人列表
注意：此字段可能返回 null，表示取不到有效值。
*/
AuthorizedUsers: Array<AuthorizedUser>;
}
/**
* CreatePersonAuthCertificateImage返回参数结构体
*/
export interface CreatePers