tccli 3.0.1027.1__py2.py3-none-any.whl → 3.0.1029.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/asr/v20190614/CreateAsyncRecognitionTask.md +1 -1
- tccli/examples/cls/v20201016/CreateCosRecharge.md +1 -1
- tccli/examples/cls/v20201016/CreateKafkaRecharge.md +9 -8
- tccli/examples/cls/v20201016/CreateScheduledSql.md +1 -1
- tccli/examples/cls/v20201016/GetAlarmLog.md +108 -15
- tccli/examples/cls/v20201016/SearchCosRechargeInfo.md +4 -4
- tccli/examples/oceanus/v20190422/DescribeJobEvents.md +36 -0
- tccli/examples/ocr/v20181119/VatInvoiceVerifyNew.md +56 -0
- tccli/examples/tdmq/v20200217/DescribeNamespaceBundlesOpt.md +1 -23
- tccli/examples/tem/v20210701/CreateCosToken.md +5 -5
- tccli/examples/teo/v20220901/ModifyAccelerationDomainStatuses.md +1 -1
- tccli/examples/tione/v20211111/DescribeBillingResourceGroups.md +72 -22
- tccli/examples/tione/v20211111/DescribeModelAccelerateVersions.md +76 -0
- tccli/examples/tse/v20201207/CreateEngine.md +2 -2
- tccli/examples/vod/v20180717/EnhanceMediaQuality.md +22 -0
- tccli/examples/waf/v20180125/GetAttackHistogram.md +5 -4
- tccli/loaders.py +1 -1
- tccli/services/asr/v20190614/api.json +2 -2
- tccli/services/asr/v20190614/examples.json +1 -1
- tccli/services/cdwdoris/v20211228/api.json +11 -1
- tccli/services/cls/v20201016/api.json +52 -43
- tccli/services/cls/v20201016/examples.json +13 -7
- tccli/services/dlc/v20210125/api.json +7 -4
- tccli/services/ecm/v20190719/api.json +17 -17
- tccli/services/ess/v20201111/api.json +58 -49
- tccli/services/essbasic/v20210526/api.json +18 -18
- tccli/services/essbasic/v20210526/examples.json +1 -1
- tccli/services/lcic/v20220817/api.json +13 -4
- tccli/services/lighthouse/v20200324/api.json +55 -50
- tccli/services/oceanus/oceanus_client.py +57 -4
- tccli/services/oceanus/v20190422/api.json +175 -0
- tccli/services/oceanus/v20190422/examples.json +8 -0
- tccli/services/ocr/v20181119/api.json +548 -10
- tccli/services/ocr/v20181119/examples.json +1 -1
- tccli/services/ssl/v20191205/api.json +54 -11
- tccli/services/tat/v20201028/api.json +1 -1
- tccli/services/tdmq/v20200217/api.json +2 -15
- tccli/services/tdmq/v20200217/examples.json +1 -1
- tccli/services/tem/v20210701/api.json +3 -3
- tccli/services/tem/v20210701/examples.json +3 -3
- tccli/services/teo/v20220901/api.json +4 -2
- tccli/services/teo/v20220901/examples.json +1 -1
- tccli/services/tione/tione_client.py +53 -0
- tccli/services/tione/v20211111/api.json +389 -18
- tccli/services/tione/v20211111/examples.json +10 -2
- tccli/services/tse/v20201207/api.json +7 -3
- tccli/services/tse/v20201207/examples.json +1 -1
- tccli/services/vod/v20180717/api.json +131 -0
- tccli/services/vod/v20180717/examples.json +8 -0
- tccli/services/vod/vod_client.py +53 -0
- tccli/services/waf/v20180125/api.json +10 -7
- tccli/services/waf/v20180125/examples.json +2 -2
- tccli/services/wedata/v20210820/api.json +22 -12
- {tccli-3.0.1027.1.dist-info → tccli-3.0.1029.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1027.1.dist-info → tccli-3.0.1029.1.dist-info}/RECORD +59 -56
- {tccli-3.0.1027.1.dist-info → tccli-3.0.1029.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1027.1.dist-info → tccli-3.0.1029.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1027.1.dist-info → tccli-3.0.1029.1.dist-info}/license_files/LICENSE +0 -0
@@ -7660,7 +7660,7 @@
|
|
7660
7660
|
"example": "无",
|
7661
7661
|
"member": "string",
|
7662
7662
|
"name": "ImageId",
|
7663
|
-
"
|
7663
|
+
"output_required": true,
|
7664
7664
|
"type": "string",
|
7665
7665
|
"value_allowed_null": false
|
7666
7666
|
},
|
@@ -7670,7 +7670,7 @@
|
|
7670
7670
|
"example": "无",
|
7671
7671
|
"member": "string",
|
7672
7672
|
"name": "ImageName",
|
7673
|
-
"
|
7673
|
+
"output_required": true,
|
7674
7674
|
"type": "string",
|
7675
7675
|
"value_allowed_null": false
|
7676
7676
|
},
|
@@ -7680,7 +7680,7 @@
|
|
7680
7680
|
"example": "无",
|
7681
7681
|
"member": "string",
|
7682
7682
|
"name": "ImageState",
|
7683
|
-
"
|
7683
|
+
"output_required": true,
|
7684
7684
|
"type": "string",
|
7685
7685
|
"value_allowed_null": false
|
7686
7686
|
},
|
@@ -7690,7 +7690,7 @@
|
|
7690
7690
|
"example": "无",
|
7691
7691
|
"member": "string",
|
7692
7692
|
"name": "ImageType",
|
7693
|
-
"
|
7693
|
+
"output_required": true,
|
7694
7694
|
"type": "string",
|
7695
7695
|
"value_allowed_null": false
|
7696
7696
|
},
|
@@ -7700,7 +7700,7 @@
|
|
7700
7700
|
"example": "无",
|
7701
7701
|
"member": "string",
|
7702
7702
|
"name": "ImageOsName",
|
7703
|
-
"
|
7703
|
+
"output_required": true,
|
7704
7704
|
"type": "string",
|
7705
7705
|
"value_allowed_null": false
|
7706
7706
|
},
|
@@ -7710,7 +7710,7 @@
|
|
7710
7710
|
"example": "无",
|
7711
7711
|
"member": "string",
|
7712
7712
|
"name": "ImageDescription",
|
7713
|
-
"
|
7713
|
+
"output_required": true,
|
7714
7714
|
"type": "string",
|
7715
7715
|
"value_allowed_null": false
|
7716
7716
|
},
|
@@ -7720,7 +7720,7 @@
|
|
7720
7720
|
"example": "无",
|
7721
7721
|
"member": "string",
|
7722
7722
|
"name": "ImageCreateTime",
|
7723
|
-
"
|
7723
|
+
"output_required": true,
|
7724
7724
|
"type": "string",
|
7725
7725
|
"value_allowed_null": false
|
7726
7726
|
},
|
@@ -7730,7 +7730,7 @@
|
|
7730
7730
|
"example": "无",
|
7731
7731
|
"member": "string",
|
7732
7732
|
"name": "Architecture",
|
7733
|
-
"
|
7733
|
+
"output_required": true,
|
7734
7734
|
"type": "string",
|
7735
7735
|
"value_allowed_null": false
|
7736
7736
|
},
|
@@ -7740,7 +7740,7 @@
|
|
7740
7740
|
"example": "无",
|
7741
7741
|
"member": "string",
|
7742
7742
|
"name": "OsType",
|
7743
|
-
"
|
7743
|
+
"output_required": true,
|
7744
7744
|
"type": "string",
|
7745
7745
|
"value_allowed_null": false
|
7746
7746
|
},
|
@@ -7750,7 +7750,7 @@
|
|
7750
7750
|
"example": "无",
|
7751
7751
|
"member": "string",
|
7752
7752
|
"name": "OsVersion",
|
7753
|
-
"
|
7753
|
+
"output_required": true,
|
7754
7754
|
"type": "string",
|
7755
7755
|
"value_allowed_null": false
|
7756
7756
|
},
|
@@ -7760,7 +7760,7 @@
|
|
7760
7760
|
"example": "无",
|
7761
7761
|
"member": "string",
|
7762
7762
|
"name": "Platform",
|
7763
|
-
"
|
7763
|
+
"output_required": true,
|
7764
7764
|
"type": "string",
|
7765
7765
|
"value_allowed_null": false
|
7766
7766
|
},
|
@@ -7770,7 +7770,7 @@
|
|
7770
7770
|
"example": "无",
|
7771
7771
|
"member": "int64",
|
7772
7772
|
"name": "ImageOwner",
|
7773
|
-
"
|
7773
|
+
"output_required": true,
|
7774
7774
|
"type": "int",
|
7775
7775
|
"value_allowed_null": false
|
7776
7776
|
},
|
@@ -7780,7 +7780,7 @@
|
|
7780
7780
|
"example": "无",
|
7781
7781
|
"member": "int64",
|
7782
7782
|
"name": "ImageSize",
|
7783
|
-
"
|
7783
|
+
"output_required": true,
|
7784
7784
|
"type": "int",
|
7785
7785
|
"value_allowed_null": false
|
7786
7786
|
},
|
@@ -7790,7 +7790,7 @@
|
|
7790
7790
|
"example": "无",
|
7791
7791
|
"member": "SrcImage",
|
7792
7792
|
"name": "SrcImage",
|
7793
|
-
"
|
7793
|
+
"output_required": true,
|
7794
7794
|
"type": "object",
|
7795
7795
|
"value_allowed_null": false
|
7796
7796
|
},
|
@@ -7800,7 +7800,7 @@
|
|
7800
7800
|
"example": "无",
|
7801
7801
|
"member": "string",
|
7802
7802
|
"name": "ImageSource",
|
7803
|
-
"
|
7803
|
+
"output_required": true,
|
7804
7804
|
"type": "string",
|
7805
7805
|
"value_allowed_null": false
|
7806
7806
|
},
|
@@ -7810,7 +7810,7 @@
|
|
7810
7810
|
"example": "无",
|
7811
7811
|
"member": "string",
|
7812
7812
|
"name": "TaskId",
|
7813
|
-
"
|
7813
|
+
"output_required": true,
|
7814
7814
|
"type": "string",
|
7815
7815
|
"value_allowed_null": false
|
7816
7816
|
},
|
@@ -7820,7 +7820,7 @@
|
|
7820
7820
|
"example": "无",
|
7821
7821
|
"member": "bool",
|
7822
7822
|
"name": "IsSupportCloudInit",
|
7823
|
-
"
|
7823
|
+
"output_required": true,
|
7824
7824
|
"type": "bool",
|
7825
7825
|
"value_allowed_null": false
|
7826
7826
|
}
|
@@ -57,7 +57,7 @@
|
|
57
57
|
"status": "online"
|
58
58
|
},
|
59
59
|
"CreateDocument": {
|
60
|
-
"document": "创建签署流程电子文档<br />\n\n注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow\" target=\"_blank\">创建签署流程</a>和<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/StartFlow\" target=\"_blank\">发起签署流程</a>接口使用。具体逻辑可以参考下图:\n\n
|
60
|
+
"document": "创建签署流程电子文档<br />\n\n注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow\" target=\"_blank\">创建签署流程</a>和<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/StartFlow\" target=\"_blank\">发起签署流程</a>接口使用。具体逻辑可以参考下图:\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)",
|
61
61
|
"input": "CreateDocumentRequest",
|
62
62
|
"name": "模板发起合同-创建电子文档",
|
63
63
|
"output": "CreateDocumentResponse",
|
@@ -78,7 +78,7 @@
|
|
78
78
|
"status": "online"
|
79
79
|
},
|
80
80
|
"CreateFlow": {
|
81
|
-
"document": "通过模板创建签署流程<br/>\n适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。\n\n
|
81
|
+
"document": "通过模板创建签署流程<br/>\n适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。\n<table>\n\t<thead>\n\t\t<tr>\n\t\t\t<th>签署人类别</th>\n\t\t\t<th>需要提前准备的信息</th>\n\t\t</tr>\n\t</thead>\n\t<tbody>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署(未认证加入或已认证加入)</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署(已认证加入)</td>\n\t\t\t<td>签署企业的名字、员工在电子签平台的ID(UserId)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>其他企业的员工签署</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>个人(自然人)签署</td>\n\t\t\t<td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>\n\t\t</tr>\n\t</tbody>\n</table>\n\n\n注:配合<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument\" target=\"_blank\">创建电子文档</a>和<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/StartFlow\" target=\"_blank\">发起签署流程</a>接口使用。整体的逻辑如下图\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)\n\n注:**静默(自动)签署不支持合同签署方存在填写**功能",
|
82
82
|
"input": "CreateFlowRequest",
|
83
83
|
"name": "模板发起合同-创建签署流程",
|
84
84
|
"output": "CreateFlowResponse",
|
@@ -92,7 +92,7 @@
|
|
92
92
|
"status": "online"
|
93
93
|
},
|
94
94
|
"CreateFlowByFiles": {
|
95
|
-
"document": "此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>\n
|
95
|
+
"document": "此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>\n适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>\n\n<table>\n\t<thead>\n\t\t<tr>\n\t\t\t<th>签署人类别</th>\n\t\t\t<th>需要提前准备的信息</th>\n\t\t</tr>\n\t</thead>\n\t<tbody>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署(未认证加入或已认证加入)</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署(已认证加入)</td>\n\t\t\t<td>签署企业的名字、员工在电子签平台的ID(UserId)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>其他企业的员工签署</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>个人(自然人)签署</td>\n\t\t\t<td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>\n\t\t</tr>\n\t</tbody>\n</table>\n\n\n\n该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>\n\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)\n\n注:\n- 不同类型的签署方传参不同, 可以参考开发者中心的ApproverInfo结构体说明\n- 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度(**过期,拒签,签署完成,解除完成等状态不会返还额度**)\n- **静默(自动)签署不支持合同签署方存在填写**功能",
|
96
96
|
"input": "CreateFlowByFilesRequest",
|
97
97
|
"name": "用PDF文件创建签署流程",
|
98
98
|
"output": "CreateFlowByFilesResponse",
|
@@ -106,21 +106,21 @@
|
|
106
106
|
"status": "online"
|
107
107
|
},
|
108
108
|
"CreateFlowGroupByFiles": {
|
109
|
-
"document": "此接口(CreateFlowGroupByFiles)可用于通过多个文件创建合同组签署流程。\n\n适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。\n\n注意事项:使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds
|
109
|
+
"document": "此接口(CreateFlowGroupByFiles)可用于通过多个文件创建合同组签署流程。\n\n适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。\n\n注意事项:使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。\n\n注:`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`",
|
110
110
|
"input": "CreateFlowGroupByFilesRequest",
|
111
111
|
"name": "通过多文件创建合同组签署流程",
|
112
112
|
"output": "CreateFlowGroupByFilesResponse",
|
113
113
|
"status": "online"
|
114
114
|
},
|
115
115
|
"CreateFlowGroupByTemplates": {
|
116
|
-
"document": "此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。\n\n
|
116
|
+
"document": "此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。\n\n适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。\n\n注:`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`",
|
117
117
|
"input": "CreateFlowGroupByTemplatesRequest",
|
118
118
|
"name": "通过多模板创建合同组签署流程",
|
119
119
|
"output": "CreateFlowGroupByTemplatesResponse",
|
120
120
|
"status": "online"
|
121
121
|
},
|
122
122
|
"CreateFlowReminds": {
|
123
|
-
"document": "指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:\n\n1.
|
123
|
+
"document": "指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:\n\n1. 发起合同时,**签署人的NotifyType需设置为sms**\n2. 合同中当前状态为 **待签署** 的签署人是催办的对象\n3. **每个合同只能催办一次**\n\n**催办的效果**: 对方会收到如下的短信通知\n![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)\n\n注:`合同催办是白名单功能,请联系客户经理申请开白后使用`",
|
124
124
|
"input": "CreateFlowRemindsRequest",
|
125
125
|
"name": "合同催办",
|
126
126
|
"output": "CreateFlowRemindsResponse",
|
@@ -218,7 +218,7 @@
|
|
218
218
|
"status": "online"
|
219
219
|
},
|
220
220
|
"CreateSchemeUrl": {
|
221
|
-
"document": "获取跳转至腾讯电子签小程序的签署链接\n\n适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。\n\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>\n\n注:\n`1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`\n`2. 签署链接的有效期为90天,超过有效期链接不可用`\n`3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接`\n\n其中小程序的原始Id如下,或者查看小程序信息自助获取。\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
|
221
|
+
"document": "获取跳转至腾讯电子签小程序的签署链接\n\n适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。\n\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>\n\n注:\n`1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`\n\n`2. 签署链接的有效期为90天,超过有效期链接不可用`\n\n`3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接`\n\n其中小程序的原始Id如下,或者查看小程序信息自助获取。\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
|
222
222
|
"input": "CreateSchemeUrlRequest",
|
223
223
|
"name": "获取跳转至腾讯电子签小程序的签署链接",
|
224
224
|
"output": "CreateSchemeUrlResponse",
|
@@ -449,7 +449,7 @@
|
|
449
449
|
"status": "online"
|
450
450
|
},
|
451
451
|
"StartFlow": {
|
452
|
-
"document": "此接口用于启动流程。它是模板发起合同的最后一步。\n在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。\n\n
|
452
|
+
"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注:\n- **合同发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)\n- **静默(自动)签署不支持合同签署方存在填写**功能",
|
453
453
|
"input": "StartFlowRequest",
|
454
454
|
"name": "模板发起合同-发起签署流程",
|
455
455
|
"output": "StartFlowResponse",
|
@@ -470,7 +470,7 @@
|
|
470
470
|
"status": "online"
|
471
471
|
},
|
472
472
|
"UploadFiles": {
|
473
|
-
"document": "此接口(UploadFiles)文件上传。<br/>\n\n适用场景:用于合同,印章的文件上传。文件上传以后,\n如果是PDF格式文件可配合<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles\" target=\"_blank\">用PDF文件创建签署流程</a>接口进行合同流程的发起\n如果是其他类型可以配合<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务</a>接口转换成PDF文件\n\n注: \n1.
|
473
|
+
"document": "此接口(UploadFiles)文件上传。<br/>\n\n适用场景:用于合同,印章的文件上传。文件上传以后,\n如果是PDF格式文件可配合<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles\" target=\"_blank\">用PDF文件创建签署流程</a>接口进行合同流程的发起\n如果是其他类型可以配合<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务</a>接口转换成PDF文件\n\n注: \n1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下\n2. 调用此接口时需要设置单独的Domain请求域名,<font color=\"red\">联调开发环境为: file.test.ess.tencent.cn,正式环境需要设置为:file.ess.tencent.cn</font>,代码示例\n```\nHttpProfile httpProfile = new HttpProfile();\nhttpProfile.setEndpoint(\"file.test.ess.tencent.cn\");\n```",
|
474
474
|
"input": "UploadFilesRequest",
|
475
475
|
"name": "上传文件",
|
476
476
|
"output": "UploadFilesResponse",
|
@@ -2622,7 +2622,7 @@
|
|
2622
2622
|
{
|
2623
2623
|
"disabled": false,
|
2624
2624
|
"document": "合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。\n\n该名称还将用于合同签署完成后的下载文件名。",
|
2625
|
-
"example": "
|
2625
|
+
"example": "2013年采购西红柿合同",
|
2626
2626
|
"member": "string",
|
2627
2627
|
"name": "FlowName",
|
2628
2628
|
"required": true,
|
@@ -2640,7 +2640,7 @@
|
|
2640
2640
|
{
|
2641
2641
|
"disabled": false,
|
2642
2642
|
"document": "本合同流程需包含的PDF文件资源编号列表,通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。\n\n注: `目前,此接口仅支持单个文件发起。`",
|
2643
|
-
"example": "
|
2643
|
+
"example": "[\"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\"]",
|
2644
2644
|
"member": "string",
|
2645
2645
|
"name": "FileIds",
|
2646
2646
|
"required": true,
|
@@ -2649,7 +2649,7 @@
|
|
2649
2649
|
{
|
2650
2650
|
"disabled": false,
|
2651
2651
|
"document": "合同流程描述信息(可自定义此描述),最大长度1000个字符。",
|
2652
|
-
"example": "
|
2652
|
+
"example": "2013年采购西红柿合同10吨",
|
2653
2653
|
"member": "string",
|
2654
2654
|
"name": "FlowDescription",
|
2655
2655
|
"required": false,
|
@@ -2658,7 +2658,7 @@
|
|
2658
2658
|
{
|
2659
2659
|
"disabled": false,
|
2660
2660
|
"document": "合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。",
|
2661
|
-
"example": "
|
2661
|
+
"example": "销售合同",
|
2662
2662
|
"member": "string",
|
2663
2663
|
"name": "FlowType",
|
2664
2664
|
"required": false,
|
@@ -2685,7 +2685,7 @@
|
|
2685
2685
|
{
|
2686
2686
|
"disabled": false,
|
2687
2687
|
"document": "可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:\n<ul><li> **0**:合同发起时通知(默认值)</li>\n<li> **1**:签署完成后通知</li></ul>",
|
2688
|
-
"example": "
|
2688
|
+
"example": "1",
|
2689
2689
|
"member": "int64",
|
2690
2690
|
"name": "CcNotifyType",
|
2691
2691
|
"required": false,
|
@@ -2694,7 +2694,7 @@
|
|
2694
2694
|
{
|
2695
2695
|
"disabled": false,
|
2696
2696
|
"document": "是否为预览模式,取值如下:\n<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>\n<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>",
|
2697
|
-
"example": "
|
2697
|
+
"example": "false",
|
2698
2698
|
"member": "bool",
|
2699
2699
|
"name": "NeedPreview",
|
2700
2700
|
"required": false,
|
@@ -2712,25 +2712,16 @@
|
|
2712
2712
|
{
|
2713
2713
|
"disabled": false,
|
2714
2714
|
"document": "合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。\n如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。",
|
2715
|
-
"example": "
|
2715
|
+
"example": "1703061565",
|
2716
2716
|
"member": "int64",
|
2717
2717
|
"name": "Deadline",
|
2718
2718
|
"required": false,
|
2719
2719
|
"type": "int"
|
2720
2720
|
},
|
2721
|
-
{
|
2722
|
-
"disabled": false,
|
2723
|
-
"document": "合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。\n\n到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。",
|
2724
|
-
"example": "无",
|
2725
|
-
"member": "int64",
|
2726
|
-
"name": "RemindedOn",
|
2727
|
-
"required": false,
|
2728
|
-
"type": "int"
|
2729
|
-
},
|
2730
2721
|
{
|
2731
2722
|
"disabled": false,
|
2732
2723
|
"document": "合同流程的签署顺序类型:\n<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>\n<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>",
|
2733
|
-
"example": "
|
2724
|
+
"example": "true",
|
2734
2725
|
"member": "bool",
|
2735
2726
|
"name": "Unordered",
|
2736
2727
|
"required": false,
|
@@ -2738,35 +2729,26 @@
|
|
2738
2729
|
},
|
2739
2730
|
{
|
2740
2731
|
"disabled": false,
|
2741
|
-
"document": "
|
2742
|
-
"example": "
|
2732
|
+
"document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
|
2733
|
+
"example": "QmFzZTY0IEJhc2U2NCA=",
|
2743
2734
|
"member": "string",
|
2744
|
-
"name": "
|
2735
|
+
"name": "UserData",
|
2745
2736
|
"required": false,
|
2746
2737
|
"type": "string"
|
2747
2738
|
},
|
2748
2739
|
{
|
2749
2740
|
"disabled": false,
|
2750
|
-
"document": "
|
2751
|
-
"example": "
|
2752
|
-
"member": "
|
2753
|
-
"name": "
|
2754
|
-
"required": false,
|
2755
|
-
"type": "bool"
|
2756
|
-
},
|
2757
|
-
{
|
2758
|
-
"disabled": false,
|
2759
|
-
"document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
|
2760
|
-
"example": "无",
|
2761
|
-
"member": "string",
|
2762
|
-
"name": "UserData",
|
2741
|
+
"document": "合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。\n\n到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。",
|
2742
|
+
"example": "1703061565",
|
2743
|
+
"member": "int64",
|
2744
|
+
"name": "RemindedOn",
|
2763
2745
|
"required": false,
|
2764
|
-
"type": "
|
2746
|
+
"type": "int"
|
2765
2747
|
},
|
2766
2748
|
{
|
2767
2749
|
"disabled": false,
|
2768
2750
|
"document": "指定个人签署方查看合同的校验方式\n<ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>\n<li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>",
|
2769
|
-
"example": "
|
2751
|
+
"example": "MobileCheck",
|
2770
2752
|
"member": "string",
|
2771
2753
|
"name": "ApproverVerifyType",
|
2772
2754
|
"required": false,
|
@@ -2781,6 +2763,15 @@
|
|
2781
2763
|
"required": false,
|
2782
2764
|
"type": "int"
|
2783
2765
|
},
|
2766
|
+
{
|
2767
|
+
"disabled": false,
|
2768
|
+
"document": "您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:\n<ul><li>{合同名称} </li>\n<li>{发起方企业} </li>\n<li>{发起方姓名} </li>\n<li>{签署方N企业}</li>\n<li>{签署方N姓名}</li></ul>\n其中,N表示签署方的编号,从1开始,不能超过签署人的数量。\n\n例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子\n\n合同名称:租房合同 \n发起方:腾讯公司(张三) \n签署方:李四\n\n",
|
2769
|
+
"example": "合同名称:{合同名称} {发起方企业} {发起方姓名};国家:中国;发起方:{发起方企业};签署方1: {签署方1企业};签署",
|
2770
|
+
"member": "string",
|
2771
|
+
"name": "CustomShowMap",
|
2772
|
+
"required": false,
|
2773
|
+
"type": "string"
|
2774
|
+
},
|
2784
2775
|
{
|
2785
2776
|
"disabled": false,
|
2786
2777
|
"document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
@@ -2792,12 +2783,21 @@
|
|
2792
2783
|
},
|
2793
2784
|
{
|
2794
2785
|
"disabled": false,
|
2795
|
-
"document": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:\n<ul><li> **E_PRESCRIPTION_AUTO_SIGN
|
2786
|
+
"document": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:\n<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>\n注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`",
|
2796
2787
|
"example": "E_PRESCRIPTION_AUTO_SIGN",
|
2797
2788
|
"member": "string",
|
2798
2789
|
"name": "AutoSignScene",
|
2799
2790
|
"required": false,
|
2800
2791
|
"type": "string"
|
2792
|
+
},
|
2793
|
+
{
|
2794
|
+
"disabled": false,
|
2795
|
+
"document": "发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:\n<ul><li> **false**:(默认)不需要审批,直接签署。</li>\n<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>\n企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果\n<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>\n<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>\n注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`",
|
2796
|
+
"example": "true",
|
2797
|
+
"member": "bool",
|
2798
|
+
"name": "NeedSignReview",
|
2799
|
+
"required": false,
|
2800
|
+
"type": "bool"
|
2801
2801
|
}
|
2802
2802
|
],
|
2803
2803
|
"type": "object"
|
@@ -2924,7 +2924,7 @@
|
|
2924
2924
|
"members": [
|
2925
2925
|
{
|
2926
2926
|
"disabled": false,
|
2927
|
-
"document": "执行本接口操作的员工信息。\n注:
|
2927
|
+
"document": "执行本接口操作的员工信息。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
2928
2928
|
"example": "无",
|
2929
2929
|
"member": "UserInfo",
|
2930
2930
|
"name": "Operator",
|
@@ -3358,7 +3358,7 @@
|
|
3358
3358
|
},
|
3359
3359
|
{
|
3360
3360
|
"disabled": false,
|
3361
|
-
"document": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:\n<ul><li> **E_PRESCRIPTION_AUTO_SIGN
|
3361
|
+
"document": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:\n<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>\n注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`",
|
3362
3362
|
"example": "E_PRESCRIPTION_AUTO_SIGN",
|
3363
3363
|
"member": "string",
|
3364
3364
|
"name": "AutoSignScene",
|
@@ -4435,6 +4435,15 @@
|
|
4435
4435
|
"required": false,
|
4436
4436
|
"type": "string"
|
4437
4437
|
},
|
4438
|
+
{
|
4439
|
+
"disabled": false,
|
4440
|
+
"document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n",
|
4441
|
+
"example": "无",
|
4442
|
+
"member": "CcInfo",
|
4443
|
+
"name": "CcInfos",
|
4444
|
+
"required": false,
|
4445
|
+
"type": "object"
|
4446
|
+
},
|
4438
4447
|
{
|
4439
4448
|
"disabled": false,
|
4440
4449
|
"document": "合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接\n注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`",
|
@@ -4865,7 +4874,7 @@
|
|
4865
4874
|
{
|
4866
4875
|
"disabled": false,
|
4867
4876
|
"document": "生成的签署链接在签署页面隐藏的按钮列表,可设置如下:\n\n<ul><li> **0** :合同签署页面更多操作按钮</li>\n<li> **1** :合同签署页面更多操作的拒绝签署按钮</li>\n<li> **2** :合同签署页面更多操作的转他人处理按钮</li>\n<li> **3** :签署成功页的查看详情按钮</li></ul>\n\n注: `字段为数组, 可以传值隐藏多个按钮`",
|
4868
|
-
"example": "
|
4877
|
+
"example": "[1,2]",
|
4869
4878
|
"member": "int64",
|
4870
4879
|
"name": "Hides",
|
4871
4880
|
"required": false,
|
@@ -8864,7 +8873,7 @@
|
|
8864
8873
|
},
|
8865
8874
|
{
|
8866
8875
|
"disabled": false,
|
8867
|
-
"document": "资源Id
|
8876
|
+
"document": "资源Id(即FileId),用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)",
|
8868
8877
|
"example": "无",
|
8869
8878
|
"member": "string",
|
8870
8879
|
"name": "ResourceId",
|