tencentcloud-sdk-nodejs

/** * CreateOrganizationGroupInvitationLink请求参数结构体 */ export interface CreateOrganizationGroupInvitationLinkRequest { /** * 执行本接口操作的员工信息。使用此接口时，必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` */ Operator: UserInfo; /** * 到期时间（以秒为单位的时间戳），其上限为30天的有效期限。 */ ExpireTime: number; } /** * DescribeCancelFlowsTask返回参数结构体 */ export interface DescribeCancelFlowsTaskResponse { /** * 批量撤销任务编号，为32位字符串，通过接口<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl">获取批量撤销签署流程腾讯电子签小程序链接</a>获得。 */ TaskId?: string; /** * 任务状态，需要关注的状态<ul><li>**PROCESSING** - 任务执行中</li><li>**END** - 任务处理完成</li><li>**TIMEOUT** 任务超时未处理完成，用户未在批量撤销链接有效期内操作</li></ul> */ TaskStatus?: string; /** * 批量撤销成功的签署流程编号 */ SuccessFlowIds?: Array<string>; /** * 批量撤销失败的签署流程信息 */ FailureFlows?: Array<CancelFailureFlow>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateSeal请求参数结构体 */ export interface CreateSealRequest { /** * 执行本接口操作的员工信息。 注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code> */ Operator: UserInfo; /** * 电子印章名字，1-50个中文字符 注:<code>同一企业下电子印章名字不能相同</code> */ SealName: string; /** * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 电子印章生成方式<ul><li>空值:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li><li>SealGenerateSourceSystem: 系统生成印章, 无需上传SealImage图片</li></ul> */ GenerateSource?: string; /** * 电子印章类型 , 可选类型如下: <ul><li>OFFICIAL: (默认)公章</li><li>CONTRACT: 合同专用章;</li><li>FINANCE: 财务专用章;</li><li>PERSONNEL: 人事专用章</li><li>INVOICE: 发票专用章</li><li>OTHER: 其他</li></ul>注: 同企业下只能有一个公章, 重复创建会报错 */ SealType?: string; /** * 电子印章图片文件名称，1-50个中文字符。 */ FileName?: string; /** * 电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式注: <code>通过图片创建的电子印章，需电子签平台人工审核</code> */ Image?: string; /** * 电子印章宽度,单位px 参数不再启用，系统会设置印章大小为标准尺寸。 */ Width?: number; /** * 电子印章高度,单位px 参数不再启用，系统会设置印章大小为标准尺寸。 */ Height?: number; /** * 电子印章印章颜色(默认红色RED),RED-红色系统目前只支持红色印章创建。 */ Color?: string; /** * 企业印章横向文字，最多可填15个汉字 (若超过印章最大宽度，优先压缩字间距，其次缩小字号) 横向文字的位置如下图中的"印章横向文字在这里"<img src="https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage2.png" alt="image"> */ SealHorizontalText?: string; /** * 暂时不支持下弦文字设置 */ SealChordText?: string; /** * 系统生成的印章只支持：STAR */ SealCentralType?: string; /** * 通过文件上传时，服务端生成的电子印章上传图片的token */ FileToken?: string; /** * 印章样式, 可以选择的样式如下: <ul><li>**circle**:(默认)圆形印章</li><li>**ellipse**:椭圆印章</li></ul> */ SealStyle?: string; /** * 印章尺寸，格式为宽_高（单位：mm，整数），用于签署时按物理尺寸将印章加盖到PDF。 取值范围： • 图片上传印章（Image 或 FileToken 非空时生效）：支持自定义尺寸，宽、高均为 10-100 的整数（即 1cm-10cm），宽高比（宽/高）需在 0.1-10 之间。 • 系统生成印章（未传 Image 与 FileToken）：仅支持与SealStyle 匹配的固定枚举值： - 圆形印章（SealStyle=cycle）：38_38 / 40_40 / 42_42 / 45_45 / 50_50 / 58_58 - 椭圆印章（SealStyle=ellipse）：40_30 / 45_30 字段依赖关系： • 与 SealStyle关联：仅系统生成印章场景下 SealStyle 生效，此时 SealSize 需与 SealStyle对应的枚举匹配；图片上传印章场景 SealStyle 会被忽略，SealSize支持自定义。 • 与 SealType 关联：公章/合同章仅支持圆形枚举，财务/人事/其它章支持圆形或椭圆枚举。 • 与 Image / FileToken 关联：SealSize 是加盖到 PDF的物理尺寸，与上传图片的像素分辨率无绑定，图片会按 SealSize 缩放渲染；建议上传图片的宽高比与 SealSize 保持一致，避免拉伸形变。 */ SealSize?: string; /** * 企业税号 注:<ul><li>1.印章类型SealType是INVOICE类型时，此参数才会生效</li><li>2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号（如果是通过授权书授权方式认证的企业，此参数必传不能为空）</li></ul> */ TaxIdentifyCode?: string; /** * 印章描述内容 */ SealDescription?: string; /** * 个性化配置字段，默认不传。 */ Options?: Array<Option>; } /** * ModifyIntegrationDepartment返回参数结构体 */ export interface ModifyIntegrationDepartmentResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CancelFlow返回参数结构体 */ export interface CancelFlowResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 集成版员工部门信息。 */ export interface Department { /** * 部门ID。 */ DepartmentId?: string; /** * 部门名称。 */ DepartmentName?: string; } /** * DescribeContractReviewWebUrl请求参数结构体 */ export interface DescribeContractReviewWebUrlRequest { /** * 执行本接口操作的员工信息。使用此接口时，必须填写userId。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` */ Operator: UserInfo; /** * 合同审查任务ID，该参数通过调用接口<a href="https://qian.tencent.com/developers/companyApis/embedPages/CreateContractReviewWebUrl" target="_blank">创建合同审查web页面</a>获取。 */ TaskId: string; } /** * DescribeInformationExtractionTask请求参数结构体 */ export interface DescribeInformationExtractionTaskRequest { /** * 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` */ Operator: UserInfo; /** * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 合同智能提取任务ID，该参数通过调用接口[批量创建合同智能提取任务接口](https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/CreateBatchInformationExtractionTask)获取。 */ TaskId?: string; } /** * CreateDynamicFlowApprover请求参数结构体 */ export interface CreateDynamicFlowApproverRequest { /** * 执行本接口操作的员工信息。使用此接口时，必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` */ Operator: UserInfo; /** * 合同流程ID，为32位字符串 */ FlowId: string; /** * 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。 */ Approvers: Array<ApproverInfo>; /** * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。` */ AutoSignScene?: string; } /** * DisableUserAutoSign请求参数结构体 */ export interface DisableUserAutoSignRequest { /** * 执行本接口操作的员工信息。 注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code> */ Operator: UserInfo; /** * 自动签使用的场景值, 可以选择的场景值如下:<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul> */ SceneKey: string; /** * 需要关闭自动签的个人的信息，如姓名，证件信息等。 */ UserInfo: UserThreeFactor; /** * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; } /** * UploadFiles请求参数结构体 */ export interface UploadFilesRequest { /** * 文件对应业务类型,可以选择的类型如下<ul><li> TEMPLATE : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li> DOCUMENT : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可</li><li> SEAL : 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png</li><li> ARCHIVE : 此文件用于归档文件夹，文件类型支持.pdf/.zip格式</li></ul> ["yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT"]枚举值：<ul><li>TEMPLATE：此上传的文件用户生成合同模板</li><li>DOCUMENT：此文件用来发起合同流程</li><li>SEAL：此文件用于印章的生成</li><li>ARCHIVE：此文件用于归档文件夹</li></ul> */ BusinessType: string; /** * 执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。 注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code> */ Caller?: Caller; /** * 请上传文件内容数组，最多可上传20个文件。所有文件必须符合FileType指定的文件类型。 */ FileInfos?: Array<UploadFile>; /** * 文件类型，默认通过文件内容和文件后缀一起解析得到文件类型，调用接口时可以显示的指定上传文件的类型。 可支持的指定类型如下:<ul><li>pdf</li><li>doc</li><li>docx</li><li>xls</li><li>xlsx</li><li>html</li><li>jpg</li><li>jpeg</li><li>png</li></ul>如：pdf 表示上传的文件张三入职合同.pdf的文件类型是 pdf */ FileType?: string; /** * 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。<ul><li>**true**：将灰色矩阵置为白色。</li><li>**false**：无需处理，不会将灰色矩阵置为白色（默认）。</li></ul>注: <code>该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。</code> */ CoverRect?: boolean; /** * 该字段已不再使用 */ CustomIds?: Array<string>; /** * 不再使用，上传文件链接数组，最多支持20个URL * @deprecated */ FileUrls?: string; /** * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 文件过期时间的时间戳取值范围：[1782835200, 4102329600]单位：秒设置上传文件的过期时间，此功能为付费能力，请联系电子签运营人员开通 */ Deadline?: number; } /** * CreateFileConvertTask请求参数结构体 */ export interface CreateFileConvertTaskRequest { /** * 需要进行转换的资源文件类型 支持的文件类型如下：枚举值：<ul><li>doc： doc</li><li>docx： docx</li><li>xls： xls</li><li>xlsx： xlsx</li><li>jpg： jpg</li><li>jpeg： jpeg</li><li>png： png</li><li>html： html</li><li>bmp： bmp</li></ul> */ ResourceType: string; /** * 需要进行转换操作的文件资源名称，带资源后缀名。注: <code>资源名称长度限制为256个字符</code> */ ResourceName: string; /** * 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。注: <code>目前，此接口仅支持单个文件进行转换。</code> */ ResourceId: string; /** * 执行本接口操作的员工信息。 注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code> */ Operator: UserInfo; /** * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; } /** * 意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。 */ export interface IntentionQuestionResult { /** * 视频base64（其中包含全程问题和回答音频，mp4格式）注：`需进行base64解码获取视频文件` */ Video?: string; /** * 和答案匹配结果列表 */ ResultCode?: Array<string>; /** * 回答问题语音识别结果列表 */ AsrResult?: Array<string>; } /** * OperateSeals返回参数结构体 */ export interface OperateSealsResponse { /** * 人脸验证操作人链接，用法可以参考"[跳转电子签小程序配置](https://qian.tencent.com/developers/company/openwxminiprogram/)"，默认为空。 */ SealOperatorVerifyPath?: string; /** * 人脸验证操作人二维码链接，扫码后会跳转到腾讯电子签小程序进行人脸验证，默认为空。 */ SealOperatorVerifyQrcodeUrl?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 被授权的用户信息 */ export interface HasAuthUser { /** * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。 */ UserId?: string; /** * 当前员工的归属情况，可能值是： MainOrg：在集团企业的场景下，返回此值代表是归属主企业 CurrentOrg：在普通企业场景下返回此值；或者在集团企业的场景下，返回此值代表归属子企业 */ BelongTo?: string; /** * 集团主企业id，当前企业为集团子企业时，该字段有值 */ MainOrganizationId?: string; } /** * CancelUserAutoSignEnableUrl返回参数结构体 */ export interface CancelUserAutoSignEnableUrlResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateContractDiffTaskWebUrl返回参数结构体 */ export interface CreateContractDiffTaskWebUrlResponse { /** * 接口返回的合同对比任务ID，可以调用接口<a href="https://qian.tencent.com/developers/companyApis/embedPages/DescribeContractDiffTaskWebUrl" target="_blank">获取合同对比结果web页面</a>查看对比任务的结果。当`SkipFileUpload`参数为`true`时才会返回值，否则为空。 */ TaskId?: string; /** * 合同对比嵌入式web页面链接，有效期：5分钟链接仅能使用一次 */ WebUrl?: string; /** * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。 */ UserData?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * VerifyDigitFile请求参数结构体 */ export interface VerifyDigitFileRequest { /** * 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。 */ Operator?: UserInfo; /** * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 加签接口返回的文件Id */ FileId?: string; } /** * CreateFlowEvidenceReport请求参数结构体 */ export interface CreateFlowEvidenceReportRequest { /** * 执行本接口操作的员工信息。 注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code> */ Operator: UserInfo; /** * 合同流程ID，为32位字符串。 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 */ FlowId: string; /** * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 指定申请的报告类型，可选类型如下：<ul><li> 0 :合同签署报告（默认）</li></ul>枚举值：<ul><li>0：合同签署报告</li></ul> */ ReportType?: number; /** * 混合云模式获取合同文件合并出证，默认：不同意。注：此参数需要联系腾讯电子签运营进行开通后生效 */ HybridEvidenceFlowFile?: boolean; } /** * 模板中指定的印章信息 */ export interface SealInfo { /** * 印章ID */ SealId: string; /** * 印章类型。LEGAL_PERSON_SEAL: 法定代表人章； ORGANIZATIONSEAL：企业印章； OFFICIAL：企业公章； CONTRACT：合同专用章 */ SealType: string; /** * 印章名称 */ SealName: string; } /** * 签署链接信息。 */ export interface FlowApproverUrlInfo { /** * 签署短链接。注意: 1. 该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。 2. 该链接不支持小程序嵌入，仅支持移动端浏览器打开。 3. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误） */ SignUrl?: string; /** * 签署人类型。 - **1**: 个人 */ ApproverType?: number; /** * 签署人姓名。 */ ApproverName?: string; /** * 签署人手机号。 */ ApproverMobile?: string; /** * 签署长链接。注意: 1. 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。 2. 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。 3. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误） */ LongUrl?: string; } /** * 需要进行签署审核的签署人信息 */ export interface NeedReviewApproverInfo { /** * 签署方经办人的类型，支持以下类型<ul><li> ORGANIZATION 企业（含企业自动签）</li><li>PERSON 个人（含个人自动签）</li></ul> */ ApproverType: string; /** * 签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 */ ApproverName: string; /** * 签署方经办人手机号码，支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此合同签署方。 */ ApproverMobile?: string; /** * 签署方经办人的证件类型，支持以下类型<ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同居民身份证)</li></ul> */ ApproverIdCardType?: string; /** * 签署方经办人的证件号码，应符合以下规则<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul> */ ApproverIdCardNumber?: string; /** * 组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)，则企业名称必填。 */ OrganizationName?: string; } /** * CreateBatchSignUrl返回参数结构体 */ export interface CreateBatchSignUrlResponse { /** * 批量签署链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。注: 1. 非小程序和APP集成使用 2. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误） */ SignUrl?: string; /** * 链接过期时间以 Unix 时间戳格式表示，默认生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。 */ ExpiredTime?: number; /** * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径注: 1. 小程序和APP集成使用 2. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误） */ MiniAppPath?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 归档合同的参与人信息 */ export interface ArchiveFlowApproverInfo { /** * 个人签署人姓名，如果传入，必须是证件上的真实中文名；中文名最长 25 个字符； */ ApproverName?: string; /** * 参与者类型，用于区分个人或企业，可选类型如下: 0：企业 1：个人 */ ApproverType?: number; /** * 企业签署方名称。长度不超过 200 个字符。 如果名称中包含英文括号()，请使用中文括号（）代替。 如果签署方是企业签署方(approverType = 0 )，则企业名称必填。 */ OrganizationName?: string; /** * 签署人手机号，必须是合法手机号。 */ ApproverMobile?: string; /** * 签署人邮箱，必须是合法邮箱格式。 */ ApproverEmail?: string; /** * 签署方经办人的证件类型，支持以下类型，样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a><ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li><li>OTHER_CARD_TYPE 其他证件</li></ul> */ ApproverIdCardType?: string; /** * 签署方经办人的证件号码，应符合以下规则<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul> */ ApproverIdCardNumber?: string; /** * 当前参与者的签署时间，Unix 秒级时间戳。 */ ApproveTime?: number; } /** * DescribeUserAutoSignStatus返回参数结构体 */ export interface DescribeUserAutoSignStatusResponse { /** * 查询用户是否已开通自动签 */ IsOpen?: boolean; /** * 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。值为unix时间戳,单位为秒。 */ LicenseFrom?: number; /** * 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。值为unix时间戳,单位为秒。 */ LicenseTo?: number; /** * 设置用户开通自动签时是否绑定个人自动签账号许可。<ul><li>0: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: <code>不可解绑释放更换他人</code></li><li>1: 不绑定自动签账号许可开通，后续使用合同份额进行合同发起</li></ul> */ LicenseType?: number; /** * 用户开通自动签指定使用的印章，为空则未设置印章，需重新进入开通链接设置印章。 */ SealId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeContractReviewChecklistWebUrl返回参数结构体 */ export interface DescribeContractReviewChecklistWebUrlResponse { /** * 嵌入式web页面链接。注意：`链接有效期为5分钟，且链接仅能使用一次。` */ WebUrl?: string; /** * 清单 id */ Id?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 标签 */ export interface Tag { /** * 标签键，最大长度不超过50字符。 */ TagKey?: string; /** * 标签值，最大长度不超过50字符。 */ TagValue?: string; } /** * CreateFlowForwards返回参数结构体 */ export interface CreateFlowForwardsResponse { /** * 失败的合同id以及错误详情 */ FailedFlows?: Array<FlowForwardResult>; /** * 成功的合同id */ SuccessFlows?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeFlowEvidenceReport请求参数结构体 */ export interface DescribeFlowEvidenceReportRequest { /** * 执行本接口操作的员工信息。 注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code> */ Operator: UserInfo; /** * 签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生 */ ReportId: string; /** * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 指定申请的报告类型，可选类型如下：<ul><li> 0 :合同签署报告（默认）</li></ul>枚举值：<ul><li>0：合同签署报告</li></ul> */ ReportType?: number; } /** * ModifyPartnerAuthorization返回参数结构体 */ export interface ModifyPartnerAuthorizationResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSealPolicies请求参数结构体 */ export interface DeleteSealPoliciesRequest { /** * 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` */ Operator: UserInfo; /** * 印章授权编码数组。这个参数跟下面的SealId其中一个必填，另外一个可选填 */ PolicyIds?: Array<string>; /** * 电子印章ID，为32位字符串。建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。注：印章ID。这个参数跟上面的PolicyIds其中一个必填，另外一个可选填。 */ SealId?: string; /** * 待授权的员工ID，员工在腾讯电子签平台的唯一身份标识，为32位字符串。可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。 */ UserIds?: Array<string>; /** * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; } /** * CreateFlowGroupByTemplates返回参数结构体 */ export interface CreateFlowGroupByTemplatesResponse { /** * 合同(流程)组的合同组Id */ FlowGroupId?: string; /** * 合同(流程)组中子合同列表. */ FlowIds?: Array<string>; /** * 合同组签署人信息。 */ Approvers?: Array<FlowGroupApprovers>; /** * FlowGroupNeedWorkflow */ WorkflowInstanceId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 视频认证结果 */ export interface DetectInfoVideoData { /** * 活体视频的base64编码，mp4格式注:`需进行base64解码获取活体视频文件` */ LiveNessVideo?: string; } /** * 合同审查个性化参数，用于控制页面的展示内容 */ export interface ContractReviewWebUrlOption { /** * 禁用暂存。默认 false，设置为 true 会隐藏界面上的临时保存按钮 */ DisableTemporaryStore?: boolean; /** * 禁用导出。默认 false，设置为 true 会隐藏界面上的导出按钮 */ DisableExport?: boolean; /** * 禁用重新审查。默认 false，设置为 true 会隐藏界面上的重新审查按钮 */ DisableReviewAgain?: boolean; /** * 禁用二维码分享。默认 false，设置为 true 会隐藏界面上的分享二维码 */ DisableWxQrcode?: boolean; } /** * ModifySingleSignOnEmployees返回参数结构体 */ export interface ModifySingleSignOnEmployeesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateWebThemeConfig返回参数结构体 */ export interface CreateWebThemeConfigResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeFlowInfo请求参数结构体 */ export interface DescribeFlowInfoRequest { /** * 执行本接口操作的员工信息。注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code> */ Operator?: UserInfo; /** * 需要查询的流程ID列表，最多可传入100个ID。 如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。<a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a> */ FlowIds?: Array<string>; /** * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。该合同组由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。 */ FlowGroupId?: string; } /** * 企业批量注册链接信息 */ export interface OrganizationAuthUrl { /** * 企业批量注册链接，根据Endpoint的不同设置，返回不同的链接地址。失效时间：7天跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表 <table> <thead> <tr> <th>Endpoint</th> <th>示例</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>PC</td> <td>https://qian.tencent.com/console/batch-register?token=yDSx0UUgtjuaf4UEfd2MjCnfI1iuXFE6&orgName=批量认证线上测试企业9</td> <td>7天</td> </tr> <tr> <td>PC_SHORT_URL</td> <td>https://test.essurl.cn/8gDKUBAWK8</td> <td>7天</td> </tr> <tr> <td>APP</td> <td>/pages/guide/index?to=REGISTER_ENTERPRISE_FOR_BATCH&urlAuthToken=yDSx0UUgtjuaf4UEfd2MjCnfI1iuXFE6&orgName=批量认证线上测试企业9</td> <td>7天</td> </tr> </tbody> </table> 注： `1.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义` */ AuthUrl?: string; /** * 企业批量注册的错误信息，例如：企业三要素不通过 */ ErrorMessage?: string; /** * 企业批量注册的唯一 Id，此 Id 可以用在[创建企业批量认证链接-单链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationAuthorizationUrl)。 */ SubTaskId?: string; /** * 企业批量注册传递过来的企业名称，方便客户定位企业 */ OrganizationName?: string; } /** * 企业授权书信息参数，需要保证这些参数跟营业执照中的信息一致。 */ export interface OrganizationCommonInfo { /** * 组织机构名称。请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。 */ OrganizationName: string; /** * 组织机构企业统一社会信用代码。请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。 */ UniformSocialCreditCode: string; /** * 组织机构法人的姓名。请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。 */ LegalName: string; /** * 组织机构法人的证件类型 */ LegalIdCardType?: string; /** * 组织机构法人的证件号码 */ LegalIdCardNumber?: string; /** * 组织机构超管姓名。 */ AdminName?: string; /** * 组织机构超管手机号。 */ AdminMobile?: string; /** * 组织机构超管证件类型 */ AdminIdCardType?: string; /** * 组织机构超管证件号码 */ AdminIdCardNumber?: string; /** * 原超管姓名 */ OldAdminName?: string; /** * 原超管手机号 */ OldAdminMobile?: string; /** * 原超管证件类型 */ OldAdminIdCardType?: string; /** * 原超管证件号码 */ OldAdminIdCardNumber?: string; } /** * ArchiveDynamicFlow返回参数结构体 */ export interface ArchiveDynamicFlowResponse { /** * 合同流程ID */ FlowId?: string; /** * 动态签署人的参与人信息 */ Approvers?: Array<ArchiveDynamicApproverData>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateLegalSealQrCode请求参数结构体 */ export interface CreateLegalSealQrCodeRequest { /** * 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` */ Operator?: UserInfo; /** * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 机构信息，暂未开放 * @deprecated */ Organization?: OrganizationInfo; } /** * DescribeSingleSignOnEmployees请求参数结构体 */ export interface DescribeSingleSignOnEmployeesRequest { /** * 执行本接口操作的员工信息。使用此接口时，必须填写userId。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` */ Operator: UserInfo; /** * 单点登录应用号的id,获取位置如下图![image](https://qcloudimg.tencent-cloud.cn/raw/9e61aaf390a5f90ea7606fe29b9a65fd.png) */ SsoApplicationId: string; /** * 需要查询的单点登录员工的唯一Id 值.不能超过 200 个。如果传递了 openIds，limit 和 offset 参数无效， */ OpenIds?: Array<string>; /** * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 指定分页每页返回的数据条数，单页最大支持 200。如果不传，则默认是 20. */ Limit?: number; /** * OFFSET 用于指定查询结果的偏移量，如果不传默认偏移为0,最大20000。分页参数, 需要limit, offset 配合使用例如: 您希望得到第三页的数据, 且每页限制最多10条您可以使用 LIMIT 10 OFFSET 20 */ Offset?: number; } /** * 合同文件验签单个结果结构体 */ export interface PdfVerifyResult { /** * 验签结果。0-签名域未签名；1-验签成功； 3-验签失败；4-未找到签名域：文件内没有签名域；5-签名值格式不正确。 */ VerifyResult?: number; /** * 签署平台如果文件是在腾讯电子签平台签署，则为**腾讯电子签**，如果文件不在腾讯电子签平台签署，则为**其他平台**。 */ SignPlatform?: string; /** * 申请证书的主体的名字如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下 **企业**: ESS@企业名称@编码 **个人**: ESS@个人姓名@证件号@808854 如果在其他平台签署的, 主体的名字参考其他平台的说明 */ SignerName?: string; /** * 签署时间的Unix时间戳，单位毫秒 */ SignTime?: number; /** * 证书签名算法, 如SHA1withRSA等算法 */ SignAlgorithm?: string; /** * 在数字证书申请过程中，系统会自动生成一个独一无二的序列号。 */ CertSn?: string; /** * 证书起始时间的Unix时间戳，单位毫秒 */ CertNotBefore?: number; /** * 证书过期时间的时间戳，单位毫秒 */ CertNotAfter?: number; /** * 签名域横坐标，单位px */ ComponentPosX?: number; /** * 签名域纵坐标，单位px */ ComponentPosY?: number; /** * 签名域宽度，单位px */ ComponentWidth?: number; /** * 签名域高度，单位px */ ComponentHeight?: number; /** * 签名域所在页码，1～N */ ComponentPage?: number; } /** * CreateUserNameChangeUrl请求参数结构体 */ export interface CreateUserNameChangeUrlRequest { /** * 操作人信息 */ Operator: UserInfo; /** * 要跳转的链接类型 <ul> <li>HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接</li> <li>HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接</li> <li>APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径</li> </ul> 注：如果不传递，默认值是 HTTP */ Endpoint?: string; /** * 在用户完成改名后，其自定义数据将通过[企业引导个人更名后回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AB-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E6%9B%B4%E5%90%8D%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。 */ UserData?: string; } /** * 企业认证信息 */ export interface AuthRecord { /** * 经办人姓名。 */ OperatorName?: string; /** * 经办人手机号。 */ OperatorMobile?: string; /** * 认证授权方式： <ul><li> **0**：未选择授权方式（默认值）</li> <li> **1**：上传授权书</li> <li> **2**：法人授权</li> <li> **3**：法人认证</li></ul> */ AuthType?: number; /** * 企业认证授权书审核状态： <ul><li> **0**：未提交授权书（默认值）</li> <li> **1**：审核通过</li> <li> **2**：审核驳回</li> <li> **3**：审核中</li> <li> **4**：AI识别中</li> <li> **5**：客户确认AI信息</li></ul> */ AuditStatus?: number; /** * 审核失败原因，当 AuditStatus 返回2时，则会返回具体的原因。 */ Reason?: string; } /** * UnbindEmployeeUserIdWithClientOpenId请求参数结构体 */ export interface UnbindEmployeeUserIdWithClientOpenIdRequest { /** * 执行本接口操作的员工信息。使用此接口时，必须填写UserId。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` */ Operator: UserInfo; /** * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取，也可登录腾讯电子签控制台查看 ![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png) */ UserId: string; /** * 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。 */ OpenId: string; /** * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; } /** * CreateBatchInformationExtractionTask请求参数结构体 */ export interface CreateBatchInformationExtractionTaskRequest { /** * 执行合同智能提取的员工信息。 注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code> */ Operator: UserInfo; /** * 合同智能提取的文件资源编号列表，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获取PDF、WORD、PNG、JPEG文件资源编号。注意：<ul><li>此接口仅支持5个文件发起</li><li>PDF、WORD文件限制在10M以内</li><li>PNG、JPEG文件限制在5M以内</li></ul> */ ResourceIds: Array<string>; /** * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 用户配置的合同智能提取字段模板ID，会基于此模板批量创建合同智能提取任务，为32位字符串。 <a href="https://qcloudimg.tencent-cloud.cn/raw/99008608577532423ea437c7fdbedca1.png">点击查看模板Id在控制台上的位置</a>注: <code>此配置优先级最高，设置了模板ID后Fields配置就会无效</code> */ FieldTemplateId?: string; /** * 用于合同智能提取的字段信息。注意：<code>字段模板优先级最高，如果设置了FieldTemplateId值，此配置就无效</code> */ Fields?: Array<ExtractionField>; } /** * CreateFlowByFiles请求参数结构体 */ export interface CreateFlowByFilesRequest { /** * 本合同的发起人 <a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a>注：支持填入集团子公司经办人 userId 代发合同。 */ Operator: UserInfo; /** * 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。该名称还将用于合同签署完成后文件下载的默认文件名称。 */ FlowName: string; /** * 本合同流程需包含的PDF文件资源编号列表，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获取PDF文件资源编号。注: <code>目前，此接口仅支持单个文件发起。</code> */ FileIds: Array<string>; /** * 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。 */ Approvers?: Array<ApproverInfo>; /** * 合同流程描述信息(可自定义此描述)，最大长度1000个字符。 */ FlowDescription?: string; /** * 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。 如果用户已经在控制台创建了自定义合同类型，可以将这里的类型名称传入。如果没有创建，我们会自动给发起方公司创建此自定义合同类型。 <img src="https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png" alt="image"> */ FlowType?: string; /** * 发起的时候合成到PDF上的填写控件（需要提供填写控件的内容）<ul><li> 单行文本控件 </li><li> 多行文本控件 </li><li> 勾选框控件 </li><li> 数字控件 </li><li> 图片控件 </li><li> 水印控件等 </li></ul><img src="https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png" alt="image"> */ Components?: Array<Component>; /** * 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。注<ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol> */ CcInfos?: Array<CcInfo>; /** * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：<ul><li> **0**：合同发起时通知（默认值）</li><li> **1**：签署完成后通知</li></ul> */ CcNotifyType?: number; /** * 是否为预览模式，取值如下：<ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li><li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。</li></ul> */ NeedPreview?: boolean; /** * 预览模式下产生的预览链接类型 <ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>注: <code>此参数在NeedPreview 为true时有效</code> */ PreviewType?: number; /** * 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。 */ Deadline?: number; /** * 合同流程的签署顺序类型：<ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul> */ Unordered?: boolean; /** * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2">回调通知</a>模块。 */ UserData?: string; /** * 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。 */ RemindedOn?: number; /** * 指定个人签署方查看合同的校验方式<ul><li> VerifyCheck :（默认）人脸识别,人脸识别后才能查看合同内容 </li><li> MobileCheck : 手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）</li></ul> */ ApproverVerifyType?: string; /** * 签署方签署控件（印章/签名等）的生成方式：<ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li><li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul>注：签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5 */ SignBeanTag?: number; /** * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：<ul><li>{合同名称} </li><li>{发起方企业} </li><li>{发起方姓名} </li><li>{签署方N企业}</li><li>{签署方N姓名}</li></ul>其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：<code>合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}</code>，则小程序中列表页展示此合同为以下样子合同名称：租房合同 发起方：腾讯公司(张三) 签署方：李四<img src="https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png" alt="image"> */ CustomShowMap?: string; /** * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 */ Agent?: Agent; /** * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。</code> */ AutoSignScene?: string; /** * 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：<ul><li> **false**：（默认）不需要审批，直接签署。</li><li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>注：<code>此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同</code> */ NeedSignReview?: boolean; /** * 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> 0 :合同（默认值）</li> <li> 1 :文件</li> <li> 2 :协议</li><li> 3 :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"> */ FlowDisplayType?: number; /** * 是否开启动态签署合同：<ul><li> true：开启动态签署合同，可在发起时可以不传签署人，在签署过程中追加签署人（必须满足：1，发起方企业开启了模块化计费能力；2，发起方企业在企业应用管理中开启了动态签署人2.0能力）。</li><li> false：不开启动态签署合同。</li></ul> */ OpenDynamicSignFlow?: boolean; /** * 是否开启发起合同审批，默认：false（不开启），开启后，发起合同（StartFlow），会提交电子签内置的审批流 */ Workflow?: boolean; /** * 发起合同流程时对合同流程的部分操作加以限制的配置。 */ FlowOperateLimit?: FlowOperateLimit; } /** * DescribeContractReviewChecklist请求参数结构体 */ export interface DescribeContractReviewChecklistRequest { /** * 执行本接口操作的员工信息。 注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code> */ Operator: UserInfo; /** * 需要获取的合同风险审查清单ID */ ChecklistId: 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；支持的文件类型包括doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf ``` FormField输入示例： { "ComponentId": "componentId1", "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3" } ``` 当控件的 ComponentType='SELECTOR'时，FormField.ComponentValue填入选择的选项内容； ``` FormField输入示例： { "ComponentId": "componentId1", "ComponentValue": "选择的内容" } ``` 多选需要用“、”分割选项 ``` { "ComponentId": "componentId1", "ComponentValue": "选项1、选项2" } ``` 当控件的 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"} } ] } } ``` 输入示例4（表格设置表头不合成到文件）： ``` { "headers": [ { "content": "序号" }, { "content": "品牌" }, { "content": "商品名称" }, { "content": "粒径" }, { "content": "规格" }, { "content": "数量(包)" }, { "content": "重量(吨)" } ], "rowCount": 5, "body": { "cells": [ { "rowStart": 1, "rowEnd": 1, "columnStart": 1, "columnEnd": 1, "content": "1" }, { "rowStart": 1, "rowEnd": 1, "columnStart": 2, "columnEnd": 2, "content": "品牌名称1" }, { "rowStart": 1, "rowEnd": 1, "columnStart": 3, "columnEnd": 3, "content": "商品名称1" }, { "rowStart": 1, "rowEnd": 1, "columnStart": 4, "columnEnd": 4, "content": "7#" }, { "rowStart": 1, "rowEnd": 1, "columnStart": 5, "columnEnd": 5, "content": "20" }, { "rowStart": 1, "rowEnd": 1, "columnStart": 6, "columnEnd": 6, "content": "50" }, { "rowStart": 1, "rowEnd": 1, "columnStart": 7, "columnEnd": 7, "content": "1.000" }, { "rowStart": 2, "rowEnd": 2, "columnStart": 1, "columnEnd": 1, "content": "2" }, { "rowStart": 2, "rowEnd": 2, "columnStart": 2, "columnEnd": 2, "content": "品牌名称2" }, { "rowStart": 2, "rowEnd": 2, "columnStart": 3, "columnEnd": 3, "content": "商品名称2" }, { "rowStart": 2, "rowEnd": 2, "columnStart": 4, "columnEnd": 4, "content": "5#" }, { "rowStart": 2, "rowEnd": 2, "columnStart": 5, "columnEnd": 5, "content": "20" }, { "rowStart": 2, "rowEnd": 2, "columnStart": 6, "columnEnd": 6, "content": "20" }, { "rowStart": 2, "rowEnd": 2, "columnStart": 7, "columnEnd": 7, "content": "0.400" }, { "rowStart": 3, "rowEnd": 3, "columnStart": 1, "columnEnd": 1, "content": "3" }, { "rowStart": 3, "rowEnd": 3, "columnStart": 2, "columnEnd": 2, "content": "品牌名称3" }, { "rowStart": 3, "rowEnd": 3, "columnStart": 3, "columnEnd": 3, "content": "商品名称3" }, { "rowStart": 3, "rowEnd": 3, "columnStart": 4, "columnEnd": 4, "content": "2#" }, { "rowStart": 3, "rowEnd": 3, "columnStart": 5, "columnEnd": 5, "content": "20" }, { "rowStart": 3, "rowEnd": 3, "columnStart": 6, "columnEnd": 6, "content": "5" }, { "rowStart": 3, "rowEnd": 3, "columnStart": 7, "columnEnd": 7, "content": "0.100" }, { "rowStart": 4, "rowEnd": 4, "columnStart": 1, "columnEnd": 1, "content": "4" }, { "rowStart": 4, "rowEnd": 4, "columnStart": 2, "columnEnd": 2, "content": "品牌名称4" }, { "rowStart": 4, "rowEnd": 4, "columnStart": 3, "columnEnd": 3, "content": "商品名称4" }, { "rowStart": 4, "rowEnd": 4, "columnStart": 4, "columnEnd": 4, "content": "3#" }, { "rowStart": 4, "rowEnd": 4, "columnStart": 5, "columnEnd": 5, "content": "20" }, { "rowStart": 4, "rowEnd": 4, "columnStart": 6, "columnEnd": 6, "content": "10" }, { "rowStart": 4, "rowEnd": 4, "columnStart": 7, "columnEnd": 7, "content": "0.200" }, { "rowStart": 5, "rowEnd": 5, "columnStart": 1, "columnEnd": 5, "content": "合计" }, { "rowStart": 5, "rowEnd": 5, "columnStart": 6, "columnEnd": 6, "content": "85" }, { "rowStart": 5, "rowEnd": 5, "columnStart": 7, "columnEnd": 7, "content": "1.700" } ] }, "settings": { "headerRowDisplay": false } } ``` 表格参数说明 | 名称 | 类型 | 描述 | | ------------------- | ------- | ------------------------------------------------- | | headers | Array | 表头：不超过10列，不支持单元格合并，字数不超过100 | | rowCount | Integer | 表格内容最大行数 | | cells.N.rowStart | Integer | 单元格坐标：行起始index | | cells.N.rowEnd | Integer | 单元格坐标：行结束index