tccli 3.0.1224.1__py2.py3-none-any.whl → 3.0.1226.1__py2.py3-none-any.whl
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.
- tccli/__init__.py +1 -1
- tccli/services/autoscaling/v20180419/api.json +11 -0
- tccli/services/batch/v20170312/api.json +33 -11
- tccli/services/billing/v20180709/api.json +60 -30
- tccli/services/billing/v20180709/examples.json +7 -7
- tccli/services/cbs/v20170312/api.json +1 -1
- tccli/services/cdb/v20170320/api.json +218 -2
- tccli/services/cdb/v20170320/examples.json +3 -3
- tccli/services/cdwdoris/v20211228/api.json +1 -1
- tccli/services/ckafka/v20190819/api.json +791 -679
- tccli/services/cvm/v20170312/api.json +33 -11
- tccli/services/cwp/v20180228/api.json +1 -1
- tccli/services/cynosdb/v20190107/api.json +4 -4
- tccli/services/dts/v20211206/api.json +21 -1
- tccli/services/ess/v20201111/api.json +2 -2
- tccli/services/ess/v20201111/examples.json +2 -2
- tccli/services/essbasic/v20210526/api.json +2 -2
- tccli/services/essbasic/v20210526/examples.json +2 -2
- tccli/services/faceid/v20180301/api.json +1 -1
- tccli/services/hunyuan/hunyuan_client.py +53 -0
- tccli/services/hunyuan/v20230901/api.json +297 -0
- tccli/services/hunyuan/v20230901/examples.json +8 -0
- tccli/services/ims/v20201229/api.json +2 -2
- tccli/services/iotexplorer/v20190423/api.json +11 -11
- tccli/services/lcic/v20220817/api.json +1 -1
- tccli/services/live/live_client.py +548 -71
- tccli/services/live/v20180801/api.json +803 -45
- tccli/services/live/v20180801/examples.json +73 -1
- tccli/services/lke/v20231130/api.json +1 -1
- tccli/services/mps/v20190612/api.json +174 -13
- tccli/services/mrs/v20200910/api.json +4217 -4211
- tccli/services/mrs/v20200910/examples.json +14 -14
- tccli/services/ocr/ocr_client.py +0 -53
- tccli/services/ocr/v20181119/api.json +0 -162
- tccli/services/ocr/v20181119/examples.json +0 -8
- tccli/services/scf/v20180416/api.json +1 -1
- tccli/services/teo/teo_client.py +159 -0
- tccli/services/teo/v20220901/api.json +199 -0
- tccli/services/teo/v20220901/examples.json +36 -0
- tccli/services/trtc/v20190722/api.json +20 -0
- tccli/services/tsf/v20180326/api.json +1287 -118
- tccli/services/tsf/v20180326/examples.json +5 -5
- tccli/services/tts/v20190823/api.json +2 -2
- tccli/services/vclm/v20240523/api.json +77 -6
- tccli/services/vclm/v20240523/examples.json +9 -1
- tccli/services/vclm/vclm_client.py +53 -0
- tccli/services/vdb/v20230616/api.json +20 -0
- {tccli-3.0.1224.1.dist-info → tccli-3.0.1226.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1224.1.dist-info → tccli-3.0.1226.1.dist-info}/RECORD +52 -52
- {tccli-3.0.1224.1.dist-info → tccli-3.0.1226.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1224.1.dist-info → tccli-3.0.1226.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1224.1.dist-info → tccli-3.0.1226.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -2446,7 +2446,7 @@
|
|
|
2446
2446
|
{
|
|
2447
2447
|
"disabled": false,
|
|
2448
2448
|
"document": "数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。",
|
|
2449
|
-
"example": "
|
|
2449
|
+
"example": "50",
|
|
2450
2450
|
"member": "int64",
|
|
2451
2451
|
"name": "DiskSize",
|
|
2452
2452
|
"output_required": true,
|
|
@@ -2456,8 +2456,8 @@
|
|
|
2456
2456
|
},
|
|
2457
2457
|
{
|
|
2458
2458
|
"disabled": false,
|
|
2459
|
-
"document": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：<br
|
|
2460
|
-
"example": "
|
|
2459
|
+
"document": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：<br /><li>LOCAL_BASIC：本地硬盘<br /> <li>LOCAL_SSD：本地SSD硬盘<br /><li>LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定<br /><li>LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定<br /><li>CLOUD_BASIC：普通云硬盘<br /><li> CLOUD_PREMIUM：高性能云硬盘<br /><li>CLOUD_SSD：SSD云硬盘<br /><li> CLOUD_HSSD：增强型SSD云硬盘<br /> <li>CLOUD_TSSD：极速型SSD云硬盘<br /><li>CLOUD_BSSD：通用型SSD云硬盘<br /><br />默认取值：LOCAL_BASIC。<br /><br />该参数对`ResizeInstanceDisk`接口无效。</li></li></li> </li> </li></li></li></li></li></li>",
|
|
2460
|
+
"example": "CLOUD_SSD",
|
|
2461
2461
|
"member": "string",
|
|
2462
2462
|
"name": "DiskType",
|
|
2463
2463
|
"output_required": true,
|
|
@@ -2468,7 +2468,7 @@
|
|
|
2468
2468
|
{
|
|
2469
2469
|
"disabled": false,
|
|
2470
2470
|
"document": "数据盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID，暂时不支持该参数。\n该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。",
|
|
2471
|
-
"example": "
|
|
2471
|
+
"example": "disk-ciezoimt",
|
|
2472
2472
|
"member": "string",
|
|
2473
2473
|
"name": "DiskId",
|
|
2474
2474
|
"output_required": true,
|
|
@@ -2478,8 +2478,8 @@
|
|
|
2478
2478
|
},
|
|
2479
2479
|
{
|
|
2480
2480
|
"disabled": false,
|
|
2481
|
-
"document": "数据盘是否随子机销毁。取值范围：\n<li>
|
|
2482
|
-
"example": "
|
|
2481
|
+
"document": "数据盘是否随子机销毁。取值范围：\n<li>true：子机销毁时，销毁数据盘，只支持按小时后付费云盘</li>\n<li>\n false：子机销毁时，保留数据盘<br />\n 默认取值：true<br />\n 该参数目前仅用于 `RunInstances` 接口。\n</li>\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2482
|
+
"example": "true",
|
|
2483
2483
|
"member": "bool",
|
|
2484
2484
|
"name": "DeleteWithInstance",
|
|
2485
2485
|
"output_required": true,
|
|
@@ -2490,7 +2490,7 @@
|
|
|
2490
2490
|
{
|
|
2491
2491
|
"disabled": false,
|
|
2492
2492
|
"document": "数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2493
|
-
"example": "
|
|
2493
|
+
"example": "snap-6yczrj8x",
|
|
2494
2494
|
"member": "string",
|
|
2495
2495
|
"name": "SnapshotId",
|
|
2496
2496
|
"output_required": true,
|
|
@@ -2512,7 +2512,7 @@
|
|
|
2512
2512
|
{
|
|
2513
2513
|
"disabled": false,
|
|
2514
2514
|
"document": "自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。\n\n该参数目前仅用于 `RunInstances` 接口。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2515
|
-
"example": "
|
|
2515
|
+
"example": "kms-abcd1234",
|
|
2516
2516
|
"member": "string",
|
|
2517
2517
|
"name": "KmsKeyId",
|
|
2518
2518
|
"output_required": true,
|
|
@@ -2523,7 +2523,7 @@
|
|
|
2523
2523
|
{
|
|
2524
2524
|
"disabled": false,
|
|
2525
2525
|
"document": "云硬盘性能，单位：MB/s\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2526
|
-
"example": "
|
|
2526
|
+
"example": "20",
|
|
2527
2527
|
"member": "int64",
|
|
2528
2528
|
"name": "ThroughputPerformance",
|
|
2529
2529
|
"output_required": true,
|
|
@@ -2534,7 +2534,7 @@
|
|
|
2534
2534
|
{
|
|
2535
2535
|
"disabled": false,
|
|
2536
2536
|
"document": "所属的独享集群ID。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2537
|
-
"example": "
|
|
2537
|
+
"example": "cdc-1648zauv",
|
|
2538
2538
|
"member": "string",
|
|
2539
2539
|
"name": "CdcId",
|
|
2540
2540
|
"output_required": true,
|
|
@@ -2545,13 +2545,24 @@
|
|
|
2545
2545
|
{
|
|
2546
2546
|
"disabled": false,
|
|
2547
2547
|
"document": "突发性能\n\n <b>注：内测中。</b>\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2548
|
-
"example": "
|
|
2548
|
+
"example": "false",
|
|
2549
2549
|
"member": "bool",
|
|
2550
2550
|
"name": "BurstPerformance",
|
|
2551
2551
|
"output_required": false,
|
|
2552
2552
|
"required": false,
|
|
2553
2553
|
"type": "bool",
|
|
2554
2554
|
"value_allowed_null": true
|
|
2555
|
+
},
|
|
2556
|
+
{
|
|
2557
|
+
"disabled": false,
|
|
2558
|
+
"document": "磁盘名称，长度不超过128 个字符。\n\n该参数正在邀测中，暂未开放使用。",
|
|
2559
|
+
"example": "MyDiskName",
|
|
2560
|
+
"member": "string",
|
|
2561
|
+
"name": "DiskName",
|
|
2562
|
+
"output_required": false,
|
|
2563
|
+
"required": false,
|
|
2564
|
+
"type": "string",
|
|
2565
|
+
"value_allowed_null": false
|
|
2555
2566
|
}
|
|
2556
2567
|
],
|
|
2557
2568
|
"usage": "both"
|
|
@@ -11977,6 +11988,17 @@
|
|
|
11977
11988
|
"required": false,
|
|
11978
11989
|
"type": "string",
|
|
11979
11990
|
"value_allowed_null": true
|
|
11991
|
+
},
|
|
11992
|
+
{
|
|
11993
|
+
"disabled": false,
|
|
11994
|
+
"document": "磁盘名称，长度不超过128 个字符。\n\n该参数正在邀测中，暂未开放使用。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
11995
|
+
"example": "name",
|
|
11996
|
+
"member": "string",
|
|
11997
|
+
"name": "DiskName",
|
|
11998
|
+
"output_required": false,
|
|
11999
|
+
"required": false,
|
|
12000
|
+
"type": "string",
|
|
12001
|
+
"value_allowed_null": true
|
|
11980
12002
|
}
|
|
11981
12003
|
],
|
|
11982
12004
|
"usage": "both"
|
|
@@ -22465,7 +22465,7 @@
|
|
|
22465
22465
|
},
|
|
22466
22466
|
{
|
|
22467
22467
|
"disabled": false,
|
|
22468
|
-
"document": "过滤条件。\n<li>StrategyId- Uint64 - 基线策略id</li>\n<li>Status - Uint64 - 处理状态1已通过 0未通过</li>\n<li>Level - Uint64[] -
|
|
22468
|
+
"document": "过滤条件。\n<li>StrategyId- Uint64 - 基线策略id</li>\n<li>Status - Uint64 - 处理状态1已通过 0未通过</li>\n<li>Level - Uint64[] - 威胁等级</li>\n<li>BaselineName - String - 基线名称</li>\n<li>Quuid- String - 主机quuid</li>\n<li>Uuid- String - 主机uuid</li>",
|
|
22469
22469
|
"example": "[{\"Name\": \"Strate****\", \"Values\": [null]}]",
|
|
22470
22470
|
"member": "Filters",
|
|
22471
22471
|
"name": "Filters",
|
|
@@ -13552,8 +13552,8 @@
|
|
|
13552
13552
|
"members": [
|
|
13553
13553
|
{
|
|
13554
13554
|
"disabled": false,
|
|
13555
|
-
"document": "任务流ID\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
13556
|
-
"example": "
|
|
13555
|
+
"document": "任务流ID(后付费或者serverless资源返回，如果需要同步任务状态，请使用DescribeFlow接口)\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
13556
|
+
"example": "147284",
|
|
13557
13557
|
"member": "int64",
|
|
13558
13558
|
"name": "FlowId",
|
|
13559
13559
|
"output_required": true,
|
|
@@ -13562,8 +13562,8 @@
|
|
|
13562
13562
|
},
|
|
13563
13563
|
{
|
|
13564
13564
|
"disabled": false,
|
|
13565
|
-
"document": "
|
|
13566
|
-
"example": "[134]",
|
|
13565
|
+
"document": "退款订单号(预付费资源返回，如果需要同步订单状态，请使用计费产品的DescribeDealsByCond同步订单状态)\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
13566
|
+
"example": "[\"134\"]",
|
|
13567
13567
|
"member": "string",
|
|
13568
13568
|
"name": "DealNames",
|
|
13569
13569
|
"output_required": true,
|
|
@@ -9352,7 +9352,27 @@
|
|
|
9352
9352
|
"example": "invalid connection",
|
|
9353
9353
|
"member": "string",
|
|
9354
9354
|
"name": "Message",
|
|
9355
|
-
"
|
|
9355
|
+
"output_required": true,
|
|
9356
|
+
"type": "string",
|
|
9357
|
+
"value_allowed_null": false
|
|
9358
|
+
},
|
|
9359
|
+
{
|
|
9360
|
+
"disabled": false,
|
|
9361
|
+
"document": "报错原因",
|
|
9362
|
+
"example": "无",
|
|
9363
|
+
"member": "string",
|
|
9364
|
+
"name": "Reason",
|
|
9365
|
+
"output_required": false,
|
|
9366
|
+
"type": "string",
|
|
9367
|
+
"value_allowed_null": false
|
|
9368
|
+
},
|
|
9369
|
+
{
|
|
9370
|
+
"disabled": false,
|
|
9371
|
+
"document": "建议的修复方案",
|
|
9372
|
+
"example": "无",
|
|
9373
|
+
"member": "string",
|
|
9374
|
+
"name": "Solution",
|
|
9375
|
+
"output_required": false,
|
|
9356
9376
|
"type": "string",
|
|
9357
9377
|
"value_allowed_null": false
|
|
9358
9378
|
}
|
|
@@ -1914,7 +1914,7 @@
|
|
|
1914
1914
|
"members": [
|
|
1915
1915
|
{
|
|
1916
1916
|
"disabled": false,
|
|
1917
|
-
"document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>WATERMARK</b> : 水印控件；只能分配给发起方，必须设置ComponentExtra；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li></ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
|
|
1917
|
+
"document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>WATERMARK</b> : 水印控件；只能分配给发起方，必须设置ComponentExtra；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li></ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
|
|
1918
1918
|
"example": "SIGN_SEAL",
|
|
1919
1919
|
"member": "string",
|
|
1920
1920
|
"name": "ComponentType",
|
|
@@ -2046,7 +2046,7 @@
|
|
|
2046
2046
|
},
|
|
2047
2047
|
{
|
|
2048
2048
|
"disabled": false,
|
|
2049
|
-
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围6 :24</li>\n<li> <b>Opacity</b>： 透明度，范围0 :1</li>\n<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>\n<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>：`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"
|
|
2049
|
+
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围6 :24</li>\n<li> <b>Opacity</b>： 透明度，范围0 :1</li>\n<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>\n<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>：`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\">\n <thead>\n <tr>\n <th>字段名称</th>\n <th>类型</th>\n <th>描述</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>ComponentType</td>\n <td>string</td>\n <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>\n </tr>\n <tr>\n <td>ComponentName</td>\n <td>string</td>\n <td>子控件名称</td>\n </tr>\n <tr>\n <td>Placeholder</td>\n <td>string</td>\n <td>子控件提示语</td>\n </tr>\n <tr>\n <td>ComponentOffsetX</td>\n <td>float</td>\n <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td>\n </tr>\n <tr>\n <td>ComponentOffsetY</td>\n <td>float</td>\n <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td>\n </tr>\n <tr>\n <td>ComponentWidth</td>\n <td>float</td>\n <td>控件宽</td>\n </tr>\n <tr>\n <td>ComponentHeight</td>\n <td>float</td>\n <td>控件高</td>\n </tr>\n <tr>\n <td>ComponentExtra</td>\n <td>string</td>\n <td>控件的附属信息，根据ComponentType设置</td>\n </tr>\n </tbody>\n</table>\n<b>参数样例</b>：\n```json\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}\n```\n</ul>\n\n",
|
|
2050
2050
|
"example": "无",
|
|
2051
2051
|
"member": "string",
|
|
2052
2052
|
"name": "ComponentExtra",
|
|
@@ -552,8 +552,8 @@
|
|
|
552
552
|
"title": "文件发起B2C合同，签署方设置签批控件"
|
|
553
553
|
},
|
|
554
554
|
{
|
|
555
|
-
"document": "
|
|
556
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxbTUyKQWPt5NUuO4zjEuyFAyOX3v9C\"\n },\n \"FlowName\": \"文件发起-签批\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"SignComponents\": [\n {\n \"ComponentId\": \"ComponentId_1\",\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentHeight\": 100\n },\n {\n \"ComponentId\": \"ComponentId_2\",\n \"ComponentPosY\": 360,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentHeight\": 50\n },\n {\n \"
|
|
555
|
+
"document": "1.通过PDF文件发起合同 \n2.使用关键字模式\n3.指定B端签署方为企业【典子谦示例企业】，经办人为【典子谦】 \n4.指定C端签署方为个人【张三】 \n5.B 端签署人 有两个签署控件， 分别是签名控件和签批控件(SIGN_VIRTUAL_COMBINATION)，其中签批控件包含四个子控件通过ComponentExtra指定， 但是关键字跟绝对定位的区别在于 关键字方式只用传递SIGN_VIRTUAL_COMBINATION 一个签署控件即可。\n6.C 端签署人 有一个签批控件(SIGN_VIRTUAL_COMBINATION)，使用默认签批控件",
|
|
556
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxbTUyKQWPt5NUuO4zjEuyFAyOX3v9C\"\n },\n \"FlowName\": \"文件发起-签批\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"SignComponents\": [\n {\n \"ComponentId\": \"ComponentId_1\",\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentHeight\": 100\n },\n {\n \"ComponentId\": \"ComponentId_2\",\n \"ComponentPosY\": 360,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentHeight\": 50\n },\n {\n \"ComponentId\": \"甲方（盖章）\",\n \"ComponentType\": \"SIGN_VIRTUAL_COMBINATION\",\n \"ComponentHeight\": 600,\n \"ComponentWidth\": 400,\n \"ComponentRequired\": true,\n \"FileIndex\": 0,\n \"ComponentPage\": 7,\n \"ComponentPosY\": 0,\n \"ComponentPosX\": 0,\n \"RelativeLocation\": \"Below\",\n \"ComponentExtra\": \"{\\\"ChildrenComponents\\\":[{\\\"ComponentType\\\":\\\"SIGN_SIGNATURE\\\",\\\"ComponentName\\\":\\\"个人签名\\\",\\\"Placeholder\\\":\\\"请签名\\\",\\\"ComponentOffsetX\\\":10,\\\"ComponentOffsetY\\\":30,\\\"ComponentWidth\\\":119,\\\"ComponentHeight\\\":43,\\\"ComponentExtra\\\":\\\"{\\\\\\\"ComponentTypeLimit\\\\\\\":[\\\\\\\"SYSTEM_ESIGN\\\\\\\"]}\\\"},{\\\"ComponentType\\\":\\\"SIGN_SELECTOR\\\",\\\"ComponentName\\\":\\\"审批意见\\\",\\\"Placeholder\\\":\\\"\\\",\\\"ComponentOffsetX\\\":50,\\\"ComponentOffsetY\\\":130,\\\"ComponentWidth\\\":120,\\\"ComponentHeight\\\":43,\\\"ComponentExtra\\\":\\\"{\\\\\\\"Values\\\\\\\":[\\\\\\\"同意\\\\\\\",\\\\\\\"不同意\\\\\\\",\\\\\\\"待定\\\\\\\"],\\\\\\\"FontSize\\\\\\\":12,\\\\\\\"FontAlign\\\\\\\":\\\\\\\"Left\\\\\\\",\\\\\\\"Font\\\\\\\":\\\\\\\"黑体\\\\\\\",\\\\\\\"MultiSelect\\\\\\\":false}\\\"},{\\\"ComponentType\\\":\\\"SIGN_MULTI_LINE_TEXT\\\",\\\"ComponentName\\\":\\\"顺便留个言呗\\\",\\\"Placeholder\\\":\\\"\\\",\\\"ComponentOffsetX\\\":150,\\\"ComponentOffsetY\\\":300,\\\"ComponentWidth\\\":200,\\\"ComponentHeight\\\":86,\\\"ComponentExtra\\\":\\\"\\\"}]}\",\n \"GenerateMode\": \"KEYWORD\"\n }\n ]\n },\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"张三\",\n \"ApproverMobile\": \"18888888888\",\n \"SignComponents\": [\n {\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentHeight\": 100\n },\n {\n \"ComponentId\": \"已方（盖章）\",\n \"ComponentType\": \"SIGN_VIRTUAL_COMBINATION\",\n \"ComponentHeight\": 600,\n \"ComponentWidth\": 400,\n \"FileIndex\": 0,\n \"ComponentPage\": 7,\n \"ComponentPosY\": 0,\n \"ComponentPosX\": 0,\n \"ComponentRequired\": true,\n \"RelativeLocation\": \"Below\",\n \"GenerateMode\": \"KEYWORD\"\n }\n ]\n }\n ],\n \"FileIds\": [\n \"yDCWqUUckpve5id3U4f5EL77tlNh6zTZ\"\n ],\n \"Unordered\": true\n}",
|
|
557
557
|
"output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCdmUUckp7lfkotUyvGAviEmENDy2vV\",\n \"SignId\": \"yDCdmUUckp7lfkorUyvGAviC9bfPrgZE\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCdmUUckp7lfkoqUyvGAvi1LVH92Jy3\",\n \"SignId\": \"yDCdmUUckp7lfkolUyvGAvi86E6ZjRpX\"\n }\n ],\n \"FlowId\": \"yDCdmUUckp7lfko2UyvGAviyHgywsLpt\",\n \"PreviewUrl\": \"\",\n \"RequestId\": \"s1732096342358060984\"\n }\n}",
|
|
558
558
|
"title": "文件发起B2C合同，使用关键字方式，签署方设置签批控件"
|
|
559
559
|
}
|
|
@@ -5749,7 +5749,7 @@
|
|
|
5749
5749
|
},
|
|
5750
5750
|
{
|
|
5751
5751
|
"disabled": false,
|
|
5752
|
-
"document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li
|
|
5752
|
+
"document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n</ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
|
|
5753
5753
|
"example": "SIGN_SEAL",
|
|
5754
5754
|
"member": "string",
|
|
5755
5755
|
"name": "ComponentType",
|
|
@@ -5870,7 +5870,7 @@
|
|
|
5870
5870
|
},
|
|
5871
5871
|
{
|
|
5872
5872
|
"disabled": false,
|
|
5873
|
-
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：\n<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>\n<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>\n<b>参数样例</b>：`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0
|
|
5873
|
+
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：\n<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>\n<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>\n<b>参数样例</b>：`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\">\n <thead>\n <tr>\n <th>字段名称</th>\n <th>类型</th>\n <th>描述</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>ComponentType</td>\n <td>string</td>\n <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>\n </tr>\n <tr>\n <td>ComponentName</td>\n <td>string</td>\n <td>子控件名称</td>\n </tr>\n <tr>\n <td>Placeholder</td>\n <td>string</td>\n <td>子控件提示语</td>\n </tr>\n <tr>\n <td>ComponentOffsetX</td>\n <td>float</td>\n <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td>\n </tr>\n <tr>\n <td>ComponentOffsetY</td>\n <td>float</td>\n <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td>\n </tr>\n <tr>\n <td>ComponentWidth</td>\n <td>float</td>\n <td>控件宽</td>\n </tr>\n <tr>\n <td>ComponentHeight</td>\n <td>float</td>\n <td>控件高</td>\n </tr>\n <tr>\n <td>ComponentExtra</td>\n <td>string</td>\n <td>控件的附属信息，根据ComponentType设置</td>\n </tr>\n </tbody>\n</table>\n<b>参数样例</b>：\n```json\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}\n```\n</ul>\n\n\n\n",
|
|
5874
5874
|
"example": "ComponentExtra",
|
|
5875
5875
|
"member": "string",
|
|
5876
5876
|
"name": "ComponentExtra",
|
|
@@ -288,8 +288,8 @@
|
|
|
288
288
|
"title": "文件发起 签署方含有签批控件"
|
|
289
289
|
},
|
|
290
290
|
{
|
|
291
|
-
"document": "
|
|
292
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowByFiles\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n }\n },\n \"FlowName\": \"文件发起-签批\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ORGANIZATION\",\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OpenId\": \"n9527\",\n \"Name\": \"典子谦\",\n \"Mobile\": \"13200000000\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"SignComponents\": [\n {\n \"FileIndex\": 0,\n \"GenerateMode\": \"KEYWORD\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"RelativeLocation\": \"Right\",\n \"ComponentId\": \"
|
|
291
|
+
"document": "1.通过PDF文件发起合同 \n2.使用的是关键字定位\n3.指定B端签署方为企业【典子谦示例企业】，经办人为【典子谦】 \n4.指定C端签署方为个人【张三】 \n5.B 端签署有签批控件(SIGN_VIRTUAL_COMBINATION)，其中签批控件包含四个子控件, 通过在 Component 中的 ComponentExtra:指定, 但是关键字跟绝对定位的区别在于 关键字方式只用传递SIGN_VIRTUAL_COMBINATION 一个签署控件即可\n6.C 端签署人 有一个签批控件(SIGN_VIRTUAL_COMBINATION),未传ComponentExtra,系统自动生成签批子控件.",
|
|
292
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowByFiles\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n }\n },\n \"FlowName\": \"文件发起-签批\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ORGANIZATION\",\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OpenId\": \"n9527\",\n \"Name\": \"典子谦\",\n \"Mobile\": \"13200000000\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"SignComponents\": [\n {\n \"FileIndex\": 0,\n \"GenerateMode\": \"KEYWORD\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"RelativeLocation\": \"Right\",\n \"ComponentId\": \"甲方（盖章）\",\n \"ComponentExtra\": \"{\\\"ChildrenComponents\\\":[{\\\"ComponentType\\\":\\\"SIGN_SIGNATURE\\\",\\\"ComponentName\\\":\\\"个人签名\\\",\\\"Placeholder\\\":\\\"请签名\\\",\\\"ComponentOffsetX\\\":10,\\\"ComponentOffsetY\\\":30,\\\"ComponentWidth\\\":119,\\\"ComponentHeight\\\":43,\\\"ComponentExtra\\\":\\\"{\\\\\\\"ComponentTypeLimit\\\\\\\":[\\\\\\\"SYSTEM_ESIGN\\\\\\\"]}\\\"},{\\\"ComponentType\\\":\\\"SIGN_SELECTOR\\\",\\\"ComponentName\\\":\\\"审批意见\\\",\\\"Placeholder\\\":\\\"\\\",\\\"ComponentOffsetX\\\":50,\\\"ComponentOffsetY\\\":130,\\\"ComponentWidth\\\":120,\\\"ComponentHeight\\\":43,\\\"ComponentExtra\\\":\\\"{\\\\\\\"Values\\\\\\\":[\\\\\\\"同意\\\\\\\",\\\\\\\"不同意\\\\\\\",\\\\\\\"待定\\\\\\\"],\\\\\\\"FontSize\\\\\\\":12,\\\\\\\"FontAlign\\\\\\\":\\\\\\\"Left\\\\\\\",\\\\\\\"Font\\\\\\\":\\\\\\\"黑体\\\\\\\",\\\\\\\"MultiSelect\\\\\\\":false}\\\"},{\\\"ComponentType\\\":\\\"SIGN_MULTI_LINE_TEXT\\\",\\\"ComponentName\\\":\\\"顺便留个言呗\\\",\\\"Placeholder\\\":\\\"\\\",\\\"ComponentOffsetX\\\":150,\\\"ComponentOffsetY\\\":300,\\\"ComponentWidth\\\":200,\\\"ComponentHeight\\\":86,\\\"ComponentExtra\\\":\\\"\\\"}]}\",\n \"ComponentHeight\": 234,\n \"ComponentPage\": 1,\n \"ComponentType\": \"SIGN_VIRTUAL_COMBINATION\",\n \"ComponentWidth\": 210,\n \"ComponentRequired\": false\n }\n ]\n },\n {\n \"ApproverType\": \"PERSON\",\n \"Name\": \"张三\",\n \"Mobile\": \"18888888888\",\n \"SignComponents\": [\n {\n \"FileIndex\": 0,\n \"GenerateMode\": \"KEYWORD\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"RelativeLocation\": \"Right\",\n \"ComponentId\": \"已方（盖章）\",\n \"ComponentHeight\": 234,\n \"ComponentPage\": 1,\n \"ComponentType\": \"SIGN_VIRTUAL_COMBINATION\",\n \"ComponentWidth\": 210,\n \"ComponentRequired\": false\n }\n ]\n }\n ],\n \"FileIds\": [\n \"yDCWqUUckpve5id3U4f5EL77tlNh6zTZ\"\n ],\n \"Unordered\": true\n}",
|
|
293
293
|
"output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCdoUUckp7ltep9Uyq2ikIypsCCIqXS\",\n \"SignId\": \"yDCdoUUckp7ltepxUyq2ikIE79iVjD2I\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCdoUUckp7ltep7Uyq2ikIuzVkVXNut\",\n \"SignId\": \"yDCdoUUckp7ltep4Uyq2ikI1baBbI9zJ\"\n }\n ],\n \"FlowId\": \"yDCdoUUckp7ltepfUyq2ikI8VC2s92zT\",\n \"RequestId\": \"s1732015258075060878\"\n }\n}",
|
|
294
294
|
"title": "文件发起 使用关键字定位 签署方含有签批控件"
|
|
295
295
|
}
|
|
@@ -4445,7 +4445,7 @@
|
|
|
4445
4445
|
},
|
|
4446
4446
|
{
|
|
4447
4447
|
"disabled": false,
|
|
4448
|
-
"document": "状态码。\n- 取值范围：\n0：正常。\n1：停机。\n2：销号。\
|
|
4448
|
+
"document": "状态码。\n- 取值范围：\n0：正常。\n1：停机。\n2：销号。\n4：不在网。\n99：未知状态。",
|
|
4449
4449
|
"example": "1",
|
|
4450
4450
|
"member": "int64",
|
|
4451
4451
|
"name": "StatusCode",
|
|
@@ -693,6 +693,58 @@ def doQueryHunyuanImageChatJob(args, parsed_globals):
|
|
|
693
693
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
|
694
694
|
|
|
695
695
|
|
|
696
|
+
def doChatTranslations(args, parsed_globals):
|
|
697
|
+
g_param = parse_global_arg(parsed_globals)
|
|
698
|
+
|
|
699
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
|
700
|
+
cred = credential.CVMRoleCredential()
|
|
701
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
|
702
|
+
cred = credential.STSAssumeRoleCredential(
|
|
703
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
|
704
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
|
705
|
+
)
|
|
706
|
+
elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
|
|
707
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
|
708
|
+
else:
|
|
709
|
+
cred = credential.Credential(
|
|
710
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
|
711
|
+
)
|
|
712
|
+
http_profile = HttpProfile(
|
|
713
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
|
714
|
+
reqMethod="POST",
|
|
715
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
|
716
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
|
717
|
+
)
|
|
718
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
|
719
|
+
if g_param[OptionsDefine.Language]:
|
|
720
|
+
profile.language = g_param[OptionsDefine.Language]
|
|
721
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
|
722
|
+
client = mod.HunyuanClient(cred, g_param[OptionsDefine.Region], profile)
|
|
723
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
|
724
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
|
725
|
+
model = models.ChatTranslationsRequest()
|
|
726
|
+
model.from_json_string(json.dumps(args))
|
|
727
|
+
start_time = time.time()
|
|
728
|
+
while True:
|
|
729
|
+
rsp = client.ChatTranslations(model)
|
|
730
|
+
result = rsp.to_json_string()
|
|
731
|
+
try:
|
|
732
|
+
json_obj = json.loads(result)
|
|
733
|
+
except TypeError as e:
|
|
734
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
|
735
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
|
736
|
+
break
|
|
737
|
+
cur_time = time.time()
|
|
738
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
|
739
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
|
740
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
|
741
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
|
742
|
+
else:
|
|
743
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
|
744
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
|
745
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
|
746
|
+
|
|
747
|
+
|
|
696
748
|
def doActivateService(args, parsed_globals):
|
|
697
749
|
g_param = parse_global_arg(parsed_globals)
|
|
698
750
|
|
|
@@ -977,6 +1029,7 @@ ACTION_MAP = {
|
|
|
977
1029
|
"GetThreadMessage": doGetThreadMessage,
|
|
978
1030
|
"ChatCompletions": doChatCompletions,
|
|
979
1031
|
"QueryHunyuanImageChatJob": doQueryHunyuanImageChatJob,
|
|
1032
|
+
"ChatTranslations": doChatTranslations,
|
|
980
1033
|
"ActivateService": doActivateService,
|
|
981
1034
|
"GetThreadMessageList": doGetThreadMessageList,
|
|
982
1035
|
"SetPayMode": doSetPayMode,
|