tencentcloud-sdk-nodejs-ess 4.0.689 → 4.0.691

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.
@@ -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
  /**
@@ -404,7 +404,8 @@ export interface CancelUserAutoSignEnableUrlResponse {
404
404
  */
405
405
  export interface BindEmployeeUserIdWithClientOpenIdResponse {
406
406
  /**
407
- * 绑定是否成功,1表示成功,0表示失败
407
+ * 绑定是否成功。
408
+ <ul><li>**0**:失败</li><li>**1**:成功</li></ul>
408
409
  */
409
410
  Status?: number;
410
411
  /**
@@ -417,17 +418,19 @@ export interface BindEmployeeUserIdWithClientOpenIdResponse {
417
418
  */
418
419
  export interface CreateIntegrationEmployeesRequest {
419
420
  /**
420
- * 操作人信息,userId必填
421
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId
422
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
421
423
  */
422
424
  Operator: UserInfo;
423
425
  /**
424
- * 待创建员工的信息,不超过20个。
425
- 所有类型的企业支持的入参:Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持。
426
- 企微类型的企业特有支持的入参:WeworkOpenId,传入此字段无需在传入其他信息
426
+ * 待创建员工的信息,最多不超过20个。
427
+ 其中入参Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持设置。
428
+ 在创建企微企业员工场景下,只需传入WeworkOpenId,无需再传其他信息。
427
429
  */
428
430
  Employees: Array<Staff>;
429
431
  /**
430
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
432
+ * 代理企业和员工的信息。
433
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
431
434
  */
432
435
  Agent?: Agent;
433
436
  }
@@ -635,16 +638,16 @@ export interface SealInfo {
635
638
  SealName?: string;
636
639
  }
637
640
  /**
638
- * 集成版企业角色信息
641
+ * 集成版企业角色信息。
639
642
  */
640
643
  export interface StaffRole {
641
644
  /**
642
- * 角色id
645
+ * 角色ID。
643
646
  注意:此字段可能返回 null,表示取不到有效值。
644
647
  */
645
648
  RoleId?: string;
646
649
  /**
647
- * 角色名称
650
+ * 角色名称。
648
651
  注意:此字段可能返回 null,表示取不到有效值。
649
652
  */
650
653
  RoleName?: string;
@@ -747,7 +750,9 @@ export interface CreateConvertTaskApiRequest {
747
750
  */
748
751
  export interface DeleteIntegrationEmployeesResponse {
749
752
  /**
750
- * 员工删除数据
753
+ * 员工删除结果。包含成功数据与失败数据。
754
+ <ul><li>**成功数据**:展示员工姓名、手机号与电子签平台UserId</li>
755
+ <li>**失败数据**:展示员工电子签平台UserId、第三方平台OpenId和失败原因</li></ul>
751
756
  */
752
757
  DeleteEmployeeResult?: DeleteStaffsResult;
753
758
  /**
@@ -755,6 +760,31 @@ export interface DeleteIntegrationEmployeesResponse {
755
760
  */
756
761
  RequestId?: string;
757
762
  }
763
+ /**
764
+ * CreateBatchSignUrl返回参数结构体
765
+ */
766
+ export interface CreateBatchSignUrlResponse {
767
+ /**
768
+ * 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
769
+
770
+ 注: `非小程序和APP集成使用`
771
+ */
772
+ SignUrl?: string;
773
+ /**
774
+ * 链接过期时间以 Unix 时间戳格式表示,默认生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
775
+ */
776
+ ExpiredTime?: number;
777
+ /**
778
+ * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
779
+
780
+ 注: `小程序和APP集成使用`
781
+ */
782
+ MiniAppPath?: string;
783
+ /**
784
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
785
+ */
786
+ RequestId?: string;
787
+ }
758
788
  /**
759
789
  * CreateFlowReminds返回参数结构体
760
790
  */
@@ -773,15 +803,16 @@ export interface CreateFlowRemindsResponse {
773
803
  */
774
804
  export interface DescribeOrganizationGroupOrganizationsRequest {
775
805
  /**
776
- * 操作人信息,userId必填
806
+ * 执行本接口操作的员工信息,userId必填。
807
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
777
808
  */
778
809
  Operator: UserInfo;
779
810
  /**
780
- * 指定每页多少条数据,单页最大1000
811
+ * 指定分页每页返回的数据条数,单页最大1000
781
812
  */
782
813
  Limit: number;
783
814
  /**
784
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0
815
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
785
816
  */
786
817
  Offset: number;
787
818
  /**
@@ -789,15 +820,23 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
789
820
  */
790
821
  Name?: string;
791
822
  /**
792
- * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
823
+ * 成员企业加入集团的当前状态
824
+ <ul><li> **1**:待授权</li>
825
+ <li> **2**:已授权待激活</li>
826
+ <li> **3**:拒绝授权</li>
827
+ <li> **4**:已解除</li>
828
+ <li> **5**:已加入</li>
829
+ </ul>
793
830
  */
794
831
  Status?: number;
795
832
  /**
796
833
  * 是否导出当前成员企业数据
834
+ <ul><li> **false**:不导出(默认值)</li>
835
+ <li> **true**:导出</li></ul>
797
836
  */
798
837
  Export?: boolean;
799
838
  /**
800
- * 成员企业机构 ID,在PC控制台 集团管理可获取
839
+ * 成员企业机构 ID,32 位字符串,在PC控制台 集团管理可获取
801
840
  */
802
841
  Id?: string;
803
842
  }
@@ -1163,26 +1202,33 @@ export interface CreateDocumentResponse {
1163
1202
  */
1164
1203
  export interface DescribeIntegrationEmployeesRequest {
1165
1204
  /**
1166
- * 操作人信息,userId必填
1205
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
1206
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1167
1207
  */
1168
1208
  Operator: UserInfo;
1169
1209
  /**
1170
- * 指定每页多少条数据,单页最大20
1210
+ * 指定分页每页返回的数据条数,单页最大支持 20
1171
1211
  */
1172
1212
  Limit: number;
1173
1213
  /**
1174
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1214
+ * 代理企业和员工的信息。
1215
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1175
1216
  */
1176
1217
  Agent?: Agent;
1177
1218
  /**
1178
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"],查询过滤未实名用户,Key为Status,Values为["NotVerified"]
1179
- 查询某个部门的用户,Key为DepartmentId,Values为["DepartmentId"]
1180
- 根据用户Id查询员工时,Key为UserId,Values为["UserId"]
1181
- 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
1219
+ * 查询的关键字段,支持Key-Values查询。可选键值如下:
1220
+ <ul>
1221
+ <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
1222
+ <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["NotVerified"]**:查询未实名的员工</li></ul></li>
1223
+ <li>Key:**"DepartmentId"**,根据部门ID查询部门下的员工,Values为指定的部门ID:**["DepartmentId"]**</li>
1224
+ <li>Key:**"UserId"**,根据用户ID查询员工,Values为指定的用户ID:**["UserId"]**</li>
1225
+ <li>Key:**"UserWeWorkOpenId"**,根据用户企微账号ID查询员工,Values为指定用户的企微账号ID:**["UserWeWorkOpenId"]**</li>
1226
+ <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
1227
+ </ul>
1182
1228
  */
1183
1229
  Filters?: Array<Filter>;
1184
1230
  /**
1185
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
1231
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000
1186
1232
  */
1187
1233
  Offset?: number;
1188
1234
  }
@@ -1469,7 +1515,9 @@ export interface DescribeThirdPartyAuthCodeRequest {
1469
1515
  */
1470
1516
  export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1471
1517
  /**
1472
- * 解绑是否成功,1表示成功,0表示失败
1518
+ * 解绑是否成功。
1519
+ <ul><li> **0**:失败 </li>
1520
+ <li> **1**:成功 </li></ul>
1473
1521
  */
1474
1522
  Status?: number;
1475
1523
  /**
@@ -1506,19 +1554,22 @@ export interface CreateWebThemeConfigResponse {
1506
1554
  */
1507
1555
  export interface BindEmployeeUserIdWithClientOpenIdRequest {
1508
1556
  /**
1509
- * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定。(参数参考示例)
1557
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
1558
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1510
1559
  */
1511
1560
  Operator: UserInfo;
1512
1561
  /**
1513
- * 电子签系统员工UserId
1562
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
1563
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID);或者通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取。
1514
1564
  */
1515
1565
  UserId: string;
1516
1566
  /**
1517
- * 客户系统OpenId
1567
+ * 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
1518
1568
  */
1519
1569
  OpenId: string;
1520
1570
  /**
1521
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1571
+ * 代理企业和员工的信息。
1572
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1522
1573
  */
1523
1574
  Agent?: Agent;
1524
1575
  }
@@ -1532,7 +1583,9 @@ export interface DescribeIntegrationDepartmentsRequest {
1532
1583
  */
1533
1584
  Operator: UserInfo;
1534
1585
  /**
1535
- * 查询类型 0-查询单个部门节点 1-单个部门节点及一级子节点部门列表
1586
+ * 查询类型,支持以下类型:
1587
+ <ul><li>**0**:查询单个部门节点列表,不包含子节点部门信息</li>
1588
+ <li>**1**:查询单个部门节点级一级子节点部门信息列表</li></ul>
1536
1589
  */
1537
1590
  QueryType: number;
1538
1591
  /**
@@ -1541,11 +1594,13 @@ export interface DescribeIntegrationDepartmentsRequest {
1541
1594
  */
1542
1595
  Agent?: Agent;
1543
1596
  /**
1544
- * 部门ID,与DeptOpenId二选一,优先DeptId,都为空时获取根节点数据
1597
+ * 查询的部门ID
1598
+ 注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`
1545
1599
  */
1546
1600
  DeptId?: string;
1547
1601
  /**
1548
- * 客户系统部门ID,与DeptId二选一,优先DeptId,都为空时获取根节点数据
1602
+ * 查询的客户系统部门ID
1603
+ 注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`
1549
1604
  */
1550
1605
  DeptOpenId?: string;
1551
1606
  }
@@ -1642,7 +1697,7 @@ export interface ComponentLimit {
1642
1697
  */
1643
1698
  export interface CreateIntegrationDepartmentResponse {
1644
1699
  /**
1645
- * 电子签部门ID
1700
+ * 电子签部门ID。建议开发者保存此部门ID,方便后续查询或修改部门信息。
1646
1701
  */
1647
1702
  DeptId?: string;
1648
1703
  /**
@@ -2087,21 +2142,21 @@ export interface DisableUserAutoSignRequest {
2087
2142
  */
2088
2143
  export interface DescribeIntegrationEmployeesResponse {
2089
2144
  /**
2090
- * 员工数据列表
2145
+ * 员工信息列表。
2091
2146
  注意:此字段可能返回 null,表示取不到有效值。
2092
2147
  */
2093
2148
  Employees?: Array<Staff>;
2094
2149
  /**
2095
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
2150
+ * 指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000
2096
2151
  注意:此字段可能返回 null,表示取不到有效值。
2097
2152
  */
2098
2153
  Offset?: number;
2099
2154
  /**
2100
- * 指定每页多少条数据,单页最大20
2155
+ * 指定分页每页返回的数据条数,单页最大支持 20
2101
2156
  */
2102
2157
  Limit?: number;
2103
2158
  /**
2104
- * 符合条件的员工数量
2159
+ * 符合条件的员工数量。
2105
2160
  */
2106
2161
  TotalCount?: number;
2107
2162
  /**
@@ -2144,22 +2199,27 @@ export interface CreateConvertTaskApiResponse {
2144
2199
  */
2145
2200
  export interface CreateFlowSignReviewRequest {
2146
2201
  /**
2147
- * 调用方用户信息,userId 必填
2202
+ * 执行本接口操作的员工信息。
2203
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2148
2204
  */
2149
2205
  Operator: UserInfo;
2150
2206
  /**
2151
- * 签署流程编号
2207
+ * 合同流程ID,为32位字符串。
2208
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2209
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2152
2210
  */
2153
2211
  FlowId: string;
2154
2212
  /**
2155
- * 企业内部审核结果
2156
- PASS: 通过
2157
- REJECT: 拒绝
2213
+ * 企业审核结果
2214
+ <ul><li>PASS: 通过</li>
2215
+ <li>REJECT: 拒绝</li></ul>
2158
2216
  */
2159
2217
  ReviewType: string;
2160
2218
  /**
2161
- * 审核原因
2162
- 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
2219
+ * 审核结果原因,
2220
+ 字符串长度不超过200
2221
+ 当ReviewType 是拒绝(REJECT) 时此字段必填。
2222
+
2163
2223
  */
2164
2224
  ReviewMessage?: string;
2165
2225
  /**
@@ -2167,19 +2227,18 @@ export interface CreateFlowSignReviewRequest {
2167
2227
  */
2168
2228
  Agent?: Agent;
2169
2229
  /**
2170
- * 审核签署节点使用 非必填 如果填写则审核该签署节点。给个人审核时必填。
2230
+ * 审核签署节点人标识,
2231
+ 用来标识审核的签署方。
2232
+ 如果签署审核节点是个人, 此参数必填。
2171
2233
  */
2172
2234
  RecipientId?: string;
2173
2235
  /**
2174
- * 操作类型:(接口通过该字段区分操作类型)
2175
-
2176
- SignReview:签署审核
2177
- CreateReview:发起审核
2236
+ * 操作类型:(接口通过该字段区分不同的操作类型)
2178
2237
 
2179
- 默认:SignReview;SignReview:签署审核
2238
+ <ul><li>SignReview: 签署审核(默认)</li>
2239
+ <li>CreateReview: 创建审核</li></ul>
2180
2240
 
2181
- 该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
2182
- 若发起个人审核,则指定该字段为:SignReview
2241
+ 如果审核节点是个人,则操作类型只能为SignReview
2183
2242
  */
2184
2243
  OperateType?: string;
2185
2244
  }
@@ -2188,19 +2247,23 @@ export interface CreateFlowSignReviewRequest {
2188
2247
  */
2189
2248
  export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
2190
2249
  /**
2191
- * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定(参数用法参考示例)
2250
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
2251
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2192
2252
  */
2193
2253
  Operator: UserInfo;
2194
2254
  /**
2195
- * 电子签系统员工UserId
2255
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
2256
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
2196
2257
  */
2197
2258
  UserId: string;
2198
2259
  /**
2199
- * 客户系统OpenId
2260
+ * 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。
2261
+ 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
2200
2262
  */
2201
2263
  OpenId: string;
2202
2264
  /**
2203
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2265
+ * 代理企业和员工的信息。
2266
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2204
2267
  */
2205
2268
  Agent?: Agent;
2206
2269
  }
@@ -2903,78 +2966,80 @@ export interface FlowCreateApprover {
2903
2966
  ApproverSignTypes?: Array<number | bigint>;
2904
2967
  }
2905
2968
  /**
2906
- * 企业员工信息
2969
+ * 企业员工信息。
2907
2970
  */
2908
2971
  export interface Staff {
2909
2972
  /**
2910
- * 用户在电子签平台的id
2911
- 注:创建和更新场景无需填写
2973
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
2974
+ 注:`创建和更新场景无需填写。`
2912
2975
  */
2913
2976
  UserId?: string;
2914
2977
  /**
2915
- * 显示的用户名/昵称
2978
+ * 显示的用户名/昵称。
2916
2979
  */
2917
2980
  DisplayName?: string;
2918
2981
  /**
2919
- * 用户手机号
2982
+ * 用户手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
2920
2983
  */
2921
2984
  Mobile?: string;
2922
2985
  /**
2923
- * 用户邮箱
2986
+ * 用户邮箱。
2924
2987
  注意:此字段可能返回 null,表示取不到有效值。
2925
2988
  */
2926
2989
  Email?: string;
2927
2990
  /**
2928
- * 用户在第三方平台id,如需在此接口提醒员工实名,该参数不传
2991
+ * 用户在第三方平台ID。
2992
+ 注:`如需在此接口提醒员工实名,该参数不传。`
2929
2993
  注意:此字段可能返回 null,表示取不到有效值。
2930
2994
  */
2931
2995
  OpenId?: string;
2932
2996
  /**
2933
- * 员工角色
2934
- 注:创建和更新场景无需填写
2997
+ * 员工角色信息。
2998
+ 注:`创建和更新场景无需填写。`
2935
2999
  注意:此字段可能返回 null,表示取不到有效值。
2936
3000
  */
2937
3001
  Roles?: Array<StaffRole>;
2938
3002
  /**
2939
- * 员工部门
3003
+ * 员工部门信息。
2940
3004
  注意:此字段可能返回 null,表示取不到有效值。
2941
3005
  */
2942
3006
  Department?: Department;
2943
3007
  /**
2944
- * 员工是否实名
2945
- 注:创建和更新场景无需填写
3008
+ * 员工是否实名。
3009
+ 注:`创建和更新场景无需填写。`
2946
3010
  */
2947
3011
  Verified?: boolean;
2948
3012
  /**
2949
- * 员工创建时间戳,单位秒
2950
- 注:创建和更新场景无需填写
3013
+ * 员工创建时间戳,单位秒。
3014
+ 注:`创建和更新场景无需填写。`
2951
3015
  */
2952
3016
  CreatedOn?: number;
2953
3017
  /**
2954
- * 员工实名时间戳,单位秒
2955
- 注:创建和更新场景无需填写
3018
+ * 员工实名时间戳,单位秒。
3019
+ 注:`创建和更新场景无需填写。`
2956
3020
  注意:此字段可能返回 null,表示取不到有效值。
2957
3021
  */
2958
3022
  VerifiedOn?: number;
2959
3023
  /**
2960
- * 员工是否离职:0-未离职,1-离职
2961
- 注:创建和更新场景无需填写
3024
+ * 员工是否离职:
3025
+ <ul><li>**0**:未离职</li><li>**1**:离职</li></ul>
3026
+ 注:`创建和更新场景无需填写。`
2962
3027
  注意:此字段可能返回 null,表示取不到有效值。
2963
3028
  */
2964
3029
  QuiteJob?: number;
2965
3030
  /**
2966
- * 员工离职交接人用户id
2967
- 注:创建和更新场景无需填写
3031
+ * 员工离职交接人用户ID。
3032
+ 注:`创建和更新场景无需填写。`
2968
3033
  */
2969
3034
  ReceiveUserId?: string;
2970
3035
  /**
2971
- * 员工离职交接人用户OpenId
2972
- 注:创建和更新场景无需填写
3036
+ * 员工离职交接人用户OpenId
3037
+ 注:`创建和更新场景无需填写。`
2973
3038
  */
2974
3039
  ReceiveOpenId?: string;
2975
3040
  /**
2976
- * 企业微信用户账号ID
2977
- 注:仅企微类型的企业创建员工接口支持该字段
3041
+ * 企业微信用户账号ID
3042
+ 注:`仅企微类型的企业创建员工接口支持该字段。`
2978
3043
  注意:此字段可能返回 null,表示取不到有效值。
2979
3044
  */
2980
3045
  WeworkOpenId?: string;
@@ -3075,28 +3140,29 @@ export interface CreateIntegrationDepartmentRequest {
3075
3140
  */
3076
3141
  Operator: UserInfo;
3077
3142
  /**
3078
- * 部门名称,不超过50个字符
3143
+ * 部门名称,最大长度为50个字符。
3079
3144
  */
3080
3145
  DeptName: string;
3081
3146
  /**
3082
- * 代理企业和员工的信息。
3083
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3147
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3084
3148
  */
3085
3149
  Agent?: Agent;
3086
3150
  /**
3087
- * 电子签父部门ID,与ParentDeptOpenId二选一,优先ParentDeptId,都为空时自动填充至根节点下
3151
+ * 电子签父部门ID
3152
+ 注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`
3088
3153
  */
3089
3154
  ParentDeptId?: string;
3090
3155
  /**
3091
- * 第三方平台中父部门ID,与ParentDeptId二选一,优先ParentDeptId,都为空时自动填充至根节点下
3156
+ * 第三方平台中父部门ID
3157
+ 注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`
3092
3158
  */
3093
3159
  ParentDeptOpenId?: string;
3094
3160
  /**
3095
- * 客户系统部门ID,不超过64个字符
3161
+ * 客户系统部门ID,最大长度为64个字符。
3096
3162
  */
3097
3163
  DeptOpenId?: string;
3098
3164
  /**
3099
- * 排序号,1~30000范围内
3165
+ * 排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。
3100
3166
  */
3101
3167
  OrderNo?: number;
3102
3168
  }
@@ -3115,17 +3181,24 @@ export interface GroupOrganization {
3115
3181
  */
3116
3182
  Alias?: string;
3117
3183
  /**
3118
- * 成员企业id
3184
+ * 成员企业id,为 32 位字符串,可在电子签PC 控制台,企业设置->企业电子签账号 获取
3119
3185
  注意:此字段可能返回 null,表示取不到有效值。
3120
3186
  */
3121
3187
  OrganizationId?: string;
3122
3188
  /**
3123
- * 更新时间,时间戳,单位秒
3189
+ * 记录更新时间, unix时间戳,单位秒
3124
3190
  注意:此字段可能返回 null,表示取不到有效值。
3125
3191
  */
3126
3192
  UpdateTime?: number;
3127
3193
  /**
3128
- * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
3194
+ * 成员企业加入集团的当前状态
3195
+ <ul><li> **1**:待授权</li>
3196
+ <li> **2**:已授权待激活</li>
3197
+ <li> **3**:拒绝授权</li>
3198
+ <li> **4**:已解除</li>
3199
+ <li> **5**:已加入</li>
3200
+ </ul>
3201
+
3129
3202
  注意:此字段可能返回 null,表示取不到有效值。
3130
3203
  */
3131
3204
  Status?: number;
@@ -3145,22 +3218,24 @@ export interface GroupOrganization {
3145
3218
  */
3146
3219
  AdminInfo?: Admin;
3147
3220
  /**
3148
- * 企业许可证
3221
+ * 企业许可证Id,此字段暂时不需要关注
3149
3222
  注意:此字段可能返回 null,表示取不到有效值。
3150
3223
  */
3151
3224
  License?: string;
3152
3225
  /**
3153
- * 企业许可证过期时间,时间戳,单位秒
3226
+ * 企业许可证过期时间,unix时间戳,单位秒
3154
3227
  注意:此字段可能返回 null,表示取不到有效值。
3155
3228
  */
3156
3229
  LicenseExpireTime?: number;
3157
3230
  /**
3158
- * 成员企业加入集团时间,时间戳,单位秒
3231
+ * 成员企业加入集团时间,unix时间戳,单位秒
3159
3232
  注意:此字段可能返回 null,表示取不到有效值。
3160
3233
  */
3161
3234
  JoinTime?: number;
3162
3235
  /**
3163
- * 是否使用自建审批流引擎(即不是企微审批流引擎),true-是,false-否
3236
+ * 是否使用自建审批流引擎(即不是企微审批流引擎)
3237
+ <ul><li> **true**:是</li>
3238
+ <li> **false**:否</li></ul>
3164
3239
  注意:此字段可能返回 null,表示取不到有效值。
3165
3240
  */
3166
3241
  FlowEngineEnable?: boolean;
@@ -3325,15 +3400,19 @@ export interface CreateEmbedWebUrlRequest {
3325
3400
  */
3326
3401
  export interface DeleteIntegrationEmployeesRequest {
3327
3402
  /**
3328
- * 操作人信息,userId必填
3403
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
3404
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3329
3405
  */
3330
3406
  Operator: UserInfo;
3331
3407
  /**
3332
- * 待移除员工的信息,userId和openId二选一,必填一个,如果需要指定交接人的话,ReceiveUserId或者ReceiveOpenId字段二选一
3408
+ * 待移除员工的信息。应符合以下规则:
3409
+ <ul><li>UserId和OpenId不可同时为空。</li>
3410
+ <li>若需要进行离职交接,交接人信息ReceiveUserId和ReceiveOpenId不可同时为空。否则视为不进行离职交接。</li></ul>
3333
3411
  */
3334
3412
  Employees: Array<Staff>;
3335
3413
  /**
3336
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
3414
+ * 代理企业和员工的信息。
3415
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3337
3416
  */
3338
3417
  Agent?: Agent;
3339
3418
  }
@@ -3346,7 +3425,7 @@ export interface FailedUpdateStaffData {
3346
3425
  */
3347
3426
  DisplayName?: string;
3348
3427
  /**
3349
- * 用户传入的手机号
3428
+ * 用户传入的手机号,明文展示
3350
3429
  */
3351
3430
  Mobile?: string;
3352
3431
  /**
@@ -3354,7 +3433,8 @@ export interface FailedUpdateStaffData {
3354
3433
  */
3355
3434
  Reason?: string;
3356
3435
  /**
3357
- * 用户Id
3436
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
3437
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3358
3438
  */
3359
3439
  UserId?: string;
3360
3440
  /**
@@ -3469,7 +3549,7 @@ export interface CreateFlowGroupByFilesResponse {
3469
3549
  */
3470
3550
  export interface CreateIntegrationEmployeesResponse {
3471
3551
  /**
3472
- * 创建员工的结果
3552
+ * 创建员工的结果。包含创建成功的数据与创建失败数据。
3473
3553
  */
3474
3554
  CreateEmployeeResult?: CreateStaffResult;
3475
3555
  /**
@@ -3819,11 +3899,12 @@ export interface SuccessUpdateStaffData {
3819
3899
  */
3820
3900
  DisplayName?: string;
3821
3901
  /**
3822
- * 传入的手机号
3902
+ * 传入的手机号,没有打码
3823
3903
  */
3824
3904
  Mobile?: string;
3825
3905
  /**
3826
- * 用户Id
3906
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
3907
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3827
3908
  */
3828
3909
  UserId?: string;
3829
3910
  }
@@ -4188,7 +4269,7 @@ export interface ModifyIntegrationDepartmentRequest {
4188
4269
  */
4189
4270
  Operator: UserInfo;
4190
4271
  /**
4191
- * 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
4272
+ * 电子签部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
4192
4273
  */
4193
4274
  DeptId: string;
4194
4275
  /**
@@ -4197,19 +4278,19 @@ export interface ModifyIntegrationDepartmentRequest {
4197
4278
  */
4198
4279
  Agent?: Agent;
4199
4280
  /**
4200
- * 电子签父部门ID,通过DescribeIntegrationDepartments接口可以获取
4281
+ * 电子签父部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
4201
4282
  */
4202
4283
  ParentDeptId?: string;
4203
4284
  /**
4204
- * 部门名称,不超过50个字符
4285
+ * 部门名称,最大长度为50个字符。
4205
4286
  */
4206
4287
  DeptName?: string;
4207
4288
  /**
4208
- * 客户系统部门ID,不超过64个字符
4289
+ * 客户系统部门ID,最大长度为64个字符。
4209
4290
  */
4210
4291
  DeptOpenId?: string;
4211
4292
  /**
4212
- * 排序号,1~30000范围内
4293
+ * 排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。
4213
4294
  */
4214
4295
  OrderNo?: number;
4215
4296
  }
@@ -4598,7 +4679,7 @@ export interface DeleteIntegrationDepartmentRequest {
4598
4679
  */
4599
4680
  Operator: UserInfo;
4600
4681
  /**
4601
- * 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
4682
+ * 电子签中的部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口可获得。
4602
4683
  */
4603
4684
  DeptId: string;
4604
4685
  /**
@@ -4607,7 +4688,8 @@ export interface DeleteIntegrationDepartmentRequest {
4607
4688
  */
4608
4689
  Agent?: Agent;
4609
4690
  /**
4610
- * 交接部门ID。待删除部门中的合同、印章和模板数据,交接至该部门ID下,未填写交接至公司根部门。
4691
+ * 交接部门ID
4692
+ 待删除部门中的合同、印章和模板数据,将会被交接至该部门ID下;若未填写则交接至公司根部门。
4611
4693
  */
4612
4694
  ReceiveDeptId?: string;
4613
4695
  }
@@ -5236,12 +5318,12 @@ export interface Component {
5236
5318
  */
5237
5319
  export interface IntegrationDepartment {
5238
5320
  /**
5239
- * 部门ID
5321
+ * 部门ID
5240
5322
  注意:此字段可能返回 null,表示取不到有效值。
5241
5323
  */
5242
5324
  DeptId?: string;
5243
5325
  /**
5244
- * 部门名
5326
+ * 部门名。
5245
5327
  注意:此字段可能返回 null,表示取不到有效值。
5246
5328
  */
5247
5329
  DeptName?: string;
@@ -5256,7 +5338,7 @@ export interface IntegrationDepartment {
5256
5338
  */
5257
5339
  DeptOpenId?: string;
5258
5340
  /**
5259
- * 序列号
5341
+ * 序列号。
5260
5342
  注意:此字段可能返回 null,表示取不到有效值。
5261
5343
  */
5262
5344
  OrderNo?: number;
@@ -5312,6 +5394,86 @@ export interface DescribeIntegrationRolesResponse {
5312
5394
  */
5313
5395
  RequestId?: string;
5314
5396
  }
5397
+ /**
5398
+ * CreateBatchSignUrl请求参数结构体
5399
+ */
5400
+ export interface CreateBatchSignUrlRequest {
5401
+ /**
5402
+ * 执行本接口操作的员工信息。
5403
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5404
+ */
5405
+ Operator: UserInfo;
5406
+ /**
5407
+ * 签署方经办人的姓名。
5408
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
5409
+
5410
+ 注:`请确保和合同中填入的一致`
5411
+ */
5412
+ Name: string;
5413
+ /**
5414
+ * 手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
5415
+ 请确认手机号所有方为此业务通知方。
5416
+
5417
+ 注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`
5418
+ */
5419
+ Mobile: string;
5420
+ /**
5421
+ * 代理企业和员工的信息。
5422
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5423
+ */
5424
+ Agent?: Agent;
5425
+ /**
5426
+ * 证件类型,支持以下类型
5427
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
5428
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
5429
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
5430
+
5431
+ 注:`请确保和合同中填入的一致`
5432
+ */
5433
+ IdCardType?: string;
5434
+ /**
5435
+ * 证件号码,应符合以下规则
5436
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
5437
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
5438
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
5439
+
5440
+ 注:`请确保和合同中填入的一致`
5441
+ */
5442
+ IdCardNumber?: string;
5443
+ /**
5444
+ * 通知用户方式:
5445
+ <ul>
5446
+ <li>**NONE** : 不通知(默认)</li>
5447
+ <li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li>
5448
+ </ul>
5449
+ */
5450
+ NotifyType?: string;
5451
+ /**
5452
+ * 本次需要批量签署的合同流程ID列表。
5453
+ 可以不传, 如不传则是发给对方的所有待签署合同流程。
5454
+
5455
+ */
5456
+ FlowIds?: Array<string>;
5457
+ /**
5458
+ * 目标签署人的企业名称,签署人如果是企业员工身份,需要传此参数。
5459
+
5460
+ 注:
5461
+ <ul>
5462
+ <li>请确认该名称与企业营业执照中注册的名称一致。</li>
5463
+ <li>如果名称中包含英文括号(),请使用中文括号()代替。</li>
5464
+ <li>请确保此企业已完成腾讯电子签企业认证。</li>
5465
+ </ul>
5466
+ */
5467
+ OrganizationName?: string;
5468
+ /**
5469
+ * 是否直接跳转至合同内容页面进行签署
5470
+ <ul>
5471
+ <li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>
5472
+ <li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
5473
+ </ul>
5474
+ */
5475
+ JumpToDetail?: boolean;
5476
+ }
5315
5477
  /**
5316
5478
  * CreateFlowReminds请求参数结构体
5317
5479
  */
@@ -5336,7 +5498,8 @@ export interface CreateFlowRemindsRequest {
5336
5498
  */
5337
5499
  export interface UpdateIntegrationEmployeesRequest {
5338
5500
  /**
5339
- * 当前用户信息,UserId必填
5501
+ * 执行本接口操作的员工信息,UserId必填。
5502
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5340
5503
  */
5341
5504
  Operator: UserInfo;
5342
5505
  /**
@@ -5346,7 +5509,8 @@ export interface UpdateIntegrationEmployeesRequest {
5346
5509
  */
5347
5510
  Employees: Array<Staff>;
5348
5511
  /**
5349
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
5512
+ * 代理企业和员工的信息。
5513
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5350
5514
  */
5351
5515
  Agent?: Agent;
5352
5516
  }
@@ -5484,7 +5648,9 @@ export interface Admin {
5484
5648
  */
5485
5649
  Name?: string;
5486
5650
  /**
5487
- * 超管手机号
5651
+ * 超管手机号,打码显示
5652
+ 示例值:138****1569
5653
+
5488
5654
  注意:此字段可能返回 null,表示取不到有效值。
5489
5655
  */
5490
5656
  Mobile?: string;
@@ -5952,12 +6118,12 @@ export interface FlowBrief {
5952
6118
  */
5953
6119
  export interface DescribeOrganizationGroupOrganizationsResponse {
5954
6120
  /**
5955
- * 查询到的符合条件的成员企业总数量
6121
+ * 符合查询条件的资源实例总数量。
5956
6122
  注意:此字段可能返回 null,表示取不到有效值。
5957
6123
  */
5958
6124
  Total?: number;
5959
6125
  /**
5960
- * 已授权待激活的企业数量
6126
+ * 已授权待激活的子企业总数量
5961
6127
  注意:此字段可能返回 null,表示取不到有效值。
5962
6128
  */
5963
6129
  JoinedTotal?: number;
@@ -5978,7 +6144,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
5978
6144
  */
5979
6145
  List?: Array<GroupOrganization>;
5980
6146
  /**
5981
- * 已加入的企业数量
6147
+ * 已加入的子企业总数量
5982
6148
  注意:此字段可能返回 null,表示取不到有效值。
5983
6149
  */
5984
6150
  ActivatedTotal?: number;