tccli 3.0.1083.1__py2.py3-none-any.whl → 3.0.1084.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 (37) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/cdb/v20170320/CreateCloneInstance.md +5 -5
  3. tccli/examples/ckafka/v20190819/DescribeGroupInfo.md +2 -2
  4. tccli/examples/ckafka/v20190819/ModifyAclRule.md +1 -1
  5. tccli/examples/ess/v20201111/CreateFlowApprovers.md +34 -0
  6. tccli/examples/ess/v20201111/CreateFlowGroupByFiles.md +168 -0
  7. tccli/examples/ess/v20201111/CreateFlowGroupByTemplates.md +98 -0
  8. tccli/examples/ess/v20201111/CreateSchemeUrl.md +31 -3
  9. tccli/examples/essbasic/v20210526/ChannelCreateFlowApprovers.md +41 -0
  10. tccli/examples/essbasic/v20210526/ChannelCreateFlowGroupByFiles.md +171 -0
  11. tccli/examples/essbasic/v20210526/ChannelCreateFlowGroupByTemplates.md +92 -0
  12. tccli/examples/essbasic/v20210526/CreateSignUrls.md +52 -0
  13. tccli/examples/faceid/v20180301/GetFaceIdRiskInfo.md +26 -0
  14. tccli/examples/faceid/v20180301/GetFaceidRiskInfoToken.md +22 -0
  15. tccli/examples/live/v20180801/CreateLiveTimeShiftTemplate.md +8 -8
  16. tccli/examples/wedata/v20210820/ModifyTaskInfo.md +79 -29
  17. tccli/services/cdb/v20170320/api.json +75 -21
  18. tccli/services/cdb/v20170320/examples.json +2 -2
  19. tccli/services/ckafka/v20190819/api.json +21 -20
  20. tccli/services/ckafka/v20190819/examples.json +2 -2
  21. tccli/services/ess/v20201111/api.json +124 -12
  22. tccli/services/ess/v20201111/examples.json +26 -2
  23. tccli/services/essbasic/v20210526/api.json +121 -9
  24. tccli/services/essbasic/v20210526/examples.json +24 -0
  25. tccli/services/faceid/faceid_client.py +136 -30
  26. tccli/services/faceid/v20180301/api.json +147 -0
  27. tccli/services/faceid/v20180301/examples.json +16 -0
  28. tccli/services/live/v20180801/api.json +1 -1
  29. tccli/services/live/v20180801/examples.json +2 -2
  30. tccli/services/oceanus/v20190422/api.json +1 -1
  31. tccli/services/wedata/v20210820/api.json +29 -2
  32. tccli/services/wedata/v20210820/examples.json +8 -2
  33. {tccli-3.0.1083.1.dist-info → tccli-3.0.1084.1.dist-info}/METADATA +2 -2
  34. {tccli-3.0.1083.1.dist-info → tccli-3.0.1084.1.dist-info}/RECORD +37 -35
  35. {tccli-3.0.1083.1.dist-info → tccli-3.0.1084.1.dist-info}/WHEEL +0 -0
  36. {tccli-3.0.1083.1.dist-info → tccli-3.0.1084.1.dist-info}/entry_points.txt +0 -0
  37. {tccli-3.0.1083.1.dist-info → tccli-3.0.1084.1.dist-info}/license_files/LICENSE +0 -0
tccli/services/ckafka/v20190819/api.json CHANGED
@@ -491,9 +491,9 @@
491
491
  "status": "online"
492
492
  },
493
493
  "ModifyAclRule": {
494
- "document": "修改\bAC策略，目前只支持预设规则的是否应用到新增topic这一项的修改",
494
+ "document": "修改ACL策略，目前只支持预设规则的是否应用到新增topic这一项的修改",
495
495
  "input": "ModifyAclRuleRequest",
496
- "name": "修改Acl策略",
496
+ "name": "修改Acl预设规则",
497
497
  "output": "ModifyAclRuleResponse",
498
498
  "status": "online"
499
499
  },
@@ -7409,7 +7409,7 @@
7409
7409
  {
7410
7410
  "disabled": false,
7411
7411
  "document": "（过滤条件）按照实例 ID 过滤。",
7412
- "example": "",
7412
+ "example": "ckafka-resource",
7413
7413
  "member": "string",
7414
7414
  "name": "InstanceId",
7415
7415
  "required": true,
@@ -7418,7 +7418,7 @@
7418
7418
  {
7419
7419
  "disabled": false,
7420
7420
  "document": "Kafka 消费分组，Consumer-group，这里是数组形式，格式：GroupList.0=xxx&GroupList.1=yyy。",
7421
- "example": "",
7421
+ "example": "无",
7422
7422
  "member": "string",
7423
7423
  "name": "GroupList",
7424
7424
  "required": true,
@@ -7433,9 +7433,10 @@
7433
7433
  {
7434
7434
  "disabled": false,
7435
7435
  "document": "返回的结果\n注意：此字段可能返回 null，表示取不到有效值。",
7436
- "example": "",
7436
+ "example": "无",
7437
7437
  "member": "GroupInfoResponse",
7438
7438
  "name": "Result",
7439
+ "output_required": true,
7439
7440
  "type": "list",
7440
7441
  "value_allowed_null": true
7441
7442
  },
@@ -10068,60 +10069,60 @@
10068
10069
  {
10069
10070
  "disabled": false,
10070
10071
  "document": "错误码，正常为0",
10071
- "example": "",
10072
+ "example": "无",
10072
10073
  "member": "string",
10073
10074
  "name": "ErrorCode",
10074
- "required": true,
10075
+ "output_required": true,
10075
10076
  "type": "string",
10076
10077
  "value_allowed_null": false
10077
10078
  },
10078
10079
  {
10079
10080
  "disabled": false,
10080
10081
  "document": "group 状态描述（常见的为 Empty、Stable、Dead 三种状态）：\nDead：消费分组不存在\nEmpty：消费分组，当前没有任何消费者订阅\nPreparingRebalance：消费分组处于 rebalance 状态\nCompletingRebalance：消费分组处于 rebalance 状态\nStable：消费分组中各个消费者已经加入，处于稳定状态",
10081
- "example": "",
10082
+ "example": "无",
10082
10083
  "member": "string",
10083
10084
  "name": "State",
10084
- "required": true,
10085
+ "output_required": true,
10085
10086
  "type": "string",
10086
10087
  "value_allowed_null": false
10087
10088
  },
10088
10089
  {
10089
10090
  "disabled": false,
10090
10091
  "document": "消费分组选择的协议类型正常的消费者一般为 consumer 但有些系统采用了自己的协议如 kafka-connect 用的就是 connect。只有标准的 consumer 协议，本接口才知道具体的分配方式的格式，才能解析到具体的 partition 的分配情况",
10091
- "example": "",
10092
+ "example": "无",
10092
10093
  "member": "string",
10093
10094
  "name": "ProtocolType",
10094
- "required": true,
10095
+ "output_required": true,
10095
10096
  "type": "string",
10096
10097
  "value_allowed_null": false
10097
10098
  },
10098
10099
  {
10099
10100
  "disabled": false,
10100
10101
  "document": "消费者 partition 分配算法常见的有如下几种(Kafka 消费者 SDK 默认的选择项为 range)：range、 roundrobin、 sticky",
10101
- "example": "",
10102
+ "example": "无",
10102
10103
  "member": "string",
10103
10104
  "name": "Protocol",
10104
- "required": true,
10105
+ "output_required": true,
10105
10106
  "type": "string",
10106
10107
  "value_allowed_null": false
10107
10108
  },
10108
10109
  {
10109
10110
  "disabled": false,
10110
10111
  "document": "仅当 state 为 Stable 且 protocol_type 为 consumer 时， 该数组才包含信息",
10111
- "example": "",
10112
+ "example": "无",
10112
10113
  "member": "GroupInfoMember",
10113
10114
  "name": "Members",
10114
- "required": true,
10115
+ "output_required": true,
10115
10116
  "type": "list",
10116
10117
  "value_allowed_null": false
10117
10118
  },
10118
10119
  {
10119
10120
  "disabled": false,
10120
10121
  "document": "Kafka 消费分组",
10121
- "example": "",
10122
+ "example": "无",
10122
10123
  "member": "string",
10123
10124
  "name": "Group",
10124
- "required": true,
10125
+ "output_required": true,
10125
10126
  "type": "string",
10126
10127
  "value_allowed_null": false
10127
10128
  }
@@ -12476,11 +12477,11 @@
12476
12477
  },
12477
12478
  {
12478
12479
  "disabled": false,
12479
- "document": "是否应用到新增的Topic",
12480
+ "document": "修改预设规则时传入,是否应用到新增的Topic",
12480
12481
  "example": "1",
12481
12482
  "member": "int64",
12482
12483
  "name": "IsApplied",
12483
- "required": true,
12484
+ "required": false,
12484
12485
  "type": "int"
12485
12486
  }
12486
12487
  ],
@@ -12495,7 +12496,7 @@
12495
12496
  "example": "1",
12496
12497
  "member": "int64",
12497
12498
  "name": "Result",
12498
- "required": true,
12499
+ "output_required": true,
12499
12500
  "type": "int",
12500
12501
  "value_allowed_null": false
12501
12502
  },
tccli/services/ckafka/v20190819/examples.json CHANGED
@@ -429,7 +429,7 @@
429
429
  "DescribeGroupInfo": [
430
430
  {
431
431
  "document": "",
432
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeGroupInfo\r\n&InstanceId=xxxx\r\n&GroupList.0=xx\r\n&<公共请求参数>",
432
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeGroupInfo\n&InstanceId=ckafka-ivn43n20\n&GroupList.0=groupName\n&<公共请求参数>",
433
433
  "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"ErrorCode\": \"0\",\n \"State\": \"Stable\",\n \"ProtocolType\": \"consumer\",\n \"Protocol\": \"range\",\n \"Members\": [\n {\n \"MemberId\": \"consumer-1-/10.53.88.65-2018-08-10 10:17:19:639-88206ef1-9248-43a0-9ff4-e22c3ab21e92\",\n \"ClientId\": \"consumer-1\",\n \"ClientHost\": \"/10.53.88.65\",\n \"Assignment\": {\n \"Version\": 0,\n \"Topics\": [\n {\n \"Topic\": \"test\",\n \"Partitions\": [\n 0\n ]\n }\n ]\n }\n }\n ],\n \"Group\": \"perf-consumer-97910\"\n }\n ],\n \"RequestId\": \"8e9b234e-0c3e-4340-9733-adbd05879b10\"\n }\n}",
434
434
  "title": "获取消费分组信息"
435
435
  }
@@ -604,7 +604,7 @@
604
604
  ],
605
605
  "ModifyAclRule": [
606
606
  {
607
- "document": "",
607
+ "document": "修改ACL规则示范",
608
608
  "input": "https://ckafka.tencentcloudapi.com/?Action=ModifyAclRule\n&InstanceId=xxx\n&RuleName=xxx\n&IsApplied=1\n&<公共请求参数>",
609
609
  "output": "{\n \"Response\": {\n \"Result\": 1,\n \"RequestId\": \"72b987c9-8842-47ac-9ad6-fa2bde3e936d\"\n }\n}",
610
610
  "title": "修改ACL规则示范"
tccli/services/ess/v20201111/api.json CHANGED
@@ -491,7 +491,7 @@
491
491
  "status": "online"
492
492
  },
493
493
  "StartFlow": {
494
- "document": "此接口用于启动流程。它是模板发起合同的最后一步。\n在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)\n\n注：\n1.<font color=\"red\">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）\n\n2.<font color=\"red\">静默（自动）签署不支持合同签署方存在填写</font>功能\n\n3.<font color=\"red\">在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_file_resources)</font>，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。",
494
+ "document": "此接口用于启动流程。它是模板发起合同的最后一步。\n在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)\n\n注：\n1.<font color=\"red\">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）\n\n2.<font color=\"red\">静默（自动）签署不支持非本企业合同签署方存在填写</font>功能\n\n3.<font color=\"red\">在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_file_resources)</font>，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。",
495
495
  "input": "StartFlowRequest",
496
496
  "name": "模板发起合同-发起签署流程",
497
497
  "output": "StartFlowResponse",
@@ -643,7 +643,7 @@
643
643
  "example": "无",
644
644
  "member": "string",
645
645
  "name": "ApproverName",
646
- "required": true,
646
+ "required": false,
647
647
  "type": "string"
648
648
  },
649
649
  {
@@ -652,7 +652,7 @@
652
652
  "example": "无",
653
653
  "member": "string",
654
654
  "name": "ApproverMobile",
655
- "required": true,
655
+ "required": false,
656
656
  "type": "string"
657
657
  },
658
658
  {
@@ -2644,15 +2644,6 @@
2644
2644
  "required": true,
2645
2645
  "type": "object"
2646
2646
  },
2647
- {
2648
- "disabled": false,
2649
- "document": "合同流程ID，为32位字符串。\n建议开发者妥善保存此流程ID，以便于顺利进行后续操作。\n可登录腾讯电子签控制台，在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
2650
- "example": "无",
2651
- "member": "string",
2652
- "name": "FlowId",
2653
- "required": true,
2654
- "type": "string"
2655
- },
2656
2647
  {
2657
2648
  "disabled": false,
2658
2649
  "document": "补充企业签署人信息。\n\n- 如果发起方指定的补充签署人是企业微信签署人（ApproverSource=WEWORKAPP），则需要提供企业微信UserId进行补充；\n\n- 如果不指定，则使用姓名和手机号进行补充。",
@@ -2662,6 +2653,15 @@
2662
2653
  "required": true,
2663
2654
  "type": "list"
2664
2655
  },
2656
+ {
2657
+ "disabled": false,
2658
+ "document": "合同流程ID，为32位字符串。\n建议开发者妥善保存此流程ID，以便于顺利进行后续操作。\n可登录腾讯电子签控制台，在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
2659
+ "example": "无",
2660
+ "member": "string",
2661
+ "name": "FlowId",
2662
+ "required": false,
2663
+ "type": "string"
2664
+ },
2665
2665
  {
2666
2666
  "disabled": false,
2667
2667
  "document": "签署人信息补充方式\n\n<ul><li>**0**: 添加或签人候选人，或签支持一个节点传多个签署人，不传值默认或签。\n注: `或签只支持企业签署方`</li>\n<li>**1**: 表示往未指定签署人的节点，添加一个明确的签署人，支持企业或个人签署方。</li></ul>",
@@ -2688,6 +2688,15 @@
2688
2688
  "name": "Agent",
2689
2689
  "required": false,
2690
2690
  "type": "object"
2691
+ },
2692
+ {
2693
+ "disabled": false,
2694
+ "document": "合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值",
2695
+ "example": "yDR1AUUgygjazuesUuO4zjESPW4PkfNi",
2696
+ "member": "string",
2697
+ "name": "FlowGroupId",
2698
+ "required": false,
2699
+ "type": "string"
2691
2700
  }
2692
2701
  ],
2693
2702
  "type": "object"
@@ -3109,6 +3118,16 @@
3109
3118
  "type": "list",
3110
3119
  "value_allowed_null": true
3111
3120
  },
3121
+ {
3122
+ "disabled": false,
3123
+ "document": "合同组签署方信息。",
3124
+ "example": "无",
3125
+ "member": "FlowGroupApprovers",
3126
+ "name": "Approvers",
3127
+ "output_required": false,
3128
+ "type": "list",
3129
+ "value_allowed_null": false
3130
+ },
3112
3131
  {
3113
3132
  "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
3114
3133
  "member": "string",
@@ -3192,6 +3211,16 @@
3192
3211
  "type": "list",
3193
3212
  "value_allowed_null": true
3194
3213
  },
3214
+ {
3215
+ "disabled": false,
3216
+ "document": "合同组签署人信息。",
3217
+ "example": "无",
3218
+ "member": "FlowGroupApprovers",
3219
+ "name": "Approvers",
3220
+ "output_required": false,
3221
+ "type": "list",
3222
+ "value_allowed_null": false
3223
+ },
3195
3224
  {
3196
3225
  "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
3197
3226
  "member": "string",
@@ -5190,6 +5219,15 @@
5190
5219
  "name": "RecipientId",
5191
5220
  "required": false,
5192
5221
  "type": "string"
5222
+ },
5223
+ {
5224
+ "disabled": false,
5225
+ "document": "合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。",
5226
+ "example": "无",
5227
+ "member": "FlowGroupUrlInfo",
5228
+ "name": "FlowGroupUrlInfo",
5229
+ "required": false,
5230
+ "type": "object"
5193
5231
  }
5194
5232
  ],
5195
5233
  "type": "object"
@@ -8341,6 +8379,15 @@
8341
8379
  "name": "ApproverIdCardNumber",
8342
8380
  "required": false,
8343
8381
  "type": "string"
8382
+ },
8383
+ {
8384
+ "disabled": false,
8385
+ "document": "合同流程ID，补充合同组子合同动态签署人时必传。",
8386
+ "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
8387
+ "member": "string",
8388
+ "name": "FlowId",
8389
+ "required": false,
8390
+ "type": "string"
8344
8391
  }
8345
8392
  ],
8346
8393
  "usage": "in"
@@ -9135,6 +9182,56 @@
9135
9182
  ],
9136
9183
  "usage": "out"
9137
9184
  },
9185
+ "FlowGroupApproverInfo": {
9186
+ "document": "合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。",
9187
+ "members": [
9188
+ {
9189
+ "disabled": false,
9190
+ "document": "合同流程ID。",
9191
+ "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
9192
+ "member": "string",
9193
+ "name": "FlowId",
9194
+ "required": false,
9195
+ "type": "string"
9196
+ },
9197
+ {
9198
+ "disabled": false,
9199
+ "document": "签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`",
9200
+ "example": "无",
9201
+ "member": "string",
9202
+ "name": "RecipientId",
9203
+ "required": false,
9204
+ "type": "string"
9205
+ }
9206
+ ],
9207
+ "usage": "in"
9208
+ },
9209
+ "FlowGroupApprovers": {
9210
+ "document": "合同组签署方信息",
9211
+ "members": [
9212
+ {
9213
+ "disabled": false,
9214
+ "document": "合同流程ID \n注意：此字段可能返回 null，表示取不到有效值。",
9215
+ "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
9216
+ "member": "string",
9217
+ "name": "FlowId",
9218
+ "output_required": false,
9219
+ "type": "string",
9220
+ "value_allowed_null": true
9221
+ },
9222
+ {
9223
+ "disabled": false,
9224
+ "document": "签署方信息，包含合同ID和角色ID用于定位RecipientId。\n注意：此字段可能返回 null，表示取不到有效值。",
9225
+ "example": "无",
9226
+ "member": "ApproverItem",
9227
+ "name": "Approvers",
9228
+ "output_required": false,
9229
+ "type": "list",
9230
+ "value_allowed_null": true
9231
+ }
9232
+ ],
9233
+ "usage": "out"
9234
+ },
9138
9235
  "FlowGroupInfo": {
9139
9236
  "document": "此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息",
9140
9237
  "members": [
@@ -9291,6 +9388,21 @@
9291
9388
  ],
9292
9389
  "usage": "in"
9293
9390
  },
9391
+ "FlowGroupUrlInfo": {
9392
+ "document": "合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。",
9393
+ "members": [
9394
+ {
9395
+ "disabled": false,
9396
+ "document": "合同组子合同和签署方的信息，用于补充动态签署人。",
9397
+ "example": "无",
9398
+ "member": "FlowGroupApproverInfo",
9399
+ "name": "FlowGroupApproverInfos",
9400
+ "required": false,
9401
+ "type": "list"
9402
+ }
9403
+ ],
9404
+ "usage": "in"
9405
+ },
9294
9406
  "FormField": {
9295
9407
  "document": "电子文档的控件填充信息。按照控件类型进行相应的填充。\n\n当控件的 ComponentType=‘SIGN_SEAL'时，FormField.ComponentValue填入印章id。\n\n* 可用于指定自动签模板未设置自动签印章时，可由接口传入自动签印章\n* 若指定的控件上已设置ComponentValue，那以已经设置的ComponentValue为准\n\n```\nFormField输入示例：\n{\n \"ComponentId\": \"componentId1\",\n \"ComponentValue\": \"sealId（印章id）\"\n}\n```\n\n当控件的 ComponentType='TEXT'时，FormField.ComponentValue填入文本内容\n\n```\nFormField输入示例：\n{\n \"ComponentId\": \"componentId1\",\n \"ComponentValue\": \"文本内容\"\n}\n```\n\n当控件的 ComponentType='MULTI_LINE_TEXT'时，FormField.ComponentValue填入文本内容，支持自动换行。\n\n```\nFormField输入示例：\n{\n \"ComponentId\": \"componentId1\",\n \"ComponentValue\": \"多行文本内容\"\n}\n```\n\n当控件的 ComponentType='CHECK_BOX'时，FormField.ComponentValue填入true或false文本\n\n```\nFormField输入示例：\n{\n \"ComponentId\": \"componentId1\",\n \"ComponentValue\": \"true\"\n}\n```\n\n当控件的 ComponentType='FILL_IMAGE'时，FormField.ComponentValue填入图片的资源ID\n\n```\nFormField输入示例：\n{\n \"ComponentId\": \"componentId1\",\n \"ComponentValue\": \"yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n}\n```\n\n当控件的 ComponentType='ATTACHMENT'时，FormField.ComponentValue支持填入附件图片或者文件的资源ID列表，以逗号分隔，单个附件控件最多支持6个资源ID；\n支持的文件类型包括doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf\n\n```\nFormField输入示例：\n{\n \"ComponentId\": \"componentId1\",\n \"ComponentValue\": \"yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3\"\n}\n```\n\n当控件的 ComponentType='SELECTOR'时，FormField.ComponentValue填入选择的选项内容；\n\n```\nFormField输入示例：\n{\n \"ComponentId\": \"componentId1\",\n \"ComponentValue\": \"选择的内容\"\n}\n```\n\n当控件的 ComponentType='DATE'时，FormField.ComponentValue填入日期内容；\n\n```\nFormField输入示例：\n{\n \"ComponentId\": \"componentId1\",\n \"ComponentValue\": \"2023年01月01日\"\n}\n```\n\n当控件的 ComponentType='DISTRICT'时，FormField.ComponentValue填入省市区内容；\n\n```\nFormField输入示例：\n{\n \"ComponentId\": \"componentId1\",\n \"ComponentValue\": \"广东省深圳市福田区\"\n}\n```\n\n【数据表格传参说明】\n当控件的 ComponentType='DYNAMIC_TABLE'时，FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）\n输入示例1：\n\n```\n{\n \"headers\":[\n {\n \"content\":\"head1\"\n },\n {\n \"content\":\"head2\"\n },\n {\n \"content\":\"head3\"\n }\n ],\n \"rowCount\":3,\n \"body\":{\n \"cells\":[\n {\n \"rowStart\":1,\n \"rowEnd\":1,\n \"columnStart\":1,\n \"columnEnd\":1,\n \"content\":\"123\"\n },\n {\n \"rowStart\":2,\n \"rowEnd\":3,\n \"columnStart\":1,\n \"columnEnd\":2,\n \"content\":\"456\"\n },\n {\n \"rowStart\":3,\n \"rowEnd\":3,\n \"columnStart\":3,\n \"columnEnd\":3,\n \"content\":\"789\"\n }\n ]\n }\n}\n```\n\n输入示例2（表格表头宽度比例配置）：\n\n```\n{\n \"headers\":[\n {\n \"content\":\"head1\",\n \"widthPercent\": 30\n },\n {\n \"content\":\"head2\",\n \"widthPercent\": 30\n },\n {\n \"content\":\"head3\",\n \"widthPercent\": 40\n }\n ],\n \"rowCount\":3,\n \"body\":{\n \"cells\":[\n {\n \"rowStart\":1,\n \"rowEnd\":1,\n \"columnStart\":1,\n \"columnEnd\":1,\n \"content\":\"123\"\n },\n {\n \"rowStart\":2,\n \"rowEnd\":3,\n \"columnStart\":1,\n \"columnEnd\":2,\n \"content\":\"456\"\n },\n {\n \"rowStart\":3,\n \"rowEnd\":3,\n \"columnStart\":3,\n \"columnEnd\":3,\n \"content\":\"789\"\n }\n ]\n }\n}\n```\n\n输入示例3（表格设置字体加粗颜色）：\n\n```\n{\n \"headers\":[\n {\n \"content\":\"head1\"\n },\n {\n \"content\":\"head2\"\n },\n {\n \"content\":\"head3\"\n }\n ],\n \"rowCount\":3,\n \"body\":{\n \"cells\":[\n {\n \"rowStart\":1,\n \"rowEnd\":1,\n \"columnStart\":1,\n \"columnEnd\":1,\n \"content\":\"123\",\n \"style\": {\"color\": \"#b50000\", \"fontSize\": 12,\"bold\": true,\"align\": \"CENTER\"}\n },\n {\n \"rowStart\":2,\n \"rowEnd\":3,\n \"columnStart\":1,\n \"columnEnd\":2,\n \"content\":\"456\",\n \"style\": {\"color\": \"#b50000\", \"fontSize\": 12,\"bold\": true,\"align\": \"LEFT\"}\n },\n {\n \"rowStart\":3,\n \"rowEnd\":3,\n \"columnStart\":3,\n \"columnEnd\":3,\n \"content\":\"789\",\n \"style\": {\"color\": \"#b500bf\", \"fontSize\": 12,\"bold\": false,\"align\": \"RIGHT\"}\n }\n ]\n }\n}\n\n```\n\n表格参数说明\n\n| 名称 | 类型 | 描述 |\n| ------------------- | ------- | ------------------------------------------------- |\n| headers | Array | 表头：不超过10列，不支持单元格合并，字数不超过100 |\n| rowCount | Integer | 表格内容最大行数 |\n| cells.N.rowStart | Integer | 单元格坐标：行起始index |\n| cells.N.rowEnd | Integer | 单元格坐标：行结束index |\n| cells.N.columnStart | Integer | 单元格坐标：列起始index |\n| cells.N.columnEnd | Integer | 单元格坐标：列结束index |\n| cells.N.content | String | 单元格内容，字数不超过100 |\n| cells.N.style | String | 单元格字体风格配置 ，风格配置的json字符串 如： {\"font\":\"黑体\",\"fontSize\":12,\"color\":\"#FFFFFF\",\"bold\":true,\"align\":\"CENTER\"} |\n\n表格参数headers说明\nwidthPercent Integer 表头单元格列占总表头的比例，例如1：30表示 此列占表头的30%，不填写时列宽度平均拆分；例如2：总2列，某一列填写40，剩余列可以为空，按照60计算。；例如3：总3列，某一列填写30，剩余2列可以为空，分别为(100-30)/2=35\n\ncontent String 表头单元格内容，字数不超过100\n\n\nstyle String 为字体风格设置 风格支持： font : 目前支持 黑体、宋体; fontSize： 6-72; color：000000-FFFFFF 字符串形如： \"#FFFFFF\" 或者 \"0xFFFFFF\"; bold ： 是否加粗， true ： 加粗 false： 不加粗; align: 对其方式， 支持 LEFT / RIGHT / CENTER",
9296
9408
  "members": [
tccli/services/ess/v20201111/examples.json CHANGED
@@ -306,6 +306,12 @@
306
306
  "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowApprovers\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"FillApproverType\": 1,\n \"Approvers\": [\n {\n \"RecipientId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\",\n \"ApproverName\": \"典子谦\",\n \"ApproverIdCardType\": \"ID_CARD\",\n \"ApproverIdCardNumber\": \"620000198802020000\"\n }\n ]\n}",
307
307
  "output": "{\n \"Response\": {\n \"RequestId\": \"s1234345677xxxx\"\n }\n}",
308
308
  "title": "B2C签署，通过姓名和证件类型、证件号码补充已实名个人用户"
309
+ },
310
+ {
311
+ "document": "在B2C签署中，双方签署方未指定具体签署人时，需要进行补充。\n注:\n`1.补充动态签署人时FillApproverType传值为1 `\n`2.补充合同组动态签署人每个签署方都需指定FlowId`",
312
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowApprovers\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"FlowGroupId\": \"yDCVMUUckpwytlc2UE1RW1FSgWksaiI3\",\n \"FillApproverType\": 1,\n \"Approvers\": [\n {\n \"RecipientId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"OrganizationName\": \"***有限公司\",\n \"FlowId\": \"yDCVMUUckpwytlcrUE1RW1Fvnl52FPBB\"\n },\n {\n \"RecipientId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n \"ApproverName\": \"张三\",\n \"ApproverMobile\": \"18888888888\",\n \"FlowId\": \"yDCVMUUckpwytlc5UE1RW1FwLn7Hcn01\"\n }\n ]\n}",
313
+ "output": "{\n \"Response\": {\n \"RequestId\": \"s1234345677xxxx\"\n }\n}",
314
+ "title": "B2C签署，补充合同组动态签署人信息"
309
315
  }
310
316
  ],
311
317
  "CreateFlowByFiles": [
@@ -444,6 +450,12 @@
444
450
  "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}",
445
451
  "output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDwJ8UUckpk84plbUyPWcjISvuv6WMJx\",\n \"FlowIds\": [\n \"yDwJ8UUckpk84ploUyPWcjIS9KmiX55F\",\n \"yDwJ8UUckpk84plvUyPWcjIxKfGMJ9fF\",\n \"yDwJ8UUckpk84plaUyPWcjIvgnAvfS3H\"\n ],\n \"RequestId\": \"s1694572486923868447\"\n }\n}",
446
452
  "title": "通过主代子方式创建一个有3份子合同的合同组签署流程（B2B（含自动签署）、B2B、B2C）"
453
+ },
454
+ {
455
+ "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），可在发起后再进行补充。",
456
+ "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}",
457
+ "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}",
458
+ "title": "创建一个有3份子合同的合同组签署流程（B2B、B2B、B2C），指定每个子合同第一方为动态签署方"
447
459
  }
448
460
  ],
449
461
  "CreateFlowGroupByTemplates": [
@@ -470,6 +482,12 @@
470
482
  "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowGroupByTemplates\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"Agent\": {\n \"ProxyOrganizationId\": \"yDxbWUyKQDxgXVUuO5zjEB8mxCcDfAyF\"\n },\n \"FlowGroupName\": \"示例合同组-有2份子合同\",\n \"FlowGroupInfos\": [\n {\n \"TemplateId\": \"yDwXhUUckp7fs563UyNzLyWRHKWco8JV\",\n \"FlowName\": \"子合同1-B2C\",\n \"Components\": [\n {\n \"ComponentName\": \"单行文本\",\n \"ComponentValue\": \"单行文本测试\",\n \"ComponentType\": \"TEXT\",\n \"FileIndex\": 0,\n \"ComponentHeight\": 0,\n \"ComponentWidth\": 0,\n \"ComponentPage\": 0,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0\n }\n ],\n \"FlowDescription\": \"子合同1\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\"\n },\n {\n \"ApproverName\": \"张三\",\n \"ApproverType\": 1,\n \"ApproverMobile\": \"18888888888\"\n }\n ],\n \"Unordered\": true\n },\n {\n \"TemplateId\": \"yDwJ4UUckpk84g04UyPWcjIEMPGLGe2z\",\n \"FlowName\": \"子合同2\",\n \"FlowDescription\": \"子合同2-B2B\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\"\n },\n {\n \"ApproverName\": \"李四\",\n \"ApproverType\": 0,\n \"ApproverMobile\": \"15100000000\",\n \"OrganizationName\": \"李四示例企业\"\n }\n ],\n \"Unordered\": true\n }\n ]\n}",
471
483
  "output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDwJsUUckpkjwsrfUBBaFR824h9IGSYw\",\n \"FlowIds\": [\n \"yDwJqUUckpkjwsr9UBBaFR15mqRADZKl\",\n \"yDwJqUUckpkjwsr7UBBaFRRfDjTF595Z\"\n ],\n \"RequestId\": \"s1695759168343332980\"\n }\n}",
472
484
  "title": "集团主企业代子企业创建一个有两份子合同的合同组签署流程（B2B、B2C）"
485
+ },
486
+ {
487
+ "document": "1. 子合同1为B2C合同，Approvers中包含两个ApproverInfo元素，C端签署人ApproverType为1，企业签署人ApproverType为0\n\n2. 子合同1使用模板yDwXhUUckp7fs563UyNzLyWRHKWco8JV发起B端自动签署合同。需要确保在创建模板时，模板中已经指定了本企业的印章控件，否则合同发起将会失败。\n\n3. 子合同2为B2B合同，Approvers中包含两个ApproverInfo元素，企业签署人ApproverType为0。\n\n4.两份字合同指定一份为动态签署方（即不指定具体签署人，FillType=1），可在发起后再进行补充。",
488
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowGroupByTemplates\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"FlowGroupName\": \"示例合同组-有2份子合同\",\n \"FlowGroupInfos\": [\n {\n \"TemplateId\": \"yDwXhUUckp7fs563UyNzLyWRHKWco8JV\",\n \"FlowName\": \"子合同1-B2C\",\n \"Components\": [\n {\n \"ComponentName\": \"单行文本\",\n \"ComponentValue\": \"单行文本测试\",\n \"ComponentType\": \"TEXT\",\n \"FileIndex\": 0,\n \"ComponentHeight\": 0,\n \"ComponentWidth\": 0,\n \"ComponentPage\": 0,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0\n }\n ],\n \"FlowDescription\": \"子合同1\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverRoleName\": \"甲方\",\n \"ApproverOption\": {\n \"FillType\": 1\n }\n },\n {\n \"ApproverName\": \"张三\",\n \"ApproverType\": 1,\n \"ApproverMobile\": \"18888888888\",\n \"ApproverRoleName\": \"乙方\"\n }\n ],\n \"Unordered\": true\n },\n {\n \"TemplateId\": \"yDwJ5UUckpk84g04UyPWcjIEMPGLGe3z\",\n \"FlowName\": \"子合同2\",\n \"FlowDescription\": \"子合同2-B2B\",\n \"FlowType\": \"示例合同\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverRoleName\": \"甲方\",\n \"ApproverOption\": {\n \"FillType\": 1\n }\n },\n {\n \"ApproverName\": \"李四\",\n \"ApproverType\": 0,\n \"ApproverMobile\": \"15100000000\",\n \"OrganizationName\": \"李四示例企业\",\n \"ApproverRoleName\": \"乙方\"\n }\n ],\n \"Unordered\": true\n }\n ]\n}",
489
+ "output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"甲方\",\n \"RecipientId\": \"yDCVHUUckpwbqoyiUx2jLf4wRXKt9ZGp\",\n \"SignId\": \"yDCVHUUckpwbquhsUuyXGHSSbBKWsTXF\"\n },\n {\n \"ApproverRoleName\": \"乙方\",\n \"RecipientId\": \"yDCVHUUckpwbqoyeUx2jLf48NQhgRXND\",\n \"SignId\": \"yDCVHUUckpwbquh8UuyXGHSyoakAk3Fo\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbquh1UuyXGHSwzvgoRD2j\"\n },\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"甲方\",\n \"RecipientId\": \"yDCVHUUckpwbqoyiUx2jLf4wRXKt9ZGp\",\n \"SignId\": \"yDCVHUUckpwbquhjUuyXGHS1fHzeMsOc\"\n },\n {\n \"ApproverRoleName\": \"乙方\",\n \"RecipientId\": \"yDCVHUUckpwbqoyeUx2jLf48NQhgRXND\",\n \"SignId\": \"yDCVHUUckpwbquhhUuyXGHSuZutTpZ47\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbquhqUuyXGHSvjmlRJtKP\"\n }\n ],\n \"FlowGroupId\": \"yDCVHUUckpwbquh3UuyXGHSkeqSxHjw8\",\n \"FlowIds\": [\n \"yDCVHUUckpwbquh1UuyXGHSwzvgoRD2j\",\n \"yDCVHUUckpwbquhqUuyXGHSvjmlRJtKP\"\n ],\n \"RequestId\": \"s1711350937322945880\"\n }\n}",
490
+ "title": "创建一个有两份子合同的合同组签署流程（B2B、B2C），指定每个子合同第一方为动态签署方"
473
491
  }
474
492
  ],
475
493
  "CreateFlowGroupSignReview": [
@@ -840,8 +858,8 @@
840
858
  "title": "获取某个流程合同的签署链接(主代子)"
841
859
  },
842
860
  {
843
- "document": "获取动态签署人补充链接，创建合同时未指定具体签署人，可获取链接后推送给指定的人进行补充\n注：`获取动态签署人补充链接需指定PathType值为，即跳转到合同封面页，并且指定对应签署节点的签署角色编号即RecipientId`",
844
- "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSchemeUrl\n<公共请求参数>\n\n{\n \"FlowId\": \"yDwq7UU*Uu1vFD6uHSIyKQPf\",\n \"RecipientId\": \"yDw7aUUckpkxxmljUE0xkKk1DlvwRdfK\",\n \"PathType\": 3,\n \"Name\": \"典子谦\",\n \"Mobile\": \"13200000000\",\n \"EndPoint\": \"HTTP_SHORT_URL\",\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n }\n}",
861
+ "document": "获取动态签署人补充链接，创建合同时未指定具体签署人，可获取链接后推送给指定的人进行补充\n注：`获取动态签署人补充链接需指定PathType值为1或3，即跳转到合同封面页，并且指定对应签署节点的签署角色编号即RecipientId`",
862
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSchemeUrl\n<公共请求参数>\n\n{\n \"FlowId\": \"yDwq7UU*Uu1vFD6uHSIyKQPf\",\n \"RecipientId\": \"yDw7aUUckpkxxmljUE0xkKk1DlvwRdfK\",\n \"PathType\": 3,\n \"EndPoint\": \"HTTP_SHORT_URL\",\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n }\n}",
845
863
  "output": "{\n \"Response\": {\n \"RequestId\": \"s1693829642597082849\",\n \"SchemeQrcodeUrl\": \"https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06d01********************************f313b0728621415f3f14724c1d784e7737421333bf96a\",\n \"SchemeUrl\": \"https://essurl.cn/i3am**5Y9W\"\n }\n}",
846
864
  "title": "获取动态签署人补充链接（短链）"
847
865
  },
@@ -856,6 +874,12 @@
856
874
  "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSchemeUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"FlowId\": \"yDwq7UU*Uu1vFD6uHSIyKQPf\",\n \"EndPoint\": \"APP\",\n \"Name\": \"典子谦\",\n \"Mobile\": \"13200000000\"\n}",
857
875
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"OperationDenied.NoSupportJumpPage\",\n \"Message\": \"APP类型不支持跳转到电子签主页或合同列表页\"\n },\n \"RequestId\": \"s1693830251815551087\"\n }\n}",
858
876
  "title": "错误的示例- 获取某个流程合同的小程序跳转签署链接，PathType值没有传对（应该传1- 小程序合同详情）"
877
+ },
878
+ {
879
+ "document": "获取动态签署人补充链接，创建合同组时未指定具体签署人，可获取链接后推送给指定的人进行补充\n注：`获取动态签署人补充链接需指定PathType值为1或3，即跳转到合同封面页，并且指定对应签署节点的签署角色编号即RecipientId`",
880
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSchemeUrl\n<公共请求参数>\n\n{\n \"FlowGroupId\": \"yDwq7UUckpknjh4hUu1vFD6uHSIyKQPf\",\n \"FlowGroupUrlInfo\": {\n \"FlowGroupApproverInfos\": [\n {\n \"FlowId\": \"yDCVHUUckpwbquk8UuyXGHS86DkTCzfY\",\n \"RecipientId\": \"yDCVHUUckpwbqoyiUx2jLf4wRXKt9ZGp\"\n },\n {\n \"FlowId\": \"yDCVHUUckpwbquk2UuyXGHSuTPHxyR6u\",\n \"RecipientId\": \"yDCVHUUckpwbqoyeUx2jLf48NQhgRXND\"\n }\n ]\n },\n \"PathType\": 1,\n \"EndPoint\": \"HTTP_SHORT_URL\",\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n }\n}",
881
+ "output": "{\n \"Response\": {\n \"RequestId\": \"s1711335464242636975\",\n \"SchemeQrcodeUrl\": \"https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6******0a251eda6ea8b\",\n \"SchemeUrl\": \"https://test.essurl.cn/yG*****us\"\n }\n}",
882
+ "title": "获取合同组动态签署人的领取链接以及二维码"
859
883
  }
860
884
  ],
861
885
  "CreateSeal": [