tccli 3.0.1183.1__py2.py3-none-any.whl → 3.0.1185.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/bi/v20220105/api.json +9 -0
  3. tccli/services/cdb/v20170320/api.json +2 -2
  4. tccli/services/cdwdoris/v20211228/api.json +137 -0
  5. tccli/services/cdwdoris/v20211228/examples.json +1 -1
  6. tccli/services/cls/v20201016/api.json +1 -1
  7. tccli/services/cynosdb/cynosdb_client.py +65 -12
  8. tccli/services/cynosdb/v20190107/api.json +99 -0
  9. tccli/services/cynosdb/v20190107/examples.json +8 -0
  10. tccli/services/dlc/v20210125/api.json +48 -11
  11. tccli/services/dlc/v20210125/examples.json +4 -4
  12. tccli/services/dsgc/v20190723/api.json +9 -0
  13. tccli/services/ecc/v20181213/api.json +14 -12
  14. tccli/services/ecc/v20181213/examples.json +3 -3
  15. tccli/services/ess/v20201111/api.json +1 -1
  16. tccli/services/ess/v20201111/examples.json +4 -4
  17. tccli/services/essbasic/v20210526/examples.json +9 -9
  18. tccli/services/hunyuan/v20230901/api.json +1 -1
  19. tccli/services/lke/v20231130/api.json +1 -1
  20. tccli/services/oceanus/v20190422/api.json +9 -0
  21. tccli/services/oceanus/v20190422/examples.json +1 -1
  22. tccli/services/redis/v20180412/api.json +18 -13
  23. tccli/services/redis/v20180412/examples.json +2 -2
  24. tccli/services/ssl/ssl_client.py +65 -12
  25. tccli/services/ssl/v20191205/api.json +130 -0
  26. tccli/services/ssl/v20191205/examples.json +8 -0
  27. tccli/services/tcr/v20190924/api.json +3 -3
  28. tccli/services/tcr/v20190924/examples.json +1 -1
  29. tccli/services/thpc/thpc_client.py +276 -64
  30. tccli/services/thpc/v20230321/api.json +886 -12
  31. tccli/services/thpc/v20230321/examples.json +32 -0
  32. tccli/services/trtc/v20190722/api.json +2 -2
  33. tccli/services/waf/v20180125/api.json +3 -3
  34. tccli/services/waf/v20180125/examples.json +1 -1
  35. {tccli-3.0.1183.1.dist-info → tccli-3.0.1185.1.dist-info}/METADATA +2 -2
  36. {tccli-3.0.1183.1.dist-info → tccli-3.0.1185.1.dist-info}/RECORD +39 -39
  37. {tccli-3.0.1183.1.dist-info → tccli-3.0.1185.1.dist-info}/WHEEL +0 -0
  38. {tccli-3.0.1183.1.dist-info → tccli-3.0.1185.1.dist-info}/entry_points.txt +0 -0
  39. {tccli-3.0.1183.1.dist-info → tccli-3.0.1185.1.dist-info}/license_files/LICENSE +0 -0
@@ -1602,6 +1602,16 @@
1602
1602
  "AssignMangedTablePropertiesResponse": {
1603
1603
  "document": "AssignMangedTableProperties返回参数结构体",
1604
1604
  "members": [
1605
+ {
1606
+ "disabled": false,
1607
+ "document": "分配的原生表表属性",
1608
+ "example": "无",
1609
+ "member": "Property",
1610
+ "name": "Properties",
1611
+ "output_required": true,
1612
+ "type": "list",
1613
+ "value_allowed_null": false
1614
+ },
1605
1615
  {
1606
1616
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1607
1617
  "member": "string",
@@ -11064,7 +11074,7 @@
11064
11074
  },
11065
11075
  {
11066
11076
  "disabled": false,
11067
- "document": "查询的信息类型,Group:工作组 DataAuth:数据权限 EngineAuth:引擎权限",
11077
+ "document": "必传字段,查询的信息类型,Group:工作组 DataAuth:数据权限 EngineAuth:引擎权限 RowFilter:行级别权限",
11068
11078
  "example": "Group",
11069
11079
  "member": "string",
11070
11080
  "name": "Type",
@@ -11128,7 +11138,7 @@
11128
11138
  "example": "无",
11129
11139
  "member": "UserDetailInfo",
11130
11140
  "name": "UserInfo",
11131
- "required": true,
11141
+ "output_required": true,
11132
11142
  "type": "object",
11133
11143
  "value_allowed_null": true
11134
11144
  },
@@ -14632,6 +14642,7 @@
14632
14642
  "example": "test_database",
14633
14643
  "member": "string",
14634
14644
  "name": "Database",
14645
+ "output_required": true,
14635
14646
  "required": true,
14636
14647
  "type": "string",
14637
14648
  "value_allowed_null": false
@@ -14642,6 +14653,7 @@
14642
14653
  "example": "DataLakeCatalog",
14643
14654
  "member": "string",
14644
14655
  "name": "Catalog",
14656
+ "output_required": true,
14645
14657
  "required": true,
14646
14658
  "type": "string",
14647
14659
  "value_allowed_null": false
@@ -14652,6 +14664,7 @@
14652
14664
  "example": "test_table",
14653
14665
  "member": "string",
14654
14666
  "name": "Table",
14667
+ "output_required": true,
14655
14668
  "required": true,
14656
14669
  "type": "string",
14657
14670
  "value_allowed_null": false
@@ -14662,6 +14675,7 @@
14662
14675
  "example": "ALL",
14663
14676
  "member": "string",
14664
14677
  "name": "Operation",
14678
+ "output_required": true,
14665
14679
  "required": true,
14666
14680
  "type": "string",
14667
14681
  "value_allowed_null": false
@@ -14672,6 +14686,7 @@
14672
14686
  "example": "ADMIN",
14673
14687
  "member": "string",
14674
14688
  "name": "PolicyType",
14689
+ "output_required": true,
14675
14690
  "required": false,
14676
14691
  "type": "string",
14677
14692
  "value_allowed_null": false
@@ -14682,6 +14697,7 @@
14682
14697
  "example": "fun1",
14683
14698
  "member": "string",
14684
14699
  "name": "Function",
14700
+ "output_required": true,
14685
14701
  "required": false,
14686
14702
  "type": "string",
14687
14703
  "value_allowed_null": true
@@ -14692,6 +14708,7 @@
14692
14708
  "example": "view1",
14693
14709
  "member": "string",
14694
14710
  "name": "View",
14711
+ "output_required": true,
14695
14712
  "required": false,
14696
14713
  "type": "string",
14697
14714
  "value_allowed_null": true
@@ -14702,6 +14719,7 @@
14702
14719
  "example": "column1",
14703
14720
  "member": "string",
14704
14721
  "name": "Column",
14722
+ "output_required": true,
14705
14723
  "required": false,
14706
14724
  "type": "string",
14707
14725
  "value_allowed_null": true
@@ -14712,6 +14730,7 @@
14712
14730
  "example": "dataEngine1",
14713
14731
  "member": "string",
14714
14732
  "name": "DataEngine",
14733
+ "output_required": true,
14715
14734
  "required": false,
14716
14735
  "type": "string",
14717
14736
  "value_allowed_null": true
@@ -14722,6 +14741,7 @@
14722
14741
  "example": "false",
14723
14742
  "member": "bool",
14724
14743
  "name": "ReAuth",
14744
+ "output_required": true,
14725
14745
  "required": false,
14726
14746
  "type": "bool",
14727
14747
  "value_allowed_null": true
@@ -14732,6 +14752,7 @@
14732
14752
  "example": "USER",
14733
14753
  "member": "string",
14734
14754
  "name": "Source",
14755
+ "output_required": true,
14735
14756
  "required": false,
14736
14757
  "type": "string",
14737
14758
  "value_allowed_null": true
@@ -14742,6 +14763,7 @@
14742
14763
  "example": "COMMON",
14743
14764
  "member": "string",
14744
14765
  "name": "Mode",
14766
+ "output_required": true,
14745
14767
  "required": false,
14746
14768
  "type": "string",
14747
14769
  "value_allowed_null": true
@@ -14752,6 +14774,7 @@
14752
14774
  "example": "12345678",
14753
14775
  "member": "string",
14754
14776
  "name": "Operator",
14777
+ "output_required": true,
14755
14778
  "required": false,
14756
14779
  "type": "string",
14757
14780
  "value_allowed_null": true
@@ -14762,6 +14785,7 @@
14762
14785
  "example": "2021-07-28 16:19:32",
14763
14786
  "member": "string",
14764
14787
  "name": "CreateTime",
14788
+ "output_required": true,
14765
14789
  "required": false,
14766
14790
  "type": "string",
14767
14791
  "value_allowed_null": true
@@ -14772,6 +14796,7 @@
14772
14796
  "example": "1",
14773
14797
  "member": "int64",
14774
14798
  "name": "SourceId",
14799
+ "output_required": true,
14775
14800
  "required": false,
14776
14801
  "type": "int",
14777
14802
  "value_allowed_null": true
@@ -14782,6 +14807,7 @@
14782
14807
  "example": "test_group",
14783
14808
  "member": "string",
14784
14809
  "name": "SourceName",
14810
+ "output_required": true,
14785
14811
  "required": false,
14786
14812
  "type": "string",
14787
14813
  "value_allowed_null": true
@@ -14792,6 +14818,7 @@
14792
14818
  "example": "1",
14793
14819
  "member": "int64",
14794
14820
  "name": "Id",
14821
+ "output_required": true,
14795
14822
  "required": false,
14796
14823
  "type": "int",
14797
14824
  "value_allowed_null": true
@@ -18393,7 +18420,7 @@
18393
18420
  "example": "1208763821",
18394
18421
  "member": "string",
18395
18422
  "name": "UserId",
18396
- "required": true,
18423
+ "output_required": true,
18397
18424
  "type": "string",
18398
18425
  "value_allowed_null": true
18399
18426
  },
@@ -18403,7 +18430,7 @@
18403
18430
  "example": "Group",
18404
18431
  "member": "string",
18405
18432
  "name": "Type",
18406
- "required": true,
18433
+ "output_required": true,
18407
18434
  "type": "string",
18408
18435
  "value_allowed_null": true
18409
18436
  },
@@ -18413,7 +18440,7 @@
18413
18440
  "example": "ADMIN",
18414
18441
  "member": "string",
18415
18442
  "name": "UserType",
18416
- "required": true,
18443
+ "output_required": true,
18417
18444
  "type": "string",
18418
18445
  "value_allowed_null": true
18419
18446
  },
@@ -18423,7 +18450,7 @@
18423
18450
  "example": "testUser",
18424
18451
  "member": "string",
18425
18452
  "name": "UserDescription",
18426
- "required": true,
18453
+ "output_required": true,
18427
18454
  "type": "string",
18428
18455
  "value_allowed_null": true
18429
18456
  },
@@ -18433,7 +18460,7 @@
18433
18460
  "example": "无",
18434
18461
  "member": "Policys",
18435
18462
  "name": "DataPolicyInfo",
18436
- "required": true,
18463
+ "output_required": true,
18437
18464
  "type": "object",
18438
18465
  "value_allowed_null": true
18439
18466
  },
@@ -18443,7 +18470,7 @@
18443
18470
  "example": "无",
18444
18471
  "member": "Policys",
18445
18472
  "name": "EnginePolicyInfo",
18446
- "required": true,
18473
+ "output_required": true,
18447
18474
  "type": "object",
18448
18475
  "value_allowed_null": true
18449
18476
  },
@@ -18453,7 +18480,7 @@
18453
18480
  "example": "无",
18454
18481
  "member": "WorkGroups",
18455
18482
  "name": "WorkGroupInfo",
18456
- "required": true,
18483
+ "output_required": true,
18457
18484
  "type": "object",
18458
18485
  "value_allowed_null": true
18459
18486
  },
@@ -18463,7 +18490,7 @@
18463
18490
  "example": "testname",
18464
18491
  "member": "string",
18465
18492
  "name": "UserAlias",
18466
- "required": true,
18493
+ "output_required": true,
18467
18494
  "type": "string",
18468
18495
  "value_allowed_null": true
18469
18496
  },
@@ -18473,9 +18500,19 @@
18473
18500
  "example": "无",
18474
18501
  "member": "Policys",
18475
18502
  "name": "RowFilterInfo",
18476
- "required": true,
18503
+ "output_required": true,
18477
18504
  "type": "object",
18478
18505
  "value_allowed_null": true
18506
+ },
18507
+ {
18508
+ "disabled": false,
18509
+ "document": "账号类型\n注意:此字段可能返回 null,表示取不到有效值。",
18510
+ "example": "UserAccount",
18511
+ "member": "string",
18512
+ "name": "AccountType",
18513
+ "output_required": false,
18514
+ "type": "string",
18515
+ "value_allowed_null": true
18479
18516
  }
18480
18517
  ],
18481
18518
  "usage": "out"
@@ -52,7 +52,7 @@
52
52
  {
53
53
  "document": "示例一",
54
54
  "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AssignMangedTableProperties\n<公共请求参数>\n\n{\n \"TableBaseInfo\": {\n \"DatabaseName\": \"abc\",\n \"TableName\": \"abc\",\n \"DatasourceConnectionName\": \"abc\",\n \"TableComment\": \"abc\",\n \"Type\": \"abc\",\n \"TableFormat\": \"abc\",\n \"UserAlias\": \"abc\",\n \"UserSubUin\": \"abc\",\n \"GovernPolicy\": {\n \"RuleType\": \"abc\",\n \"GovernEngine\": \"abc\"\n },\n \"DbGovernPolicyIsDisable\": \"abc\",\n \"SmartPolicy\": {\n \"BaseInfo\": {\n \"Uin\": \"abc\",\n \"PolicyType\": \"abc\",\n \"Catalog\": \"abc\",\n \"Database\": \"abc\",\n \"Table\": \"abc\",\n \"AppId\": \"abc\"\n },\n \"Policy\": {\n \"Inherit\": \"abc\",\n \"Resources\": [\n {\n \"AttributionType\": \"abc\",\n \"ResourceType\": \"abc\",\n \"Name\": \"abc\",\n \"Instance\": \"abc\",\n \"Favor\": [\n {\n \"Priority\": 0,\n \"Catalog\": \"abc\",\n \"DataBase\": \"abc\",\n \"Table\": \"abc\"\n }\n ],\n \"Status\": 0\n }\n ],\n \"Written\": {\n \"WrittenEnable\": \"abc\"\n },\n \"Lifecycle\": {\n \"LifecycleEnable\": \"abc\",\n \"Expiration\": 0,\n \"DropTable\": true\n },\n \"Index\": {\n \"IndexEnable\": \"abc\"\n }\n }\n }\n },\n \"Columns\": [\n {\n \"Name\": \"abc\",\n \"Type\": \"abc\",\n \"Comment\": \"abc\",\n \"Default\": \"abc\",\n \"NotNull\": true,\n \"Precision\": 0,\n \"Scale\": 0\n }\n ],\n \"Partitions\": [\n {\n \"Name\": \"abc\",\n \"Type\": \"abc\",\n \"Comment\": \"abc\",\n \"PartitionType\": \"abc\",\n \"PartitionFormat\": \"abc\",\n \"PartitionDot\": 0,\n \"Transform\": \"abc\",\n \"TransformArgs\": [\n \"abc\"\n ]\n }\n ],\n \"Properties\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"UpsertKeys\": [\n \"abc\"\n ]\n}",
55
- "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
55
+ "output": "{\n \"Response\": {\n \"Properties\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
56
56
  "title": "示例一"
57
57
  }
58
58
  ],
@@ -785,9 +785,9 @@
785
785
  "DescribeUserInfo": [
786
786
  {
787
787
  "document": "",
788
- "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUserInfo\n<公共请求参数>\n\n{}",
789
- "output": "{\n \"Response\": {\n \"UserInfo\": {\n \"UserId\": \"123108743\",\n \"UserAlias\": \"testname\",\n \"UserType\": \"ADMIN\",\n \"UserDescription\": \"test\",\n \"Type\": \"Group\"\n },\n \"RequestId\": \"1231sad-sadsd121-fvmkl23-f124\"\n }\n}",
790
- "title": "获取用户详细信息"
788
+ "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUserInfo\n<公共请求参数>\n\n{\n \"UserId\": \"abc\",\n \"Type\": \"abc\",\n \"Filters\": [\n {\n \"Name\": \"abc\",\n \"Values\": [\n \"abc\"\n ]\n }\n ],\n \"SortBy\": \"abc\",\n \"Sorting\": \"abc\",\n \"Limit\": 0,\n \"Offset\": 0\n}",
789
+ "output": "{\n \"Response\": {\n \"UserInfo\": {\n \"UserId\": \"abc\",\n \"Type\": \"abc\",\n \"UserType\": \"abc\",\n \"UserDescription\": \"abc\",\n \"DataPolicyInfo\": {\n \"PolicySet\": [\n {\n \"Database\": \"abc\",\n \"Catalog\": \"abc\",\n \"Table\": \"abc\",\n \"Operation\": \"abc\",\n \"PolicyType\": \"abc\",\n \"Function\": \"abc\",\n \"View\": \"abc\",\n \"Column\": \"abc\",\n \"DataEngine\": \"abc\",\n \"ReAuth\": true,\n \"Source\": \"abc\",\n \"Mode\": \"abc\",\n \"Operator\": \"abc\",\n \"CreateTime\": \"abc\",\n \"SourceId\": 0,\n \"SourceName\": \"abc\",\n \"Id\": 0\n }\n ],\n \"TotalCount\": 0\n },\n \"EnginePolicyInfo\": {\n \"PolicySet\": [\n {\n \"Database\": \"abc\",\n \"Catalog\": \"abc\",\n \"Table\": \"abc\",\n \"Operation\": \"abc\",\n \"PolicyType\": \"abc\",\n \"Function\": \"abc\",\n \"View\": \"abc\",\n \"Column\": \"abc\",\n \"DataEngine\": \"abc\",\n \"ReAuth\": true,\n \"Source\": \"abc\",\n \"Mode\": \"abc\",\n \"Operator\": \"abc\",\n \"CreateTime\": \"abc\",\n \"SourceId\": 0,\n \"SourceName\": \"abc\",\n \"Id\": 0\n }\n ],\n \"TotalCount\": 0\n },\n \"WorkGroupInfo\": {\n \"WorkGroupSet\": [\n {\n \"WorkGroupId\": 0,\n \"WorkGroupName\": \"abc\",\n \"WorkGroupDescription\": \"abc\",\n \"Creator\": \"abc\",\n \"CreateTime\": \"abc\"\n }\n ],\n \"TotalCount\": 0\n },\n \"UserAlias\": \"abc\",\n \"RowFilterInfo\": {\n \"PolicySet\": [\n {\n \"Database\": \"abc\",\n \"Catalog\": \"abc\",\n \"Table\": \"abc\",\n \"Operation\": \"abc\",\n \"PolicyType\": \"abc\",\n \"Function\": \"abc\",\n \"View\": \"abc\",\n \"Column\": \"abc\",\n \"DataEngine\": \"abc\",\n \"ReAuth\": true,\n \"Source\": \"abc\",\n \"Mode\": \"abc\",\n \"Operator\": \"abc\",\n \"CreateTime\": \"abc\",\n \"SourceId\": 0,\n \"SourceName\": \"abc\",\n \"Id\": 0\n }\n ],\n \"TotalCount\": 0\n }\n },\n \"RequestId\": \"abc\"\n }\n}",
790
+ "title": "test"
791
791
  }
792
792
  ],
793
793
  "DescribeUserRoles": [
@@ -9888,6 +9888,15 @@
9888
9888
  "required": true,
9889
9889
  "type": "int"
9890
9890
  },
9891
+ {
9892
+ "disabled": false,
9893
+ "document": "过滤数组。支持的Name:\nDataSourceID 数据源ID\nDbName 数据库名称\nCategoryID 敏感数据分类ID\nRuleID 规则ID\nLevelID 敏感分级ID\nResourceRegion 资源所在地域\nSensitiveField 过滤敏感字段,可选值为1,或者无此SensitiveField字段\nDataSourceType 数据源类型,不填默认过滤非自建的所有关系型数据源类型,填selfbuilt-db只过滤自建类型\n注意:每个name默认支持最多5个values。",
9894
+ "example": "无",
9895
+ "member": "Filter",
9896
+ "name": "Filters",
9897
+ "required": false,
9898
+ "type": "list"
9899
+ },
9891
9900
  {
9892
9901
  "disabled": false,
9893
9902
  "document": "偏移量,默认为0。",
@@ -15,7 +15,7 @@
15
15
  "status": "online"
16
16
  },
17
17
  "ECC": {
18
- "document": "接口请求域名: ecc.tencentcloudapi.com \n纯文本英语作文批改",
18
+ "document": "纯文本英语作文批改",
19
19
  "input": "ECCRequest",
20
20
  "name": "纯文本英语作文批改",
21
21
  "output": "ECCResponse",
@@ -416,7 +416,7 @@
416
416
  {
417
417
  "disabled": false,
418
418
  "document": "作文文本,必填",
419
- "example": "",
419
+ "example": "",
420
420
  "member": "string",
421
421
  "name": "Content",
422
422
  "required": true,
@@ -425,7 +425,7 @@
425
425
  {
426
426
  "disabled": false,
427
427
  "document": "作文题目,可选参数",
428
- "example": "",
428
+ "example": "",
429
429
  "member": "string",
430
430
  "name": "Title",
431
431
  "required": false,
@@ -434,7 +434,7 @@
434
434
  {
435
435
  "disabled": false,
436
436
  "document": "年级标准, 默认以cet4为标准,取值与意义如下:elementary 小学,grade7 grade8 grade9分别对应初一,初二,初三。 grade10 grade11 grade12 分别对应高一,高二,高三,以及cet4和cet6 分别表示 英语4级和6级。",
437
- "example": "",
437
+ "example": "",
438
438
  "member": "string",
439
439
  "name": "Grade",
440
440
  "required": false,
@@ -443,7 +443,7 @@
443
443
  {
444
444
  "disabled": false,
445
445
  "document": "作文提纲,可选参数,作文的写作要求。",
446
- "example": "",
446
+ "example": "",
447
447
  "member": "string",
448
448
  "name": "Requirement",
449
449
  "required": false,
@@ -452,7 +452,7 @@
452
452
  {
453
453
  "disabled": false,
454
454
  "document": "范文标题,可选参数,本接口可以依据提供的范文对作文进行评分。",
455
- "example": "",
455
+ "example": "",
456
456
  "member": "string",
457
457
  "name": "ModelTitle",
458
458
  "required": false,
@@ -461,7 +461,7 @@
461
461
  {
462
462
  "disabled": false,
463
463
  "document": "范文内容,可选参数,同上,范文的正文部分。",
464
- "example": "",
464
+ "example": "",
465
465
  "member": "string",
466
466
  "name": "ModelContent",
467
467
  "required": false,
@@ -470,7 +470,7 @@
470
470
  {
471
471
  "disabled": false,
472
472
  "document": "业务应用ID,与账号应用APPID无关,是用来方便客户管理服务的参数(暂时无需传入)。",
473
- "example": "",
473
+ "example": "",
474
474
  "member": "string",
475
475
  "name": "EccAppid",
476
476
  "required": false,
@@ -479,7 +479,7 @@
479
479
  {
480
480
  "disabled": false,
481
481
  "document": "异步模式标识,0:同步模式,1:异步模式,默认为同步模式",
482
- "example": "",
482
+ "example": "",
483
483
  "member": "int64",
484
484
  "name": "IsAsync",
485
485
  "required": false,
@@ -488,7 +488,7 @@
488
488
  {
489
489
  "disabled": false,
490
490
  "document": "图像识别唯一标识,一次识别一个 SessionId。当传入此前识别接口使用过的 SessionId,则本次批改按图像批改价格收费;如使用了识别接口且本次没有传入 SessionId,则需要加取文本批改的费用;如果直接使用文本批改接口,则只收取文本批改的费用",
491
- "example": "",
491
+ "example": "",
492
492
  "member": "string",
493
493
  "name": "SessionId",
494
494
  "required": false,
@@ -503,18 +503,20 @@
503
503
  {
504
504
  "disabled": false,
505
505
  "document": "整体的批改结果\n注意:此字段可能返回 null,表示取不到有效值。",
506
- "example": "",
506
+ "example": "",
507
507
  "member": "CorrectData",
508
508
  "name": "Data",
509
+ "output_required": true,
509
510
  "type": "object",
510
511
  "value_allowed_null": true
511
512
  },
512
513
  {
513
514
  "disabled": false,
514
515
  "document": "任务 id,用于查询接口\n注意:此字段可能返回 null,表示取不到有效值。",
515
- "example": "",
516
+ "example": "",
516
517
  "member": "string",
517
518
  "name": "TaskId",
519
+ "output_required": true,
518
520
  "type": "string",
519
521
  "value_allowed_null": true
520
522
  },
@@ -37,13 +37,13 @@
37
37
  "ECC": [
38
38
  {
39
39
  "document": "IsAsync=0 时为同步模式,返回批改结果(内容仅为参考,非实际批改结果)",
40
- "input": "https://ecc.tencentcloudapi.com/?Action=ECC\r\n&Grade=\r\n&Outline=\r\n&ModelSubject=\r\n&ModelContent=\r\n&Title=\r\n&Content=this composition content\r\n&IsAsync=0\r\n&<公共请求参数>",
41
- "output": "{\n \"Response\": {\n \"Data\": {\n \"Score\": 72.39,\n \"ScoreCat\": {\n \"Words\": {\n \"Name\": \"词汇\",\n \"Score\": 76.08,\n \"Percentage\": 42\n },\n \"Sentences\": {\n \"Name\": \"句子\",\n \"Score\": 61.16,\n \"Percentage\": 28\n },\n \"Structure\": {\n \"Name\": \"篇章结构\",\n \"Score\": 80.37,\n \"Percentage\": 23\n },\n \"Content\": {\n \"Name\": \"内容\",\n \"Score\": 69,\n \"Percentage\": 7\n },\n \"Score\": 0,\n \"Percentage\": 0\n },\n \"Comment\": \"作者词汇基础扎实;可适当增加复合句和从句的使用;文中衔接词丰富。请多加练习,更上一层楼。\",\n \"SentenceComments\": [\n {\n \"Sentence\": {\n \"Sentence\": \"Teenagers likeating fast 1888861 food.\",\n \"ParaID\": 1,\n \"SentenceID\": 7\n },\n \"Suggestions\": [\n {\n \"Type\": \"Error\",\n \"ErrorType\": \"拼写错误\",\n \"Origin\": \"likeating\",\n \"Replace\": \"elevating\",\n \"Message\": \"likeating 可能是拼写错误,请注意拼写检查,这里应将 likeating 替换为 elevating\",\n \"ErrorPosition\": [\n 8,\n 8\n ]\n },\n {\n \"Type\": \"Error\",\n \"ErrorType\": \"易混淆词汇建议\",\n \"Origin\": \"1888861\",\n \"Replace\": \"1886861\",\n \"Message\": \"注意1888861 与 1886861 的区别,推荐将 1888861 替换为 1886861\",\n \"ErrorPosition\": [\n 8,\n 8\n ]\n }\n ]\n }\n ]\n },\n \"TaskId\": \"\",\n \"RequestId\": \"ae5d82c1-47a1-43c0-b8a2-4d3c35a21488\"\n }\n}",
40
+ "input": "POST / HTTP/1.1\nHost: ecc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ECC\n<公共请求参数>\n\n{\n \"Content\": \"abc\",\n \"Title\": \"abc\",\n \"Grade\": \"abc\",\n \"Requirement\": \"abc\",\n \"ModelTitle\": \"abc\",\n \"ModelContent\": \"abc\",\n \"EccAppid\": \"abc\",\n \"IsAsync\": 0,\n \"SessionId\": \"abc\"\n}",
41
+ "output": "{\n \"Response\": {\n \"Data\": {\n \"Score\": 0,\n \"ScoreCat\": {\n \"Words\": {\n \"Name\": \"abc\",\n \"Score\": 0,\n \"Percentage\": 0\n },\n \"Sentences\": {\n \"Name\": \"abc\",\n \"Score\": 0,\n \"Percentage\": 0\n },\n \"Structure\": {\n \"Name\": \"abc\",\n \"Score\": 0,\n \"Percentage\": 0\n },\n \"Score\": 0,\n \"Percentage\": 0\n },\n \"Comment\": \"abc\",\n \"SentenceComments\": [\n {\n \"Suggestions\": [\n {\n \"Type\": \"abc\",\n \"ErrorType\": \"abc\",\n \"Origin\": \"abc\",\n \"Replace\": \"abc\",\n \"Message\": \"abc\",\n \"ErrorPosition\": [\n 0\n ],\n \"ErrorCoordinates\": [\n {\n \"Coordinate\": [\n 0\n ]\n }\n ]\n }\n ],\n \"Sentence\": {\n \"Sentence\": \"abc\",\n \"ParaID\": 0,\n \"SentenceID\": 0\n }\n }\n ]\n },\n \"TaskId\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
42
42
  "title": "纯文本英语作文批改-同步"
43
43
  },
44
44
  {
45
45
  "document": "IsAsync=1 时为异步模式,返回 TaskId(内容仅为参考,非实际返回结果)",
46
- "input": "https://ecc.tencentcloudapi.com/?Action=ECC\r\n&Grade=\r\n&Outline=\r\n&ModelSubject=\r\n&ModelContent=\r\n&Title=\r\n&Content=this composition content\r\n&IsAsync=1\r\n&<公共请求参数>",
46
+ "input": "POST / HTTP/1.1\nHost: ecc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ECC\n<公共请求参数>\n\n{\n \"Content\": \"abc\",\n \"Title\": \"abc\",\n \"Grade\": \"abc\",\n \"Requirement\": \"abc\",\n \"ModelTitle\": \"abc\",\n \"ModelContent\": \"abc\",\n \"EccAppid\": \"abc\",\n \"IsAsync\": 0,\n \"SessionId\": \"abc\"\n}",
47
47
  "output": "{\n \"Response\": {\n \"Data\": null,\n \"TaskId\": \"10000004\",\n \"RequestId\": \"ae5d82c1-47a1-43c0-b8a2-4d3c35a21488\"\n }\n}",
48
48
  "title": "纯文本英语作文批改-异步"
49
49
  }
@@ -512,7 +512,7 @@
512
512
  "status": "online"
513
513
  },
514
514
  "DescribeSignFaceVideo": {
515
- "document": "该接口用于在使用视频认证方式签署合同后,获取用户的签署人脸认证视频。\n\n1. 该接口**仅适用于在H5端签署**的合同,**在通过视频认证后**获取人脸图片。\n2. 该接口**不支持小程序端**的签署人脸图片获取。\n3. 请在**签署完成后的三天内**获取人脸图片,**过期后将无法获取**。\n\n**注意:该接口需要开通白名单,请联系客户经理开通后使用。**",
515
+ "document": "该接口用于在使用视频认证方式签署合同后,获取用户的签署人脸认证视频。\n\n1. 该接口**仅适用于在H5端签署**的合同,**在通过视频认证后**获取人脸视频。\n2. 该接口**不支持小程序端**的签署人脸视频获取。\n3. 请在**签署完成后的三天内**获取人脸视频,**过期后将无法获取**。\n\n**注意:该接口需要开通白名单,请联系客户经理开通后使用。**",
516
516
  "input": "DescribeSignFaceVideoRequest",
517
517
  "name": "查询签署认证人脸视频",
518
518
  "output": "DescribeSignFaceVideoResponse",
@@ -499,13 +499,13 @@
499
499
  "CreateFlowGroupByFiles": [
500
500
  {
501
501
  "document": "1. 子合同1为B2B合同(Approvers中包含两个ApproverInfo元素);\n2. 子合同1的发起方企业自动签署(ApproverType设置为3,SIGN_SEAL对应签署控件的ComponentValue设置为自动签署使用的印章Id);\n3. 子合同2为普通B2B合同(Approvers中包含两个ApproverInfo元素,且ApproverType都是0);\n4. 子合同3为普通B2C合同(Approvers中包含两个ApproverInfo元素,C端签署人的ApproverType为1)。",
502
- "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwf2UUckps3me1aUuRbyBJvD8CIgM4K\"\n },\n \"FlowGroupName\": \"示例合同组-有3份子合同\",\n \"FlowGroupInfos\": [\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en1\"\n ],\n \"FlowName\": \"子合同1-B2B(发起方企业自动签署)\",\n \"FlowDescription\": \"子合同1\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 3,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"18251952320\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA\"\n }\n ]\n },\n {\n \"ApproverName\": \"张三\",\n \"ApproverType\": 0,\n \"OrganizationName\": \"张三示例企业\",\n \"ApproverMobile\": \"18888888888\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en2\"\n ],\n \"FlowName\": \"子合同2-普通B2B\",\n \"FlowDescription\": \"子合同2\",\n \"FlowType\": \"示例合同\",\n \"CallbackUrl\": \"\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"18251952320\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"李四示例企业\",\n \"ApproverName\": \"李四\",\n \"ApproverMobile\": \"15100000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en3\"\n ],\n \"FlowName\": \"子合同3-普通B2C\",\n \"Deadline\": 0,\n \"FlowDescription\": \"子合同3\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"王五示例企业\",\n \"ApproverName\": \"王五\",\n \"ApproverMobile\": \"13700000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": \"1\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n }\n ]\n}",
502
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwf2UUckps3me1aUuRbyBJvD8CIgM4K\"\n },\n \"FlowGroupName\": \"示例合同组-有3份子合同\",\n \"FlowGroupInfos\": [\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en1\"\n ],\n \"FlowName\": \"子合同1-B2B(发起方企业自动签署)\",\n \"FlowDescription\": \"子合同1\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 3,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"18251952320\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA\"\n }\n ]\n },\n {\n \"ApproverName\": \"张三\",\n \"ApproverType\": 0,\n \"OrganizationName\": \"张三示例企业\",\n \"ApproverMobile\": \"18888888888\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en2\"\n ],\n \"FlowName\": \"子合同2-普通B2B\",\n \"FlowDescription\": \"子合同2\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"18251952320\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"李四示例企业\",\n \"ApproverName\": \"李四\",\n \"ApproverMobile\": \"15100000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en3\"\n ],\n \"FlowName\": \"子合同3-普通B2C\",\n \"Deadline\": 0,\n \"FlowDescription\": \"子合同3\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"王五示例企业\",\n \"ApproverName\": \"王五\",\n \"ApproverMobile\": \"13700000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": \"1\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n }\n ]\n}",
503
503
  "output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDwJ7UUckpk84praUyPWcjISDLsIVxyo\",\n \"FlowIds\": [\n \"yDwJ7UUckpk84prkUyPWcjIufyhLeqjP\",\n \"yDwJ7UUckpk84prtUyPWcjIwX73sJYGC\",\n \"yDwJ7UUckpk84pryUyPWcjI11TGDLwGO\"\n ],\n \"RequestId\": \"s1694570527888078574\"\n }\n}",
504
504
  "title": "创建一个有3份子合同的合同组签署流程(B2B(含自动签署)、B2B、B2C)"
505
505
  },
506
506
  {
507
507
  "document": "1. 通过主代子方式发起合同(Agent.ProxyOrganizationId设置为子企业的电子签企业Id);\n2. 子合同1为B2B合同(Approvers中包含两个ApproverInfo元素,且ApproverType都是0);\n3. 子合同1的发起方企业自动签署(ApproverType设置为3,SIGN_SEAL对应签署控件的ComponentValue设置为自动签署使用的印章Id);\n4. 子合同2为普通B2B合同(Approvers中包含两个ApproverInfo元素,且ApproverType都是0);\n5. 子合同3为普通B2C合同(Approvers中包含两个ApproverInfo元素,C端签署人的ApproverType为1)。",
508
- "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"Agent\": {\n \"ProxyOrganizationId\": \"yDRSRUUgygj6qnwfUuO4zjEwc193c2hH\"\n },\n \"FlowGroupName\": \"示例合同组-3份子合同\",\n \"FlowGroupInfos\": [\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en1\"\n ],\n \"FlowName\": \"子合同1-B2B(发起方企业自动签署)\",\n \"FlowDescription\": \"子合同1\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 3,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"18251952320\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA\"\n }\n ]\n },\n {\n \"ApproverName\": \"张三\",\n \"ApproverType\": 0,\n \"OrganizationName\": \"张三示例企业\",\n \"ApproverMobile\": \"18888888888\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en2\"\n ],\n \"FlowName\": \"子合同2-普通B2B\",\n \"FlowDescription\": \"子合同2\",\n \"FlowType\": \"示例合同\",\n \"CallbackUrl\": \"\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"18251952320\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"李四示例企业\",\n \"ApproverName\": \"李四\",\n \"ApproverMobile\": \"15100000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en3\"\n ],\n \"FlowName\": \"子合同3-普通B2C\",\n \"Deadline\": 0,\n \"FlowDescription\": \"子合同3\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"王五示例企业\",\n \"ApproverName\": \"王五\",\n \"ApproverMobile\": \"13700000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": \"1\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n }\n ]\n}",
508
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"Agent\": {\n \"ProxyOrganizationId\": \"yDRSRUUgygj6qnwfUuO4zjEwc193c2hH\"\n },\n \"FlowGroupName\": \"示例合同组-3份子合同\",\n \"FlowGroupInfos\": [\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en1\"\n ],\n \"FlowName\": \"子合同1-B2B(发起方企业自动签署)\",\n \"FlowDescription\": \"子合同1\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 3,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"18251952320\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA\"\n }\n ]\n },\n {\n \"ApproverName\": \"张三\",\n \"ApproverType\": 0,\n \"OrganizationName\": \"张三示例企业\",\n \"ApproverMobile\": \"18888888888\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en2\"\n ],\n \"FlowName\": \"子合同2-普通B2B\",\n \"FlowDescription\": \"子合同2\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"18251952320\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"李四示例企业\",\n \"ApproverName\": \"李四\",\n \"ApproverMobile\": \"15100000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en3\"\n ],\n \"FlowName\": \"子合同3-普通B2C\",\n \"Deadline\": 0,\n \"FlowDescription\": \"子合同3\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"王五示例企业\",\n \"ApproverName\": \"王五\",\n \"ApproverMobile\": \"13700000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": \"1\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n }\n ]\n}",
509
509
  "output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDwJ8UUckpk84plbUyPWcjISvuv6WMJx\",\n \"FlowIds\": [\n \"yDwJ8UUckpk84ploUyPWcjIS9KmiX55F\",\n \"yDwJ8UUckpk84plvUyPWcjIxKfGMJ9fF\",\n \"yDwJ8UUckpk84plaUyPWcjIvgnAvfS3H\"\n ],\n \"RequestId\": \"s1694572486923868447\"\n }\n}",
510
510
  "title": "通过主代子方式创建一个有3份子合同的合同组签署流程(B2B(含自动签署)、B2B、B2C)"
511
511
  },
@@ -517,7 +517,7 @@
517
517
  },
518
518
  {
519
519
  "document": "1. 子合同1为B2B合同(Approvers中包含两个ApproverInfo元素);\n2. 子合同1、2为普通B2B合同(Approvers中包含两个ApproverInfo元素,且ApproverType都是0);\n3. 子合同3为普通B2C合同(Approvers中包含两个ApproverInfo元素,C端签署人的ApproverType为1)。\n4.三份子合同第一方签署方均指定为动态签署方(即不指定具体签署人,FillType=1),可在发起后再进行补充。",
520
- "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwf2UUckps3me1aUuRbyBJvD8CIgM4K\"\n },\n \"FlowGroupName\": \"示例合同组-有3份子合同\",\n \"FlowGroupInfos\": [\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en1\"\n ],\n \"FlowName\": \"子合同1-B2B(发起方企业自动签署)\",\n \"FlowDescription\": \"子合同1\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverRoleName\": \"甲方\",\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA\"\n }\n ]\n },\n {\n \"ApproverName\": \"张三\",\n \"ApproverType\": 0,\n \"OrganizationName\": \"张三示例企业\",\n \"ApproverMobile\": \"18888888888\",\n \"ApproverRoleName\": \"乙方\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en2\"\n ],\n \"FlowName\": \"子合同2-普通B2B\",\n \"FlowDescription\": \"子合同2\",\n \"FlowType\": \"示例合同\",\n \"CallbackUrl\": \"\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverRoleName\": \"甲方\",\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"李四示例企业\",\n \"ApproverName\": \"李四\",\n \"ApproverMobile\": \"15100000000\",\n \"ApproverRoleName\": \"乙方\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en3\"\n ],\n \"FlowName\": \"子合同3-普通B2C\",\n \"Deadline\": 0,\n \"FlowDescription\": \"子合同3\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverRoleName\": \"甲方\",\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": \"1\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"ApproverRoleName\": \"乙方\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n }\n ]\n}",
520
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwf2UUckps3me1aUuRbyBJvD8CIgM4K\"\n },\n \"FlowGroupName\": \"示例合同组-有3份子合同\",\n \"FlowGroupInfos\": [\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en1\"\n ],\n \"FlowName\": \"子合同1-B2B(发起方企业自动签署)\",\n \"FlowDescription\": \"子合同1\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverRoleName\": \"甲方\",\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA\"\n }\n ]\n },\n {\n \"ApproverName\": \"张三\",\n \"ApproverType\": 0,\n \"OrganizationName\": \"张三示例企业\",\n \"ApproverMobile\": \"18888888888\",\n \"ApproverRoleName\": \"乙方\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en2\"\n ],\n \"FlowName\": \"子合同2-普通B2B\",\n \"FlowDescription\": \"子合同2\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverRoleName\": \"甲方\",\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"李四示例企业\",\n \"ApproverName\": \"李四\",\n \"ApproverMobile\": \"15100000000\",\n \"ApproverRoleName\": \"乙方\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n },\n {\n \"FileIds\": [\n \"yDwgAUUckp1tbkbgUukJIiCyj7014en3\"\n ],\n \"FlowName\": \"子合同3-普通B2C\",\n \"Deadline\": 0,\n \"FlowDescription\": \"子合同3\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverRoleName\": \"甲方\",\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"\"\n }\n ]\n },\n {\n \"ApproverType\": \"1\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"ApproverRoleName\": \"乙方\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"Unordered\": true\n }\n ]\n}",
521
521
  "output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"甲方\",\n \"RecipientId\": \"yDCVHUUnh3kgwiU90l6PyV6AkMyS0Lgx\",\n \"SignId\": \"yDCVHUUnh3kgwxU90l6PBcCQi6YAeZWy\"\n },\n {\n \"ApproverRoleName\": \"乙方\",\n \"RecipientId\": \"yDCVHUUckpwbqu80UuyXGHSwrgMinnSy\",\n \"SignId\": \"yDCVHUUckpwbqu8dUuyXGHSxa5F93K42\"\n }\n ],\n \"FlowId\": \"yDCVHUUnh3kgw9U90l6PzoNCAOlgR7xB\"\n },\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"甲方\",\n \"RecipientId\": \"yDCVHUUckpwbqu8lUuyXGHS8vq7fLMsd\",\n \"SignId\": \"yDCVHUUckpwbquh6UuyXGHSqnN3pYpMd\"\n },\n {\n \"ApproverRoleName\": \"乙方\",\n \"RecipientId\": \"yDCVHUUnh3kgweU90l6Pwb6QiWJk1MYw\",\n \"SignId\": \"yDCVHUUnh3kgw4U90l6PxzLSFtwfT2XS\"\n }\n ],\n \"FlowId\": \"yDCVHUUnh3kgw7U90l6PwAC1pTEPzQFy\"\n },\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"甲方\",\n \"RecipientId\": \"yDCVHUUckpwbquhfUuyXGHSR8P1F70ug\",\n \"SignId\": \"yDCVHUUckpwbquhbUuyXGHSRsxjHubmd\"\n },\n {\n \"ApproverRoleName\": \"乙方\",\n \"RecipientId\": \"yDCVHUUckpwbqu8vUuyXGHSBxLkLVZWR\",\n \"SignId\": \"yDCVHUUckpwbqu8sUuyXGHSw1pO8DoHP\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbquhuUuyXGHS8IdZrFis5\"\n }\n ],\n \"FlowGroupId\": \"yDCVHUUnh3kgwfU90l6PCbX2FydFwrHu\",\n \"FlowIds\": [\n \"yDCVHUUnh3kgw9U90l6PzoNCAOlgR7xB\",\n \"yDCVHUUnh3kgw7U90l6PwAC1pTEPzQFy\",\n \"yDCVHUUckpwbquhuUuyXGHS8IdZrFis5\"\n ],\n \"RequestId\": \"s1711349304019043831\"\n }\n}",
522
522
  "title": "创建一个有3份子合同的合同组签署流程(B2B、B2B、B2C),指定每个子合同第一方为动态签署方"
523
523
  }
@@ -1474,7 +1474,7 @@
1474
1474
  ],
1475
1475
  "DescribeSignFaceVideo": [
1476
1476
  {
1477
- "document": "1. 个人用户在H5端完成合同签署,通过视频问答模式认证。\n2. 所需白名单已经开通。\n3. 在签署完成后的三天内获取人脸图片。",
1477
+ "document": "1. 个人用户在H5端完成合同签署,通过视频问答模式认证。\n2. 所需白名单已经开通。\n3. 在签署完成后的三天内获取人脸视频。",
1478
1478
  "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSignFaceVideo\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"SignId\": \"yDCNOUUckpv3ecwcUECtq4n1jXPLxLq7\"\n}",
1479
1479
  "output": "{\n \"Response\": {\n \"IntentionQuestionResult\": {\n \"AsrResult\": [\n \"同意\"\n ],\n \"ResultCode\": [\n \"0\"\n ],\n \"Video\": \"AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB\"\n },\n \"RequestId\": \"s1709628366717791449\",\n \"VideoData\": {\n \"LiveNessVideo\": \"AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB\"\n }\n }\n}",
1480
1480
  "title": "查询签署认证人脸视频结果"