tencentcloud-sdk-nodejs-essbasic 4.0.726 → 4.0.729

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.
@@ -963,7 +963,15 @@ export interface ChannelCreateRoleRequest {
963
963
  */
964
964
  Name: string
965
965
  /**
966
- * 代理企业和员工的信息。
966
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
967
+
968
+ 此接口下面信息必填。
969
+ <ul>
970
+ <li>渠道应用标识: Agent.AppId</li>
971
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
972
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
973
+ </ul>
974
+ 第三方平台子客企业和员工必须已经经过实名认证
967
975
  */
968
976
  Agent: Agent
969
977
  /**
@@ -1820,7 +1828,14 @@ export interface ChannelCreateFlowGroupByFilesRequest {
1820
1828
  */
1821
1829
  export interface ChannelCreateOrganizationModifyQrCodeRequest {
1822
1830
  /**
1823
- * 应用相关信息。 此接口Agent.AppId 必填。
1831
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1832
+
1833
+ 此接口下面信息必填。
1834
+
1835
+ 渠道应用标识: Agent.AppId
1836
+ 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
1837
+ 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
1838
+ 第三方平台子客企业和员工必须已经经过实名认证
1824
1839
  */
1825
1840
  Agent: Agent
1826
1841
  }
@@ -1885,22 +1900,26 @@ export interface DescribeFlowDetailInfoResponse {
1885
1900
  */
1886
1901
  export interface RecipientComponentInfo {
1887
1902
  /**
1888
- * 参与方Id
1889
- 注意:此字段可能返回 null,表示取不到有效值。
1903
+ * 参与方的角色ID
1890
1904
  */
1891
1905
  RecipientId?: string
1892
1906
  /**
1893
1907
  * 参与方填写状态
1894
- 注意:此字段可能返回 null,表示取不到有效值。
1908
+
1909
+ <ul><li> **0** : 还没有填写</li>
1910
+ <li> **1** : 已经填写</li></ul>
1895
1911
  */
1896
1912
  RecipientFillStatus?: string
1897
1913
  /**
1898
- * 是否发起方
1914
+ * 此角色是否是发起方角色
1915
+
1916
+ <ul><li> **true** : 是发起方角色</li>
1917
+ <li> **false** : 不是发起方角色</li></ul>
1899
1918
  注意:此字段可能返回 null,表示取不到有效值。
1900
1919
  */
1901
1920
  IsPromoter?: boolean
1902
1921
  /**
1903
- * 填写控件内容
1922
+ * 此角色的填写控件列表
1904
1923
  注意:此字段可能返回 null,表示取不到有效值。
1905
1924
  */
1906
1925
  Components?: Array<FilledComponent>
@@ -1911,7 +1930,15 @@ export interface RecipientComponentInfo {
1911
1930
  */
1912
1931
  export interface ChannelDescribeRolesRequest {
1913
1932
  /**
1914
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1933
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1934
+
1935
+ 此接口下面信息必填。
1936
+ <ul>
1937
+ <li>渠道应用标识: Agent.AppId</li>
1938
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1939
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1940
+ </ul>
1941
+ 第三方平台子客企业和员工必须已经经过实名认证
1915
1942
  */
1916
1943
  Agent: Agent
1917
1944
  /**
@@ -1950,6 +1977,50 @@ export interface PrepareFlowsResponse {
1950
1977
  RequestId?: string
1951
1978
  }
1952
1979
 
1980
+ /**
1981
+ * ChannelCancelFlow请求参数结构体
1982
+ */
1983
+ export interface ChannelCancelFlowRequest {
1984
+ /**
1985
+ * 要撤销的合同流程ID
1986
+ */
1987
+ FlowId: string
1988
+ /**
1989
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1990
+
1991
+ 此接口下面信息必填。
1992
+ <ul>
1993
+ <li>渠道应用标识: Agent.AppId</li>
1994
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1995
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1996
+ </ul>
1997
+ 第三方平台子客企业和员工必须已经经过实名认证
1998
+ */
1999
+ Agent?: Agent
2000
+ /**
2001
+ * 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
2002
+ */
2003
+ CancelMessage?: string
2004
+ /**
2005
+ * 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
2006
+
2007
+ **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
2008
+ **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
2009
+ **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
2010
+ **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
2011
+
2012
+ 注: `CancelMessage为撤销当前合同的理由`
2013
+
2014
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
2015
+ */
2016
+ CancelMessageFormat?: number
2017
+ /**
2018
+ * 暂未开放
2019
+ * @deprecated
2020
+ */
2021
+ Operator?: UserInfo
2022
+ }
2023
+
1953
2024
  /**
1954
2025
  * 此结构体 (TemplateInfo) 用于描述模板的信息。
1955
2026
 
@@ -2107,7 +2178,6 @@ export interface ChannelRole {
2107
2178
  RoleName?: string
2108
2179
  /**
2109
2180
  * 角色状态:1-启用;2-禁用
2110
- 注意:此字段可能返回 null,表示取不到有效值。
2111
2181
  */
2112
2182
  RoleStatus?: number
2113
2183
  /**
@@ -2314,6 +2384,61 @@ export interface CreateChannelFlowEvidenceReportRequest {
2314
2384
  Operator?: UserInfo
2315
2385
  }
2316
2386
 
2387
+ /**
2388
+ * ChannelDescribeBillUsageDetail请求参数结构体
2389
+ */
2390
+ export interface ChannelDescribeBillUsageDetailRequest {
2391
+ /**
2392
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2393
+
2394
+ 此接口下面信息必填。
2395
+ <ul>
2396
+ <li>渠道应用标识: Agent.AppId</li>
2397
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2398
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2399
+ </ul>
2400
+ 第三方平台子客企业和员工必须已经经过实名认证
2401
+ */
2402
+ Agent: Agent
2403
+ /**
2404
+ * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
2405
+ */
2406
+ StartTime: string
2407
+ /**
2408
+ * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
2409
+ */
2410
+ EndTime: string
2411
+ /**
2412
+ * 查询的套餐类型 (选填 )不传则查询所有套餐;
2413
+ 目前支持:
2414
+ <ul>
2415
+ <li>**CloudEnterprise**: 企业版合同</li>
2416
+ <li>**SingleSignature**: 单方签章</li>
2417
+ <li>**CloudProve**: 签署报告</li>
2418
+ <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
2419
+ <li>**ChannelWeCard**: 微工卡</li>
2420
+ <li>**SignFlow**: 合同套餐</li>
2421
+ <li>**SignFace**: 签署意愿(人脸识别)</li>
2422
+ <li>**SignPassword**: 签署意愿(密码)</li>
2423
+ <li>**SignSMS**: 签署意愿(短信)</li>
2424
+ <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
2425
+ <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
2426
+ <li>**OrgEssAuth**: 签署企业实名</li>
2427
+ <li>**FlowNotify**: 短信通知</li>
2428
+ <li>**AuthService**: 企业工商信息查询</li>
2429
+ </ul>
2430
+ */
2431
+ QuotaType?: string
2432
+ /**
2433
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
2434
+ */
2435
+ Offset?: number
2436
+ /**
2437
+ * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
2438
+ */
2439
+ Limit?: number
2440
+ }
2441
+
2317
2442
  /**
2318
2443
  * ChannelCancelUserAutoSignEnableUrl请求参数结构体
2319
2444
  */
@@ -3112,14 +3237,15 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
3112
3237
 
3113
3238
  此接口下面信息必填。
3114
3239
  <ul>
3115
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
3116
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
3117
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
3240
+ <li>渠道应用标识: Agent.AppId</li>
3241
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3242
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3118
3243
  </ul>
3244
+ 第三方平台子客企业和员工必须已经经过实名认证
3119
3245
  */
3120
3246
  Agent: Agent
3121
3247
  /**
3122
- * 二维码ID,为32位字符串。
3248
+ * 需要取消签署的二维码ID,为32位字符串。由[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
3123
3249
  */
3124
3250
  QrCodeId: string
3125
3251
  /**
@@ -3188,30 +3314,43 @@ LEGAL_PERSON_SEAL:法定代表人章
3188
3314
  */
3189
3315
  export interface DescribeUsageRequest {
3190
3316
  /**
3191
- * 应用信息,此接口Agent.AppId必填
3317
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3318
+
3319
+ 此接口下面信息必填。
3320
+ <ul>
3321
+ <li>渠道应用标识: Agent.AppId</li>
3322
+ </ul>
3192
3323
  */
3193
3324
  Agent: Agent
3194
3325
  /**
3195
- * 开始时间,例如:2021-03-21
3326
+ * 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-03-21)
3327
+
3328
+ 注: `查询日期范围区间长度大于90天`。
3196
3329
  */
3197
3330
  StartDate: string
3198
3331
  /**
3199
- * 结束时间,例如:2021-06-21
3200
- 开始时间到结束时间的区间长度小于等于90天。
3332
+ * 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-04-21)
3333
+
3334
+ 注: `查询日期范围区间长度大于90天`。
3201
3335
  */
3202
3336
  EndDate: string
3203
3337
  /**
3204
3338
  * 是否汇总数据,默认不汇总。
3205
- 不汇总:返回在统计区间内第三方平台下所有企业的每日明细,即每个企业N条数据,N为统计天数;
3206
- 汇总:返回在统计区间内第三方平台下所有企业的汇总后数据,即每个企业一条数据;
3339
+ <ul><li> **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加</li>
3340
+ <li> **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)</li></ul>
3341
+
3207
3342
  */
3208
3343
  NeedAggregate?: boolean
3209
3344
  /**
3210
- * 单次返回的最多条目数量。默认为1000,且不能超过1000。
3345
+ * 指定每页返回的数据条数,和Offset参数配合使用。
3346
+
3347
+ 注: `默认值为1000,单页做大值为1000`
3211
3348
  */
3212
3349
  Limit?: number
3213
3350
  /**
3214
- * 偏移量,默认是0。
3351
+ * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
3352
+
3353
+ 注:`offset从0开始,即第一页为0。`
3215
3354
  */
3216
3355
  Offset?: number
3217
3356
  /**
@@ -3845,12 +3984,19 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
3845
3984
  */
3846
3985
  export interface ChannelCreateBoundFlowsRequest {
3847
3986
  /**
3848
- * 应用信息
3849
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
3987
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3988
+
3989
+ 此接口下面信息必填。
3990
+ <ul>
3991
+ <li>渠道应用标识: Agent.AppId</li>
3992
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3993
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3994
+ </ul>
3995
+ 第三方平台子客企业和员工必须已经经过实名认证, 合同会领取给对应的Agent.ProxyOperator.OpenId指定的员工来处理
3850
3996
  */
3851
3997
  Agent: Agent
3852
3998
  /**
3853
- * 领取的合同id列表
3999
+ * 需要领取的合同流程的ID列表
3854
4000
  */
3855
4001
  FlowIds?: Array<string>
3856
4002
  /**
@@ -4107,15 +4253,15 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
4107
4253
 
4108
4254
  此接口下面信息必填。
4109
4255
  <ul>
4110
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4111
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4112
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
4256
+ <li>渠道应用标识: Agent.AppId</li>
4257
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4258
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4113
4259
  </ul>
4260
+ 第三方平台子客企业和员工必须已经经过实名认证
4114
4261
  */
4115
4262
  Agent: Agent
4116
4263
  /**
4117
4264
  * 合同模板ID,为32位字符串。
4118
- 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
4119
4265
  */
4120
4266
  TemplateId: string
4121
4267
  /**
@@ -4166,7 +4312,9 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
4166
4312
  */
4167
4313
  export interface SignQrCode {
4168
4314
  /**
4169
- * 二维码ID,为32位字符串。
4315
+ * 二维码ID,为32位字符串。
4316
+
4317
+ 注: 需要保留此二维码ID, 用于后序通过<a href="https://qian.tencent.com/developers/partnerApis/templates/ChannelCancelMultiFlowSignQRCode" target="_blank">取消一码多扫二维码</a>关闭这个二维码的签署功能。
4170
4318
  */
4171
4319
  QrCodeId?: string
4172
4320
  /**
@@ -4174,7 +4322,8 @@ export interface SignQrCode {
4174
4322
  */
4175
4323
  QrCodeUrl?: string
4176
4324
  /**
4177
- * 二维码的有截止时间,格式为Unix标准时间戳(秒)。 一旦超过二维码的有效期限,该二维码将自动失效。
4325
+ * 二维码的有截止时间,格式为Unix标准时间戳(秒),可以通过入参的QrEffectiveDay来设置有效期,默认为7天有效期。
4326
+ 一旦超过二维码的有效期限,该二维码将自动失效。
4178
4327
  */
4179
4328
  ExpiredTime?: number
4180
4329
  }
@@ -4482,22 +4631,6 @@ export interface ChannelGetTaskResultApiRequest {
4482
4631
  Organization?: OrganizationInfo
4483
4632
  }
4484
4633
 
4485
- /**
4486
- * 批量补充签署人时,补充失败的报错说明
4487
- */
4488
- export interface FillError {
4489
- /**
4490
- * 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
4491
- 注意:此字段可能返回 null,表示取不到有效值。
4492
- */
4493
- RecipientId?: string
4494
- /**
4495
- * 补充失败错误说明
4496
- 注意:此字段可能返回 null,表示取不到有效值。
4497
- */
4498
- ErrMessage?: string
4499
- }
4500
-
4501
4634
  /**
4502
4635
  * ChannelCreatePreparedPersonalEsign请求参数结构体
4503
4636
  */
@@ -4561,6 +4694,40 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
4561
4694
  LicenseType?: number
4562
4695
  }
4563
4696
 
4697
+ /**
4698
+ * 批量补充签署人时,补充失败的报错说明
4699
+ */
4700
+ export interface FillError {
4701
+ /**
4702
+ * 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
4703
+ 注意:此字段可能返回 null,表示取不到有效值。
4704
+ */
4705
+ RecipientId?: string
4706
+ /**
4707
+ * 补充失败错误说明
4708
+ 注意:此字段可能返回 null,表示取不到有效值。
4709
+ */
4710
+ ErrMessage?: string
4711
+ }
4712
+
4713
+ /**
4714
+ * ChannelDescribeBillUsageDetail返回参数结构体
4715
+ */
4716
+ export interface ChannelDescribeBillUsageDetailResponse {
4717
+ /**
4718
+ * 返回查询记录总数
4719
+ */
4720
+ Total?: number
4721
+ /**
4722
+ * 消耗记录详情
4723
+ */
4724
+ Details?: Array<ChannelBillUsageDetail>
4725
+ /**
4726
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4727
+ */
4728
+ RequestId?: string
4729
+ }
4730
+
4564
4731
  /**
4565
4732
  * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
4566
4733
  */
@@ -4804,11 +4971,11 @@ export interface ExtentServiceAuthInfo {
4804
4971
  /**
4805
4972
  * 扩展服务类型
4806
4973
  <ul>
4807
- <li>AUTO_SIGN 企业自动签(自动签署)</li>
4974
+ <li>AUTO_SIGN 企业自动签(自动签署)</li>
4808
4975
  <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
4809
4976
  <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
4810
- <li> PAGING_SEAL 骑缝章</li>
4811
- <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
4977
+ <li> PAGING_SEAL 骑缝章</li>
4978
+ <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
4812
4979
  <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
4813
4980
  </ul>
4814
4981
  */
@@ -4818,7 +4985,9 @@ export interface ExtentServiceAuthInfo {
4818
4985
  */
4819
4986
  Name?: string
4820
4987
  /**
4821
- * 扩展服务的开通状态: ENABLE:开通 DISABLE:未开通
4988
+ * 扩展服务的开通状态
4989
+ **ENABLE**:开通
4990
+ **DISABLE**:未开通
4822
4991
  */
4823
4992
  Status?: string
4824
4993
  /**
@@ -4866,28 +5035,27 @@ export interface Filter {
4866
5035
  */
4867
5036
  export interface FilledComponent {
4868
5037
  /**
4869
- * 控件Id
4870
- 注意:此字段可能返回 null,表示取不到有效值。
5038
+ * 填写控件ID
4871
5039
  */
4872
5040
  ComponentId?: string
4873
5041
  /**
4874
5042
  * 控件名称
4875
- 注意:此字段可能返回 null,表示取不到有效值。
4876
5043
  */
4877
5044
  ComponentName?: string
4878
5045
  /**
4879
- * 控件填写状态;0-未填写;1-已填写
4880
- 注意:此字段可能返回 null,表示取不到有效值。
5046
+ * 此填写控件的填写状态
5047
+ **0** : 此填写控件**未填写**
5048
+ **1** : 此填写控件**已填写**
4881
5049
  */
4882
5050
  ComponentFillStatus?: string
4883
5051
  /**
4884
5052
  * 控件填写内容
4885
- 注意:此字段可能返回 null,表示取不到有效值。
4886
5053
  */
4887
5054
  ComponentValue?: string
4888
5055
  /**
4889
5056
  * 图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
4890
- 注意:此字段可能返回 null,表示取不到有效值。
5057
+
5058
+ 注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效`
4891
5059
  */
4892
5060
  ImageUrl?: string
4893
5061
  }
@@ -4931,7 +5099,15 @@ export interface CreateSignUrlsResponse {
4931
5099
  */
4932
5100
  export interface ChannelDeleteRoleRequest {
4933
5101
  /**
4934
- * 代理企业和员工的信息。
5102
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5103
+
5104
+ 此接口下面信息必填。
5105
+ <ul>
5106
+ <li>渠道应用标识: Agent.AppId</li>
5107
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5108
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
5109
+ </ul>
5110
+ 第三方平台子客企业和员工必须已经经过实名认证
4935
5111
  */
4936
5112
  Agent: Agent
4937
5113
  /**
@@ -5232,8 +5408,7 @@ export interface ChannelCreateReleaseFlowRequest {
5232
5408
  */
5233
5409
  export interface ChannelDescribeFlowComponentsResponse {
5234
5410
  /**
5235
- * 流程关联的填写控件信息,控件会按照参与方进行分类。
5236
- 注意:此字段可能返回 null,表示取不到有效值。
5411
+ * 合同填写控件信息列表,填写控件会按照参与方角色进行分类。
5237
5412
  */
5238
5413
  RecipientComponentInfos?: Array<RecipientComponentInfo>
5239
5414
  /**
@@ -5316,6 +5491,38 @@ export interface ApproverOption {
5316
5491
  FlowReadLimit?: string
5317
5492
  }
5318
5493
 
5494
+ /**
5495
+ * ChannelDescribeUserAutoSignStatus返回参数结构体
5496
+ */
5497
+ export interface ChannelDescribeUserAutoSignStatusResponse {
5498
+ /**
5499
+ * 查询用户是否已开通自动签
5500
+ */
5501
+ IsOpen?: boolean
5502
+ /**
5503
+ * 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
5504
+
5505
+ 值为unix时间戳,单位为秒。
5506
+ */
5507
+ LicenseFrom?: number
5508
+ /**
5509
+ * 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
5510
+
5511
+ 值为unix时间戳,单位为秒。
5512
+ */
5513
+ LicenseTo?: number
5514
+ /**
5515
+ * 设置用户开通自动签时是否绑定个人自动签账号许可。
5516
+
5517
+ <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
5518
+ */
5519
+ LicenseType?: number
5520
+ /**
5521
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5522
+ */
5523
+ RequestId?: string
5524
+ }
5525
+
5319
5526
  /**
5320
5527
  * 同步的员工的信息
5321
5528
  */
@@ -5803,47 +6010,85 @@ export interface SignUrl {
5803
6010
  }
5804
6011
 
5805
6012
  /**
5806
- * ChannelCancelFlow请求参数结构体
6013
+ * 用户计费使用情况详情
5807
6014
  */
5808
- export interface ChannelCancelFlowRequest {
6015
+ export interface ChannelBillUsageDetail {
5809
6016
  /**
5810
- * 要撤销的合同流程ID
6017
+ * 合同流程ID,为32位字符串。
5811
6018
  */
5812
- FlowId: string
6019
+ FlowId?: string
5813
6020
  /**
5814
- * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5815
-
5816
- 此接口下面信息必填。
6021
+ * 合同经办人名称
6022
+ 如果有多个经办人用分号隔开。
6023
+ */
6024
+ OperatorName?: string
6025
+ /**
6026
+ * 发起方组织机构名称
6027
+ */
6028
+ CreateOrganizationName?: string
6029
+ /**
6030
+ * 合同流程的名称。
6031
+ */
6032
+ FlowName?: string
6033
+ /**
6034
+ * 合同流程当前的签署状态, 会存在下列的状态值
5817
6035
  <ul>
5818
- <li>渠道应用标识: Agent.AppId</li>
5819
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5820
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6036
+ <li>**INIT**: 合同创建</li>
6037
+ <li>**PART**: 合同签署中(至少有一个签署方已经签署)</li>
6038
+ <li>**REJECT**: 合同拒签</li>
6039
+ <li>**ALL**: 合同签署完成</li>
6040
+ <li>**DEADLINE**: 合同流签(合同过期)</li>
6041
+ <li>**CANCEL**: 合同撤回</li>
6042
+ <li>**RELIEVED**: 解除协议(已解除)</li>
6043
+ <li>**WILLEXPIRE**: 合同即将过期</li>
6044
+ <li>**EXCEPTION**: 合同异常</li>
5821
6045
  </ul>
5822
- 第三方平台子客企业和员工必须已经经过实名认证
5823
6046
  */
5824
- Agent?: Agent
6047
+ FlowStatus?: string
5825
6048
  /**
5826
- * 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
6049
+ * 查询的套餐类型
6050
+ 对应关系如下:
6051
+ <ul>
6052
+ <li>**CloudEnterprise**: 企业版合同</li>
6053
+ <li>**SingleSignature**: 单方签章</li>
6054
+ <li>**CloudProve**: 签署报告</li>
6055
+ <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
6056
+ <li>**ChannelWeCard**: 微工卡</li>
6057
+ <li>**SignFlow**: 合同套餐</li>
6058
+ <li>**SignFace**: 签署意愿(人脸识别)</li>
6059
+ <li>**SignPassword**: 签署意愿(密码)</li>
6060
+ <li>**SignSMS**: 签署意愿(短信)</li>
6061
+ <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
6062
+ <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
6063
+ <li>**OrgEssAuth**: 签署企业实名</li>
6064
+ <li>**FlowNotify**: 短信通知</li>
6065
+ <li>**AuthService**: 企业工商信息查询</li>
6066
+ </ul>
5827
6067
  */
5828
- CancelMessage?: string
6068
+ QuotaType?: string
5829
6069
  /**
5830
- * 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
5831
-
5832
- **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
5833
- **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
5834
- **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
5835
- **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
5836
-
5837
- 注: `CancelMessage为撤销当前合同的理由`
5838
-
5839
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
6070
+ * 合同使用量
6071
+ 注: `如果消耗类型是撤销返还,此值为负值代表返还的合同数量`
5840
6072
  */
5841
- CancelMessageFormat?: number
6073
+ UseCount?: number
5842
6074
  /**
5843
- * 暂未开放
5844
- * @deprecated
6075
+ * 消耗的时间戳,格式为Unix标准时间戳(秒)。
5845
6076
  */
5846
- Operator?: UserInfo
6077
+ CostTime?: number
6078
+ /**
6079
+ * 消耗的套餐名称
6080
+ */
6081
+ QuotaName?: string
6082
+ /**
6083
+ * 消耗类型
6084
+ **1**.扣费
6085
+ **2**.撤销返还
6086
+ */
6087
+ CostType?: number
6088
+ /**
6089
+ * 备注
6090
+ */
6091
+ Remark?: string
5847
6092
  }
5848
6093
 
5849
6094
  /**
@@ -6132,33 +6377,33 @@ export interface ChannelCreateOrganizationBatchSignUrlResponse {
6132
6377
  */
6133
6378
  export interface UsageDetail {
6134
6379
  /**
6135
- * 子客企业唯一标识
6380
+ * 子客企业标识
6136
6381
  */
6137
- ProxyOrganizationOpenId: string
6382
+ ProxyOrganizationOpenId?: string
6138
6383
  /**
6139
6384
  * 子客企业名
6140
6385
  注意:此字段可能返回 null,表示取不到有效值。
6141
6386
  */
6142
- ProxyOrganizationName: string
6387
+ ProxyOrganizationName?: string
6143
6388
  /**
6144
- * 日期,当需要汇总数据时日期为空
6389
+ * 对应的消耗日期, **如果是汇总数据则为1970-01-01**
6145
6390
  注意:此字段可能返回 null,表示取不到有效值。
6146
6391
  */
6147
- Date: string
6392
+ Date?: string
6148
6393
  /**
6149
- * 消耗数量
6394
+ * 消耗合同数量
6150
6395
  */
6151
- Usage: number
6396
+ Usage?: number
6152
6397
  /**
6153
- * 撤回数量
6398
+ * 撤回合同数量
6154
6399
  注意:此字段可能返回 null,表示取不到有效值。
6155
6400
  */
6156
- Cancel: number
6401
+ Cancel?: number
6157
6402
  /**
6158
6403
  * 消耗渠道
6159
6404
  注意:此字段可能返回 null,表示取不到有效值。
6160
6405
  */
6161
- FlowChannel: string
6406
+ FlowChannel?: string
6162
6407
  }
6163
6408
 
6164
6409
  /**
@@ -6315,38 +6560,6 @@ export interface ChannelDescribeEmployeesResponse {
6315
6560
  RequestId?: string
6316
6561
  }
6317
6562
 
6318
- /**
6319
- * ChannelCreateFlowApprovers请求参数结构体
6320
- */
6321
- export interface ChannelCreateFlowApproversRequest {
6322
- /**
6323
- * 渠道应用相关信息
6324
- */
6325
- Agent: Agent
6326
- /**
6327
- * 合同唯一编号
6328
- */
6329
- FlowId: string
6330
- /**
6331
- * 补充企业签署人信息。
6332
-
6333
- - 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
6334
-
6335
- - 如果不指定,则使用姓名和手机号进行补充。
6336
- */
6337
- Approvers: Array<FillApproverInfo>
6338
- /**
6339
- * 操作人信息
6340
- */
6341
- Operator?: UserInfo
6342
- /**
6343
- * 签署人信息补充方式
6344
-
6345
- <ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
6346
- */
6347
- FillApproverType?: number
6348
- }
6349
-
6350
6563
  /**
6351
6564
  * ChannelDeleteRole返回参数结构体
6352
6565
  */
@@ -6470,35 +6683,43 @@ export interface CreateSealByImageRequest {
6470
6683
  }
6471
6684
 
6472
6685
  /**
6473
- * ChannelDescribeUserAutoSignStatus返回参数结构体
6686
+ * ChannelCreateFlowApprovers请求参数结构体
6474
6687
  */
6475
- export interface ChannelDescribeUserAutoSignStatusResponse {
6688
+ export interface ChannelCreateFlowApproversRequest {
6476
6689
  /**
6477
- * 查询用户是否已开通自动签
6690
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6691
+
6692
+ 此接口下面信息必填。
6693
+ <ul>
6694
+ <li>渠道应用标识: Agent.AppId</li>
6695
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6696
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6697
+ </ul>
6698
+ 第三方平台子客企业和员工必须已经经过实名认证
6478
6699
  */
6479
- IsOpen?: boolean
6700
+ Agent: Agent
6480
6701
  /**
6481
- * 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
6482
-
6483
- 值为unix时间戳,单位为秒。
6702
+ * 合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
6484
6703
  */
6485
- LicenseFrom?: number
6704
+ FlowId: string
6486
6705
  /**
6487
- * 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
6706
+ * 补充企业签署人信息。
6488
6707
 
6489
- 值为unix时间戳,单位为秒。
6708
+ - 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
6709
+
6710
+ - 如果不指定,则使用姓名和手机号进行补充。
6490
6711
  */
6491
- LicenseTo?: number
6712
+ Approvers: Array<FillApproverInfo>
6492
6713
  /**
6493
- * 设置用户开通自动签时是否绑定个人自动签账号许可。
6494
-
6495
- <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
6714
+ * 操作人信息
6496
6715
  */
6497
- LicenseType?: number
6716
+ Operator?: UserInfo
6498
6717
  /**
6499
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6718
+ * 签署人信息补充方式
6719
+
6720
+ <ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
6500
6721
  */
6501
- RequestId?: string
6722
+ FillApproverType?: number
6502
6723
  }
6503
6724
 
6504
6725
  /**
@@ -6642,11 +6863,19 @@ export interface CcInfo {
6642
6863
  */
6643
6864
  export interface ChannelDescribeFlowComponentsRequest {
6644
6865
  /**
6645
- * 应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
6866
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6867
+
6868
+ 此接口下面信息必填。
6869
+ <ul>
6870
+ <li>渠道应用标识: Agent.AppId</li>
6871
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6872
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6873
+ </ul>
6874
+ 第三方平台子客企业和员工必须已经经过实名认证
6646
6875
  */
6647
6876
  Agent: Agent
6648
6877
  /**
6649
- * 电子签流程的Id
6878
+ * 需要获取填写控件填写内容的合同流程ID
6650
6879
  */
6651
6880
  FlowId: string
6652
6881
  }