tencentcloud-sdk-nodejs-essbasic 4.0.805 → 4.0.807

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.
@@ -368,6 +368,34 @@ export interface ChannelBatchCancelFlowsResponse {
368
368
  RequestId?: string
369
369
  }
370
370
 
371
+ /**
372
+ * ChannelDescribeSignFaceVideo请求参数结构体
373
+ */
374
+ export interface ChannelDescribeSignFaceVideoRequest {
375
+ /**
376
+ * 合同流程ID,为32位字符串。
377
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
378
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
379
+ */
380
+ FlowId: string
381
+ /**
382
+ * 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
383
+ */
384
+ SignId: string
385
+ /**
386
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
387
+
388
+ 此接口下面信息必填。
389
+ <ul>
390
+ <li>渠道应用标识: Agent.AppId</li>
391
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
392
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
393
+ </ul>
394
+ 第三方平台子客企业和员工必须已经经过实名认证
395
+ */
396
+ Agent: Agent
397
+ }
398
+
371
399
  /**
372
400
  * ChannelDisableUserAutoSign返回参数结构体
373
401
  */
@@ -630,6 +658,29 @@ export interface DescribeResourceUrlsByFlowsRequest {
630
658
  Operator?: UserInfo
631
659
  }
632
660
 
661
+ /**
662
+ * 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
663
+ */
664
+ export interface IntentionQuestionResult {
665
+ /**
666
+ * 视频base64(其中包含全程问题和回答音频,mp4格式)
667
+
668
+ 注:`需进行base64解码获取视频文件`
669
+ 注意:此字段可能返回 null,表示取不到有效值。
670
+ */
671
+ Video?: string
672
+ /**
673
+ * 和答案匹配结果列表
674
+ 注意:此字段可能返回 null,表示取不到有效值。
675
+ */
676
+ ResultCode?: Array<string>
677
+ /**
678
+ * 回答问题语音识别结果列表
679
+ 注意:此字段可能返回 null,表示取不到有效值。
680
+ */
681
+ AsrResult?: Array<string>
682
+ }
683
+
633
684
  /**
634
685
  * 企业扩展服务授权列表详情
635
686
  */
@@ -1379,304 +1430,83 @@ export interface ChannelCreateSealPolicyResponse {
1379
1430
  }
1380
1431
 
1381
1432
  /**
1382
- * 电子文档的控件填充信息。按照控件类型进行相应的填充。
1383
-
1384
- 当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
1385
- ```
1386
- FormField输入示例:
1387
- {
1388
- "ComponentId": "componentId1",
1389
- "ComponentValue": "文本内容"
1390
- }
1391
- ```
1392
- 当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
1393
- ```
1394
- FormField输入示例:
1395
- {
1396
- "ComponentId": "componentId1",
1397
- "ComponentValue": "多行文本内容"
1398
- }
1399
- ```
1400
- 当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
1401
- ```
1402
- FormField输入示例:
1403
- {
1404
- "ComponentId": "componentId1",
1405
- "ComponentValue": "true"
1406
- }
1407
- ```
1408
- 当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
1409
- ```
1410
- FormField输入示例:
1411
- {
1412
- "ComponentId": "componentId1",
1413
- "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
1414
- }
1415
- ```
1416
- 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
1417
- ```
1418
- FormField输入示例:
1419
- {
1420
- "ComponentId": "componentId1",
1421
- "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
1422
- }
1423
- ```
1424
- 当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
1425
- ```
1426
- FormField输入示例:
1427
- {
1428
- "ComponentId": "componentId1",
1429
- "ComponentValue": "选择的内容"
1430
- }
1431
- ```
1432
- 当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
1433
- ```
1434
- FormField输入示例:
1435
- {
1436
- "ComponentId": "componentId1",
1437
- "ComponentValue": "2023年01月01日"
1438
- }
1439
- ```
1440
- 当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
1441
- ```
1442
- FormField输入示例:
1443
- {
1444
- "ComponentId": "componentId1",
1445
- "ComponentValue": "广东省深圳市福田区"
1433
+ * PrepareFlows请求参数结构体
1434
+ */
1435
+ export interface PrepareFlowsRequest {
1436
+ /**
1437
+ * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1438
+ */
1439
+ Agent: Agent
1440
+ /**
1441
+ * 多个合同(签署流程)信息,最大支持20个签署流程。
1442
+ */
1443
+ FlowInfos: Array<FlowInfo>
1444
+ /**
1445
+ * 操作完成后的跳转地址,最大长度200
1446
+ */
1447
+ JumpUrl: string
1448
+ /**
1449
+ * 暂未开放
1450
+ * @deprecated
1451
+ */
1452
+ Operator?: UserInfo
1446
1453
  }
1447
- ```
1448
- 【数据表格传参说明】
1449
- 当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
1450
- 输入示例1:
1451
1454
 
1452
- ```
1453
- {
1454
- "headers":[
1455
- {
1456
- "content":"head1"
1457
- },
1458
- {
1459
- "content":"head2"
1460
- },
1461
- {
1462
- "content":"head3"
1463
- }
1464
- ],
1465
- "rowCount":3,
1466
- "body":{
1467
- "cells":[
1468
- {
1469
- "rowStart":1,
1470
- "rowEnd":1,
1471
- "columnStart":1,
1472
- "columnEnd":1,
1473
- "content":"123"
1474
- },
1475
- {
1476
- "rowStart":2,
1477
- "rowEnd":3,
1478
- "columnStart":1,
1479
- "columnEnd":2,
1480
- "content":"456"
1481
- },
1482
- {
1483
- "rowStart":3,
1484
- "rowEnd":3,
1485
- "columnStart":3,
1486
- "columnEnd":3,
1487
- "content":"789"
1488
- }
1489
- ]
1490
- }
1455
+ /**
1456
+ * ChannelDescribeSignFaceVideo返回参数结构体
1457
+ */
1458
+ export interface ChannelDescribeSignFaceVideoResponse {
1459
+ /**
1460
+ * 核身视频结果。
1461
+ 注意:此字段可能返回 null,表示取不到有效值。
1462
+ */
1463
+ VideoData?: DetectInfoVideoData
1464
+ /**
1465
+ * 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
1466
+ 注意:此字段可能返回 null,表示取不到有效值。
1467
+ */
1468
+ IntentionQuestionResult?: IntentionQuestionResult
1469
+ /**
1470
+ * 意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
1471
+ 注意:此字段可能返回 null,表示取不到有效值。
1472
+ */
1473
+ IntentionActionResult?: IntentionActionResult
1474
+ /**
1475
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1476
+ */
1477
+ RequestId?: string
1491
1478
  }
1492
1479
 
1493
- ```
1494
-
1495
- 输入示例2(表格表头宽度比例配置):
1496
-
1497
- ```
1498
- {
1499
- "headers":[
1500
- {
1501
- "content":"head1",
1502
- "widthPercent": 30
1503
- },
1504
- {
1505
- "content":"head2",
1506
- "widthPercent": 30
1507
- },
1508
- {
1509
- "content":"head3",
1510
- "widthPercent": 40
1511
- }
1512
- ],
1513
- "rowCount":3,
1514
- "body":{
1515
- "cells":[
1516
- {
1517
- "rowStart":1,
1518
- "rowEnd":1,
1519
- "columnStart":1,
1520
- "columnEnd":1,
1521
- "content":"123"
1522
- },
1523
- {
1524
- "rowStart":2,
1525
- "rowEnd":3,
1526
- "columnStart":1,
1527
- "columnEnd":2,
1528
- "content":"456"
1529
- },
1530
- {
1531
- "rowStart":3,
1532
- "rowEnd":3,
1533
- "columnStart":3,
1534
- "columnEnd":3,
1535
- "content":"789"
1536
- }
1537
- ]
1538
- }
1480
+ /**
1481
+ * ChannelCancelFlow返回参数结构体
1482
+ */
1483
+ export interface ChannelCancelFlowResponse {
1484
+ /**
1485
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1486
+ */
1487
+ RequestId?: string
1539
1488
  }
1540
1489
 
1541
- ```
1542
-
1490
+ /**
1491
+ * 签署流程下载信息
1492
+ */
1493
+ export interface DownloadFlowInfo {
1494
+ /**
1495
+ * 文件夹名称
1496
+ */
1497
+ FileName: string
1498
+ /**
1499
+ * 签署流程的标识数组
1500
+ */
1501
+ FlowIdList: Array<string>
1502
+ }
1543
1503
 
1544
- 输入示例3(表格设置字体加粗颜色):
1545
-
1546
- ```
1547
- {
1548
- "headers":[
1549
- {
1550
- "content":"head1"
1551
- },
1552
- {
1553
- "content":"head2"
1554
- },
1555
- {
1556
- "content":"head3"
1557
- }
1558
- ],
1559
- "rowCount":3,
1560
- "body":{
1561
- "cells":[
1562
- {
1563
- "rowStart":1,
1564
- "rowEnd":1,
1565
- "columnStart":1,
1566
- "columnEnd":1,
1567
- "content":"123",
1568
- "style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "CENTER"}
1569
- },
1570
- {
1571
- "rowStart":2,
1572
- "rowEnd":3,
1573
- "columnStart":1,
1574
- "columnEnd":2,
1575
- "content":"456",
1576
- "style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "LEFT"}
1577
- },
1578
- {
1579
- "rowStart":3,
1580
- "rowEnd":3,
1581
- "columnStart":3,
1582
- "columnEnd":3,
1583
- "content":"789",
1584
- "style": {"color": "#b500bf", "fontSize": 12,"bold": false,"align": "RIGHT"}
1585
- }
1586
- ]
1587
- }
1588
- }
1589
-
1590
- ```
1591
-
1592
- 表格参数说明
1593
-
1594
- | 名称 | 类型 | 描述 |
1595
- | ------------------- | ------- | ------------------------------------------------- |
1596
- | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
1597
- | rowCount | Integer | 表格内容最大行数 |
1598
- | cells.N.rowStart | Integer | 单元格坐标:行起始index |
1599
- | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
1600
- | cells.N.columnStart | Integer | 单元格坐标:列起始index |
1601
- | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
1602
- | cells.N.content | String | 单元格内容,字数不超过100 |
1603
- | cells.N.style | String | 单元格字体风格配置 ,风格配置的json字符串 如: {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"} |
1604
-
1605
- 表格参数headers说明
1606
- widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
1607
-
1608
- content String 表头单元格内容,字数不超过100
1609
-
1610
- style String 为字体风格设置 风格支持: font : 目前支持 黑体、宋体; fontSize: 6-72; color:000000-FFFFFF 字符串形如: "#FFFFFF" 或者 "0xFFFFFF"; bold : 是否加粗, true : 加粗 false: 不加粗; align: 对其方式, 支持 LEFT / RIGHT / CENTER
1611
- */
1612
- export interface FormField {
1613
- /**
1614
- * 控件填充值,ComponentType和传入值格式对应关系如下:
1615
- <ul>
1616
- <li>TEXT - 普通文本控件,需输入文本字符串;</li>
1617
- <li>MULTI_LINE_TEXT - 多行文本控件,需输入文本字符串;</li>
1618
- <li>CHECK_BOX - 勾选框控件,若选中需填写ComponentValue,填写 true或者 false 字符串;</li>
1619
- <li>FILL_IMAGE - 图片控件,需填写ComponentValue为图片的资源 ID;</li>
1620
- <li>DYNAMIC_TABLE - 动态表格控件;</li>
1621
- <li>ATTACHMENT - 附件控件,需填写ComponentValue为附件图片的资源 ID列表,以逗号分割;</li>
1622
- <li>DATE - 日期控件;格式为 <b>xxxx年xx月xx日</b> 字符串;</li>
1623
- <li>DISTRICT - 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容;</li>
1624
- </ul>
1625
-
1626
- */
1627
- ComponentValue: string
1628
- /**
1629
- * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
1630
- CreateFlowsByTemplates 接口不使用此字段。
1631
-
1632
- <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
1633
- 注意:此字段可能返回 null,表示取不到有效值。
1634
- */
1635
- ComponentId?: string
1636
- /**
1637
- * 控件的名字,跟ComponentId二选一,不能全为空
1638
-
1639
- <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
1640
- 注意:此字段可能返回 null,表示取不到有效值。
1641
- */
1642
- ComponentName?: string
1643
- /**
1644
- * 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
1645
- 注意:此字段可能返回 null,表示取不到有效值。
1646
- */
1647
- LockComponentValue?: boolean
1648
- }
1649
-
1650
- /**
1651
- * ChannelCancelFlow返回参数结构体
1652
- */
1653
- export interface ChannelCancelFlowResponse {
1654
- /**
1655
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1656
- */
1657
- RequestId?: string
1658
- }
1659
-
1660
- /**
1661
- * 签署流程下载信息
1662
- */
1663
- export interface DownloadFlowInfo {
1664
- /**
1665
- * 文件夹名称
1666
- */
1667
- FileName: string
1668
- /**
1669
- * 签署流程的标识数组
1670
- */
1671
- FlowIdList: Array<string>
1672
- }
1673
-
1674
- /**
1675
- * 签署人签署链接信息。
1676
- */
1677
- export interface FlowApproverUrlInfo {
1678
- /**
1679
- * 签署短链接。
1504
+ /**
1505
+ * 签署人签署链接信息。
1506
+ */
1507
+ export interface FlowApproverUrlInfo {
1508
+ /**
1509
+ * 签署短链接。
1680
1510
 
1681
1511
  注意:
1682
1512
  1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
@@ -2298,6 +2128,19 @@ export interface RecipientComponentInfo {
2298
2128
  Components?: Array<FilledComponent>
2299
2129
  }
2300
2130
 
2131
+ /**
2132
+ * 视频认证结果
2133
+ */
2134
+ export interface DetectInfoVideoData {
2135
+ /**
2136
+ * 活体视频的base64编码,mp4格式
2137
+
2138
+ 注:`需进行base64解码获取活体视频文件`
2139
+ 注意:此字段可能返回 null,表示取不到有效值。
2140
+ */
2141
+ LiveNessVideo?: string
2142
+ }
2143
+
2301
2144
  /**
2302
2145
  * ChannelDescribeRoles请求参数结构体
2303
2146
  */
@@ -2384,6 +2227,24 @@ export interface PrepareFlowsResponse {
2384
2227
  RequestId?: string
2385
2228
  }
2386
2229
 
2230
+ /**
2231
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。 通过链接,用户可直接访问电子签名小程序并签署合同。
2232
+ */
2233
+ export interface SignUrl {
2234
+ /**
2235
+ * 跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
2236
+ */
2237
+ AppSignUrl?: string
2238
+ /**
2239
+ * 签署链接有效时间,格式类似"2022-08-05 15:55:01"
2240
+ */
2241
+ EffectiveTime?: string
2242
+ /**
2243
+ * 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
2244
+ */
2245
+ HttpSignUrl?: string
2246
+ }
2247
+
2387
2248
  /**
2388
2249
  * ChannelCancelFlow请求参数结构体
2389
2250
  */
@@ -3525,6 +3386,17 @@ export interface FillApproverInfo {
3525
3386
  NotChannelOrganization?: boolean
3526
3387
  }
3527
3388
 
3389
+ /**
3390
+ * 意愿核身点头确认模式结果详细数据
3391
+ */
3392
+ export interface IntentionActionResultDetail {
3393
+ /**
3394
+ * 视频base64编码(其中包含全程提示文本和点头音频,mp4格式)
3395
+ 注意:此字段可能返回 null,表示取不到有效值。
3396
+ */
3397
+ Video?: string
3398
+ }
3399
+
3528
3400
  /**
3529
3401
  * ChannelCreateUserAutoSignSealUrl请求参数结构体
3530
3402
  */
@@ -4349,6 +4221,30 @@ export interface AuthorizedUser {
4349
4221
  OpenId: string
4350
4222
  }
4351
4223
 
4224
+ /**
4225
+ * 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
4226
+
4227
+ 注: `视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
4228
+ */
4229
+ export interface Intention {
4230
+ /**
4231
+ * 视频认证类型,支持以下类型
4232
+ <ul><li>1 : 问答模式</li>
4233
+ <li>2 : 点头模式</li></ul>
4234
+
4235
+ 注: `视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
4236
+ */
4237
+ IntentionType?: number
4238
+ /**
4239
+ * 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
4240
+ */
4241
+ IntentionQuestions?: Array<IntentionQuestion>
4242
+ /**
4243
+ * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
4244
+ */
4245
+ IntentionActions?: Array<IntentionAction>
4246
+ }
4247
+
4352
4248
  /**
4353
4249
  * ChannelDeleteRoleUsers返回参数结构体
4354
4250
  */
@@ -4978,6 +4874,14 @@ export interface FlowApproverInfo {
4978
4874
  注:`此参数仅在通过文件发起合同或者合同组时生效`
4979
4875
  */
4980
4876
  Components?: Array<Component>
4877
+ /**
4878
+ * 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
4879
+
4880
+ 注:
4881
+ `1.视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
4882
+ `2.使用视频认证必须指定签署认证方式为人脸(即ApproverSignTypes)。`
4883
+ */
4884
+ Intention?: Intention
4981
4885
  }
4982
4886
 
4983
4887
  /**
@@ -5349,26 +5253,14 @@ export interface ChannelCreateRoleResponse {
5349
5253
  }
5350
5254
 
5351
5255
  /**
5352
- * SyncProxyOrganizationOperators返回参数结构体
5256
+ * 意愿核身点头确认模式结果
5353
5257
  */
5354
- export interface SyncProxyOrganizationOperatorsResponse {
5355
- /**
5356
- * 同步的状态, 全部同步失败接口是接口会直接报错
5357
-
5358
- <ul><li> **1** :全部成功</li>
5359
- <li> **2** :部分成功</li></ul>
5360
- 注意:此字段可能返回 null,表示取不到有效值。
5361
- */
5362
- Status?: number
5258
+ export interface IntentionActionResult {
5363
5259
  /**
5364
- * 同步失败员工ID及其失败原因
5260
+ * 意愿核身结果详细数据,与每段点头确认过程一一对应
5365
5261
  注意:此字段可能返回 null,表示取不到有效值。
5366
5262
  */
5367
- FailedList?: Array<SyncFailReason>
5368
- /**
5369
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5370
- */
5371
- RequestId?: string
5263
+ Details?: Array<IntentionActionResultDetail>
5372
5264
  }
5373
5265
 
5374
5266
  /**
@@ -5786,26 +5678,13 @@ export interface ApproverRestriction {
5786
5678
  }
5787
5679
 
5788
5680
  /**
5789
- * PrepareFlows请求参数结构体
5681
+ * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
5790
5682
  */
5791
- export interface PrepareFlowsRequest {
5792
- /**
5793
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
5794
- */
5795
- Agent: Agent
5796
- /**
5797
- * 多个合同(签署流程)信息,最大支持20个签署流程。
5798
- */
5799
- FlowInfos: Array<FlowInfo>
5800
- /**
5801
- * 操作完成后的跳转地址,最大长度200
5802
- */
5803
- JumpUrl: string
5683
+ export interface IntentionAction {
5804
5684
  /**
5805
- * 暂未开放
5806
- * @deprecated
5685
+ * 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
5807
5686
  */
5808
- Operator?: UserInfo
5687
+ Text?: string
5809
5688
  }
5810
5689
 
5811
5690
  /**
@@ -5885,6 +5764,29 @@ export interface ChannelDescribeOrganizationSealsResponse {
5885
5764
  RequestId?: string
5886
5765
  }
5887
5766
 
5767
+ /**
5768
+ * SyncProxyOrganizationOperators返回参数结构体
5769
+ */
5770
+ export interface SyncProxyOrganizationOperatorsResponse {
5771
+ /**
5772
+ * 同步的状态, 全部同步失败接口是接口会直接报错
5773
+
5774
+ <ul><li> **1** :全部成功</li>
5775
+ <li> **2** :部分成功</li></ul>
5776
+ 注意:此字段可能返回 null,表示取不到有效值。
5777
+ */
5778
+ Status?: number
5779
+ /**
5780
+ * 同步失败员工ID及其失败原因
5781
+ 注意:此字段可能返回 null,表示取不到有效值。
5782
+ */
5783
+ FailedList?: Array<SyncFailReason>
5784
+ /**
5785
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5786
+ */
5787
+ RequestId?: string
5788
+ }
5789
+
5888
5790
  /**
5889
5791
  * CreateSealByImage返回参数结构体
5890
5792
  */
@@ -6658,22 +6560,273 @@ export interface ChannelCreateFlowGroupByTemplatesRequest {
6658
6560
  }
6659
6561
 
6660
6562
  /**
6661
- * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。 通过链接,用户可直接访问电子签名小程序并签署合同。
6662
- */
6663
- export interface SignUrl {
6664
- /**
6665
- * 跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
6666
- */
6667
- AppSignUrl?: string
6668
- /**
6669
- * 签署链接有效时间,格式类似"2022-08-05 15:55:01"
6670
- */
6671
- EffectiveTime?: string
6672
- /**
6673
- * 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
6674
- */
6675
- HttpSignUrl?: string
6676
- }
6563
+ * 电子文档的控件填充信息。按照控件类型进行相应的填充。
6564
+
6565
+ 当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
6566
+ ```
6567
+ FormField输入示例:
6568
+ {
6569
+ "ComponentId": "componentId1",
6570
+ "ComponentValue": "文本内容"
6571
+ }
6572
+ ```
6573
+ 当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
6574
+ ```
6575
+ FormField输入示例:
6576
+ {
6577
+ "ComponentId": "componentId1",
6578
+ "ComponentValue": "多行文本内容"
6579
+ }
6580
+ ```
6581
+ 当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
6582
+ ```
6583
+ FormField输入示例:
6584
+ {
6585
+ "ComponentId": "componentId1",
6586
+ "ComponentValue": "true"
6587
+ }
6588
+ ```
6589
+ 当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
6590
+ ```
6591
+ FormField输入示例:
6592
+ {
6593
+ "ComponentId": "componentId1",
6594
+ "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
6595
+ }
6596
+ ```
6597
+ 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
6598
+ ```
6599
+ FormField输入示例:
6600
+ {
6601
+ "ComponentId": "componentId1",
6602
+ "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
6603
+ }
6604
+ ```
6605
+ 当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
6606
+ ```
6607
+ FormField输入示例:
6608
+ {
6609
+ "ComponentId": "componentId1",
6610
+ "ComponentValue": "选择的内容"
6611
+ }
6612
+ ```
6613
+ 当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
6614
+ ```
6615
+ FormField输入示例:
6616
+ {
6617
+ "ComponentId": "componentId1",
6618
+ "ComponentValue": "2023年01月01日"
6619
+ }
6620
+ ```
6621
+ 当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
6622
+ ```
6623
+ FormField输入示例:
6624
+ {
6625
+ "ComponentId": "componentId1",
6626
+ "ComponentValue": "广东省深圳市福田区"
6627
+ }
6628
+ ```
6629
+ 【数据表格传参说明】
6630
+ 当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
6631
+ 输入示例1:
6632
+
6633
+ ```
6634
+ {
6635
+ "headers":[
6636
+ {
6637
+ "content":"head1"
6638
+ },
6639
+ {
6640
+ "content":"head2"
6641
+ },
6642
+ {
6643
+ "content":"head3"
6644
+ }
6645
+ ],
6646
+ "rowCount":3,
6647
+ "body":{
6648
+ "cells":[
6649
+ {
6650
+ "rowStart":1,
6651
+ "rowEnd":1,
6652
+ "columnStart":1,
6653
+ "columnEnd":1,
6654
+ "content":"123"
6655
+ },
6656
+ {
6657
+ "rowStart":2,
6658
+ "rowEnd":3,
6659
+ "columnStart":1,
6660
+ "columnEnd":2,
6661
+ "content":"456"
6662
+ },
6663
+ {
6664
+ "rowStart":3,
6665
+ "rowEnd":3,
6666
+ "columnStart":3,
6667
+ "columnEnd":3,
6668
+ "content":"789"
6669
+ }
6670
+ ]
6671
+ }
6672
+ }
6673
+
6674
+ ```
6675
+
6676
+ 输入示例2(表格表头宽度比例配置):
6677
+
6678
+ ```
6679
+ {
6680
+ "headers":[
6681
+ {
6682
+ "content":"head1",
6683
+ "widthPercent": 30
6684
+ },
6685
+ {
6686
+ "content":"head2",
6687
+ "widthPercent": 30
6688
+ },
6689
+ {
6690
+ "content":"head3",
6691
+ "widthPercent": 40
6692
+ }
6693
+ ],
6694
+ "rowCount":3,
6695
+ "body":{
6696
+ "cells":[
6697
+ {
6698
+ "rowStart":1,
6699
+ "rowEnd":1,
6700
+ "columnStart":1,
6701
+ "columnEnd":1,
6702
+ "content":"123"
6703
+ },
6704
+ {
6705
+ "rowStart":2,
6706
+ "rowEnd":3,
6707
+ "columnStart":1,
6708
+ "columnEnd":2,
6709
+ "content":"456"
6710
+ },
6711
+ {
6712
+ "rowStart":3,
6713
+ "rowEnd":3,
6714
+ "columnStart":3,
6715
+ "columnEnd":3,
6716
+ "content":"789"
6717
+ }
6718
+ ]
6719
+ }
6720
+ }
6721
+
6722
+ ```
6723
+
6724
+
6725
+ 输入示例3(表格设置字体加粗颜色):
6726
+
6727
+ ```
6728
+ {
6729
+ "headers":[
6730
+ {
6731
+ "content":"head1"
6732
+ },
6733
+ {
6734
+ "content":"head2"
6735
+ },
6736
+ {
6737
+ "content":"head3"
6738
+ }
6739
+ ],
6740
+ "rowCount":3,
6741
+ "body":{
6742
+ "cells":[
6743
+ {
6744
+ "rowStart":1,
6745
+ "rowEnd":1,
6746
+ "columnStart":1,
6747
+ "columnEnd":1,
6748
+ "content":"123",
6749
+ "style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "CENTER"}
6750
+ },
6751
+ {
6752
+ "rowStart":2,
6753
+ "rowEnd":3,
6754
+ "columnStart":1,
6755
+ "columnEnd":2,
6756
+ "content":"456",
6757
+ "style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "LEFT"}
6758
+ },
6759
+ {
6760
+ "rowStart":3,
6761
+ "rowEnd":3,
6762
+ "columnStart":3,
6763
+ "columnEnd":3,
6764
+ "content":"789",
6765
+ "style": {"color": "#b500bf", "fontSize": 12,"bold": false,"align": "RIGHT"}
6766
+ }
6767
+ ]
6768
+ }
6769
+ }
6770
+
6771
+ ```
6772
+
6773
+ 表格参数说明
6774
+
6775
+ | 名称 | 类型 | 描述 |
6776
+ | ------------------- | ------- | ------------------------------------------------- |
6777
+ | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
6778
+ | rowCount | Integer | 表格内容最大行数 |
6779
+ | cells.N.rowStart | Integer | 单元格坐标:行起始index |
6780
+ | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
6781
+ | cells.N.columnStart | Integer | 单元格坐标:列起始index |
6782
+ | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
6783
+ | cells.N.content | String | 单元格内容,字数不超过100 |
6784
+ | cells.N.style | String | 单元格字体风格配置 ,风格配置的json字符串 如: {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"} |
6785
+
6786
+ 表格参数headers说明
6787
+ widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
6788
+
6789
+ content String 表头单元格内容,字数不超过100
6790
+
6791
+ style String 为字体风格设置 风格支持: font : 目前支持 黑体、宋体; fontSize: 6-72; color:000000-FFFFFF 字符串形如: "#FFFFFF" 或者 "0xFFFFFF"; bold : 是否加粗, true : 加粗 false: 不加粗; align: 对其方式, 支持 LEFT / RIGHT / CENTER
6792
+ */
6793
+ export interface FormField {
6794
+ /**
6795
+ * 控件填充值,ComponentType和传入值格式对应关系如下:
6796
+ <ul>
6797
+ <li>TEXT - 普通文本控件,需输入文本字符串;</li>
6798
+ <li>MULTI_LINE_TEXT - 多行文本控件,需输入文本字符串;</li>
6799
+ <li>CHECK_BOX - 勾选框控件,若选中需填写ComponentValue,填写 true或者 false 字符串;</li>
6800
+ <li>FILL_IMAGE - 图片控件,需填写ComponentValue为图片的资源 ID;</li>
6801
+ <li>DYNAMIC_TABLE - 动态表格控件;</li>
6802
+ <li>ATTACHMENT - 附件控件,需填写ComponentValue为附件图片的资源 ID列表,以逗号分割;</li>
6803
+ <li>DATE - 日期控件;格式为 <b>xxxx年xx月xx日</b> 字符串;</li>
6804
+ <li>DISTRICT - 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容;</li>
6805
+ </ul>
6806
+
6807
+ */
6808
+ ComponentValue: string
6809
+ /**
6810
+ * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
6811
+ CreateFlowsByTemplates 接口不使用此字段。
6812
+
6813
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
6814
+ 注意:此字段可能返回 null,表示取不到有效值。
6815
+ */
6816
+ ComponentId?: string
6817
+ /**
6818
+ * 控件的名字,跟ComponentId二选一,不能全为空
6819
+
6820
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
6821
+ 注意:此字段可能返回 null,表示取不到有效值。
6822
+ */
6823
+ ComponentName?: string
6824
+ /**
6825
+ * 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
6826
+ 注意:此字段可能返回 null,表示取不到有效值。
6827
+ */
6828
+ LockComponentValue?: boolean
6829
+ }
6677
6830
 
6678
6831
  /**
6679
6832
  * CreateFlowGroupSignReview请求参数结构体
@@ -7416,6 +7569,20 @@ export interface DescribeChannelFlowEvidenceReportResponse {
7416
7569
  RequestId?: string
7417
7570
  }
7418
7571
 
7572
+ /**
7573
+ * 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
7574
+ */
7575
+ export interface IntentionQuestion {
7576
+ /**
7577
+ * 当选择语音问答模式时,系统自动播报的问题文本,最大长度为150个字符。
7578
+ */
7579
+ Question?: string
7580
+ /**
7581
+ * 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表,传入后可自动判断用户回答文本是否在标准文本列表中。
7582
+ */
7583
+ Answers?: Array<string>
7584
+ }
7585
+
7419
7586
  /**
7420
7587
  * CreateSealByImage请求参数结构体
7421
7588
  */