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
@@ -64,7 +64,7 @@
|
|
64
64
|
"status": "online"
|
65
65
|
},
|
66
66
|
"CreateBatchQuickSignUrl": {
|
67
|
-
"document": "
|
67
|
+
"document": "该接口用于发起合同后,生成个人/企业用户的批量待办链接。\n**注意:**\n1. 该接口可生成签署人的批量、合同组签署/查看链接 。\n2. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n3. 该接口返回的签署链接适用于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>。\n4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
|
68
68
|
"input": "CreateBatchQuickSignUrlRequest",
|
69
69
|
"name": "获取H5批量签署或查看链接",
|
70
70
|
"output": "CreateBatchQuickSignUrlResponse",
|
@@ -127,7 +127,7 @@
|
|
127
127
|
"status": "online"
|
128
128
|
},
|
129
129
|
"CreateFlowApprovers": {
|
130
|
-
"document": "**适用场景 :**\n\n当通过模板或文件发起合同时, 签署人不制定, 等合同发起后再指定 可以用下面2种方案\n\n<b><font color=\"red\">1. 或签合同</font>: 若未指定企业签署人信息(只指定企业的名字),合同变成或签合同(个人签署方不支持或签合同)</b>。需调用此接口补充或添加签署人。或签签署人在控制台上的展示样式如下(会带有<b>或签</b>标识):\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/b2715f0236faee807cfc0521f93cf01b.png)\n\n<b><font color=\"red\">2. 动态签署人合同</font>: 若未指定具体签署人的信息,则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档 <a href=\"https://qian.tencent.com/developers/company/dynamic_signer/\" target=\"_blank\">动态签署人合同</a> 。动态签署人在控制台上的展示样式如下:\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/2729477978e020c3bbb4d2e767bb78eb.png)\n\n实际签署人需要通过[获取跳转至腾讯电子签小程序的签署链接](https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl/)生成的链接进入小程序,领取合同并签署。同一签署环节可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。\n\n\n**限制条件**:\n\n1.本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。\n\n2.本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。\n\n3.他方企业仅支持通过姓名+手机号进行补充。\n\n4.个人签署人支持通过姓名+手机号进行补充(若<b>个人用户已完成实名</b>,动态签署人合同也可以可通过姓名+证件号码进行补充)\n\n\n**整体流程如下图:**\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/29a0fba0ceebf9227849459947384862.png)",
|
130
|
+
"document": "**适用场景 :**\n\n当通过模板或文件发起合同时, 签署人不制定, 等合同发起后再指定 可以用下面2种方案\n\n<b><font color=\"red\">1. 或签合同</font>: 若未指定企业签署人信息(只指定企业的名字),合同变成或签合同(个人签署方不支持或签合同)</b>。需调用此接口补充或添加签署人。或签签署人在控制台上的展示样式如下(会带有<b>或签</b>标识):\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/b2715f0236faee807cfc0521f93cf01b.png)\n\n<b><font color=\"red\">2. 动态签署人合同</font>: 若未指定具体签署人的信息,则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档 <a href=\"https://qian.tencent.com/developers/company/dynamic_signer/\" target=\"_blank\">动态签署人合同</a> 。动态签署人在控制台上的展示样式如下:\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/2729477978e020c3bbb4d2e767bb78eb.png)\n\n实际签署人需要通过[获取跳转至腾讯电子签小程序的签署链接](https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl/)生成的链接进入小程序,领取合同并签署。同一签署环节可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。\n\n**接口使用说明**:\n\n1.本接口现已支持批量补充签署人\n\n2.当<a href=\"https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中指定需要补充的FlowId时,可以对指定合同补充签署人;可以指定多个相同发起方的不同合同在完成批量补充\n\n3.当<a href=\"https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/\" target=\"_blank\">补充签署人接口入参</a>中指定需要补充的FlowId时,是对指定的合同补充多个指定的签署人\n\n4.如果同时指定了<a href=\"https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId和<a href=\"https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/\" target=\"_blank\">补充签署人接口入参</a>中的FlowId,仅使用<a href=\"https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId作为补充的合同\n\n5.如果部分指定了<a href=\"https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId,又指定了<a href=\"https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/\" target=\"_blank\">补充签署人接口入参</a>中的FlowId;那么<a href=\"https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>存在指定的FlowId,则使用<a href=\"https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId,不存在则使用<a href=\"https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/\" target=\"_blank\">补充签署人接口入参</a>中的FlowId作为补充的合同\n\n\n6.如果同时未指定了<a href=\"https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId和<a href=\"https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/\" target=\"_blank\">补充签署人接口入参</a>中的FlowId,则传参错误。\n\n7.新加入的签署方<font color=\"red\">平台不会发送短信</font>通知。请您生成相应的链接,并将该链接发送给签署方以便完成签署过程。\n\n**限制条件**:\n\n1.本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。\n\n2.本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。\n\n3.他方企业仅支持通过姓名+手机号进行补充。\n\n4.个人签署人支持通过姓名+手机号进行补充(若<b>个人用户已完成实名</b>,动态签署人合同也可以可通过姓名+证件号码进行补充)\n\n\n**整体流程如下图:**\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/29a0fba0ceebf9227849459947384862.png)",
|
131
131
|
"input": "CreateFlowApproversRequest",
|
132
132
|
"name": "补充签署流程签署人信息",
|
133
133
|
"output": "CreateFlowApproversResponse",
|
@@ -155,14 +155,14 @@
|
|
155
155
|
"status": "online"
|
156
156
|
},
|
157
157
|
"CreateFlowGroupByFiles": {
|
158
|
-
"document": "此接口(CreateFlowGroupByFiles
|
158
|
+
"document": "此接口(CreateFlowGroupByFiles)可用于通过多个文件创建合同组签署流程。使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。\n\n- 该接口允许通过PDF资源ID一次性创建多个合同,这些合同被组织在一个合同组中。\n- 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。\n- 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。\n\n<img src=\"https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png\" width=\"400\" />\n\n### 2. 适用场景\n\n该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。\n\n\n### 3. 合同额度的扣减与返还\n- **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。\n- **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。\n- **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。\n\n### 4.合同组暂不支持抄送功能",
|
159
159
|
"input": "CreateFlowGroupByFilesRequest",
|
160
160
|
"name": "通过多文件创建合同组签署流程",
|
161
161
|
"output": "CreateFlowGroupByFilesResponse",
|
162
162
|
"status": "online"
|
163
163
|
},
|
164
164
|
"CreateFlowGroupByTemplates": {
|
165
|
-
"document": "此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。\n\n
|
165
|
+
"document": "此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。\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\n### 3. 合同额度的扣减与返还\n- **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。\n- **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。\n- **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。\n\n### 4.合同组暂不支持抄送功能",
|
166
166
|
"input": "CreateFlowGroupByTemplatesRequest",
|
167
167
|
"name": "通过多模板创建合同组签署流程",
|
168
168
|
"output": "CreateFlowGroupByTemplatesResponse",
|
@@ -267,16 +267,16 @@
|
|
267
267
|
"status": "online"
|
268
268
|
},
|
269
269
|
"CreateOrganizationInfoChangeUrl": {
|
270
|
-
"document": "此接口(CreateOrganizationInfoChangeUrl)用于创建企业信息变更链接,支持创建企业超管变更链接或企业基础信息变更链接,通过入参ChangeType指定。\n\n
|
270
|
+
"document": "此接口(CreateOrganizationInfoChangeUrl)用于创建企业信息变更链接,支持创建企业超管变更链接或企业基础信息变更链接,通过入参ChangeType指定。\n\n 需要企业的<font color=\"red\">现有的超级管理员、法人来点击</font>链接执行变动操作。\n\n### 2. 企业基础信息\n#### A. 可变动的信息\n- **企业名称**\n- **法定代表人姓名**(新法人将收到邀请链接)\n- **企业地址和所在地**\n- **企业超级管理员变更** (此变更将企业超级管理员的职责转移给企业的其他员工)\n\n#### B. 不可变动的信息\n- **统一社会信用代码**\n- **企业主体类型**\n\n### 3.变更影响\n\n如果企业的名字变更将导致下面的影响:\n\n- **合同**:已存在的合同将保持不变。新发起的合同需使用新的企业名称作为签署方,否则无法签署。\n- **印章**:所有现有的机构公章和合同专用章将被删除,并将根据新的企业名称重新生成。法人章、财务专用章和人事专用章将不做处理。\n- **证书**:企业证书将重新由CA机构使用新的企业名称生成。",
|
271
271
|
"input": "CreateOrganizationInfoChangeUrlRequest",
|
272
272
|
"name": "创建企业信息变更链接",
|
273
273
|
"output": "CreateOrganizationInfoChangeUrlResponse",
|
274
274
|
"status": "online"
|
275
275
|
},
|
276
276
|
"CreatePartnerAutoSignAuthUrl": {
|
277
|
-
"document": "
|
277
|
+
"document": "创建一个用于他方自动签授权的链接(可选择他方授权或我方授权)。通过这个链接,合作方企业可以直接进入小程序,进行自动签授权操作。\n\n如果授权企业尚未开通企业自动签功能,该链接还将引导他们首先开通本企业的自动签服务\n\n注: \n1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)\n2. 已经在授权中或者授权成功的企业,无法重复授权\n3. 授权企业和被授权企业必须都是已认证企业\n4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。\n\n\n**该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**\n![image](https://qcloudimg.tencent-cloud.cn/raw/489aa0bf74941469b5e740f428f17c3a.png)",
|
278
278
|
"input": "CreatePartnerAutoSignAuthUrlRequest",
|
279
|
-
"name": "
|
279
|
+
"name": "创建他方自动签授权链接",
|
280
280
|
"output": "CreatePartnerAutoSignAuthUrlResponse",
|
281
281
|
"status": "online"
|
282
282
|
},
|
@@ -302,7 +302,7 @@
|
|
302
302
|
"status": "online"
|
303
303
|
},
|
304
304
|
"CreateReleaseFlow": {
|
305
|
-
"document": "发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。\n解除协议的模板是官方提供
|
305
|
+
"document": "发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。\n解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。具体用法可以参考文档[合同解除](https://qian.tencent.com/developers/company/flow_release)。\n\n注意:\n<ul>\n<li><strong>完成原合同签署后方可发起解除协议:</strong>只有在原合同所有签署人完成签署后,才可以启动解除协议的流程。</li>\n<li><strong>原合同状态更新:</strong>解除协议一旦签署完毕,原合同及解除协议状态将更新为“已解除”。</li>\n<li><strong>解除协议的个人参与要求:</strong>原合同中的个人参与者必须直接参与解除协议,禁止替换为其他第三方个人。</li>\n<li><strong>企业参与人的代理权:</strong>若原合同的企业参与人无法亲自参与解除协议,可指派具有等同权限的企业员工代行。</li>\n<li><strong>解除协议的费用问题:</strong>发起解除协议将产生费用,其扣费标准与其他企业合同相同。</li>\n<li><strong>解除协议的发起资格:</strong>仅限原合同中的企业类型参与者发起解除协议,个人参与者无此权限。</li>\n<li><strong>非原合同企业参与者的权限:</strong>非原合同的企业参与者发起解除协议时,必须具备相应的解除权限。</li>\n<li><strong>自动签署:</strong>支持本企业的自动签署,不支持其他企业的自动签署(不能不动神色的把别人参与的合同作废了)</li>\n</ul>\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/3427941ecb091bf0c55009bad192dd1c.png)",
|
306
306
|
"input": "CreateReleaseFlowRequest",
|
307
307
|
"name": "发起解除协议",
|
308
308
|
"output": "CreateReleaseFlowResponse",
|
@@ -392,6 +392,13 @@
|
|
392
392
|
"output": "DeleteIntegrationRoleUsersResponse",
|
393
393
|
"status": "online"
|
394
394
|
},
|
395
|
+
"DeleteOrganizationAuthorizations": {
|
396
|
+
"document": "批量清理未认证的企业认证流程。\n\n此接口用来清除企业方认证信息填写错误,批量清理认证中的认证流信息。\n为接口[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks) 和[查询企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls) 接口的扩展接口。即在批量认证过程中,当发起认证企业发现超管信息错误的时候,可以将当前超管下的所有认证流企业清除。\n\n注意:\n**这个接口的操作人必须跟生成批量认证链接接口的操作人一致,才可以调用,否则会返回当前操作人没有认证中的企业认证流**",
|
397
|
+
"input": "DeleteOrganizationAuthorizationsRequest",
|
398
|
+
"name": "批量清除未认证的企业认证流",
|
399
|
+
"output": "DeleteOrganizationAuthorizationsResponse",
|
400
|
+
"status": "online"
|
401
|
+
},
|
395
402
|
"DeleteSealPolicies": {
|
396
403
|
"document": "本接口(DeleteSealPolicies)用于撤销企业员工持有的印章权限",
|
397
404
|
"input": "DeleteSealPoliciesRequest",
|
@@ -442,7 +449,7 @@
|
|
442
449
|
"status": "online"
|
443
450
|
},
|
444
451
|
"DescribeFileUrls": {
|
445
|
-
"document": "本接口(DescribeFileUrls)用于查询文件的下载URL。\n适用场景:通过传参合同流程编号,下载对应的合同PDF
|
452
|
+
"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>。您可以在接口返回的信息中查看具体的过期时间。为避免错误,请确保在链接过期之前进行下载操作。",
|
446
453
|
"input": "DescribeFileUrlsRequest",
|
447
454
|
"name": "查询文件下载URL",
|
448
455
|
"output": "DescribeFileUrlsResponse",
|
@@ -535,7 +542,7 @@
|
|
535
542
|
"DescribeSignFaceVideo": {
|
536
543
|
"document": "该接口用于在使用视频认证方式签署合同后,获取用户的签署人脸认证视频。\n\n1. 该接口**仅适用于在H5端签署**的合同,**在通过视频认证后**获取人脸视频。\n2. 该接口**不支持小程序端**的签署人脸视频获取。\n3. 请在**签署完成后的三天内**获取人脸视频,**过期后将无法获取**。\n\n**注意:该接口需要开通白名单,请联系客户经理开通后使用。**",
|
537
544
|
"input": "DescribeSignFaceVideoRequest",
|
538
|
-
"name": "
|
545
|
+
"name": "查询H5签署认证人脸视频",
|
539
546
|
"output": "DescribeSignFaceVideoResponse",
|
540
547
|
"status": "online"
|
541
548
|
},
|
@@ -568,7 +575,7 @@
|
|
568
575
|
"status": "online"
|
569
576
|
},
|
570
577
|
"GetTaskResultApi": {
|
571
|
-
"document": "此接口(GetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>进行资源文件的转换操作<br />\n前提条件:已调用 <a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />\n\n适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />\n注:\n1.
|
578
|
+
"document": "此接口(GetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>进行资源文件的转换操作<br />\n前提条件:已调用 <a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />\n\n适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />\n注:\n1. `大文件转换所需的时间可能会比较长`\n2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`",
|
572
579
|
"input": "GetTaskResultApiRequest",
|
573
580
|
"name": "查询转换任务状态",
|
574
581
|
"output": "GetTaskResultApiResponse",
|
@@ -582,7 +589,7 @@
|
|
582
589
|
"status": "online"
|
583
590
|
},
|
584
591
|
"ModifyExtendedService": {
|
585
|
-
"document": "管理企业扩展服务\n\n- **直接开通的情形:** 若在操作过程中接口没有返回跳转链接,这表明无需进行任何跳转操作。此时,相应的企业拓展服务将会直接被开通或关闭。\n\n- **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。\n - **OPEN_SERVER_SIGN(企业自动签)**\n
|
592
|
+
"document": "管理企业扩展服务\n\n- **直接开通的情形:** 若在操作过程中接口没有返回跳转链接,这表明无需进行任何跳转操作。此时,相应的企业拓展服务将会直接被开通或关闭。\n\n- **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。\n - **OPEN_SERVER_SIGN(企业自动签)**\n\n注意: `在调用此接口以管理企业扩展服务时,操作者(入参中的Operator)必须是企业的超级管理员(超管)或法人`\n\n\n对应的扩展服务能力可以在控制台的【扩展服务】中找到\n![image](https://qcloudimg.tencent-cloud.cn/raw/7eb35d2473d6c29784f3b35617bca9a9.png)",
|
586
593
|
"input": "ModifyExtendedServiceRequest",
|
587
594
|
"name": "管理企业扩展服务",
|
588
595
|
"output": "ModifyExtendedServiceResponse",
|
@@ -1032,7 +1039,7 @@
|
|
1032
1039
|
},
|
1033
1040
|
{
|
1034
1041
|
"disabled": false,
|
1035
|
-
"document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** :
|
1042
|
+
"document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** : 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>\n\n注:\n`使用动态签署人能力前,需登陆腾讯电子签控制台打开服务开关`",
|
1036
1043
|
"example": "无",
|
1037
1044
|
"member": "int64",
|
1038
1045
|
"name": "FillType",
|
@@ -1907,7 +1914,7 @@
|
|
1907
1914
|
"members": [
|
1908
1915
|
{
|
1909
1916
|
"disabled": false,
|
1910
|
-
"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>WATERMARK</b> : 水印控件;只能分配给发起方,必须设置ComponentExtra;</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注:` 表单域的控件不能作为印章和签名控件`",
|
1917
|
+
"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>WATERMARK</b> : 水印控件;只能分配给发起方,必须设置ComponentExtra;</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注:` 表单域的控件不能作为印章和签名控件`",
|
1911
1918
|
"example": "SIGN_SEAL",
|
1912
1919
|
"member": "string",
|
1913
1920
|
"name": "ComponentType",
|
@@ -2039,7 +2046,7 @@
|
|
2039
2046
|
},
|
2040
2047
|
{
|
2041
2048
|
"disabled": false,
|
2042
|
-
"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为WATERMARK时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围6 :24</li>\n<li> <b>Opacity</b>: 透明度,范围0 :1</li>\n<li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>\n<li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>:`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\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\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\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
|
2049
|
+
"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为WATERMARK时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围6 :24</li>\n<li> <b>Opacity</b>: 透明度,范围0 :1</li>\n<li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>\n<li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>:`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\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\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\">签署印章透明度功能设置,</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}\"`",
|
2043
2050
|
"example": "无",
|
2044
2051
|
"member": "string",
|
2045
2052
|
"name": "ComponentExtra",
|
@@ -2596,7 +2603,7 @@
|
|
2596
2603
|
"members": [
|
2597
2604
|
{
|
2598
2605
|
"disabled": false,
|
2599
|
-
"document": "批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。\n注:\n`1.
|
2606
|
+
"document": "批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。\n<ul>\n<li>若为个人参与方:ApproverType=1</li>\n<li>若为企业参与方:ApproverType=0。同时 OrganizationName 参数需传入参与方企业名称。 </li>\n</ul>\n注:\n`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`\n`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`",
|
2600
2607
|
"example": "无",
|
2601
2608
|
"member": "FlowCreateApprover",
|
2602
2609
|
"name": "FlowApproverInfo",
|
@@ -2650,7 +2657,7 @@
|
|
2650
2657
|
},
|
2651
2658
|
{
|
2652
2659
|
"disabled": false,
|
2653
|
-
"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</ul>",
|
2660
|
+
"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>",
|
2654
2661
|
"example": "[0, 1, 2, 3, 4]",
|
2655
2662
|
"member": "int64",
|
2656
2663
|
"name": "SignatureTypes",
|
@@ -2677,7 +2684,7 @@
|
|
2677
2684
|
},
|
2678
2685
|
{
|
2679
2686
|
"disabled": false,
|
2680
|
-
"document": "批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。\t",
|
2687
|
+
"document": "批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。\t\n\n注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`",
|
2681
2688
|
"example": "无",
|
2682
2689
|
"member": "FlowBatchUrlInfo",
|
2683
2690
|
"name": "FlowBatchUrlInfo",
|
@@ -2686,7 +2693,7 @@
|
|
2686
2693
|
},
|
2687
2694
|
{
|
2688
2695
|
"disabled": false,
|
2689
|
-
"document": "<b>只有在生成H5签署链接的情形下</b>( 如调用<a href=\"https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl\" target=\"_blank\">获取H5签署链接</a>、<a href=\"https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl\" target=\"_blank\">获取H5批量签署链接</a>等接口),该配置才会生效。 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。
|
2696
|
+
"document": "<b>只有在生成H5签署链接的情形下</b>( 如调用<a href=\"https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl\" target=\"_blank\">获取H5签署链接</a>、<a href=\"https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl\" target=\"_blank\">获取H5批量签署链接</a>等接口),该配置才会生效。 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。 \n\n 注意: \n1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。\n2. 使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。 \n3. 签署完成后,可以通过<a href=\"https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo\" target=\"_blank\">查询签署认证人脸视频</a>获取到当时的视频。",
|
2690
2697
|
"example": "无",
|
2691
2698
|
"member": "Intention",
|
2692
2699
|
"name": "Intention",
|
@@ -2695,7 +2702,7 @@
|
|
2695
2702
|
},
|
2696
2703
|
{
|
2697
2704
|
"disabled": false,
|
2698
|
-
"document": "
|
2705
|
+
"document": "缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。\n\n注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`",
|
2699
2706
|
"example": "无",
|
2700
2707
|
"member": "bool",
|
2701
2708
|
"name": "CacheApproverInfo",
|
@@ -3391,7 +3398,7 @@
|
|
3391
3398
|
},
|
3392
3399
|
{
|
3393
3400
|
"disabled": false,
|
3394
|
-
"document": "合同流程ID,为32位字符串。\n建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)
|
3401
|
+
"document": "合同流程ID,为32位字符串。\n- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n- 可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。\n- <font color=\"red\">不建议继续使用</font>,请使用<a href=\"https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId来指定需要补充的合同id",
|
3395
3402
|
"example": "无",
|
3396
3403
|
"member": "string",
|
3397
3404
|
"name": "FlowId",
|
@@ -3611,7 +3618,7 @@
|
|
3611
3618
|
},
|
3612
3619
|
{
|
3613
3620
|
"disabled": false,
|
3614
|
-
"document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n",
|
3621
|
+
"document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n\n<b>注</b>\n1. 抄送人名单中可以包括自然人以及本企业的员工。\n2. 请确保抄送人列表中的成员不与任何签署人重复。\n",
|
3615
3622
|
"example": "无",
|
3616
3623
|
"member": "CcInfo",
|
3617
3624
|
"name": "CcInfos",
|
@@ -3938,23 +3945,23 @@
|
|
3938
3945
|
"members": [
|
3939
3946
|
{
|
3940
3947
|
"disabled": false,
|
3941
|
-
"document": "合同(流程)组的合同组Id
|
3948
|
+
"document": "合同(流程)组的合同组Id",
|
3942
3949
|
"example": "无",
|
3943
3950
|
"member": "string",
|
3944
3951
|
"name": "FlowGroupId",
|
3945
3952
|
"output_required": true,
|
3946
3953
|
"type": "string",
|
3947
|
-
"value_allowed_null":
|
3954
|
+
"value_allowed_null": false
|
3948
3955
|
},
|
3949
3956
|
{
|
3950
3957
|
"disabled": false,
|
3951
|
-
"document": "合同(流程)
|
3958
|
+
"document": "合同(流程)组中子合同列表.",
|
3952
3959
|
"example": "无",
|
3953
3960
|
"member": "string",
|
3954
3961
|
"name": "FlowIds",
|
3955
3962
|
"output_required": true,
|
3956
3963
|
"type": "list",
|
3957
|
-
"value_allowed_null":
|
3964
|
+
"value_allowed_null": false
|
3958
3965
|
},
|
3959
3966
|
{
|
3960
3967
|
"disabled": false,
|
@@ -4449,7 +4456,7 @@
|
|
4449
4456
|
},
|
4450
4457
|
{
|
4451
4458
|
"disabled": false,
|
4452
|
-
"document": "合同流程的抄送人列表,最多可支持50
|
4459
|
+
"document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n\n<b>注</b>\n1. 抄送人名单中可以包括自然人以及本企业的员工。\n2. 请确保抄送人列表中的成员不与任何签署人重复。",
|
4453
4460
|
"example": "无",
|
4454
4461
|
"member": "CcInfo",
|
4455
4462
|
"name": "CcInfos",
|
@@ -5237,6 +5244,15 @@
|
|
5237
5244
|
"name": "ForbidPersonalMultipleSign",
|
5238
5245
|
"required": false,
|
5239
5246
|
"type": "bool"
|
5247
|
+
},
|
5248
|
+
{
|
5249
|
+
"disabled": false,
|
5250
|
+
"document": "合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。\n例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。",
|
5251
|
+
"example": "true",
|
5252
|
+
"member": "bool",
|
5253
|
+
"name": "FlowNameAppendScannerInfo",
|
5254
|
+
"required": false,
|
5255
|
+
"type": "bool"
|
5240
5256
|
}
|
5241
5257
|
],
|
5242
5258
|
"type": "object"
|
@@ -5446,6 +5462,15 @@
|
|
5446
5462
|
"name": "Endpoint",
|
5447
5463
|
"required": false,
|
5448
5464
|
"type": "string"
|
5465
|
+
},
|
5466
|
+
{
|
5467
|
+
"disabled": false,
|
5468
|
+
"document": "指定企业初始化引导,现在可以配置如下的选项:\n\n<b>1</b>: 启用此选项后,在企业认证的最终步骤将添加创建印章的引导。如下图的位置\n![image](https://qcloudimg.tencent-cloud.cn/raw/88e0b45095a5c589de8995462ad755dc.jpg)",
|
5469
|
+
"example": "1",
|
5470
|
+
"member": "uint64",
|
5471
|
+
"name": "Initialization",
|
5472
|
+
"required": false,
|
5473
|
+
"type": "list"
|
5449
5474
|
}
|
5450
5475
|
],
|
5451
5476
|
"type": "object"
|
@@ -5747,7 +5772,7 @@
|
|
5747
5772
|
},
|
5748
5773
|
{
|
5749
5774
|
"disabled": false,
|
5750
|
-
"document": "被授企业id/授权方企业id
|
5775
|
+
"document": "被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入",
|
5751
5776
|
"example": "无",
|
5752
5777
|
"member": "string",
|
5753
5778
|
"name": "AuthorizedOrganizationId",
|
@@ -5756,7 +5781,7 @@
|
|
5756
5781
|
},
|
5757
5782
|
{
|
5758
5783
|
"disabled": false,
|
5759
|
-
"document": "
|
5784
|
+
"document": "被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。\n注: `如果名称中包含英文括号(),请使用中文括号()代替。`",
|
5760
5785
|
"example": "无",
|
5761
5786
|
"member": "string",
|
5762
5787
|
"name": "AuthorizedOrganizationName",
|
@@ -5765,7 +5790,7 @@
|
|
5765
5790
|
},
|
5766
5791
|
{
|
5767
5792
|
"disabled": false,
|
5768
|
-
"document": "
|
5793
|
+
"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>",
|
5769
5794
|
"example": "无",
|
5770
5795
|
"member": "string",
|
5771
5796
|
"name": "SealTypes",
|
@@ -5774,7 +5799,7 @@
|
|
5774
5799
|
},
|
5775
5800
|
{
|
5776
5801
|
"disabled": false,
|
5777
|
-
"document": "
|
5802
|
+
"document": "在处理授权关系时,授权的方向\n<ul>\n<li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>\n<li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>\n</ul>",
|
5778
5803
|
"example": "无",
|
5779
5804
|
"member": "bool",
|
5780
5805
|
"name": "AuthToMe",
|
@@ -5911,7 +5936,7 @@
|
|
5911
5936
|
},
|
5912
5937
|
{
|
5913
5938
|
"disabled": false,
|
5914
|
-
"document": "
|
5939
|
+
"document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。\n注意:此字段可能返回 null,表示取不到有效值。",
|
5915
5940
|
"example": "2206EB**4597742",
|
5916
5941
|
"member": "string",
|
5917
5942
|
"name": "SerialNumber",
|
@@ -6370,7 +6395,7 @@
|
|
6370
6395
|
},
|
6371
6396
|
{
|
6372
6397
|
"disabled": false,
|
6373
|
-
"document": "替换解除协议的签署人,
|
6398
|
+
"document": "替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br/>\n如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href=\"https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/\">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>\n\n注:\n1. 支持更换企业的签署人,不支持更换个人类型的签署人。\n2. 己方企业支持自动签署,他方企业不支持自动签署。\n3. <b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。",
|
6374
6399
|
"example": "无",
|
6375
6400
|
"member": "ReleasedApprover",
|
6376
6401
|
"name": "ReleasedApprovers",
|
@@ -6467,7 +6492,7 @@
|
|
6467
6492
|
},
|
6468
6493
|
{
|
6469
6494
|
"disabled": false,
|
6470
|
-
"document": "
|
6495
|
+
"document": "合同流程签署方的组织机构名称。如果名称中包含英文括号(),请使用中文括号()代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`",
|
6471
6496
|
"example": "典子谦示例企业",
|
6472
6497
|
"member": "string",
|
6473
6498
|
"name": "OrganizationName",
|
@@ -7725,6 +7750,125 @@
|
|
7725
7750
|
],
|
7726
7751
|
"type": "object"
|
7727
7752
|
},
|
7753
|
+
"DeleteOrganizationAuthorizationInfo": {
|
7754
|
+
"document": "清理的企业认证流信息",
|
7755
|
+
"members": [
|
7756
|
+
{
|
7757
|
+
"disabled": false,
|
7758
|
+
"document": "认证流 Id 是指在企业认证过程中,当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内,一个企业只能有一个认证流程处于成功状态,以确保认证的唯一性和有效性。",
|
7759
|
+
"example": "yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY",
|
7760
|
+
"member": "string",
|
7761
|
+
"name": "AuthorizationId",
|
7762
|
+
"output_required": false,
|
7763
|
+
"type": "string",
|
7764
|
+
"value_allowed_null": false
|
7765
|
+
},
|
7766
|
+
{
|
7767
|
+
"disabled": false,
|
7768
|
+
"document": "认证的企业名称",
|
7769
|
+
"example": "典子谦示例企业",
|
7770
|
+
"member": "string",
|
7771
|
+
"name": "OrganizationName",
|
7772
|
+
"output_required": false,
|
7773
|
+
"type": "string",
|
7774
|
+
"value_allowed_null": false
|
7775
|
+
},
|
7776
|
+
{
|
7777
|
+
"disabled": false,
|
7778
|
+
"document": "清除认证流产生的错误信息",
|
7779
|
+
"example": "无",
|
7780
|
+
"member": "string",
|
7781
|
+
"name": "Errormessage",
|
7782
|
+
"output_required": false,
|
7783
|
+
"type": "string",
|
7784
|
+
"value_allowed_null": false
|
7785
|
+
}
|
7786
|
+
],
|
7787
|
+
"usage": "out"
|
7788
|
+
},
|
7789
|
+
"DeleteOrganizationAuthorizationsRequest": {
|
7790
|
+
"document": "DeleteOrganizationAuthorizations请求参数结构体",
|
7791
|
+
"members": [
|
7792
|
+
{
|
7793
|
+
"disabled": false,
|
7794
|
+
"document": "执行本接口操作的员工信息, userId 必填。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
7795
|
+
"example": "无",
|
7796
|
+
"member": "UserInfo",
|
7797
|
+
"name": "Operator",
|
7798
|
+
"required": true,
|
7799
|
+
"type": "object"
|
7800
|
+
},
|
7801
|
+
{
|
7802
|
+
"disabled": false,
|
7803
|
+
"document": "认证流Ids数组\n认证流 Id 是指在企业认证过程中,当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内,一个企业只能有一个认证流程处于成功状态,以确保认证的唯一性和有效性。\n\n\n认证流 Id可以通过回调 [授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E5%9B%9B-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83) 获取\n\n注意:\n如果传递了认证流Id,则下面的参数 超管二要素不会生效",
|
7804
|
+
"example": "yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY",
|
7805
|
+
"member": "string",
|
7806
|
+
"name": "AuthorizationIds",
|
7807
|
+
"required": false,
|
7808
|
+
"type": "list"
|
7809
|
+
},
|
7810
|
+
{
|
7811
|
+
"disabled": false,
|
7812
|
+
"document": "认证人姓名,组织机构超管姓名。 \n在注册流程中,必须是超管本人进行操作。 ",
|
7813
|
+
"example": "张三",
|
7814
|
+
"member": "string",
|
7815
|
+
"name": "AdminName",
|
7816
|
+
"required": false,
|
7817
|
+
"type": "string"
|
7818
|
+
},
|
7819
|
+
{
|
7820
|
+
"disabled": false,
|
7821
|
+
"document": "认证人手机号,组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。 ",
|
7822
|
+
"example": "18888888888",
|
7823
|
+
"member": "string",
|
7824
|
+
"name": "AdminMobile",
|
7825
|
+
"required": false,
|
7826
|
+
"type": "string"
|
7827
|
+
},
|
7828
|
+
{
|
7829
|
+
"disabled": false,
|
7830
|
+
"document": "代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
7831
|
+
"example": "无",
|
7832
|
+
"member": "Agent",
|
7833
|
+
"name": "Agent",
|
7834
|
+
"required": false,
|
7835
|
+
"type": "object"
|
7836
|
+
}
|
7837
|
+
],
|
7838
|
+
"type": "object"
|
7839
|
+
},
|
7840
|
+
"DeleteOrganizationAuthorizationsResponse": {
|
7841
|
+
"document": "DeleteOrganizationAuthorizations返回参数结构体",
|
7842
|
+
"members": [
|
7843
|
+
{
|
7844
|
+
"disabled": false,
|
7845
|
+
"document": "清理的认证流的详细信息,其中包括企业名称,认证流唯一 Id 以及清理过程中产生的错误信息",
|
7846
|
+
"example": "无",
|
7847
|
+
"member": "DeleteOrganizationAuthorizationInfo",
|
7848
|
+
"name": "DeleteOrganizationAuthorizationInfos",
|
7849
|
+
"output_required": false,
|
7850
|
+
"type": "list",
|
7851
|
+
"value_allowed_null": false
|
7852
|
+
},
|
7853
|
+
{
|
7854
|
+
"disabled": false,
|
7855
|
+
"document": "批量清理认证流返回的状态值\n其中包括\n- 1 全部成功\n- 2 部分成功\n- 3 全部失败",
|
7856
|
+
"example": "1",
|
7857
|
+
"member": "uint64",
|
7858
|
+
"name": "Status",
|
7859
|
+
"output_required": false,
|
7860
|
+
"type": "int",
|
7861
|
+
"value_allowed_null": false
|
7862
|
+
},
|
7863
|
+
{
|
7864
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
7865
|
+
"member": "string",
|
7866
|
+
"name": "RequestId",
|
7867
|
+
"type": "string"
|
7868
|
+
}
|
7869
|
+
],
|
7870
|
+
"type": "object"
|
7871
|
+
},
|
7728
7872
|
"DeleteSealPoliciesRequest": {
|
7729
7873
|
"document": "DeleteSealPolicies请求参数结构体",
|
7730
7874
|
"members": [
|
@@ -10385,7 +10529,7 @@
|
|
10385
10529
|
},
|
10386
10530
|
{
|
10387
10531
|
"disabled": false,
|
10388
|
-
"document": "合同流程ID
|
10532
|
+
"document": "合同流程ID\n- 补充合同组子合同动态签署人时必传。\n- 补充普通合同时,请阅读:<a href=\"https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/\" target=\"_blank\">补充签署人接口</a>的接口使用说明",
|
10389
10533
|
"example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
|
10390
10534
|
"member": "string",
|
10391
10535
|
"name": "FlowId",
|
@@ -10417,6 +10561,16 @@
|
|
10417
10561
|
"output_required": false,
|
10418
10562
|
"type": "string",
|
10419
10563
|
"value_allowed_null": true
|
10564
|
+
},
|
10565
|
+
{
|
10566
|
+
"disabled": false,
|
10567
|
+
"document": "合同流程ID,为32位字符串。\t\n注意:此字段可能返回 null,表示取不到有效值。",
|
10568
|
+
"example": "无",
|
10569
|
+
"member": "string",
|
10570
|
+
"name": "FlowId",
|
10571
|
+
"output_required": false,
|
10572
|
+
"type": "string",
|
10573
|
+
"value_allowed_null": true
|
10420
10574
|
}
|
10421
10575
|
],
|
10422
10576
|
"usage": "out"
|
@@ -12207,7 +12361,7 @@
|
|
12207
12361
|
"members": [
|
12208
12362
|
{
|
12209
12363
|
"disabled": false,
|
12210
|
-
"document": "操作跳转链接\n<ul>\n<li><strong>有效期:</strong> 跳转链接的有效期为24小时。</li>\n<li><strong>无跳转链接返回的情况:</strong> 如果在操作过程中没有返回跳转链接,这意味着无需进行跳转操作。在这种情况下,服务将会直接被开通或关闭。\n<li><strong>有跳转链接返回的情况:</strong> 当操作类型为“OPEN”(开通服务),并且扩展服务类型为以下之一时, 系统将返回一个操作链接。当前操作人(超级管理员或法人)需要点击此链接,以完成服务的开通操作。\n\n<ul>\n<li><strong>OPEN_SERVER_SIGN</strong>(企业自动签署)</li>\n
|
12364
|
+
"document": "操作跳转链接\n<ul>\n<li><strong>有效期:</strong> 跳转链接的有效期为24小时。</li>\n<li><strong>无跳转链接返回的情况:</strong> 如果在操作过程中没有返回跳转链接,这意味着无需进行跳转操作。在这种情况下,服务将会直接被开通或关闭。\n<li><strong>有跳转链接返回的情况:</strong> 当操作类型为“OPEN”(开通服务),并且扩展服务类型为以下之一时, 系统将返回一个操作链接。当前操作人(超级管理员或法人)需要点击此链接,以完成服务的开通操作。\n\n<ul>\n<li><strong>OPEN_SERVER_SIGN</strong>(企业自动签署)</li>\n</ul></li></li>\n</ul>",
|
12211
12365
|
"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",
|
12212
12366
|
"member": "string",
|
12213
12367
|
"name": "OperateUrl",
|
@@ -12838,7 +12992,7 @@
|
|
12838
12992
|
},
|
12839
12993
|
{
|
12840
12994
|
"disabled": false,
|
12841
|
-
"document": "
|
12995
|
+
"document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。",
|
12842
12996
|
"example": "无",
|
12843
12997
|
"member": "string",
|
12844
12998
|
"name": "CertSn",
|
@@ -13518,7 +13672,7 @@
|
|
13518
13672
|
},
|
13519
13673
|
{
|
13520
13674
|
"disabled": false,
|
13521
|
-
"document": "参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。\n\n如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。\n",
|
13675
|
+
"document": "参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。\n\n如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png)\n",
|
13522
13676
|
"example": "供应商",
|
13523
13677
|
"member": "string",
|
13524
13678
|
"name": "ApproverSignRole",
|