tencentcloud-sdk-nodejs-ess 4.0.681 → 4.0.683

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.
@@ -111,16 +111,17 @@ export interface CancelFlowResponse {
111
111
  */
112
112
  export interface DescribeFlowEvidenceReportRequest {
113
113
  /**
114
- * 调用方用户信息,userId 必填
114
+ * 执行本接口操作的员工信息。
115
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
115
116
  */
116
117
  Operator: UserInfo;
117
118
  /**
118
- * 出证报告编号
119
+ * 签署报告编号
119
120
  */
120
121
  ReportId: string;
121
122
  /**
122
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
123
-
123
+ * 代理企业和员工的信息。
124
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
124
125
  */
125
126
  Agent?: Agent;
126
127
  }
@@ -308,11 +309,11 @@ export interface ModifyApplicationCallbackInfoResponse {
308
309
  */
309
310
  export interface CreateMultiFlowSignQRCodeResponse {
310
311
  /**
311
- * 签署二维码对象
312
+ * 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
312
313
  */
313
314
  QrCode?: SignQrCode;
314
315
  /**
315
- * 签署链接对象
316
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
316
317
  */
317
318
  SignUrls?: SignUrl;
318
319
  /**
@@ -325,12 +326,16 @@ export interface CreateMultiFlowSignQRCodeResponse {
325
326
  */
326
327
  export interface FlowApproverUrlInfo {
327
328
  /**
328
- * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
329
+ * 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
330
+ 注: `注意该链接有效期为30分钟`
329
331
  注意:此字段可能返回 null,表示取不到有效值。
330
332
  */
331
333
  SignUrl?: string;
332
334
  /**
333
- * 签署人类型 1-个人
335
+ * 签署参与人类型
336
+ <ul><li> **1** :个人参与方</li></ul>
337
+
338
+ 注: `现在仅支持个人参与方`
334
339
  注意:此字段可能返回 null,表示取不到有效值。
335
340
  */
336
341
  ApproverType?: number;
@@ -345,7 +350,8 @@ export interface FlowApproverUrlInfo {
345
350
  */
346
351
  ApproverMobile?: string;
347
352
  /**
348
- * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
353
+ * 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
354
+ 注: `注意该链接有效期为30分钟`
349
355
  注意:此字段可能返回 null,表示取不到有效值。
350
356
  */
351
357
  LongUrl?: string;
@@ -377,18 +383,18 @@ export interface DescribeThirdPartyAuthCodeResponse {
377
383
  RequestId?: string;
378
384
  }
379
385
  /**
380
- * 被授权用户信息
386
+ * 被授权的用户信息
381
387
  */
382
388
  export interface HasAuthUser {
383
389
  /**
384
- * 用户id
390
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
385
391
  注意:此字段可能返回 null,表示取不到有效值。
386
392
  */
387
393
  UserId?: string;
388
394
  /**
389
- * 用户归属
390
- MainOrg:主企业
391
- CurrentOrg:当前企业
395
+ * 当前员工的归属情况,可能值是:
396
+ MainOrg:在集团企业的场景下,返回此值代表是归属主企业
397
+ CurrentOrg:在普通企业场景下返回此值;或者在集团企业的场景下,返回此值代表归属子企业
392
398
  注意:此字段可能返回 null,表示取不到有效值。
393
399
  */
394
400
  BelongTo?: string;
@@ -600,13 +606,10 @@ export interface CreateFlowEvidenceReportRequest {
600
606
  */
601
607
  export interface StartFlowResponse {
602
608
  /**
603
- * 发起成功之后返回状态,
604
-
605
- START-发起成功,
606
-
607
- REVIEW-提交审核成功,
608
-
609
- EXECUTING-已提交发起任务
609
+ * 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
610
+ START - 发起成功
611
+ REVIEW - 提交审核成功
612
+ EXECUTING - 已提交发起任务
610
613
  */
611
614
  Status?: string;
612
615
  /**
@@ -888,6 +891,11 @@ export interface FlowApproverDetail {
888
891
  注意:此字段可能返回 null,表示取不到有效值。
889
892
  */
890
893
  OrganizationName?: string;
894
+ /**
895
+ * 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
896
+ 注意:此字段可能返回 null,表示取不到有效值。
897
+ */
898
+ SignId?: string;
891
899
  }
892
900
  /**
893
901
  * CreateFlowGroupByFiles请求参数结构体
@@ -938,11 +946,12 @@ export interface DescribeFlowEvidenceReportResponse {
938
946
  */
939
947
  ReportUrl?: string;
940
948
  /**
941
- * 出证任务执行的状态, 分布表示下面的含义
942
-
943
- EvidenceStatusExecuting 出证任务在执行中
944
- EvidenceStatusSuccess 出证任务执行成功
945
- EvidenceStatusFailed 出证任务执行失败
949
+ * 签署报告出证任务的状态
950
+ <ul>
951
+ <li>EvidenceStatusExecuting : 出证任务在执行中</li>
952
+ <li>EvidenceStatusSuccess : 出证任务执行成功</li>
953
+ <li>EvidenceStatusFailed : 出证任务执行失败</li>
954
+ </ul>
946
955
  */
947
956
  Status?: string;
948
957
  /**
@@ -951,11 +960,11 @@ export interface DescribeFlowEvidenceReportResponse {
951
960
  RequestId?: string;
952
961
  }
953
962
  /**
954
- * 应用回调信息
963
+ * 企业应用回调信息
955
964
  */
956
965
  export interface CallbackInfo {
957
966
  /**
958
- * 回调url
967
+ * 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
959
968
  */
960
969
  CallbackUrl: string;
961
970
  /**
@@ -964,11 +973,11 @@ export interface CallbackInfo {
964
973
  */
965
974
  Token?: string;
966
975
  /**
967
- * 回调加密key
976
+ * 回调加密key,用于回调消息加解密。
968
977
  */
969
978
  CallbackKey?: string;
970
979
  /**
971
- * 回调验签token
980
+ * 回调验签token,用于回调通知校验。
972
981
  */
973
982
  CallbackToken?: string;
974
983
  }
@@ -1270,65 +1279,69 @@ export interface CreateFlowRequest {
1270
1279
  */
1271
1280
  export interface CreateSchemeUrlRequest {
1272
1281
  /**
1273
- * 调用方用户信息,userId 必填
1282
+ * 执行本接口操作的员工信息, userId 必填。
1283
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1274
1284
  */
1275
1285
  Operator: UserInfo;
1276
1286
  /**
1277
- * 企业名称
1287
+ * 合同流程签署方的组织机构名称。
1288
+ 如果名称中包含英文括号(),请使用中文括号()代替。
1278
1289
  */
1279
1290
  OrganizationName?: string;
1280
1291
  /**
1281
- * 姓名,最大长度50个字符
1292
+ * 合同流程里边签署方经办人的姓名。
1293
+
1282
1294
  */
1283
1295
  Name?: string;
1284
1296
  /**
1285
- * 手机号,大陆手机号11
1297
+ * 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
1286
1298
  */
1287
1299
  Mobile?: string;
1288
1300
  /**
1289
1301
  * 要跳转的链接类型
1290
1302
 
1291
- - HTTP:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认),此时返回长链
1292
- - HTTP_SHORT_URL:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链
1293
- - APP 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
1294
-
1303
+ <ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li>
1304
+ <li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li>
1305
+ <li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li></ul>
1295
1306
  */
1296
1307
  EndPoint?: string;
1297
1308
  /**
1298
- * 签署流程编号 (PathType=1时必传)
1309
+ * 合同流程ID
1310
+ 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
1299
1311
  */
1300
1312
  FlowId?: string;
1301
1313
  /**
1302
- * 合同组ID
1314
+ * 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值
1303
1315
  */
1304
1316
  FlowGroupId?: string;
1305
1317
  /**
1306
1318
  * 要跳转到的页面类型
1307
1319
 
1308
- - 0: 不传, 主页 (默认)
1309
- - 1: 小程序合同详情
1310
- - 2: 小程序合同列表页
1311
-
1320
+ <ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
1321
+ <li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
1322
+ <li> **2** : 腾讯电子签小程序合同列表页</li></ul>
1312
1323
  */
1313
1324
  PathType?: number;
1314
1325
  /**
1315
- * 是否自动回跳
1316
- true:是,
1317
- false:否。
1318
- 该参数只针对"APP" 类型的签署链接有效
1326
+ * 签署完成后是否自动回跳
1327
+ <ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>
1328
+ 注: ` 该参数只针对"APP" 类型的签署链接有效`
1319
1329
  */
1320
1330
  AutoJumpBack?: boolean;
1321
1331
  /**
1322
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1332
+ * 代理企业和员工的信息。
1333
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1323
1334
  */
1324
1335
  Agent?: Agent;
1325
1336
  /**
1326
- * 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
1337
+ * 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
1327
1338
 
1328
- - 0:合同签署页面更多操作按钮
1329
- - 1:合同签署页面更多操作的拒绝签署按钮
1330
- - 2:合同签署页面更多操作的转他人处理按钮
1331
- - 3:签署成功页的查看详情按钮
1339
+ <ul><li> **0** :合同签署页面更多操作按钮</li>
1340
+ <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
1341
+ <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
1342
+ <li> **3** :签署成功页的查看详情按钮</li></ul>
1343
+
1344
+ 注: `字段为数组, 可以传值隐藏多个按钮`
1332
1345
  */
1333
1346
  Hides?: Array<number | bigint>;
1334
1347
  }
@@ -1426,6 +1439,7 @@ export interface DescribeIntegrationMainOrganizationUserRequest {
1426
1439
  export interface CreateReleaseFlowResponse {
1427
1440
  /**
1428
1441
  * 解除协议流程编号
1442
+ `注意:这里的流程编号对应的合同是本次发起的解除协议。`
1429
1443
 
1430
1444
  */
1431
1445
  FlowId?: string;
@@ -1911,37 +1925,42 @@ export interface CreateBatchCancelFlowUrlResponse {
1911
1925
  */
1912
1926
  export interface UserThreeFactor {
1913
1927
  /**
1914
- * 姓名
1928
+ * 签署方经办人的姓名。
1929
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
1915
1930
  */
1916
1931
  Name: string;
1917
1932
  /**
1918
- * 证件类型:
1919
- ID_CARD 身份证
1920
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
1921
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
1933
+ * 证件类型,支持以下类型
1934
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
1935
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
1936
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
1922
1937
  */
1923
1938
  IdCardType: string;
1924
1939
  /**
1925
- * 证件号,如果有 X 请大写
1940
+ * 证件号码,应符合以下规则
1941
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1942
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
1943
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
1926
1944
  */
1927
1945
  IdCardNumber: string;
1928
1946
  }
1929
1947
  /**
1930
- * 一码多扫签署二维码对象
1948
+ * 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
1931
1949
  */
1932
1950
  export interface SignQrCode {
1933
1951
  /**
1934
- * 二维码id
1952
+ * 二维码ID,为32位字符串。
1935
1953
  */
1936
- QrCodeId: string;
1954
+ QrCodeId?: string;
1937
1955
  /**
1938
- * 二维码url
1956
+ * 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
1939
1957
  */
1940
- QrCodeUrl: string;
1958
+ QrCodeUrl?: string;
1941
1959
  /**
1942
- * 二维码过期时间戳,单位秒
1960
+ * 二维码的有截止时间,格式为Unix标准时间戳(秒)。
1961
+ 一旦超过二维码的有效期限,该二维码将自动失效。
1943
1962
  */
1944
- ExpiredTime: number;
1963
+ ExpiredTime?: number;
1945
1964
  }
1946
1965
  /**
1947
1966
  * CreateSealPolicy返回参数结构体
@@ -2105,7 +2124,11 @@ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
2105
2124
  */
2106
2125
  export interface CreateSchemeUrlResponse {
2107
2126
  /**
2108
- * 小程序链接地址,有效期90天。如果EndPoint是App,得到的链接Path如’weixin://dl/business/?t= *TICKET*‘,用于客户APP、小程序直接拉起电子签小程序;其他EndPoint得到的https链接如'https://essurl.cn/xxx',点击链接会打开一个H5页面,然后拉起电子签小程序。
2127
+ * 腾讯电子签小程序的签署链接。
2128
+
2129
+ <ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
2130
+ <li>如果EndPoint是**HTTP**,得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`,点击后会跳转到腾讯电子签小程序进行签署</li>
2131
+ <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
2109
2132
  */
2110
2133
  SchemeUrl?: string;
2111
2134
  /**
@@ -3504,21 +3527,27 @@ export interface CreateFlowByFilesRequest {
3504
3527
  */
3505
3528
  export interface CreateFlowSignUrlRequest {
3506
3529
  /**
3507
- * 流程编号
3530
+ * 合同流程ID,为32位字符串。
3531
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3532
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
3508
3533
  */
3509
3534
  FlowId: string;
3510
3535
  /**
3511
- * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。
3536
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
3512
3537
 
3513
- 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
3538
+ 注:
3539
+ `1. ApproverType目前只支持个人类型的签署人。`
3540
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
3514
3541
  */
3515
3542
  FlowApproverInfos: Array<FlowCreateApprover>;
3516
3543
  /**
3517
- * 用户信息,此结构体UserId必填
3544
+ * 执行本接口操作的员工信息。
3545
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3518
3546
  */
3519
3547
  Operator?: UserInfo;
3520
3548
  /**
3521
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3549
+ * 代理企业和员工的信息。
3550
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3522
3551
  */
3523
3552
  Agent?: Agent;
3524
3553
  /**
@@ -3527,7 +3556,7 @@ export interface CreateFlowSignUrlRequest {
3527
3556
  */
3528
3557
  Organization?: OrganizationInfo;
3529
3558
  /**
3530
- * 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
3559
+ * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
3531
3560
  */
3532
3561
  JumpUrl?: string;
3533
3562
  }
@@ -3536,31 +3565,42 @@ export interface CreateFlowSignUrlRequest {
3536
3565
  */
3537
3566
  export interface CreateReleaseFlowRequest {
3538
3567
  /**
3539
- * 调用方用户信息,userId 必填
3568
+ * 执行本接口操作的员工信息。
3569
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3540
3570
  */
3541
3571
  Operator: UserInfo;
3542
3572
  /**
3543
- * 待解除的签署流程编号(即原签署流程的编号)
3573
+ * 待解除的签署流程编号(即原签署流程的编号)。
3544
3574
  */
3545
3575
  NeedRelievedFlowId: string;
3546
3576
  /**
3547
- * 解除协议内容
3577
+ * 解除协议内容。
3548
3578
  */
3549
3579
  ReliveInfo: RelieveInfo;
3550
3580
  /**
3551
- * 非必须,解除协议的本企业签署人列表,
3552
- 默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
3553
- 解除协议的签署人数量不能多于原流程的签署人数量
3581
+ * 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3582
+ */
3583
+ Agent?: Agent;
3584
+ /**
3585
+ * 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
3586
+ 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3587
+ 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
3588
+
3589
+ `注意:只能更换同企业的签署人。`<br/>
3590
+ `注意:不支持更换个人类型的签署人。`<br/>
3554
3591
  */
3555
3592
  ReleasedApprovers?: Array<ReleasedApprover>;
3556
3593
  /**
3557
- * 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
3594
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
3595
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3558
3596
  */
3559
3597
  Deadline?: number;
3560
3598
  /**
3561
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3599
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
3600
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
3601
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
3562
3602
  */
3563
- Agent?: Agent;
3603
+ UserData?: string;
3564
3604
  }
3565
3605
  /**
3566
3606
  * CreateIntegrationUserRoles请求参数结构体
@@ -4118,11 +4158,15 @@ export interface RemindFlowRecords {
4118
4158
  */
4119
4159
  export interface CancelUserAutoSignEnableUrlRequest {
4120
4160
  /**
4121
- * 操作人信息,UseId必填
4161
+ * 执行本接口操作的员工信息。
4162
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4122
4163
  */
4123
4164
  Operator: UserInfo;
4124
4165
  /**
4125
- * 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
4166
+ * 企业开通用户自动签场景,例如电子处方。
4167
+ <ul>
4168
+ <li>E_PRESCRIPTION_AUTO_SIGN : 电子处方</li>
4169
+ </ul>
4126
4170
  */
4127
4171
  SceneKey: string;
4128
4172
  /**
@@ -4130,6 +4174,11 @@ export interface CancelUserAutoSignEnableUrlRequest {
4130
4174
 
4131
4175
  */
4132
4176
  UserInfo: UserThreeFactor;
4177
+ /**
4178
+ * 代理企业和员工的信息。
4179
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4180
+ */
4181
+ Agent?: Agent;
4133
4182
  }
4134
4183
  /**
4135
4184
  * 创建员工的失败数据
@@ -4340,15 +4389,17 @@ export interface GetTaskResultApiResponse {
4340
4389
  */
4341
4390
  export interface CancelMultiFlowSignQRCodeRequest {
4342
4391
  /**
4343
- * 调用方用户信息,userId 必填
4392
+ * 执行本接口操作的员工信息。
4393
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
4344
4394
  */
4345
4395
  Operator: UserInfo;
4346
4396
  /**
4347
- * 二维码id
4397
+ * 二维码ID,为32位字符串。
4348
4398
  */
4349
4399
  QrCodeId: string;
4350
4400
  /**
4351
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4401
+ * 代理企业和员工的信息。
4402
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4352
4403
  */
4353
4404
  Agent?: Agent;
4354
4405
  }
@@ -4397,19 +4448,23 @@ export interface WebThemeConfig {
4397
4448
  */
4398
4449
  export interface ModifyApplicationCallbackInfoRequest {
4399
4450
  /**
4400
- * 调用方用户信息,userId 必填
4451
+ * 执行本接口操作的员工信息。
4452
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4401
4453
  */
4402
4454
  Operator: UserInfo;
4403
4455
  /**
4404
- * 操作类型:1-新增,2-删除
4456
+ * 操作类型:
4457
+ 1-新增
4458
+ 2-删除
4405
4459
  */
4406
4460
  OperateType: number;
4407
4461
  /**
4408
- * 回调信息
4462
+ * 企业应用回调信息
4409
4463
  */
4410
4464
  CallbackInfo: CallbackInfo;
4411
4465
  /**
4412
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4466
+ * 代理企业和员工的信息。
4467
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4413
4468
  */
4414
4469
  Agent?: Agent;
4415
4470
  }
@@ -4438,27 +4493,29 @@ export interface IntegrationMainOrganizationUser {
4438
4493
  */
4439
4494
  export interface StartFlowRequest {
4440
4495
  /**
4441
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
4496
+ * 执行本接口操作的员工信息。
4497
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4442
4498
  */
4443
4499
  Operator: UserInfo;
4444
4500
  /**
4445
- * 签署流程编号,由CreateFlow接口返回
4501
+ * 合同流程ID,为32位字符串。
4502
+ 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
4446
4503
  */
4447
4504
  FlowId: string;
4448
4505
  /**
4449
4506
  * 客户端Token,保持接口幂等性,最大长度64个字符
4507
+ * @deprecated
4450
4508
  */
4451
4509
  ClientToken?: string;
4452
4510
  /**
4453
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4511
+ * 代理企业和员工的信息。
4512
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4454
4513
  */
4455
4514
  Agent?: Agent;
4456
4515
  /**
4457
- * 给关注人发送短信通知的类型,
4458
-
4459
- 0-合同发起时通知
4460
-
4461
- 1-签署完成后通知
4516
+ * 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
4517
+ 0 - 合同发起时通知(默认)
4518
+ 1 - 签署完成后通知
4462
4519
  */
4463
4520
  CcNotifyType?: number;
4464
4521
  }
@@ -4720,19 +4777,22 @@ export interface PermissionGroup {
4720
4777
  */
4721
4778
  export interface CancelFlowRequest {
4722
4779
  /**
4723
- * 调用方用户信息,userId 必填
4780
+ * 执行本接口操作的员工信息。
4781
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4724
4782
  */
4725
4783
  Operator: UserInfo;
4726
4784
  /**
4727
- * 签署流程id
4785
+ * 合同流程ID, 为32位字符串。
4786
+ 建议开发者保存此流程ID方便后续其他操作。
4728
4787
  */
4729
4788
  FlowId: string;
4730
4789
  /**
4731
- * 撤销原因,最长200个字符;
4790
+ * 撤销此合同(流程)的原因,最长200个字。
4732
4791
  */
4733
4792
  CancelMessage: string;
4734
4793
  /**
4735
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4794
+ * 代理企业和员工的信息。
4795
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4736
4796
  */
4737
4797
  Agent?: Agent;
4738
4798
  }
@@ -5041,22 +5101,26 @@ export interface IntegrationDepartment {
5041
5101
  */
5042
5102
  export interface DescribeExtendedServiceAuthInfosRequest {
5043
5103
  /**
5044
- * 操作人信息
5104
+ * 执行本接口操作的员工信息。
5105
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5045
5106
  */
5046
5107
  Operator: UserInfo;
5047
5108
  /**
5048
- * 代理相关应用信息,如集团主企业代子企业操作
5109
+ * 要查询的扩展服务类型。
5110
+ 默认为空,即查询当前支持的所有扩展服务信息。
5111
+ 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
5112
+ <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
5113
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
5114
+ <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
5115
+ <li>PAGING_SEAL:骑缝章</li>
5116
+ <li>BATCH_SIGN:批量签署</li></ul>
5049
5117
  */
5050
- Agent?: Agent;
5118
+ ExtendServiceType?: string;
5051
5119
  /**
5052
- * 扩展服务类型,默认为空,查询目前支持的所有扩展服务信息,单个指定则查询单个扩展服务开通信息,取值:
5053
- OPEN_SERVER_SIGN:开通企业静默签署
5054
- OVERSEA_SIGN:企业与港澳台居民签署合同
5055
- MOBILE_CHECK_APPROVER:使用手机号验证签署方身份
5056
- PAGING_SEAL:骑缝章
5057
- BATCH_SIGN:批量签署
5120
+ * 代理企业和员工的信息。
5121
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5058
5122
  */
5059
- ExtendServiceType?: string;
5123
+ Agent?: Agent;
5060
5124
  }
5061
5125
  /**
5062
5126
  * DescribeIntegrationRoles返回参数结构体
@@ -5164,21 +5228,24 @@ export interface CreateFlowGroupByTemplatesRequest {
5164
5228
  FlowGroupOptions?: FlowGroupOptions;
5165
5229
  }
5166
5230
  /**
5167
- * 一码多扫签署二维码签署信息
5231
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。
5232
+ 通过链接,用户可直接访问电子签名小程序并签署合同。
5168
5233
  */
5169
5234
  export interface SignUrl {
5170
5235
  /**
5171
- * 小程序签署链接
5236
+ * 跳转至电子签名小程序签署的链接地址。
5237
+ 适用于客户端APP及小程序直接唤起电子签名小程序。
5172
5238
  */
5173
- AppSignUrl: string;
5239
+ AppSignUrl?: string;
5174
5240
  /**
5175
- * 签署链接有效时间
5241
+ * 签署链接有效时间,格式类似"2022-08-05 15:55:01"
5176
5242
  */
5177
- EffectiveTime: string;
5243
+ EffectiveTime?: string;
5178
5244
  /**
5179
- * 移动端签署链接
5245
+ * 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。
5246
+ 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
5180
5247
  */
5181
- HttpSignUrl: string;
5248
+ HttpSignUrl?: string;
5182
5249
  }
5183
5250
  /**
5184
5251
  * VerifyPdf返回参数结构体
@@ -5326,39 +5393,40 @@ export interface UploadFilesRequest {
5326
5393
  FileUrls?: string;
5327
5394
  }
5328
5395
  /**
5329
- * 授权服务信息
5396
+ * 扩展服务开通和授权的详细信息
5330
5397
  */
5331
5398
  export interface ExtendAuthInfo {
5332
5399
  /**
5333
- * 授权服务类型
5334
- OPEN_SERVER_SIGN:开通企业静默签署
5335
- OVERSEA_SIGN:企业与港澳台居民签署合同
5336
- MOBILE_CHECK_APPROVER:使用手机号验证签署方身份
5337
- PAGING_SEAL:骑缝章
5338
- BATCH_SIGN:批量签署
5400
+ * 扩展服务的类型,可能是以下值:
5401
+ <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
5402
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
5403
+ <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
5404
+ <li>PAGING_SEAL:骑缝章</li>
5405
+ <li>BATCH_SIGN:批量签署</li></ul>
5339
5406
  */
5340
5407
  Type?: string;
5341
5408
  /**
5342
- * 授权服务名称
5409
+ * 扩展服务的名称
5343
5410
  */
5344
5411
  Name?: string;
5345
5412
  /**
5346
- * 授权服务状态,ENABLE:开通
5413
+ * 扩展服务的开通状态:
5414
+ ENABLE:开通
5347
5415
  DISABLE:未开通
5348
5416
  */
5349
5417
  Status?: string;
5350
5418
  /**
5351
- * 授权人用户id
5419
+ * 操作扩展服务的操作人UserId,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
5352
5420
  注意:此字段可能返回 null,表示取不到有效值。
5353
5421
  */
5354
5422
  OperatorUserId?: string;
5355
5423
  /**
5356
- * 授权时间戳,单位秒
5424
+ * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
5357
5425
  注意:此字段可能返回 null,表示取不到有效值。
5358
5426
  */
5359
5427
  OperateOn?: number;
5360
5428
  /**
5361
- * 被授权用户列表
5429
+ * 该扩展服务若可以授权,此参数对应授权人员的列表
5362
5430
  注意:此字段可能返回 null,表示取不到有效值。
5363
5431
  */
5364
5432
  HasAuthUserList?: Array<HasAuthUser>;
@@ -5435,40 +5503,45 @@ export interface CreateBatchCancelFlowUrlRequest {
5435
5503
  */
5436
5504
  export interface CreateMultiFlowSignQRCodeRequest {
5437
5505
  /**
5438
- * 用户信息,其中UserId为必填参数
5506
+ * 执行本接口操作的员工信息。
5507
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5439
5508
  */
5440
5509
  Operator: UserInfo;
5441
5510
  /**
5442
- * 模板ID
5511
+ * 合同模板ID,为32位字符串。
5512
+ 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
5443
5513
  */
5444
5514
  TemplateId: string;
5445
5515
  /**
5446
- * 签署流程名称,最大长度不超过200字符
5516
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
5517
+ 该名称还将用于合同签署完成后的下载文件名。
5447
5518
  */
5448
5519
  FlowName: string;
5449
5520
  /**
5450
- * 最大可发起签署流程份数,默认5
5451
- <br/>发起流程数量超过此上限后二维码自动失效
5521
+ * 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
5522
+ 一旦发起流程数超越该限制,该二维码将自动失效。
5452
5523
  */
5453
5524
  MaxFlowNum?: number;
5454
5525
  /**
5455
- * 签署流程有效天数
5456
- <br/>默认7天
5457
- <br/>最高设置不超过30天
5526
+ * 二维码的有效期限,默认为7天,最高设定不得超过90天。
5527
+ 一旦超过二维码的有效期限,该二维码将自动失效。
5458
5528
  */
5459
- FlowEffectiveDay?: number;
5529
+ QrEffectiveDay?: number;
5460
5530
  /**
5461
- * 二维码有效天数 默认7天 最高设置不超过90天
5531
+ * 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
5532
+ 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
5533
+ 最长设定期限不得超过30天。
5462
5534
  */
5463
- QrEffectiveDay?: number;
5535
+ FlowEffectiveDay?: number;
5464
5536
  /**
5465
- * 指定的签署人信息
5466
- <br/>指定后,则只允许指定的签署人扫码签署
5537
+ * 指定签署人信息。
5538
+ 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
5467
5539
  */
5468
5540
  Restrictions?: Array<ApproverRestriction>;
5469
5541
  /**
5470
- * 用户自定义字段
5471
- <br/>回调的时候会进行透传,长度需要小于20480
5542
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
5543
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
5544
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
5472
5545
  */
5473
5546
  UserData?: string;
5474
5547
  /**
@@ -5480,7 +5553,8 @@ export interface CreateMultiFlowSignQRCodeRequest {
5480
5553
  */
5481
5554
  CallbackUrl?: string;
5482
5555
  /**
5483
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5556
+ * 代理企业和员工的信息。
5557
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5484
5558
  */
5485
5559
  Agent?: Agent;
5486
5560
  /**
@@ -5736,7 +5810,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
5736
5810
  */
5737
5811
  export interface DescribeExtendedServiceAuthInfosResponse {
5738
5812
  /**
5739
- * 授权服务信息列表
5813
+ * 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
5740
5814
  */
5741
5815
  AuthInfoList?: Array<ExtendAuthInfo>;
5742
5816
  /**