tccli 3.0.1083.1__py2.py3-none-any.whl → 3.0.1084.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/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/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/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/ess/v20201111/api.json +124 -12
- tccli/services/ess/v20201111/examples.json +26 -2
- 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 +147 -0
- tccli/services/faceid/v20180301/examples.json +16 -0
- 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.1083.1.dist-info → tccli-3.0.1084.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1083.1.dist-info → tccli-3.0.1084.1.dist-info}/RECORD +37 -35
- {tccli-3.0.1083.1.dist-info → tccli-3.0.1084.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1083.1.dist-info → tccli-3.0.1084.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1083.1.dist-info → tccli-3.0.1084.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -2001,15 +2001,6 @@
|
|
|
2001
2001
|
"required": true,
|
|
2002
2002
|
"type": "object"
|
|
2003
2003
|
},
|
|
2004
|
-
{
|
|
2005
|
-
"disabled": false,
|
|
2006
|
-
"document": "合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
|
|
2007
|
-
"example": "无",
|
|
2008
|
-
"member": "string",
|
|
2009
|
-
"name": "FlowId",
|
|
2010
|
-
"required": true,
|
|
2011
|
-
"type": "string"
|
|
2012
|
-
},
|
|
2013
2004
|
{
|
|
2014
2005
|
"disabled": false,
|
|
2015
2006
|
"document": "补充企业签署人信息。\n\n- 如果发起方指定的补充签署人是企业签署人，则需要提供企业名称或者企业OpenId；\n\n- 如果不指定，则使用姓名和手机号进行补充。",
|
|
@@ -2019,6 +2010,15 @@
|
|
|
2019
2010
|
"required": true,
|
|
2020
2011
|
"type": "list"
|
|
2021
2012
|
},
|
|
2013
|
+
{
|
|
2014
|
+
"disabled": false,
|
|
2015
|
+
"document": "合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
|
|
2016
|
+
"example": "无",
|
|
2017
|
+
"member": "string",
|
|
2018
|
+
"name": "FlowId",
|
|
2019
|
+
"required": false,
|
|
2020
|
+
"type": "string"
|
|
2021
|
+
},
|
|
2022
2022
|
{
|
|
2023
2023
|
"disabled": false,
|
|
2024
2024
|
"document": "签署人信息补充方式\n\n<ul><li>**1**: 表示往未指定签署人的节点，添加一个明确的签署人，支持企业或个人签署方。</li></ul>",
|
|
@@ -2036,6 +2036,15 @@
|
|
|
2036
2036
|
"name": "Operator",
|
|
2037
2037
|
"required": false,
|
|
2038
2038
|
"type": "object"
|
|
2039
|
+
},
|
|
2040
|
+
{
|
|
2041
|
+
"disabled": false,
|
|
2042
|
+
"document": "合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值",
|
|
2043
|
+
"example": "yDR1AUUgygjazuesUuO4zjESPW4PkfNi",
|
|
2044
|
+
"member": "string",
|
|
2045
|
+
"name": "FlowGroupId",
|
|
2046
|
+
"required": false,
|
|
2047
|
+
"type": "string"
|
|
2039
2048
|
}
|
|
2040
2049
|
],
|
|
2041
2050
|
"type": "object"
|
|
@@ -2354,6 +2363,16 @@
|
|
|
2354
2363
|
"type": "list",
|
|
2355
2364
|
"value_allowed_null": true
|
|
2356
2365
|
},
|
|
2366
|
+
{
|
|
2367
|
+
"disabled": false,
|
|
2368
|
+
"document": "合同组签署方信息。",
|
|
2369
|
+
"example": "无",
|
|
2370
|
+
"member": "FlowGroupApprovers",
|
|
2371
|
+
"name": "Approvers",
|
|
2372
|
+
"output_required": false,
|
|
2373
|
+
"type": "list",
|
|
2374
|
+
"value_allowed_null": false
|
|
2375
|
+
},
|
|
2357
2376
|
{
|
|
2358
2377
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
2359
2378
|
"member": "string",
|
|
@@ -2429,6 +2448,16 @@
|
|
|
2429
2448
|
"type": "list",
|
|
2430
2449
|
"value_allowed_null": false
|
|
2431
2450
|
},
|
|
2451
|
+
{
|
|
2452
|
+
"disabled": false,
|
|
2453
|
+
"document": "合同组签署方信息",
|
|
2454
|
+
"example": "无",
|
|
2455
|
+
"member": "FlowGroupApprovers",
|
|
2456
|
+
"name": "Approvers",
|
|
2457
|
+
"output_required": false,
|
|
2458
|
+
"type": "list",
|
|
2459
|
+
"value_allowed_null": false
|
|
2460
|
+
},
|
|
2432
2461
|
{
|
|
2433
2462
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
2434
2463
|
"member": "string",
|
|
@@ -6728,6 +6757,15 @@
|
|
|
6728
6757
|
"name": "RecipientIds",
|
|
6729
6758
|
"required": false,
|
|
6730
6759
|
"type": "list"
|
|
6760
|
+
},
|
|
6761
|
+
{
|
|
6762
|
+
"disabled": false,
|
|
6763
|
+
"document": "合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。",
|
|
6764
|
+
"example": "无",
|
|
6765
|
+
"member": "FlowGroupUrlInfo",
|
|
6766
|
+
"name": "FlowGroupUrlInfo",
|
|
6767
|
+
"required": false,
|
|
6768
|
+
"type": "object"
|
|
6731
6769
|
}
|
|
6732
6770
|
],
|
|
6733
6771
|
"type": "object"
|
|
@@ -7888,6 +7926,15 @@
|
|
|
7888
7926
|
"name": "ApproverIdCardNumber",
|
|
7889
7927
|
"required": false,
|
|
7890
7928
|
"type": "string"
|
|
7929
|
+
},
|
|
7930
|
+
{
|
|
7931
|
+
"disabled": false,
|
|
7932
|
+
"document": "合同流程ID，补充合同组子合同动态签署人时必传。",
|
|
7933
|
+
"example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
|
|
7934
|
+
"member": "string",
|
|
7935
|
+
"name": "FlowId",
|
|
7936
|
+
"required": false,
|
|
7937
|
+
"type": "string"
|
|
7891
7938
|
}
|
|
7892
7939
|
],
|
|
7893
7940
|
"usage": "in"
|
|
@@ -8687,6 +8734,56 @@
|
|
|
8687
8734
|
],
|
|
8688
8735
|
"usage": "in"
|
|
8689
8736
|
},
|
|
8737
|
+
"FlowGroupApproverInfo": {
|
|
8738
|
+
"document": "合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。",
|
|
8739
|
+
"members": [
|
|
8740
|
+
{
|
|
8741
|
+
"disabled": false,
|
|
8742
|
+
"document": "合同流程ID。",
|
|
8743
|
+
"example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
|
|
8744
|
+
"member": "string",
|
|
8745
|
+
"name": "FlowId",
|
|
8746
|
+
"required": false,
|
|
8747
|
+
"type": "string"
|
|
8748
|
+
},
|
|
8749
|
+
{
|
|
8750
|
+
"disabled": false,
|
|
8751
|
+
"document": "签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`",
|
|
8752
|
+
"example": "无",
|
|
8753
|
+
"member": "string",
|
|
8754
|
+
"name": "RecipientId",
|
|
8755
|
+
"required": false,
|
|
8756
|
+
"type": "string"
|
|
8757
|
+
}
|
|
8758
|
+
],
|
|
8759
|
+
"usage": "in"
|
|
8760
|
+
},
|
|
8761
|
+
"FlowGroupApprovers": {
|
|
8762
|
+
"document": "合同组签署方信息",
|
|
8763
|
+
"members": [
|
|
8764
|
+
{
|
|
8765
|
+
"disabled": false,
|
|
8766
|
+
"document": "合同流程ID\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
8767
|
+
"example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
|
|
8768
|
+
"member": "string",
|
|
8769
|
+
"name": "FlowId",
|
|
8770
|
+
"output_required": false,
|
|
8771
|
+
"type": "string",
|
|
8772
|
+
"value_allowed_null": true
|
|
8773
|
+
},
|
|
8774
|
+
{
|
|
8775
|
+
"disabled": false,
|
|
8776
|
+
"document": "签署方信息，包含合同ID和角色ID用于定位RecipientId。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
8777
|
+
"example": "无",
|
|
8778
|
+
"member": "ApproverItem",
|
|
8779
|
+
"name": "Approvers",
|
|
8780
|
+
"output_required": false,
|
|
8781
|
+
"type": "list",
|
|
8782
|
+
"value_allowed_null": true
|
|
8783
|
+
}
|
|
8784
|
+
],
|
|
8785
|
+
"usage": "out"
|
|
8786
|
+
},
|
|
8690
8787
|
"FlowGroupOptions": {
|
|
8691
8788
|
"document": "合同组的配置项信息包括：在合同组签署过程中，是否需要对每个子合同进行独立的意愿确认。",
|
|
8692
8789
|
"members": [
|
|
@@ -8711,6 +8808,21 @@
|
|
|
8711
8808
|
],
|
|
8712
8809
|
"usage": "in"
|
|
8713
8810
|
},
|
|
8811
|
+
"FlowGroupUrlInfo": {
|
|
8812
|
+
"document": "合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。",
|
|
8813
|
+
"members": [
|
|
8814
|
+
{
|
|
8815
|
+
"disabled": false,
|
|
8816
|
+
"document": "合同组子合同和签署方的信息，用于补充动态签署人。\t",
|
|
8817
|
+
"example": "无",
|
|
8818
|
+
"member": "FlowGroupApproverInfo",
|
|
8819
|
+
"name": "FlowGroupApproverInfos",
|
|
8820
|
+
"required": false,
|
|
8821
|
+
"type": "list"
|
|
8822
|
+
}
|
|
8823
|
+
],
|
|
8824
|
+
"usage": "in"
|
|
8825
|
+
},
|
|
8714
8826
|
"FlowInfo": {
|
|
8715
8827
|
"document": "此结构体 (FlowInfo) 用于描述签署流程信息。",
|
|
8716
8828
|
"members": [
|
|
@@ -182,6 +182,12 @@
|
|
|
182
182
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelDescribeUserAutoSignStatus\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"Agent\": {\n \"ProxyAppId\": \"c17bdf9c2a7bdcb32611f4d0200fef3d\",\n \"ProxyOrganizationOpenId\": \"d7c13a8b81340cce9e3968c0ee248f04\",\n \"ProxyOperator\": {\n \"OpenId\": \"00498cc8500be9cxxxxxxx3aff766cac\"\n },\n \"AppId\": \"65fb0c591044be8a1f60aa382cc5ed0e\"\n },\n \"FlowId\": \"111111***22222\",\n \"FillApproverType\": 1,\n \"Approvers\": [\n {\n \"RecipientId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n \"ApproverName\": \"张三\",\n \"ApproverIdCardType\": \"ID_CARD\",\n \"ApproverIdCardNumber\": \"620000198802020000\"\n }\n ]\n}",
|
|
183
183
|
"output": "{\n \"Response\": {\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\"\n }\n}",
|
|
184
184
|
"title": "B2C签署，通过姓名和证件类型、证件号码补充已实名个人用户"
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
"document": "在B2C签署中，双方签署方未指定具体签署人时，需要进行补充。 \n注:`补充动态签署人时FillApproverType传值为1 `",
|
|
188
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelDescribeUserAutoSignStatus\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"Agent\": {\n \"ProxyAppId\": \"c17bdf9c2a7bdcb32611f4d0200fef3d\",\n \"ProxyOrganizationOpenId\": \"d7c13a8b81340cce9e3968c0ee248f04\",\n \"ProxyOperator\": {\n \"OpenId\": \"00498cc8500be9cxxxxxxx3aff766cac\"\n },\n \"AppId\": \"65fb0c591044be8a1f60aa382cc5ed0e\"\n },\n \"FlowGroupId\": \"111111***22222\",\n \"FillApproverType\": 1,\n \"Approvers\": [\n {\n \"RecipientId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"OrganizationName\": \"***有限公司\",\n \"FlowId\": \"yDCVMUUckpwytrk2UE1RW1FSR2BqdoGS\"\n },\n {\n \"RecipientId\": \"yDCVMUUckpwytrksUE1RW1FRR08t7Lxf\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"OrganizationName\": \"***有限公司\",\n \"FlowId\": \"yDCVMUUckpwytrk2UE1RW1FSR2BqdoGS\"\n }\n ]\n}",
|
|
189
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\"\n }\n}",
|
|
190
|
+
"title": "B2C签署，补充合同组两方动态签署人信息"
|
|
185
191
|
}
|
|
186
192
|
],
|
|
187
193
|
"ChannelCreateFlowByFiles": [
|
|
@@ -216,6 +222,12 @@
|
|
|
216
222
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"kevin\"\n },\n \"ProxyOrganizationOpenId\": \"zk_online_org\",\n \"AppId\": \"394fc83e7a1cc97ba27c3342f425c836\"\n },\n \"FlowGroupName\": \"采购合同\",\n \"FlowFileInfos\": [\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"番茄的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年番茄的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"CallbackUrl\": \"\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"OrganizationName\": \"王五示例企业\",\n \"OrganizationOpenId\": \"zk_online_org\",\n \"OpenId\": \"zk\",\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\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"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 \"CustomerData\": \"5ZCI5ZCM5Lus5ZCI5ZCM5Lus\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n },\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"黄瓜的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年黄瓜的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"CallbackUrl\": \"\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"OrganizationName\": \"李四示例企业\",\n \"OrganizationOpenId\": \"zk_online_org\",\n \"OpenId\": \"zk\",\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\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"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 \"CustomerData\": \"5paw55qE5a2Q5ZCI5ZCMMg==\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n },\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"马铃薯的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年马铃薯的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"CallbackUrl\": \"\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"OrganizationName\": \"张三示例企业\",\n \"OrganizationOpenId\": \"zk_online_org\",\n \"OpenId\": \"zk\",\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\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"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 \"CustomerData\": \"5paw55qE5a2Q5ZCI5ZCMMw==\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n }\n ]\n}",
|
|
217
223
|
"output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDwiSUUg0e3wmkUyoVjXzyZbNlhaVk85\",\n \"FlowIds\": [\n \"yDwiSUUg0e3wm2UyoVjXz1xWSYus0Jtc\",\n \"yDwiSUUg0e3wmrUyoVjXzSP9OEVRSAlk\",\n \"yDwiSUUg0e3wmhUyoVjXzByicWYPOymz\"\n ],\n \"RequestId\": \"s1698139089675399175\"\n }\n}",
|
|
218
224
|
"title": "创建三个合同组成的合同组"
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
"document": "1. 入参中FlowFileInfos有三个元素, 表示三个合同组成此合同组\n2. 每个合同都是B2C合同\n3.三份子合同均指定一方为动态签署方（即不指定具体签署人，FillType=1），可在发起后再进行补充。",
|
|
228
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"kevin\"\n },\n \"ProxyOrganizationOpenId\": \"zk_online_org\",\n \"AppId\": \"394fc83e7a1cc97ba27c3342f425c836\"\n },\n \"FlowGroupName\": \"采购合同\",\n \"FlowFileInfos\": [\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"番茄的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年番茄的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"CallbackUrl\": \"\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\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\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"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 \"CustomerData\": \"5ZCI5ZCM5Lus5ZCI5ZCM5Lus\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n },\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"黄瓜的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年黄瓜的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"CallbackUrl\": \"\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\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\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"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 \"CustomerData\": \"5paw55qE5a2Q5ZCI5ZCMMg==\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n },\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"马铃薯的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年马铃薯的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"CallbackUrl\": \"\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\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\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"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 \"CustomerData\": \"5paw55qE5a2Q5ZCI5ZCMMw==\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n }\n ]\n}",
|
|
229
|
+
"output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu2fUuyXGHSxNMdtKoFQ\",\n \"SignId\": \"yDCVHUUckpwbqu2xUuyXGHS1pifZeuEM\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu24UuyXGHSwSOzFjmPR\",\n \"SignId\": \"yDCVHUUckpwbqu2bUuyXGHSyMBsyo35X\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbqu2eUuyXGHSubvJWEDif\"\n },\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu2mUuyXGHSx4AVZuJkj\",\n \"SignId\": \"yDCVHUUckpwbqu29UuyXGHSS9mARSyFZ\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu27UuyXGHSR81vG2CR9\",\n \"SignId\": \"yDCVHUUckpwbqu2uUuyXGHS8JfqC4sho\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbqu2zUuyXGHSBho2CDwGz\"\n },\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu28UuyXGHS1CLfd5m1g\",\n \"SignId\": \"yDCVHUUckpwbqu22UuyXGHS8gj9IYCTL\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu2rUuyXGHSw7ZeJH7Dk\",\n \"SignId\": \"yDCVHUUckpwbqu25UuyXGHSu11RucwZR\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbqu2qUuyXGHSvEB4yY7su\"\n }\n ],\n \"FlowGroupId\": \"yDCVHUUckpwbquhgUuyXGHSxM3rGJCM3\",\n \"FlowIds\": [\n \"yDCVHUUckpwbqu2eUuyXGHSubvJWEDif\",\n \"yDCVHUUckpwbqu2zUuyXGHSBho2CDwGz\",\n \"yDCVHUUckpwbqu2qUuyXGHSvEB4yY7su\"\n ],\n \"RequestId\": \"s1711351873868654231\"\n }\n}",
|
|
230
|
+
"title": "创建三个合同组成的合同组，指定每个子合同第一方为动态签署方"
|
|
219
231
|
}
|
|
220
232
|
],
|
|
221
233
|
"ChannelCreateFlowGroupByTemplates": [
|
|
@@ -224,6 +236,12 @@
|
|
|
224
236
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowGroupByTemplates\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"kev_8\"\n },\n \"ProxyOrganizationOpenId\": \"kev_open_organization_8\",\n \"AppId\": \"16fd2f7d7ae85d13ca5f8d501d57b5ec\"\n },\n \"FlowGroupName\": \"2023年张三入职合同组合\",\n \"FlowInfos\": [\n {\n \"FlowName\": \"2023年张三入职合同\",\n \"FlowApprovers\": [\n {\n \"OrganizationName\": \"典子谦示例企业\",\n \"OrganizationOpenId\": \"kev_open_organization_8\",\n \"OpenId\": \"kev_8\",\n \"ApproverType\": \"ORGANIZATION\",\n \"RecipientId\": \"yDwgKUUckp1jdybwUWptGKyGVpNME9fH\"\n },\n {\n \"Name\": \"张三\",\n \"Mobile\": \"18888888888\",\n \"ApproverType\": \"PERSON\",\n \"RecipientId\": \"yDwgKUUckp1jdybvUWptGKBD9TeupFMV\"\n }\n ],\n \"Deadline\": 1698202075,\n \"TemplateId\": \"yDwgKUUckp1jdy4dUWptGKRavSGWt9cW\"\n },\n {\n \"FlowName\": \"2023年张三入职保密协议\",\n \"FlowApprovers\": [\n {\n \"OrganizationName\": \"典子谦示例企业\",\n \"OrganizationOpenId\": \"kev_open_organization_8\",\n \"OpenId\": \"kev_8\",\n \"ApproverType\": \"ORGANIZATION\",\n \"RecipientId\": \"yDwgKUUckp1jdybwUWptGKyGVpNME9fH\"\n },\n {\n \"Name\": \"张三\",\n \"Mobile\": \"18888888888\",\n \"ApproverType\": \"PERSON\",\n \"RecipientId\": \"yDwgKUUckp1jdybvUWptGKBD9TeupFMV\"\n }\n ],\n \"Deadline\": 1698202075,\n \"TemplateId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\"\n }\n ]\n}",
|
|
225
237
|
"output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDwiwUUckpo0n304UuwJzdxCQJhOooyw\",\n \"FlowIds\": [\n \"yDwiwUUckpo0n30bUuwJzdxxvnaMZpxW\",\n \"yDwiwUUckpo0n30uUuwJzdxxwyCoXw1Z\"\n ],\n \"RequestId\": \"s1698201691021218250\",\n \"TaskInfos\": [\n {\n \"TaskId\": \"\",\n \"TaskStatus\": \"\"\n },\n {\n \"TaskId\": \"\",\n \"TaskStatus\": \"\"\n }\n ]\n }\n}",
|
|
226
238
|
"title": "通过多模板创建有2个合同的合同组"
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
"document": "1. 入参中FlowFileInfos有2个元素, 表示2个合同组成此合同组\n2. 每个合同都是B2C合同\n4.指定子合同一方为动态签署方（即不指定具体签署人，FillType=1），可在发起后再进行补充。",
|
|
242
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowGroupByTemplates\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"kev_8\"\n },\n \"ProxyOrganizationOpenId\": \"kev_open_organization_8\",\n \"AppId\": \"16fd2f7d7ae85d13ca5f8d501d57b5ec\"\n },\n \"FlowGroupName\": \"2023年张三入职合同组合\",\n \"FlowInfos\": [\n {\n \"FlowName\": \"2023年张三入职合同\",\n \"FlowApprovers\": [\n {\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"ApproverType\": \"ORGANIZATION\",\n \"RecipientId\": \"yDwgKUUckp1jdybwUWptGKyGVpNME9fH\"\n },\n {\n \"Name\": \"张三\",\n \"Mobile\": \"18888888888\",\n \"ApproverType\": \"PERSON\",\n \"RecipientId\": \"yDwgKUUckp1jdybvUWptGKBD9TeupFMV\"\n }\n ],\n \"Deadline\": 1698202075,\n \"TemplateId\": \"yDwgKUUckp1jdy4dUWptGKRavSGWt9cW\"\n },\n {\n \"FlowName\": \"2023年张三入职保密协议\",\n \"FlowApprovers\": [\n {\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"ApproverType\": \"ORGANIZATION\",\n \"RecipientId\": \"yDwgKUUckp1jdybwUWptGKyGVpNME9fH\"\n },\n {\n \"Name\": \"张三\",\n \"Mobile\": \"18888888888\",\n \"ApproverType\": \"PERSON\",\n \"RecipientId\": \"yDwgKUUckp1jdybvUWptGKBD9TeupFMV\"\n }\n ],\n \"Deadline\": 1698202075,\n \"TemplateId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\"\n }\n ]\n}",
|
|
243
|
+
"output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDSx0UUckptqcu0rUuvGhoq88RKQezmP\",\n \"SignId\": \"yDCVHUUckpwbqurqUuyXGHS1da6wB7v2\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqurlUuyXGHSChXDgrj1C\",\n \"SignId\": \"yDCVHUUckpwbqurgUuyXGHS1cwtnpm8o\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbqur3UuyXGHSxpj1wPeJn\"\n },\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDSx0UUckptqcu0rUuvGhoq88RKQezmP\",\n \"SignId\": \"yDCVHUUckpwbqursUuyXGHSCOm804z86\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqurrUuyXGHS8cOo8z4Vc\",\n \"SignId\": \"yDCVHUUckpwbqulcUuyXGHSSvCaqc6He\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbqur1UuyXGHS1JCWpHawy\"\n }\n ],\n \"FlowGroupId\": \"yDCVHUUckpwbqurkUuyXGHS89Y9LLM4x\",\n \"FlowIds\": [\n \"yDCVHUUckpwbqur3UuyXGHSxpj1wPeJn\",\n \"yDCVHUUckpwbqur1UuyXGHS1JCWpHawy\"\n ],\n \"RequestId\": \"s1711352113176693412\",\n \"TaskInfos\": [\n {\n \"TaskId\": \"\",\n \"TaskStatus\": \"\"\n },\n {\n \"TaskId\": \"\",\n \"TaskStatus\": \"\"\n }\n ]\n }\n}",
|
|
244
|
+
"title": "通过多模板创建有2个合同的合同组，指定每个子合同第一方为动态签署方"
|
|
227
245
|
}
|
|
228
246
|
],
|
|
229
247
|
"ChannelCreateFlowReminds": [
|
|
@@ -832,6 +850,12 @@
|
|
|
832
850
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSignUrls\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyAppId\": \"\"\n },\n \"FlowIds\": [\n \"yDwiBUUckpo27hh3UuLiduR83BEL3kSb\"\n ],\n \"Endpoint\": \"WEIXINAPP\",\n \"GenerateType\": \"PERSON\",\n \"Name\": \"张三\",\n \"Mobile\": \"18888888888\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"620000198802020000\"\n}",
|
|
833
851
|
"output": "{\n \"Response\": {\n \"SignUrlInfos\": [\n {\n \"SignUrl\": \"https://essurl.cn/9oJ**P\",\n \"Deadline\": 0,\n \"SignOrder\": 0,\n \"SignId\": \"\",\n \"CustomUserId\": \"\",\n \"Name\": \"\",\n \"Mobile\": \"\",\n \"OrganizationName\": \"\",\n \"ApproverType\": \"\",\n \"IdCardNumber\": \"\",\n \"FlowId\": \"yDwiBUUckpo27hh3UuLiduR83BEL3kSb\",\n \"OpenId\": \"\",\n \"FlowGroupId\": \"\",\n \"SignQrcodeUrl\": \"\"\n }\n ],\n \"ErrorMessages\": [],\n \"RequestId\": \"0ec76ecb**bde91\"\n }\n}",
|
|
834
852
|
"title": "指定证件信息，为个人/自然人生成签署链接"
|
|
853
|
+
},
|
|
854
|
+
{
|
|
855
|
+
"document": "获取动态签署人补充链接，创建合同组时未指定具体签署人，可获取链接后推送给指定的人进行补充\n注： \n`1.参数GenerateType需传值为RECIPIENT` \n`2.需指定对应的合同组FlowGroupUrlInfo签署方角色编号（即RecipientId）` \n",
|
|
856
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSignUrls\n<公共请求参数>\n\n{\n \"FlowGroupId\": \"yDCVAUUckpwa592pUxoLjOlRVS9Zgusf\",\n \"FlowGroupUrlInfo\": {\n \"FlowGroupApproverInfos\": [\n {\n \"FlowId\": \"yDCVAUUckpwa59rcUxoLjOlEctyesTzj\",\n \"RecipientId\": \"yDCVAUUckpwa59riUxoLjOluu9cf6B3s\"\n },\n {\n \"FlowId\": \"yDCVAUUckpwa592dUxoLjOl8StWKvg9K\",\n \"RecipientId\": \"yDCVAUUckpwa59r6UxoLjOlCC6ZHk7rL\"\n }\n ]\n },\n \"GenerateType\": \"RECIPIENT\",\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"1000***8062\",\n \"ProxyOperator\": {\n \"OpenId\": \"yDR3L****eTdCt5TVx\"\n },\n \"AppId\": \"125***319\"\n },\n \"Endpoint\": \"\"\n}",
|
|
857
|
+
"output": "{\n \"Response\": {\n \"ErrorMessages\": [],\n \"RequestId\": \"s1696937862717144539\",\n \"SignUrlInfos\": [\n {\n \"ApproverType\": \"\",\n \"CustomUserId\": \"\",\n \"Deadline\": 0,\n \"FlowGroupId\": \"\",\n \"FlowId\": \"yDwhGUUfe5g******CX8ZwTiSg8gISocy\",\n \"IdCardNumber\": \"\",\n \"Mobile\": \"\",\n \"Name\": \"\",\n \"OpenId\": \"\",\n \"OrganizationName\": \"\",\n \"SignId\": \"\",\n \"SignOrder\": 0,\n \"SignQrcodeUrl\": \"https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06dcbe2797f**************69ee4e24cd976dd8376dbd41c6ff227c803c4c561c\",\n \"SignUrl\": \"https://test.essurl.cn/gGI***nZC\"\n }\n ]\n }\n}",
|
|
858
|
+
"title": "获取合同组动态签署人补充链接"
|
|
835
859
|
}
|
|
836
860
|
],
|
|
837
861
|
"DescribeBatchOrganizationRegistrationUrls": [
|