tencentcloud-sdk-nodejs 4.0.688 → 4.0.690

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.
Files changed (100) hide show
  1. package/CHANGELOG.md +489 -0
  2. package/SERVICE_CHANGELOG.md +580 -389
  3. package/package.json +1 -1
  4. package/products.md +28 -28
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/batch/v20170312/batch_models.ts +0 -4
  7. package/src/services/bi/v20220105/bi_models.ts +18 -0
  8. package/src/services/cvm/v20170312/cvm_client.ts +6 -3
  9. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  10. package/src/services/cynosdb/v20190107/cynosdb_client.ts +8 -6
  11. package/src/services/cynosdb/v20190107/cynosdb_models.ts +214 -88
  12. package/src/services/dlc/v20210125/dlc_client.ts +41 -6
  13. package/src/services/dlc/v20210125/dlc_models.ts +773 -274
  14. package/src/services/es/v20180416/es_models.ts +5 -5
  15. package/src/services/ess/v20201111/ess_client.ts +63 -60
  16. package/src/services/ess/v20201111/ess_models.ts +264 -229
  17. package/src/services/essbasic/v20210526/essbasic_client.ts +52 -3
  18. package/src/services/essbasic/v20210526/essbasic_models.ts +203 -9
  19. package/src/services/facefusion/v20220927/facefusion_models.ts +5 -1
  20. package/src/services/iss/v20230517/iss_models.ts +3 -3
  21. package/src/services/lcic/v20220817/lcic_models.ts +4 -0
  22. package/src/services/lighthouse/v20200324/lighthouse_models.ts +23 -19
  23. package/src/services/live/v20180801/live_models.ts +32 -27
  24. package/src/services/mongodb/v20190725/mongodb_models.ts +46 -46
  25. package/src/services/monitor/v20180724/monitor_models.ts +6 -2
  26. package/src/services/nlp/v20190408/nlp_client.ts +0 -17
  27. package/src/services/nlp/v20190408/nlp_models.ts +0 -117
  28. package/src/services/omics/v20221128/omics_models.ts +1 -1
  29. package/src/services/postgres/v20170312/postgres_models.ts +33 -30
  30. package/src/services/rce/v20201103/rce_models.ts +42 -11
  31. package/src/services/ssa/v20180608/ssa_client.ts +16 -3
  32. package/src/services/ssa/v20180608/ssa_models.ts +94 -24
  33. package/src/services/ssl/v20191205/ssl_client.ts +26 -2
  34. package/src/services/ssl/v20191205/ssl_models.ts +64 -16
  35. package/src/services/tat/v20201028/tat_models.ts +30 -9
  36. package/src/services/tse/v20201207/tse_client.ts +82 -18
  37. package/src/services/tse/v20201207/tse_models.ts +543 -270
  38. package/src/services/vod/v20180717/vod_client.ts +3 -9
  39. package/src/services/vod/v20180717/vod_models.ts +247 -242
  40. package/src/services/vpc/v20170312/vpc_models.ts +44 -22
  41. package/src/services/waf/v20180125/waf_client.ts +92 -29
  42. package/src/services/waf/v20180125/waf_models.ts +377 -77
  43. package/tencentcloud/common/sdk_version.d.ts +1 -1
  44. package/tencentcloud/common/sdk_version.js +1 -1
  45. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +0 -4
  46. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +18 -0
  47. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +3 -0
  48. package/tencentcloud/services/cvm/v20170312/cvm_client.js +3 -0
  49. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  50. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +5 -5
  51. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +4 -4
  52. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +209 -85
  53. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +9 -1
  54. package/tencentcloud/services/dlc/v20210125/dlc_client.js +12 -0
  55. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +695 -211
  56. package/tencentcloud/services/es/v20180416/es_models.d.ts +5 -5
  57. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +53 -41
  58. package/tencentcloud/services/ess/v20201111/ess_client.js +53 -43
  59. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +264 -226
  60. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +26 -3
  61. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +31 -2
  62. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +195 -9
  63. package/tencentcloud/services/facefusion/v20220927/facefusion_models.d.ts +5 -1
  64. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +3 -3
  65. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +4 -0
  66. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +23 -19
  67. package/tencentcloud/services/live/v20180801/live_models.d.ts +32 -27
  68. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +46 -46
  69. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +6 -2
  70. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +1 -7
  71. package/tencentcloud/services/nlp/v20190408/nlp_client.js +0 -8
  72. package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +0 -112
  73. package/tencentcloud/services/omics/v20221128/omics_models.d.ts +1 -1
  74. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +33 -30
  75. package/tencentcloud/services/rce/v20201103/rce_models.d.ts +42 -11
  76. package/tencentcloud/services/ssa/v20180608/ssa_client.d.ts +5 -1
  77. package/tencentcloud/services/ssa/v20180608/ssa_client.js +6 -0
  78. package/tencentcloud/services/ssa/v20180608/ssa_models.d.ts +91 -24
  79. package/tencentcloud/services/ssl/v20191205/ssl_client.d.ts +9 -1
  80. package/tencentcloud/services/ssl/v20191205/ssl_client.js +12 -0
  81. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +60 -16
  82. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +30 -9
  83. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +25 -5
  84. package/tencentcloud/services/tse/v20201207/tse_client.js +36 -6
  85. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +531 -272
  86. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -7
  87. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -7
  88. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +247 -242
  89. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +44 -22
  90. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +30 -10
  91. package/tencentcloud/services/waf/v20180125/waf_client.js +43 -13
  92. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +364 -77
  93. package/test/dlc.v20210125.test.js +20 -0
  94. package/test/ess.v20201111.test.js +2 -12
  95. package/test/essbasic.v20210526.test.js +30 -0
  96. package/test/nlp.v20190408.test.js +0 -10
  97. package/test/ssa.v20180608.test.js +10 -0
  98. package/test/ssl.v20191205.test.js +20 -0
  99. package/test/tse.v20201207.test.js +54 -4
  100. package/test/waf.v20180125.test.js +58 -8
@@ -143,15 +143,15 @@ export interface UpdateIntegrationEmployeesResponse {
143
143
  RequestId?: string;
144
144
  }
145
145
  /**
146
- * 集成版员工部门信息
146
+ * 集成版员工部门信息。
147
147
  */
148
148
  export interface Department {
149
149
  /**
150
- * 部门id
150
+ * 部门ID。
151
151
  */
152
152
  DepartmentId?: string;
153
153
  /**
154
- * 部门名称
154
+ * 部门名称。
155
155
  */
156
156
  DepartmentName?: string;
157
157
  }
@@ -239,7 +239,7 @@ export interface CreatePreparedPersonalEsignRequest {
239
239
  */
240
240
  export interface DescribeIntegrationDepartmentsResponse {
241
241
  /**
242
- * 部门列表
242
+ * 部门信息列表。部门信息根据部门排序号OrderNo降序排列,根据部门创建时间升序排列。
243
243
  */
244
244
  Departments?: Array<IntegrationDepartment>;
245
245
  /**
@@ -247,27 +247,6 @@ export interface DescribeIntegrationDepartmentsResponse {
247
247
  */
248
248
  RequestId?: string;
249
249
  }
250
- /**
251
- * 模板中文件的信息结构
252
- */
253
- export interface FileInfo {
254
- /**
255
- * 文件ID
256
- */
257
- FileId?: string;
258
- /**
259
- * 文件名
260
- */
261
- FileName?: string;
262
- /**
263
- * 文件大小,单位为Byte
264
- */
265
- FileSize?: number;
266
- /**
267
- * 文件上传时间,格式为Unix标准时间戳(秒)
268
- */
269
- CreatedOn?: number;
270
- }
271
250
  /**
272
251
  * CreateFlowApprovers返回参数结构体
273
252
  */
@@ -425,7 +404,8 @@ export interface CancelUserAutoSignEnableUrlResponse {
425
404
  */
426
405
  export interface BindEmployeeUserIdWithClientOpenIdResponse {
427
406
  /**
428
- * 绑定是否成功,1表示成功,0表示失败
407
+ * 绑定是否成功。
408
+ <ul><li>**0**:失败</li><li>**1**:成功</li></ul>
429
409
  */
430
410
  Status?: number;
431
411
  /**
@@ -438,17 +418,19 @@ export interface BindEmployeeUserIdWithClientOpenIdResponse {
438
418
  */
439
419
  export interface CreateIntegrationEmployeesRequest {
440
420
  /**
441
- * 操作人信息,userId必填
421
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId
422
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
442
423
  */
443
424
  Operator: UserInfo;
444
425
  /**
445
- * 待创建员工的信息,不超过20个。
446
- 所有类型的企业支持的入参:Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持。
447
- 企微类型的企业特有支持的入参:WeworkOpenId,传入此字段无需在传入其他信息
426
+ * 待创建员工的信息,最多不超过20个。
427
+ 其中入参Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持设置。
428
+ 在创建企微企业员工场景下,只需传入WeworkOpenId,无需再传其他信息。
448
429
  */
449
430
  Employees: Array<Staff>;
450
431
  /**
451
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
432
+ * 代理企业和员工的信息。
433
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
452
434
  */
453
435
  Agent?: Agent;
454
436
  }
@@ -563,27 +545,36 @@ export interface ReleasedApprover {
563
545
  */
564
546
  export interface DescribeIntegrationRolesRequest {
565
547
  /**
566
- * 操作人信息,UserId必填
548
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
549
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
567
550
  */
568
551
  Operator: UserInfo;
569
552
  /**
570
- * 指定每页多少条数据,单页最大200
553
+ * 指定分页每页返回的数据条数,单页最大支持 200
571
554
  */
572
555
  Limit: number;
573
556
  /**
574
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
557
+ * 代理企业和员工的信息。
558
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
575
559
  */
576
560
  Agent?: Agent;
577
561
  /**
578
- * 查询的关键字段:
579
- Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
580
- Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
581
- Key:"IsGroupRole",Values:["0"]:查询非集团角色,Values:["1"]表示查询集团角色
582
- Key:"IsReturnPermissionGroup"Values:["0"]:表示接口不返回角色对应的权限树字段,Values:["1"]表示接口返回角色对应的权限树字段
562
+ * 查询的关键字段,支持Key-Value单值查询。可选键值对如下:
563
+ <ul>
564
+ <li>Key:"RoleType",查询角色类型,Values可选:
565
+ <ul><li>**"1"**:查询系统角色</li><li>**"2"**:查询自定义角色</li></ul>
566
+ </li><li>Key:"RoleStatus",查询角色状态,Values可选:
567
+ <ul><li>**"1"**:查询启用角色</li><li>**"2"**:查询禁用角色</li></ul>
568
+ </li><li>Key:"IsGroupRole",是否查询集团角色,Values可选:
569
+ <ul><li>**"0"**:查询非集团角色</li><li>**"1"**:查询集团角色</li></ul>
570
+ </li><li>Key:"IsReturnPermissionGroup",是否返回角色对应权限树,Values可选:
571
+ <ul><li>**"0"**:接口不返回角色对应的权限树字段</li><li>**"1"**:接口返回角色对应的权限树字段</li></ul>
572
+ </li>
573
+ </ul>
583
574
  */
584
575
  Filters?: Array<Filter>;
585
576
  /**
586
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
577
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大2000
587
578
  */
588
579
  Offset?: number;
589
580
  }
@@ -647,16 +638,16 @@ export interface SealInfo {
647
638
  SealName?: string;
648
639
  }
649
640
  /**
650
- * 集成版企业角色信息
641
+ * 集成版企业角色信息。
651
642
  */
652
643
  export interface StaffRole {
653
644
  /**
654
- * 角色id
645
+ * 角色ID。
655
646
  注意:此字段可能返回 null,表示取不到有效值。
656
647
  */
657
648
  RoleId?: string;
658
649
  /**
659
- * 角色名称
650
+ * 角色名称。
660
651
  注意:此字段可能返回 null,表示取不到有效值。
661
652
  */
662
653
  RoleName?: string;
@@ -759,7 +750,9 @@ export interface CreateConvertTaskApiRequest {
759
750
  */
760
751
  export interface DeleteIntegrationEmployeesResponse {
761
752
  /**
762
- * 员工删除数据
753
+ * 员工删除结果。包含成功数据与失败数据。
754
+ <ul><li>**成功数据**:展示员工姓名、手机号与电子签平台UserId</li>
755
+ <li>**失败数据**:展示员工电子签平台UserId、第三方平台OpenId和失败原因</li></ul>
763
756
  */
764
757
  DeleteEmployeeResult?: DeleteStaffsResult;
765
758
  /**
@@ -785,15 +778,16 @@ export interface CreateFlowRemindsResponse {
785
778
  */
786
779
  export interface DescribeOrganizationGroupOrganizationsRequest {
787
780
  /**
788
- * 操作人信息,userId必填
781
+ * 执行本接口操作的员工信息,userId必填。
782
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
789
783
  */
790
784
  Operator: UserInfo;
791
785
  /**
792
- * 指定每页多少条数据,单页最大1000
786
+ * 指定分页每页返回的数据条数,单页最大1000
793
787
  */
794
788
  Limit: number;
795
789
  /**
796
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0
790
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
797
791
  */
798
792
  Offset: number;
799
793
  /**
@@ -801,15 +795,23 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
801
795
  */
802
796
  Name?: string;
803
797
  /**
804
- * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
798
+ * 成员企业加入集团的当前状态
799
+ <ul><li> **1**:待授权</li>
800
+ <li> **2**:已授权待激活</li>
801
+ <li> **3**:拒绝授权</li>
802
+ <li> **4**:已解除</li>
803
+ <li> **5**:已加入</li>
804
+ </ul>
805
805
  */
806
806
  Status?: number;
807
807
  /**
808
808
  * 是否导出当前成员企业数据
809
+ <ul><li> **false**:不导出(默认值)</li>
810
+ <li> **true**:导出</li></ul>
809
811
  */
810
812
  Export?: boolean;
811
813
  /**
812
- * 成员企业机构 ID,在PC控制台 集团管理可获取
814
+ * 成员企业机构 ID,32 位字符串,在PC控制台 集团管理可获取
813
815
  */
814
816
  Id?: string;
815
817
  }
@@ -1175,42 +1177,36 @@ export interface CreateDocumentResponse {
1175
1177
  */
1176
1178
  export interface DescribeIntegrationEmployeesRequest {
1177
1179
  /**
1178
- * 操作人信息,userId必填
1180
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
1181
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1179
1182
  */
1180
1183
  Operator: UserInfo;
1181
1184
  /**
1182
- * 指定每页多少条数据,单页最大20
1185
+ * 指定分页每页返回的数据条数,单页最大支持 20
1183
1186
  */
1184
1187
  Limit: number;
1185
1188
  /**
1186
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1189
+ * 代理企业和员工的信息。
1190
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1187
1191
  */
1188
1192
  Agent?: Agent;
1189
1193
  /**
1190
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"],查询过滤未实名用户,Key为Status,Values为["NotVerified"]
1191
- 查询某个部门的用户,Key为DepartmentId,Values为["DepartmentId"]
1192
- 根据用户Id查询员工时,Key为UserId,Values为["UserId"]
1193
- 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
1194
+ * 查询的关键字段,支持Key-Values查询。可选键值如下:
1195
+ <ul>
1196
+ <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
1197
+ <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["NotVerified"]**:查询未实名的员工</li></ul></li>
1198
+ <li>Key:**"DepartmentId"**,根据部门ID查询部门下的员工,Values为指定的部门ID:**["DepartmentId"]**</li>
1199
+ <li>Key:**"UserId"**,根据用户ID查询员工,Values为指定的用户ID:**["UserId"]**</li>
1200
+ <li>Key:**"UserWeWorkOpenId"**,根据用户企微账号ID查询员工,Values为指定用户的企微账号ID:**["UserWeWorkOpenId"]**</li>
1201
+ <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
1202
+ </ul>
1194
1203
  */
1195
1204
  Filters?: Array<Filter>;
1196
1205
  /**
1197
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
1206
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000
1198
1207
  */
1199
1208
  Offset?: number;
1200
1209
  }
1201
- /**
1202
- * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1203
- */
1204
- export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1205
- /**
1206
- * 解绑是否成功,1表示成功,0表示失败
1207
- */
1208
- Status?: number;
1209
- /**
1210
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1211
- */
1212
- RequestId?: string;
1213
- }
1214
1210
  /**
1215
1211
  * CreateIntegrationUserRoles返回参数结构体
1216
1212
  */
@@ -1490,13 +1486,19 @@ export interface DescribeThirdPartyAuthCodeRequest {
1490
1486
  Agent?: Agent;
1491
1487
  }
1492
1488
  /**
1493
- * DescribeIntegrationMainOrganizationUser请求参数结构体
1489
+ * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1494
1490
  */
1495
- export interface DescribeIntegrationMainOrganizationUserRequest {
1491
+ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1496
1492
  /**
1497
- * 操作人信息,userId必填
1493
+ * 解绑是否成功。
1494
+ <ul><li> **0**:失败 </li>
1495
+ <li> **1**:成功 </li></ul>
1498
1496
  */
1499
- Operator: UserInfo;
1497
+ Status?: number;
1498
+ /**
1499
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1500
+ */
1501
+ RequestId?: string;
1500
1502
  }
1501
1503
  /**
1502
1504
  * CreateReleaseFlow返回参数结构体
@@ -1527,19 +1529,22 @@ export interface CreateWebThemeConfigResponse {
1527
1529
  */
1528
1530
  export interface BindEmployeeUserIdWithClientOpenIdRequest {
1529
1531
  /**
1530
- * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定。(参数参考示例)
1532
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
1533
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1531
1534
  */
1532
1535
  Operator: UserInfo;
1533
1536
  /**
1534
- * 电子签系统员工UserId
1537
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
1538
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID);或者通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取。
1535
1539
  */
1536
1540
  UserId: string;
1537
1541
  /**
1538
- * 客户系统OpenId
1542
+ * 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
1539
1543
  */
1540
1544
  OpenId: string;
1541
1545
  /**
1542
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1546
+ * 代理企业和员工的信息。
1547
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1543
1548
  */
1544
1549
  Agent?: Agent;
1545
1550
  }
@@ -1553,7 +1558,9 @@ export interface DescribeIntegrationDepartmentsRequest {
1553
1558
  */
1554
1559
  Operator: UserInfo;
1555
1560
  /**
1556
- * 查询类型 0-查询单个部门节点 1-单个部门节点及一级子节点部门列表
1561
+ * 查询类型,支持以下类型:
1562
+ <ul><li>**0**:查询单个部门节点列表,不包含子节点部门信息</li>
1563
+ <li>**1**:查询单个部门节点级一级子节点部门信息列表</li></ul>
1557
1564
  */
1558
1565
  QueryType: number;
1559
1566
  /**
@@ -1562,11 +1569,13 @@ export interface DescribeIntegrationDepartmentsRequest {
1562
1569
  */
1563
1570
  Agent?: Agent;
1564
1571
  /**
1565
- * 部门ID,与DeptOpenId二选一,优先DeptId,都为空时获取根节点数据
1572
+ * 查询的部门ID
1573
+ 注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`
1566
1574
  */
1567
1575
  DeptId?: string;
1568
1576
  /**
1569
- * 客户系统部门ID,与DeptId二选一,优先DeptId,都为空时获取根节点数据
1577
+ * 查询的客户系统部门ID
1578
+ 注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`
1570
1579
  */
1571
1580
  DeptOpenId?: string;
1572
1581
  }
@@ -1663,7 +1672,7 @@ export interface ComponentLimit {
1663
1672
  */
1664
1673
  export interface CreateIntegrationDepartmentResponse {
1665
1674
  /**
1666
- * 电子签部门ID
1675
+ * 电子签部门ID。建议开发者保存此部门ID,方便后续查询或修改部门信息。
1667
1676
  */
1668
1677
  DeptId?: string;
1669
1678
  /**
@@ -1802,12 +1811,15 @@ export interface DescribeUserAutoSignStatusResponse {
1802
1811
  /**
1803
1812
  * 补充签署人信息
1804
1813
  - RecipientId 必须指定
1805
- - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
1814
+ - 通过企业微信自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
1806
1815
  - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
1807
1816
  */
1808
1817
  export interface FillApproverInfo {
1809
1818
  /**
1810
- * 对应模板中的参与方ID
1819
+ * 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
1820
+ 模板发起合同时,该参数为必填项。
1821
+ 文件发起合同是,该参数无需传值。
1822
+ 如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
1811
1823
  */
1812
1824
  RecipientId: string;
1813
1825
  /**
@@ -1817,16 +1829,16 @@ export interface FillApproverInfo {
1817
1829
  */
1818
1830
  ApproverSource?: string;
1819
1831
  /**
1820
- * 企业自定义账号ID
1821
- <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
1832
+ * 企业微信UserId
1833
+ <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企业微信的UserId
1822
1834
  */
1823
1835
  CustomUserId?: string;
1824
1836
  /**
1825
- * 补充签署人姓名
1837
+ * 补充企业签署人员工姓名
1826
1838
  */
1827
1839
  ApproverName?: string;
1828
1840
  /**
1829
- * 补充签署人手机号
1841
+ * 补充企业签署人员工手机号
1830
1842
  */
1831
1843
  ApproverMobile?: string;
1832
1844
  }
@@ -2105,21 +2117,21 @@ export interface DisableUserAutoSignRequest {
2105
2117
  */
2106
2118
  export interface DescribeIntegrationEmployeesResponse {
2107
2119
  /**
2108
- * 员工数据列表
2120
+ * 员工信息列表。
2109
2121
  注意:此字段可能返回 null,表示取不到有效值。
2110
2122
  */
2111
2123
  Employees?: Array<Staff>;
2112
2124
  /**
2113
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
2125
+ * 指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000
2114
2126
  注意:此字段可能返回 null,表示取不到有效值。
2115
2127
  */
2116
2128
  Offset?: number;
2117
2129
  /**
2118
- * 指定每页多少条数据,单页最大20
2130
+ * 指定分页每页返回的数据条数,单页最大支持 20
2119
2131
  */
2120
2132
  Limit?: number;
2121
2133
  /**
2122
- * 符合条件的员工数量
2134
+ * 符合条件的员工数量。
2123
2135
  */
2124
2136
  TotalCount?: number;
2125
2137
  /**
@@ -2206,19 +2218,23 @@ export interface CreateFlowSignReviewRequest {
2206
2218
  */
2207
2219
  export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
2208
2220
  /**
2209
- * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定(参数用法参考示例)
2221
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
2222
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2210
2223
  */
2211
2224
  Operator: UserInfo;
2212
2225
  /**
2213
- * 电子签系统员工UserId
2226
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
2227
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
2214
2228
  */
2215
2229
  UserId: string;
2216
2230
  /**
2217
- * 客户系统OpenId
2231
+ * 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。
2232
+ 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
2218
2233
  */
2219
2234
  OpenId: string;
2220
2235
  /**
2221
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2236
+ * 代理企业和员工的信息。
2237
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2222
2238
  */
2223
2239
  Agent?: Agent;
2224
2240
  }
@@ -2244,7 +2260,7 @@ export interface CreateSchemeUrlResponse {
2244
2260
  */
2245
2261
  export interface CreateUserAutoSignEnableUrlResponse {
2246
2262
  /**
2247
- * 个人用户自动签的开通链接, 短链形式
2263
+ * 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
2248
2264
  */
2249
2265
  Url?: string;
2250
2266
  /**
@@ -2685,25 +2701,31 @@ export interface UserInfo {
2685
2701
  */
2686
2702
  export interface CreateFlowApproversRequest {
2687
2703
  /**
2688
- * 调用方用户信息,userId 必填
2704
+ * 执行本接口操作的员工信息。
2705
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2689
2706
  */
2690
2707
  Operator: UserInfo;
2691
2708
  /**
2692
- * 签署流程编号
2709
+ * 合同流程ID,为32位字符串。
2710
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2711
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2693
2712
  */
2694
2713
  FlowId: string;
2695
2714
  /**
2696
- * 补充签署人信息
2715
+ * 补充企业签署人信息。
2716
+
2717
+ - 如果发起方指定的补充签署人是企业微信签署人(ApproverSource=WEWORKAPP),则需要提供企业微信UserId进行补充;
2718
+
2719
+ - 如果不指定,则使用姓名和手机号进行补充。
2697
2720
  */
2698
2721
  Approvers: Array<FillApproverInfo>;
2699
2722
  /**
2700
- * 企微消息中的发起人
2723
+ * 在可定制的企业微信通知中,发起人可以根据具体需求进行自定义设置。
2701
2724
  */
2702
2725
  Initiator?: string;
2703
2726
  /**
2704
- * 代理相关应用信息,如集团主企业代子企业操作
2705
-
2706
-
2727
+ * 代理企业和员工的信息。
2728
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2707
2729
  */
2708
2730
  Agent?: Agent;
2709
2731
  }
@@ -2774,10 +2796,10 @@ export interface FlowCreateApprover {
2774
2796
  */
2775
2797
  ApproverIdCardNumber?: string;
2776
2798
  /**
2777
- * 签署方经办人在模板中的参与方ID
2778
- <br/>模板发起合同时,该参数为必填项
2779
- <br/>文件发起合同是,该参数无序传值
2780
-
2799
+ * 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
2800
+ 模板发起合同时,该参数为必填项。
2801
+ 文件发起合同是,该参数无需传值。
2802
+ 如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
2781
2803
  */
2782
2804
  RecipientId?: string;
2783
2805
  /**
@@ -2915,78 +2937,80 @@ export interface FlowCreateApprover {
2915
2937
  ApproverSignTypes?: Array<number | bigint>;
2916
2938
  }
2917
2939
  /**
2918
- * 企业员工信息
2940
+ * 企业员工信息。
2919
2941
  */
2920
2942
  export interface Staff {
2921
2943
  /**
2922
- * 用户在电子签平台的id
2923
- 注:创建和更新场景无需填写
2944
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
2945
+ 注:`创建和更新场景无需填写。`
2924
2946
  */
2925
2947
  UserId?: string;
2926
2948
  /**
2927
- * 显示的用户名/昵称
2949
+ * 显示的用户名/昵称。
2928
2950
  */
2929
2951
  DisplayName?: string;
2930
2952
  /**
2931
- * 用户手机号
2953
+ * 用户手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
2932
2954
  */
2933
2955
  Mobile?: string;
2934
2956
  /**
2935
- * 用户邮箱
2957
+ * 用户邮箱。
2936
2958
  注意:此字段可能返回 null,表示取不到有效值。
2937
2959
  */
2938
2960
  Email?: string;
2939
2961
  /**
2940
- * 用户在第三方平台id,如需在此接口提醒员工实名,该参数不传
2962
+ * 用户在第三方平台ID。
2963
+ 注:`如需在此接口提醒员工实名,该参数不传。`
2941
2964
  注意:此字段可能返回 null,表示取不到有效值。
2942
2965
  */
2943
2966
  OpenId?: string;
2944
2967
  /**
2945
- * 员工角色
2946
- 注:创建和更新场景无需填写
2968
+ * 员工角色信息。
2969
+ 注:`创建和更新场景无需填写。`
2947
2970
  注意:此字段可能返回 null,表示取不到有效值。
2948
2971
  */
2949
2972
  Roles?: Array<StaffRole>;
2950
2973
  /**
2951
- * 员工部门
2974
+ * 员工部门信息。
2952
2975
  注意:此字段可能返回 null,表示取不到有效值。
2953
2976
  */
2954
2977
  Department?: Department;
2955
2978
  /**
2956
- * 员工是否实名
2957
- 注:创建和更新场景无需填写
2979
+ * 员工是否实名。
2980
+ 注:`创建和更新场景无需填写。`
2958
2981
  */
2959
2982
  Verified?: boolean;
2960
2983
  /**
2961
- * 员工创建时间戳,单位秒
2962
- 注:创建和更新场景无需填写
2984
+ * 员工创建时间戳,单位秒。
2985
+ 注:`创建和更新场景无需填写。`
2963
2986
  */
2964
2987
  CreatedOn?: number;
2965
2988
  /**
2966
- * 员工实名时间戳,单位秒
2967
- 注:创建和更新场景无需填写
2989
+ * 员工实名时间戳,单位秒。
2990
+ 注:`创建和更新场景无需填写。`
2968
2991
  注意:此字段可能返回 null,表示取不到有效值。
2969
2992
  */
2970
2993
  VerifiedOn?: number;
2971
2994
  /**
2972
- * 员工是否离职:0-未离职,1-离职
2973
- 注:创建和更新场景无需填写
2995
+ * 员工是否离职:
2996
+ <ul><li>**0**:未离职</li><li>**1**:离职</li></ul>
2997
+ 注:`创建和更新场景无需填写。`
2974
2998
  注意:此字段可能返回 null,表示取不到有效值。
2975
2999
  */
2976
3000
  QuiteJob?: number;
2977
3001
  /**
2978
- * 员工离职交接人用户id
2979
- 注:创建和更新场景无需填写
3002
+ * 员工离职交接人用户ID。
3003
+ 注:`创建和更新场景无需填写。`
2980
3004
  */
2981
3005
  ReceiveUserId?: string;
2982
3006
  /**
2983
- * 员工离职交接人用户OpenId
2984
- 注:创建和更新场景无需填写
3007
+ * 员工离职交接人用户OpenId
3008
+ 注:`创建和更新场景无需填写。`
2985
3009
  */
2986
3010
  ReceiveOpenId?: string;
2987
3011
  /**
2988
- * 企业微信用户账号ID
2989
- 注:仅企微类型的企业创建员工接口支持该字段
3012
+ * 企业微信用户账号ID
3013
+ 注:`仅企微类型的企业创建员工接口支持该字段。`
2990
3014
  注意:此字段可能返回 null,表示取不到有效值。
2991
3015
  */
2992
3016
  WeworkOpenId?: string;
@@ -3087,28 +3111,29 @@ export interface CreateIntegrationDepartmentRequest {
3087
3111
  */
3088
3112
  Operator: UserInfo;
3089
3113
  /**
3090
- * 部门名称,不超过50个字符
3114
+ * 部门名称,最大长度为50个字符。
3091
3115
  */
3092
3116
  DeptName: string;
3093
3117
  /**
3094
- * 代理企业和员工的信息。
3095
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3118
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3096
3119
  */
3097
3120
  Agent?: Agent;
3098
3121
  /**
3099
- * 电子签父部门ID,与ParentDeptOpenId二选一,优先ParentDeptId,都为空时自动填充至根节点下
3122
+ * 电子签父部门ID
3123
+ 注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`
3100
3124
  */
3101
3125
  ParentDeptId?: string;
3102
3126
  /**
3103
- * 第三方平台中父部门ID,与ParentDeptId二选一,优先ParentDeptId,都为空时自动填充至根节点下
3127
+ * 第三方平台中父部门ID
3128
+ 注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`
3104
3129
  */
3105
3130
  ParentDeptOpenId?: string;
3106
3131
  /**
3107
- * 客户系统部门ID,不超过64个字符
3132
+ * 客户系统部门ID,最大长度为64个字符。
3108
3133
  */
3109
3134
  DeptOpenId?: string;
3110
3135
  /**
3111
- * 排序号,1~30000范围内
3136
+ * 排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。
3112
3137
  */
3113
3138
  OrderNo?: number;
3114
3139
  }
@@ -3127,17 +3152,24 @@ export interface GroupOrganization {
3127
3152
  */
3128
3153
  Alias?: string;
3129
3154
  /**
3130
- * 成员企业id
3155
+ * 成员企业id,为 32 位字符串,可在电子签PC 控制台,企业设置->企业电子签账号 获取
3131
3156
  注意:此字段可能返回 null,表示取不到有效值。
3132
3157
  */
3133
3158
  OrganizationId?: string;
3134
3159
  /**
3135
- * 更新时间,时间戳,单位秒
3160
+ * 记录更新时间, unix时间戳,单位秒
3136
3161
  注意:此字段可能返回 null,表示取不到有效值。
3137
3162
  */
3138
3163
  UpdateTime?: number;
3139
3164
  /**
3140
- * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
3165
+ * 成员企业加入集团的当前状态
3166
+ <ul><li> **1**:待授权</li>
3167
+ <li> **2**:已授权待激活</li>
3168
+ <li> **3**:拒绝授权</li>
3169
+ <li> **4**:已解除</li>
3170
+ <li> **5**:已加入</li>
3171
+ </ul>
3172
+
3141
3173
  注意:此字段可能返回 null,表示取不到有效值。
3142
3174
  */
3143
3175
  Status?: number;
@@ -3157,22 +3189,24 @@ export interface GroupOrganization {
3157
3189
  */
3158
3190
  AdminInfo?: Admin;
3159
3191
  /**
3160
- * 企业许可证
3192
+ * 企业许可证Id,此字段暂时不需要关注
3161
3193
  注意:此字段可能返回 null,表示取不到有效值。
3162
3194
  */
3163
3195
  License?: string;
3164
3196
  /**
3165
- * 企业许可证过期时间,时间戳,单位秒
3197
+ * 企业许可证过期时间,unix时间戳,单位秒
3166
3198
  注意:此字段可能返回 null,表示取不到有效值。
3167
3199
  */
3168
3200
  LicenseExpireTime?: number;
3169
3201
  /**
3170
- * 成员企业加入集团时间,时间戳,单位秒
3202
+ * 成员企业加入集团时间,unix时间戳,单位秒
3171
3203
  注意:此字段可能返回 null,表示取不到有效值。
3172
3204
  */
3173
3205
  JoinTime?: number;
3174
3206
  /**
3175
- * 是否使用自建审批流引擎(即不是企微审批流引擎),true-是,false-否
3207
+ * 是否使用自建审批流引擎(即不是企微审批流引擎)
3208
+ <ul><li> **true**:是</li>
3209
+ <li> **false**:否</li></ul>
3176
3210
  注意:此字段可能返回 null,表示取不到有效值。
3177
3211
  */
3178
3212
  FlowEngineEnable?: boolean;
@@ -3299,24 +3333,23 @@ export interface CreateEmbedWebUrlRequest {
3299
3333
  */
3300
3334
  Operator: UserInfo;
3301
3335
  /**
3302
- * WEB嵌入资源类型。
3303
- <br/>CREATE_SEAL: 生成创建印章的嵌入页面
3304
- <br/>CREATE_TEMPLATE:生成创建模板的嵌入页面
3305
- <br/>MODIFY_TEMPLATE:生成编辑模板的嵌入页面
3306
- <br/>PREVIEW_TEMPLATE:生成预览模板的嵌入页面
3307
- <br/>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
3308
- <br/>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
3309
- <br/>EXTEND_SERVICE:生成拓展服务的嵌入页面
3310
- <br/>PREVIEW_FLOW:生成预览合同的嵌入页面
3311
- <br/>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面
3312
-
3336
+ * WEB嵌入资源类型,支持以下类型
3337
+ <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
3338
+ <li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>
3339
+ <li>MODIFY_TEMPLATE:生成编辑模板的嵌入页面</li>
3340
+ <li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>
3341
+ <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
3342
+ <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
3343
+ <li>EXTEND_SERVICE:生成拓展服务的嵌入页面</li>
3344
+ <li>PREVIEW_FLOW:生成预览合同的嵌入页面</li>
3345
+ <li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面</li></ul>
3313
3346
  */
3314
3347
  EmbedType: string;
3315
3348
  /**
3316
3349
  * WEB嵌入的业务资源ID
3317
- <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
3318
- <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id
3319
- <br/>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id
3350
+ <ul><li>PREVIEW_SEAL_DETAIL,必填,取值为印章id</li>
3351
+ <li>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id</li>
3352
+ <li>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id</li><ul>
3320
3353
  */
3321
3354
  BusinessId?: string;
3322
3355
  /**
@@ -3338,15 +3371,19 @@ export interface CreateEmbedWebUrlRequest {
3338
3371
  */
3339
3372
  export interface DeleteIntegrationEmployeesRequest {
3340
3373
  /**
3341
- * 操作人信息,userId必填
3374
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
3375
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3342
3376
  */
3343
3377
  Operator: UserInfo;
3344
3378
  /**
3345
- * 待移除员工的信息,userId和openId二选一,必填一个,如果需要指定交接人的话,ReceiveUserId或者ReceiveOpenId字段二选一
3379
+ * 待移除员工的信息。应符合以下规则:
3380
+ <ul><li>UserId和OpenId不可同时为空。</li>
3381
+ <li>若需要进行离职交接,交接人信息ReceiveUserId和ReceiveOpenId不可同时为空。否则视为不进行离职交接。</li></ul>
3346
3382
  */
3347
3383
  Employees: Array<Staff>;
3348
3384
  /**
3349
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
3385
+ * 代理企业和员工的信息。
3386
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3350
3387
  */
3351
3388
  Agent?: Agent;
3352
3389
  }
@@ -3359,7 +3396,7 @@ export interface FailedUpdateStaffData {
3359
3396
  */
3360
3397
  DisplayName?: string;
3361
3398
  /**
3362
- * 用户传入的手机号
3399
+ * 用户传入的手机号,明文展示
3363
3400
  */
3364
3401
  Mobile?: string;
3365
3402
  /**
@@ -3367,7 +3404,8 @@ export interface FailedUpdateStaffData {
3367
3404
  */
3368
3405
  Reason?: string;
3369
3406
  /**
3370
- * 用户Id
3407
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
3408
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3371
3409
  */
3372
3410
  UserId?: string;
3373
3411
  /**
@@ -3482,7 +3520,7 @@ export interface CreateFlowGroupByFilesResponse {
3482
3520
  */
3483
3521
  export interface CreateIntegrationEmployeesResponse {
3484
3522
  /**
3485
- * 创建员工的结果
3523
+ * 创建员工的结果。包含创建成功的数据与创建失败数据。
3486
3524
  */
3487
3525
  CreateEmployeeResult?: CreateStaffResult;
3488
3526
  /**
@@ -3495,11 +3533,11 @@ export interface CreateIntegrationEmployeesResponse {
3495
3533
  */
3496
3534
  export interface DeleteIntegrationRoleUsersRequest {
3497
3535
  /**
3498
- * 操作人信息,userId必填
3536
+ * 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3499
3537
  */
3500
3538
  Operator: UserInfo;
3501
3539
  /**
3502
- * 角色id
3540
+ * 角色id,可以通过DescribeIntegrationRoles接口获取角色信息
3503
3541
  */
3504
3542
  RoleId: string;
3505
3543
  /**
@@ -3507,7 +3545,7 @@ export interface DeleteIntegrationRoleUsersRequest {
3507
3545
  */
3508
3546
  Users: Array<UserInfo>;
3509
3547
  /**
3510
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3548
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3511
3549
  */
3512
3550
  Agent?: Agent;
3513
3551
  }
@@ -3746,7 +3784,7 @@ export interface CreateReleaseFlowRequest {
3746
3784
  */
3747
3785
  export interface CreateIntegrationUserRolesRequest {
3748
3786
  /**
3749
- * 操作人信息,UserId必填
3787
+ * 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3750
3788
  */
3751
3789
  Operator: UserInfo;
3752
3790
  /**
@@ -3754,11 +3792,11 @@ export interface CreateIntegrationUserRolesRequest {
3754
3792
  */
3755
3793
  UserIds: Array<string>;
3756
3794
  /**
3757
- * 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取
3795
+ * 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取角色信息
3758
3796
  */
3759
3797
  RoleIds: Array<string>;
3760
3798
  /**
3761
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3799
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3762
3800
  */
3763
3801
  Agent?: Agent;
3764
3802
  }
@@ -3832,11 +3870,12 @@ export interface SuccessUpdateStaffData {
3832
3870
  */
3833
3871
  DisplayName?: string;
3834
3872
  /**
3835
- * 传入的手机号
3873
+ * 传入的手机号,没有打码
3836
3874
  */
3837
3875
  Mobile?: string;
3838
3876
  /**
3839
- * 用户Id
3877
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
3878
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3840
3879
  */
3841
3880
  UserId?: string;
3842
3881
  }
@@ -4201,7 +4240,7 @@ export interface ModifyIntegrationDepartmentRequest {
4201
4240
  */
4202
4241
  Operator: UserInfo;
4203
4242
  /**
4204
- * 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
4243
+ * 电子签部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
4205
4244
  */
4206
4245
  DeptId: string;
4207
4246
  /**
@@ -4210,19 +4249,19 @@ export interface ModifyIntegrationDepartmentRequest {
4210
4249
  */
4211
4250
  Agent?: Agent;
4212
4251
  /**
4213
- * 电子签父部门ID,通过DescribeIntegrationDepartments接口可以获取
4252
+ * 电子签父部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
4214
4253
  */
4215
4254
  ParentDeptId?: string;
4216
4255
  /**
4217
- * 部门名称,不超过50个字符
4256
+ * 部门名称,最大长度为50个字符。
4218
4257
  */
4219
4258
  DeptName?: string;
4220
4259
  /**
4221
- * 客户系统部门ID,不超过64个字符
4260
+ * 客户系统部门ID,最大长度为64个字符。
4222
4261
  */
4223
4262
  DeptOpenId?: string;
4224
4263
  /**
4225
- * 排序号,1~30000范围内
4264
+ * 排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。
4226
4265
  */
4227
4266
  OrderNo?: number;
4228
4267
  }
@@ -4318,18 +4357,25 @@ export interface CreateOrganizationBatchSignUrlResponse {
4318
4357
  RequestId?: string;
4319
4358
  }
4320
4359
  /**
4321
- * DescribeIntegrationMainOrganizationUser返回参数结构体
4360
+ * 模板中文件的信息结构
4322
4361
  */
4323
- export interface DescribeIntegrationMainOrganizationUserResponse {
4362
+ export interface FileInfo {
4324
4363
  /**
4325
- * 主企业员工账号信息
4326
- 注意:此字段可能返回 null,表示取不到有效值。
4364
+ * 文件ID
4327
4365
  */
4328
- IntegrationMainOrganizationUser?: IntegrationMainOrganizationUser;
4366
+ FileId?: string;
4329
4367
  /**
4330
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4368
+ * 文件名
4331
4369
  */
4332
- RequestId?: string;
4370
+ FileName?: string;
4371
+ /**
4372
+ * 文件大小,单位为Byte
4373
+ */
4374
+ FileSize?: number;
4375
+ /**
4376
+ * 文件上传时间,格式为Unix标准时间戳(秒)
4377
+ */
4378
+ CreatedOn?: number;
4333
4379
  }
4334
4380
  /**
4335
4381
  * CancelUserAutoSignEnableUrl请求参数结构体
@@ -4604,7 +4650,7 @@ export interface DeleteIntegrationDepartmentRequest {
4604
4650
  */
4605
4651
  Operator: UserInfo;
4606
4652
  /**
4607
- * 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
4653
+ * 电子签中的部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口可获得。
4608
4654
  */
4609
4655
  DeptId: string;
4610
4656
  /**
@@ -4613,7 +4659,8 @@ export interface DeleteIntegrationDepartmentRequest {
4613
4659
  */
4614
4660
  Agent?: Agent;
4615
4661
  /**
4616
- * 交接部门ID。待删除部门中的合同、印章和模板数据,交接至该部门ID下,未填写交接至公司根部门。
4662
+ * 交接部门ID
4663
+ 待删除部门中的合同、印章和模板数据,将会被交接至该部门ID下;若未填写则交接至公司根部门。
4617
4664
  */
4618
4665
  ReceiveDeptId?: string;
4619
4666
  }
@@ -4659,26 +4706,6 @@ export interface ModifyApplicationCallbackInfoRequest {
4659
4706
  */
4660
4707
  Agent?: Agent;
4661
4708
  }
4662
- /**
4663
- * 主企业员工账号信息
4664
- */
4665
- export interface IntegrationMainOrganizationUser {
4666
- /**
4667
- * 主企业id
4668
- 注意:此字段可能返回 null,表示取不到有效值。
4669
- */
4670
- MainOrganizationId?: string;
4671
- /**
4672
- * 主企业员工UserId
4673
- 注意:此字段可能返回 null,表示取不到有效值。
4674
- */
4675
- MainUserId?: string;
4676
- /**
4677
- * 主企业员工名
4678
- 注意:此字段可能返回 null,表示取不到有效值。
4679
- */
4680
- UserName?: string;
4681
- }
4682
4709
  /**
4683
4710
  * StartFlow请求参数结构体
4684
4711
  */
@@ -5262,12 +5289,12 @@ export interface Component {
5262
5289
  */
5263
5290
  export interface IntegrationDepartment {
5264
5291
  /**
5265
- * 部门ID
5292
+ * 部门ID
5266
5293
  注意:此字段可能返回 null,表示取不到有效值。
5267
5294
  */
5268
5295
  DeptId?: string;
5269
5296
  /**
5270
- * 部门名
5297
+ * 部门名。
5271
5298
  注意:此字段可能返回 null,表示取不到有效值。
5272
5299
  */
5273
5300
  DeptName?: string;
@@ -5282,7 +5309,7 @@ export interface IntegrationDepartment {
5282
5309
  */
5283
5310
  DeptOpenId?: string;
5284
5311
  /**
5285
- * 序列号
5312
+ * 序列号。
5286
5313
  注意:此字段可能返回 null,表示取不到有效值。
5287
5314
  */
5288
5315
  OrderNo?: number;
@@ -5318,19 +5345,19 @@ export interface DescribeExtendedServiceAuthInfosRequest {
5318
5345
  */
5319
5346
  export interface DescribeIntegrationRolesResponse {
5320
5347
  /**
5321
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
5348
+ * 指定分页返回的页码。页码从0开始,最大为2000
5322
5349
  */
5323
5350
  Offset?: number;
5324
5351
  /**
5325
- * 指定每页多少条数据,单页最大200
5352
+ * 指定分页每页返回的数据条数,单页最大支持 200
5326
5353
  */
5327
5354
  Limit?: number;
5328
5355
  /**
5329
- * 符合查询条件的总的角色数
5356
+ * 符合查询条件的总角色数。
5330
5357
  */
5331
5358
  TotalCount?: number;
5332
5359
  /**
5333
- * 企业角色信息列表
5360
+ * 企业角色信息列表。
5334
5361
  */
5335
5362
  IntegrateRoles?: Array<IntegrateRole>;
5336
5363
  /**
@@ -5362,7 +5389,8 @@ export interface CreateFlowRemindsRequest {
5362
5389
  */
5363
5390
  export interface UpdateIntegrationEmployeesRequest {
5364
5391
  /**
5365
- * 当前用户信息,UserId必填
5392
+ * 执行本接口操作的员工信息,UserId必填。
5393
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5366
5394
  */
5367
5395
  Operator: UserInfo;
5368
5396
  /**
@@ -5372,7 +5400,8 @@ export interface UpdateIntegrationEmployeesRequest {
5372
5400
  */
5373
5401
  Employees: Array<Staff>;
5374
5402
  /**
5375
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
5403
+ * 代理企业和员工的信息。
5404
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5376
5405
  */
5377
5406
  Agent?: Agent;
5378
5407
  }
@@ -5403,23 +5432,30 @@ export interface DescribeFlowBriefsRequest {
5403
5432
  */
5404
5433
  export interface CreateFlowGroupByTemplatesRequest {
5405
5434
  /**
5406
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
5435
+ * 执行本接口操作的员工信息。
5436
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
5407
5437
  */
5408
5438
  Operator: UserInfo;
5409
5439
  /**
5410
- * 合同组名称,最大长度200个字符
5440
+ * 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
5411
5441
  */
5412
5442
  FlowGroupName: string;
5413
5443
  /**
5414
- * 合同组的子合同信息,支持2-50个子合同
5444
+ * 合同(流程)组的子合同信息,支持2-50个子合同
5415
5445
  */
5416
5446
  FlowGroupInfos: Array<FlowGroupInfo>;
5417
5447
  /**
5418
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5448
+ * 代理企业和员工的信息。
5449
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5419
5450
  */
5420
5451
  Agent?: Agent;
5421
5452
  /**
5422
- * 合同组的配置信息。包括是否通知本企业签署方,是否通知其他签署方
5453
+ * 合同(流程)组的配置项信息。
5454
+ 其中包括:
5455
+ <ul>
5456
+ <li>是否通知本企业签署方</li>
5457
+ <li>是否通知其他签署方</li>
5458
+ </ul>
5423
5459
  */
5424
5460
  FlowGroupOptions?: FlowGroupOptions;
5425
5461
  }
@@ -5503,7 +5539,9 @@ export interface Admin {
5503
5539
  */
5504
5540
  Name?: string;
5505
5541
  /**
5506
- * 超管手机号
5542
+ * 超管手机号,打码显示
5543
+ 示例值:138****1569
5544
+
5507
5545
  注意:此字段可能返回 null,表示取不到有效值。
5508
5546
  */
5509
5547
  Mobile?: string;
@@ -5971,12 +6009,12 @@ export interface FlowBrief {
5971
6009
  */
5972
6010
  export interface DescribeOrganizationGroupOrganizationsResponse {
5973
6011
  /**
5974
- * 查询到的符合条件的成员企业总数量
6012
+ * 符合查询条件的资源实例总数量。
5975
6013
  注意:此字段可能返回 null,表示取不到有效值。
5976
6014
  */
5977
6015
  Total?: number;
5978
6016
  /**
5979
- * 已授权待激活的企业数量
6017
+ * 已授权待激活的子企业总数量
5980
6018
  注意:此字段可能返回 null,表示取不到有效值。
5981
6019
  */
5982
6020
  JoinedTotal?: number;
@@ -5997,7 +6035,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
5997
6035
  */
5998
6036
  List?: Array<GroupOrganization>;
5999
6037
  /**
6000
- * 已加入的企业数量
6038
+ * 已加入的子企业总数量
6001
6039
  注意:此字段可能返回 null,表示取不到有效值。
6002
6040
  */
6003
6041
  ActivatedTotal?: number;