tccli 3.0.1266.1__py2.py3-none-any.whl → 3.0.1267.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/antiddos/v20200309/api.json +12 -6
- tccli/services/antiddos/v20200309/examples.json +2 -2
- tccli/services/ccc/v20200210/api.json +2 -2
- tccli/services/emr/v20190103/api.json +11 -1
- tccli/services/ess/ess_client.py +159 -0
- tccli/services/ess/v20201111/api.json +350 -2
- tccli/services/ess/v20201111/examples.json +36 -0
- tccli/services/gme/v20180711/api.json +77 -39
- tccli/services/gme/v20180711/examples.json +2 -2
- tccli/services/hunyuan/v20230901/api.json +5 -5
- tccli/services/hunyuan/v20230901/examples.json +6 -6
- tccli/services/lcic/v20220817/api.json +18 -18
- tccli/services/lighthouse/v20200324/api.json +10 -10
- tccli/services/live/v20180801/api.json +1 -1
- tccli/services/lkeap/v20240522/api.json +3 -3
- tccli/services/mps/v20190612/api.json +40 -0
- tccli/services/ocr/v20181119/api.json +22 -2
- tccli/services/redis/v20180412/api.json +40 -40
- tccli/services/smop/v20201203/api.json +34 -34
- tccli/services/vms/v20200902/api.json +2 -2
- tccli/services/vpc/v20170312/api.json +997 -9
- tccli/services/vpc/v20170312/examples.json +100 -4
- tccli/services/vpc/vpc_client.py +690 -54
- tccli/services/wedata/v20210820/api.json +79 -3
- {tccli-3.0.1266.1.dist-info → tccli-3.0.1267.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1266.1.dist-info → tccli-3.0.1267.1.dist-info}/RECORD +30 -30
- {tccli-3.0.1266.1.dist-info → tccli-3.0.1267.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1266.1.dist-info → tccli-3.0.1267.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1266.1.dist-info → tccli-3.0.1267.1.dist-info}/license_files/LICENSE +0 -0
@@ -119,6 +119,13 @@
|
|
119
119
|
"output": "CreateExtendedServiceAuthInfosResponse",
|
120
120
|
"status": "online"
|
121
121
|
},
|
122
|
+
"CreateFileCounterSign": {
|
123
|
+
"document": "此接口用于发起数字文件CA加签操作。可以使用同步或者异步模式进行。\n\n**注意: 1. 文件类型暂时仅支持PDF类型文件。2. 此接口为『数字文件CA加签服务』白名单功能,使用前请联系对接的客户经理沟通。**",
|
124
|
+
"input": "CreateFileCounterSignRequest",
|
125
|
+
"name": "文件加签接口",
|
126
|
+
"output": "CreateFileCounterSignResponse",
|
127
|
+
"status": "online"
|
128
|
+
},
|
122
129
|
"CreateFlow": {
|
123
130
|
"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\n\n注:**静默(自动)签署不支持合同签署方存在填写**功能\n<br>\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/createflow_seversign.mp4\" target=\"_blank\">创建静默(自动)签署模板和开通自动签署</a><br>\n2. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/flow_document_start.mp4\" target=\"_blank\">用模板创建发起合同</a><br>",
|
124
131
|
"input": "CreateFlowRequest",
|
@@ -455,6 +462,13 @@
|
|
455
462
|
"output": "DescribeExtendedServiceAuthInfosResponse",
|
456
463
|
"status": "online"
|
457
464
|
},
|
465
|
+
"DescribeFileCounterSignResult": {
|
466
|
+
"document": "文件CA加签任务结果查询接口,用于查询 CreateFileCounterSign接口 发起的异步加签任务。\n\n注意:`此接口为『数字文件CA加签服务』白名单功能,使用前请联系对接的客户经理沟通。`",
|
467
|
+
"input": "DescribeFileCounterSignResultRequest",
|
468
|
+
"name": "文件加签任务结果轮询接口",
|
469
|
+
"output": "DescribeFileCounterSignResultResponse",
|
470
|
+
"status": "online"
|
471
|
+
},
|
458
472
|
"DescribeFileUrls": {
|
459
473
|
"document": "本接口(DescribeFileUrls)用于查询文件的下载URL。\n适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。\n\n\n### 2. 确保合同的PDF已经合成后,再调用本接口。\n\n用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color=\"red\"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。\n\n**第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。\n\n**第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowBriefs)接口来主动检查合同的签署状态。请仅在确认合同状态为“签署完成”后,进行文件的下载操作。\n\n### 3. 链接具有有效期限\n<font color=\"red\"><b>生成的链接是有时间限制的,过期后将无法访问</b></font>。您可以在接口返回的信息中查看具体的过期时间。为避免错误,请确保在链接过期之前进行下载操作。",
|
460
474
|
"input": "DescribeFileUrlsRequest",
|
@@ -665,6 +679,13 @@
|
|
665
679
|
"output": "UploadFilesResponse",
|
666
680
|
"status": "online"
|
667
681
|
},
|
682
|
+
"VerifyDigitFile": {
|
683
|
+
"document": "对加签后的文件进行数字签名验证,判断数字签名是否有效。",
|
684
|
+
"input": "VerifyDigitFileRequest",
|
685
|
+
"name": "加签文件验签接口",
|
686
|
+
"output": "VerifyDigitFileResponse",
|
687
|
+
"status": "online"
|
688
|
+
},
|
668
689
|
"VerifyPdf": {
|
669
690
|
"document": "对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。\n\n\n**补充**: 可以到控制台[合同验签](https://qian.tencent.com/verifySign)体验验签功能,界面如下\n",
|
670
691
|
"input": "VerifyPdfRequest",
|
@@ -3434,6 +3455,90 @@
|
|
3434
3455
|
],
|
3435
3456
|
"type": "object"
|
3436
3457
|
},
|
3458
|
+
"CreateFileCounterSignRequest": {
|
3459
|
+
"document": "CreateFileCounterSign请求参数结构体",
|
3460
|
+
"members": [
|
3461
|
+
{
|
3462
|
+
"disabled": false,
|
3463
|
+
"document": "需要加签的文件Id。\n\n注: `暂时只支持pdf类型的文件`",
|
3464
|
+
"example": "yDtwRUUckp7f7e************qq28pI",
|
3465
|
+
"member": "string",
|
3466
|
+
"name": "FileId",
|
3467
|
+
"required": true,
|
3468
|
+
"type": "string"
|
3469
|
+
},
|
3470
|
+
{
|
3471
|
+
"disabled": false,
|
3472
|
+
"document": "执行本接口操作的员工信息。注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
3473
|
+
"example": "无",
|
3474
|
+
"member": "UserInfo",
|
3475
|
+
"name": "Operator",
|
3476
|
+
"required": false,
|
3477
|
+
"type": "object"
|
3478
|
+
},
|
3479
|
+
{
|
3480
|
+
"disabled": false,
|
3481
|
+
"document": "代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
3482
|
+
"example": "无",
|
3483
|
+
"member": "Agent",
|
3484
|
+
"name": "Agent",
|
3485
|
+
"required": false,
|
3486
|
+
"type": "object"
|
3487
|
+
},
|
3488
|
+
{
|
3489
|
+
"disabled": false,
|
3490
|
+
"document": "是否使用同步模式。\n<ul><li><b>false</b>:异步模式,返回taskId。需要使用taskId轮询结果查询接口。</li>\n<li><b>true</b>: 同步模式,此接口将直接返回taskId和ResultFileId(加签后文件id)。</li></ul>\n注:\n1. 当加签文件较大的时候,建议使用异步接口进行操作。否则文件加签时间过长会导致接口超时。",
|
3491
|
+
"example": "false",
|
3492
|
+
"member": "bool",
|
3493
|
+
"name": "SyncMode",
|
3494
|
+
"required": false,
|
3495
|
+
"type": "bool"
|
3496
|
+
}
|
3497
|
+
],
|
3498
|
+
"type": "object"
|
3499
|
+
},
|
3500
|
+
"CreateFileCounterSignResponse": {
|
3501
|
+
"document": "CreateFileCounterSign返回参数结构体",
|
3502
|
+
"members": [
|
3503
|
+
{
|
3504
|
+
"disabled": false,
|
3505
|
+
"document": "加签任务的状态。\n\n<ul>\n<li><b>PROCESSING</b>: 任务正在执行中。</li>\n<li><b>FINISHED</b>: 已执行成功</li>\n</ul>",
|
3506
|
+
"example": "PROCESSING",
|
3507
|
+
"member": "string",
|
3508
|
+
"name": "Status",
|
3509
|
+
"output_required": false,
|
3510
|
+
"type": "string",
|
3511
|
+
"value_allowed_null": false
|
3512
|
+
},
|
3513
|
+
{
|
3514
|
+
"disabled": false,
|
3515
|
+
"document": "加签完成后新的文件Id",
|
3516
|
+
"example": "yDtwRUUckp7f7e************qq28pI",
|
3517
|
+
"member": "string",
|
3518
|
+
"name": "ResultFileId",
|
3519
|
+
"output_required": false,
|
3520
|
+
"type": "string",
|
3521
|
+
"value_allowed_null": false
|
3522
|
+
},
|
3523
|
+
{
|
3524
|
+
"disabled": false,
|
3525
|
+
"document": "异步模式下用于轮询状态的任务Id",
|
3526
|
+
"example": "yDCmrUUc************6",
|
3527
|
+
"member": "string",
|
3528
|
+
"name": "TaskId",
|
3529
|
+
"output_required": false,
|
3530
|
+
"type": "string",
|
3531
|
+
"value_allowed_null": false
|
3532
|
+
},
|
3533
|
+
{
|
3534
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
3535
|
+
"member": "string",
|
3536
|
+
"name": "RequestId",
|
3537
|
+
"type": "string"
|
3538
|
+
}
|
3539
|
+
],
|
3540
|
+
"type": "object"
|
3541
|
+
},
|
3437
3542
|
"CreateFlowApproversRequest": {
|
3438
3543
|
"document": "CreateFlowApprovers请求参数结构体",
|
3439
3544
|
"members": [
|
@@ -8561,6 +8666,81 @@
|
|
8561
8666
|
],
|
8562
8667
|
"type": "object"
|
8563
8668
|
},
|
8669
|
+
"DescribeFileCounterSignResultRequest": {
|
8670
|
+
"document": "DescribeFileCounterSignResult请求参数结构体",
|
8671
|
+
"members": [
|
8672
|
+
{
|
8673
|
+
"disabled": false,
|
8674
|
+
"document": "执行本接口操作的员工信息。注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
8675
|
+
"example": "无",
|
8676
|
+
"member": "UserInfo",
|
8677
|
+
"name": "Operator",
|
8678
|
+
"required": false,
|
8679
|
+
"type": "object"
|
8680
|
+
},
|
8681
|
+
{
|
8682
|
+
"disabled": false,
|
8683
|
+
"document": "代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
8684
|
+
"example": "无",
|
8685
|
+
"member": "Agent",
|
8686
|
+
"name": "Agent",
|
8687
|
+
"required": false,
|
8688
|
+
"type": "object"
|
8689
|
+
},
|
8690
|
+
{
|
8691
|
+
"disabled": false,
|
8692
|
+
"document": "加签任务Id",
|
8693
|
+
"example": "yDtwwU****************pfyw8AO",
|
8694
|
+
"member": "string",
|
8695
|
+
"name": "TaskId",
|
8696
|
+
"required": false,
|
8697
|
+
"type": "string"
|
8698
|
+
}
|
8699
|
+
],
|
8700
|
+
"type": "object"
|
8701
|
+
},
|
8702
|
+
"DescribeFileCounterSignResultResponse": {
|
8703
|
+
"document": "DescribeFileCounterSignResult返回参数结构体",
|
8704
|
+
"members": [
|
8705
|
+
{
|
8706
|
+
"disabled": false,
|
8707
|
+
"document": "加签任务的状态。\n\n<ul>\n<li><b>PROCESSING</b>: 任务正在执行中。</li>\n<li><b>FINISHED</b>: 已执行成功</li>\n<li><b>FAILED</b>: 执行失败</li>\n</ul>",
|
8708
|
+
"example": "PROCESSING",
|
8709
|
+
"member": "string",
|
8710
|
+
"name": "Status",
|
8711
|
+
"output_required": false,
|
8712
|
+
"type": "string",
|
8713
|
+
"value_allowed_null": false
|
8714
|
+
},
|
8715
|
+
{
|
8716
|
+
"disabled": false,
|
8717
|
+
"document": "加签完成后新的文件Id",
|
8718
|
+
"example": "yDtwRUUckp7f7e************qq28pI",
|
8719
|
+
"member": "string",
|
8720
|
+
"name": "ResultFileId",
|
8721
|
+
"output_required": false,
|
8722
|
+
"type": "string",
|
8723
|
+
"value_allowed_null": false
|
8724
|
+
},
|
8725
|
+
{
|
8726
|
+
"disabled": false,
|
8727
|
+
"document": "失败的错误信息,加签任务失败的情况下会返回。",
|
8728
|
+
"example": "无",
|
8729
|
+
"member": "string",
|
8730
|
+
"name": "ErrorDetail",
|
8731
|
+
"output_required": false,
|
8732
|
+
"type": "string",
|
8733
|
+
"value_allowed_null": false
|
8734
|
+
},
|
8735
|
+
{
|
8736
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
8737
|
+
"member": "string",
|
8738
|
+
"name": "RequestId",
|
8739
|
+
"type": "string"
|
8740
|
+
}
|
8741
|
+
],
|
8742
|
+
"type": "object"
|
8743
|
+
},
|
8564
8744
|
"DescribeFileUrlsRequest": {
|
8565
8745
|
"document": "DescribeFileUrls请求参数结构体",
|
8566
8746
|
"members": [
|
@@ -8575,7 +8755,7 @@
|
|
8575
8755
|
},
|
8576
8756
|
{
|
8577
8757
|
"disabled": false,
|
8578
|
-
"document": "
|
8758
|
+
"document": "文件对应的业务类型,目前支持:<ul><li>**FLOW ** : <font color=\"red\">如需下载合同文件请选择此项</font></li><li>**TEMPLATE ** : 如需下载模板文件请选择此项</li><li>**DOCUMENT **: 如需下载文档文件请选择此项</li><li>**SEAL **: 如需下载印章图片请选择此项</li><li>**DIGITFILE**: 如需下载加签文件请选择此项</li></ul>",
|
8579
8759
|
"example": "DOCUMENT",
|
8580
8760
|
"member": "string",
|
8581
8761
|
"name": "BusinessType",
|
@@ -8584,7 +8764,7 @@
|
|
8584
8764
|
},
|
8585
8765
|
{
|
8586
8766
|
"disabled": false,
|
8587
|
-
"document": "
|
8767
|
+
"document": "业务编号的数组,取值如下:<ul><li>流程编号</li><li>模板编号</li><li>文档编号</li><li>印章编号</li><li>加签文件编号</li><li>如需下载合同文件请传入FlowId,最大支持20个资源</li></ul>",
|
8588
8768
|
"example": "[\"yDRSRUUgygj6rq7wUuO4zjECxndqQApl\",\"yDwFkUUckpstzjhfUugNAWf1KibXqS26\"]",
|
8589
8769
|
"member": "string",
|
8590
8770
|
"name": "BusinessIds",
|
@@ -15518,6 +15698,174 @@
|
|
15518
15698
|
],
|
15519
15699
|
"usage": "in"
|
15520
15700
|
},
|
15701
|
+
"VerifyDigitFileRequest": {
|
15702
|
+
"document": "VerifyDigitFile请求参数结构体",
|
15703
|
+
"members": [
|
15704
|
+
{
|
15705
|
+
"disabled": false,
|
15706
|
+
"document": "执行本接口操作的员工信息。注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。",
|
15707
|
+
"example": "无",
|
15708
|
+
"member": "UserInfo",
|
15709
|
+
"name": "Operator",
|
15710
|
+
"required": false,
|
15711
|
+
"type": "object"
|
15712
|
+
},
|
15713
|
+
{
|
15714
|
+
"disabled": false,
|
15715
|
+
"document": "代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
15716
|
+
"example": "无",
|
15717
|
+
"member": "Agent",
|
15718
|
+
"name": "Agent",
|
15719
|
+
"required": false,
|
15720
|
+
"type": "object"
|
15721
|
+
},
|
15722
|
+
{
|
15723
|
+
"disabled": false,
|
15724
|
+
"document": "加签接口返回的文件Id",
|
15725
|
+
"example": "yDwcCUUgyg3tgmvhUEVzyNa15Zayy6Sf",
|
15726
|
+
"member": "string",
|
15727
|
+
"name": "FileId",
|
15728
|
+
"required": false,
|
15729
|
+
"type": "string"
|
15730
|
+
}
|
15731
|
+
],
|
15732
|
+
"type": "object"
|
15733
|
+
},
|
15734
|
+
"VerifyDigitFileResponse": {
|
15735
|
+
"document": "VerifyDigitFile返回参数结构体",
|
15736
|
+
"members": [
|
15737
|
+
{
|
15738
|
+
"disabled": false,
|
15739
|
+
"document": "加签文件MD5哈希值",
|
15740
|
+
"example": "C39BBA405153FB9A0705BEF095351CBD",
|
15741
|
+
"member": "string",
|
15742
|
+
"name": "PdfResourceMd5",
|
15743
|
+
"output_required": false,
|
15744
|
+
"type": "string",
|
15745
|
+
"value_allowed_null": false
|
15746
|
+
},
|
15747
|
+
{
|
15748
|
+
"disabled": false,
|
15749
|
+
"document": "验签结果代码,代码的含义如下:<ul><li>**1**:文件验证成功。</li><li>**2**:文件验证失败。</li></ul>",
|
15750
|
+
"example": "1",
|
15751
|
+
"member": "int64",
|
15752
|
+
"name": "VerifyResult",
|
15753
|
+
"output_required": false,
|
15754
|
+
"type": "int",
|
15755
|
+
"value_allowed_null": false
|
15756
|
+
},
|
15757
|
+
{
|
15758
|
+
"disabled": false,
|
15759
|
+
"document": "验签序列号, 为11为数组组成的字符串",
|
15760
|
+
"example": "17364056473214",
|
15761
|
+
"member": "string",
|
15762
|
+
"name": "VerifySerialNo",
|
15763
|
+
"output_required": false,
|
15764
|
+
"type": "string",
|
15765
|
+
"value_allowed_null": false
|
15766
|
+
},
|
15767
|
+
{
|
15768
|
+
"disabled": false,
|
15769
|
+
"document": "验签结果详情,每个签名域对应的验签结果。",
|
15770
|
+
"example": "无",
|
15771
|
+
"member": "VerifyDigitFileResult",
|
15772
|
+
"name": "VerifyDigitFileResults",
|
15773
|
+
"output_required": false,
|
15774
|
+
"type": "list",
|
15775
|
+
"value_allowed_null": false
|
15776
|
+
},
|
15777
|
+
{
|
15778
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
15779
|
+
"member": "string",
|
15780
|
+
"name": "RequestId",
|
15781
|
+
"type": "string"
|
15782
|
+
}
|
15783
|
+
],
|
15784
|
+
"type": "object"
|
15785
|
+
},
|
15786
|
+
"VerifyDigitFileResult": {
|
15787
|
+
"document": "数字加签文件验签结果",
|
15788
|
+
"members": [
|
15789
|
+
{
|
15790
|
+
"disabled": false,
|
15791
|
+
"document": "证书起始时间的Unix时间戳,单位毫秒",
|
15792
|
+
"example": "1699006057000",
|
15793
|
+
"member": "int64",
|
15794
|
+
"name": "CertNotBefore",
|
15795
|
+
"output_required": false,
|
15796
|
+
"required": false,
|
15797
|
+
"type": "int",
|
15798
|
+
"value_allowed_null": false
|
15799
|
+
},
|
15800
|
+
{
|
15801
|
+
"disabled": false,
|
15802
|
+
"document": "证书过期时间的时间戳,单位毫秒",
|
15803
|
+
"example": "1730542057000",
|
15804
|
+
"member": "int64",
|
15805
|
+
"name": "CertNotAfter",
|
15806
|
+
"output_required": false,
|
15807
|
+
"required": false,
|
15808
|
+
"type": "int",
|
15809
|
+
"value_allowed_null": false
|
15810
|
+
},
|
15811
|
+
{
|
15812
|
+
"disabled": false,
|
15813
|
+
"document": "证书序列号,在数字证书申请过程中,系统会自动生成一个独一无二的序号。\t",
|
15814
|
+
"example": "6c8e2911fadf70ea",
|
15815
|
+
"member": "string",
|
15816
|
+
"name": "CertSn",
|
15817
|
+
"output_required": false,
|
15818
|
+
"required": false,
|
15819
|
+
"type": "string",
|
15820
|
+
"value_allowed_null": false
|
15821
|
+
},
|
15822
|
+
{
|
15823
|
+
"disabled": false,
|
15824
|
+
"document": "证书签名算法, 如SHA1withRSA等算法",
|
15825
|
+
"example": "SHA1withRSA",
|
15826
|
+
"member": "string",
|
15827
|
+
"name": "SignAlgorithm",
|
15828
|
+
"output_required": false,
|
15829
|
+
"required": false,
|
15830
|
+
"type": "string",
|
15831
|
+
"value_allowed_null": false
|
15832
|
+
},
|
15833
|
+
{
|
15834
|
+
"disabled": false,
|
15835
|
+
"document": "签署时间的Unix时间戳,单位毫秒",
|
15836
|
+
"example": "1699252042000",
|
15837
|
+
"member": "int64",
|
15838
|
+
"name": "SignTime",
|
15839
|
+
"output_required": false,
|
15840
|
+
"required": false,
|
15841
|
+
"type": "int",
|
15842
|
+
"value_allowed_null": false
|
15843
|
+
},
|
15844
|
+
{
|
15845
|
+
"disabled": false,
|
15846
|
+
"document": "签名类型。0表示带签章的数字签名,1表示仅数字签名",
|
15847
|
+
"example": "1",
|
15848
|
+
"member": "int64",
|
15849
|
+
"name": "SignType",
|
15850
|
+
"output_required": false,
|
15851
|
+
"required": false,
|
15852
|
+
"type": "int",
|
15853
|
+
"value_allowed_null": false
|
15854
|
+
},
|
15855
|
+
{
|
15856
|
+
"disabled": false,
|
15857
|
+
"document": "申请证书的主体的名字\n\n如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下\n**企业**: ESS@企业名称@编码\n**个人**: ESS@个人姓名@证件号@808854\n\n如果在其他平台签署的, 主体的名字参考其他平台的说明",
|
15858
|
+
"example": "ESS@典子谦示例企业@382919",
|
15859
|
+
"member": "string",
|
15860
|
+
"name": "SignerName",
|
15861
|
+
"output_required": false,
|
15862
|
+
"required": false,
|
15863
|
+
"type": "string",
|
15864
|
+
"value_allowed_null": false
|
15865
|
+
}
|
15866
|
+
],
|
15867
|
+
"usage": "both"
|
15868
|
+
},
|
15521
15869
|
"VerifyPdfRequest": {
|
15522
15870
|
"document": "VerifyPdf请求参数结构体",
|
15523
15871
|
"members": [
|
@@ -364,6 +364,26 @@
|
|
364
364
|
"title": "创建企业扩展服务授权- 批量签署"
|
365
365
|
}
|
366
366
|
],
|
367
|
+
"CreateFileCounterSign": [
|
368
|
+
{
|
369
|
+
"document": "文件CA加签--同步模式",
|
370
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFileCounterSign\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDCpyUc*******************bsVny9l\"\n },\n \"SyncMode\": true,\n \"FileId\": \"yDtwuU*******************FYPZ\"\n}",
|
371
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"xxxxxxxxxxx\",\n \"ResultFileId\": \"yD45ww**********************ZIM1o\",\n \"Status\": \"FINISHED\",\n \"TaskId\": \"yDsdsU********************EtgCQI7\"\n }\n}",
|
372
|
+
"title": "文件CA加签--同步模式"
|
373
|
+
},
|
374
|
+
{
|
375
|
+
"document": "文件CA加签--异步模式",
|
376
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFileCounterSign\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDCpyUc*******************bsVny9l\"\n },\n \"SyncMode\": true,\n \"FileId\": \"yDtwuU*******************FYPZ\"\n}",
|
377
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"谢谢谢谢谢谢休息休息\",\n \"ResultFileId\": \"\",\n \"Status\": \"FINISHED\",\n \"TaskId\": \"yDtww************************EtgCQI7\"\n }\n}",
|
378
|
+
"title": "文件CA加签--异步模式"
|
379
|
+
},
|
380
|
+
{
|
381
|
+
"document": "文件CA加签,使用同步模式,且集团主企业使用子企业CA进行加签场景",
|
382
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFileCounterSign\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDCpyUc*******************bsVny9l\"\n },\n \"Agent\": {\n \"ProxyOrganizationId\": \"yUIdyeU*******************bsdf234l\"\n },\n \"SyncMode\": true,\n \"FileId\": \"yDtwuU*******************FYPZ\"\n}",
|
383
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"xxxxxxxxxxx\",\n \"ResultFileId\": \"yD45ww**********************ZIM1o\",\n \"Status\": \"FINISHED\",\n \"TaskId\": \"yDsdsU********************EtgCQI7\"\n }\n}",
|
384
|
+
"title": "文件CA加签--同步模式--主带子场景"
|
385
|
+
}
|
386
|
+
],
|
367
387
|
"CreateFlow": [
|
368
388
|
{
|
369
389
|
"document": "创建一个单C流程",
|
@@ -1372,6 +1392,14 @@
|
|
1372
1392
|
"title": "查询不支持的特定扩展服务"
|
1373
1393
|
}
|
1374
1394
|
],
|
1395
|
+
"DescribeFileCounterSignResult": [
|
1396
|
+
{
|
1397
|
+
"document": "根据TaskId查询任务结果",
|
1398
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFileCounterSignResult\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDCpyUc*******************bsVny9l\"\n },\n \"Agent\": {\n \"ProxyOrganizationId\": \"yUIdyeU*******************bsdf234l\"\n },\n \"TaskId\": \"yDtwuU*******************FYPZ\"\n}",
|
1399
|
+
"output": "{\n \"Response\": {\n \"ErrorDetail\": \"\",\n \"RequestId\": \"s1737011895277384406\",\n \"ResultFileId\": \"yDtwwUUckp7m1csmUuFhivskVdRNkoJ9\",\n \"Status\": \"FINISHED\"\n }\n}",
|
1400
|
+
"title": "根据TaskId查询任务结果"
|
1401
|
+
}
|
1402
|
+
],
|
1375
1403
|
"DescribeFileUrls": [
|
1376
1404
|
{
|
1377
1405
|
"document": "",
|
@@ -1840,6 +1868,14 @@
|
|
1840
1868
|
"title": "上传Word合同文件(后序需要转换)"
|
1841
1869
|
}
|
1842
1870
|
],
|
1871
|
+
"VerifyDigitFile": [
|
1872
|
+
{
|
1873
|
+
"document": "1.填入加签后的文件Id,对文件进行验证",
|
1874
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VerifyDigitFile\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy\"\n },\n \"FileId\": \"yDwFdUUckpsveo27UEQPEVo14KnASuGI\"\n}",
|
1875
|
+
"output": "{\n \"Response\": {\n \"PdfResourceMd5\": \"213CA8C1C84B7BAA73F6FD3959C2F079\",\n \"RequestId\": \"s1739352792186436957\",\n \"VerifyDigitFileResults\": [\n {\n \"CertNotAfter\": 1754852419000,\n \"CertNotBefore\": 1723316419000,\n \"CertSn\": \"2201c8e9cdd3abb6\",\n \"SignAlgorithm\": \"SHA256withRSA\",\n \"SignTime\": 1737103505000,\n \"SignType\": 1,\n \"SignerName\": \"ESS@XXXXX责任公司测试@662001\"\n }\n ],\n \"VerifyResult\": 1,\n \"VerifySerialNo\": \"17393527923979\"\n }\n}",
|
1876
|
+
"title": "加签文件验证成功示例"
|
1877
|
+
}
|
1878
|
+
],
|
1843
1879
|
"VerifyPdf": [
|
1844
1880
|
{
|
1845
1881
|
"document": "1.对流程合同yDwFdUUckpsveo27UEQPEVo14KnASuGI进行数字签名验证\n2.流程合同yDwFdUUckpsveo27UEQPEVo14KnASuGI验证正常",
|