tccli 3.0.1082.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.
- tccli/__init__.py +1 -1
- tccli/examples/cdb/v20170320/CreateCloneInstance.md +5 -5
- tccli/examples/ckafka/v20190819/DescribeGroupInfo.md +2 -2
- tccli/examples/ckafka/v20190819/ModifyAclRule.md +1 -1
- tccli/examples/ess/v20201111/CreateFlowApprovers.md +34 -0
- tccli/examples/ess/v20201111/CreateFlowGroupByFiles.md +168 -0
- tccli/examples/ess/v20201111/CreateFlowGroupByTemplates.md +98 -0
- tccli/examples/ess/v20201111/CreatePrepareFlow.md +4 -0
- tccli/examples/ess/v20201111/CreateSchemeUrl.md +31 -3
- tccli/examples/essbasic/v20210526/ChannelCreateFlowApprovers.md +41 -0
- tccli/examples/essbasic/v20210526/ChannelCreateFlowGroupByFiles.md +171 -0
- tccli/examples/essbasic/v20210526/ChannelCreateFlowGroupByTemplates.md +92 -0
- tccli/examples/essbasic/v20210526/CreateSignUrls.md +52 -0
- tccli/examples/faceid/v20180301/GetFaceIdRiskInfo.md +26 -0
- tccli/examples/faceid/v20180301/GetFaceidRiskInfoToken.md +22 -0
- tccli/examples/live/v20180801/CreateLiveTimeShiftTemplate.md +8 -8
- tccli/examples/wedata/v20210820/ModifyTaskInfo.md +79 -29
- tccli/services/apigateway/v20180808/api.json +1 -1
- tccli/services/cdb/v20170320/api.json +75 -21
- tccli/services/cdb/v20170320/examples.json +2 -2
- tccli/services/ckafka/v20190819/api.json +21 -20
- tccli/services/ckafka/v20190819/examples.json +2 -2
- tccli/services/clb/v20180317/api.json +1 -1
- tccli/services/cwp/v20180228/api.json +30 -20
- tccli/services/ess/v20201111/api.json +211 -12
- tccli/services/ess/v20201111/examples.json +30 -6
- tccli/services/essbasic/v20210526/api.json +121 -9
- tccli/services/essbasic/v20210526/examples.json +24 -0
- tccli/services/faceid/faceid_client.py +136 -30
- tccli/services/faceid/v20180301/api.json +157 -1
- tccli/services/faceid/v20180301/examples.json +16 -0
- tccli/services/gaap/v20180529/api.json +76 -36
- tccli/services/live/v20180801/api.json +1 -1
- tccli/services/live/v20180801/examples.json +2 -2
- tccli/services/oceanus/v20190422/api.json +1 -1
- tccli/services/wedata/v20210820/api.json +29 -2
- tccli/services/wedata/v20210820/examples.json +8 -2
- {tccli-3.0.1082.1.dist-info → tccli-3.0.1084.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1082.1.dist-info → tccli-3.0.1084.1.dist-info}/RECORD +42 -40
- {tccli-3.0.1082.1.dist-info → tccli-3.0.1084.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1082.1.dist-info → tccli-3.0.1084.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1082.1.dist-info → tccli-3.0.1084.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -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\n\n注：\n1.<font color=\"red\">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）\n\n2.<font color=\"red\"
|
|
494
|
+
"document": "此接口用于启动流程。它是模板发起合同的最后一步。\n在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。\n\n\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":
|
|
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":
|
|
655
|
+
"required": false,
|
|
656
656
|
"type": "string"
|
|
657
657
|
},
|
|
658
658
|
{
|
|
@@ -895,6 +895,15 @@
|
|
|
895
895
|
"required": false,
|
|
896
896
|
"type": "bool"
|
|
897
897
|
},
|
|
898
|
+
{
|
|
899
|
+
"disabled": false,
|
|
900
|
+
"document": "允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑",
|
|
901
|
+
"example": "true",
|
|
902
|
+
"member": "bool",
|
|
903
|
+
"name": "CanEditApprover",
|
|
904
|
+
"required": false,
|
|
905
|
+
"type": "bool"
|
|
906
|
+
},
|
|
898
907
|
{
|
|
899
908
|
"disabled": false,
|
|
900
909
|
"document": "签署人信息补充类型，默认无需补充。\n\n<ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li>\n</ul>",
|
|
@@ -2635,15 +2644,6 @@
|
|
|
2635
2644
|
"required": true,
|
|
2636
2645
|
"type": "object"
|
|
2637
2646
|
},
|
|
2638
|
-
{
|
|
2639
|
-
"disabled": false,
|
|
2640
|
-
"document": "合同流程ID，为32位字符串。\n建议开发者妥善保存此流程ID，以便于顺利进行后续操作。\n可登录腾讯电子签控制台，在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
|
|
2641
|
-
"example": "无",
|
|
2642
|
-
"member": "string",
|
|
2643
|
-
"name": "FlowId",
|
|
2644
|
-
"required": true,
|
|
2645
|
-
"type": "string"
|
|
2646
|
-
},
|
|
2647
2647
|
{
|
|
2648
2648
|
"disabled": false,
|
|
2649
2649
|
"document": "补充企业签署人信息。\n\n- 如果发起方指定的补充签署人是企业微信签署人（ApproverSource=WEWORKAPP），则需要提供企业微信UserId进行补充；\n\n- 如果不指定，则使用姓名和手机号进行补充。",
|
|
@@ -2653,6 +2653,15 @@
|
|
|
2653
2653
|
"required": true,
|
|
2654
2654
|
"type": "list"
|
|
2655
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
|
+
},
|
|
2656
2665
|
{
|
|
2657
2666
|
"disabled": false,
|
|
2658
2667
|
"document": "签署人信息补充方式\n\n<ul><li>**0**: 添加或签人候选人，或签支持一个节点传多个签署人，不传值默认或签。\n注: `或签只支持企业签署方`</li>\n<li>**1**: 表示往未指定签署人的节点，添加一个明确的签署人，支持企业或个人签署方。</li></ul>",
|
|
@@ -2679,6 +2688,15 @@
|
|
|
2679
2688
|
"name": "Agent",
|
|
2680
2689
|
"required": false,
|
|
2681
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"
|
|
2682
2700
|
}
|
|
2683
2701
|
],
|
|
2684
2702
|
"type": "object"
|
|
@@ -3100,6 +3118,16 @@
|
|
|
3100
3118
|
"type": "list",
|
|
3101
3119
|
"value_allowed_null": true
|
|
3102
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
|
+
},
|
|
3103
3131
|
{
|
|
3104
3132
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
3105
3133
|
"member": "string",
|
|
@@ -3183,6 +3211,16 @@
|
|
|
3183
3211
|
"type": "list",
|
|
3184
3212
|
"value_allowed_null": true
|
|
3185
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
|
+
},
|
|
3186
3224
|
{
|
|
3187
3225
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
3188
3226
|
"member": "string",
|
|
@@ -3347,6 +3385,51 @@
|
|
|
3347
3385
|
"name": "CustomCreateFlowDescription",
|
|
3348
3386
|
"required": false,
|
|
3349
3387
|
"type": "string"
|
|
3388
|
+
},
|
|
3389
|
+
{
|
|
3390
|
+
"disabled": false,
|
|
3391
|
+
"document": " 禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”\n",
|
|
3392
|
+
"example": "无",
|
|
3393
|
+
"member": "string",
|
|
3394
|
+
"name": "ForbidAddApprover",
|
|
3395
|
+
"required": false,
|
|
3396
|
+
"type": "string"
|
|
3397
|
+
},
|
|
3398
|
+
{
|
|
3399
|
+
"disabled": false,
|
|
3400
|
+
"document": " 禁止设置设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板\n",
|
|
3401
|
+
"example": "无",
|
|
3402
|
+
"member": "string",
|
|
3403
|
+
"name": "ForbidEditFlowProperties",
|
|
3404
|
+
"required": false,
|
|
3405
|
+
"type": "string"
|
|
3406
|
+
},
|
|
3407
|
+
{
|
|
3408
|
+
"disabled": false,
|
|
3409
|
+
"document": "在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数 只能二选一使用，具体的控件类型如下\n<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>\n<li>SIGN_SEAL : 企业印章</li>\n<li>SIGN_PAGING_SEAL : 骑缝章</li>\n<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>\n<li>SIGN_APPROVE : 签批</li>\n<li>SIGN_OPINION : 签署意见</li>\n<li>BUSI-FULL-NAME : 企业全称</li>\n<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>\n<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>\n<li>PERSONAL-NAME : 签署人姓名</li>\n<li>PERSONAL-MOBILE : 签署人手机号</li>\n<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>\n<li>PERSONAL-IDCARD : 签署人证件号</li>\n<li>TEXT : 单行文本</li>\n<li>MULTI_LINE_TEXT : 多行文本</li>\n<li>CHECK_BOX : 勾选框</li>\n<li>SELECTOR : 选择器</li>\n<li>DIGIT : 数字</li>\n<li>DATE : 日期</li>\n<li>FILL_IMAGE : 图片</li>\n<li>ATTACHMENT : 附件</li>\n<li>EMAIL : 邮箱</li>\n<li>LOCATION : 地址</li>\n<li>EDUCATION : 学历</li>\n<li>GENDER : 性别</li>\n<li>DISTRICT : 省市区</li></ul>",
|
|
3410
|
+
"example": "无",
|
|
3411
|
+
"member": "string",
|
|
3412
|
+
"name": "HideComponentTypes",
|
|
3413
|
+
"required": false,
|
|
3414
|
+
"type": "list"
|
|
3415
|
+
},
|
|
3416
|
+
{
|
|
3417
|
+
"disabled": false,
|
|
3418
|
+
"document": "在发起流程的可嵌入页面要显示的控件列表，和 HideComponentTypes 参数 只能二选一使用，具体的控件类型如下\n<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>\n<li>SIGN_SEAL : 企业印章</li>\n<li>SIGN_PAGING_SEAL : 骑缝章</li>\n<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>\n<li>SIGN_APPROVE : 签批</li>\n<li>SIGN_OPINION : 签署意见</li>\n<li>BUSI-FULL-NAME : 企业全称</li>\n<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>\n<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>\n<li>PERSONAL-NAME : 签署人姓名</li>\n<li>PERSONAL-MOBILE : 签署人手机号</li>\n<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>\n<li>PERSONAL-IDCARD : 签署人证件号</li>\n<li>TEXT : 单行文本</li>\n<li>MULTI_LINE_TEXT : 多行文本</li>\n<li>CHECK_BOX : 勾选框</li>\n<li>SELECTOR : 选择器</li>\n<li>DIGIT : 数字</li>\n<li>DATE : 日期</li>\n<li>FILL_IMAGE : 图片</li>\n<li>ATTACHMENT : 附件</li>\n<li>EMAIL : 邮箱</li>\n<li>LOCATION : 地址</li>\n<li>EDUCATION : 学历</li>\n<li>GENDER : 性别</li>\n<li>DISTRICT : 省市区</li></ul>",
|
|
3419
|
+
"example": "无",
|
|
3420
|
+
"member": "string",
|
|
3421
|
+
"name": "ShowComponentTypes",
|
|
3422
|
+
"required": false,
|
|
3423
|
+
"type": "list"
|
|
3424
|
+
},
|
|
3425
|
+
{
|
|
3426
|
+
"disabled": false,
|
|
3427
|
+
"document": "发起流程的可嵌入页面结果页配置",
|
|
3428
|
+
"example": "无",
|
|
3429
|
+
"member": "CreateResultPageConfig",
|
|
3430
|
+
"name": "ResultPageConfig",
|
|
3431
|
+
"required": false,
|
|
3432
|
+
"type": "list"
|
|
3350
3433
|
}
|
|
3351
3434
|
],
|
|
3352
3435
|
"usage": "in"
|
|
@@ -4975,6 +5058,39 @@
|
|
|
4975
5058
|
],
|
|
4976
5059
|
"type": "object"
|
|
4977
5060
|
},
|
|
5061
|
+
"CreateResultPageConfig": {
|
|
5062
|
+
"document": "发起流程的可嵌入页面操作结果页配置",
|
|
5063
|
+
"members": [
|
|
5064
|
+
{
|
|
5065
|
+
"disabled": false,
|
|
5066
|
+
"document": "<ul>\n <li>0 : 发起审批成功页面（通过接口<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/CreatePrepareFlow/\" target=\"_blank\">创建发起流程web页面</a>发起时设置了NeedCreateReview参数为true）</li>\n</ul>",
|
|
5067
|
+
"example": "无",
|
|
5068
|
+
"member": "int64",
|
|
5069
|
+
"name": "Type",
|
|
5070
|
+
"required": true,
|
|
5071
|
+
"type": "int"
|
|
5072
|
+
},
|
|
5073
|
+
{
|
|
5074
|
+
"disabled": false,
|
|
5075
|
+
"document": "结果页标题，不超过50字",
|
|
5076
|
+
"example": "无",
|
|
5077
|
+
"member": "string",
|
|
5078
|
+
"name": "Title",
|
|
5079
|
+
"required": true,
|
|
5080
|
+
"type": "string"
|
|
5081
|
+
},
|
|
5082
|
+
{
|
|
5083
|
+
"disabled": false,
|
|
5084
|
+
"document": "结果页描述，不超过200字",
|
|
5085
|
+
"example": "无",
|
|
5086
|
+
"member": "string",
|
|
5087
|
+
"name": "Description",
|
|
5088
|
+
"required": false,
|
|
5089
|
+
"type": "string"
|
|
5090
|
+
}
|
|
5091
|
+
],
|
|
5092
|
+
"usage": "in"
|
|
5093
|
+
},
|
|
4978
5094
|
"CreateSchemeUrlRequest": {
|
|
4979
5095
|
"document": "CreateSchemeUrl请求参数结构体",
|
|
4980
5096
|
"members": [
|
|
@@ -5103,6 +5219,15 @@
|
|
|
5103
5219
|
"name": "RecipientId",
|
|
5104
5220
|
"required": false,
|
|
5105
5221
|
"type": "string"
|
|
5222
|
+
},
|
|
5223
|
+
{
|
|
5224
|
+
"disabled": false,
|
|
5225
|
+
"document": "合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。",
|
|
5226
|
+
"example": "无",
|
|
5227
|
+
"member": "FlowGroupUrlInfo",
|
|
5228
|
+
"name": "FlowGroupUrlInfo",
|
|
5229
|
+
"required": false,
|
|
5230
|
+
"type": "object"
|
|
5106
5231
|
}
|
|
5107
5232
|
],
|
|
5108
5233
|
"type": "object"
|
|
@@ -8254,6 +8379,15 @@
|
|
|
8254
8379
|
"name": "ApproverIdCardNumber",
|
|
8255
8380
|
"required": false,
|
|
8256
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"
|
|
8257
8391
|
}
|
|
8258
8392
|
],
|
|
8259
8393
|
"usage": "in"
|
|
@@ -9048,6 +9182,56 @@
|
|
|
9048
9182
|
],
|
|
9049
9183
|
"usage": "out"
|
|
9050
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
|
+
},
|
|
9051
9235
|
"FlowGroupInfo": {
|
|
9052
9236
|
"document": "此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息",
|
|
9053
9237
|
"members": [
|
|
@@ -9204,6 +9388,21 @@
|
|
|
9204
9388
|
],
|
|
9205
9389
|
"usage": "in"
|
|
9206
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
|
+
},
|
|
9207
9406
|
"FormField": {
|
|
9208
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",
|
|
9209
9408
|
"members": [
|
|
@@ -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": [
|
|
@@ -739,25 +757,25 @@
|
|
|
739
757
|
"CreatePrepareFlow": [
|
|
740
758
|
{
|
|
741
759
|
"document": "通过文件发起，无序，b2c，开启智能填写区",
|
|
742
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRSsUxxxxxxxxxxxxxxxxxLdSu\"\n },\n \"Unordered\": true,\n \"IntelligentStatus\": \"OPEN\",\n \"FlowName\": \"文件发起-嵌入式合同\",\n \"Deadline\": 1791859333,\n \"ResourceId\": \"yDR0xxxxxxxxxxxxxxxxxxxEYm\",\n \"ResourceType\": 2,\n \"UserFlowTypeId\": \"\",\n \"FlowType\": \"嵌入式文件发起合同\",\n \"UserData\": \"\",\n \"FlowId\": \"\",\n \"InitiatorComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 760,\n \"ComponentHeight\": 30,\n \"ComponentWidth\": 300,\n \"FileIndex\": 0,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"这是发起填写控件{{ @now }}\",\n \"LockComponentValue\": true,\n \"ForbidMoveAndDelete\": true,\n \"ComponentRequired\": true,\n \"ComponentPage\": 1\n }\n ],\n \"FlowOption\": {\n \"CanEditFlow\": false,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": true,\n \"HideShowFlowType\": true,\n \"HideShowDeadline\": true,\n \"CanSkipAddApprover\": true,\n \"SkipUploadFile\": true,\n \"ForbidEditFillComponent\": true,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"ApproverOption\": {\n \"NoRefuse\": true,\n \"NoTransfer\": true\n },\n \"ApproverVerifyTypes\": [\n 1,\n 2\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ],\n \"Components\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 560,\n \"ComponentHeight\": 30,\n \"ComponentWidth\": 300,\n \"FileIndex\": 0,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"这是第一个签署人的填写控件{{ @now }}\",\n \"LockComponentValue\": true,\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 360,\n \"ComponentHeight\": 100,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ForbidMoveAndDelete\": true,\n \"ComponentValue\": \"\",\n \"LockComponentValue\": true,\n \"ComponentPage\": 1\n }\n ],\n \"IsFullText\": true\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000001\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"Components\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 660,\n \"ComponentHeight\": 30,\n \"ComponentWidth\": 300,\n \"FileIndex\": 0,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"这是第二个签署人的填写控件\",\n \"LockComponentValue\": true,\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"IsFullText\": true\n }\n ]\n}",
|
|
760
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRSsUxxxxxxxxxxxxxxxxxLdSu\"\n },\n \"Unordered\": true,\n \"IntelligentStatus\": \"OPEN\",\n \"FlowName\": \"文件发起-嵌入式合同\",\n \"Deadline\": 1791859333,\n \"ResourceId\": \"yDR0xxxxxxxxxxxxxxxxxxxEYm\",\n \"ResourceType\": 2,\n \"UserFlowTypeId\": \"\",\n \"FlowType\": \"嵌入式文件发起合同\",\n \"UserData\": \"\",\n \"FlowId\": \"\",\n \"InitiatorComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 760,\n \"ComponentHeight\": 30,\n \"ComponentWidth\": 300,\n \"FileIndex\": 0,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"这是发起填写控件{{ @now }}\",\n \"LockComponentValue\": true,\n \"ForbidMoveAndDelete\": true,\n \"ComponentRequired\": true,\n \"ComponentPage\": 1\n }\n ],\n \"FlowOption\": {\n \"CanEditFlow\": false,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": true,\n \"HideShowFlowType\": true,\n \"HideShowDeadline\": true,\n \"CanSkipAddApprover\": true,\n \"SkipUploadFile\": true,\n \"ForbidEditFillComponent\": true,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"ApproverOption\": {\n \"NoRefuse\": true,\n \"NoTransfer\": true,\n \"CanEditApprover\": true\n },\n \"ApproverVerifyTypes\": [\n 1,\n 2\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ],\n \"Components\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 560,\n \"ComponentHeight\": 30,\n \"ComponentWidth\": 300,\n \"FileIndex\": 0,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"这是第一个签署人的填写控件{{ @now }}\",\n \"LockComponentValue\": true,\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 360,\n \"ComponentHeight\": 100,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ForbidMoveAndDelete\": true,\n \"ComponentValue\": \"\",\n \"LockComponentValue\": true,\n \"ComponentPage\": 1\n }\n ],\n \"IsFullText\": true\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000001\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"Components\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 660,\n \"ComponentHeight\": 30,\n \"ComponentWidth\": 300,\n \"FileIndex\": 0,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"这是第二个签署人的填写控件\",\n \"LockComponentValue\": true,\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"IsFullText\": true\n }\n ]\n}",
|
|
743
761
|
"output": "{\n \"Response\": {\n \"RequestId\": \"s1692004929990936987\",\n \"Url\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1692005230&code=yDwqmxxxxxxxxxxxxxKaLJfQEGm&businessId=yDwqmUUxxxxxxxxxDAgN4fKi&channel=TENCENTCLOUD&operateSource=byFile&themeId=saas_web_theme_732aaefa78c439d726f541b89c49e022\"\n }\n}",
|
|
744
762
|
"title": "创建签署流程"
|
|
745
763
|
},
|
|
746
764
|
{
|
|
747
765
|
"document": "",
|
|
748
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRSsUxxxxxxxxxxxxxxxxxLdSu\"\n },\n \"Unordered\": true,\n \"IntelligentStatus\": \"OPEN\",\n \"FlowName\": \"文件发起-嵌入式合同\",\n \"Deadline\": 1791859333,\n \"ResourceId\": \"\",\n \"ResourceType\": 2,\n \"UserFlowTypeId\": \"\",\n \"FlowType\": \"嵌入式文件发起合同\",\n \"UserData\": \"\",\n \"FlowId\": \"\",\n \"FlowOption\": {\n \"CanEditFlow\": false,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": true,\n \"HideShowFlowType\": true,\n \"HideShowDeadline\": true,\n \"CanSkipAddApprover\": true,\n \"SkipUploadFile\": true,\n \"ForbidEditFillComponent\": true,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"ApproverOption\": {\n \"NoRefuse\": true,\n \"NoTransfer\": true\n },\n \"ApproverVerifyTypes\": [\n 1,\n 2\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ],\n \"Components\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 560,\n \"ComponentHeight\": 30,\n \"ComponentWidth\": 300,\n \"FileIndex\": 0,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"这是第一个签署人的填写控件{{ @now }}\",\n \"LockComponentValue\": true,\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 360,\n \"ComponentHeight\": 100,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ForbidMoveAndDelete\": true,\n \"ComponentValue\": \"\",\n \"LockComponentValue\": true,\n \"ComponentPage\": 1\n }\n ],\n \"IsFullText\": true\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000001\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"Components\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 660,\n \"ComponentHeight\": 30,\n \"ComponentWidth\": 300,\n \"FileIndex\": 0,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"这是第二个签署人的填写控件\",\n \"LockComponentValue\": true,\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"IsFullText\": true\n }\n ]\n}",
|
|
766
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRSsUxxxxxxxxxxxxxxxxxLdSu\"\n },\n \"Unordered\": true,\n \"IntelligentStatus\": \"OPEN\",\n \"FlowName\": \"文件发起-嵌入式合同\",\n \"Deadline\": 1791859333,\n \"ResourceId\": \"\",\n \"ResourceType\": 2,\n \"UserFlowTypeId\": \"\",\n \"FlowType\": \"嵌入式文件发起合同\",\n \"UserData\": \"\",\n \"FlowId\": \"\",\n \"FlowOption\": {\n \"CanEditFlow\": false,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": true,\n \"HideShowFlowType\": true,\n \"HideShowDeadline\": true,\n \"CanSkipAddApprover\": true,\n \"SkipUploadFile\": true,\n \"ForbidEditFillComponent\": true,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"ApproverOption\": {\n \"NoRefuse\": true,\n \"NoTransfer\": true,\n \"CanEditApprover\": true\n },\n \"ApproverVerifyTypes\": [\n 1,\n 2\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ],\n \"Components\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 560,\n \"ComponentHeight\": 30,\n \"ComponentWidth\": 300,\n \"FileIndex\": 0,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"这是第一个签署人的填写控件{{ @now }}\",\n \"LockComponentValue\": true,\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 360,\n \"ComponentHeight\": 100,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ForbidMoveAndDelete\": true,\n \"ComponentValue\": \"\",\n \"LockComponentValue\": true,\n \"ComponentPage\": 1\n }\n ],\n \"IsFullText\": true\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000001\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"Components\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 660,\n \"ComponentHeight\": 30,\n \"ComponentWidth\": 300,\n \"FileIndex\": 0,\n \"ComponentType\": \"TEXT\",\n \"ComponentValue\": \"这是第二个签署人的填写控件\",\n \"LockComponentValue\": true,\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ForbidMoveAndDelete\": true,\n \"ComponentPage\": 1\n }\n ],\n \"IsFullText\": true\n }\n ]\n}",
|
|
749
767
|
"output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue\",\n \"Message\": \"请指定文件类型的资源id\"\n },\n \"RequestId\": \"s1694764534616690016\"\n }\n}",
|
|
750
768
|
"title": "文件发起，设置跳过上传文件，必须要传资源id"
|
|
751
769
|
},
|
|
752
770
|
{
|
|
753
771
|
"document": "模板发起，b2c",
|
|
754
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRSsUxxxxxxxxxxxxxxxxxLdSu\"\n },\n \"Unordered\": true,\n \"IntelligentStatus\": \"open\",\n \"FlowName\": \"模板发起-嵌入式合同\",\n \"Deadline\": 1991859333,\n \"ResourceId\": \"yDwXXUUckxxxxxxxxxx4S7NM8r\",\n \"ResourceType\": 1,\n \"UserFlowTypeId\": \"\",\n \"FlowType\": \"\",\n \"UserData\": \"\",\n \"FlowOption\": {\n \"CanEditFlow\": false,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": true,\n \"HideShowFlowType\": true,\n \"HideShowDeadline\": true,\n \"CanSkipAddApprover\": true,\n \"SkipUploadFile\": true,\n \"ForbidEditFillComponent\": true,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"RecipientId\": \"yDwXXxxxxxxxxxxxxxxOZbdgN6\",\n \"ApproverOption\": {\n \"NoRefuse\": true,\n \"NoTransfer\": true\n },\n \"ApproverVerifyTypes\": [\n 1,\n 2\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ],\n \"IsFullText\": true\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000001\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"RecipientId\": \"yDwXXUUxxxxxxxxxxxxxxO1XEwdCTnI\",\n \"IsFullText\": true\n }\n ]\n}",
|
|
772
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRSsUxxxxxxxxxxxxxxxxxLdSu\"\n },\n \"Unordered\": true,\n \"IntelligentStatus\": \"open\",\n \"FlowName\": \"模板发起-嵌入式合同\",\n \"Deadline\": 1991859333,\n \"ResourceId\": \"yDwXXUUckxxxxxxxxxx4S7NM8r\",\n \"ResourceType\": 1,\n \"UserFlowTypeId\": \"\",\n \"FlowType\": \"\",\n \"UserData\": \"\",\n \"FlowOption\": {\n \"CanEditFlow\": false,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": true,\n \"HideShowFlowType\": true,\n \"HideShowDeadline\": true,\n \"CanSkipAddApprover\": true,\n \"SkipUploadFile\": true,\n \"ForbidEditFillComponent\": true,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"RecipientId\": \"yDwXXxxxxxxxxxxxxxxOZbdgN6\",\n \"ApproverOption\": {\n \"NoRefuse\": true,\n \"NoTransfer\": true,\n \"CanEditApprover\": true\n },\n \"ApproverVerifyTypes\": [\n 1,\n 2\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ],\n \"IsFullText\": true\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000001\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"RecipientId\": \"yDwXXUUxxxxxxxxxxxxxxO1XEwdCTnI\",\n \"IsFullText\": true\n }\n ]\n}",
|
|
755
773
|
"output": "{\n \"Response\": {\n \"RequestId\": \"s1692004929990936987\",\n \"Url\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1692005230&code=yDwqmxxxxxxxxxxxxxKaLJfQEGm&businessId=yDwqmUUxxxxxxxxxDAgN4fKi&channel=TENCENTCLOUD&operateSource=byFile&themeId=saas_web_theme_732aaefa78c439d726f541b89c49e022\"\n }\n}",
|
|
756
774
|
"title": "通过模板发起嵌入式url"
|
|
757
775
|
},
|
|
758
776
|
{
|
|
759
777
|
"document": "",
|
|
760
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRSsUxxxxxxxxxxxxxxxxxLdSu\"\n },\n \"Unordered\": true,\n \"IntelligentStatus\": \"open\",\n \"FlowName\": \"模板发起-嵌入式合同\",\n \"Deadline\": 1991859333,\n \"ResourceId\": \"yDwXXUUckxxxxxxxxxx4S7NM8r\",\n \"ResourceType\": 1,\n \"NeedCreateReview\": true,\n \"FlowType\": \"\",\n \"UserData\": \"\",\n \"FlowOption\": {\n \"CanEditFlow\": false,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": true,\n \"HideShowFlowType\": true,\n \"HideShowDeadline\": true,\n \"CanSkipAddApprover\": true,\n \"SkipUploadFile\": true,\n \"ForbidEditFillComponent\": true,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"RecipientId\": \"yDwXXxxxxxxxxxxxxxxOZbdgN6\",\n \"ApproverOption\": {\n \"NoRefuse\": true,\n \"NoTransfer\": true\n },\n \"ApproverVerifyTypes\": [\n 1,\n 2\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ],\n \"IsFullText\": true\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000001\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"RecipientId\": \"yDwXXUUxxxxxxxxxxxxxxO1XEwdCTnI\",\n \"IsFullText\": true\n }\n ]\n}",
|
|
778
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRSsUxxxxxxxxxxxxxxxxxLdSu\"\n },\n \"Unordered\": true,\n \"IntelligentStatus\": \"open\",\n \"FlowName\": \"模板发起-嵌入式合同\",\n \"Deadline\": 1991859333,\n \"ResourceId\": \"yDwXXUUckxxxxxxxxxx4S7NM8r\",\n \"ResourceType\": 1,\n \"NeedCreateReview\": true,\n \"FlowType\": \"\",\n \"UserData\": \"\",\n \"FlowOption\": {\n \"CanEditFlow\": false,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": true,\n \"HideShowFlowType\": true,\n \"HideShowDeadline\": true,\n \"CanSkipAddApprover\": true,\n \"SkipUploadFile\": true,\n \"ForbidEditFillComponent\": true,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"RecipientId\": \"yDwXXxxxxxxxxxxxxxxOZbdgN6\",\n \"ApproverOption\": {\n \"NoRefuse\": true,\n \"NoTransfer\": true,\n \"CanEditApprover\": true\n },\n \"ApproverVerifyTypes\": [\n 1,\n 2\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ],\n \"IsFullText\": true\n },\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"典子谦示例企业\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000001\",\n \"PreReadTime\": 3,\n \"Required\": true,\n \"RecipientId\": \"yDwXXUUxxxxxxxxxxxxxxO1XEwdCTnI\",\n \"IsFullText\": true\n }\n ]\n}",
|
|
761
779
|
"output": "{\n \"Response\": {\n \"RequestId\": \"s1692004929990936987\",\n \"Url\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1692005230&code=yDwqmxxxxxxxxxxxxxKaLJfQEGm&businessId=yDwqmUUxxxxxxxxxDAgN4fKi&channel=TENCENTCLOUD&operateSource=byFile&themeId=saas_web_theme_732aaefa78c439d726f541b89c49e022\"\n }\n}",
|
|
762
780
|
"title": "通过模板发起待签署审核"
|
|
763
781
|
}
|
|
@@ -840,8 +858,8 @@
|
|
|
840
858
|
"title": "获取某个流程合同的签署链接(主代子)"
|
|
841
859
|
},
|
|
842
860
|
{
|
|
843
|
-
"document": "获取动态签署人补充链接，创建合同时未指定具体签署人，可获取链接后推送给指定的人进行补充\n注：`获取动态签署人补充链接需指定PathType
|
|
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 \"
|
|
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": [
|