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
@@ -155,7 +155,7 @@
|
|
155
155
|
"status": "online"
|
156
156
|
},
|
157
157
|
"ChannelCreateReleaseFlow": {
|
158
|
-
"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
|
158
|
+
"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>",
|
159
159
|
"input": "ChannelCreateReleaseFlowRequest",
|
160
160
|
"name": "发起解除协议",
|
161
161
|
"output": "ChannelCreateReleaseFlowResponse",
|
@@ -662,7 +662,7 @@
|
|
662
662
|
},
|
663
663
|
{
|
664
664
|
"disabled": false,
|
665
|
-
"document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li>\n
|
665
|
+
"document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>\n\n注:\n`使用动态签署人能力前,需登陆腾讯电子签控制台打开服务开关`",
|
666
666
|
"example": "无",
|
667
667
|
"member": "int64",
|
668
668
|
"name": "FillType",
|
@@ -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",
|
@@ -5971,6 +6000,15 @@
|
|
5971
6000
|
"required": false,
|
5972
6001
|
"type": "string"
|
5973
6002
|
},
|
6003
|
+
{
|
6004
|
+
"disabled": false,
|
6005
|
+
"document": "子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注:`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业,这里修改经办人手机号传入将不会生效`",
|
6006
|
+
"example": "18888888888",
|
6007
|
+
"member": "string",
|
6008
|
+
"name": "ProxyOperatorMobile",
|
6009
|
+
"required": false,
|
6010
|
+
"type": "string"
|
6011
|
+
},
|
5974
6012
|
{
|
5975
6013
|
"disabled": false,
|
5976
6014
|
"document": "Web控制台登录后进入的功能模块, 支持的模块包括:\n<ul>\n<li> **空值** :(默认)企业中心模块</li>\n<li> **DOCUMENT** :合同管理模块</li>\n<li> **TEMPLATE** :企业模板管理模块</li>\n<li> **SEAL** :印章管理模块</li>\n<li> **OPERATOR** :组织管理模块</li></ul>\n注意:\n1、如果EndPoint选择\"CHANNEL\"或\"APP\",该参数仅支持传递\"SEAL\",进入印章管理模块\n2、该参数**仅在企业和员工激活已经完成,登录控制台场景才生效**。",
|
@@ -6728,6 +6766,15 @@
|
|
6728
6766
|
"name": "RecipientIds",
|
6729
6767
|
"required": false,
|
6730
6768
|
"type": "list"
|
6769
|
+
},
|
6770
|
+
{
|
6771
|
+
"disabled": false,
|
6772
|
+
"document": "合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。",
|
6773
|
+
"example": "无",
|
6774
|
+
"member": "FlowGroupUrlInfo",
|
6775
|
+
"name": "FlowGroupUrlInfo",
|
6776
|
+
"required": false,
|
6777
|
+
"type": "object"
|
6731
6778
|
}
|
6732
6779
|
],
|
6733
6780
|
"type": "object"
|
@@ -7888,6 +7935,15 @@
|
|
7888
7935
|
"name": "ApproverIdCardNumber",
|
7889
7936
|
"required": false,
|
7890
7937
|
"type": "string"
|
7938
|
+
},
|
7939
|
+
{
|
7940
|
+
"disabled": false,
|
7941
|
+
"document": "合同流程ID,补充合同组子合同动态签署人时必传。",
|
7942
|
+
"example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
|
7943
|
+
"member": "string",
|
7944
|
+
"name": "FlowId",
|
7945
|
+
"required": false,
|
7946
|
+
"type": "string"
|
7891
7947
|
}
|
7892
7948
|
],
|
7893
7949
|
"usage": "in"
|
@@ -8248,7 +8304,7 @@
|
|
8248
8304
|
},
|
8249
8305
|
{
|
8250
8306
|
"disabled": false,
|
8251
|
-
"document": "
|
8307
|
+
"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)",
|
8252
8308
|
"example": "[\"OCR_ESIGN\"]",
|
8253
8309
|
"member": "string",
|
8254
8310
|
"name": "ComponentLimitType",
|
@@ -8302,7 +8358,7 @@
|
|
8302
8358
|
},
|
8303
8359
|
{
|
8304
8360
|
"disabled": false,
|
8305
|
-
"document": "签署人签署合同时的认证方式\n<ul><li> **1** :人脸认证</li>\n<li> **2** :签署密码</li>\n<li> **3** :运营商三要素</li></ul>\n\n默认为1(人脸认证 ),2(签署密码)\n\n注: \n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明",
|
8361
|
+
"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>\n2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明",
|
8306
8362
|
"example": "[1,2,3]",
|
8307
8363
|
"member": "int64",
|
8308
8364
|
"name": "ApproverSignTypes",
|
@@ -8687,6 +8743,56 @@
|
|
8687
8743
|
],
|
8688
8744
|
"usage": "in"
|
8689
8745
|
},
|
8746
|
+
"FlowGroupApproverInfo": {
|
8747
|
+
"document": "合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。",
|
8748
|
+
"members": [
|
8749
|
+
{
|
8750
|
+
"disabled": false,
|
8751
|
+
"document": "合同流程ID。",
|
8752
|
+
"example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
|
8753
|
+
"member": "string",
|
8754
|
+
"name": "FlowId",
|
8755
|
+
"required": false,
|
8756
|
+
"type": "string"
|
8757
|
+
},
|
8758
|
+
{
|
8759
|
+
"disabled": false,
|
8760
|
+
"document": "签署节点ID,用于生成动态签署人链接完成领取。注:`生成动态签署人补充链接时必传。`",
|
8761
|
+
"example": "无",
|
8762
|
+
"member": "string",
|
8763
|
+
"name": "RecipientId",
|
8764
|
+
"required": false,
|
8765
|
+
"type": "string"
|
8766
|
+
}
|
8767
|
+
],
|
8768
|
+
"usage": "in"
|
8769
|
+
},
|
8770
|
+
"FlowGroupApprovers": {
|
8771
|
+
"document": "合同组签署方信息",
|
8772
|
+
"members": [
|
8773
|
+
{
|
8774
|
+
"disabled": false,
|
8775
|
+
"document": "合同流程ID\n注意:此字段可能返回 null,表示取不到有效值。",
|
8776
|
+
"example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
|
8777
|
+
"member": "string",
|
8778
|
+
"name": "FlowId",
|
8779
|
+
"output_required": false,
|
8780
|
+
"type": "string",
|
8781
|
+
"value_allowed_null": true
|
8782
|
+
},
|
8783
|
+
{
|
8784
|
+
"disabled": false,
|
8785
|
+
"document": "签署方信息,包含合同ID和角色ID用于定位RecipientId。\n注意:此字段可能返回 null,表示取不到有效值。",
|
8786
|
+
"example": "无",
|
8787
|
+
"member": "ApproverItem",
|
8788
|
+
"name": "Approvers",
|
8789
|
+
"output_required": false,
|
8790
|
+
"type": "list",
|
8791
|
+
"value_allowed_null": true
|
8792
|
+
}
|
8793
|
+
],
|
8794
|
+
"usage": "out"
|
8795
|
+
},
|
8690
8796
|
"FlowGroupOptions": {
|
8691
8797
|
"document": "合同组的配置项信息包括:在合同组签署过程中,是否需要对每个子合同进行独立的意愿确认。",
|
8692
8798
|
"members": [
|
@@ -8711,6 +8817,21 @@
|
|
8711
8817
|
],
|
8712
8818
|
"usage": "in"
|
8713
8819
|
},
|
8820
|
+
"FlowGroupUrlInfo": {
|
8821
|
+
"document": "合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。",
|
8822
|
+
"members": [
|
8823
|
+
{
|
8824
|
+
"disabled": false,
|
8825
|
+
"document": "合同组子合同和签署方的信息,用于补充动态签署人。\t",
|
8826
|
+
"example": "无",
|
8827
|
+
"member": "FlowGroupApproverInfo",
|
8828
|
+
"name": "FlowGroupApproverInfos",
|
8829
|
+
"required": false,
|
8830
|
+
"type": "list"
|
8831
|
+
}
|
8832
|
+
],
|
8833
|
+
"usage": "in"
|
8834
|
+
},
|
8714
8835
|
"FlowInfo": {
|
8715
8836
|
"document": "此结构体 (FlowInfo) 用于描述签署流程信息。",
|
8716
8837
|
"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": [
|
@@ -376,7 +394,7 @@
|
|
376
394
|
"title": "错误示例-解除协议中更换原合同个人类型的参与人"
|
377
395
|
},
|
378
396
|
{
|
379
|
-
"document": "1. 更换原合同中本方企业的参与人\n2.
|
397
|
+
"document": "1. 更换原合同中本方企业的参与人\n2. 该企业参与人指定为自动签署(ApproverType 设置为 ENTERPRISESERVER)",
|
380
398
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"NeedRelievedFlowId\": \"yDR1AUUgygjazuesUuO4zjESPW4PkfNi\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"ApproverNumber\": 2,\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"OrganizationName\": \"典子谦示例企业\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方以作赔偿\",\n \"OriginalOtherSettlement\": \"无\",\n \"OtherDeals\": \"无\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
|
381
399
|
"output": "{\n \"Response\": {\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"RequestId\": \"s312334445587989\"\n }\n}",
|
382
400
|
"title": "发起解除协议(替换原流程中本企业的参与人并指定其为自动签署)"
|
@@ -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": [
|