tccli 3.0.1391.1__py2.py3-none-any.whl → 3.0.1414.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of tccli might be problematic. Click here for more details.
- tccli/__init__.py +1 -1
- tccli/services/__init__.py +2 -1
- tccli/services/ai3d/v20250513/api.json +22 -4
- tccli/services/aiart/aiart_client.py +173 -67
- tccli/services/aiart/v20221229/api.json +193 -0
- tccli/services/aiart/v20221229/examples.json +16 -0
- tccli/services/apm/apm_client.py +53 -0
- tccli/services/apm/v20210622/api.json +354 -0
- tccli/services/apm/v20210622/examples.json +8 -0
- tccli/services/asr/v20190614/api.json +3 -3
- tccli/services/autoscaling/v20180419/api.json +24 -2
- tccli/services/batch/v20170312/api.json +1 -1
- tccli/services/bda/bda_client.py +15 -704
- tccli/services/bda/v20200324/api.json +107 -1819
- tccli/services/bda/v20200324/examples.json +0 -176
- tccli/services/billing/billing_client.py +326 -8
- tccli/services/billing/v20180709/api.json +2200 -255
- tccli/services/billing/v20180709/examples.json +48 -0
- tccli/services/cam/v20190116/api.json +4 -4
- tccli/services/captcha/v20190722/api.json +3 -3
- tccli/services/cat/v20180409/api.json +7 -7
- tccli/services/ccc/ccc_client.py +235 -76
- tccli/services/ccc/v20200210/api.json +502 -18
- tccli/services/ccc/v20200210/examples.json +24 -0
- tccli/services/cdb/cdb_client.py +106 -0
- tccli/services/cdb/v20170320/api.json +257 -44
- tccli/services/cdb/v20170320/examples.json +22 -6
- tccli/services/cdn/cdn_client.py +4 -163
- tccli/services/cdn/v20180606/api.json +61 -310
- tccli/services/cdn/v20180606/examples.json +1 -25
- tccli/services/cdwdoris/v20211228/api.json +51 -12
- tccli/services/cdwpg/v20201230/api.json +11 -1
- tccli/services/cdwpg/v20201230/examples.json +1 -1
- tccli/services/cfg/v20210820/api.json +11 -1
- tccli/services/cfs/cfs_client.py +41 -94
- tccli/services/cfs/v20190719/api.json +171 -55
- tccli/services/cfs/v20190719/examples.json +1 -9
- tccli/services/cfw/v20190904/api.json +122 -10
- tccli/services/ckafka/ckafka_client.py +188 -29
- tccli/services/ckafka/v20190819/api.json +277 -4
- tccli/services/ckafka/v20190819/examples.json +25 -1
- tccli/services/clb/clb_client.py +0 -265
- tccli/services/clb/v20180317/api.json +130 -296
- tccli/services/clb/v20180317/examples.json +12 -40
- tccli/services/cloudapp/v20220530/api.json +55 -0
- tccli/services/cloudaudit/v20190319/api.json +11 -0
- tccli/services/cloudhsm/v20191112/api.json +10 -10
- tccli/services/cls/v20201016/api.json +63 -45
- tccli/services/cls/v20201016/examples.json +10 -4
- tccli/services/csip/v20221121/api.json +53 -3
- tccli/services/ctem/v20231128/api.json +320 -0
- tccli/services/ctem/v20231128/examples.json +3 -3
- tccli/services/cvm/cvm_client.py +0 -212
- tccli/services/cvm/v20170312/api.json +91 -843
- tccli/services/cvm/v20170312/examples.json +32 -58
- tccli/services/cynosdb/cynosdb_client.py +167 -8
- tccli/services/cynosdb/v20190107/api.json +1126 -148
- tccli/services/cynosdb/v20190107/examples.json +31 -7
- tccli/services/dbbrain/dbbrain_client.py +246 -87
- tccli/services/dbbrain/v20191016/api.json +74 -62
- tccli/services/dbbrain/v20191016/examples.json +1 -1
- tccli/services/dbbrain/v20210527/api.json +601 -177
- tccli/services/dbbrain/v20210527/examples.json +28 -4
- tccli/services/dc/v20180410/api.json +101 -3
- tccli/services/dcdb/v20180411/api.json +1 -1
- tccli/services/dlc/dlc_client.py +53 -0
- tccli/services/dlc/v20210125/api.json +237 -24
- tccli/services/dlc/v20210125/examples.json +12 -4
- tccli/services/dnspod/dnspod_client.py +106 -0
- tccli/services/dnspod/v20210323/api.json +126 -20
- tccli/services/dnspod/v20210323/examples.json +17 -7
- tccli/services/dsgc/v20190723/api.json +73 -15
- tccli/services/dts/v20180330/api.json +4 -4
- tccli/services/dts/v20211206/api.json +408 -127
- tccli/services/dts/v20211206/examples.json +15 -9
- tccli/services/eb/v20210416/api.json +41 -1
- tccli/services/eb/v20210416/examples.json +1 -1
- tccli/services/emr/v20190103/api.json +56 -9
- tccli/services/emr/v20190103/examples.json +5 -5
- tccli/services/es/es_client.py +273 -8
- tccli/services/es/v20180416/api.json +845 -33
- tccli/services/es/v20180416/examples.json +33 -1
- tccli/services/es/v20250101/api.json +135 -2
- tccli/services/es/v20250101/examples.json +8 -0
- tccli/services/ess/ess_client.py +509 -32
- tccli/services/ess/v20201111/api.json +1366 -113
- tccli/services/ess/v20201111/examples.json +94 -10
- tccli/services/essbasic/v20210526/api.json +265 -27
- tccli/services/essbasic/v20210526/examples.json +12 -12
- tccli/services/facefusion/v20220927/api.json +1 -1
- tccli/services/gaap/v20180529/api.json +18 -8
- tccli/services/gme/gme_client.py +53 -0
- tccli/services/gme/v20180711/api.json +241 -1
- tccli/services/gme/v20180711/examples.json +8 -0
- tccli/services/gs/gs_client.py +216 -4
- tccli/services/gs/v20191118/api.json +202 -1
- tccli/services/gs/v20191118/examples.json +32 -0
- tccli/services/gwlb/gwlb_client.py +53 -0
- tccli/services/gwlb/v20240906/api.json +150 -0
- tccli/services/gwlb/v20240906/examples.json +8 -0
- tccli/services/hai/v20230812/api.json +5 -5
- tccli/services/hunyuan/v20230901/api.json +3 -3
- tccli/services/hunyuan/v20230901/examples.json +1 -1
- tccli/services/iai/v20180301/api.json +227 -207
- tccli/services/iai/v20180301/examples.json +26 -26
- tccli/services/iai/v20200303/api.json +4 -4
- tccli/services/iai/v20200303/examples.json +1 -1
- tccli/services/ioa/ioa_client.py +265 -0
- tccli/services/ioa/v20220601/api.json +781 -85
- tccli/services/ioa/v20220601/examples.json +46 -0
- tccli/services/iotexplorer/iotexplorer_client.py +387 -16
- tccli/services/iotexplorer/v20190423/api.json +1183 -63
- tccli/services/iotexplorer/v20190423/examples.json +92 -0
- tccli/services/keewidb/v20220308/api.json +69 -17
- tccli/services/keewidb/v20220308/examples.json +5 -5
- tccli/services/lcic/v20220817/api.json +61 -15
- tccli/services/lighthouse/v20200324/api.json +193 -24
- tccli/services/lighthouse/v20200324/examples.json +9 -3
- tccli/services/live/v20180801/api.json +6 -6
- tccli/services/live/v20180801/examples.json +7 -1
- tccli/services/lke/lke_client.py +40 -93
- tccli/services/lke/v20231130/api.json +943 -390
- tccli/services/lke/v20231130/examples.json +38 -46
- tccli/services/lkeap/v20240522/api.json +39 -12
- tccli/services/lkeap/v20240522/examples.json +12 -0
- tccli/services/mariadb/v20170312/api.json +1 -1
- tccli/services/mna/v20210119/api.json +11 -2
- tccli/services/mna/v20210119/examples.json +1 -1
- tccli/services/mongodb/mongodb_client.py +334 -16
- tccli/services/mongodb/v20190725/api.json +1092 -383
- tccli/services/mongodb/v20190725/examples.json +69 -21
- tccli/services/monitor/monitor_client.py +106 -0
- tccli/services/monitor/v20180724/api.json +383 -12
- tccli/services/monitor/v20180724/examples.json +24 -2
- tccli/services/mps/mps_client.py +220 -8
- tccli/services/mps/v20190612/api.json +1999 -179
- tccli/services/mps/v20190612/examples.json +56 -6
- tccli/services/mqtt/v20240516/api.json +10 -0
- tccli/services/mqtt/v20240516/examples.json +3 -9
- tccli/services/nlp/v20190408/api.json +6 -6
- tccli/services/oceanus/oceanus_client.py +318 -0
- tccli/services/oceanus/v20190422/api.json +461 -26
- tccli/services/oceanus/v20190422/examples.json +50 -2
- tccli/services/ocr/ocr_client.py +41 -253
- tccli/services/ocr/v20181119/api.json +153 -659
- tccli/services/ocr/v20181119/examples.json +8 -40
- tccli/services/omics/v20221128/api.json +90 -7
- tccli/services/organization/v20210331/api.json +46 -7
- tccli/services/postgres/v20170312/api.json +333 -77
- tccli/services/postgres/v20170312/examples.json +37 -31
- tccli/services/privatedns/privatedns_client.py +641 -58
- tccli/services/privatedns/v20201028/api.json +930 -19
- tccli/services/privatedns/v20201028/examples.json +91 -3
- tccli/services/pts/v20210728/api.json +2 -2
- tccli/services/redis/v20180412/api.json +303 -109
- tccli/services/redis/v20180412/examples.json +12 -12
- tccli/services/region/v20220627/api.json +1 -1
- tccli/services/rum/v20210622/api.json +22 -4
- tccli/services/rum/v20210622/examples.json +2 -2
- tccli/services/sms/v20190711/api.json +12 -12
- tccli/services/sms/v20190711/examples.json +9 -3
- tccli/services/sms/v20210111/api.json +13 -13
- tccli/services/sms/v20210111/examples.json +8 -2
- tccli/services/sqlserver/v20180328/api.json +46 -7
- tccli/services/sqlserver/v20180328/examples.json +2 -2
- tccli/services/ssl/v20191205/api.json +28 -0
- tccli/services/svp/v20240125/api.json +14 -4
- tccli/services/tag/v20180813/api.json +3 -3
- tccli/services/tat/v20201028/api.json +22 -3
- tccli/services/tcb/v20180608/api.json +1 -1
- tccli/services/tcss/tcss_client.py +228 -69
- tccli/services/tcss/v20201101/api.json +273 -25
- tccli/services/tcss/v20201101/examples.json +26 -2
- tccli/services/teo/teo_client.py +317 -52
- tccli/services/teo/v20220901/api.json +1824 -242
- tccli/services/teo/v20220901/examples.json +109 -21
- tccli/services/thpc/thpc_client.py +57 -4
- tccli/services/thpc/v20230321/api.json +163 -21
- tccli/services/thpc/v20230321/examples.json +13 -5
- tccli/services/tione/tione_client.py +163 -4
- tccli/services/tione/v20211111/api.json +285 -21
- tccli/services/tione/v20211111/examples.json +27 -3
- tccli/services/tke/tke_client.py +8 -8
- tccli/services/tke/v20180525/api.json +168 -130
- tccli/services/tke/v20180525/examples.json +20 -20
- tccli/services/tke/v20220501/api.json +215 -3
- tccli/services/tke/v20220501/examples.json +8 -0
- tccli/services/tms/tms_client.py +106 -0
- tccli/services/tms/v20201229/api.json +249 -3
- tccli/services/tms/v20201229/examples.json +16 -0
- tccli/services/tmt/v20180321/api.json +78 -1
- tccli/services/trabbit/v20230418/api.json +271 -4
- tccli/services/trabbit/v20230418/examples.json +9 -3
- tccli/services/trocket/v20230308/api.json +4 -4
- tccli/services/trro/trro_client.py +106 -0
- tccli/services/trro/v20220325/api.json +456 -0
- tccli/services/trro/v20220325/examples.json +16 -0
- tccli/services/trtc/v20190722/api.json +197 -49
- tccli/services/trtc/v20190722/examples.json +4 -4
- tccli/services/tse/v20201207/api.json +69 -2
- tccli/services/tse/v20201207/examples.json +3 -3
- tccli/services/tsf/v20180326/api.json +70 -7
- tccli/services/tsf/v20180326/examples.json +2 -2
- tccli/services/vclm/v20240523/api.json +145 -0
- tccli/services/vclm/v20240523/examples.json +16 -0
- tccli/services/vclm/vclm_client.py +106 -0
- tccli/services/vcube/v20220410/api.json +1 -1
- tccli/services/vod/v20180717/api.json +7 -7
- tccli/services/vpc/v20170312/api.json +1216 -70
- tccli/services/vpc/v20170312/examples.json +139 -3
- tccli/services/vpc/vpc_client.py +1023 -122
- tccli/services/vrs/v20200824/api.json +11 -11
- tccli/services/vrs/v20200824/examples.json +1 -1
- tccli/services/vtc/v20240223/api.json +14 -14
- tccli/services/waf/v20180125/api.json +812 -143
- tccli/services/waf/v20180125/examples.json +2 -2
- tccli/services/wedata/v20210820/api.json +1281 -601
- tccli/services/wedata/v20210820/examples.json +127 -157
- tccli/services/wedata/v20250806/api.json +19335 -0
- tccli/services/wedata/v20250806/examples.json +999 -0
- tccli/services/wedata/wedata_client.py +7072 -1131
- {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/METADATA +9 -7
- {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/RECORD +226 -224
- {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/WHEEL +1 -1
- {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1391.1.dist-info/license_files → tccli-3.0.1414.1.dist-info/licenses}/LICENSE +0 -0
|
@@ -85,12 +85,19 @@
|
|
|
85
85
|
"status": "online"
|
|
86
86
|
},
|
|
87
87
|
"CreateBatchSignUrl": {
|
|
88
|
-
"document": "通过此接口,可以创建小程序批量签署链接,个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。\n\n注意事项:\n- 使用此接口生成链接,需要贵企业先开通 <font color=\"red\">个人签署方仅校验手机号 </font>功能。您可以在 <b
|
|
88
|
+
"document": "通过此接口,可以创建小程序批量签署链接,个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。\n\n注意事项:\n- 使用此接口生成链接,需要贵企业先开通 <font color=\"red\">个人签署方仅校验手机号 </font>功能。您可以在 <b>【腾讯电子签网页端控制台】->【更多】->【高级签署能力】</b>中找到该功能。\n- 生成批量签署链接时,<font color=\"red\">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人点击链接后需要输入短信验证码才能查看合同内容。\n- 企业员工批量签署链接:需要传入签署方所在企业名称,用户名字和手机号(或者身份证件信息)参数来生成签署链接。<font color=\"red\">该签署方企业必须已完成腾讯电子签企业认证</font>\n- 个人批量签署链接:需要传入签署方用户名字和手机号(或者身份证件信息)参数来生成签署链接。个人批量签署进行的合同的签名区, 全部变成<font color=\"red\">手写签名</font>(不管合同里边设置的签名限制)来进行。\n- 不支持签署方含有签批控件,或设置了签署方在签署时自行添加签署控件功能的合同进行批量签署。\n- 进行小程序批量签署必须指定待签署的流程id,<font color=\"red\">接口中FlowIds参数必传。</font>",
|
|
89
89
|
"input": "CreateBatchSignUrlRequest",
|
|
90
90
|
"name": "获取跳转至腾讯电子签小程序的批量签署链接",
|
|
91
91
|
"output": "CreateBatchSignUrlResponse",
|
|
92
92
|
"status": "online"
|
|
93
93
|
},
|
|
94
|
+
"CreateContractComparisonTask": {
|
|
95
|
+
"document": "此接口(CreateContractComparisonTask)用于创建合同对比任务。\n适用场景:对比两份合同中字段(如:金额、日期、甲方名称等)的内容差异。",
|
|
96
|
+
"input": "CreateContractComparisonTaskRequest",
|
|
97
|
+
"name": "创建合同对比任务",
|
|
98
|
+
"output": "CreateContractComparisonTaskResponse",
|
|
99
|
+
"status": "online"
|
|
100
|
+
},
|
|
94
101
|
"CreateContractDiffTaskWebUrl": {
|
|
95
102
|
"document": "接口(CreateContractDiffTaskWebUrl)用于创建合同对比的可嵌入web页面链接(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。\n注:本接口生成的web页面暂不支持<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/CreateWebThemeConfig\" target=\"_blank\">设置本企业嵌入式页面主题配置</a>\n\n未跳过上传确认的嵌入页面长相如下:\n\n跳过上传确认的嵌入页面长相如下:\n",
|
|
96
103
|
"input": "CreateContractDiffTaskWebUrlRequest",
|
|
@@ -245,6 +252,13 @@
|
|
|
245
252
|
"output": "CreateFlowSignUrlResponse",
|
|
246
253
|
"status": "online"
|
|
247
254
|
},
|
|
255
|
+
"CreateInformationExtractionWebUrl": {
|
|
256
|
+
"document": "此接口(CreateInformationExtractionWebUrl)用来创建合同信息提取web页面链接(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。\n\n注: \n1. pdf、word格式限制大小为10M以下\n2. pdg、jpeg、jpg格式限制大小为5M以下",
|
|
257
|
+
"input": "CreateInformationExtractionWebUrlRequest",
|
|
258
|
+
"name": "创建合同智能提取web页面",
|
|
259
|
+
"output": "CreateInformationExtractionWebUrlResponse",
|
|
260
|
+
"status": "online"
|
|
261
|
+
},
|
|
248
262
|
"CreateIntegrationDepartment": {
|
|
249
263
|
"document": "此接口(CreateIntegrationDepartment)用于创建企业的部门信息,支持绑定客户系统部门ID。",
|
|
250
264
|
"input": "CreateIntegrationDepartmentRequest",
|
|
@@ -406,6 +420,13 @@
|
|
|
406
420
|
"output": "CreateSealPolicyResponse",
|
|
407
421
|
"status": "online"
|
|
408
422
|
},
|
|
423
|
+
"CreateSingleSignOnEmployees": {
|
|
424
|
+
"document": "此接口(CreateSingleSignOnEmployees)用于创建单点登录企业员工。\n创建好的员工,可以通过腾讯电子签提供的链接, 如下图位置,进行登录。\n此操作的功能:\n1. 可以绑定已经实名的员工,然后 sso 登录实名绑定。\n2. 可以提前导入员工,在 sso 登录的时候进行实名。\n3. 如果已经绑定过,可以直接通过 sso 链接登录腾讯电子签。\n\n",
|
|
425
|
+
"input": "CreateSingleSignOnEmployeesRequest",
|
|
426
|
+
"name": "创建单点登录企业员工信息",
|
|
427
|
+
"output": "CreateSingleSignOnEmployeesResponse",
|
|
428
|
+
"status": "online"
|
|
429
|
+
},
|
|
409
430
|
"CreateUserAutoSignEnableUrl": {
|
|
410
431
|
"document": "获取个人用户自动签的开通链接。\n\n注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`",
|
|
411
432
|
"input": "CreateUserAutoSignEnableUrlRequest",
|
|
@@ -490,6 +511,13 @@
|
|
|
490
511
|
"output": "DeleteSealPoliciesResponse",
|
|
491
512
|
"status": "online"
|
|
492
513
|
},
|
|
514
|
+
"DeleteSingleSignOnEmployees": {
|
|
515
|
+
"document": "此接口(DeleteSingleSignOnEmployees)用于删除单点登录企业员工。\n注意:\n此接口只能删除未跟腾讯电子签绑定的单点登录企业员工,\n如果企业员工的单点登录信息已经和腾讯电子签里面的企业员工绑定,需要企业的超级管理员或者组织管理员在腾讯电子签控制台对当前企业员工进行离职操作,如下图操作。\n",
|
|
516
|
+
"input": "DeleteSingleSignOnEmployeesRequest",
|
|
517
|
+
"name": "删除单点登录企业员工信息",
|
|
518
|
+
"output": "DeleteSingleSignOnEmployeesResponse",
|
|
519
|
+
"status": "online"
|
|
520
|
+
},
|
|
493
521
|
"DescribeBatchOrganizationRegistrationTasks": {
|
|
494
522
|
"document": "本接口(DescribeBatchOrganizationRegistrationTasks)用于查询企业批量认证任务状态。",
|
|
495
523
|
"input": "DescribeBatchOrganizationRegistrationTasksRequest",
|
|
@@ -525,6 +553,13 @@
|
|
|
525
553
|
"output": "DescribeCancelFlowsTaskResponse",
|
|
526
554
|
"status": "online"
|
|
527
555
|
},
|
|
556
|
+
"DescribeContractComparisonTask": {
|
|
557
|
+
"document": "本接口(DescribeContractComparisonTask)用于查询合同对比任务结果详情。",
|
|
558
|
+
"input": "DescribeContractComparisonTaskRequest",
|
|
559
|
+
"name": "查询合同对比任务结果",
|
|
560
|
+
"output": "DescribeContractComparisonTaskResponse",
|
|
561
|
+
"status": "online"
|
|
562
|
+
},
|
|
528
563
|
"DescribeContractDiffTaskWebUrl": {
|
|
529
564
|
"document": "接口(DescribeContractDiffTaskWebUrl)用于获取合同对比结果可嵌入的web页面链接(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。\n注:本接口生成的web页面暂不支持<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/CreateWebThemeConfig\" target=\"_blank\">设置本企业嵌入式页面主题配置</a>\n\n嵌入页面长相如下:\n",
|
|
530
565
|
"input": "DescribeContractDiffTaskWebUrlRequest",
|
|
@@ -554,7 +589,7 @@
|
|
|
554
589
|
"status": "online"
|
|
555
590
|
},
|
|
556
591
|
"DescribeExtendedServiceAuthInfos": {
|
|
557
|
-
"document": "查询企业扩展服务的开通和授权情况,当前支持查询以下内容:\n\n1. **企业自动签署**\n2. **批量签署授权**\n3. **企业与港澳台居民签署合同**\n4. **拓宽签署方年龄限制**\n5. **个人签署方仅校验手机号**\n6. **隐藏合同经办人姓名**\n7. **正楷临摹签名失败后更换其他签名类型**\n8. **短信通知签署方**\n9. **个人签署方手写签名时需逐个手写**\n10. **签署密码开通引导**\n11. **个人签署方手动签名**\n12. **限制企业员工小程序端登录**\n13. **限制企业员工网页端登录**\n\n\n
|
|
592
|
+
"document": "查询企业扩展服务的开通和授权情况,当前支持查询以下内容:\n\n1. **企业自动签署**\n2. **批量签署授权**\n3. **企业与港澳台居民签署合同**\n4. **拓宽签署方年龄限制**\n5. **个人签署方仅校验手机号**\n6. **隐藏合同经办人姓名**\n7. **正楷临摹签名失败后更换其他签名类型**\n8. **短信通知签署方**\n9. **个人签署方手写签名时需逐个手写**\n10. **签署密码开通引导**\n11. **个人签署方手动签名**\n12. **限制企业员工小程序端登录**\n13. **限制企业员工网页端登录**\n\n\n对应能力开通页面在【Web控制台】-> 【更多】->【高级签署能力】,如下图所示:\n\n\n\n注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId需要传递超管或者法人的UserId)",
|
|
558
593
|
"input": "DescribeExtendedServiceAuthInfosRequest",
|
|
559
594
|
"name": "查询企业扩展服务授权信息",
|
|
560
595
|
"output": "DescribeExtendedServiceAuthInfosResponse",
|
|
@@ -616,6 +651,13 @@
|
|
|
616
651
|
"output": "DescribeInformationExtractionTaskResponse",
|
|
617
652
|
"status": "online"
|
|
618
653
|
},
|
|
654
|
+
"DescribeInformationExtractionWebUrl": {
|
|
655
|
+
"document": "此接口(DescribeInformationExtractionWebUrl)用来获取合同信息提取web页面链接(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。",
|
|
656
|
+
"input": "DescribeInformationExtractionWebUrlRequest",
|
|
657
|
+
"name": "获取合同智能提取结果web页面",
|
|
658
|
+
"output": "DescribeInformationExtractionWebUrlResponse",
|
|
659
|
+
"status": "online"
|
|
660
|
+
},
|
|
619
661
|
"DescribeIntegrationDepartments": {
|
|
620
662
|
"document": "此接口(DescribeIntegrationDepartments)用于查询企业的部门信息列表,支持查询单个部门节点或单个部门节点及一级子节点部门列表。",
|
|
621
663
|
"input": "DescribeIntegrationDepartmentsRequest",
|
|
@@ -679,6 +721,13 @@
|
|
|
679
721
|
"output": "DescribeSignFaceVideoResponse",
|
|
680
722
|
"status": "online"
|
|
681
723
|
},
|
|
724
|
+
"DescribeSingleSignOnEmployees": {
|
|
725
|
+
"document": "此接口(DescribeSingleSignOnEmployees)用于查询单点登录企业员工。",
|
|
726
|
+
"input": "DescribeSingleSignOnEmployeesRequest",
|
|
727
|
+
"name": "查询单点登录企业员工信息",
|
|
728
|
+
"output": "DescribeSingleSignOnEmployeesResponse",
|
|
729
|
+
"status": "online"
|
|
730
|
+
},
|
|
682
731
|
"DescribeThirdPartyAuthCode": {
|
|
683
732
|
"document": "通过AuthCode查询个人用户是否实名\n\n\n注意: \n<ul>\n<li>此接口为合作引流场景使用,使用<b>有白名单限制</b>,使用前请联系对接的客户经理沟通。</li>\n<li><b>AuthCode 只能使用一次</b>,查询一次再次查询会返回错误</li>\n</ul>",
|
|
684
733
|
"input": "DescribeThirdPartyAuthCodeRequest",
|
|
@@ -694,9 +743,9 @@
|
|
|
694
743
|
"status": "online"
|
|
695
744
|
},
|
|
696
745
|
"DescribeUserFlowType": {
|
|
697
|
-
"document": "
|
|
746
|
+
"document": "查询用户模板类型,分为两种模式:\n<ul>\n<li>QueryBindTemplate:false,查询用户合同模板类型,返回用户合同模板类型ID,用户合同模板类型名称,用户合同模板类型描述信息</li>\n<li>QueryBindTemplate:false,查询用户合同模板类型,返回用户合同模板类型ID,用户合同模板类型名称,用户合同模板类型描述信息,被绑定的模板数量</li>\n</ul>",
|
|
698
747
|
"input": "DescribeUserFlowTypeRequest",
|
|
699
|
-
"name": "
|
|
748
|
+
"name": "查询用户模板类型",
|
|
700
749
|
"output": "DescribeUserFlowTypeResponse",
|
|
701
750
|
"status": "online"
|
|
702
751
|
},
|
|
@@ -714,6 +763,13 @@
|
|
|
714
763
|
"output": "DisableUserAutoSignResponse",
|
|
715
764
|
"status": "online"
|
|
716
765
|
},
|
|
766
|
+
"ExportContractComparisonTask": {
|
|
767
|
+
"document": "本接口(ExportContractComparisonTask)用于导出指定的合同对比任务的结果文件。任务完成后,用户可根据不同的使用场景,选择导出可视化对比报告(PDF)或结构化差异明细(EXCEL)。",
|
|
768
|
+
"input": "ExportContractComparisonTaskRequest",
|
|
769
|
+
"name": "导出合同对比任务详情",
|
|
770
|
+
"output": "ExportContractComparisonTaskResponse",
|
|
771
|
+
"status": "online"
|
|
772
|
+
},
|
|
717
773
|
"GetTaskResultApi": {
|
|
718
774
|
"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文件创建签署流程】接口发起合同。`",
|
|
719
775
|
"input": "GetTaskResultApiRequest",
|
|
@@ -729,7 +785,7 @@
|
|
|
729
785
|
"status": "online"
|
|
730
786
|
},
|
|
731
787
|
"ModifyExtendedService": {
|
|
732
|
-
"document": "管理企业扩展服务\n\n- **直接开通的情形:**
|
|
788
|
+
"document": "管理企业扩展服务\n\n- **直接开通的情形:** 若在操作过程中接口没有返回跳转链接,这表明无需进行任何跳转操作。此时,相应的企业高级签署能力将会直接被开通或关闭。\n\n- **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业高级签署能力时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。\n - **OPEN_SERVER_SIGN(企业自动签)**\n\n注意: `在调用此接口以管理企业扩展服务时,操作者(入参中的Operator)必须是企业的超级管理员(超管)或法人`\n\n\n对应的扩展服务能力可以在控制台的【高级签署能力】中找到\n\n\n",
|
|
733
789
|
"input": "ModifyExtendedServiceRequest",
|
|
734
790
|
"name": "管理企业扩展服务",
|
|
735
791
|
"output": "ModifyExtendedServiceResponse",
|
|
@@ -763,6 +819,13 @@
|
|
|
763
819
|
"output": "ModifyPartnerAutoSignAuthUrlResponse",
|
|
764
820
|
"status": "online"
|
|
765
821
|
},
|
|
822
|
+
"ModifySingleSignOnEmployees": {
|
|
823
|
+
"document": "此接口(ModifySingleSignOnEmployees)用于修改单点登录企业员工。\n 注意: 此接口只能修改未跟腾讯电子签绑定的单点登录企业员工, 如果企业员工的单点登录信息已经和腾讯电子签里面的企业员工绑定,需要在腾讯电子签小程序进行个人信息变更操作。",
|
|
824
|
+
"input": "ModifySingleSignOnEmployeesRequest",
|
|
825
|
+
"name": "修改单点登录企业员工信息",
|
|
826
|
+
"output": "ModifySingleSignOnEmployeesResponse",
|
|
827
|
+
"status": "online"
|
|
828
|
+
},
|
|
766
829
|
"OperateSeals": {
|
|
767
830
|
"document": "修改印章状态(停用、启用)",
|
|
768
831
|
"input": "OperateSealsRequest",
|
|
@@ -850,7 +913,7 @@
|
|
|
850
913
|
{
|
|
851
914
|
"disabled": false,
|
|
852
915
|
"document": "超管手机号,打码显示\n示例值:138****1569\n",
|
|
853
|
-
"example": "
|
|
916
|
+
"example": "1888****888",
|
|
854
917
|
"member": "string",
|
|
855
918
|
"name": "Mobile",
|
|
856
919
|
"output_required": true,
|
|
@@ -949,7 +1012,7 @@
|
|
|
949
1012
|
},
|
|
950
1013
|
{
|
|
951
1014
|
"disabled": false,
|
|
952
|
-
"document": "签署方经办人手机号码,
|
|
1015
|
+
"document": "签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此合同签署方。",
|
|
953
1016
|
"example": "18888888888",
|
|
954
1017
|
"member": "string",
|
|
955
1018
|
"name": "ApproverMobile",
|
|
@@ -1225,7 +1288,7 @@
|
|
|
1225
1288
|
},
|
|
1226
1289
|
{
|
|
1227
1290
|
"disabled": false,
|
|
1228
|
-
"document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** : 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>\n\n\n\n注:\n1.
|
|
1291
|
+
"document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** : 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>\n\n\n\n注:\n1. `使用动态签署人能力前,需登录腾讯电子签控制台打开服务开关`\n2. 此参数在嵌入式场景下无效。",
|
|
1229
1292
|
"example": "1",
|
|
1230
1293
|
"member": "int64",
|
|
1231
1294
|
"name": "FillType",
|
|
@@ -1605,7 +1668,7 @@
|
|
|
1605
1668
|
"usage": "in"
|
|
1606
1669
|
},
|
|
1607
1670
|
"BatchOrganizationRegistrationTasksDetails": {
|
|
1608
|
-
"document": "批量认证企业任务详情信息,其中包括 TaskId
|
|
1671
|
+
"document": "批量认证企业任务详情信息,其中包括 TaskId,状态信息等。",
|
|
1609
1672
|
"members": [
|
|
1610
1673
|
{
|
|
1611
1674
|
"disabled": false,
|
|
@@ -2094,8 +2157,8 @@
|
|
|
2094
2157
|
"members": [
|
|
2095
2158
|
{
|
|
2096
2159
|
"disabled": false,
|
|
2097
|
-
"document": "被抄送方手机号码,
|
|
2098
|
-
"example": "
|
|
2160
|
+
"document": "被抄送方手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。",
|
|
2161
|
+
"example": "1320****000",
|
|
2099
2162
|
"member": "string",
|
|
2100
2163
|
"name": "Mobile",
|
|
2101
2164
|
"required": false,
|
|
@@ -2140,6 +2203,52 @@
|
|
|
2140
2203
|
],
|
|
2141
2204
|
"usage": "in"
|
|
2142
2205
|
},
|
|
2206
|
+
"ComparisonDetail": {
|
|
2207
|
+
"document": "合同对比差异结果详情。",
|
|
2208
|
+
"members": [
|
|
2209
|
+
{
|
|
2210
|
+
"disabled": false,
|
|
2211
|
+
"document": "对比前后差异类型,具体如下:\n<ul><li> **add**:新增</li>\n<li> **change**:变更</li>\n<li> **delete**:删除</li>\n</ul>",
|
|
2212
|
+
"example": "add",
|
|
2213
|
+
"member": "string",
|
|
2214
|
+
"name": "ComparisonType",
|
|
2215
|
+
"output_required": false,
|
|
2216
|
+
"type": "string",
|
|
2217
|
+
"value_allowed_null": false
|
|
2218
|
+
},
|
|
2219
|
+
{
|
|
2220
|
+
"disabled": false,
|
|
2221
|
+
"document": "对比内容类型,具体如下:\n<ul><li> **text**:文本</li>\n<li> **table**:表格</li>\n<li> **picture**:图片</li>\n</ul>",
|
|
2222
|
+
"example": "text",
|
|
2223
|
+
"member": "string",
|
|
2224
|
+
"name": "ContentType",
|
|
2225
|
+
"output_required": false,
|
|
2226
|
+
"type": "string",
|
|
2227
|
+
"value_allowed_null": false
|
|
2228
|
+
},
|
|
2229
|
+
{
|
|
2230
|
+
"disabled": false,
|
|
2231
|
+
"document": "原文文本。",
|
|
2232
|
+
"example": "******",
|
|
2233
|
+
"member": "string",
|
|
2234
|
+
"name": "OriginText",
|
|
2235
|
+
"output_required": false,
|
|
2236
|
+
"type": "string",
|
|
2237
|
+
"value_allowed_null": false
|
|
2238
|
+
},
|
|
2239
|
+
{
|
|
2240
|
+
"disabled": false,
|
|
2241
|
+
"document": "对比文本。",
|
|
2242
|
+
"example": "-----",
|
|
2243
|
+
"member": "string",
|
|
2244
|
+
"name": "DiffText",
|
|
2245
|
+
"output_required": false,
|
|
2246
|
+
"type": "string",
|
|
2247
|
+
"value_allowed_null": false
|
|
2248
|
+
}
|
|
2249
|
+
],
|
|
2250
|
+
"usage": "out"
|
|
2251
|
+
},
|
|
2143
2252
|
"Component": {
|
|
2144
2253
|
"document": "此结构体 (Component) 用于描述控件属性。\n\n在通过文件发起合同时,对应的component有三种定位方式\n1. 绝对定位方式 (可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标)\n2. 表单域(FIELD)定位方式\n3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找",
|
|
2145
2254
|
"members": [
|
|
@@ -2157,7 +2266,7 @@
|
|
|
2157
2266
|
{
|
|
2158
2267
|
"disabled": false,
|
|
2159
2268
|
"document": "**在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。\n",
|
|
2160
|
-
"example": "43",
|
|
2269
|
+
"example": "43.1",
|
|
2161
2270
|
"member": "float",
|
|
2162
2271
|
"name": "ComponentHeight",
|
|
2163
2272
|
"output_required": true,
|
|
@@ -2168,7 +2277,7 @@
|
|
|
2168
2277
|
{
|
|
2169
2278
|
"disabled": false,
|
|
2170
2279
|
"document": "**在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。\n",
|
|
2171
|
-
"example": "119",
|
|
2280
|
+
"example": "119.1",
|
|
2172
2281
|
"member": "float",
|
|
2173
2282
|
"name": "ComponentWidth",
|
|
2174
2283
|
"output_required": true,
|
|
@@ -2190,7 +2299,7 @@
|
|
|
2190
2299
|
{
|
|
2191
2300
|
"disabled": false,
|
|
2192
2301
|
"document": "**在绝对定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。",
|
|
2193
|
-
"example": "100",
|
|
2302
|
+
"example": "100.1",
|
|
2194
2303
|
"member": "float",
|
|
2195
2304
|
"name": "ComponentPosX",
|
|
2196
2305
|
"output_required": true,
|
|
@@ -2201,7 +2310,7 @@
|
|
|
2201
2310
|
{
|
|
2202
2311
|
"disabled": false,
|
|
2203
2312
|
"document": "**在绝对定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。",
|
|
2204
|
-
"example": "100",
|
|
2313
|
+
"example": "100.1",
|
|
2205
2314
|
"member": "float",
|
|
2206
2315
|
"name": "ComponentPosY",
|
|
2207
2316
|
"output_required": true,
|
|
@@ -2277,7 +2386,7 @@
|
|
|
2277
2386
|
},
|
|
2278
2387
|
{
|
|
2279
2388
|
"disabled": false,
|
|
2280
|
-
"document": "\n**在所有的定位方式下**,控件的扩展参数,为<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>: 范围6 :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>: 范围6 :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 :72</li>\n<li> <b>Opacity</b>: 透明度,范围0 :1</li>\n<li> <b>Rotate</b>: 水印旋转角度,范围0 :359</li>\n<li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>\n<li> <b>Position</b>: 水印位置,None-平铺(默认值),LeftTop-左上,LeftBottom-左下,RightTop-右上,RightBottom-右下,Center-居中</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为SELECTOR时</font>,支持以下参数:\n<ul><li> <b>WordWrap</b>:bool。是否支持选择控件内容自动折行合成。false:不支持(默认)。 true : 支持自动折行合成</li>\n</ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_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<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>\n<li> <b>OTHER</b> : 其他</li>\n</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、SIGN_SIGNATURE类型时</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.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n",
|
|
2389
|
+
"document": "\n**在所有的定位方式下**,控件的扩展参数,为<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>: 范围6 :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>: 范围6 :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 :72</li>\n<li> <b>Opacity</b>: 透明度,范围0 :1</li>\n<li> <b>Rotate</b>: 水印旋转角度,范围0 :359</li>\n<li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>\n<li> <b>Position</b>: 水印位置,None-平铺(默认值),LeftTop-左上,LeftBottom-左下,RightTop-右上,RightBottom-右下,Center-居中</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为SELECTOR时</font>,支持以下参数:\n<ul><li> <b>WordWrap</b>:bool。是否支持选择控件内容自动折行合成。false:不支持(默认)。 true : 支持自动折行合成</li>\n</ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_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<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>\n<li> <b>OTHER</b> : 其他</li>\n</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、SIGN_SIGNATURE类型时</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.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">签署意见功能设置,</font>当ComponentType为SIGN_OPINION时,可以通过以下参数设置签署意见的相关内容:\n<ul><li> <b>Values</b>:签署意见预设的需要用户填写的文本</li>\n<li> <b>ValuesArray</b>:签署意见需要用户按顺序点击的分词(组合后应和Values内容一致)</li></ul>\n<b>参数样例</b>:`{\"Values\":\"我已知晓内容并同意签署\",\"ValuesArray\":[\"我\",\"已知晓\",\"内容\",\"并\",\"同意\",\"签署\"]}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n",
|
|
2281
2390
|
"example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}",
|
|
2282
2391
|
"member": "string",
|
|
2283
2392
|
"name": "ComponentExtra",
|
|
@@ -2299,7 +2408,7 @@
|
|
|
2299
2408
|
},
|
|
2300
2409
|
{
|
|
2301
2410
|
"disabled": false,
|
|
2302
|
-
"document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容,可以用 \\n 来控制换行位置 </li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 格式化为:xxxx年xx月xx日(例如2024年05年28日)</li>\n<li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li></ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td
|
|
2411
|
+
"document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容,可以用 \\n 来控制换行位置 </li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 格式化为:xxxx年xx月xx日(例如2024年05年28日)</li>\n<li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li></ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>\n注: `部分特殊控件需要在控制台配置模板形式创建`",
|
|
2303
2412
|
"example": "100元",
|
|
2304
2413
|
"member": "string",
|
|
2305
2414
|
"name": "ComponentValue",
|
|
@@ -2311,7 +2420,7 @@
|
|
|
2311
2420
|
{
|
|
2312
2421
|
"disabled": false,
|
|
2313
2422
|
"document": "**如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。\n注意: `向左调整设置为负数, 向右调整设置成正数`",
|
|
2314
|
-
"example": "10",
|
|
2423
|
+
"example": "10.1",
|
|
2315
2424
|
"member": "float",
|
|
2316
2425
|
"name": "OffsetX",
|
|
2317
2426
|
"output_required": true,
|
|
@@ -2322,7 +2431,7 @@
|
|
|
2322
2431
|
{
|
|
2323
2432
|
"disabled": false,
|
|
2324
2433
|
"document": "**如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。\n注意: `向上调整设置为负数, 向下调整设置成正数`",
|
|
2325
|
-
"example": "10",
|
|
2434
|
+
"example": "10.1",
|
|
2326
2435
|
"member": "float",
|
|
2327
2436
|
"name": "OffsetY",
|
|
2328
2437
|
"output_required": true,
|
|
@@ -2366,7 +2475,7 @@
|
|
|
2366
2475
|
{
|
|
2367
2476
|
"disabled": false,
|
|
2368
2477
|
"document": "**如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。\n\n注意:关键字索引是从0开始计数的",
|
|
2369
|
-
"example": "
|
|
2478
|
+
"example": "[1,2]",
|
|
2370
2479
|
"member": "int64",
|
|
2371
2480
|
"name": "KeywordIndexes",
|
|
2372
2481
|
"output_required": true,
|
|
@@ -2841,7 +2950,7 @@
|
|
|
2841
2950
|
{
|
|
2842
2951
|
"disabled": false,
|
|
2843
2952
|
"document": "组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 Admin Mobile保持一致。",
|
|
2844
|
-
"example": "
|
|
2953
|
+
"example": "1320****000",
|
|
2845
2954
|
"member": "string",
|
|
2846
2955
|
"name": "AdminMobile",
|
|
2847
2956
|
"required": true,
|
|
@@ -3098,7 +3207,7 @@
|
|
|
3098
3207
|
{
|
|
3099
3208
|
"disabled": false,
|
|
3100
3209
|
"document": "生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:\n<ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>\n<li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>\n注:\n`不指定该值时,默认为签署方自行选择。`",
|
|
3101
|
-
"example": "
|
|
3210
|
+
"example": "0",
|
|
3102
3211
|
"member": "uint64",
|
|
3103
3212
|
"name": "SignTypeSelector",
|
|
3104
3213
|
"required": false,
|
|
@@ -3122,6 +3231,15 @@
|
|
|
3122
3231
|
"required": false,
|
|
3123
3232
|
"type": "object"
|
|
3124
3233
|
},
|
|
3234
|
+
{
|
|
3235
|
+
"disabled": false,
|
|
3236
|
+
"document": "用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。",
|
|
3237
|
+
"example": "5",
|
|
3238
|
+
"member": "int64",
|
|
3239
|
+
"name": "VideoVerifyTimesLimit",
|
|
3240
|
+
"required": false,
|
|
3241
|
+
"type": "int"
|
|
3242
|
+
},
|
|
3125
3243
|
{
|
|
3126
3244
|
"disabled": false,
|
|
3127
3245
|
"document": "缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。\n\n注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`",
|
|
@@ -3133,7 +3251,7 @@
|
|
|
3133
3251
|
},
|
|
3134
3252
|
{
|
|
3135
3253
|
"disabled": false,
|
|
3136
|
-
"document": "是否允许此链接中签署方批量拒签。\n <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>\n\n
|
|
3254
|
+
"document": "是否允许此链接中签署方批量拒签。\n <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>\n\n注:`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。`\n",
|
|
3137
3255
|
"example": "false",
|
|
3138
3256
|
"member": "bool",
|
|
3139
3257
|
"name": "CanBatchReject",
|
|
@@ -3197,7 +3315,7 @@
|
|
|
3197
3315
|
},
|
|
3198
3316
|
{
|
|
3199
3317
|
"disabled": false,
|
|
3200
|
-
"document": "手机号码,
|
|
3318
|
+
"document": "手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注:<ul><li>请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li></ul>",
|
|
3201
3319
|
"example": "18888888888",
|
|
3202
3320
|
"member": "string",
|
|
3203
3321
|
"name": "Mobile",
|
|
@@ -3305,7 +3423,7 @@
|
|
|
3305
3423
|
},
|
|
3306
3424
|
{
|
|
3307
3425
|
"disabled": false,
|
|
3308
|
-
"document": "是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>\n注:`1.
|
|
3426
|
+
"document": "是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>\n注:`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页(JumpToDetail参数为true),也不支持批量拒签功能`",
|
|
3309
3427
|
"example": "false",
|
|
3310
3428
|
"member": "bool",
|
|
3311
3429
|
"name": "CanBatchReject",
|
|
@@ -3366,6 +3484,98 @@
|
|
|
3366
3484
|
],
|
|
3367
3485
|
"type": "object"
|
|
3368
3486
|
},
|
|
3487
|
+
"CreateContractComparisonTaskRequest": {
|
|
3488
|
+
"document": "CreateContractComparisonTask请求参数结构体",
|
|
3489
|
+
"members": [
|
|
3490
|
+
{
|
|
3491
|
+
"disabled": false,
|
|
3492
|
+
"document": "执行合同审查任务的员工信息。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
|
3493
|
+
"example": "无",
|
|
3494
|
+
"member": "UserInfo",
|
|
3495
|
+
"name": "Operator",
|
|
3496
|
+
"required": true,
|
|
3497
|
+
"type": "object"
|
|
3498
|
+
},
|
|
3499
|
+
{
|
|
3500
|
+
"disabled": false,
|
|
3501
|
+
"document": "原版文件ID,对比基准的旧版本文件唯一标识,通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">UploadFiles</a>接口获取文件资源ID。",
|
|
3502
|
+
"example": "yD*******************Cj",
|
|
3503
|
+
"member": "string",
|
|
3504
|
+
"name": "OriginFileResourceId",
|
|
3505
|
+
"required": true,
|
|
3506
|
+
"type": "string"
|
|
3507
|
+
},
|
|
3508
|
+
{
|
|
3509
|
+
"disabled": false,
|
|
3510
|
+
"document": "新版文件ID,与旧版进行对比的新版本文件唯一标识,通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">UploadFiles</a>接口获取文件资源ID。",
|
|
3511
|
+
"example": "yD*******************Ed",
|
|
3512
|
+
"member": "string",
|
|
3513
|
+
"name": "DiffFileResourceId",
|
|
3514
|
+
"required": true,
|
|
3515
|
+
"type": "string"
|
|
3516
|
+
},
|
|
3517
|
+
{
|
|
3518
|
+
"disabled": false,
|
|
3519
|
+
"document": "对比任务备注,长度不能超过50个字符。",
|
|
3520
|
+
"example": "这是一项对比任务",
|
|
3521
|
+
"member": "string",
|
|
3522
|
+
"name": "Comment",
|
|
3523
|
+
"required": false,
|
|
3524
|
+
"type": "string"
|
|
3525
|
+
},
|
|
3526
|
+
{
|
|
3527
|
+
"disabled": false,
|
|
3528
|
+
"document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
|
|
3529
|
+
"example": "QmFzZTY0IEJhc2U2NCA",
|
|
3530
|
+
"member": "string",
|
|
3531
|
+
"name": "UserData",
|
|
3532
|
+
"required": false,
|
|
3533
|
+
"type": "string"
|
|
3534
|
+
},
|
|
3535
|
+
{
|
|
3536
|
+
"disabled": false,
|
|
3537
|
+
"document": "标签列表,用户自定义的键值对(Key-Value),可绑定到资源上,用于资源的分类、管理和访问控制。",
|
|
3538
|
+
"example": "无",
|
|
3539
|
+
"member": "Tag",
|
|
3540
|
+
"name": "Tags",
|
|
3541
|
+
"required": false,
|
|
3542
|
+
"type": "list"
|
|
3543
|
+
}
|
|
3544
|
+
],
|
|
3545
|
+
"type": "object"
|
|
3546
|
+
},
|
|
3547
|
+
"CreateContractComparisonTaskResponse": {
|
|
3548
|
+
"document": "CreateContractComparisonTask返回参数结构体",
|
|
3549
|
+
"members": [
|
|
3550
|
+
{
|
|
3551
|
+
"disabled": false,
|
|
3552
|
+
"document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。",
|
|
3553
|
+
"example": "QmFzZTY0IEJhc2U2NCA",
|
|
3554
|
+
"member": "string",
|
|
3555
|
+
"name": "UserData",
|
|
3556
|
+
"output_required": false,
|
|
3557
|
+
"type": "string",
|
|
3558
|
+
"value_allowed_null": false
|
|
3559
|
+
},
|
|
3560
|
+
{
|
|
3561
|
+
"disabled": false,
|
|
3562
|
+
"document": "合同对比任务ID,可以调用接口<a href=\"https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/DescribeContractComparisonTask\" target=\"_blank\">查询合同对比任务结果</a>查看对比任务的结果。",
|
|
3563
|
+
"example": "yD*******************Qi",
|
|
3564
|
+
"member": "string",
|
|
3565
|
+
"name": "TaskId",
|
|
3566
|
+
"output_required": false,
|
|
3567
|
+
"type": "string",
|
|
3568
|
+
"value_allowed_null": false
|
|
3569
|
+
},
|
|
3570
|
+
{
|
|
3571
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
3572
|
+
"member": "string",
|
|
3573
|
+
"name": "RequestId",
|
|
3574
|
+
"type": "string"
|
|
3575
|
+
}
|
|
3576
|
+
],
|
|
3577
|
+
"type": "object"
|
|
3578
|
+
},
|
|
3369
3579
|
"CreateContractDiffTaskWebUrlRequest": {
|
|
3370
3580
|
"document": "CreateContractDiffTaskWebUrl请求参数结构体",
|
|
3371
3581
|
"members": [
|
|
@@ -3404,6 +3614,24 @@
|
|
|
3404
3614
|
"name": "DiffFileResourceId",
|
|
3405
3615
|
"required": false,
|
|
3406
3616
|
"type": "string"
|
|
3617
|
+
},
|
|
3618
|
+
{
|
|
3619
|
+
"disabled": false,
|
|
3620
|
+
"document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
|
|
3621
|
+
"example": "QmFzZTY0IEJhc2U2NCA",
|
|
3622
|
+
"member": "string",
|
|
3623
|
+
"name": "UserData",
|
|
3624
|
+
"required": false,
|
|
3625
|
+
"type": "string"
|
|
3626
|
+
},
|
|
3627
|
+
{
|
|
3628
|
+
"disabled": false,
|
|
3629
|
+
"document": "标签列表,用户自定义的键值对(Key-Value),可绑定到资源上,用于资源的分类、管理和访问控制。",
|
|
3630
|
+
"example": "无",
|
|
3631
|
+
"member": "Tag",
|
|
3632
|
+
"name": "Tags",
|
|
3633
|
+
"required": false,
|
|
3634
|
+
"type": "list"
|
|
3407
3635
|
}
|
|
3408
3636
|
],
|
|
3409
3637
|
"type": "object"
|
|
@@ -3431,6 +3659,16 @@
|
|
|
3431
3659
|
"type": "string",
|
|
3432
3660
|
"value_allowed_null": false
|
|
3433
3661
|
},
|
|
3662
|
+
{
|
|
3663
|
+
"disabled": false,
|
|
3664
|
+
"document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。",
|
|
3665
|
+
"example": "QmFzZTY0IEJhc2U2NCA",
|
|
3666
|
+
"member": "string",
|
|
3667
|
+
"name": "UserData",
|
|
3668
|
+
"output_required": false,
|
|
3669
|
+
"type": "string",
|
|
3670
|
+
"value_allowed_null": false
|
|
3671
|
+
},
|
|
3434
3672
|
{
|
|
3435
3673
|
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
3436
3674
|
"member": "string",
|
|
@@ -3813,7 +4051,7 @@
|
|
|
3813
4051
|
},
|
|
3814
4052
|
{
|
|
3815
4053
|
"disabled": false,
|
|
3816
|
-
"document": "WEB嵌入资源类型,支持以下类型\n<ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>\n<li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>\n<li>MODIFY_TEMPLATE:生成编辑模板的嵌入页面</li>\n<li>CREATE_CONTRACT_DRAFT_COOPEDIT:生成创建起草合同的嵌入页面</li>\n<li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>\n<li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>\n<li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>\n<li>EXTEND_SERVICE
|
|
4054
|
+
"document": "WEB嵌入资源类型,支持以下类型\n<ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>\n<li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>\n<li>MODIFY_TEMPLATE:生成编辑模板的嵌入页面</li>\n<li>CREATE_CONTRACT_DRAFT_COOPEDIT:生成创建起草合同的嵌入页面</li>\n<li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>\n<li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>\n<li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>\n<li>EXTEND_SERVICE:生成高级签署能力的嵌入页面</li>\n<li>PREVIEW_FLOW:生成预览合同的嵌入页面(支持移动端)</li>\n<li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面(仅支持PC端)</li></ul>\n\n注意:\n不同的嵌入类型,操作人需要的权限项不同(权限配置可参考[权限配置](https://qian.tencent.com/document/61355))。\n<table border=\"1\">\n<thead>\n<tr><th>EmbedType</th><th>权限</th></tr>\n</thead> \n<tbody> \n<tr><th>CREATE_SEAL</th><th>印章管理-添加印章</th></tr>\n<tr><th>CREATE_TEMPLATE</th><th>模板管理-创建模板</th></tr>\n<tr><th>MODIFY_TEMPLATE</th><th>模板管理-编辑模板</th></tr>\n<tr><th>CREATE_CONTRACT_DRAFT_COOPEDIT</th><th>合同管理-起草合同</th></tr>\n<tr><th>PREVIEW_TEMPLATE</th><th>拥有下面三种权限的一种就行</br>\n模板管理-查询模板(本企业全部模板)</br>\n模板管理-查询模板(本部门全部模板)</br>\n模板管理-查询模板(本人创建模板)</th></tr>\n<tr><th>PREVIEW_SEAL_LIST</th><th>印章管理</th></tr>\n<tr><th>PREVIEW_SEAL_DETAIL</th><th>印章管理</th></tr>\n<tr><th>EXTEND_SERVICE</th><th>无要求</th></tr>\n<tr><th>PREVIEW_FLOW</th><th>是否是当前合同的参与方,或者发起方企业的法人、超管、合同管理员</th></tr>\n<tr><th>PREVIEW_FLOW_DETAIL</th><th>是否是当前合同的参与方,或者发起方企业的法人、超管、合同管理员</th></tr>\n</tbody> \n</table>",
|
|
3817
4055
|
"example": "PREVIEW_FLOW",
|
|
3818
4056
|
"member": "string",
|
|
3819
4057
|
"name": "EmbedType",
|
|
@@ -5116,7 +5354,7 @@
|
|
|
5116
5354
|
},
|
|
5117
5355
|
{
|
|
5118
5356
|
"disabled": false,
|
|
5119
|
-
"document": "
|
|
5357
|
+
"document": " 禁止设置签署流程属性 (顺序、合同签署认证方式等),若为true则在发起流程的可嵌入页面隐藏签署流程设置面板\n",
|
|
5120
5358
|
"example": "true",
|
|
5121
5359
|
"member": "bool",
|
|
5122
5360
|
"name": "ForbidEditFlowProperties",
|
|
@@ -5167,6 +5405,60 @@
|
|
|
5167
5405
|
"name": "ForbidEditWatermark",
|
|
5168
5406
|
"required": false,
|
|
5169
5407
|
"type": "bool"
|
|
5408
|
+
},
|
|
5409
|
+
{
|
|
5410
|
+
"disabled": true,
|
|
5411
|
+
"document": "隐藏操作指引: 具体的控件类型如下\n\n<ul><li>1 : 操作指引入口</li>\n<li>2 : 操作文档</li>\n<li>3 : 操作视频</li>\n</ul>\n注:仅对新版页面生效",
|
|
5412
|
+
"example": "[1,2,3]",
|
|
5413
|
+
"member": "uint64",
|
|
5414
|
+
"name": "HideOperationInstructions",
|
|
5415
|
+
"required": false,
|
|
5416
|
+
"type": "list"
|
|
5417
|
+
},
|
|
5418
|
+
{
|
|
5419
|
+
"disabled": false,
|
|
5420
|
+
"document": "隐藏操作步骤: 具体的控件类型如下\n\n<ul><li>1 : 选择文件及签署方</li>\n<li>2 : 补充文件内容</li>\n<li>4 : 发起前合同信息与设置确认</li>\n</ul>\n注:仅对新版页面生效",
|
|
5421
|
+
"example": "[1,2,4]",
|
|
5422
|
+
"member": "uint64",
|
|
5423
|
+
"name": "HideOperationSteps",
|
|
5424
|
+
"required": false,
|
|
5425
|
+
"type": "list"
|
|
5426
|
+
},
|
|
5427
|
+
{
|
|
5428
|
+
"disabled": false,
|
|
5429
|
+
"document": "本企业简称,注:仅对新版页面生效",
|
|
5430
|
+
"example": "本企业",
|
|
5431
|
+
"member": "string",
|
|
5432
|
+
"name": "SelfName",
|
|
5433
|
+
"required": false,
|
|
5434
|
+
"type": "string"
|
|
5435
|
+
},
|
|
5436
|
+
{
|
|
5437
|
+
"disabled": false,
|
|
5438
|
+
"document": "发起后签署码隐藏,默认false,注:仅对新版页面生效",
|
|
5439
|
+
"example": "true",
|
|
5440
|
+
"member": "bool",
|
|
5441
|
+
"name": "HideSignCodeAfterStart",
|
|
5442
|
+
"required": false,
|
|
5443
|
+
"type": "bool"
|
|
5444
|
+
},
|
|
5445
|
+
{
|
|
5446
|
+
"disabled": false,
|
|
5447
|
+
"document": "发起成功后是否预览合同 <ul><li>(默认) false -否</li> <li> true - 展示预览按钮</li></ul>\t",
|
|
5448
|
+
"example": "false",
|
|
5449
|
+
"member": "bool",
|
|
5450
|
+
"name": "PreviewAfterStart",
|
|
5451
|
+
"required": false,
|
|
5452
|
+
"type": "bool"
|
|
5453
|
+
},
|
|
5454
|
+
{
|
|
5455
|
+
"disabled": false,
|
|
5456
|
+
"document": "发起成功之后是否签署合同,仅当前经办人作为签署人时生效 <ul><li>(默认) false -否</li> <li> true - 展示签署按钮</li></ul>\t",
|
|
5457
|
+
"example": "false",
|
|
5458
|
+
"member": "bool",
|
|
5459
|
+
"name": "SignAfterStart",
|
|
5460
|
+
"required": false,
|
|
5461
|
+
"type": "bool"
|
|
5170
5462
|
}
|
|
5171
5463
|
],
|
|
5172
5464
|
"usage": "in"
|
|
@@ -5536,6 +5828,15 @@
|
|
|
5536
5828
|
"required": false,
|
|
5537
5829
|
"type": "list"
|
|
5538
5830
|
},
|
|
5831
|
+
{
|
|
5832
|
+
"disabled": false,
|
|
5833
|
+
"document": "用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。",
|
|
5834
|
+
"example": "5",
|
|
5835
|
+
"member": "int64",
|
|
5836
|
+
"name": "VideoVerifyTimesLimit",
|
|
5837
|
+
"required": false,
|
|
5838
|
+
"type": "int"
|
|
5839
|
+
},
|
|
5539
5840
|
{
|
|
5540
5841
|
"disabled": true,
|
|
5541
5842
|
"document": "机构信息,暂未开放",
|
|
@@ -5588,12 +5889,12 @@
|
|
|
5588
5889
|
],
|
|
5589
5890
|
"type": "object"
|
|
5590
5891
|
},
|
|
5591
|
-
"
|
|
5592
|
-
"document": "
|
|
5892
|
+
"CreateInformationExtractionWebUrlRequest": {
|
|
5893
|
+
"document": "CreateInformationExtractionWebUrl请求参数结构体",
|
|
5593
5894
|
"members": [
|
|
5594
5895
|
{
|
|
5595
5896
|
"disabled": false,
|
|
5596
|
-
"document": "
|
|
5897
|
+
"document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
|
5597
5898
|
"example": "无",
|
|
5598
5899
|
"member": "UserInfo",
|
|
5599
5900
|
"name": "Operator",
|
|
@@ -5602,43 +5903,107 @@
|
|
|
5602
5903
|
},
|
|
5603
5904
|
{
|
|
5604
5905
|
"disabled": false,
|
|
5605
|
-
"document": "
|
|
5606
|
-
"example": "
|
|
5906
|
+
"document": "需要提取的合同文件资源ID,可通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">UploadFiles</a>接口获取文件资源ID。\n\n注: \n- `word、pdf文件每个文件限制在10M以下`\n- `png、jpg、jpeg文件每个限制在5M以下`",
|
|
5907
|
+
"example": "[\"yDtGEUUgydz\"]",
|
|
5607
5908
|
"member": "string",
|
|
5608
|
-
"name": "
|
|
5609
|
-
"required": true,
|
|
5610
|
-
"type": "string"
|
|
5611
|
-
},
|
|
5612
|
-
{
|
|
5613
|
-
"disabled": false,
|
|
5614
|
-
"document": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
|
5615
|
-
"example": "无",
|
|
5616
|
-
"member": "Agent",
|
|
5617
|
-
"name": "Agent",
|
|
5909
|
+
"name": "ResourceIds",
|
|
5618
5910
|
"required": false,
|
|
5619
|
-
"type": "
|
|
5911
|
+
"type": "list"
|
|
5620
5912
|
},
|
|
5621
5913
|
{
|
|
5622
5914
|
"disabled": false,
|
|
5623
|
-
"document": "
|
|
5624
|
-
"example": "
|
|
5915
|
+
"document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
|
|
5916
|
+
"example": "5rWL6K+V5pWw5o2u",
|
|
5625
5917
|
"member": "string",
|
|
5626
|
-
"name": "
|
|
5918
|
+
"name": "UserData",
|
|
5627
5919
|
"required": false,
|
|
5628
5920
|
"type": "string"
|
|
5629
5921
|
},
|
|
5630
5922
|
{
|
|
5631
5923
|
"disabled": false,
|
|
5632
|
-
"document": "
|
|
5633
|
-
"example": "
|
|
5634
|
-
"member": "
|
|
5635
|
-
"name": "
|
|
5924
|
+
"document": "个性化参数,用于控制页面展示内容",
|
|
5925
|
+
"example": "无",
|
|
5926
|
+
"member": "WebUrlOption",
|
|
5927
|
+
"name": "Option",
|
|
5636
5928
|
"required": false,
|
|
5637
|
-
"type": "
|
|
5638
|
-
}
|
|
5929
|
+
"type": "object"
|
|
5930
|
+
}
|
|
5931
|
+
],
|
|
5932
|
+
"type": "object"
|
|
5933
|
+
},
|
|
5934
|
+
"CreateInformationExtractionWebUrlResponse": {
|
|
5935
|
+
"document": "CreateInformationExtractionWebUrl返回参数结构体",
|
|
5936
|
+
"members": [
|
|
5639
5937
|
{
|
|
5640
5938
|
"disabled": false,
|
|
5641
|
-
"document": "
|
|
5939
|
+
"document": "合同信息提取嵌入式web页面链接。\n\n注意:`链接有效期为5分钟,且链接仅能使用一次。`",
|
|
5940
|
+
"example": "https://embed.test.qian.tencent.cn/ai-contract-info-extract-embed?embed=1&code=xxx&channel=TENCENTCLOUD&embedType=CONTRACT_EXTRACTION&shortKey=xx",
|
|
5941
|
+
"member": "string",
|
|
5942
|
+
"name": "Url",
|
|
5943
|
+
"output_required": true,
|
|
5944
|
+
"type": "string",
|
|
5945
|
+
"value_allowed_null": false
|
|
5946
|
+
},
|
|
5947
|
+
{
|
|
5948
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
5949
|
+
"member": "string",
|
|
5950
|
+
"name": "RequestId",
|
|
5951
|
+
"type": "string"
|
|
5952
|
+
}
|
|
5953
|
+
],
|
|
5954
|
+
"type": "object"
|
|
5955
|
+
},
|
|
5956
|
+
"CreateIntegrationDepartmentRequest": {
|
|
5957
|
+
"document": "CreateIntegrationDepartment请求参数结构体",
|
|
5958
|
+
"members": [
|
|
5959
|
+
{
|
|
5960
|
+
"disabled": false,
|
|
5961
|
+
"document": "执行本接口操作的员工信息。\n注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`",
|
|
5962
|
+
"example": "无",
|
|
5963
|
+
"member": "UserInfo",
|
|
5964
|
+
"name": "Operator",
|
|
5965
|
+
"required": true,
|
|
5966
|
+
"type": "object"
|
|
5967
|
+
},
|
|
5968
|
+
{
|
|
5969
|
+
"disabled": false,
|
|
5970
|
+
"document": "部门名称,最大长度为50个字符。",
|
|
5971
|
+
"example": "销售部门",
|
|
5972
|
+
"member": "string",
|
|
5973
|
+
"name": "DeptName",
|
|
5974
|
+
"required": true,
|
|
5975
|
+
"type": "string"
|
|
5976
|
+
},
|
|
5977
|
+
{
|
|
5978
|
+
"disabled": false,
|
|
5979
|
+
"document": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
|
5980
|
+
"example": "无",
|
|
5981
|
+
"member": "Agent",
|
|
5982
|
+
"name": "Agent",
|
|
5983
|
+
"required": false,
|
|
5984
|
+
"type": "object"
|
|
5985
|
+
},
|
|
5986
|
+
{
|
|
5987
|
+
"disabled": false,
|
|
5988
|
+
"document": "电子签父部门ID。\n注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`",
|
|
5989
|
+
"example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
|
|
5990
|
+
"member": "string",
|
|
5991
|
+
"name": "ParentDeptId",
|
|
5992
|
+
"required": false,
|
|
5993
|
+
"type": "string"
|
|
5994
|
+
},
|
|
5995
|
+
{
|
|
5996
|
+
"disabled": false,
|
|
5997
|
+
"document": "第三方平台中父部门ID。\n注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`",
|
|
5998
|
+
"example": "456",
|
|
5999
|
+
"member": "string",
|
|
6000
|
+
"name": "ParentDeptOpenId",
|
|
6001
|
+
"required": false,
|
|
6002
|
+
"type": "string"
|
|
6003
|
+
},
|
|
6004
|
+
{
|
|
6005
|
+
"disabled": false,
|
|
6006
|
+
"document": "客户系统部门ID,最大长度为64个字符。",
|
|
5642
6007
|
"example": "789",
|
|
5643
6008
|
"member": "string",
|
|
5644
6009
|
"name": "DeptOpenId",
|
|
@@ -6538,7 +6903,7 @@
|
|
|
6538
6903
|
{
|
|
6539
6904
|
"disabled": false,
|
|
6540
6905
|
"document": "操作人信息",
|
|
6541
|
-
"example": "
|
|
6906
|
+
"example": "无",
|
|
6542
6907
|
"member": "UserInfo",
|
|
6543
6908
|
"name": "Operator",
|
|
6544
6909
|
"required": true,
|
|
@@ -6582,7 +6947,7 @@
|
|
|
6582
6947
|
},
|
|
6583
6948
|
{
|
|
6584
6949
|
"disabled": false,
|
|
6585
|
-
"document": "认证完成跳回的链接,最长500
|
|
6950
|
+
"document": "<font color=\"red\">即将废弃</font>,入参请使用JumpEvents。\n认证完成跳回的链接,最长500个字符。\n",
|
|
6586
6951
|
"example": "https://auth.qq.com/action-next?uid=12345",
|
|
6587
6952
|
"member": "string",
|
|
6588
6953
|
"name": "AutoJumpUrl",
|
|
@@ -6709,7 +7074,7 @@
|
|
|
6709
7074
|
{
|
|
6710
7075
|
"disabled": false,
|
|
6711
7076
|
"document": "指定企业初始化引导,现在可以配置如下的选项:\n\n<b>1</b>: 启用此选项后,在企业认证的最终步骤将添加创建印章的引导。如下图的位置\n",
|
|
6712
|
-
"example": "1",
|
|
7077
|
+
"example": "[1]",
|
|
6713
7078
|
"member": "uint64",
|
|
6714
7079
|
"name": "Initialization",
|
|
6715
7080
|
"required": false,
|
|
@@ -6718,7 +7083,7 @@
|
|
|
6718
7083
|
{
|
|
6719
7084
|
"disabled": false,
|
|
6720
7085
|
"document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。 \n授权书可以通过接口[生成企业授权书](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthFile) 来获得。\np.s. 如果上传授权书 ,需遵循以下条件 \n1. 超管的信息(超管姓名,超管手机号)必须为必填参数。\n2. 认证方式AuthorizationTypes必须只能是上传授权书方式 ",
|
|
6721
|
-
"example": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW",
|
|
7086
|
+
"example": "[\"UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW\"]",
|
|
6722
7087
|
"member": "string",
|
|
6723
7088
|
"name": "PowerOfAttorneys",
|
|
6724
7089
|
"required": false,
|
|
@@ -6750,6 +7115,15 @@
|
|
|
6750
7115
|
"name": "BankAccountNumberSame",
|
|
6751
7116
|
"required": false,
|
|
6752
7117
|
"type": "bool"
|
|
7118
|
+
},
|
|
7119
|
+
{
|
|
7120
|
+
"disabled": false,
|
|
7121
|
+
"document": "跳转事件,其中包括认证期间收录,授权书审核,企业认证的回跳事件。\np.s.\nEndpoint如果是APP 类型,请传递JumpUrl为<font color=\"red\">\"true\" </font>\n如果 Endpoint 是 H5 类型,请参考文档跳转电子签H5 \n\np.s. 如果Endpoint是 APP,传递的跳转地址无效,不会进行跳转,仅会进行回跳。",
|
|
7122
|
+
"example": "无",
|
|
7123
|
+
"member": "JumpEvent",
|
|
7124
|
+
"name": "JumpEvents",
|
|
7125
|
+
"required": false,
|
|
7126
|
+
"type": "list"
|
|
6753
7127
|
}
|
|
6754
7128
|
],
|
|
6755
7129
|
"type": "object"
|
|
@@ -6846,7 +7220,7 @@
|
|
|
6846
7220
|
{
|
|
6847
7221
|
"disabled": false,
|
|
6848
7222
|
"document": "为签署方经办人在签署合同中的参与方ID,必须与参数FlowIds数组一一对应。\n您可以通过查询合同接口(DescribeFlowInfo)查询此参数。\n若传了此参数,则可以不传 UserId, Name, Mobile等参数",
|
|
6849
|
-
"example": "yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E",
|
|
7223
|
+
"example": "[\"yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E\"]",
|
|
6850
7224
|
"member": "string",
|
|
6851
7225
|
"name": "RecipientIds",
|
|
6852
7226
|
"required": false,
|
|
@@ -6860,6 +7234,15 @@
|
|
|
6860
7234
|
"name": "FlowGroupId",
|
|
6861
7235
|
"required": false,
|
|
6862
7236
|
"type": "string"
|
|
7237
|
+
},
|
|
7238
|
+
{
|
|
7239
|
+
"disabled": false,
|
|
7240
|
+
"document": "是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>注:`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。`",
|
|
7241
|
+
"example": "false",
|
|
7242
|
+
"member": "bool",
|
|
7243
|
+
"name": "CanBatchReject",
|
|
7244
|
+
"required": false,
|
|
7245
|
+
"type": "bool"
|
|
6863
7246
|
}
|
|
6864
7247
|
],
|
|
6865
7248
|
"type": "object"
|
|
@@ -7890,7 +8273,7 @@
|
|
|
7890
8273
|
},
|
|
7891
8274
|
{
|
|
7892
8275
|
"disabled": false,
|
|
7893
|
-
"document": "合同流程里边签署方经办人手机号码,
|
|
8276
|
+
"document": "合同流程里边签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。`注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`",
|
|
7894
8277
|
"example": "13200000000",
|
|
7895
8278
|
"member": "string",
|
|
7896
8279
|
"name": "Mobile",
|
|
@@ -8091,7 +8474,7 @@
|
|
|
8091
8474
|
{
|
|
8092
8475
|
"disabled": false,
|
|
8093
8476
|
"document": "需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填,跟上面的Users同时起作用",
|
|
8094
|
-
"example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84",
|
|
8477
|
+
"example": "[\"yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84\"]",
|
|
8095
8478
|
"member": "string",
|
|
8096
8479
|
"name": "UserIds",
|
|
8097
8480
|
"required": false,
|
|
@@ -8114,6 +8497,15 @@
|
|
|
8114
8497
|
"name": "Agent",
|
|
8115
8498
|
"required": false,
|
|
8116
8499
|
"type": "object"
|
|
8500
|
+
},
|
|
8501
|
+
{
|
|
8502
|
+
"disabled": false,
|
|
8503
|
+
"document": "个性化配置字段,默认不传。",
|
|
8504
|
+
"example": "无",
|
|
8505
|
+
"member": "Option",
|
|
8506
|
+
"name": "Options",
|
|
8507
|
+
"required": false,
|
|
8508
|
+
"type": "list"
|
|
8117
8509
|
}
|
|
8118
8510
|
],
|
|
8119
8511
|
"type": "object"
|
|
@@ -8124,13 +8516,33 @@
|
|
|
8124
8516
|
{
|
|
8125
8517
|
"disabled": false,
|
|
8126
8518
|
"document": "最终授权成功的用户ID,在腾讯电子签平台的唯一身份标识,为32位字符串。\n可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查看某位员工的UserId(在页面中展示为用户ID)。",
|
|
8127
|
-
"example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84",
|
|
8519
|
+
"example": "[\"yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84\"]",
|
|
8128
8520
|
"member": "string",
|
|
8129
8521
|
"name": "UserIds",
|
|
8130
8522
|
"output_required": true,
|
|
8131
8523
|
"type": "list",
|
|
8132
8524
|
"value_allowed_null": false
|
|
8133
8525
|
},
|
|
8526
|
+
{
|
|
8527
|
+
"disabled": false,
|
|
8528
|
+
"document": "人脸验证操作人链接,用法可以参考\"[跳转电子签小程序配置](https://qian.tencent.com/developers/company/openwxminiprogram/)\",默认为空。",
|
|
8529
|
+
"example": "/pages/guide/index?to=FACE_IDENTIFY&request_token=yDXXXXXXXXXXXXXX&expired_time=1758888888",
|
|
8530
|
+
"member": "string",
|
|
8531
|
+
"name": "SealOperatorVerifyPath",
|
|
8532
|
+
"output_required": false,
|
|
8533
|
+
"type": "string",
|
|
8534
|
+
"value_allowed_null": false
|
|
8535
|
+
},
|
|
8536
|
+
{
|
|
8537
|
+
"disabled": false,
|
|
8538
|
+
"document": "人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。",
|
|
8539
|
+
"example": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=xxxxxxxxxxxxxxxxxxxxxxxxxxx",
|
|
8540
|
+
"member": "string",
|
|
8541
|
+
"name": "SealOperatorVerifyQrcodeUrl",
|
|
8542
|
+
"output_required": false,
|
|
8543
|
+
"type": "string",
|
|
8544
|
+
"value_allowed_null": false
|
|
8545
|
+
},
|
|
8134
8546
|
{
|
|
8135
8547
|
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
8136
8548
|
"member": "string",
|
|
@@ -8304,6 +8716,15 @@
|
|
|
8304
8716
|
"name": "SealDescription",
|
|
8305
8717
|
"required": false,
|
|
8306
8718
|
"type": "string"
|
|
8719
|
+
},
|
|
8720
|
+
{
|
|
8721
|
+
"disabled": false,
|
|
8722
|
+
"document": "个性化配置字段,默认不传。",
|
|
8723
|
+
"example": "无",
|
|
8724
|
+
"member": "Option",
|
|
8725
|
+
"name": "Options",
|
|
8726
|
+
"required": false,
|
|
8727
|
+
"type": "list"
|
|
8307
8728
|
}
|
|
8308
8729
|
],
|
|
8309
8730
|
"type": "object"
|
|
@@ -8321,6 +8742,100 @@
|
|
|
8321
8742
|
"type": "string",
|
|
8322
8743
|
"value_allowed_null": false
|
|
8323
8744
|
},
|
|
8745
|
+
{
|
|
8746
|
+
"disabled": false,
|
|
8747
|
+
"document": "人脸验证操作人链接,用法可以参考\"[跳转电子签小程序配置](https://qian.tencent.com/developers/company/openwxminiprogram/)\",默认为空。",
|
|
8748
|
+
"example": "/pages/guide/index?to=FACE_IDENTIFY&request_token=yDXXXXXXXXXXXXXX&expired_time=1758888888",
|
|
8749
|
+
"member": "string",
|
|
8750
|
+
"name": "SealOperatorVerifyPath",
|
|
8751
|
+
"output_required": false,
|
|
8752
|
+
"type": "string",
|
|
8753
|
+
"value_allowed_null": false
|
|
8754
|
+
},
|
|
8755
|
+
{
|
|
8756
|
+
"disabled": false,
|
|
8757
|
+
"document": "人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。",
|
|
8758
|
+
"example": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=xxxxxxxxxxxxxxxxxxxxxxxxxxx",
|
|
8759
|
+
"member": "string",
|
|
8760
|
+
"name": "SealOperatorVerifyQrcodeUrl",
|
|
8761
|
+
"output_required": false,
|
|
8762
|
+
"type": "string",
|
|
8763
|
+
"value_allowed_null": false
|
|
8764
|
+
},
|
|
8765
|
+
{
|
|
8766
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
8767
|
+
"member": "string",
|
|
8768
|
+
"name": "RequestId",
|
|
8769
|
+
"type": "string"
|
|
8770
|
+
}
|
|
8771
|
+
],
|
|
8772
|
+
"type": "object"
|
|
8773
|
+
},
|
|
8774
|
+
"CreateSingleSignOnEmployeesRequest": {
|
|
8775
|
+
"document": "CreateSingleSignOnEmployees请求参数结构体",
|
|
8776
|
+
"members": [
|
|
8777
|
+
{
|
|
8778
|
+
"disabled": false,
|
|
8779
|
+
"document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
|
8780
|
+
"example": "无",
|
|
8781
|
+
"member": "UserInfo",
|
|
8782
|
+
"name": "Operator",
|
|
8783
|
+
"required": true,
|
|
8784
|
+
"type": "object"
|
|
8785
|
+
},
|
|
8786
|
+
{
|
|
8787
|
+
"disabled": false,
|
|
8788
|
+
"document": "待创建员工的信息最多不超过200个。\n\n注意:\n1. 传递的 openId 不能重复, 且字符不能超过64位。\n2. 传递的手机号不能重复。\n3. 绑定的角色必须存在且不能超过 10 个。",
|
|
8789
|
+
"example": "无",
|
|
8790
|
+
"member": "SingleSignOnEmployees",
|
|
8791
|
+
"name": "Employees",
|
|
8792
|
+
"required": true,
|
|
8793
|
+
"type": "list"
|
|
8794
|
+
},
|
|
8795
|
+
{
|
|
8796
|
+
"disabled": false,
|
|
8797
|
+
"document": "单点登录应用号的id,获取位置如下图",
|
|
8798
|
+
"example": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS",
|
|
8799
|
+
"member": "string",
|
|
8800
|
+
"name": "SsoApplicationId",
|
|
8801
|
+
"required": true,
|
|
8802
|
+
"type": "string"
|
|
8803
|
+
},
|
|
8804
|
+
{
|
|
8805
|
+
"disabled": false,
|
|
8806
|
+
"document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
|
8807
|
+
"example": "无",
|
|
8808
|
+
"member": "Agent",
|
|
8809
|
+
"name": "Agent",
|
|
8810
|
+
"required": false,
|
|
8811
|
+
"type": "object"
|
|
8812
|
+
}
|
|
8813
|
+
],
|
|
8814
|
+
"type": "object"
|
|
8815
|
+
},
|
|
8816
|
+
"CreateSingleSignOnEmployeesResponse": {
|
|
8817
|
+
"document": "CreateSingleSignOnEmployees返回参数结构体",
|
|
8818
|
+
"members": [
|
|
8819
|
+
{
|
|
8820
|
+
"disabled": false,
|
|
8821
|
+
"document": "导入员工返回的错误信息,信息数组的顺序跟导入的保持一致",
|
|
8822
|
+
"example": "[\"导入员工失败,错误信息:[当前openId[rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0]已经被绑定了,请更换openId进行绑定]\"]",
|
|
8823
|
+
"member": "string",
|
|
8824
|
+
"name": "ErrorMessages",
|
|
8825
|
+
"output_required": false,
|
|
8826
|
+
"type": "list",
|
|
8827
|
+
"value_allowed_null": false
|
|
8828
|
+
},
|
|
8829
|
+
{
|
|
8830
|
+
"disabled": false,
|
|
8831
|
+
"document": "导入员工返回的状态码\n0-全部成功\n1-部分成功\n2-全部失败",
|
|
8832
|
+
"example": "0",
|
|
8833
|
+
"member": "uint64",
|
|
8834
|
+
"name": "Status",
|
|
8835
|
+
"output_required": false,
|
|
8836
|
+
"type": "int",
|
|
8837
|
+
"value_allowed_null": false
|
|
8838
|
+
},
|
|
8324
8839
|
{
|
|
8325
8840
|
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
8326
8841
|
"member": "string",
|
|
@@ -9414,6 +9929,60 @@
|
|
|
9414
9929
|
],
|
|
9415
9930
|
"type": "object"
|
|
9416
9931
|
},
|
|
9932
|
+
"DeleteSingleSignOnEmployeesRequest": {
|
|
9933
|
+
"document": "DeleteSingleSignOnEmployees请求参数结构体",
|
|
9934
|
+
"members": [
|
|
9935
|
+
{
|
|
9936
|
+
"disabled": false,
|
|
9937
|
+
"document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
|
9938
|
+
"example": "无",
|
|
9939
|
+
"member": "UserInfo",
|
|
9940
|
+
"name": "Operator",
|
|
9941
|
+
"required": true,
|
|
9942
|
+
"type": "object"
|
|
9943
|
+
},
|
|
9944
|
+
{
|
|
9945
|
+
"disabled": false,
|
|
9946
|
+
"document": "单点登录应用号的id,获取位置如下图",
|
|
9947
|
+
"example": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS",
|
|
9948
|
+
"member": "string",
|
|
9949
|
+
"name": "SsoApplicationId",
|
|
9950
|
+
"required": true,
|
|
9951
|
+
"type": "string"
|
|
9952
|
+
},
|
|
9953
|
+
{
|
|
9954
|
+
"disabled": false,
|
|
9955
|
+
"document": "需要删除的单点登录员工的唯一Id 值",
|
|
9956
|
+
"example": "rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0",
|
|
9957
|
+
"member": "string",
|
|
9958
|
+
"name": "OpenId",
|
|
9959
|
+
"required": true,
|
|
9960
|
+
"type": "string"
|
|
9961
|
+
},
|
|
9962
|
+
{
|
|
9963
|
+
"disabled": false,
|
|
9964
|
+
"document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
|
9965
|
+
"example": "无",
|
|
9966
|
+
"member": "Agent",
|
|
9967
|
+
"name": "Agent",
|
|
9968
|
+
"required": false,
|
|
9969
|
+
"type": "object"
|
|
9970
|
+
}
|
|
9971
|
+
],
|
|
9972
|
+
"type": "object"
|
|
9973
|
+
},
|
|
9974
|
+
"DeleteSingleSignOnEmployeesResponse": {
|
|
9975
|
+
"document": "DeleteSingleSignOnEmployees返回参数结构体",
|
|
9976
|
+
"members": [
|
|
9977
|
+
{
|
|
9978
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
9979
|
+
"member": "string",
|
|
9980
|
+
"name": "RequestId",
|
|
9981
|
+
"type": "string"
|
|
9982
|
+
}
|
|
9983
|
+
],
|
|
9984
|
+
"type": "object"
|
|
9985
|
+
},
|
|
9417
9986
|
"DeleteStaffsResult": {
|
|
9418
9987
|
"document": "删除员工结果",
|
|
9419
9988
|
"members": [
|
|
@@ -9829,12 +10398,12 @@
|
|
|
9829
10398
|
],
|
|
9830
10399
|
"type": "object"
|
|
9831
10400
|
},
|
|
9832
|
-
"
|
|
9833
|
-
"document": "
|
|
10401
|
+
"DescribeContractComparisonTaskRequest": {
|
|
10402
|
+
"document": "DescribeContractComparisonTask请求参数结构体",
|
|
9834
10403
|
"members": [
|
|
9835
10404
|
{
|
|
9836
10405
|
"disabled": false,
|
|
9837
|
-
"document": "
|
|
10406
|
+
"document": "执行合同审查任务的员工信息。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
|
9838
10407
|
"example": "无",
|
|
9839
10408
|
"member": "UserInfo",
|
|
9840
10409
|
"name": "Operator",
|
|
@@ -9843,32 +10412,207 @@
|
|
|
9843
10412
|
},
|
|
9844
10413
|
{
|
|
9845
10414
|
"disabled": false,
|
|
9846
|
-
"document": "合同对比任务ID
|
|
9847
|
-
"example": "
|
|
10415
|
+
"document": "合同对比任务ID,该参数通过调用接口CreateContractComparisonTask获取。",
|
|
10416
|
+
"example": "yD*******************ob",
|
|
9848
10417
|
"member": "string",
|
|
9849
10418
|
"name": "TaskId",
|
|
9850
10419
|
"required": true,
|
|
9851
10420
|
"type": "string"
|
|
10421
|
+
},
|
|
10422
|
+
{
|
|
10423
|
+
"disabled": false,
|
|
10424
|
+
"document": "是否返回详细的对比结果。为 true时,响应中将包含详细的对比信息,如相似度、文本差异具体内容等;为 false时,仅返回任务基本状态信息。\n注:`详细结果数据量可能较大,请按需开启。`",
|
|
10425
|
+
"example": "true",
|
|
10426
|
+
"member": "bool",
|
|
10427
|
+
"name": "ShowDetail",
|
|
10428
|
+
"required": false,
|
|
10429
|
+
"type": "bool"
|
|
9852
10430
|
}
|
|
9853
10431
|
],
|
|
9854
10432
|
"type": "object"
|
|
9855
10433
|
},
|
|
9856
|
-
"
|
|
9857
|
-
"document": "
|
|
10434
|
+
"DescribeContractComparisonTaskResponse": {
|
|
10435
|
+
"document": "DescribeContractComparisonTask返回参数结构体",
|
|
9858
10436
|
"members": [
|
|
9859
10437
|
{
|
|
9860
10438
|
"disabled": false,
|
|
9861
|
-
"document": "
|
|
9862
|
-
"example": "
|
|
10439
|
+
"document": "合同对比任务ID。",
|
|
10440
|
+
"example": "yD*******************ob",
|
|
9863
10441
|
"member": "string",
|
|
9864
|
-
"name": "
|
|
9865
|
-
"output_required":
|
|
10442
|
+
"name": "TaskId",
|
|
10443
|
+
"output_required": false,
|
|
9866
10444
|
"type": "string",
|
|
9867
10445
|
"value_allowed_null": false
|
|
9868
10446
|
},
|
|
9869
10447
|
{
|
|
9870
|
-
"
|
|
9871
|
-
"
|
|
10448
|
+
"disabled": false,
|
|
10449
|
+
"document": "合同对比任务状态。\n状态如下:\n<ul><li> **0**:待创建(未执行)</li>\n<li> **1**:对比中</li>\n<li> **2**:对比成功</li>\n<li> **3**:对比失败</li>\n</ul>",
|
|
10450
|
+
"example": "2",
|
|
10451
|
+
"member": "int64",
|
|
10452
|
+
"name": "Status",
|
|
10453
|
+
"output_required": false,
|
|
10454
|
+
"type": "int",
|
|
10455
|
+
"value_allowed_null": false
|
|
10456
|
+
},
|
|
10457
|
+
{
|
|
10458
|
+
"disabled": false,
|
|
10459
|
+
"document": "对比失败的具体原因描述,仅当状态为失败时返回此字段。",
|
|
10460
|
+
"example": "对比失败",
|
|
10461
|
+
"member": "string",
|
|
10462
|
+
"name": "Message",
|
|
10463
|
+
"output_required": false,
|
|
10464
|
+
"type": "string",
|
|
10465
|
+
"value_allowed_null": false
|
|
10466
|
+
},
|
|
10467
|
+
{
|
|
10468
|
+
"disabled": false,
|
|
10469
|
+
"document": "原版文件ID,对比基准的旧版本文件唯一标识。",
|
|
10470
|
+
"example": "yD*******************Cj",
|
|
10471
|
+
"member": "string",
|
|
10472
|
+
"name": "OriginalFileResourceId",
|
|
10473
|
+
"output_required": false,
|
|
10474
|
+
"type": "string",
|
|
10475
|
+
"value_allowed_null": false
|
|
10476
|
+
},
|
|
10477
|
+
{
|
|
10478
|
+
"disabled": false,
|
|
10479
|
+
"document": "新版文件ID,与旧版进行对比的新版本文件唯一标识。",
|
|
10480
|
+
"example": "yD*******************Ed",
|
|
10481
|
+
"member": "string",
|
|
10482
|
+
"name": "DiffFileResourceId",
|
|
10483
|
+
"output_required": false,
|
|
10484
|
+
"type": "string",
|
|
10485
|
+
"value_allowed_null": false
|
|
10486
|
+
},
|
|
10487
|
+
{
|
|
10488
|
+
"disabled": false,
|
|
10489
|
+
"document": "对比任务备注,长度不能超过50个字符。",
|
|
10490
|
+
"example": "这是一项对比任务",
|
|
10491
|
+
"member": "string",
|
|
10492
|
+
"name": "Comment",
|
|
10493
|
+
"output_required": false,
|
|
10494
|
+
"type": "string",
|
|
10495
|
+
"value_allowed_null": false
|
|
10496
|
+
},
|
|
10497
|
+
{
|
|
10498
|
+
"disabled": false,
|
|
10499
|
+
"document": "合同对比差异点总数。",
|
|
10500
|
+
"example": "10",
|
|
10501
|
+
"member": "int64",
|
|
10502
|
+
"name": "TotalDiffCount",
|
|
10503
|
+
"output_required": false,
|
|
10504
|
+
"type": "int",
|
|
10505
|
+
"value_allowed_null": false
|
|
10506
|
+
},
|
|
10507
|
+
{
|
|
10508
|
+
"disabled": false,
|
|
10509
|
+
"document": "合同对比新增点数量。",
|
|
10510
|
+
"example": "4",
|
|
10511
|
+
"member": "int64",
|
|
10512
|
+
"name": "AddDiffCount",
|
|
10513
|
+
"output_required": false,
|
|
10514
|
+
"type": "int",
|
|
10515
|
+
"value_allowed_null": false
|
|
10516
|
+
},
|
|
10517
|
+
{
|
|
10518
|
+
"disabled": false,
|
|
10519
|
+
"document": "合同对比修改点数量。",
|
|
10520
|
+
"example": "4",
|
|
10521
|
+
"member": "int64",
|
|
10522
|
+
"name": "ChangeDiffCount",
|
|
10523
|
+
"output_required": false,
|
|
10524
|
+
"type": "int",
|
|
10525
|
+
"value_allowed_null": false
|
|
10526
|
+
},
|
|
10527
|
+
{
|
|
10528
|
+
"disabled": false,
|
|
10529
|
+
"document": "合同对比删除点数量。",
|
|
10530
|
+
"example": "2",
|
|
10531
|
+
"member": "int64",
|
|
10532
|
+
"name": "DeleteDiffCount",
|
|
10533
|
+
"output_required": false,
|
|
10534
|
+
"type": "int",
|
|
10535
|
+
"value_allowed_null": false
|
|
10536
|
+
},
|
|
10537
|
+
{
|
|
10538
|
+
"disabled": false,
|
|
10539
|
+
"document": "提交人,提交此任务或请求的用户唯一标识。",
|
|
10540
|
+
"example": "yD*******************dc",
|
|
10541
|
+
"member": "string",
|
|
10542
|
+
"name": "Operator",
|
|
10543
|
+
"output_required": false,
|
|
10544
|
+
"type": "string",
|
|
10545
|
+
"value_allowed_null": false
|
|
10546
|
+
},
|
|
10547
|
+
{
|
|
10548
|
+
"disabled": false,
|
|
10549
|
+
"document": "合同对比任务创建时间,时间戳。",
|
|
10550
|
+
"example": "1758526698",
|
|
10551
|
+
"member": "int64",
|
|
10552
|
+
"name": "CreateTime",
|
|
10553
|
+
"output_required": false,
|
|
10554
|
+
"type": "int",
|
|
10555
|
+
"value_allowed_null": false
|
|
10556
|
+
},
|
|
10557
|
+
{
|
|
10558
|
+
"disabled": false,
|
|
10559
|
+
"document": "对比差异详情,请求参数ShowDetail为true时返回。",
|
|
10560
|
+
"example": "无",
|
|
10561
|
+
"member": "ComparisonDetail",
|
|
10562
|
+
"name": "ComparisonDetail",
|
|
10563
|
+
"output_required": false,
|
|
10564
|
+
"type": "list",
|
|
10565
|
+
"value_allowed_null": false
|
|
10566
|
+
},
|
|
10567
|
+
{
|
|
10568
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
10569
|
+
"member": "string",
|
|
10570
|
+
"name": "RequestId",
|
|
10571
|
+
"type": "string"
|
|
10572
|
+
}
|
|
10573
|
+
],
|
|
10574
|
+
"type": "object"
|
|
10575
|
+
},
|
|
10576
|
+
"DescribeContractDiffTaskWebUrlRequest": {
|
|
10577
|
+
"document": "DescribeContractDiffTaskWebUrl请求参数结构体",
|
|
10578
|
+
"members": [
|
|
10579
|
+
{
|
|
10580
|
+
"disabled": false,
|
|
10581
|
+
"document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
|
10582
|
+
"example": "无",
|
|
10583
|
+
"member": "UserInfo",
|
|
10584
|
+
"name": "Operator",
|
|
10585
|
+
"required": true,
|
|
10586
|
+
"type": "object"
|
|
10587
|
+
},
|
|
10588
|
+
{
|
|
10589
|
+
"disabled": false,
|
|
10590
|
+
"document": "合同对比任务ID,该参数通过调用接口<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/CreateContractDiffTaskWebUrl\" target=\"_blank\">创建合同对比web页面</a>获取。",
|
|
10591
|
+
"example": "yDt3wUUckpx9w197UyoAic68BmF35hFu",
|
|
10592
|
+
"member": "string",
|
|
10593
|
+
"name": "TaskId",
|
|
10594
|
+
"required": true,
|
|
10595
|
+
"type": "string"
|
|
10596
|
+
}
|
|
10597
|
+
],
|
|
10598
|
+
"type": "object"
|
|
10599
|
+
},
|
|
10600
|
+
"DescribeContractDiffTaskWebUrlResponse": {
|
|
10601
|
+
"document": "DescribeContractDiffTaskWebUrl返回参数结构体",
|
|
10602
|
+
"members": [
|
|
10603
|
+
{
|
|
10604
|
+
"disabled": false,
|
|
10605
|
+
"document": "合同对比嵌入式web页面链接,有效期:5分钟\n链接仅能使用一次",
|
|
10606
|
+
"example": "https://embed.qian.tencent.cn/contract-compare?embed=1&code=yDt3RUUckpx9s4h8UuFSuGdR9VDNF2lh&channel=TENCENTCLOUD&embedType=CONTRACT_DIFF&businessType=TASK_ID&businessId=yDttgUUckpxxat41UyoAic6CrjE7K0x2",
|
|
10607
|
+
"member": "string",
|
|
10608
|
+
"name": "WebUrl",
|
|
10609
|
+
"output_required": true,
|
|
10610
|
+
"type": "string",
|
|
10611
|
+
"value_allowed_null": false
|
|
10612
|
+
},
|
|
10613
|
+
{
|
|
10614
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
10615
|
+
"member": "string",
|
|
9872
10616
|
"name": "RequestId",
|
|
9873
10617
|
"type": "string"
|
|
9874
10618
|
}
|
|
@@ -10746,8 +11490,8 @@
|
|
|
10746
11490
|
},
|
|
10747
11491
|
{
|
|
10748
11492
|
"disabled": false,
|
|
10749
|
-
"document": "搜索过滤的条件,本字段允许您通过指定模板 ID
|
|
10750
|
-
"example": "
|
|
11493
|
+
"document": "搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png\" target=\"_blank\">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png\" target=\"_blank\">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href=\"https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png\" target=\"_blank\">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong>为您想要查询的用户模板类型id列表。</li></ul>",
|
|
11494
|
+
"example": "无",
|
|
10751
11495
|
"member": "Filter",
|
|
10752
11496
|
"name": "Filters",
|
|
10753
11497
|
"required": false,
|
|
@@ -10801,7 +11545,7 @@
|
|
|
10801
11545
|
{
|
|
10802
11546
|
"disabled": true,
|
|
10803
11547
|
"document": "暂未开放",
|
|
10804
|
-
"example": "
|
|
11548
|
+
"example": "1",
|
|
10805
11549
|
"member": "uint64",
|
|
10806
11550
|
"name": "GenerateSource",
|
|
10807
11551
|
"required": false,
|
|
@@ -10936,6 +11680,52 @@
|
|
|
10936
11680
|
],
|
|
10937
11681
|
"type": "object"
|
|
10938
11682
|
},
|
|
11683
|
+
"DescribeInformationExtractionWebUrlRequest": {
|
|
11684
|
+
"document": "DescribeInformationExtractionWebUrl请求参数结构体",
|
|
11685
|
+
"members": [
|
|
11686
|
+
{
|
|
11687
|
+
"disabled": false,
|
|
11688
|
+
"document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
|
11689
|
+
"example": "无",
|
|
11690
|
+
"member": "UserInfo",
|
|
11691
|
+
"name": "Operator",
|
|
11692
|
+
"required": true,
|
|
11693
|
+
"type": "object"
|
|
11694
|
+
},
|
|
11695
|
+
{
|
|
11696
|
+
"disabled": false,
|
|
11697
|
+
"document": "合同信息提取任务ID,该参数可通过回调事件[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)获取或者从控制台信息提取任务列表获取。\n\n注意:`不填写任务ID时返回信息提取任务列表URL,填写任务ID时返回信息提取任务详情URL`",
|
|
11698
|
+
"example": "yDtGEUUgydjcwqRz",
|
|
11699
|
+
"member": "string",
|
|
11700
|
+
"name": "TaskId",
|
|
11701
|
+
"required": false,
|
|
11702
|
+
"type": "string"
|
|
11703
|
+
}
|
|
11704
|
+
],
|
|
11705
|
+
"type": "object"
|
|
11706
|
+
},
|
|
11707
|
+
"DescribeInformationExtractionWebUrlResponse": {
|
|
11708
|
+
"document": "DescribeInformationExtractionWebUrl返回参数结构体",
|
|
11709
|
+
"members": [
|
|
11710
|
+
{
|
|
11711
|
+
"disabled": false,
|
|
11712
|
+
"document": "合同信息提取嵌入式web页面链接。\n注意:`链接有效期为5分钟,且链接仅能使用一次。`",
|
|
11713
|
+
"example": "https://embed.test.qian.tencent.cn/ai-contract-info-extract-e",
|
|
11714
|
+
"member": "string",
|
|
11715
|
+
"name": "Url",
|
|
11716
|
+
"output_required": true,
|
|
11717
|
+
"type": "string",
|
|
11718
|
+
"value_allowed_null": false
|
|
11719
|
+
},
|
|
11720
|
+
{
|
|
11721
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
11722
|
+
"member": "string",
|
|
11723
|
+
"name": "RequestId",
|
|
11724
|
+
"type": "string"
|
|
11725
|
+
}
|
|
11726
|
+
],
|
|
11727
|
+
"type": "object"
|
|
11728
|
+
},
|
|
10939
11729
|
"DescribeIntegrationDepartmentsRequest": {
|
|
10940
11730
|
"document": "DescribeIntegrationDepartments请求参数结构体",
|
|
10941
11731
|
"members": [
|
|
@@ -11500,8 +12290,8 @@
|
|
|
11500
12290
|
},
|
|
11501
12291
|
{
|
|
11502
12292
|
"disabled": false,
|
|
11503
|
-
"document": "印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>
|
|
11504
|
-
"example": "OFFICIAL",
|
|
12293
|
+
"document": "印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>FINANCE</strong>:财务专用章;</li> <li><strong>PERSONNEL</strong>:人事专用章;</li><li><strong>INVOICE</strong>:发票专用章;</li><li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> <li><strong>EMPLOYEE_QUALIFICATION_SEAL</strong>:员工执业章。</li> </ul>",
|
|
12294
|
+
"example": "[\"OFFICIAL\"]",
|
|
11505
12295
|
"member": "string",
|
|
11506
12296
|
"name": "SealTypes",
|
|
11507
12297
|
"required": false,
|
|
@@ -11519,7 +12309,7 @@
|
|
|
11519
12309
|
{
|
|
11520
12310
|
"disabled": false,
|
|
11521
12311
|
"document": "需查询的印章状态列表。\n<ul>\n<li>空:(默认)仅查询启用状态的印章;</li>\n<li><strong>ALL</strong>:查询所有状态的印章;</li>\n<li><strong>CHECKING</strong>:查询待审核的印章;</li>\n<li><strong>SUCCESS</strong>:查询启用状态的印章;</li>\n<li><strong>FAIL</strong>:查询印章审核拒绝的印章;</li>\n<li><strong>DISABLE</strong>:查询已停用的印章;</li>\n<li><strong>STOPPED</strong>:查询已终止的印章;</li>\n<li><strong>VOID</strong>:查询已作废的印章;</li>\n<li><strong>INVALID</strong>:查询已失效的印章。</li>\n</ul>",
|
|
11522
|
-
"example": "ALL",
|
|
12312
|
+
"example": "[\"ALL\"]",
|
|
11523
12313
|
"member": "string",
|
|
11524
12314
|
"name": "SealStatuses",
|
|
11525
12315
|
"required": false,
|
|
@@ -11754,6 +12544,88 @@
|
|
|
11754
12544
|
],
|
|
11755
12545
|
"type": "object"
|
|
11756
12546
|
},
|
|
12547
|
+
"DescribeSingleSignOnEmployeesRequest": {
|
|
12548
|
+
"document": "DescribeSingleSignOnEmployees请求参数结构体",
|
|
12549
|
+
"members": [
|
|
12550
|
+
{
|
|
12551
|
+
"disabled": false,
|
|
12552
|
+
"document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
|
12553
|
+
"example": "无",
|
|
12554
|
+
"member": "UserInfo",
|
|
12555
|
+
"name": "Operator",
|
|
12556
|
+
"required": true,
|
|
12557
|
+
"type": "object"
|
|
12558
|
+
},
|
|
12559
|
+
{
|
|
12560
|
+
"disabled": false,
|
|
12561
|
+
"document": "单点登录应用号的id,获取位置如下图",
|
|
12562
|
+
"example": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS",
|
|
12563
|
+
"member": "string",
|
|
12564
|
+
"name": "SsoApplicationId",
|
|
12565
|
+
"required": true,
|
|
12566
|
+
"type": "string"
|
|
12567
|
+
},
|
|
12568
|
+
{
|
|
12569
|
+
"disabled": false,
|
|
12570
|
+
"document": "需要删除的单点登录员工的唯一Id 值.不能超过 200 个。\n如果传递了 openIds,limit 和 offset 参数无效,",
|
|
12571
|
+
"example": "[\"rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0\"]",
|
|
12572
|
+
"member": "string",
|
|
12573
|
+
"name": "OpenIds",
|
|
12574
|
+
"required": false,
|
|
12575
|
+
"type": "list"
|
|
12576
|
+
},
|
|
12577
|
+
{
|
|
12578
|
+
"disabled": false,
|
|
12579
|
+
"document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
|
12580
|
+
"example": "无",
|
|
12581
|
+
"member": "Agent",
|
|
12582
|
+
"name": "Agent",
|
|
12583
|
+
"required": false,
|
|
12584
|
+
"type": "object"
|
|
12585
|
+
},
|
|
12586
|
+
{
|
|
12587
|
+
"disabled": false,
|
|
12588
|
+
"document": "指定分页每页返回的数据条数,单页最大支持 200。如果不传, 则默认是 20.",
|
|
12589
|
+
"example": "200",
|
|
12590
|
+
"member": "uint64",
|
|
12591
|
+
"name": "Limit",
|
|
12592
|
+
"required": false,
|
|
12593
|
+
"type": "int"
|
|
12594
|
+
},
|
|
12595
|
+
{
|
|
12596
|
+
"disabled": false,
|
|
12597
|
+
"document": "OFFSET 用于指定查询结果的偏移量,如果不传默认偏移为0,最大20000。 分页参数, 需要limit, offset 配合使用 例如: 您希望得到第三页的数据, 且每页限制最多10条 您可以使用 LIMIT 10 OFFSET 20\t",
|
|
12598
|
+
"example": "0",
|
|
12599
|
+
"member": "uint64",
|
|
12600
|
+
"name": "Offset",
|
|
12601
|
+
"required": false,
|
|
12602
|
+
"type": "int"
|
|
12603
|
+
}
|
|
12604
|
+
],
|
|
12605
|
+
"type": "object"
|
|
12606
|
+
},
|
|
12607
|
+
"DescribeSingleSignOnEmployeesResponse": {
|
|
12608
|
+
"document": "DescribeSingleSignOnEmployees返回参数结构体",
|
|
12609
|
+
"members": [
|
|
12610
|
+
{
|
|
12611
|
+
"disabled": false,
|
|
12612
|
+
"document": "单点登录企业员工信息",
|
|
12613
|
+
"example": "无",
|
|
12614
|
+
"member": "SingleSignOnEmployees",
|
|
12615
|
+
"name": "Employees",
|
|
12616
|
+
"output_required": true,
|
|
12617
|
+
"type": "list",
|
|
12618
|
+
"value_allowed_null": false
|
|
12619
|
+
},
|
|
12620
|
+
{
|
|
12621
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
12622
|
+
"member": "string",
|
|
12623
|
+
"name": "RequestId",
|
|
12624
|
+
"type": "string"
|
|
12625
|
+
}
|
|
12626
|
+
],
|
|
12627
|
+
"type": "object"
|
|
12628
|
+
},
|
|
11757
12629
|
"DescribeThirdPartyAuthCodeRequest": {
|
|
11758
12630
|
"document": "DescribeThirdPartyAuthCode请求参数结构体",
|
|
11759
12631
|
"members": [
|
|
@@ -11936,8 +12808,8 @@
|
|
|
11936
12808
|
},
|
|
11937
12809
|
{
|
|
11938
12810
|
"disabled": false,
|
|
11939
|
-
"document": "搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。\n<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png\" target=\"_blank\">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png\" target=\"_blank\">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href=\"https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png\" target=\"_blank\">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong
|
|
11940
|
-
"example": "
|
|
12811
|
+
"document": "搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。\n<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png\" target=\"_blank\">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png\" target=\"_blank\">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href=\"https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png\" target=\"_blank\">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong>为您想要查询的用户模板类型id列表。</li></ul>",
|
|
12812
|
+
"example": "无",
|
|
11941
12813
|
"member": "Filter",
|
|
11942
12814
|
"name": "Filters",
|
|
11943
12815
|
"required": false,
|
|
@@ -11945,7 +12817,7 @@
|
|
|
11945
12817
|
},
|
|
11946
12818
|
{
|
|
11947
12819
|
"disabled": false,
|
|
11948
|
-
"document": "
|
|
12820
|
+
"document": "查询绑定了模板的用户合同类型 <ul> <li>false(默认值),查询用户合同类型</li> <li>true,查询绑定了模板的用户合同类型</li> </ul>\t",
|
|
11949
12821
|
"example": "false",
|
|
11950
12822
|
"member": "bool",
|
|
11951
12823
|
"name": "QueryBindTemplate",
|
|
@@ -12210,6 +13082,80 @@
|
|
|
12210
13082
|
],
|
|
12211
13083
|
"usage": "in"
|
|
12212
13084
|
},
|
|
13085
|
+
"ExportContractComparisonTaskRequest": {
|
|
13086
|
+
"document": "ExportContractComparisonTask请求参数结构体",
|
|
13087
|
+
"members": [
|
|
13088
|
+
{
|
|
13089
|
+
"disabled": false,
|
|
13090
|
+
"document": "执行合同审查任务的员工信息。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
|
13091
|
+
"example": "无",
|
|
13092
|
+
"member": "UserInfo",
|
|
13093
|
+
"name": "Operator",
|
|
13094
|
+
"required": true,
|
|
13095
|
+
"type": "object"
|
|
13096
|
+
},
|
|
13097
|
+
{
|
|
13098
|
+
"disabled": false,
|
|
13099
|
+
"document": "合同对比任务ID,该参数通过调用接口CreateContractComparisonTask获取。",
|
|
13100
|
+
"example": "yD*******************ob",
|
|
13101
|
+
"member": "string",
|
|
13102
|
+
"name": "TaskId",
|
|
13103
|
+
"required": true,
|
|
13104
|
+
"type": "string"
|
|
13105
|
+
},
|
|
13106
|
+
{
|
|
13107
|
+
"disabled": false,
|
|
13108
|
+
"document": "导出对比结果文件类型。\n类型如下:\n<ul>\n<li> **0**:【PDF】以新合同文件为基础,导出带有可视化对比点标注的PDF文件。</li>\n<li> **1**:【EXCEL】导出结构化的对比点明细表格,以列表形式罗列每一个差异点,包含改动位置、类型、标签及修改前后的完整内容。</li>\n</ul>",
|
|
13109
|
+
"example": "1",
|
|
13110
|
+
"member": "int64",
|
|
13111
|
+
"name": "ExportType",
|
|
13112
|
+
"required": false,
|
|
13113
|
+
"type": "int"
|
|
13114
|
+
},
|
|
13115
|
+
{
|
|
13116
|
+
"disabled": false,
|
|
13117
|
+
"document": "是否忽略,适用于PDF。\n<ul>\n<li> **true**:导出文件标注去掉忽略项。</li>\n<li> **false**:导出文件包含所有对比点。</li>\n</ul>",
|
|
13118
|
+
"example": "true",
|
|
13119
|
+
"member": "bool",
|
|
13120
|
+
"name": "Ignore",
|
|
13121
|
+
"required": false,
|
|
13122
|
+
"type": "bool"
|
|
13123
|
+
}
|
|
13124
|
+
],
|
|
13125
|
+
"type": "object"
|
|
13126
|
+
},
|
|
13127
|
+
"ExportContractComparisonTaskResponse": {
|
|
13128
|
+
"document": "ExportContractComparisonTask返回参数结构体",
|
|
13129
|
+
"members": [
|
|
13130
|
+
{
|
|
13131
|
+
"disabled": false,
|
|
13132
|
+
"document": "对比任务详情下载链接。",
|
|
13133
|
+
"example": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.PDF",
|
|
13134
|
+
"member": "string",
|
|
13135
|
+
"name": "ResourceUrl",
|
|
13136
|
+
"output_required": false,
|
|
13137
|
+
"type": "string",
|
|
13138
|
+
"value_allowed_null": false
|
|
13139
|
+
},
|
|
13140
|
+
{
|
|
13141
|
+
"disabled": false,
|
|
13142
|
+
"document": "下载链接有效截止时间。",
|
|
13143
|
+
"example": "1760009219",
|
|
13144
|
+
"member": "int64",
|
|
13145
|
+
"name": "ExpireTime",
|
|
13146
|
+
"output_required": false,
|
|
13147
|
+
"type": "int",
|
|
13148
|
+
"value_allowed_null": false
|
|
13149
|
+
},
|
|
13150
|
+
{
|
|
13151
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
13152
|
+
"member": "string",
|
|
13153
|
+
"name": "RequestId",
|
|
13154
|
+
"type": "string"
|
|
13155
|
+
}
|
|
13156
|
+
],
|
|
13157
|
+
"type": "object"
|
|
13158
|
+
},
|
|
12213
13159
|
"ExtendAuthInfo": {
|
|
12214
13160
|
"document": "扩展服务开通和授权的详细信息",
|
|
12215
13161
|
"members": [
|
|
@@ -12348,7 +13294,7 @@
|
|
|
12348
13294
|
},
|
|
12349
13295
|
{
|
|
12350
13296
|
"disabled": false,
|
|
12351
|
-
"document": "用于描述字段信息。\n\n注意:\n1
|
|
13297
|
+
"document": "用于描述字段信息。\n\n注意:\n1、描述字段不能超过100个字符",
|
|
12352
13298
|
"example": "字段描述",
|
|
12353
13299
|
"member": "string",
|
|
12354
13300
|
"name": "Description",
|
|
@@ -12359,10 +13305,21 @@
|
|
|
12359
13305
|
},
|
|
12360
13306
|
{
|
|
12361
13307
|
"disabled": false,
|
|
12362
|
-
"document": "提取出合同中的字段信息。",
|
|
12363
|
-
"example": "[\"张三\"]",
|
|
13308
|
+
"document": "提取出合同中的字段信息。",
|
|
13309
|
+
"example": "[\"张三\"]",
|
|
13310
|
+
"member": "string",
|
|
13311
|
+
"name": "Values",
|
|
13312
|
+
"output_required": false,
|
|
13313
|
+
"required": false,
|
|
13314
|
+
"type": "list",
|
|
13315
|
+
"value_allowed_null": false
|
|
13316
|
+
},
|
|
13317
|
+
{
|
|
13318
|
+
"disabled": false,
|
|
13319
|
+
"document": "当字段类型`Type`为OPTION时为必输项,输入选项值",
|
|
13320
|
+
"example": "[\"选项值1\"]",
|
|
12364
13321
|
"member": "string",
|
|
12365
|
-
"name": "
|
|
13322
|
+
"name": "ChoiceList",
|
|
12366
13323
|
"output_required": false,
|
|
12367
13324
|
"required": false,
|
|
12368
13325
|
"type": "list",
|
|
@@ -12986,7 +13943,7 @@
|
|
|
12986
13943
|
{
|
|
12987
13944
|
"disabled": true,
|
|
12988
13945
|
"document": "模板配置中的参与方ID,与控件绑定",
|
|
12989
|
-
"example": "
|
|
13946
|
+
"example": "1",
|
|
12990
13947
|
"member": "string",
|
|
12991
13948
|
"name": "ReceiptId",
|
|
12992
13949
|
"output_required": true,
|
|
@@ -13006,7 +13963,7 @@
|
|
|
13006
13963
|
{
|
|
13007
13964
|
"disabled": false,
|
|
13008
13965
|
"document": "签署人手机号",
|
|
13009
|
-
"example": "
|
|
13966
|
+
"example": "1320****000",
|
|
13010
13967
|
"member": "string",
|
|
13011
13968
|
"name": "Mobile",
|
|
13012
13969
|
"output_required": true,
|
|
@@ -13152,7 +14109,7 @@
|
|
|
13152
14109
|
{
|
|
13153
14110
|
"disabled": false,
|
|
13154
14111
|
"document": "签署人手机号。",
|
|
13155
|
-
"example": "
|
|
14112
|
+
"example": "1320****000",
|
|
13156
14113
|
"member": "string",
|
|
13157
14114
|
"name": "ApproverMobile",
|
|
13158
14115
|
"output_required": true,
|
|
@@ -13359,7 +14316,7 @@
|
|
|
13359
14316
|
},
|
|
13360
14317
|
{
|
|
13361
14318
|
"disabled": false,
|
|
13362
|
-
"document": "签署方经办人手机号码,
|
|
14319
|
+
"document": "签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。\n\n注:`在未指定签署人电子签UserId情况下,为必填参数`\n",
|
|
13363
14320
|
"example": "18888888888",
|
|
13364
14321
|
"member": "string",
|
|
13365
14322
|
"name": "ApproverMobile",
|
|
@@ -13486,7 +14443,7 @@
|
|
|
13486
14443
|
{
|
|
13487
14444
|
"disabled": true,
|
|
13488
14445
|
"document": "签署完前端跳转的url,暂未使用",
|
|
13489
|
-
"example": "
|
|
14446
|
+
"example": "http://qq.com",
|
|
13490
14447
|
"member": "string",
|
|
13491
14448
|
"name": "JumpUrl",
|
|
13492
14449
|
"required": false,
|
|
@@ -14005,7 +14962,7 @@
|
|
|
14005
14962
|
"members": [
|
|
14006
14963
|
{
|
|
14007
14964
|
"disabled": false,
|
|
14008
|
-
"document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \\n 来控制换行位置</li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>\n</ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td
|
|
14965
|
+
"document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \\n 来控制换行位置</li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>\n</ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>\n",
|
|
14009
14966
|
"example": "ComponentValue",
|
|
14010
14967
|
"member": "string",
|
|
14011
14968
|
"name": "ComponentValue",
|
|
@@ -14652,6 +15609,30 @@
|
|
|
14652
15609
|
],
|
|
14653
15610
|
"usage": "out"
|
|
14654
15611
|
},
|
|
15612
|
+
"JumpEvent": {
|
|
15613
|
+
"document": "跳转事件的结构体,其中包括认证期间收录,授权书审核,企业认证的回跳事件。",
|
|
15614
|
+
"members": [
|
|
15615
|
+
{
|
|
15616
|
+
"disabled": false,
|
|
15617
|
+
"document": "跳转事件枚举,\n* 1 - 企业收录。\n* 2 - 超管授权书审核。\n* 3 - 认证完成。",
|
|
15618
|
+
"example": "1",
|
|
15619
|
+
"member": "uint64",
|
|
15620
|
+
"name": "JumpEventType",
|
|
15621
|
+
"required": false,
|
|
15622
|
+
"type": "int"
|
|
15623
|
+
},
|
|
15624
|
+
{
|
|
15625
|
+
"disabled": false,
|
|
15626
|
+
"document": "为认证成功后页面进行回跳的URL,请确保回跳地址的可用性。\nEndpoint如果是APP 类型,请传递<font color=\"red\">\"true\"</font>\n如果 Endpoint 是 H5 类型,请参考文档[跳转电子签H5](https://qian.tencent.com/developers/company/openqianh5/)\n\np.s. 如果Endpoint是 APP,传递的跳转地址无效,不会进行跳转,仅会进行回跳。",
|
|
15627
|
+
"example": "https://qian.tencent.com/",
|
|
15628
|
+
"member": "string",
|
|
15629
|
+
"name": "JumpUrl",
|
|
15630
|
+
"required": false,
|
|
15631
|
+
"type": "string"
|
|
15632
|
+
}
|
|
15633
|
+
],
|
|
15634
|
+
"usage": "in"
|
|
15635
|
+
},
|
|
14655
15636
|
"MiniAppCreateApproverInfo": {
|
|
14656
15637
|
"document": "创建流程的签署方信息",
|
|
14657
15638
|
"members": [
|
|
@@ -14684,7 +15665,7 @@
|
|
|
14684
15665
|
},
|
|
14685
15666
|
{
|
|
14686
15667
|
"disabled": false,
|
|
14687
|
-
"document": "签署方经办人手机号码,
|
|
15668
|
+
"document": "签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。\n\n注:`在未指定签署人电子签UserId情况下,为必填参数`\n",
|
|
14688
15669
|
"example": "18888888888",
|
|
14689
15670
|
"member": "string",
|
|
14690
15671
|
"name": "ApproverMobile",
|
|
@@ -14759,7 +15740,7 @@
|
|
|
14759
15740
|
},
|
|
14760
15741
|
{
|
|
14761
15742
|
"disabled": false,
|
|
14762
|
-
"document": "小程序集成发起,是否禁止发起时修改合同内容\n<ul>\n<li>false:默认值,不禁止发起时修改合同内容</li>\n<li>true
|
|
15743
|
+
"document": "小程序集成发起,是否禁止发起时修改合同内容\n<ul>\n<li>false:默认值,不禁止发起时修改合同内容</li>\n<li>true:禁止发起时修改合同内容(将直接跳过添加/编辑签署人步骤,直接到核对合同信息页面</li>\n</ul>\n指定为true,效果如下:\n\n效果如下:\n",
|
|
14763
15744
|
"example": "true",
|
|
14764
15745
|
"member": "bool",
|
|
14765
15746
|
"name": "ForbidEditFlow",
|
|
@@ -15243,6 +16224,60 @@
|
|
|
15243
16224
|
],
|
|
15244
16225
|
"type": "object"
|
|
15245
16226
|
},
|
|
16227
|
+
"ModifySingleSignOnEmployeesRequest": {
|
|
16228
|
+
"document": "ModifySingleSignOnEmployees请求参数结构体",
|
|
16229
|
+
"members": [
|
|
16230
|
+
{
|
|
16231
|
+
"disabled": false,
|
|
16232
|
+
"document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
|
16233
|
+
"example": "无",
|
|
16234
|
+
"member": "UserInfo",
|
|
16235
|
+
"name": "Operator",
|
|
16236
|
+
"required": true,
|
|
16237
|
+
"type": "object"
|
|
16238
|
+
},
|
|
16239
|
+
{
|
|
16240
|
+
"disabled": false,
|
|
16241
|
+
"document": "单点登录应用号的id,获取位置如下图",
|
|
16242
|
+
"example": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS",
|
|
16243
|
+
"member": "string",
|
|
16244
|
+
"name": "SsoApplicationId",
|
|
16245
|
+
"required": true,
|
|
16246
|
+
"type": "string"
|
|
16247
|
+
},
|
|
16248
|
+
{
|
|
16249
|
+
"disabled": false,
|
|
16250
|
+
"document": "待修改员工的信息。",
|
|
16251
|
+
"example": "无",
|
|
16252
|
+
"member": "SingleSignOnEmployees",
|
|
16253
|
+
"name": "Employee",
|
|
16254
|
+
"required": true,
|
|
16255
|
+
"type": "object"
|
|
16256
|
+
},
|
|
16257
|
+
{
|
|
16258
|
+
"disabled": false,
|
|
16259
|
+
"document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
|
16260
|
+
"example": "无",
|
|
16261
|
+
"member": "Agent",
|
|
16262
|
+
"name": "Agent",
|
|
16263
|
+
"required": false,
|
|
16264
|
+
"type": "object"
|
|
16265
|
+
}
|
|
16266
|
+
],
|
|
16267
|
+
"type": "object"
|
|
16268
|
+
},
|
|
16269
|
+
"ModifySingleSignOnEmployeesResponse": {
|
|
16270
|
+
"document": "ModifySingleSignOnEmployees返回参数结构体",
|
|
16271
|
+
"members": [
|
|
16272
|
+
{
|
|
16273
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
16274
|
+
"member": "string",
|
|
16275
|
+
"name": "RequestId",
|
|
16276
|
+
"type": "string"
|
|
16277
|
+
}
|
|
16278
|
+
],
|
|
16279
|
+
"type": "object"
|
|
16280
|
+
},
|
|
15246
16281
|
"NeedReviewApproverInfo": {
|
|
15247
16282
|
"document": "需要进行签署审核的签署人信息",
|
|
15248
16283
|
"members": [
|
|
@@ -15266,7 +16301,7 @@
|
|
|
15266
16301
|
},
|
|
15267
16302
|
{
|
|
15268
16303
|
"disabled": false,
|
|
15269
|
-
"document": "签署方经办人手机号码,
|
|
16304
|
+
"document": "签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。",
|
|
15270
16305
|
"example": "18888888888",
|
|
15271
16306
|
"member": "string",
|
|
15272
16307
|
"name": "ApproverMobile",
|
|
@@ -15517,6 +16552,15 @@
|
|
|
15517
16552
|
"name": "SealIds",
|
|
15518
16553
|
"required": false,
|
|
15519
16554
|
"type": "list"
|
|
16555
|
+
},
|
|
16556
|
+
{
|
|
16557
|
+
"disabled": false,
|
|
16558
|
+
"document": "个性化配置字段,默认不传。",
|
|
16559
|
+
"example": "无",
|
|
16560
|
+
"member": "Option",
|
|
16561
|
+
"name": "Options",
|
|
16562
|
+
"required": false,
|
|
16563
|
+
"type": "list"
|
|
15520
16564
|
}
|
|
15521
16565
|
],
|
|
15522
16566
|
"type": "object"
|
|
@@ -15524,6 +16568,26 @@
|
|
|
15524
16568
|
"OperateSealsResponse": {
|
|
15525
16569
|
"document": "OperateSeals返回参数结构体",
|
|
15526
16570
|
"members": [
|
|
16571
|
+
{
|
|
16572
|
+
"disabled": false,
|
|
16573
|
+
"document": "人脸验证操作人链接,用法可以参考\"[跳转电子签小程序配置](https://qian.tencent.com/developers/company/openwxminiprogram/)\",默认为空。",
|
|
16574
|
+
"example": "/pages/guide/index?to=FACE_IDENTIFY&request_token=yDXXXXXXXXXXXXXX&expired_time=1758888888",
|
|
16575
|
+
"member": "string",
|
|
16576
|
+
"name": "SealOperatorVerifyPath",
|
|
16577
|
+
"output_required": false,
|
|
16578
|
+
"type": "string",
|
|
16579
|
+
"value_allowed_null": false
|
|
16580
|
+
},
|
|
16581
|
+
{
|
|
16582
|
+
"disabled": false,
|
|
16583
|
+
"document": "人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。",
|
|
16584
|
+
"example": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=xxxxxxxxxxxxxxxxxxxxxxxxxxx",
|
|
16585
|
+
"member": "string",
|
|
16586
|
+
"name": "SealOperatorVerifyQrcodeUrl",
|
|
16587
|
+
"output_required": false,
|
|
16588
|
+
"type": "string",
|
|
16589
|
+
"value_allowed_null": false
|
|
16590
|
+
},
|
|
15527
16591
|
{
|
|
15528
16592
|
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
|
15529
16593
|
"member": "string",
|
|
@@ -15616,6 +16680,34 @@
|
|
|
15616
16680
|
],
|
|
15617
16681
|
"type": "object"
|
|
15618
16682
|
},
|
|
16683
|
+
"Option": {
|
|
16684
|
+
"document": "业务逻辑个性化配置字段,默认不传\n\n注: `配置前请联系对接的客户经理沟通确认。`",
|
|
16685
|
+
"members": [
|
|
16686
|
+
{
|
|
16687
|
+
"disabled": false,
|
|
16688
|
+
"document": "个性化配置参数Key字段,对应传入字段的字段名",
|
|
16689
|
+
"example": "SealOperatorVerify",
|
|
16690
|
+
"member": "string",
|
|
16691
|
+
"name": "Key",
|
|
16692
|
+
"output_required": false,
|
|
16693
|
+
"required": true,
|
|
16694
|
+
"type": "string",
|
|
16695
|
+
"value_allowed_null": false
|
|
16696
|
+
},
|
|
16697
|
+
{
|
|
16698
|
+
"disabled": false,
|
|
16699
|
+
"document": "个性化配置参数Value字段,对应传入字段的字段值",
|
|
16700
|
+
"example": "true",
|
|
16701
|
+
"member": "string",
|
|
16702
|
+
"name": "Value",
|
|
16703
|
+
"output_required": false,
|
|
16704
|
+
"required": true,
|
|
16705
|
+
"type": "string",
|
|
16706
|
+
"value_allowed_null": false
|
|
16707
|
+
}
|
|
16708
|
+
],
|
|
16709
|
+
"usage": "both"
|
|
16710
|
+
},
|
|
15619
16711
|
"OrgBillSummary": {
|
|
15620
16712
|
"document": "企业套餐余额情况",
|
|
15621
16713
|
"members": [
|
|
@@ -15725,7 +16817,7 @@
|
|
|
15725
16817
|
{
|
|
15726
16818
|
"disabled": false,
|
|
15727
16819
|
"document": "组织机构企业统一社会信用代码。\n请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。",
|
|
15728
|
-
"example": "
|
|
16820
|
+
"example": "370000****0303000X",
|
|
15729
16821
|
"member": "string",
|
|
15730
16822
|
"name": "UniformSocialCreditCode",
|
|
15731
16823
|
"output_required": false,
|
|
@@ -15758,7 +16850,7 @@
|
|
|
15758
16850
|
{
|
|
15759
16851
|
"disabled": false,
|
|
15760
16852
|
"document": "组织机构法人的证件号码",
|
|
15761
|
-
"example": "
|
|
16853
|
+
"example": "370000****0303000X",
|
|
15762
16854
|
"member": "string",
|
|
15763
16855
|
"name": "LegalIdCardNumber",
|
|
15764
16856
|
"output_required": false,
|
|
@@ -15780,7 +16872,7 @@
|
|
|
15780
16872
|
{
|
|
15781
16873
|
"disabled": false,
|
|
15782
16874
|
"document": "组织机构超管手机号。\n",
|
|
15783
|
-
"example": "
|
|
16875
|
+
"example": "1888****888",
|
|
15784
16876
|
"member": "string",
|
|
15785
16877
|
"name": "AdminMobile",
|
|
15786
16878
|
"output_required": false,
|
|
@@ -15802,7 +16894,7 @@
|
|
|
15802
16894
|
{
|
|
15803
16895
|
"disabled": false,
|
|
15804
16896
|
"document": "组织机构超管证件号码\n",
|
|
15805
|
-
"example": "
|
|
16897
|
+
"example": "370000****0303000X",
|
|
15806
16898
|
"member": "string",
|
|
15807
16899
|
"name": "AdminIdCardNumber",
|
|
15808
16900
|
"output_required": false,
|
|
@@ -15824,7 +16916,7 @@
|
|
|
15824
16916
|
{
|
|
15825
16917
|
"disabled": false,
|
|
15826
16918
|
"document": "原超管手机号",
|
|
15827
|
-
"example": "
|
|
16919
|
+
"example": "1510****000",
|
|
15828
16920
|
"member": "string",
|
|
15829
16921
|
"name": "OldAdminMobile",
|
|
15830
16922
|
"output_required": false,
|
|
@@ -15846,7 +16938,7 @@
|
|
|
15846
16938
|
{
|
|
15847
16939
|
"disabled": false,
|
|
15848
16940
|
"document": "原超管证件号码",
|
|
15849
|
-
"example": "
|
|
16941
|
+
"example": "650000****0404000X",
|
|
15850
16942
|
"member": "string",
|
|
15851
16943
|
"name": "OldAdminIdCardNumber",
|
|
15852
16944
|
"output_required": false,
|
|
@@ -16007,7 +17099,7 @@
|
|
|
16007
17099
|
{
|
|
16008
17100
|
"disabled": false,
|
|
16009
17101
|
"document": "审查依据",
|
|
16010
|
-
"example": "
|
|
17102
|
+
"example": "通用商业合同审查清单{特殊类型合同补充要点}, 系统审查要求。",
|
|
16011
17103
|
"member": "string",
|
|
16012
17104
|
"name": "RiskBasis",
|
|
16013
17105
|
"output_required": false,
|
|
@@ -16678,7 +17770,7 @@
|
|
|
16678
17770
|
"members": [
|
|
16679
17771
|
{
|
|
16680
17772
|
"disabled": false,
|
|
16681
|
-
"document": "
|
|
17773
|
+
"document": "法人姓名",
|
|
16682
17774
|
"example": "张三",
|
|
16683
17775
|
"member": "string",
|
|
16684
17776
|
"name": "LegalName",
|
|
@@ -16700,7 +17792,7 @@
|
|
|
16700
17792
|
},
|
|
16701
17793
|
{
|
|
16702
17794
|
"disabled": false,
|
|
16703
|
-
"document": "
|
|
17795
|
+
"document": "社会统一信用代码",
|
|
16704
17796
|
"example": "91110108772551611J",
|
|
16705
17797
|
"member": "string",
|
|
16706
17798
|
"name": "UnifiedSocialCreditCode",
|
|
@@ -16865,7 +17957,7 @@
|
|
|
16865
17957
|
{
|
|
16866
17958
|
"disabled": false,
|
|
16867
17959
|
"document": "签署人手机号。",
|
|
16868
|
-
"example": "
|
|
17960
|
+
"example": "1320****000",
|
|
16869
17961
|
"member": "string",
|
|
16870
17962
|
"name": "Mobile",
|
|
16871
17963
|
"required": true,
|
|
@@ -16874,7 +17966,7 @@
|
|
|
16874
17966
|
{
|
|
16875
17967
|
"disabled": true,
|
|
16876
17968
|
"document": "要更换的原合同参与人RecipientId编号。(可通过接口<a href=\"https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/\">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>",
|
|
16877
|
-
"example": "
|
|
17969
|
+
"example": "1",
|
|
16878
17970
|
"member": "string",
|
|
16879
17971
|
"name": "RelievedApproverReceiptId",
|
|
16880
17972
|
"required": false,
|
|
@@ -17282,6 +18374,100 @@
|
|
|
17282
18374
|
],
|
|
17283
18375
|
"usage": "out"
|
|
17284
18376
|
},
|
|
18377
|
+
"SingleSignOnEmployees": {
|
|
18378
|
+
"document": "单点登录企业员工信息。",
|
|
18379
|
+
"members": [
|
|
18380
|
+
{
|
|
18381
|
+
"disabled": false,
|
|
18382
|
+
"document": "用户在idp分配的唯一值,需要保持跟在电子签应用集成->单点登录配置->端点配置中配置的。\n如下图配置。",
|
|
18383
|
+
"example": "jO9PmCBpse8R4maF4sYzTNNNddyioonBEseA70z",
|
|
18384
|
+
"member": "string",
|
|
18385
|
+
"name": "OpenId",
|
|
18386
|
+
"output_required": true,
|
|
18387
|
+
"required": true,
|
|
18388
|
+
"type": "string",
|
|
18389
|
+
"value_allowed_null": false
|
|
18390
|
+
},
|
|
18391
|
+
{
|
|
18392
|
+
"disabled": false,
|
|
18393
|
+
"document": "企业员工姓名。 员工的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\t",
|
|
18394
|
+
"example": "典子谦",
|
|
18395
|
+
"member": "string",
|
|
18396
|
+
"name": "Name",
|
|
18397
|
+
"output_required": false,
|
|
18398
|
+
"required": true,
|
|
18399
|
+
"type": "string",
|
|
18400
|
+
"value_allowed_null": false
|
|
18401
|
+
},
|
|
18402
|
+
{
|
|
18403
|
+
"disabled": false,
|
|
18404
|
+
"document": "用户手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。",
|
|
18405
|
+
"example": "18888888888",
|
|
18406
|
+
"member": "string",
|
|
18407
|
+
"name": "Mobile",
|
|
18408
|
+
"output_required": false,
|
|
18409
|
+
"required": true,
|
|
18410
|
+
"type": "string",
|
|
18411
|
+
"value_allowed_null": false
|
|
18412
|
+
},
|
|
18413
|
+
{
|
|
18414
|
+
"disabled": false,
|
|
18415
|
+
"document": "员工在腾讯电子签平台的唯一身份标识,为32位字符串。\n注:`创建和更新场景无需填写。`",
|
|
18416
|
+
"example": "查询企业角色列表",
|
|
18417
|
+
"member": "string",
|
|
18418
|
+
"name": "UserId",
|
|
18419
|
+
"output_required": false,
|
|
18420
|
+
"required": false,
|
|
18421
|
+
"type": "string",
|
|
18422
|
+
"value_allowed_null": false
|
|
18423
|
+
},
|
|
18424
|
+
{
|
|
18425
|
+
"disabled": false,
|
|
18426
|
+
"document": "用户邮箱。",
|
|
18427
|
+
"example": "abc@def.com",
|
|
18428
|
+
"member": "string",
|
|
18429
|
+
"name": "Email",
|
|
18430
|
+
"output_required": false,
|
|
18431
|
+
"required": false,
|
|
18432
|
+
"type": "string",
|
|
18433
|
+
"value_allowed_null": false
|
|
18434
|
+
},
|
|
18435
|
+
{
|
|
18436
|
+
"disabled": false,
|
|
18437
|
+
"document": "员工角色信息。\n此处roleId为电子签配置的 RoleId,可通过接口[查询企业角色列表](https://qian.tencent.com/developers/companyApis/roles/DescribeIntegrationRoles) 获取",
|
|
18438
|
+
"example": "[\"d2865fec7e498905f95eb1d8f147f972\"]",
|
|
18439
|
+
"member": "string",
|
|
18440
|
+
"name": "RoleIds",
|
|
18441
|
+
"output_required": false,
|
|
18442
|
+
"required": false,
|
|
18443
|
+
"type": "list",
|
|
18444
|
+
"value_allowed_null": false
|
|
18445
|
+
},
|
|
18446
|
+
{
|
|
18447
|
+
"disabled": false,
|
|
18448
|
+
"document": "员工是否实名。",
|
|
18449
|
+
"example": "true",
|
|
18450
|
+
"member": "bool",
|
|
18451
|
+
"name": "IsVerified",
|
|
18452
|
+
"output_required": false,
|
|
18453
|
+
"required": false,
|
|
18454
|
+
"type": "bool",
|
|
18455
|
+
"value_allowed_null": false
|
|
18456
|
+
},
|
|
18457
|
+
{
|
|
18458
|
+
"disabled": false,
|
|
18459
|
+
"document": "员工创建时间戳,单位秒。",
|
|
18460
|
+
"example": "1758685647",
|
|
18461
|
+
"member": "int64",
|
|
18462
|
+
"name": "CreatedOn",
|
|
18463
|
+
"output_required": false,
|
|
18464
|
+
"required": false,
|
|
18465
|
+
"type": "int",
|
|
18466
|
+
"value_allowed_null": false
|
|
18467
|
+
}
|
|
18468
|
+
],
|
|
18469
|
+
"usage": "both"
|
|
18470
|
+
},
|
|
17285
18471
|
"Staff": {
|
|
17286
18472
|
"document": "企业员工信息。",
|
|
17287
18473
|
"members": [
|
|
@@ -17309,8 +18495,8 @@
|
|
|
17309
18495
|
},
|
|
17310
18496
|
{
|
|
17311
18497
|
"disabled": false,
|
|
17312
|
-
"document": "用户手机号码,
|
|
17313
|
-
"example": "
|
|
18498
|
+
"document": "用户手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。",
|
|
18499
|
+
"example": "1320****000",
|
|
17314
18500
|
"member": "string",
|
|
17315
18501
|
"name": "Mobile",
|
|
17316
18502
|
"output_required": true,
|
|
@@ -17713,7 +18899,7 @@
|
|
|
17713
18899
|
{
|
|
17714
18900
|
"disabled": false,
|
|
17715
18901
|
"document": "传入的手机号,没有打码",
|
|
17716
|
-
"example": "
|
|
18902
|
+
"example": "1320****000",
|
|
17717
18903
|
"member": "string",
|
|
17718
18904
|
"name": "Mobile",
|
|
17719
18905
|
"output_required": true,
|
|
@@ -17743,6 +18929,34 @@
|
|
|
17743
18929
|
],
|
|
17744
18930
|
"usage": "out"
|
|
17745
18931
|
},
|
|
18932
|
+
"Tag": {
|
|
18933
|
+
"document": "标签",
|
|
18934
|
+
"members": [
|
|
18935
|
+
{
|
|
18936
|
+
"disabled": false,
|
|
18937
|
+
"document": "标签键,最大长度不超过50字符。",
|
|
18938
|
+
"example": "Key",
|
|
18939
|
+
"member": "string",
|
|
18940
|
+
"name": "TagKey",
|
|
18941
|
+
"output_required": false,
|
|
18942
|
+
"required": false,
|
|
18943
|
+
"type": "string",
|
|
18944
|
+
"value_allowed_null": false
|
|
18945
|
+
},
|
|
18946
|
+
{
|
|
18947
|
+
"disabled": false,
|
|
18948
|
+
"document": "标签值,最大长度不超过50字符。",
|
|
18949
|
+
"example": "Value",
|
|
18950
|
+
"member": "string",
|
|
18951
|
+
"name": "TagValue",
|
|
18952
|
+
"output_required": false,
|
|
18953
|
+
"required": false,
|
|
18954
|
+
"type": "string",
|
|
18955
|
+
"value_allowed_null": false
|
|
18956
|
+
}
|
|
18957
|
+
],
|
|
18958
|
+
"usage": "both"
|
|
18959
|
+
},
|
|
17746
18960
|
"TemplateInfo": {
|
|
17747
18961
|
"document": "此结构体 (TemplateInfo) 用于描述模板的信息。\n\n> **模板组成** \n>\n> 一个模板通常会包含以下结构信息\n>- 模板基本信息\n>- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方\n>- 填写控件 Components\n>- 签署控件 SignComponents\n>- 生成模板的文件基础信息 FileInfos",
|
|
17748
18962
|
"members": [
|
|
@@ -18025,7 +19239,7 @@
|
|
|
18025
19239
|
"usage": "both"
|
|
18026
19240
|
},
|
|
18027
19241
|
"TemplateUserFlowType": {
|
|
18028
|
-
"document": "
|
|
19242
|
+
"document": "模板对应的合同类型",
|
|
18029
19243
|
"members": [
|
|
18030
19244
|
{
|
|
18031
19245
|
"disabled": false,
|
|
@@ -18062,7 +19276,7 @@
|
|
|
18062
19276
|
},
|
|
18063
19277
|
{
|
|
18064
19278
|
"disabled": false,
|
|
18065
|
-
"document": "
|
|
19279
|
+
"document": "每个合同类型绑定的模板数量",
|
|
18066
19280
|
"example": "10",
|
|
18067
19281
|
"member": "int64",
|
|
18068
19282
|
"name": "TemplateNum",
|
|
@@ -18555,7 +19769,7 @@
|
|
|
18555
19769
|
},
|
|
18556
19770
|
{
|
|
18557
19771
|
"disabled": false,
|
|
18558
|
-
"document": "验签序列号, 为11
|
|
19772
|
+
"document": "验签序列号, 为11位数字组成的字符串",
|
|
18559
19773
|
"example": "17364056473214",
|
|
18560
19774
|
"member": "string",
|
|
18561
19775
|
"name": "VerifySerialNo",
|
|
@@ -18773,6 +19987,45 @@
|
|
|
18773
19987
|
}
|
|
18774
19988
|
],
|
|
18775
19989
|
"usage": "in"
|
|
19990
|
+
},
|
|
19991
|
+
"WebUrlOption": {
|
|
19992
|
+
"document": "提取web嵌入页面个性化设置",
|
|
19993
|
+
"members": [
|
|
19994
|
+
{
|
|
19995
|
+
"disabled": false,
|
|
19996
|
+
"document": "禁用链接预览",
|
|
19997
|
+
"example": "false",
|
|
19998
|
+
"member": "bool",
|
|
19999
|
+
"name": "DisableLinkPreview",
|
|
20000
|
+
"output_required": false,
|
|
20001
|
+
"required": false,
|
|
20002
|
+
"type": "bool",
|
|
20003
|
+
"value_allowed_null": false
|
|
20004
|
+
},
|
|
20005
|
+
{
|
|
20006
|
+
"disabled": false,
|
|
20007
|
+
"document": "禁用任务编辑",
|
|
20008
|
+
"example": "false",
|
|
20009
|
+
"member": "bool",
|
|
20010
|
+
"name": "DisableTaskEditing",
|
|
20011
|
+
"output_required": false,
|
|
20012
|
+
"required": false,
|
|
20013
|
+
"type": "bool",
|
|
20014
|
+
"value_allowed_null": false
|
|
20015
|
+
},
|
|
20016
|
+
{
|
|
20017
|
+
"disabled": false,
|
|
20018
|
+
"document": "禁用任务结果编辑",
|
|
20019
|
+
"example": "false",
|
|
20020
|
+
"member": "bool",
|
|
20021
|
+
"name": "DisableTaskResultEditing",
|
|
20022
|
+
"output_required": false,
|
|
20023
|
+
"required": false,
|
|
20024
|
+
"type": "bool",
|
|
20025
|
+
"value_allowed_null": false
|
|
20026
|
+
}
|
|
20027
|
+
],
|
|
20028
|
+
"usage": "both"
|
|
18776
20029
|
}
|
|
18777
20030
|
},
|
|
18778
20031
|
"version": "1.0"
|