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.
@@ -385,21 +385,18 @@ ChildrenComponent结构体定义:
385
385
  /**
386
386
  * 填写控件在腾讯电子签小程序填写界面展示的提示信息,例如,在身份证号码填写控件中,提示信息可以设置成“请输入18位身份证号码”。
387
387
  注:`签署控件设置此字段无效`
388
- 注意:此字段可能返回 null,表示取不到有效值。
389
388
  */
390
389
  Placeholder?: string
391
390
  /**
392
391
  * **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
393
392
  <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
394
393
  <li>true:锁定控件值,在页面编辑控件值</li></ul>
395
- 注意:此字段可能返回 null,表示取不到有效值。
396
394
  */
397
395
  LockComponentValue?: boolean
398
396
  /**
399
397
  * **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
400
398
  <ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
401
399
  <li> <b>true</b> : 可以移动和删除控件</li></ul>
402
- 注意:此字段可能返回 null,表示取不到有效值。
403
400
  */
404
401
  ForbidMoveAndDelete?: boolean
405
402
  }
@@ -542,12 +539,10 @@ export interface DescribeExtendedServiceAuthDetailResponse {
542
539
  export interface Department {
543
540
  /**
544
541
  * 部门id
545
- 注意:此字段可能返回 null,表示取不到有效值。
546
542
  */
547
543
  DepartmentId?: string
548
544
  /**
549
545
  * 部门名称
550
- 注意:此字段可能返回 null,表示取不到有效值。
551
546
  */
552
547
  DepartmentName?: string
553
548
  }
@@ -718,6 +713,26 @@ export interface AuthFailMessage {
718
713
  Message?: string
719
714
  }
720
715
 
716
+ /**
717
+ * CreateFlowForwards请求参数结构体
718
+ */
719
+ export interface CreateFlowForwardsRequest {
720
+ /**
721
+ * 合同对应参与方需要修改的目标经办人对应的OpenId。
722
+
723
+ 注意:`需要保证目标经办人已经加入企业且已实名`
724
+ */
725
+ TargetOpenId: string
726
+ /**
727
+ * 企业签署方的合同及对应签署方
728
+ */
729
+ FlowForwardInfos: Array<FlowForwardInfo>
730
+ /**
731
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
732
+ */
733
+ Agent: Agent
734
+ }
735
+
721
736
  /**
722
737
  * DescribeFlowDetailInfo请求参数结构体
723
738
  */
@@ -844,17 +859,14 @@ export interface IntentionQuestionResult {
844
859
  * 视频base64(其中包含全程问题和回答音频,mp4格式)
845
860
 
846
861
  注:`需进行base64解码获取视频文件`
847
- 注意:此字段可能返回 null,表示取不到有效值。
848
862
  */
849
863
  Video?: string
850
864
  /**
851
865
  * 和答案匹配结果列表
852
- 注意:此字段可能返回 null,表示取不到有效值。
853
866
  */
854
867
  ResultCode?: Array<string>
855
868
  /**
856
869
  * 回答问题语音识别结果列表
857
- 注意:此字段可能返回 null,表示取不到有效值。
858
870
  */
859
871
  AsrResult?: Array<string>
860
872
  }
@@ -864,33 +876,27 @@ export interface IntentionQuestionResult {
864
876
  */
865
877
  export interface AuthInfoDetail {
866
878
  /**
867
- * 扩展服务类型,和入参一致
868
- 注意:此字段可能返回 null,表示取不到有效值。
879
+ * 扩展服务类型,和入参一致
869
880
  */
870
881
  Type?: string
871
882
  /**
872
- * 扩展服务名称
873
- 注意:此字段可能返回 null,表示取不到有效值。
883
+ * 扩展服务名称
874
884
  */
875
885
  Name?: string
876
886
  /**
877
- * 授权员工列表
878
- 注意:此字段可能返回 null,表示取不到有效值。
887
+ * 授权员工列表
879
888
  */
880
889
  HasAuthUserList?: Array<HasAuthUser>
881
890
  /**
882
- * 授权企业列表(企业自动签时,该字段有值)
883
- 注意:此字段可能返回 null,表示取不到有效值。
891
+ * 授权企业列表(企业自动签时,该字段有值)
884
892
  */
885
893
  HasAuthOrganizationList?: Array<HasAuthOrganization>
886
894
  /**
887
- * 授权员工列表总数
888
- 注意:此字段可能返回 null,表示取不到有效值。
895
+ * 授权员工列表总数
889
896
  */
890
897
  AuthUserTotal?: number
891
898
  /**
892
- * 授权企业列表总数
893
- 注意:此字段可能返回 null,表示取不到有效值。
899
+ * 授权企业列表总数
894
900
  */
895
901
  AuthOrganizationTotal?: number
896
902
  }
@@ -953,7 +959,6 @@ export interface HasAuthUser {
953
959
  * 第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。
954
960
 
955
961
 
956
- 注意:此字段可能返回 null,表示取不到有效值。
957
962
  */
958
963
  OpenId?: string
959
964
  }
@@ -1044,7 +1049,6 @@ export interface DetectInfoVideoData {
1044
1049
  * 活体视频的base64编码,mp4格式
1045
1050
 
1046
1051
  注:`需进行base64解码获取活体视频文件`
1047
- 注意:此字段可能返回 null,表示取不到有效值。
1048
1052
  */
1049
1053
  LiveNessVideo?: string
1050
1054
  }
@@ -1812,7 +1816,6 @@ export interface FlowApproverUrlInfo {
1812
1816
  1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1813
1817
  2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1814
1818
  3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1815
- 注意:此字段可能返回 null,表示取不到有效值。
1816
1819
  */
1817
1820
  LongUrl?: string
1818
1821
  }
@@ -2150,57 +2153,46 @@ export interface UploadFilesResponse {
2150
2153
  export interface Permission {
2151
2154
  /**
2152
2155
  * 权限名称
2153
- 注意:此字段可能返回 null,表示取不到有效值。
2154
2156
  */
2155
2157
  Name?: string
2156
2158
  /**
2157
2159
  * 权限key
2158
- 注意:此字段可能返回 null,表示取不到有效值。
2159
2160
  */
2160
2161
  Key?: string
2161
2162
  /**
2162
2163
  * 权限类型 1前端,2后端
2163
- 注意:此字段可能返回 null,表示取不到有效值。
2164
2164
  */
2165
2165
  Type?: number
2166
2166
  /**
2167
2167
  * 是否隐藏
2168
- 注意:此字段可能返回 null,表示取不到有效值。
2169
2168
  */
2170
2169
  Hide?: number
2171
2170
  /**
2172
2171
  * 数据权限标签 1:表示根节点,2:表示叶子结点
2173
- 注意:此字段可能返回 null,表示取不到有效值。
2174
2172
  */
2175
2173
  DataLabel?: number
2176
2174
  /**
2177
2175
  * 数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权
2178
- 注意:此字段可能返回 null,表示取不到有效值。
2179
2176
  */
2180
2177
  DataType?: number
2181
2178
  /**
2182
2179
  * 数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己
2183
- 注意:此字段可能返回 null,表示取不到有效值。
2184
2180
  */
2185
2181
  DataRange?: number
2186
2182
  /**
2187
2183
  * 关联权限, 表示这个功能权限要受哪个数据权限管控
2188
- 注意:此字段可能返回 null,表示取不到有效值。
2189
2184
  */
2190
2185
  DataTo?: string
2191
2186
  /**
2192
2187
  * 父级权限key
2193
- 注意:此字段可能返回 null,表示取不到有效值。
2194
2188
  */
2195
2189
  ParentKey?: string
2196
2190
  /**
2197
2191
  * 是否选中
2198
- 注意:此字段可能返回 null,表示取不到有效值。
2199
2192
  */
2200
2193
  IsChecked?: boolean
2201
2194
  /**
2202
2195
  * 子权限集合
2203
- 注意:此字段可能返回 null,表示取不到有效值。
2204
2196
  */
2205
2197
  Children?: Array<Permission>
2206
2198
  }
@@ -2264,7 +2256,6 @@ export interface FlowApproverDetail {
2264
2256
  ReceiptId?: string
2265
2257
  /**
2266
2258
  * 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
2267
- 注意:此字段可能返回 null,表示取不到有效值。
2268
2259
  */
2269
2260
  ProxyOrganizationOpenId?: string
2270
2261
  /**
@@ -2286,7 +2277,6 @@ export interface FlowApproverDetail {
2286
2277
  /**
2287
2278
  * 签署方经办人的姓名。
2288
2279
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2289
- 注意:此字段可能返回 null,表示取不到有效值。
2290
2280
  */
2291
2281
  ApproveName?: string
2292
2282
  /**
@@ -2303,12 +2293,10 @@ export interface FlowApproverDetail {
2303
2293
  <li> **FORWARD** :已经转他人处理</li>
2304
2294
  <li> **STOP** :流程已终止</li>
2305
2295
  <li> **RELIEVED** :解除协议(已解除)</li></ul>
2306
- 注意:此字段可能返回 null,表示取不到有效值。
2307
2296
  */
2308
2297
  ApproveStatus?: string
2309
2298
  /**
2310
2299
  * 签署人拒签等情况的时候填写的原因
2311
- 注意:此字段可能返回 null,表示取不到有效值。
2312
2300
  */
2313
2301
  ApproveMessage?: string
2314
2302
  /**
@@ -2319,17 +2307,14 @@ export interface FlowApproverDetail {
2319
2307
  * 参与者类型
2320
2308
  <ul><li> **ORGANIZATION** :企业签署人</li>
2321
2309
  <li> **PERSON** :个人签署人</li></ul>
2322
- 注意:此字段可能返回 null,表示取不到有效值。
2323
2310
  */
2324
2311
  ApproveType?: string
2325
2312
  /**
2326
2313
  * 自定义签署人的角色名, 如: 收款人、开具人、见证人等
2327
- 注意:此字段可能返回 null,表示取不到有效值。
2328
2314
  */
2329
2315
  ApproverRoleName?: string
2330
2316
  /**
2331
2317
  * 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点。
2332
- 注意:此字段可能返回 null,表示取不到有效值。
2333
2318
  */
2334
2319
  SignId?: string
2335
2320
  /**
@@ -2473,19 +2458,16 @@ export interface ApproverItem {
2473
2458
  * 签署方唯一编号
2474
2459
 
2475
2460
  在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
2476
- 注意:此字段可能返回 null,表示取不到有效值。
2477
2461
  */
2478
2462
  SignId?: string
2479
2463
  /**
2480
2464
  * 签署方角色编号
2481
2465
 
2482
2466
  在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
2483
- 注意:此字段可能返回 null,表示取不到有效值。
2484
2467
  */
2485
2468
  RecipientId?: string
2486
2469
  /**
2487
2470
  * 签署方角色名称
2488
- 注意:此字段可能返回 null,表示取不到有效值。
2489
2471
  */
2490
2472
  ApproverRoleName?: string
2491
2473
  }
@@ -2541,12 +2523,10 @@ export interface RecipientComponentInfo {
2541
2523
 
2542
2524
  <ul><li> **true** : 是发起方角色</li>
2543
2525
  <li> **false** : 不是发起方角色</li></ul>
2544
- 注意:此字段可能返回 null,表示取不到有效值。
2545
2526
  */
2546
2527
  IsPromoter?: boolean
2547
2528
  /**
2548
2529
  * 此角色的填写控件列表
2549
- 注意:此字段可能返回 null,表示取不到有效值。
2550
2530
  */
2551
2531
  Components?: Array<FilledComponent>
2552
2532
  }
@@ -2779,14 +2759,12 @@ export interface TemplateInfo {
2779
2759
  您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。
2780
2760
 
2781
2761
  注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。
2782
- 注意:此字段可能返回 null,表示取不到有效值。
2783
2762
  */
2784
2763
  PreviewUrl?: string
2785
2764
  /**
2786
2765
  * 第三方应用集成-模板PDF文件链接,有效期5分钟。
2787
2766
  请求参数WithPdfUrl=true时返回
2788
2767
  (此功能开放需要联系客户经理)。
2789
- 注意:此字段可能返回 null,表示取不到有效值。
2790
2768
  */
2791
2769
  PdfUrl?: string
2792
2770
  /**
@@ -2795,19 +2773,16 @@ export interface TemplateInfo {
2795
2773
  ChannelTemplateId?: string
2796
2774
  /**
2797
2775
  * 本模板关联的三方应用平台平台企业模板名称
2798
- 注意:此字段可能返回 null,表示取不到有效值。
2799
2776
  */
2800
2777
  ChannelTemplateName?: string
2801
2778
  /**
2802
2779
  * 0-需要子客企业手动领取平台企业的模板(默认);
2803
2780
  1-平台自动设置子客模板
2804
- 注意:此字段可能返回 null,表示取不到有效值。
2805
2781
  */
2806
2782
  ChannelAutoSave?: number
2807
2783
  /**
2808
2784
  * 模板版本,由全数字字符组成。
2809
2785
  默认为空,模板版本号由日期和序号组成,初始版本为yyyyMMdd001,yyyyMMdd002表示第二个版本,以此类推。
2810
- 注意:此字段可能返回 null,表示取不到有效值。
2811
2786
  */
2812
2787
  TemplateVersion?: string
2813
2788
  /**
@@ -2815,11 +2790,20 @@ export interface TemplateInfo {
2815
2790
 
2816
2791
  <ul><li>1:启用(默认),表示模板处于启用状态,可以被用户正常使用。</li>
2817
2792
  <li>2:停用,表示模板处于停用状态,禁止用户使用该模板。</li></ul>
2818
- 注意:此字段可能返回 null,表示取不到有效值。
2819
2793
  */
2820
2794
  Available?: number
2821
2795
  }
2822
2796
 
2797
+ /**
2798
+ * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
2799
+ */
2800
+ export interface IntentionAction {
2801
+ /**
2802
+ * 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
2803
+ */
2804
+ Text?: string
2805
+ }
2806
+
2823
2807
  /**
2824
2808
  * ChannelCreateOrganizationBatchSignUrl请求参数结构体
2825
2809
  */
@@ -2893,12 +2877,10 @@ export interface GetDownloadFlowUrlResponse {
2893
2877
  export interface ChannelRole {
2894
2878
  /**
2895
2879
  * 角色ID,为32位字符串
2896
- 注意:此字段可能返回 null,表示取不到有效值。
2897
2880
  */
2898
2881
  RoleId?: string
2899
2882
  /**
2900
2883
  * 角色的名称
2901
- 注意:此字段可能返回 null,表示取不到有效值。
2902
2884
  */
2903
2885
  RoleName?: string
2904
2886
  /**
@@ -2909,7 +2891,6 @@ export interface ChannelRole {
2909
2891
  RoleStatus?: number
2910
2892
  /**
2911
2893
  * 此角色对应的权限列表
2912
- 注意:此字段可能返回 null,表示取不到有效值。
2913
2894
  */
2914
2895
  PermissionGroups?: Array<PermissionGroup>
2915
2896
  }
@@ -3096,12 +3077,10 @@ export interface AutoSignConfig {
3096
3077
  export interface StaffRole {
3097
3078
  /**
3098
3079
  * 角色id
3099
- 注意:此字段可能返回 null,表示取不到有效值。
3100
3080
  */
3101
3081
  RoleId?: string
3102
3082
  /**
3103
3083
  * 角色名称
3104
- 注意:此字段可能返回 null,表示取不到有效值。
3105
3084
  */
3106
3085
  RoleName?: string
3107
3086
  }
@@ -3382,22 +3361,18 @@ export interface Staff {
3382
3361
  Mobile?: string
3383
3362
  /**
3384
3363
  * 员工邮箱
3385
- 注意:此字段可能返回 null,表示取不到有效值。
3386
3364
  */
3387
3365
  Email?: string
3388
3366
  /**
3389
3367
  * 员工在第三方应用平台的用户ID
3390
- 注意:此字段可能返回 null,表示取不到有效值。
3391
3368
  */
3392
3369
  OpenId?: string
3393
3370
  /**
3394
3371
  * 员工角色
3395
- 注意:此字段可能返回 null,表示取不到有效值。
3396
3372
  */
3397
3373
  Roles?: Array<StaffRole>
3398
3374
  /**
3399
3375
  * 员工部门
3400
- 注意:此字段可能返回 null,表示取不到有效值。
3401
3376
  */
3402
3377
  Department?: Department
3403
3378
  /**
@@ -3497,73 +3472,60 @@ export interface OrganizationCommonInfo {
3497
3472
  * 组织机构名称。
3498
3473
  请确认该名称与企业营业执照中注册的名称一致。
3499
3474
  如果名称中包含英文括号(),请使用中文括号()代替。
3500
- 注意:此字段可能返回 null,表示取不到有效值。
3501
3475
  */
3502
3476
  OrganizationName: string
3503
3477
  /**
3504
3478
  * 组织机构企业统一社会信用代码。
3505
3479
  请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
3506
- 注意:此字段可能返回 null,表示取不到有效值。
3507
3480
  */
3508
3481
  UniformSocialCreditCode: string
3509
3482
  /**
3510
3483
  * 组织机构法人的姓名。
3511
3484
  请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
3512
- 注意:此字段可能返回 null,表示取不到有效值。
3513
3485
  */
3514
3486
  LegalName: string
3515
3487
  /**
3516
3488
  * 组织机构法人的证件类型
3517
- 注意:此字段可能返回 null,表示取不到有效值。
3518
3489
  */
3519
3490
  LegalIdCardType?: string
3520
3491
  /**
3521
3492
  * 组织机构法人的证件号码
3522
- 注意:此字段可能返回 null,表示取不到有效值。
3523
3493
  */
3524
3494
  LegalIdCardNumber?: string
3525
3495
  /**
3526
3496
  * 组织机构超管姓名。
3527
3497
 
3528
- 注意:此字段可能返回 null,表示取不到有效值。
3529
3498
  */
3530
3499
  AdminName?: string
3531
3500
  /**
3532
3501
  * 组织机构超管手机号。
3533
3502
 
3534
- 注意:此字段可能返回 null,表示取不到有效值。
3535
3503
  */
3536
3504
  AdminMobile?: string
3537
3505
  /**
3538
3506
  * 组织机构超管证件类型
3539
3507
 
3540
- 注意:此字段可能返回 null,表示取不到有效值。
3541
3508
  */
3542
3509
  AdminIdCardType?: string
3543
3510
  /**
3544
3511
  * 组织机构超管证件号码
3545
3512
 
3546
- 注意:此字段可能返回 null,表示取不到有效值。
3547
3513
  */
3548
3514
  AdminIdCardNumber?: string
3549
3515
  /**
3550
3516
  * 原超管姓名
3551
- 注意:此字段可能返回 null,表示取不到有效值。
3552
3517
  */
3553
3518
  OldAdminName?: string
3554
3519
  /**
3555
3520
  * 原超管手机号
3556
- 注意:此字段可能返回 null,表示取不到有效值。
3557
3521
  */
3558
3522
  OldAdminMobile?: string
3559
3523
  /**
3560
3524
  * 原超管证件类型
3561
- 注意:此字段可能返回 null,表示取不到有效值。
3562
3525
  */
3563
3526
  OldAdminIdCardType?: string
3564
3527
  /**
3565
3528
  * 原超管证件号码
3566
- 注意:此字段可能返回 null,表示取不到有效值。
3567
3529
  */
3568
3530
  OldAdminIdCardNumber?: string
3569
3531
  }
@@ -3791,22 +3753,18 @@ export interface SignUrlInfo {
3791
3753
  * 签署链接,过期时间为90天
3792
3754
 
3793
3755
  注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
3794
- 注意:此字段可能返回 null,表示取不到有效值。
3795
3756
  */
3796
3757
  SignUrl?: string
3797
3758
  /**
3798
3759
  * 合同过期时间戳,单位秒
3799
- 注意:此字段可能返回 null,表示取不到有效值。
3800
3760
  */
3801
3761
  Deadline?: number
3802
3762
  /**
3803
3763
  * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
3804
- 注意:此字段可能返回 null,表示取不到有效值。
3805
3764
  */
3806
3765
  SignOrder?: number
3807
3766
  /**
3808
3767
  * 签署人编号
3809
- 注意:此字段可能返回 null,表示取不到有效值。
3810
3768
  */
3811
3769
  SignId?: string
3812
3770
  /**
@@ -3817,49 +3775,40 @@ export interface SignUrlInfo {
3817
3775
  CustomUserId?: string
3818
3776
  /**
3819
3777
  * 用户姓名
3820
- 注意:此字段可能返回 null,表示取不到有效值。
3821
3778
  */
3822
3779
  Name?: string
3823
3780
  /**
3824
3781
  * 用户手机号码
3825
- 注意:此字段可能返回 null,表示取不到有效值。
3826
3782
  */
3827
3783
  Mobile?: string
3828
3784
  /**
3829
3785
  * 签署参与者机构名字
3830
- 注意:此字段可能返回 null,表示取不到有效值。
3831
3786
  */
3832
3787
  OrganizationName?: string
3833
3788
  /**
3834
3789
  * 参与者类型, 类型如下:
3835
- **ORGANIZATION**:企业经办人
3836
- **PERSON**: 自然人
3837
- 注意:此字段可能返回 null,表示取不到有效值。
3790
+ **ORGANIZATION**:企业经办人
3791
+ **PERSON**: 自然人
3838
3792
  */
3839
3793
  ApproverType?: string
3840
3794
  /**
3841
3795
  * 经办人身份证号
3842
- 注意:此字段可能返回 null,表示取不到有效值。
3843
3796
  */
3844
3797
  IdCardNumber?: string
3845
3798
  /**
3846
3799
  * 签署链接对应流程Id
3847
- 注意:此字段可能返回 null,表示取不到有效值。
3848
3800
  */
3849
3801
  FlowId?: string
3850
3802
  /**
3851
3803
  * 企业经办人 用户在渠道的编号
3852
- 注意:此字段可能返回 null,表示取不到有效值。
3853
3804
  */
3854
3805
  OpenId?: string
3855
3806
  /**
3856
3807
  * 合同组签署链接对应的合同组id
3857
- 注意:此字段可能返回 null,表示取不到有效值。
3858
3808
  */
3859
3809
  FlowGroupId?: string
3860
3810
  /**
3861
3811
  * 二维码,在生成动态签署人跳转封面页链接时返回
3862
- 注意:此字段可能返回 null,表示取不到有效值。
3863
3812
  */
3864
3813
  SignQrcodeUrl?: string
3865
3814
  }
@@ -4094,7 +4043,6 @@ export interface CreatePersonAuthCertificateImageResponse {
4094
4043
  export interface IntentionActionResultDetail {
4095
4044
  /**
4096
4045
  * 视频base64编码(其中包含全程提示文本和点头音频,mp4格式)
4097
- 注意:此字段可能返回 null,表示取不到有效值。
4098
4046
  */
4099
4047
  Video?: string
4100
4048
  }
@@ -4157,6 +4105,20 @@ export interface ChannelCreateUserAutoSignSealUrlRequest {
4157
4105
  ExpiredTime?: number
4158
4106
  }
4159
4107
 
4108
+ /**
4109
+ * 转交合同结果
4110
+ */
4111
+ export interface FlowForwardResult {
4112
+ /**
4113
+ * 合同流程ID为32位字符串。您可以登录腾讯电子签控制台,在 "合同" -> "合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
4114
+ */
4115
+ FlowId?: string
4116
+ /**
4117
+ * 如果失败,返回的错误细节。
4118
+ */
4119
+ ErrorDetail?: string
4120
+ }
4121
+
4160
4122
  /**
4161
4123
  * 合同验签每个签署区的信息
4162
4124
  */
@@ -4723,12 +4685,10 @@ export interface ModifyFlowDeadlineResponse {
4723
4685
  export interface TaskInfo {
4724
4686
  /**
4725
4687
  * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
4726
- 注意:此字段可能返回 null,表示取不到有效值。
4727
4688
  */
4728
4689
  TaskId?: string
4729
4690
  /**
4730
4691
  * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
4731
- 注意:此字段可能返回 null,表示取不到有效值。
4732
4692
  */
4733
4693
  TaskStatus?: string
4734
4694
  }
@@ -4801,27 +4761,22 @@ export interface ApproverComponentLimitType {
4801
4761
  export interface HasAuthOrganization {
4802
4762
  /**
4803
4763
  * 授权企业openid,
4804
- 注意:此字段可能返回 null,表示取不到有效值。
4805
4764
  */
4806
4765
  OrganizationOpenId?: string
4807
4766
  /**
4808
- * 授权企业名称
4809
- 注意:此字段可能返回 null,表示取不到有效值。
4767
+ * 授权企业名称
4810
4768
  */
4811
4769
  OrganizationName?: string
4812
4770
  /**
4813
4771
  * 被授权企业openid,
4814
- 注意:此字段可能返回 null,表示取不到有效值。
4815
4772
  */
4816
4773
  AuthorizedOrganizationOpenId?: string
4817
4774
  /**
4818
- * 被授权企业名称
4819
- 注意:此字段可能返回 null,表示取不到有效值。
4775
+ * 被授权企业名称
4820
4776
  */
4821
4777
  AuthorizedOrganizationName?: string
4822
4778
  /**
4823
- * 授权时间,格式为时间戳,单位s
4824
- 注意:此字段可能返回 null,表示取不到有效值。
4779
+ * 授权时间,格式为时间戳,单位s
4825
4780
  */
4826
4781
  AuthorizeTime?: number
4827
4782
  }
@@ -4832,17 +4787,14 @@ export interface HasAuthOrganization {
4832
4787
  export interface ResourceUrlInfo {
4833
4788
  /**
4834
4789
  * 资源链接地址,过期时间5分钟
4835
- 注意:此字段可能返回 null,表示取不到有效值。
4836
4790
  */
4837
4791
  Url?: string
4838
4792
  /**
4839
4793
  * 资源名称
4840
- 注意:此字段可能返回 null,表示取不到有效值。
4841
4794
  */
4842
4795
  Name?: string
4843
4796
  /**
4844
4797
  * 资源类型
4845
- 注意:此字段可能返回 null,表示取不到有效值。
4846
4798
  */
4847
4799
  Type?: string
4848
4800
  }
@@ -5948,21 +5900,38 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
5948
5900
  export interface FillError {
5949
5901
  /**
5950
5902
  * 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
5951
- 注意:此字段可能返回 null,表示取不到有效值。
5952
5903
  */
5953
5904
  RecipientId?: string
5954
5905
  /**
5955
5906
  * 补充失败错误说明
5956
- 注意:此字段可能返回 null,表示取不到有效值。
5957
5907
  */
5958
5908
  ErrMessage?: string
5959
5909
  /**
5960
- * 合同流程ID,为32位字符串。
5961
- 注意:此字段可能返回 null,表示取不到有效值。
5910
+ * 合同流程ID,为32位字符串。
5962
5911
  */
5963
5912
  FlowId?: string
5964
5913
  }
5965
5914
 
5915
+ /**
5916
+ * CreateEmployeeChangeUrl返回参数结构体
5917
+ */
5918
+ export interface CreateEmployeeChangeUrlResponse {
5919
+ /**
5920
+ * 修改员工信息的小程序链接<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a>
5921
+ */
5922
+ MiniAppPath?: string
5923
+ /**
5924
+ * 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
5925
+
5926
+
5927
+ */
5928
+ ExpireTime?: number
5929
+ /**
5930
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5931
+ */
5932
+ RequestId?: string
5933
+ }
5934
+
5966
5935
  /**
5967
5936
  * ChannelRenewAutoSignLicense请求参数结构体
5968
5937
  */
@@ -6011,7 +5980,6 @@ export interface ChannelDescribeBillUsageDetailResponse {
6011
5980
  export interface IntentionActionResult {
6012
5981
  /**
6013
5982
  * 意愿核身结果详细数据,与每段点头确认过程一一对应
6014
- 注意:此字段可能返回 null,表示取不到有效值。
6015
5983
  */
6016
5984
  Details?: Array<IntentionActionResultDetail>
6017
5985
  }
@@ -6103,6 +6071,20 @@ export interface CreatePersonAuthCertificateImageRequest {
6103
6071
  SceneKey?: string
6104
6072
  }
6105
6073
 
6074
+ /**
6075
+ * 合同转交相关信息
6076
+ */
6077
+ export interface FlowForwardInfo {
6078
+ /**
6079
+ * 合同流程ID,为32位字符串。此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
6080
+ */
6081
+ FlowId: string
6082
+ /**
6083
+ * 签署方经办人在合同中的参与方ID,为32位字符串。
6084
+ */
6085
+ RecipientId: string
6086
+ }
6087
+
6106
6088
  /**
6107
6089
  * CreateFlowsByTemplates返回参数结构体
6108
6090
  */
@@ -6156,7 +6138,6 @@ export interface SyncFailReason {
6156
6138
  Id?: string
6157
6139
  /**
6158
6140
  * 新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
6159
- 注意:此字段可能返回 null,表示取不到有效值。
6160
6141
  */
6161
6142
  Message?: string
6162
6143
  }
@@ -6463,19 +6444,16 @@ export interface FormField {
6463
6444
  CreateFlowsByTemplates 接口不使用此字段。
6464
6445
 
6465
6446
  <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
6466
- 注意:此字段可能返回 null,表示取不到有效值。
6467
6447
  */
6468
6448
  ComponentId?: string
6469
6449
  /**
6470
6450
  * 控件的名字,跟ComponentId二选一,不能全为空
6471
6451
 
6472
6452
  <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
6473
- 注意:此字段可能返回 null,表示取不到有效值。
6474
6453
  */
6475
6454
  ComponentName?: string
6476
6455
  /**
6477
6456
  * 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
6478
- 注意:此字段可能返回 null,表示取不到有效值。
6479
6457
  */
6480
6458
  LockComponentValue?: boolean
6481
6459
  }
@@ -6486,16 +6464,40 @@ CreateFlowsByTemplates 接口不使用此字段。
6486
6464
  export interface FailedCreateRoleData {
6487
6465
  /**
6488
6466
  * 用户userId
6489
- 注意:此字段可能返回 null,表示取不到有效值。
6490
6467
  */
6491
6468
  UserId?: string
6492
6469
  /**
6493
6470
  * 角色RoleId列表
6494
- 注意:此字段可能返回 null,表示取不到有效值。
6495
6471
  */
6496
6472
  RoleIds?: Array<string>
6497
6473
  }
6498
6474
 
6475
+ /**
6476
+ * CreateEmployeeChangeUrl请求参数结构体
6477
+ */
6478
+ export interface CreateEmployeeChangeUrlRequest {
6479
+ /**
6480
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6481
+
6482
+ 此接口下面信息必填。
6483
+ <ul>
6484
+ <li>渠道应用标识: Agent.AppId</li>
6485
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6486
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6487
+ </ul>
6488
+ 第三方平台子客企业和员工必须已经经过实名认证
6489
+ */
6490
+ Agent: Agent
6491
+ /**
6492
+ * 待修改的员工OpenId
6493
+ */
6494
+ OpenId?: string
6495
+ /**
6496
+ * 待修改的员工手机号,支持海外格式
6497
+ */
6498
+ NewMobile?: string
6499
+ }
6500
+
6499
6501
  /**
6500
6502
  * ChannelDescribeUserAutoSignStatus请求参数结构体
6501
6503
  */
@@ -6526,12 +6528,10 @@ export interface ChannelDescribeUserAutoSignStatusRequest {
6526
6528
  export interface FlowResourceUrlInfo {
6527
6529
  /**
6528
6530
  * 合同流程的ID
6529
- 注意:此字段可能返回 null,表示取不到有效值。
6530
6531
  */
6531
6532
  FlowId?: string
6532
6533
  /**
6533
6534
  * 对应的合同流程的PDF下载链接
6534
- 注意:此字段可能返回 null,表示取不到有效值。
6535
6535
  */
6536
6536
  ResourceUrlInfos?: Array<ResourceUrlInfo>
6537
6537
  }
@@ -6580,12 +6580,10 @@ export interface ExtentServiceAuthInfo {
6580
6580
  Status?: string
6581
6581
  /**
6582
6582
  * 操作扩展服务的操作人第三方应用平台的用户openid
6583
- 注意:此字段可能返回 null,表示取不到有效值。
6584
6583
  */
6585
6584
  OperatorOpenId?: string
6586
6585
  /**
6587
- * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
6588
- 注意:此字段可能返回 null,表示取不到有效值。
6586
+ * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
6589
6587
  */
6590
6588
  OperateOn?: number
6591
6589
  }
@@ -6668,12 +6666,10 @@ export interface FilledComponent {
6668
6666
  export interface FlowApproverItem {
6669
6667
  /**
6670
6668
  * 合同编号
6671
- 注意:此字段可能返回 null,表示取不到有效值。
6672
6669
  */
6673
6670
  FlowId?: string
6674
6671
  /**
6675
6672
  * 签署方信息,如角色ID、角色名称等
6676
- 注意:此字段可能返回 null,表示取不到有效值。
6677
6673
  */
6678
6674
  Approvers?: Array<ApproverItem>
6679
6675
  }
@@ -7005,13 +7001,21 @@ export interface ApproverRestriction {
7005
7001
  }
7006
7002
 
7007
7003
  /**
7008
- * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
7004
+ * CreateFlowForwards返回参数结构体
7009
7005
  */
7010
- export interface IntentionAction {
7006
+ export interface CreateFlowForwardsResponse {
7011
7007
  /**
7012
- * 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
7008
+ * 失败的合同id以及错误详情
7013
7009
  */
7014
- Text?: string
7010
+ FailedFlows?: Array<FlowForwardResult>
7011
+ /**
7012
+ * 成功的合同id
7013
+ */
7014
+ SuccessFlows?: Array<string>
7015
+ /**
7016
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7017
+ */
7018
+ RequestId?: string
7015
7019
  }
7016
7020
 
7017
7021
  /**
@@ -7633,22 +7637,18 @@ export interface ChannelGetTaskResultApiResponse {
7633
7637
  export interface PermissionGroup {
7634
7638
  /**
7635
7639
  * 权限组名称
7636
- 注意:此字段可能返回 null,表示取不到有效值。
7637
7640
  */
7638
7641
  GroupName?: string
7639
7642
  /**
7640
7643
  * 权限组key
7641
- 注意:此字段可能返回 null,表示取不到有效值。
7642
7644
  */
7643
7645
  GroupKey?: string
7644
7646
  /**
7645
7647
  * 是否隐藏分组,0否1是
7646
- 注意:此字段可能返回 null,表示取不到有效值。
7647
7648
  */
7648
7649
  Hide?: number
7649
7650
  /**
7650
7651
  * 权限集合
7651
- 注意:此字段可能返回 null,表示取不到有效值。
7652
7652
  */
7653
7653
  Permissions?: Array<Permission>
7654
7654
  }
@@ -7972,12 +7972,10 @@ export interface ChannelModifyRoleRequest {
7972
7972
  export interface FlowGroupApprovers {
7973
7973
  /**
7974
7974
  * 合同流程ID
7975
- 注意:此字段可能返回 null,表示取不到有效值。
7976
7975
  */
7977
7976
  FlowId?: string
7978
7977
  /**
7979
7978
  * 签署方信息,包含合同ID和角色ID用于定位RecipientId。
7980
- 注意:此字段可能返回 null,表示取不到有效值。
7981
7979
  */
7982
7980
  Approvers?: Array<ApproverItem>
7983
7981
  }
@@ -8469,7 +8467,6 @@ export interface OccupiedSeal {
8469
8467
  SealStatus?: string
8470
8468
  /**
8471
8469
  * 审核失败原因
8472
- 注意:此字段可能返回 null,表示取不到有效值。
8473
8470
  */
8474
8471
  FailReason?: string
8475
8472
  /**
@@ -8788,12 +8785,10 @@ export interface UsageDetail {
8788
8785
  ProxyOrganizationOpenId?: string
8789
8786
  /**
8790
8787
  * 子客企业名
8791
- 注意:此字段可能返回 null,表示取不到有效值。
8792
8788
  */
8793
8789
  ProxyOrganizationName?: string
8794
8790
  /**
8795
8791
  * 对应的消耗日期, **如果是汇总数据则为1970-01-01**
8796
- 注意:此字段可能返回 null,表示取不到有效值。
8797
8792
  */
8798
8793
  Date?: string
8799
8794
  /**
@@ -8802,12 +8797,10 @@ export interface UsageDetail {
8802
8797
  Usage?: number
8803
8798
  /**
8804
8799
  * 撤回合同数量
8805
- 注意:此字段可能返回 null,表示取不到有效值。
8806
8800
  */
8807
8801
  Cancel?: number
8808
8802
  /**
8809
8803
  * 消耗渠道
8810
- 注意:此字段可能返回 null,表示取不到有效值。
8811
8804
  */
8812
8805
  FlowChannel?: string
8813
8806
  }