tccli 3.0.1028.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/ocr/v20181119/VatInvoiceVerifyNew.md +56 -0
- tccli/examples/tdmq/v20200217/DescribeNamespaceBundlesOpt.md +1 -23
- tccli/examples/teo/v20220901/ModifyAccelerationDomainStatuses.md +1 -1
- tccli/examples/tione/v20211111/DescribeBillingResourceGroups.md +72 -22
- tccli/examples/vod/v20180717/EnhanceMediaQuality.md +22 -0
- tccli/services/asr/v20190614/api.json +1 -1
- tccli/services/asr/v20190614/examples.json +1 -1
- tccli/services/dlc/v20210125/api.json +7 -4
- tccli/services/ess/v20201111/api.json +38 -38
- tccli/services/essbasic/v20210526/api.json +10 -10
- tccli/services/essbasic/v20210526/examples.json +1 -1
- tccli/services/lcic/v20220817/api.json +13 -4
- tccli/services/ocr/v20181119/api.json +548 -10
- tccli/services/ocr/v20181119/examples.json +1 -1
- tccli/services/tdmq/v20200217/api.json +2 -15
- tccli/services/tdmq/v20200217/examples.json +1 -1
- tccli/services/teo/v20220901/examples.json +1 -1
- tccli/services/tione/v20211111/api.json +18 -18
- tccli/services/tione/v20211111/examples.json +2 -2
- 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-3.0.1028.1.dist-info → tccli-3.0.1029.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1028.1.dist-info → tccli-3.0.1029.1.dist-info}/RECORD +29 -28
- {tccli-3.0.1028.1.dist-info → tccli-3.0.1029.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1028.1.dist-info → tccli-3.0.1029.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1028.1.dist-info → tccli-3.0.1029.1.dist-info}/license_files/LICENSE +0 -0
tccli/__init__.py
CHANGED
@@ -1 +1 @@
|
|
1
|
-
__version__ = '3.0.
|
1
|
+
__version__ = '3.0.1029.1'
|
@@ -7,7 +7,7 @@ Input:
|
|
7
7
|
```
|
8
8
|
tccli asr CreateAsyncRecognitionTask --cli-unfold-argument \
|
9
9
|
--EngineType 16k_zh \
|
10
|
-
--Url
|
10
|
+
--Url rtmp://test.com/test_stream \
|
11
11
|
--CallbackUrl http://test.com/callback \
|
12
12
|
--SignToken
|
13
13
|
```
|
@@ -30,6 +30,7 @@ Output:
|
|
30
30
|
"CheckCode": "",
|
31
31
|
"Code": "144002288010",
|
32
32
|
"Date": "",
|
33
|
+
"ElectronicType": "",
|
33
34
|
"HasSellerList": "",
|
34
35
|
"IsAbandoned": "N",
|
35
36
|
"Items": [],
|
@@ -99,6 +100,61 @@ Output:
|
|
99
100
|
"TaxtationOrgName": "",
|
100
101
|
"Tonnage": "",
|
101
102
|
"VinNo": ""
|
103
|
+
},
|
104
|
+
"ElectronicTrainTicket": {
|
105
|
+
"BuyerName": "abc",
|
106
|
+
"BuyerTaxCode": "abc",
|
107
|
+
"Number": "abc",
|
108
|
+
"Date": "abc",
|
109
|
+
"TotalCN": "abc",
|
110
|
+
"Tax": "abc",
|
111
|
+
"ServiceType": "abc",
|
112
|
+
"TimeGetOn": "abc",
|
113
|
+
"TrainNumber": "abc",
|
114
|
+
"Code": "abc",
|
115
|
+
"SeatType": "abc",
|
116
|
+
"DateGetOn": "abc",
|
117
|
+
"TrainCabin": "abc",
|
118
|
+
"StationGetOn": "abc",
|
119
|
+
"ElectronicNumber": "abc",
|
120
|
+
"PassengerName": "abc",
|
121
|
+
"PassengerNo": "abc",
|
122
|
+
"Amount": "abc",
|
123
|
+
"StationGetOff": "abc",
|
124
|
+
"TaxRate": "abc",
|
125
|
+
"Seat": "abc",
|
126
|
+
"Total": "abc",
|
127
|
+
"CheckCode": "abc",
|
128
|
+
"StateCode": "0"
|
129
|
+
},
|
130
|
+
"ElectronicAirTransport": {
|
131
|
+
"Code": "abc",
|
132
|
+
"Number": "abc",
|
133
|
+
"Date": "abc",
|
134
|
+
"Amount": "abc",
|
135
|
+
"CheckCode": "abc",
|
136
|
+
"Total": "abc",
|
137
|
+
"DeductionMark": "abc",
|
138
|
+
"StateCode": "abc",
|
139
|
+
"BuyerTaxCode": "abc",
|
140
|
+
"BuyerName": "abc",
|
141
|
+
"DomesticInternationalMark": "abc",
|
142
|
+
"PassengerName": "abc",
|
143
|
+
"PassengerNo": "abc",
|
144
|
+
"ElectronicNumber": "abc",
|
145
|
+
"ElectronicAirTransportDetails": [
|
146
|
+
{
|
147
|
+
"FlightSegment": "abc",
|
148
|
+
"StationGetOn": "abc",
|
149
|
+
"StationGetOff": "abc",
|
150
|
+
"Carrier": "abc",
|
151
|
+
"FlightNumber": "abc",
|
152
|
+
"SeatLevel": "abc",
|
153
|
+
"FlightDate": "abc",
|
154
|
+
"DepartureTime": "abc",
|
155
|
+
"FareBasis": "abc"
|
156
|
+
}
|
157
|
+
]
|
102
158
|
}
|
103
159
|
}
|
104
160
|
}
|
@@ -19,29 +19,7 @@ Output:
|
|
19
19
|
{
|
20
20
|
"Response": {
|
21
21
|
"RequestId": "d2d3e253-3b1d-4471-a350-25e6ae20916c",
|
22
|
-
"TotalCount": 30
|
23
|
-
"BundleSet": [
|
24
|
-
{},
|
25
|
-
{},
|
26
|
-
{},
|
27
|
-
{},
|
28
|
-
{},
|
29
|
-
{},
|
30
|
-
{},
|
31
|
-
{},
|
32
|
-
{},
|
33
|
-
{},
|
34
|
-
{},
|
35
|
-
{},
|
36
|
-
{},
|
37
|
-
{},
|
38
|
-
{},
|
39
|
-
{},
|
40
|
-
{},
|
41
|
-
{},
|
42
|
-
{},
|
43
|
-
{}
|
44
|
-
]
|
22
|
+
"TotalCount": 30
|
45
23
|
}
|
46
24
|
}
|
47
25
|
```
|
@@ -6,47 +6,97 @@ Input:
|
|
6
6
|
|
7
7
|
```
|
8
8
|
tccli tione DescribeBillingResourceGroups --cli-unfold-argument \
|
9
|
-
--
|
10
|
-
--Filters.0.
|
11
|
-
--Filters.0.
|
9
|
+
--Type abc \
|
10
|
+
--Filters.0.Name abc \
|
11
|
+
--Filters.0.Values abc \
|
12
12
|
--Filters.0.Negative True \
|
13
|
-
--
|
14
|
-
--TagFilters.0.TagKey
|
15
|
-
--
|
16
|
-
--SearchWord xx \
|
13
|
+
--Filters.0.Fuzzy True \
|
14
|
+
--TagFilters.0.TagKey abc \
|
15
|
+
--TagFilters.0.TagValues abc \
|
17
16
|
--Offset 0 \
|
18
|
-
--
|
17
|
+
--Limit 0 \
|
18
|
+
--SearchWord abc \
|
19
|
+
--DontShowInstanceSet True
|
19
20
|
```
|
20
21
|
|
21
22
|
Output:
|
22
23
|
```
|
23
24
|
{
|
24
25
|
"Response": {
|
25
|
-
"RequestId": "02be3c0f-d1f1-4a8e-97bd-38128985baa7",
|
26
26
|
"TotalCount": 1,
|
27
27
|
"ResourceGroupSet": [
|
28
28
|
{
|
29
|
-
"ResourceGroupId": "
|
30
|
-
"ResourceGroupName": "
|
29
|
+
"ResourceGroupId": "abc",
|
30
|
+
"ResourceGroupName": "abc",
|
31
|
+
"FreeInstance": 1,
|
31
32
|
"TotalInstance": 1,
|
32
|
-
"UsedResource": {
|
33
|
-
|
33
|
+
"UsedResource": {
|
34
|
+
"Cpu": 1,
|
35
|
+
"Memory": 1,
|
36
|
+
"Gpu": 1,
|
37
|
+
"GpuDetailSet": [
|
38
|
+
{
|
39
|
+
"Name": "abc",
|
40
|
+
"Value": 1
|
41
|
+
}
|
42
|
+
]
|
43
|
+
},
|
44
|
+
"TotalResource": {
|
45
|
+
"Cpu": 1,
|
46
|
+
"Memory": 1,
|
47
|
+
"Gpu": 1,
|
48
|
+
"GpuDetailSet": [
|
49
|
+
{
|
50
|
+
"Name": "abc",
|
51
|
+
"Value": 1
|
52
|
+
}
|
53
|
+
]
|
54
|
+
},
|
34
55
|
"InstanceSet": [
|
35
56
|
{
|
36
|
-
"InstanceId": "
|
37
|
-
"UsedResource": {
|
57
|
+
"InstanceId": "abc",
|
58
|
+
"UsedResource": {
|
59
|
+
"Cpu": 1,
|
60
|
+
"Memory": 1,
|
61
|
+
"Gpu": 1,
|
62
|
+
"GpuType": "abc",
|
63
|
+
"RealGpu": 1,
|
64
|
+
"RealGpuDetailSet": [
|
65
|
+
{
|
66
|
+
"Name": "abc",
|
67
|
+
"Value": 1
|
68
|
+
}
|
69
|
+
]
|
70
|
+
},
|
38
71
|
"TotalResource": {
|
39
|
-
"Cpu":
|
40
|
-
"Memory":
|
72
|
+
"Cpu": 1,
|
73
|
+
"Memory": 1,
|
74
|
+
"Gpu": 1,
|
75
|
+
"GpuType": "abc",
|
76
|
+
"RealGpu": 1
|
41
77
|
},
|
42
|
-
"InstanceStatus": "
|
43
|
-
"
|
44
|
-
"
|
45
|
-
"
|
78
|
+
"InstanceStatus": "abc",
|
79
|
+
"SubUin": "abc",
|
80
|
+
"CreateTime": "abc",
|
81
|
+
"ExpireTime": "abc",
|
82
|
+
"AutoRenewFlag": "abc",
|
83
|
+
"SpecId": "abc",
|
84
|
+
"SpecAlias": "abc",
|
85
|
+
"SpecFeatures": [
|
86
|
+
"abc"
|
87
|
+
],
|
88
|
+
"CvmInstanceId": "abc"
|
89
|
+
}
|
90
|
+
],
|
91
|
+
"TagSet": [
|
92
|
+
{
|
93
|
+
"TagKey": "abc",
|
94
|
+
"TagValue": "abc"
|
46
95
|
}
|
47
96
|
]
|
48
97
|
}
|
49
|
-
]
|
98
|
+
],
|
99
|
+
"RequestId": "abc"
|
50
100
|
}
|
51
101
|
}
|
52
102
|
```
|
@@ -0,0 +1,22 @@
|
|
1
|
+
**Example 1: 发起音画质重生任务**
|
2
|
+
|
3
|
+
对 fileId 为 5285485487985271487 的视频发起音画质重生任务。
|
4
|
+
|
5
|
+
Input:
|
6
|
+
|
7
|
+
```
|
8
|
+
tccli vod EnhanceMediaQuality --cli-unfold-argument \
|
9
|
+
--FileId 5285485487985271487 \
|
10
|
+
--Definition 10
|
11
|
+
```
|
12
|
+
|
13
|
+
Output:
|
14
|
+
```
|
15
|
+
{
|
16
|
+
"Response": {
|
17
|
+
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
|
18
|
+
"TaskId": "125xxx65-EnhanceMediaQuality-bffb15f07530b57bc1aabb01fac74bcc"
|
19
|
+
}
|
20
|
+
}
|
21
|
+
```
|
22
|
+
|
@@ -683,7 +683,7 @@
|
|
683
683
|
},
|
684
684
|
{
|
685
685
|
"disabled": false,
|
686
|
-
"document": "
|
686
|
+
"document": "单标点最多字数(目前仅支持8k_zh/16k_zh引擎)\n**可控制单行字幕最大字数,适用于字幕生成场景**,取值范围:[6,40]\n0:不开启该功能;\n默认值为0\n\n注意:需设置ResTextFormat为3,解析返回的ResultDetail列表,通过结构中FinalSentence获取单个标点断句结果",
|
687
687
|
"example": "0",
|
688
688
|
"member": "int64",
|
689
689
|
"name": "SentenceMaxLength",
|
@@ -19,7 +19,7 @@
|
|
19
19
|
"CreateAsyncRecognitionTask": [
|
20
20
|
{
|
21
21
|
"document": "创建一个异步识别任务,通过接口返回拿到任务ID",
|
22
|
-
"input": "POST / HTTP/1.1\nHost: asr.tencentcloudapi.com\nContent-Type: application/json; charset=utf-8\nX-TC-Version: 2019-06-14\nX-TC-Region: ap-shanghai\nX-TC-Action: CreateAsyncRecognitionTask\nX-TC-Timestamp: 1599140162\nAuthorization: TC3-HMAC-SHA256 Credential=AKIDYu6A16GdCxUlnbTSVItxvhxxx2gpbx2/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=0615f73a69c6b054affd69e4b1cbb68fbe84ae8024a9347df4aa5054933adac8\n<公共请求参数>\n\n{\n \"EngineType\": \"16k_zh\",\n \"Url\": \"
|
22
|
+
"input": "POST / HTTP/1.1\nHost: asr.tencentcloudapi.com\nContent-Type: application/json; charset=utf-8\nX-TC-Version: 2019-06-14\nX-TC-Region: ap-shanghai\nX-TC-Action: CreateAsyncRecognitionTask\nX-TC-Timestamp: 1599140162\nAuthorization: TC3-HMAC-SHA256 Credential=AKIDYu6A16GdCxUlnbTSVItxvhxxx2gpbx2/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=0615f73a69c6b054affd69e4b1cbb68fbe84ae8024a9347df4aa5054933adac8\n<公共请求参数>\n\n{\n \"EngineType\": \"16k_zh\",\n \"Url\": \"rtmp://test.com/test_stream\",\n \"CallbackUrl\": \"http://test.com/callback\",\n \"SignToken\": \"\"\n}",
|
23
23
|
"output": "{\n \"Response\": {\n \"RequestId\": \"fabc2d63-a1b7-40a0-b4c3-640f78974919\",\n \"Data\": {\n \"TaskId\": 1000000007\n }\n }\n}",
|
24
24
|
"title": "语音流异步识别任务创建"
|
25
25
|
}
|
@@ -4383,20 +4383,22 @@
|
|
4383
4383
|
"members": [
|
4384
4384
|
{
|
4385
4385
|
"disabled": false,
|
4386
|
-
"document": "
|
4387
|
-
"example": "
|
4386
|
+
"document": "定时拉起时间:如:周一&周三8点\n注意:此字段可能返回 null,表示取不到有效值。",
|
4387
|
+
"example": "0000101-08:00:00",
|
4388
4388
|
"member": "string",
|
4389
4389
|
"name": "ResumeTime",
|
4390
|
+
"output_required": true,
|
4390
4391
|
"required": false,
|
4391
4392
|
"type": "string",
|
4392
4393
|
"value_allowed_null": true
|
4393
4394
|
},
|
4394
4395
|
{
|
4395
4396
|
"disabled": false,
|
4396
|
-
"document": "
|
4397
|
-
"example": "
|
4397
|
+
"document": "定时挂起时间:如:周一&周三20点\n注意:此字段可能返回 null,表示取不到有效值。",
|
4398
|
+
"example": "0000101-20:00:00",
|
4398
4399
|
"member": "string",
|
4399
4400
|
"name": "SuspendTime",
|
4401
|
+
"output_required": true,
|
4400
4402
|
"required": false,
|
4401
4403
|
"type": "string",
|
4402
4404
|
"value_allowed_null": true
|
@@ -4407,6 +4409,7 @@
|
|
4407
4409
|
"example": "0",
|
4408
4410
|
"member": "int64",
|
4409
4411
|
"name": "SuspendStrategy",
|
4412
|
+
"output_required": true,
|
4410
4413
|
"required": false,
|
4411
4414
|
"type": "int",
|
4412
4415
|
"value_allowed_null": true
|
@@ -78,7 +78,7 @@
|
|
78
78
|
"status": "online"
|
79
79
|
},
|
80
80
|
"CreateFlow": {
|
81
|
-
"document": "通过模板创建签署流程<br/>\n适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。\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注:**静默(自动)签署不支持合同签署方存在填写**功能",
|
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适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>\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![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)\n\n注:\n- 不同类型的签署方传参不同, 可以参考开发者中心的ApproverInfo结构体说明\n- 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度(**过期,拒签,签署完成,解除完成等状态不会返还额度**)\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",
|
@@ -120,7 +120,7 @@
|
|
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",
|
@@ -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)为必填项。",
|
@@ -2798,6 +2789,15 @@
|
|
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"
|
@@ -2950,15 +2950,6 @@
|
|
2950
2950
|
"ChannelCreatePrepareFlowRequest": {
|
2951
2951
|
"document": "ChannelCreatePrepareFlow请求参数结构体",
|
2952
2952
|
"members": [
|
2953
|
-
{
|
2954
|
-
"disabled": false,
|
2955
|
-
"document": "资源id,与ResourceType相对应,取值范围:\n<ul>\n<li>文件Id(通过UploadFiles获取文件资源Id)</li>\n<li>模板Id</li>\n</ul>",
|
2956
|
-
"example": "无",
|
2957
|
-
"member": "string",
|
2958
|
-
"name": "ResourceId",
|
2959
|
-
"required": true,
|
2960
|
-
"type": "string"
|
2961
|
-
},
|
2962
2953
|
{
|
2963
2954
|
"disabled": false,
|
2964
2955
|
"document": "资源类型,取值有:\n<ul><li> **1**:模板</li>\n<li> **2**:文件(默认值)</li></ul>",
|
@@ -2986,6 +2977,15 @@
|
|
2986
2977
|
"required": false,
|
2987
2978
|
"type": "object"
|
2988
2979
|
},
|
2980
|
+
{
|
2981
|
+
"disabled": false,
|
2982
|
+
"document": "资源id,与ResourceType相对应,取值范围:\n<ul>\n<li>文件Id(通过UploadFiles获取文件资源Id)</li>\n<li>模板Id</li>\n</ul>",
|
2983
|
+
"example": "无",
|
2984
|
+
"member": "string",
|
2985
|
+
"name": "ResourceId",
|
2986
|
+
"required": false,
|
2987
|
+
"type": "string"
|
2988
|
+
},
|
2989
2989
|
{
|
2990
2990
|
"disabled": false,
|
2991
2991
|
"document": "合同流程配置信息,用于配置发起合同时定制化如是否允许修改,某些按钮的隐藏等逻辑",
|
@@ -5122,7 +5122,7 @@
|
|
5122
5122
|
},
|
5123
5123
|
{
|
5124
5124
|
"disabled": false,
|
5125
|
-
"document": "在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:\n\n **0** :企业/企业员工(企业签署方或模板发起时的企业静默签)\n **1** :个人/自然人\n**3** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)\n\n注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。\n",
|
5125
|
+
"document": "在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:\n\n **0** :企业/企业员工(企业签署方或模板发起时的企业静默签)\n **1** :个人/自然人\n**3** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)\n\n注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。\n使用自动签时,请确保企业已经开通自动签功能,开通方式:控制台 -> 企业设置 -> 扩展服务 -> 企业自动签。\n使用文件发起自动签时使用前请联系对接的客户经理沟通。\n",
|
5126
5126
|
"example": "1",
|
5127
5127
|
"member": "int64",
|
5128
5128
|
"name": "ApproverType",
|
@@ -277,7 +277,7 @@
|
|
277
277
|
"ChannelCreatePrepareFlow": [
|
278
278
|
{
|
279
279
|
"document": "",
|
280
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"5d18c1c4c8926cd11\"\n },\n \"ProxyOrganizationOpenId\": \"572c69xxxxxx245e4\",\n \"AppId\": \"yDRsbUUgxxxx7ZfBvipOMJ\"\n },\n \"ResourceId\": \"yDwqFUUckp3em41rUwWPgIBjsYgG5bba\",\n \"ResourceType\": 2,\n \"FlowInfo\": {\n \"FlowName\": \"第三方预发起合同-跳过文件上传\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FlowDescription\": \"\",\n \"Deadline\": 0, \n \"Unordered\": false,\n \"IntelligentStatus\": \"CLOSE\",\n \"FormFields\": [],\n \"NeedCreateReview\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"CcInfos\": []\n },\n \"FlowOption\": {\n \"CanEditFlow\": true,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": false,\n \"HideShowFlowType\": false,\n \"HideShowDeadline\": false,\n \"ForbidEditFillComponent\": false,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"FlowApproverList\": [\n {\n \"ApproverType\": 0,\n \"NotChannelOrganization\": false,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n131517\",\n \"ApproverOption\": { \"CanEditApprover\": true },\n \"IsFullText\": true,\n \"PreReadTime\": 0\n\n },\n {\n \"ApproverType\": 1,\n \"ApproverIdCardType\": \"\",\n \"ApproverName\": \"里斯\",\n \"NotChannelOrganization\":false,\n \"ApproverMobile\": \"13312312312\",\n \"IsFullText\": true,\n \"PreReadTime\": 0\n }\n ]\n}",
|
280
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n\n\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"5d18c1c4c8926cd11\"\n },\n \"ProxyOrganizationOpenId\": \"572c69xxxxxx245e4\",\n \"AppId\": \"yDRsbUUgxxxx7ZfBvipOMJ\"\n },\n \"ResourceId\": \"yDwqFUUckp3em41rUwWPgIBjsYgG5bba\",\n \"ResourceType\": 2,\n \"FlowInfo\": {\n \"FlowName\": \"第三方预发起合同-跳过文件上传\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FlowDescription\": \"\",\n \"Deadline\": 0, \n \"Unordered\": false,\n \"IntelligentStatus\": \"CLOSE\",\n \"FormFields\": [],\n \"NeedCreateReview\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"CcInfos\": []\n },\n \"FlowOption\": {\n \"CanEditFlow\": true,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": false,\n \"HideShowFlowType\": false,\n \"HideShowDeadline\": false,\n \"ForbidEditFillComponent\": false,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"FlowApproverList\": [\n {\n \"ApproverType\": 0,\n \"NotChannelOrganization\": false,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n131517\",\n \"ApproverOption\": { \"CanEditApprover\": true },\n \"IsFullText\": true,\n \"PreReadTime\": 0\n\n },\n {\n \"ApproverType\": 1,\n \"ApproverIdCardType\": \"\",\n \"ApproverName\": \"里斯\",\n \"NotChannelOrganization\":false,\n \"ApproverMobile\": \"13312312312\",\n \"IsFullText\": true,\n \"PreReadTime\": 0\n }\n ]\n}",
|
281
281
|
"output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb\",\n \"PreviewFlowUrl\": \"\",\n \"RequestId\": \"c52aaa17-3f81-4640-be03-fca0a553d2e3\"\n }\n}",
|
282
282
|
"title": "文件发起-跳过文件上传"
|
283
283
|
},
|
@@ -1633,7 +1633,7 @@
|
|
1633
1633
|
},
|
1634
1634
|
{
|
1635
1635
|
"disabled": false,
|
1636
|
-
"document": "
|
1636
|
+
"document": "直播类型:0 常规(默认)1 伪直播",
|
1637
1637
|
"example": "0",
|
1638
1638
|
"member": "uint64",
|
1639
1639
|
"name": "LiveType",
|
@@ -3186,7 +3186,7 @@
|
|
3186
3186
|
},
|
3187
3187
|
{
|
3188
3188
|
"disabled": false,
|
3189
|
-
"document": "
|
3189
|
+
"document": "直播类型:0 常规(默认)1 伪直播",
|
3190
3190
|
"example": "0",
|
3191
3191
|
"member": "uint64",
|
3192
3192
|
"name": "LiveType",
|
@@ -5749,7 +5749,7 @@
|
|
5749
5749
|
},
|
5750
5750
|
{
|
5751
5751
|
"disabled": false,
|
5752
|
-
"document": "
|
5752
|
+
"document": "直播类型:0 常规(默认)1 伪直播",
|
5753
5753
|
"example": "0",
|
5754
5754
|
"member": "uint64",
|
5755
5755
|
"name": "LiveType",
|
@@ -5773,6 +5773,15 @@
|
|
5773
5773
|
"name": "EnableAutoStart",
|
5774
5774
|
"required": false,
|
5775
5775
|
"type": "int"
|
5776
|
+
},
|
5777
|
+
{
|
5778
|
+
"disabled": false,
|
5779
|
+
"document": "录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道",
|
5780
|
+
"example": "无",
|
5781
|
+
"member": "string",
|
5782
|
+
"name": "RecordBackground",
|
5783
|
+
"required": false,
|
5784
|
+
"type": "string"
|
5776
5785
|
}
|
5777
5786
|
],
|
5778
5787
|
"usage": "in"
|
@@ -5962,7 +5971,7 @@
|
|
5962
5971
|
},
|
5963
5972
|
{
|
5964
5973
|
"disabled": false,
|
5965
|
-
"document": "
|
5974
|
+
"document": "直播类型:0 常规(默认)1 伪直播\n注意:此字段可能返回 null,表示取不到有效值。",
|
5966
5975
|
"example": "0",
|
5967
5976
|
"member": "uint64",
|
5968
5977
|
"name": "LiveType",
|