tencentcloud-sdk-nodejs-ess 4.0.723 → 4.0.725
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +340 -0
- package/SERVICE_CHANGELOG.md +455 -44
- package/package.json +1 -1
- package/products.md +25 -25
- package/src/services/ess/v20201111/ess_client.ts +31 -17
- package/src/services/ess/v20201111/ess_models.ts +340 -178
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +20 -15
- package/tencentcloud/services/ess/v20201111/ess_client.js +21 -14
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +336 -177
|
@@ -29,6 +29,99 @@ export interface DescribePersonCertificateResponse {
|
|
|
29
29
|
RequestId?: string
|
|
30
30
|
}
|
|
31
31
|
|
|
32
|
+
/**
|
|
33
|
+
* 用户计费使用情况详情
|
|
34
|
+
*/
|
|
35
|
+
export interface BillUsageDetail {
|
|
36
|
+
/**
|
|
37
|
+
* 合同流程ID,为32位字符串。
|
|
38
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
39
|
+
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
40
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
41
|
+
*/
|
|
42
|
+
FlowId?: string
|
|
43
|
+
/**
|
|
44
|
+
* 合同经办人名称
|
|
45
|
+
如果有多个经办人用分号隔开。
|
|
46
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
47
|
+
*/
|
|
48
|
+
OperatorName?: string
|
|
49
|
+
/**
|
|
50
|
+
* 发起方组织机构名称
|
|
51
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
52
|
+
*/
|
|
53
|
+
CreateOrganizationName?: string
|
|
54
|
+
/**
|
|
55
|
+
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
56
|
+
该名称还将用于合同签署完成后的下载文件名。
|
|
57
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
58
|
+
*/
|
|
59
|
+
FlowName?: string
|
|
60
|
+
/**
|
|
61
|
+
* 当前合同状态,如下是状态码对应的状态。
|
|
62
|
+
0-还没有发起
|
|
63
|
+
1-等待签署
|
|
64
|
+
2-部分签署
|
|
65
|
+
3-拒签
|
|
66
|
+
4-已签署
|
|
67
|
+
5-已过期
|
|
68
|
+
6-已撤销
|
|
69
|
+
7-还没有预发起
|
|
70
|
+
8-等待填写
|
|
71
|
+
9-部分填写
|
|
72
|
+
10-拒填
|
|
73
|
+
11-已解除
|
|
74
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
75
|
+
*/
|
|
76
|
+
Status?: number
|
|
77
|
+
/**
|
|
78
|
+
* 套餐类型
|
|
79
|
+
对应关系如下
|
|
80
|
+
CloudEnterprise-企业版合同
|
|
81
|
+
SingleSignature-单方签章
|
|
82
|
+
CloudProve-签署报告
|
|
83
|
+
CloudOnlineSign-腾讯会议在线签约
|
|
84
|
+
ChannelWeCard-微工卡
|
|
85
|
+
SignFlow-合同套餐
|
|
86
|
+
SignFace-签署意愿(人脸识别)
|
|
87
|
+
SignPassword-签署意愿(密码)
|
|
88
|
+
SignSMS-签署意愿(短信)
|
|
89
|
+
PersonalEssAuth-签署人实名(腾讯电子签认证)
|
|
90
|
+
PersonalThirdAuth-签署人实名(信任第三方认证)
|
|
91
|
+
OrgEssAuth-签署企业实名
|
|
92
|
+
FlowNotify-短信通知
|
|
93
|
+
AuthService-企业工商信息查询
|
|
94
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
95
|
+
*/
|
|
96
|
+
QuotaType?: string
|
|
97
|
+
/**
|
|
98
|
+
* 合同使用量
|
|
99
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
100
|
+
*/
|
|
101
|
+
UseCount?: number
|
|
102
|
+
/**
|
|
103
|
+
* 消耗的时间戳,格式为Unix标准时间戳(秒)。
|
|
104
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
105
|
+
*/
|
|
106
|
+
CostTime?: number
|
|
107
|
+
/**
|
|
108
|
+
* 消耗的套餐名称
|
|
109
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
110
|
+
*/
|
|
111
|
+
QuotaName?: string
|
|
112
|
+
/**
|
|
113
|
+
* 消耗类型
|
|
114
|
+
1.扣费 2.撤销返还
|
|
115
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
116
|
+
*/
|
|
117
|
+
CostType?: number
|
|
118
|
+
/**
|
|
119
|
+
* 备注
|
|
120
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
121
|
+
*/
|
|
122
|
+
Remark?: string
|
|
123
|
+
}
|
|
124
|
+
|
|
32
125
|
/**
|
|
33
126
|
* CreateSeal请求参数结构体
|
|
34
127
|
*/
|
|
@@ -60,7 +153,7 @@ export interface CreateSealRequest {
|
|
|
60
153
|
* 电子印章类型 , 可选类型如下:
|
|
61
154
|
<ul><li>**OFFICIAL**: (默认)公章</li>
|
|
62
155
|
<li>**CONTRACT**: 合同专用章;</li>
|
|
63
|
-
<li>**FINANCE**:
|
|
156
|
+
<li>**FINANCE**: 财务专用章;</li>
|
|
64
157
|
<li>**PERSONNEL**: 人事专用章</li>
|
|
65
158
|
</ul>
|
|
66
159
|
注: `同企业下只能有一个公章, 重复创建会报错`
|
|
@@ -1485,6 +1578,7 @@ export interface DescribeIntegrationEmployeesRequest {
|
|
|
1485
1578
|
<li>Key:**"UserId"**,根据用户ID查询员工,Values为指定的用户ID:**["UserId"]**</li>
|
|
1486
1579
|
<li>Key:**"UserWeWorkOpenId"**,根据用户企微账号ID查询员工,Values为指定用户的企微账号ID:**["UserWeWorkOpenId"]**</li>
|
|
1487
1580
|
<li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
|
|
1581
|
+
<li>Key:**"RoleId"**,根据电子签角色ID查询员工,Values为指定的角色ID,满足其中任意一个角色即可:**["RoleId1","RoleId2",...]**</li>
|
|
1488
1582
|
</ul>
|
|
1489
1583
|
*/
|
|
1490
1584
|
Filters?: Array<Filter>
|
|
@@ -1931,6 +2025,21 @@ export interface Permission {
|
|
|
1931
2025
|
Children?: Array<Permission>
|
|
1932
2026
|
}
|
|
1933
2027
|
|
|
2028
|
+
/**
|
|
2029
|
+
* DescribeFlowBriefs返回参数结构体
|
|
2030
|
+
*/
|
|
2031
|
+
export interface DescribeFlowBriefsResponse {
|
|
2032
|
+
/**
|
|
2033
|
+
* 合同流程基础信息列表,包含流程的名称、状态、创建日期等基本信息。
|
|
2034
|
+
注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
|
|
2035
|
+
*/
|
|
2036
|
+
FlowBriefs?: Array<FlowBrief>
|
|
2037
|
+
/**
|
|
2038
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2039
|
+
*/
|
|
2040
|
+
RequestId?: string
|
|
2041
|
+
}
|
|
2042
|
+
|
|
1934
2043
|
/**
|
|
1935
2044
|
* 企业员工信息。
|
|
1936
2045
|
*/
|
|
@@ -2711,47 +2820,151 @@ export interface CreateSchemeUrlResponse {
|
|
|
2711
2820
|
}
|
|
2712
2821
|
|
|
2713
2822
|
/**
|
|
2714
|
-
*
|
|
2823
|
+
* CreateFlowByFiles请求参数结构体
|
|
2715
2824
|
*/
|
|
2716
|
-
export interface
|
|
2825
|
+
export interface CreateFlowByFilesRequest {
|
|
2717
2826
|
/**
|
|
2718
|
-
*
|
|
2827
|
+
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
|
|
2828
|
+
支持填入集团子公司经办人 userId 代发合同。
|
|
2829
|
+
|
|
2830
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
2719
2831
|
*/
|
|
2720
|
-
|
|
2832
|
+
Operator: UserInfo
|
|
2721
2833
|
/**
|
|
2722
|
-
*
|
|
2834
|
+
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
2723
2835
|
|
|
2724
|
-
|
|
2836
|
+
该名称还将用于合同签署完成后的下载文件名。
|
|
2725
2837
|
*/
|
|
2726
|
-
|
|
2838
|
+
FlowName: string
|
|
2727
2839
|
/**
|
|
2728
|
-
*
|
|
2840
|
+
* 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
|
|
2729
2841
|
|
|
2730
|
-
|
|
2842
|
+
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
|
|
2731
2843
|
*/
|
|
2732
|
-
|
|
2844
|
+
Approvers: Array<ApproverInfo>
|
|
2733
2845
|
/**
|
|
2734
|
-
*
|
|
2846
|
+
* 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
|
|
2735
2847
|
|
|
2736
|
-
注:
|
|
2848
|
+
注: `目前,此接口仅支持单个文件发起。`
|
|
2737
2849
|
*/
|
|
2738
|
-
|
|
2850
|
+
FileIds: Array<string>
|
|
2739
2851
|
/**
|
|
2740
|
-
*
|
|
2852
|
+
* 合同流程描述信息(可自定义此描述),最大长度1000个字符。
|
|
2853
|
+
*/
|
|
2854
|
+
FlowDescription?: string
|
|
2855
|
+
/**
|
|
2856
|
+
* 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
|
|
2857
|
+
*/
|
|
2858
|
+
FlowType?: string
|
|
2859
|
+
/**
|
|
2860
|
+
* 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
|
2861
|
+
<ul><li> 单行文本控件 </li>
|
|
2862
|
+
<li> 多行文本控件 </li>
|
|
2863
|
+
<li> 勾选框控件 </li>
|
|
2864
|
+
<li> 数字控件 </li>
|
|
2865
|
+
<li> 图片控件 </li>
|
|
2866
|
+
<li> 动态表格等填写控件</li></ul>
|
|
2867
|
+
*/
|
|
2868
|
+
Components?: Array<Component>
|
|
2869
|
+
/**
|
|
2870
|
+
* 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
|
|
2741
2871
|
|
|
2742
|
-
注: `如果获取的是H5链接, 则不会返回此二维码图片`
|
|
2743
2872
|
*/
|
|
2744
|
-
|
|
2873
|
+
CcInfos?: Array<CcInfo>
|
|
2745
2874
|
/**
|
|
2746
|
-
*
|
|
2747
|
-
<ul><li>
|
|
2748
|
-
<li> **
|
|
2875
|
+
* 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
|
|
2876
|
+
<ul><li> **0**:合同发起时通知(默认值)</li>
|
|
2877
|
+
<li> **1**:签署完成后通知</li></ul>
|
|
2749
2878
|
*/
|
|
2750
|
-
|
|
2879
|
+
CcNotifyType?: number
|
|
2751
2880
|
/**
|
|
2752
|
-
*
|
|
2881
|
+
* 是否为预览模式,取值如下:
|
|
2882
|
+
<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
|
2883
|
+
<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
2753
2884
|
*/
|
|
2754
|
-
|
|
2885
|
+
NeedPreview?: boolean
|
|
2886
|
+
/**
|
|
2887
|
+
* 预览模式下产生的预览链接类型
|
|
2888
|
+
<ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
|
|
2889
|
+
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
|
2890
|
+
注: `此参数在NeedPreview 为true时有效`
|
|
2891
|
+
|
|
2892
|
+
*/
|
|
2893
|
+
PreviewType?: number
|
|
2894
|
+
/**
|
|
2895
|
+
* 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
|
2896
|
+
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
2897
|
+
*/
|
|
2898
|
+
Deadline?: number
|
|
2899
|
+
/**
|
|
2900
|
+
* 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
|
|
2901
|
+
|
|
2902
|
+
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
|
2903
|
+
*/
|
|
2904
|
+
RemindedOn?: number
|
|
2905
|
+
/**
|
|
2906
|
+
* 合同流程的签署顺序类型:
|
|
2907
|
+
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
2908
|
+
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
2909
|
+
*/
|
|
2910
|
+
Unordered?: boolean
|
|
2911
|
+
/**
|
|
2912
|
+
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
|
|
2913
|
+
<ul><li>{合同名称} </li>
|
|
2914
|
+
<li>{发起方企业} </li>
|
|
2915
|
+
<li>{发起方姓名} </li>
|
|
2916
|
+
<li>{签署方N企业}</li>
|
|
2917
|
+
<li>{签署方N姓名}</li></ul>
|
|
2918
|
+
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
2919
|
+
|
|
2920
|
+
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
2921
|
+
|
|
2922
|
+
合同名称:租房合同
|
|
2923
|
+
发起方:腾讯公司(张三)
|
|
2924
|
+
签署方:李四
|
|
2925
|
+
|
|
2926
|
+
|
|
2927
|
+
*/
|
|
2928
|
+
CustomShowMap?: string
|
|
2929
|
+
/**
|
|
2930
|
+
* 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
2931
|
+
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
2932
|
+
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
2933
|
+
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
2934
|
+
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
2935
|
+
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
2936
|
+
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
2937
|
+
*/
|
|
2938
|
+
NeedSignReview?: boolean
|
|
2939
|
+
/**
|
|
2940
|
+
* 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
|
2941
|
+
|
|
2942
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
2943
|
+
*/
|
|
2944
|
+
UserData?: string
|
|
2945
|
+
/**
|
|
2946
|
+
* 指定个人签署方查看合同的校验方式
|
|
2947
|
+
<ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
|
|
2948
|
+
<li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
|
|
2949
|
+
*/
|
|
2950
|
+
ApproverVerifyType?: string
|
|
2951
|
+
/**
|
|
2952
|
+
* 签署方签署控件(印章/签名等)的生成方式:
|
|
2953
|
+
<ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
|
|
2954
|
+
<li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
|
|
2955
|
+
*/
|
|
2956
|
+
SignBeanTag?: number
|
|
2957
|
+
/**
|
|
2958
|
+
* 代理企业和员工的信息。
|
|
2959
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
2960
|
+
*/
|
|
2961
|
+
Agent?: Agent
|
|
2962
|
+
/**
|
|
2963
|
+
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
|
|
2964
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
|
|
2965
|
+
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
2966
|
+
*/
|
|
2967
|
+
AutoSignScene?: string
|
|
2755
2968
|
}
|
|
2756
2969
|
|
|
2757
2970
|
/**
|
|
@@ -4092,154 +4305,6 @@ export interface DeleteIntegrationRoleUsersRequest {
|
|
|
4092
4305
|
Agent?: Agent
|
|
4093
4306
|
}
|
|
4094
4307
|
|
|
4095
|
-
/**
|
|
4096
|
-
* CreateFlowByFiles请求参数结构体
|
|
4097
|
-
*/
|
|
4098
|
-
export interface CreateFlowByFilesRequest {
|
|
4099
|
-
/**
|
|
4100
|
-
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
|
|
4101
|
-
支持填入集团子公司经办人 userId 代发合同。
|
|
4102
|
-
|
|
4103
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
4104
|
-
*/
|
|
4105
|
-
Operator: UserInfo
|
|
4106
|
-
/**
|
|
4107
|
-
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
4108
|
-
|
|
4109
|
-
该名称还将用于合同签署完成后的下载文件名。
|
|
4110
|
-
*/
|
|
4111
|
-
FlowName: string
|
|
4112
|
-
/**
|
|
4113
|
-
* 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
|
|
4114
|
-
|
|
4115
|
-
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
|
|
4116
|
-
*/
|
|
4117
|
-
Approvers: Array<ApproverInfo>
|
|
4118
|
-
/**
|
|
4119
|
-
* 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
|
|
4120
|
-
|
|
4121
|
-
注: `目前,此接口仅支持单个文件发起。`
|
|
4122
|
-
*/
|
|
4123
|
-
FileIds: Array<string>
|
|
4124
|
-
/**
|
|
4125
|
-
* 合同流程描述信息(可自定义此描述),最大长度1000个字符。
|
|
4126
|
-
*/
|
|
4127
|
-
FlowDescription?: string
|
|
4128
|
-
/**
|
|
4129
|
-
* 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
|
|
4130
|
-
*/
|
|
4131
|
-
FlowType?: string
|
|
4132
|
-
/**
|
|
4133
|
-
* 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
|
4134
|
-
<ul><li> 单行文本控件 </li>
|
|
4135
|
-
<li> 多行文本控件 </li>
|
|
4136
|
-
<li> 勾选框控件 </li>
|
|
4137
|
-
<li> 数字控件 </li>
|
|
4138
|
-
<li> 图片控件 </li>
|
|
4139
|
-
<li> 动态表格等填写控件</li></ul>
|
|
4140
|
-
*/
|
|
4141
|
-
Components?: Array<Component>
|
|
4142
|
-
/**
|
|
4143
|
-
* 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
|
|
4144
|
-
|
|
4145
|
-
*/
|
|
4146
|
-
CcInfos?: Array<CcInfo>
|
|
4147
|
-
/**
|
|
4148
|
-
* 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
|
|
4149
|
-
<ul><li> **0**:合同发起时通知(默认值)</li>
|
|
4150
|
-
<li> **1**:签署完成后通知</li></ul>
|
|
4151
|
-
*/
|
|
4152
|
-
CcNotifyType?: number
|
|
4153
|
-
/**
|
|
4154
|
-
* 是否为预览模式,取值如下:
|
|
4155
|
-
<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
|
4156
|
-
<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
4157
|
-
*/
|
|
4158
|
-
NeedPreview?: boolean
|
|
4159
|
-
/**
|
|
4160
|
-
* 预览模式下产生的预览链接类型
|
|
4161
|
-
<ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
|
|
4162
|
-
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
|
4163
|
-
注: `此参数在NeedPreview 为true时有效`
|
|
4164
|
-
|
|
4165
|
-
*/
|
|
4166
|
-
PreviewType?: number
|
|
4167
|
-
/**
|
|
4168
|
-
* 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
|
4169
|
-
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
4170
|
-
*/
|
|
4171
|
-
Deadline?: number
|
|
4172
|
-
/**
|
|
4173
|
-
* 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
|
|
4174
|
-
|
|
4175
|
-
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
|
4176
|
-
*/
|
|
4177
|
-
RemindedOn?: number
|
|
4178
|
-
/**
|
|
4179
|
-
* 合同流程的签署顺序类型:
|
|
4180
|
-
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
4181
|
-
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
4182
|
-
*/
|
|
4183
|
-
Unordered?: boolean
|
|
4184
|
-
/**
|
|
4185
|
-
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
|
|
4186
|
-
<ul><li>{合同名称} </li>
|
|
4187
|
-
<li>{发起方企业} </li>
|
|
4188
|
-
<li>{发起方姓名} </li>
|
|
4189
|
-
<li>{签署方N企业}</li>
|
|
4190
|
-
<li>{签署方N姓名}</li></ul>
|
|
4191
|
-
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
4192
|
-
|
|
4193
|
-
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
4194
|
-
|
|
4195
|
-
合同名称:租房合同
|
|
4196
|
-
发起方:腾讯公司(张三)
|
|
4197
|
-
签署方:李四
|
|
4198
|
-
|
|
4199
|
-
|
|
4200
|
-
*/
|
|
4201
|
-
CustomShowMap?: string
|
|
4202
|
-
/**
|
|
4203
|
-
* 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
4204
|
-
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
4205
|
-
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
4206
|
-
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
4207
|
-
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
4208
|
-
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
4209
|
-
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
4210
|
-
*/
|
|
4211
|
-
NeedSignReview?: boolean
|
|
4212
|
-
/**
|
|
4213
|
-
* 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
|
4214
|
-
|
|
4215
|
-
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
4216
|
-
*/
|
|
4217
|
-
UserData?: string
|
|
4218
|
-
/**
|
|
4219
|
-
* 指定个人签署方查看合同的校验方式
|
|
4220
|
-
<ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
|
|
4221
|
-
<li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
|
|
4222
|
-
*/
|
|
4223
|
-
ApproverVerifyType?: string
|
|
4224
|
-
/**
|
|
4225
|
-
* 签署方签署控件(印章/签名等)的生成方式:
|
|
4226
|
-
<ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
|
|
4227
|
-
<li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
|
|
4228
|
-
*/
|
|
4229
|
-
SignBeanTag?: number
|
|
4230
|
-
/**
|
|
4231
|
-
* 代理企业和员工的信息。
|
|
4232
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
4233
|
-
*/
|
|
4234
|
-
Agent?: Agent
|
|
4235
|
-
/**
|
|
4236
|
-
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
|
|
4237
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
|
|
4238
|
-
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
4239
|
-
*/
|
|
4240
|
-
AutoSignScene?: string
|
|
4241
|
-
}
|
|
4242
|
-
|
|
4243
4308
|
/**
|
|
4244
4309
|
* CreateFlowSignUrl请求参数结构体
|
|
4245
4310
|
*/
|
|
@@ -5166,6 +5231,10 @@ export interface CreatePrepareFlowResponse {
|
|
|
5166
5231
|
* 发起流程的web页面链接,有效期5分钟
|
|
5167
5232
|
*/
|
|
5168
5233
|
Url?: string
|
|
5234
|
+
/**
|
|
5235
|
+
* 创建的合同id(还未实际发起),每次调用会生成新的id,用户可以记录此字段对应后续页面发起的合同,若在页面上未成功发起,则此字段无效。
|
|
5236
|
+
*/
|
|
5237
|
+
FlowId?: string
|
|
5169
5238
|
/**
|
|
5170
5239
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
5171
5240
|
*/
|
|
@@ -6221,6 +6290,68 @@ export interface CreateFlowGroupByTemplatesRequest {
|
|
|
6221
6290
|
FlowGroupOptions?: FlowGroupOptions
|
|
6222
6291
|
}
|
|
6223
6292
|
|
|
6293
|
+
/**
|
|
6294
|
+
* DescribeBillUsageDetail返回参数结构体
|
|
6295
|
+
*/
|
|
6296
|
+
export interface DescribeBillUsageDetailResponse {
|
|
6297
|
+
/**
|
|
6298
|
+
* 总数
|
|
6299
|
+
*/
|
|
6300
|
+
Total?: number
|
|
6301
|
+
/**
|
|
6302
|
+
* 消耗详情
|
|
6303
|
+
*/
|
|
6304
|
+
Details?: Array<BillUsageDetail>
|
|
6305
|
+
/**
|
|
6306
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6307
|
+
*/
|
|
6308
|
+
RequestId?: string
|
|
6309
|
+
}
|
|
6310
|
+
|
|
6311
|
+
/**
|
|
6312
|
+
* CreateUserAutoSignEnableUrl返回参数结构体
|
|
6313
|
+
*/
|
|
6314
|
+
export interface CreateUserAutoSignEnableUrlResponse {
|
|
6315
|
+
/**
|
|
6316
|
+
* 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
|
|
6317
|
+
*/
|
|
6318
|
+
Url?: string
|
|
6319
|
+
/**
|
|
6320
|
+
* 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
6321
|
+
|
|
6322
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
6323
|
+
*/
|
|
6324
|
+
AppId?: string
|
|
6325
|
+
/**
|
|
6326
|
+
* 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
6327
|
+
|
|
6328
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
6329
|
+
*/
|
|
6330
|
+
AppOriginalId?: string
|
|
6331
|
+
/**
|
|
6332
|
+
* 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
6333
|
+
|
|
6334
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
6335
|
+
*/
|
|
6336
|
+
Path?: string
|
|
6337
|
+
/**
|
|
6338
|
+
* base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
|
|
6339
|
+
|
|
6340
|
+
注: `如果获取的是H5链接, 则不会返回此二维码图片`
|
|
6341
|
+
*/
|
|
6342
|
+
QrCode?: string
|
|
6343
|
+
/**
|
|
6344
|
+
* 返回的链接类型
|
|
6345
|
+
<ul><li> 空: 默认小程序端链接</li>
|
|
6346
|
+
<li> **H5SIGN** : h5端链接</li></ul>
|
|
6347
|
+
*/
|
|
6348
|
+
UrlType?: string
|
|
6349
|
+
/**
|
|
6350
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6351
|
+
*/
|
|
6352
|
+
RequestId?: string
|
|
6353
|
+
}
|
|
6354
|
+
|
|
6224
6355
|
/**
|
|
6225
6356
|
* 流程签署二维码的签署信息,适用于客户系统整合二维码功能。
|
|
6226
6357
|
通过链接,用户可直接访问电子签名小程序并签署合同。
|
|
@@ -6296,18 +6427,49 @@ export interface DeleteStaffsResult {
|
|
|
6296
6427
|
}
|
|
6297
6428
|
|
|
6298
6429
|
/**
|
|
6299
|
-
*
|
|
6430
|
+
* DescribeBillUsageDetail请求参数结构体
|
|
6300
6431
|
*/
|
|
6301
|
-
export interface
|
|
6432
|
+
export interface DescribeBillUsageDetailRequest {
|
|
6302
6433
|
/**
|
|
6303
|
-
*
|
|
6304
|
-
注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
|
|
6434
|
+
* 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
6305
6435
|
*/
|
|
6306
|
-
|
|
6436
|
+
StartTime: string
|
|
6307
6437
|
/**
|
|
6308
|
-
*
|
|
6438
|
+
* 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
6309
6439
|
*/
|
|
6310
|
-
|
|
6440
|
+
EndTime: string
|
|
6441
|
+
/**
|
|
6442
|
+
* 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
|
|
6443
|
+
*/
|
|
6444
|
+
Offset?: number
|
|
6445
|
+
/**
|
|
6446
|
+
* 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
|
|
6447
|
+
*/
|
|
6448
|
+
Limit?: number
|
|
6449
|
+
/**
|
|
6450
|
+
* 查询的套餐类型 (选填 )不传则查询所有套餐;
|
|
6451
|
+
对应关系如下
|
|
6452
|
+
CloudEnterprise-企业版合同
|
|
6453
|
+
SingleSignature-单方签章
|
|
6454
|
+
CloudProve-签署报告
|
|
6455
|
+
CloudOnlineSign-腾讯会议在线签约
|
|
6456
|
+
ChannelWeCard-微工卡
|
|
6457
|
+
SignFlow-合同套餐
|
|
6458
|
+
SignFace-签署意愿(人脸识别)
|
|
6459
|
+
SignPassword-签署意愿(密码)
|
|
6460
|
+
SignSMS-签署意愿(短信)
|
|
6461
|
+
PersonalEssAuth-签署人实名(腾讯电子签认证)
|
|
6462
|
+
PersonalThirdAuth-签署人实名(信任第三方认证)
|
|
6463
|
+
OrgEssAuth-签署企业实名
|
|
6464
|
+
FlowNotify-短信通知
|
|
6465
|
+
AuthService-企业工商信息查询
|
|
6466
|
+
*/
|
|
6467
|
+
QuotaType?: string
|
|
6468
|
+
/**
|
|
6469
|
+
* 代理企业和员工的信息。
|
|
6470
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
6471
|
+
*/
|
|
6472
|
+
Agent?: Agent
|
|
6311
6473
|
}
|
|
6312
6474
|
|
|
6313
6475
|
/**
|