tencentcloud-sdk-nodejs-ess 4.0.680 → 4.0.682

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.
@@ -337,11 +337,11 @@ export interface ModifyApplicationCallbackInfoResponse {
337
337
  */
338
338
  export interface CreateMultiFlowSignQRCodeResponse {
339
339
  /**
340
- * 签署二维码对象
340
+ * 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
341
341
  */
342
342
  QrCode?: SignQrCode
343
343
  /**
344
- * 签署链接对象
344
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
345
345
  */
346
346
  SignUrls?: SignUrl
347
347
  /**
@@ -410,18 +410,18 @@ export interface DescribeThirdPartyAuthCodeResponse {
410
410
  }
411
411
 
412
412
  /**
413
- * 被授权用户信息
413
+ * 被授权的用户信息
414
414
  */
415
415
  export interface HasAuthUser {
416
416
  /**
417
- * 用户id
417
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
418
418
  注意:此字段可能返回 null,表示取不到有效值。
419
419
  */
420
420
  UserId?: string
421
421
  /**
422
- * 用户归属
423
- MainOrg:主企业
424
- CurrentOrg:当前企业
422
+ * 当前员工的归属情况,可能值是:
423
+ MainOrg:在集团企业的场景下,返回此值代表是归属主企业
424
+ CurrentOrg:在普通企业场景下返回此值;或者在集团企业的场景下,返回此值代表归属子企业
425
425
  注意:此字段可能返回 null,表示取不到有效值。
426
426
  */
427
427
  BelongTo?: string
@@ -642,13 +642,10 @@ export interface CreateFlowEvidenceReportRequest {
642
642
  */
643
643
  export interface StartFlowResponse {
644
644
  /**
645
- * 发起成功之后返回状态,
646
-
647
- START-发起成功,
648
-
649
- REVIEW-提交审核成功,
650
-
651
- EXECUTING-已提交发起任务
645
+ * 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
646
+ START - 发起成功
647
+ REVIEW - 提交审核成功
648
+ EXECUTING - 已提交发起任务
652
649
  */
653
650
  Status?: string
654
651
  /**
@@ -940,6 +937,11 @@ export interface FlowApproverDetail {
940
937
  注意:此字段可能返回 null,表示取不到有效值。
941
938
  */
942
939
  OrganizationName?: string
940
+ /**
941
+ * 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
942
+ 注意:此字段可能返回 null,表示取不到有效值。
943
+ */
944
+ SignId?: string
943
945
  }
944
946
 
945
947
  /**
@@ -1007,11 +1009,11 @@ EvidenceStatusFailed 出证任务执行失败
1007
1009
  }
1008
1010
 
1009
1011
  /**
1010
- * 应用回调信息
1012
+ * 企业应用回调信息
1011
1013
  */
1012
1014
  export interface CallbackInfo {
1013
1015
  /**
1014
- * 回调url
1016
+ * 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
1015
1017
  */
1016
1018
  CallbackUrl: string
1017
1019
  /**
@@ -1020,11 +1022,11 @@ export interface CallbackInfo {
1020
1022
  */
1021
1023
  Token?: string
1022
1024
  /**
1023
- * 回调加密key
1025
+ * 回调加密key,用于回调消息加解密。
1024
1026
  */
1025
1027
  CallbackKey?: string
1026
1028
  /**
1027
- * 回调验签token
1029
+ * 回调验签token,用于回调通知校验。
1028
1030
  */
1029
1031
  CallbackToken?: string
1030
1032
  }
@@ -1334,65 +1336,69 @@ false:有序签
1334
1336
  */
1335
1337
  export interface CreateSchemeUrlRequest {
1336
1338
  /**
1337
- * 调用方用户信息,userId 必填
1339
+ * 执行本接口操作的员工信息, userId 必填。
1340
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1338
1341
  */
1339
1342
  Operator: UserInfo
1340
1343
  /**
1341
- * 企业名称
1344
+ * 合同流程签署方的组织机构名称。
1345
+ 如果名称中包含英文括号(),请使用中文括号()代替。
1342
1346
  */
1343
1347
  OrganizationName?: string
1344
1348
  /**
1345
- * 姓名,最大长度50个字符
1349
+ * 合同流程里边签署方经办人的姓名。
1350
+
1346
1351
  */
1347
1352
  Name?: string
1348
1353
  /**
1349
- * 手机号,大陆手机号11
1354
+ * 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
1350
1355
  */
1351
1356
  Mobile?: string
1352
1357
  /**
1353
1358
  * 要跳转的链接类型
1354
1359
 
1355
- - HTTP:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认),此时返回长链
1356
- - HTTP_SHORT_URL:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链
1357
- - APP 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
1358
-
1360
+ <ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li>
1361
+ <li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li>
1362
+ <li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li></ul>
1359
1363
  */
1360
1364
  EndPoint?: string
1361
1365
  /**
1362
- * 签署流程编号 (PathType=1时必传)
1366
+ * 合同流程ID
1367
+ 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
1363
1368
  */
1364
1369
  FlowId?: string
1365
1370
  /**
1366
- * 合同组ID
1371
+ * 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值
1367
1372
  */
1368
1373
  FlowGroupId?: string
1369
1374
  /**
1370
1375
  * 要跳转到的页面类型
1371
1376
 
1372
- - 0: 不传, 主页 (默认)
1373
- - 1: 小程序合同详情
1374
- - 2: 小程序合同列表页
1375
-
1377
+ <ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
1378
+ <li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
1379
+ <li> **2** : 腾讯电子签小程序合同列表页</li></ul>
1376
1380
  */
1377
1381
  PathType?: number
1378
1382
  /**
1379
- * 是否自动回跳
1380
- true:是,
1381
- false:否。
1382
- 该参数只针对"APP" 类型的签署链接有效
1383
+ * 签署完成后是否自动回跳
1384
+ <ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>
1385
+ 注: ` 该参数只针对"APP" 类型的签署链接有效`
1383
1386
  */
1384
1387
  AutoJumpBack?: boolean
1385
1388
  /**
1386
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1389
+ * 代理企业和员工的信息。
1390
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1387
1391
  */
1388
1392
  Agent?: Agent
1389
1393
  /**
1390
- * 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
1394
+ * 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
1391
1395
 
1392
- - 0:合同签署页面更多操作按钮
1393
- - 1:合同签署页面更多操作的拒绝签署按钮
1394
- - 2:合同签署页面更多操作的转他人处理按钮
1395
- - 3:签署成功页的查看详情按钮
1396
+ <ul><li> **0** :合同签署页面更多操作按钮</li>
1397
+ <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
1398
+ <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
1399
+ <li> **3** :签署成功页的查看详情按钮</li></ul>
1400
+
1401
+ 注: `字段为数组, 可以传值隐藏多个按钮`
1396
1402
  */
1397
1403
  Hides?: Array<number | bigint>
1398
1404
  }
@@ -2013,21 +2019,22 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
2013
2019
  }
2014
2020
 
2015
2021
  /**
2016
- * 一码多扫签署二维码对象
2022
+ * 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
2017
2023
  */
2018
2024
  export interface SignQrCode {
2019
2025
  /**
2020
- * 二维码id
2026
+ * 二维码ID,为32位字符串。
2021
2027
  */
2022
- QrCodeId: string
2028
+ QrCodeId?: string
2023
2029
  /**
2024
- * 二维码url
2030
+ * 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
2025
2031
  */
2026
- QrCodeUrl: string
2032
+ QrCodeUrl?: string
2027
2033
  /**
2028
- * 二维码过期时间戳,单位秒
2034
+ * 二维码的有截止时间,格式为Unix标准时间戳(秒)。
2035
+ 一旦超过二维码的有效期限,该二维码将自动失效。
2029
2036
  */
2030
- ExpiredTime: number
2037
+ ExpiredTime?: number
2031
2038
  }
2032
2039
 
2033
2040
  /**
@@ -2199,7 +2206,11 @@ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
2199
2206
  */
2200
2207
  export interface CreateSchemeUrlResponse {
2201
2208
  /**
2202
- * 小程序链接地址,有效期90天。如果EndPoint是App,得到的链接Path如’weixin://dl/business/?t= *TICKET*‘,用于客户APP、小程序直接拉起电子签小程序;其他EndPoint得到的https链接如'https://essurl.cn/xxx',点击链接会打开一个H5页面,然后拉起电子签小程序。
2209
+ * 腾讯电子签小程序的签署链接。
2210
+
2211
+ <ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
2212
+ <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>
2213
+ <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
2203
2214
  */
2204
2215
  SchemeUrl?: string
2205
2216
  /**
@@ -4558,19 +4569,23 @@ export interface WebThemeConfig {
4558
4569
  */
4559
4570
  export interface ModifyApplicationCallbackInfoRequest {
4560
4571
  /**
4561
- * 调用方用户信息,userId 必填
4572
+ * 执行本接口操作的员工信息。
4573
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4562
4574
  */
4563
4575
  Operator: UserInfo
4564
4576
  /**
4565
- * 操作类型:1-新增,2-删除
4577
+ * 操作类型:
4578
+ 1-新增
4579
+ 2-删除
4566
4580
  */
4567
4581
  OperateType: number
4568
4582
  /**
4569
- * 回调信息
4583
+ * 企业应用回调信息
4570
4584
  */
4571
4585
  CallbackInfo: CallbackInfo
4572
4586
  /**
4573
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4587
+ * 代理企业和员工的信息。
4588
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4574
4589
  */
4575
4590
  Agent?: Agent
4576
4591
  }
@@ -4601,27 +4616,29 @@ export interface IntegrationMainOrganizationUser {
4601
4616
  */
4602
4617
  export interface StartFlowRequest {
4603
4618
  /**
4604
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
4619
+ * 执行本接口操作的员工信息。
4620
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4605
4621
  */
4606
4622
  Operator: UserInfo
4607
4623
  /**
4608
- * 签署流程编号,由CreateFlow接口返回
4624
+ * 合同流程ID,为32位字符串。
4625
+ 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
4609
4626
  */
4610
4627
  FlowId: string
4611
4628
  /**
4612
4629
  * 客户端Token,保持接口幂等性,最大长度64个字符
4630
+ * @deprecated
4613
4631
  */
4614
4632
  ClientToken?: string
4615
4633
  /**
4616
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4634
+ * 代理企业和员工的信息。
4635
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4617
4636
  */
4618
4637
  Agent?: Agent
4619
4638
  /**
4620
- * 给关注人发送短信通知的类型,
4621
-
4622
- 0-合同发起时通知
4623
-
4624
- 1-签署完成后通知
4639
+ * 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
4640
+ 0 - 合同发起时通知(默认)
4641
+ 1 - 签署完成后通知
4625
4642
  */
4626
4643
  CcNotifyType?: number
4627
4644
  }
@@ -5216,22 +5233,26 @@ export interface IntegrationDepartment {
5216
5233
  */
5217
5234
  export interface DescribeExtendedServiceAuthInfosRequest {
5218
5235
  /**
5219
- * 操作人信息
5236
+ * 执行本接口操作的员工信息。
5237
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5220
5238
  */
5221
5239
  Operator: UserInfo
5222
5240
  /**
5223
- * 代理相关应用信息,如集团主企业代子企业操作
5241
+ * 要查询的扩展服务类型。
5242
+ 默认为空,即查询当前支持的所有扩展服务信息。
5243
+ 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
5244
+ <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
5245
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
5246
+ <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
5247
+ <li>PAGING_SEAL:骑缝章</li>
5248
+ <li>BATCH_SIGN:批量签署</li></ul>
5224
5249
  */
5225
- Agent?: Agent
5250
+ ExtendServiceType?: string
5226
5251
  /**
5227
- * 扩展服务类型,默认为空,查询目前支持的所有扩展服务信息,单个指定则查询单个扩展服务开通信息,取值:
5228
- OPEN_SERVER_SIGN:开通企业静默签署
5229
- OVERSEA_SIGN:企业与港澳台居民签署合同
5230
- MOBILE_CHECK_APPROVER:使用手机号验证签署方身份
5231
- PAGING_SEAL:骑缝章
5232
- BATCH_SIGN:批量签署
5252
+ * 代理企业和员工的信息。
5253
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5233
5254
  */
5234
- ExtendServiceType?: string
5255
+ Agent?: Agent
5235
5256
  }
5236
5257
 
5237
5258
  /**
@@ -5345,21 +5366,24 @@ export interface CreateFlowGroupByTemplatesRequest {
5345
5366
  }
5346
5367
 
5347
5368
  /**
5348
- * 一码多扫签署二维码签署信息
5369
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。
5370
+ 通过链接,用户可直接访问电子签名小程序并签署合同。
5349
5371
  */
5350
5372
  export interface SignUrl {
5351
5373
  /**
5352
- * 小程序签署链接
5374
+ * 跳转至电子签名小程序签署的链接地址。
5375
+ 适用于客户端APP及小程序直接唤起电子签名小程序。
5353
5376
  */
5354
- AppSignUrl: string
5377
+ AppSignUrl?: string
5355
5378
  /**
5356
- * 签署链接有效时间
5379
+ * 签署链接有效时间,格式类似"2022-08-05 15:55:01"
5357
5380
  */
5358
- EffectiveTime: string
5381
+ EffectiveTime?: string
5359
5382
  /**
5360
- * 移动端签署链接
5383
+ * 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。
5384
+ 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
5361
5385
  */
5362
- HttpSignUrl: string
5386
+ HttpSignUrl?: string
5363
5387
  }
5364
5388
 
5365
5389
  /**
@@ -5515,39 +5539,40 @@ true--是,处理置白
5515
5539
  }
5516
5540
 
5517
5541
  /**
5518
- * 授权服务信息
5542
+ * 扩展服务开通和授权的详细信息
5519
5543
  */
5520
5544
  export interface ExtendAuthInfo {
5521
5545
  /**
5522
- * 授权服务类型
5523
- OPEN_SERVER_SIGN:开通企业静默签署
5524
- OVERSEA_SIGN:企业与港澳台居民签署合同
5525
- MOBILE_CHECK_APPROVER:使用手机号验证签署方身份
5526
- PAGING_SEAL:骑缝章
5527
- BATCH_SIGN:批量签署
5546
+ * 扩展服务的类型,可能是以下值:
5547
+ <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
5548
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
5549
+ <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
5550
+ <li>PAGING_SEAL:骑缝章</li>
5551
+ <li>BATCH_SIGN:批量签署</li></ul>
5528
5552
  */
5529
5553
  Type?: string
5530
5554
  /**
5531
- * 授权服务名称
5555
+ * 扩展服务的名称
5532
5556
  */
5533
5557
  Name?: string
5534
5558
  /**
5535
- * 授权服务状态,ENABLE:开通
5559
+ * 扩展服务的开通状态:
5560
+ ENABLE:开通
5536
5561
  DISABLE:未开通
5537
5562
  */
5538
5563
  Status?: string
5539
5564
  /**
5540
- * 授权人用户id
5565
+ * 操作扩展服务的操作人UserId,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
5541
5566
  注意:此字段可能返回 null,表示取不到有效值。
5542
5567
  */
5543
5568
  OperatorUserId?: string
5544
5569
  /**
5545
- * 授权时间戳,单位秒
5570
+ * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
5546
5571
  注意:此字段可能返回 null,表示取不到有效值。
5547
5572
  */
5548
5573
  OperateOn?: number
5549
5574
  /**
5550
- * 被授权用户列表
5575
+ * 该扩展服务若可以授权,此参数对应授权人员的列表
5551
5576
  注意:此字段可能返回 null,表示取不到有效值。
5552
5577
  */
5553
5578
  HasAuthUserList?: Array<HasAuthUser>
@@ -5628,40 +5653,45 @@ export interface CreateBatchCancelFlowUrlRequest {
5628
5653
  */
5629
5654
  export interface CreateMultiFlowSignQRCodeRequest {
5630
5655
  /**
5631
- * 用户信息,其中UserId为必填参数
5656
+ * 执行本接口操作的员工信息。
5657
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5632
5658
  */
5633
5659
  Operator: UserInfo
5634
5660
  /**
5635
- * 模板ID
5661
+ * 合同模板ID,为32位字符串。
5662
+ 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
5636
5663
  */
5637
5664
  TemplateId: string
5638
5665
  /**
5639
- * 签署流程名称,最大长度不超过200字符
5666
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
5667
+ 该名称还将用于合同签署完成后的下载文件名。
5640
5668
  */
5641
5669
  FlowName: string
5642
5670
  /**
5643
- * 最大可发起签署流程份数,默认5
5644
- <br/>发起流程数量超过此上限后二维码自动失效
5671
+ * 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
5672
+ 一旦发起流程数超越该限制,该二维码将自动失效。
5645
5673
  */
5646
5674
  MaxFlowNum?: number
5647
5675
  /**
5648
- * 签署流程有效天数
5649
- <br/>默认7天
5650
- <br/>最高设置不超过30天
5676
+ * 二维码的有效期限,默认为7天,最高设定不得超过90天。
5677
+ 一旦超过二维码的有效期限,该二维码将自动失效。
5651
5678
  */
5652
- FlowEffectiveDay?: number
5679
+ QrEffectiveDay?: number
5653
5680
  /**
5654
- * 二维码有效天数 默认7天 最高设置不超过90天
5681
+ * 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
5682
+ 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
5683
+ 最长设定期限不得超过30天。
5655
5684
  */
5656
- QrEffectiveDay?: number
5685
+ FlowEffectiveDay?: number
5657
5686
  /**
5658
- * 指定的签署人信息
5659
- <br/>指定后,则只允许指定的签署人扫码签署
5687
+ * 指定签署人信息。
5688
+ 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
5660
5689
  */
5661
5690
  Restrictions?: Array<ApproverRestriction>
5662
5691
  /**
5663
- * 用户自定义字段
5664
- <br/>回调的时候会进行透传,长度需要小于20480
5692
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
5693
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
5694
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
5665
5695
  */
5666
5696
  UserData?: string
5667
5697
  /**
@@ -5673,7 +5703,8 @@ export interface CreateMultiFlowSignQRCodeRequest {
5673
5703
  */
5674
5704
  CallbackUrl?: string
5675
5705
  /**
5676
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5706
+ * 代理企业和员工的信息。
5707
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5677
5708
  */
5678
5709
  Agent?: Agent
5679
5710
  /**
@@ -5939,7 +5970,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
5939
5970
  */
5940
5971
  export interface DescribeExtendedServiceAuthInfosResponse {
5941
5972
  /**
5942
- * 授权服务信息列表
5973
+ * 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
5943
5974
  */
5944
5975
  AuthInfoList?: Array<ExtendAuthInfo>
5945
5976
  /**
@@ -12,15 +12,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
12
12
  */
13
13
  DescribeFlowInfo(req: DescribeFlowInfoRequest, cb?: (error: string, rep: DescribeFlowInfoResponse) => void): Promise<DescribeFlowInfoResponse>;
14
14
  /**
15
- * 新增/删除应用callbackinfo
16
- callbackinfo包含: 回调地址和签名key
17
- 操作:新增/删除
15
+ * 新增/删除企业应用集成中的回调配置。
16
+ 新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
17
+ 请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
18
+ 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
18
19
  */
19
20
  ModifyApplicationCallbackInfo(req: ModifyApplicationCallbackInfoRequest, cb?: (error: string, rep: ModifyApplicationCallbackInfoResponse) => void): Promise<ModifyApplicationCallbackInfoResponse>;
20
21
  /**
21
- * 此接口用于发起流程
22
- 适用场景:见创建签署流程接口。
23
- 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
22
+ * 此接口用于启动流程。它是模板发起合同的最后一步。
23
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于激活包含完整合同信息(模板及内容信息)的流程。
24
+ 流程激活后,将生成一份待签署的电子合同。
24
25
  */
25
26
  StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
26
27
  /**
@@ -143,7 +144,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
143
144
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
144
145
  /**
145
146
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
146
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
147
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
148
+ 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
147
149
 
148
150
  **本接口适用于发起方没有填写控件的 B2C或者单C模板**
149
151
 
@@ -184,8 +186,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
184
186
  */
185
187
  CreateFlowGroupByTemplates(req: CreateFlowGroupByTemplatesRequest, cb?: (error: string, rep: CreateFlowGroupByTemplatesResponse) => void): Promise<CreateFlowGroupByTemplatesResponse>;
186
188
  /**
187
- * 查询企业扩展服务授权信息,目前支持查询:企业静默签,企业与港澳台居民签署合同,使用手机号验证签署方身份,骑缝章,批量签署能力是否已经开通
188
- */
189
+ * 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
190
+ 1. 企业静默签
191
+ 2. 企业与港澳台居民签署合同
192
+ 3. 使用手机号验证签署方身份
193
+ 4. 骑缝章
194
+ 5. 批量签署能力
195
+ */
189
196
  DescribeExtendedServiceAuthInfos(req: DescribeExtendedServiceAuthInfosRequest, cb?: (error: string, rep: DescribeExtendedServiceAuthInfosResponse) => void): Promise<DescribeExtendedServiceAuthInfosResponse>;
190
197
  /**
191
198
  * 根据产品要求,调整接口目录
@@ -334,17 +341,22 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
334
341
  */
335
342
  DeleteIntegrationEmployees(req: DeleteIntegrationEmployeesRequest, cb?: (error: string, rep: DeleteIntegrationEmployeesResponse) => void): Promise<DeleteIntegrationEmployeesResponse>;
336
343
  /**
337
- * 获取小程序签署链接
344
+ * 获取跳转至腾讯电子签小程序的签署链接
338
345
 
339
346
  适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
340
347
 
341
- 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
342
-
348
+ 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
343
349
 
344
- 跳转到小程序的实现,参考官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式)
350
+ 注:
351
+ `1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
352
+ `2. 签署链接的有效期为90天,超过有效期链接不可用`
345
353
 
354
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
346
355
 
347
- 如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
356
+ | 小程序 | AppID | 原始ID |
357
+ | ------------ | ------------ | ------------ |
358
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
359
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
348
360
  */
349
361
  CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
350
362
  /**
@@ -35,17 +35,18 @@ class Client extends TencentCloudCommon.AbstractClient {
35
35
  return this.request("DescribeFlowInfo", req, cb);
36
36
  }
37
37
  /**
38
- * 新增/删除应用callbackinfo
39
- callbackinfo包含: 回调地址和签名key
40
- 操作:新增/删除
38
+ * 新增/删除企业应用集成中的回调配置。
39
+ 新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
40
+ 请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
41
+ 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
41
42
  */
42
43
  async ModifyApplicationCallbackInfo(req, cb) {
43
44
  return this.request("ModifyApplicationCallbackInfo", req, cb);
44
45
  }
45
46
  /**
46
- * 此接口用于发起流程
47
- 适用场景:见创建签署流程接口。
48
- 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
47
+ * 此接口用于启动流程。它是模板发起合同的最后一步。
48
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于激活包含完整合同信息(模板及内容信息)的流程。
49
+ 流程激活后,将生成一份待签署的电子合同。
49
50
  */
50
51
  async StartFlow(req, cb) {
51
52
  return this.request("StartFlow", req, cb);
@@ -210,7 +211,8 @@ class Client extends TencentCloudCommon.AbstractClient {
210
211
  }
211
212
  /**
212
213
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
213
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
214
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
215
+ 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
214
216
 
215
217
  **本接口适用于发起方没有填写控件的 B2C或者单C模板**
216
218
 
@@ -263,8 +265,13 @@ class Client extends TencentCloudCommon.AbstractClient {
263
265
  return this.request("CreateFlowGroupByTemplates", req, cb);
264
266
  }
265
267
  /**
266
- * 查询企业扩展服务授权信息,目前支持查询:企业静默签,企业与港澳台居民签署合同,使用手机号验证签署方身份,骑缝章,批量签署能力是否已经开通
267
- */
268
+ * 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
269
+ 1. 企业静默签
270
+ 2. 企业与港澳台居民签署合同
271
+ 3. 使用手机号验证签署方身份
272
+ 4. 骑缝章
273
+ 5. 批量签署能力
274
+ */
268
275
  async DescribeExtendedServiceAuthInfos(req, cb) {
269
276
  return this.request("DescribeExtendedServiceAuthInfos", req, cb);
270
277
  }
@@ -465,17 +472,22 @@ class Client extends TencentCloudCommon.AbstractClient {
465
472
  return this.request("DeleteIntegrationEmployees", req, cb);
466
473
  }
467
474
  /**
468
- * 获取小程序签署链接
475
+ * 获取跳转至腾讯电子签小程序的签署链接
469
476
 
470
477
  适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
471
478
 
472
- 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
473
-
479
+ 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
474
480
 
475
- 跳转到小程序的实现,参考官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式)
481
+ 注:
482
+ `1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
483
+ `2. 签署链接的有效期为90天,超过有效期链接不可用`
476
484
 
485
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
477
486
 
478
- 如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
487
+ | 小程序 | AppID | 原始ID |
488
+ | ------------ | ------------ | ------------ |
489
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
490
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
479
491
  */
480
492
  async CreateSchemeUrl(req, cb) {
481
493
  return this.request("CreateSchemeUrl", req, cb);