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.
@@ -131,16 +131,17 @@ export interface CancelFlowResponse {
131
131
  */
132
132
  export interface DescribeFlowEvidenceReportRequest {
133
133
  /**
134
- * 调用方用户信息,userId 必填
134
+ * 执行本接口操作的员工信息。
135
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
135
136
  */
136
137
  Operator: UserInfo
137
138
  /**
138
- * 出证报告编号
139
+ * 签署报告编号
139
140
  */
140
141
  ReportId: string
141
142
  /**
142
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
143
-
143
+ * 代理企业和员工的信息。
144
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
144
145
  */
145
146
  Agent?: Agent
146
147
  }
@@ -337,11 +338,11 @@ export interface ModifyApplicationCallbackInfoResponse {
337
338
  */
338
339
  export interface CreateMultiFlowSignQRCodeResponse {
339
340
  /**
340
- * 签署二维码对象
341
+ * 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
341
342
  */
342
343
  QrCode?: SignQrCode
343
344
  /**
344
- * 签署链接对象
345
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
345
346
  */
346
347
  SignUrls?: SignUrl
347
348
  /**
@@ -355,12 +356,16 @@ export interface CreateMultiFlowSignQRCodeResponse {
355
356
  */
356
357
  export interface FlowApproverUrlInfo {
357
358
  /**
358
- * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
359
+ * 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
360
+ 注: `注意该链接有效期为30分钟`
359
361
  注意:此字段可能返回 null,表示取不到有效值。
360
362
  */
361
363
  SignUrl?: string
362
364
  /**
363
- * 签署人类型 1-个人
365
+ * 签署参与人类型
366
+ <ul><li> **1** :个人参与方</li></ul>
367
+
368
+ 注: `现在仅支持个人参与方`
364
369
  注意:此字段可能返回 null,表示取不到有效值。
365
370
  */
366
371
  ApproverType?: number
@@ -375,7 +380,8 @@ export interface FlowApproverUrlInfo {
375
380
  */
376
381
  ApproverMobile?: string
377
382
  /**
378
- * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
383
+ * 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
384
+ 注: `注意该链接有效期为30分钟`
379
385
  注意:此字段可能返回 null,表示取不到有效值。
380
386
  */
381
387
  LongUrl?: string
@@ -410,18 +416,18 @@ export interface DescribeThirdPartyAuthCodeResponse {
410
416
  }
411
417
 
412
418
  /**
413
- * 被授权用户信息
419
+ * 被授权的用户信息
414
420
  */
415
421
  export interface HasAuthUser {
416
422
  /**
417
- * 用户id
423
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
418
424
  注意:此字段可能返回 null,表示取不到有效值。
419
425
  */
420
426
  UserId?: string
421
427
  /**
422
- * 用户归属
423
- MainOrg:主企业
424
- CurrentOrg:当前企业
428
+ * 当前员工的归属情况,可能值是:
429
+ MainOrg:在集团企业的场景下,返回此值代表是归属主企业
430
+ CurrentOrg:在普通企业场景下返回此值;或者在集团企业的场景下,返回此值代表归属子企业
425
431
  注意:此字段可能返回 null,表示取不到有效值。
426
432
  */
427
433
  BelongTo?: string
@@ -642,13 +648,10 @@ export interface CreateFlowEvidenceReportRequest {
642
648
  */
643
649
  export interface StartFlowResponse {
644
650
  /**
645
- * 发起成功之后返回状态,
646
-
647
- START-发起成功,
648
-
649
- REVIEW-提交审核成功,
650
-
651
- EXECUTING-已提交发起任务
651
+ * 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
652
+ START - 发起成功
653
+ REVIEW - 提交审核成功
654
+ EXECUTING - 已提交发起任务
652
655
  */
653
656
  Status?: string
654
657
  /**
@@ -940,6 +943,11 @@ export interface FlowApproverDetail {
940
943
  注意:此字段可能返回 null,表示取不到有效值。
941
944
  */
942
945
  OrganizationName?: string
946
+ /**
947
+ * 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
948
+ 注意:此字段可能返回 null,表示取不到有效值。
949
+ */
950
+ SignId?: string
943
951
  }
944
952
 
945
953
  /**
@@ -993,11 +1001,12 @@ export interface DescribeFlowEvidenceReportResponse {
993
1001
  */
994
1002
  ReportUrl?: string
995
1003
  /**
996
- * 出证任务执行的状态, 分布表示下面的含义
997
-
998
- EvidenceStatusExecuting 出证任务在执行中
999
- EvidenceStatusSuccess 出证任务执行成功
1000
- EvidenceStatusFailed 出证任务执行失败
1004
+ * 签署报告出证任务的状态
1005
+ <ul>
1006
+ <li>EvidenceStatusExecuting : 出证任务在执行中</li>
1007
+ <li>EvidenceStatusSuccess : 出证任务执行成功</li>
1008
+ <li>EvidenceStatusFailed : 出证任务执行失败</li>
1009
+ </ul>
1001
1010
  */
1002
1011
  Status?: string
1003
1012
  /**
@@ -1007,11 +1016,11 @@ EvidenceStatusFailed 出证任务执行失败
1007
1016
  }
1008
1017
 
1009
1018
  /**
1010
- * 应用回调信息
1019
+ * 企业应用回调信息
1011
1020
  */
1012
1021
  export interface CallbackInfo {
1013
1022
  /**
1014
- * 回调url
1023
+ * 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
1015
1024
  */
1016
1025
  CallbackUrl: string
1017
1026
  /**
@@ -1020,11 +1029,11 @@ export interface CallbackInfo {
1020
1029
  */
1021
1030
  Token?: string
1022
1031
  /**
1023
- * 回调加密key
1032
+ * 回调加密key,用于回调消息加解密。
1024
1033
  */
1025
1034
  CallbackKey?: string
1026
1035
  /**
1027
- * 回调验签token
1036
+ * 回调验签token,用于回调通知校验。
1028
1037
  */
1029
1038
  CallbackToken?: string
1030
1039
  }
@@ -1334,65 +1343,69 @@ false:有序签
1334
1343
  */
1335
1344
  export interface CreateSchemeUrlRequest {
1336
1345
  /**
1337
- * 调用方用户信息,userId 必填
1346
+ * 执行本接口操作的员工信息, userId 必填。
1347
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1338
1348
  */
1339
1349
  Operator: UserInfo
1340
1350
  /**
1341
- * 企业名称
1351
+ * 合同流程签署方的组织机构名称。
1352
+ 如果名称中包含英文括号(),请使用中文括号()代替。
1342
1353
  */
1343
1354
  OrganizationName?: string
1344
1355
  /**
1345
- * 姓名,最大长度50个字符
1356
+ * 合同流程里边签署方经办人的姓名。
1357
+
1346
1358
  */
1347
1359
  Name?: string
1348
1360
  /**
1349
- * 手机号,大陆手机号11
1361
+ * 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
1350
1362
  */
1351
1363
  Mobile?: string
1352
1364
  /**
1353
1365
  * 要跳转的链接类型
1354
1366
 
1355
- - HTTP:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认),此时返回长链
1356
- - HTTP_SHORT_URL:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链
1357
- - APP 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
1358
-
1367
+ <ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li>
1368
+ <li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li>
1369
+ <li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li></ul>
1359
1370
  */
1360
1371
  EndPoint?: string
1361
1372
  /**
1362
- * 签署流程编号 (PathType=1时必传)
1373
+ * 合同流程ID
1374
+ 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
1363
1375
  */
1364
1376
  FlowId?: string
1365
1377
  /**
1366
- * 合同组ID
1378
+ * 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值
1367
1379
  */
1368
1380
  FlowGroupId?: string
1369
1381
  /**
1370
1382
  * 要跳转到的页面类型
1371
1383
 
1372
- - 0: 不传, 主页 (默认)
1373
- - 1: 小程序合同详情
1374
- - 2: 小程序合同列表页
1375
-
1384
+ <ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
1385
+ <li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
1386
+ <li> **2** : 腾讯电子签小程序合同列表页</li></ul>
1376
1387
  */
1377
1388
  PathType?: number
1378
1389
  /**
1379
- * 是否自动回跳
1380
- true:是,
1381
- false:否。
1382
- 该参数只针对"APP" 类型的签署链接有效
1390
+ * 签署完成后是否自动回跳
1391
+ <ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>
1392
+ 注: ` 该参数只针对"APP" 类型的签署链接有效`
1383
1393
  */
1384
1394
  AutoJumpBack?: boolean
1385
1395
  /**
1386
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1396
+ * 代理企业和员工的信息。
1397
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1387
1398
  */
1388
1399
  Agent?: Agent
1389
1400
  /**
1390
- * 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
1401
+ * 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
1391
1402
 
1392
- - 0:合同签署页面更多操作按钮
1393
- - 1:合同签署页面更多操作的拒绝签署按钮
1394
- - 2:合同签署页面更多操作的转他人处理按钮
1395
- - 3:签署成功页的查看详情按钮
1403
+ <ul><li> **0** :合同签署页面更多操作按钮</li>
1404
+ <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
1405
+ <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
1406
+ <li> **3** :签署成功页的查看详情按钮</li></ul>
1407
+
1408
+ 注: `字段为数组, 可以传值隐藏多个按钮`
1396
1409
  */
1397
1410
  Hides?: Array<number | bigint>
1398
1411
  }
@@ -1495,6 +1508,7 @@ export interface DescribeIntegrationMainOrganizationUserRequest {
1495
1508
  export interface CreateReleaseFlowResponse {
1496
1509
  /**
1497
1510
  * 解除协议流程编号
1511
+ `注意:这里的流程编号对应的合同是本次发起的解除协议。`
1498
1512
 
1499
1513
  */
1500
1514
  FlowId?: string
@@ -1996,38 +2010,43 @@ export interface CreateBatchCancelFlowUrlResponse {
1996
2010
  */
1997
2011
  export interface UserThreeFactor {
1998
2012
  /**
1999
- * 姓名
2013
+ * 签署方经办人的姓名。
2014
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2000
2015
  */
2001
2016
  Name: string
2002
2017
  /**
2003
- * 证件类型:
2004
- ID_CARD 身份证
2005
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
2006
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
2018
+ * 证件类型,支持以下类型
2019
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
2020
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
2021
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
2007
2022
  */
2008
2023
  IdCardType: string
2009
2024
  /**
2010
- * 证件号,如果有 X 请大写
2025
+ * 证件号码,应符合以下规则
2026
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
2027
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
2028
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
2011
2029
  */
2012
2030
  IdCardNumber: string
2013
2031
  }
2014
2032
 
2015
2033
  /**
2016
- * 一码多扫签署二维码对象
2034
+ * 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
2017
2035
  */
2018
2036
  export interface SignQrCode {
2019
2037
  /**
2020
- * 二维码id
2038
+ * 二维码ID,为32位字符串。
2021
2039
  */
2022
- QrCodeId: string
2040
+ QrCodeId?: string
2023
2041
  /**
2024
- * 二维码url
2042
+ * 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
2025
2043
  */
2026
- QrCodeUrl: string
2044
+ QrCodeUrl?: string
2027
2045
  /**
2028
- * 二维码过期时间戳,单位秒
2046
+ * 二维码的有截止时间,格式为Unix标准时间戳(秒)。
2047
+ 一旦超过二维码的有效期限,该二维码将自动失效。
2029
2048
  */
2030
- ExpiredTime: number
2049
+ ExpiredTime?: number
2031
2050
  }
2032
2051
 
2033
2052
  /**
@@ -2199,7 +2218,11 @@ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
2199
2218
  */
2200
2219
  export interface CreateSchemeUrlResponse {
2201
2220
  /**
2202
- * 小程序链接地址,有效期90天。如果EndPoint是App,得到的链接Path如’weixin://dl/business/?t= *TICKET*‘,用于客户APP、小程序直接拉起电子签小程序;其他EndPoint得到的https链接如'https://essurl.cn/xxx',点击链接会打开一个H5页面,然后拉起电子签小程序。
2221
+ * 腾讯电子签小程序的签署链接。
2222
+
2223
+ <ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
2224
+ <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>
2225
+ <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
2203
2226
  */
2204
2227
  SchemeUrl?: string
2205
2228
  /**
@@ -3632,21 +3655,27 @@ export interface CreateFlowByFilesRequest {
3632
3655
  */
3633
3656
  export interface CreateFlowSignUrlRequest {
3634
3657
  /**
3635
- * 流程编号
3658
+ * 合同流程ID,为32位字符串。
3659
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3660
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
3636
3661
  */
3637
3662
  FlowId: string
3638
3663
  /**
3639
- * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。
3664
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
3640
3665
 
3641
- 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
3666
+ 注:
3667
+ `1. ApproverType目前只支持个人类型的签署人。`
3668
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
3642
3669
  */
3643
3670
  FlowApproverInfos: Array<FlowCreateApprover>
3644
3671
  /**
3645
- * 用户信息,此结构体UserId必填
3672
+ * 执行本接口操作的员工信息。
3673
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3646
3674
  */
3647
3675
  Operator?: UserInfo
3648
3676
  /**
3649
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3677
+ * 代理企业和员工的信息。
3678
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3650
3679
  */
3651
3680
  Agent?: Agent
3652
3681
  /**
@@ -3655,7 +3684,7 @@ export interface CreateFlowSignUrlRequest {
3655
3684
  */
3656
3685
  Organization?: OrganizationInfo
3657
3686
  /**
3658
- * 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
3687
+ * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
3659
3688
  */
3660
3689
  JumpUrl?: string
3661
3690
  }
@@ -3665,31 +3694,42 @@ export interface CreateFlowSignUrlRequest {
3665
3694
  */
3666
3695
  export interface CreateReleaseFlowRequest {
3667
3696
  /**
3668
- * 调用方用户信息,userId 必填
3697
+ * 执行本接口操作的员工信息。
3698
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3669
3699
  */
3670
3700
  Operator: UserInfo
3671
3701
  /**
3672
- * 待解除的签署流程编号(即原签署流程的编号)
3702
+ * 待解除的签署流程编号(即原签署流程的编号)。
3673
3703
  */
3674
3704
  NeedRelievedFlowId: string
3675
3705
  /**
3676
- * 解除协议内容
3706
+ * 解除协议内容。
3677
3707
  */
3678
3708
  ReliveInfo: RelieveInfo
3679
3709
  /**
3680
- * 非必须,解除协议的本企业签署人列表,
3681
- 默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
3682
- 解除协议的签署人数量不能多于原流程的签署人数量
3710
+ * 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3711
+ */
3712
+ Agent?: Agent
3713
+ /**
3714
+ * 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
3715
+ 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3716
+ 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
3717
+
3718
+ `注意:只能更换同企业的签署人。`<br/>
3719
+ `注意:不支持更换个人类型的签署人。`<br/>
3683
3720
  */
3684
3721
  ReleasedApprovers?: Array<ReleasedApprover>
3685
3722
  /**
3686
- * 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
3723
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
3724
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3687
3725
  */
3688
3726
  Deadline?: number
3689
3727
  /**
3690
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3728
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
3729
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
3730
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
3691
3731
  */
3692
- Agent?: Agent
3732
+ UserData?: string
3693
3733
  }
3694
3734
 
3695
3735
  /**
@@ -4267,11 +4307,15 @@ true - 可以,false - 不可以。
4267
4307
  */
4268
4308
  export interface CancelUserAutoSignEnableUrlRequest {
4269
4309
  /**
4270
- * 操作人信息,UseId必填
4310
+ * 执行本接口操作的员工信息。
4311
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4271
4312
  */
4272
4313
  Operator: UserInfo
4273
4314
  /**
4274
- * 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
4315
+ * 企业开通用户自动签场景,例如电子处方。
4316
+ <ul>
4317
+ <li>E_PRESCRIPTION_AUTO_SIGN : 电子处方</li>
4318
+ </ul>
4275
4319
  */
4276
4320
  SceneKey: string
4277
4321
  /**
@@ -4279,6 +4323,11 @@ export interface CancelUserAutoSignEnableUrlRequest {
4279
4323
 
4280
4324
  */
4281
4325
  UserInfo: UserThreeFactor
4326
+ /**
4327
+ * 代理企业和员工的信息。
4328
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4329
+ */
4330
+ Agent?: Agent
4282
4331
  }
4283
4332
 
4284
4333
  /**
@@ -4498,15 +4547,17 @@ ProcessTimeout - 转换文件超时
4498
4547
  */
4499
4548
  export interface CancelMultiFlowSignQRCodeRequest {
4500
4549
  /**
4501
- * 调用方用户信息,userId 必填
4550
+ * 执行本接口操作的员工信息。
4551
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
4502
4552
  */
4503
4553
  Operator: UserInfo
4504
4554
  /**
4505
- * 二维码id
4555
+ * 二维码ID,为32位字符串。
4506
4556
  */
4507
4557
  QrCodeId: string
4508
4558
  /**
4509
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4559
+ * 代理企业和员工的信息。
4560
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4510
4561
  */
4511
4562
  Agent?: Agent
4512
4563
  }
@@ -4558,19 +4609,23 @@ export interface WebThemeConfig {
4558
4609
  */
4559
4610
  export interface ModifyApplicationCallbackInfoRequest {
4560
4611
  /**
4561
- * 调用方用户信息,userId 必填
4612
+ * 执行本接口操作的员工信息。
4613
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4562
4614
  */
4563
4615
  Operator: UserInfo
4564
4616
  /**
4565
- * 操作类型:1-新增,2-删除
4617
+ * 操作类型:
4618
+ 1-新增
4619
+ 2-删除
4566
4620
  */
4567
4621
  OperateType: number
4568
4622
  /**
4569
- * 回调信息
4623
+ * 企业应用回调信息
4570
4624
  */
4571
4625
  CallbackInfo: CallbackInfo
4572
4626
  /**
4573
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4627
+ * 代理企业和员工的信息。
4628
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4574
4629
  */
4575
4630
  Agent?: Agent
4576
4631
  }
@@ -4601,27 +4656,29 @@ export interface IntegrationMainOrganizationUser {
4601
4656
  */
4602
4657
  export interface StartFlowRequest {
4603
4658
  /**
4604
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
4659
+ * 执行本接口操作的员工信息。
4660
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4605
4661
  */
4606
4662
  Operator: UserInfo
4607
4663
  /**
4608
- * 签署流程编号,由CreateFlow接口返回
4664
+ * 合同流程ID,为32位字符串。
4665
+ 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
4609
4666
  */
4610
4667
  FlowId: string
4611
4668
  /**
4612
4669
  * 客户端Token,保持接口幂等性,最大长度64个字符
4670
+ * @deprecated
4613
4671
  */
4614
4672
  ClientToken?: string
4615
4673
  /**
4616
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4674
+ * 代理企业和员工的信息。
4675
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4617
4676
  */
4618
4677
  Agent?: Agent
4619
4678
  /**
4620
- * 给关注人发送短信通知的类型,
4621
-
4622
- 0-合同发起时通知
4623
-
4624
- 1-签署完成后通知
4679
+ * 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
4680
+ 0 - 合同发起时通知(默认)
4681
+ 1 - 签署完成后通知
4625
4682
  */
4626
4683
  CcNotifyType?: number
4627
4684
  }
@@ -4891,19 +4948,22 @@ export interface PermissionGroup {
4891
4948
  */
4892
4949
  export interface CancelFlowRequest {
4893
4950
  /**
4894
- * 调用方用户信息,userId 必填
4951
+ * 执行本接口操作的员工信息。
4952
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4895
4953
  */
4896
4954
  Operator: UserInfo
4897
4955
  /**
4898
- * 签署流程id
4956
+ * 合同流程ID, 为32位字符串。
4957
+ 建议开发者保存此流程ID方便后续其他操作。
4899
4958
  */
4900
4959
  FlowId: string
4901
4960
  /**
4902
- * 撤销原因,最长200个字符;
4961
+ * 撤销此合同(流程)的原因,最长200个字。
4903
4962
  */
4904
4963
  CancelMessage: string
4905
4964
  /**
4906
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4965
+ * 代理企业和员工的信息。
4966
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4907
4967
  */
4908
4968
  Agent?: Agent
4909
4969
  }
@@ -5216,22 +5276,26 @@ export interface IntegrationDepartment {
5216
5276
  */
5217
5277
  export interface DescribeExtendedServiceAuthInfosRequest {
5218
5278
  /**
5219
- * 操作人信息
5279
+ * 执行本接口操作的员工信息。
5280
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5220
5281
  */
5221
5282
  Operator: UserInfo
5222
5283
  /**
5223
- * 代理相关应用信息,如集团主企业代子企业操作
5284
+ * 要查询的扩展服务类型。
5285
+ 默认为空,即查询当前支持的所有扩展服务信息。
5286
+ 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
5287
+ <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
5288
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
5289
+ <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
5290
+ <li>PAGING_SEAL:骑缝章</li>
5291
+ <li>BATCH_SIGN:批量签署</li></ul>
5224
5292
  */
5225
- Agent?: Agent
5293
+ ExtendServiceType?: string
5226
5294
  /**
5227
- * 扩展服务类型,默认为空,查询目前支持的所有扩展服务信息,单个指定则查询单个扩展服务开通信息,取值:
5228
- OPEN_SERVER_SIGN:开通企业静默签署
5229
- OVERSEA_SIGN:企业与港澳台居民签署合同
5230
- MOBILE_CHECK_APPROVER:使用手机号验证签署方身份
5231
- PAGING_SEAL:骑缝章
5232
- BATCH_SIGN:批量签署
5295
+ * 代理企业和员工的信息。
5296
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5233
5297
  */
5234
- ExtendServiceType?: string
5298
+ Agent?: Agent
5235
5299
  }
5236
5300
 
5237
5301
  /**
@@ -5345,21 +5409,24 @@ export interface CreateFlowGroupByTemplatesRequest {
5345
5409
  }
5346
5410
 
5347
5411
  /**
5348
- * 一码多扫签署二维码签署信息
5412
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。
5413
+ 通过链接,用户可直接访问电子签名小程序并签署合同。
5349
5414
  */
5350
5415
  export interface SignUrl {
5351
5416
  /**
5352
- * 小程序签署链接
5417
+ * 跳转至电子签名小程序签署的链接地址。
5418
+ 适用于客户端APP及小程序直接唤起电子签名小程序。
5353
5419
  */
5354
- AppSignUrl: string
5420
+ AppSignUrl?: string
5355
5421
  /**
5356
- * 签署链接有效时间
5422
+ * 签署链接有效时间,格式类似"2022-08-05 15:55:01"
5357
5423
  */
5358
- EffectiveTime: string
5424
+ EffectiveTime?: string
5359
5425
  /**
5360
- * 移动端签署链接
5426
+ * 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。
5427
+ 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
5361
5428
  */
5362
- HttpSignUrl: string
5429
+ HttpSignUrl?: string
5363
5430
  }
5364
5431
 
5365
5432
  /**
@@ -5515,39 +5582,40 @@ true--是,处理置白
5515
5582
  }
5516
5583
 
5517
5584
  /**
5518
- * 授权服务信息
5585
+ * 扩展服务开通和授权的详细信息
5519
5586
  */
5520
5587
  export interface ExtendAuthInfo {
5521
5588
  /**
5522
- * 授权服务类型
5523
- OPEN_SERVER_SIGN:开通企业静默签署
5524
- OVERSEA_SIGN:企业与港澳台居民签署合同
5525
- MOBILE_CHECK_APPROVER:使用手机号验证签署方身份
5526
- PAGING_SEAL:骑缝章
5527
- BATCH_SIGN:批量签署
5589
+ * 扩展服务的类型,可能是以下值:
5590
+ <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
5591
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
5592
+ <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
5593
+ <li>PAGING_SEAL:骑缝章</li>
5594
+ <li>BATCH_SIGN:批量签署</li></ul>
5528
5595
  */
5529
5596
  Type?: string
5530
5597
  /**
5531
- * 授权服务名称
5598
+ * 扩展服务的名称
5532
5599
  */
5533
5600
  Name?: string
5534
5601
  /**
5535
- * 授权服务状态,ENABLE:开通
5602
+ * 扩展服务的开通状态:
5603
+ ENABLE:开通
5536
5604
  DISABLE:未开通
5537
5605
  */
5538
5606
  Status?: string
5539
5607
  /**
5540
- * 授权人用户id
5608
+ * 操作扩展服务的操作人UserId,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
5541
5609
  注意:此字段可能返回 null,表示取不到有效值。
5542
5610
  */
5543
5611
  OperatorUserId?: string
5544
5612
  /**
5545
- * 授权时间戳,单位秒
5613
+ * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
5546
5614
  注意:此字段可能返回 null,表示取不到有效值。
5547
5615
  */
5548
5616
  OperateOn?: number
5549
5617
  /**
5550
- * 被授权用户列表
5618
+ * 该扩展服务若可以授权,此参数对应授权人员的列表
5551
5619
  注意:此字段可能返回 null,表示取不到有效值。
5552
5620
  */
5553
5621
  HasAuthUserList?: Array<HasAuthUser>
@@ -5628,40 +5696,45 @@ export interface CreateBatchCancelFlowUrlRequest {
5628
5696
  */
5629
5697
  export interface CreateMultiFlowSignQRCodeRequest {
5630
5698
  /**
5631
- * 用户信息,其中UserId为必填参数
5699
+ * 执行本接口操作的员工信息。
5700
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5632
5701
  */
5633
5702
  Operator: UserInfo
5634
5703
  /**
5635
- * 模板ID
5704
+ * 合同模板ID,为32位字符串。
5705
+ 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
5636
5706
  */
5637
5707
  TemplateId: string
5638
5708
  /**
5639
- * 签署流程名称,最大长度不超过200字符
5709
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
5710
+ 该名称还将用于合同签署完成后的下载文件名。
5640
5711
  */
5641
5712
  FlowName: string
5642
5713
  /**
5643
- * 最大可发起签署流程份数,默认5
5644
- <br/>发起流程数量超过此上限后二维码自动失效
5714
+ * 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
5715
+ 一旦发起流程数超越该限制,该二维码将自动失效。
5645
5716
  */
5646
5717
  MaxFlowNum?: number
5647
5718
  /**
5648
- * 签署流程有效天数
5649
- <br/>默认7天
5650
- <br/>最高设置不超过30天
5719
+ * 二维码的有效期限,默认为7天,最高设定不得超过90天。
5720
+ 一旦超过二维码的有效期限,该二维码将自动失效。
5651
5721
  */
5652
- FlowEffectiveDay?: number
5722
+ QrEffectiveDay?: number
5653
5723
  /**
5654
- * 二维码有效天数 默认7天 最高设置不超过90天
5724
+ * 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
5725
+ 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
5726
+ 最长设定期限不得超过30天。
5655
5727
  */
5656
- QrEffectiveDay?: number
5728
+ FlowEffectiveDay?: number
5657
5729
  /**
5658
- * 指定的签署人信息
5659
- <br/>指定后,则只允许指定的签署人扫码签署
5730
+ * 指定签署人信息。
5731
+ 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
5660
5732
  */
5661
5733
  Restrictions?: Array<ApproverRestriction>
5662
5734
  /**
5663
- * 用户自定义字段
5664
- <br/>回调的时候会进行透传,长度需要小于20480
5735
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
5736
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
5737
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
5665
5738
  */
5666
5739
  UserData?: string
5667
5740
  /**
@@ -5673,7 +5746,8 @@ export interface CreateMultiFlowSignQRCodeRequest {
5673
5746
  */
5674
5747
  CallbackUrl?: string
5675
5748
  /**
5676
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5749
+ * 代理企业和员工的信息。
5750
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5677
5751
  */
5678
5752
  Agent?: Agent
5679
5753
  /**
@@ -5939,7 +6013,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
5939
6013
  */
5940
6014
  export interface DescribeExtendedServiceAuthInfosResponse {
5941
6015
  /**
5942
- * 授权服务信息列表
6016
+ * 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
5943
6017
  */
5944
6018
  AuthInfoList?: Array<ExtendAuthInfo>
5945
6019
  /**