tencentcloud-sdk-nodejs-essbasic 4.0.1038 → 4.0.1042

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.
@@ -364,21 +364,18 @@ export interface Component {
364
364
  /**
365
365
  * 填写控件在腾讯电子签小程序填写界面展示的提示信息,例如,在身份证号码填写控件中,提示信息可以设置成“请输入18位身份证号码”。
366
366
  注:`签署控件设置此字段无效`
367
- 注意:此字段可能返回 null,表示取不到有效值。
368
367
  */
369
368
  Placeholder?: string;
370
369
  /**
371
370
  * **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
372
371
  <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
373
372
  <li>true:锁定控件值,在页面编辑控件值</li></ul>
374
- 注意:此字段可能返回 null,表示取不到有效值。
375
373
  */
376
374
  LockComponentValue?: boolean;
377
375
  /**
378
376
  * **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
379
377
  <ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
380
378
  <li> <b>true</b> : 可以移动和删除控件</li></ul>
381
- 注意:此字段可能返回 null,表示取不到有效值。
382
379
  */
383
380
  ForbidMoveAndDelete?: boolean;
384
381
  }
@@ -513,12 +510,10 @@ export interface DescribeExtendedServiceAuthDetailResponse {
513
510
  export interface Department {
514
511
  /**
515
512
  * 部门id
516
- 注意:此字段可能返回 null,表示取不到有效值。
517
513
  */
518
514
  DepartmentId?: string;
519
515
  /**
520
516
  * 部门名称
521
- 注意:此字段可能返回 null,表示取不到有效值。
522
517
  */
523
518
  DepartmentName?: string;
524
519
  }
@@ -681,6 +676,25 @@ export interface AuthFailMessage {
681
676
  */
682
677
  Message?: string;
683
678
  }
679
+ /**
680
+ * CreateFlowForwards请求参数结构体
681
+ */
682
+ export interface CreateFlowForwardsRequest {
683
+ /**
684
+ * 合同对应参与方需要修改的目标经办人对应的OpenId。
685
+
686
+ 注意:`需要保证目标经办人已经加入企业且已实名`
687
+ */
688
+ TargetOpenId: string;
689
+ /**
690
+ * 企业签署方的合同及对应签署方
691
+ */
692
+ FlowForwardInfos: Array<FlowForwardInfo>;
693
+ /**
694
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
695
+ */
696
+ Agent: Agent;
697
+ }
684
698
  /**
685
699
  * DescribeFlowDetailInfo请求参数结构体
686
700
  */
@@ -803,17 +817,14 @@ export interface IntentionQuestionResult {
803
817
  * 视频base64(其中包含全程问题和回答音频,mp4格式)
804
818
 
805
819
  注:`需进行base64解码获取视频文件`
806
- 注意:此字段可能返回 null,表示取不到有效值。
807
820
  */
808
821
  Video?: string;
809
822
  /**
810
823
  * 和答案匹配结果列表
811
- 注意:此字段可能返回 null,表示取不到有效值。
812
824
  */
813
825
  ResultCode?: Array<string>;
814
826
  /**
815
827
  * 回答问题语音识别结果列表
816
- 注意:此字段可能返回 null,表示取不到有效值。
817
828
  */
818
829
  AsrResult?: Array<string>;
819
830
  }
@@ -823,32 +834,26 @@ export interface IntentionQuestionResult {
823
834
  export interface AuthInfoDetail {
824
835
  /**
825
836
  * 扩展服务类型,和入参一致
826
- 注意:此字段可能返回 null,表示取不到有效值。
827
837
  */
828
838
  Type?: string;
829
839
  /**
830
840
  * 扩展服务名称
831
- 注意:此字段可能返回 null,表示取不到有效值。
832
841
  */
833
842
  Name?: string;
834
843
  /**
835
844
  * 授权员工列表
836
- 注意:此字段可能返回 null,表示取不到有效值。
837
845
  */
838
846
  HasAuthUserList?: Array<HasAuthUser>;
839
847
  /**
840
848
  * 授权企业列表(企业自动签时,该字段有值)
841
- 注意:此字段可能返回 null,表示取不到有效值。
842
849
  */
843
850
  HasAuthOrganizationList?: Array<HasAuthOrganization>;
844
851
  /**
845
852
  * 授权员工列表总数
846
- 注意:此字段可能返回 null,表示取不到有效值。
847
853
  */
848
854
  AuthUserTotal?: number;
849
855
  /**
850
856
  * 授权企业列表总数
851
- 注意:此字段可能返回 null,表示取不到有效值。
852
857
  */
853
858
  AuthOrganizationTotal?: number;
854
859
  }
@@ -907,7 +912,6 @@ export interface HasAuthUser {
907
912
  * 第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。
908
913
 
909
914
 
910
- 注意:此字段可能返回 null,表示取不到有效值。
911
915
  */
912
916
  OpenId?: string;
913
917
  }
@@ -994,7 +998,6 @@ export interface DetectInfoVideoData {
994
998
  * 活体视频的base64编码,mp4格式
995
999
 
996
1000
  注:`需进行base64解码获取活体视频文件`
997
- 注意:此字段可能返回 null,表示取不到有效值。
998
1001
  */
999
1002
  LiveNessVideo?: string;
1000
1003
  }
@@ -1742,7 +1745,6 @@ export interface FlowApproverUrlInfo {
1742
1745
  1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1743
1746
  2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1744
1747
  3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1745
- 注意:此字段可能返回 null,表示取不到有效值。
1746
1748
  */
1747
1749
  LongUrl?: string;
1748
1750
  }
@@ -2073,57 +2075,46 @@ export interface UploadFilesResponse {
2073
2075
  export interface Permission {
2074
2076
  /**
2075
2077
  * 权限名称
2076
- 注意:此字段可能返回 null,表示取不到有效值。
2077
2078
  */
2078
2079
  Name?: string;
2079
2080
  /**
2080
2081
  * 权限key
2081
- 注意:此字段可能返回 null,表示取不到有效值。
2082
2082
  */
2083
2083
  Key?: string;
2084
2084
  /**
2085
2085
  * 权限类型 1前端,2后端
2086
- 注意:此字段可能返回 null,表示取不到有效值。
2087
2086
  */
2088
2087
  Type?: number;
2089
2088
  /**
2090
2089
  * 是否隐藏
2091
- 注意:此字段可能返回 null,表示取不到有效值。
2092
2090
  */
2093
2091
  Hide?: number;
2094
2092
  /**
2095
2093
  * 数据权限标签 1:表示根节点,2:表示叶子结点
2096
- 注意:此字段可能返回 null,表示取不到有效值。
2097
2094
  */
2098
2095
  DataLabel?: number;
2099
2096
  /**
2100
2097
  * 数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权
2101
- 注意:此字段可能返回 null,表示取不到有效值。
2102
2098
  */
2103
2099
  DataType?: number;
2104
2100
  /**
2105
2101
  * 数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己
2106
- 注意:此字段可能返回 null,表示取不到有效值。
2107
2102
  */
2108
2103
  DataRange?: number;
2109
2104
  /**
2110
2105
  * 关联权限, 表示这个功能权限要受哪个数据权限管控
2111
- 注意:此字段可能返回 null,表示取不到有效值。
2112
2106
  */
2113
2107
  DataTo?: string;
2114
2108
  /**
2115
2109
  * 父级权限key
2116
- 注意:此字段可能返回 null,表示取不到有效值。
2117
2110
  */
2118
2111
  ParentKey?: string;
2119
2112
  /**
2120
2113
  * 是否选中
2121
- 注意:此字段可能返回 null,表示取不到有效值。
2122
2114
  */
2123
2115
  IsChecked?: boolean;
2124
2116
  /**
2125
2117
  * 子权限集合
2126
- 注意:此字段可能返回 null,表示取不到有效值。
2127
2118
  */
2128
2119
  Children?: Array<Permission>;
2129
2120
  }
@@ -2184,7 +2175,6 @@ export interface FlowApproverDetail {
2184
2175
  ReceiptId?: string;
2185
2176
  /**
2186
2177
  * 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
2187
- 注意:此字段可能返回 null,表示取不到有效值。
2188
2178
  */
2189
2179
  ProxyOrganizationOpenId?: string;
2190
2180
  /**
@@ -2206,7 +2196,6 @@ export interface FlowApproverDetail {
2206
2196
  /**
2207
2197
  * 签署方经办人的姓名。
2208
2198
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2209
- 注意:此字段可能返回 null,表示取不到有效值。
2210
2199
  */
2211
2200
  ApproveName?: string;
2212
2201
  /**
@@ -2223,12 +2212,10 @@ export interface FlowApproverDetail {
2223
2212
  <li> **FORWARD** :已经转他人处理</li>
2224
2213
  <li> **STOP** :流程已终止</li>
2225
2214
  <li> **RELIEVED** :解除协议(已解除)</li></ul>
2226
- 注意:此字段可能返回 null,表示取不到有效值。
2227
2215
  */
2228
2216
  ApproveStatus?: string;
2229
2217
  /**
2230
2218
  * 签署人拒签等情况的时候填写的原因
2231
- 注意:此字段可能返回 null,表示取不到有效值。
2232
2219
  */
2233
2220
  ApproveMessage?: string;
2234
2221
  /**
@@ -2239,17 +2226,14 @@ export interface FlowApproverDetail {
2239
2226
  * 参与者类型
2240
2227
  <ul><li> **ORGANIZATION** :企业签署人</li>
2241
2228
  <li> **PERSON** :个人签署人</li></ul>
2242
- 注意:此字段可能返回 null,表示取不到有效值。
2243
2229
  */
2244
2230
  ApproveType?: string;
2245
2231
  /**
2246
2232
  * 自定义签署人的角色名, 如: 收款人、开具人、见证人等
2247
- 注意:此字段可能返回 null,表示取不到有效值。
2248
2233
  */
2249
2234
  ApproverRoleName?: string;
2250
2235
  /**
2251
2236
  * 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点。
2252
- 注意:此字段可能返回 null,表示取不到有效值。
2253
2237
  */
2254
2238
  SignId?: string;
2255
2239
  /**
@@ -2387,19 +2371,16 @@ export interface ApproverItem {
2387
2371
  * 签署方唯一编号
2388
2372
 
2389
2373
  在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
2390
- 注意:此字段可能返回 null,表示取不到有效值。
2391
2374
  */
2392
2375
  SignId?: string;
2393
2376
  /**
2394
2377
  * 签署方角色编号
2395
2378
 
2396
2379
  在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
2397
- 注意:此字段可能返回 null,表示取不到有效值。
2398
2380
  */
2399
2381
  RecipientId?: string;
2400
2382
  /**
2401
2383
  * 签署方角色名称
2402
- 注意:此字段可能返回 null,表示取不到有效值。
2403
2384
  */
2404
2385
  ApproverRoleName?: string;
2405
2386
  }
@@ -2453,12 +2434,10 @@ export interface RecipientComponentInfo {
2453
2434
 
2454
2435
  <ul><li> **true** : 是发起方角色</li>
2455
2436
  <li> **false** : 不是发起方角色</li></ul>
2456
- 注意:此字段可能返回 null,表示取不到有效值。
2457
2437
  */
2458
2438
  IsPromoter?: boolean;
2459
2439
  /**
2460
2440
  * 此角色的填写控件列表
2461
- 注意:此字段可能返回 null,表示取不到有效值。
2462
2441
  */
2463
2442
  Components?: Array<FilledComponent>;
2464
2443
  }
@@ -2684,14 +2663,12 @@ export interface TemplateInfo {
2684
2663
  您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。
2685
2664
 
2686
2665
  注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。
2687
- 注意:此字段可能返回 null,表示取不到有效值。
2688
2666
  */
2689
2667
  PreviewUrl?: string;
2690
2668
  /**
2691
2669
  * 第三方应用集成-模板PDF文件链接,有效期5分钟。
2692
2670
  请求参数WithPdfUrl=true时返回
2693
2671
  (此功能开放需要联系客户经理)。
2694
- 注意:此字段可能返回 null,表示取不到有效值。
2695
2672
  */
2696
2673
  PdfUrl?: string;
2697
2674
  /**
@@ -2700,19 +2677,16 @@ export interface TemplateInfo {
2700
2677
  ChannelTemplateId?: string;
2701
2678
  /**
2702
2679
  * 本模板关联的三方应用平台平台企业模板名称
2703
- 注意:此字段可能返回 null,表示取不到有效值。
2704
2680
  */
2705
2681
  ChannelTemplateName?: string;
2706
2682
  /**
2707
2683
  * 0-需要子客企业手动领取平台企业的模板(默认);
2708
2684
  1-平台自动设置子客模板
2709
- 注意:此字段可能返回 null,表示取不到有效值。
2710
2685
  */
2711
2686
  ChannelAutoSave?: number;
2712
2687
  /**
2713
2688
  * 模板版本,由全数字字符组成。
2714
2689
  默认为空,模板版本号由日期和序号组成,初始版本为yyyyMMdd001,yyyyMMdd002表示第二个版本,以此类推。
2715
- 注意:此字段可能返回 null,表示取不到有效值。
2716
2690
  */
2717
2691
  TemplateVersion?: string;
2718
2692
  /**
@@ -2720,10 +2694,18 @@ export interface TemplateInfo {
2720
2694
 
2721
2695
  <ul><li>1:启用(默认),表示模板处于启用状态,可以被用户正常使用。</li>
2722
2696
  <li>2:停用,表示模板处于停用状态,禁止用户使用该模板。</li></ul>
2723
- 注意:此字段可能返回 null,表示取不到有效值。
2724
2697
  */
2725
2698
  Available?: number;
2726
2699
  }
2700
+ /**
2701
+ * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
2702
+ */
2703
+ export interface IntentionAction {
2704
+ /**
2705
+ * 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
2706
+ */
2707
+ Text?: string;
2708
+ }
2727
2709
  /**
2728
2710
  * ChannelCreateOrganizationBatchSignUrl请求参数结构体
2729
2711
  */
@@ -2794,12 +2776,10 @@ export interface GetDownloadFlowUrlResponse {
2794
2776
  export interface ChannelRole {
2795
2777
  /**
2796
2778
  * 角色ID,为32位字符串
2797
- 注意:此字段可能返回 null,表示取不到有效值。
2798
2779
  */
2799
2780
  RoleId?: string;
2800
2781
  /**
2801
2782
  * 角色的名称
2802
- 注意:此字段可能返回 null,表示取不到有效值。
2803
2783
  */
2804
2784
  RoleName?: string;
2805
2785
  /**
@@ -2810,7 +2790,6 @@ export interface ChannelRole {
2810
2790
  RoleStatus?: number;
2811
2791
  /**
2812
2792
  * 此角色对应的权限列表
2813
- 注意:此字段可能返回 null,表示取不到有效值。
2814
2793
  */
2815
2794
  PermissionGroups?: Array<PermissionGroup>;
2816
2795
  }
@@ -2992,12 +2971,10 @@ export interface AutoSignConfig {
2992
2971
  export interface StaffRole {
2993
2972
  /**
2994
2973
  * 角色id
2995
- 注意:此字段可能返回 null,表示取不到有效值。
2996
2974
  */
2997
2975
  RoleId?: string;
2998
2976
  /**
2999
2977
  * 角色名称
3000
- 注意:此字段可能返回 null,表示取不到有效值。
3001
2978
  */
3002
2979
  RoleName?: string;
3003
2980
  }
@@ -3268,22 +3245,18 @@ export interface Staff {
3268
3245
  Mobile?: string;
3269
3246
  /**
3270
3247
  * 员工邮箱
3271
- 注意:此字段可能返回 null,表示取不到有效值。
3272
3248
  */
3273
3249
  Email?: string;
3274
3250
  /**
3275
3251
  * 员工在第三方应用平台的用户ID
3276
- 注意:此字段可能返回 null,表示取不到有效值。
3277
3252
  */
3278
3253
  OpenId?: string;
3279
3254
  /**
3280
3255
  * 员工角色
3281
- 注意:此字段可能返回 null,表示取不到有效值。
3282
3256
  */
3283
3257
  Roles?: Array<StaffRole>;
3284
3258
  /**
3285
3259
  * 员工部门
3286
- 注意:此字段可能返回 null,表示取不到有效值。
3287
3260
  */
3288
3261
  Department?: Department;
3289
3262
  /**
@@ -3380,73 +3353,60 @@ export interface OrganizationCommonInfo {
3380
3353
  * 组织机构名称。
3381
3354
  请确认该名称与企业营业执照中注册的名称一致。
3382
3355
  如果名称中包含英文括号(),请使用中文括号()代替。
3383
- 注意:此字段可能返回 null,表示取不到有效值。
3384
3356
  */
3385
3357
  OrganizationName: string;
3386
3358
  /**
3387
3359
  * 组织机构企业统一社会信用代码。
3388
3360
  请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
3389
- 注意:此字段可能返回 null,表示取不到有效值。
3390
3361
  */
3391
3362
  UniformSocialCreditCode: string;
3392
3363
  /**
3393
3364
  * 组织机构法人的姓名。
3394
3365
  请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
3395
- 注意:此字段可能返回 null,表示取不到有效值。
3396
3366
  */
3397
3367
  LegalName: string;
3398
3368
  /**
3399
3369
  * 组织机构法人的证件类型
3400
- 注意:此字段可能返回 null,表示取不到有效值。
3401
3370
  */
3402
3371
  LegalIdCardType?: string;
3403
3372
  /**
3404
3373
  * 组织机构法人的证件号码
3405
- 注意:此字段可能返回 null,表示取不到有效值。
3406
3374
  */
3407
3375
  LegalIdCardNumber?: string;
3408
3376
  /**
3409
3377
  * 组织机构超管姓名。
3410
3378
 
3411
- 注意:此字段可能返回 null,表示取不到有效值。
3412
3379
  */
3413
3380
  AdminName?: string;
3414
3381
  /**
3415
3382
  * 组织机构超管手机号。
3416
3383
 
3417
- 注意:此字段可能返回 null,表示取不到有效值。
3418
3384
  */
3419
3385
  AdminMobile?: string;
3420
3386
  /**
3421
3387
  * 组织机构超管证件类型
3422
3388
 
3423
- 注意:此字段可能返回 null,表示取不到有效值。
3424
3389
  */
3425
3390
  AdminIdCardType?: string;
3426
3391
  /**
3427
3392
  * 组织机构超管证件号码
3428
3393
 
3429
- 注意:此字段可能返回 null,表示取不到有效值。
3430
3394
  */
3431
3395
  AdminIdCardNumber?: string;
3432
3396
  /**
3433
3397
  * 原超管姓名
3434
- 注意:此字段可能返回 null,表示取不到有效值。
3435
3398
  */
3436
3399
  OldAdminName?: string;
3437
3400
  /**
3438
3401
  * 原超管手机号
3439
- 注意:此字段可能返回 null,表示取不到有效值。
3440
3402
  */
3441
3403
  OldAdminMobile?: string;
3442
3404
  /**
3443
3405
  * 原超管证件类型
3444
- 注意:此字段可能返回 null,表示取不到有效值。
3445
3406
  */
3446
3407
  OldAdminIdCardType?: string;
3447
3408
  /**
3448
3409
  * 原超管证件号码
3449
- 注意:此字段可能返回 null,表示取不到有效值。
3450
3410
  */
3451
3411
  OldAdminIdCardNumber?: string;
3452
3412
  }
@@ -3669,22 +3629,18 @@ export interface SignUrlInfo {
3669
3629
  * 签署链接,过期时间为90天
3670
3630
 
3671
3631
  注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
3672
- 注意:此字段可能返回 null,表示取不到有效值。
3673
3632
  */
3674
3633
  SignUrl?: string;
3675
3634
  /**
3676
3635
  * 合同过期时间戳,单位秒
3677
- 注意:此字段可能返回 null,表示取不到有效值。
3678
3636
  */
3679
3637
  Deadline?: number;
3680
3638
  /**
3681
3639
  * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
3682
- 注意:此字段可能返回 null,表示取不到有效值。
3683
3640
  */
3684
3641
  SignOrder?: number;
3685
3642
  /**
3686
3643
  * 签署人编号
3687
- 注意:此字段可能返回 null,表示取不到有效值。
3688
3644
  */
3689
3645
  SignId?: string;
3690
3646
  /**
@@ -3695,49 +3651,40 @@ export interface SignUrlInfo {
3695
3651
  CustomUserId?: string;
3696
3652
  /**
3697
3653
  * 用户姓名
3698
- 注意:此字段可能返回 null,表示取不到有效值。
3699
3654
  */
3700
3655
  Name?: string;
3701
3656
  /**
3702
3657
  * 用户手机号码
3703
- 注意:此字段可能返回 null,表示取不到有效值。
3704
3658
  */
3705
3659
  Mobile?: string;
3706
3660
  /**
3707
3661
  * 签署参与者机构名字
3708
- 注意:此字段可能返回 null,表示取不到有效值。
3709
3662
  */
3710
3663
  OrganizationName?: string;
3711
3664
  /**
3712
3665
  * 参与者类型, 类型如下:
3713
- **ORGANIZATION**:企业经办人
3714
- **PERSON**: 自然人
3715
- 注意:此字段可能返回 null,表示取不到有效值。
3666
+ **ORGANIZATION**:企业经办人
3667
+ **PERSON**: 自然人
3716
3668
  */
3717
3669
  ApproverType?: string;
3718
3670
  /**
3719
3671
  * 经办人身份证号
3720
- 注意:此字段可能返回 null,表示取不到有效值。
3721
3672
  */
3722
3673
  IdCardNumber?: string;
3723
3674
  /**
3724
3675
  * 签署链接对应流程Id
3725
- 注意:此字段可能返回 null,表示取不到有效值。
3726
3676
  */
3727
3677
  FlowId?: string;
3728
3678
  /**
3729
3679
  * 企业经办人 用户在渠道的编号
3730
- 注意:此字段可能返回 null,表示取不到有效值。
3731
3680
  */
3732
3681
  OpenId?: string;
3733
3682
  /**
3734
3683
  * 合同组签署链接对应的合同组id
3735
- 注意:此字段可能返回 null,表示取不到有效值。
3736
3684
  */
3737
3685
  FlowGroupId?: string;
3738
3686
  /**
3739
3687
  * 二维码,在生成动态签署人跳转封面页链接时返回
3740
- 注意:此字段可能返回 null,表示取不到有效值。
3741
3688
  */
3742
3689
  SignQrcodeUrl?: string;
3743
3690
  }
@@ -3968,7 +3915,6 @@ export interface CreatePersonAuthCertificateImageResponse {
3968
3915
  export interface IntentionActionResultDetail {
3969
3916
  /**
3970
3917
  * 视频base64编码(其中包含全程提示文本和点头音频,mp4格式)
3971
- 注意:此字段可能返回 null,表示取不到有效值。
3972
3918
  */
3973
3919
  Video?: string;
3974
3920
  }
@@ -4027,6 +3973,19 @@ export interface ChannelCreateUserAutoSignSealUrlRequest {
4027
3973
  */
4028
3974
  ExpiredTime?: number;
4029
3975
  }
3976
+ /**
3977
+ * 转交合同结果
3978
+ */
3979
+ export interface FlowForwardResult {
3980
+ /**
3981
+ * 合同流程ID为32位字符串。您可以登录腾讯电子签控制台,在 "合同" -> "合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
3982
+ */
3983
+ FlowId?: string;
3984
+ /**
3985
+ * 如果失败,返回的错误细节。
3986
+ */
3987
+ ErrorDetail?: string;
3988
+ }
4030
3989
  /**
4031
3990
  * 合同验签每个签署区的信息
4032
3991
  */
@@ -4578,12 +4537,10 @@ export interface ModifyFlowDeadlineResponse {
4578
4537
  export interface TaskInfo {
4579
4538
  /**
4580
4539
  * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
4581
- 注意:此字段可能返回 null,表示取不到有效值。
4582
4540
  */
4583
4541
  TaskId?: string;
4584
4542
  /**
4585
4543
  * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
4586
- 注意:此字段可能返回 null,表示取不到有效值。
4587
4544
  */
4588
4545
  TaskStatus?: string;
4589
4546
  }
@@ -4652,27 +4609,22 @@ export interface ApproverComponentLimitType {
4652
4609
  export interface HasAuthOrganization {
4653
4610
  /**
4654
4611
  * 授权企业openid,
4655
- 注意:此字段可能返回 null,表示取不到有效值。
4656
4612
  */
4657
4613
  OrganizationOpenId?: string;
4658
4614
  /**
4659
4615
  * 授权企业名称
4660
- 注意:此字段可能返回 null,表示取不到有效值。
4661
4616
  */
4662
4617
  OrganizationName?: string;
4663
4618
  /**
4664
4619
  * 被授权企业openid,
4665
- 注意:此字段可能返回 null,表示取不到有效值。
4666
4620
  */
4667
4621
  AuthorizedOrganizationOpenId?: string;
4668
4622
  /**
4669
4623
  * 被授权企业名称
4670
- 注意:此字段可能返回 null,表示取不到有效值。
4671
4624
  */
4672
4625
  AuthorizedOrganizationName?: string;
4673
4626
  /**
4674
4627
  * 授权时间,格式为时间戳,单位s
4675
- 注意:此字段可能返回 null,表示取不到有效值。
4676
4628
  */
4677
4629
  AuthorizeTime?: number;
4678
4630
  }
@@ -4682,17 +4634,14 @@ export interface HasAuthOrganization {
4682
4634
  export interface ResourceUrlInfo {
4683
4635
  /**
4684
4636
  * 资源链接地址,过期时间5分钟
4685
- 注意:此字段可能返回 null,表示取不到有效值。
4686
4637
  */
4687
4638
  Url?: string;
4688
4639
  /**
4689
4640
  * 资源名称
4690
- 注意:此字段可能返回 null,表示取不到有效值。
4691
4641
  */
4692
4642
  Name?: string;
4693
4643
  /**
4694
4644
  * 资源类型
4695
- 注意:此字段可能返回 null,表示取不到有效值。
4696
4645
  */
4697
4646
  Type?: string;
4698
4647
  }
@@ -5776,20 +5725,36 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
5776
5725
  export interface FillError {
5777
5726
  /**
5778
5727
  * 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
5779
- 注意:此字段可能返回 null,表示取不到有效值。
5780
5728
  */
5781
5729
  RecipientId?: string;
5782
5730
  /**
5783
5731
  * 补充失败错误说明
5784
- 注意:此字段可能返回 null,表示取不到有效值。
5785
5732
  */
5786
5733
  ErrMessage?: string;
5787
5734
  /**
5788
5735
  * 合同流程ID,为32位字符串。
5789
- 注意:此字段可能返回 null,表示取不到有效值。
5790
5736
  */
5791
5737
  FlowId?: string;
5792
5738
  }
5739
+ /**
5740
+ * CreateEmployeeChangeUrl返回参数结构体
5741
+ */
5742
+ export interface CreateEmployeeChangeUrlResponse {
5743
+ /**
5744
+ * 修改员工信息的小程序链接<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a>
5745
+ */
5746
+ MiniAppPath?: string;
5747
+ /**
5748
+ * 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
5749
+
5750
+
5751
+ */
5752
+ ExpireTime?: number;
5753
+ /**
5754
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5755
+ */
5756
+ RequestId?: string;
5757
+ }
5793
5758
  /**
5794
5759
  * ChannelRenewAutoSignLicense请求参数结构体
5795
5760
  */
@@ -5836,7 +5801,6 @@ export interface ChannelDescribeBillUsageDetailResponse {
5836
5801
  export interface IntentionActionResult {
5837
5802
  /**
5838
5803
  * 意愿核身结果详细数据,与每段点头确认过程一一对应
5839
- 注意:此字段可能返回 null,表示取不到有效值。
5840
5804
  */
5841
5805
  Details?: Array<IntentionActionResultDetail>;
5842
5806
  }
@@ -5925,6 +5889,19 @@ export interface CreatePersonAuthCertificateImageRequest {
5925
5889
  */
5926
5890
  SceneKey?: string;
5927
5891
  }
5892
+ /**
5893
+ * 合同转交相关信息
5894
+ */
5895
+ export interface FlowForwardInfo {
5896
+ /**
5897
+ * 合同流程ID,为32位字符串。此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
5898
+ */
5899
+ FlowId: string;
5900
+ /**
5901
+ * 签署方经办人在合同中的参与方ID,为32位字符串。
5902
+ */
5903
+ RecipientId: string;
5904
+ }
5928
5905
  /**
5929
5906
  * CreateFlowsByTemplates返回参数结构体
5930
5907
  */
@@ -5977,7 +5954,6 @@ export interface SyncFailReason {
5977
5954
  Id?: string;
5978
5955
  /**
5979
5956
  * 新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
5980
- 注意:此字段可能返回 null,表示取不到有效值。
5981
5957
  */
5982
5958
  Message?: string;
5983
5959
  }
@@ -6281,19 +6257,16 @@ export interface FormField {
6281
6257
  CreateFlowsByTemplates 接口不使用此字段。
6282
6258
 
6283
6259
  <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
6284
- 注意:此字段可能返回 null,表示取不到有效值。
6285
6260
  */
6286
6261
  ComponentId?: string;
6287
6262
  /**
6288
6263
  * 控件的名字,跟ComponentId二选一,不能全为空
6289
6264
 
6290
6265
  <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
6291
- 注意:此字段可能返回 null,表示取不到有效值。
6292
6266
  */
6293
6267
  ComponentName?: string;
6294
6268
  /**
6295
6269
  * 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
6296
- 注意:此字段可能返回 null,表示取不到有效值。
6297
6270
  */
6298
6271
  LockComponentValue?: boolean;
6299
6272
  }
@@ -6303,15 +6276,38 @@ export interface FormField {
6303
6276
  export interface FailedCreateRoleData {
6304
6277
  /**
6305
6278
  * 用户userId
6306
- 注意:此字段可能返回 null,表示取不到有效值。
6307
6279
  */
6308
6280
  UserId?: string;
6309
6281
  /**
6310
6282
  * 角色RoleId列表
6311
- 注意:此字段可能返回 null,表示取不到有效值。
6312
6283
  */
6313
6284
  RoleIds?: Array<string>;
6314
6285
  }
6286
+ /**
6287
+ * CreateEmployeeChangeUrl请求参数结构体
6288
+ */
6289
+ export interface CreateEmployeeChangeUrlRequest {
6290
+ /**
6291
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6292
+
6293
+ 此接口下面信息必填。
6294
+ <ul>
6295
+ <li>渠道应用标识: Agent.AppId</li>
6296
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6297
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6298
+ </ul>
6299
+ 第三方平台子客企业和员工必须已经经过实名认证
6300
+ */
6301
+ Agent: Agent;
6302
+ /**
6303
+ * 待修改的员工OpenId
6304
+ */
6305
+ OpenId?: string;
6306
+ /**
6307
+ * 待修改的员工手机号,支持海外格式
6308
+ */
6309
+ NewMobile?: string;
6310
+ }
6315
6311
  /**
6316
6312
  * ChannelDescribeUserAutoSignStatus请求参数结构体
6317
6313
  */
@@ -6341,12 +6337,10 @@ export interface ChannelDescribeUserAutoSignStatusRequest {
6341
6337
  export interface FlowResourceUrlInfo {
6342
6338
  /**
6343
6339
  * 合同流程的ID
6344
- 注意:此字段可能返回 null,表示取不到有效值。
6345
6340
  */
6346
6341
  FlowId?: string;
6347
6342
  /**
6348
6343
  * 对应的合同流程的PDF下载链接
6349
- 注意:此字段可能返回 null,表示取不到有效值。
6350
6344
  */
6351
6345
  ResourceUrlInfos?: Array<ResourceUrlInfo>;
6352
6346
  }
@@ -6393,12 +6387,10 @@ export interface ExtentServiceAuthInfo {
6393
6387
  Status?: string;
6394
6388
  /**
6395
6389
  * 操作扩展服务的操作人第三方应用平台的用户openid
6396
- 注意:此字段可能返回 null,表示取不到有效值。
6397
6390
  */
6398
6391
  OperatorOpenId?: string;
6399
6392
  /**
6400
6393
  * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
6401
- 注意:此字段可能返回 null,表示取不到有效值。
6402
6394
  */
6403
6395
  OperateOn?: number;
6404
6396
  }
@@ -6476,12 +6468,10 @@ export interface FilledComponent {
6476
6468
  export interface FlowApproverItem {
6477
6469
  /**
6478
6470
  * 合同编号
6479
- 注意:此字段可能返回 null,表示取不到有效值。
6480
6471
  */
6481
6472
  FlowId?: string;
6482
6473
  /**
6483
6474
  * 签署方信息,如角色ID、角色名称等
6484
- 注意:此字段可能返回 null,表示取不到有效值。
6485
6475
  */
6486
6476
  Approvers?: Array<ApproverItem>;
6487
6477
  }
@@ -6802,13 +6792,21 @@ export interface ApproverRestriction {
6802
6792
  IdCardNumber?: string;
6803
6793
  }
6804
6794
  /**
6805
- * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
6795
+ * CreateFlowForwards返回参数结构体
6806
6796
  */
6807
- export interface IntentionAction {
6797
+ export interface CreateFlowForwardsResponse {
6808
6798
  /**
6809
- * 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
6799
+ * 失败的合同id以及错误详情
6810
6800
  */
6811
- Text?: string;
6801
+ FailedFlows?: Array<FlowForwardResult>;
6802
+ /**
6803
+ * 成功的合同id
6804
+ */
6805
+ SuccessFlows?: Array<string>;
6806
+ /**
6807
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6808
+ */
6809
+ RequestId?: string;
6812
6810
  }
6813
6811
  /**
6814
6812
  * ChannelCreateFlowByFiles返回参数结构体
@@ -7406,22 +7404,18 @@ export interface ChannelGetTaskResultApiResponse {
7406
7404
  export interface PermissionGroup {
7407
7405
  /**
7408
7406
  * 权限组名称
7409
- 注意:此字段可能返回 null,表示取不到有效值。
7410
7407
  */
7411
7408
  GroupName?: string;
7412
7409
  /**
7413
7410
  * 权限组key
7414
- 注意:此字段可能返回 null,表示取不到有效值。
7415
7411
  */
7416
7412
  GroupKey?: string;
7417
7413
  /**
7418
7414
  * 是否隐藏分组,0否1是
7419
- 注意:此字段可能返回 null,表示取不到有效值。
7420
7415
  */
7421
7416
  Hide?: number;
7422
7417
  /**
7423
7418
  * 权限集合
7424
- 注意:此字段可能返回 null,表示取不到有效值。
7425
7419
  */
7426
7420
  Permissions?: Array<Permission>;
7427
7421
  }
@@ -7735,12 +7729,10 @@ export interface ChannelModifyRoleRequest {
7735
7729
  export interface FlowGroupApprovers {
7736
7730
  /**
7737
7731
  * 合同流程ID
7738
- 注意:此字段可能返回 null,表示取不到有效值。
7739
7732
  */
7740
7733
  FlowId?: string;
7741
7734
  /**
7742
7735
  * 签署方信息,包含合同ID和角色ID用于定位RecipientId。
7743
- 注意:此字段可能返回 null,表示取不到有效值。
7744
7736
  */
7745
7737
  Approvers?: Array<ApproverItem>;
7746
7738
  }
@@ -8221,7 +8213,6 @@ export interface OccupiedSeal {
8221
8213
  SealStatus?: string;
8222
8214
  /**
8223
8215
  * 审核失败原因
8224
- 注意:此字段可能返回 null,表示取不到有效值。
8225
8216
  */
8226
8217
  FailReason?: string;
8227
8218
  /**
@@ -8531,12 +8522,10 @@ export interface UsageDetail {
8531
8522
  ProxyOrganizationOpenId?: string;
8532
8523
  /**
8533
8524
  * 子客企业名
8534
- 注意:此字段可能返回 null,表示取不到有效值。
8535
8525
  */
8536
8526
  ProxyOrganizationName?: string;
8537
8527
  /**
8538
8528
  * 对应的消耗日期, **如果是汇总数据则为1970-01-01**
8539
- 注意:此字段可能返回 null,表示取不到有效值。
8540
8529
  */
8541
8530
  Date?: string;
8542
8531
  /**
@@ -8545,12 +8534,10 @@ export interface UsageDetail {
8545
8534
  Usage?: number;
8546
8535
  /**
8547
8536
  * 撤回合同数量
8548
- 注意:此字段可能返回 null,表示取不到有效值。
8549
8537
  */
8550
8538
  Cancel?: number;
8551
8539
  /**
8552
8540
  * 消耗渠道
8553
- 注意:此字段可能返回 null,表示取不到有效值。
8554
8541
  */
8555
8542
  FlowChannel?: string;
8556
8543
  }