tccli 3.0.922.1__py2.py3-none-any.whl → 3.0.924.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/apigateway/v20180808/DescribeServicesStatus.md +33 -19
- tccli/examples/cdb/v20170320/CreateDBInstance.md +2 -2
- tccli/examples/ckafka/v20190819/CreateAcl.md +4 -1
- tccli/examples/clb/v20180317/CloneLoadBalancer.md +3 -3
- tccli/examples/clb/v20180317/DescribeListeners.md +49 -127
- tccli/examples/clb/v20180317/DescribeLoadBalancers.md +578 -158
- tccli/examples/cls/v20201016/CreateScheduledSql.md +13 -11
- tccli/examples/cls/v20201016/DeleteScheduledSql.md +2 -2
- tccli/examples/cls/v20201016/DescribeConfigs.md +2 -1
- tccli/examples/cls/v20201016/DescribeKafkaConsumer.md +23 -0
- tccli/examples/cls/v20201016/DescribeScheduledSqlInfo.md +22 -19
- tccli/examples/cls/v20201016/ModifyKafkaConsumer.md +21 -0
- tccli/examples/cls/v20201016/ModifyScheduledSql.md +11 -9
- tccli/examples/cynosdb/v20190107/DescribeAccounts.md +10 -10
- tccli/examples/cynosdb/v20190107/DescribeClusterDetail.md +77 -65
- tccli/examples/ess/v20201111/CancelUserAutoSignEnableUrl.md +1 -1
- tccli/examples/ess/v20201111/CreateBatchCancelFlowUrl.md +5 -4
- tccli/examples/ess/v20201111/CreateUserAutoSignEnableUrl.md +2 -2
- tccli/examples/ess/v20201111/DescribeFlowBriefs.md +6 -2
- tccli/examples/ess/v20201111/DescribeFlowEvidenceReport.md +1 -1
- tccli/examples/ess/v20201111/DescribeFlowInfo.md +24 -38
- tccli/examples/ess/v20201111/DescribeUserAutoSignStatus.md +1 -1
- tccli/examples/ess/v20201111/GetTaskResultApi.md +2 -2
- tccli/examples/essbasic/v20210526/ChannelBatchCancelFlows.md +5 -5
- tccli/examples/essbasic/v20210526/ChannelCreateBatchCancelFlowUrl.md +10 -8
- tccli/examples/essbasic/v20210526/ChannelCreateFlowSignUrl.md +9 -8
- tccli/examples/essbasic/v20210526/ChannelCreateWebThemeConfig.md +7 -6
- tccli/examples/essbasic/v20210526/DescribeFlowDetailInfo.md +19 -30
- tccli/examples/essbasic/v20210526/DescribeTemplates.md +13 -4
- tccli/examples/essbasic/v20210526/OperateChannelTemplate.md +2 -2
- tccli/examples/lcic/v20220817/DescribeRoom.md +2 -0
- tccli/examples/mna/v20210119/GetDevices.md +9 -16
- tccli/examples/mna/v20210119/UpdateDevice.md +7 -10
- tccli/examples/ms/v20180408/CreateEncryptInstance.md +30 -30
- tccli/examples/ms/v20180408/CreateOrderInstance.md +2 -2
- tccli/examples/ms/v20180408/DescribeEncryptInstances.md +73 -65
- tccli/examples/ms/v20180408/DescribeEncryptPlan.md +34 -34
- tccli/examples/ms/v20180408/DescribeOrderInstances.md +1 -1
- tccli/examples/oceanus/v20190422/CreateJobConfig.md +1 -1
- tccli/examples/tdmq/v20200217/CreateRocketMQVipInstance.md +28 -0
- tccli/examples/tione/v20211111/CreateNotebook.md +62 -0
- tccli/examples/tione/v20211111/CreateNotebookImage.md +18 -0
- tccli/examples/tione/v20211111/DeleteNotebook.md +20 -0
- tccli/examples/tione/v20211111/DeleteNotebookImageRecord.md +18 -0
- tccli/examples/tione/v20211111/DescribeNotebook.md +70 -0
- tccli/examples/tione/v20211111/DescribeNotebookImageKernels.md +23 -0
- tccli/examples/tione/v20211111/DescribeNotebookImageRecords.md +28 -0
- tccli/examples/tione/v20211111/DescribeNotebooks.md +77 -0
- tccli/examples/tione/v20211111/ModifyNotebook.md +64 -0
- tccli/examples/tione/v20211111/ModifyNotebookTags.md +22 -0
- tccli/examples/tione/v20211111/StartNotebook.md +20 -0
- tccli/examples/tione/v20211111/StopCreatingImage.md +18 -0
- tccli/examples/tione/v20211111/StopNotebook.md +20 -0
- tccli/examples/vpc/v20170312/CreateVpnGateway.md +20 -26
- tccli/examples/waf/v20180125/GetAttackHistogram.md +142 -0
- tccli/services/apigateway/v20180808/api.json +119 -12
- tccli/services/apigateway/v20180808/examples.json +4 -4
- tccli/services/asr/v20190614/api.json +1 -1
- tccli/services/cdb/v20170320/api.json +101 -90
- tccli/services/cdb/v20170320/examples.json +2 -2
- tccli/services/cdn/v20180606/api.json +59 -6
- tccli/services/ckafka/v20190819/api.json +10 -10
- tccli/services/ckafka/v20190819/examples.json +1 -1
- tccli/services/clb/v20180317/api.json +221 -68
- tccli/services/clb/v20180317/examples.json +10 -10
- tccli/services/cls/cls_client.py +110 -4
- tccli/services/cls/v20201016/api.json +330 -115
- tccli/services/cls/v20201016/examples.json +23 -7
- tccli/services/cynosdb/v20190107/api.json +82 -31
- tccli/services/cynosdb/v20190107/examples.json +3 -3
- tccli/services/dlc/v20210125/api.json +11 -11
- tccli/services/emr/v20190103/api.json +10 -0
- tccli/services/ess/v20201111/api.json +519 -142
- tccli/services/ess/v20201111/examples.json +9 -9
- tccli/services/essbasic/v20210526/api.json +195 -126
- tccli/services/essbasic/v20210526/examples.json +13 -13
- tccli/services/faceid/v20180301/api.json +21 -16
- tccli/services/lcic/v20220817/api.json +10 -0
- tccli/services/lcic/v20220817/examples.json +2 -2
- tccli/services/live/v20180801/api.json +42 -22
- tccli/services/mna/v20210119/api.json +11 -12
- tccli/services/mna/v20210119/examples.json +4 -4
- tccli/services/mps/v20190612/api.json +142 -61
- tccli/services/ms/v20180408/api.json +92 -19
- tccli/services/ms/v20180408/examples.json +31 -31
- tccli/services/nlp/v20190408/api.json +2 -1
- tccli/services/oceanus/v20190422/api.json +355 -41
- tccli/services/oceanus/v20190422/examples.json +1 -1
- tccli/services/ocr/ocr_client.py +4 -110
- tccli/services/ocr/v20181119/api.json +0 -315
- tccli/services/ocr/v20181119/examples.json +0 -16
- tccli/services/tdmq/tdmq_client.py +53 -0
- tccli/services/tdmq/v20200217/api.json +126 -0
- tccli/services/tdmq/v20200217/examples.json +8 -0
- tccli/services/teo/v20220901/api.json +18 -18
- tccli/services/tione/tione_client.py +987 -298
- tccli/services/tione/v20211111/api.json +1784 -20
- tccli/services/tione/v20211111/examples.json +104 -0
- tccli/services/tts/v20190823/api.json +1 -1
- tccli/services/vpc/v20170312/api.json +45 -65
- tccli/services/vpc/v20170312/examples.json +3 -3
- tccli/services/waf/v20180125/api.json +111 -0
- tccli/services/waf/v20180125/examples.json +8 -0
- tccli/services/waf/waf_client.py +57 -4
- {tccli-3.0.922.1.dist-info → tccli-3.0.924.1.dist-info}/METADATA +2 -2
- {tccli-3.0.922.1.dist-info → tccli-3.0.924.1.dist-info}/RECORD +110 -93
- {tccli-3.0.922.1.dist-info → tccli-3.0.924.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.922.1.dist-info → tccli-3.0.924.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.922.1.dist-info → tccli-3.0.924.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"ChannelBatchCancelFlows": [
|
|
4
4
|
{
|
|
5
5
|
"document": "指定需要批量撤销的签署流程Id，批量撤销合同\n客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口失败后返回错误信息",
|
|
6
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelBatchCancelFlows\n<公共请求参数>\n\n{\n \"FlowIds\": [\n \"
|
|
6
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelBatchCancelFlows\n<公共请求参数>\n\n{\n \"FlowIds\": [\n \"yDwhGUUfe5g******CX8ZwTiSg8gISocy\"\n ],\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"yDR3L****eTdCt5TVx\"\n },\n \"AppId\": \"125***319\",\n \"ProxyOrganizationOpenId\": \"1000***8062\"\n },\n \"CancelMessage\": \"因为合同里边的金额填写错误\",\n \"CancelMessageFormat\": \"0\"\n}",
|
|
7
7
|
"output": "{\n \"Response\": {\n \"FailMessages\": [],\n \"RequestId\": \"c5e01d20-xxxxxx09d3d32b00\"\n }\n}",
|
|
8
8
|
"title": "根据签署流程id批量撤销合同"
|
|
9
9
|
}
|
|
@@ -27,8 +27,8 @@
|
|
|
27
27
|
"ChannelCreateBatchCancelFlowUrl": [
|
|
28
28
|
{
|
|
29
29
|
"document": "指定需要批量撤回的签署流程Id，获取批量撤销链接\n客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回",
|
|
30
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchCancelFlowUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"
|
|
31
|
-
"output": "{\n \"Response\": {\n \"BatchCancelFlowUrl\": \"
|
|
30
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchCancelFlowUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"600***487\",\n \"ProxyOperator\": {\n \"OpenId\": \"7f3497f0****7b0ec\"\n },\n \"AppId\": \"130****4283\"\n },\n \"FlowIds\": [\n \"yDwF*****Xhgx9shH\"\n ]\n}",
|
|
31
|
+
"output": "{\n \"Response\": {\n \"BatchCancelFlowUrl\": \"https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=BATCH_REVOKE_FLOW&tokenId=yDwhCUUck*****dKO5TA&userId=yDxHTUUgydj9*****yrY850RBN&expireOn=1690030266&login=1&verify=1\",\n \"FailMessages\": [\n \"\"\n ],\n \"RequestId\": \"e906c2a4-cb12-4f33-891e-39352d4dee3d\",\n \"UrlExpireOn\": \"2023-07-22 20:51:06\"\n }\n}",
|
|
32
32
|
"title": "根据签署流程id创建批量撤回url"
|
|
33
33
|
}
|
|
34
34
|
],
|
|
@@ -99,8 +99,8 @@
|
|
|
99
99
|
"ChannelCreateFlowSignUrl": [
|
|
100
100
|
{
|
|
101
101
|
"document": "发起流程后，给其中的C端签署人创建签署链接",
|
|
102
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"00498cc***********3aff766cac\"\n },\n \"AppId\": \"
|
|
103
|
-
"output": "{\n \"Response\": {\n \"FlowApproverUrlInfos\": [\n {\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"
|
|
102
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"00498cc***********3aff766cac\"\n },\n \"AppId\": \"100***2432\",\n \"ProxyOrganizationOpenId\": \"d7c13a8***********0ee248f04\"\n },\n \"FlowApproverInfos\": [\n {\n \"Mobile\": \"185***12\",\n \"Name\": \"张三\"\n }\n ],\n \"FlowId\": \"yDRCL*****zjEwg0vjoimj\"\n}",
|
|
103
|
+
"output": "{\n \"Response\": {\n \"FlowApproverUrlInfos\": [\n {\n \"ApproverType\": \"PERSON\",\n \"LongUrl\": \"https://quick.beta.qian.tencent.cn/home?ApproverIdCardNumber=NCoqK***&ApproverIdCardType=ID_CARD&ApproverMobile=MTU4%3D&ApproverName=%25E9%2583%2591%****1%2589&ApproverType=1&Code=yDwhGUUckp3s****z1m3P&CodeType=QUICK&FlowId=yDwhGUUckp3s****T&ShowHeader=1&token=HXC5rU3bEd\",\n \"Mobile\": \"158***3432\",\n \"Name\": \"张三\",\n \"SignUrl\": \"https://test.essurl.cn/HXC5rU3bEd\"\n }\n ],\n \"RequestId\": \"s1690514917653165172\"\n }\n}",
|
|
104
104
|
"title": "创建个人用户H5签署链接"
|
|
105
105
|
}
|
|
106
106
|
],
|
|
@@ -161,8 +161,8 @@
|
|
|
161
161
|
"ChannelCreateWebThemeConfig": [
|
|
162
162
|
{
|
|
163
163
|
"document": "生成嵌入式主题",
|
|
164
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateWebThemeConfig\n<公共请求参数>\n\n{\n \"
|
|
165
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
164
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateWebThemeConfig\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDRsbUUgy***y8lsS7ZfBvipOMJ\",\n \"ProxyAppId\": \"yDRTvUUgyg***7yEkoMkHXm\",\n \"ProxyOperator\": {\n \"OpenId\": \"5d18c1c4****--3a0c8926cd11\"\n },\n \"ProxyOrganizationOpenId\": \"572c69b2-****-14e06d1245e4\"\n },\n \"ThemeType\": \"EMBED_WEB_THEME\",\n \"WebThemeConfig\": {\n \"DisplaySignBrandLogo\": true,\n \"WebEmbedThemeColor\": \"#4de813\"\n }\n}",
|
|
165
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"s169*****642528438\"\n }\n}",
|
|
166
166
|
"title": "生成嵌入式主题"
|
|
167
167
|
}
|
|
168
168
|
],
|
|
@@ -316,7 +316,7 @@
|
|
|
316
316
|
{
|
|
317
317
|
"document": "查询签署流程合同的详细信息",
|
|
318
318
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFlowDetailInfo\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"子客企业经办人id\"\n },\n \"ProxyOrganizationOpenId\": \"子客企业第三方id\",\n \"AppId\": \"16fd2f7d7xxxxx5f8d501d57b5ec\"\n },\n \"FlowIds\": [\n \"yDxjGUUgydjxxxxxzjERvGKmZJeX\"\n ]\n}",
|
|
319
|
-
"output": "{\n \"Response\": {\n \"ApplicationId\": \"
|
|
319
|
+
"output": "{\n \"Response\": {\n \"ApplicationId\": \"yDwcC******ciRHST9jtYB\",\n \"FlowGroupId\": \"\",\n \"FlowGroupName\": \"\",\n \"FlowInfo\": [\n {\n \"CcInfos\": [],\n \"CreateOn\": 1686120086,\n \"CustomData\": \"\",\n \"DeadLine\": 1717656086,\n \"FlowApproverInfos\": [\n {\n \"ApproveMessage\": \"\",\n \"ApproveName\": \"张三\",\n \"ApproveStatus\": \"PENDING\",\n \"ApproveTime\": 0,\n \"ApproveType\": \"PERSON\",\n \"Mobile\": \"133*****75\",\n \"ProxyOperatorOpenId\": \"oHeIG5gF****TXeXZrb4\",\n \"ProxyOrganizationName\": \"\",\n \"ProxyOrganizationOpenId\": \"\",\n \"ReceiptId\": \"yDwg4UUc****QEAn6BWc39jZVY\",\n \"SignOrder\": 0\n }\n ],\n \"FlowId\": \"yDwg4UUc******6CLBKPEvnl\",\n \"FlowMessage\": \"\",\n \"FlowName\": \"电子合同\",\n \"FlowStatus\": \"INIT\",\n \"FlowType\": \"\",\n \"NeedCreateReview\": false\n }\n ],\n \"ProxyOrganizationOpenId\": \"t1td99d*****d28ec280dd4\",\n \"RequestId\": \"c1f80560-****-ae0be7462559\"\n }\n}",
|
|
320
320
|
"title": "查询签署流程合同的详细信息"
|
|
321
321
|
}
|
|
322
322
|
],
|
|
@@ -332,19 +332,19 @@
|
|
|
332
332
|
{
|
|
333
333
|
"document": "查询有效模板列表",
|
|
334
334
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTemplates\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"yDxAyUyK****cb7u0jQn0Zh7f7\",\n \"ProxyOperator\": {\n \"OpenId\": \"732aaef****541b89c49e0cc\"\n },\n \"AppId\": \"ed68bc6***********0214e4e\"\n },\n \"TemplateId\": \"templated_test_id\",\n \"ContentType\": 1,\n \"Offset\": 0,\n \"Limit\": 2\n}",
|
|
335
|
-
"output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"ChannelAutoSave\": 0,\n \"PdfUrl\": \"test\",\n \"Description\": \"test\",\n \"Recipients\": [\n {\n \"RecipientType\": \"test\",\n \"Description\": \"test\",\n \"RoutingOrder\": 0,\n \"SignType\": 0,\n \"RecipientId\": \"test\",\n \"IsPromoter\": true,\n \"RequireValidation\": true,\n \"RoleName\": \"test\",\n \"RequireSign\": true\n }\n ],\n \"TemplateName\": \"test\",\n \"CreatedOn\": 1234567890,\n \"Creator\": \"test\",\n \"ChannelTemplateName\": \"test\",\n \"SignComponents\": [\n {\n \"ComponentValue\": \"test\",\n \"FileIndex\": 0,\n \"OffsetX\": 0
|
|
335
|
+
"output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"ChannelAutoSave\": 0,\n \"PdfUrl\": \"test\",\n \"Description\": \"test\",\n \"Recipients\": [\n {\n \"RecipientType\": \"test\",\n \"Description\": \"test\",\n \"RoutingOrder\": 0,\n \"SignType\": 0,\n \"RecipientId\": \"test\",\n \"IsPromoter\": true,\n \"RequireValidation\": true,\n \"RoleName\": \"test\",\n \"RequireSign\": true\n }\n ],\n \"TemplateName\": \"test\",\n \"CreatedOn\": 1234567890,\n \"Creator\": \"test\",\n \"ChannelTemplateName\": \"test\",\n \"Available\": 2,\n \"SignComponents\": [\n {\n \"ComponentValue\": \"test\",\n \"FileIndex\": 0,\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ComponentType\": \"test\",\n \"ComponentPosX\": 1241.15,\n \"ComponentPosY\": 125.12,\n \"GenerateMode\": \"test\",\n \"KeywordIndexes\": [\n 0\n ],\n \"ComponentDateFontSize\": 0,\n \"RelativeLocation\": \"test\",\n \"ComponentHeight\": 12.142,\n \"ComponentDescription\": \"test\",\n \"ComponentRequired\": true,\n \"ComponentId\": \"test\",\n \"ComponentRecipientId\": \"test\",\n \"KeywordPage\": 0,\n \"ComponentWidth\": 1.1,\n \"ComponentName\": \"test\",\n \"ChannelComponentId\": \"test\",\n \"ComponentExtra\": \"test\",\n \"ComponentPage\": 1,\n \"KeywordOrder\": \"test\",\n \"Placeholder\": \"\",\n \"DocumentId\": \"test\"\n }\n ],\n \"TemplateType\": 0,\n \"IsPromoter\": true,\n \"PreviewUrl\": \"test\",\n \"Components\": [\n {\n \"ComponentValue\": \"test\",\n \"FileIndex\": 0,\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ComponentType\": \"test\",\n \"ComponentPosX\": 1241.15,\n \"ComponentPosY\": 125.12,\n \"GenerateMode\": \"test\",\n \"KeywordIndexes\": [\n 0\n ],\n \"ComponentDateFontSize\": 0,\n \"RelativeLocation\": \"test\",\n \"ComponentHeight\": 12.142,\n \"ComponentDescription\": \"test\",\n \"ComponentRequired\": true,\n \"ComponentId\": \"test\",\n \"ComponentRecipientId\": \"test\",\n \"KeywordPage\": 0,\n \"ComponentWidth\": 1.1,\n \"ComponentName\": \"test\",\n \"ChannelComponentId\": \"test\",\n \"ComponentExtra\": \"test\",\n \"ComponentPage\": 1,\n \"KeywordOrder\": \"test\",\n \"Placeholder\": \"\",\n \"DocumentId\": \"test\"\n }\n ],\n \"TemplateId\": \"test\",\n \"TemplateVersion\": \"test\",\n \"ChannelTemplateId\": \"test\"\n }\n ],\n \"TotalCount\": 1,\n \"Limit\": 1,\n \"RequestId\": \"test\",\n \"Offset\": 1\n }\n}",
|
|
336
336
|
"title": "查询有效模板列表"
|
|
337
337
|
},
|
|
338
338
|
{
|
|
339
339
|
"document": "返回所有component",
|
|
340
340
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTemplates\n<公共请求参数>\n\n{\n \"QueryAllComponents\": \"true\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test1xxxxx_test1\"\n },\n \"AppId\": \"7f3497fxxx35e0984a9657b0ec\",\n \"ProxyOrganizationOpenId\": \"test1_clarxxxnization1\"\n },\n \"TemplateId\": \"yDR0JUUgygxxxxjESIpKDSkE9\"\n}",
|
|
341
|
-
"output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": \"test\",\n \"TemplateName\": \"test\",\n \"Description\": \"test\",\n \"Components\": [\n {\n \"ComponentId\": \"test\",\n \"ComponentType\": \"test\",\n \"ComponentName\": \"test\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"test\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"test\",\n \"ComponentWidth\": 0,\n \"ComponentHeight\": 0,\n \"ComponentPage\": 0,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"test\",\n \"ComponentValue\": \"test\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"test\",\n \"ComponentDescription\": \"test\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"test\",\n \"KeywordOrder\": \"test\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"test\",\n \"KeywordIndexes\": [\n 0\n ]\n }\n ],\n \"Recipients\": [\n {\n \"RecipientId\": \"test\",\n \"RecipientType\": \"test\",\n \"Description\": \"test\",\n \"RoleName\": \"test\",\n \"RequireValidation\": true,\n \"RequireSign\": true,\n \"SignType\": 0,\n \"RoutingOrder\": 0,\n \"IsPromoter\": true\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentId\": \"test\",\n \"ComponentType\": \"test\",\n \"ComponentName\": \"test\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"test\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"test\",\n \"ComponentWidth\": 0,\n \"ComponentHeight\": 0,\n \"ComponentPage\": 0,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"test\",\n \"ComponentValue\": \"test\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"test\",\n \"ComponentDescription\": \"test\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"test\",\n \"KeywordOrder\": \"test\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"test\",\n \"KeywordIndexes\": [\n 0\n ]\n }\n ],\n \"TemplateType\": 0,\n \"IsPromoter\": true,\n \"Creator\": \"test\",\n \"CreatedOn\": 0,\n \"PreviewUrl\": \"test\",\n \"PdfUrl\": \"test\",\n \"ChannelTemplateId\": \"test\",\n \"ChannelTemplateName\": \"test\",\n \"ChannelAutoSave\": 0,\n \"TemplateVersion\": \"test\"\n }\n ],\n \"TotalCount\": 0,\n \"Limit\": 1,\n \"Offset\": 1,\n \"RequestId\": \"test\"\n }\n}",
|
|
341
|
+
"output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": \"test\",\n \"TemplateName\": \"test\",\n \"Description\": \"test\",\n \"Available\": 2,\n \"Components\": [\n {\n \"ComponentId\": \"test\",\n \"ComponentType\": \"test\",\n \"ComponentName\": \"test\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"test\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"test\",\n \"ComponentWidth\": 0,\n \"ComponentHeight\": 0,\n \"ComponentPage\": 0,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"test\",\n \"ComponentValue\": \"test\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"test\",\n \"ComponentDescription\": \"test\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"test\",\n \"KeywordOrder\": \"test\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"test\",\n \"Placeholder\": \"\",\n \"KeywordIndexes\": [\n 0\n ]\n }\n ],\n \"Recipients\": [\n {\n \"RecipientId\": \"test\",\n \"RecipientType\": \"test\",\n \"Description\": \"test\",\n \"RoleName\": \"test\",\n \"RequireValidation\": true,\n \"RequireSign\": true,\n \"SignType\": 0,\n \"RoutingOrder\": 0,\n \"IsPromoter\": true\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentId\": \"test\",\n \"ComponentType\": \"test\",\n \"ComponentName\": \"test\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"test\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"test\",\n \"ComponentWidth\": 0,\n \"ComponentHeight\": 0,\n \"ComponentPage\": 0,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"test\",\n \"ComponentValue\": \"test\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"test\",\n \"ComponentDescription\": \"test\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"test\",\n \"KeywordOrder\": \"test\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"test\",\n \"Placeholder\": \"\",\n \"KeywordIndexes\": [\n 0\n ]\n }\n ],\n \"TemplateType\": 0,\n \"IsPromoter\": true,\n \"Creator\": \"test\",\n \"CreatedOn\": 0,\n \"PreviewUrl\": \"test\",\n \"PdfUrl\": \"test\",\n \"ChannelTemplateId\": \"test\",\n \"ChannelTemplateName\": \"test\",\n \"ChannelAutoSave\": 0,\n \"TemplateVersion\": \"test\"\n }\n ],\n \"TotalCount\": 0,\n \"Limit\": 1,\n \"Offset\": 1,\n \"RequestId\": \"test\"\n }\n}",
|
|
342
342
|
"title": "返回所有component"
|
|
343
343
|
},
|
|
344
344
|
{
|
|
345
345
|
"document": "模糊搜索模板名",
|
|
346
346
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTemplates\n<公共请求参数>\n\n{\n \"TemplateName\": \"顺序签署\",\n \"QueryAllComponents\": \"true\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test1xxxa_test1\"\n },\n \"AppId\": \"7f3497f015xxxxe0984a9657b0ec\",\n \"ProxyOrganizationOpenId\": \"test1_claraxxxanization1\"\n },\n \"Limit\": \"2\"\n}",
|
|
347
|
-
"output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": \"test\",\n \"TemplateName\": \"test\",\n \"Description\": \"test\",\n \"Components\": [\n {\n \"ComponentId\": \"test\",\n \"ComponentType\": \"test\",\n \"ComponentName\": \"test\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"test\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"test\",\n \"ComponentWidth\": 0,\n \"ComponentHeight\": 0,\n \"ComponentPage\": 0,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"test\",\n \"ComponentValue\": \"test\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"test\",\n \"ComponentDescription\": \"test\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"test\",\n \"KeywordOrder\": \"test\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"test\",\n \"KeywordIndexes\": [\n 0\n ]\n }\n ],\n \"Recipients\": [\n {\n \"RecipientId\": \"test\",\n \"RecipientType\": \"test\",\n \"Description\": \"test\",\n \"RoleName\": \"test\",\n \"RequireValidation\": true,\n \"RequireSign\": true,\n \"SignType\": 0,\n \"RoutingOrder\": 0,\n \"IsPromoter\": true\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentId\": \"test\",\n \"ComponentType\": \"test\",\n \"ComponentName\": \"test\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"test\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"test\",\n \"ComponentWidth\": 0,\n \"ComponentHeight\": 0,\n \"ComponentPage\": 0,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"test\",\n \"ComponentValue\": \"test\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"test\",\n \"ComponentDescription\": \"test\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"test\",\n \"KeywordOrder\": \"test\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"test\",\n \"KeywordIndexes\": [\n 0\n ]\n }\n ],\n \"TemplateType\": 0,\n \"IsPromoter\": true,\n \"Creator\": \"test\",\n \"CreatedOn\": 0,\n \"PreviewUrl\": \"test\",\n \"PdfUrl\": \"test\",\n \"ChannelTemplateId\": \"test\",\n \"ChannelTemplateName\": \"test\",\n \"ChannelAutoSave\": 0,\n \"TemplateVersion\": \"test\"\n }\n ],\n \"TotalCount\": 0,\n \"Limit\": 1,\n \"Offset\": 1,\n \"RequestId\": \"test\"\n }\n}",
|
|
347
|
+
"output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": \"test\",\n \"TemplateName\": \"test\",\n \"Description\": \"test\",\n \"Available\": 2,\n \"Components\": [\n {\n \"ComponentId\": \"test\",\n \"ComponentType\": \"test\",\n \"ComponentName\": \"test\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"test\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"test\",\n \"ComponentWidth\": 0,\n \"ComponentHeight\": 0,\n \"ComponentPage\": 0,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"test\",\n \"ComponentValue\": \"test\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"test\",\n \"ComponentDescription\": \"test\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"test\",\n \"KeywordOrder\": \"test\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"test\",\n \"Placeholder\": \"\",\n \"KeywordIndexes\": [\n 0\n ]\n }\n ],\n \"Recipients\": [\n {\n \"RecipientId\": \"test\",\n \"RecipientType\": \"test\",\n \"Description\": \"test\",\n \"RoleName\": \"test\",\n \"RequireValidation\": true,\n \"RequireSign\": true,\n \"SignType\": 0,\n \"RoutingOrder\": 0,\n \"IsPromoter\": true\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentId\": \"test\",\n \"ComponentType\": \"test\",\n \"ComponentName\": \"test\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"test\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"test\",\n \"ComponentWidth\": 0,\n \"ComponentHeight\": 0,\n \"ComponentPage\": 0,\n \"ComponentPosX\": 0,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"test\",\n \"ComponentValue\": \"test\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"test\",\n \"ComponentDescription\": \"test\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"test\",\n \"KeywordOrder\": \"test\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"test\",\n \"Placeholder\": \"\",\n \"KeywordIndexes\": [\n 0\n ]\n }\n ],\n \"TemplateType\": 0,\n \"IsPromoter\": true,\n \"Creator\": \"test\",\n \"CreatedOn\": 0,\n \"PreviewUrl\": \"test\",\n \"PdfUrl\": \"test\",\n \"ChannelTemplateId\": \"test\",\n \"ChannelTemplateName\": \"test\",\n \"ChannelAutoSave\": 0,\n \"TemplateVersion\": \"test\"\n }\n ],\n \"TotalCount\": 0,\n \"Limit\": 1,\n \"Offset\": 1,\n \"RequestId\": \"test\"\n }\n}",
|
|
348
348
|
"title": "模糊搜索模板名"
|
|
349
349
|
}
|
|
350
350
|
],
|
|
@@ -393,8 +393,8 @@
|
|
|
393
393
|
"OperateChannelTemplate": [
|
|
394
394
|
{
|
|
395
395
|
"document": "查询模板库中的模板信息",
|
|
396
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: OperateChannelTemplate\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"
|
|
397
|
-
"output": "{\n \"Response\": {\n \"AppId\": \"
|
|
396
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: OperateChannelTemplate\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yD*****id\"\n },\n \"TemplateId\": \"yDxlkUyKxxxxxxxxxjEvToNRI2MuTr\",\n \"OperateType\": \"select\"\n}",
|
|
397
|
+
"output": "{\n \"Response\": {\n \"AppId\": \"yD*****id\",\n \"AuthTag\": \"all\",\n \"FailMessageList\": [],\n \"OperateResult\": \"all-success\",\n \"ProxyOrganizationOpenIds\": [\n \"子客企业1\",\n \"子客企业2\"\n ],\n \"TemplateId\": \"yDxlkUyKQDpMxxxxxoNRI2MuTr\",\n \"RequestId\": \"s16395xxxxx249716125\"\n }\n}",
|
|
398
398
|
"title": "查询模板库中的模板信息"
|
|
399
399
|
},
|
|
400
400
|
{
|
|
@@ -243,30 +243,30 @@
|
|
|
243
243
|
"document": "BankCard2EVerification请求参数结构体",
|
|
244
244
|
"members": [
|
|
245
245
|
{
|
|
246
|
-
"default": "",
|
|
247
246
|
"disabled": false,
|
|
248
247
|
"document": "姓名",
|
|
249
248
|
"example": "张三",
|
|
249
|
+
"is_base64": false,
|
|
250
250
|
"member": "string",
|
|
251
251
|
"name": "Name",
|
|
252
252
|
"required": true,
|
|
253
253
|
"type": "string"
|
|
254
254
|
},
|
|
255
255
|
{
|
|
256
|
-
"default": "",
|
|
257
256
|
"disabled": false,
|
|
258
257
|
"document": "银行卡",
|
|
259
258
|
"example": "6222222222222222222",
|
|
259
|
+
"is_base64": false,
|
|
260
260
|
"member": "string",
|
|
261
261
|
"name": "BankCard",
|
|
262
262
|
"required": true,
|
|
263
263
|
"type": "string"
|
|
264
264
|
},
|
|
265
265
|
{
|
|
266
|
-
"default": "",
|
|
267
266
|
"disabled": false,
|
|
268
267
|
"document": "敏感数据加密信息。对传入信息（姓名、银行卡号）有加密需求的用户可使用此参数，详情请点击左侧链接。",
|
|
269
268
|
"example": "无",
|
|
269
|
+
"is_base64": false,
|
|
270
270
|
"member": "Encryption",
|
|
271
271
|
"name": "Encryption",
|
|
272
272
|
"required": false,
|
|
@@ -280,11 +280,11 @@
|
|
|
280
280
|
"members": [
|
|
281
281
|
{
|
|
282
282
|
"disabled": false,
|
|
283
|
-
"document": "认证结果码\n计费结果码：\n '0': '认证通过'\n '-1': '认证未通过'\n '-4': '持卡人信息有误'\n '-5': '未开通无卡支付'\n '-6': '此卡被没收'\n '-7': '无效卡号'\n '-8': '此卡无对应发卡行'\n '-9': '该卡未初始化或睡眠卡'\n '-10': '作弊卡、吞卡'\n '-11': '此卡已挂失'\n '-12': '该卡已过期'\n '-13': '受限制的卡'\n '-14': '密码错误次数超限'\n '-15': '发卡行不支持此交易'\n不计费结果码：\n '-2': '姓名校验不通过'\n '-3': '银行卡号码有误'\n '-16': '验证中心服务繁忙'",
|
|
283
|
+
"document": "认证结果码\n计费结果码：\n '0': '认证通过'\n '-1': '认证未通过'\n '-4': '持卡人信息有误'\n '-5': '未开通无卡支付'\n '-6': '此卡被没收'\n '-7': '无效卡号'\n '-8': '此卡无对应发卡行'\n '-9': '该卡未初始化或睡眠卡'\n '-10': '作弊卡、吞卡'\n '-11': '此卡已挂失'\n '-12': '该卡已过期'\n '-13': '受限制的卡'\n '-14': '密码错误次数超限'\n '-15': '发卡行不支持此交易'\n不计费结果码：\n '-2': '姓名校验不通过'\n '-3': '银行卡号码有误'\n '-16': '验证中心服务繁忙'\n '-17': '验证次数超限，请次日重试'\n",
|
|
284
284
|
"example": "0",
|
|
285
285
|
"member": "string",
|
|
286
286
|
"name": "Result",
|
|
287
|
-
"
|
|
287
|
+
"output_required": true,
|
|
288
288
|
"type": "string",
|
|
289
289
|
"value_allowed_null": false
|
|
290
290
|
},
|
|
@@ -294,7 +294,7 @@
|
|
|
294
294
|
"example": "认证通过",
|
|
295
295
|
"member": "string",
|
|
296
296
|
"name": "Description",
|
|
297
|
-
"
|
|
297
|
+
"output_required": true,
|
|
298
298
|
"type": "string",
|
|
299
299
|
"value_allowed_null": false
|
|
300
300
|
},
|
|
@@ -311,60 +311,60 @@
|
|
|
311
311
|
"document": "BankCard4EVerification请求参数结构体",
|
|
312
312
|
"members": [
|
|
313
313
|
{
|
|
314
|
-
"default": "",
|
|
315
314
|
"disabled": false,
|
|
316
315
|
"document": "姓名",
|
|
317
316
|
"example": "张三",
|
|
317
|
+
"is_base64": false,
|
|
318
318
|
"member": "string",
|
|
319
319
|
"name": "Name",
|
|
320
320
|
"required": true,
|
|
321
321
|
"type": "string"
|
|
322
322
|
},
|
|
323
323
|
{
|
|
324
|
-
"default": "",
|
|
325
324
|
"disabled": false,
|
|
326
325
|
"document": "银行卡",
|
|
327
326
|
"example": "6222222222222222222",
|
|
327
|
+
"is_base64": false,
|
|
328
328
|
"member": "string",
|
|
329
329
|
"name": "BankCard",
|
|
330
330
|
"required": true,
|
|
331
331
|
"type": "string"
|
|
332
332
|
},
|
|
333
333
|
{
|
|
334
|
-
"default": "",
|
|
335
334
|
"disabled": false,
|
|
336
335
|
"document": "手机号码",
|
|
337
336
|
"example": "6222222222222222222",
|
|
337
|
+
"is_base64": false,
|
|
338
338
|
"member": "string",
|
|
339
339
|
"name": "Phone",
|
|
340
340
|
"required": true,
|
|
341
341
|
"type": "string"
|
|
342
342
|
},
|
|
343
343
|
{
|
|
344
|
-
"default": "",
|
|
345
344
|
"disabled": false,
|
|
346
345
|
"document": "开户证件号，与CertType参数的证件类型一致，如：身份证，则传入身份证号。",
|
|
347
346
|
"example": "6222222222222222222",
|
|
347
|
+
"is_base64": false,
|
|
348
348
|
"member": "string",
|
|
349
349
|
"name": "IdCard",
|
|
350
350
|
"required": true,
|
|
351
351
|
"type": "string"
|
|
352
352
|
},
|
|
353
353
|
{
|
|
354
|
-
"default": "",
|
|
355
354
|
"disabled": false,
|
|
356
355
|
"document": "证件类型，请确认该证件为开户时使用的证件类型，未用于开户的证件信息不支持验证。\n目前默认为0：身份证，其他证件类型暂不支持。",
|
|
357
356
|
"example": "0",
|
|
357
|
+
"is_base64": false,
|
|
358
358
|
"member": "int64",
|
|
359
359
|
"name": "CertType",
|
|
360
360
|
"required": false,
|
|
361
361
|
"type": "int"
|
|
362
362
|
},
|
|
363
363
|
{
|
|
364
|
-
"default": "",
|
|
365
364
|
"disabled": false,
|
|
366
365
|
"document": "敏感数据加密信息。对传入信息（姓名、身份证号、手机号、银行卡号）有加密需求的用户可使用此参数，详情请点击左侧链接。",
|
|
367
366
|
"example": "无",
|
|
367
|
+
"is_base64": false,
|
|
368
368
|
"member": "Encryption",
|
|
369
369
|
"name": "Encryption",
|
|
370
370
|
"required": false,
|
|
@@ -378,11 +378,11 @@
|
|
|
378
378
|
"members": [
|
|
379
379
|
{
|
|
380
380
|
"disabled": false,
|
|
381
|
-
"document": "认证结果码\n收费结果码：\n'0': '认证通过'\n'-1': '认证未通过'\n'-6': '持卡人信息有误'\n'-7': '未开通无卡支付'\n'-8': '此卡被没收'\n'-9': '无效卡号'\n'-10': '此卡无对应发卡行'\n'-11': '该卡未初始化或睡眠卡'\n'-12': '作弊卡、吞卡'\n'-13': '此卡已挂失'\n'-14': '该卡已过期'\n'-15': '受限制的卡'\n'-16': '密码错误次数超限'\n'-17': '发卡行不支持此交易'\n不收费结果码：\n'-2': '姓名校验不通过'\n'-3': '身份证号码有误'\n'-4': '银行卡号码有误'\n'-5': '手机号码不合法'\n'-18': '验证中心服务繁忙'",
|
|
381
|
+
"document": "认证结果码\n收费结果码：\n'0': '认证通过'\n'-1': '认证未通过'\n'-6': '持卡人信息有误'\n'-7': '未开通无卡支付'\n'-8': '此卡被没收'\n'-9': '无效卡号'\n'-10': '此卡无对应发卡行'\n'-11': '该卡未初始化或睡眠卡'\n'-12': '作弊卡、吞卡'\n'-13': '此卡已挂失'\n'-14': '该卡已过期'\n'-15': '受限制的卡'\n'-16': '密码错误次数超限'\n'-17': '发卡行不支持此交易'\n不收费结果码：\n'-2': '姓名校验不通过'\n'-3': '身份证号码有误'\n'-4': '银行卡号码有误'\n'-5': '手机号码不合法'\n'-18': '验证中心服务繁忙'\n'-19': '验证次数超限，请次日重试'",
|
|
382
382
|
"example": "0",
|
|
383
383
|
"member": "string",
|
|
384
384
|
"name": "Result",
|
|
385
|
-
"
|
|
385
|
+
"output_required": true,
|
|
386
386
|
"type": "string",
|
|
387
387
|
"value_allowed_null": false
|
|
388
388
|
},
|
|
@@ -392,7 +392,7 @@
|
|
|
392
392
|
"example": "认证通过",
|
|
393
393
|
"member": "string",
|
|
394
394
|
"name": "Description",
|
|
395
|
-
"
|
|
395
|
+
"output_required": true,
|
|
396
396
|
"type": "string",
|
|
397
397
|
"value_allowed_null": false
|
|
398
398
|
},
|
|
@@ -412,6 +412,7 @@
|
|
|
412
412
|
"disabled": false,
|
|
413
413
|
"document": "开户证件号，与CertType参数的证件类型一致，如：身份证，则传入身份证号。",
|
|
414
414
|
"example": "440111201903211111",
|
|
415
|
+
"is_base64": false,
|
|
415
416
|
"member": "string",
|
|
416
417
|
"name": "IdCard",
|
|
417
418
|
"required": true,
|
|
@@ -421,6 +422,7 @@
|
|
|
421
422
|
"disabled": false,
|
|
422
423
|
"document": "姓名",
|
|
423
424
|
"example": "张三",
|
|
425
|
+
"is_base64": false,
|
|
424
426
|
"member": "string",
|
|
425
427
|
"name": "Name",
|
|
426
428
|
"required": true,
|
|
@@ -430,6 +432,7 @@
|
|
|
430
432
|
"disabled": false,
|
|
431
433
|
"document": "银行卡",
|
|
432
434
|
"example": "6222222222222222222",
|
|
435
|
+
"is_base64": false,
|
|
433
436
|
"member": "string",
|
|
434
437
|
"name": "BankCard",
|
|
435
438
|
"required": true,
|
|
@@ -439,6 +442,7 @@
|
|
|
439
442
|
"disabled": false,
|
|
440
443
|
"document": "证件类型，请确认该证件为开户时使用的证件类型，未用于开户的证件信息不支持验证。\n目前默认：0 身份证，其他证件类型暂不支持。",
|
|
441
444
|
"example": "0",
|
|
445
|
+
"is_base64": false,
|
|
442
446
|
"member": "int64",
|
|
443
447
|
"name": "CertType",
|
|
444
448
|
"required": false,
|
|
@@ -448,6 +452,7 @@
|
|
|
448
452
|
"disabled": false,
|
|
449
453
|
"document": "敏感数据加密信息。对传入信息（姓名、身份证号、银行卡号）有加密需求的用户可使用此参数，详情请点击左侧链接。",
|
|
450
454
|
"example": "无",
|
|
455
|
+
"is_base64": false,
|
|
451
456
|
"member": "Encryption",
|
|
452
457
|
"name": "Encryption",
|
|
453
458
|
"required": false,
|
|
@@ -461,7 +466,7 @@
|
|
|
461
466
|
"members": [
|
|
462
467
|
{
|
|
463
468
|
"disabled": false,
|
|
464
|
-
"document": "认证结果码\n收费结果码：\n'0': '认证通过'\n'-1': '认证未通过'\n'-5': '持卡人信息有误'\n'-6': '未开通无卡支付'\n'-7': '此卡被没收'\n'-8': '无效卡号'\n'-9': '此卡无对应发卡行'\n'-10': '该卡未初始化或睡眠卡'\n'-11': '作弊卡、吞卡'\n'-12': '此卡已挂失'\n'-13': '该卡已过期'\n'-14': '受限制的卡'\n'-15': '密码错误次数超限'\n'-16': '发卡行不支持此交易'\n不收费结果码：\n'-2': '姓名校验不通过'\n'-3': '身份证号码有误'\n'-4': '银行卡号码有误'\n'-17': '验证中心服务繁忙'",
|
|
469
|
+
"document": "认证结果码\n收费结果码：\n'0': '认证通过'\n'-1': '认证未通过'\n'-5': '持卡人信息有误'\n'-6': '未开通无卡支付'\n'-7': '此卡被没收'\n'-8': '无效卡号'\n'-9': '此卡无对应发卡行'\n'-10': '该卡未初始化或睡眠卡'\n'-11': '作弊卡、吞卡'\n'-12': '此卡已挂失'\n'-13': '该卡已过期'\n'-14': '受限制的卡'\n'-15': '密码错误次数超限'\n'-16': '发卡行不支持此交易'\n不收费结果码：\n'-2': '姓名校验不通过'\n'-3': '身份证号码有误'\n'-4': '银行卡号码有误'\n'-17': '验证中心服务繁忙'\n'-18': '验证次数超限，请次日重试'",
|
|
465
470
|
"example": "0",
|
|
466
471
|
"member": "string",
|
|
467
472
|
"name": "Result",
|
|
@@ -2813,6 +2813,16 @@
|
|
|
2813
2813
|
"type": "int",
|
|
2814
2814
|
"value_allowed_null": false
|
|
2815
2815
|
},
|
|
2816
|
+
{
|
|
2817
|
+
"disabled": false,
|
|
2818
|
+
"document": "观看类型。互动观看 （默认）\t",
|
|
2819
|
+
"example": "1",
|
|
2820
|
+
"member": "uint64",
|
|
2821
|
+
"name": "AudienceType",
|
|
2822
|
+
"output_required": true,
|
|
2823
|
+
"type": "int",
|
|
2824
|
+
"value_allowed_null": false
|
|
2825
|
+
},
|
|
2816
2826
|
{
|
|
2817
2827
|
"disabled": false,
|
|
2818
2828
|
"document": "分辨率。可以有如下取值：\n1 标清\n2 高清\n3 全高清",
|
|
@@ -272,13 +272,13 @@
|
|
|
272
272
|
{
|
|
273
273
|
"document": "获取课堂房间信息",
|
|
274
274
|
"input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRoom\n<公共请求参数>\n\n{\n \"RoomId\": 1\n}",
|
|
275
|
-
"output": "{\n \"Response\": {\n \"AutoMic\": 1,\n \"RecordUrl\": \"https://example.com/test.mp4\",\n \"Name\": \"test\",\n \"AudioQuality\": 1,\n \"MaxMicNumber\": 1,\n \"SubType\": \"videodoc\",\n \"SdkAppId\": 1,\n \"RequestId\": \"test\",\n \"StartTime\": 1,\n \"TeacherId\": \"test\",\n \"Assistants\": [\n \"test\"\n ],\n \"EndTime\": 1,\n \"Resolution\": 1,\n \"DisableRecord\": 1,\n \"Status\": 0,\n \"EnableDirectControl\": 0,\n \"GroupId\": \"afdg\"\n }\n}",
|
|
275
|
+
"output": "{\n \"Response\": {\n \"AutoMic\": 1,\n \"RecordUrl\": \"https://example.com/test.mp4\",\n \"Name\": \"test\",\n \"AudioQuality\": 1,\n \"MaxMicNumber\": 1,\n \"SubType\": \"videodoc\",\n \"SdkAppId\": 1,\n \"RequestId\": \"test\",\n \"StartTime\": 1,\n \"AudienceType\": 1,\n \"TeacherId\": \"test\",\n \"Assistants\": [\n \"test\"\n ],\n \"EndTime\": 1,\n \"Resolution\": 1,\n \"DisableRecord\": 1,\n \"Status\": 0,\n \"EnableDirectControl\": 0,\n \"GroupId\": \"afdg\"\n }\n}",
|
|
276
276
|
"title": "房间信息"
|
|
277
277
|
},
|
|
278
278
|
{
|
|
279
279
|
"document": "获取房间信息",
|
|
280
280
|
"input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRoom\n<公共请求参数>\n\n{\n \"RoomId\": 331450358\n}",
|
|
281
|
-
"output": "{\n \"Response\": {\n \"Assistants\": [],\n \"AudioQuality\": 0,\n \"AutoMic\": 0,\n \"DisableRecord\": 0,\n \"EnableDirectControl\": 0,\n \"EndTime\": 1687943391,\n \"GroupId\": \"\",\n \"InteractionMode\": 1,\n \"IsGradingRequiredPostClass\": 0,\n \"MaxMicNumber\": 2,\n \"Name\": \"测试1\",\n \"RecordUrl\": \"\",\n \"RequestId\": \"a8dea9b9-5172-4c01-a53d-5a53437f7fdf\",\n \"Resolution\": 1,\n \"RoomType\": 1,\n \"SdkAppId\": 3923193,\n \"StartTime\": 1687943339,\n \"Status\": 0,\n \"SubType\": \"video\",\n \"TeacherId\": \"2O2bjPEXxStIac3NC9kfH3mHeBC\",\n \"VideoOrientation\": 1\n }\n}",
|
|
281
|
+
"output": "{\n \"Response\": {\n \"Assistants\": [],\n \"AudienceType\": 1,\n \"AudioQuality\": 0,\n \"AutoMic\": 0,\n \"DisableRecord\": 0,\n \"EnableDirectControl\": 0,\n \"EndTime\": 1687943391,\n \"GroupId\": \"\",\n \"InteractionMode\": 1,\n \"IsGradingRequiredPostClass\": 0,\n \"MaxMicNumber\": 2,\n \"Name\": \"测试1\",\n \"RecordUrl\": \"\",\n \"RequestId\": \"a8dea9b9-5172-4c01-a53d-5a53437f7fdf\",\n \"Resolution\": 1,\n \"RoomType\": 1,\n \"SdkAppId\": 3923193,\n \"StartTime\": 1687943339,\n \"Status\": 0,\n \"SubType\": \"video\",\n \"TeacherId\": \"2O2bjPEXxStIac3NC9kfH3mHeBC\",\n \"VideoOrientation\": 1\n }\n}",
|
|
282
282
|
"title": "示例"
|
|
283
283
|
}
|
|
284
284
|
],
|
|
@@ -2123,37 +2123,41 @@
|
|
|
2123
2123
|
"document": "通用混流输入参数。",
|
|
2124
2124
|
"members": [
|
|
2125
2125
|
{
|
|
2126
|
-
"default": "",
|
|
2127
2126
|
"disabled": false,
|
|
2128
2127
|
"document": "输入流名称。80字节以内，仅含字母、数字以及下划线的字符串。\n当LayoutParams.InputType=0(音视频)/4(纯音频)/5(纯视频)时，该值为需要混流的流名称。\n当LayoutParams.InputType=2(图片)/3(画布)时，该值仅用作标识输入，可用类似Canvas1、Pictrue1的名称。",
|
|
2129
2128
|
"example": "ExampleStreamName1",
|
|
2129
|
+
"is_base64": false,
|
|
2130
2130
|
"member": "string",
|
|
2131
2131
|
"name": "InputStreamName",
|
|
2132
2132
|
"required": true,
|
|
2133
|
-
"type": "string"
|
|
2134
|
-
"value_allowed_null": false
|
|
2133
|
+
"type": "string"
|
|
2135
2134
|
},
|
|
2136
2135
|
{
|
|
2137
|
-
"default": "",
|
|
2138
2136
|
"disabled": false,
|
|
2139
2137
|
"document": "输入流布局参数。",
|
|
2140
2138
|
"example": "无",
|
|
2141
2139
|
"member": "CommonMixLayoutParams",
|
|
2142
2140
|
"name": "LayoutParams",
|
|
2143
2141
|
"required": true,
|
|
2144
|
-
"type": "object"
|
|
2145
|
-
"value_allowed_null": false
|
|
2142
|
+
"type": "object"
|
|
2146
2143
|
},
|
|
2147
2144
|
{
|
|
2148
|
-
"default": "",
|
|
2149
2145
|
"disabled": false,
|
|
2150
2146
|
"document": "输入流裁剪参数。",
|
|
2151
2147
|
"example": "无",
|
|
2152
2148
|
"member": "CommonMixCropParams",
|
|
2153
2149
|
"name": "CropParams",
|
|
2154
2150
|
"required": false,
|
|
2155
|
-
"type": "object"
|
|
2156
|
-
|
|
2151
|
+
"type": "object"
|
|
2152
|
+
},
|
|
2153
|
+
{
|
|
2154
|
+
"disabled": false,
|
|
2155
|
+
"document": "抠图参数。",
|
|
2156
|
+
"example": "无",
|
|
2157
|
+
"member": "MixPortraitSegmentParams",
|
|
2158
|
+
"name": "PortraitSegmentParams",
|
|
2159
|
+
"required": false,
|
|
2160
|
+
"type": "object"
|
|
2157
2161
|
}
|
|
2158
2162
|
],
|
|
2159
2163
|
"usage": "in"
|
|
@@ -3175,110 +3179,110 @@
|
|
|
3175
3179
|
"document": "CreateLiveRecordTemplate请求参数结构体",
|
|
3176
3180
|
"members": [
|
|
3177
3181
|
{
|
|
3178
|
-
"default": "",
|
|
3179
3182
|
"disabled": false,
|
|
3180
3183
|
"document": "模板名。仅支持中文、英文、数字、_、-。",
|
|
3181
3184
|
"example": "templat",
|
|
3185
|
+
"is_base64": false,
|
|
3182
3186
|
"member": "string",
|
|
3183
3187
|
"name": "TemplateName",
|
|
3184
3188
|
"required": true,
|
|
3185
3189
|
"type": "string"
|
|
3186
3190
|
},
|
|
3187
3191
|
{
|
|
3188
|
-
"default": "",
|
|
3189
3192
|
"disabled": false,
|
|
3190
3193
|
"document": "描述信息。",
|
|
3191
3194
|
"example": "test",
|
|
3195
|
+
"is_base64": false,
|
|
3192
3196
|
"member": "string",
|
|
3193
3197
|
"name": "Description",
|
|
3194
3198
|
"required": false,
|
|
3195
3199
|
"type": "string"
|
|
3196
3200
|
},
|
|
3197
3201
|
{
|
|
3198
|
-
"default": "",
|
|
3199
3202
|
"disabled": false,
|
|
3200
3203
|
"document": "Flv录制参数，开启Flv录制时设置。",
|
|
3201
3204
|
"example": "无",
|
|
3205
|
+
"is_base64": false,
|
|
3202
3206
|
"member": "RecordParam",
|
|
3203
3207
|
"name": "FlvParam",
|
|
3204
3208
|
"required": false,
|
|
3205
3209
|
"type": "object"
|
|
3206
3210
|
},
|
|
3207
3211
|
{
|
|
3208
|
-
"default": "",
|
|
3209
3212
|
"disabled": false,
|
|
3210
3213
|
"document": "Hls录制参数，开启hls录制时设置。",
|
|
3211
3214
|
"example": "无",
|
|
3215
|
+
"is_base64": false,
|
|
3212
3216
|
"member": "RecordParam",
|
|
3213
3217
|
"name": "HlsParam",
|
|
3214
3218
|
"required": false,
|
|
3215
3219
|
"type": "object"
|
|
3216
3220
|
},
|
|
3217
3221
|
{
|
|
3218
|
-
"default": "",
|
|
3219
3222
|
"disabled": false,
|
|
3220
3223
|
"document": "Mp4录制参数，开启Mp4录制时设置。",
|
|
3221
3224
|
"example": "无",
|
|
3225
|
+
"is_base64": false,
|
|
3222
3226
|
"member": "RecordParam",
|
|
3223
3227
|
"name": "Mp4Param",
|
|
3224
3228
|
"required": false,
|
|
3225
3229
|
"type": "object"
|
|
3226
3230
|
},
|
|
3227
3231
|
{
|
|
3228
|
-
"default": "",
|
|
3229
3232
|
"disabled": false,
|
|
3230
3233
|
"document": "Aac录制参数，开启Aac录制时设置。",
|
|
3231
3234
|
"example": "无",
|
|
3235
|
+
"is_base64": false,
|
|
3232
3236
|
"member": "RecordParam",
|
|
3233
3237
|
"name": "AacParam",
|
|
3234
3238
|
"required": false,
|
|
3235
3239
|
"type": "object"
|
|
3236
3240
|
},
|
|
3237
3241
|
{
|
|
3238
|
-
"default": "",
|
|
3239
3242
|
"disabled": false,
|
|
3240
3243
|
"document": "直播类型，默认 0。\n0：普通直播，\n1：慢直播。",
|
|
3241
3244
|
"example": "12",
|
|
3245
|
+
"is_base64": false,
|
|
3242
3246
|
"member": "int64",
|
|
3243
3247
|
"name": "IsDelayLive",
|
|
3244
3248
|
"required": false,
|
|
3245
3249
|
"type": "int"
|
|
3246
3250
|
},
|
|
3247
3251
|
{
|
|
3248
|
-
"default": "",
|
|
3249
3252
|
"disabled": false,
|
|
3250
3253
|
"document": "HLS专属录制参数。",
|
|
3251
3254
|
"example": "无",
|
|
3255
|
+
"is_base64": false,
|
|
3252
3256
|
"member": "HlsSpecialParam",
|
|
3253
3257
|
"name": "HlsSpecialParam",
|
|
3254
3258
|
"required": false,
|
|
3255
3259
|
"type": "object"
|
|
3256
3260
|
},
|
|
3257
3261
|
{
|
|
3258
|
-
"default": "",
|
|
3259
3262
|
"disabled": false,
|
|
3260
3263
|
"document": "Mp3录制参数，开启Mp3录制时设置。",
|
|
3261
3264
|
"example": "无",
|
|
3265
|
+
"is_base64": false,
|
|
3262
3266
|
"member": "RecordParam",
|
|
3263
3267
|
"name": "Mp3Param",
|
|
3264
3268
|
"required": false,
|
|
3265
3269
|
"type": "object"
|
|
3266
3270
|
},
|
|
3267
3271
|
{
|
|
3268
|
-
"default": "",
|
|
3269
3272
|
"disabled": false,
|
|
3270
|
-
"document": "
|
|
3273
|
+
"document": "是否去除水印，类型为慢直播时此参数无效。\n如果为false，则录制水印流或转码流；如果为true，则录制原始流。",
|
|
3271
3274
|
"example": "false",
|
|
3275
|
+
"is_base64": false,
|
|
3272
3276
|
"member": "bool",
|
|
3273
3277
|
"name": "RemoveWatermark",
|
|
3274
3278
|
"required": false,
|
|
3275
3279
|
"type": "bool"
|
|
3276
3280
|
},
|
|
3277
3281
|
{
|
|
3278
|
-
"default": "",
|
|
3279
3282
|
"disabled": false,
|
|
3280
3283
|
"document": "FLV 录制特殊参数。",
|
|
3281
3284
|
"example": "无",
|
|
3285
|
+
"is_base64": false,
|
|
3282
3286
|
"member": "FlvSpecialParam",
|
|
3283
3287
|
"name": "FlvSpecialParam",
|
|
3284
3288
|
"required": false,
|
|
@@ -3296,7 +3300,7 @@
|
|
|
3296
3300
|
"example": "1000",
|
|
3297
3301
|
"member": "int64",
|
|
3298
3302
|
"name": "TemplateId",
|
|
3299
|
-
"
|
|
3303
|
+
"output_required": true,
|
|
3300
3304
|
"type": "int",
|
|
3301
3305
|
"value_allowed_null": false
|
|
3302
3306
|
},
|
|
@@ -11999,6 +12003,22 @@
|
|
|
11999
12003
|
],
|
|
12000
12004
|
"usage": "out"
|
|
12001
12005
|
},
|
|
12006
|
+
"MixPortraitSegmentParams": {
|
|
12007
|
+
"document": "混流抠图参数",
|
|
12008
|
+
"members": [
|
|
12009
|
+
{
|
|
12010
|
+
"disabled": false,
|
|
12011
|
+
"document": "抠图背景颜色，\n常用的颜色有：\n红色：0xcc0033。\n黄色：0xcc9900。\n绿色：0xcccc33。\n蓝色：0x99CCFF。\n黑色：0x000000。\n白色：0xFFFFFF。\n灰色：0x999999。",
|
|
12012
|
+
"example": "0xcccc33",
|
|
12013
|
+
"is_base64": false,
|
|
12014
|
+
"member": "string",
|
|
12015
|
+
"name": "Color",
|
|
12016
|
+
"required": false,
|
|
12017
|
+
"type": "string"
|
|
12018
|
+
}
|
|
12019
|
+
],
|
|
12020
|
+
"usage": "in"
|
|
12021
|
+
},
|
|
12002
12022
|
"ModifyLiveCallbackTemplateRequest": {
|
|
12003
12023
|
"document": "ModifyLiveCallbackTemplate请求参数结构体",
|
|
12004
12024
|
"members": [
|