/**
* 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;
/**
* 当前合同状态,如下是状态码对应的状态。
- **0**: 还没有发起
- **1**: 等待签署
- **2**: 部分签署
- **3**: 拒签
- **4**: 已签署
- **5**: 已过期
- **6**: 已撤销
- **7**: 还没有预发起
- **8**: 等待填写
- **9**: 部分填写
- **10**: 拒填
- **11**: 已解除
*/
Status?: number;
/**
* 查询的套餐类型
对应关系如下:
- **CloudEnterprise**: 企业版合同
- **SingleSignature**: 单方签章
- **CloudProve**: 签署报告
- **CloudOnlineSign**: 腾讯会议在线签约
- **ChannelWeCard**: 微工卡
- **SignFlow**: 合同套餐
- **SignFace**: 签署意愿（人脸识别）
- **SignPassword**: 签署意愿（密码）
- **SignSMS**: 签署意愿（短信）
- **PersonalEssAuth**: 签署人实名（腾讯电子签认证）
- **PersonalThirdAuth**: 签署人实名（信任第三方认证）
- **OrgEssAuth**: 签署企业实名
- **FlowNotify**: 短信通知
- **AuthService**: 企业工商信息查询
*/
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;
/**
* 电子印章生成方式
- 空值:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片
- SealGenerateSourceSystem: 系统生成印章, 无需上传SealImage图片
*/
GenerateSource?: string;
/**
* 电子印章类型 , 可选类型如下:
- **OFFICIAL**: (默认)公章
- **CONTRACT**: 合同专用章;
- **FINANCE**: 财务专用章;
- **PERSONNEL**: 人事专用章
- **INVOICE**: 发票专用章
注: `同企业下只能有一个公章, 重复创建会报错`
*/
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;
/**
* 印章样式, 可以选择的样式如下:
- **circle**:(默认)圆形印章
- **ellipse**:椭圆印章
*/
SealStyle?: string;
/**
* 印章尺寸取值描述, 可以选择的尺寸如下:
- **42_42**: 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效
- **40_40**: 圆形企业印章直径40mm, 当SealStyle是圆形的时候才有效
- **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效
- **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效
*/
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;
/**
* 签署报告编号, 由提交申请出证报告任务产生
*/
ReportId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* UpdateIntegrationEmployees返回参数结构体
*/
export interface UpdateIntegrationEmployeesResponse {
/**
* 更新成功的用户列表
*/
SuccessEmployeeData?: Array;
/**
* 更新失败的用户列表
*/
FailedEmployeeData?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集成版员工部门信息。
*/
export interface Department {
/**
* 部门ID。
*/
DepartmentId?: string;
/**
* 部门名称。
*/
DepartmentName?: string;
}
/**
* CreatePreparedPersonalEsign请求参数结构体
*/
export interface CreatePreparedPersonalEsignRequest {
/**
* 个人用户姓名
*/
UserName: string;
/**
* 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
IdCardNumber: string;
/**
* 印章名称，长度1-50个字。
*/
SealName: string;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 证件类型，支持以下类型
- ID_CARD : 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
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;
/**
* 是否处理印章，默认不做印章处理。
取值如下：
- false：不做任何处理；
- true：做透明化处理和颜色增强。
*/
ProcessSeal?: boolean;
/**
* 印章图片文件 id
取值：
填写的FileId通过UploadFiles接口上传文件获取。
*/
FileId?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
*/
LicenseType?: number;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
*/
SceneKey?: string;
}
/**
* DescribeIntegrationDepartments返回参数结构体
*/
export interface DescribeIntegrationDepartmentsResponse {
/**
* 部门信息列表。部门信息根据部门排序号OrderNo降序排列，根据部门创建时间升序排列。
*/
Departments?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteExtendedServiceAuthInfos返回参数结构体
*/
export interface DeleteExtendedServiceAuthInfosResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowApprovers返回参数结构体
*/
export interface CreateFlowApproversResponse {
/**
* 批量补充签署人时，补充失败的报错说明
注:`目前仅补充动态签署人时会返回补充失败的原因`
注意：此字段可能返回 null，表示取不到有效值。
*/
FillError?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFileUrls返回参数结构体
*/
export interface DescribeFileUrlsResponse {
/**
* 文件URL信息；
链接不是永久链接, 过期时间受UrlTtl入参的影响, 默认有效期5分钟后, 到期后链接失效。
*/
FileUrls?: Array;
/**
* URL数量
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateExtendedServiceAuthInfos请求参数结构体
*/
export interface CreateExtendedServiceAuthInfosRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 本企业员工的id，需要已实名，正常在职员工
*/
UserIds: Array;
/**
* 取值
- OPEN_SERVER_SIGN：企业自动签
- BATCH_SIGN：批量签署
*/
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 {
/**
* 签署短链接。
注意:
- 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
- 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
注意：此字段可能返回 null，表示取不到有效值。
*/
SignUrl?: string;
/**
* 签署人类型。
- **1**: 个人
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproverType?: number;
/**
* 签署人姓名。
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproverName?: string;
/**
* 签署人手机号。
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproverMobile?: string;
/**
* 签署长链接。
注意:
- 该链接有效期为**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;
/**
* 合同流程当前的签署状态, 会存在下列的状态值
- **0** : 未开启流程(合同中不存在填写环节)
- **1** : 待签署
- **2** : 部分签署
- **3** : 已拒签
- **4** : 已签署
- **5** : 已过期
- **6** : 已撤销
- **7** : 未开启流程(合同中存在填写环节)
- **8** : 等待填写
- **9** : 部分填写
- **10** : 已拒填
- **21** : 已解除
注意：此字段可能返回 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 中对应个人用户是否实名
- **VERIFIED** : 此个人已实名
- **UNVERIFIED**: 此个人未实名
*/
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 {
/**
* 绑定是否成功。
*/
Status?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIntegrationEmployees请求参数结构体
*/
export interface CreateIntegrationEmployeesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 待创建员工的信息，最多不超过20个。
其中入参Mobile和DisplayName必填，OpenId、Email和Department.DepartmentId选填，其他字段暂不支持设置。
在创建企微企业员工场景下，只需传入WeworkOpenId，无需再传其他信息。
*/
Employees: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 创建合同个性化参数
*/
export interface CreateFlowOption {
/**
* 是否允许修改发起合同时确认弹窗的合同信息（合同名称、合同类型、签署截止时间），若不允许编辑，则表单字段将被禁止输入。
true：允许编辑
false：不允许编辑（默认值）
*/
CanEditFlow?: boolean;
/**
* 是否允许编辑模板控件
true:允许编辑模板控件信息
false:不允许编辑模板控件信息（默认值）
*/
CanEditFormField?: boolean;
/**
* 发起页面隐藏合同名称展示
true:发起页面隐藏合同名称展示
false:发起页面不隐藏合同名称展示（默认值）
*/
HideShowFlowName?: boolean;
/**
* 发起页面隐藏合同类型展示
true:发起页面隐藏合同类型展示
false:发起页面不隐藏合同类型展示（默认值）
*/
HideShowFlowType?: boolean;
/**
* 发起页面隐藏合同截止日期展示
true:发起页面隐藏合同截止日期展示
false:发起页面不隐藏合同截止日期展示（默认值）
*/
HideShowDeadline?: boolean;
/**
* 发起页面允许跳过添加签署人环节
true:发起页面允许跳过添加签署人环节
false:发起页面不允许跳过添加签署人环节（默认值）
*/
CanSkipAddApprover?: boolean;
/**
* 文件发起页面跳过文件上传步骤
true:文件发起页面跳过文件上传步骤
false:文件发起页面不跳过文件上传步骤（默认值）
*/
SkipUploadFile?: boolean;
/**
* 禁止编辑填写控件
true:禁止编辑填写控件
false:允许编辑填写控件（默认值）
*/
ForbidEditFillComponent?: boolean;
/**
* 定制化发起合同弹窗的描述信息，描述信息最长500字符
*/
CustomCreateFlowDescription?: string;
}
/**
* 解除协议的签署人，如不指定，默认使用原流程中的签署人。
`注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。`
`注意：目前不支持替换C端（个人身份类型）签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。`
`注意：当指定C端签署人的签署方自定义控件别名不空时，除RelievedApproverReceiptId参数外，可以只参数ApproverSignRole。`
*/
export interface ReleasedApprover {
/**
* 签署人姓名，最大长度50个字。
*/
Name: string;
/**
* 签署人手机号。
*/
Mobile: string;
/**
* 要更换的原合同参与人RecipientId编号。(可通过接口DescribeFlowInfo查询签署人的RecipientId编号)
*/
RelievedApproverReceiptId: string;
/**
* 指定签署人类型，目前仅支持
- **ORGANIZATION**：企业（默认值）
- **ENTERPRISESERVER**：企业静默签
*/
ApproverType?: string;
/**
* 签署控件类型，支持自定义企业签署方的签署控件类型
- **SIGN_SEAL**：默认为印章控件类型（默认值）
- **SIGN_SIGNATURE**：手写签名控件类型
*/
ApproverSignComponentType?: string;
/**
* 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`，以此类推。
如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
*/
ApproverSignRole?: string;
}
/**
* DescribeIntegrationRoles请求参数结构体
*/
export interface DescribeIntegrationRolesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 指定分页每页返回的数据条数，单页最大支持 200。
*/
Limit: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 查询的关键字段，支持Key-Value单值查询。可选键值对如下：
- Key:"RoleType"，查询角色类型，Values可选：
- **"1"**：查询系统角色
- **"2"**：查询自定义角色
- Key:"RoleStatus"，查询角色状态，Values可选：
- **"1"**：查询启用角色
- **"2"**：查询禁用角色
- Key:"IsGroupRole"，是否查询集团角色，Values可选：
- **"0"**：查询非集团角色
- **"1"**：查询集团角色
- Key:"IsReturnPermissionGroup"，是否返回角色对应权限树，Values可选：
- **"0"**：接口不返回角色对应的权限树字段
- **"1"**：接口返回角色对应的权限树字段
*/
Filters?: Array;
/**
* 指定分页返回第几页的数据，如果不传默认返回第一页。页码从 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 {
/**
* 发起成功后返回的状态，根据合同流程的不同，返回不同状态：
- **START** : 发起成功, 合同进入签署环节
- **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能，使用前请联系对接的客户经理沟通。`
- **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节
*/
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;
/**
* 集团角色的话，需要传递集团子企业列表，如果是全选，则传1
*/
SubOrganizationIds?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DeleteIntegrationRoleUsers返回参数结构体
*/
export interface DeleteIntegrationRoleUsersResponse {
/**
* 角色id
*/
RoleId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateConvertTaskApi请求参数结构体
*/
export interface CreateConvertTaskApiRequest {
/**
* 需要进行转换的资源文件类型
支持的文件类型如下：
- doc
- docx
- xls
- xlsx
- jpg
- jpeg
- png
- html
- bmp
- txt
*/
ResourceType: string;
/**
* 需要进行转换操作的文件资源名称，带资源后缀名。
注: `资源名称长度限制为256个字符`
*/
ResourceName: string;
/**
* 需要进行转换操作的文件资源Id，通过UploadFiles接口获取文件资源Id。
注: `目前，此接口仅支持单个文件进行转换。`
*/
ResourceId: string;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 暂未开放
* @deprecated
*/
Organization?: OrganizationInfo;
}
/**
* DeleteIntegrationEmployees返回参数结构体
*/
export interface DeleteIntegrationEmployeesResponse {
/**
* 员工删除结果。包含成功数据与失败数据。
- **成功数据**：展示员工姓名、手机号与电子签平台UserId
- **失败数据**：展示员工电子签平台UserId、第三方平台OpenId和失败原因
*/
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;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOrganizationGroupOrganizations请求参数结构体
*/
export interface DescribeOrganizationGroupOrganizationsRequest {
/**
* 执行本接口操作的员工信息,userId必填。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 指定分页每页返回的数据条数，单页最大1000
*/
Limit: number;
/**
* 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
*/
Offset: number;
/**
* 查询成员企业的企业名，模糊匹配
*/
Name?: string;
/**
* 成员企业加入集团的当前状态
- **1**：待授权
- **2**：已授权待激活
- **3**：拒绝授权
- **4**：已解除
- **5**：已加入
*/
Status?: number;
/**
* 是否导出当前成员企业数据
- **false**：不导出（默认值）
- **true**：导出
*/
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;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 合同（流程）组的配置项信息。
其中包括：
*/
FlowGroupOptions?: FlowGroupOptions;
}
/**
* DescribeFlowComponents返回参数结构体
*/
export interface DescribeFlowComponentsResponse {
/**
* 合同流程关联的填写控件信息，按照参与方进行分类返回。
注意：此字段可能返回 null，表示取不到有效值。
*/
RecipientComponentInfos?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFlowEvidenceReport返回参数结构体
*/
export interface DescribeFlowEvidenceReportResponse {
/**
* 出证报告PDF的下载 URL，`有效期为5分钟`，超过有效期后将无法再下载。
注意：此字段可能返回 null，表示取不到有效值。
*/
ReportUrl?: string;
/**
* 出证任务执行的状态, 状态含义如下：
- **EvidenceStatusExecuting**： 出证任务在执行中
- **EvidenceStatusSuccess**： 出证任务执行成功
- **EvidenceStatusFailed** ： 出征任务执行失败
*/
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;
/**
* 电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
注：印章ID。这个参数跟上面的PolicyIds其中一个必填，另外一个可选填。
*/
SealId?: string;
/**
* 待授权的员工ID，员工在腾讯电子签平台的唯一身份标识，为32位字符串。
可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
*/
UserIds?: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateFlowGroupByTemplates返回参数结构体
*/
export interface CreateFlowGroupByTemplatesResponse {
/**
* 合同(流程)组的合同组Id
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowGroupId?: string;
/**
* 合同(流程)组中子合同列表.
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowIds?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 此结构体 (TemplateInfo) 用于描述模板的信息。
> **模板组成**
>
> 一个模板通常会包含以下结构信息
>- 模板基本信息
>- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
>- 填写控件 Components
>- 签署控件 SignComponents
>- 生成模板的文件基础信息 FileInfos
*/
export interface TemplateInfo {
/**
* 模板ID，模板的唯一标识
*/
TemplateId?: string;
/**
* 模板名
*/
TemplateName?: string;
/**
* 模板描述信息
*/
Description?: string;
/**
* 模板关联的资源ID列表
*/
DocumentResourceIds?: Array;
/**
* 生成模板的文件基础信息
*/
FileInfos?: Array;
/**
* 附件关联的资源ID
*/
AttachmentResourceIds?: Array;
/**
* 签署顺序
无序 -1
有序为序列数字 0,1,2
*/
SignOrder?: Array;
/**
* 模板中的签署参与方列表
*/
Recipients?: Array;
/**
* 模板的填充控件列表
*/
Components?: Array;
/**
* 模板中的签署控件列表
*/
SignComponents?: Array;
/**
* 模板状态
-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;
/**
* 模板内部指定的印章列表
注意：此字段可能返回 null，表示取不到有效值。
* @deprecated
*/
Seals?: Array;
}
/**
* 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;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIntegrationEmployees请求参数结构体
*/
export interface DescribeIntegrationEmployeesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 指定分页每页返回的数据条数，单页最大支持 20。
*/
Limit: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 查询的关键字段，支持Key-Values查询。可选键值如下：
- Key:**"Status"**，根据实名状态查询员工，Values可选：
- **["IsVerified"]**：查询已实名的员工
- **["NotVerified"]**：查询未实名的员工
- Key:**"DepartmentId"**，根据部门ID查询部门下的员工，Values为指定的部门ID：**["DepartmentId"]**
- Key:**"UserId"**，根据用户ID查询员工，Values为指定的用户ID：**["UserId"]**
- Key:**"UserWeWorkOpenId"**，根据用户企微账号ID查询员工，Values为指定用户的企微账号ID：**["UserWeWorkOpenId"]**
- Key:**"StaffOpenId"**，根据第三方系统用户OpenId查询员工，Values为第三方系统用户OpenId列表：**["OpenId1","OpenId2",...]**
- Key:**"RoleId"**，根据电子签角色ID查询员工，Values为指定的角色ID，满足其中任意一个角色即可：**["RoleId1","RoleId2",...]**
*/
Filters?: Array;
/**
* 指定分页返回第几页的数据，如果不传默认返回第一页。页码从 0 开始，即首页为 0，最大20000。
*/
Offset?: number;
}
/**
* CreateIntegrationUserRoles返回参数结构体
*/
export interface CreateIntegrationUserRolesResponse {
/**
* 绑定角色失败列表信息
*/
FailedCreateRoleData?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlow请求参数结构体
*/
export interface CreateFlowRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
FlowName: string;
/**
* 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
注: `approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效`
*/
Approvers: Array;
/**
* 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
*/
FlowDescription?: string;
/**
* 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
*/
FlowType?: string;
/**
* 已经废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
*/
ClientToken?: string;
/**
* 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
DeadLine?: number;
/**
* 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
*/
RemindedOn?: number;
/**
* 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
UserData?: string;
/**
* 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
注：`请和模板中的配置保持一致`
*/
Unordered?: boolean;
/**
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
*/
CustomShowMap?: string;
/**
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
NeedSignReview?: boolean;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
*/
CcInfos?: Array;
/**
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
- **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签）
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
*/
AutoSignScene?: string;
/**
* 暂未开放
* @deprecated
*/
RelatedFlowId?: string;
/**
* 暂未开放
* @deprecated
*/
CallbackUrl?: string;
}
/**
* CreateSchemeUrl请求参数结构体
*/
export interface CreateSchemeUrlRequest {
/**
* 执行本接口操作的员工信息, userId 必填。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程签署方的组织机构名称。
如果名称中包含英文括号()，请使用中文括号（）代替。
*/
OrganizationName?: string;
/**
* 合同流程里边签署方经办人的姓名。
*/
Name?: string;
/**
* 合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
*/
Mobile?: string;
/**
* 证件类型，支持以下类型
- ID_CARD : 居民身份证
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
IdCardType?: string;
/**
* 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。
- 港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母(但“I”、“O”除外)，后7位为阿拉伯数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
IdCardNumber?: string;
/**
* 要跳转的链接类型
- **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
- **HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
- **APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
*/
EndPoint?: string;
/**
* 合同流程ID
注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
*/
FlowId?: string;
/**
* 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
*/
FlowGroupId?: string;
/**
* 要跳转到的页面类型
- **0** : 腾讯电子签小程序个人首页 (默认)
- **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)
- **2** : 腾讯电子签小程序合同列表页
- **3** : 腾讯电子签小程序合同封面页
注：`生成动态签署人补充链接时，必须指定为封面页`
*/
PathType?: number;
/**
* 签署完成后是否自动回跳
- **false**：否, 签署完成不会自动跳转回来(默认)
- **true**：是, 签署完成会自动跳转回来
注: ` 该参数只针对"APP" 类型的签署链接有效`
*/
AutoJumpBack?: boolean;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
- **0** :合同签署页面更多操作按钮
- **1** :合同签署页面更多操作的拒绝签署按钮
- **2** :合同签署页面更多操作的转他人处理按钮
- **3** :签署成功页的查看详情按钮
注: `字段为数组, 可以传值隐藏多个按钮`
*/
Hides?: Array;
/**
* 签署节点ID，用于生成动态签署人链接完成领取。
注：`生成动态签署人补充链接时必传。`
*/
RecipientId?: string;
}
/**
* DeleteIntegrationDepartment返回参数结构体
*/
export interface DeleteIntegrationDepartmentResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自动签开启、签署相关配置
*/
export interface AutoSignConfig {
/**
* 自动签开通个人用户信息, 包括名字,身份证等
*/
UserInfo: UserThreeFactor;
/**
* 是否回调证书信息:
- **false**: 不需要(默认)
- **true**:需要
*/
CertInfoCallback?: boolean;
/**
* 是否支持用户自定义签名印章:
- **false**: 不能自己定义(默认)
- **true**: 可以自己定义
*/
UserDefineSeal?: boolean;
/**
* 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
- **false**: 不需要(默认)
- **true**: 需要
*/
SealImgCallback?: boolean;
/**
* 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。
腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
回调的相关说明可参考开发者中心的回调通知模块。
* @deprecated
*/
CallbackUrl?: string;
/**
* 开通时候的身份验证方式, 取值为：
- **WEIXINAPP** : 微信人脸识别
- **INSIGHT** : 慧眼人脸认别
- **TELECOM** : 运营商三要素验证
注：
- 如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP
- 如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT
*/
VerifyChannels?: Array;
/**
* 设置用户开通自动签时是否绑定个人自动签账号许可。
- **0**: (默认) 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`
- **1**: 不绑定自动签账号许可开通，后续使用合同份额进行合同发起
*/
LicenseType?: number;
}
/**
* DescribeThirdPartyAuthCode请求参数结构体
*/
export interface DescribeThirdPartyAuthCodeRequest {
/**
* 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码，AuthCode由腾讯电子签小程序生成。
*/
AuthCode: string;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* UnbindEmployeeUserIdWithClientOpenId返回参数结构体
*/
export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
/**
* 解绑是否成功。
*/
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)；或者通过DescribeIntegrationEmployees接口获取。
*/
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;
}
/**
* DescribeFlowBriefs返回参数结构体
*/
export interface DescribeFlowBriefsResponse {
/**
* 合同流程基础信息列表，包含流程的名称、状态、创建日期等基本信息。
注：`与入参 FlowIds 的顺序可能存在不一致的情况。`
*/
FlowBriefs?: Array;
/**
* 唯一请求 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;
/**
* 员工部门信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
Department?: Department;
/**
* 员工是否实名。
注：`创建和更新场景无需填写。`
*/
Verified?: boolean;
/**
* 员工创建时间戳，单位秒。
注：`创建和更新场景无需填写。`
*/
CreatedOn?: number;
/**
* 员工实名时间戳，单位秒。
注：`创建和更新场景无需填写。`
注意：此字段可能返回 null，表示取不到有效值。
*/
VerifiedOn?: number;
/**
* 员工是否离职：
注：`创建和更新场景无需填写。`
注意：此字段可能返回 null，表示取不到有效值。
*/
QuiteJob?: number;
/**
* 员工离职交接人用户ID。
注：`创建和更新场景无需填写。`
*/
ReceiveUserId?: string;
/**
* 员工离职交接人用户OpenId。
注：`创建和更新场景无需填写。`
*/
ReceiveOpenId?: string;
/**
* 企业微信用户账号ID。
注：`仅企微类型的企业创建员工接口支持该字段。`
注意：此字段可能返回 null，表示取不到有效值。
*/
WeworkOpenId?: string;
}
/**
* 签署控件的类型和范围限制条件，用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
*/
export interface ComponentLimit {
/**
* 控件类型，支持以下类型
- SIGN_SEAL : 印章控件
- SIGN_PAGING_SEAL : 骑缝章控件
- SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件
- SIGN_SIGNATURE : 用户签名控件
*/
ComponentType: string;
/**
* 签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围
1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）
2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）
- HANDWRITE : 手写签名
- OCR_ESIGN : OCR印章（智慧手写签名）
- ESIGN : 个人印章
- SYSTEM_ESIGN : 系统印章
3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
*/
ComponentValue?: Array;
}
/**
* CreateIntegrationDepartment返回参数结构体
*/
export interface CreateIntegrationDepartmentResponse {
/**
* 电子签部门ID。建议开发者保存此部门ID，方便后续查询或修改部门信息。
*/
DeptId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFlowTemplates请求参数结构体
*/
export interface DescribeFlowTemplatesRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 查询内容控制
- **0**：模板列表及详情（默认）
- **1**：仅模板列表
*/
ContentType?: number;
/**
* 搜索条件，本字段用于指定模板Id进行查询。
Key：template-id Values：需要查询的模板Id列表
*/
Filters?: Array;
/**
* 查询结果分页返回，指定从第几页返回数据，和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;
/**
* 设置用户开通自动签时是否绑定个人自动签账号许可。
- **0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`
*/
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: 企业微信
仅【企微或签】时指定WEWORKAPP
*/
ApproverSource?: string;
/**
* 企业微信UserId
当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;
}
/**
* CreatePersonAuthCertificateImage返回参数结构体
*/
export interface CreatePersonAuthCertificateImageResponse {
/**
* 个人用户认证证书图片下载URL，`有效期为5分钟`，超过有效期后将无法再下载。
*/
AuthCertUrl?: string;
/**
* 个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。
该编号会合成到个人用户证书证明图片。
注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
注意：此字段可能返回 null，表示取不到有效值。
*/
ImageCertId?: string;
/**
* CA供应商下发给用户的证书编号，在证书到期后自动续期后此证书编号会发生变动，且不会合成到个人用户证书证明图片中。
注意：`腾讯电子签接入多家CA供应商以提供容灾能力，不同CA下发的证书编号区别较大，但基本都是由数字和字母组成，长度在200以下。`
注意：此字段可能返回 null，表示取不到有效值。
*/
SerialNumber?: string;
/**
* CA证书颁发时间，格式为Unix标准时间戳（秒）
该时间格式化后会合成到个人用户证书证明图片
注意：此字段可能返回 null，表示取不到有效值。
*/
ValidFrom?: number;
/**
* CA证书有效截止时间，格式为Unix标准时间戳（秒）
该时间格式化后会合成到个人用户证书证明图片
注意：此字段可能返回 null，表示取不到有效值。
*/
ValidTo?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 删除员工失败数据
*/
export interface FailedDeleteStaffData {
/**
* 员工在电子签的userId
注意：此字段可能返回 null，表示取不到有效值。
*/
UserId: string;
/**
* 员工在第三方平台的openId
注意：此字段可能返回 null，表示取不到有效值。
*/
OpenId: string;
/**
* 失败原因
*/
Reason: string;
}
/**
* 合同文件验签单个结果结构体
*/
export interface PdfVerifyResult {
/**
* 验签结果。0-签名域未签名；1-验签成功； 3-验签失败；4-未找到签名域：文件内没有签名域；5-签名值格式不正确。
*/
VerifyResult?: number;
/**
* 签署平台
如果文件是在腾讯电子签平台签署，则为**腾讯电子签**，
如果文件不在腾讯电子签平台签署，则为**其他平台**。
*/
SignPlatform?: string;
/**
* 申请证书的主体的名字
如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
**企业**: ESS@企业名称@编码
**个人**: ESS@个人姓名@证件号@808854
如果在其他平台签署的, 主体的名字参考其他平台的说明
*/
SignerName?: string;
/**
* 签署时间的Unix时间戳，单位毫秒
*/
SignTime?: number;
/**
* 证书签名算法, 如SHA1withRSA等算法
*/
SignAlgorithm?: string;
/**
* CA供应商下发给用户的证书编号
注意：`腾讯电子签接入多家CA供应商以提供容灾能力，不同CA下发的证书编号区别较大，但基本都是由数字和字母组成，长度在200以下`。
*/
CertSn?: string;
/**
* 证书起始时间的Unix时间戳，单位毫秒
*/
CertNotBefore?: number;
/**
* 证书过期时间的时间戳，单位毫秒
*/
CertNotAfter?: number;
/**
* 签名域横坐标，单位px
*/
ComponentPosX?: number;
/**
* 签名域纵坐标，单位px
*/
ComponentPosY?: number;
/**
* 签名域宽度，单位px
*/
ComponentWidth?: number;
/**
* 签名域高度，单位px
*/
ComponentHeight?: number;
/**
* 签名域所在页码，1～N
*/
ComponentPage?: number;
}
/**
* CreateBatchCancelFlowUrl返回参数结构体
*/
export interface CreateBatchCancelFlowUrlResponse {
/**
* 批量撤回签署流程链接
*/
BatchCancelFlowUrl?: string;
/**
* 签署流程撤回失败信息
数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错
*/
FailMessages?: Array;
/**
* 签署连接过期时间字符串：年月日-时分秒
例如:2023-07-28 17:25:59
*/
UrlExpireOn?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用户的三要素：姓名，证件号，证件类型
*/
export interface UserThreeFactor {
/**
* 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
*/
Name: string;
/**
* 证件类型，支持以下类型
- ID_CARD : 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
IdCardType: string;
/**
* 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
IdCardNumber: string;
}
/**
* 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
*/
export interface SignQrCode {
/**
* 二维码ID，为32位字符串。
*/
QrCodeId?: string;
/**
* 二维码URL，可通过转换二维码的工具或代码组件将此URL转化为二维码，以便用户扫描进行流程签署。
*/
QrCodeUrl?: string;
/**
* 二维码的有截止时间，格式为Unix标准时间戳（秒）。
一旦超过二维码的有效期限，该二维码将自动失效。
*/
ExpiredTime?: number;
}
/**
* CreateSealPolicy返回参数结构体
*/
export interface CreateSealPolicyResponse {
/**
* 最终授权成功的用户ID，在腾讯电子签平台的唯一身份标识，为32位字符串。
可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
*/
UserIds?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisableUserAutoSign请求参数结构体
*/
export interface DisableUserAutoSignRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
*/
SceneKey: string;
/**
* 需要关闭自动签的个人的信息，如姓名，证件信息等。
*/
UserInfo: UserThreeFactor;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DescribeIntegrationEmployees返回参数结构体
*/
export interface DescribeIntegrationEmployeesResponse {
/**
* 员工信息列表。
注意：此字段可能返回 null，表示取不到有效值。
*/
Employees?: Array;
/**
* 指定分页返回第几页的数据。页码从 0 开始，即首页为 0，最大20000。
注意：此字段可能返回 null，表示取不到有效值。
*/
Offset?: number;
/**
* 指定分页每页返回的数据条数，单页最大支持 20。
*/
Limit?: number;
/**
* 符合条件的员工数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 删除员工的成功数据
*/
export interface SuccessDeleteStaffData {
/**
* 员工名
*/
DisplayName: string;
/**
* 员工手机号
*/
Mobile: string;
/**
* 员工在电子签平台的id
*/
UserId: string;
}
/**
* CreateConvertTaskApi返回参数结构体
*/
export interface CreateConvertTaskApiResponse {
/**
* 接口返回的文件转换任务Id，可以调用接口查询转换任务状态获取转换任务的状态和转换后的文件资源Id。
*/
TaskId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowSignReview请求参数结构体
*/
export interface CreateFlowSignReviewRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowId: string;
/**
* 企业审核结果
*/
ReviewType: string;
/**
* 审核结果原因，
字符串长度不超过200
当ReviewType 是拒绝（REJECT） 时此字段必填。
*/
ReviewMessage?: string;
/**
* 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
*/
Agent?: Agent;
/**
* 审核签署节点人标识，
用来标识审核的签署方。
如果签署审核节点是个人， 此参数必填。
*/
RecipientId?: string;
/**
* 操作类型：（接口通过该字段区分不同的操作类型）
- SignReview: 签署审核（默认）
- CreateReview: 创建审核
如果审核节点是个人，则操作类型只能为SignReview。
*/
OperateType?: string;
}
/**
* UnbindEmployeeUserIdWithClientOpenId请求参数结构体
*/
export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
*/
UserId: string;
/**
* 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。
该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
*/
OpenId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateSchemeUrl返回参数结构体
*/
export interface CreateSchemeUrlResponse {
/**
* 腾讯电子签小程序的签署链接。
- 如果EndPoint是**APP**，得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"
- 如果EndPoint是**HTTP**，得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`，点击后会跳转到腾讯电子签小程序进行签署
- 如果EndPoint是**HTTP_SHORT_URL**，得到的链接类似于 `https://essurl.cn/2n**42Nd`，点击后会跳转到腾讯电子签小程序进行签署
*/
SchemeUrl?: string;
/**
* 二维码，在生成动态签署人跳转封面页链接时返回
*/
SchemeQrcodeUrl?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowByFiles请求参数结构体
*/
export interface CreateFlowByFilesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
FlowName: string;
/**
* 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。
*/
Approvers: Array;
/**
* 本合同流程需包含的PDF文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
*/
FileIds: Array;
/**
* 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
*/
FlowDescription?: string;
/**
* 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
*/
FlowType?: string;
/**
* 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
*/
Components?: Array;
/**
* 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
*/
CcInfos?: Array;
/**
* 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
- **0**：合同发起时通知（默认值）
- **1**：签署完成后通知
*/
CcNotifyType?: number;
/**
* 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。
*/
NeedPreview?: boolean;
/**
* 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
*/
PreviewType?: number;
/**
* 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
Deadline?: number;
/**
* 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
*/
RemindedOn?: number;
/**
* 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
*/
Unordered?: boolean;
/**
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
*/
CustomShowMap?: string;
/**
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
NeedSignReview?: boolean;
/**
* 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
*/
UserData?: string;
/**
* 指定个人签署方查看合同的校验方式
- **VerifyCheck** :（默认）人脸识别,人脸识别后才能合同内容
- **MobileCheck** : 手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
*/
ApproverVerifyType?: string;
/**
* 签署方签署控件（印章/签名等）的生成方式：
- **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
- **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
*/
SignBeanTag?: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
- **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签）
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
*/
AutoSignScene?: string;
}
/**
* 此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息
*/
export interface FlowGroupInfo {
/**
* 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
FlowName: string;
/**
* 签署流程参与者信息，最大限制50方
注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
*/
Approvers: Array;
/**
* 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。
建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
*/
FileIds?: Array;
/**
* 合同模板ID，为32位字符串。
建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
*/
TemplateId?: string;
/**
* 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
示例值：劳务合同
*/
FlowType?: string;
/**
* 签署流程描述,最大长度1000个字符
*/
FlowDescription?: string;
/**
* 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
示例值：1604912664
*/
Deadline?: number;
/**
* 合同（流程）的回调地址
* @deprecated
*/
CallbackUrl?: string;
/**
* 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
UserData?: string;
/**
* 发送类型：
true：无序签
false：有序签
注：默认为false（有序签），请和模板中的配置保持一致
示例值：true
*/
Unordered?: boolean;
/**
* 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
*/
Components?: Array;
/**
* 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
示例值：true
*/
NeedSignReview?: boolean;
/**
* 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
示例值：E_PRESCRIPTION_AUTO_SIGN
*/
AutoSignScene?: string;
}
/**
* CreateFlowSignUrl返回参数结构体
*/
export interface CreateFlowSignUrlResponse {
/**
* 签署人签署链接信息
*/
FlowApproverUrlInfos?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 发起流程快速注册相关信息
*/
export interface RegisterInfo {
/**
* 法人姓名
*/
LegalName: string;
/**
* 社会统一信用代码
* @deprecated
*/
Uscc?: string;
/**
* 社会统一信用代码
*/
UnifiedSocialCreditCode?: string;
}
/**
* DescribeFileUrls请求参数结构体
*/
export interface DescribeFileUrlsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 文件对应的业务类型，目前支持：
- **FLOW ** : 如需下载合同文件请选择此项
- **TEMPLATE ** : 如需下载模板文件请选择此项
- **DOCUMENT **: 如需下载文档文件请选择此项
- **SEAL **: 如需下载印章图片请选择此项
*/
BusinessType: string;
/**
* 业务编号的数组，取值如下：
- 流程编号
- 模板编号
- 文档编号
- 印章编号
- 如需下载合同文件请传入FlowId，最大支持20个资源
*/
BusinessIds: Array;
/**
* 下载后的文件命名，只有FileType为zip的时候生效
*/
FileName?: string;
/**
* 要下载的文件类型，取值如下：
*/
FileType?: string;
/**
* 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 1000。
*/
Offset?: number;
/**
* 指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 100。
*/
Limit?: number;
/**
* 下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)
*/
UrlTtl?: number;
/**
* 暂不开放
* @deprecated
*/
CcToken?: string;
/**
* 暂不开放
* @deprecated
*/
Scene?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 电子文档的控件填充信息。按照控件类型进行相应的填充。
当控件的 ComponentType=‘SIGN_SEAL'时，FormField.ComponentValue填入印章id。
* 可用于指定自动签模板未设置自动签印章时，可由接口传入自动签印章
* 若指定的控件上已设置ComponentValue，那以已经设置的ComponentValue为准
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "sealId（印章id）"
}
```
当控件的 ComponentType='TEXT'时，FormField.ComponentValue填入文本内容
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "文本内容"
}
```
当控件的 ComponentType='MULTI_LINE_TEXT'时，FormField.ComponentValue填入文本内容，支持自动换行。
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "多行文本内容"
}
```
当控件的 ComponentType='CHECK_BOX'时，FormField.ComponentValue填入true或false文本
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "true"
}
```
当控件的 ComponentType='FILL_IMAGE'时，FormField.ComponentValue填入图片的资源ID
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
```
当控件的 ComponentType='ATTACHMENT'时，FormField.ComponentValue填入附件图片的资源ID列表，以逗号分隔，单个附件控件最多支持6个资源ID；
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
}
```
当控件的 ComponentType='SELECTOR'时，FormField.ComponentValue填入选择的选项内容；
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "选择的内容"
}
```
当控件的 ComponentType='DATE'时，FormField.ComponentValue填入日期内容；
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "2023年01月01日"
}
```
当控件的 ComponentType='DISTRICT'时，FormField.ComponentValue填入省市区内容；
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "广东省深圳市福田区"
}
```
【数据表格传参说明】
当控件的 ComponentType='DYNAMIC_TABLE'时，FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
输入示例1：
```
{
"headers":[
{
"content":"head1"
},
{
"content":"head2"
},
{
"content":"head3"
}
],
"rowCount":3,
"body":{
"cells":[
{
"rowStart":1,
"rowEnd":1,
"columnStart":1,
"columnEnd":1,
"content":"123"
},
{
"rowStart":2,
"rowEnd":3,
"columnStart":1,
"columnEnd":2,
"content":"456"
},
{
"rowStart":3,
"rowEnd":3,
"columnStart":3,
"columnEnd":3,
"content":"789"
}
]
}
}
```
输入示例2（表格表头宽度比例配置）：
```
{
"headers":[
{
"content":"head1",
"widthPercent": 30
},
{
"content":"head2",
"widthPercent": 30
},
{
"content":"head3",
"widthPercent": 40
}
],
"rowCount":3,
"body":{
"cells":[
{
"rowStart":1,
"rowEnd":1,
"columnStart":1,
"columnEnd":1,
"content":"123"
},
{
"rowStart":2,
"rowEnd":3,
"columnStart":1,
"columnEnd":2,
"content":"456"
},
{
"rowStart":3,
"rowEnd":3,
"columnStart":3,
"columnEnd":3,
"content":"789"
}
]
}
}
```
输入示例3（表格设置字体加粗颜色）：
```
{
"headers":[
{
"content":"head1"
},
{
"content":"head2"
},
{
"content":"head3"
}
],
"rowCount":3,
"body":{
"cells":[
{
"rowStart":1,
"rowEnd":1,
"columnStart":1,
"columnEnd":1,
"content":"123",
"style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "CENTER"}
},
{
"rowStart":2,
"rowEnd":3,
"columnStart":1,
"columnEnd":2,
"content":"456",
"style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "LEFT"}
},
{
"rowStart":3,
"rowEnd":3,
"columnStart":3,
"columnEnd":3,
"content":"789",
"style": {"color": "#b500bf", "fontSize": 12,"bold": false,"align": "RIGHT"}
}
]
}
}
```
表格参数说明
| 名称 | 类型 | 描述 |
| ------------------- | ------- | ------------------------------------------------- |
| headers | Array | 表头：不超过10列，不支持单元格合并，字数不超过100 |
| rowCount | Integer | 表格内容最大行数 |
| cells.N.rowStart | Integer | 单元格坐标：行起始index |
| cells.N.rowEnd | Integer | 单元格坐标：行结束index |
| cells.N.columnStart | Integer | 单元格坐标：列起始index |
| cells.N.columnEnd | Integer | 单元格坐标：列结束index |
| cells.N.content | String | 单元格内容，字数不超过100 |
| cells.N.style | String | 单元格字体风格配置 ，风格配置的json字符串 如： {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"} |
表格参数headers说明
widthPercent Integer 表头单元格列占总表头的比例，例如1：30表示 此列占表头的30%，不填写时列宽度平均拆分；例如2：总2列，某一列填写40，剩余列可以为空，按照60计算。；例如3：总3列，某一列填写30，剩余2列可以为空，分别为(100-30)/2=35
content String 表头单元格内容，字数不超过100
style String 为字体风格设置 风格支持： font : 目前支持 黑体、宋体; fontSize： 6-72; color：000000-FFFFFF 字符串形如： "#FFFFFF" 或者 "0xFFFFFF"; bold ： 是否加粗， true ： 加粗 false： 不加粗; align: 对其方式， 支持 LEFT / RIGHT / CENTER
*/
export interface FormField {
/**
* 控件填充vaule，ComponentType和传入值类型对应关系：
TEXT - 文本内容
MULTI_LINE_TEXT - 文本内容
CHECK_BOX - true/false
FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
SELECTOR - 选项值
DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
*/
ComponentValue: string;
/**
* 控件id，和ComponentName选择一项传入即可
*/
ComponentId?: string;
/**
* 控件名字，最大长度不超过30字符，和ComponentId选择一项传入即可
*/
ComponentName?: string;
}
/**
* CreateUserAutoSignSealUrl请求参数结构体
*/
export interface CreateUserAutoSignSealUrlRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
*/
SceneKey: string;
/**
* 自动签开通个人用户信息, 包括名字,身份证等。
*/
UserInfo: UserThreeFactor;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
*/
ExpiredTime?: number;
}
/**
* 用户信息
*/
export interface UserInfo {
/**
* 用户在平台的编号
*/
UserId?: string;
/**
* 用户的来源渠道，一般不用传，特定场景根据接口说明传值
* @deprecated
*/
Channel?: string;
/**
* 用户在渠道的编号，一般不用传，特定场景根据接口说明传值
* @deprecated
*/
OpenId?: string;
/**
* 用户真实IP，内部字段，暂未开放
* @deprecated
*/
ClientIp?: string;
/**
* 用户代理IP，内部字段，暂未开放
* @deprecated
*/
ProxyIp?: string;
}
/**
* CreateFlowApprovers请求参数结构体
*/
export interface CreateFlowApproversRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowId: string;
/**
* 补充企业签署人信息。
- 如果发起方指定的补充签署人是企业微信签署人（ApproverSource=WEWORKAPP），则需要提供企业微信UserId进行补充；
- 如果不指定，则使用姓名和手机号进行补充。
*/
Approvers: Array;
/**
* 签署人信息补充方式
- **0**: 添加或签人候选人，或签支持一个节点传多个签署人，不传值默认或签。
注: `或签只支持企业签署方`
- **1**: 表示往未指定签署人的节点，添加一个明确的签署人，支持企业或个人签署方。
*/
FillApproverType?: number;
/**
* 在可定制的企业微信通知中，发起人可以根据具体需求进行自定义设置。
*/
Initiator?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* ModifyIntegrationRole返回参数结构体
*/
export interface ModifyIntegrationRoleResponse {
/**
* 角色id
*/
RoleId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 扩展服务开通和授权的详细信息
*/
export interface ExtendAuthInfo {
/**
* 扩展服务的类型，可能是以下值：
- OPEN_SERVER_SIGN：企业静默签署
- OVERSEA_SIGN：企业与港澳台居民签署合同
- MOBILE_CHECK_APPROVER：使用手机号验证签署方身份
- PAGING_SEAL：骑缝章
- BATCH_SIGN：批量签署
*/
Type?: string;
/**
* 扩展服务的名称
*/
Name?: string;
/**
* 扩展服务的开通状态：
ENABLE：开通
DISABLE：未开通
*/
Status?: string;
/**
* 操作扩展服务的操作人UserId，员工在腾讯电子签平台的唯一身份标识，为32位字符串。
注意：此字段可能返回 null，表示取不到有效值。
*/
OperatorUserId?: string;
/**
* 扩展服务的操作时间，格式为Unix标准时间戳（秒）。
注意：此字段可能返回 null，表示取不到有效值。
*/
OperateOn?: number;
/**
* 该扩展服务若可以授权，此参数对应授权人员的列表
注意：此字段可能返回 null，表示取不到有效值。
*/
HasAuthUserList?: Array;
}
/**
* 创建流程的签署方信息
*/
export interface FlowCreateApprover {
/**
* 在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:
0：企业
1：个人
3：企业静默签署
注：类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
7: 个人自动签署，适用于个人自动签场景。
注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。
*/
ApproverType: number;
/**
* 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`
*/
OrganizationName?: string;
/**
* 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
在未指定签署人电子签UserId情况下，为必填参数
*/
ApproverName?: string;
/**
* 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此合同签署方。
在未指定签署人电子签UserId情况下，为必填参数
*/
ApproverMobile?: string;
/**
* 证件类型，支持以下类型
- ID_CARD : 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
ApproverIdCardType?: string;
/**
* 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
ApproverIdCardNumber?: string;
/**
* 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
模板发起合同时，该参数为必填项。
文件发起合同时，该参数无需传值。
如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
*/
RecipientId?: string;
/**
* 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
*/
VerifyChannel?: Array;
/**
* 通知签署方经办人的方式, 有以下途径:
- **sms** : (默认)短信
- **none** : 不通知
注: `发起方也是签署方时不给此签署方发送短信`
*/
NotifyType?: string;
/**
* 合同强制需要阅读全文，无需传此参数
*/
IsFullText?: boolean;
/**
* 合同的强制预览时间：3~300s，未指定则按合同页数计算
*/
PreReadTime?: number;
/**
* 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
注: `若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息`
*/
UserId?: string;
/**
* 字段已经废弃，当前只支持true，默认为true
*/
Required?: boolean;
/**
* 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
*/
ApproverSource?: string;
/**
* 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。
*/
CustomApproverTag?: string;
/**
* 已经废弃, 快速注册相关信息
*/
RegisterInfo?: RegisterInfo;
/**
* 签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。
*/
ApproverOption?: ApproverOption;
/**
* 签署完前端跳转的url，暂未使用
* @deprecated
*/
JumpUrl?: string;
/**
* 签署ID
- 发起流程时系统自动补充
- 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
*/
SignId?: string;
/**
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
ApproverNeedSignReview?: boolean;
/**
* 签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
SignComponents?: Array;
/**
* 签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
Components?: Array;
/**
* 签署方控件类型为 SIGN_SIGNATURE时，可以指定签署方签名方式
HANDWRITE – 手写签名
OCR_ESIGN -- AI智能识别手写签名
ESIGN -- 个人印章类型
SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
*/
ComponentLimitType?: Array;
/**
* 指定个人签署方查看合同的校验方式,可以传值如下:
- **1** : （默认）人脸识别,人脸识别后才能合同内容
- **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
注:
- 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
- 此字段可传多个校验方式
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
.
*/
ApproverVerifyTypes?: Array;
/**
* 您可以指定签署方签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证，需进行人脸识别成功后才能签署合同；
- **2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；
- **3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。
注：
- 默认情况下，认证校验方式为人脸认证和签署密码两种形式；
- 您可以传递多种值，表示可用多种认证校验方式。
注:
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
ApproverSignTypes?: Array;
}
/**
* 签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式
*/
export interface ApproverComponentLimitType {
/**
* 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
*/
RecipientId: string;
/**
* 签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式，可多选
签名方式：
- HANDWRITE-手写签名
- ESIGN-个人印章类型
- OCR_ESIGN-AI智能识别手写签名
- SYSTEM_ESIGN-系统签名
*/
Values: Array;
}
/**
* 参与方填写控件信息
*/
export interface RecipientComponentInfo {
/**
* 参与方Id
注意：此字段可能返回 null，表示取不到有效值。
*/
RecipientId?: string;
/**
* 参与方填写状态
注意：此字段可能返回 null，表示取不到有效值。
*/
RecipientFillStatus?: string;
/**
* 是否为发起方
注意：此字段可能返回 null，表示取不到有效值。
*/
IsPromoter?: boolean;
/**
* 填写控件列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Components?: Array;
}
/**
* CreateFlowEvidenceReport返回参数结构体
*/
export interface CreateFlowEvidenceReportResponse {
/**
* 出证报告 ID，可用于获取出证报告任务执行结果查询出证任务结果和出证PDF的下载URL
注意：此字段可能返回 null，表示取不到有效值。
*/
ReportId?: string;
/**
* 出证任务执行的状态, 状态含义如下：
- **EvidenceStatusExecuting**： 出证任务在执行中
- **EvidenceStatusSuccess**： 出证任务执行成功
- **EvidenceStatusFailed** ： 出征任务执行失败
*/
Status?: string;
/**
* 此字段已经废除,不再使用.
出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取
注意：此字段可能返回 null，表示取不到有效值。
* @deprecated
*/
ReportUrl?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIntegrationRole返回参数结构体
*/
export interface CreateIntegrationRoleResponse {
/**
* 角色id
*/
RoleId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFlowComponents请求参数结构体
*/
export interface DescribeFlowComponentsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateIntegrationDepartment请求参数结构体
*/
export interface CreateIntegrationDepartmentRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 部门名称，最大长度为50个字符。
*/
DeptName: string;
/**
* 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 电子签父部门ID。
注：`如果同时指定了ParentDeptId与ParentDeptOpenId参数，系统将优先使用ParentDeptId。当二者都未指定时，创建的新部门将自动填充至根节点部门下。`
*/
ParentDeptId?: string;
/**
* 第三方平台中父部门ID。
注：`如果同时指定了ParentDeptId与ParentDeptOpenId参数，系统将优先使用ParentDeptId。当二者都未指定时，创建的新部门将自动填充至根节点部门下。`
*/
ParentDeptOpenId?: string;
/**
* 客户系统部门ID，最大长度为64个字符。
*/
DeptOpenId?: string;
/**
* 排序号，支持设置的数值范围为1~30000。同一父部门下，排序号越大，部门顺序越靠前。
*/
OrderNo?: number;
}
/**
* 成员企业信息
*/
export interface GroupOrganization {
/**
* 成员企业名
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 成员企业别名
注意：此字段可能返回 null，表示取不到有效值。
*/
Alias?: string;
/**
* 成员企业id，为 32 位字符串，可在电子签PC 控制台，企业设置->企业电子签账号 获取
注意：此字段可能返回 null，表示取不到有效值。
*/
OrganizationId?: string;
/**
* 记录更新时间， unix时间戳，单位秒
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: number;
/**
* 成员企业加入集团的当前状态
- **1**：待授权
- **2**：已授权待激活
- **3**：拒绝授权
- **4**：已解除
- **5**：已加入
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: number;
/**
* 是否为集团主企业
注意：此字段可能返回 null，表示取不到有效值。
*/
IsMainOrganization?: boolean;
/**
* 企业社会信用代码
注意：此字段可能返回 null，表示取不到有效值。
*/
IdCardNumber?: string;
/**
* 企业超管信息
注意：此字段可能返回 null，表示取不到有效值。
*/
AdminInfo?: Admin;
/**
* 企业许可证Id，此字段暂时不需要关注
注意：此字段可能返回 null，表示取不到有效值。
*/
License?: string;
/**
* 企业许可证过期时间，unix时间戳，单位秒
注意：此字段可能返回 null，表示取不到有效值。
*/
LicenseExpireTime?: number;
/**
* 成员企业加入集团时间，unix时间戳，单位秒
注意：此字段可能返回 null，表示取不到有效值。
*/
JoinTime?: number;
/**
* 是否使用自建审批流引擎（即不是企微审批流引擎）
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowEngineEnable?: boolean;
}
/**
* 授权用户
*/
export interface AuthorizedUser {
/**
* 电子签系统中的用户id
*/
UserId: string;
}
/**
* CreateDocument请求参数结构体
*/
export interface CreateDocumentRequest {
/**
* 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
*/
Operator: UserInfo;
/**
* 合同流程ID，为32位字符串。
此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
*/
FlowId: string;
/**
* 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
*/
TemplateId: string;
/**
* 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
*/
FileNames?: Array;
/**
* 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
- 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
*/
FormFields?: Array;
/**
* 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。
注: `当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知`
*/
NeedPreview?: boolean;
/**
* 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子。
注: `1.此参数在NeedPreview 为true时有效`
`2.动态表格控件不支持H5链接方式预览`
*/
PreviewType?: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 已废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
*/
ClientToken?: string;
}
/**
* 催办接口返回的详细信息。
*/
export interface RemindFlowRecords {
/**
* 合同流程是否可以催办：
true - 可以，false - 不可以。
若无法催办，将返回RemindMessage以解释原因。
*/
CanRemind?: boolean;
/**
* 合同流程ID，为32位字符串。
*/
FlowId?: string;
/**
* 在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。
*/
RemindMessage?: string;
}
/**
* CreatePreparedPersonalEsign返回参数结构体
*/
export interface CreatePreparedPersonalEsignResponse {
/**
* 导入生成的印章ID，为32位字符串。
建议开发者保存此印章ID，开头实名认证后，通过此 ID查询导入的印章。
*/
SealId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOrganizationSeals返回参数结构体
*/
export interface DescribeOrganizationSealsResponse {
/**
* 在设置了SealId时返回0或1，没有设置时返回公司的总印章数量，可能比返回的印章数组数量多
*/
TotalCount?: number;
/**
* 查询到的印章结果数组
*/
Seals?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateEmbedWebUrl请求参数结构体
*/
export interface CreateEmbedWebUrlRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* WEB嵌入资源类型，支持以下类型
- CREATE_SEAL: 生成创建印章的嵌入页面
- CREATE_TEMPLATE：生成创建模板的嵌入页面
- MODIFY_TEMPLATE：生成编辑模板的嵌入页面
- PREVIEW_TEMPLATE：生成预览模板的嵌入页面
- PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
- PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
- EXTEND_SERVICE：生成拓展服务的嵌入页面
- PREVIEW_FLOW：生成预览合同的嵌入页面
- PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面
*/
EmbedType: string;
/**
* WEB嵌入的业务资源ID
- PREVIEW_SEAL_DETAIL，必填，取值为印章id
- MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id
- PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id
*/
BusinessId?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 抄送方信息
*/
Reviewer?: ReviewerInfo;
/**
* 个性化参数，用于控制页面展示内容
*/
Option?: EmbedUrlOption;
/**
* 用户自定义参数
- 目前仅支持EmbedType=CREATE_TEMPLATE时传入
- 指定后，创建，编辑，删除模板时，回调都会携带该userData
- 支持的格式：json字符串的BASE64编码字符串
- 示例：
- json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9
- eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式
*/
UserData?: string;
}
/**
* DeleteIntegrationEmployees请求参数结构体
*/
export interface DeleteIntegrationEmployeesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 待移除员工的信息。应符合以下规则：
- UserId和OpenId不可同时为空。
- 若需要进行离职交接，交接人信息ReceiveUserId和ReceiveOpenId不可同时为空。否则视为不进行离职交接。
*/
Employees: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 更新员工信息失败返回的数据信息
*/
export interface FailedUpdateStaffData {
/**
* 用户传入的名称
*/
DisplayName?: string;
/**
* 用户传入的手机号，明文展示
*/
Mobile?: string;
/**
* 失败原因
*/
Reason?: string;
/**
* 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
*/
UserId?: string;
/**
* 员工在第三方平台的openId
*/
OpenId?: string;
}
/**
* GetTaskResultApi请求参数结构体
*/
export interface GetTaskResultApiRequest {
/**
* 转换任务Id，通过接口创建文件转换任务接口或创建多文件转换任务接口
得到的转换任务id
*/
TaskId: string;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 暂未开放
* @deprecated
*/
Organization?: OrganizationInfo;
}
/**
* 此结构体(FlowGroupOptions)描述的是合同组的个性化配置，支持控制是否发送短信、未实名个人签署方查看合同组时是否需要实名认证（仅在合同组文件发起配置时生效）
*/
export interface FlowGroupOptions {
/**
* 签署人校验方式,支持以下类型
- VerifyCheck : 人脸识别 (默认值)
- MobileCheck : 手机号验证
参数说明：此参数仅在合同组文件发起有效，可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
*/
ApproverVerifyType?: string;
/**
* 发起合同（流程）组本方企业经办人通知方式
签署通知类型，支持以下类型
*/
SelfOrganizationApproverNotifyType?: string;
/**
* 发起合同（流程）组他方经办人通知方式
签署通知类型，支持以下类型
*/
OtherApproverNotifyType?: string;
}
/**
* ModifyIntegrationRole请求参数结构体
*/
export interface ModifyIntegrationRoleRequest {
/**
* 角色Id，可通过接口 DescribeIntegrationRoles 查询获取
*/
RoleId: string;
/**
* 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
*/
Name: string;
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 角色描述，最大长度为50个字符
*/
Description?: string;
/**
* 权限树
*/
PermissionGroups?: Array;
/**
* 集团角色的话，需要传递集团子企业列表，如果是全选，则传1
*/
SubOrganizationIds?: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateFlowGroupByFiles返回参数结构体
*/
export interface CreateFlowGroupByFilesResponse {
/**
* 合同(流程)组的合同组Id
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowGroupId?: string;
/**
* 合同(流程)组中子合同列表.
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowIds?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIntegrationEmployees返回参数结构体
*/
export interface CreateIntegrationEmployeesResponse {
/**
* 创建员工的结果。包含创建成功的数据与创建失败数据。
*/
CreateEmployeeResult?: CreateStaffResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 批量补充签署人时，补充失败的报错说明
*/
export interface FillError {
/**
* 为签署方经办人在签署合同中的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。与入参中补充的签署人角色ID对应，批量补充部分失败返回对应的错误信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
RecipientId?: string;
/**
* 补充失败错误说明
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrMessage?: string;
}
/**
* DeleteIntegrationRoleUsers请求参数结构体
*/
export interface DeleteIntegrationRoleUsersRequest {
/**
* 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 角色id，可以通过DescribeIntegrationRoles接口获取角色信息
*/
RoleId: string;
/**
* 用户信息,最多 200 个用户，并且 UserId 和 OpenId 二选一，其他字段不需要传
*/
Users: Array;
/**
* 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateFlowSignUrl请求参数结构体
*/
export interface CreateFlowSignUrlRequest {
/**
* 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowId: string;
/**
* 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，其他可不传，
注:
`1. ApproverType目前只支持个人类型的签署人。`
`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
*/
FlowApproverInfos: Array;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 机构信息，暂未开放
* @deprecated
*/
Organization?: OrganizationInfo;
/**
* 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
*/
JumpUrl?: string;
}
/**
* CreateReleaseFlow请求参数结构体
*/
export interface CreateReleaseFlowRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 待解除的签署流程编号（即原签署流程的编号）。
*/
NeedRelievedFlowId: string;
/**
* 解除协议内容, 包括解除理由等信息。
*/
ReliveInfo: RelieveInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 替换解除协议的签署人， 如不指定替换签署人, 则使用原流程的签署人。
如需更换原合同中的企业端签署人，可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口DescribeFlowInfo查询签署人的RecipientId编号)
注意：
`只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人。`
`可以不指定替换签署人, 使用原流程的签署人 `
*/
ReleasedApprovers?: Array;
/**
* 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
Deadline?: number;
/**
* 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
UserData?: string;
}
/**
* CreateIntegrationUserRoles请求参数结构体
*/
export interface CreateIntegrationUserRolesRequest {
/**
* 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 绑定角色的用户id列表，不能重复，不能大于 100 个
*/
UserIds: Array;
/**
* 绑定角色的角色id列表，不能重复，不能大于 100，可以通过DescribeIntegrationRoles接口获取角色信息
*/
RoleIds: Array;
/**
* 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
*/
export interface FlowDetailInfo {
/**
* 合同流程ID，为32位字符串。
*/
FlowId?: string;
/**
* 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
*/
FlowName?: string;
/**
* 合同流程的类别分类（如销售合同/入职合同等）。
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowType?: string;
/**
* 合同流程当前的签署状态, 会存在下列的状态值 - **0** : 未开启流程(合同中不存在填写环节)
- **1** : 待签署
- **2** : 部分签署
- **3** : 已拒签
- **4** : 已签署
- **5** : 已过期
- **6** : 已撤销
- **7** : 未开启流程(合同中存在填写环节)
- **8** : 等待填写
- **9** : 部分填写
- **10** : 已拒填
- **21** : 已解除
*/
FlowStatus?: number;
/**
* 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowMessage?: string;
/**
* 合同流程描述信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
FlowDescription?: string;
/**
* 合同流程的创建时间戳，格式为Unix标准时间戳（秒）。
*/
CreatedOn?: number;
/**
* 合同流程的签署方数组
*/
FlowApproverInfos?: Array;
/**
* 合同流程的关注方信息数组
*/
CcInfos?: Array;
/**
* 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
注意：此字段可能返回 null，表示取不到有效值。
*/
Creator?: string;
}
/**
* 更新员工信息成功返回的数据信息
*/
export interface SuccessUpdateStaffData {
/**
* 传入的用户名称
*/
DisplayName?: string;
/**
* 传入的手机号，没有打码
*/
Mobile?: string;
/**
* 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
*/
UserId?: string;
}
/**
* CreatePersonAuthCertificateImage请求参数结构体
*/
export interface CreatePersonAuthCertificateImageRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 个人用户名称
*/
UserName: string;
/**
* 证件类型，支持以下类型
- ID_CARD : 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
IdCardType: string;
/**
* 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
IdCardNumber: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
*/
SceneKey?: string;
}
/**
* CreateFlowByFiles返回参数结构体
*/
export interface CreateFlowByFilesResponse {
/**
* 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
*/
FlowId?: string;
/**
* 合同预览链接URL。
注：如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
注意：此字段可能返回 null，表示取不到有效值。
*/
PreviewUrl?: string;
/**
* 签署方信息，如角色ID、角色名称等
注意：此字段可能返回 null，表示取不到有效值。
*/
Approvers?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UploadFiles返回参数结构体
*/
export interface UploadFilesResponse {
/**
* 文件资源ID数组，每个文件资源ID为32位字符串。
建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
*/
FileIds?: Array;
/**
* 上传成功文件数量
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 创建员工的成功数据
*/
export interface SuccessCreateStaffData {
/**
* 员工名
*/
DisplayName?: string;
/**
* 员工手机号
*/
Mobile?: string;
/**
* 员工在电子签平台的id
*/
UserId?: string;
/**
* 提示，当创建已存在未实名用户时，该字段有值
注意：此字段可能返回 null，表示取不到有效值。
*/
Note?: string;
/**
* 传入的企微账号id
*/
WeworkOpenId?: string;
}
/**
* 流程中参与方的信息结构
*/
export interface Recipient {
/**
* 签署参与者ID，唯一标识
*/
RecipientId?: string;
/**
* 参与者类型。
默认为空。
ENTERPRISE-企业；
INDIVIDUAL-个人；
PROMOTER-发起方
*/
RecipientType?: string;
/**
* 描述信息
*/
Description?: string;
/**
* 角色名称
*/
RoleName?: string;
/**
* 是否需要验证，
默认为false-不需要验证
*/
RequireValidation?: boolean;
/**
* 是否需要签署，
默认为true-需要签署
*/
RequireSign?: boolean;
/**
* 此参与方添加的顺序，从0～N
*/
RoutingOrder?: number;
/**
* 是否需要发送，
默认为true-需要发送
*/
RequireDelivery?: boolean;
/**
* 邮箱地址
*/
Email?: string;
/**
* 电话号码
*/
Mobile?: string;
/**
* 关联的用户ID，电子签系统的用户ID
*/
UserId?: string;
/**
* 发送方式，默认为EMAIL。
EMAIL-邮件；
MOBILE-手机短信；
WECHAT-微信通知
*/
DeliveryMethod?: string;
/**
* 参与方的一些附属信息，json格式
*/
RecipientExtra?: string;
/**
* 签署人查看合同校验方式, 支持的类型如下:
*/
ApproverVerifyTypes?: Array;
/**
* 签署人进行合同签署时的认证方式，支持的类型如下:
- 1 :人脸认证
- 2 :签署密码
- 3 :运营商三要素认证
- 4 :UKey认证
*/
ApproverSignTypes?: Array;
}
/**
* VerifyPdf请求参数结构体
*/
export interface VerifyPdfRequest {
/**
* 合同流程ID，为32位字符串。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowId: string;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 绑定角色失败信息
*/
export interface FailedCreateRoleData {
/**
* 用户userId
注意：此字段可能返回 null，表示取不到有效值。
*/
UserId?: string;
/**
* 角色id列表
注意：此字段可能返回 null，表示取不到有效值。
*/
RoleIds?: Array;
}
/**
* 合同参与者信息。
*/
export interface ApproverInfo {
/**
* 在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:
**0**：企业
**1**：个人
**3**：企业静默签署
注：`类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。`
**7**: 个人自动签署，适用于个人自动签场景。
注: `个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。`
*/
ApproverType: number;
/**
* 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
*/
ApproverName: string;
/**
* 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此合同签署方。
*/
ApproverMobile: string;
/**
* 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。
*/
OrganizationName?: string;
/**
* 合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
*/
SignComponents?: Array;
/**
* 签署方经办人的证件类型，支持以下类型
- ID_CARD 居民身份证 (默认值)
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
- OTHER_CARD_TYPE 其他证件
注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
*/
ApproverIdCardType?: string;
/**
* 签署方经办人的证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
ApproverIdCardNumber?: string;
/**
* 通知签署方经办人的方式, 有以下途径:
- **sms** : (默认)短信
- **none** : 不通知
*/
NotifyType?: string;
/**
* 收据场景设置签署人角色类型, 可以设置如下****类型****:
- **1** :收款人
- **2** :开具人
- **3** :见证人
注: `收据场景为白名单功能，使用前请联系对接的客户经理沟通。`
*/
ApproverRole?: number;
/**
* 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。
注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
*/
ApproverRoleName?: string;
/**
* 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
*/
VerifyChannel?: Array;
/**
* 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：
- 合同页数少于等于2页，阅读时间为3秒；
- 合同页数为3到5页，阅读时间为5秒；
- 合同页数大于等于6页，阅读时间为10秒。
*/
PreReadTime?: number;
/**
* 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
注: `若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息`
*/
UserId?: string;
/**
* 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
*/
ApproverSource?: string;
/**
* 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。
*/
CustomApproverTag?: string;
/**
* 可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人等。
详细操作可以参考开发者中心的ApproverOption结构体。
*/
ApproverOption?: ApproverOption;
/**
* 指定个人签署方查看合同的校验方式,可以传值如下:
- **1** : （默认）人脸识别,人脸识别后才能合同内容
- **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
注:
- 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
- 此字段可传多个校验方式
*/
ApproverVerifyTypes?: Array;
/**
* 您可以指定签署方签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证，需进行人脸识别成功后才能签署合同；
- **2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；
- **3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。
注：
1. 默认情况下，认证校验方式为人脸认证和签署密码两种形式
2. 您可以传递多种值，表示可用多种认证校验方式
3. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明
*/
ApproverSignTypes?: Array;
/**
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
ApproverNeedSignReview?: boolean;
/**
* [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID）或签名方式。
注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
*/
AddSignComponentsLimits?: Array;
/**
* 签署须知：支持传入富文本，最长字数：500个中文字符
*/
SignInstructionContent?: string;
}
/**
* CreateFlowSignReview返回参数结构体
*/
export interface CreateFlowSignReviewResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyIntegrationDepartment请求参数结构体
*/
export interface ModifyIntegrationDepartmentRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 电子签部门ID，通过DescribeIntegrationDepartments接口获得。
*/
DeptId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 电子签父部门ID，通过DescribeIntegrationDepartments接口获得。
*/
ParentDeptId?: string;
/**
* 部门名称，最大长度为50个字符。
*/
DeptName?: string;
/**
* 客户系统部门ID，最大长度为64个字符。
*/
DeptOpenId?: string;
/**
* 排序号，支持设置的数值范围为1~30000。同一父部门下，排序号越大，部门顺序越靠前。
*/
OrderNo?: number;
}
/**
* 查询过滤条件
*/
export interface Filter {
/**
* 查询过滤条件的Key
*/
Key: string;
/**
* 查询过滤条件的Value列表
*/
Values: Array;
}
/**
* 创建员工的结果
*/
export interface CreateStaffResult {
/**
* 创建员工的成功列表
注意：此字段可能返回 null，表示取不到有效值。
*/
SuccessEmployeeData: Array;
/**
* 创建员工的失败列表
注意：此字段可能返回 null，表示取不到有效值。
*/
FailedEmployeeData: Array;
}
/**
* CreateUserAutoSignEnableUrl请求参数结构体
*/
export interface CreateUserAutoSignEnableUrlRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
*/
SceneKey: string;
/**
* 自动签开通配置信息, 包括开通的人员的信息等
*/
AutoSignConfig: AutoSignConfig;
/**
* 生成的链接类型：
- 不传(即为空值) 则会生成小程序端开通链接(默认)
- **H5SIGN** : 生成H5端开通链接
*/
UrlType?: string;
/**
* 是否通知开通方，通知类型:
- 默认不设置为不通知开通方
- **SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号
*/
NotifyType?: string;
/**
* 如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项
*/
NotifyAddress?: string;
/**
* 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
*/
ExpiredTime?: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateOrganizationBatchSignUrl返回参数结构体
*/
export interface CreateOrganizationBatchSignUrlResponse {
/**
* 批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
*/
SignUrl?: string;
/**
* 链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。
*/
ExpiredTime?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 模板中文件的信息结构
*/
export interface FileInfo {
/**
* 文件ID
*/
FileId?: string;
/**
* 文件名
*/
FileName?: string;
/**
* 文件大小，单位为Byte
*/
FileSize?: number;
/**
* 文件上传时间，格式为Unix标准时间戳（秒）
*/
CreatedOn?: number;
}
/**
* CancelUserAutoSignEnableUrl请求参数结构体
*/
export interface CancelUserAutoSignEnableUrlRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
*/
SceneKey: string;
/**
* 预撤销链接的用户信息，包含姓名、证件类型、证件号码等信息。
*/
UserInfo: UserThreeFactor;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 创建员工的失败数据
*/
export interface FailedCreateStaffData {
/**
* 员工名
*/
DisplayName?: string;
/**
* 员工手机号
*/
Mobile?: string;
/**
* 传入的企微账号id
*/
WeworkOpenId?: string;
/**
* 失败原因
*/
Reason?: string;
}
/**
* CreateExtendedServiceAuthInfos返回参数结构体
*/
export interface CreateExtendedServiceAuthInfosResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 指定签署人限制项
*/
export interface ApproverRestriction {
/**
* 指定签署人名字
*/
Name?: string;
/**
* 指定签署人手机号，11位数字
*/
Mobile?: string;
/**
* 指定签署人证件类型，ID_CARD-身份证
*/
IdCardType?: string;
/**
* 指定签署人证件号码，字母大写
*/
IdCardNumber?: string;
}
/**
* CreateWebThemeConfig请求参数结构体
*/
export interface CreateWebThemeConfigRequest {
/**
* 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 主题类型，取值如下：
- **EMBED_WEB_THEME**：嵌入式主题（默认），web页面嵌入的主题风格配置
*/
ThemeType: string;
/**
* 电子签logo是否展示，主体颜色等配置项
*/
WebThemeConfig: WebThemeConfig;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 签署方信息，发起合同后可获取到对应的签署方信息，如角色ID，角色名称
*/
export interface ApproverItem {
/**
* 签署方唯一编号
注意：此字段可能返回 null，表示取不到有效值。
*/
SignId?: string;
/**
* 签署方角色编号
注意：此字段可能返回 null，表示取不到有效值。
*/
RecipientId?: string;
/**
* 签署方角色名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ApproverRoleName?: string;
}
/**
* CreateOrganizationBatchSignUrl请求参数结构体
*/
export interface CreateOrganizationBatchSignUrlRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 请指定需执行批量签署的流程ID，数量范围为1-100。
您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。
用户将利用链接对这些合同实施批量操作。
*/
FlowIds: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 员工在腾讯电子签平台的独特身份标识，为32位字符串。
您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的UserId（在页面中显示为用户ID）。
UserId必须是传入合同（FlowId）中的签署人。
- 1. 若UserId为空，Name和Mobile 必须提供。
- 2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。
*/
UserId?: string;
/**
* 员工姓名，必须与手机号码一起使用。
如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
*/
Name?: string;
/**
* 员工手机号，必须与姓名一起使用。
如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
*/
Mobile?: string;
}
/**
* 企业角色数据信息
*/
export interface IntegrateRole {
/**
* 角色id
注意：此字段可能返回 null，表示取不到有效值。
*/
RoleId?: string;
/**
* 角色名
注意：此字段可能返回 null，表示取不到有效值。
*/
RoleName?: string;
/**
* 角色状态，1-启用，2-禁用
注意：此字段可能返回 null，表示取不到有效值。
*/
RoleStatus?: number;
/**
* 是否是集团角色，true-是，false-否
注意：此字段可能返回 null，表示取不到有效值。
*/
IsGroupRole?: boolean;
/**
* 管辖的子企业列表
注意：此字段可能返回 null，表示取不到有效值。
*/
SubOrgIdList?: Array;
/**
* 权限树
注意：此字段可能返回 null，表示取不到有效值。
*/
PermissionGroups?: Array;
}
/**
* CreatePrepareFlow返回参数结构体
*/
export interface CreatePrepareFlowResponse {
/**
* 发起流程的web页面链接，有效期5分钟
*/
Url?: string;
/**
* 创建的合同id（还未实际发起），每次调用会生成新的id，用户可以记录此字段对应后续页面发起的合同，若在页面上未成功发起，则此字段无效。
*/
FlowId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetTaskResultApi返回参数结构体
*/
export interface GetTaskResultApiResponse {
/**
* 任务Id
*/
TaskId?: string;
/**
* 任务状态，需要关注的状态
- **0** :NeedTranform - 任务已提交
- **4** :Processing - 文档转换中
- **8** :TaskEnd - 任务处理完成
- **-2** :DownloadFailed - 下载失败
- **-6** :ProcessFailed - 转换失败
- **-13**:ProcessTimeout - 转换文件超时
*/
TaskStatus?: number;
/**
* 状态描述，需要关注的状态
- **NeedTranform** : 任务已提交
- **Processing** : 文档转换中
- **TaskEnd** : 任务处理完成
- **DownloadFailed** : 下载失败
- **ProcessFailed** : 转换失败
- **ProcessTimeout** : 转换文件超时
*/
TaskMessage?: string;
/**
* 资源Id，也是FileId，用于文件发起时使用
*/
ResourceId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelMultiFlowSignQRCode请求参数结构体
*/
export interface CancelMultiFlowSignQRCodeRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 二维码ID，为32位字符串。
*/
QrCodeId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DeleteIntegrationDepartment请求参数结构体
*/
export interface DeleteIntegrationDepartmentRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 电子签中的部门ID，通过DescribeIntegrationDepartments接口可获得。
*/
DeptId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 交接部门ID。
待删除部门中的合同、印章和模板数据，将会被交接至该部门ID下；若未填写则交接至公司根部门。
*/
ReceiveDeptId?: string;
}
/**
* 页面主题配置
*/
export interface WebThemeConfig {
/**
* 是否显示页面底部电子签logo，取值如下：
- **true**：页面底部显示电子签logo
- **false**：页面底部不显示电子签logo（默认）
*/
DisplaySignBrandLogo?: boolean;
/**
* 主题颜色：
支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)
*/
WebEmbedThemeColor?: string;
}
/**
* ModifyApplicationCallbackInfo请求参数结构体
*/
export interface ModifyApplicationCallbackInfoRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 操作类型：
1-新增
2-删除
*/
OperateType: number;
/**
* 企业应用回调信息
*/
CallbackInfo: CallbackInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* StartFlow请求参数结构体
*/
export interface StartFlowRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程ID，为32位字符串。
此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
*/
FlowId: string;
/**
* 客户端Token，保持接口幂等性,最大长度64个字符
* @deprecated
*/
ClientToken?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
- **0** :合同发起时通知通知对方来查看合同（默认）
- **1** : 签署完成后通知对方来查看合同
*/
CcNotifyType?: number;
}
/**
* CreateSeal返回参数结构体
*/
export interface CreateSealResponse {
/**
* 电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
*/
SealId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreatePrepareFlow请求参数结构体
*/
export interface CreatePrepareFlowRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 资源id，与ResourceType相对应，取值范围：
- 文件Id（通过UploadFiles获取文件资源Id）
- 模板Id
*/
ResourceId: string;
/**
* 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
*/
FlowName: string;
/**
* 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
*/
Unordered?: boolean;
/**
* 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
*/
Deadline?: number;
/**
* 用户自定义合同类型Id
该id为电子签企业内的合同类型id， 可以在控制台-合同-自定义合同类型处获取
注: `该参数如果和FlowType同时传，以该参数优先生效`
*/
UserFlowTypeId?: string;
/**
* 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
*/
FlowType?: string;
/**
* 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。
*/
Approvers?: Array;
/**
* 开启或者关闭智能添加填写区：
- **OPEN**：开启（默认值）
- **CLOSE**：关闭
*/
IntelligentStatus?: string;
/**
* 资源类型，取值有：
*/
ResourceType?: number;
/**
* 该字段已废弃，请使用InitiatorComponents
*/
Components?: Component;
/**
* 发起合同个性化参数
用于满足创建及页面操作过程中的个性化要求
具体定制化内容详见数据接口说明
*/
FlowOption?: CreateFlowOption;
/**
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
NeedSignReview?: boolean;
/**
* 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true，发起审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。
*/
NeedCreateReview?: boolean;
/**
* 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
UserData?: string;
/**
* 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`
*/
FlowId?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
*/
InitiatorComponents?: Array;
}
/**
* 签署人个性化能力信息
*/
export interface ApproverOption {
/**
* 签署方是否可以拒签
- **false** : ( 默认)可以拒签
- **true** :不可以拒签
*/
NoRefuse?: boolean;
/**
* 签署方是否可以转他人处理
- **false** : ( 默认)可以转他人处理
- **true** :不可以转他人处理
*/
NoTransfer?: boolean;
/**
* 签署人信息补充类型，默认无需补充。
- **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`
*/
FillType?: number;
/**
* 签署人阅读合同限制参数
取值：
- LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底
- LimitReadTime，阅读合同仅限制阅读时长
- LimitBottom，阅读合同仅限制必须阅读到底
- NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）
*/
FlowReadLimit?: string;
}
/**
* CreateEmbedWebUrl返回参数结构体
*/
export interface CreateEmbedWebUrlResponse {
/**
* 嵌入的web链接，有效期：5分钟
EmbedType=PREVIEW_CC_FLOW，该url为h5链接
*/
WebUrl?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateSealPolicy请求参数结构体
*/
export interface CreateSealPolicyRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 用户在电子文件签署平台标识信息，具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用
*/
Users: Array;
/**
* 电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
*/
SealId: string;
/**
* 授权有效期。时间戳秒级
*/
Expired: number;
/**
* 需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填，跟上面的Users同时起作用
*/
UserIds?: Array;
/**
* 印章授权内容
*/
Policy?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DescribeOrganizationSeals请求参数结构体
*/
export interface DescribeOrganizationSealsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 200。
*/
Limit: number;
/**
* 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 20000。
*/
Offset?: number;
/**
* 查询信息类型，取值如下：
*/
InfoType?: number;
/**
* 印章id（没有输入返回所有）
*/
SealId?: string;
/**
* 印章类型列表（都是组织机构印章）。
为空时查询所有类型的印章。
目前支持以下类型：
- OFFICIAL：企业公章；
- CONTRACT：合同专用章；
- ORGANIZATION_SEAL：企业印章(图片上传创建)；
- LEGAL_PERSON_SEAL：法定代表人章
*/
SealTypes?: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 查询的印章状态列表。
- 空，只查询启用状态的印章；
- ALL，查询所有状态的印章；
- CHECKING，查询待审核的印章；
- SUCCESS，查询启用状态的印章；
- FAIL，查询印章审核拒绝的印章；
- DISABLE，查询已停用的印章；
- STOPPED，查询已终止的印章；
- VOID，查询已作废的印章；
- INVALID，查询已失效的印章；
*/
SealStatuses?: Array;
}
/**
* 权限树中的权限组
*/
export interface PermissionGroup {
/**
* 权限组名称
注意：此字段可能返回 null，表示取不到有效值。
*/
GroupName?: string;
/**
* 权限组key
注意：此字段可能返回 null，表示取不到有效值。
*/
GroupKey?: string;
/**
* 是否隐藏分组，0否1是
注意：此字段可能返回 null，表示取不到有效值。
*/
Hide?: number;
/**
* 权限集合
注意：此字段可能返回 null，表示取不到有效值。
*/
Permissions?: Array;
}
/**
* CancelFlow请求参数结构体
*/
export interface CancelFlowRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程ID, 为32位字符串。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowId: string;
/**
* 撤销此合同流程的原因，最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成（不支持表情）。
*/
CancelMessage: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
*/
export interface UploadFile {
/**
* Base64编码后的文件内容
*/
FileBody: string;
/**
* 文件名，最大长度不超过200字符
*/
FileName?: string;
}
/**
* 此结构体 (Component) 用于描述控件属性。
在通过文件发起合同时，对应的component有三种定位方式
1. 绝对定位方式
2. 表单域(FIELD)定位方式
3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找
可以参考官网说明
https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
*/
export interface Component {
/**
* 如果是Component填写控件类型，则可选的字段为：
TEXT - 普通文本控件，输入文本字符串；
MULTI_LINE_TEXT - 多行文本控件，输入文本字符串；
CHECK_BOX - 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
FILL_IMAGE - 图片控件，ComponentValue 填写图片的资源 ID；
DYNAMIC_TABLE - 动态表格控件；
ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
SELECTOR - 选择器控件，ComponentValue填写选择的字符串内容；
DATE - 日期控件；默认是格式化为xxxx年xx月xx日字符串；
DISTRICT - 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
如果是SignComponent签署控件类型，则可选的字段为
SIGN_SEAL - 签署印章控件；
SIGN_DATE - 签署日期控件；
SIGN_SIGNATURE - 用户签名控件；
SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；
SIGN_PAGING_SEAL - 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
SIGN_OPINION - 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
表单域的控件不能作为印章和签名控件
*/
ComponentType: string;
/**
* 控件所属文件的序号（取值为：0-N）。
目前单文件的情况下，值是0
*/
FileIndex: number;
/**
* 参数控件高度，单位pt
*/
ComponentHeight: number;
/**
* 参数控件宽度，单位pt
*/
ComponentWidth: number;
/**
* 参数控件所在页码，取值为：1-N
*/
ComponentPage: number;
/**
* 参数控件X位置，单位pt
*/
ComponentPosX: number;
/**
* 参数控件Y位置，单位pt
*/
ComponentPosY: number;
/**
* 控件唯一ID。
或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
*/
ComponentId?: string;
/**
* 控件名。
或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
*/
ComponentName?: string;
/**
* 是否必选，默认为false-非必选
*/
ComponentRequired?: boolean;
/**
* 控件关联的参与方ID，对应Recipient结构体中的RecipientId
*/
ComponentRecipientId?: string;
/**
* 扩展参数：
为JSON格式。
不同类型的控件会有部分非通用参数
ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：
1 Font：目前只支持黑体、宋体
2 FontSize： 范围12-72
3 FontAlign： Left/Right/Center，左对齐/居中/右对齐
4 FontColor：字符串类型，格式为RGB颜色数字
参数样例：{\"FontColor\":\"255,0,0\",\"FontSize\":12}
ComponentType为FILL_IMAGE时，支持以下参数：
NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中
FillMethod: int. 填充方式。0-铺满（默认）；1-等比例缩放
ComponentType为SIGN_SIGNATURE类型可以控制签署方式
{“ComponentTypeLimit”: [“xxx”]}
xxx可以为：
HANDWRITE – 手写签名
OCR_ESIGN -- AI智能识别手写签名
ESIGN -- 个人印章类型
SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
如：{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
ComponentType为SIGN_DATE时，支持以下参数：
1 Font：字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体"
2 FontSize： 数字类型，范围6-72，默认值为12
3 FontAlign： 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
4 Format： 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
5 Gaps:： 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数
如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期
特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）
参数样例： "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"
ComponentType为SIGN_SEAL类型时，支持以下参数：
1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）
参数样例： "ComponentExtra":"{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"
*/
ComponentExtra?: string;
/**
* 是否是表单域类型，默认false-不是
注意：此字段可能返回 null，表示取不到有效值。
*/
IsFormType?: boolean;
/**
* 控件填充vaule，ComponentType和传入值类型对应关系：
TEXT - 文本内容
MULTI_LINE_TEXT - 文本内容
CHECK_BOX - true/false
FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
SELECTOR - 选项值
DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
DATE - 默认是格式化为xxxx年xx月xx日
SIGN_SEAL - 印章ID，于控制台查询获取
SIGN_PAGING_SEAL - 可以指定印章ID，于控制台查询获取
控件值约束说明：
企业全称控件：
约束：企业名称中文字符中文括号
检查正则表达式：/^[\u3400-\u4dbf\u4e00-\u9fa5（）]+$/
统一社会信用代码控件：
检查正则表达式：/^[A-Z0-9]{1,18}$/
法人名称控件：
约束：最大50个字符，2到25个汉字或者1到50个字母
检查正则表达式：/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
签署意见控件：
约束：签署意见最大长度为50字符
签署人手机号控件：
约束：国内手机号 13,14,15,16,17,18,19号段长度11位
签署人身份证控件：
约束：合法的身份证号码检查
控件名称：
约束：控件名称最大长度为20字符
单行文本控件：
约束：只允许输入中文，英文，数字，中英文标点符号
多行文本控件：
约束：只允许输入中文，英文，数字，中英文标点符号
勾选框控件：
约束：选择填字符串true，不选填字符串false
选择器控件：
约束：同单行文本控件约束，填写选择值中的字符串
数字控件：
约束：请输入有效的数字(可带小数点)
检查正则表达式：/^(-|\+)?\d+(\.\d+)?$/
日期控件：
约束：格式：yyyy年mm月dd日
附件控件：
约束：JPG或PNG图片，上传数量限制，1到6个，最大6个附件
图片控件：
约束：JPG或PNG图片，填写上传的图片资源ID
邮箱控件：
约束：请输入有效的邮箱地址, w3c标准
检查正则表达式：/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
参考：https://emailregex.com/
地址控件：
同单行文本控件约束
省市区控件：
同单行文本控件约束
性别控件：
同单行文本控件约束，填写选择值中的字符串
学历控件：
同单行文本控件约束，填写选择值中的字符串
*/
ComponentValue?: string;
/**
* 控件生成的方式：
NORMAL - 普通控件
FIELD - 表单域
KEYWORD - 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）
*/
GenerateMode?: string;
/**
* 日期签署控件的字号，默认为 12
*/
ComponentDateFontSize?: number;
/**
* 第三方应用集成平台模板控件 ID 标识
*/
ChannelComponentId?: string;
/**
* 指定关键字时横坐标偏移量，单位pt
注意：此字段可能返回 null，表示取不到有效值。
*/
OffsetX?: number;
/**
* 指定关键字时纵坐标偏移量，单位pt
注意：此字段可能返回 null，表示取不到有效值。
*/
OffsetY?: number;
/**
* 第三方应用集成中子客企业控件来源。
0-平台指定；
1-用户自定义
*/
ChannelComponentSource?: number;
/**
* 指定关键字排序规则，Positive-正序，Reverse-倒序。
传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。
传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
*/
KeywordOrder?: string;
/**
* 指定关键字页码。
指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
*/
KeywordPage?: number;
/**
* 关键字位置模式，
Middle-居中，
Below-正下方，
Right-正右方，
LowerRight-右上角，
UpperRight-右下角。
示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
*/
RelativeLocation?: string;
/**
* 关键字索引。
如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。
示例：[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
*/
KeywordIndexes?: Array;
/**
* 是否锁定控件值不允许编辑（嵌入式发起使用）
默认false：不锁定控件值，允许在页面编辑控件值
注意：此字段可能返回 null，表示取不到有效值。
*/
LockComponentValue?: boolean;
/**
* 是否禁止移动和删除控件
默认false，不禁止移动和删除控件
注意：此字段可能返回 null，表示取不到有效值。
*/
ForbidMoveAndDelete?: boolean;
}
/**
* 部门信息
*/
export interface IntegrationDepartment {
/**
* 部门ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
DeptId?: string;
/**
* 部门名。
注意：此字段可能返回 null，表示取不到有效值。
*/
DeptName?: string;
/**
* 父部门ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ParentDeptId?: string;
/**
* 客户系统部门ID
注意：此字段可能返回 null，表示取不到有效值。
*/
DeptOpenId?: string;
/**
* 序列号。
注意：此字段可能返回 null，表示取不到有效值。
*/
OrderNo?: number;
}
/**
* DescribeExtendedServiceAuthInfos请求参数结构体
*/
export interface DescribeExtendedServiceAuthInfosRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 要查询的扩展服务类型。
默认为空，即查询当前支持的所有扩展服务信息。
若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
- OPEN_SERVER_SIGN：企业静默签署
- OVERSEA_SIGN：企业与港澳台居民签署合同
- MOBILE_CHECK_APPROVER：使用手机号验证签署方身份
- PAGING_SEAL：骑缝章
- BATCH_SIGN：批量签署
- AGE_LIMIT_EXPANSION：拓宽签署方年龄限制
*/
ExtendServiceType?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DescribeIntegrationRoles返回参数结构体
*/
export interface DescribeIntegrationRolesResponse {
/**
* 指定分页返回的页码。页码从0开始，最大为2000。
*/
Offset?: number;
/**
* 指定分页每页返回的数据条数，单页最大支持 200。
*/
Limit?: number;
/**
* 符合查询条件的总角色数。
*/
TotalCount?: number;
/**
* 企业角色信息列表。
*/
IntegrateRoles?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateBatchSignUrl请求参数结构体
*/
export interface CreateBatchSignUrlRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`请确保和合同中填入的一致`
*/
Name: string;
/**
* 手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`
*/
Mobile: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 证件类型，支持以下类型
- ID_CARD : 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
注：`请确保和合同中填入的一致`
*/
IdCardType?: string;
/**
* 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
注：`请确保和合同中填入的一致`
*/
IdCardNumber?: string;
/**
* 通知用户方式：
- **NONE** : 不通知（默认）
- **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）
*/
NotifyType?: string;
/**
* 本次需要批量签署的合同流程ID列表。
可以不传, 如不传则是发给对方的所有待签署合同流程。
*/
FlowIds?: Array;
/**
* 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。
注：
- 请确认该名称与企业营业执照中注册的名称一致。
- 如果名称中包含英文括号()，请使用中文括号（）代替。
- 请确保此企业已完成腾讯电子签企业认证。
*/
OrganizationName?: string;
/**
* 是否直接跳转至合同内容页面进行签署
- **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
- **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
*/
JumpToDetail?: boolean;
}
/**
* CreateFlowReminds请求参数结构体
*/
export interface CreateFlowRemindsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 需执行催办的签署流程ID数组，最多包含100个。
*/
FlowIds: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* UpdateIntegrationEmployees请求参数结构体
*/
export interface UpdateIntegrationEmployeesRequest {
/**
* 执行本接口操作的员工信息,UserId必填。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 员工信息，不超过100个。
根据UserId或OpenId更新员工，必填一个，优先UserId。
可更新Mobile、DisplayName、Email和Department.DepartmentId字段，其他字段暂不支持
*/
Employees: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DescribeFlowBriefs请求参数结构体
*/
export interface DescribeFlowBriefsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 查询的合同流程ID列表最多支持100个流程ID。
如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowIds: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateFlowGroupByTemplates请求参数结构体
*/
export interface CreateFlowGroupByTemplatesRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
*/
FlowGroupName: string;
/**
* 合同（流程）组的子合同信息，支持2-50个子合同
*/
FlowGroupInfos: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 合同（流程）组的配置项信息。
其中包括：
*/
FlowGroupOptions?: FlowGroupOptions;
}
/**
* DescribeBillUsageDetail返回参数结构体
*/
export interface DescribeBillUsageDetailResponse {
/**
* 总数
*/
Total?: number;
/**
* 消耗详情
*/
Details?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateUserAutoSignEnableUrl返回参数结构体
*/
export interface CreateUserAutoSignEnableUrlResponse {
/**
* 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
*/
Url?: string;
/**
* 腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
注: `如果获取的是H5链接, 则不会返回此值`
*/
AppId?: string;
/**
* 腾讯电子签小程序的原始 Id, ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
注: `如果获取的是H5链接, 则不会返回此值`
*/
AppOriginalId?: string;
/**
* 腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
注: `如果获取的是H5链接, 则不会返回此值`
*/
Path?: string;
/**
* base64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
注: `如果获取的是H5链接, 则不会返回此二维码图片`
*/
QrCode?: string;
/**
* 返回的链接类型
- 空: 默认小程序端链接
- **H5SIGN** : h5端链接
*/
UrlType?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 流程签署二维码的签署信息，适用于客户系统整合二维码功能。
通过链接，用户可直接访问电子签名小程序并签署合同。
*/
export interface SignUrl {
/**
* 跳转至电子签名小程序签署的链接地址。
适用于客户端APP及小程序直接唤起电子签名小程序。
*/
AppSignUrl?: string;
/**
* 签署链接有效时间，格式类似"2022-08-05 15:55:01"
*/
EffectiveTime?: string;
/**
* 跳转至电子签名小程序签署的链接地址，格式类似于https://essurl.cn/xxx。
打开此链接将会展示H5中间页面，随后唤起电子签名小程序以进行合同签署。
*/
HttpSignUrl?: string;
}
/**
* VerifyPdf返回参数结构体
*/
export interface VerifyPdfResponse {
/**
* 验签结果代码，代码的含义如下：
- **1**：文件未被篡改，全部签名在腾讯电子签完成。
- **2**：文件未被篡改，部分签名在腾讯电子签完成。
- **3**：文件被篡改。
- **4**：异常：文件内没有签名域。
- **5**：异常：文件签名格式错误。
*/
VerifyResult?: number;
/**
* 验签结果详情，每个签名域对应的验签结果。状态值如下
- **1** :验签成功，在电子签签署
- **2** :验签成功，在其他平台签署
- **3** :验签失败
- **4** :pdf文件没有签名域
- **5** :文件签名格式错误
*/
PdfVerifyResults?: Array;
/**
* 验签序列号, 为11为数组组成的字符串
*/
VerifySerialNo?: string;
/**
* 合同文件MD5哈希值
*/
PdfResourceMd5?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 删除员工结果
*/
export interface DeleteStaffsResult {
/**
* 删除员工的成功数据
注意：此字段可能返回 null，表示取不到有效值。
*/
SuccessEmployeeData: Array;
/**
* 删除员工的失败数据
注意：此字段可能返回 null，表示取不到有效值。
*/
FailedEmployeeData: Array;
}
/**
* DescribeBillUsageDetail请求参数结构体
*/
export interface DescribeBillUsageDetailRequest {
/**
* 查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天
*/
StartTime: string;
/**
* 查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天
*/
EndTime: string;
/**
* 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
*/
Offset?: number;
/**
* 指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。
*/
Limit?: number;
/**
* 查询的套餐类型 （选填 ）不传则查询所有套餐；
目前支持:
- **CloudEnterprise**: 企业版合同
- **SingleSignature**: 单方签章
- **CloudProve**: 签署报告
- **CloudOnlineSign**: 腾讯会议在线签约
- **ChannelWeCard**: 微工卡
- **SignFlow**: 合同套餐
- **SignFace**: 签署意愿（人脸识别）
- **SignPassword**: 签署意愿（密码）
- **SignSMS**: 签署意愿（短信）
- **PersonalEssAuth**: 签署人实名（腾讯电子签认证）
- **PersonalThirdAuth**: 签署人实名（信任第三方认证）
- **OrgEssAuth**: 签署企业实名
- **FlowNotify**: 短信通知
- **AuthService**: 企业工商信息查询
*/
QuotaType?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 企业超管信息
*/
export interface Admin {
/**
* 超管名
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 超管手机号，打码显示
示例值：138****1569
注意：此字段可能返回 null，表示取不到有效值。
*/
Mobile?: string;
}
/**
* 此结构体 (Caller) 用于描述调用方属性。
*/
export interface Caller {
/**
* 应用号
* @deprecated
*/
ApplicationId?: string;
/**
* 主机构ID
* @deprecated
*/
OrganizationId?: string;
/**
* 经办人的用户ID，同UserId
*/
OperatorId?: string;
/**
* 下属机构ID
* @deprecated
*/
SubOrganizationId?: string;
}
/**
* DescribeFlowTemplates返回参数结构体
*/
export interface DescribeFlowTemplatesResponse {
/**
* 模板详情列表数据
*/
Templates?: Array;
/**
* 查询到的模板总数
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UploadFiles请求参数结构体
*/
export interface UploadFilesRequest {
/**
* 文件对应业务类型,可以选择的类型如下
- **TEMPLATE** : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过创建文件转换任务转换后才能使用
- **DOCUMENT** : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html，如果非pdf文件需要通过创建文件转换任务转换后才能使用
- **DOCUMENT** : 此文件用于合同图片控件的填充，文件类型支持.jpg/.png
- **SEAL** : 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png
*/
BusinessType: string;
/**
* 执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Caller?: Caller;
/**
* 上传文件内容数组，最多支持上传20个文件。
*/
FileInfos?: Array;
/**
* 文件类型， 默认通过文件内容和文件后缀一起解析得到文件类型，调用接口时可以显示的指定上传文件的类型。
可支持的指定类型如下:
- pdf
- doc
- docx
- xls
- xlsx
- html
- jpg
- jpeg
- png
如：pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf
*/
FileType?: string;
/**
* 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。
- **true**：将灰色矩阵置为白色。
- **false**：无需处理，不会将灰色矩阵置为白色（默认）。
注: `该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。`
*/
CoverRect?: boolean;
/**
* 用户自定义ID数组，与上传文件一一对应
注: `历史遗留问题，已经废弃，调用接口时不用赋值`
*/
CustomIds?: Array;
/**
* 不再使用，上传文件链接数组，最多支持20个URL
* @deprecated
*/
FileUrls?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DescribePersonCertificate请求参数结构体
*/
export interface DescribePersonCertificateRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 个人用户的三要素信息：
*/
UserInfo: UserThreeFactor;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 证书使用场景，可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
*/
SceneKey?: string;
}
/**
* 解除协议文档中内容信息，包括但不限于：解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。
*/
export interface RelieveInfo {
/**
* 解除理由，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
*/
Reason: string;
/**
* 解除后仍然有效的条款，保留条款，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
*/
RemainInForceItem?: string;
/**
* 原合同事项处理-费用结算，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
*/
OriginalExpenseSettlement?: string;
/**
* 原合同事项处理-其他事项，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
*/
OriginalOtherSettlement?: string;
/**
* 其他约定，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
*/
OtherDeals?: string;
}
/**
* 个性化参数
*/
export interface EmbedUrlOption {
/**
* 合同详情预览，允许展示控件信息
true：允许在合同详情页展示控件
false：不允许在合同详情页展示控件
默认false，合同详情页不展示控件
*/
ShowFlowDetailComponent?: boolean;
/**
* 模板预览，允许展示模板控件信息
true：允许在模板预览页展示控件
false：不允许在模板预览页展示控件
默认false，模板预览页不展示控件
*/
ShowTemplateComponent?: boolean;
}
/**
* CreateBatchCancelFlowUrl请求参数结构体
*/
export interface CreateBatchCancelFlowUrlRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 需要执行撤回的流程(合同)的编号列表，最多100个.
列表中的流程(合同)编号不要重复.
*/
FlowIds: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateMultiFlowSignQRCode请求参数结构体
*/
export interface CreateMultiFlowSignQRCodeRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同模板ID，为32位字符串。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
*/
TemplateId: string;
/**
* 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
FlowName: string;
/**
* 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。
一旦发起流程数超越该限制，该二维码将自动失效。
*/
MaxFlowNum?: number;
/**
* 二维码的有效期限，默认为7天，最高设定不得超过90天。
一旦超过二维码的有效期限，该二维码将自动失效。
*/
QrEffectiveDay?: number;
/**
* 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。
若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。
最长设定期限不得超过30天。
*/
FlowEffectiveDay?: number;
/**
* 指定签署人信息。
在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
*/
Restrictions?: Array;
/**
* 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
UserData?: string;
/**
* 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 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
* @deprecated
*/
CallbackUrl?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 限制二维码用户条件（已弃用）
* @deprecated
*/
ApproverRestrictions?: ApproverRestriction;
/**
* 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
*/
ApproverComponentLimitTypes?: Array;
}
/**
* DescribeFlowInfo请求参数结构体
*/
export interface DescribeFlowInfoRequest {
/**
* 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 需要查询的流程ID列表，最多可传入100个ID。
如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。
*/
FlowIds?: Array;
/**
* 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。该合同组由通过多文件创建合同组签署流程等接口创建。
*/
FlowGroupId?: string;
}
/**
* DeleteExtendedServiceAuthInfos请求参数结构体
*/
export interface DeleteExtendedServiceAuthInfosRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 本企业员工的id，需要已实名，正常在职员工
*/
UserIds: Array;
/**
* 取值如下所示：
- OPEN_SERVER_SIGN：企业自动签
- BATCH_SIGN：批量签署
*/
ExtendServiceType?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DescribeIntegrationDepartments请求参数结构体
*/
export interface DescribeIntegrationDepartmentsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 查询类型，支持以下类型：
- **0**：查询单个部门节点列表，不包含子节点部门信息
- **1**：查询单个部门节点级一级子节点部门信息列表
*/
QueryType: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 查询的部门ID。
注：`如果同时指定了DeptId与DeptOpenId参数，系统将优先使用DeptId参数进行查询。当二者都未指定时，系统将返回根节点部门数据。`
*/
DeptId?: string;
/**
* 查询的客户系统部门ID。
注：`如果同时指定了DeptId与DeptOpenId参数，系统将优先使用DeptId参数进行查询。当二者都未指定时，系统将返回根节点部门数据。`
*/
DeptOpenId?: string;
}
/**
* DescribeFlowInfo返回参数结构体
*/
export interface DescribeFlowInfoResponse {
/**
* 合同流程的详细信息。
如果查询的是合同组信息，则返回的是组内所有子合同流程的详细信息。
*/
FlowDetailInfos?: Array;
/**
* 合同组ID，只有在查询合同组信息时才会返回。
*/
FlowGroupId?: string;
/**
* 合同组名称，只有在查询合同组信息时才会返回。
*/
FlowGroupName?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelMultiFlowSignQRCode返回参数结构体
*/
export interface CancelMultiFlowSignQRCodeResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlow返回参数结构体
*/
export interface CreateFlowResponse {
/**
* 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
注:
此返回的合同流程ID，需再次调用创建电子文档和发起签署流程接口将合同开始后，合同才能进入签署环节
*/
FlowId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUserAutoSignStatus请求参数结构体
*/
export interface DescribeUserAutoSignStatusRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
*/
SceneKey: string;
/**
* 要查询状态的用户信息, 包括名字,身份证等
*/
UserInfo: UserThreeFactor;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 文档内的填充控件返回结构体，返回控件的基本信息和填写内容值
*/
export interface FilledComponent {
/**
* 控件Id
注意：此字段可能返回 null，表示取不到有效值。
*/
ComponentId?: string;
/**
* 控件名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ComponentName?: string;
/**
* 控件填写状态；0-未填写；1-已填写
注意：此字段可能返回 null，表示取不到有效值。
*/
ComponentFillStatus?: string;
/**
* 控件填写内容
注意：此字段可能返回 null，表示取不到有效值。
*/
ComponentValue?: string;
/**
* 控件所属参与方Id
注意：此字段可能返回 null，表示取不到有效值。
*/
ComponentRecipientId?: string;
/**
* 图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。
注意：此字段可能返回 null，表示取不到有效值。
*/
ImageUrl?: string;
}
/**
* CreateBatchQuickSignUrl请求参数结构体
*/
export interface CreateBatchQuickSignUrlRequest {
/**
* 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
注:
`1. ApproverType目前只支持个人类型的签署人。`
`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
`3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
*/
FlowApproverInfo: FlowCreateApprover;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
*/
FlowIds?: Array;
/**
* 合同组编号
注：`该参数和合同流程ID数组必须二选一`
*/
FlowGroupId?: string;
/**
* 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
*/
JumpUrl?: string;
/**
* 指定批量签署合同的签名类型，可传递以下值：
- **0**：手写签名(默认)
- **1**：OCR楷体
注：
- 默认情况下，签名类型为手写签名
- 您可以传递多种值，表示可用多种签名类型。
*/
SignatureTypes?: Array;
/**
* 指定批量签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同
- **2**：密码认证(默认)，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署
- **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
注：
- 默认情况下，认证校验方式为人脸和密码认证
- 您可以传递多种值，表示可用多种认证校验方式。
*/
ApproverSignTypes?: Array;
}
/**
* 下载文件的URL信息
*/
export interface FileUrl {
/**
* 下载文件的URL，有效期为输入的UrlTtl，默认5分钟
*/
Url: string;
/**
* 下载文件的附加信息。如果是pdf文件，会返回pdf文件每页的有效高宽
注意：此字段可能返回 null，表示取不到有效值。
*/
Option: string;
}
/**
* CreateOrganizationInfoChangeUrl请求参数结构体
*/
export interface CreateOrganizationInfoChangeUrlRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 企业信息变更类型，可选类型如下：
- **1**：企业超管变更
- **2**：企业基础信息变更
*/
ChangeType: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DescribeOrganizationGroupOrganizations返回参数结构体
*/
export interface DescribeOrganizationGroupOrganizationsResponse {
/**
* 符合查询条件的资源实例总数量。
注意：此字段可能返回 null，表示取不到有效值。
*/
Total?: number;
/**
* 已授权待激活的子企业总数量
注意：此字段可能返回 null，表示取不到有效值。
*/
JoinedTotal?: number;
/**
* 已加入的企业数量(废弃,请使用ActivatedTotal)
注意：此字段可能返回 null，表示取不到有效值。
* @deprecated
*/
ActivedTotal?: number;
/**
* 如果入参Export为 true 时使用，表示导出Excel的url
注意：此字段可能返回 null，表示取不到有效值。
*/
ExportUrl?: string;
/**
* 成员企业信息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
List?: Array;
/**
* 已加入的子企业总数量
注意：此字段可能返回 null，表示取不到有效值。
*/
ActivatedTotal?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeExtendedServiceAuthInfos返回参数结构体
*/
export interface DescribeExtendedServiceAuthInfosResponse {
/**
* 服务开通和授权的信息列表，根据查询类型返回所有支持的扩展服务开通和授权状况，或者返回特定扩展服务的开通和授权状况。
*/
AuthInfoList?: Array;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 抄送信息
*/
export interface CcInfo {
/**
* 被抄送方手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
*/
Mobile?: string;
/**
* 被抄送方姓名。
抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。
*/
Name?: string;
/**
* 被抄送方类型, 可设置以下类型:
- **0** :个人抄送方
- **1** :企业员工抄送方
*/
CcType?: number;
/**
* 被抄送方权限, 可设置如下权限:
- **0** :可查看合同内容
- **1** :可查看合同内容也可下载原文
*/
CcPermission?: number;
/**
* 通知签署方经办人的方式, 有以下途径:
- **sms** : (默认)短信
- **none** : 不通知
*/
NotifyType?: string;
}