tencentcloud-sdk-nodejs-essbasic 4.0.397 → 4.0.433

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.
@@ -142,13 +142,13 @@ ENTERPRISESERVER-企业静默签;
142
142
  }
143
143
 
144
144
  /**
145
- * PrepareFlows返回参数结构体
145
+ * ChannelCreateConvertTaskApi返回参数结构体
146
146
  */
147
- export interface PrepareFlowsResponse {
147
+ export interface ChannelCreateConvertTaskApiResponse {
148
148
  /**
149
- * 待发起文件确认页
149
+ * 任务id
150
150
  */
151
- ConfirmUrl: string
151
+ TaskId: string
152
152
 
153
153
  /**
154
154
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -157,36 +157,38 @@ export interface PrepareFlowsResponse {
157
157
  }
158
158
 
159
159
  /**
160
- * 合作企业经办人列表信息
160
+ * OperateChannelTemplate请求参数结构体
161
161
  */
162
- export interface ProxyOrganizationOperator {
162
+ export interface OperateChannelTemplateRequest {
163
163
  /**
164
- * 经办人ID(渠道颁发),最大长度64个字符
164
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
165
165
  */
166
- Id: string
166
+ Agent: Agent
167
167
 
168
168
  /**
169
- * 经办人姓名,最大长度50个字符
169
+ * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
170
170
  */
171
- Name?: string
171
+ OperateType: string
172
172
 
173
173
  /**
174
- * 经办人身份证件类型
175
- 1.ID_CARD 居民身份证
176
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
177
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
178
- */
179
- IdCardType?: string
174
+ * 渠道方模板库模板唯一标识
175
+ */
176
+ TemplateId: string
180
177
 
181
178
  /**
182
- * 经办人证件号
179
+ * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
183
180
  */
184
- IdCardNumber?: string
181
+ ProxyOrganizationOpenIds?: string
185
182
 
186
183
  /**
187
- * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
184
+ * 模板可见性, 全部可见-"all", 部分可见-"part"
188
185
  */
189
- Mobile?: string
186
+ AuthTag?: string
187
+
188
+ /**
189
+ * 操作者的信息
190
+ */
191
+ Operator?: UserInfo
190
192
  }
191
193
 
192
194
  /**
@@ -244,6 +246,33 @@ export interface TemplateInfo {
244
246
  CreatedOn: number
245
247
  }
246
248
 
249
+ /**
250
+ * UploadFiles请求参数结构体
251
+ */
252
+ export interface UploadFilesRequest {
253
+ /**
254
+ * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
255
+ */
256
+ Agent: Agent
257
+
258
+ /**
259
+ * 文件对应业务类型,用于区分文件存储路径:
260
+ 1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
261
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
262
+ */
263
+ BusinessType: string
264
+
265
+ /**
266
+ * 上传文件内容数组,最多支持20个文件
267
+ */
268
+ FileInfos?: Array<UploadFile>
269
+
270
+ /**
271
+ * 操作者的信息
272
+ */
273
+ Operator?: UserInfo
274
+ }
275
+
247
276
  /**
248
277
  * GetDownloadFlowUrl返回参数结构体
249
278
  */
@@ -289,6 +318,11 @@ export interface ChannelCreateMultiFlowSignQRCodeResponse {
289
318
  */
290
319
  QrCode: SignQrCode
291
320
 
321
+ /**
322
+ * 签署链接对象
323
+ */
324
+ SignUrls: SignUrl
325
+
292
326
  /**
293
327
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
294
328
  */
@@ -421,6 +455,26 @@ export interface OperateChannelTemplateResponse {
421
455
  RequestId?: string
422
456
  }
423
457
 
458
+ /**
459
+ * CreateSignUrls返回参数结构体
460
+ */
461
+ export interface CreateSignUrlsResponse {
462
+ /**
463
+ * 签署参与者签署H5链接信息数组
464
+ */
465
+ SignUrlInfos: Array<SignUrlInfo>
466
+
467
+ /**
468
+ * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
469
+ */
470
+ ErrorMessages: Array<string>
471
+
472
+ /**
473
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
474
+ */
475
+ RequestId?: string
476
+ }
477
+
424
478
  /**
425
479
  * CreateSignUrls请求参数结构体
426
480
  */
@@ -534,6 +588,11 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
534
588
  */
535
589
  CallbackUrl?: string
536
590
 
591
+ /**
592
+ * 限制二维码用户条件
593
+ */
594
+ ApproverRestrictions?: ApproverRestriction
595
+
537
596
  /**
538
597
  * 用户信息
539
598
  */
@@ -555,6 +614,26 @@ export interface AuthFailMessage {
555
614
  Message: string
556
615
  }
557
616
 
617
+ /**
618
+ * CreateChannelFlowEvidenceReport请求参数结构体
619
+ */
620
+ export interface CreateChannelFlowEvidenceReportRequest {
621
+ /**
622
+ * 签署流程编号
623
+ */
624
+ FlowId: string
625
+
626
+ /**
627
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
628
+ */
629
+ Agent: Agent
630
+
631
+ /**
632
+ * 操作者的信息
633
+ */
634
+ Operator?: UserInfo
635
+ }
636
+
558
637
  /**
559
638
  * DescribeFlowDetailInfo请求参数结构体
560
639
  */
@@ -576,71 +655,109 @@ export interface DescribeFlowDetailInfoRequest {
576
655
  }
577
656
 
578
657
  /**
579
- * 一码多扫签署二维码对象
658
+ * ChannelGetTaskResultApi返回参数结构体
580
659
  */
581
- export interface SignQrCode {
660
+ export interface ChannelGetTaskResultApiResponse {
582
661
  /**
583
- * 二维码id
662
+ * 任务Id
584
663
  */
585
- QrCodeId: string
664
+ TaskId: string
586
665
 
587
666
  /**
588
- * 二维码url
667
+ * 任务状态,需要关注的状态
668
+ 0 :NeedTranform - 任务已提交
669
+ 4 :Processing - 文档转换中
670
+ 8 :TaskEnd - 任务处理完成
671
+ -2 :DownloadFailed - 下载失败
672
+ -6 :ProcessFailed - 转换失败
673
+ -13:ProcessTimeout - 转换文件超时
674
+ */
675
+ TaskStatus: number
676
+
677
+ /**
678
+ * 状态描述,需要关注的状态
679
+ NeedTranform - 任务已提交
680
+ Processing - 文档转换中
681
+ TaskEnd - 任务处理完成
682
+ DownloadFailed - 下载失败
683
+ ProcessFailed - 转换失败
684
+ ProcessTimeout - 转换文件超时
685
+ */
686
+ TaskMessage: string
687
+
688
+ /**
689
+ * 资源Id,也是FileId,用于文件发起使用
589
690
  */
590
- QrCodeUrl: string
691
+ ResourceId: string
591
692
 
592
693
  /**
593
- * 二维码过期时间
694
+ * 预览文件Url,有效期30分钟
695
+ 注意:此字段可能返回 null,表示取不到有效值。
696
+ */
697
+ PreviewUrl: string
698
+
699
+ /**
700
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
594
701
  */
595
- ExpiredTime: number
702
+ RequestId?: string
596
703
  }
597
704
 
598
705
  /**
599
- * UploadFiles请求参数结构体
706
+ * 合作企业经办人列表信息
600
707
  */
601
- export interface UploadFilesRequest {
708
+ export interface ProxyOrganizationOperator {
602
709
  /**
603
- * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
710
+ * 经办人ID(渠道颁发),最大长度64个字符
604
711
  */
605
- Agent: Agent
712
+ Id: string
606
713
 
607
714
  /**
608
- * 文件对应业务类型,用于区分文件存储路径:
609
- 1. TEMPLATE - 模板; 文件类型:.pdf
610
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
715
+ * 经办人姓名,最大长度50个字符
716
+ */
717
+ Name?: string
718
+
719
+ /**
720
+ * 经办人身份证件类型
721
+ 1.ID_CARD 居民身份证
722
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
723
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
611
724
  */
612
- BusinessType: string
725
+ IdCardType?: string
613
726
 
614
727
  /**
615
- * 上传文件内容数组,最多支持20个文件
728
+ * 经办人证件号
616
729
  */
617
- FileInfos?: Array<UploadFile>
730
+ IdCardNumber?: string
618
731
 
619
732
  /**
620
- * 操作者的信息
733
+ * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
621
734
  */
622
- Operator?: UserInfo
735
+ Mobile?: string
623
736
  }
624
737
 
625
738
  /**
626
- * DescribeResourceUrlsByFlows请求参数结构体
739
+ * ChannelGetTaskResultApi请求参数结构体
627
740
  */
628
- export interface DescribeResourceUrlsByFlowsRequest {
741
+ export interface ChannelGetTaskResultApiRequest {
629
742
  /**
630
- * 渠道应用相关信息。
631
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
632
- */
743
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
744
+ */
633
745
  Agent: Agent
634
746
 
635
747
  /**
636
- * 查询资源所对应的签署流程Id,最多支持50个。
748
+ * 任务Id,通过ChannelCreateConvertTaskApi接口获得
637
749
  */
638
- FlowIds?: Array<string>
750
+ TaskId: string
639
751
 
640
752
  /**
641
753
  * 操作者的信息
642
754
  */
643
755
  Operator?: UserInfo
756
+
757
+ /**
758
+ * 暂未开放
759
+ */
760
+ Organization?: OrganizationInfo
644
761
  }
645
762
 
646
763
  /**
@@ -660,6 +777,7 @@ export interface UploadFile {
660
777
 
661
778
  /**
662
779
  * 此结构体 (Component) 用于描述控件属性。
780
+
663
781
  */
664
782
  export interface Component {
665
783
  /**
@@ -679,12 +797,18 @@ export interface Component {
679
797
  /**
680
798
  * 如果是Component控件类型,则可选的字段为:
681
799
  TEXT - 普通文本控件;
682
- DATE - 普通日期控件;跟TEXT相比会有校验逻辑
800
+ MULTI_LINE_TEXT - 多行文本控件;
801
+ CHECK_BOX - 勾选框控件;
802
+ FILL_IMAGE - 图片控件;
803
+ DYNAMIC_TABLE - 动态表格控件;
804
+ ATTACHMENT - 附件控件;
805
+ SELECTOR - 选择器控件;
806
+
683
807
  如果是SignComponent控件类型,则可选的字段为
684
808
  SIGN_SEAL - 签署印章控件;
685
809
  SIGN_DATE - 签署日期控件;
686
810
  SIGN_SIGNATURE - 用户签名控件;
687
- SIGN_PERSONAL_SEAL - 个人签署印章控件;
811
+ SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
688
812
 
689
813
  表单域的控件不能作为印章和签名控件
690
814
  */
@@ -749,8 +873,13 @@ TEXT控件可以指定字体
749
873
  ComponentExtra?: string
750
874
 
751
875
  /**
752
- * 印章 ID,传参 DEFAULT_COMPANY_SEAL 表示使用默认印章。
753
- 控件填入内容,印章控件里面,如果是手写签名内容为PNG图片格式的base64编码
876
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
877
+ TEXT - 文本内容
878
+ MULTI_LINE_TEXT - 文本内容
879
+ CHECK_BOX - true/false
880
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
881
+ SELECTOR - 选项值
882
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
754
883
  */
755
884
  ComponentValue?: string
756
885
 
@@ -898,6 +1027,36 @@ export interface CreateConsoleLoginUrlRequest {
898
1027
  Operator?: UserInfo
899
1028
  }
900
1029
 
1030
+ /**
1031
+ * 机构信息
1032
+ */
1033
+ export interface OrganizationInfo {
1034
+ /**
1035
+ * 用户在渠道的机构编号
1036
+ */
1037
+ OrganizationOpenId: string
1038
+
1039
+ /**
1040
+ * 用户真实的IP
1041
+ */
1042
+ ClientIp: string
1043
+
1044
+ /**
1045
+ * 机构的代理IP
1046
+ */
1047
+ ProxyIp: string
1048
+
1049
+ /**
1050
+ * 机构在平台的编号
1051
+ */
1052
+ OrganizationId?: string
1053
+
1054
+ /**
1055
+ * 用户渠道
1056
+ */
1057
+ Channel?: string
1058
+ }
1059
+
901
1060
  /**
902
1061
  * CreateFlowsByTemplates返回参数结构体
903
1062
  */
@@ -923,12 +1082,45 @@ export interface CreateFlowsByTemplatesResponse {
923
1082
  */
924
1083
  PreviewUrls: Array<string>
925
1084
 
1085
+ /**
1086
+ * 复杂文档合成任务的任务信息数组
1087
+ */
1088
+ TaskInfos: Array<TaskInfo>
1089
+
926
1090
  /**
927
1091
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
928
1092
  */
929
1093
  RequestId?: string
930
1094
  }
931
1095
 
1096
+ /**
1097
+ * ChannelCreateFlowSignReview请求参数结构体
1098
+ */
1099
+ export interface ChannelCreateFlowSignReviewRequest {
1100
+ /**
1101
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1102
+ */
1103
+ Agent: Agent
1104
+
1105
+ /**
1106
+ * 签署流程编号
1107
+ */
1108
+ FlowId: string
1109
+
1110
+ /**
1111
+ * 企业内部审核结果
1112
+ PASS: 通过
1113
+ REJECT: 拒绝
1114
+ */
1115
+ ReviewType: string
1116
+
1117
+ /**
1118
+ * 审核原因
1119
+ 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
1120
+ */
1121
+ ReviewMessage?: string
1122
+ }
1123
+
932
1124
  /**
933
1125
  * PrepareFlows请求参数结构体
934
1126
  */
@@ -993,6 +1185,26 @@ export interface CreateSealByImageResponse {
993
1185
  RequestId?: string
994
1186
  }
995
1187
 
1188
+ /**
1189
+ * 一码多扫签署二维码签署信息
1190
+ */
1191
+ export interface SignUrl {
1192
+ /**
1193
+ * 小程序签署链接
1194
+ */
1195
+ AppSignUrl: string
1196
+
1197
+ /**
1198
+ * 签署链接有效时间
1199
+ */
1200
+ EffectiveTime: string
1201
+
1202
+ /**
1203
+ * 移动端签署链接
1204
+ */
1205
+ HttpSignUrl: string
1206
+ }
1207
+
996
1208
  /**
997
1209
  * 流程对应资源链接信息
998
1210
  */
@@ -1174,33 +1386,23 @@ export interface CreateSealByImageRequest {
1174
1386
  }
1175
1387
 
1176
1388
  /**
1177
- * 接口调用者信息
1389
+ * 一码多扫签署二维码对象
1178
1390
  */
1179
- export interface UserInfo {
1180
- /**
1181
- * 用户在渠道的编号
1182
- */
1183
- OpenId?: string
1184
-
1185
- /**
1186
- * 用户的来源渠道
1187
- */
1188
- Channel?: string
1189
-
1391
+ export interface SignQrCode {
1190
1392
  /**
1191
- * 自定义用户编号
1393
+ * 二维码id
1192
1394
  */
1193
- CustomUserId?: string
1395
+ QrCodeId: string
1194
1396
 
1195
1397
  /**
1196
- * 用户真实IP
1398
+ * 二维码url
1197
1399
  */
1198
- ClientIp?: string
1400
+ QrCodeUrl: string
1199
1401
 
1200
1402
  /**
1201
- * 用户代理IP
1403
+ * 二维码过期时间
1202
1404
  */
1203
- ProxyIp?: string
1405
+ ExpiredTime: number
1204
1406
  }
1205
1407
 
1206
1408
  /**
@@ -1258,18 +1460,23 @@ export interface UsageDetail {
1258
1460
  }
1259
1461
 
1260
1462
  /**
1261
- * CreateSignUrls返回参数结构体
1463
+ * ChannelCreateBatchCancelFlowUrl返回参数结构体
1262
1464
  */
1263
- export interface CreateSignUrlsResponse {
1465
+ export interface ChannelCreateBatchCancelFlowUrlResponse {
1264
1466
  /**
1265
- * 签署参与者签署H5链接信息数组
1467
+ * 批量撤销url
1266
1468
  */
1267
- SignUrlInfos: Array<SignUrlInfo>
1469
+ BatchCancelFlowUrl: string
1268
1470
 
1269
1471
  /**
1270
- * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
1472
+ * 签署流程批量撤销失败原因
1271
1473
  */
1272
- ErrorMessages: Array<string>
1474
+ FailMessages: Array<string>
1475
+
1476
+ /**
1477
+ * 签署撤销url过期时间-年月日-时分秒
1478
+ */
1479
+ UrlExpireOn: string
1273
1480
 
1274
1481
  /**
1275
1482
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1278,33 +1485,19 @@ export interface CreateSignUrlsResponse {
1278
1485
  }
1279
1486
 
1280
1487
  /**
1281
- * OperateChannelTemplate请求参数结构体
1488
+ * DescribeResourceUrlsByFlows请求参数结构体
1282
1489
  */
1283
- export interface OperateChannelTemplateRequest {
1490
+ export interface DescribeResourceUrlsByFlowsRequest {
1284
1491
  /**
1285
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1286
- */
1492
+ * 渠道应用相关信息。
1493
+ 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1494
+ */
1287
1495
  Agent: Agent
1288
1496
 
1289
1497
  /**
1290
- * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
1291
- */
1292
- OperateType: string
1293
-
1294
- /**
1295
- * 渠道方模板库模板唯一标识
1296
- */
1297
- TemplateId: string
1298
-
1299
- /**
1300
- * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
1301
- */
1302
- ProxyOrganizationOpenIds?: string
1303
-
1304
- /**
1305
- * 模板可见性, 全部可见-"all", 部分可见-"part"
1498
+ * 查询资源所对应的签署流程Id,最多支持50个。
1306
1499
  */
1307
- AuthTag?: string
1500
+ FlowIds?: Array<string>
1308
1501
 
1309
1502
  /**
1310
1503
  * 操作者的信息
@@ -1347,6 +1540,21 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
1347
1540
  Operator?: UserInfo
1348
1541
  }
1349
1542
 
1543
+ /**
1544
+ * CreateChannelFlowEvidenceReport返回参数结构体
1545
+ */
1546
+ export interface CreateChannelFlowEvidenceReportResponse {
1547
+ /**
1548
+ * 出证报告 URL(有效五分钟)
1549
+ */
1550
+ ReportUrl: string
1551
+
1552
+ /**
1553
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1554
+ */
1555
+ RequestId?: string
1556
+ }
1557
+
1350
1558
  /**
1351
1559
  * 同步经办人失败原因
1352
1560
  */
@@ -1364,6 +1572,21 @@ export interface SyncFailReason {
1364
1572
  Message: string
1365
1573
  }
1366
1574
 
1575
+ /**
1576
+ * PrepareFlows返回参数结构体
1577
+ */
1578
+ export interface PrepareFlowsResponse {
1579
+ /**
1580
+ * 待发起文件确认页
1581
+ */
1582
+ ConfirmUrl: string
1583
+
1584
+ /**
1585
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1586
+ */
1587
+ RequestId?: string
1588
+ }
1589
+
1367
1590
  /**
1368
1591
  * DescribeUsage请求参数结构体
1369
1592
  */
@@ -1407,12 +1630,57 @@ export interface DescribeUsageRequest {
1407
1630
  Operator?: UserInfo
1408
1631
  }
1409
1632
 
1633
+ /**
1634
+ * ChannelCreateBatchCancelFlowUrl请求参数结构体
1635
+ */
1636
+ export interface ChannelCreateBatchCancelFlowUrlRequest {
1637
+ /**
1638
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1639
+ */
1640
+ Agent: Agent
1641
+
1642
+ /**
1643
+ * 签署流程Id数组
1644
+ */
1645
+ FlowIds: Array<string>
1646
+
1647
+ /**
1648
+ * 操作人信息
1649
+ */
1650
+ Operator?: UserInfo
1651
+ }
1652
+
1653
+ /**
1654
+ * 指定签署人限制项
1655
+ */
1656
+ export interface ApproverRestriction {
1657
+ /**
1658
+ * 指定签署人名字
1659
+ */
1660
+ Name?: string
1661
+
1662
+ /**
1663
+ * 指定签署人手机号
1664
+ */
1665
+ Mobile?: string
1666
+
1667
+ /**
1668
+ * 指定签署人证件类型
1669
+ */
1670
+ IdCardType?: string
1671
+
1672
+ /**
1673
+ * 指定签署人证件号码
1674
+ */
1675
+ IdCardNumber?: string
1676
+ }
1677
+
1410
1678
  /**
1411
1679
  * ChannelCreateFlowByFiles请求参数结构体
1412
1680
  */
1413
1681
  export interface ChannelCreateFlowByFilesRequest {
1414
1682
  /**
1415
- * 渠道应用相关信息
1683
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1416
1684
  */
1417
1685
  Agent?: Agent
1418
1686
 
@@ -1432,7 +1700,7 @@ export interface ChannelCreateFlowByFilesRequest {
1432
1700
  FileIds?: Array<string>
1433
1701
 
1434
1702
  /**
1435
- * 签署文件中的控件,如:填写控件等
1703
+ * 签署文件中的发起方的填写控件,需要在发起的时候进行填充
1436
1704
  */
1437
1705
  Components?: Array<Component>
1438
1706
 
@@ -1471,6 +1739,11 @@ export interface ChannelCreateFlowByFilesRequest {
1471
1739
  */
1472
1740
  CustomerData?: string
1473
1741
 
1742
+ /**
1743
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1744
+ */
1745
+ NeedSignReview?: boolean
1746
+
1474
1747
  /**
1475
1748
  * 操作者的信息
1476
1749
  */
@@ -1518,6 +1791,16 @@ export interface UploadFilesResponse {
1518
1791
  RequestId?: string
1519
1792
  }
1520
1793
 
1794
+ /**
1795
+ * ChannelCreateFlowSignReview返回参数结构体
1796
+ */
1797
+ export interface ChannelCreateFlowSignReviewResponse {
1798
+ /**
1799
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1800
+ */
1801
+ RequestId?: string
1802
+ }
1803
+
1521
1804
  /**
1522
1805
  * 应用相关信息
1523
1806
  */
@@ -1528,7 +1811,7 @@ export interface Agent {
1528
1811
  AppId: string
1529
1812
 
1530
1813
  /**
1531
- * 渠道/平台合作企业的企业ID
1814
+ * 渠道/平台合作企业的企业ID,最大64位字符串
1532
1815
  */
1533
1816
  ProxyOrganizationOpenId?: string
1534
1817
 
@@ -1543,22 +1826,30 @@ export interface Agent {
1543
1826
  ProxyAppId?: string
1544
1827
 
1545
1828
  /**
1546
- * 腾讯电子签颁发给渠道侧合作企业的企业ID
1829
+ * 内部参数,腾讯电子签颁发给渠道侧合作企业的企业ID,不需要传
1547
1830
  */
1548
1831
  ProxyOrganizationId?: string
1549
1832
  }
1550
1833
 
1551
1834
  /**
1552
1835
  * 此结构 (FormField) 用于描述内容控件填充结构。
1836
+
1553
1837
  */
1554
1838
  export interface FormField {
1555
1839
  /**
1556
- * 表单域或控件的Value
1557
- */
1840
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
1841
+ TEXT - 文本内容
1842
+ MULTI_LINE_TEXT - 文本内容
1843
+ CHECK_BOX - true/false
1844
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1845
+ SELECTOR - 选项值
1846
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
1847
+ */
1558
1848
  ComponentValue: string
1559
1849
 
1560
1850
  /**
1561
- * 表单域或控件的ID,跟ComponentName二选一,不能全为空
1851
+ * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
1852
+ CreateFlowsByTemplates 接口不使用此字段。
1562
1853
  注意:此字段可能返回 null,表示取不到有效值。
1563
1854
  */
1564
1855
  ComponentId?: string
@@ -1570,6 +1861,71 @@ export interface FormField {
1570
1861
  ComponentName?: string
1571
1862
  }
1572
1863
 
1864
+ /**
1865
+ * 接口调用者信息
1866
+ */
1867
+ export interface UserInfo {
1868
+ /**
1869
+ * 用户在渠道的编号,最大64位字符串
1870
+ */
1871
+ OpenId?: string
1872
+
1873
+ /**
1874
+ * 用户的来源渠道
1875
+ */
1876
+ Channel?: string
1877
+
1878
+ /**
1879
+ * 自定义用户编号
1880
+ */
1881
+ CustomUserId?: string
1882
+
1883
+ /**
1884
+ * 用户真实IP
1885
+ */
1886
+ ClientIp?: string
1887
+
1888
+ /**
1889
+ * 用户代理IP
1890
+ */
1891
+ ProxyIp?: string
1892
+ }
1893
+
1894
+ /**
1895
+ * ChannelCreateConvertTaskApi请求参数结构体
1896
+ */
1897
+ export interface ChannelCreateConvertTaskApiRequest {
1898
+ /**
1899
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1900
+ */
1901
+ Agent: Agent
1902
+
1903
+ /**
1904
+ * 资源类型 取值范围doc,docx,html之一
1905
+ */
1906
+ ResourceType: string
1907
+
1908
+ /**
1909
+ * 资源名称,长度限制为256字符
1910
+ */
1911
+ ResourceName: string
1912
+
1913
+ /**
1914
+ * 资源Id,通过UploadFiles获取
1915
+ */
1916
+ ResourceId: string
1917
+
1918
+ /**
1919
+ * 操作者信息
1920
+ */
1921
+ Operator?: UserInfo
1922
+
1923
+ /**
1924
+ * 暂未开放
1925
+ */
1926
+ Organization?: OrganizationInfo
1927
+ }
1928
+
1573
1929
  /**
1574
1930
  * 签署人的流程信息明细
1575
1931
  */
@@ -1637,6 +1993,66 @@ export interface FlowApproverDetail {
1637
1993
 
1638
1994
  /**
1639
1995
  * 此结构体 (FlowInfo) 用于描述签署流程信息。
1996
+
1997
+ 【动态表格传参说明】
1998
+ 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
1999
+ 输入示例
2000
+
2001
+ ```
2002
+ {
2003
+ "headers":[
2004
+ {
2005
+ "content":"head1"
2006
+ },
2007
+ {
2008
+ "content":"head2"
2009
+ },
2010
+ {
2011
+ "content":"head3"
2012
+ }
2013
+ ],
2014
+ "rowCount":3,
2015
+ "body":{
2016
+ "cells":[
2017
+ {
2018
+ "rowStart":1,
2019
+ "rowEnd":1,
2020
+ "columnStart":1,
2021
+ "columnEnd":1,
2022
+ "content":"123"
2023
+ },
2024
+ {
2025
+ "rowStart":2,
2026
+ "rowEnd":3,
2027
+ "columnStart":1,
2028
+ "columnEnd":2,
2029
+ "content":"456"
2030
+ },
2031
+ {
2032
+ "rowStart":3,
2033
+ "rowEnd":3,
2034
+ "columnStart":3,
2035
+ "columnEnd":3,
2036
+ "content":"789"
2037
+ }
2038
+ ]
2039
+ }
2040
+ }
2041
+
2042
+ ```
2043
+
2044
+ 表格参数说明
2045
+
2046
+ | 名称 | 类型 | 描述 |
2047
+ | ------------------- | ------- | ------------------------------------------------- |
2048
+ | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
2049
+ | rowCount | Integer | 表格内容最大行数 |
2050
+ | cells.N.rowStart | Integer | 单元格坐标:行起始index |
2051
+ | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
2052
+ | cells.N.columnStart | Integer | 单元格坐标:列起始index |
2053
+ | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
2054
+ | cells.N.content | String | 单元格内容,字数不超过100 |
2055
+
1640
2056
  */
1641
2057
  export interface FlowInfo {
1642
2058
  /**
@@ -1693,6 +2109,14 @@ export interface FlowInfo {
1693
2109
  * 被抄送人的信息列表,抄送功能暂不开放
1694
2110
  */
1695
2111
  CcInfos?: Array<CcInfo>
2112
+
2113
+ /**
2114
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
2115
+ 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
2116
+
2117
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2118
+ */
2119
+ NeedSignReview?: boolean
1696
2120
  }
1697
2121
 
1698
2122
  /**
@@ -1774,6 +2198,23 @@ PERSON 自然人
1774
2198
  OpenId: string
1775
2199
  }
1776
2200
 
2201
+ /**
2202
+ * 复杂文档合成任务的任务信息
2203
+ */
2204
+ export interface TaskInfo {
2205
+ /**
2206
+ * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
2207
+ 注意:此字段可能返回 null,表示取不到有效值。
2208
+ */
2209
+ TaskId: string
2210
+
2211
+ /**
2212
+ * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
2213
+ 注意:此字段可能返回 null,表示取不到有效值。
2214
+ */
2215
+ TaskStatus: string
2216
+ }
2217
+
1777
2218
  /**
1778
2219
  * 抄送信息
1779
2220
  */