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.
- package/package.json +1 -1
- package/products.md +34 -34
- package/src/services/essbasic/v20210526/essbasic_client.ts +29 -4
- package/src/services/essbasic/v20210526/essbasic_models.ts +507 -340
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +11 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +12 -0
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +823 -665
|
@@ -345,6 +345,33 @@ export interface ChannelBatchCancelFlowsResponse {
|
|
|
345
345
|
*/
|
|
346
346
|
RequestId?: string;
|
|
347
347
|
}
|
|
348
|
+
/**
|
|
349
|
+
* ChannelDescribeSignFaceVideo请求参数结构体
|
|
350
|
+
*/
|
|
351
|
+
export interface ChannelDescribeSignFaceVideoRequest {
|
|
352
|
+
/**
|
|
353
|
+
* 合同流程ID,为32位字符串。
|
|
354
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
355
|
+
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
356
|
+
*/
|
|
357
|
+
FlowId: string;
|
|
358
|
+
/**
|
|
359
|
+
* 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
|
|
360
|
+
*/
|
|
361
|
+
SignId: string;
|
|
362
|
+
/**
|
|
363
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
364
|
+
|
|
365
|
+
此接口下面信息必填。
|
|
366
|
+
<ul>
|
|
367
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
368
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
369
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
370
|
+
</ul>
|
|
371
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
372
|
+
*/
|
|
373
|
+
Agent: Agent;
|
|
374
|
+
}
|
|
348
375
|
/**
|
|
349
376
|
* ChannelDisableUserAutoSign返回参数结构体
|
|
350
377
|
*/
|
|
@@ -596,6 +623,28 @@ export interface DescribeResourceUrlsByFlowsRequest {
|
|
|
596
623
|
*/
|
|
597
624
|
Operator?: UserInfo;
|
|
598
625
|
}
|
|
626
|
+
/**
|
|
627
|
+
* 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
|
|
628
|
+
*/
|
|
629
|
+
export interface IntentionQuestionResult {
|
|
630
|
+
/**
|
|
631
|
+
* 视频base64(其中包含全程问题和回答音频,mp4格式)
|
|
632
|
+
|
|
633
|
+
注:`需进行base64解码获取视频文件`
|
|
634
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
635
|
+
*/
|
|
636
|
+
Video?: string;
|
|
637
|
+
/**
|
|
638
|
+
* 和答案匹配结果列表
|
|
639
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
640
|
+
*/
|
|
641
|
+
ResultCode?: Array<string>;
|
|
642
|
+
/**
|
|
643
|
+
* 回答问题语音识别结果列表
|
|
644
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
645
|
+
*/
|
|
646
|
+
AsrResult?: Array<string>;
|
|
647
|
+
}
|
|
599
648
|
/**
|
|
600
649
|
* 企业扩展服务授权列表详情
|
|
601
650
|
*/
|
|
@@ -1324,406 +1373,184 @@ export interface ChannelCreateSealPolicyResponse {
|
|
|
1324
1373
|
RequestId?: string;
|
|
1325
1374
|
}
|
|
1326
1375
|
/**
|
|
1327
|
-
*
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1376
|
+
* PrepareFlows请求参数结构体
|
|
1377
|
+
*/
|
|
1378
|
+
export interface PrepareFlowsRequest {
|
|
1379
|
+
/**
|
|
1380
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
|
|
1381
|
+
*/
|
|
1382
|
+
Agent: Agent;
|
|
1383
|
+
/**
|
|
1384
|
+
* 多个合同(签署流程)信息,最大支持20个签署流程。
|
|
1385
|
+
*/
|
|
1386
|
+
FlowInfos: Array<FlowInfo>;
|
|
1387
|
+
/**
|
|
1388
|
+
* 操作完成后的跳转地址,最大长度200
|
|
1389
|
+
*/
|
|
1390
|
+
JumpUrl: string;
|
|
1391
|
+
/**
|
|
1392
|
+
* 暂未开放
|
|
1393
|
+
* @deprecated
|
|
1394
|
+
*/
|
|
1395
|
+
Operator?: UserInfo;
|
|
1335
1396
|
}
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1397
|
+
/**
|
|
1398
|
+
* ChannelDescribeSignFaceVideo返回参数结构体
|
|
1399
|
+
*/
|
|
1400
|
+
export interface ChannelDescribeSignFaceVideoResponse {
|
|
1401
|
+
/**
|
|
1402
|
+
* 核身视频结果。
|
|
1403
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1404
|
+
*/
|
|
1405
|
+
VideoData?: DetectInfoVideoData;
|
|
1406
|
+
/**
|
|
1407
|
+
* 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
|
|
1408
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1409
|
+
*/
|
|
1410
|
+
IntentionQuestionResult?: IntentionQuestionResult;
|
|
1411
|
+
/**
|
|
1412
|
+
* 意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
|
|
1413
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1414
|
+
*/
|
|
1415
|
+
IntentionActionResult?: IntentionActionResult;
|
|
1416
|
+
/**
|
|
1417
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1418
|
+
*/
|
|
1419
|
+
RequestId?: string;
|
|
1343
1420
|
}
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1421
|
+
/**
|
|
1422
|
+
* ChannelCancelFlow返回参数结构体
|
|
1423
|
+
*/
|
|
1424
|
+
export interface ChannelCancelFlowResponse {
|
|
1425
|
+
/**
|
|
1426
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1427
|
+
*/
|
|
1428
|
+
RequestId?: string;
|
|
1351
1429
|
}
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1430
|
+
/**
|
|
1431
|
+
* 签署流程下载信息
|
|
1432
|
+
*/
|
|
1433
|
+
export interface DownloadFlowInfo {
|
|
1434
|
+
/**
|
|
1435
|
+
* 文件夹名称
|
|
1436
|
+
*/
|
|
1437
|
+
FileName: string;
|
|
1438
|
+
/**
|
|
1439
|
+
* 签署流程的标识数组
|
|
1440
|
+
*/
|
|
1441
|
+
FlowIdList: Array<string>;
|
|
1359
1442
|
}
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1443
|
+
/**
|
|
1444
|
+
* 签署人签署链接信息。
|
|
1445
|
+
*/
|
|
1446
|
+
export interface FlowApproverUrlInfo {
|
|
1447
|
+
/**
|
|
1448
|
+
* 签署短链接。
|
|
1449
|
+
|
|
1450
|
+
注意:
|
|
1451
|
+
1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
1452
|
+
2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
1453
|
+
3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
1454
|
+
*/
|
|
1455
|
+
SignUrl?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* 签署人类型。
|
|
1458
|
+
- **PERSON**: 个人
|
|
1459
|
+
*/
|
|
1460
|
+
ApproverType?: string;
|
|
1461
|
+
/**
|
|
1462
|
+
* 签署人姓名。
|
|
1463
|
+
*/
|
|
1464
|
+
Name?: string;
|
|
1465
|
+
/**
|
|
1466
|
+
* 签署人手机号。
|
|
1467
|
+
*/
|
|
1468
|
+
Mobile?: string;
|
|
1469
|
+
/**
|
|
1470
|
+
* 签署长链接。
|
|
1471
|
+
|
|
1472
|
+
注意:
|
|
1473
|
+
1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
1474
|
+
2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
1475
|
+
3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
1476
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1477
|
+
*/
|
|
1478
|
+
LongUrl?: string;
|
|
1367
1479
|
}
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
|
|
1480
|
+
/**
|
|
1481
|
+
* ChannelCreateWebThemeConfig请求参数结构体
|
|
1482
|
+
*/
|
|
1483
|
+
export interface ChannelCreateWebThemeConfigRequest {
|
|
1484
|
+
/**
|
|
1485
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
|
|
1486
|
+
*/
|
|
1487
|
+
Agent: Agent;
|
|
1488
|
+
/**
|
|
1489
|
+
* 主题类型<br/>EMBED_WEB_THEME:嵌入式主题
|
|
1490
|
+
<ul>
|
|
1491
|
+
<li>EMBED_WEB_THEME,web页面嵌入的主题风格配置</li>
|
|
1492
|
+
<li>COMPANY_AUTHENTICATE,子客认证主题配置, 对当前第三方应用号生效,
|
|
1493
|
+
目前支持的有,背景图替换,隐藏企业认证页面导航栏和隐藏企业认证顶部logo</li>
|
|
1494
|
+
</ul>
|
|
1495
|
+
*/
|
|
1496
|
+
ThemeType: string;
|
|
1497
|
+
/**
|
|
1498
|
+
* 主题配置
|
|
1499
|
+
*/
|
|
1500
|
+
WebThemeConfig: WebThemeConfig;
|
|
1375
1501
|
}
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1502
|
+
/**
|
|
1503
|
+
* 需要进行签署审核的签署人信息
|
|
1504
|
+
*/
|
|
1505
|
+
export interface NeedReviewApproverInfo {
|
|
1506
|
+
/**
|
|
1507
|
+
* 签署方经办人的类型,支持以下类型
|
|
1508
|
+
<ul><li> ORGANIZATION 企业(含企业自动签)</li>
|
|
1509
|
+
<li>PERSON 个人(含个人自动签)</li></ul>
|
|
1510
|
+
*/
|
|
1511
|
+
ApproverType: string;
|
|
1512
|
+
/**
|
|
1513
|
+
* 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
1514
|
+
*/
|
|
1515
|
+
ApproverName: string;
|
|
1516
|
+
/**
|
|
1517
|
+
* 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
|
|
1518
|
+
*/
|
|
1519
|
+
ApproverMobile?: string;
|
|
1520
|
+
/**
|
|
1521
|
+
* 签署方经办人的证件类型,支持以下类型
|
|
1522
|
+
<ul><li>ID_CARD 居民身份证 (默认值)</li>
|
|
1523
|
+
<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
|
|
1524
|
+
<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
|
|
1525
|
+
<li>OTHER_CARD_TYPE 其他证件</li></ul>
|
|
1526
|
+
|
|
1527
|
+
注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
1528
|
+
*/
|
|
1529
|
+
ApproverIdCardType?: string;
|
|
1530
|
+
/**
|
|
1531
|
+
* 签署方经办人的证件号码,应符合以下规则
|
|
1532
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
1533
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
1534
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
1535
|
+
*/
|
|
1536
|
+
ApproverIdCardNumber?: string;
|
|
1537
|
+
/**
|
|
1538
|
+
* 组织机构名称。
|
|
1539
|
+
请确认该名称与企业营业执照中注册的名称一致。
|
|
1540
|
+
如果名称中包含英文括号(),请使用中文括号()代替。
|
|
1541
|
+
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
|
|
1542
|
+
|
|
1543
|
+
*/
|
|
1544
|
+
OrganizationName?: string;
|
|
1383
1545
|
}
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
```
|
|
1393
|
-
【数据表格传参说明】
|
|
1394
|
-
当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
|
|
1395
|
-
输入示例1:
|
|
1396
|
-
|
|
1397
|
-
```
|
|
1398
|
-
{
|
|
1399
|
-
"headers":[
|
|
1400
|
-
{
|
|
1401
|
-
"content":"head1"
|
|
1402
|
-
},
|
|
1403
|
-
{
|
|
1404
|
-
"content":"head2"
|
|
1405
|
-
},
|
|
1406
|
-
{
|
|
1407
|
-
"content":"head3"
|
|
1408
|
-
}
|
|
1409
|
-
],
|
|
1410
|
-
"rowCount":3,
|
|
1411
|
-
"body":{
|
|
1412
|
-
"cells":[
|
|
1413
|
-
{
|
|
1414
|
-
"rowStart":1,
|
|
1415
|
-
"rowEnd":1,
|
|
1416
|
-
"columnStart":1,
|
|
1417
|
-
"columnEnd":1,
|
|
1418
|
-
"content":"123"
|
|
1419
|
-
},
|
|
1420
|
-
{
|
|
1421
|
-
"rowStart":2,
|
|
1422
|
-
"rowEnd":3,
|
|
1423
|
-
"columnStart":1,
|
|
1424
|
-
"columnEnd":2,
|
|
1425
|
-
"content":"456"
|
|
1426
|
-
},
|
|
1427
|
-
{
|
|
1428
|
-
"rowStart":3,
|
|
1429
|
-
"rowEnd":3,
|
|
1430
|
-
"columnStart":3,
|
|
1431
|
-
"columnEnd":3,
|
|
1432
|
-
"content":"789"
|
|
1433
|
-
}
|
|
1434
|
-
]
|
|
1435
|
-
}
|
|
1436
|
-
}
|
|
1437
|
-
|
|
1438
|
-
```
|
|
1439
|
-
|
|
1440
|
-
输入示例2(表格表头宽度比例配置):
|
|
1441
|
-
|
|
1442
|
-
```
|
|
1443
|
-
{
|
|
1444
|
-
"headers":[
|
|
1445
|
-
{
|
|
1446
|
-
"content":"head1",
|
|
1447
|
-
"widthPercent": 30
|
|
1448
|
-
},
|
|
1449
|
-
{
|
|
1450
|
-
"content":"head2",
|
|
1451
|
-
"widthPercent": 30
|
|
1452
|
-
},
|
|
1453
|
-
{
|
|
1454
|
-
"content":"head3",
|
|
1455
|
-
"widthPercent": 40
|
|
1456
|
-
}
|
|
1457
|
-
],
|
|
1458
|
-
"rowCount":3,
|
|
1459
|
-
"body":{
|
|
1460
|
-
"cells":[
|
|
1461
|
-
{
|
|
1462
|
-
"rowStart":1,
|
|
1463
|
-
"rowEnd":1,
|
|
1464
|
-
"columnStart":1,
|
|
1465
|
-
"columnEnd":1,
|
|
1466
|
-
"content":"123"
|
|
1467
|
-
},
|
|
1468
|
-
{
|
|
1469
|
-
"rowStart":2,
|
|
1470
|
-
"rowEnd":3,
|
|
1471
|
-
"columnStart":1,
|
|
1472
|
-
"columnEnd":2,
|
|
1473
|
-
"content":"456"
|
|
1474
|
-
},
|
|
1475
|
-
{
|
|
1476
|
-
"rowStart":3,
|
|
1477
|
-
"rowEnd":3,
|
|
1478
|
-
"columnStart":3,
|
|
1479
|
-
"columnEnd":3,
|
|
1480
|
-
"content":"789"
|
|
1481
|
-
}
|
|
1482
|
-
]
|
|
1483
|
-
}
|
|
1484
|
-
}
|
|
1485
|
-
|
|
1486
|
-
```
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
输入示例3(表格设置字体加粗颜色):
|
|
1490
|
-
|
|
1491
|
-
```
|
|
1492
|
-
{
|
|
1493
|
-
"headers":[
|
|
1494
|
-
{
|
|
1495
|
-
"content":"head1"
|
|
1496
|
-
},
|
|
1497
|
-
{
|
|
1498
|
-
"content":"head2"
|
|
1499
|
-
},
|
|
1500
|
-
{
|
|
1501
|
-
"content":"head3"
|
|
1502
|
-
}
|
|
1503
|
-
],
|
|
1504
|
-
"rowCount":3,
|
|
1505
|
-
"body":{
|
|
1506
|
-
"cells":[
|
|
1507
|
-
{
|
|
1508
|
-
"rowStart":1,
|
|
1509
|
-
"rowEnd":1,
|
|
1510
|
-
"columnStart":1,
|
|
1511
|
-
"columnEnd":1,
|
|
1512
|
-
"content":"123",
|
|
1513
|
-
"style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "CENTER"}
|
|
1514
|
-
},
|
|
1515
|
-
{
|
|
1516
|
-
"rowStart":2,
|
|
1517
|
-
"rowEnd":3,
|
|
1518
|
-
"columnStart":1,
|
|
1519
|
-
"columnEnd":2,
|
|
1520
|
-
"content":"456",
|
|
1521
|
-
"style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "LEFT"}
|
|
1522
|
-
},
|
|
1523
|
-
{
|
|
1524
|
-
"rowStart":3,
|
|
1525
|
-
"rowEnd":3,
|
|
1526
|
-
"columnStart":3,
|
|
1527
|
-
"columnEnd":3,
|
|
1528
|
-
"content":"789",
|
|
1529
|
-
"style": {"color": "#b500bf", "fontSize": 12,"bold": false,"align": "RIGHT"}
|
|
1530
|
-
}
|
|
1531
|
-
]
|
|
1532
|
-
}
|
|
1533
|
-
}
|
|
1534
|
-
|
|
1535
|
-
```
|
|
1536
|
-
|
|
1537
|
-
表格参数说明
|
|
1538
|
-
|
|
1539
|
-
| 名称 | 类型 | 描述 |
|
|
1540
|
-
| ------------------- | ------- | ------------------------------------------------- |
|
|
1541
|
-
| headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
|
|
1542
|
-
| rowCount | Integer | 表格内容最大行数 |
|
|
1543
|
-
| cells.N.rowStart | Integer | 单元格坐标:行起始index |
|
|
1544
|
-
| cells.N.rowEnd | Integer | 单元格坐标:行结束index |
|
|
1545
|
-
| cells.N.columnStart | Integer | 单元格坐标:列起始index |
|
|
1546
|
-
| cells.N.columnEnd | Integer | 单元格坐标:列结束index |
|
|
1547
|
-
| cells.N.content | String | 单元格内容,字数不超过100 |
|
|
1548
|
-
| cells.N.style | String | 单元格字体风格配置 ,风格配置的json字符串 如: {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"} |
|
|
1549
|
-
|
|
1550
|
-
表格参数headers说明
|
|
1551
|
-
widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
|
|
1552
|
-
|
|
1553
|
-
content String 表头单元格内容,字数不超过100
|
|
1554
|
-
|
|
1555
|
-
style String 为字体风格设置 风格支持: font : 目前支持 黑体、宋体; fontSize: 6-72; color:000000-FFFFFF 字符串形如: "#FFFFFF" 或者 "0xFFFFFF"; bold : 是否加粗, true : 加粗 false: 不加粗; align: 对其方式, 支持 LEFT / RIGHT / CENTER
|
|
1556
|
-
*/
|
|
1557
|
-
export interface FormField {
|
|
1558
|
-
/**
|
|
1559
|
-
* 控件填充值,ComponentType和传入值格式对应关系如下:
|
|
1560
|
-
<ul>
|
|
1561
|
-
<li>TEXT - 普通文本控件,需输入文本字符串;</li>
|
|
1562
|
-
<li>MULTI_LINE_TEXT - 多行文本控件,需输入文本字符串;</li>
|
|
1563
|
-
<li>CHECK_BOX - 勾选框控件,若选中需填写ComponentValue,填写 true或者 false 字符串;</li>
|
|
1564
|
-
<li>FILL_IMAGE - 图片控件,需填写ComponentValue为图片的资源 ID;</li>
|
|
1565
|
-
<li>DYNAMIC_TABLE - 动态表格控件;</li>
|
|
1566
|
-
<li>ATTACHMENT - 附件控件,需填写ComponentValue为附件图片的资源 ID列表,以逗号分割;</li>
|
|
1567
|
-
<li>DATE - 日期控件;格式为 <b>xxxx年xx月xx日</b> 字符串;</li>
|
|
1568
|
-
<li>DISTRICT - 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容;</li>
|
|
1569
|
-
</ul>
|
|
1570
|
-
|
|
1571
|
-
*/
|
|
1572
|
-
ComponentValue: string;
|
|
1573
|
-
/**
|
|
1574
|
-
* 表单域或控件的ID,跟ComponentName二选一,不能全为空;
|
|
1575
|
-
CreateFlowsByTemplates 接口不使用此字段。
|
|
1576
|
-
|
|
1577
|
-
<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
|
|
1578
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1579
|
-
*/
|
|
1580
|
-
ComponentId?: string;
|
|
1581
|
-
/**
|
|
1582
|
-
* 控件的名字,跟ComponentId二选一,不能全为空
|
|
1583
|
-
|
|
1584
|
-
<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
|
|
1585
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1586
|
-
*/
|
|
1587
|
-
ComponentName?: string;
|
|
1588
|
-
/**
|
|
1589
|
-
* 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
|
|
1590
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1591
|
-
*/
|
|
1592
|
-
LockComponentValue?: boolean;
|
|
1593
|
-
}
|
|
1594
|
-
/**
|
|
1595
|
-
* ChannelCancelFlow返回参数结构体
|
|
1596
|
-
*/
|
|
1597
|
-
export interface ChannelCancelFlowResponse {
|
|
1598
|
-
/**
|
|
1599
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1600
|
-
*/
|
|
1601
|
-
RequestId?: string;
|
|
1602
|
-
}
|
|
1603
|
-
/**
|
|
1604
|
-
* 签署流程下载信息
|
|
1605
|
-
*/
|
|
1606
|
-
export interface DownloadFlowInfo {
|
|
1607
|
-
/**
|
|
1608
|
-
* 文件夹名称
|
|
1609
|
-
*/
|
|
1610
|
-
FileName: string;
|
|
1611
|
-
/**
|
|
1612
|
-
* 签署流程的标识数组
|
|
1613
|
-
*/
|
|
1614
|
-
FlowIdList: Array<string>;
|
|
1615
|
-
}
|
|
1616
|
-
/**
|
|
1617
|
-
* 签署人签署链接信息。
|
|
1618
|
-
*/
|
|
1619
|
-
export interface FlowApproverUrlInfo {
|
|
1620
|
-
/**
|
|
1621
|
-
* 签署短链接。
|
|
1622
|
-
|
|
1623
|
-
注意:
|
|
1624
|
-
1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
1625
|
-
2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
1626
|
-
3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
1627
|
-
*/
|
|
1628
|
-
SignUrl?: string;
|
|
1629
|
-
/**
|
|
1630
|
-
* 签署人类型。
|
|
1631
|
-
- **PERSON**: 个人
|
|
1632
|
-
*/
|
|
1633
|
-
ApproverType?: string;
|
|
1634
|
-
/**
|
|
1635
|
-
* 签署人姓名。
|
|
1636
|
-
*/
|
|
1637
|
-
Name?: string;
|
|
1638
|
-
/**
|
|
1639
|
-
* 签署人手机号。
|
|
1640
|
-
*/
|
|
1641
|
-
Mobile?: string;
|
|
1642
|
-
/**
|
|
1643
|
-
* 签署长链接。
|
|
1644
|
-
|
|
1645
|
-
注意:
|
|
1646
|
-
1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
1647
|
-
2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
1648
|
-
3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
1649
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1650
|
-
*/
|
|
1651
|
-
LongUrl?: string;
|
|
1652
|
-
}
|
|
1653
|
-
/**
|
|
1654
|
-
* ChannelCreateWebThemeConfig请求参数结构体
|
|
1655
|
-
*/
|
|
1656
|
-
export interface ChannelCreateWebThemeConfigRequest {
|
|
1657
|
-
/**
|
|
1658
|
-
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
|
|
1659
|
-
*/
|
|
1660
|
-
Agent: Agent;
|
|
1661
|
-
/**
|
|
1662
|
-
* 主题类型<br/>EMBED_WEB_THEME:嵌入式主题
|
|
1663
|
-
<ul>
|
|
1664
|
-
<li>EMBED_WEB_THEME,web页面嵌入的主题风格配置</li>
|
|
1665
|
-
<li>COMPANY_AUTHENTICATE,子客认证主题配置, 对当前第三方应用号生效,
|
|
1666
|
-
目前支持的有,背景图替换,隐藏企业认证页面导航栏和隐藏企业认证顶部logo</li>
|
|
1667
|
-
</ul>
|
|
1668
|
-
*/
|
|
1669
|
-
ThemeType: string;
|
|
1670
|
-
/**
|
|
1671
|
-
* 主题配置
|
|
1672
|
-
*/
|
|
1673
|
-
WebThemeConfig: WebThemeConfig;
|
|
1674
|
-
}
|
|
1675
|
-
/**
|
|
1676
|
-
* 需要进行签署审核的签署人信息
|
|
1677
|
-
*/
|
|
1678
|
-
export interface NeedReviewApproverInfo {
|
|
1679
|
-
/**
|
|
1680
|
-
* 签署方经办人的类型,支持以下类型
|
|
1681
|
-
<ul><li> ORGANIZATION 企业(含企业自动签)</li>
|
|
1682
|
-
<li>PERSON 个人(含个人自动签)</li></ul>
|
|
1683
|
-
*/
|
|
1684
|
-
ApproverType: string;
|
|
1685
|
-
/**
|
|
1686
|
-
* 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
1687
|
-
*/
|
|
1688
|
-
ApproverName: string;
|
|
1689
|
-
/**
|
|
1690
|
-
* 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
|
|
1691
|
-
*/
|
|
1692
|
-
ApproverMobile?: string;
|
|
1693
|
-
/**
|
|
1694
|
-
* 签署方经办人的证件类型,支持以下类型
|
|
1695
|
-
<ul><li>ID_CARD 居民身份证 (默认值)</li>
|
|
1696
|
-
<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
|
|
1697
|
-
<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
|
|
1698
|
-
<li>OTHER_CARD_TYPE 其他证件</li></ul>
|
|
1699
|
-
|
|
1700
|
-
注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
1701
|
-
*/
|
|
1702
|
-
ApproverIdCardType?: string;
|
|
1703
|
-
/**
|
|
1704
|
-
* 签署方经办人的证件号码,应符合以下规则
|
|
1705
|
-
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
1706
|
-
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
1707
|
-
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
1708
|
-
*/
|
|
1709
|
-
ApproverIdCardNumber?: string;
|
|
1710
|
-
/**
|
|
1711
|
-
* 组织机构名称。
|
|
1712
|
-
请确认该名称与企业营业执照中注册的名称一致。
|
|
1713
|
-
如果名称中包含英文括号(),请使用中文括号()代替。
|
|
1714
|
-
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
|
|
1715
|
-
|
|
1716
|
-
*/
|
|
1717
|
-
OrganizationName?: string;
|
|
1718
|
-
}
|
|
1719
|
-
/**
|
|
1720
|
-
* CreateFlowGroupSignReview返回参数结构体
|
|
1721
|
-
*/
|
|
1722
|
-
export interface CreateFlowGroupSignReviewResponse {
|
|
1723
|
-
/**
|
|
1724
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1725
|
-
*/
|
|
1726
|
-
RequestId?: string;
|
|
1546
|
+
/**
|
|
1547
|
+
* CreateFlowGroupSignReview返回参数结构体
|
|
1548
|
+
*/
|
|
1549
|
+
export interface CreateFlowGroupSignReviewResponse {
|
|
1550
|
+
/**
|
|
1551
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1552
|
+
*/
|
|
1553
|
+
RequestId?: string;
|
|
1727
1554
|
}
|
|
1728
1555
|
/**
|
|
1729
1556
|
* ChannelCreateConvertTaskApi请求参数结构体
|
|
@@ -2224,6 +2051,18 @@ export interface RecipientComponentInfo {
|
|
|
2224
2051
|
*/
|
|
2225
2052
|
Components?: Array<FilledComponent>;
|
|
2226
2053
|
}
|
|
2054
|
+
/**
|
|
2055
|
+
* 视频认证结果
|
|
2056
|
+
*/
|
|
2057
|
+
export interface DetectInfoVideoData {
|
|
2058
|
+
/**
|
|
2059
|
+
* 活体视频的base64编码,mp4格式
|
|
2060
|
+
|
|
2061
|
+
注:`需进行base64解码获取活体视频文件`
|
|
2062
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2063
|
+
*/
|
|
2064
|
+
LiveNessVideo?: string;
|
|
2065
|
+
}
|
|
2227
2066
|
/**
|
|
2228
2067
|
* ChannelDescribeRoles请求参数结构体
|
|
2229
2068
|
*/
|
|
@@ -2307,6 +2146,23 @@ export interface PrepareFlowsResponse {
|
|
|
2307
2146
|
*/
|
|
2308
2147
|
RequestId?: string;
|
|
2309
2148
|
}
|
|
2149
|
+
/**
|
|
2150
|
+
* 流程签署二维码的签署信息,适用于客户系统整合二维码功能。 通过链接,用户可直接访问电子签名小程序并签署合同。
|
|
2151
|
+
*/
|
|
2152
|
+
export interface SignUrl {
|
|
2153
|
+
/**
|
|
2154
|
+
* 跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
|
|
2155
|
+
*/
|
|
2156
|
+
AppSignUrl?: string;
|
|
2157
|
+
/**
|
|
2158
|
+
* 签署链接有效时间,格式类似"2022-08-05 15:55:01"
|
|
2159
|
+
*/
|
|
2160
|
+
EffectiveTime?: string;
|
|
2161
|
+
/**
|
|
2162
|
+
* 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
|
|
2163
|
+
*/
|
|
2164
|
+
HttpSignUrl?: string;
|
|
2165
|
+
}
|
|
2310
2166
|
/**
|
|
2311
2167
|
* ChannelCancelFlow请求参数结构体
|
|
2312
2168
|
*/
|
|
@@ -3423,6 +3279,16 @@ export interface FillApproverInfo {
|
|
|
3423
3279
|
*/
|
|
3424
3280
|
NotChannelOrganization?: boolean;
|
|
3425
3281
|
}
|
|
3282
|
+
/**
|
|
3283
|
+
* 意愿核身点头确认模式结果详细数据
|
|
3284
|
+
*/
|
|
3285
|
+
export interface IntentionActionResultDetail {
|
|
3286
|
+
/**
|
|
3287
|
+
* 视频base64编码(其中包含全程提示文本和点头音频,mp4格式)
|
|
3288
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3289
|
+
*/
|
|
3290
|
+
Video?: string;
|
|
3291
|
+
}
|
|
3426
3292
|
/**
|
|
3427
3293
|
* ChannelCreateUserAutoSignSealUrl请求参数结构体
|
|
3428
3294
|
*/
|
|
@@ -4223,6 +4089,29 @@ export interface AuthorizedUser {
|
|
|
4223
4089
|
*/
|
|
4224
4090
|
OpenId: string;
|
|
4225
4091
|
}
|
|
4092
|
+
/**
|
|
4093
|
+
* 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
|
|
4094
|
+
|
|
4095
|
+
注: `视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
4096
|
+
*/
|
|
4097
|
+
export interface Intention {
|
|
4098
|
+
/**
|
|
4099
|
+
* 视频认证类型,支持以下类型
|
|
4100
|
+
<ul><li>1 : 问答模式</li>
|
|
4101
|
+
<li>2 : 点头模式</li></ul>
|
|
4102
|
+
|
|
4103
|
+
注: `视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
4104
|
+
*/
|
|
4105
|
+
IntentionType?: number;
|
|
4106
|
+
/**
|
|
4107
|
+
* 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
|
|
4108
|
+
*/
|
|
4109
|
+
IntentionQuestions?: Array<IntentionQuestion>;
|
|
4110
|
+
/**
|
|
4111
|
+
* 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
|
|
4112
|
+
*/
|
|
4113
|
+
IntentionActions?: Array<IntentionAction>;
|
|
4114
|
+
}
|
|
4226
4115
|
/**
|
|
4227
4116
|
* ChannelDeleteRoleUsers返回参数结构体
|
|
4228
4117
|
*/
|
|
@@ -4844,6 +4733,14 @@ export interface FlowApproverInfo {
|
|
|
4844
4733
|
注:`此参数仅在通过文件发起合同或者合同组时生效`
|
|
4845
4734
|
*/
|
|
4846
4735
|
Components?: Array<Component>;
|
|
4736
|
+
/**
|
|
4737
|
+
* 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
|
|
4738
|
+
|
|
4739
|
+
注:
|
|
4740
|
+
`1.视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
4741
|
+
`2.使用视频认证必须指定签署认证方式为人脸(即ApproverSignTypes)。`
|
|
4742
|
+
*/
|
|
4743
|
+
Intention?: Intention;
|
|
4847
4744
|
}
|
|
4848
4745
|
/**
|
|
4849
4746
|
* ChannelCreateUserAutoSignEnableUrl返回参数结构体
|
|
@@ -5195,36 +5092,24 @@ export interface DescribeChannelFlowEvidenceReportRequest {
|
|
|
5195
5092
|
*/
|
|
5196
5093
|
export interface ChannelCreateRoleResponse {
|
|
5197
5094
|
/**
|
|
5198
|
-
* 角色id
|
|
5199
|
-
*/
|
|
5200
|
-
RoleId?: string;
|
|
5201
|
-
/**
|
|
5202
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
5203
|
-
*/
|
|
5204
|
-
RequestId?: string;
|
|
5205
|
-
}
|
|
5206
|
-
/**
|
|
5207
|
-
* SyncProxyOrganizationOperators返回参数结构体
|
|
5208
|
-
*/
|
|
5209
|
-
export interface SyncProxyOrganizationOperatorsResponse {
|
|
5210
|
-
/**
|
|
5211
|
-
* 同步的状态, 全部同步失败接口是接口会直接报错
|
|
5212
|
-
|
|
5213
|
-
<ul><li> **1** :全部成功</li>
|
|
5214
|
-
<li> **2** :部分成功</li></ul>
|
|
5215
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
5216
|
-
*/
|
|
5217
|
-
Status?: number;
|
|
5218
|
-
/**
|
|
5219
|
-
* 同步失败员工ID及其失败原因
|
|
5220
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
5095
|
+
* 角色id
|
|
5221
5096
|
*/
|
|
5222
|
-
|
|
5097
|
+
RoleId?: string;
|
|
5223
5098
|
/**
|
|
5224
5099
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
5225
5100
|
*/
|
|
5226
5101
|
RequestId?: string;
|
|
5227
5102
|
}
|
|
5103
|
+
/**
|
|
5104
|
+
* 意愿核身点头确认模式结果
|
|
5105
|
+
*/
|
|
5106
|
+
export interface IntentionActionResult {
|
|
5107
|
+
/**
|
|
5108
|
+
* 意愿核身结果详细数据,与每段点头确认过程一一对应
|
|
5109
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5110
|
+
*/
|
|
5111
|
+
Details?: Array<IntentionActionResultDetail>;
|
|
5112
|
+
}
|
|
5228
5113
|
/**
|
|
5229
5114
|
* 绑定失败的用户角色信息
|
|
5230
5115
|
*/
|
|
@@ -5623,26 +5508,13 @@ export interface ApproverRestriction {
|
|
|
5623
5508
|
IdCardNumber?: string;
|
|
5624
5509
|
}
|
|
5625
5510
|
/**
|
|
5626
|
-
*
|
|
5511
|
+
* 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
|
|
5627
5512
|
*/
|
|
5628
|
-
export interface
|
|
5629
|
-
/**
|
|
5630
|
-
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
|
|
5631
|
-
*/
|
|
5632
|
-
Agent: Agent;
|
|
5633
|
-
/**
|
|
5634
|
-
* 多个合同(签署流程)信息,最大支持20个签署流程。
|
|
5635
|
-
*/
|
|
5636
|
-
FlowInfos: Array<FlowInfo>;
|
|
5637
|
-
/**
|
|
5638
|
-
* 操作完成后的跳转地址,最大长度200
|
|
5639
|
-
*/
|
|
5640
|
-
JumpUrl: string;
|
|
5513
|
+
export interface IntentionAction {
|
|
5641
5514
|
/**
|
|
5642
|
-
*
|
|
5643
|
-
* @deprecated
|
|
5515
|
+
* 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
|
|
5644
5516
|
*/
|
|
5645
|
-
|
|
5517
|
+
Text?: string;
|
|
5646
5518
|
}
|
|
5647
5519
|
/**
|
|
5648
5520
|
* 签署方信息,发起合同后可获取到对应的签署方信息,如角色ID,角色名称
|
|
@@ -5717,6 +5589,28 @@ export interface ChannelDescribeOrganizationSealsResponse {
|
|
|
5717
5589
|
*/
|
|
5718
5590
|
RequestId?: string;
|
|
5719
5591
|
}
|
|
5592
|
+
/**
|
|
5593
|
+
* SyncProxyOrganizationOperators返回参数结构体
|
|
5594
|
+
*/
|
|
5595
|
+
export interface SyncProxyOrganizationOperatorsResponse {
|
|
5596
|
+
/**
|
|
5597
|
+
* 同步的状态, 全部同步失败接口是接口会直接报错
|
|
5598
|
+
|
|
5599
|
+
<ul><li> **1** :全部成功</li>
|
|
5600
|
+
<li> **2** :部分成功</li></ul>
|
|
5601
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5602
|
+
*/
|
|
5603
|
+
Status?: number;
|
|
5604
|
+
/**
|
|
5605
|
+
* 同步失败员工ID及其失败原因
|
|
5606
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5607
|
+
*/
|
|
5608
|
+
FailedList?: Array<SyncFailReason>;
|
|
5609
|
+
/**
|
|
5610
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
5611
|
+
*/
|
|
5612
|
+
RequestId?: string;
|
|
5613
|
+
}
|
|
5720
5614
|
/**
|
|
5721
5615
|
* CreateSealByImage返回参数结构体
|
|
5722
5616
|
*/
|
|
@@ -6199,47 +6093,249 @@ export interface ChannelCreateBatchSignUrlRequest {
|
|
|
6199
6093
|
<li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
|
|
6200
6094
|
</ul>
|
|
6201
6095
|
*/
|
|
6202
|
-
JumpToDetail?: boolean;
|
|
6096
|
+
JumpToDetail?: boolean;
|
|
6097
|
+
}
|
|
6098
|
+
/**
|
|
6099
|
+
* ChannelCreateOrganizationModifyQrCode返回参数结构体
|
|
6100
|
+
*/
|
|
6101
|
+
export interface ChannelCreateOrganizationModifyQrCodeResponse {
|
|
6102
|
+
/**
|
|
6103
|
+
* 二维码下载链接
|
|
6104
|
+
*/
|
|
6105
|
+
QrCodeUrl?: string;
|
|
6106
|
+
/**
|
|
6107
|
+
* 二维码失效时间 UNIX 时间戳 精确到秒
|
|
6108
|
+
*/
|
|
6109
|
+
ExpiredTime?: number;
|
|
6110
|
+
/**
|
|
6111
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6112
|
+
*/
|
|
6113
|
+
RequestId?: string;
|
|
6114
|
+
}
|
|
6115
|
+
/**
|
|
6116
|
+
* ChannelDeleteSealPolicies返回参数结构体
|
|
6117
|
+
*/
|
|
6118
|
+
export interface ChannelDeleteSealPoliciesResponse {
|
|
6119
|
+
/**
|
|
6120
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6121
|
+
*/
|
|
6122
|
+
RequestId?: string;
|
|
6123
|
+
}
|
|
6124
|
+
/**
|
|
6125
|
+
* ChannelCreateWebThemeConfig返回参数结构体
|
|
6126
|
+
*/
|
|
6127
|
+
export interface ChannelCreateWebThemeConfigResponse {
|
|
6128
|
+
/**
|
|
6129
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6130
|
+
*/
|
|
6131
|
+
RequestId?: string;
|
|
6132
|
+
}
|
|
6133
|
+
/**
|
|
6134
|
+
* GetDownloadFlowUrl请求参数结构体
|
|
6135
|
+
*/
|
|
6136
|
+
export interface GetDownloadFlowUrlRequest {
|
|
6137
|
+
/**
|
|
6138
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6139
|
+
|
|
6140
|
+
此接口下面信息必填。
|
|
6141
|
+
<ul>
|
|
6142
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6143
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6144
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
6145
|
+
</ul>
|
|
6146
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
6147
|
+
*/
|
|
6148
|
+
Agent: Agent;
|
|
6149
|
+
/**
|
|
6150
|
+
* 程合同ID列表, 可将这些流程ID组织成合同组的形式, 下载时候每个文件夹会是一个zip压缩包, 每个文件夹最多20个合同, 所有文件夹最多50个合同
|
|
6151
|
+
如下列组织形式, 控制台下载页面点击下载按钮后, 会生成**2023采购合同.zip**和**2023入职合同.zip** 两个下载任务(注:`部分浏览器需要授权或不支持创建多下载任务`)
|
|
6152
|
+
|
|
6153
|
+
**2023采购合同.zip**压缩包会有`yDwivUUckpor6wtoUuogwQHCAB0ES0pQ`和`yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh`两个合同的文件
|
|
6154
|
+
**2023入职合同.zip** 压缩包会有`yDwivUUckpor6wobUuogwQHvdGfvDi5K`的文件
|
|
6155
|
+
|
|
6156
|
+

|
|
6157
|
+
*/
|
|
6158
|
+
DownLoadFlows?: Array<DownloadFlowInfo>;
|
|
6159
|
+
/**
|
|
6160
|
+
* 操作者的信息,不用传
|
|
6161
|
+
* @deprecated
|
|
6162
|
+
*/
|
|
6163
|
+
Operator?: UserInfo;
|
|
6164
|
+
}
|
|
6165
|
+
/**
|
|
6166
|
+
* ChannelCreateEmbedWebUrl返回参数结构体
|
|
6167
|
+
*/
|
|
6168
|
+
export interface ChannelCreateEmbedWebUrlResponse {
|
|
6169
|
+
/**
|
|
6170
|
+
* 嵌入的web链接,5分钟有效
|
|
6171
|
+
*/
|
|
6172
|
+
WebUrl?: string;
|
|
6173
|
+
/**
|
|
6174
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6175
|
+
*/
|
|
6176
|
+
RequestId?: string;
|
|
6177
|
+
}
|
|
6178
|
+
/**
|
|
6179
|
+
* ChannelBatchCancelFlows请求参数结构体
|
|
6180
|
+
*/
|
|
6181
|
+
export interface ChannelBatchCancelFlowsRequest {
|
|
6182
|
+
/**
|
|
6183
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6184
|
+
|
|
6185
|
+
此接口下面信息必填。
|
|
6186
|
+
<ul>
|
|
6187
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6188
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6189
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
6190
|
+
</ul>
|
|
6191
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
6192
|
+
*/
|
|
6193
|
+
Agent: Agent;
|
|
6194
|
+
/**
|
|
6195
|
+
* 要撤销的合同流程ID列表,最多100个,超过100不处理
|
|
6196
|
+
*/
|
|
6197
|
+
FlowIds: Array<string>;
|
|
6198
|
+
/**
|
|
6199
|
+
* 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
6200
|
+
|
|
6201
|
+
备注:`如果不传递撤回原因,那么默认撤回原因是 "自动撤销(通过接口实现)"`
|
|
6202
|
+
*/
|
|
6203
|
+
CancelMessage?: string;
|
|
6204
|
+
/**
|
|
6205
|
+
* 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
|
|
6206
|
+
|
|
6207
|
+
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
6208
|
+
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
|
|
6209
|
+
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
|
|
6210
|
+
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
6211
|
+
|
|
6212
|
+
注: `CancelMessage为撤销当前合同的理由`
|
|
6213
|
+
|
|
6214
|
+

|
|
6215
|
+
|
|
6216
|
+
|
|
6217
|
+
*/
|
|
6218
|
+
CancelMessageFormat?: number;
|
|
6219
|
+
/**
|
|
6220
|
+
* 暂未开放
|
|
6221
|
+
* @deprecated
|
|
6222
|
+
*/
|
|
6223
|
+
Operator?: UserInfo;
|
|
6224
|
+
}
|
|
6225
|
+
/**
|
|
6226
|
+
* CreateChannelOrganizationInfoChangeUrl请求参数结构体
|
|
6227
|
+
*/
|
|
6228
|
+
export interface CreateChannelOrganizationInfoChangeUrlRequest {
|
|
6229
|
+
/**
|
|
6230
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6231
|
+
|
|
6232
|
+
此接口下面信息必填。
|
|
6233
|
+
<ul>
|
|
6234
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6235
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6236
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
6237
|
+
</ul>
|
|
6238
|
+
第三方平台子客企业和员工必须已经过实名认证
|
|
6239
|
+
*/
|
|
6240
|
+
Agent: Agent;
|
|
6241
|
+
/**
|
|
6242
|
+
* 企业信息变更类型,可选类型如下:
|
|
6243
|
+
<ul><li>**1**:企业超管变更, 可以将超管换成同企业的其他员工</li>
|
|
6244
|
+
<li>**2**:企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息</li></ul>
|
|
6245
|
+
*/
|
|
6246
|
+
ChangeType: number;
|
|
6247
|
+
/**
|
|
6248
|
+
* 变更链接类型:
|
|
6249
|
+
<ul>
|
|
6250
|
+
<li>**WEIXINAPP** : 创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。(默认)</li>
|
|
6251
|
+
<li>**APP** : 创建变更小程序链接,可从第三方App或者小程序跳转到微信腾讯电子签小程序进行更换。</li>
|
|
6252
|
+
</ul>
|
|
6253
|
+
*/
|
|
6254
|
+
Endpoint?: string;
|
|
6255
|
+
}
|
|
6256
|
+
/**
|
|
6257
|
+
* ChannelModifyRole请求参数结构体
|
|
6258
|
+
*/
|
|
6259
|
+
export interface ChannelModifyRoleRequest {
|
|
6260
|
+
/**
|
|
6261
|
+
* 代理企业和员工的信息。
|
|
6262
|
+
*/
|
|
6263
|
+
Agent: Agent;
|
|
6264
|
+
/**
|
|
6265
|
+
* 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
|
|
6266
|
+
*/
|
|
6267
|
+
Name: string;
|
|
6268
|
+
/**
|
|
6269
|
+
* 角色Id,可通过接口 ChannelDescribeRoles 查询获取
|
|
6270
|
+
*/
|
|
6271
|
+
RoleId: string;
|
|
6272
|
+
/**
|
|
6273
|
+
* 角色描述,最大长度为50个字符
|
|
6274
|
+
*/
|
|
6275
|
+
Description?: string;
|
|
6276
|
+
/**
|
|
6277
|
+
* 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
|
|
6278
|
+
*/
|
|
6279
|
+
PermissionGroups?: Array<PermissionGroup>;
|
|
6280
|
+
}
|
|
6281
|
+
/**
|
|
6282
|
+
* ModifyFlowDeadline请求参数结构体
|
|
6283
|
+
*/
|
|
6284
|
+
export interface ModifyFlowDeadlineRequest {
|
|
6285
|
+
/**
|
|
6286
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
|
|
6287
|
+
*/
|
|
6288
|
+
Agent: Agent;
|
|
6289
|
+
/**
|
|
6290
|
+
* 合同流程ID,为32位字符串。
|
|
6291
|
+
<ul><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</li>
|
|
6292
|
+
<li>可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
|
|
6293
|
+
*/
|
|
6294
|
+
FlowId: string;
|
|
6295
|
+
/**
|
|
6296
|
+
* 签署流程或签署人新的签署截止时间,格式为Unix标准时间戳(秒)
|
|
6297
|
+
|
|
6298
|
+
*/
|
|
6299
|
+
Deadline: number;
|
|
6300
|
+
/**
|
|
6301
|
+
* 签署方角色编号,为32位字符串
|
|
6302
|
+
<ul><li>若指定了此参数,则只调整签署流程中此签署人的签署截止时间,否则调整合同整体的签署截止时间(合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间)</li>
|
|
6303
|
+
<li>通过[用PDF文件创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)发起合同,或通过[用模板创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/CreateFlowsByTemplates)时,返回参数[FlowApprovers](https://test.qian.tencent.cn/developers/partnerApis/dataTypes/#approveritem)会返回此信息,建议开发者妥善保存</li>
|
|
6304
|
+
<li>也可通过[获取合同信息](https://test.qian.tencent.cn/developers/partnerApis/flows/DescribeFlowDetailInfo)接口查询签署人的RecipientId编号</li></ul>
|
|
6305
|
+
*/
|
|
6306
|
+
RecipientId?: string;
|
|
6203
6307
|
}
|
|
6204
6308
|
/**
|
|
6205
|
-
*
|
|
6309
|
+
* ChannelUpdateSealStatus请求参数结构体
|
|
6206
6310
|
*/
|
|
6207
|
-
export interface
|
|
6311
|
+
export interface ChannelUpdateSealStatusRequest {
|
|
6208
6312
|
/**
|
|
6209
|
-
*
|
|
6313
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6210
6314
|
*/
|
|
6211
|
-
|
|
6315
|
+
Agent: Agent;
|
|
6212
6316
|
/**
|
|
6213
|
-
*
|
|
6317
|
+
* 印章状态,目前支持传入以下类型:
|
|
6318
|
+
<ul><li>DISABLE-停用印章</li></ul>
|
|
6214
6319
|
*/
|
|
6215
|
-
|
|
6320
|
+
Status: string;
|
|
6216
6321
|
/**
|
|
6217
|
-
*
|
|
6322
|
+
* 印章ID
|
|
6218
6323
|
*/
|
|
6219
|
-
|
|
6220
|
-
}
|
|
6221
|
-
/**
|
|
6222
|
-
* ChannelDeleteSealPolicies返回参数结构体
|
|
6223
|
-
*/
|
|
6224
|
-
export interface ChannelDeleteSealPoliciesResponse {
|
|
6324
|
+
SealId: string;
|
|
6225
6325
|
/**
|
|
6226
|
-
*
|
|
6326
|
+
* 更新印章状态原因说明
|
|
6227
6327
|
*/
|
|
6228
|
-
|
|
6229
|
-
}
|
|
6230
|
-
/**
|
|
6231
|
-
* ChannelCreateWebThemeConfig返回参数结构体
|
|
6232
|
-
*/
|
|
6233
|
-
export interface ChannelCreateWebThemeConfigResponse {
|
|
6328
|
+
Reason?: string;
|
|
6234
6329
|
/**
|
|
6235
|
-
*
|
|
6330
|
+
* 操作者的信息
|
|
6331
|
+
* @deprecated
|
|
6236
6332
|
*/
|
|
6237
|
-
|
|
6333
|
+
Operator?: UserInfo;
|
|
6238
6334
|
}
|
|
6239
6335
|
/**
|
|
6240
|
-
*
|
|
6336
|
+
* ChannelCreateFlowGroupByTemplates请求参数结构体
|
|
6241
6337
|
*/
|
|
6242
|
-
export interface
|
|
6338
|
+
export interface ChannelCreateFlowGroupByTemplatesRequest {
|
|
6243
6339
|
/**
|
|
6244
6340
|
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6245
6341
|
|
|
@@ -6253,232 +6349,281 @@ export interface GetDownloadFlowUrlRequest {
|
|
|
6253
6349
|
*/
|
|
6254
6350
|
Agent: Agent;
|
|
6255
6351
|
/**
|
|
6256
|
-
*
|
|
6257
|
-
如下列组织形式, 控制台下载页面点击下载按钮后, 会生成**2023采购合同.zip**和**2023入职合同.zip** 两个下载任务(注:`部分浏览器需要授权或不支持创建多下载任务`)
|
|
6258
|
-
|
|
6259
|
-
**2023采购合同.zip**压缩包会有`yDwivUUckpor6wtoUuogwQHCAB0ES0pQ`和`yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh`两个合同的文件
|
|
6260
|
-
**2023入职合同.zip** 压缩包会有`yDwivUUckpor6wobUuogwQHvdGfvDi5K`的文件
|
|
6261
|
-
|
|
6262
|
-

|
|
6352
|
+
* 合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。
|
|
6263
6353
|
*/
|
|
6264
|
-
|
|
6354
|
+
FlowInfos: Array<FlowInfo>;
|
|
6265
6355
|
/**
|
|
6266
|
-
*
|
|
6267
|
-
* @deprecated
|
|
6356
|
+
* 合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
6268
6357
|
*/
|
|
6269
|
-
|
|
6358
|
+
FlowGroupName: string;
|
|
6270
6359
|
}
|
|
6271
6360
|
/**
|
|
6272
|
-
*
|
|
6273
|
-
|
|
6274
|
-
|
|
6275
|
-
|
|
6276
|
-
|
|
6277
|
-
|
|
6278
|
-
|
|
6279
|
-
|
|
6280
|
-
|
|
6281
|
-
|
|
6282
|
-
|
|
6361
|
+
* 电子文档的控件填充信息。按照控件类型进行相应的填充。
|
|
6362
|
+
|
|
6363
|
+
当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
|
|
6364
|
+
```
|
|
6365
|
+
FormField输入示例:
|
|
6366
|
+
{
|
|
6367
|
+
"ComponentId": "componentId1",
|
|
6368
|
+
"ComponentValue": "文本内容"
|
|
6369
|
+
}
|
|
6370
|
+
```
|
|
6371
|
+
当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
|
|
6372
|
+
```
|
|
6373
|
+
FormField输入示例:
|
|
6374
|
+
{
|
|
6375
|
+
"ComponentId": "componentId1",
|
|
6376
|
+
"ComponentValue": "多行文本内容"
|
|
6377
|
+
}
|
|
6378
|
+
```
|
|
6379
|
+
当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
|
|
6380
|
+
```
|
|
6381
|
+
FormField输入示例:
|
|
6382
|
+
{
|
|
6383
|
+
"ComponentId": "componentId1",
|
|
6384
|
+
"ComponentValue": "true"
|
|
6385
|
+
}
|
|
6386
|
+
```
|
|
6387
|
+
当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
|
|
6388
|
+
```
|
|
6389
|
+
FormField输入示例:
|
|
6390
|
+
{
|
|
6391
|
+
"ComponentId": "componentId1",
|
|
6392
|
+
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
|
6393
|
+
}
|
|
6394
|
+
```
|
|
6395
|
+
当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
|
|
6396
|
+
```
|
|
6397
|
+
FormField输入示例:
|
|
6398
|
+
{
|
|
6399
|
+
"ComponentId": "componentId1",
|
|
6400
|
+
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
|
|
6401
|
+
}
|
|
6402
|
+
```
|
|
6403
|
+
当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
|
|
6404
|
+
```
|
|
6405
|
+
FormField输入示例:
|
|
6406
|
+
{
|
|
6407
|
+
"ComponentId": "componentId1",
|
|
6408
|
+
"ComponentValue": "选择的内容"
|
|
6409
|
+
}
|
|
6410
|
+
```
|
|
6411
|
+
当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
|
|
6412
|
+
```
|
|
6413
|
+
FormField输入示例:
|
|
6414
|
+
{
|
|
6415
|
+
"ComponentId": "componentId1",
|
|
6416
|
+
"ComponentValue": "2023年01月01日"
|
|
6417
|
+
}
|
|
6418
|
+
```
|
|
6419
|
+
当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
|
|
6420
|
+
```
|
|
6421
|
+
FormField输入示例:
|
|
6422
|
+
{
|
|
6423
|
+
"ComponentId": "componentId1",
|
|
6424
|
+
"ComponentValue": "广东省深圳市福田区"
|
|
6425
|
+
}
|
|
6426
|
+
```
|
|
6427
|
+
【数据表格传参说明】
|
|
6428
|
+
当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
|
|
6429
|
+
输入示例1:
|
|
6430
|
+
|
|
6431
|
+
```
|
|
6432
|
+
{
|
|
6433
|
+
"headers":[
|
|
6434
|
+
{
|
|
6435
|
+
"content":"head1"
|
|
6436
|
+
},
|
|
6437
|
+
{
|
|
6438
|
+
"content":"head2"
|
|
6439
|
+
},
|
|
6440
|
+
{
|
|
6441
|
+
"content":"head3"
|
|
6442
|
+
}
|
|
6443
|
+
],
|
|
6444
|
+
"rowCount":3,
|
|
6445
|
+
"body":{
|
|
6446
|
+
"cells":[
|
|
6447
|
+
{
|
|
6448
|
+
"rowStart":1,
|
|
6449
|
+
"rowEnd":1,
|
|
6450
|
+
"columnStart":1,
|
|
6451
|
+
"columnEnd":1,
|
|
6452
|
+
"content":"123"
|
|
6453
|
+
},
|
|
6454
|
+
{
|
|
6455
|
+
"rowStart":2,
|
|
6456
|
+
"rowEnd":3,
|
|
6457
|
+
"columnStart":1,
|
|
6458
|
+
"columnEnd":2,
|
|
6459
|
+
"content":"456"
|
|
6460
|
+
},
|
|
6461
|
+
{
|
|
6462
|
+
"rowStart":3,
|
|
6463
|
+
"rowEnd":3,
|
|
6464
|
+
"columnStart":3,
|
|
6465
|
+
"columnEnd":3,
|
|
6466
|
+
"content":"789"
|
|
6467
|
+
}
|
|
6468
|
+
]
|
|
6469
|
+
}
|
|
6470
|
+
}
|
|
6471
|
+
|
|
6472
|
+
```
|
|
6473
|
+
|
|
6474
|
+
输入示例2(表格表头宽度比例配置):
|
|
6475
|
+
|
|
6476
|
+
```
|
|
6477
|
+
{
|
|
6478
|
+
"headers":[
|
|
6479
|
+
{
|
|
6480
|
+
"content":"head1",
|
|
6481
|
+
"widthPercent": 30
|
|
6482
|
+
},
|
|
6483
|
+
{
|
|
6484
|
+
"content":"head2",
|
|
6485
|
+
"widthPercent": 30
|
|
6486
|
+
},
|
|
6487
|
+
{
|
|
6488
|
+
"content":"head3",
|
|
6489
|
+
"widthPercent": 40
|
|
6490
|
+
}
|
|
6491
|
+
],
|
|
6492
|
+
"rowCount":3,
|
|
6493
|
+
"body":{
|
|
6494
|
+
"cells":[
|
|
6495
|
+
{
|
|
6496
|
+
"rowStart":1,
|
|
6497
|
+
"rowEnd":1,
|
|
6498
|
+
"columnStart":1,
|
|
6499
|
+
"columnEnd":1,
|
|
6500
|
+
"content":"123"
|
|
6501
|
+
},
|
|
6502
|
+
{
|
|
6503
|
+
"rowStart":2,
|
|
6504
|
+
"rowEnd":3,
|
|
6505
|
+
"columnStart":1,
|
|
6506
|
+
"columnEnd":2,
|
|
6507
|
+
"content":"456"
|
|
6508
|
+
},
|
|
6509
|
+
{
|
|
6510
|
+
"rowStart":3,
|
|
6511
|
+
"rowEnd":3,
|
|
6512
|
+
"columnStart":3,
|
|
6513
|
+
"columnEnd":3,
|
|
6514
|
+
"content":"789"
|
|
6515
|
+
}
|
|
6516
|
+
]
|
|
6517
|
+
}
|
|
6518
|
+
}
|
|
6519
|
+
|
|
6520
|
+
```
|
|
6521
|
+
|
|
6522
|
+
|
|
6523
|
+
输入示例3(表格设置字体加粗颜色):
|
|
6524
|
+
|
|
6525
|
+
```
|
|
6526
|
+
{
|
|
6527
|
+
"headers":[
|
|
6528
|
+
{
|
|
6529
|
+
"content":"head1"
|
|
6530
|
+
},
|
|
6531
|
+
{
|
|
6532
|
+
"content":"head2"
|
|
6533
|
+
},
|
|
6534
|
+
{
|
|
6535
|
+
"content":"head3"
|
|
6536
|
+
}
|
|
6537
|
+
],
|
|
6538
|
+
"rowCount":3,
|
|
6539
|
+
"body":{
|
|
6540
|
+
"cells":[
|
|
6541
|
+
{
|
|
6542
|
+
"rowStart":1,
|
|
6543
|
+
"rowEnd":1,
|
|
6544
|
+
"columnStart":1,
|
|
6545
|
+
"columnEnd":1,
|
|
6546
|
+
"content":"123",
|
|
6547
|
+
"style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "CENTER"}
|
|
6548
|
+
},
|
|
6549
|
+
{
|
|
6550
|
+
"rowStart":2,
|
|
6551
|
+
"rowEnd":3,
|
|
6552
|
+
"columnStart":1,
|
|
6553
|
+
"columnEnd":2,
|
|
6554
|
+
"content":"456",
|
|
6555
|
+
"style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "LEFT"}
|
|
6556
|
+
},
|
|
6557
|
+
{
|
|
6558
|
+
"rowStart":3,
|
|
6559
|
+
"rowEnd":3,
|
|
6560
|
+
"columnStart":3,
|
|
6561
|
+
"columnEnd":3,
|
|
6562
|
+
"content":"789",
|
|
6563
|
+
"style": {"color": "#b500bf", "fontSize": 12,"bold": false,"align": "RIGHT"}
|
|
6564
|
+
}
|
|
6565
|
+
]
|
|
6566
|
+
}
|
|
6283
6567
|
}
|
|
6284
|
-
|
|
6285
|
-
|
|
6568
|
+
|
|
6569
|
+
```
|
|
6570
|
+
|
|
6571
|
+
表格参数说明
|
|
6572
|
+
|
|
6573
|
+
| 名称 | 类型 | 描述 |
|
|
6574
|
+
| ------------------- | ------- | ------------------------------------------------- |
|
|
6575
|
+
| headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
|
|
6576
|
+
| rowCount | Integer | 表格内容最大行数 |
|
|
6577
|
+
| cells.N.rowStart | Integer | 单元格坐标:行起始index |
|
|
6578
|
+
| cells.N.rowEnd | Integer | 单元格坐标:行结束index |
|
|
6579
|
+
| cells.N.columnStart | Integer | 单元格坐标:列起始index |
|
|
6580
|
+
| cells.N.columnEnd | Integer | 单元格坐标:列结束index |
|
|
6581
|
+
| cells.N.content | String | 单元格内容,字数不超过100 |
|
|
6582
|
+
| cells.N.style | String | 单元格字体风格配置 ,风格配置的json字符串 如: {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"} |
|
|
6583
|
+
|
|
6584
|
+
表格参数headers说明
|
|
6585
|
+
widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
|
|
6586
|
+
|
|
6587
|
+
content String 表头单元格内容,字数不超过100
|
|
6588
|
+
|
|
6589
|
+
style String 为字体风格设置 风格支持: font : 目前支持 黑体、宋体; fontSize: 6-72; color:000000-FFFFFF 字符串形如: "#FFFFFF" 或者 "0xFFFFFF"; bold : 是否加粗, true : 加粗 false: 不加粗; align: 对其方式, 支持 LEFT / RIGHT / CENTER
|
|
6286
6590
|
*/
|
|
6287
|
-
export interface
|
|
6591
|
+
export interface FormField {
|
|
6288
6592
|
/**
|
|
6289
|
-
*
|
|
6290
|
-
|
|
6291
|
-
此接口下面信息必填。
|
|
6593
|
+
* 控件填充值,ComponentType和传入值格式对应关系如下:
|
|
6292
6594
|
<ul>
|
|
6293
|
-
<li
|
|
6294
|
-
<li
|
|
6295
|
-
<li
|
|
6595
|
+
<li>TEXT - 普通文本控件,需输入文本字符串;</li>
|
|
6596
|
+
<li>MULTI_LINE_TEXT - 多行文本控件,需输入文本字符串;</li>
|
|
6597
|
+
<li>CHECK_BOX - 勾选框控件,若选中需填写ComponentValue,填写 true或者 false 字符串;</li>
|
|
6598
|
+
<li>FILL_IMAGE - 图片控件,需填写ComponentValue为图片的资源 ID;</li>
|
|
6599
|
+
<li>DYNAMIC_TABLE - 动态表格控件;</li>
|
|
6600
|
+
<li>ATTACHMENT - 附件控件,需填写ComponentValue为附件图片的资源 ID列表,以逗号分割;</li>
|
|
6601
|
+
<li>DATE - 日期控件;格式为 <b>xxxx年xx月xx日</b> 字符串;</li>
|
|
6602
|
+
<li>DISTRICT - 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容;</li>
|
|
6296
6603
|
</ul>
|
|
6297
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
6298
|
-
*/
|
|
6299
|
-
Agent: Agent;
|
|
6300
|
-
/**
|
|
6301
|
-
* 要撤销的合同流程ID列表,最多100个,超过100不处理
|
|
6302
|
-
*/
|
|
6303
|
-
FlowIds: Array<string>;
|
|
6304
|
-
/**
|
|
6305
|
-
* 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
6306
|
-
|
|
6307
|
-
备注:`如果不传递撤回原因,那么默认撤回原因是 "自动撤销(通过接口实现)"`
|
|
6308
|
-
*/
|
|
6309
|
-
CancelMessage?: string;
|
|
6310
|
-
/**
|
|
6311
|
-
* 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
|
|
6312
|
-
|
|
6313
|
-
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
6314
|
-
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
|
|
6315
|
-
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
|
|
6316
|
-
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
6317
|
-
|
|
6318
|
-
注: `CancelMessage为撤销当前合同的理由`
|
|
6319
|
-
|
|
6320
|
-

|
|
6321
|
-
|
|
6322
|
-
|
|
6323
|
-
*/
|
|
6324
|
-
CancelMessageFormat?: number;
|
|
6325
|
-
/**
|
|
6326
|
-
* 暂未开放
|
|
6327
|
-
* @deprecated
|
|
6328
|
-
*/
|
|
6329
|
-
Operator?: UserInfo;
|
|
6330
|
-
}
|
|
6331
|
-
/**
|
|
6332
|
-
* CreateChannelOrganizationInfoChangeUrl请求参数结构体
|
|
6333
|
-
*/
|
|
6334
|
-
export interface CreateChannelOrganizationInfoChangeUrlRequest {
|
|
6335
|
-
/**
|
|
6336
|
-
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6337
6604
|
|
|
6338
|
-
此接口下面信息必填。
|
|
6339
|
-
<ul>
|
|
6340
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
6341
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6342
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
6343
|
-
</ul>
|
|
6344
|
-
第三方平台子客企业和员工必须已经过实名认证
|
|
6345
|
-
*/
|
|
6346
|
-
Agent: Agent;
|
|
6347
|
-
/**
|
|
6348
|
-
* 企业信息变更类型,可选类型如下:
|
|
6349
|
-
<ul><li>**1**:企业超管变更, 可以将超管换成同企业的其他员工</li>
|
|
6350
|
-
<li>**2**:企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息</li></ul>
|
|
6351
|
-
*/
|
|
6352
|
-
ChangeType: number;
|
|
6353
|
-
/**
|
|
6354
|
-
* 变更链接类型:
|
|
6355
|
-
<ul>
|
|
6356
|
-
<li>**WEIXINAPP** : 创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。(默认)</li>
|
|
6357
|
-
<li>**APP** : 创建变更小程序链接,可从第三方App或者小程序跳转到微信腾讯电子签小程序进行更换。</li>
|
|
6358
|
-
</ul>
|
|
6359
|
-
*/
|
|
6360
|
-
Endpoint?: string;
|
|
6361
|
-
}
|
|
6362
|
-
/**
|
|
6363
|
-
* ChannelModifyRole请求参数结构体
|
|
6364
|
-
*/
|
|
6365
|
-
export interface ChannelModifyRoleRequest {
|
|
6366
|
-
/**
|
|
6367
|
-
* 代理企业和员工的信息。
|
|
6368
|
-
*/
|
|
6369
|
-
Agent: Agent;
|
|
6370
|
-
/**
|
|
6371
|
-
* 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
|
|
6372
|
-
*/
|
|
6373
|
-
Name: string;
|
|
6374
|
-
/**
|
|
6375
|
-
* 角色Id,可通过接口 ChannelDescribeRoles 查询获取
|
|
6376
|
-
*/
|
|
6377
|
-
RoleId: string;
|
|
6378
|
-
/**
|
|
6379
|
-
* 角色描述,最大长度为50个字符
|
|
6380
|
-
*/
|
|
6381
|
-
Description?: string;
|
|
6382
|
-
/**
|
|
6383
|
-
* 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
|
|
6384
|
-
*/
|
|
6385
|
-
PermissionGroups?: Array<PermissionGroup>;
|
|
6386
|
-
}
|
|
6387
|
-
/**
|
|
6388
|
-
* ModifyFlowDeadline请求参数结构体
|
|
6389
|
-
*/
|
|
6390
|
-
export interface ModifyFlowDeadlineRequest {
|
|
6391
|
-
/**
|
|
6392
|
-
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
|
|
6393
|
-
*/
|
|
6394
|
-
Agent: Agent;
|
|
6395
|
-
/**
|
|
6396
|
-
* 合同流程ID,为32位字符串。
|
|
6397
|
-
<ul><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</li>
|
|
6398
|
-
<li>可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
|
|
6399
6605
|
*/
|
|
6400
|
-
|
|
6606
|
+
ComponentValue: string;
|
|
6401
6607
|
/**
|
|
6402
|
-
*
|
|
6608
|
+
* 表单域或控件的ID,跟ComponentName二选一,不能全为空;
|
|
6609
|
+
CreateFlowsByTemplates 接口不使用此字段。
|
|
6403
6610
|
|
|
6611
|
+
<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
|
|
6612
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
6404
6613
|
*/
|
|
6405
|
-
|
|
6406
|
-
/**
|
|
6407
|
-
* 签署方角色编号,为32位字符串
|
|
6408
|
-
<ul><li>若指定了此参数,则只调整签署流程中此签署人的签署截止时间,否则调整合同整体的签署截止时间(合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间)</li>
|
|
6409
|
-
<li>通过[用PDF文件创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)发起合同,或通过[用模板创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/CreateFlowsByTemplates)时,返回参数[FlowApprovers](https://test.qian.tencent.cn/developers/partnerApis/dataTypes/#approveritem)会返回此信息,建议开发者妥善保存</li>
|
|
6410
|
-
<li>也可通过[获取合同信息](https://test.qian.tencent.cn/developers/partnerApis/flows/DescribeFlowDetailInfo)接口查询签署人的RecipientId编号</li></ul>
|
|
6411
|
-
*/
|
|
6412
|
-
RecipientId?: string;
|
|
6413
|
-
}
|
|
6414
|
-
/**
|
|
6415
|
-
* ChannelUpdateSealStatus请求参数结构体
|
|
6416
|
-
*/
|
|
6417
|
-
export interface ChannelUpdateSealStatusRequest {
|
|
6418
|
-
/**
|
|
6419
|
-
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6420
|
-
*/
|
|
6421
|
-
Agent: Agent;
|
|
6422
|
-
/**
|
|
6423
|
-
* 印章状态,目前支持传入以下类型:
|
|
6424
|
-
<ul><li>DISABLE-停用印章</li></ul>
|
|
6425
|
-
*/
|
|
6426
|
-
Status: string;
|
|
6427
|
-
/**
|
|
6428
|
-
* 印章ID
|
|
6429
|
-
*/
|
|
6430
|
-
SealId: string;
|
|
6431
|
-
/**
|
|
6432
|
-
* 更新印章状态原因说明
|
|
6433
|
-
*/
|
|
6434
|
-
Reason?: string;
|
|
6435
|
-
/**
|
|
6436
|
-
* 操作者的信息
|
|
6437
|
-
* @deprecated
|
|
6438
|
-
*/
|
|
6439
|
-
Operator?: UserInfo;
|
|
6440
|
-
}
|
|
6441
|
-
/**
|
|
6442
|
-
* ChannelCreateFlowGroupByTemplates请求参数结构体
|
|
6443
|
-
*/
|
|
6444
|
-
export interface ChannelCreateFlowGroupByTemplatesRequest {
|
|
6614
|
+
ComponentId?: string;
|
|
6445
6615
|
/**
|
|
6446
|
-
*
|
|
6616
|
+
* 控件的名字,跟ComponentId二选一,不能全为空
|
|
6447
6617
|
|
|
6448
|
-
|
|
6449
|
-
|
|
6450
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
6451
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6452
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
6453
|
-
</ul>
|
|
6454
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
6455
|
-
*/
|
|
6456
|
-
Agent: Agent;
|
|
6457
|
-
/**
|
|
6458
|
-
* 合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。
|
|
6459
|
-
*/
|
|
6460
|
-
FlowInfos: Array<FlowInfo>;
|
|
6461
|
-
/**
|
|
6462
|
-
* 合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
6463
|
-
*/
|
|
6464
|
-
FlowGroupName: string;
|
|
6465
|
-
}
|
|
6466
|
-
/**
|
|
6467
|
-
* 流程签署二维码的签署信息,适用于客户系统整合二维码功能。 通过链接,用户可直接访问电子签名小程序并签署合同。
|
|
6468
|
-
*/
|
|
6469
|
-
export interface SignUrl {
|
|
6470
|
-
/**
|
|
6471
|
-
* 跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
|
|
6472
|
-
*/
|
|
6473
|
-
AppSignUrl?: string;
|
|
6474
|
-
/**
|
|
6475
|
-
* 签署链接有效时间,格式类似"2022-08-05 15:55:01"
|
|
6618
|
+
<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
|
|
6619
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
6476
6620
|
*/
|
|
6477
|
-
|
|
6621
|
+
ComponentName?: string;
|
|
6478
6622
|
/**
|
|
6479
|
-
*
|
|
6623
|
+
* 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
|
|
6624
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
6480
6625
|
*/
|
|
6481
|
-
|
|
6626
|
+
LockComponentValue?: boolean;
|
|
6482
6627
|
}
|
|
6483
6628
|
/**
|
|
6484
6629
|
* CreateFlowGroupSignReview请求参数结构体
|
|
@@ -7200,6 +7345,19 @@ export interface DescribeChannelFlowEvidenceReportResponse {
|
|
|
7200
7345
|
*/
|
|
7201
7346
|
RequestId?: string;
|
|
7202
7347
|
}
|
|
7348
|
+
/**
|
|
7349
|
+
* 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
|
|
7350
|
+
*/
|
|
7351
|
+
export interface IntentionQuestion {
|
|
7352
|
+
/**
|
|
7353
|
+
* 当选择语音问答模式时,系统自动播报的问题文本,最大长度为150个字符。
|
|
7354
|
+
*/
|
|
7355
|
+
Question?: string;
|
|
7356
|
+
/**
|
|
7357
|
+
* 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表,传入后可自动判断用户回答文本是否在标准文本列表中。
|
|
7358
|
+
*/
|
|
7359
|
+
Answers?: Array<string>;
|
|
7360
|
+
}
|
|
7203
7361
|
/**
|
|
7204
7362
|
* CreateSealByImage请求参数结构体
|
|
7205
7363
|
*/
|