@nocobase/plugin-verification

/** * SyncProxyOrganization返回参数结构体 */ export interface SyncProxyOrganizationResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用户计费使用情况详情 */ export interface BillUsageDetail { /** * 合同流程ID，为32位字符串。建议开发者妥善保存此流程ID，以便于顺利进行后续操作。注意：此字段可能返回 null，表示取不到有效值。 */ FlowId?: string; /** * 合同经办人名称如果有多个经办人用分号隔开。注意：此字段可能返回 null，表示取不到有效值。 */ OperatorName?: string; /** * 发起方组织机构名称注意：此字段可能返回 null，表示取不到有效值。 */ CreateOrganizationName?: string; /** * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。注意：此字段可能返回 null，表示取不到有效值。 */ FlowName?: string; /** * 当前合同状态,如下是状态码对应的状态。 0-还没有发起 1-等待签署 2-部分签署 3-拒签 4-已签署 5-已过期 6-已撤销 7-还没有预发起 8-等待填写 9-部分填写 10-拒填 11-已解除注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * 套餐类型对应关系如下 CloudEnterprise-企业版合同 SingleSignature-单方签章 CloudProve-签署报告 CloudOnlineSign-腾讯会议在线签约 ChannelWeCard-微工卡 SignFlow-合同套餐 SignFace-签署意愿（人脸识别） SignPassword-签署意愿（密码） SignSMS-签署意愿（短信） PersonalEssAuth-签署人实名（腾讯电子签认证） PersonalThirdAuth-签署人实名（信任第三方认证） OrgEssAuth-签署企业实名 FlowNotify-短信通知 AuthService-企业工商信息查询注意：此字段可能返回 null，表示取不到有效值。 */ QuotaType?: string; /** * 合同使用量注意：此字段可能返回 null，表示取不到有效值。 */ UseCount?: number; /** * 消耗的时间戳，格式为Unix标准时间戳（秒）。注意：此字段可能返回 null，表示取不到有效值。 */ CostTime?: number; /** * 消耗的套餐名称注意：此字段可能返回 null，表示取不到有效值。 */ QuotaName?: string; /** * 消耗类型 1.扣费 2.撤销返还注意：此字段可能返回 null，表示取不到有效值。 */ CostType?: number; /** * 备注注意：此字段可能返回 null，表示取不到有效值。 */ Remark?: string; } /** * ChannelCreateConvertTaskApi返回参数结构体 */ export interface ChannelCreateConvertTaskApiResponse { /** * 接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。 */ TaskId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelCreateFlowReminds返回参数结构体 */ export interface ChannelCreateFlowRemindsResponse { /** * 合同催办结果的详细信息列表。 */ RemindFlowRecords?: Array<RemindFlowRecords>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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 { /** * 控件编号 CreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；否则以ComponentName填充注：当GenerateMode=KEYWORD时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构 */ ComponentId?: string; /** * 如果是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; /** * 控件简称，不超过30个字符 */ ComponentName?: string; /** * 控件是否为必填项，默认为false-非必填 */ ComponentRequired?: boolean; /** * 控件关联的参与方ID，对应Recipient结构体中的RecipientId */ ComponentRecipientId?: string; /** * 控件所属文件的序号 (文档中文件的排列序号，从0开始) */ FileIndex?: number; /** * 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找） */ GenerateMode?: string; /** * 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填 */ ComponentWidth?: number; /** * 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填 */ ComponentHeight?: number; /** * 参数控件所在页码，从1开始 */ ComponentPage?: number; /** * 参数控件X位置，单位px */ ComponentPosX?: number; /** * 参数控件Y位置，单位px */ ComponentPosY?: number; /** * 扩展参数：为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":"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}" */ ComponentExtra?: string; /** * 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DATE - 默认是格式化为xxxx年xx月xx日 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo 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; /** * 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小 */ ComponentDateFontSize?: number; /** * 控件所属文档的Id, 模板相关接口为空值 */ DocumentId?: string; /** * 控件描述，不超过30个字符 */ ComponentDescription?: string; /** * 指定关键字时横坐标偏移量，单位pt */ OffsetX?: number; /** * 指定关键字时纵坐标偏移量，单位pt */ OffsetY?: number; /** * 平台企业控件ID。如果不为空，属于平台企业预设控件； */ ChannelComponentId?: string; /** * 指定关键字排序规则， 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<number | bigint>; /** * 填写提示的内容注意：此字段可能返回 null，表示取不到有效值。 */ Placeholder?: string; /** * 是否锁定控件值不允许编辑（嵌入式发起使用） <br/>默认false：不锁定控件值，允许在页面编辑控件值注意：此字段可能返回 null，表示取不到有效值。 */ LockComponentValue?: boolean; /** * 是否禁止移动和删除控件 <br/>默认false，不禁止移动和删除控件注意：此字段可能返回 null，表示取不到有效值。 */ ForbidMoveAndDelete?: boolean; } /** * ChannelDeleteSealPolicies请求参数结构体 */ export interface ChannelDeleteSealPoliciesRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 */ Agent: Agent; /** * 操作的印章ID */ SealId: string; /** * 需要删除授权的用户ID数组，可以传入电子签系统用户ID或OpenId。注: 1. `填写OpenId时，系统会通过组织+渠道+OpenId查询得到对应的UserId进行授权取消操作` */ UserIds: Array<string>; /** * 组织机构信息，不用传 * @deprecated */ Organization?: OrganizationInfo; /** * 操作人（用户）信息，不用传 * @deprecated */ Operator?: UserInfo; } /** * ChannelBatchCancelFlows返回参数结构体 */ export interface ChannelBatchCancelFlowsResponse { /** * 签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为"", 失败则对应失败原因注: `如果全部撤销成功, 此数组为空数组` */ FailMessages?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelDisableUserAutoSign返回参数结构体 */ export interface ChannelDisableUserAutoSignResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 第三方应用集成员工部门信息 */ export interface Department { /** * 部门id 注意：此字段可能返回 null，表示取不到有效值。 */ DepartmentId: string; /** * 部门名称注意：此字段可能返回 null，表示取不到有效值。 */ DepartmentName: string; } /** * 签署人配置信息 */ export interface CommonApproverOption { /** * 是否允许修改签署人信息 */ CanEditApprover?: boolean; } /** * ChannelCreateFlowGroupByTemplates返回参数结构体 */ export interface ChannelCreateFlowGroupByTemplatesResponse { /** * 合同组ID，为32位字符串。建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。 */ FlowGroupId?: string; /** * 合同组中每个合同流程ID，每个ID均为32位字符串。注: `此数组的顺序和入参中的FlowInfos顺序一致` */ FlowIds?: Array<string>; /** * 复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情； */ TaskInfos?: Array<TaskInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelCreateFlowSignReview请求参数结构体 */ export interface ChannelCreateFlowSignReviewRequest { /** * 应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 */ Agent: Agent; /** * 签署流程编号 */ FlowId: string; /** * 企业内部审核结果 PASS: 通过 REJECT: 拒绝 SIGN_REJECT:拒签(流程结束) */ ReviewType: string; /** * 审核原因当ReviewType 是REJECT 时此字段必填,字符串长度不超过200 */ ReviewMessage?: string; /** * 签署节点审核时需要指定，给个人审核时必填。 */ RecipientId?: string; /** * 操作类型，默认：SignReview；SignReview:签署审核，CreateReview：发起审核注：接口通过该字段区分操作类型该字段不传或者为空，则默认为SignReview签署审核，走签署审核流程若想使用发起审核，请指定该字段为：CreateReview 若发起个人审核，则指定该字段为：SignReview */ OperateType?: string; } /** * 授权出错信息 */ export interface AuthFailMessage { /** * 第三方平台子客企业的唯一标识，长度不能超过64，只能由字母和数字组成。开发者可自定义此字段的值，并需要保存此 ID 以便进行后续操作。一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的，不可更改，不可重复使用。例如，可以使用企业名称的哈希值，或者社会统一信用代码的哈希值，或者随机哈希值。 */ ProxyOrganizationOpenId?: string; /** * 错误信息 */ Message?: string; } /** * DescribeFlowDetailInfo请求参数结构体 */ export interface DescribeFlowDetailInfoRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** * 需要查询的流程ID列表，最多可传入100个ID。如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。 */ FlowIds?: Array<string>; /** * 需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。合同组由<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。 */ FlowGroupId?: string; /** * 暂未开放 * @deprecated */ Operator?: UserInfo; } /** * ChannelCancelUserAutoSignEnableUrl返回参数结构体 */ export interface ChannelCancelUserAutoSignEnableUrlResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyExtendedService请求参数结构体 */ export interface ModifyExtendedServiceRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li> <li>第三方平台子客企业中的员工标识: Agent.AppId</li> </ul> */ Agent: Agent; /** * 扩展服务类型 <ul> <li>AUTO_SIGN 企业自动签（自动签署）</li> <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li> <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li> <li> PAGING_SEAL 骑缝章</li> <li> DOWNLOAD_FLOW 授权渠道下载合同 </li> <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li> </ul> */ ServiceType: string; /** * 操作类型 OPEN:开通 CLOSE:关闭 */ Operate: string; /** * 链接跳转类型，支持以下类型 <ul> <li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li> <li>APP : 第三方APP或小程序跳转电子签小程序</li> </ul> */ Endpoint?: string; } /** * DescribeResourceUrlsByFlows请求参数结构体 */ export interface DescribeResourceUrlsByFlowsRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** * 需要下载的合同流程的ID, 至少需要1个, 做多50个 */ FlowIds?: Array<string>; /** * 操作者的信息，不用传 * @deprecated */ Operator?: UserInfo; } /** * CreateChannelOrganizationInfoChangeUrl返回参数结构体 */ export interface CreateChannelOrganizationInfoChangeUrlResponse { /** * 创建的企业信息变更链接。需要在移动端打开，会跳转到微信腾讯电子签小程序进行更换。 */ Url?: string; /** * 链接过期时间。链接7天有效。 */ ExpiredTime?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 催办接口返回的详细信息。 */ export interface RemindFlowRecords { /** * 合同流程是否可以催办： true - 可以，false - 不可以。若无法催办，将返回RemindMessage以解释原因。 */ CanRemind?: boolean; /** * 合同流程ID，为32位字符串。 */ FlowId?: string; /** * 在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。 */ RemindMessage?: string; } /** * ChannelCreateFlowSignUrl返回参数结构体 */ export interface ChannelCreateFlowSignUrlResponse { /** * 签署人签署链接信息 */ FlowApproverUrlInfos?: Array<FlowApproverUrlInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelCreateBatchSignUrl返回参数结构体 */ export interface ChannelCreateBatchSignUrlResponse { /** * 批量签署链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。注: `非小程序和APP集成使用` */ SignUrl?: string; /** * 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。 */ ExpiredTime?: number; /** * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径注: `小程序和APP集成使用` */ MiniAppPath?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelCreatePrepareFlow返回参数结构体 */ export interface ChannelCreatePrepareFlowResponse { /** * 发起的合同嵌入链接，可以直接点击进入进行合同发起，有效期为5分钟 */ PrepareFlowUrl?: string; /** * 合同发起后预览链接，注意此时合同并未发起，仅只是展示效果，有效期为5分钟 */ PreviewFlowUrl?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 主题配置 */ export interface WebThemeConfig { /** * 是否显示页面底部电子签logo，取值如下： <ul><li> **true**：页面底部显示电子签logo</li> <li> **false**：页面底部不显示电子签logo（默认）</li></ul> */ DisplaySignBrandLogo?: boolean; /** * 主题颜色：支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65) <br/> */ WebEmbedThemeColor?: string; } /** * OperateChannelTemplate返回参数结构体 */ export interface OperateChannelTemplateResponse { /** * 第三方应用平台的应用ID 注意：此字段可能返回 null，表示取不到有效值。 */ AppId?: string; /** * 合同模板ID 注意：此字段可能返回 null，表示取不到有效值。 */ TemplateId?: string; /** * 描述模板可见性更改的结果。 <ul> <li>all-success: 全部成功</li> <li>part-success: 部分成功,失败的会在FailMessageList中展示</li> <li>fail:全部失败, 失败的会在FailMessageList中展示</li> </ul> 注意：此字段可能返回 null，表示取不到有效值。 */ OperateResult?: string; /** * 模板可见范围: **all**: 所有本第三方应用合作企业可见 **part**: 指定的本第三方应用合作企业注意：此字段可能返回 null，表示取不到有效值。 */ AuthTag?: string; /** * 第三方平台子客企业标识列表注意：此字段可能返回 null，表示取不到有效值。 */ ProxyOrganizationOpenIds?: Array<string>; /** * 操作失败信息数组注意：此字段可能返回 null，表示取不到有效值。 */ FailMessageList?: Array<AuthFailMessage>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 合同组中每个子合同的发起信息 */ export interface FlowFileInfo { /** * 签署文件资源Id列表，目前仅支持单个文件 */ FileIds: Array<string>; /** * 签署流程名称，长度不超过200个字符 */ FlowName: string; /** * 签署流程签约方列表，最多不超过5个参与方 */ FlowApprovers: Array<FlowApproverInfo>; /** * 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年 */ Deadline?: number; /** * 签署流程的描述，长度不超过1000个字符 */ FlowDescription?: string; /** * 签署流程的类型，长度不超过255个字符 */ FlowType?: string; /** * 签署流程回调地址，长度不超过255个字符 */ CallbackUrl?: string; /** * 第三方应用的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN */ CustomerData?: string; /** * 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署 */ Unordered?: boolean; /** * 签署文件中的发起方的填写控件，需要在发起的时候进行填充 */ Components?: Array<Component>; /** * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始 */ CustomShowMap?: string; /** * 本企业(发起方企业)是否需要签署审批 */ NeedSignReview?: boolean; } /** * 创建合同个性化参数 */ export interface CreateFlowOption { /** * 是否允许修改合同信息， **true**：可以 **false**：（默认）不可以 */ CanEditFlow?: boolean; /** * 是否允许发起合同弹窗隐藏合同名称 **true**：允许 **false**：（默认）不允许 */ HideShowFlowName?: boolean; /** * 是否允许发起合同弹窗隐藏合同类型， **true**：允许 **false**：（默认）不允许 */ HideShowFlowType?: boolean; /** * 是否允许发起合同弹窗隐藏合同到期时间 **true**：允许 **false**：（默认）不允许 */ HideShowDeadline?: boolean; /** * 是否允许发起合同步骤跳过指定签署方步骤 **true**：允许 **false**：（默认）不允许 */ CanSkipAddApprover?: boolean; /** * 定制化发起合同弹窗的描述信息，长度不能超过500，只能由中文、字母、数字和标点组成。 */ CustomCreateFlowDescription?: string; /** * 禁止编辑填写控件 **true**：禁止编辑填写控件 **false**：（默认）允许编辑填写控件 */ ForbidEditFillComponent?: boolean; /** * 跳过上传文件步骤 **true**：跳过 **false**：（默认）不跳过，需要传ResourceId */ SkipUploadFile?: boolean; } /** * ChannelCreateRole请求参数结构体 */ export interface ChannelCreateRoleRequest { /** * 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。 */ Name: string; /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** * 角色描述，最大长度为50个字符 */ Description?: string; /** * 权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出 */ PermissionGroups?: Array<PermissionGroup>; } /** * 基础流程信息 */ export interface BaseFlowInfo { /** * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 */ FlowName: string; /** * 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。 */ FlowType: string; /** * 合同流程描述信息(可自定义此描述)，最大长度1000个字符。 */ FlowDescription: string; /** * 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。 */ Deadline: number; /** * 合同流程的签署顺序类型： **false**：(默认)有序签署, 本合同多个参与人需要依次签署 **true**：无序签署, 本合同多个参与人没有先后签署限制 */ Unordered?: boolean; /** * 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE") */ IntelligentStatus?: string; /** * 填写控件内容，填写的控制的ID-填写的内容对列表 */ FormFields?: Array<FormField>; /** * 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： <ul><li> **false**：（默认）不需要审批，直接签署。</li> <li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul> 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 <ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li> <li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul> 注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同` */ NeedSignReview?: boolean; /** * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。 */ UserData?: string; /** * 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。注:`此功能为白名单功能，使用前请联系对接的客户经理沟通。` */ CcInfos?: Array<CcInfo>; /** * 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。 */ NeedCreateReview?: boolean; /** * 填写控件：文件发起使用 */ Components?: Array<Component>; } /** * 解除协议的签署人，如不指定，默认使用待解除流程(原流程)中的签署人。</br> `注意`: - 不支持更换C端(个人身份类型)签署人，如果原流程中含有C端签署人，默认使用原流程中的该签署人。 - 目前不支持替换C端(个人身份类型)签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。 - 当指定C端签署人的签署方自定义控件别名不空时，除参数ApproverNumber外，可以只传参数ApproverSignRole。如果需要指定B端(企业身份类型)签署人，其中ReleasedApprover需要传递的参数如下： `ApproverNumber`, `OrganizationName`, `ApproverType`必传。</br> 对于其他身份标识： - **子客企业指定经办人**：OpenId必传，OrganizationOpenId必传； - **非子客企业经办人**：Name、Mobile必传。 */ export interface ReleasedApprover { /** * 签署人在原合同签署人列表中的顺序序号(从0开始，按顺序依次递增)。</br> 可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。 */ ApproverNumber: number; /** * 指定签署人类型，目前支持 <ul><li> **ORGANIZATION**：企业(默认值)</li> <li> **ENTERPRISESERVER**：企业静默签</li></ul> */ ApproverType: string; /** * 签署人姓名，最大长度50个字。 */ Name?: string; /** * 签署方经办人的证件类型，支持以下类型 <ul><li>ID_CARD : 居民身份证(默认值)</li> <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li> <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul> */ IdCardType?: string; /** * 证件号码，应符合以下规则 <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li> <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母(但“I”、“O”除外)，后7位为阿拉伯数字。</li> <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul> */ IdCardNumber?: string; /** * 签署人手机号。 */ Mobile?: string; /** * 组织机构名称。请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。如果签署方是企业签署方(approverType = 0 或者 approverType = 3)，则企业名称必填。 */ OrganizationName?: string; /** * 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。</br> 当为子客企业指定经办人时，此OrganizationOpenId必传。 */ OrganizationOpenId?: string; /** * 第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成。</br> 当签署方为同一第三方平台下的员工时，此OpenId必传。 */ OpenId?: string; /** * 签署控件类型，支持自定义企业签署方的签署控件类型 <ul><li> **SIGN_SEAL**：默认为印章控件类型(默认值)</li> <li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul> */ ApproverSignComponentType?: string; /** * 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`，以此类推。</br> 如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。 */ ApproverSignRole?: string; } /** * CreateConsoleLoginUrl返回参数结构体 */ export interface CreateConsoleLoginUrlResponse { /** * 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表 <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> </tbody> </table> 注： `1.链接仅单次有效，每次登录需要需要重新创建新的链接` `2.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义` */ ConsoleUrl?: string; /** * 子客企业是否已开通腾讯电子签， <ul><li> **true** :已经开通腾讯电子签</li> <li> **false** :还未开通腾讯电子签</li></ul> 注：`企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断，非企业名称或者社会信用代码` */ IsActivated?: boolean; /** * 当前经办人是否已认证并加入功能 <ul><li> **true** : 已经认证加入公司</li> <li> **false** : 还未认证加入公司</li></ul> 注意：**员工是否实名是根据Agent.ProxyOperator.OpenId判断，非经办人姓名** */ ProxyOperatorIsVerified?: boolean; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelDeleteRoleUsers请求参数结构体 */ export interface ChannelDeleteRoleUsersRequest { /** * 代理信息此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 */ Agent: Agent; /** * 角色Id（非超管或法人角色Id） */ RoleId: string; /** * 电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数，最多两百 */ UserIds?: Array<string>; /** * 操作人信息 * @deprecated */ Operator?: UserInfo; /** * 客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数，最多两百 */ OpenIds?: Array<string>; } /** * ChannelCreateUserRoles返回参数结构体 */ export interface ChannelCreateUserRolesResponse { /** * 绑定失败的用户角色列表 */ FailedCreateRoleData?: Array<FailedCreateRoleData>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SyncProxyOrganization请求参数结构体 */ export interface SyncProxyOrganizationRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> </ul> */ Agent: Agent; /** * 第三方平台子客企业名称，请确认该名称与企业营业执照中注册的名称一致。注: `如果名称中包含英文括号()，请使用中文括号（）代替。` */ ProxyOrganizationName: string; /** * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M */ BusinessLicense?: string; /** * 第三方平台子客企业统一社会信用代码，最大长度200个字符 */ UniformSocialCreditCode?: string; /** * 第三方平台子客企业法定代表人的名字 */ ProxyLegalName?: string; /** * 暂未开放 * @deprecated */ Operator?: UserInfo; /** * 第三方平台子客企业法定代表人的证件类型，支持以下类型 <ul><li>ID_CARD : 居民身份证 (默认值)</li></ul> 注: `现在仅支持ID_CARD居民身份证类型` */ ProxyLegalIdCardType?: string; /** * 第三方平台子客企业法定代表人的证件号码, 应符合以下规则 <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li></ul> */ ProxyLegalIdCardNumber?: string; /** * 第三方平台子客企业详细住所，最大长度500个字符注：`需要符合省市区详情的格式例如： XX省XX市XX区街道具体地址` */ ProxyAddress?: string; } /** * ChannelCreatePrepareFlow请求参数结构体 */ export interface ChannelCreatePrepareFlowRequest { /** * 资源id，与ResourceType相对应，取值范围： <ul> <li>文件Id（通过UploadFiles获取文件资源Id）</li> <li>模板Id</li> </ul> */ ResourceId: string; /** * 资源类型，取值有： <ul><li> **1**：模板</li> <li> **2**：文件（默认值）</li></ul> */ ResourceType: number; /** * 要创建的合同信息 */ FlowInfo: BaseFlowInfo; /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent?: Agent; /** * 合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑 */ FlowOption?: CreateFlowOption; /** * 合同签署人信息 */ FlowApproverList?: Array<CommonFlowApprover>; /** * 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接注: `该参数必须是一个待发起审核的合同id，并且还未审核通过` */ FlowId?: string; /** * 该参数不可用，请通过获取 web 可嵌入接口获取合同流程预览 URL * @deprecated */ NeedPreview?: boolean; /** * 企业机构信息，不用传 * @deprecated */ Organization?: OrganizationInfo; /** * 操作人（用户）信息，不用传 * @deprecated */ Operator?: UserInfo; } /** * ChannelCreateFlowReminds请求参数结构体 */ export interface ChannelCreateFlowRemindsRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** * 需执行催办的合同流程ID数组，最多支持100个。 */ FlowIds: Array<string>; } /** * ChannelCreateSealPolicy返回参数结构体 */ export interface ChannelCreateSealPolicyResponse { /** * 最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的。请求参数填写OpenId时，返回授权成功的 Openid。 */ UserIds?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 电子文档的控件填充信息。按照控件类型进行相应的填充。当控件的 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 { /** * 控件填充值，ComponentType和传入值格式对应关系如下： <ul> <li>TEXT - 普通文本控件，需输入文本字符串；</li> <li>MULTI_LINE_TEXT - 多行文本控件，需输入文本字符串；</li> <li>CHECK_BOX - 勾选框控件，若选中需填写ComponentValue，填写 true或者 false 字符串；</li> <li>FILL_IMAGE - 图片控件，需填写ComponentValue为图片的资源 ID；</li> <li>DYNAMIC_TABLE - 动态表格控件；</li> <li>ATTACHMENT - 附件控件，需填写ComponentValue为附件图片的资源 ID列表，以逗号分割；</li> <li>DATE - 日期控件；格式为 <b>xxxx年xx月xx日</b> 字符串；</li> <li>DISTRICT - 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容；</li> </ul> */ ComponentValue: string; /** * 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。注意：此字段可能返回 null，表示取不到有效值。 */ ComponentId?: string; /** * 控件的名字，跟ComponentId二选一，不能全为空注意：此字段可能返回 null，表示取不到有效值。 */ ComponentName?: string; /** * 是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定注意：此字段可能返回 null，表示取不到有效值。 */ LockComponentValue?: boolean; } /** * ChannelCancelFlow返回参数结构体 */ export interface ChannelCancelFlowResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 签署流程下载信息 */ export interface DownloadFlowInfo { /** * 文件夹名称 */ FileName: string; /** * 签署流程的标识数组 */ FlowIdList: Array<string>; } /** * 签署人签署链接信息。 */ export interface FlowApproverUrlInfo { /** * 签署短链接。</br> 注意: - 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。 - 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。 */ SignUrl?: string; /** * 签署人类型。 - **PERSON**: 个人 */ ApproverType?: string; /** * 签署人姓名。 */ Name?: string; /** * 签署人手机号。 */ Mobile?: string; /** * 签署长链接。</br> 注意: - 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。 - 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。注意：此字段可能返回 null，表示取不到有效值。 */ LongUrl?: string; } /** * ChannelCreateWebThemeConfig请求参数结构体 */ export interface ChannelCreateWebThemeConfigRequest { /** * 应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 */ Agent: Agent; /** * 主题类型<br/>EMBED_WEB_THEME：嵌入式主题 <br/>目前只支持EMBED_WEB_THEME，web页面嵌入的主题风格配置 */ ThemeType: string; /** * 主题配置 */ WebThemeConfig: WebThemeConfig; } /** * ChannelCreateConvertTaskApi请求参数结构体 */ export interface ChannelCreateConvertTaskApiRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** * 需要进行转换的资源文件类型支持的文件类型如下： <ul><li>doc</li> <li>docx</li> <li>xls</li> <li>xlsx</li> <li>jpg</li> <li>jpeg</li> <li>png</li> <li>bmp</li> <li>html</li> <li>txt</li></ul> */ ResourceType: string; /** * 需要进行转换操作的文件资源名称，带资源后缀名。注: `资源名称长度限制为256个字符` */ ResourceName: string; /** * 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。注: `目前，此接口仅支持单个文件进行转换。` */ ResourceId: string; /** * 调用方用户信息，不用传 * @deprecated */ Operator?: UserInfo; /** * 暂未开放 * @deprecated */ Organization?: OrganizationInfo; } /** * ChannelCreateFlowByFiles请求参数结构体 */ export interface ChannelCreateFlowByFilesRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li> <li>第三方平台子客企业中的员工标识: Agent.AppId</li> </ul> */ Agent?: Agent; /** * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 */ FlowName?: string; /** * 合同流程描述信息(可自定义此描述)，最大长度1000个字符。 */ FlowDescription?: string; /** * 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo" target="_blank">FlowApproverInfo结构体</a>。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。 */ FlowApprovers?: Array<FlowApproverInfo>; /** * 本合同流程需包含的PDF文件资源编号列表，通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。注: `目前，此接口仅支持单个文件发起。` */ FileIds?: Array<string>; /** * 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体 <ul><li>单行文本控件</li> <li>多行文本控件</li> <li>勾选框控件</li> <li>数字控件</li> <li>图片控件</li> <li>数据表格等填写控件</li></ul> */ Components?: Array<Component>; /** * 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。 */ Deadline?: number; /** * 执行结果的回调URL，长度不超过255个字符，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_data_types" target="_blank">回调通知</a>模块。注: `如果不传递回调地址，则默认是配置应用号时候使用的回调地址` */ CallbackUrl?: string; /** * 合同流程的签署顺序类型： <ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li> <li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul> **注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序` */ Unordered?: boolean; /** * 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。 */ FlowType?: string; /** * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： <ul><li>{合同名称} </li> <li>{发起方企业} </li> <li>{发起方姓名} </li> <li>{签署方N企业}</li> <li>{签署方N姓名}</li></ul> 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四 */ CustomShowMap?: string; /** * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">回调通知</a>模块。 */ CustomerData?: string; /** * 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： <ul><li> **false**：（默认）不需要审批，直接签署。</li> <li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul> 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 <ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li> <li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul> 注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同` */ NeedSignReview?: boolean; /** * 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。 */ ApproverVerifyType?: string; /** * 签署方签署控件（印章/签名等）的生成方式： <ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li> <li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul> **注**: `发起后添加控件功能不支持添加签批控件` */ SignBeanTag?: number; /** * 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。 */ CcInfos?: Array<CcInfo>; /** * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容： <ul><li> **0**：合同发起时通知（默认值）</li> <li> **1**：签署完成后通知</li></ul> */ CcNotifyType?: number; /** * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签） </li></ul> 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。` */ AutoSignScene?: string; /** * 操作者的信息，不用传 * @deprecated */ Operator?: UserInfo; } /** * UploadFiles返回参数结构体 */ export interface UploadFilesResponse { /** * 上传成功文件数量注: `如果一个文件上传失败, 则全部文件皆上传失败` */ TotalCount?: number; /** * 文件资源ID数组，每个文件资源ID为32位字符串。建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用` */ FileIds?: Array<string>; /** * 对应上传文件的下载链接，过期时间5分钟 */ FileUrls?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 应用相关信息, 整体应用的层级图如下注: 1. `不同的业务系统可以采用不同的应用，不同应用下的数据是隔离的, 应用A中的某个企业已经实名, 在应用B中此企业还需要重新认证` */ export interface Agent { /** * 应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png) */ AppId: string; /** * 第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串 */ ProxyOrganizationOpenId?: string; /** * 第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。 */ ProxyOperator?: UserInfo; /** * **不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。 */ ProxyAppId?: string; /** * 内部参数，暂未开放使用 * @deprecated */ ProxyOrganizationId?: string; } /** * ChannelCreatePreparedPersonalEsign返回参数结构体 */ export interface ChannelCreatePreparedPersonalEsignResponse { /** * 电子印章ID，为32位字符串。建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。 */ SealId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 签署人的流程信息明细 */ export interface FlowApproverDetail { /** * 模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色 */ ReceiptId?: string; /** * 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a> 注意：此字段可能返回 null，表示取不到有效值。 */ ProxyOrganizationOpenId?: string; /** * 第三方平台子客企业员工的唯一标识 */ ProxyOperatorOpenId?: string; /** * 第三方平台子客企业名称，与企业营业执照中注册的名称一致。 */ ProxyOrganizationName?: string; /** * 签署人手机号 */ Mobile?: string; /** * 签署顺序，如果是有序签署，签署顺序从小到大 */ SignOrder?: number; /** * 签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。注意：此字段可能返回 null，表示取不到有效值。 */ ApproveName?: string; /** * 当前签署人的状态, 状态如下 <ul><li> **PENDING** :待签署</li> <li> **FILLPENDING** :待填写</li> <li> **FILLACCEPT** :填写完成</li> <li> **FILLREJECT** :拒绝填写</li> <li> **WAITPICKUP** :待领取</li> <li> **ACCEPT** :已签署</li> <li> **REJECT** :拒签</li> <li> **DEADLINE** :过期没人处理</li> <li> **CANCEL** :流程已撤回</li> <li> **FORWARD** :已经转他人处理</li> <li> **STOP** :流程已终止</li> <li> **RELIEVED** :解除协议（已解除）</li></ul> 注意：此字段可能返回 null，表示取不到有效值。 */ ApproveStatus?: string; /** * 签署人拒签等情况的时候填写的原因注意：此字段可能返回 null，表示取不到有效值。 */ ApproveMessage?: string; /** * 签署人签署时间戳，单位秒 */ ApproveTime?: number; /** * 参与者类型 <ul><li> **ORGANIZATION** :企业签署人</li> <li> **PERSON** :个人签署人</li></ul> 注意：此字段可能返回 null，表示取不到有效值。 */ ApproveType?: string; /** * 自定义签署人的角色名, 如: 收款人、开具人、见证人等注意：此字段可能返回 null，表示取不到有效值。 */ ApproverRoleName?: string; } /** * DescribeResourceUrlsByFlows返回参数结构体 */ export interface DescribeResourceUrlsByFlowsResponse { /** * 合同流程PDF下载链接 */ FlowResourceUrlInfos?: Array<FlowResourceUrlInfo>; /** * 如果某个序号的合同流程生成PDF下载链接成功, 对应序号的值为空如果某个序号的合同流程生成PDF下载链接失败, 对应序号的值为错误的原因 */ ErrorMessages?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelCreateFlowGroupByFiles请求参数结构体 */ export interface ChannelCreateFlowGroupByFilesRequest { /** * 合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。 */ FlowFileInfos: Array<FlowFileInfo>; /** * 合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 */ FlowGroupName: string; /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent?: Agent; /** * 合同组中签署人校验和认证的方式： <ul><li>**VerifyCheck**：人脸识别（默认）</li> <li>**MobileCheck**：手机号验证</li></ul> 注意： `1. MobileCheck 方式，未实名的个人/自然人签署方无需进行人脸识别实名认证即可查看合同（但签署合同时仍然需要人脸实名），企业签署方需经过人脸认证。` `2. 合同组的校验和认证的方式会优先使用，会覆盖合同组中单个合同和合同签署方认证方式的限制配置。` */ ApproverVerifyType?: string; /** * 合同组的签署配置项信息，例如在合同组签署过程中，是否需要对每个子合同进行独立的意愿确认。 */ FlowGroupOptions?: FlowGroupOptions; /** * 操作者的信息，此参数不用传 * @deprecated */ Operator?: UserInfo; } /** * ChannelCreateOrganizationModifyQrCode请求参数结构体 */ export interface ChannelCreateOrganizationModifyQrCodeRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; } /** * ChannelCreateFlowByFiles返回参数结构体 */ export interface ChannelCreateFlowByFilesResponse { /** * 合同流程ID，为32位字符串。建议开发者妥善保存此流程ID，以便于顺利进行后续操作。注意：此字段可能返回 null，表示取不到有效值。 */ FlowId?: string; /** * 签署方信息，如角色ID、角色名称等注意：此字段可能返回 null，表示取不到有效值。 */ Approvers?: Array<ApproverItem>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeFlowDetailInfo返回参数结构体 */ export interface DescribeFlowDetailInfoResponse { /** * 合同归属的第三方平台应用号ID */ ApplicationId?: string; /** * 合同归属的第三方平台子客企业OpenId */ ProxyOrganizationOpenId?: string; /** * 合同流程的详细信息。如果查询的是合同组信息，则返回的是组内所有子合同流程的详细信息。注意：此字段可能返回 null，表示取不到有效值。 */ FlowInfo?: Array<FlowDetailInfo>; /** * 合同组ID，只有在查询合同组信息时才会返回。注意：此字段可能返回 null，表示取不到有效值。 */ FlowGroupId?: string; /**