tencentcloud-sdk-nodejs-essbasic 4.0.961 → 4.0.963
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/package.json +1 -1
- package/products.md +59 -60
- package/src/services/essbasic/v20210526/essbasic_client.ts +68 -9
- package/src/services/essbasic/v20210526/essbasic_models.ts +211 -69
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +51 -9
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +54 -8
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +206 -69
|
@@ -1305,6 +1305,8 @@ export interface ReleasedApprover {
|
|
|
1305
1305
|
/**
|
|
1306
1306
|
* 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。
|
|
1307
1307
|
如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
|
|
1308
|
+
|
|
1309
|
+

|
|
1308
1310
|
*/
|
|
1309
1311
|
ApproverSignRole?: string
|
|
1310
1312
|
/**
|
|
@@ -1962,6 +1964,67 @@ export interface UploadFilesResponse {
|
|
|
1962
1964
|
RequestId?: string
|
|
1963
1965
|
}
|
|
1964
1966
|
|
|
1967
|
+
/**
|
|
1968
|
+
* 权限树节点权限
|
|
1969
|
+
*/
|
|
1970
|
+
export interface Permission {
|
|
1971
|
+
/**
|
|
1972
|
+
* 权限名称
|
|
1973
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1974
|
+
*/
|
|
1975
|
+
Name?: string
|
|
1976
|
+
/**
|
|
1977
|
+
* 权限key
|
|
1978
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1979
|
+
*/
|
|
1980
|
+
Key?: string
|
|
1981
|
+
/**
|
|
1982
|
+
* 权限类型 1前端,2后端
|
|
1983
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1984
|
+
*/
|
|
1985
|
+
Type?: number
|
|
1986
|
+
/**
|
|
1987
|
+
* 是否隐藏
|
|
1988
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1989
|
+
*/
|
|
1990
|
+
Hide?: number
|
|
1991
|
+
/**
|
|
1992
|
+
* 数据权限标签 1:表示根节点,2:表示叶子结点
|
|
1993
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1994
|
+
*/
|
|
1995
|
+
DataLabel?: number
|
|
1996
|
+
/**
|
|
1997
|
+
* 数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权
|
|
1998
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1999
|
+
*/
|
|
2000
|
+
DataType?: number
|
|
2001
|
+
/**
|
|
2002
|
+
* 数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己
|
|
2003
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2004
|
+
*/
|
|
2005
|
+
DataRange?: number
|
|
2006
|
+
/**
|
|
2007
|
+
* 关联权限, 表示这个功能权限要受哪个数据权限管控
|
|
2008
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2009
|
+
*/
|
|
2010
|
+
DataTo?: string
|
|
2011
|
+
/**
|
|
2012
|
+
* 父级权限key
|
|
2013
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2014
|
+
*/
|
|
2015
|
+
ParentKey?: string
|
|
2016
|
+
/**
|
|
2017
|
+
* 是否选中
|
|
2018
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2019
|
+
*/
|
|
2020
|
+
IsChecked?: boolean
|
|
2021
|
+
/**
|
|
2022
|
+
* 子权限集合
|
|
2023
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2024
|
+
*/
|
|
2025
|
+
Children?: Array<Permission>
|
|
2026
|
+
}
|
|
2027
|
+
|
|
1965
2028
|
/**
|
|
1966
2029
|
* 应用相关信息, 整体应用的层级图如下
|
|
1967
2030
|
|
|
@@ -2984,64 +3047,21 @@ export interface ChannelCancelUserAutoSignEnableUrlRequest {
|
|
|
2984
3047
|
}
|
|
2985
3048
|
|
|
2986
3049
|
/**
|
|
2987
|
-
*
|
|
3050
|
+
* DeleteOrganizationAuthorizations返回参数结构体
|
|
2988
3051
|
*/
|
|
2989
|
-
export interface
|
|
2990
|
-
/**
|
|
2991
|
-
* 权限名称
|
|
2992
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2993
|
-
*/
|
|
2994
|
-
Name?: string
|
|
2995
|
-
/**
|
|
2996
|
-
* 权限key
|
|
2997
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2998
|
-
*/
|
|
2999
|
-
Key?: string
|
|
3000
|
-
/**
|
|
3001
|
-
* 权限类型 1前端,2后端
|
|
3002
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3003
|
-
*/
|
|
3004
|
-
Type?: number
|
|
3052
|
+
export interface DeleteOrganizationAuthorizationsResponse {
|
|
3005
3053
|
/**
|
|
3006
|
-
*
|
|
3007
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3054
|
+
* 清理认证流的详细信息,包括企业名称、认证流唯一 ID 以及清理认证流过程中产生的错误信息。
|
|
3008
3055
|
*/
|
|
3009
|
-
|
|
3056
|
+
DeleteOrganizationAuthorizationInfos?: Array<DeleteOrganizationAuthorizationInfo>
|
|
3010
3057
|
/**
|
|
3011
|
-
*
|
|
3012
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3013
|
-
*/
|
|
3014
|
-
DataLabel?: number
|
|
3015
|
-
/**
|
|
3016
|
-
* 数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权
|
|
3017
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3058
|
+
* 批量清理认证流返回的状态值其中包括- 1 全部成功- 2 部分成功- 3 全部失败
|
|
3018
3059
|
*/
|
|
3019
|
-
|
|
3020
|
-
/**
|
|
3021
|
-
* 数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己
|
|
3022
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3023
|
-
*/
|
|
3024
|
-
DataRange?: number
|
|
3025
|
-
/**
|
|
3026
|
-
* 关联权限, 表示这个功能权限要受哪个数据权限管控
|
|
3027
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3028
|
-
*/
|
|
3029
|
-
DataTo?: string
|
|
3030
|
-
/**
|
|
3031
|
-
* 父级权限key
|
|
3032
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3033
|
-
*/
|
|
3034
|
-
ParentKey?: string
|
|
3035
|
-
/**
|
|
3036
|
-
* 是否选中
|
|
3037
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3038
|
-
*/
|
|
3039
|
-
IsChecked?: boolean
|
|
3060
|
+
Status?: number
|
|
3040
3061
|
/**
|
|
3041
|
-
*
|
|
3042
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3062
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3043
3063
|
*/
|
|
3044
|
-
|
|
3064
|
+
RequestId?: string
|
|
3045
3065
|
}
|
|
3046
3066
|
|
|
3047
3067
|
/**
|
|
@@ -3360,7 +3380,14 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
3360
3380
|
*/
|
|
3361
3381
|
TopNavigationStatus?: string
|
|
3362
3382
|
/**
|
|
3363
|
-
*
|
|
3383
|
+
* 是否自动激活子客企业,有下面两种选项:
|
|
3384
|
+
|
|
3385
|
+
**false(默认设置)**:不自动激活子客户。您需要通过控制台或调用[激活或者续期子企业](https://qian.tencent.com/developers/partnerApis/accounts/CreateChannelSubOrganizationActive)接口手动完成激活过程。
|
|
3386
|
+
|
|
3387
|
+
**true**:若持有的许可证充足,子客户企业注册完成后将自动激活,无需手动操作或访问控制台。
|
|
3388
|
+
|
|
3389
|
+
<b>注</b>:如果<b>应用扩展服务</b>中的<b>自动激活子客企业</b>为打开态, 则忽略本接口的AutoActive这个参数(若持有的许可证充足,子客户企业注册完成后将自动激活),具体位置参考下图:
|
|
3390
|
+

|
|
3364
3391
|
*/
|
|
3365
3392
|
AutoActive?: boolean
|
|
3366
3393
|
}
|
|
@@ -3394,6 +3421,16 @@ export interface CreateLegalSealQrCodeRequest {
|
|
|
3394
3421
|
Organization?: OrganizationInfo
|
|
3395
3422
|
}
|
|
3396
3423
|
|
|
3424
|
+
/**
|
|
3425
|
+
* CreateCloseOrganizationUrl请求参数结构体
|
|
3426
|
+
*/
|
|
3427
|
+
export interface CreateCloseOrganizationUrlRequest {
|
|
3428
|
+
/**
|
|
3429
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
|
|
3430
|
+
*/
|
|
3431
|
+
Agent: Agent
|
|
3432
|
+
}
|
|
3433
|
+
|
|
3397
3434
|
/**
|
|
3398
3435
|
* 签署链接内容
|
|
3399
3436
|
*/
|
|
@@ -3662,7 +3699,9 @@ export interface FillApproverInfo {
|
|
|
3662
3699
|
*/
|
|
3663
3700
|
ApproverIdCardNumber?: string
|
|
3664
3701
|
/**
|
|
3665
|
-
* 合同流程ID
|
|
3702
|
+
* 合同流程ID
|
|
3703
|
+
- 补充合同组子合同动态签署人时必传。
|
|
3704
|
+
- 补充正常合同,请阅读:<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口</a>接口使用说明
|
|
3666
3705
|
*/
|
|
3667
3706
|
FlowId?: string
|
|
3668
3707
|
}
|
|
@@ -4071,6 +4110,40 @@ export interface DescribeExtendedServiceAuthInfoRequest {
|
|
|
4071
4110
|
Agent: Agent
|
|
4072
4111
|
}
|
|
4073
4112
|
|
|
4113
|
+
/**
|
|
4114
|
+
* CreateCloseOrganizationUrl返回参数结构体
|
|
4115
|
+
*/
|
|
4116
|
+
export interface CreateCloseOrganizationUrlResponse {
|
|
4117
|
+
/**
|
|
4118
|
+
* 链接有效期,unix时间戳,精确到秒
|
|
4119
|
+
*/
|
|
4120
|
+
ExpiredOn?: number
|
|
4121
|
+
/**
|
|
4122
|
+
* H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
|
|
4123
|
+
*/
|
|
4124
|
+
LongUrl?: string
|
|
4125
|
+
/**
|
|
4126
|
+
* H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
|
|
4127
|
+
*/
|
|
4128
|
+
ShortUrl?: string
|
|
4129
|
+
/**
|
|
4130
|
+
* APP或小程序跳转电子签小程序链接, 一般用于客户小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
|
|
4131
|
+
*/
|
|
4132
|
+
MiniAppPath?: string
|
|
4133
|
+
/**
|
|
4134
|
+
* 二维码链接
|
|
4135
|
+
*/
|
|
4136
|
+
QrcodeUrl?: string
|
|
4137
|
+
/**
|
|
4138
|
+
* 直接跳转至电子签小程序的二维码链接,无需通过中转页。您需要自行将其转换为二维码,使用微信扫码后可直接进入。请注意,直接点击链接是无效的。
|
|
4139
|
+
*/
|
|
4140
|
+
WeixinQrcodeUrl?: string
|
|
4141
|
+
/**
|
|
4142
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4143
|
+
*/
|
|
4144
|
+
RequestId?: string
|
|
4145
|
+
}
|
|
4146
|
+
|
|
4074
4147
|
/**
|
|
4075
4148
|
* DescribeChannelSealPolicyWorkflowUrl请求参数结构体
|
|
4076
4149
|
*/
|
|
@@ -4515,6 +4588,28 @@ export interface ChannelCreateBoundFlowsRequest {
|
|
|
4515
4588
|
Operator?: UserInfo
|
|
4516
4589
|
}
|
|
4517
4590
|
|
|
4591
|
+
/**
|
|
4592
|
+
* 清理的企业认证流信息
|
|
4593
|
+
*/
|
|
4594
|
+
export interface DeleteOrganizationAuthorizationInfo {
|
|
4595
|
+
/**
|
|
4596
|
+
* 认证流 Id 是指在企业认证过程中,当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内,一个企业只能有一个认证流程处于成功状态,以确保认证的唯一性和有效性。
|
|
4597
|
+
*/
|
|
4598
|
+
AuthorizationId?: string
|
|
4599
|
+
/**
|
|
4600
|
+
* 认证的企业名称
|
|
4601
|
+
*/
|
|
4602
|
+
OrganizationName?: string
|
|
4603
|
+
/**
|
|
4604
|
+
* 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
|
|
4605
|
+
*/
|
|
4606
|
+
OrganizationOpenId?: string
|
|
4607
|
+
/**
|
|
4608
|
+
* 清除认证流产生的错误信息
|
|
4609
|
+
*/
|
|
4610
|
+
Errormessage?: string
|
|
4611
|
+
}
|
|
4612
|
+
|
|
4518
4613
|
/**
|
|
4519
4614
|
* ChannelDescribeEmployees请求参数结构体
|
|
4520
4615
|
*/
|
|
@@ -4717,7 +4812,10 @@ export interface CreateSignUrlsRequest {
|
|
|
4717
4812
|
Agent: Agent
|
|
4718
4813
|
/**
|
|
4719
4814
|
* 合同流程ID数组,最多支持100个。
|
|
4720
|
-
|
|
4815
|
+
|
|
4816
|
+
注:
|
|
4817
|
+
1. 必须选择提供此参数或合同组编号中的一个。
|
|
4818
|
+
2. 当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。
|
|
4721
4819
|
*/
|
|
4722
4820
|
FlowIds?: Array<string>
|
|
4723
4821
|
/**
|
|
@@ -4741,19 +4839,16 @@ export interface CreateSignUrlsRequest {
|
|
|
4741
4839
|
/**
|
|
4742
4840
|
* 签署链接生成类型,可以选择的类型如下
|
|
4743
4841
|
|
|
4744
|
-
<ul><li
|
|
4745
|
-
<li
|
|
4746
|
-
<li
|
|
4747
|
-
<li
|
|
4748
|
-
<li
|
|
4749
|
-
<li
|
|
4842
|
+
<ul><li><strong>ALL</strong>:(默认)为所有签署方生成签署链接,但不包括自动签署(静默签署)的签署方。注意:<strong>此中类型不支持多个合同ID(FlowIds)</strong>。</li>
|
|
4843
|
+
<li><strong>CHANNEL</strong>:适用于第三方子企业的员工签署方。</li>
|
|
4844
|
+
<li><strong>NOT_CHANNEL</strong>:适用于SaaS平台企业的员工签署方。</li>
|
|
4845
|
+
<li><strong>PERSON</strong>:适用于个人或自然人签署方。</li>
|
|
4846
|
+
<li><strong>FOLLOWER</strong>:适用于关注方,目前指合同的抄送方。</li>
|
|
4847
|
+
<li><strong>RECIPIENT</strong>:根据RecipientId生成对应的签署链接,适用于动态添加签署人的情况。</li></ul>
|
|
4750
4848
|
*/
|
|
4751
4849
|
GenerateType?: string
|
|
4752
4850
|
/**
|
|
4753
|
-
* SaaS
|
|
4754
|
-
如果名称中包含英文括号(),请使用中文括号()代替。
|
|
4755
|
-
|
|
4756
|
-
注: `GenerateType为"NOT_CHANNEL"时必填`
|
|
4851
|
+
* SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
|
|
4757
4852
|
*/
|
|
4758
4853
|
OrganizationName?: string
|
|
4759
4854
|
/**
|
|
@@ -5450,6 +5545,11 @@ export interface FillError {
|
|
|
5450
5545
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5451
5546
|
*/
|
|
5452
5547
|
ErrMessage?: string
|
|
5548
|
+
/**
|
|
5549
|
+
* 合同流程ID,为32位字符串。
|
|
5550
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5551
|
+
*/
|
|
5552
|
+
FlowId?: string
|
|
5453
5553
|
}
|
|
5454
5554
|
|
|
5455
5555
|
/**
|
|
@@ -6736,6 +6836,30 @@ export interface WebThemeConfig {
|
|
|
6736
6836
|
HideAuthenticateTopLogo?: boolean
|
|
6737
6837
|
}
|
|
6738
6838
|
|
|
6839
|
+
/**
|
|
6840
|
+
* DeleteOrganizationAuthorizations请求参数结构体
|
|
6841
|
+
*/
|
|
6842
|
+
export interface DeleteOrganizationAuthorizationsRequest {
|
|
6843
|
+
/**
|
|
6844
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6845
|
+
|
|
6846
|
+
此接口下面信息必填。
|
|
6847
|
+
<ul>
|
|
6848
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6849
|
+
</ul>
|
|
6850
|
+
|
|
6851
|
+
*/
|
|
6852
|
+
Agent: Agent
|
|
6853
|
+
/**
|
|
6854
|
+
* 认证人姓名,组织机构超管姓名。 在注册流程中,必须是超管本人进行操作。
|
|
6855
|
+
*/
|
|
6856
|
+
AdminName?: string
|
|
6857
|
+
/**
|
|
6858
|
+
* 认证人手机号,组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。
|
|
6859
|
+
*/
|
|
6860
|
+
AdminMobile?: string
|
|
6861
|
+
}
|
|
6862
|
+
|
|
6739
6863
|
/**
|
|
6740
6864
|
* ChannelCreateFlowGroupByFiles返回参数结构体
|
|
6741
6865
|
*/
|
|
@@ -6801,7 +6925,7 @@ export interface ApproverOption {
|
|
|
6801
6925
|
/**
|
|
6802
6926
|
* 签署人信息补充类型,默认无需补充。
|
|
6803
6927
|
|
|
6804
|
-
<ul><li> **1** :
|
|
6928
|
+
<ul><li> **1** : 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>
|
|
6805
6929
|
|
|
6806
6930
|
注:
|
|
6807
6931
|
`使用动态签署人能力前,需登陆腾讯电子签控制台打开服务开关`
|
|
@@ -8044,6 +8168,15 @@ export interface EmbedUrlOption {
|
|
|
8044
8168
|
<li> <b>false</b> :(默认)不允许在模板预览页展示控件</li></ul>
|
|
8045
8169
|
*/
|
|
8046
8170
|
ShowTemplateComponent?: boolean
|
|
8171
|
+
/**
|
|
8172
|
+
* 跳过上传文件,默认为false(展示上传文件页)
|
|
8173
|
+
- false: 展示上传文件页
|
|
8174
|
+
- true: 不展示上传文件页
|
|
8175
|
+
|
|
8176
|
+
|
|
8177
|
+
注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**,
|
|
8178
|
+
*/
|
|
8179
|
+
SkipUploadFile?: string
|
|
8047
8180
|
}
|
|
8048
8181
|
|
|
8049
8182
|
/**
|
|
@@ -8363,7 +8496,10 @@ export interface ChannelCreateFlowApproversRequest {
|
|
|
8363
8496
|
*/
|
|
8364
8497
|
Approvers: Array<FillApproverInfo>
|
|
8365
8498
|
/**
|
|
8366
|
-
* 合同流程ID,为32位字符串。
|
|
8499
|
+
* 合同流程ID,为32位字符串。
|
|
8500
|
+
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
8501
|
+
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
8502
|
+
- <font color="red">不建议继续使用</font>,请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId指定合同
|
|
8367
8503
|
*/
|
|
8368
8504
|
FlowId?: string
|
|
8369
8505
|
/**
|
|
@@ -8500,11 +8636,17 @@ export interface ChannelCreateEmbedWebUrlRequest {
|
|
|
8500
8636
|
/**
|
|
8501
8637
|
* WEB嵌入的业务资源ID
|
|
8502
8638
|
|
|
8639
|
+
当EmbedType取值
|
|
8503
8640
|
<ul>
|
|
8504
|
-
<li
|
|
8505
|
-
<li
|
|
8506
|
-
<li
|
|
8641
|
+
<li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE必填,取值为模板id</li>
|
|
8642
|
+
<li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li>
|
|
8643
|
+
<li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL必填,取值为合同id</li>
|
|
8644
|
+
<li>为PREVIEW_SEAL_DETAIL必填,取值为印章id</li>
|
|
8507
8645
|
</ul>
|
|
8646
|
+
|
|
8647
|
+
|
|
8648
|
+
注意:
|
|
8649
|
+
1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口[创建文件转换任务](https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi) 来进行转换成PDF资源。
|
|
8508
8650
|
*/
|
|
8509
8651
|
BusinessId?: string
|
|
8510
8652
|
/**
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDescribeSignFaceVideoRequest, ChannelDisableUserAutoSignResponse, DescribeExtendedServiceAuthDetailResponse, CreateLegalSealQrCodeResponse, DescribeCancelFlowsTaskResponse, CreateEmployeeQualificationSealQrCodeResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, CreateBatchInitOrganizationUrlResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelDescribeSignFaceVideoResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, CreateFlowGroupSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, CreateChannelSubOrganizationActiveRequest, ChannelRenewAutoSignLicenseResponse, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, DescribeBatchOrganizationRegistrationUrlsRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, CreateBatchOrganizationRegistrationTasksResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeExtendedServiceAuthDetailRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, CreateLegalSealQrCodeRequest, CreatePersonAuthCertificateImageResponse, CreateEmployeeQualificationSealQrCodeRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeChannelSealPolicyWorkflowUrlRequest, CreatePartnerAutoSignAuthUrlResponse, ModifyFlowDeadlineResponse, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, CreateFlowBlockchainEvidenceUrlResponse, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, DescribeChannelOrganizationsRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelRenewAutoSignLicenseRequest, ChannelDescribeBillUsageDetailResponse, CreatePersonAuthCertificateImageRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, CreateBatchOrganizationRegistrationTasksRequest, ChannelCreateBatchQuickSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, ChannelCreateBatchCancelFlowUrlRequest, ChannelDescribeAccountBillDetailResponse, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, CreateChannelSubOrganizationActiveResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeCancelFlowsTaskRequest, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ModifyFlowDeadlineRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, CreateBatchInitOrganizationUrlRequest, CreateFlowGroupSignReviewRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, DescribeBatchOrganizationRegistrationUrlsResponse, UploadFilesRequest, CreateSealByImageRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeAccountBillDetailRequest, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateFlowBlockchainEvidenceUrlRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest, PrepareFlowsRequest } from "./essbasic_models";
|
|
2
|
+
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDescribeSignFaceVideoRequest, ChannelDisableUserAutoSignResponse, DescribeExtendedServiceAuthDetailResponse, CreateLegalSealQrCodeResponse, DescribeCancelFlowsTaskResponse, CreateEmployeeQualificationSealQrCodeResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, CreateBatchInitOrganizationUrlResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelDescribeSignFaceVideoResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, CreateFlowGroupSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, CreateChannelSubOrganizationActiveRequest, ChannelRenewAutoSignLicenseResponse, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, DescribeBatchOrganizationRegistrationUrlsRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, CreateBatchOrganizationRegistrationTasksResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DeleteOrganizationAuthorizationsResponse, DescribeExtendedServiceAuthDetailRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, CreateLegalSealQrCodeRequest, CreateCloseOrganizationUrlRequest, CreatePersonAuthCertificateImageResponse, CreateEmployeeQualificationSealQrCodeRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, CreateCloseOrganizationUrlResponse, DescribeChannelSealPolicyWorkflowUrlRequest, CreatePartnerAutoSignAuthUrlResponse, ModifyFlowDeadlineResponse, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, CreateFlowBlockchainEvidenceUrlResponse, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, DescribeChannelOrganizationsRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelRenewAutoSignLicenseRequest, ChannelDescribeBillUsageDetailResponse, CreatePersonAuthCertificateImageRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, CreateBatchOrganizationRegistrationTasksRequest, ChannelCreateBatchQuickSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, ChannelCreateBatchCancelFlowUrlRequest, ChannelDescribeAccountBillDetailResponse, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, CreateChannelSubOrganizationActiveResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, DeleteOrganizationAuthorizationsRequest, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeCancelFlowsTaskRequest, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ModifyFlowDeadlineRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, CreateBatchInitOrganizationUrlRequest, CreateFlowGroupSignReviewRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, DescribeBatchOrganizationRegistrationUrlsResponse, UploadFilesRequest, CreateSealByImageRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeAccountBillDetailRequest, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateFlowBlockchainEvidenceUrlRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest, PrepareFlowsRequest } from "./essbasic_models";
|
|
3
3
|
/**
|
|
4
4
|
* essbasic client
|
|
5
5
|
* @class
|
|
@@ -597,9 +597,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
597
597
|
* 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
|
|
598
598
|
前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
|
|
599
599
|
|
|
600
|
-
适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源
|
|
600
|
+
适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源ID。<br />
|
|
601
601
|
注:
|
|
602
|
-
1.
|
|
602
|
+
1. `大文件转换所需的时间可能会比较长。`
|
|
603
|
+
2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`
|
|
603
604
|
*/
|
|
604
605
|
ChannelGetTaskResultApi(req: ChannelGetTaskResultApiRequest, cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void): Promise<ChannelGetTaskResultApiResponse>;
|
|
605
606
|
/**
|
|
@@ -710,7 +711,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
710
711
|
ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
|
|
711
712
|
/**
|
|
712
713
|
* 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
|
|
713
|
-
|
|
714
|
+
解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。具体用法可以参考文档[合同解除](https://qian.tencent.com/developers/partner/flow_release)。
|
|
714
715
|
|
|
715
716
|
注意:
|
|
716
717
|
<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
|
|
@@ -729,6 +730,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
729
730
|
**注**:通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganizationOperators" target="_blank">企业员工新增或离职</a>接口增加的新员工或者离职的员工也会在列表中。
|
|
730
731
|
*/
|
|
731
732
|
ChannelDescribeEmployees(req: ChannelDescribeEmployeesRequest, cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void): Promise<ChannelDescribeEmployeesResponse>;
|
|
733
|
+
/**
|
|
734
|
+
* 创建企业注销链接
|
|
735
|
+
|
|
736
|
+
系统将返回操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成企业的注销操作。
|
|
737
|
+
|
|
738
|
+
注意: `在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人。`
|
|
739
|
+
*/
|
|
740
|
+
CreateCloseOrganizationUrl(req: CreateCloseOrganizationUrlRequest, cb?: (error: string, rep: CreateCloseOrganizationUrlResponse) => void): Promise<CreateCloseOrganizationUrlResponse>;
|
|
732
741
|
/**
|
|
733
742
|
* 通过合同编号批量撤销合同,单次最多支持撤销100份合同。
|
|
734
743
|
|
|
@@ -786,10 +795,25 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
786
795
|
*/
|
|
787
796
|
GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
|
|
788
797
|
/**
|
|
789
|
-
*
|
|
798
|
+
* **适用场景**:
|
|
790
799
|
当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口动态补充签署人。同一签署人只允许补充一人,最终实际签署人取决于谁先领取合同完成签署。
|
|
791
800
|
|
|
792
|
-
|
|
801
|
+
**接口使用说明**:
|
|
802
|
+
|
|
803
|
+
1.本接口现已支持批量补充签署人
|
|
804
|
+
|
|
805
|
+
2.当<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中指定需要补充的FlowId时,可以对指定合同补充签署人;可以指定多个相同发起方的不同合同在完成批量补充
|
|
806
|
+
|
|
807
|
+
3.当<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中指定需要补充的FlowId时,是对指定的合同补充多个指定的签署人
|
|
808
|
+
|
|
809
|
+
4.如果同时指定了<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId和<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId,仅使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId作为补充的合同
|
|
810
|
+
|
|
811
|
+
5.如果部分指定了<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId,又指定了<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId;那么<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>存在指定的FlowId,则使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId,不存在则使用<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId作为补充的合同
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
6.如果同时未指定了<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId和<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId,则传参错误
|
|
815
|
+
|
|
816
|
+
**限制条件**:
|
|
793
817
|
1. 本企业(发起方企业)企业签署人仅支持通过企业名称+姓名+手机号进行补充。
|
|
794
818
|
2. 个人签署人支持通过姓名+手机号进行补充,补充动态签署人时:若个人用户已完成实名,则可通过姓名+证件号码进行补充。
|
|
795
819
|
*/
|
|
@@ -828,10 +852,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
828
852
|
*/
|
|
829
853
|
ChannelCreateRole(req: ChannelCreateRoleRequest, cb?: (error: string, rep: ChannelCreateRoleResponse) => void): Promise<ChannelCreateRoleResponse>;
|
|
830
854
|
/**
|
|
831
|
-
* 获取合同流程PDF
|
|
855
|
+
* 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同。
|
|
832
856
|
|
|
833
|
-
|
|
834
|
-
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
### 1. 确保合同的PDF已经合成后,再调用本接口。
|
|
861
|
+
用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。
|
|
862
|
+
|
|
863
|
+
**第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。
|
|
864
|
+
**第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo)接口来主动检查合同的签署状态。请仅在确认合同状态为“全部签署完成”后,进行文件的下载操作。
|
|
865
|
+
|
|
866
|
+
### 2. 有两种开通下载权限的途径。
|
|
835
867
|
|
|
836
868
|
**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图。
|
|
837
869
|
授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
|
|
@@ -1201,6 +1233,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
1201
1233
|
注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
1202
1234
|
*/
|
|
1203
1235
|
ChannelCreateUserAutoSignEnableUrl(req: ChannelCreateUserAutoSignEnableUrlRequest, cb?: (error: string, rep: ChannelCreateUserAutoSignEnableUrlResponse) => void): Promise<ChannelCreateUserAutoSignEnableUrlResponse>;
|
|
1236
|
+
/**
|
|
1237
|
+
* 批量清理未认证的企业认证流程。
|
|
1238
|
+
|
|
1239
|
+
此接口用来清除企业方认证信息填写错误,批量清理认证中的认证流信息。
|
|
1240
|
+
为接口[提交子企业批量认证链接创建任务](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks) 和[查询子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls) 接口的扩展接口。即在批量认证过程中,当发起认证企业发现超管信息错误的时候,可以将当前超管下的所有认证流企业清除。
|
|
1241
|
+
|
|
1242
|
+
注意:
|
|
1243
|
+
**这个接口的操作人必须跟生成批量认证链接接口的应用号一致,才可以调用,否则会返回当前操作人没有认证中的企业认证流**
|
|
1244
|
+
*/
|
|
1245
|
+
DeleteOrganizationAuthorizations(req: DeleteOrganizationAuthorizationsRequest, cb?: (error: string, rep: DeleteOrganizationAuthorizationsResponse) => void): Promise<DeleteOrganizationAuthorizationsResponse>;
|
|
1204
1246
|
/**
|
|
1205
1247
|
* 用于获取合同中填写控件填写状态和填写的内容。
|
|
1206
1248
|
|
|
@@ -692,9 +692,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
692
692
|
* 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
|
|
693
693
|
前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
|
|
694
694
|
|
|
695
|
-
适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源
|
|
695
|
+
适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源ID。<br />
|
|
696
696
|
注:
|
|
697
|
-
1.
|
|
697
|
+
1. `大文件转换所需的时间可能会比较长。`
|
|
698
|
+
2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`
|
|
698
699
|
*/
|
|
699
700
|
async ChannelGetTaskResultApi(req, cb) {
|
|
700
701
|
return this.request("ChannelGetTaskResultApi", req, cb);
|
|
@@ -827,7 +828,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
827
828
|
}
|
|
828
829
|
/**
|
|
829
830
|
* 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
|
|
830
|
-
|
|
831
|
+
解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。具体用法可以参考文档[合同解除](https://qian.tencent.com/developers/partner/flow_release)。
|
|
831
832
|
|
|
832
833
|
注意:
|
|
833
834
|
<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
|
|
@@ -850,6 +851,16 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
850
851
|
async ChannelDescribeEmployees(req, cb) {
|
|
851
852
|
return this.request("ChannelDescribeEmployees", req, cb);
|
|
852
853
|
}
|
|
854
|
+
/**
|
|
855
|
+
* 创建企业注销链接
|
|
856
|
+
|
|
857
|
+
系统将返回操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成企业的注销操作。
|
|
858
|
+
|
|
859
|
+
注意: `在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人。`
|
|
860
|
+
*/
|
|
861
|
+
async CreateCloseOrganizationUrl(req, cb) {
|
|
862
|
+
return this.request("CreateCloseOrganizationUrl", req, cb);
|
|
863
|
+
}
|
|
853
864
|
/**
|
|
854
865
|
* 通过合同编号批量撤销合同,单次最多支持撤销100份合同。
|
|
855
866
|
|
|
@@ -915,10 +926,25 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
915
926
|
return this.request("GetDownloadFlowUrl", req, cb);
|
|
916
927
|
}
|
|
917
928
|
/**
|
|
918
|
-
*
|
|
929
|
+
* **适用场景**:
|
|
919
930
|
当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口动态补充签署人。同一签署人只允许补充一人,最终实际签署人取决于谁先领取合同完成签署。
|
|
920
931
|
|
|
921
|
-
|
|
932
|
+
**接口使用说明**:
|
|
933
|
+
|
|
934
|
+
1.本接口现已支持批量补充签署人
|
|
935
|
+
|
|
936
|
+
2.当<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中指定需要补充的FlowId时,可以对指定合同补充签署人;可以指定多个相同发起方的不同合同在完成批量补充
|
|
937
|
+
|
|
938
|
+
3.当<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中指定需要补充的FlowId时,是对指定的合同补充多个指定的签署人
|
|
939
|
+
|
|
940
|
+
4.如果同时指定了<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId和<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId,仅使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId作为补充的合同
|
|
941
|
+
|
|
942
|
+
5.如果部分指定了<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId,又指定了<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId;那么<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>存在指定的FlowId,则使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId,不存在则使用<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId作为补充的合同
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
6.如果同时未指定了<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId和<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId,则传参错误
|
|
946
|
+
|
|
947
|
+
**限制条件**:
|
|
922
948
|
1. 本企业(发起方企业)企业签署人仅支持通过企业名称+姓名+手机号进行补充。
|
|
923
949
|
2. 个人签署人支持通过姓名+手机号进行补充,补充动态签署人时:若个人用户已完成实名,则可通过姓名+证件号码进行补充。
|
|
924
950
|
*/
|
|
@@ -965,10 +991,18 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
965
991
|
return this.request("ChannelCreateRole", req, cb);
|
|
966
992
|
}
|
|
967
993
|
/**
|
|
968
|
-
* 获取合同流程PDF
|
|
994
|
+
* 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同。
|
|
969
995
|
|
|
970
|
-
|
|
971
|
-
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
### 1. 确保合同的PDF已经合成后,再调用本接口。
|
|
1000
|
+
用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。
|
|
1001
|
+
|
|
1002
|
+
**第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。
|
|
1003
|
+
**第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo)接口来主动检查合同的签署状态。请仅在确认合同状态为“全部签署完成”后,进行文件的下载操作。
|
|
1004
|
+
|
|
1005
|
+
### 2. 有两种开通下载权限的途径。
|
|
972
1006
|
|
|
973
1007
|
**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图。
|
|
974
1008
|
授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
|
|
@@ -1380,6 +1414,18 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
1380
1414
|
async ChannelCreateUserAutoSignEnableUrl(req, cb) {
|
|
1381
1415
|
return this.request("ChannelCreateUserAutoSignEnableUrl", req, cb);
|
|
1382
1416
|
}
|
|
1417
|
+
/**
|
|
1418
|
+
* 批量清理未认证的企业认证流程。
|
|
1419
|
+
|
|
1420
|
+
此接口用来清除企业方认证信息填写错误,批量清理认证中的认证流信息。
|
|
1421
|
+
为接口[提交子企业批量认证链接创建任务](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks) 和[查询子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls) 接口的扩展接口。即在批量认证过程中,当发起认证企业发现超管信息错误的时候,可以将当前超管下的所有认证流企业清除。
|
|
1422
|
+
|
|
1423
|
+
注意:
|
|
1424
|
+
**这个接口的操作人必须跟生成批量认证链接接口的应用号一致,才可以调用,否则会返回当前操作人没有认证中的企业认证流**
|
|
1425
|
+
*/
|
|
1426
|
+
async DeleteOrganizationAuthorizations(req, cb) {
|
|
1427
|
+
return this.request("DeleteOrganizationAuthorizations", req, cb);
|
|
1428
|
+
}
|
|
1383
1429
|
/**
|
|
1384
1430
|
* 用于获取合同中填写控件填写状态和填写的内容。
|
|
1385
1431
|
|