;
}
/**
* CreateDraftContractByPromptsTask返回参数结构体
*/
export interface CreateDraftContractByPromptsTaskResponse {
/**
* 起草任务id
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteIntegrationDepartment请求参数结构体
*/
export interface DeleteIntegrationDepartmentRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 电子签中的部门ID,通过DescribeIntegrationDepartments接口可获得。
*/
DeptId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 交接部门ID。
待删除部门中的合同、印章和模板数据,将会被交接至该部门ID下;若未填写则交接至公司根部门。
*/
ReceiveDeptId?: string;
}
/**
* 创建流程的签署方信息
*/
export interface MiniAppCreateApproverInfo {
/**
* 在指定签署方时,可以选择企业B端或个人C端等不同的参与者类型,可选类型如下:
- 0 :企业B端。
- 1 :个人C端。
- 3 :企业B端静默(自动)签署,无需签署人参与,“授权签”可以参考“授权签”使用说明文档。
- 7 :个人C端“授权签”,适用于个人“授权签”场景。注: 个人“授权签”场景为白名单功能,使用前请联系对接的客户经理沟通。
*/
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,请大写)。
- 中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。
- 中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
*/
ApproverIdCardNumber?: string;
/**
* 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
模板发起合同时,该参数为必填项,可以通过查询模板信息接口获得。
文件发起合同时,该参数无需传值。
如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
*/
RecipientId?: string;
}
/**
* ExportContractReviewResult请求参数结构体
*/
export interface ExportContractReviewResultRequest {
/**
* 执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 合同审查任务ID
*/
TaskId: string;
/**
* 导出文件类型
枚举值:
- 1: WORD、PDF当前带风险批注文件
- 2: 审查结果&摘要(.xIsx)
- 3: WORD、PDF审查合同内容时的文件(最原始文件)
- 4: WORD、PDF当前无风险批注文件
*/
FileType: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
}
/**
* DescribeFileCounterSignResult返回参数结构体
*/
export interface DescribeFileCounterSignResultResponse {
/**
* 加签任务的状态。
- PROCESSING: 任务正在执行中。
- FINISHED: 已执行成功
- FAILED: 执行失败
*/
Status?: string;
/**
* 加签完成后新的文件Id
*/
ResultFileId?: string;
/**
* 失败的错误信息,加签任务失败的情况下会返回。
*/
ErrorDetail?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 此结构体 (Component) 用于描述控件属性。
在通过文件发起合同时,对应的component有三种定位方式
1. 绝对定位方式 (可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标)
2. 表单域(FIELD)定位方式
3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找
*/
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日字符串;
- WATERMARK : 水印控件;只能分配给发起方,必须设置ComponentExtra;
- DISTRICT : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;
- VIRTUAL_COMBINATION : 虚拟控件,内部特定控件(CHECK_BOX),本身不填充任何文字内容
如果是SignComponent签署控件类型,
需要根据签署人的类型可选的字段为
企业方
- SIGN_SEAL : 签署印章控件;
- SIGN_DATE : 签署日期控件;
- SIGN_SIGNATURE : 用户签名控件;
- SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件;;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
- SIGN_PAGING_SEAL : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
- SIGN_OPINION : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
- SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容
- SIGN_MULTI_LINE_TEXT : 多行文本,仅可用在签批控件内部作为组合控件,单独无法使用,常用作批注附言
- SIGN_SELECTOR : 选择器,仅可用在签批控件内部作为组合控件,单独无法使用,常用作审批意见的选择
- SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。
个人方
- SIGN_DATE : 签署日期控件;
- SIGN_SIGNATURE : 用户签名控件;
- SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件;
- SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容
- SIGN_MULTI_LINE_TEXT : 多行文本,仅可用在签批控件内部作为组合控件,单独无法使用,常用作批注附言
- SIGN_SELECTOR : 选择器,仅可用在签批控件内部作为组合控件,单独无法使用,常用作审批意见的选择
- SIGN_OPINION : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
注:表单域的控件不能作为印章和签名控件
*/
ComponentType: string;
/**
* 在绝对定位方式和关键字定位方式下,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
*/
ComponentHeight: number;
/**
* 在绝对定位方式和关键字定位方式下,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
*/
ComponentWidth: number;
/**
* 在绝对定位方式方式下,指定控件所在PDF文件上的页码
在使用文件发起的情况下,绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码,使用负数时,页码从最后一页开始。例如:ComponentPage设置为-1,即代表在PDF文件的最后一页,以此类推。
注:
- 页码编号是从1开始编号的。
- 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
*/
ComponentPage: number;
/**
* 在绝对定位方式下,可以指定控件横向位置的位置,单位为pt(点)。
*/
ComponentPosX: number;
/**
* 在绝对定位方式下,可以指定控件纵向位置的位置,单位为pt(点)。
*/
ComponentPosY: number;
/**
* 【暂未使用】控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
*/
FileIndex: number;
/**
* 控件生成的方式:
- NORMAL : 绝对定位控件
- FIELD : 表单域
- KEYWORD : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
*/
GenerateMode?: string;
/**
* 控件唯一ID。
在绝对定位方式方式下,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
在关键字定位方式下,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
例:
- 如传入的关键字<font color="red">"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符)进行对应操作。
- 如传入的关键字为<font color="red">"甲方签署",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符)都会执行相应操作。
注:控件ID可以在一个PDF中不可重复
点击查看ComponentId在模板编辑页面的位置
*/
ComponentId?: string;
/**
* 在绝对定位方式方式下,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
在表单域定位方式下,ComponentName不仅为控件名,也是表单域名称。
注:控件名可以在一个PDF中可以重复
点击查看ComponentName在模板页面的位置
*/
ComponentName?: string;
/**
* 如果是填写控件,ComponentRequired表示在填写页面此控件是否必填
- false(默认):可以不填写
- true :必须填写此填写控件
如果是签署控件,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
*/
ComponentRequired?: boolean;
/**
* 在通过接口拉取控件信息场景下,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),发起合同时候不要填写此字段留空即可
*/
ComponentRecipientId?: string;
/**
* 在所有的定位方式下,控件的扩展参数,为JSON格式,不同类型的控件会有部分非通用参数。
ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
- Font:目前只支持黑体、宋体、仿宋
- FontSize: 范围6 :72
- FontAlign: Left/Right/Center,左对齐/居中/右对齐
- FontColor:字符串类型,格式为RGB颜色数字
- Bold是否加粗:true/false
参数样例:{"FontColor":"255,0,0","FontSize":12,"Bold":false}ComponentType为DATE时,支持以下参数:
- Font:目前只支持黑体、宋体、仿宋
- FontSize: 范围6 :72
参数样例:{"FontColor":"255,0,0","FontSize":12}ComponentType为WATERMARK时,支持以下参数:
- Font:目前只支持黑体、宋体、仿宋
- FontSize: 范围6 :72
- Opacity: 透明度,范围0 :1
- Rotate: 水印旋转角度,范围0 :359
- Density: 水印样式,1-宽松,2-标准(默认值),3-密集,
- Position: 水印位置,None-平铺(默认值),LeftTop-左上,LeftBottom-左下,RightTop-右上,RightBottom-右下,Center-居中
- SubType: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息
参数样例:"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"ComponentType为FILL_IMAGE时,支持以下参数:
- NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true : 不居中
- FillMethod : int. 填充方式。0-铺满(默认);1-等比例缩放
ComponentType为SELECTOR时,支持以下参数:
- WordWrap:bool。是否支持选择控件内容自动折行合成。false:不支持(默认)。 true : 支持自动折行合成
ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时,可以通过ComponentTypeLimit参数控制签名方式
- HANDWRITE : 需要实时手写的手写签名
- HANDWRITTEN_ESIGN : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
- OCR_ESIGN : AI智能识别手写签名
- ESIGN : 个人印章类型
- SYSTEM_ESIGN : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
- IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)
参考样例:{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时,可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型,支持指定以下印章类型
- OFFICIAL : 企业公章
- CONTRACT : 合同专用章
- FINANCE : 财务专用章
- PERSONNEL : 人事专用章
- OTHER : 其他
参考样例:{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
ComponentType为SIGN_DATE时,支持以下参数:
- Font :字符串类型目前只支持"黑体"、"宋体"、"仿宋",如果不填默认为"黑体"
- FontSize : 数字类型,范围6-72,默认值为12
- FontAlign : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐
- Format : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”,”yyyy m d HH:MM:SS”,”yyyy/m/d HH:MM:SS”,”yyyy-m-d HH:MM:SS”,”yyyy.m.d HH:MM:SS”。
- Gaps : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数
如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)参数样例: "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时,支持以下参数:
- PageRanges :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
参数样例:"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"签署印章透明度功能设置,当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:
- Opacity:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度
参数样例:{"Opacity":0.7}签署印章大小功能设置,当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:
- UseSealSize:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false
参数样例:{"UseSealSize":true}签署意见功能设置,当ComponentType为SIGN_OPINION时,可以通过以下参数设置签署意见的相关内容:
- Values:签署意见预设的需要用户填写的文本
- ValuesArray:签署意见需要用户按顺序点击的分词(组合后应和Values内容一致)
- SignMethod:签署方式,目前支持1-词组拼接方式
参数样例:{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"],"SignMethod":1}关键字模式下支持关键字找不到的情况下不进行报错的设置
- IgnoreKeywordError :1-关键字查找不到时不进行报错
场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。参数样例:"{"IgnoreKeywordError":1}"ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时,支持以下参数:
- Children: 绝对定位模式下,用来指定此签批控件的组合子控件
参数样例:
{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}- ChildrenComponents: 关键字定位模式下,用来指定此签批控件的组合子控件
ChildrenComponent结构体定义: | 字段名称 | 类型 | 描述 |
| ComponentType | string | 子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT |
| ComponentName | string | 子控件名称 |
| Placeholder | string | 子控件提示语 |
| ComponentValue | string | 子控件值(签署方不可设置) |
| ComponentOffsetX | float | 控件偏移位置X(相对于父控件(签批控件的ComponentX)) |
| ComponentOffsetY | float | 控件偏移位置Y 相对于父控件(签批控件的ComponentY)) |
| ComponentWidth | float | 控件宽 |
| ComponentHeight | float | 控件高 |
| ComponentExtra | string | 控件的附属信息,根据ComponentType设置 |
参数样例:输入:
{ ChildrenComponents: [ { ComponentType: SIGN_SIGNATURE, ComponentName: 个人签名, Placeholder: 请签名, ComponentOffsetX: 10, ComponentOffsetY: 30, ComponentWidth: 119, ComponentHeight: 43, ComponentExtra: {\ComponentTypeLimit\:[\SYSTEM_ESIGN\]} }, { ComponentType: SIGN_SELECTOR, ComponentName: 是否同意此协议, Placeholder: , ComponentOffsetX: 50, ComponentOffsetY: 130, ComponentWidth: 120, ComponentHeight: 43, ComponentExtra: {\Values\:[\同意\,\不同意\,\再想想\],\FontSize\:12,\FontAlign\:\Left\,\Font\:\黑体\,\MultiSelect\:false} }, { ComponentType: SIGN_MULTI_LINE_TEXT, ComponentName: 批注附言, Placeholder: , ComponentOffsetX: 150, ComponentOffsetY: 300, ComponentWidth: 200, ComponentHeight: 86, ComponentExtra: } ]}
*/
ComponentExtra?: string;
/**
* 在通过接口拉取控件信息场景下,为出参参数,此控件是否通过表单域定位方式生成,默认false-不是,发起合同时候不要填写此字段留空即可
*/
IsFormType?: boolean;
/**
* 控件填充vaule,ComponentType和传入值类型对应关系:
- TEXT : 文本内容
- MULTI_LINE_TEXT : 文本内容,可以用 \n 来控制换行位置
- CHECK_BOX : true/false
- FILL_IMAGE、ATTACHMENT : 附件的FileId,需要通过UploadFiles接口上传获取
- SELECTOR : 选项值
- DYNAMIC_TABLE - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)
- DATE : 格式化为:xxxx年xx月xx日(例如2024年05年28日)
- SIGN_SEAL : 印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)
- SIGN_PAGING_SEAL : 可以指定印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)
控件值约束说明:
| 特殊控件 | 填写约束 |
| 企业全称控件 | 企业名称中文字符中文括号 |
| 统一社会信用代码控件 | 企业注册的统一社会信用代码 |
| 法人名称控件 | 最大50个字符,2到25个汉字或者1到50个字母 |
| 签署意见控件 | 签署意见最大长度为50字符 |
| 签署人手机号控件 | 中国大陆手机号 13,14,15,16,17,18,19号段长度11位 |
| 签署人身份证控件 | 合法的身份证号码检查 |
| 控件名称 | 控件名称最大长度为20字符,不支持表情 |
| 单行文本控件 | 只允许输入中文,英文,数字,中英文标点符号,不支持表情 |
| 多行文本控件 | 只允许输入中文,英文,数字,中英文标点符号,不支持表情 |
| 勾选框控件 | 选择填字符串true,不选填字符串false |
| 选择器控件 | 同单行文本控件约束,填写选择值中的字符串 |
| 数字控件 | 请输入有效的数字(可带小数点) |
| 日期控件 | 格式:yyyy年mm月dd日 |
| 附件控件 | JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID |
| 图片控件 | JPG或PNG图片,填写上传的图片资源ID |
| 邮箱控件 | 有效的邮箱地址, w3c标准 |
| 地址控件 | 只允许输入中文,英文,数字,中英文标点符号,不支持表情 |
| 省市区控件 | 只允许输入中文,英文,数字,中英文标点符号,不支持表情 |
| 性别控件 | 选择值中的字符串 |
| 学历控件 | 选择值中的字符串 |
| 水印控件 | 水印控件设置为CUSTOM_WATERMARK类型时的水印内容 |
注: 部分特殊控件需要在控制台配置模板形式创建
*/
ComponentValue?: string;
/**
* 如果控件是关键字定位方式,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
注意: 向左调整设置为负数, 向右调整设置成正数
*/
OffsetX?: number;
/**
* 如果控件是关键字定位方式,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
注意: 向上调整设置为负数, 向下调整设置成正数
*/
OffsetY?: number;
/**
* 如果控件是关键字定位方式,指定关键字排序规则时,可以选择Positive或Reverse两种排序方式。
- Positive :表示正序,即根据关键字在PDF文件内的顺序进行排列
- Reverse :表示倒序,即根据关键字在PDF文件内的反序进行排列
在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。
*/
KeywordOrder?: string;
/**
* 如果控件是关键字定位方式,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
*/
KeywordPage?: number;
/**
* 如果控件是关键字定位方式,关键字生成的区域的对齐方式, 可以设置下面的值
- Middle :居中
- Below :正下方
- Right :正右方
- LowerRight :右下角
- UpperRight :右上角。
示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
*/
RelativeLocation?: string;
/**
* 如果控件是关键字定位方式,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
注意:关键字索引是从0开始计数的
*/
KeywordIndexes?: Array;
/**
* web嵌入发起合同场景下, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
- false(默认):不锁定控件值,允许在页面编辑控件值
- true:锁定控件值,在页面无法编辑控件值
*/
LockComponentValue?: boolean;
/**
* web嵌入发起合同场景下,是否禁止移动和删除填写和签署控件
- false(默认) :可以移动和删除控件
- true : 禁止移动和删除控件
*/
ForbidMoveAndDelete?: boolean;
/**
* 【暂未使用】日期签署控件的字号,默认为 12
*/
ComponentDateFontSize?: number;
/**
* 【暂未使用】第三方应用集成平台模板控件 ID 标识
*/
ChannelComponentId?: string;
/**
* 【暂未使用】第三方应用集成中子客企业控件来源。
*/
ChannelComponentSource?: number;
}
/**
* CreateFlowGroupReminds返回参数结构体
*/
export interface CreateFlowGroupRemindsResponse {
/**
* 合同组催办接口返回的详细信息。
*/
RemindFlowGroupRecords?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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 : 港澳台居民居住证(格式同中国大陆居民身份证)
注:
1. `请确保和合同中填入的一致`。
2. `在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。`
*/
IdCardType?: string;
/**
* 指定批量签署合同的签名类型,可传递以下值:- **0**:手写签名
- **1**:OCR楷体
- **2**:姓名印章
- **3**:图片印章
- **4**:系统签名
- **5**:长效手写签名(包含手写签名)
注:- 不传值的情况则计算所有合同中个人签署区的签名类型,规则如下:
- 1.如果所有合同中所有的个人签署区方式包含多种则是手写
- 2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式(例如合同1有多个签署区都是指定OCR楷体,合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体)
- 该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数
*/
SignatureTypes?: Array;
/**
* 证件号码,应符合以下规则
- 中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
- 中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。
- 中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
注:
1. `请确保和合同中填入的一致`。
2. `在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
*/
IdCardNumber?: string;
/**
* 通知用户方式:
- **NONE** : 不通知(默认)
- **SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)
*/
NotifyType?: string;
/**
* 批量签署的合同流程ID数组,此参数必传。
注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
*/
FlowIds?: Array;
/**
* 目标签署人的企业名称,签署人如果是企业员工身份,需要传此参数。
注:
- 请确认该名称与企业营业执照中注册的名称一致。
- 如果名称中包含英文括号(),请使用中文括号()代替。
*/
OrganizationName?: string;
/**
* 是否直接跳转至合同内容页面进行签署
- **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
- **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
*/
JumpToDetail?: boolean;
/**
* 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
*/
FlowBatchUrlInfo?: FlowBatchUrlInfo;
/**
* 签署完成后是否自动回跳
- false:否, 签署完成不会自动跳转回来(默认)
- true:是, 签署完成会自动跳转回来
注:
1. 该参数只针对APP类型(电子签小程序跳转贵方小程序)场景 的签署链接有效
2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
3. 电子签小程序跳转贵方APP,不支持自动跳转,必须用户手动点击完成按钮(微信的限制)
*/
AutoJumpBack?: boolean;
/**
* 仅公众号 H5 跳转电子签小程序时,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
*/
UrlUseEnv?: string;
/**
* 是否允许此链接中签署方批量拒签。 - false (默认): 不允许批量拒签
- true : 允许批量拒签。
注:`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页(JumpToDetail参数为true),也不支持批量拒签功能`
*/
CanBatchReject?: boolean;
/**
* 是否允许此链接中签署方批量确认已读文件。 - false (默认): 不允许批量确认已读文件。
- true : 允许批量确认已读文件。
注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。`
*/
CanSkipReadFlow?: boolean;
}
/**
* CreateBatchInformationExtractionTask返回参数结构体
*/
export interface CreateBatchInformationExtractionTaskResponse {
/**
* 合同智能提取的任务ID列表,每个任务ID为32位字符串。
建议开发者保存此任务ID,后续查询合同智能提取详情需要此任务ID。
注意:返回的索引和ResourceIds数组一致
*/
TaskIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 合同组签署方信息
*/
export interface FlowGroupApprovers {
/**
* 合同流程ID
*/
FlowId?: string;
/**
* 签署方信息,包含合同ID和角色ID用于定位RecipientId。
*/
Approvers?: Array;
}
/**
* DescribeContractComparisonTask请求参数结构体
*/
export interface DescribeContractComparisonTaskRequest {
/**
* 执行合同审查任务的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同对比任务ID,该参数通过调用接口CreateContractComparisonTask获取。
*/
TaskId: string;
/**
* 是否返回详细的对比结果。为 true时,响应中将包含详细的对比信息,如相似度、文本差异具体内容等;为 false时,仅返回任务基本状态信息。
注:`详细结果数据量可能较大,请按需开启。`
*/
ShowDetail?: boolean;
/**
* 搜索条件,具体参考Filter结构体。本接口取值:
1. **format-type:**
按照【 合同文本格式类型 】进行过滤;
类型:String;
是否必填项:否;
类型如下:
- **0**:段落(正文)
- **1**:标点符号
- **2**:页眉页脚
- **3**:目录
- **4**:印章
- **5**:序号
- **7**:下划线内容(填写区)
*/
Filters?: Array;
}
/**
* DescribeFlowBriefs请求参数结构体
*/
export interface DescribeFlowBriefsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 查询的合同流程ID列表最多支持100个流程ID。
如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
*/
FlowIds: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
}
/**
* CreateInformationExtractionWebUrl返回参数结构体
*/
export interface CreateInformationExtractionWebUrlResponse {
/**
* 合同信息提取嵌入式web页面链接。
注意:`链接有效期为5分钟,且链接仅能使用一次。`
*/
Url?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowGroupSignReview请求参数结构体
*/
export interface CreateFlowGroupSignReviewRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同(流程)组的合同组Id,为32位字符串,通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时返回。
*/
FlowGroupId: string;
/**
* 提交的审核结果,审核结果有下面三种情况
- PASS: 审核通过,合同流程可以继续执行签署等操作
- REJECT: 审核拒绝,合同流程不会变动
- SIGN_REJECT:拒签,合同流程直接结束,合同状态变为**合同拒签**
*/
ReviewType: string;
/**
* 需要进行签署审核的签署人的个人信息或企业信息,签署方的匹配方式按照以下规则:
个人:二选一(选择其中任意信息组合即可)
企业:二选一 (选择其中任意信息组合即可)
- 企业名+姓名+证件类型+证件号
- 企业名+姓名+手机号
*/
ApproverInfo: NeedReviewApproverInfo;
/**
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
*/
Agent?: Agent;
/**
* 审核不通过的原因,该字段的字符串长度不超过200个字符。
注:`当审核类型(ReviewType)为审核拒绝(REJECT)或拒签(SIGN_REJECT)时,审核结果原因字段必须填写`
*/
ReviewMessage?: string;
}
/**
* 企业超管信息
*/
export interface Admin {
/**
* 超管名
*/
Name?: string;
/**
* 超管手机号,打码显示
示例值:138****1569
*/
Mobile?: string;
}
/**
* 此结构体 (Caller) 用于描述调用方属性。
*/
export interface Caller {
/**
* 应用号
* @deprecated
*/
ApplicationId?: string;
/**
* 主机构ID
* @deprecated
*/
OrganizationId?: string;
/**
* 经办人的用户ID,同UserId
*/
OperatorId?: string;
/**
* 下属机构ID
* @deprecated
*/
SubOrganizationId?: string;
}
/**
* ExportContractComparisonTask返回参数结构体
*/
export interface ExportContractComparisonTaskResponse {
/**
* 对比任务详情下载链接。
*/
ResourceUrl?: string;
/**
* 下载链接有效截止时间。
*/
ExpireTime?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeContractReviewChecklist返回参数结构体
*/
export interface DescribeContractReviewChecklistResponse {
/**
* 获取的合同风险审查清单ID
*/
ChecklistId?: string;
/**
* 获取的合同风险审查清单名称
*/
Name?: string;
/**
* 获取的合同风险审查清单是否启用
*/
Enabled?: boolean;
/**
* 获取的合同风险审查清单审查点列表
*/
Categories?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 个性化参数
*/
export interface EmbedUrlOption {
/**
* 合同详情预览,允许展示控件信息
- true:允许在合同详情页展示控件
- false:(默认)不允许在合同详情页展示控件
*/
ShowFlowDetailComponent?: boolean;
/**
* 模板预览,允许展示模板控件信息
- true :允许在模板预览页展示控件
- false :(默认)不允许在模板预览页展示控件
*/
ShowTemplateComponent?: boolean;
/**
* 跳过上传文件,默认为false(展示上传文件页)
- false: 展示上传文件页
- true: 不展示上传文件页
注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)和EmbedType=CREATE_CONTRACT_DRAFT_COOPEDIT(创建起草合同)有效**,
*/
SkipUploadFile?: boolean;
/**
* 隐藏下载文件按钮,默认为false(展示下载文件按钮)
- false: 展示下载文件按钮
- true: 不展示下载文件按钮
注意: 此参数仅针对**EmbedType=PREVIEW_FLOW_DETAIL(查看合同详情)**有效
*/
SkipDownloadFile?: boolean;
/**
* 是否禁止编辑(展示)水印控件属性
- (默认) false -否
- true - 禁止编辑
*/
ForbidEditWatermark?: boolean;
/**
* 印章描述
*/
SealDescription?: string;
/**
* 是否禁止编辑印章描述内容
- (默认) false -否
- true - 禁止编辑
*/
ForbidEditSealDescription?: boolean;
}
/**
* DescribeContractReviewMarkedRiskExportTask请求参数结构体
*/
export interface DescribeContractReviewMarkedRiskExportTaskRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 导出任务 ID。
*/
TaskId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
}
/**
* DescribeContractComparisonTask返回参数结构体
*/
export interface DescribeContractComparisonTaskResponse {
/**
* 合同对比任务ID。
*/
TaskId?: string;
/**
* 合同对比任务状态。
状态如下:
- **0**:待创建(未执行)
- **1**:对比中
- **2**:对比成功
- **3**:对比失败
*/
Status?: number;
/**
* 对比失败的具体原因描述,仅当状态为失败时返回此字段。
*/
Message?: string;
/**
* 原版文件ID,对比基准的旧版本文件唯一标识。
*/
OriginalFileResourceId?: string;
/**
* 新版文件ID,与旧版进行对比的新版本文件唯一标识。
*/
DiffFileResourceId?: string;
/**
* 对比任务备注,长度不能超过50个字符。
*/
Comment?: string;
/**
* 合同对比差异点总数。
*/
TotalDiffCount?: number;
/**
* 合同对比新增点数量。
*/
AddDiffCount?: number;
/**
* 合同对比修改点数量。
*/
ChangeDiffCount?: number;
/**
* 合同对比删除点数量。
*/
DeleteDiffCount?: number;
/**
* 提交人,提交此任务或请求的用户唯一标识。
*/
Operator?: string;
/**
* 合同对比任务创建时间,时间戳。
*/
CreateTime?: number;
/**
* 对比差异详情,请求参数ShowDetail为true时返回。
*/
ComparisonDetail?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeArchiveFlowTask请求参数结构体
*/
export interface DescribeArchiveFlowTaskRequest {
/**
* 执行本接口操作的员工信息。注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 任务id,创建归档任务时返回
*/
TaskId: string;
}
/**
* CreateModifyAdminAuthorizationUrl返回参数结构体
*/
export interface CreateModifyAdminAuthorizationUrlResponse {
/**
* 变更企业超管授权书链接。
没有有效期限制。
注意:
此链接仅能由当时认证企业的认证人使用。
*/
Url?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOrganizationInfoChangeUrl返回参数结构体
*/
export interface CreateOrganizationInfoChangeUrlResponse {
/**
* 创建的企业信息变更链接。
*/
Url?: string;
/**
* 链接过期时间。链接7天有效。
*/
ExpiredTime?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlow返回参数结构体
*/
export interface CreateFlowResponse {
/**
* 合同流程ID,为32位字符串。
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
注:
此返回的合同流程ID,需再次调用创建电子文档和发起签署流程接口将合同开始后,合同才能进入签署环节,点击查看FlowId在控制台中的位置(只在进入签署环节后有效)
*/
FlowId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateUserNameChangeUrl返回参数结构体
*/
export interface CreateUserNameChangeUrlResponse {
/**
* 腾讯电子签小程序的个人更名链接。
如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。
1.如果EndPoint是APP:
得到的链接类似于pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0, 用法可以参考描述中的"跳转到小程序的实现"
2.如果EndPoint是HTTP:
得到的链接类似于 https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d,点击后会跳转到腾讯电子签小程序进行签署
3.如果EndPoint是HTTP_SHORT_URL:
得到的链接类似于https://essurl.cn/2n**42Nd,点击后会跳转到腾讯电子签小程序进行签署
`注:` 生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数
*/
UserVerifyUrl?: string;
/**
* 链接过期时间,为Unix时间戳(单位为秒)。
*/
ExpireTime?: number;
/**
* 小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回
*/
MiniAppId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifySingleSignOnEmployees请求参数结构体
*/
export interface ModifySingleSignOnEmployeesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 单点登录应用号的id,获取位置如下图
*/
SsoApplicationId: string;
/**
* 待修改员工的信息。
*/
Employee: SingleSignOnEmployees;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
}
/**
* DeleteSingleSignOnEmployees请求参数结构体
*/
export interface DeleteSingleSignOnEmployeesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 单点登录应用号的id,获取位置如下图
*/
SsoApplicationId: string;
/**
* 需要删除的单点登录员工的唯一Id 值
*/
OpenId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
}
/**
* CancelMultiFlowSignQRCode返回参数结构体
*/
export interface CancelMultiFlowSignQRCodeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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;
}
/**
* 合同智能提取字段信息
*/
export interface ExtractionField {
/**
* 用于合同智能提取的字段名称。
注意: `长度不能超过30个字符`
*/
Name: string;
/**
* 指定合同智能提取的字段类型,目前仅支持`TEXT`、`DATE`、`NUMBER`、`OPTION`类型。
类型支持如下:
1、TEXT(文本)
2、DATE(日期)
3、NUMBER(数字)
4、OPTION(选项值)
*/
Type: string;
/**
* 用于描述字段信息。
注意:
1、描述字段不能超过100个字符
*/
Description?: string;
/**
* 提取出合同中的字段信息。
*/
Values?: Array;
/**
* 当字段类型`Type`为OPTION时为必输项,输入选项值
*/
ChoiceList?: Array;
}
/**
* DescribeUserFlowType返回参数结构体
*/
export interface DescribeUserFlowTypeResponse {
/**
* 查询到的所有用户合同类型列表
*/
AllUserFlowTypes?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 合同信息提取字段值信息。
*/
export interface ExtractionFieldResult {
/**
* 字段ID
*/
Id?: string;
/**
* 用于合同智能提取的字段名称。
*/
Name?: string;
/**
* 合同智能提取的字段类型,目前仅支持TEXT、DATE、NUMBER、OPTION类型。
类型支持如下: 1、TEXT(文本) 2、DATE(日期) 3、NUMBER(数字) 4、OPTION(选项值)
*/
Type?: string;
/**
* 提取出合同中的字段信息。
*/
Values?: Array;
/**
* 是否需要语义提取,默认为false
*/
RequiresSemanticExtraction?: boolean;
/**
* 提取出值在合同中的坐标位置信息
*/
Positions?: Array;
}
/**
* DescribeExtendedServiceAuthDetail返回参数结构体
*/
export interface DescribeExtendedServiceAuthDetailResponse {
/**
* 服务授权的信息列表,根据查询类型返回特定扩展服务的授权状况。
*/
AuthInfoDetail?: AuthInfoDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLegalSealQrCode返回参数结构体
*/
export interface CreateLegalSealQrCodeResponse {
/**
* 二维码图片base64值,二维码有效期7天(604800秒)
二维码图片的样式如下图:

*/
QrcodeBase64?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIntegrationDepartments返回参数结构体
*/
export interface DescribeIntegrationDepartmentsResponse {
/**
* 部门信息列表。部门信息根据部门排序号OrderNo降序排列,根据部门创建时间升序排列。
*/
Departments?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFileCounterSign请求参数结构体
*/
export interface CreateFileCounterSignRequest {
/**
* 需要加签的文件Id。
注: `暂时只支持pdf类型的文件`
*/
FileId: string;
/**
* 执行本接口操作的员工信息。注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 是否使用同步模式。
- false:异步模式,返回taskId。需要使用taskId轮询结果查询接口。
- true: 同步模式,此接口将直接返回taskId和ResultFileId(加签后文件id)。
注:
1. 当加签文件较大的时候,建议使用异步接口进行操作。否则文件加签时间过长会导致接口超时。
*/
SyncMode?: boolean;
}
/**
* 提取web嵌入页面个性化设置
*/
export interface WebUrlOption {
/**
* 禁用链接预览
*/
DisableLinkPreview?: boolean;
/**
* 禁用任务编辑
*/
DisableTaskEditing?: boolean;
/**
* 禁用任务结果编辑
*/
DisableTaskResultEditing?: boolean;
}
/**
* DescribeOrganizationVerifyStatus返回参数结构体
*/
export interface DescribeOrganizationVerifyStatusResponse {
/**
* 当前企业认证状态
*/
VerifyStatus?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteExtendedServiceAuthInfos返回参数结构体
*/
export interface DeleteExtendedServiceAuthInfosResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeEnterpriseContractReviewChecklists返回参数结构体
*/
export interface DescribeEnterpriseContractReviewChecklistsResponse {
/**
* 查询的总条数
*/
Total?: number;
/**
* 清单列表
*/
Checklists?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 企业扩展服务授权列表详情
*/
export interface AuthInfoDetail {
/**
* 扩展服务类型,和入参一致
*/
Type?: string;
/**
* 扩展服务名称
*/
Name?: string;
/**
* 授权员工列表
*/
HasAuthUserList?: Array;
/**
* 授权企业列表(企业“授权签”时,该字段有值)
*/
HasAuthOrganizationList?: Array;
/**
* 授权员工列表总数
*/
AuthUserTotal?: number;
/**
* 授权企业列表总数
*/
AuthOrganizationTotal?: number;
}
/**
* ModifyApplicationCallbackInfo返回参数结构体
*/
export interface ModifyApplicationCallbackInfoResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 催办邮件结构体
*/
export interface RemindEmailInfo {
/**
* 签署编号
*/
SignId?: string;
/**
* 指定邮箱地址,催办时使用此邮箱替代 DB 中存储的邮箱
*/
ApproverEmail?: string;
}
/**
* 用于定义合同风险识别角色信息。
*/
export interface RiskIdentificationRoleInfo {
/**
* 风险识别角色的名称。用于唯一标识和区分不同的风险识别角色。
注意:`最大长度应不超过200个字符`
*/
Name: string;
/**
* 风险识别角色的详细说明。
注意: `最大长度应不超过500个字符`
*/
Description?: string;
}
/**
* CreateUserVerifyUrl请求参数结构体
*/
export interface CreateUserVerifyUrlRequest {
/**
* 操作人信息
*/
Operator: UserInfo;
/**
* 要实名的姓名
*/
Name?: string;
/**
* 要实名的身份证号码,
身份证号码如果有x的话,统一传大写X
*/
IdCardNumber?: string;
/**
* 证件类型,目前只支持身份证类型:ID_CARD
*/
IdCardType?: string;
/**
* 要实名的手机号,兼容带+86的格式
*/
Mobile?: string;
/**
* 实名完之后的跳转链接,最大长度1000个字符。
链接类型请参考 跳转电子签H5。
注:此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递
*/
JumpUrl?: string;
/**
* 要跳转的链接类型
- HTTP:适用于短信通知或H5跳转的电子签小程序HTTP长链接
- HTTP_SHORT_URL:适用于短信通知或H5跳转的电子签小程序HTTP短链接
- APP:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径
- H5:适用于跳转至电子签H5实名页面的长链接
- H5_SHORT_URL:适用于跳转至电子签H5实名页面的短链接
注:如果不传递,默认值是 APP
*/
Endpoint?: string;
/**
* 签署完成后是否自动回跳
- false:否, 实名完成不会自动跳转回来(默认)
- true:是, 实名完成会自动跳转回来
注:
1. 该参数只针对APP类型(第三方APP或小程序跳转电子签小程序)场景 的实名链接有效
2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
3. 电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)
*/
AutoJumpBack?: boolean;
/**
* 在用户完成实名认证后,其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回,以便用户确认其个人数据信息。请注意,自定义数据的字符长度上限为1000,且必须采用base64编码格式。
*/
UserData?: string;
}
/**
* DescribeLMInformationExtractionTaskFieldFeedback请求参数结构体
*/
export interface DescribeLMInformationExtractionTaskFieldFeedbackRequest {
/**
* 执行合同智能提取任务的员工信息。
*/
Operator: UserInfo;
/**
* 合同智能提取任务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;
}
/**
* CreateIntegrationEmployees请求参数结构体
*/
export interface CreateIntegrationEmployeesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 待创建员工的信息最多不超过20个。
**1. 在创建企业微信员工的场景下** : 只需传入下面的参数,其他信息不支持设置。
| 参数 | 是否必填 | 含义 |
| WeworkOpenId | 是 | 企业微信用户账号ID |
**2. 在其他场景下** : 只需传入下面的参数,其他信息不支持设置。
| 参数 | 是否必填 | 含义 |
| DisplayName | 是 | 用户的真实名字 |
| Mobile | 是 | 用户手机号码 |
| OpenId | 否 | 用户的自定义ID |
| Email | 否 | 用户的邮箱 |
| Department.DepartmentId | 否 | 用户加入后的部门ID |
注: `每个手机号每天最多使用3次`
*/
Employees: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 员工邀请方式
可通过以下途径进行设置:
- **SMS(默认)**:邀请将通过短信或企业微信消息发送。若场景非企业微信,则采用企业微信消息;其他情境下则使用短信通知。短信内含链接,点击后将进入微信小程序进行认证并加入企业的流程。
- **H5**:将生成H5链接,用户点击链接后可进入H5页面进行认证并加入企业的流程。
- **NONE**:系统会根据Endpoint生成签署链接,业务方需获取链接并通知客户。
*/
InvitationNotifyType?: string;
/**
* 回跳地址,为认证成功后页面进行回跳的URL,请确保回跳地址的可用性。
注:`只有在员工邀请方式(InvitationNotifyType参数)为H5场景下才生效, 其他方式下设置无效。`
*/
JumpUrl?: string;
/**
* 要跳转的链接类型- **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)
- **HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链
- **APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
- **H5**: 第三方移动端浏览器进行嵌入,不支持小程序嵌入,过期时间一个月
注意:InvitationNotifyType 和 Endpoint 的关系图| 通知类型(InvitationNotifyType) | Endpoint |
| SMS(默认) | 不需要传递,会将 Endpoint 默认设置为HTTP_SHORT_URL |
| H5 | 不需要传递,会将 Endpoint 默认设置为 H5 |
| NONE | 所有 Endpoint 都支持(HTTP_URL/HTTP_SHORT_URL/H5/APP)默认为HTTP_SHORT_URL |
*/
Endpoint?: string;
}
/**
* 创建合同个性化参数
*/
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;
/**
* 禁止添加签署方,若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”
*/
ForbidAddApprover?: boolean;
/**
* 是否可以编辑签署人包括新增,修改,删除
- (默认) false -可以编辑签署人
- true - 禁止编辑签署人
注意:如果设置参数为 true, 则 参数签署人 FlowApproverList 不能为空
*/
ForbidEditApprover?: boolean;
/**
* 禁止设置签署流程属性 (顺序、合同签署认证方式等),若为true则在发起流程的可嵌入页面隐藏签署流程设置面板
*/
ForbidEditFlowProperties?: boolean;
/**
* 在发起流程的可嵌入页面要隐藏的控件列表,和 ShowComponentTypes 参数 只能二选一使用(注:
空数组代表未指定),具体的控件类型如下
- SIGN_SIGNATURE : 个人签名/印章
- SIGN_SEAL : 企业印章
- SIGN_PAGING_SEAL : 骑缝章
- SIGN_LEGAL_PERSON_SEAL : 法定代表人章
- SIGN_APPROVE : 签批
- SIGN_OPINION : 签署意见
- SIGN_PAGING_SIGNATURE : 手写签名骑缝控件
- BUSI-FULL-NAME : 企业全称
- BUSI-CREDIT-CODE : 统一社会信用代码
- BUSI-LEGAL-NAME : 法人/经营者姓名
- PERSONAL-NAME : 签署人姓名
- PERSONAL-MOBILE : 签署人手机号
- PERSONAL-IDCARD-TYPE : 签署人证件类型
- PERSONAL-IDCARD : 签署人证件号
- TEXT : 单行文本
- MULTI_LINE_TEXT : 多行文本
- CHECK_BOX : 勾选框
- SELECTOR : 选择器
- DIGIT : 数字
- DATE : 日期
- FILL_IMAGE : 图片
- ATTACHMENT : 附件
- EMAIL : 邮箱
- LOCATION : 地址
- EDUCATION : 学历
- GENDER : 性别
- DISTRICT : 省市区
*/
HideComponentTypes?: Array;
/**
* 在发起流程的可嵌入页面要显示的控件列表,和 HideComponentTypes 参数 只能二选一使用(注:
空数组代表未指定),具体的控件类型如下
- SIGN_SIGNATURE : 个人签名/印章
- SIGN_SEAL : 企业印章
- SIGN_PAGING_SEAL : 骑缝章
- SIGN_LEGAL_PERSON_SEAL : 法定代表人章
- SIGN_APPROVE : 签批
- SIGN_OPINION : 签署意见
- SIGN_PAGING_SIGNATURE : 手写签名骑缝控件
- BUSI-FULL-NAME : 企业全称
- BUSI-CREDIT-CODE : 统一社会信用代码
- BUSI-LEGAL-NAME : 法人/经营者姓名
- PERSONAL-NAME : 签署人姓名
- PERSONAL-MOBILE : 签署人手机号
- PERSONAL-IDCARD-TYPE : 签署人证件类型
- PERSONAL-IDCARD : 签署人证件号
- TEXT : 单行文本
- MULTI_LINE_TEXT : 多行文本
- CHECK_BOX : 勾选框
- SELECTOR : 选择器
- DIGIT : 数字
- DATE : 日期
- FILL_IMAGE : 图片
- ATTACHMENT : 附件
- EMAIL : 邮箱
- LOCATION : 地址
- EDUCATION : 学历
- GENDER : 性别
- DISTRICT : 省市区
*/
ShowComponentTypes?: Array;
/**
* 发起流程的可嵌入页面结果页配置
*/
ResultPageConfig?: Array;
/**
* 签署控件的配置信息,用在嵌入式发起的页面配置,包括
*/
SignComponentConfig?: SignComponentConfig;
/**
* 是否禁止编辑(展示)水印控件属性
- (默认) false -否
- true - 禁止编辑
*/
ForbidEditWatermark?: boolean;
/**
* 隐藏操作指引: 具体的控件类型如下
- 1 : 操作指引入口
- 2 : 操作文档
- 3 : 操作视频
注:仅对新版页面生效
* @deprecated
*/
HideOperationInstructions?: Array;
/**
* 隐藏操作步骤: 具体的控件类型如下
- 1 : 选择文件及签署方
- 2 : 补充文件内容
- 4 : 发起前合同信息与设置确认
注:仅对新版页面生效
*/
HideOperationSteps?: Array;
/**
* 本企业简称,注:仅对新版页面生效
*/
SelfName?: string;
/**
* 发起后签署码隐藏,默认false,注:仅对新版页面生效
*/
HideSignCodeAfterStart?: boolean;
/**
* 发起成功后是否预览合同
- (默认) false -否
- true - 展示预览按钮
*/
PreviewAfterStart?: boolean;
/**
* 发起成功之后是否签署合同,仅当前经办人作为签署人时生效
- (默认) false -否
- true - 展示签署按钮
*/
SignAfterStart?: boolean;
/**
* 发起过程中是否展示“保存草稿”按钮

- 点击保存后,可以通过CreatePrepareFlow返回的DraftId保存草稿id
- 可以用于二次发起合同: CreatePrepareFlow,ResourceType =3 //草稿
*/
NeedFlowDraft?: boolean;
/**
* 若指定了合同抄送人,此参数用来控制操作人能否在嵌入式页面看见或编辑(修改、增加、删除)抄送人信息。
枚举值:
- 0: 不可见不可编辑
- 1: 可见不可编辑
- 2: 可见可编辑
默认值:0
*/
CcInfoVisibility?: number;
}
/**
* DescribeContractDiffTaskWebUrl返回参数结构体
*/
export interface DescribeContractDiffTaskWebUrlResponse {
/**
* 合同对比嵌入式web页面链接,有效期:5分钟
链接仅能使用一次
*/
WebUrl?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 机构信息
*/
export interface OrganizationInfo {
/**
* 机构在平台的编号,内部字段,暂未开放
* @deprecated
*/
OrganizationId?: string;
/**
* 用户渠道,内部字段,暂未开放
* @deprecated
*/
Channel?: string;
/**
* 用户在渠道的机构编号,内部字段,暂未开放
* @deprecated
*/
OrganizationOpenId?: string;
/**
* 用户真实的IP,内部字段,暂未开放
* @deprecated
*/
ClientIp?: string;
/**
* 机构的代理IP,内部字段,暂未开放
* @deprecated
*/
ProxyIp?: string;
}
/**
* 动态签署2.0合同参与人信息
*/
export interface ArchiveDynamicApproverData {
/**
* 签署方唯一编号,一个全局唯一的标识符,不同的流程不会出现冲突。
可以使用签署方的唯一编号来生成签署链接(也可以通过RecipientId来生成签署链接)。
*/
SignId?: string;
/**
* 签署方角色编号,签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。
填写控件和签署控件都与特定的角色编号关联。
*/
RecipientId?: string;
}
/**
* CreateOrganizationAuthUrl请求参数结构体
*/
export interface CreateOrganizationAuthUrlRequest {
/**
* 操作人信息
*/
Operator: UserInfo;
/**
* 指定授权方式 支持多选:
*/
AuthorizationTypes?: Array;
/**
* 认证企业名称,请确认该名称与企业营业执照中注册的名称一致。
注:
如果名称中包含英文括号(),请使用中文括号()代替。
EndPointType=“H5”或者"SHORT_H5"时,该参数必填
*/
OrganizationName?: string;
/**
* 企业统一社会信用代码
*/
UniformSocialCreditCode?: string;
/**
* 企业法人的姓名
*/
LegalName?: string;
/**
* 即将废弃,入参请使用JumpEvents。
认证完成跳回的链接,最长500个字符。
*/
AutoJumpUrl?: string;
/**
* 营业执照企业地址
入参限制:最大长度500个字符
*/
OrganizationAddress?: string;
/**
* 认证人姓名
*/
AdminName?: string;
/**
* 认证人手机号
*/
AdminMobile?: string;
/**
* 认证人身份证号
*/
AdminIdCardNumber?: string;
/**
* 认证人证件类型, 支持以下类型
- ID_CARD : 中国大陆居民身份证 (默认值)
- HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)
*/
AdminIdCardType?: string;
/**
* 对方打开链接认证时,对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。
- false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
- true:启用状态,实际认证时必须与接口传递的信息完全相符。
*/
UniformSocialCreditCodeSame?: boolean;
/**
* 对方打开链接认证时,法人姓名是否要与接口传递上来的保持一致。
- false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
- true:启用状态,实际认证时必须与接口传递的信息完全相符。
p.s. 仅在法人姓名不为空时有效
*/
LegalNameSame?: boolean;
/**
* 对方打开链接认证时,认证人姓名是否要与接口传递上来的保持一致。
- false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
- true:启用状态,实际认证时必须与接口传递的信息完全相符。
p.s. 仅在认证人姓名不为空时有效
*/
AdminNameSame?: boolean;
/**
* 对方打开链接认证时,认证人居民身份证件号是否要与接口传递上来的保持一致。
- false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
- true:启用状态,实际认证时必须与接口传递的信息完全相符。
p.s. 仅在认证人身份证号不为空时有效
*/
AdminIdCardNumberSame?: boolean;
/**
* 对方打开链接认证时,认证人手机号是否要与接口传递上来的保持一致。
- false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
- true:启用状态,实际认证时必须与接口传递的信息完全相符。
p.s. 仅在认证人手机号不为空时有效
*/
AdminMobileSame?: boolean;
/**
* 对方打开链接认证时,企业名称是否要与接口传递上来的保持一致。
- false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
- true:启用状态,实际认证时必须与接口传递的信息完全相符。
p.s. 仅在企业名称不为空时有效
*/
OrganizationNameSame?: boolean;
/**
* 营业执照正面照(支持PNG或JPG格式)需以base64格式提供,且文件大小不得超过5MB。
*/
BusinessLicense?: string;
/**
* 跳转链接类型:
- PC:适用于PC端的认证链接
- APP:用于全屏或半屏跳转的小程序链接
- SHORT_URL:跳转小程序的链接的短链形式
- H5:适用于H5页面的认证链接
- SHORT_H5:H5认证链接的短链形式
*/
Endpoint?: string;
/**
* 指定企业初始化引导,现在可以配置如下的选项:
1: 启用此选项后,在企业认证的最终步骤将添加创建印章的引导。如下图的位置

2:开通企业授权API签署协议,目前仅支持PC网页端,即Endpoint=PC(该功能需联系电子签客服开通)

枚举值:
*/
Initialization?: Array;
/**
* 授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。
授权书可以通过接口生成企业授权书 来获得。
p.s. 如果上传授权书 ,需遵循以下条件
- 超管的信息(超管姓名,超管手机号)必须为必填参数。
- 认证方式AuthorizationTypes必须只能是上传授权书方式
*/
PowerOfAttorneys?: Array;
/**
* 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 4096长度。
在. 企业引导企业实名认证后回调中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
UserData?: string;
/**
* 组织机构对公打款账号,账户名跟企业名称一致。
p.s.
只有认证方式是授权书+对公打款时才生效。
*/
BankAccountNumber?: string;
/**
* 对方打开链接认证时,对公打款账号是否要与接口传递上来的保持一致。
- false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
- true:启用状态,实际认证时必须与接口传递的信息完全相符。
p.s. 仅在对公打款不为空时有效
*/
BankAccountNumberSame?: boolean;
/**
* 跳转事件,其中包括认证期间收录,授权书审核,企业认证的回跳事件。
p.s.
Endpoint如果是APP 类型,请传递JumpUrl为"true"
如果 Endpoint 是 H5 类型,请参考文档跳转电子签H5
p.s. 如果Endpoint是 APP,传递的跳转地址无效,不会进行跳转,仅会进行回跳。
*/
JumpEvents?: Array;
/**
* 企业证照类型:
- USCC :(默认)工商组织营业执照
- PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证
- CLINICFILLINGCERTIFICATE :诊所备案证
注意 :
如果企业证照类型是医疗机构执业许可证或者诊所备案证,则参数设置企业授权方式(AuthorizationTypes)和企业认证方式(AuthorizationMethods)都无效.
医疗机构执业许可证和诊所备案证的企业授权方式 仅有授权书的方式。企业认证仅有上传营业执照的方式。
*/
OrganizationIdCardType?: string;
/**
* 是否允许编辑企业注册时的证照类型
true:不允许编辑。
false:允许编辑(默认值)。
注意:
入参中的OrganizationIdCardType值不为空的时候,才可设置为不可编辑。
*/
OrganizationIdCardTypeSame?: boolean;
/**
* 指定企业认证的授权方式 支持多选:
- 1: 上传营业执照
- 2: 腾讯云快速认证
- 3: 腾讯商户号授权(仅支持小程序端)
注意:
1.如果没有指定,则默认是1,仅有上传营业执照。
2.H5 仅支持上传营业执照。
*/
AuthorizationMethod?: Array;
/**
* 企业认证页面隐藏上传营业执照


*/
HideBizLicense?: boolean;
/**
* 对方打开链接认证时,公司地址是否要与接口传递上来的保持一致。
- false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
- true:启用状态,实际认证时会回显接口传递的值,且不可更改
p.s. 仅在公司地址(OrganizationAddress)不为空时有效如下图所示:

*/
AddressSame?: boolean;
/**
* 对方打开链接认证时,公司营业执照是否要与接口传递上来的保持一致。
- false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致,用户可以进行修改
- true:启用状态,实际认证时回填的信息就是用户传递的值,并且不能修改
p.s. 仅在公司营业执照(BusinessLicense)不为空时有效
如下图
*/
BizLicenseSame?: boolean;
}
/**
* 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?: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
}
/**
* CancelOrganizationFlows返回参数结构体
*/
export interface CancelOrganizationFlowsResponse {
/**
* 全量撤销企业合同任务编号,为32位字符串,可用于查询批量撤销合同结果 或关联全量撤销企业合同任务结果回调
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
/**
* OFFSET 用于指定查询结果的偏移量,如果不传默认偏移为0,最大2000。
分页参数, 需要limit, offset 配合使用
例如:
您希望得到第三页的数据, 且每页限制最多10条
您可以使用 LIMIT 10 OFFSET 20
*/
Offset?: number;
}
/**
* CreateFlowGroupSignReview返回参数结构体
*/
export interface CreateFlowGroupSignReviewResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowReminds返回参数结构体
*/
export interface CreateFlowRemindsResponse {
/**
* 合同催办结果的详细信息列表。
*/
RemindFlowRecords?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集团子企业使用集团主企业的套餐使用情况
*/
export interface SubOrgBillUsage {
/**
* 套餐使用数
*/
Used?: number;
/**
* 套餐类型
对应关系如下:
- **CloudEnterprise**: 企业版合同
- **SingleSignature**: 单方签章
- **CloudProve**: 签署报告
- **CloudOnlineSign**: 腾讯会议在线签约
- **ChannelWeCard**: 微工卡
- **SignFlow**: 合同套餐
- **SignFace**: 签署意愿(人脸识别)
- **SignPassword**: 签署意愿(密码)
- **SignSMS**: 签署意愿(短信)
- **PersonalEssAuth**: 签署人实名(腾讯电子签认证)
- **PersonalThirdAuth**: 签署人实名(信任第三方认证)
- **OrgEssAuth**: 签署企业实名
- **FlowNotify**: 短信通知
- **AuthService**: 企业工商信息查询
*/
QuotaType?: string;
}
/**
* DescribeOrganizationGroupOrganizations请求参数结构体
*/
export interface DescribeOrganizationGroupOrganizationsRequest {
/**
* 执行本接口操作的员工信息,userId必填。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 指定分页每页返回的数据条数,单页最大支持 200。
*/
Limit: number;
/**
* 偏移量,默认为0,最大20000。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
*/
Offset: number;
/**
* 查询成员企业的企业名,模糊匹配
* @deprecated
*/
Name?: string;
/**
* 成员企业加入集团的当前状态
- **1**:待授权
- **2**:已授权待激活
- **3**:拒绝授权
- **4**:已解除
- **5**:已加入
*/
Status?: number;
/**
* 是否导出当前成员企业数据
- **false**:不导出(默认值)
- **true**:导出
p.s.
若传入此参数, LImit参数将无效,导出的为全量数据。
*/
Export?: boolean;
/**
* 成员企业机构 ID,32 位字符串,在PC控制台 集团管理可获取
*/
Id?: string;
}
/**
* 代理相关应用信息,如集团主企业代子企业操作
*/
export interface Agent {
/**
* CA-API应用编号,用于同平台企业下标识不同的CA-API应用
* @deprecated
*/
AppId?: string;
/**
* 被代理机构的应用号,一般不用传
* @deprecated
*/
ProxyAppId?: string;
/**
* 被代理机构在电子签平台的机构编号,集团代理下场景必传
*/
ProxyOrganizationId?: string;
/**
* 被代理机构的经办人,一般不用传
* @deprecated
*/
ProxyOperator?: string;
}
/**
* DescribeFileConvertTask请求参数结构体
*/
export interface DescribeFileConvertTaskRequest {
/**
* 转换任务Id,通过接口创建文件转换任务接口得到的转换任务id
*/
TaskId: string;
/**
* 执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
}
/**
* 企业应用回调信息
*/
export interface CallbackInfo {
/**
* 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
*/
CallbackUrl: string;
/**
* 回调加密key,已废弃
* @deprecated
*/
Token?: string;
/**
* 回调加密key,用于回调消息加解密。
*/
CallbackKey?: string;
/**
* 回调验签token,用于回调通知校验。
*/
CallbackToken?: string;
}
/**
* DescribeBatchOrganizationRegistrationUrls请求参数结构体
*/
export interface DescribeBatchOrganizationRegistrationUrlsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 通过接口CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任得到的任务Id
*/
TaskId: string;
/**
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
*/
Agent?: Agent;
}
/**
* 此结构体 (TemplateInfo) 用于描述模板的信息。
> **模板组成**
>
> 一个模板通常会包含以下结构信息
>- 模板基本信息
>- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
>- 填写控件 Components
>- 签署控件 SignComponents
>- 生成模板的文件基础信息 FileInfos
*/
export interface TemplateInfo {
/**
* 模板ID,模板的唯一标识
*/
TemplateId?: string;
/**
* 模板的名字
*/
TemplateName?: string;
/**
* 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
点击查看在模板中配置的签署参与方角色列表的样子
*/
Recipients?: Array;
/**
* 模板的填充控件列表
点击查看在模板中配置的填充控件的样子
*/
Components?: Array;
/**
* 此模板中的签署控件列表
点击查看在模板中配置的签署控件的样子
*/
SignComponents?: Array;
/**
* 模板描述信息
*/
Description?: string;
/**
* 此模板的资源ID
*/
DocumentResourceIds?: Array;
/**
* 生成模板的文件基础信息
*/
FileInfos?: Array;
/**
* 此模板里边附件的资源ID
*/
AttachmentResourceIds?: Array;
/**
* 签署人参与签署的顺序,可以分为以下两种方式:
无序:不限定签署人的签署顺序,签署人可以在任何时间签署。此种方式值为 :{-1}
有序:通过序列数字标识签署顺序,从0开始编码,数字越大签署顺序越靠后,签署人按照指定的顺序依次签署。此种方式值为: {0,1,2,3………}
*/
SignOrder?: Array;
/**
* 此模板的状态可以分为以下几种:
-1:不可用状态。
0:草稿态,即模板正在编辑或未发布状态。
1:正式态,只有正式态的模板才可以发起合同。
*/
Status?: number;
/**
* 模板的创建者信息,用户的名字
注: 是创建者的名字,而非创建者的用户ID
*/
Creator?: string;
/**
* 模板创建的时间戳,格式为Unix标准时间戳(秒)
*/
CreatedOn?: number;
/**
* 此模板创建方角色信息。
点击查看在模板中配置的创建方角色的样子
*/
Promoter?: Recipient;
/**
* 模板类型可以分为以下两种:1:带有本企业“授权签”的模板,即签署过程无需签署人手动操作,系统自动完成签署。3:普通模板,即签署人需要手动进行签署操作。
*/
TemplateType?: number;
/**
* 模板可用状态可以分为以下两种:
1:(默认)启用状态,即模板可以正常使用。
2:停用状态,即模板暂时无法使用。
可到控制台启停模板
*/
Available?: number;
/**
* 创建模板的企业ID,电子签的机构ID
*/
OrganizationId?: string;
/**
* 模板创建人用户ID
*/
CreatorId?: string;
/**
* 模板的 H5 预览链接,有效期为 5 分钟。
您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。
注意:只有在请求接口时将 WithPreviewUrl 参数设置为 true,才会生成预览链接。
*/
PreviewUrl?: string;
/**
* 用户自定义合同类型。
返回配置模板的时候选择的合同类型。点击查看配置的位置
自定义合同类型配置的地方如链接图所示。点击查看自定义合同类型管理的位置
*/
UserFlowType?: UserFlowType;
/**
* 模板版本的编号,旨在标识其独特的版本信息,通常呈现为一串字符串,由日期和递增的数字组成
*/
TemplateVersion?: string;
/**
* 模板是否已发布可以分为以下两种状态:
true:已发布状态,表示该模板已经发布并可以正常使用。
false:未发布状态,表示该模板还未发布,无法使用。
*/
Published?: boolean;
/**
* 集体账号场景下: 集团账号分享给子企业的模板的来源模板ID。
*/
ShareTemplateId?: string;
/**
* 此模板配置的预填印章列表(包括“授权签”指定的印章)
*/
TemplateSeals?: Array;
/**
* 模板内部指定的印章列表
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Seals?: Array;
}
/**
* DescribeEnterpriseContractReviewChecklists请求参数结构体
*/
export interface DescribeEnterpriseContractReviewChecklistsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 过滤条件
*/
Filters?: Filter;
/**
* 指定每页返回的数据条数,和Offset参数配合使用。
*/
Limit?: number;
/**
* 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
*/
Offset?: number;
}
/**
* CreateDocument返回参数结构体
*/
export interface CreateDocumentResponse {
/**
* 合同流程的底层电子文档ID,为32位字符串。
注:
后续需用同样的FlowId再次调用发起签署流程,合同才能进入签署环节
*/
DocumentId?: string;
/**
* 合同预览链接URL。
注: 1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
`2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,完整的预览链接需通过合同文档合成完成回调获取。
*/
PreviewFileUrl?: string;
/**
* 签署方信息,如角色ID、角色名称等
*/
Approvers?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIntegrationUserRoles返回参数结构体
*/
export interface CreateIntegrationUserRolesResponse {
/**
* 绑定角色失败列表信息
*/
FailedCreateRoleData?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateEmbedWebUrl返回参数结构体
*/
export interface CreateEmbedWebUrlResponse {
/**
* 嵌入的web链接,有效期:5分钟
链接仅能使用一次
建议:每次都用接口生成链接,保证链接的有效性
EmbedType=PREVIEW_CC_FLOW,该url为h5链接
*/
WebUrl?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集成版企业角色信息。
*/
export interface StaffRole {
/**
* 角色ID。
*/
RoleId?: string;
/**
* 角色名称。
*/
RoleName?: string;
}
/**
* UnbindEmployeeUserIdWithClientOpenId返回参数结构体
*/
export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
/**
* 解绑是否成功。
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateReleaseFlow返回参数结构体
*/
export interface CreateReleaseFlowResponse {
/**
* 解除协议流程编号
注意:这里的流程编号对应的合同是本次发起的解除协议。
*/
FlowId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 合同审查清单个性化参数,用于控制页面的展示内容
*/
export interface ContractReviewChecklistWebUrlOption {
/**
* 禁用新建清单功能。默认 false,设置为 true 会隐藏界面的新建按钮。
*/
DisableCreateChecklist?: boolean;
}
/**
* BindEmployeeUserIdWithClientOpenId请求参数结构体
*/
export interface BindEmployeeUserIdWithClientOpenIdRequest {
/**
* 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
通过DescribeIntegrationEmployees接口获取,也可登录腾讯电子签控制台查看

*/
UserId: string;
/**
* 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
*/
OpenId: 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;
}
/**
* DescribeExtendedServiceAuthDetail请求参数结构体
*/
export interface DescribeExtendedServiceAuthDetailRequest {
/**
* 执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 要查询的扩展服务类型。如下所示:
- OPEN_SERVER_SIGN:企业“授权签”
- BATCH_SIGN:批量签署
*/
ExtendServiceType?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 指定每页返回的数据条数,和Offset参数配合使用。 注:1.默认值为20,单页做大值为200。
*/
Limit?: number;
/**
* 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。 注:1.offset从0开始,即第一页为0。 2.默认从第一页返回。
*/
Offset?: number;
/**
* 查询指定的合作方企业的授权信息,当ExtendServiceType=OPEN_SERVER_SIGN:企业“授权签”时有效
*/
PartnerOrganizationName?: string;
}
/**
* CreateOrganizationAuthFile请求参数结构体
*/
export interface CreateOrganizationAuthFileRequest {
/**
* 企业授权书信息参数, 需要自行保证这些参数跟营业执照中的信息一致。
*/
OrganizationCommonInfo: OrganizationCommonInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 授权书类型:
- 0: 企业认证超管授权书
- 1: 超管变更授权书
- 2: 企业注销授权书
*/
Type?: number;
}
/**
* 签署控件的类型和范围限制条件,用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
*/
export interface ComponentLimit {
/**
* 控件类型,支持以下类型
- SIGN_SEAL : 印章控件
- SIGN_PAGING_SEAL : 骑缝章控件
- SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件
- SIGN_SIGNATURE : 用户签名控件
*/
ComponentType: string;
/**
* 签署控件类型的值(可选),用于限制签署时印章或者签名的选择范围
1.当 ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时,可指定印章类型或具体企业印章Id。具体场景与规则说明如下:
指定印章类型:可传入以下枚举值来限制印章类型
- OFFICIAL : 企业公章
- CONTRACT : 合同专用章
- FINANCE : 财务专用章
- PERSONNEL : 人事专用章
- OTHER : 其他
指定具体印章Id:可通过传递 ComponentValue 来指定具体的企业印章ID(支持传入多个)
限制条件:
- 可为本企业(即发起方)的签署人指定本企业具体印章ID。
- 主企业发起或集团账号主代子发起的业务场景下,也支持指定子企业的具体印章ID。
- 他方企业签署人不支持指定具体印章ID
注意: 若请求中同时指定了具体的印章ID和印章类型,将以印章ID为准,传入的印章类型参数会被自动忽略。
2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
- HANDWRITE : 需要实时手写的手写签名
- HANDWRITTEN_ESIGN : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
- OCR_ESIGN : OCR印章(智慧手写签名)
- ESIGN : 个人印章
- SYSTEM_ESIGN : 系统印章
3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
*/
ComponentValue?: Array;
}
/**
* ModifyPartnerAuthorization请求参数结构体
*/
export interface ModifyPartnerAuthorizationRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 腾讯电子签平台分配的生态集成业务的**业务标识**,**需要联系接入产品经理提供**。
*/
BusinessId: string;
/**
* 合作方企业通过集成方创建的应用id, 必须与业务标记(Business)保持对应。

*/
PartnerApplicationId: string;
/**
* 第三方应用的配置信息。其中包括 回调地址,加密KEY等信息。
执行成功后会覆盖掉对应的第三方应用的回调相关配置。
*/
ApplicationInfo: CallbackInfo;
}
/**
* CreateIntegrationSubOrganizationActiveRecord返回参数结构体
*/
export interface CreateIntegrationSubOrganizationActiveRecordResponse {
/**
* 激活失败的成员企业ID集合
*/
FailedSubOrganizationIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 合同备注
*/
export interface FlowRemarkItem {
/**
* 合同备注下标,对应最多5个备注位
取值范围:[0, 4]
*/
RemarkId?: number;
/**
* 合同备注内容,不超过 50 个字符,DELETE 时无需传入
*/
RemarkValue?: 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;
/**
* 企业签署人的员工姓名。除企业微信应用场景(ApproverSource设置为WEWORKAPP)外,本字段为必填。
*/
ApproverName?: string;
/**
* 补充企业签署人员工手机号
- ApproverSource!=WEWORKAPP时,必传
*/
ApproverMobile?: string;
/**
* 补充企业动态签署人时,需要指定对应企业名称
*/
OrganizationName?: string;
/**
* 签署方经办人的证件类型,支持以下类型
- ID_CARD 中国大陆居民身份证
- HONGKONG_AND_MACAO 中国港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)
注: 补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。
*/
ApproverIdCardType?: string;
/**
* 签署方经办人的证件号码,应符合以下规则
- 中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
- 中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字
- 中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串
注:补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。
*/
ApproverIdCardNumber?: string;
/**
* 合同流程ID
- 补充合同组子合同动态签署人时必传。
- 补充普通合同时,请阅读:补充签署人接口的接口使用说明
*/
FlowId?: string;
/**
* 通知类型:
当FillApproverType =0,或签场景补充签署人时,指定是否发送或签领取短信SMS:开启或签领取短信通知NONE:关闭或签领取短信通知当NotifyType=NONE时,可调用获取跳转至腾讯电子签小程序的签署链接接口生成签署链接来完成或签领取
*/
NotifyType?: string;
}
/**
* CreatePersonAuthCertificateImage返回参数结构体
*/
export interface CreatePersonAuthCertificateImageResponse {
/**
* 个人用户认证证书图片下载URL,有效期为5分钟,超过有效期后将无法再下载。
*/
AuthCertUrl?: string;
/**
* 个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。
该编号会合成到个人用户证书证明图片。
注: 个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动
*/
ImageCertId?: string;
/**
* 在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。
*/
SerialNumber?: string;
/**
* CA证书颁发时间,格式为Unix标准时间戳(秒)
该时间格式化后会合成到个人用户证书证明图片
*/
ValidFrom?: number;
/**
* CA证书有效截止时间,格式为Unix标准时间戳(秒)
该时间格式化后会合成到个人用户证书证明图片
*/
ValidTo?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 转交合同结果
*/
export interface FlowForwardResult {
/**
* 合同流程ID为32位字符串。您可以登录腾讯电子签控制台,在 "合同" -> "合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
*/
FlowId?: string;
/**
* 如果失败,返回的错误细节。
*/
ErrorDetail?: string;
}
/**
* DescribeLMInformationExtractionTaskFieldFeedback返回参数结构体
*/
export interface DescribeLMInformationExtractionTaskFieldFeedbackResponse {
/**
* 合同智能提取子任务反馈信息
*/
SubTaskFeedbackList?: Array;
/**
* 合同智能提取任务ID
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLMInformationExtractionTaskFieldFeedback返回参数结构体
*/
export interface CreateLMInformationExtractionTaskFieldFeedbackResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIntegrationEmployees返回参数结构体
*/
export interface DescribeIntegrationEmployeesResponse {
/**
* 员工信息列表。
*/
Employees?: Array;
/**
* 偏移量
*/
Offset?: number;
/**
* 指定分页每页返回的数据条数,单页最大支持 20。
*/
Limit?: number;
/**
* 符合条件的员工数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyFlowDeadline返回参数结构体
*/
export interface ModifyFlowDeadlineResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateBatchCancelFlowUrl返回参数结构体
*/
export interface CreateBatchCancelFlowUrlResponse {
/**
* 批量撤回签署流程链接
*/
BatchCancelFlowUrl?: string;
/**
* 签署流程撤回失败信息
数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错
*/
FailMessages?: Array;
/**
* 签署连接过期时间字符串:年月日-时分秒
*/
UrlExpireOn?: string;
/**
* 批量撤销任务编号,为32位字符串,可用于[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 创建员工的失败数据
*/
export interface FailedCreateStaffData {
/**
* 员工名
*/
DisplayName?: string;
/**
* 员工手机号
*/
Mobile?: string;
/**
* 传入的企微账号id
*/
WeworkOpenId?: string;
/**
* 失败原因
*/
Reason?: 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。
*/
RequestId?: string;
}
/**
* 此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息
*/
export interface FlowGroupInfo {
/**
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
FlowName: string;
/**
* 签署流程参与者信息,最大限制50方
注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
*/
Approvers: Array;
/**
* 文件资源ID,通过多文件上传UploadFiles接口获得,为32位字符串。
注:此字段定义为数组,但仅支持单个文件
*/
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 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、“授权签”合同。示例值:true
*/
NeedSignReview?: boolean;
/**
* 个人“授权签”场景。发起“授权签”时,需设置对应“授权签”场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
*/
AutoSignScene?: string;
/**
* 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:
- 0 :合同(默认值)
- 1 :文件
- 2 :协议
- 3 :文书
效果如下:
*/
FlowDisplayType?: number;
/**
* 抄送人信息
*/
CcInfos?: Array;
}
/**
* CreatePartnerAutoSignAuthUrl返回参数结构体
*/
export interface CreatePartnerAutoSignAuthUrlResponse {
/**
* 授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
*/
Url?: string;
/**
* 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
*/
MiniAppPath?: string;
/**
* 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
*/
ExpireTime?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ArchiveDynamicFlow请求参数结构体
*/
export interface ArchiveDynamicFlowRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程ID, 为32位字符串。
可登录腾讯电子签控制台,[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
*/
FlowId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
}
/**
* ModifyIntegrationRole返回参数结构体
*/
export interface ModifyIntegrationRoleResponse {
/**
* 角色id
*/
RoleId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式
*/
export interface ApproverComponentLimitType {
/**
* 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
*/
RecipientId: string;
/**
* 签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式,可多选
签名方式:
- HANDWRITE-手写签名
- ESIGN-个人印章类型
- OCR_ESIGN-AI智能识别手写签名
- SYSTEM_ESIGN-系统签名
*/
Values: Array;
}
/**
* CreateSingleSignOnEmployees返回参数结构体
*/
export interface CreateSingleSignOnEmployeesResponse {
/**
* 导入员工返回的错误信息,信息数组的顺序跟导入的保持一致
*/
ErrorMessages?: Array;
/**
* 导入员工返回的状态码
0-全部成功
1-部分成功
2-全部失败
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowEvidenceReport返回参数结构体
*/
export interface CreateFlowEvidenceReportResponse {
/**
* 出证报告 ID,可用于获取出证报告任务执行结果查询出证任务结果和出证PDF的下载URL
*/
ReportId?: string;
/**
* 出证任务执行的状态, 状态含义如下:
- **EvidenceStatusExecuting**: 出证任务在执行中
- **EvidenceStatusSuccess**: 出证任务执行成功
- **EvidenceStatusFailed** : 出证任务执行失败
*/
Status?: string;
/**
* 此字段已经废除,不再使用.
出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取
* @deprecated
*/
ReportUrl?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频核身相关配置
*/
export interface RuleIdConfig {
/**
* 意愿核身语音播报速度,配置后问答模式和点头模式的语音播报环节都会生效,默认值为0:
0-智能语速(根据播报文案的长度自动调整语音播报速度)
1-固定1倍速
2-固定1.2倍速
3-固定1.5倍速
*/
Speed?: number;
}
/**
* OperateTemplate返回参数结构体
*/
export interface OperateTemplateResponse {
/**
* 模板ID,为32位字符串,模板复制新建时返回
*/
TemplateId?: string;
/**
* 模板名称,模板复制新建时返回
*/
TemplateName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOrganizationGroupInvitationLink返回参数结构体
*/
export interface CreateOrganizationGroupInvitationLinkResponse {
/**
* 加入集团二维码链接,子企业的管理员可以直接扫码进入。
注意:1. 该链接有效期时间为ExpireTime,同时需要注意保密,不要外泄给无关用户。2. 该链接不支持小程序嵌入,仅支持移动端浏览器打开。3. 生成的链路后面不能再增加参数(会出现覆盖链接中已有参数导致错误)
*/
Link?: string;
/**
* 到期时间(以秒为单位的时间戳)
*/
ExpireTime?: number;
/**
* 加入集团短链接。
注意:
1. 该链接有效期时间为ExpireTime,同时需要注意保密,不要外泄给无关用户。
2. 该链接不支持小程序嵌入,仅支持移动端浏览器打开。
3. 生成的链路后面不能再增加参数(会出现覆盖链接中已有参数导致错误)
*/
JumpUrl?: string;
/**
* 腾讯电子签小程序加入集团链接。
小程序和APP集成使用
得到的链接类似于`pages/guide?shortKey=yDw***k1xFc5`, 用法可以参考:跳转电子签小程序
注: 生成的链路后面不能再增加参数
*/
MiniAppPath?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteIntegrationRoleUsers返回参数结构体
*/
export interface DeleteIntegrationRoleUsersResponse {
/**
* 角色id
*/
RoleId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowGroupByFiles请求参数结构体
*/
export interface CreateFlowGroupByFilesRequest {
/**
* 执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
*/
FlowGroupName: string;
/**
* 合同(流程)组的子合同信息,支持2-50个子合同
*/
FlowGroupInfos: Array;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 合同(流程)组的配置项信息。
其中包括:
*/
FlowGroupOptions?: FlowGroupOptions;
/**
* 用户自定义合同类型。
自定义合同类型配置的地方如链接图所示。点击查看自定义合同类型管理的位置
注意:
如果传递了自定义合同类型,则每一个子合同设置的自定义合同类型将会失效,已最外层定义的为准。
例如:
这份合同组有三个子合同,设置合同类型为人事/劳务
第一份子合同设置的合同自定义合同类型是采购
第二份和第三份子合同设置的合同自定义合同类型是人事/劳务
但最终这个合同组的合同类型是人事/劳务
*/
UserFlowType?: UserFlowType;
}
/**
* 催办接口返回的详细信息。
*/
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。
*/
RequestId?: string;
}
/**
* 此结构体(FlowGroupOptions)描述的是合同组的个性化配置,支持控制是否发送短信、未实名个人签署方查看合同组时是否需要实名认证(仅在合同组文件发起配置时生效)
*/
export interface FlowGroupOptions {
/**
* 签署人校验方式,支持以下类型
- VerifyCheck : 人脸识别 (默认值)
- MobileCheck : 手机号验证
参数说明:此参数仅在合同组文件发起有效,可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
*/
ApproverVerifyType?: string;
/**
* 发起合同(流程)组本方企业经办人通知方式
签署通知类型,支持以下类型
*/
SelfOrganizationApproverNotifyType?: string;
/**
* 发起合同(流程)组他方经办人通知方式
签署通知类型,支持以下类型
*/
OtherApproverNotifyType?: string;
/**
* 是否开启发起合同组的发起审批,默认:false(不开启),开启后,发起合同组会提交电子签内置审批流
*/
FlowGroupNeedWorkflow?: boolean;
/**
* 是否不可编辑合同名称 true-不可编辑 false-可编辑(默认)
*/
NoEditFlowName?: boolean;
/**
* 是否不可编辑合同类型 true-不可编辑 false-可编辑(默认)
*/
NoEditFlowType?: boolean;
/**
* 是否不可编辑合同截止日期 true-不可编辑 false-可编辑(默认)
*/
NoEditDeadline?: boolean;
/**
* 签署控件配置(如是否默认展示日期),用于嵌入式发起页面配置
*/
SignComponentConfig?: SignComponentConfig;
/**
* 是否禁止编辑水印控件属性 true-禁止 false-否(默认)
*/
ForbidEditWatermark?: boolean;
/**
* 发起成功后是否隐藏签署码 true-隐藏 false-否(默认)
*/
HideSignCodeAfterStart?: boolean;
/**
* 发起成功后是否签署合同,仅当前经办人为签署人时生效 true-展示签署 false-否(默认)
*/
SignAfterStart?: boolean;
/**
* 发起成功后是否预览合同 true-展示预览按钮 false-否(默认)
*/
PreviewAfterStart?: boolean;
}
/**
* 创建合同,若对方签署人的企业信息还未在腾讯电子签注册。则在进行引导企业注册时控制企业填写的信息。
具体可查看[视频](https://qian.tencent.com/developers/video/?menu=scene&id=6)
*/
export interface RegisterInfo {
/**
* 法人姓名
*/
LegalName: string;
/**
* 社会统一信用代码
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Uscc?: string;
/**
* 社会统一信用代码
*/
UnifiedSocialCreditCode?: string;
/**
* 组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。
*/
OrganizationAddress?: string;
/**
* 指定企业认证的授权方式 支持多选:
*/
AuthorizationTypes?: Array;
/**
* 指定企业认证的授权方式:
* @deprecated
*/
AuthorizationType?: number;
/**
* 指定企业认证的授权方式 支持多选:
- 1: 上传营业执照
- 2: 腾讯云快速认证
- 3: 腾讯商户号授权(仅支持小程序端)
*/
AuthorizationMethods?: Array;
/**
* 企业证照类型:
USCC :(默认)工商组织营业执照
PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证
CLINICFILLINGCERTIFICATE:诊所备案证
*/
OrganizationIdCardType?: string;
/**
* 企业创建时候的个性化参数。
其中,包括一下内容:
LegalNameSame 是否可以编辑法人。
UnifiedSocialCreditCodeSame 是否可以编辑证件号码。
OrganizationIdCardTypeSame 是否可以更改证照类型。
*/
RegisterInfoOption?: RegisterInfoOption;
}
/**
* 合同审查反馈信息
*/
export interface RiskIdentificationFeedbackInfo {
/**
* 审查结果ID
*/
RiskId?: string;
/**
* 反馈结果
- 1: 其他错误
- 2: 审查错误
- 3: 审查正确
*/
FeedbackResult?: number;
/**
* 反馈原因
*/
Reason?: string;
}
/**
* CreateReleaseFlow请求参数结构体
*/
export interface CreateReleaseFlowRequest {
/**
* 执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 待解除的签署流程编号(即原签署流程的编号)。
*/
NeedRelievedFlowId: string;
/**
* 解除协议内容, 包括解除理由等信息。
*/
ReliveInfo: RelieveInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。
如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口DescribeFlowInfo查询签署人的RecipientId编号)
注:1. 支持更换企业的签署人,不支持更换个人类型的签署人。2. 己方企业支持“授权签”,他方企业不支持“授权签”。3. 仅将需要替换的签署人添加至此列表,无需替换的签署人无需添加进来。
*/
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;
}
/**
* 更新员工信息成功返回的数据信息, 仅支持未实名的用户进行更新
会通过短信、企微消息或者H5Url 链接
如果是通过H5邀请加入的方式,会返回H5 链接
*/
export interface SuccessUpdateStaffData {
/**
* 传入的用户名称
*/
DisplayName?: string;
/**
* 传入的手机号,没有打码
*/
Mobile?: string;
/**
* 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
*/
UserId?: string;
/**
* H5端员工实名链接
只有入参 InvitationNotifyType = H5的时候才会进行返回。
*/
Url?: string;
}
/**
* 创建/修改员工成功返回的信息
现在支持saas/企微/H5端进行加入。
*/
export interface SuccessCreateStaffData {
/**
* 员工名
*/
DisplayName?: string;
/**
* 员工手机号
*/
Mobile?: string;
/**
* 员工在电子签平台的id
*/
UserId?: string;
/**
* 提示,当创建已存在未实名用户时,该字段有值
*/
Note?: string;
/**
* 传入的企微账号id
*/
WeworkOpenId?: string;
/**
* 员工邀请返回链接 根据入参的 InvitationNotifyType 和 Endpoint 返回链接 | 链接类型 | 有效期 | 示例 |
| HTTP_SHORT_URL(短链) | 一天 | https://test.essurl.cn/fvG7UBEd0F |
| HTTP(长链) | 一天 | https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=USER_VERIFY&verifyToken=yDCVbUUckpwocmfpUySko7IS83LTV0u0&expireTime=1710840183 |
| H5 | 30 天 | https://quick.test.qian.tencent.cn/guide?Code=yDCVbUUckpwtvxqoUbTw4VBBjLbfAtW7&CodeType=QUICK&shortKey=yDCVbUY7lhqV7mZlCL2d |
| APP | 一天 | /pages/guide/index?to=USER_VERIFY&verifyToken=yDCVbUUckpwocm96UySko7ISvEIZH7Yz&expireTime=1710840455 |
*/
Url?: string;
}
/**
* 主体信息
*/
export interface Identity {
/**
* 统一社会信用代码
*/
CreditCode?: string;
/**
* 组织机构代码
*/
OrgCode?: string;
/**
* 营业执照注册编号
*/
RegNo?: string;
/**
* 企业名称
*/
EntName?: string;
/**
* 修改人法人代表姓名
*/
LegalRepName?: string;
/**
* 渠道经营状态
*/
OpState?: string;
/**
* 经营期限自(格式YYYY-MM-DD)
*/
OpFromDate?: string;
/**
* 经营期限至
*/
OpToDate?: string;
/**
* 成立日期(格式YYYY-MM-DD)
*/
EstabDate?: string;
/**
* 核准日期(格式YYYY-MM-DD)
*/
ApprDate?: string;
/**
* 吊销日期(格式YYYY-MM-DD)
*/
RevoDate?: string;
/**
* 注销日期(格式YYYY-MM-DD)
*/
CancelDate?: string;
/**
* 登记机关
*/
RegOrg?: string;
/**
* 企业类型编码
*/
EntTypeCode?: string;
/**
* 企业类型
*/
EntType?: string;
/**
* 经营业务范围
*/
BizScope?: string;
/**
* 许可经营项目
*/
LicenseBizItem?: string;
/**
* 注册地址行政编号
*/
RegAreaCode?: string;
/**
* 注册地址
*/
RegAddress?: string;
/**
* 注册资本币种
*/
RegCapitalCurtype?: string;
/**
* 注册资本(万元)
*/
RegCapital?: string;
/**
* 实收资本(万元)
*/
PaidCapital?: string;
/**
* 原注册号
*/
OriRegNo?: string;
/**
* 企业英文名称
*/
EntNameEng?: string;
/**
* 曾用名
*/
OriEntName?: string;
/**
* 企业经营状态枚举。常见值如下:
未定义的状态 = 0
正常 = 1
注销 = 2
吊销 = 3
吊销后注销 = 4
撤销 = 5
其他 = 99
*/
OpStateCode?: number;
/**
* 查询日期(格式YYYY-MM-DD)
*/
SearchDate?: string;
}
/**
* CreateArchiveFlowTask返回参数结构体
*/
export interface CreateArchiveFlowTaskResponse {
/**
* 归档任务ID,后续使用 查询归档任务状态接口获取归档任务执行结果
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
*/
export interface UploadFile {
/**
* Base64编码后的文件内容
*/
FileBody: string;
/**
* 文件的名字。
文件名的最大长度应不超过200个字符,并且文件名的后缀必须反映其文件类型。
例如,PDF文件应以“.pdf”结尾,如“XXX.pdf”,而Word文件应以“.doc”或“.docx”结尾,如“XXX.doc”或“XXX.docx”。
*/
FileName?: string;
}
/**
* CreateFlowSignReview返回参数结构体
*/
export interface CreateFlowSignReviewResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RenewAutoSignLicense请求参数结构体
*/
export interface RenewAutoSignLicenseRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
*/
SceneKey: string;
/**
* 需要续期自动签的个人的信息,如姓名,证件信息等。
*/
UserInfo: UserThreeFactor;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
}
/**
* 文档内的填充控件返回结构体,返回控件的基本信息和填写内容值
*/
export interface FilledComponent {
/**
* 控件Id
*/
ComponentId?: string;
/**
* 控件名称
*/
ComponentName?: string;
/**
* 控件填写状态;0-未填写;1-已填写
*/
ComponentFillStatus?: string;
/**
* 控件填写内容
*/
ComponentValue?: string;
/**
* 控件所属参与方Id
*/
ComponentRecipientId?: string;
/**
* 图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
*/
ImageUrl?: string;
}
/**
* 合同组催办接口返回的详细信息。
*/
export interface RemindFlowGroupRecord {
/**
* 对应签署人出现的合同列表
*/
FlowIds?: Array;
/**
* 对应签署人出现的合同名
*/
FlowNames?: Array;
/**
* 签署人姓名
*/
ApproverName?: string;
/**
* 签署人手机号
*/
Mobile?: string;
/**
* 催办合同组下签署人维度详细信息
注意:此字段可能返回 null,表示取不到有效值。
*/
RemindMessageList?: Array;
}
/**
* CreateWebThemeConfig请求参数结构体
*/
export interface CreateWebThemeConfigRequest {
/**
* 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 主题类型,取值如下:
- **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置
*/
ThemeType: string;
/**
* 电子签logo是否展示,主体颜色等配置项
*/
WebThemeConfig: WebThemeConfig;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
}
/**
* CreateEmployeeQualificationSealQrCode返回参数结构体
*/
export interface CreateEmployeeQualificationSealQrCodeResponse {
/**
* 二维码图片的Base64 注: `此二维码的有效时间为7天,过期后需要重新生成新的二维码图片`
*/
QrcodeBase64?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateUserVerifyUrl返回参数结构体
*/
export interface CreateUserVerifyUrlResponse {
/**
* 腾讯电子签小程序的实名认证链接。
如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。
1.如果EndPoint是APP:
得到的链接类似于pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0, 用法可以参考描述中的"跳转到小程序的实现"
2.如果EndPoint是HTTP:
得到的链接类似于 https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d,点击后会跳转到腾讯电子签小程序进行签署
3.如果EndPoint是HTTP_SHORT_URL:
得到的链接类似于https://essurl.cn/2n**42Nd,点击后会跳转到腾讯电子签小程序进行签署
4.如果EndPoint是H5:
得到的链接类似于 https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb,点击后会跳转到腾讯电子签H5页面进行签署
5.如果EndPoint是H5_SHORT_URL:
得到的链接类似于https://essurl.cn/2n**42Nd,点击后会跳转到腾讯电子签H5页面进行签署
`注:` 生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数
示例值:https://essurl.cn/2n**42Nd
*/
UserVerifyUrl?: string;
/**
* 链接过期时间,为Unix时间戳(单位为秒)。
*/
ExpireTime?: number;
/**
* 小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回
*/
MiniAppId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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),用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)
*/
ResourceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用户自定义合同类型, 自定义合同类型的管理可以[点击查看在控制台位置的截图](https://qcloudimg.tencent-cloud.cn/raw/85a9b2ebce07b0cd6d75d5327d538235.png)
*/
export interface UserFlowType {
/**
* 合同类型ID
*/
UserFlowTypeId?: string;
/**
* 合同类型名称
*/
Name?: string;
/**
* 合同类型说明
*/
Description?: string;
}
/**
* CreatePrepareFlowGroup请求参数结构体
*/
export interface CreatePrepareFlowGroupRequest {
/**
* 执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
*/
FlowGroupName: string;
/**
* 合同(流程)组的子合同信息,支持2-50个子合同
*/
FlowGroupInfos: Array;
/**
* 资源类型,取值有:
*/
ResourceType: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 合同组发起控制参数,例如FlowGroupNeedWorkflow,表示开启嵌入式合同组发起审批
*/
FlowGroupOptions?: FlowGroupOptions;
/**
* 合同组类型,发起合同组后会应用到所有子合同
*/
FlowGroupType?: string;
/**
* 合同组过期时间,发起合同组后会应用到所有子合同
*/
FlowGroupDeadline?: number;
}
/**
* CreateFileCounterSign返回参数结构体
*/
export interface CreateFileCounterSignResponse {
/**
* 加签任务的状态。
- PROCESSING: 任务正在执行中。
- FINISHED: 已执行成功
*/
Status?: string;
/**
* 加签完成后新的文件Id
*/
ResultFileId?: string;
/**
* 异步模式下用于轮询状态的任务Id
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数字加签文件验签结果
*/
export interface VerifyDigitFileResult {
/**
* 证书起始时间的Unix时间戳,单位毫秒
*/
CertNotBefore?: number;
/**
* 证书过期时间的时间戳,单位毫秒
*/
CertNotAfter?: number;
/**
* 证书序列号,在数字证书申请过程中,系统会自动生成一个独一无二的序号。
*/
CertSn?: string;
/**
* 证书签名算法, 如SHA1withRSA等算法
*/
SignAlgorithm?: string;
/**
* 签署时间的Unix时间戳,单位毫秒
*/
SignTime?: number;
/**
* 签名类型。0表示带签章的数字签名,1表示仅数字签名
*/
SignType?: number;
/**
* 申请证书的主体的名字
如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
**企业**: ESS@企业名称@编码
**个人**: ESS@个人姓名@证件号@808854
如果在其他平台签署的, 主体的名字参考其他平台的说明
*/
SignerName?: string;
}
/**
* 签署人的转交记录详情
*/
export interface ForwardRecord {
/**
* 转交人打码后的姓名
*/
Name?: string;
/**
* 转交人打码后的手机号
*/
Mobile?: string;
/**
* 进行转交的原因
枚举值:
- QUIT_FORWARD: 离职转交
- FORWARD: 员工操作转交
*/
ForwardType?: string;
/**
* 转交的详情信息
*/
ForwardMessage?: string;
/**
* 转交时间
单位:时间戳(秒级)
*/
ForwardTime?: number;
}
/**
* CreatePrepareFlow请求参数结构体
*/
export interface CreatePrepareFlowRequest {
/**
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 资源id,与ResourceType相对应,取值范围:
- 文件Id(通过UploadFiles获取文件资源Id)
- 模板Id(通过控制台创建模板后获取模板Id)
- 草稿Id(通过嵌入页面保存草稿后获取草稿Id)
注意:需要同时设置 ResourceType 参数指定资源类型
*/
ResourceId: string;
/**
* 自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。
该名称还将用于合同签署完成后文件下载的默认文件名称。
*/
FlowName: string;
/**
* 资源类型,取值有:
- **1**:模板
- **2**:文件(默认值)
- **3**:草稿
*/
ResourceType?: number;
/**
* 合同流程的签署顺序类型:
- **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;
/**
* 该字段已不再使用,请使用InitiatorComponents
*/
Components?: Component;
/**
* 发起合同个性化参数
用于满足创建及页面操作过程中的个性化要求
具体定制化内容详见数据接口说明
*/
FlowOption?: CreateFlowOption;
/**
* 发起方企业签署员工,在进行签署操作前,是否需要先通过企业内部审批流程 (签署审核)1. false(默认): 无需审批,发起方企业签署员工可直接进行签署操作。2. true: 需要先走企业内部审批流程。 当流程进展到发起方企业签署员工时,其签署操作会被阻塞,等待企业内部审批结果。企业应通过 提交签署流程审批结果审批接口,将内部审批结果通知腾讯电子签平台:1. 若通知为“审核通过”,发起方企业签署员工可继续完成签署操作。2. 若通知为“审核未通过”,平台将继续阻塞该签署方的签署操作,直到企业再次通知平台审核通过为止。说明: 此能力可用于与企业内部审批流程打通,适用于手动签署和“授权签”两种模式。
*/
NeedSignReview?: boolean;
/**
* 发起方在创建合同流程前,是否必须先通过企业内部审批流程 (发起审核)
当设置为 true 时:
- 您需要在企业内部完成审批,并通过接口 提交签署流程审批结果 将审批结果回传给腾讯电子签。
- 只有当审核状态为“通过”时,合同流程正常发起。
- 若未通过或未回传审核结果,发起操作将被阻塞,阻止合同流程。
当设置为 false (默认值)时:
发起方无需经过企业内部审批,可直接发起合同流程。
*/
NeedCreateReview?: boolean;
/**
* 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
UserData?: string;
/**
* 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
*/
CcInfos?: Array;
/**
* 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
注: 该参数必须是一个待发起审核的合同id,并且还未审核通过
*/
FlowId?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
*/
InitiatorComponents?: Array;
/**
* 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:
- 0 :合同(默认值)
- 1 :文件
- 2 :协议
- 3 :文书
效果如下:
*/
FlowDisplayType?: number;
/**
* 此字段已不再使用,请使用 CreateFlowOption 里面的 SignComponentConfig
签署控件的配置信息,用在嵌入式发起的页面配置,
包括
* @deprecated
*/
SignComponentConfig?: SignComponentConfig;
/**
* 是否开启嵌入式合同发起时,提交发起审批流,默认:false(不开启),开启后,嵌入式合同发起后,会提交电子签内置审批流
*/
Workflow?: boolean;
}
/**
* DescribeCancelFlowsTask请求参数结构体
*/
export interface DescribeCancelFlowsTaskRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 批量撤销任务编号,为32位字符串,通过接口获取批量撤销签署流程腾讯电子签小程序链接和接口全量撤销企业合同获得。
*/
TaskId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 撤销任务类型
枚举值:
- 0: 默认类型,获取批量撤销合同小程序链接的批量撤销任务
- 1: 全量撤销任务
枚举值:
- 0: 默认类型,批量撤销合同任务或者获取批量撤销合同小程序链接的批量撤销任务
- 1: 全量撤销任务
枚举值:
- 0: 默认类型,获取批量撤销合同小程序链接的批量撤销任务
- 1: 全量撤销任务
*/
CancelType?: number;
}
/**
* DescribeContractReviewMarkedRiskExportTask返回参数结构体
*/
export interface DescribeContractReviewMarkedRiskExportTaskResponse {
/**
* 导出文件 url。
*/
Url?: string;
/**
* 任务状态。未知 = 0; 创建完成 = 1; 队列中 = 2; 执行中 = 3; 执行成功 = 4; 失败 = 5; 终止 = 6;
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateSealPolicy请求参数结构体
*/
export interface CreateSealPolicyRequest {
/**
* 执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 用户在电子文件签署平台标识信息,具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用,
同时也支持使用主企业的User进行授权, 当使用主企业的User时, 需要有集团角色。
*/
Users: Array;
/**
* 电子印章ID,为32位字符串。
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
*/
SealId: string;
/**
* 授权有效期,时间戳秒级。可以传0,代表有效期到2099年12月12日23点59分59秒。
*/
Expired: number;
/**
* 需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填,跟上面的Users同时起作用。
支持使用主企业的UserId进行授权, 当使用主企业的UserId时,该UserId 需要有集团角色。
*/
UserIds?: Array;
/**
* 印章授权内容,最多300 个字符。
*/
Policy?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
*/
Agent?: Agent;
/**
* 个性化配置字段,默认不传。
*/
Options?: Array