tccli 3.0.1248.1__py2.py3-none-any.whl → 3.0.1250.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/aiart/aiart_client.py +113 -7
- tccli/services/aiart/v20221229/api.json +191 -0
- tccli/services/aiart/v20221229/examples.json +16 -0
- tccli/services/batch/v20170312/api.json +1 -1
- tccli/services/cbs/v20170312/api.json +6 -0
- tccli/services/cdb/v20170320/api.json +9 -0
- tccli/services/cfw/v20190904/api.json +5 -3
- tccli/services/cmq/cmq_client.py +4 -799
- tccli/services/cmq/v20190304/api.json +135 -1329
- tccli/services/cmq/v20190304/examples.json +0 -120
- tccli/services/config/config_client.py +110 -4
- tccli/services/config/v20220802/api.json +374 -0
- tccli/services/config/v20220802/examples.json +16 -0
- tccli/services/cvm/v20170312/api.json +1 -1
- tccli/services/dc/v20180410/api.json +50 -48
- tccli/services/dc/v20180410/examples.json +8 -8
- tccli/services/ecm/v20190719/api.json +64 -62
- tccli/services/ecm/v20190719/examples.json +5 -5
- tccli/services/es/v20180416/api.json +10 -0
- tccli/services/ess/v20201111/api.json +163 -163
- tccli/services/ess/v20201111/examples.json +15 -21
- tccli/services/essbasic/v20210526/api.json +89 -89
- tccli/services/essbasic/v20210526/examples.json +2 -2
- tccli/services/hai/hai_client.py +60 -7
- tccli/services/hai/v20230812/api.json +195 -0
- tccli/services/hai/v20230812/examples.json +8 -0
- tccli/services/iotexplorer/iotexplorer_client.py +228 -16
- tccli/services/iotexplorer/v20190423/api.json +536 -0
- tccli/services/iotexplorer/v20190423/examples.json +32 -0
- tccli/services/iotvideo/iotvideo_client.py +53 -0
- tccli/services/iotvideo/v20211125/api.json +80 -0
- tccli/services/iotvideo/v20211125/examples.json +8 -0
- tccli/services/lkeap/v20240522/api.json +13 -13
- tccli/services/lkeap/v20240522/examples.json +2 -2
- tccli/services/mna/v20210119/api.json +24 -24
- tccli/services/mna/v20210119/examples.json +2 -2
- tccli/services/redis/v20180412/api.json +181 -181
- tccli/services/redis/v20180412/examples.json +1 -1
- tccli/services/sms/v20190711/api.json +48 -0
- tccli/services/sms/v20210111/api.json +48 -0
- tccli/services/tcb/v20180608/api.json +173 -145
- tccli/services/tcb/v20180608/examples.json +8 -8
- tccli/services/tcr/v20190924/api.json +5 -5
- tccli/services/tke/v20220501/api.json +1 -1
- tccli/services/trro/v20220325/api.json +71 -61
- tccli/services/trro/v20220325/examples.json +1 -1
- tccli/services/trtc/v20190722/api.json +114 -114
- tccli/services/tse/v20201207/api.json +18 -0
- tccli/services/vpc/v20170312/api.json +35 -33
- tccli/services/vpc/v20170312/examples.json +18 -18
- tccli/services/wedata/v20210820/api.json +80 -2
- tccli/services/wedata/v20210820/examples.json +1 -1
- {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/RECORD +58 -58
- {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/license_files/LICENSE +0 -0
@@ -1663,7 +1663,7 @@
|
|
1663
1663
|
{
|
1664
1664
|
"disabled": false,
|
1665
1665
|
"document": "要撤销的合同流程ID列表,最多100个,超过100不处理",
|
1666
|
-
"example": "
|
1666
|
+
"example": "[\"yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw\"]",
|
1667
1667
|
"member": "string",
|
1668
1668
|
"name": "FlowIds",
|
1669
1669
|
"required": true,
|
@@ -1697,7 +1697,7 @@
|
|
1697
1697
|
{
|
1698
1698
|
"disabled": false,
|
1699
1699
|
"document": "与入参的FlowIds数组一致, 成功生成到撤销链接中,则为\"\", 不能撤销合同则为失败原因",
|
1700
|
-
"example": "
|
1700
|
+
"example": "因为\"xxx\"撤销失败",
|
1701
1701
|
"member": "string",
|
1702
1702
|
"name": "FailMessages",
|
1703
1703
|
"output_required": true,
|
@@ -1717,7 +1717,7 @@
|
|
1717
1717
|
{
|
1718
1718
|
"disabled": false,
|
1719
1719
|
"document": "批量撤销任务编号,为32位字符串,可用于[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)",
|
1720
|
-
"example": "
|
1720
|
+
"example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84",
|
1721
1721
|
"member": "string",
|
1722
1722
|
"name": "TaskId",
|
1723
1723
|
"output_required": true,
|
@@ -1757,7 +1757,7 @@
|
|
1757
1757
|
{
|
1758
1758
|
"disabled": false,
|
1759
1759
|
"document": "批量签署的合同流程ID数组。\n注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`",
|
1760
|
-
"example": "
|
1760
|
+
"example": "[\"yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E\"]",
|
1761
1761
|
"member": "string",
|
1762
1762
|
"name": "FlowIds",
|
1763
1763
|
"required": false,
|
@@ -1775,7 +1775,7 @@
|
|
1775
1775
|
{
|
1776
1776
|
"disabled": false,
|
1777
1777
|
"document": "签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)",
|
1778
|
-
"example": "
|
1778
|
+
"example": "https://YOUR_CUSTOM_URL/xxxx",
|
1779
1779
|
"member": "string",
|
1780
1780
|
"name": "JumpUrl",
|
1781
1781
|
"required": false,
|
@@ -1829,7 +1829,7 @@
|
|
1829
1829
|
{
|
1830
1830
|
"disabled": false,
|
1831
1831
|
"document": "缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。\n\n注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`",
|
1832
|
-
"example": "
|
1832
|
+
"example": "false",
|
1833
1833
|
"member": "bool",
|
1834
1834
|
"name": "CacheApproverInfo",
|
1835
1835
|
"required": false,
|
@@ -1875,7 +1875,7 @@
|
|
1875
1875
|
{
|
1876
1876
|
"disabled": false,
|
1877
1877
|
"document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n注:`请确保和合同中填入的一致`,`除动态签署人或子客员工经办人场景外,此参数必填`",
|
1878
|
-
"example": "
|
1878
|
+
"example": "真实姓名",
|
1879
1879
|
"member": "string",
|
1880
1880
|
"name": "Name",
|
1881
1881
|
"required": false,
|
@@ -1884,7 +1884,7 @@
|
|
1884
1884
|
{
|
1885
1885
|
"disabled": false,
|
1886
1886
|
"document": "手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`,`除动态签署人或子客员工经办人场景外,此参数必填`",
|
1887
|
-
"example": "
|
1887
|
+
"example": "187****9829",
|
1888
1888
|
"member": "string",
|
1889
1889
|
"name": "Mobile",
|
1890
1890
|
"required": false,
|
@@ -1902,7 +1902,7 @@
|
|
1902
1902
|
{
|
1903
1903
|
"disabled": false,
|
1904
1904
|
"document": "证件类型,支持以下类型\n<ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>\n<li>**HONGKONG_AND_MACAO** : 中国港澳居民来往内地通行证</li>\n<li>**HONGKONG_MACAO_AND_TAIWAN** : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
|
1905
|
-
"example": "
|
1905
|
+
"example": "ID_CARD",
|
1906
1906
|
"member": "string",
|
1907
1907
|
"name": "IdCardType",
|
1908
1908
|
"required": false,
|
@@ -1911,7 +1911,7 @@
|
|
1911
1911
|
{
|
1912
1912
|
"disabled": false,
|
1913
1913
|
"document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`请确保和合同中填入的一致`",
|
1914
|
-
"example": "
|
1914
|
+
"example": "421049****8749",
|
1915
1915
|
"member": "string",
|
1916
1916
|
"name": "IdCardNumber",
|
1917
1917
|
"required": false,
|
@@ -1920,7 +1920,7 @@
|
|
1920
1920
|
{
|
1921
1921
|
"disabled": false,
|
1922
1922
|
"document": "通知用户方式:\n<ul>\n<li>**NONE** : 不通知(默认)</li>\n<li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li>\n</ul>",
|
1923
|
-
"example": "
|
1923
|
+
"example": "SMS",
|
1924
1924
|
"member": "string",
|
1925
1925
|
"name": "NotifyType",
|
1926
1926
|
"required": false,
|
@@ -1929,7 +1929,7 @@
|
|
1929
1929
|
{
|
1930
1930
|
"disabled": false,
|
1931
1931
|
"document": "批量签署的合同流程ID数组。\n注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`",
|
1932
|
-
"example": "
|
1932
|
+
"example": "[\"yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E\"]",
|
1933
1933
|
"member": "string",
|
1934
1934
|
"name": "FlowIds",
|
1935
1935
|
"required": false,
|
@@ -1938,7 +1938,7 @@
|
|
1938
1938
|
{
|
1939
1939
|
"disabled": false,
|
1940
1940
|
"document": "SaaS平台企业员工签署方的企业名称。目标签署人如果为saas应用企业员工身份,此参数必填。\n\n注:\n<ul>\n<li>请确认该名称与企业营业执照中注册的名称一致。</li>\n<li>如果名称中包含英文括号(),请使用中文括号()代替。</li>\n<li>请确保此企业已完成腾讯电子签企业认证。</li>\n<li>**若为子客企业员工,请使用OpenId,OrganizationOpenId参数,此参数留空即可**</li>\n</ul>",
|
1941
|
-
"example": "
|
1941
|
+
"example": "企业名称",
|
1942
1942
|
"member": "string",
|
1943
1943
|
"name": "OrganizationName",
|
1944
1944
|
"required": false,
|
@@ -1947,7 +1947,7 @@
|
|
1947
1947
|
{
|
1948
1948
|
"disabled": false,
|
1949
1949
|
"document": "是否直接跳转至合同内容页面进行签署\n<ul>\n<li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>\n<li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>\n</ul>",
|
1950
|
-
"example": "
|
1950
|
+
"example": "false",
|
1951
1951
|
"member": "bool",
|
1952
1952
|
"name": "JumpToDetail",
|
1953
1953
|
"required": false,
|
@@ -1965,7 +1965,7 @@
|
|
1965
1965
|
{
|
1966
1966
|
"disabled": false,
|
1967
1967
|
"document": "第三方平台子客企业员工的标识OpenId,批签合同经办人为子客员工的情况下为必填。\n\n注:\n<ul>\n<li>传入的OpenId对应员工在此子客企业下必须已经实名</li>\n<li>传递了此参数可以无需传递Name,Mobile,IdCardNumber,IdCardType参数。系统会根据员工OpenId自动拉取实名信息。</li>\n</ul>",
|
1968
|
-
"example": "
|
1968
|
+
"example": "openid_1",
|
1969
1969
|
"member": "string",
|
1970
1970
|
"name": "OpenId",
|
1971
1971
|
"required": false,
|
@@ -1974,7 +1974,7 @@
|
|
1974
1974
|
{
|
1975
1975
|
"disabled": false,
|
1976
1976
|
"document": "第三方平台子客企业的企业的标识, 即OrganizationOpenId,批签合同经办人为子客企业员工是为必填。",
|
1977
|
-
"example": "
|
1977
|
+
"example": "orgopenid_1",
|
1978
1978
|
"member": "string",
|
1979
1979
|
"name": "OrganizationOpenId",
|
1980
1980
|
"required": false,
|
@@ -1992,7 +1992,7 @@
|
|
1992
1992
|
{
|
1993
1993
|
"disabled": false,
|
1994
1994
|
"document": "<font color=\"red\">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。 \n\n参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。",
|
1995
|
-
"example": "
|
1995
|
+
"example": "WeChatOfficialAccounts",
|
1996
1996
|
"member": "string",
|
1997
1997
|
"name": "UrlUseEnv",
|
1998
1998
|
"required": false,
|
@@ -2007,7 +2007,7 @@
|
|
2007
2007
|
{
|
2008
2008
|
"disabled": false,
|
2009
2009
|
"document": "批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。\n\n注: \n1. 非小程序和APP集成使用\n2. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
|
2010
|
-
"example": "
|
2010
|
+
"example": "https://essurl.cn/Rg0**Q",
|
2011
2011
|
"member": "string",
|
2012
2012
|
"name": "SignUrl",
|
2013
2013
|
"output_required": true,
|
@@ -2017,7 +2017,7 @@
|
|
2017
2017
|
{
|
2018
2018
|
"disabled": false,
|
2019
2019
|
"document": "链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。",
|
2020
|
-
"example": "
|
2020
|
+
"example": "1736415329",
|
2021
2021
|
"member": "int64",
|
2022
2022
|
"name": "ExpiredTime",
|
2023
2023
|
"output_required": true,
|
@@ -2027,7 +2027,7 @@
|
|
2027
2027
|
{
|
2028
2028
|
"disabled": false,
|
2029
2029
|
"document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径\n\n注: \n1. 小程序和APP集成使用\n2. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
|
2030
|
-
"example": "
|
2030
|
+
"example": "pages/guide/index?shortKey=FuP3**wc",
|
2031
2031
|
"member": "string",
|
2032
2032
|
"name": "MiniAppPath",
|
2033
2033
|
"output_required": true,
|
@@ -2058,7 +2058,7 @@
|
|
2058
2058
|
{
|
2059
2059
|
"disabled": false,
|
2060
2060
|
"document": "需要领取的合同流程的ID列表",
|
2061
|
-
"example": "
|
2061
|
+
"example": "[\"yDSxWUUckptu4clgUuLlo0OwJKbYCO48\"]",
|
2062
2062
|
"member": "string",
|
2063
2063
|
"name": "FlowIds",
|
2064
2064
|
"required": false,
|
@@ -2291,7 +2291,7 @@
|
|
2291
2291
|
{
|
2292
2292
|
"disabled": false,
|
2293
2293
|
"document": "嵌入的web链接,5分钟有效",
|
2294
|
-
"example": "
|
2294
|
+
"example": "https://test.ess.com/seal-create?embed=1&code=testcode&channel=PROXYCHANNEL",
|
2295
2295
|
"member": "string",
|
2296
2296
|
"name": "WebUrl",
|
2297
2297
|
"output_required": true,
|
@@ -2331,7 +2331,7 @@
|
|
2331
2331
|
{
|
2332
2332
|
"disabled": false,
|
2333
2333
|
"document": "合同流程ID,为32位字符串。 \n- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n- 可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。\n- <font color=\"red\">不建议继续使用</font>,请使用<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId指定合同",
|
2334
|
-
"example": "
|
2334
|
+
"example": "yDCZHUUnitvronUuNTdBrElW0gOVqCfy",
|
2335
2335
|
"member": "string",
|
2336
2336
|
"name": "FlowId",
|
2337
2337
|
"required": false,
|
@@ -2340,7 +2340,7 @@
|
|
2340
2340
|
{
|
2341
2341
|
"disabled": false,
|
2342
2342
|
"document": "签署人信息补充方式\n\n<ul><li>**1**: 表示往未指定签署人的节点,添加一个明确的签署人,支持企业或个人签署方。</li></ul>",
|
2343
|
-
"example": "
|
2343
|
+
"example": "1",
|
2344
2344
|
"member": "int64",
|
2345
2345
|
"name": "FillApproverType",
|
2346
2346
|
"required": false,
|
@@ -2372,13 +2372,13 @@
|
|
2372
2372
|
"members": [
|
2373
2373
|
{
|
2374
2374
|
"disabled": false,
|
2375
|
-
"document": "批量补充签署人时,补充失败的报错说明 \n注:`目前仅补充动态签署人时会返回补充失败的原因`\t
|
2375
|
+
"document": "批量补充签署人时,补充失败的报错说明 \n注:`目前仅补充动态签署人时会返回补充失败的原因`\t",
|
2376
2376
|
"example": "无",
|
2377
2377
|
"member": "FillError",
|
2378
2378
|
"name": "FillError",
|
2379
2379
|
"output_required": false,
|
2380
2380
|
"type": "list",
|
2381
|
-
"value_allowed_null":
|
2381
|
+
"value_allowed_null": false
|
2382
2382
|
},
|
2383
2383
|
{
|
2384
2384
|
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
@@ -2503,7 +2503,7 @@
|
|
2503
2503
|
{
|
2504
2504
|
"disabled": false,
|
2505
2505
|
"document": "发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:\n<ul><li> **false**:(默认)不需要审批,直接签署。</li>\n<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>\n企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果\n<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>\n<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>\n注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`",
|
2506
|
-
"example": "
|
2506
|
+
"example": "false",
|
2507
2507
|
"member": "bool",
|
2508
2508
|
"name": "NeedSignReview",
|
2509
2509
|
"required": false,
|
@@ -2512,7 +2512,7 @@
|
|
2512
2512
|
{
|
2513
2513
|
"disabled": false,
|
2514
2514
|
"document": "签署人校验方式\nVerifyCheck: 人脸识别(默认)\nMobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)\n参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。",
|
2515
|
-
"example": "
|
2515
|
+
"example": "VerifyCheck",
|
2516
2516
|
"member": "string",
|
2517
2517
|
"name": "ApproverVerifyType",
|
2518
2518
|
"required": false,
|
@@ -2539,7 +2539,7 @@
|
|
2539
2539
|
{
|
2540
2540
|
"disabled": false,
|
2541
2541
|
"document": "可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:\n<ul><li> **0**:合同发起时通知(默认值)</li>\n<li> **1**:签署完成后通知</li></ul>",
|
2542
|
-
"example": "
|
2542
|
+
"example": "0",
|
2543
2543
|
"member": "int64",
|
2544
2544
|
"name": "CcNotifyType",
|
2545
2545
|
"required": false,
|
@@ -2616,23 +2616,23 @@
|
|
2616
2616
|
"members": [
|
2617
2617
|
{
|
2618
2618
|
"disabled": false,
|
2619
|
-
"document": "合同流程ID,为32位字符串。\n建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n\n[点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
|
2619
|
+
"document": "合同流程ID,为32位字符串。\n建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n\n[点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)",
|
2620
2620
|
"example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
|
2621
2621
|
"member": "string",
|
2622
2622
|
"name": "FlowId",
|
2623
2623
|
"output_required": true,
|
2624
2624
|
"type": "string",
|
2625
|
-
"value_allowed_null":
|
2625
|
+
"value_allowed_null": false
|
2626
2626
|
},
|
2627
2627
|
{
|
2628
2628
|
"disabled": false,
|
2629
|
-
"document": "签署方信息,如角色ID
|
2629
|
+
"document": "签署方信息,如角色ID、角色名称等",
|
2630
2630
|
"example": "无",
|
2631
2631
|
"member": "ApproverItem",
|
2632
2632
|
"name": "Approvers",
|
2633
2633
|
"output_required": false,
|
2634
2634
|
"type": "list",
|
2635
|
-
"value_allowed_null":
|
2635
|
+
"value_allowed_null": false
|
2636
2636
|
},
|
2637
2637
|
{
|
2638
2638
|
"disabled": false,
|
@@ -2686,7 +2686,7 @@
|
|
2686
2686
|
{
|
2687
2687
|
"disabled": false,
|
2688
2688
|
"document": "合同组中签署人校验和认证的方式:\n<ul><li>**VerifyCheck**:人脸识别(默认)</li>\n<li>**MobileCheck**:手机号验证</li></ul>\n注意:\n`1. MobileCheck 方式,未实名的个人/自然人签署方无需进行人脸识别实名认证即可查看合同(但签署合同时仍然需要人脸实名),企业签署方需经过人脸认证。`\n`2. 合同组的校验和认证的方式会优先使用,会覆盖合同组中单个合同和合同签署方认证方式的限制配置。`",
|
2689
|
-
"example": "
|
2689
|
+
"example": "VerifyCheck",
|
2690
2690
|
"member": "string",
|
2691
2691
|
"name": "ApproverVerifyType",
|
2692
2692
|
"required": false,
|
@@ -2718,23 +2718,23 @@
|
|
2718
2718
|
"members": [
|
2719
2719
|
{
|
2720
2720
|
"disabled": false,
|
2721
|
-
"document": "合同组ID,为32位字符串。\n建议开发者妥善保存此合同组ID
|
2721
|
+
"document": "合同组ID,为32位字符串。\n建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。",
|
2722
2722
|
"example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
|
2723
2723
|
"member": "string",
|
2724
2724
|
"name": "FlowGroupId",
|
2725
2725
|
"output_required": true,
|
2726
2726
|
"type": "string",
|
2727
|
-
"value_allowed_null":
|
2727
|
+
"value_allowed_null": false
|
2728
2728
|
},
|
2729
2729
|
{
|
2730
2730
|
"disabled": false,
|
2731
|
-
"document": "合同组中每个合同流程ID,每个ID均为32位字符串。\n\n注:\n`此数组的顺序和入参中的FlowGroupInfos
|
2731
|
+
"document": "合同组中每个合同流程ID,每个ID均为32位字符串。\n\n注:\n`此数组的顺序和入参中的FlowGroupInfos顺序一致`",
|
2732
2732
|
"example": "[\"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\"yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS\"]",
|
2733
2733
|
"member": "string",
|
2734
2734
|
"name": "FlowIds",
|
2735
2735
|
"output_required": true,
|
2736
2736
|
"type": "list",
|
2737
|
-
"value_allowed_null":
|
2737
|
+
"value_allowed_null": false
|
2738
2738
|
},
|
2739
2739
|
{
|
2740
2740
|
"disabled": false,
|
@@ -3904,7 +3904,7 @@
|
|
3904
3904
|
},
|
3905
3905
|
{
|
3906
3906
|
"disabled": false,
|
3907
|
-
"document": "
|
3907
|
+
"document": "是否通知开通方,通知类型:<ul><li>默认为不通知开通方</li><li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>",
|
3908
3908
|
"example": "无",
|
3909
3909
|
"member": "string",
|
3910
3910
|
"name": "NotifyType",
|
@@ -4776,7 +4776,7 @@
|
|
4776
4776
|
{
|
4777
4777
|
"disabled": false,
|
4778
4778
|
"document": "印章id,是否查询特定的印章(没有输入返回所有)\n\n注: `没有输入返回所有记录,最大返回100条。`",
|
4779
|
-
"example": "
|
4779
|
+
"example": "yDSxWUUckptu4clgUuLlo0OwJKbYCO48",
|
4780
4780
|
"member": "string",
|
4781
4781
|
"name": "SealId",
|
4782
4782
|
"required": false,
|
@@ -4785,7 +4785,7 @@
|
|
4785
4785
|
{
|
4786
4786
|
"disabled": false,
|
4787
4787
|
"document": "电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: 公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li><li>**LEGAL_PERSON_SEAL**: 法定代表人章;</li><li>**EMPLOYEE_QUALIFICATION_SEAL**: 员工执业章</li></ul>注: `1.为空时查询所有类型的印章。`",
|
4788
|
-
"example": "
|
4788
|
+
"example": "INVOICE",
|
4789
4789
|
"member": "string",
|
4790
4790
|
"name": "SealTypes",
|
4791
4791
|
"required": false,
|
@@ -4794,7 +4794,7 @@
|
|
4794
4794
|
{
|
4795
4795
|
"disabled": false,
|
4796
4796
|
"document": "\n需查询的印章状态列表。\n\n<ul> <li>空,()仅查询启用状态的印章;</li> <li><strong>ALL</strong>,查询所有状态的印章;</li> <li><strong>CHECKING</strong>,查询待审核的印章;</li> <li><strong>SUCCESS</strong>,查询启用状态的印章;</li> <li><strong>FAIL</strong>,查询印章审核拒绝的印章;</li> <li><strong>DISABLE</strong>,查询已停用的印章;</li> <li><strong>STOPPED</strong>,查询已终止的印章;</li> <li><strong>VOID</strong>,查询已作废的印章;</li> <li><strong>INVALID</strong>,查询已失效的印章。</li> </ul>",
|
4797
|
-
"example": "
|
4797
|
+
"example": "ALL",
|
4798
4798
|
"member": "string",
|
4799
4799
|
"name": "SealStatuses",
|
4800
4800
|
"required": false,
|
@@ -5028,7 +5028,7 @@
|
|
5028
5028
|
{
|
5029
5029
|
"disabled": false,
|
5030
5030
|
"document": "自动签使用的场景值, 可以选择的场景值如下:\n<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>",
|
5031
|
-
"example": "
|
5031
|
+
"example": "E_PRESCRIPTION_AUTO_SIGN",
|
5032
5032
|
"member": "string",
|
5033
5033
|
"name": "SceneKey",
|
5034
5034
|
"required": true,
|
@@ -5091,7 +5091,7 @@
|
|
5091
5091
|
{
|
5092
5092
|
"disabled": false,
|
5093
5093
|
"document": "设置用户开通自动签时是否绑定个人自动签账号许可。<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li><li>**1**: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul>",
|
5094
|
-
"example": "
|
5094
|
+
"example": "1",
|
5095
5095
|
"member": "int64",
|
5096
5096
|
"name": "LicenseType",
|
5097
5097
|
"output_required": false,
|
@@ -5101,7 +5101,7 @@
|
|
5101
5101
|
{
|
5102
5102
|
"disabled": false,
|
5103
5103
|
"document": "用户开通自动签指定使用的印章,为空则未设置印章,需重新进入开通链接设置印章。",
|
5104
|
-
"example": "
|
5104
|
+
"example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
|
5105
5105
|
"member": "string",
|
5106
5106
|
"name": "SealId",
|
5107
5107
|
"output_required": false,
|
@@ -5132,7 +5132,7 @@
|
|
5132
5132
|
{
|
5133
5133
|
"disabled": false,
|
5134
5134
|
"document": "自动签使用的场景值, 可以选择的场景值如下:\n<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>",
|
5135
|
-
"example": "
|
5135
|
+
"example": "E_PRESCRIPTION_AUTO_SIGN",
|
5136
5136
|
"member": "string",
|
5137
5137
|
"name": "SceneKey",
|
5138
5138
|
"required": true,
|
@@ -5186,7 +5186,7 @@
|
|
5186
5186
|
{
|
5187
5187
|
"disabled": false,
|
5188
5188
|
"document": "转换任务Id,通过接口<a href=\"https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>得到的转换任务id",
|
5189
|
-
"example": "
|
5189
|
+
"example": "yDwivUUckpo2v2bhUx8pIP8vBdA0hGSe",
|
5190
5190
|
"member": "string",
|
5191
5191
|
"name": "TaskId",
|
5192
5192
|
"required": true,
|
@@ -5219,7 +5219,7 @@
|
|
5219
5219
|
{
|
5220
5220
|
"disabled": false,
|
5221
5221
|
"document": "任务Id",
|
5222
|
-
"example": "
|
5222
|
+
"example": "yDwivUUckpo2v2bhUx8pIP8vBdA0hGSe",
|
5223
5223
|
"member": "string",
|
5224
5224
|
"name": "TaskId",
|
5225
5225
|
"output_required": true,
|
@@ -5229,7 +5229,7 @@
|
|
5229
5229
|
{
|
5230
5230
|
"disabled": false,
|
5231
5231
|
"document": "任务状态,需要关注的状态\n<ul><li>**0** :NeedTranform - 任务已提交</li>\n<li>**4** :Processing - 文档转换中</li>\n<li>**8** :TaskEnd - 任务处理完成</li>\n<li>**-2** :DownloadFailed - 下载失败</li>\n<li>**-6** :ProcessFailed - 转换失败</li>\n<li>**-13**:ProcessTimeout - 转换文件超时</li></ul>",
|
5232
|
-
"example": "
|
5232
|
+
"example": "0",
|
5233
5233
|
"member": "int64",
|
5234
5234
|
"name": "TaskStatus",
|
5235
5235
|
"output_required": true,
|
@@ -5239,7 +5239,7 @@
|
|
5239
5239
|
{
|
5240
5240
|
"disabled": false,
|
5241
5241
|
"document": "状态描述,需要关注的状态\n<ul><li> **NeedTranform** : 任务已提交</li>\n<li> **Processing** : 文档转换中</li>\n<li> **TaskEnd** : 任务处理完成</li>\n<li> **DownloadFailed** : 下载失败</li>\n<li> **ProcessFailed** : 转换失败</li>\n<li> **ProcessTimeout** : 转换文件超时</li></ul>",
|
5242
|
-
"example": "
|
5242
|
+
"example": "NeedTranform",
|
5243
5243
|
"member": "string",
|
5244
5244
|
"name": "TaskMessage",
|
5245
5245
|
"output_required": true,
|
@@ -5249,7 +5249,7 @@
|
|
5249
5249
|
{
|
5250
5250
|
"disabled": false,
|
5251
5251
|
"document": "资源Id(即FileId),用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)",
|
5252
|
-
"example": "
|
5252
|
+
"example": "yDCYyUU5v4h32uUEp5vIWRaloaz5mYuu",
|
5253
5253
|
"member": "string",
|
5254
5254
|
"name": "ResourceId",
|
5255
5255
|
"output_required": true,
|
@@ -5259,7 +5259,7 @@
|
|
5259
5259
|
{
|
5260
5260
|
"disabled": true,
|
5261
5261
|
"document": "预览文件Url,有效期30分钟 \n当前字段返回为空,发起的时候,将ResourceId 放入发起即可\n注意:此字段可能返回 null,表示取不到有效值。",
|
5262
|
-
"example": "
|
5262
|
+
"example": "http://xxx.com",
|
5263
5263
|
"member": "string",
|
5264
5264
|
"name": "PreviewUrl",
|
5265
5265
|
"output_required": true,
|
@@ -5290,7 +5290,7 @@
|
|
5290
5290
|
{
|
5291
5291
|
"disabled": false,
|
5292
5292
|
"document": "角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。",
|
5293
|
-
"example": "
|
5293
|
+
"example": "资料管理员",
|
5294
5294
|
"member": "string",
|
5295
5295
|
"name": "Name",
|
5296
5296
|
"required": true,
|
@@ -5299,7 +5299,7 @@
|
|
5299
5299
|
{
|
5300
5300
|
"disabled": false,
|
5301
5301
|
"document": "角色Id,可通过接口 ChannelDescribeRoles 查询获取",
|
5302
|
-
"example": "
|
5302
|
+
"example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
|
5303
5303
|
"member": "string",
|
5304
5304
|
"name": "RoleId",
|
5305
5305
|
"required": true,
|
@@ -5308,7 +5308,7 @@
|
|
5308
5308
|
{
|
5309
5309
|
"disabled": false,
|
5310
5310
|
"document": "角色描述,最大长度为50个字符",
|
5311
|
-
"example": "
|
5311
|
+
"example": "管理资料的角色",
|
5312
5312
|
"member": "string",
|
5313
5313
|
"name": "Description",
|
5314
5314
|
"required": false,
|
@@ -5485,7 +5485,7 @@
|
|
5485
5485
|
},
|
5486
5486
|
{
|
5487
5487
|
"disabled": false,
|
5488
|
-
"document": "
|
5488
|
+
"document": "账号到期时间,时间戳",
|
5489
5489
|
"example": "无",
|
5490
5490
|
"member": "int64",
|
5491
5491
|
"name": "LicenseExpireTime",
|
@@ -7309,7 +7309,7 @@
|
|
7309
7309
|
},
|
7310
7310
|
{
|
7311
7311
|
"disabled": false,
|
7312
|
-
"document": "合同预览链接URL数组。\n\n注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL",
|
7312
|
+
"document": "合同预览链接URL数组。\n\n注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL\n如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过[合同文档合成完成回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)获取或使用返回的TaskInfo中的TaskId通过[查询转换任务状态\n](https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi)接口查询得到",
|
7313
7313
|
"example": "[\"https://test.ess.tencent.cn/document-url-preview?channel=PROXYCHANNEL&scene=SINGLEPAGE&code=yDwqoUUcKny&codeType=QUICK&businessType=RESOURCE&businessId=yDwqcUUck\"]",
|
7314
7314
|
"member": "string",
|
7315
7315
|
"name": "PreviewUrls",
|
@@ -8365,7 +8365,7 @@
|
|
8365
8365
|
{
|
8366
8366
|
"disabled": false,
|
8367
8367
|
"document": "该字段是指第三方平台子客企业的唯一标识,用于查询单独某个子客的企业数据。\n\n**注**:`如果需要批量查询本应用下的所有企业的信息,则该字段不需要赋值`",
|
8368
|
-
"example": "
|
8368
|
+
"example": "OrganizationOpenId_1",
|
8369
8369
|
"member": "string",
|
8370
8370
|
"name": "OrganizationOpenId",
|
8371
8371
|
"required": false,
|
@@ -8374,7 +8374,7 @@
|
|
8374
8374
|
{
|
8375
8375
|
"disabled": false,
|
8376
8376
|
"document": "可以按照当前企业的认证状态进行过滤。可值如下:\n<ul><li>**\"UNVERIFIED\"**: 未认证的企业</li>\n <li>**\"VERIFYINGLEGALPENDINGAUTHORIZATION\"**: 认证中待法人授权的企业</li>\n <li>**\"VERIFYINGAUTHORIZATIONFILEPENDING\"**: 认证中授权书审核中的企业</li>\n <li>**\"VERIFYINGAUTHORIZATIONFILEREJECT\"**: 认证中授权书已驳回的企业</li>\n <li>**\"VERIFYING\"**: 认证进行中的企业</li>\n <li>**\"VERIFIED\"**: 已认证完成的企业</li></ul>",
|
8377
|
-
"example": "
|
8377
|
+
"example": "UNVERIFIED",
|
8378
8378
|
"member": "string",
|
8379
8379
|
"name": "AuthorizationStatusList",
|
8380
8380
|
"required": false,
|
@@ -8408,7 +8408,7 @@
|
|
8408
8408
|
{
|
8409
8409
|
"disabled": false,
|
8410
8410
|
"document": "指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000。",
|
8411
|
-
"example": "
|
8411
|
+
"example": "0",
|
8412
8412
|
"member": "int64",
|
8413
8413
|
"name": "Offset",
|
8414
8414
|
"output_required": false,
|
@@ -8418,7 +8418,7 @@
|
|
8418
8418
|
{
|
8419
8419
|
"disabled": false,
|
8420
8420
|
"document": "指定分页每页返回的数据条数,单页最大支持 200。",
|
8421
|
-
"example": "
|
8421
|
+
"example": "10",
|
8422
8422
|
"member": "int64",
|
8423
8423
|
"name": "Limit",
|
8424
8424
|
"output_required": false,
|
@@ -8428,7 +8428,7 @@
|
|
8428
8428
|
{
|
8429
8429
|
"disabled": false,
|
8430
8430
|
"document": "满足查询条件的企业总数量。",
|
8431
|
-
"example": "
|
8431
|
+
"example": "100",
|
8432
8432
|
"member": "int64",
|
8433
8433
|
"name": "Total",
|
8434
8434
|
"output_required": false,
|
@@ -8459,7 +8459,7 @@
|
|
8459
8459
|
{
|
8460
8460
|
"disabled": false,
|
8461
8461
|
"document": "用印审批单的ID,可通过用印[申请回调](https://qian.tencent.com/developers/partner/callback_types_seals#%E4%B8%89-%E7%94%A8%E5%8D%B0%E7%94%B3%E8%AF%B7%E5%AE%A1%E6%89%B9%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5)获取。",
|
8462
|
-
"example": "
|
8462
|
+
"example": "yDCYyUU5v4h32uUEp5vIWRaloaz5mYuu",
|
8463
8463
|
"member": "string",
|
8464
8464
|
"name": "WorkflowInstanceId",
|
8465
8465
|
"required": true,
|
@@ -8468,7 +8468,7 @@
|
|
8468
8468
|
{
|
8469
8469
|
"disabled": false,
|
8470
8470
|
"document": "生成链接的类型:\n生成链接的类型\n<ul><li>**LongLink**:(默认)长链接,H5跳转到电子签小程序链接,链接有效期为1年</li>\n<li>**ShortLink**:H5跳转到电子签小程序链接,一般用于发送短信中带的链接,打开后进入腾讯电子签小程序,链接有效期为7天</li>\n<li>**App**:第三方APP或小程序跳转电子签小程序链接,一般用于贵方小程序或者APP跳转过来,打开后进入腾讯电子签小程序,链接有效期为1年</li></ul>",
|
8471
|
-
"example": "
|
8471
|
+
"example": "LongLink",
|
8472
8472
|
"member": "string",
|
8473
8473
|
"name": "Endpoint",
|
8474
8474
|
"required": false,
|
@@ -8483,7 +8483,7 @@
|
|
8483
8483
|
{
|
8484
8484
|
"disabled": false,
|
8485
8485
|
"document": "用印审批小程序链接,链接类型(通过H5唤起小程序或通过APP跳转方式查看)。",
|
8486
|
-
"example": "
|
8486
|
+
"example": "https://qian.tencent.com/",
|
8487
8487
|
"member": "string",
|
8488
8488
|
"name": "WorkflowUrl",
|
8489
8489
|
"output_required": false,
|
@@ -8514,7 +8514,7 @@
|
|
8514
8514
|
{
|
8515
8515
|
"disabled": false,
|
8516
8516
|
"document": "要查询的扩展服务类型。\n如下所示:\n<ul><li> AUTO_SIGN:企业静默签署</li>\n<li>BATCH_SIGN:批量签署</li>\n</ul>\n",
|
8517
|
-
"example": "
|
8517
|
+
"example": "AUTO_SIGN",
|
8518
8518
|
"member": "string",
|
8519
8519
|
"name": "ExtendServiceType",
|
8520
8520
|
"required": true,
|
@@ -8523,7 +8523,7 @@
|
|
8523
8523
|
{
|
8524
8524
|
"disabled": false,
|
8525
8525
|
"document": "指定每页返回的数据条数,和Offset参数配合使用。 注:`1.默认值为20,单页做大值为200。`\t",
|
8526
|
-
"example": "
|
8526
|
+
"example": "10",
|
8527
8527
|
"member": "int64",
|
8528
8528
|
"name": "Limit",
|
8529
8529
|
"required": false,
|
@@ -8532,7 +8532,7 @@
|
|
8532
8532
|
{
|
8533
8533
|
"disabled": false,
|
8534
8534
|
"document": "查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。 注:`1.offset从0开始,即第一页为0。` `2.默认从第一页返回。`\t",
|
8535
|
-
"example": "
|
8535
|
+
"example": "0",
|
8536
8536
|
"member": "int64",
|
8537
8537
|
"name": "Offset",
|
8538
8538
|
"required": false,
|
@@ -8615,7 +8615,7 @@
|
|
8615
8615
|
{
|
8616
8616
|
"disabled": false,
|
8617
8617
|
"document": "需要查询的流程ID列表,最多可传入100个ID。\n如果要查询合同组的信息,则不需要传入此参数,只需传入 FlowGroupId 参数即可。",
|
8618
|
-
"example": "
|
8618
|
+
"example": "[\"yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw\"]",
|
8619
8619
|
"member": "string",
|
8620
8620
|
"name": "FlowIds",
|
8621
8621
|
"required": false,
|
@@ -8624,7 +8624,7 @@
|
|
8624
8624
|
{
|
8625
8625
|
"disabled": false,
|
8626
8626
|
"document": "需要查询的流程组ID,如果传入此参数,则会忽略 FlowIds 参数。\n\n合同组由<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates\" target=\"_blank\">通过多模板创建合同组签署流程</a>和<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles\" target=\"_blank\">通过多文件创建合同组签署流程</a>等接口创建。",
|
8627
|
-
"example": "
|
8627
|
+
"example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
|
8628
8628
|
"member": "string",
|
8629
8629
|
"name": "FlowGroupId",
|
8630
8630
|
"required": false,
|
@@ -8648,7 +8648,7 @@
|
|
8648
8648
|
{
|
8649
8649
|
"disabled": false,
|
8650
8650
|
"document": "合同归属的第三方平台应用号ID",
|
8651
|
-
"example": "
|
8651
|
+
"example": "yDCZHUUnitvronUuNTdBrElW0gOVqCfy",
|
8652
8652
|
"member": "string",
|
8653
8653
|
"name": "ApplicationId",
|
8654
8654
|
"output_required": true,
|
@@ -8658,7 +8658,7 @@
|
|
8658
8658
|
{
|
8659
8659
|
"disabled": false,
|
8660
8660
|
"document": "合同归属的第三方平台子客企业OpenId",
|
8661
|
-
"example": "
|
8661
|
+
"example": "openId_123",
|
8662
8662
|
"member": "string",
|
8663
8663
|
"name": "ProxyOrganizationOpenId",
|
8664
8664
|
"output_required": true,
|
@@ -8678,7 +8678,7 @@
|
|
8678
8678
|
{
|
8679
8679
|
"disabled": false,
|
8680
8680
|
"document": "合同组ID,只有在查询合同组信息时才会返回。\n注意:此字段可能返回 null,表示取不到有效值。",
|
8681
|
-
"example": "
|
8681
|
+
"example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
|
8682
8682
|
"member": "string",
|
8683
8683
|
"name": "FlowGroupId",
|
8684
8684
|
"output_required": true,
|
@@ -8688,7 +8688,7 @@
|
|
8688
8688
|
{
|
8689
8689
|
"disabled": false,
|
8690
8690
|
"document": "合同组名称,只有在查询合同组信息时才会返回。\n注意:此字段可能返回 null,表示取不到有效值。",
|
8691
|
-
"example": "
|
8691
|
+
"example": "合同组名称-1",
|
8692
8692
|
"member": "string",
|
8693
8693
|
"name": "FlowGroupName",
|
8694
8694
|
"output_required": true,
|
@@ -8784,7 +8784,7 @@
|
|
8784
8784
|
{
|
8785
8785
|
"disabled": false,
|
8786
8786
|
"document": "合同模板ID,为32位字符串。\n\n可以通过<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl\" target=\"_blank\">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。\n\n[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)",
|
8787
|
-
"example": "
|
8787
|
+
"example": "yDxZBURlR5VUy0fKyKS3wFGsowVtMwKQ",
|
8788
8788
|
"member": "string",
|
8789
8789
|
"name": "TemplateId",
|
8790
8790
|
"required": false,
|
@@ -8793,7 +8793,7 @@
|
|
8793
8793
|
{
|
8794
8794
|
"disabled": false,
|
8795
8795
|
"document": "查询模板的内容\n\n<ul><li>**0**:(默认)模板列表及详情</li>\n<li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>",
|
8796
|
-
"example": "
|
8796
|
+
"example": "0",
|
8797
8797
|
"member": "int64",
|
8798
8798
|
"name": "ContentType",
|
8799
8799
|
"required": false,
|
@@ -8802,7 +8802,7 @@
|
|
8802
8802
|
{
|
8803
8803
|
"disabled": false,
|
8804
8804
|
"document": "合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持100个模板的批量查询。\n\n注意: \n1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`\n2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`\n4. `若传递此参数,分页参数(Limit,Offset)无效`\n\n\n[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)\n",
|
8805
|
-
"example": "
|
8805
|
+
"example": "[\"yDxZBURlR5VUy0fKyKS3wFGsowVtMwKQ\"]",
|
8806
8806
|
"member": "string",
|
8807
8807
|
"name": "TemplateIds",
|
8808
8808
|
"required": false,
|
@@ -8811,7 +8811,7 @@
|
|
8811
8811
|
{
|
8812
8812
|
"disabled": false,
|
8813
8813
|
"document": "指定每页返回的数据条数,和Offset参数配合使用。\n\n注:`1.默认值为20,单页做大值为100。`",
|
8814
|
-
"example": "
|
8814
|
+
"example": "10",
|
8815
8815
|
"member": "uint64",
|
8816
8816
|
"name": "Limit",
|
8817
8817
|
"required": false,
|
@@ -8820,7 +8820,7 @@
|
|
8820
8820
|
{
|
8821
8821
|
"disabled": false,
|
8822
8822
|
"document": "查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。\n\n注:`1.offset从0开始,即第一页为0。`\n`2.默认从第一页返回。`",
|
8823
|
-
"example": "
|
8823
|
+
"example": "0",
|
8824
8824
|
"member": "uint64",
|
8825
8825
|
"name": "Offset",
|
8826
8826
|
"required": false,
|
@@ -8829,7 +8829,7 @@
|
|
8829
8829
|
{
|
8830
8830
|
"disabled": false,
|
8831
8831
|
"document": "模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。",
|
8832
|
-
"example": "
|
8832
|
+
"example": "模板名称1",
|
8833
8833
|
"member": "string",
|
8834
8834
|
"name": "TemplateName",
|
8835
8835
|
"required": false,
|
@@ -8838,7 +8838,7 @@
|
|
8838
8838
|
{
|
8839
8839
|
"disabled": false,
|
8840
8840
|
"document": "对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。",
|
8841
|
-
"example": "
|
8841
|
+
"example": "yDCYyUU5v4h32uUEp5vIWRaloaz5mYuu",
|
8842
8842
|
"member": "string",
|
8843
8843
|
"name": "ChannelTemplateId",
|
8844
8844
|
"required": false,
|
@@ -8847,7 +8847,7 @@
|
|
8847
8847
|
{
|
8848
8848
|
"disabled": false,
|
8849
8849
|
"document": "返回控件的范围, 是只返回发起方自己的还是所有参与方的\n\n<ul><li>**false**:(默认)只返回发起方控件</li>\n<li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>",
|
8850
|
-
"example": "
|
8850
|
+
"example": "false",
|
8851
8851
|
"member": "bool",
|
8852
8852
|
"name": "QueryAllComponents",
|
8853
8853
|
"required": false,
|
@@ -8856,7 +8856,7 @@
|
|
8856
8856
|
{
|
8857
8857
|
"disabled": false,
|
8858
8858
|
"document": "是否获取模板预览链接。\n\n<ul><li>**false**:不获取(默认)</li>\n<li>**true**:获取</li></ul>\n\n设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。\n",
|
8859
|
-
"example": "
|
8859
|
+
"example": "false",
|
8860
8860
|
"member": "bool",
|
8861
8861
|
"name": "WithPreviewUrl",
|
8862
8862
|
"required": false,
|
@@ -8865,7 +8865,7 @@
|
|
8865
8865
|
{
|
8866
8866
|
"disabled": false,
|
8867
8867
|
"document": "是否获取模板的PDF文件链接。\n\n<ul><li>**false**:不获取(默认)</li>\n<li>**true**:获取</li></ul>\n\n设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地\n\n注: `此功能需要开通功能白名单【第三方应用集成企业获取模版PDF下载链接】,使用前请联系对接的客户经理沟通。`",
|
8868
|
-
"example": "
|
8868
|
+
"example": "false",
|
8869
8869
|
"member": "bool",
|
8870
8870
|
"name": "WithPdfUrl",
|
8871
8871
|
"required": false,
|
@@ -8977,7 +8977,7 @@
|
|
8977
8977
|
{
|
8978
8978
|
"disabled": false,
|
8979
8979
|
"document": "指定每页返回的数据条数,和Offset参数配合使用。\n\n注: `默认值为1000,单页做大值为1000`",
|
8980
|
-
"example": "
|
8980
|
+
"example": "10",
|
8981
8981
|
"member": "uint64",
|
8982
8982
|
"name": "Limit",
|
8983
8983
|
"required": false,
|
@@ -8986,7 +8986,7 @@
|
|
8986
8986
|
{
|
8987
8987
|
"disabled": false,
|
8988
8988
|
"document": "查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。\n\n注:`offset从0开始,即第一页为0。`",
|
8989
|
-
"example": "
|
8989
|
+
"example": "0",
|
8990
8990
|
"member": "uint64",
|
8991
8991
|
"name": "Offset",
|
8992
8992
|
"required": false,
|
@@ -9010,7 +9010,7 @@
|
|
9010
9010
|
{
|
9011
9011
|
"disabled": false,
|
9012
9012
|
"document": "用量明细条数",
|
9013
|
-
"example": "
|
9013
|
+
"example": "1000",
|
9014
9014
|
"member": "uint64",
|
9015
9015
|
"name": "Total",
|
9016
9016
|
"output_required": true,
|
@@ -10620,7 +10620,7 @@
|
|
10620
10620
|
{
|
10621
10621
|
"disabled": false,
|
10622
10622
|
"document": "跳转控制台合同下载页面链接 , 5分钟之内有效,且只能访问一次\n",
|
10623
|
-
"example": "
|
10623
|
+
"example": "https://qian.tencent.com/",
|
10624
10624
|
"member": "string",
|
10625
10625
|
"name": "DownLoadUrl",
|
10626
10626
|
"output_required": true,
|
@@ -11900,7 +11900,7 @@
|
|
11900
11900
|
{
|
11901
11901
|
"disabled": false,
|
11902
11902
|
"document": "操作完成后的跳转地址,最大长度200",
|
11903
|
-
"example": "
|
11903
|
+
"example": "https://ess.tencent.com",
|
11904
11904
|
"member": "string",
|
11905
11905
|
"name": "JumpUrl",
|
11906
11906
|
"required": true,
|