tccli 3.0.1215.1__py2.py3-none-any.whl → 3.0.1217.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/argparser.py +1 -1
- tccli/command.py +2 -2
- tccli/configure.py +46 -1
- tccli/credentials.py +25 -0
- tccli/main.py +6 -2
- tccli/plugins/sso/__init__.py +61 -0
- tccli/plugins/sso/configs.py +4 -0
- tccli/plugins/sso/configure.py +45 -0
- tccli/plugins/sso/login.py +144 -0
- tccli/plugins/sso/logout.py +21 -0
- tccli/plugins/sso/terminal.py +161 -0
- tccli/plugins/sso/texts.py +40 -0
- tccli/services/__init__.py +6 -3
- tccli/services/acp/v20220105/api.json +7 -7
- tccli/services/acp/v20220105/examples.json +2 -2
- tccli/services/aiart/v20221229/api.json +29 -29
- tccli/services/aiart/v20221229/examples.json +8 -8
- tccli/services/apigateway/v20180808/api.json +18 -17
- tccli/services/apigateway/v20180808/examples.json +12 -12
- tccli/services/apm/v20210622/api.json +118 -4
- tccli/services/asr/v20190614/api.json +21 -20
- tccli/services/asr/v20190614/examples.json +13 -13
- tccli/services/autoscaling/v20180419/api.json +371 -309
- tccli/services/autoscaling/v20180419/examples.json +17 -17
- tccli/services/batch/v20170312/api.json +7 -7
- tccli/services/bda/v20200324/api.json +39 -31
- tccli/services/bda/v20200324/examples.json +9 -9
- tccli/services/bh/__init__.py +4 -0
- tccli/services/bh/bh_client.py +3428 -0
- tccli/services/bh/v20230418/api.json +8180 -0
- tccli/services/bh/v20230418/examples.json +519 -0
- tccli/services/bi/v20220105/api.json +80 -4
- tccli/services/bi/v20220105/examples.json +1 -1
- tccli/services/billing/billing_client.py +53 -0
- tccli/services/billing/v20180709/api.json +330 -24
- tccli/services/billing/v20180709/examples.json +8 -0
- tccli/services/bsca/v20210811/api.json +223 -18
- tccli/services/bsca/v20210811/examples.json +4 -4
- tccli/services/btoe/v20210514/api.json +4 -4
- tccli/services/btoe/v20210514/examples.json +2 -2
- tccli/services/ca/v20230228/api.json +60 -0
- tccli/services/cam/v20190116/api.json +11 -11
- tccli/services/cat/v20180409/api.json +9 -0
- tccli/services/cbs/v20170312/api.json +200 -188
- tccli/services/cbs/v20170312/examples.json +4 -4
- tccli/services/ccc/ccc_client.py +53 -0
- tccli/services/ccc/v20200210/api.json +541 -325
- tccli/services/ccc/v20200210/examples.json +26 -18
- tccli/services/cdb/cdb_client.py +13 -13
- tccli/services/cdb/v20170320/api.json +308 -274
- tccli/services/cdb/v20170320/examples.json +38 -38
- tccli/services/cdc/v20201214/api.json +283 -270
- tccli/services/cdc/v20201214/examples.json +26 -26
- tccli/services/cdn/v20180606/api.json +5 -3
- tccli/services/cds/v20180420/api.json +82 -76
- tccli/services/cds/v20180420/examples.json +1 -1
- tccli/services/cdwch/v20200915/api.json +1 -1
- tccli/services/cdwdoris/v20211228/api.json +54 -4
- tccli/services/cdz/v20221123/api.json +41 -5
- tccli/services/cfg/v20210820/api.json +31 -0
- tccli/services/cfs/v20190719/api.json +89 -1
- tccli/services/cfs/v20190719/examples.json +1 -1
- tccli/services/cfw/cfw_client.py +0 -53
- tccli/services/cfw/v20190904/api.json +1895 -2011
- tccli/services/cfw/v20190904/examples.json +175 -171
- tccli/services/ciam/v20220331/api.json +316 -315
- tccli/services/ciam/v20220331/examples.json +49 -49
- tccli/services/ckafka/v20190819/api.json +104 -75
- tccli/services/clb/v20180317/api.json +48 -26
- tccli/services/clb/v20180317/examples.json +1 -1
- tccli/services/cloudapp/v20220530/api.json +5 -1
- tccli/services/cloudaudit/cloudaudit_client.py +30 -30
- tccli/services/cloudaudit/v20190319/api.json +254 -211
- tccli/services/cloudaudit/v20190319/examples.json +19 -19
- tccli/services/cloudstudio/v20230508/api.json +38 -37
- tccli/services/cloudstudio/v20230508/examples.json +4 -4
- tccli/services/cls/cls_client.py +216 -4
- tccli/services/cls/v20201016/api.json +935 -147
- tccli/services/cls/v20201016/examples.json +43 -5
- tccli/services/csip/v20221121/api.json +2566 -2386
- tccli/services/csip/v20221121/examples.json +108 -108
- tccli/services/cvm/v20170312/api.json +191 -112
- tccli/services/cvm/v20170312/examples.json +2 -2
- tccli/services/cwp/cwp_client.py +4 -110
- tccli/services/cwp/v20180228/api.json +6498 -6252
- tccli/services/cwp/v20180228/examples.json +372 -412
- tccli/services/cynosdb/v20190107/api.json +170 -110
- tccli/services/cynosdb/v20190107/examples.json +91 -91
- tccli/services/dasb/v20191018/api.json +859 -637
- tccli/services/dasb/v20191018/examples.json +101 -101
- tccli/services/dcdb/dcdb_client.py +114 -61
- tccli/services/dcdb/v20180411/api.json +141 -7
- tccli/services/dcdb/v20180411/examples.json +32 -0
- tccli/services/dlc/v20210125/api.json +21 -11
- tccli/services/dnspod/dnspod_client.py +417 -46
- tccli/services/dnspod/v20210323/api.json +751 -30
- tccli/services/dnspod/v20210323/examples.json +62 -0
- tccli/services/domain/v20180808/api.json +3 -3
- tccli/services/domain/v20180808/examples.json +3 -3
- tccli/services/dts/v20211206/api.json +4 -4
- tccli/services/eb/v20210416/api.json +15 -15
- tccli/services/eb/v20210416/examples.json +1 -1
- tccli/services/ecm/v20190719/api.json +2 -2
- tccli/services/emr/v20190103/api.json +339 -114
- tccli/services/emr/v20190103/examples.json +64 -82
- tccli/services/es/es_client.py +249 -37
- tccli/services/es/v20180416/api.json +550 -0
- tccli/services/es/v20180416/examples.json +33 -1
- tccli/services/ess/ess_client.py +53 -0
- tccli/services/ess/v20201111/api.json +192 -38
- tccli/services/ess/v20201111/examples.json +35 -9
- tccli/services/essbasic/essbasic_client.py +106 -0
- tccli/services/essbasic/v20210526/api.json +287 -60
- tccli/services/essbasic/v20210526/examples.json +58 -18
- tccli/services/facefusion/v20181201/api.json +47 -45
- tccli/services/facefusion/v20181201/examples.json +2 -2
- tccli/services/facefusion/v20220927/api.json +54 -48
- tccli/services/facefusion/v20220927/examples.json +5 -5
- tccli/services/faceid/v20180301/api.json +497 -496
- tccli/services/faceid/v20180301/examples.json +219 -101
- tccli/services/fmu/v20191213/api.json +59 -67
- tccli/services/fmu/v20191213/examples.json +22 -22
- tccli/services/ft/v20200304/api.json +53 -57
- tccli/services/ft/v20200304/examples.json +14 -14
- tccli/services/gaap/v20180529/api.json +44 -26
- tccli/services/gaap/v20180529/examples.json +24 -30
- tccli/services/gme/v20180711/api.json +21 -11
- tccli/services/gme/v20180711/examples.json +1 -1
- tccli/services/hai/v20230812/api.json +116 -9
- tccli/services/hai/v20230812/examples.json +4 -4
- tccli/services/hunyuan/hunyuan_client.py +436 -12
- tccli/services/hunyuan/v20230901/api.json +1482 -118
- tccli/services/hunyuan/v20230901/examples.json +82 -18
- tccli/services/iai/v20180301/api.json +23 -19
- tccli/services/iai/v20180301/examples.json +2 -2
- tccli/services/iai/v20200303/api.json +530 -511
- tccli/services/iai/v20200303/examples.json +116 -86
- tccli/services/ig/__init__.py +4 -0
- tccli/services/ig/ig_client.py +195 -0
- tccli/services/ig/v20210518/api.json +83 -0
- tccli/services/ig/v20210518/examples.json +13 -0
- tccli/services/ioa/ioa_client.py +53 -0
- tccli/services/ioa/v20220601/api.json +662 -413
- tccli/services/ioa/v20220601/examples.json +24 -10
- tccli/services/iotexplorer/v20190423/api.json +73 -13
- tccli/services/iotexplorer/v20190423/examples.json +3 -3
- tccli/services/iotvideo/iotvideo_client.py +106 -0
- tccli/services/iotvideo/v20191126/api.json +256 -24
- tccli/services/iotvideo/v20191126/examples.json +19 -3
- tccli/services/iotvideo/v20201215/api.json +1 -1
- tccli/services/iotvideo/v20201215/examples.json +1 -1
- tccli/services/iotvideo/v20211125/api.json +1 -1
- tccli/services/iotvideo/v20211125/examples.json +2 -2
- tccli/services/iss/iss_client.py +69 -122
- tccli/services/iss/v20230517/api.json +10 -54
- tccli/services/iss/v20230517/examples.json +0 -14
- tccli/services/kms/v20190118/api.json +301 -268
- tccli/services/kms/v20190118/examples.json +45 -51
- tccli/services/lcic/lcic_client.py +159 -0
- tccli/services/lcic/v20220817/api.json +273 -1
- tccli/services/lcic/v20220817/examples.json +24 -0
- tccli/services/lighthouse/v20200324/api.json +56 -0
- tccli/services/live/live_client.py +159 -0
- tccli/services/live/v20180801/api.json +279 -9
- tccli/services/live/v20180801/examples.json +24 -0
- tccli/services/lke/v20231130/api.json +17 -17
- tccli/services/lke/v20231130/examples.json +19 -25
- tccli/services/mariadb/v20170312/api.json +7 -7
- tccli/services/market/v20191010/api.json +3 -3
- tccli/services/market/v20191010/examples.json +2 -2
- tccli/services/mmps/v20200710/api.json +47 -47
- tccli/services/mmps/v20200710/examples.json +3 -3
- tccli/services/mongodb/v20190725/api.json +10 -12
- tccli/services/monitor/v20180724/api.json +46 -19
- tccli/services/mps/v20190612/api.json +282 -5
- tccli/services/mps/v20190612/examples.json +25 -1
- tccli/services/mqtt/v20240516/api.json +2 -2
- tccli/services/mrs/v20200910/api.json +72 -34
- tccli/services/mrs/v20200910/examples.json +2 -2
- tccli/services/ms/v20180408/api.json +535 -506
- tccli/services/ms/v20180408/examples.json +25 -25
- tccli/services/oceanus/v20190422/api.json +130 -0
- tccli/services/ocr/ocr_client.py +232 -20
- tccli/services/ocr/v20181119/api.json +2263 -758
- tccli/services/ocr/v20181119/examples.json +200 -180
- tccli/services/omics/v20221128/api.json +614 -553
- tccli/services/omics/v20221128/examples.json +9 -9
- tccli/services/organization/organization_client.py +352 -34
- tccli/services/organization/v20210331/api.json +464 -4
- tccli/services/organization/v20210331/examples.json +49 -1
- tccli/services/partners/v20180321/api.json +244 -234
- tccli/services/partners/v20180321/examples.json +19 -19
- tccli/services/privatedns/privatedns_client.py +428 -4
- tccli/services/privatedns/v20201028/api.json +815 -11
- tccli/services/privatedns/v20201028/examples.json +64 -0
- tccli/services/pts/v20210728/api.json +18 -0
- tccli/services/pts/v20210728/examples.json +1 -1
- tccli/services/rce/rce_client.py +53 -0
- tccli/services/rce/v20201103/api.json +146 -0
- tccli/services/rce/v20201103/examples.json +8 -0
- tccli/services/redis/v20180412/api.json +42 -42
- tccli/services/redis/v20180412/examples.json +19 -19
- tccli/services/region/v20220627/api.json +1 -1
- tccli/services/rum/v20210622/api.json +9 -0
- tccli/services/scf/scf_client.py +269 -4
- tccli/services/scf/v20180416/api.json +569 -15
- tccli/services/scf/v20180416/examples.json +47 -1
- tccli/services/smop/v20201203/api.json +46 -42
- tccli/services/smop/v20201203/examples.json +2 -2
- tccli/services/soe/v20180724/api.json +10 -10
- tccli/services/sqlserver/v20180328/api.json +21 -8
- tccli/services/sqlserver/v20180328/examples.json +5 -5
- tccli/services/ssl/v20191205/api.json +98 -5
- tccli/services/ssm/v20190923/api.json +292 -231
- tccli/services/ssm/v20190923/examples.json +42 -42
- tccli/services/tat/v20201028/api.json +124 -122
- tccli/services/tat/v20201028/examples.json +24 -30
- tccli/services/tchd/v20230306/api.json +5 -5
- tccli/services/tchd/v20230306/examples.json +3 -3
- tccli/services/tcr/v20190924/api.json +1 -1
- tccli/services/tcr/v20190924/examples.json +1 -1
- tccli/services/tcss/v20201101/api.json +1984 -1437
- tccli/services/tcss/v20201101/examples.json +350 -368
- tccli/services/tdmq/v20200217/api.json +603 -464
- tccli/services/tdmq/v20200217/examples.json +105 -105
- tccli/services/tds/v20220801/api.json +4 -4
- tccli/services/tem/v20210701/api.json +429 -372
- tccli/services/tem/v20210701/examples.json +85 -85
- tccli/services/teo/teo_client.py +277 -12
- tccli/services/teo/v20220901/api.json +1029 -124
- tccli/services/teo/v20220901/examples.json +84 -8
- tccli/services/thpc/v20230321/api.json +5 -5
- tccli/services/tke/tke_client.py +270 -58
- tccli/services/tke/v20180525/api.json +79 -27
- tccli/services/tke/v20180525/examples.json +9 -1
- tccli/services/tke/v20220501/api.json +176 -0
- tccli/services/tke/v20220501/examples.json +24 -0
- tccli/services/tms/tms_client.py +4 -57
- tccli/services/tms/v20201229/api.json +0 -354
- tccli/services/tms/v20201229/examples.json +0 -8
- tccli/services/tmt/v20180321/api.json +38 -8
- tccli/services/trp/v20210515/api.json +86 -74
- tccli/services/trp/v20210515/examples.json +65 -65
- tccli/services/trro/v20220325/api.json +72 -71
- tccli/services/trro/v20220325/examples.json +8 -8
- tccli/services/trtc/trtc_client.py +8 -61
- tccli/services/trtc/v20190722/api.json +293 -52
- tccli/services/trtc/v20190722/examples.json +3 -11
- tccli/services/tse/tse_client.py +110 -4
- tccli/services/tse/v20201207/api.json +122 -7
- tccli/services/tse/v20201207/examples.json +25 -9
- tccli/services/vclm/v20240523/api.json +225 -82
- tccli/services/vclm/v20240523/examples.json +13 -19
- tccli/services/vod/v20180717/api.json +431 -4
- tccli/services/vod/v20180717/examples.json +25 -5
- tccli/services/vod/v20240718/api.json +11 -11
- tccli/services/vod/v20240718/examples.json +4 -4
- tccli/services/vod/vod_client.py +53 -0
- tccli/services/vpc/v20170312/api.json +1195 -892
- tccli/services/vpc/v20170312/examples.json +84 -68
- tccli/services/vpc/vpc_client.py +168 -62
- tccli/services/waf/v20180125/api.json +2611 -2187
- tccli/services/waf/v20180125/examples.json +224 -284
- tccli/services/waf/waf_client.py +225 -119
- tccli/services/wav/v20210129/api.json +48 -48
- tccli/services/wav/v20210129/examples.json +4 -4
- tccli/services/wedata/v20210820/api.json +1595 -25
- tccli/services/wedata/v20210820/examples.json +44 -4
- tccli/services/wedata/wedata_client.py +265 -0
- tccli/services/weilingwith/v20230427/api.json +6 -6
- tccli/services/weilingwith/v20230427/examples.json +3 -3
- tccli/sso.py +229 -0
- {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/METADATA +6 -2
- {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/RECORD +278 -265
- tccli/services/cr/__init__.py +0 -4
- tccli/services/cr/cr_client.py +0 -1626
- tccli/services/cr/v20180321/api.json +0 -2829
- tccli/services/cr/v20180321/examples.json +0 -235
- {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/license_files/LICENSE +0 -0
@@ -36,7 +36,7 @@
|
|
36
36
|
"status": "online"
|
37
37
|
},
|
38
38
|
"ChannelCreateBatchQuickSignUrl": {
|
39
|
-
"document": "
|
39
|
+
"document": "该接口用于发起合同后,生成个人/企业用户的批量待办链接。\n**注意:**\n1. 该接口可生成签署人的批量、合同组签署/查看链接 。\n2. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
|
40
40
|
"input": "ChannelCreateBatchQuickSignUrlRequest",
|
41
41
|
"name": "获取H5批量签署或查看链接",
|
42
42
|
"output": "ChannelCreateBatchQuickSignUrlResponse",
|
@@ -71,7 +71,7 @@
|
|
71
71
|
"status": "online"
|
72
72
|
},
|
73
73
|
"ChannelCreateFlowApprovers": {
|
74
|
-
"document": "
|
74
|
+
"document": "**适用场景**:\n当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口动态补充签署人。同一签署人只允许补充一人,最终实际签署人取决于谁先领取合同完成签署。\n\n**接口使用说明**:\n\n1.本接口现已支持批量补充签署人\n\n2.当<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中指定需要补充的FlowId时,可以对指定合同补充签署人;可以指定多个相同发起方的不同合同在完成批量补充\n\n3.当<a href=\"https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/\" target=\"_blank\">补充签署人接口入参</a>中指定需要补充的FlowId时,是对指定的合同补充多个指定的签署人\n\n4.如果同时指定了<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId和<a href=\"https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/\" target=\"_blank\">补充签署人接口入参</a>中的FlowId,仅使用<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId作为补充的合同\n\n5.如果部分指定了<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId,又指定了<a href=\"https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/\" target=\"_blank\">补充签署人接口入参</a>中的FlowId;那么<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>存在指定的FlowId,则使用<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId,不存在则使用<a href=\"https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/\" target=\"_blank\">补充签署人接口入参</a>中的FlowId作为补充的合同\n\n\n6.如果同时未指定了<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId和<a href=\"https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/\" target=\"_blank\">补充签署人接口入参</a>中的FlowId,则传参错误\n\n**限制条件**:\n1. 本企业(发起方企业)企业签署人仅支持通过企业名称+姓名+手机号进行补充。\n2. 个人签署人支持通过姓名+手机号进行补充,补充动态签署人时:若个人用户已完成实名,则可通过姓名+证件号码进行补充。",
|
75
75
|
"input": "ChannelCreateFlowApproversRequest",
|
76
76
|
"name": "补充签署流程签署人信息",
|
77
77
|
"output": "ChannelCreateFlowApproversResponse",
|
@@ -85,14 +85,14 @@
|
|
85
85
|
"status": "online"
|
86
86
|
},
|
87
87
|
"ChannelCreateFlowGroupByFiles": {
|
88
|
-
"document": "接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。\n\n
|
88
|
+
"document": "接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。\n\n- 该接口允许通过选择多个模板一次性创建多个合同,这些合同被组织在一个合同组中。\n- 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。\n- 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。\n\n<img src=\"https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png\" width=\"400\" />\n\n\n### 2. 适用场景\n\n该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。\n\n### 3. 发起方要求和签署方实名要求\n- **发起方要求**:作为合同发起方的第三方子企业A的员工必须进行实名认证。\n- **签署方要求**:签署方可以是多种身份(如第三方子企业的员工、个人、SaaS平台企业员工),其中企业和员工可以不进行实名认证。\n\n**可以作为发起方和签署方的角色列表**\n\n<table>\n<thead>\n<tr>\n<th>场景编号</th>\n<th>可作为发起方类型</th>\n<th>可作为签署方的类型</th>\n</tr>\n</thead>\n\n<tbody>\n<tr>\n<td>场景一</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业A员工</td>\n</tr>\n\n<tr>\n<td>场景二</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B员工</td>\n</tr>\n\n<tr>\n<td>场景三</td>\n<td>第三方子企业A员工</td>\n<td>个人/自然人</td>\n</tr>\n\n<tr>\n<td>场景四</td>\n<td>第三方子企业A员工</td>\n<td>SaaS平台企业员工</td>\n</tr>\n</tbody>\n</table>\n\n### 4. 签署方参数差异\n- 根据签署方的不同类型(第三方子企业的员工、个人、SaaS平台企业员工),传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 `FlowApproverInfo` 结构体说明。\n\n### 5. 合同额度的扣减与返还\n- **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。\n- **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。\n- **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。\n\n### 6. 静默(自动)签署的限制\n- 在使用静默(自动)签署功能时,合同签署方不能有填写控件。<font color=\"red\">此接口静默签(企业自动签)能力为白名单功能</font>,使用前请联系对接的客户经理沟通。\n\n### 7.合同组暂不支持抄送功能",
|
89
89
|
"input": "ChannelCreateFlowGroupByFilesRequest",
|
90
90
|
"name": "通过多文件创建合同组签署流程",
|
91
91
|
"output": "ChannelCreateFlowGroupByFilesResponse",
|
92
92
|
"status": "online"
|
93
93
|
},
|
94
94
|
"ChannelCreateFlowGroupByTemplates": {
|
95
|
-
"document": "接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。\n\n
|
95
|
+
"document": "接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。\n\n- 该接口允许通过选择多个模板一次性创建多个合同,这些合同被组织在一个合同组中。\n- 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。\n- 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。\n\n<img src=\"https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png\" width=\"400\" />\n\n### 2. 适用场景\n\n该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。\n\n### 3. 发起方要求和签署方实名要求\n- **发起方要求**:作为合同发起方的第三方子企业A的员工必须进行实名认证。\n- **签署方要求**:签署方可以是多种身份(如第三方子企业的员工、个人、SaaS平台企业员工),其中企业和员工可以不进行实名认证。\n\n**可以作为发起方和签署方的角色列表**\n\n<table>\n<thead>\n<tr>\n<th>场景编号</th>\n<th>可作为发起方类型</th>\n<th>可作为签署方的类型</th>\n</tr>\n</thead>\n\n<tbody>\n<tr>\n<td>场景一</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业A员工</td>\n</tr>\n<tr>\n<td>场景二</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B员工</td>\n</tr>\n\n<tr>\n<td>场景三</td>\n<td>第三方子企业A员工</td>\n<td>个人/自然人</td>\n</tr>\n\n<tr>\n<td>场景四</td>\n<td>第三方子企业A员工</td>\n<td>SaaS平台企业员工</td>\n</tr>\n</tbody>\n</table>\n\n### 4. 签署方参数差异\n- 根据签署方的不同类型(第三方子企业的员工、个人、SaaS平台企业员工),传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 `FlowApproverInfo` 结构体说明。\n\n### 5. 合同额度的扣减与返还\n- **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。\n- **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。\n- **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。\n\n### 6. 静默(自动)签署的限制\n- 在使用静默(自动)签署功能时,合同签署方不能有填写控件。<font color=\"red\">此接口静默签(企业自动签)能力为白名单功能</font>,使用前请联系对接的客户经理沟通。\n\n### 7.合同组暂不支持抄送功能",
|
96
96
|
"input": "ChannelCreateFlowGroupByTemplatesRequest",
|
97
97
|
"name": "通过多模板创建合同组签署流程",
|
98
98
|
"output": "ChannelCreateFlowGroupByTemplatesResponse",
|
@@ -155,7 +155,7 @@
|
|
155
155
|
"status": "online"
|
156
156
|
},
|
157
157
|
"ChannelCreateReleaseFlow": {
|
158
|
-
"document": "发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。\n
|
158
|
+
"document": "发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。\n解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。具体用法可以参考文档[合同解除](https://qian.tencent.com/developers/partner/flow_release)。\n\n注意:\n<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>\n<li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>\n<li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>\n<li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>\n<li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>\n<li>在解除协议签署完毕后,原合同及解除协议均变为已解除状态。</li>\n<li>非原合同企业参与人发起解除协议时,需要有<code>解除合同的权限</code>。</li>\n</ul>",
|
159
159
|
"input": "ChannelCreateReleaseFlowRequest",
|
160
160
|
"name": "发起解除协议",
|
161
161
|
"output": "ChannelCreateReleaseFlowResponse",
|
@@ -204,7 +204,7 @@
|
|
204
204
|
"status": "online"
|
205
205
|
},
|
206
206
|
"ChannelDeleteRole": {
|
207
|
-
"document": "此接口(ChannelDeleteRole)用来删除企业自定义角色。\n\n
|
207
|
+
"document": "此接口(ChannelDeleteRole)用来删除企业自定义角色。\n\n注:**系统角色不可删除。**",
|
208
208
|
"input": "ChannelDeleteRoleRequest",
|
209
209
|
"name": "删除角色",
|
210
210
|
"output": "ChannelDeleteRoleResponse",
|
@@ -246,7 +246,7 @@
|
|
246
246
|
"status": "online"
|
247
247
|
},
|
248
248
|
"ChannelDescribeFlowComponents": {
|
249
|
-
"document": "
|
249
|
+
"document": "您可以通过合同流程ID查询相关的<font color=\"red\"><b>填写控件</b></font>信息及其内容。这包括控件的归属方、控件的填写状态(是否已填写)以及具体的填写内容。\n\n无论是<font color=\"red\"><b>发起方还是签署方</b></font>填写的控件,均包含在查询结果中。\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)\n### 2. 那些控件会出现在结果里边? \n**A.不返回的控件类型:**\n- 动态表格\n- 附件控件\n- 水印控件\n\n**B.返回的控件类型:**\n- 单行文本\n- 多行文本\n- 勾选框控件\n- 数字控件\n- 日期控件\n- 图片控件(图片下载地址)\n- 邮箱控件\n- 地址控件\n- 学历控件\n- 性别控件\n- 省市区控件\n\n### 3.怎么授权? \n\n此接口需要授权, 有两种开通权限的途径\n\n**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图\n授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)\n\n**第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>\n![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)",
|
250
250
|
"input": "ChannelDescribeFlowComponentsRequest",
|
251
251
|
"name": "获取合同填写控件内容",
|
252
252
|
"output": "ChannelDescribeFlowComponentsResponse",
|
@@ -288,7 +288,7 @@
|
|
288
288
|
"status": "online"
|
289
289
|
},
|
290
290
|
"ChannelGetTaskResultApi": {
|
291
|
-
"document": "此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href=\"https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>进行资源文件的转换操作<br />\n前提条件:已调用 <a href=\"https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />\n\n适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源
|
291
|
+
"document": "此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href=\"https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>进行资源文件的转换操作<br />\n前提条件:已调用 <a href=\"https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />\n\n适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源ID。<br />\n注:\n1. `大文件转换所需的时间可能会比较长。`\n2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`",
|
292
292
|
"input": "ChannelGetTaskResultApiRequest",
|
293
293
|
"name": "查询转换任务状态",
|
294
294
|
"output": "ChannelGetTaskResultApiResponse",
|
@@ -357,6 +357,13 @@
|
|
357
357
|
"output": "CreateChannelSubOrganizationActiveResponse",
|
358
358
|
"status": "online"
|
359
359
|
},
|
360
|
+
"CreateCloseOrganizationUrl": {
|
361
|
+
"document": "创建企业注销链接\n\n系统将返回操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成企业的注销操作。\n\n注意: `在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人。`",
|
362
|
+
"input": "CreateCloseOrganizationUrlRequest",
|
363
|
+
"name": "创建企业注销链接",
|
364
|
+
"output": "CreateCloseOrganizationUrlResponse",
|
365
|
+
"status": "online"
|
366
|
+
},
|
360
367
|
"CreateConsoleLoginUrl": {
|
361
368
|
"document": "此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。\n\nWeb链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:\n<table>\n<thead>\n<tr>\n<th>子客企业状态</th>\n<th>子客企业员工状态</th>\n<th>点击链接进入的流程</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>企业未激活</td>\n<td>员工未认证</td>\n<td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工未认证</td>\n<td>进入员工认证并加入企业流程</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工已认证</td>\n<td>进入子客企业Web控制台</td>\n</tr>\n</tbody>\n</table>\n如果是企业激活流程,需要注意如下情况:\n\n1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。\n2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。\n\n系统的渠道企业, 应用, 子客企业, 子客员工的组织形式\n![image](https://qcloudimg.tencent-cloud.cn/raw/77677faeea26c9d7f37474597c81fe01.png)\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4\" target=\"_blank\">【生成子客登录链接】代码编写 & 子企业认证示例</a><br>",
|
362
369
|
"input": "CreateConsoleLoginUrlRequest",
|
@@ -400,14 +407,14 @@
|
|
400
407
|
"status": "online"
|
401
408
|
},
|
402
409
|
"CreatePartnerAutoSignAuthUrl": {
|
403
|
-
"document": "
|
410
|
+
"document": "创建一个用于他方自动签授权的链接(可选择他方授权或我方授权)。通过这个链接,合作方企业可以直接进入小程序,进行自动签授权操作。\n\n如果授权企业尚未开通企业自动签功能,该链接还将引导他们首先开通本企业的自动签服务\n\n\n注: \n1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)\n2. 已经在授权中或者授权成功的企业,无法重复授权\n3. 授权企业和被授权企业必须都是已认证企业\n4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。\n\n**该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**\n![image](https://qcloudimg.tencent-cloud.cn/raw/091823fd4f02af7dda416fa10ca65f2d.png)",
|
404
411
|
"input": "CreatePartnerAutoSignAuthUrlRequest",
|
405
|
-
"name": "
|
412
|
+
"name": "创建企业自动签授权链接",
|
406
413
|
"output": "CreatePartnerAutoSignAuthUrlResponse",
|
407
414
|
"status": "online"
|
408
415
|
},
|
409
416
|
"CreatePersonAuthCertificateImage": {
|
410
|
-
"document": "获取个人用户认证证书图片下载URL\n\n个人用户认证证书图片样式如下图\n\n![image](https://
|
417
|
+
"document": "获取个人用户认证证书图片下载URL\n\n个人用户认证证书图片样式如下图\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/d568bc0f101bef582f7af2cb5ab7a715.png)\n\n注: \n<ul>\n<li>只能获取个人用户证明图片, 企业员工的暂不支持</li>\n<li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>\n</ul>",
|
411
418
|
"input": "CreatePersonAuthCertificateImageRequest",
|
412
419
|
"name": "获取个人用户认证证书图片",
|
413
420
|
"output": "CreatePersonAuthCertificateImageResponse",
|
@@ -427,6 +434,13 @@
|
|
427
434
|
"output": "CreateSignUrlsResponse",
|
428
435
|
"status": "online"
|
429
436
|
},
|
437
|
+
"DeleteOrganizationAuthorizations": {
|
438
|
+
"document": "批量清理未认证的企业认证流程。\n\n此接口用来清除企业方认证信息填写错误,批量清理认证中的认证流信息。\n为接口[提交子企业批量认证链接创建任务](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks) 和[查询子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls) 接口的扩展接口。即在批量认证过程中,当发起认证企业发现超管信息错误的时候,可以将当前超管下的所有认证流企业清除。\n\n注意:\n**这个接口的操作人必须跟生成批量认证链接接口的应用号一致,才可以调用,否则会返回当前操作人没有认证中的企业认证流**",
|
439
|
+
"input": "DeleteOrganizationAuthorizationsRequest",
|
440
|
+
"name": "批量清除未认证的企业认证流",
|
441
|
+
"output": "DeleteOrganizationAuthorizationsResponse",
|
442
|
+
"status": "online"
|
443
|
+
},
|
430
444
|
"DescribeBatchOrganizationRegistrationUrls": {
|
431
445
|
"document": "此接口用于获取企业批量认证异步任务的状态及结果。需要先调用接口<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks\" target=\"_blank\">提交子企业批量认证链接创建任务</a>获取到任务ID,然后再调用此接口获取到各个子企业的注册认证链接。整体流程如下图。\n![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)\n\n\n注:\n`异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间`",
|
432
446
|
"input": "DescribeBatchOrganizationRegistrationUrlsRequest",
|
@@ -484,7 +498,7 @@
|
|
484
498
|
"status": "online"
|
485
499
|
},
|
486
500
|
"DescribeResourceUrlsByFlows": {
|
487
|
-
"document": "获取合同流程PDF
|
501
|
+
"document": "获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同。\n\n\n\n\n### 2. 确保合同的PDF已经合成后,再调用本接口。\n 用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color=\"red\"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。\n\n**第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。\n\n**第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo)接口来主动检查合同的签署状态。请仅在确认合同状态为“全部签署完成”后,进行文件的下载操作。\n\n### 3. 链接具有有效期限\n<font color=\"red\"><b>生成的链接是有时间限制的,过期后将无法访问</b></font>。您可以在接口返回的信息中查看具体的过期时间。为避免错误,请确保在链接过期之前进行下载操作。\n\n### 4. 有两种开通下载权限的途径。\n\n**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图。\n授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)\n\n**第二种**: 渠道方企业在**企业应用管理**的配置界面打开需要配置的应用,点击**应用扩展服务**开通此功能,需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>\n注: \n1. `请注意如果第三方应用的子客主动关闭了渠道端下载渠道子客合同功能开关,那么渠道方开通了此功能也无法下载子客的合同文件`\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)",
|
488
502
|
"input": "DescribeResourceUrlsByFlowsRequest",
|
489
503
|
"name": "获取合同PDF下载链接",
|
490
504
|
"output": "DescribeResourceUrlsByFlowsResponse",
|
@@ -498,7 +512,7 @@
|
|
498
512
|
"status": "online"
|
499
513
|
},
|
500
514
|
"DescribeUsage": {
|
501
|
-
"document": "此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。\n\n注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。",
|
515
|
+
"document": "此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。\n\n<font color=\"red\">此接口即将下线, 请使用新接口</font> [查询渠道计费消耗情况](https://qian.tencent.com/developers/partnerApis/fee/ChannelDescribeBillUsageDetail)\n\n注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。",
|
502
516
|
"input": "DescribeUsageRequest",
|
503
517
|
"name": "合同消耗数量查询",
|
504
518
|
"output": "DescribeUsageResponse",
|
@@ -512,7 +526,7 @@
|
|
512
526
|
"status": "online"
|
513
527
|
},
|
514
528
|
"ModifyExtendedService": {
|
515
|
-
"document": "管理企业扩展服务\n\n- **直接开通的情形:** 若在操作过程中接口没有返回跳转链接,这表明无需进行任何跳转操作。此时,相应的企业拓展服务将会直接被开通或关闭。\n\n- **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。\n - **AUTO_SIGN(企业自动签)**\n - **DOWNLOAD_FLOW(授权渠道下载合同)**\n
|
529
|
+
"document": "管理企业扩展服务\n\n- **直接开通的情形:** 若在操作过程中接口没有返回跳转链接,这表明无需进行任何跳转操作。此时,相应的企业拓展服务将会直接被开通或关闭。\n\n- **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。\n - **AUTO_SIGN(企业自动签)**\n - **DOWNLOAD_FLOW(授权渠道下载合同)**\n\n注意: `在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人`\n\n\n对应的扩展服务能力可以在控制台的【扩展服务】中找到\n![image](https://qcloudimg.tencent-cloud.cn/raw/99eebd37883ec55ed1f1df3a57aee60a.png)",
|
516
530
|
"input": "ModifyExtendedServiceRequest",
|
517
531
|
"name": "管理企业扩展服务",
|
518
532
|
"output": "ModifyExtendedServiceResponse",
|
@@ -711,7 +725,7 @@
|
|
711
725
|
},
|
712
726
|
{
|
713
727
|
"disabled": false,
|
714
|
-
"document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** :
|
728
|
+
"document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** : 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>\n\n注:\n`使用动态签署人能力前,需登陆腾讯电子签控制台打开服务开关`",
|
715
729
|
"example": "无",
|
716
730
|
"member": "int64",
|
717
731
|
"name": "FillType",
|
@@ -1054,7 +1068,7 @@
|
|
1054
1068
|
},
|
1055
1069
|
{
|
1056
1070
|
"disabled": false,
|
1057
|
-
"document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n",
|
1071
|
+
"document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n\n注\n1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。\n2. 请确保抄送人列表中的成员不与任何签署人重复。",
|
1058
1072
|
"example": "无",
|
1059
1073
|
"member": "CcInfo",
|
1060
1074
|
"name": "CcInfos",
|
@@ -1122,43 +1136,39 @@
|
|
1122
1136
|
"members": [
|
1123
1137
|
{
|
1124
1138
|
"disabled": false,
|
1125
|
-
"document": "
|
1126
|
-
"example": "
|
1139
|
+
"document": "被抄送方手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。",
|
1140
|
+
"example": "13200000000",
|
1127
1141
|
"member": "string",
|
1128
1142
|
"name": "Mobile",
|
1129
1143
|
"required": false,
|
1130
|
-
"type": "string"
|
1131
|
-
"value_allowed_null": false
|
1144
|
+
"type": "string"
|
1132
1145
|
},
|
1133
1146
|
{
|
1134
1147
|
"disabled": false,
|
1135
|
-
"document": "
|
1136
|
-
"example": "
|
1148
|
+
"document": "被抄送方姓名。\n抄送方的姓名将用于身份认证,请确保填写的姓名为抄送方的真实姓名,而非昵称等代名。",
|
1149
|
+
"example": "典子谦",
|
1137
1150
|
"member": "string",
|
1138
1151
|
"name": "Name",
|
1139
1152
|
"required": false,
|
1140
|
-
"type": "string"
|
1141
|
-
"value_allowed_null": true
|
1153
|
+
"type": "string"
|
1142
1154
|
},
|
1143
1155
|
{
|
1144
1156
|
"disabled": false,
|
1145
|
-
"document": "
|
1146
|
-
"example": "
|
1157
|
+
"document": "被抄送方类型, 可设置以下类型:\n<ul><li> **0** :个人抄送方</li>\n<li> **1** :企业员工抄送方</li></ul>",
|
1158
|
+
"example": "1",
|
1147
1159
|
"member": "int64",
|
1148
1160
|
"name": "CcType",
|
1149
1161
|
"required": false,
|
1150
|
-
"type": "int"
|
1151
|
-
"value_allowed_null": true
|
1162
|
+
"type": "int"
|
1152
1163
|
},
|
1153
1164
|
{
|
1154
1165
|
"disabled": false,
|
1155
|
-
"document": "
|
1156
|
-
"example": "
|
1166
|
+
"document": "被抄送方权限, 可设置如下权限:\n<ul><li> **0** :可查看合同内容</li>\n<li> **1** :可查看合同内容也可下载原文</li></ul>",
|
1167
|
+
"example": "1",
|
1157
1168
|
"member": "int64",
|
1158
1169
|
"name": "CcPermission",
|
1159
1170
|
"required": false,
|
1160
|
-
"type": "int"
|
1161
|
-
"value_allowed_null": true
|
1171
|
+
"type": "int"
|
1162
1172
|
}
|
1163
1173
|
],
|
1164
1174
|
"usage": "in"
|
@@ -1614,7 +1624,7 @@
|
|
1614
1624
|
"members": [
|
1615
1625
|
{
|
1616
1626
|
"disabled": false,
|
1617
|
-
"document": "批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。\n注:\n`1.
|
1627
|
+
"document": "批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。\n<ul>\n<li>若为个人参与方:ApproverType:\"PERSON\"</li>\n<li>若为企业参与方:ApproverType:\"ORGANIZATION\"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,还需要传 OpenId、OrganizationOpenId。</li>\n</ul>\n\n注:\n`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`\n`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`",
|
1618
1628
|
"example": "无",
|
1619
1629
|
"member": "FlowApproverInfo",
|
1620
1630
|
"name": "FlowApproverInfo",
|
@@ -1659,7 +1669,7 @@
|
|
1659
1669
|
},
|
1660
1670
|
{
|
1661
1671
|
"disabled": false,
|
1662
|
-
"document": "指定批量签署合同的签名类型,可传递以下值:\n<ul><li>**0**:手写签名(默认)</li>\n<li>**1**:OCR楷体</li>\n<li>**2**:姓名印章</li>\n<li>**3**:图片印章</li>\n<li>**4**:系统签名</li></ul>\n注:\n<ul><li>默认情况下,签名类型为手写签名</li>\n<li>您可以传递多种值,表示可用多种签名类型。</li>\n<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li
|
1672
|
+
"document": "指定批量签署合同的签名类型,可传递以下值:\n<ul><li>**0**:手写签名(默认)</li>\n<li>**1**:OCR楷体</li>\n<li>**2**:姓名印章</li>\n<li>**3**:图片印章</li>\n<li>**4**:系统签名</li></ul>\n注:\n<ul><li>默认情况下,签名类型为手写签名</li>\n<li>您可以传递多种值,表示可用多种签名类型。</li>\n<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>\n<li>若签署方为企业员工,此参数无效,签名方式将以合同中为准。</li>\n</ul>",
|
1663
1673
|
"example": "[0, 1, 2, 3, 4]",
|
1664
1674
|
"member": "int64",
|
1665
1675
|
"name": "SignatureTypes",
|
@@ -1686,7 +1696,7 @@
|
|
1686
1696
|
},
|
1687
1697
|
{
|
1688
1698
|
"disabled": false,
|
1689
|
-
"document": "批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。\t",
|
1699
|
+
"document": "批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。\t\n\n注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`",
|
1690
1700
|
"example": "无",
|
1691
1701
|
"member": "FlowBatchUrlInfo",
|
1692
1702
|
"name": "FlowBatchUrlInfo",
|
@@ -1704,7 +1714,7 @@
|
|
1704
1714
|
},
|
1705
1715
|
{
|
1706
1716
|
"disabled": false,
|
1707
|
-
"document": "
|
1717
|
+
"document": "缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。\n\n注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`",
|
1708
1718
|
"example": "无",
|
1709
1719
|
"member": "bool",
|
1710
1720
|
"name": "CacheApproverInfo",
|
@@ -2142,7 +2152,7 @@
|
|
2142
2152
|
},
|
2143
2153
|
{
|
2144
2154
|
"disabled": false,
|
2145
|
-
"document": "合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID
|
2155
|
+
"document": "合同流程ID,为32位字符串。 \n- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n- 可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。\n- <font color=\"red\">不建议继续使用</font>,请使用<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId指定合同",
|
2146
2156
|
"example": "无",
|
2147
2157
|
"member": "string",
|
2148
2158
|
"name": "FlowId",
|
@@ -2233,7 +2243,7 @@
|
|
2233
2243
|
},
|
2234
2244
|
{
|
2235
2245
|
"disabled": false,
|
2236
|
-
"document": "合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C
|
2246
|
+
"document": "合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。\n\n如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。",
|
2237
2247
|
"example": "无",
|
2238
2248
|
"member": "FlowApproverInfo",
|
2239
2249
|
"name": "FlowApprovers",
|
@@ -2341,7 +2351,7 @@
|
|
2341
2351
|
},
|
2342
2352
|
{
|
2343
2353
|
"disabled": false,
|
2344
|
-
"document": "合同流程的抄送人列表,最多可支持50
|
2354
|
+
"document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n\n<b>注</b>\n1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。\n2. 请确保抄送人列表中的成员不与任何签署人重复。",
|
2345
2355
|
"example": "无",
|
2346
2356
|
"member": "CcInfo",
|
2347
2357
|
"name": "CcInfos",
|
@@ -2925,6 +2935,15 @@
|
|
2925
2935
|
"name": "ForbidPersonalMultipleSign",
|
2926
2936
|
"required": false,
|
2927
2937
|
"type": "bool"
|
2938
|
+
},
|
2939
|
+
{
|
2940
|
+
"disabled": false,
|
2941
|
+
"document": "合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。",
|
2942
|
+
"example": "true",
|
2943
|
+
"member": "bool",
|
2944
|
+
"name": "FlowNameAppendScannerInfo",
|
2945
|
+
"required": false,
|
2946
|
+
"type": "bool"
|
2928
2947
|
}
|
2929
2948
|
],
|
2930
2949
|
"type": "object"
|
@@ -3397,7 +3416,7 @@
|
|
3397
3416
|
},
|
3398
3417
|
{
|
3399
3418
|
"disabled": false,
|
3400
|
-
"document": "
|
3419
|
+
"document": "替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br/>\n如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href=\"https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/\">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>\n\n注:\n1. 支持更换企业的签署人,不支持更换个人类型的签署人。\n2. 己方企业支持自动签署,他方企业不支持自动签署。\n3. <b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。",
|
3401
3420
|
"example": "无",
|
3402
3421
|
"member": "ReleasedApprover",
|
3403
3422
|
"name": "ReleasedApprovers",
|
@@ -5721,7 +5740,7 @@
|
|
5721
5740
|
},
|
5722
5741
|
{
|
5723
5742
|
"disabled": false,
|
5724
|
-
"document": "**如果是Component填写控件类型,则可选的字段为**:\n\n<ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>\n<li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>\n<li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>\n<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>\n\n**如果是SignComponent签署控件类型,\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li></ul>\n \n注:` 表单域的控件不能作为印章和签名控件`",
|
5743
|
+
"document": "**如果是Component填写控件类型,则可选的字段为**:\n\n<ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>\n<li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>\n<li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>\n<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>\n\n**如果是SignComponent签署控件类型,\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li></ul>\n \n注:` 表单域的控件不能作为印章和签名控件`",
|
5725
5744
|
"example": "SIGN_SEAL",
|
5726
5745
|
"member": "string",
|
5727
5746
|
"name": "ComponentType",
|
@@ -5842,7 +5861,7 @@
|
|
5842
5861
|
},
|
5843
5862
|
{
|
5844
5863
|
"disabled": false,
|
5845
|
-
"document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:\n<ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>\n<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>\n<b>参数样例</b>:`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
|
5864
|
+
"document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:\n<ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>\n<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>\n<b>参数样例</b>:`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
|
5846
5865
|
"example": "ComponentExtra",
|
5847
5866
|
"member": "string",
|
5848
5867
|
"name": "ComponentExtra",
|
@@ -6376,6 +6395,93 @@
|
|
6376
6395
|
],
|
6377
6396
|
"type": "object"
|
6378
6397
|
},
|
6398
|
+
"CreateCloseOrganizationUrlRequest": {
|
6399
|
+
"document": "CreateCloseOrganizationUrl请求参数结构体",
|
6400
|
+
"members": [
|
6401
|
+
{
|
6402
|
+
"disabled": false,
|
6403
|
+
"document": "应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。",
|
6404
|
+
"example": "无",
|
6405
|
+
"member": "Agent",
|
6406
|
+
"name": "Agent",
|
6407
|
+
"required": true,
|
6408
|
+
"type": "object"
|
6409
|
+
}
|
6410
|
+
],
|
6411
|
+
"type": "object"
|
6412
|
+
},
|
6413
|
+
"CreateCloseOrganizationUrlResponse": {
|
6414
|
+
"document": "CreateCloseOrganizationUrl返回参数结构体",
|
6415
|
+
"members": [
|
6416
|
+
{
|
6417
|
+
"disabled": false,
|
6418
|
+
"document": "链接有效期,unix时间戳,精确到秒",
|
6419
|
+
"example": "1730257357",
|
6420
|
+
"member": "int64",
|
6421
|
+
"name": "ExpiredOn",
|
6422
|
+
"output_required": true,
|
6423
|
+
"type": "int",
|
6424
|
+
"value_allowed_null": false
|
6425
|
+
},
|
6426
|
+
{
|
6427
|
+
"disabled": false,
|
6428
|
+
"document": "H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序",
|
6429
|
+
"example": "https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=ENTERPRISE_LOGOUT_LANDING&shortKey=yDCkuUW35EQA3r0aqr88",
|
6430
|
+
"member": "string",
|
6431
|
+
"name": "LongUrl",
|
6432
|
+
"output_required": true,
|
6433
|
+
"type": "string",
|
6434
|
+
"value_allowed_null": false
|
6435
|
+
},
|
6436
|
+
{
|
6437
|
+
"disabled": false,
|
6438
|
+
"document": "H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序",
|
6439
|
+
"example": "https:/essurl.cn/ppiKUBJLt0",
|
6440
|
+
"member": "string",
|
6441
|
+
"name": "ShortUrl",
|
6442
|
+
"output_required": true,
|
6443
|
+
"type": "string",
|
6444
|
+
"value_allowed_null": false
|
6445
|
+
},
|
6446
|
+
{
|
6447
|
+
"disabled": false,
|
6448
|
+
"document": "APP或小程序跳转电子签小程序链接, 一般用于客户小程序或者APP跳转过来, 打开后进入腾讯电子签小程序",
|
6449
|
+
"example": "pages/guide/index?to=ENTERPRISE_LOGOUT_LANDING&shortKey=yDCkuUW35EQA3r0aqr88",
|
6450
|
+
"member": "string",
|
6451
|
+
"name": "MiniAppPath",
|
6452
|
+
"output_required": true,
|
6453
|
+
"type": "string",
|
6454
|
+
"value_allowed_null": false
|
6455
|
+
},
|
6456
|
+
{
|
6457
|
+
"disabled": false,
|
6458
|
+
"document": "二维码链接",
|
6459
|
+
"example": "https://dyn.ess.tencent.cn/imgs/qrcode_urls/enterprise_logout_landing/yDCkxUUckp495fo9Ua9wie1hisAGTzhI.png",
|
6460
|
+
"member": "string",
|
6461
|
+
"name": "QrcodeUrl",
|
6462
|
+
"output_required": true,
|
6463
|
+
"type": "string",
|
6464
|
+
"value_allowed_null": false
|
6465
|
+
},
|
6466
|
+
{
|
6467
|
+
"disabled": false,
|
6468
|
+
"document": "直接跳转至电子签小程序的二维码链接,无需通过中转页。您需要自行将其转换为二维码,使用微信扫码后可直接进入。请注意,直接点击链接是无效的。",
|
6469
|
+
"example": "https://res.ess.tencent.cn/mp-gate/release/ENTERPRISE_LOGOUT_LANDING?shortKey=yDCkuUW35EQA3r0aqr82",
|
6470
|
+
"member": "string",
|
6471
|
+
"name": "WeixinQrcodeUrl",
|
6472
|
+
"output_required": true,
|
6473
|
+
"type": "string",
|
6474
|
+
"value_allowed_null": false
|
6475
|
+
},
|
6476
|
+
{
|
6477
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
6478
|
+
"member": "string",
|
6479
|
+
"name": "RequestId",
|
6480
|
+
"type": "string"
|
6481
|
+
}
|
6482
|
+
],
|
6483
|
+
"type": "object"
|
6484
|
+
},
|
6379
6485
|
"CreateConsoleLoginUrlRequest": {
|
6380
6486
|
"document": "CreateConsoleLoginUrl请求参数结构体",
|
6381
6487
|
"members": [
|
@@ -6516,7 +6622,7 @@
|
|
6516
6622
|
},
|
6517
6623
|
{
|
6518
6624
|
"disabled": false,
|
6519
|
-
"document": "
|
6625
|
+
"document": "是否自动激活子客企业,有下面两种选项:\n\n**false(默认设置)**:不自动激活子客户。您需要通过控制台或调用[激活或者续期子企业](https://qian.tencent.com/developers/partnerApis/accounts/CreateChannelSubOrganizationActive)接口手动完成激活过程。\n\n**true**:若持有的许可证充足,子客户企业注册完成后将自动激活,无需手动操作或访问控制台。\n\n<b>注</b>:如果<b>应用扩展服务</b>中的<b>自动激活子客企业</b>为打开态, 则忽略本接口的AutoActive这个参数(若持有的许可证充足,子客户企业注册完成后将自动激活),具体位置参考下图:\n![image](https://qcloudimg.tencent-cloud.cn/raw/c3639b05503d3735bac483d17aa6b0a3.png)",
|
6520
6626
|
"example": "无",
|
6521
6627
|
"member": "bool",
|
6522
6628
|
"name": "AutoActive",
|
@@ -7022,7 +7128,7 @@
|
|
7022
7128
|
},
|
7023
7129
|
{
|
7024
7130
|
"disabled": false,
|
7025
|
-
"document": "被授企业id
|
7131
|
+
"document": "被授企业id/授权方企业id(即OrganizationId),如果是企业之间授权和AuthorizedOrganizationName二选一传入。\n\n注:`被授权企业必须和当前企业在同一应用号下`",
|
7026
7132
|
"example": "无",
|
7027
7133
|
"member": "string",
|
7028
7134
|
"name": "AuthorizedOrganizationId",
|
@@ -7031,7 +7137,7 @@
|
|
7031
7137
|
},
|
7032
7138
|
{
|
7033
7139
|
"disabled": false,
|
7034
|
-
"document": "
|
7140
|
+
"document": "被授企业名称/授权方企业的名字,如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。\n\n注: \n1. 如果名称中包含英文括号(),请使用中文括号()代替。\n2. 被授权企业必须和当前企业在同一应用号下",
|
7035
7141
|
"example": "无",
|
7036
7142
|
"member": "string",
|
7037
7143
|
"name": "AuthorizedOrganizationName",
|
@@ -7040,7 +7146,7 @@
|
|
7040
7146
|
},
|
7041
7147
|
{
|
7042
7148
|
"disabled": false,
|
7043
|
-
"document": "
|
7149
|
+
"document": "是否给平台应用授权\n\n<ul>\n<li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li>\n<li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li>\n</ul>\n\n 注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单,请联系运营经理开通。",
|
7044
7150
|
"example": "无",
|
7045
7151
|
"member": "bool",
|
7046
7152
|
"name": "PlatformAppAuthorization",
|
@@ -7049,7 +7155,7 @@
|
|
7049
7155
|
},
|
7050
7156
|
{
|
7051
7157
|
"disabled": false,
|
7052
|
-
"document": "
|
7158
|
+
"document": "在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:\n\n<ul>\n<li><strong>OFFICIAL</strong>:企业公章,用于代表企业对外的正式文件和重要事务的认证。</li>\n<li><strong>CONTRACT</strong>:合同专用章,专门用于签署各类合同。</li>\n<li><strong>FINANCE</strong>:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。</li>\n<li><strong>PERSONNEL</strong>:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li>\n</ul>",
|
7053
7159
|
"example": "无",
|
7054
7160
|
"member": "string",
|
7055
7161
|
"name": "SealTypes",
|
@@ -7058,7 +7164,7 @@
|
|
7058
7164
|
},
|
7059
7165
|
{
|
7060
7166
|
"disabled": false,
|
7061
|
-
"document": "
|
7167
|
+
"document": "在处理授权关系时,授权的方向\n<ul>\n<li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>\n<li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>\n</ul>",
|
7062
7168
|
"example": "无",
|
7063
7169
|
"member": "bool",
|
7064
7170
|
"name": "AuthToMe",
|
@@ -7186,7 +7292,7 @@
|
|
7186
7292
|
},
|
7187
7293
|
{
|
7188
7294
|
"disabled": false,
|
7189
|
-
"document": "
|
7295
|
+
"document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。\n注意:此字段可能返回 null,表示取不到有效值。",
|
7190
7296
|
"example": "2206EB**4597742",
|
7191
7297
|
"member": "string",
|
7192
7298
|
"name": "SerialNumber",
|
@@ -7365,7 +7471,7 @@
|
|
7365
7471
|
},
|
7366
7472
|
{
|
7367
7473
|
"disabled": false,
|
7368
|
-
"document": "合同流程ID数组,最多支持100个。\n注:
|
7474
|
+
"document": "合同流程ID数组,最多支持100个。\n\n注: \n1. 必须选择提供此参数或合同组编号中的一个。\n2. 当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。",
|
7369
7475
|
"example": "[\"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\"]",
|
7370
7476
|
"member": "string",
|
7371
7477
|
"name": "FlowIds",
|
@@ -7392,7 +7498,7 @@
|
|
7392
7498
|
},
|
7393
7499
|
{
|
7394
7500
|
"disabled": false,
|
7395
|
-
"document": "签署链接生成类型,可以选择的类型如下\n\n<ul><li
|
7501
|
+
"document": "签署链接生成类型,可以选择的类型如下\n\n<ul><li><strong>ALL</strong>:(默认)为所有签署方生成签署链接,但不包括自动签署(静默签署)的签署方。注意:<strong>此中类型不支持多个合同ID(FlowIds)</strong>。</li>\n<li><strong>CHANNEL</strong>:适用于第三方子企业的员工签署方。</li>\n<li><strong>NOT_CHANNEL</strong>:适用于SaaS平台企业的员工签署方。</li>\n<li><strong>PERSON</strong>:适用于个人或自然人签署方。</li>\n<li><strong>FOLLOWER</strong>:适用于关注方,目前指合同的抄送方。</li>\n<li><strong>RECIPIENT</strong>:根据RecipientId生成对应的签署链接,适用于动态添加签署人的情况。</li></ul>",
|
7396
7502
|
"example": "CHANNEL",
|
7397
7503
|
"member": "string",
|
7398
7504
|
"name": "GenerateType",
|
@@ -7401,7 +7507,7 @@
|
|
7401
7507
|
},
|
7402
7508
|
{
|
7403
7509
|
"disabled": false,
|
7404
|
-
"document": "SaaS
|
7510
|
+
"document": "SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: `1.GenerateType为\"NOT_CHANNEL\"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`",
|
7405
7511
|
"example": "典子谦示例企业",
|
7406
7512
|
"member": "string",
|
7407
7513
|
"name": "OrganizationName",
|
@@ -7446,7 +7552,7 @@
|
|
7446
7552
|
},
|
7447
7553
|
{
|
7448
7554
|
"disabled": false,
|
7449
|
-
"document": "第三方平台子客企业的企业的标识, 即OrganizationOpenId
|
7555
|
+
"document": "第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: `1.GenerateType为\"CHANNEL\"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`",
|
7450
7556
|
"example": "org_dianziqian",
|
7451
7557
|
"member": "string",
|
7452
7558
|
"name": "OrganizationOpenId",
|
@@ -7551,6 +7657,117 @@
|
|
7551
7657
|
],
|
7552
7658
|
"type": "object"
|
7553
7659
|
},
|
7660
|
+
"DeleteOrganizationAuthorizationInfo": {
|
7661
|
+
"document": "清理的企业认证流信息",
|
7662
|
+
"members": [
|
7663
|
+
{
|
7664
|
+
"disabled": false,
|
7665
|
+
"document": "认证流 Id 是指在企业认证过程中,当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内,一个企业只能有一个认证流程处于成功状态,以确保认证的唯一性和有效性。\t",
|
7666
|
+
"example": "yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY",
|
7667
|
+
"member": "string",
|
7668
|
+
"name": "AuthorizationId",
|
7669
|
+
"output_required": false,
|
7670
|
+
"type": "string",
|
7671
|
+
"value_allowed_null": false
|
7672
|
+
},
|
7673
|
+
{
|
7674
|
+
"disabled": false,
|
7675
|
+
"document": "认证的企业名称\t",
|
7676
|
+
"example": "典子谦示例企业\t",
|
7677
|
+
"member": "string",
|
7678
|
+
"name": "OrganizationName",
|
7679
|
+
"output_required": false,
|
7680
|
+
"type": "string",
|
7681
|
+
"value_allowed_null": false
|
7682
|
+
},
|
7683
|
+
{
|
7684
|
+
"disabled": false,
|
7685
|
+
"document": "第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#agent\" target=\"_blank\">Agent结构体</a>",
|
7686
|
+
"example": "org_dianziqian",
|
7687
|
+
"member": "string",
|
7688
|
+
"name": "OrganizationOpenId",
|
7689
|
+
"output_required": false,
|
7690
|
+
"type": "string",
|
7691
|
+
"value_allowed_null": false
|
7692
|
+
},
|
7693
|
+
{
|
7694
|
+
"disabled": false,
|
7695
|
+
"document": "清除认证流产生的错误信息",
|
7696
|
+
"example": "无",
|
7697
|
+
"member": "string",
|
7698
|
+
"name": "Errormessage",
|
7699
|
+
"output_required": false,
|
7700
|
+
"type": "string",
|
7701
|
+
"value_allowed_null": false
|
7702
|
+
}
|
7703
|
+
],
|
7704
|
+
"usage": "out"
|
7705
|
+
},
|
7706
|
+
"DeleteOrganizationAuthorizationsRequest": {
|
7707
|
+
"document": "DeleteOrganizationAuthorizations请求参数结构体",
|
7708
|
+
"members": [
|
7709
|
+
{
|
7710
|
+
"disabled": false,
|
7711
|
+
"document": "关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: Agent.AppId</li>\n</ul>\n",
|
7712
|
+
"example": "无",
|
7713
|
+
"member": "Agent",
|
7714
|
+
"name": "Agent",
|
7715
|
+
"required": true,
|
7716
|
+
"type": "object"
|
7717
|
+
},
|
7718
|
+
{
|
7719
|
+
"disabled": false,
|
7720
|
+
"document": "认证人姓名,组织机构超管姓名。 在注册流程中,必须是超管本人进行操作。 ",
|
7721
|
+
"example": "张三",
|
7722
|
+
"member": "string",
|
7723
|
+
"name": "AdminName",
|
7724
|
+
"required": false,
|
7725
|
+
"type": "string"
|
7726
|
+
},
|
7727
|
+
{
|
7728
|
+
"disabled": false,
|
7729
|
+
"document": "认证人手机号,组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。 ",
|
7730
|
+
"example": "18888888888",
|
7731
|
+
"member": "string",
|
7732
|
+
"name": "AdminMobile",
|
7733
|
+
"required": false,
|
7734
|
+
"type": "string"
|
7735
|
+
}
|
7736
|
+
],
|
7737
|
+
"type": "object"
|
7738
|
+
},
|
7739
|
+
"DeleteOrganizationAuthorizationsResponse": {
|
7740
|
+
"document": "DeleteOrganizationAuthorizations返回参数结构体",
|
7741
|
+
"members": [
|
7742
|
+
{
|
7743
|
+
"disabled": false,
|
7744
|
+
"document": "清理认证流的详细信息,包括企业名称、认证流唯一 ID 以及清理认证流过程中产生的错误信息。",
|
7745
|
+
"example": "无",
|
7746
|
+
"member": "DeleteOrganizationAuthorizationInfo",
|
7747
|
+
"name": "DeleteOrganizationAuthorizationInfos",
|
7748
|
+
"output_required": false,
|
7749
|
+
"type": "list",
|
7750
|
+
"value_allowed_null": false
|
7751
|
+
},
|
7752
|
+
{
|
7753
|
+
"disabled": false,
|
7754
|
+
"document": "批量清理认证流返回的状态值其中包括- 1 全部成功- 2 部分成功- 3 全部失败",
|
7755
|
+
"example": "1",
|
7756
|
+
"member": "uint64",
|
7757
|
+
"name": "Status",
|
7758
|
+
"output_required": false,
|
7759
|
+
"type": "int",
|
7760
|
+
"value_allowed_null": false
|
7761
|
+
},
|
7762
|
+
{
|
7763
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
7764
|
+
"member": "string",
|
7765
|
+
"name": "RequestId",
|
7766
|
+
"type": "string"
|
7767
|
+
}
|
7768
|
+
],
|
7769
|
+
"type": "object"
|
7770
|
+
},
|
7554
7771
|
"Department": {
|
7555
7772
|
"document": "第三方应用集成员工部门信息",
|
7556
7773
|
"members": [
|
@@ -8711,7 +8928,7 @@
|
|
8711
8928
|
},
|
8712
8929
|
{
|
8713
8930
|
"disabled": false,
|
8714
|
-
"document": "合同流程ID
|
8931
|
+
"document": "合同流程ID\n- 补充合同组子合同动态签署人时必传。\n- 补充正常合同,请阅读:<a href=\"https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/\" target=\"_blank\">补充签署人接口</a>接口使用说明",
|
8715
8932
|
"example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
|
8716
8933
|
"member": "string",
|
8717
8934
|
"name": "FlowId",
|
@@ -8743,6 +8960,16 @@
|
|
8743
8960
|
"output_required": false,
|
8744
8961
|
"type": "string",
|
8745
8962
|
"value_allowed_null": true
|
8963
|
+
},
|
8964
|
+
{
|
8965
|
+
"disabled": false,
|
8966
|
+
"document": "合同流程ID,为32位字符串。\t\n注意:此字段可能返回 null,表示取不到有效值。",
|
8967
|
+
"example": "无",
|
8968
|
+
"member": "string",
|
8969
|
+
"name": "FlowId",
|
8970
|
+
"output_required": false,
|
8971
|
+
"type": "string",
|
8972
|
+
"value_allowed_null": true
|
8746
8973
|
}
|
8747
8974
|
],
|
8748
8975
|
"usage": "out"
|
@@ -9685,7 +9912,7 @@
|
|
9685
9912
|
},
|
9686
9913
|
{
|
9687
9914
|
"disabled": false,
|
9688
|
-
"document": "合同流程的参与方列表,最多可支持50
|
9915
|
+
"document": "合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)\n\n注: \n<font color=\"red\" > <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。\n例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>\n\n[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)\n",
|
9689
9916
|
"example": "签署人信息",
|
9690
9917
|
"member": "FlowApproverInfo",
|
9691
9918
|
"name": "FlowApprovers",
|
@@ -9748,7 +9975,7 @@
|
|
9748
9975
|
},
|
9749
9976
|
{
|
9750
9977
|
"disabled": false,
|
9751
|
-
"document": "合同流程的抄送人列表,最多可支持50
|
9978
|
+
"document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n\n<b>注</b>\n1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。\n2. 请确保抄送人列表中的成员不与任何签署人重复。",
|
9752
9979
|
"example": " ",
|
9753
9980
|
"member": "CcInfo",
|
9754
9981
|
"name": "CcInfos",
|
@@ -10157,7 +10384,7 @@
|
|
10157
10384
|
},
|
10158
10385
|
{
|
10159
10386
|
"disabled": false,
|
10160
|
-
"document": " 扩展服务类型\n<ul>\n<li>AUTO_SIGN 企业自动签(自动签署)</li>\n<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>\n<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>\n<li>
|
10387
|
+
"document": " 扩展服务类型\n<ul>\n<li>AUTO_SIGN 企业自动签(自动签署)</li>\n<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>\n<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>\n<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>\n<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>\n<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>\n</ul>",
|
10161
10388
|
"example": "AUTO_SIGN",
|
10162
10389
|
"member": "string",
|
10163
10390
|
"name": "ServiceType",
|
@@ -10190,7 +10417,7 @@
|
|
10190
10417
|
"members": [
|
10191
10418
|
{
|
10192
10419
|
"disabled": false,
|
10193
|
-
"document": "操作跳转链接\n<ul><li><strong>链接有效期:</strong> 跳转链接的有效期为24小时。</li>\n<li><strong>没有返回链接的情形:</strong> 如果在操作时没有返回跳转链接,说明此次操作无需进行跳转,服务将会直接被开通或关闭。</li>\n<li><strong>返回链接的情形:</strong> 当操作类型为<b>OPEN(开通服务)</b>,并且扩展服务类型为<b>AUTO_SIGN( 企业自动签署)</b>、<b>DOWNLOAD_FLOW(授权渠道下载合同)</b
|
10420
|
+
"document": "操作跳转链接\n<ul><li><strong>链接有效期:</strong> 跳转链接的有效期为24小时。</li>\n<li><strong>没有返回链接的情形:</strong> 如果在操作时没有返回跳转链接,说明此次操作无需进行跳转,服务将会直接被开通或关闭。</li>\n<li><strong>返回链接的情形:</strong> 当操作类型为<b>OPEN(开通服务)</b>,并且扩展服务类型为<b>AUTO_SIGN( 企业自动签署)</b>、<b>DOWNLOAD_FLOW(授权渠道下载合同)</b>时,系统将返回一个操作链接。收到操作链接后,贵方需主动联系超级管理员(超管)或法人。<font color=\"red\"><b>由超管或法人点击链接</b></font>,以完成服务的开通操作。</li>\n</ul>\n\n",
|
10194
10421
|
"example": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=xxxxx&organizationId=xxxxx&channelType=xxxxx&expired_time=1673428532&login=1&verify=1",
|
10195
10422
|
"member": "string",
|
10196
10423
|
"name": "OperateUrl",
|
@@ -10715,7 +10942,7 @@
|
|
10715
10942
|
},
|
10716
10943
|
{
|
10717
10944
|
"disabled": false,
|
10718
|
-
"document": "
|
10945
|
+
"document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。",
|
10719
10946
|
"example": "6c8e2911fadf70ea",
|
10720
10947
|
"member": "string",
|
10721
10948
|
"name": "CertSn",
|
@@ -11527,7 +11754,7 @@
|
|
11527
11754
|
},
|
11528
11755
|
{
|
11529
11756
|
"disabled": false,
|
11530
|
-
"document": "参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。\n如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20
|
11757
|
+
"document": "参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。\n如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png)",
|
11531
11758
|
"example": "供应商",
|
11532
11759
|
"member": "string",
|
11533
11760
|
"name": "ApproverSignRole",
|