tccli 3.0.1083.1__py2.py3-none-any.whl → 3.0.1085.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/aiart/v20221229/QueryTextToImageProJob.md +30 -0
- tccli/examples/aiart/v20221229/SubmitTextToImageProJob.md +22 -0
- tccli/examples/billing/v20180709/DescribeCostDetail.md +36 -33
- tccli/examples/billing/v20180709/DescribeCostSummaryByProject.md +25 -80
- tccli/examples/billing/v20180709/DescribeCostSummaryByRegion.md +23 -14
- tccli/examples/billing/v20180709/DescribeCostSummaryByResource.md +53 -27
- tccli/examples/ccc/v20200210/CreateCompanyApply.md +36 -0
- tccli/examples/ccc/v20200210/DescribeCompanyList.md +33 -0
- tccli/examples/ccc/v20200210/ModifyCompanyApply.md +36 -0
- tccli/examples/cdb/v20170320/CreateCloneInstance.md +5 -5
- tccli/examples/ckafka/v20190819/CreateInstancePost.md +9 -6
- tccli/examples/ckafka/v20190819/CreatePrometheus.md +29 -0
- tccli/examples/ckafka/v20190819/DescribeGroupInfo.md +2 -2
- tccli/examples/ckafka/v20190819/DescribePrometheus.md +25 -0
- tccli/examples/ckafka/v20190819/ModifyAclRule.md +1 -1
- tccli/examples/cynosdb/v20190107/RollbackToNewCluster.md +62 -0
- tccli/examples/dlc/v20210125/QueryTaskCostDetail.md +20 -0
- 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/ChannelCreateReleaseFlow.md +1 -1
- tccli/examples/essbasic/v20210526/CreateSignUrls.md +52 -0
- tccli/examples/faceid/v20180301/GetFaceIdResult.md +4 -4
- tccli/examples/faceid/v20180301/GetFaceIdRiskInfo.md +26 -0
- tccli/examples/faceid/v20180301/GetFaceidRiskInfoToken.md +22 -0
- tccli/examples/iotexplorer/v20190423/BindCloudStorageUser.md +22 -0
- tccli/examples/iotexplorer/v20190423/CreateIotVideoCloudStorage.md +22 -0
- tccli/examples/iotexplorer/v20190423/DeleteCloudStorageEvent.md +26 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStorage.md +27 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStorageDate.md +24 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStorageEvents.md +87 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStorageMultiThumbnail.md +28 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStorageOrder.md +25 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStoragePackageConsumeDetails.md +21 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStoragePackageConsumeStats.md +44 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStorageStreamData.md +24 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStorageThumbnail.md +24 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStorageThumbnailList.md +28 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStorageTime.md +43 -0
- tccli/examples/iotexplorer/v20190423/DescribeCloudStorageUsers.md +29 -0
- tccli/examples/iotexplorer/v20190423/DescribeDevicePackages.md +37 -0
- tccli/examples/iotexplorer/v20190423/DescribePackageConsumeTask.md +21 -0
- tccli/examples/iotexplorer/v20190423/DescribePackageConsumeTasks.md +39 -0
- tccli/examples/iotexplorer/v20190423/GenerateSignedVideoURL.md +22 -0
- tccli/examples/iotexplorer/v20190423/InheritCloudStorageUser.md +23 -0
- tccli/examples/iotexplorer/v20190423/ResetCloudStorage.md +21 -0
- tccli/examples/iotexplorer/v20190423/ResetCloudStorageEvent.md +22 -0
- tccli/examples/iotexplorer/v20190423/TransferCloudStorage.md +22 -0
- tccli/examples/live/v20180801/CreateLiveTimeShiftTemplate.md +8 -8
- tccli/examples/monitor/v20180724/CreateExporterIntegration.md +626 -2
- tccli/examples/ocr/v20181119/ReconstructDocument.md +2263 -0
- tccli/examples/pts/v20210728/CreateEnvironment.md +18 -0
- tccli/examples/pts/v20210728/DeleteEnvironments.md +18 -0
- tccli/examples/pts/v20210728/DescribeEnvironments.md +18 -0
- tccli/examples/pts/v20210728/UpdateEnvironment.md +18 -0
- tccli/examples/ssl/v20191205/UploadCertificate.md +48 -3
- tccli/examples/tag/v20180813/DescribeProjects.md +1 -1
- tccli/examples/tione/v20211111/CreateModelService.md +3 -1
- tccli/examples/tione/v20211111/ModifyModelService.md +62 -228
- tccli/examples/wedata/v20210820/BatchCreateIntegrationTaskAlarms.md +11 -11
- tccli/examples/wedata/v20210820/BatchForceSuccessIntegrationTaskInstances.md +2 -2
- tccli/examples/wedata/v20210820/BatchKillIntegrationTaskInstances.md +2 -2
- tccli/examples/wedata/v20210820/BatchMakeUpIntegrationTasks.md +2 -2
- tccli/examples/wedata/v20210820/BatchRerunIntegrationTaskInstances.md +5 -2
- tccli/examples/wedata/v20210820/CheckDuplicateRuleName.md +5 -5
- tccli/examples/wedata/v20210820/CheckDuplicateTemplateName.md +4 -4
- tccli/examples/wedata/v20210820/CheckIntegrationNodeNameExists.md +4 -4
- tccli/examples/wedata/v20210820/CheckIntegrationTaskNameExists.md +4 -4
- tccli/examples/wedata/v20210820/CheckTaskNameExist.md +3 -3
- tccli/examples/wedata/v20210820/CommitExportTask.md +4 -4
- tccli/examples/wedata/v20210820/CreateInLongAgent.md +6 -6
- tccli/examples/wedata/v20210820/CreateOrUpdateResource.md +2 -1
- tccli/examples/wedata/v20210820/CreateRuleTemplate.md +1 -1
- tccli/examples/wedata/v20210820/CreateTaskAlarmRegular.md +11 -11
- tccli/examples/wedata/v20210820/DeleteInLongAgent.md +3 -3
- tccli/examples/wedata/v20210820/DeleteIntegrationNode.md +2 -2
- tccli/examples/wedata/v20210820/DeleteOfflineTask.md +4 -4
- tccli/examples/wedata/v20210820/DeleteRule.md +1 -1
- tccli/examples/wedata/v20210820/DeleteRuleTemplate.md +1 -1
- tccli/examples/wedata/v20210820/DescribeClusterNamespaceList.md +6 -6
- tccli/examples/wedata/v20210820/DescribeDataBases.md +12 -8
- tccli/examples/wedata/v20210820/DescribeDataCheckStat.md +5 -5
- tccli/examples/wedata/v20210820/DescribeDataObjects.md +6 -3
- tccli/examples/wedata/v20210820/DescribeExecStrategy.md +20 -16
- tccli/examples/wedata/v20210820/DescribeInLongAgentTaskList.md +6 -6
- tccli/examples/wedata/v20210820/DescribeInLongAgentVpcList.md +3 -3
- tccli/examples/wedata/v20210820/DescribeInstances.md +6 -6
- tccli/examples/wedata/v20210820/DescribeIntegrationNode.md +61 -43
- tccli/examples/wedata/v20210820/DescribeIntegrationStatistics.md +13 -13
- tccli/examples/wedata/v20210820/DescribeIntegrationStatisticsAgentStatus.md +6 -6
- tccli/examples/wedata/v20210820/DescribeIntegrationStatisticsInstanceTrend.md +8 -10
- tccli/examples/wedata/v20210820/DescribeIntegrationStatisticsRecordsTrend.md +1 -1
- tccli/examples/wedata/v20210820/DescribeIntegrationStatisticsTaskStatus.md +5 -5
- tccli/examples/wedata/v20210820/DescribeIntegrationStatisticsTaskStatusTrend.md +8 -10
- tccli/examples/wedata/v20210820/DescribeMonitorsByPage.md +7 -7
- tccli/examples/wedata/v20210820/DescribeOfflineTaskToken.md +3 -3
- tccli/examples/wedata/v20210820/DescribeProdTasks.md +6 -5
- tccli/examples/wedata/v20210820/DescribeRealTimeTaskInstanceNodeInfo.md +9 -9
- tccli/examples/wedata/v20210820/DescribeRealTimeTaskSpeed.md +32 -26
- tccli/examples/wedata/v20210820/DescribeRule.md +118 -23
- tccli/examples/wedata/v20210820/DescribeRuleDataSources.md +11 -8
- tccli/examples/wedata/v20210820/DescribeRuleDimStat.md +3 -3
- tccli/examples/wedata/v20210820/DescribeRuleExecDetail.md +48 -41
- tccli/examples/wedata/v20210820/DescribeRuleExecExportResult.md +15 -10
- tccli/examples/wedata/v20210820/DescribeRuleExecLog.md +2 -2
- tccli/examples/wedata/v20210820/DescribeRuleExecResults.md +72 -4
- tccli/examples/wedata/v20210820/DescribeRuleExecResultsByPage.md +38 -33
- tccli/examples/wedata/v20210820/DescribeRuleExecStat.md +14 -14
- tccli/examples/wedata/v20210820/DescribeRuleGroup.md +50 -23
- tccli/examples/wedata/v20210820/DescribeRuleGroupExecResultsByPage.md +87 -14
- tccli/examples/wedata/v20210820/DescribeRuleGroupExecResultsByPageWithoutAuth.md +81 -12
- tccli/examples/wedata/v20210820/DescribeRuleGroupSubscription.md +12 -6
- tccli/examples/wedata/v20210820/DescribeRuleGroupTable.md +35 -27
- tccli/examples/wedata/v20210820/DescribeRuleGroupsByPage.md +51 -21
- tccli/examples/wedata/v20210820/DescribeRuleHistoryByPage.md +9 -9
- tccli/examples/wedata/v20210820/DescribeRuleTablesByPage.md +52 -35
- tccli/examples/wedata/v20210820/DescribeRuleTemplate.md +33 -16
- tccli/examples/wedata/v20210820/DescribeRuleTemplates.md +8 -8
- tccli/examples/wedata/v20210820/DescribeRuleTemplatesByPage.md +13 -13
- tccli/examples/wedata/v20210820/DescribeRulesByPage.md +123 -28
- tccli/examples/wedata/v20210820/DescribeStandardRuleDetailInfoList.md +3 -3
- tccli/examples/wedata/v20210820/DescribeTableInfoList.md +9 -2
- tccli/examples/wedata/v20210820/DescribeTaskInstance.md +35 -35
- tccli/examples/wedata/v20210820/DescribeTaskInstanceReportDetail.md +28 -26
- tccli/examples/wedata/v20210820/DescribeTaskLockStatus.md +7 -7
- tccli/examples/wedata/v20210820/DescribeTaskReport.md +6 -6
- tccli/examples/wedata/v20210820/DescribeTaskReportDetailList.md +17 -17
- tccli/examples/wedata/v20210820/DescribeTopTableStat.md +9 -9
- tccli/examples/wedata/v20210820/DescribeTrendStat.md +2 -2
- tccli/examples/wedata/v20210820/DryRunDIOfflineTask.md +10 -9
- tccli/examples/wedata/v20210820/GetIntegrationNodeColumnSchema.md +13 -11
- tccli/examples/wedata/v20210820/GetOfflineDIInstanceList.md +26 -26
- tccli/examples/wedata/v20210820/LockIntegrationTask.md +4 -4
- tccli/examples/wedata/v20210820/ModifyIntegrationNode.md +42 -41
- tccli/examples/wedata/v20210820/ModifyIntegrationTask.md +110 -58
- tccli/examples/wedata/v20210820/ModifyMonitorStatus.md +4 -4
- tccli/examples/wedata/v20210820/ModifyRule.md +24 -24
- tccli/examples/wedata/v20210820/ModifyRuleGroupSubscription.md +11 -13
- tccli/examples/wedata/v20210820/ModifyTaskAlarmRegular.md +45 -16
- tccli/examples/wedata/v20210820/ModifyTaskInfo.md +79 -29
- tccli/examples/wedata/v20210820/ModifyTaskName.md +5 -5
- tccli/examples/wedata/v20210820/RestartInLongAgent.md +3 -3
- tccli/examples/wedata/v20210820/RobAndLockIntegrationTask.md +7 -7
- tccli/examples/wedata/v20210820/StopIntegrationTask.md +4 -4
- tccli/examples/wedata/v20210820/TaskLog.md +5 -15
- tccli/examples/wedata/v20210820/UnlockIntegrationTask.md +4 -4
- tccli/examples/wedata/v20210820/UpdateInLongAgent.md +5 -5
- tccli/services/aiart/aiart_client.py +106 -0
- tccli/services/aiart/v20221229/api.json +174 -0
- tccli/services/aiart/v20221229/examples.json +16 -0
- tccli/services/asr/v20190614/api.json +4 -4
- tccli/services/bi/v20220105/api.json +27 -0
- tccli/services/billing/v20180709/api.json +365 -130
- tccli/services/billing/v20180709/examples.json +4 -4
- tccli/services/ccc/ccc_client.py +159 -0
- tccli/services/ccc/v20200210/api.json +442 -0
- tccli/services/ccc/v20200210/examples.json +24 -0
- tccli/services/cdb/v20170320/api.json +78 -24
- tccli/services/cdb/v20170320/examples.json +2 -2
- tccli/services/cdwpg/v20201230/api.json +9 -0
- tccli/services/ckafka/ckafka_client.py +106 -0
- tccli/services/ckafka/v20190819/api.json +211 -32
- tccli/services/ckafka/v20190819/examples.json +19 -3
- tccli/services/clb/v20180317/api.json +2 -2
- tccli/services/cloudstudio/v20230508/api.json +40 -4
- tccli/services/cls/v20201016/api.json +30 -30
- tccli/services/csip/v20221121/api.json +76 -76
- tccli/services/cwp/v20180228/api.json +124 -8
- tccli/services/cynosdb/cynosdb_client.py +53 -0
- tccli/services/cynosdb/v20190107/api.json +255 -0
- tccli/services/cynosdb/v20190107/examples.json +8 -0
- tccli/services/dlc/dlc_client.py +53 -0
- tccli/services/dlc/v20210125/api.json +103 -4
- tccli/services/dlc/v20210125/examples.json +8 -0
- tccli/services/dsgc/v20190723/api.json +20 -0
- tccli/services/dts/v20211206/api.json +56 -2
- tccli/services/es/v20180416/api.json +127 -24
- tccli/services/ess/v20201111/api.json +143 -31
- tccli/services/ess/v20201111/examples.json +26 -2
- tccli/services/essbasic/v20210526/api.json +134 -13
- tccli/services/essbasic/v20210526/examples.json +25 -1
- tccli/services/faceid/faceid_client.py +136 -30
- tccli/services/faceid/v20180301/api.json +167 -10
- tccli/services/faceid/v20180301/examples.json +17 -1
- tccli/services/iotexplorer/iotexplorer_client.py +1453 -234
- tccli/services/iotexplorer/v20190423/api.json +2179 -117
- tccli/services/iotexplorer/v20190423/examples.json +184 -0
- tccli/services/lcic/v20220817/api.json +62 -4
- tccli/services/live/v20180801/api.json +1 -1
- tccli/services/live/v20180801/examples.json +2 -2
- tccli/services/monitor/v20180724/examples.json +111 -3
- tccli/services/mps/v20190612/api.json +53 -27
- tccli/services/ms/v20180408/api.json +14 -14
- tccli/services/oceanus/v20190422/api.json +1 -1
- tccli/services/ocr/ocr_client.py +53 -0
- tccli/services/ocr/v20181119/api.json +276 -0
- tccli/services/ocr/v20181119/examples.json +8 -0
- tccli/services/pts/pts_client.py +212 -0
- tccli/services/pts/v20210728/api.json +96 -0
- tccli/services/pts/v20210728/examples.json +32 -0
- tccli/services/ssl/v20191205/examples.json +9 -3
- tccli/services/tag/v20180813/examples.json +1 -1
- tccli/services/tione/v20211111/api.json +77 -3
- tccli/services/tione/v20211111/examples.json +2 -2
- tccli/services/tms/v20201229/api.json +1 -1
- tccli/services/trtc/v20190722/api.json +1 -1
- tccli/services/tts/v20190823/api.json +10 -1
- tccli/services/vod/v20180717/api.json +6 -6
- tccli/services/wedata/v20210820/api.json +650 -200
- tccli/services/wedata/v20210820/examples.json +154 -148
- {tccli-3.0.1083.1.dist-info → tccli-3.0.1085.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1083.1.dist-info → tccli-3.0.1085.1.dist-info}/RECORD +220 -181
- {tccli-3.0.1083.1.dist-info → tccli-3.0.1085.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1083.1.dist-info → tccli-3.0.1085.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1083.1.dist-info → tccli-3.0.1085.1.dist-info}/license_files/LICENSE +0 -0
@@ -218,7 +218,7 @@
|
|
218
218
|
"status": "online"
|
219
219
|
},
|
220
220
|
"CreateReleaseFlow": {
|
221
|
-
"document": "发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。\n解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。\n\n注意:\n<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>\n<li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>\n<li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>\n<li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>\n<li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>\n<li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li
|
221
|
+
"document": "发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。\n解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。\n\n注意:\n<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>\n<li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>\n<li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>\n<li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>\n<li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>\n<li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li>\n<li>非原合同企业参与人发起解除协议时,需要有<code>解除合同的权限</code>。</li>\n</ul>",
|
222
222
|
"input": "CreateReleaseFlowRequest",
|
223
223
|
"name": "发起解除协议",
|
224
224
|
"output": "CreateReleaseFlowResponse",
|
@@ -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\"
|
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":
|
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
|
{
|
@@ -783,7 +783,7 @@
|
|
783
783
|
},
|
784
784
|
{
|
785
785
|
"disabled": false,
|
786
|
-
"document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>\n\n注:\n1.
|
786
|
+
"document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>\n\n默认为1(人脸认证 ),2(签署密码),3(运营商三要素)\n\n注:\n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n3. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明",
|
787
787
|
"example": "[1,2,3]",
|
788
788
|
"member": "int64",
|
789
789
|
"name": "ApproverSignTypes",
|
@@ -906,7 +906,7 @@
|
|
906
906
|
},
|
907
907
|
{
|
908
908
|
"disabled": false,
|
909
|
-
"document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li>\n
|
909
|
+
"document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>\n\n注:\n`使用动态签署人能力前,需登陆腾讯电子签控制台打开服务开关`",
|
910
910
|
"example": "无",
|
911
911
|
"member": "int64",
|
912
912
|
"name": "FillType",
|
@@ -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",
|
@@ -3361,19 +3390,19 @@
|
|
3361
3390
|
"disabled": false,
|
3362
3391
|
"document": " 禁止添加签署方,若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”\n",
|
3363
3392
|
"example": "无",
|
3364
|
-
"member": "
|
3393
|
+
"member": "bool",
|
3365
3394
|
"name": "ForbidAddApprover",
|
3366
3395
|
"required": false,
|
3367
|
-
"type": "
|
3396
|
+
"type": "bool"
|
3368
3397
|
},
|
3369
3398
|
{
|
3370
3399
|
"disabled": false,
|
3371
3400
|
"document": " 禁止设置设置签署流程属性 (顺序、合同签署认证方式等),若为true则在发起流程的可嵌入页面隐藏签署流程设置面板\n",
|
3372
3401
|
"example": "无",
|
3373
|
-
"member": "
|
3402
|
+
"member": "bool",
|
3374
3403
|
"name": "ForbidEditFlowProperties",
|
3375
3404
|
"required": false,
|
3376
|
-
"type": "
|
3405
|
+
"type": "bool"
|
3377
3406
|
},
|
3378
3407
|
{
|
3379
3408
|
"disabled": false,
|
@@ -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"
|
@@ -8776,7 +8823,7 @@
|
|
8776
8823
|
"members": [
|
8777
8824
|
{
|
8778
8825
|
"disabled": false,
|
8779
|
-
"document": "
|
8826
|
+
"document": "在指定签署方时,可以选择企业B端或个人C端等不同的参与者类型,可选类型如下:\n\n<ul><li> <b>0</b> :企业B端。</li>\n<li> <b>1</b> :个人C端。</li>\n<li> <b>3</b> :企业B端静默(自动)签署,无需签署人参与,自动签署可以参考<a href=\"https://qian.tencent.com/developers/company/autosign_guide\" target=\"_blank\" rel=\"noopener noreferrer\">自动签署使用说明</a>文档。</li>\n<li> <b>7</b> :个人C端自动签署,适用于个人自动签场景。注: <b>个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。</b> </li></ul>",
|
8780
8827
|
"example": "1",
|
8781
8828
|
"member": "int64",
|
8782
8829
|
"name": "ApproverType",
|
@@ -8803,7 +8850,7 @@
|
|
8803
8850
|
},
|
8804
8851
|
{
|
8805
8852
|
"disabled": false,
|
8806
|
-
"document": "签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)
|
8853
|
+
"document": "签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。\n\n注:`在未指定签署人电子签UserId情况下,为必填参数`\n",
|
8807
8854
|
"example": "无",
|
8808
8855
|
"member": "string",
|
8809
8856
|
"name": "ApproverMobile",
|
@@ -8812,7 +8859,7 @@
|
|
8812
8859
|
},
|
8813
8860
|
{
|
8814
8861
|
"disabled": false,
|
8815
|
-
"document": "证件类型,支持以下类型\n<ul><li>ID_CARD
|
8862
|
+
"document": "证件类型,支持以下类型\n<ul><li><b>ID_CARD</b>: 居民身份证 (默认值)</li>\n<li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>\n<li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 港澳台居民居住证(格式同居民身份证)</li></ul>",
|
8816
8863
|
"example": "ID_CARD",
|
8817
8864
|
"member": "string",
|
8818
8865
|
"name": "ApproverIdCardType",
|
@@ -8830,7 +8877,7 @@
|
|
8830
8877
|
},
|
8831
8878
|
{
|
8832
8879
|
"disabled": false,
|
8833
|
-
"document": "签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。\n
|
8880
|
+
"document": "签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。\n\n<b>模板发起合同时,该参数为必填项,可以通过[查询模版信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>\n<b>文件发起合同时,该参数无需传值。</b>\n\n如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。",
|
8834
8881
|
"example": "无",
|
8835
8882
|
"member": "string",
|
8836
8883
|
"name": "RecipientId",
|
@@ -8839,7 +8886,7 @@
|
|
8839
8886
|
},
|
8840
8887
|
{
|
8841
8888
|
"disabled": false,
|
8842
|
-
"document": "签署意愿确认渠道,默认为WEIXINAPP:人脸识别\n\n注:
|
8889
|
+
"document": "签署意愿确认渠道,默认为WEIXINAPP:人脸识别\n\n注: <font color=\"red\">将要废弃</font >, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`",
|
8843
8890
|
"example": "[\"WEIXINAPP\"]",
|
8844
8891
|
"member": "string",
|
8845
8892
|
"name": "VerifyChannel",
|
@@ -8848,7 +8895,7 @@
|
|
8848
8895
|
},
|
8849
8896
|
{
|
8850
8897
|
"disabled": false,
|
8851
|
-
"document": "通知签署方经办人的方式, 有以下途径:\n<ul><li> **sms** : (默认)短信</li>\n<li> **none** : 不通知</li></ul>\n\n注:
|
8898
|
+
"document": "通知签署方经办人的方式, 有以下途径:\n<ul><li> **sms** : (默认)短信</li>\n<li> **none** : 不通知</li></ul>\n\n注: `既是发起方又是签署方时,不给此签署方发送短信`",
|
8852
8899
|
"example": "无",
|
8853
8900
|
"member": "string",
|
8854
8901
|
"name": "NotifyType",
|
@@ -8866,7 +8913,7 @@
|
|
8866
8913
|
},
|
8867
8914
|
{
|
8868
8915
|
"disabled": false,
|
8869
|
-
"document": "
|
8916
|
+
"document": "签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。\n\n若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:\n<ul>\n<li>合同页数少于等于2页,阅读时间为3秒;</li>\n<li>合同页数为3到5页,阅读时间为5秒;</li>\n<li>合同页数大于等于6页,阅读时间为10秒。</li>\n</ul>",
|
8870
8917
|
"example": "无",
|
8871
8918
|
"member": "uint64",
|
8872
8919
|
"name": "PreReadTime",
|
@@ -8875,7 +8922,7 @@
|
|
8875
8922
|
},
|
8876
8923
|
{
|
8877
8924
|
"disabled": false,
|
8878
|
-
"document": "签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得\n\n
|
8925
|
+
"document": "签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得\n\n注: \n如果传进来的<font color=\"red\">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)",
|
8879
8926
|
"example": "无",
|
8880
8927
|
"member": "string",
|
8881
8928
|
"name": "UserId",
|
@@ -8884,7 +8931,7 @@
|
|
8884
8931
|
},
|
8885
8932
|
{
|
8886
8933
|
"disabled": false,
|
8887
|
-
"document": "
|
8934
|
+
"document": "<font color=\"red\">字段已经废弃</font>,当前只支持true,默认为true",
|
8888
8935
|
"example": "无",
|
8889
8936
|
"member": "bool",
|
8890
8937
|
"name": "Required",
|
@@ -8938,7 +8985,7 @@
|
|
8938
8985
|
},
|
8939
8986
|
{
|
8940
8987
|
"disabled": false,
|
8941
|
-
"document": "
|
8988
|
+
"document": "签署人的签署ID\n\n<ul>\n<li>在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数,电子签后台系统会自动生成。</li>\n<li>在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时,可以通过查询详情接口获取签署人的SignId,然后可以将此值传入,为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。</li>\n</ul>",
|
8942
8989
|
"example": "无",
|
8943
8990
|
"member": "string",
|
8944
8991
|
"name": "SignId",
|
@@ -8974,7 +9021,7 @@
|
|
8974
9021
|
},
|
8975
9022
|
{
|
8976
9023
|
"disabled": false,
|
8977
|
-
"document": "
|
9024
|
+
"document": "当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时,可以指定签署方签名方式。如果不指定,签署人可以使用所有的签名类型,可指定的签名类型包括:\n\n<ul><li> <b>HANDWRITE</b> :手写签名。</li>\n<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>\n<li> <b>ESIGN</b> :个人印章类型。</li>\n<li> <b>IMG_ESIGN</b> : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>\n<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>\n\n各种签名的样式可以参考下图:\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)",
|
8978
9025
|
"example": "无",
|
8979
9026
|
"member": "string",
|
8980
9027
|
"name": "ComponentLimitType",
|
@@ -9010,7 +9057,7 @@
|
|
9010
9057
|
},
|
9011
9058
|
{
|
9012
9059
|
"disabled": false,
|
9013
|
-
"document": "
|
9060
|
+
"document": "签署人的签署截止时间,格式为Unix标准时间戳(秒), 超过此时间未签署的合同变成已过期状态,不能在继续签署\n\n注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`",
|
9014
9061
|
"example": "1604912664",
|
9015
9062
|
"member": "int64",
|
9016
9063
|
"name": "Deadline",
|
@@ -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": [
|
@@ -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
|
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": [
|