tccli 3.0.1251.1__py2.py3-none-any.whl → 3.0.1252.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/services/aiart/v20221229/api.json +12 -3
- tccli/services/bi/v20220105/api.json +6 -6
- tccli/services/cat/v20180409/api.json +25 -24
- tccli/services/cat/v20180409/examples.json +17 -17
- tccli/services/ccc/ccc_client.py +53 -0
- tccli/services/ccc/v20200210/api.json +89 -0
- tccli/services/ccc/v20200210/examples.json +8 -0
- tccli/services/cdb/v20170320/api.json +12 -0
- tccli/services/cdwdoris/v20211228/api.json +233 -193
- tccli/services/cdwdoris/v20211228/examples.json +6 -6
- tccli/services/cloudaudit/v20190319/api.json +2 -2
- tccli/services/cloudaudit/v20190319/examples.json +2 -2
- tccli/services/config/v20220802/api.json +20 -9
- tccli/services/config/v20220802/examples.json +1 -1
- tccli/services/ess/v20201111/api.json +94 -92
- tccli/services/ess/v20201111/examples.json +9 -9
- tccli/services/essbasic/v20210526/api.json +2 -2
- tccli/services/essbasic/v20210526/examples.json +6 -6
- tccli/services/lcic/v20220817/api.json +1 -1
- tccli/services/monitor/v20180724/api.json +68 -50
- tccli/services/monitor/v20180724/examples.json +21 -21
- tccli/services/mps/mps_client.py +379 -61
- tccli/services/mps/v20190612/api.json +495 -13
- tccli/services/mps/v20190612/examples.json +48 -0
- tccli/services/ssl/v20191205/api.json +3 -3
- tccli/services/ssl/v20191205/examples.json +1 -1
- tccli/services/trtc/v20190722/api.json +11 -0
- tccli/services/tse/v20201207/api.json +10 -0
- tccli/services/wedata/v20210820/api.json +382 -96
- tccli/services/wedata/v20210820/examples.json +1 -1
- {tccli-3.0.1251.1.dist-info → tccli-3.0.1252.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1251.1.dist-info → tccli-3.0.1252.1.dist-info}/RECORD +36 -36
- {tccli-3.0.1251.1.dist-info → tccli-3.0.1252.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1251.1.dist-info → tccli-3.0.1252.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1251.1.dist-info → tccli-3.0.1252.1.dist-info}/license_files/LICENSE +0 -0
@@ -958,7 +958,7 @@
|
|
958
958
|
{
|
959
959
|
"disabled": false,
|
960
960
|
"document": "签署须知:支持传入富文本,最长字数:500个中文字符",
|
961
|
-
"example": "
|
961
|
+
"example": "这个合同不能截图转发",
|
962
962
|
"member": "string",
|
963
963
|
"name": "SignInstructionContent",
|
964
964
|
"required": false,
|
@@ -1572,7 +1572,7 @@
|
|
1572
1572
|
{
|
1573
1573
|
"disabled": false,
|
1574
1574
|
"document": "员工在腾讯电子签平台的唯一身份标识,为32位字符串。\n\n通过<a href=\"https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees\" target=\"_blank\">DescribeIntegrationEmployees</a>接口获取,也可登录腾讯电子签控制台查看\n![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)",
|
1575
|
-
"example": "
|
1575
|
+
"example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
|
1576
1576
|
"member": "string",
|
1577
1577
|
"name": "UserId",
|
1578
1578
|
"required": true,
|
@@ -1581,7 +1581,7 @@
|
|
1581
1581
|
{
|
1582
1582
|
"disabled": false,
|
1583
1583
|
"document": "员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。",
|
1584
|
-
"example": "
|
1584
|
+
"example": "n9527",
|
1585
1585
|
"member": "string",
|
1586
1586
|
"name": "OpenId",
|
1587
1587
|
"required": true,
|
@@ -1605,7 +1605,7 @@
|
|
1605
1605
|
{
|
1606
1606
|
"disabled": false,
|
1607
1607
|
"document": "绑定是否成功。\n<ul><li>**0**:失败</li><li>**1**:成功</li></ul>",
|
1608
|
-
"example": "
|
1608
|
+
"example": "1",
|
1609
1609
|
"member": "int64",
|
1610
1610
|
"name": "Status",
|
1611
1611
|
"output_required": true,
|
@@ -1851,7 +1851,7 @@
|
|
1851
1851
|
{
|
1852
1852
|
"disabled": false,
|
1853
1853
|
"document": "自动签使用的场景值, 可以选择的场景值如下:\n<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>",
|
1854
|
-
"example": "
|
1854
|
+
"example": "E_PRESCRIPTION_AUTO_SIGN",
|
1855
1855
|
"member": "string",
|
1856
1856
|
"name": "SceneKey",
|
1857
1857
|
"required": true,
|
@@ -2272,7 +2272,7 @@
|
|
2272
2272
|
{
|
2273
2273
|
"disabled": false,
|
2274
2274
|
"document": "需要执行撤回的流程(合同)的编号列表,最多100个.\n列表中的流程(合同)编号不要重复.",
|
2275
|
-
"example": "
|
2275
|
+
"example": "[\"yDt1JUUckp77a2omUyEmko88eg49PTsN\"]",
|
2276
2276
|
"member": "string",
|
2277
2277
|
"name": "FlowIds",
|
2278
2278
|
"required": true,
|
@@ -2296,7 +2296,7 @@
|
|
2296
2296
|
{
|
2297
2297
|
"disabled": false,
|
2298
2298
|
"document": "批量撤回签署流程链接",
|
2299
|
-
"example": "
|
2299
|
+
"example": "https://qian.tencent.cn/code=yDtwRUUckp7fyqz6UuQZAp18BNrB74xu",
|
2300
2300
|
"member": "string",
|
2301
2301
|
"name": "BatchCancelFlowUrl",
|
2302
2302
|
"output_required": true,
|
@@ -2306,7 +2306,7 @@
|
|
2306
2306
|
{
|
2307
2307
|
"disabled": false,
|
2308
2308
|
"document": "签署流程撤回失败信息\n数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错",
|
2309
|
-
"example": "
|
2309
|
+
"example": "[\"合同已经过期\"]",
|
2310
2310
|
"member": "string",
|
2311
2311
|
"name": "FailMessages",
|
2312
2312
|
"output_required": true,
|
@@ -2315,8 +2315,8 @@
|
|
2315
2315
|
},
|
2316
2316
|
{
|
2317
2317
|
"disabled": false,
|
2318
|
-
"document": "签署连接过期时间字符串:年月日-时分秒\n
|
2319
|
-
"example": "
|
2318
|
+
"document": "签署连接过期时间字符串:年月日-时分秒\n",
|
2319
|
+
"example": "2023-07-28 17:25:59",
|
2320
2320
|
"member": "string",
|
2321
2321
|
"name": "UrlExpireOn",
|
2322
2322
|
"output_required": true,
|
@@ -2326,7 +2326,7 @@
|
|
2326
2326
|
{
|
2327
2327
|
"disabled": false,
|
2328
2328
|
"document": "批量撤销任务编号,为32位字符串,可用于[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/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)",
|
2329
|
-
"example": "
|
2329
|
+
"example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
|
2330
2330
|
"member": "string",
|
2331
2331
|
"name": "TaskId",
|
2332
2332
|
"output_required": true,
|
@@ -2357,7 +2357,7 @@
|
|
2357
2357
|
{
|
2358
2358
|
"disabled": false,
|
2359
2359
|
"document": "初始化操作类型\n<ul>\n<li>CREATE_SEAL : 创建印章</li>\n<li>AUTH_JOIN_ORGANIZATION_GROUP : 加入集团企业</li>\n<li>OPEN_AUTO_SIGN :开通企业自动签署</li>\n<li>PARTNER_AUTO_SIGN_AUTH :合作方企业授权自动签</li>\n</ul>",
|
2360
|
-
"example": "
|
2360
|
+
"example": "[\"CREATE_SEAL \"]",
|
2361
2361
|
"member": "string",
|
2362
2362
|
"name": "OperateTypes",
|
2363
2363
|
"required": true,
|
@@ -2366,7 +2366,7 @@
|
|
2366
2366
|
{
|
2367
2367
|
"disabled": false,
|
2368
2368
|
"document": "批量操作的企业Id列表,最大支持50个",
|
2369
|
-
"example": "
|
2369
|
+
"example": "[\"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"]",
|
2370
2370
|
"member": "string",
|
2371
2371
|
"name": "OrganizationIds",
|
2372
2372
|
"required": true,
|
@@ -2384,7 +2384,7 @@
|
|
2384
2384
|
{
|
2385
2385
|
"disabled": false,
|
2386
2386
|
"document": "被授权的合作方企业在电子签的企业电子签账号,当操作类型包含 PARTNER_AUTO_SIGN_AUTH (合作方企业授权自动签)时必传。\n\n企业电子签账号可在[电子签的网页端](https://qian.tencent.com/console/company-settings/company-center) ,于企业设置-企业信息菜单栏下复制获取。\n\n![企业电子签账号](https://qcloudimg.tencent-cloud.cn/raw/4e6b30ee92f00671f7f1c5bd127c27db.png)",
|
2387
|
-
"example": "
|
2387
|
+
"example": "yDt1JUUckp77a2tqUyEmko8RVpCEHoNA",
|
2388
2388
|
"member": "string",
|
2389
2389
|
"name": "AuthorizedOrganizationId",
|
2390
2390
|
"required": false,
|
@@ -2399,7 +2399,7 @@
|
|
2399
2399
|
{
|
2400
2400
|
"disabled": false,
|
2401
2401
|
"document": "小程序路径",
|
2402
|
-
"example": "
|
2402
|
+
"example": "pages/home/index?code=001XzUF",
|
2403
2403
|
"member": "string",
|
2404
2404
|
"name": "MiniAppPath",
|
2405
2405
|
"output_required": true,
|
@@ -2409,7 +2409,7 @@
|
|
2409
2409
|
{
|
2410
2410
|
"disabled": false,
|
2411
2411
|
"document": "操作长链",
|
2412
|
-
"example": "
|
2412
|
+
"example": "https://embed.beta.qian.tencent.cn/code=yDtwRUUckp7fyqz6UuQZAp18BNrB74xu",
|
2413
2413
|
"member": "string",
|
2414
2414
|
"name": "OperateLongUrl",
|
2415
2415
|
"output_required": true,
|
@@ -2419,7 +2419,7 @@
|
|
2419
2419
|
{
|
2420
2420
|
"disabled": false,
|
2421
2421
|
"document": "操作短链",
|
2422
|
-
"example": "
|
2422
|
+
"example": "https://essurl.cn/001XzUF",
|
2423
2423
|
"member": "string",
|
2424
2424
|
"name": "OperateShortUrl",
|
2425
2425
|
"output_required": true,
|
@@ -2429,7 +2429,7 @@
|
|
2429
2429
|
{
|
2430
2430
|
"disabled": false,
|
2431
2431
|
"document": "操作二维码",
|
2432
|
-
"example": "
|
2432
|
+
"example": "https://file.cn/qrcode.jpg",
|
2433
2433
|
"member": "string",
|
2434
2434
|
"name": "QRCodeUrl",
|
2435
2435
|
"output_required": true,
|
@@ -2514,7 +2514,7 @@
|
|
2514
2514
|
{
|
2515
2515
|
"disabled": false,
|
2516
2516
|
"document": "要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**QR_CODE**: 跳转电子签小程序的http_url的二维码形式, 可以在页面展示适合此类型</li></ul>",
|
2517
|
-
"example": "
|
2517
|
+
"example": "HTTP",
|
2518
2518
|
"member": "string",
|
2519
2519
|
"name": "Endpoint",
|
2520
2520
|
"required": false,
|
@@ -2539,7 +2539,7 @@
|
|
2539
2539
|
{
|
2540
2540
|
"disabled": false,
|
2541
2541
|
"document": "认证流认证失败信息",
|
2542
|
-
"example": "
|
2542
|
+
"example": "[\"企业三要素校验失败\"]",
|
2543
2543
|
"member": "string",
|
2544
2544
|
"name": "ErrorMessages",
|
2545
2545
|
"output_required": false,
|
@@ -2549,7 +2549,7 @@
|
|
2549
2549
|
{
|
2550
2550
|
"disabled": false,
|
2551
2551
|
"document": "链接过期时间,为 7 天后,创建时间,格式为Unix标准时间戳(秒)。",
|
2552
|
-
"example": "
|
2552
|
+
"example": "1736751627",
|
2553
2553
|
"member": "uint64",
|
2554
2554
|
"name": "ExpireTime",
|
2555
2555
|
"output_required": false,
|
@@ -2613,7 +2613,7 @@
|
|
2613
2613
|
{
|
2614
2614
|
"disabled": false,
|
2615
2615
|
"document": "生成注册链接的任务Id,\n根据这个id, 调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接,进入认证流程",
|
2616
|
-
"example": "
|
2616
|
+
"example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
|
2617
2617
|
"member": "string",
|
2618
2618
|
"name": "TaskId",
|
2619
2619
|
"output_required": false,
|
@@ -2623,7 +2623,7 @@
|
|
2623
2623
|
{
|
2624
2624
|
"disabled": false,
|
2625
2625
|
"document": "批量生成企业认证链接的详细错误信息,\n顺序与输入参数保持一致。\n若企业认证均成功生成,则不返回错误信息;\n若存在任何错误,则返回具体的错误描述。",
|
2626
|
-
"example": "
|
2626
|
+
"example": "[\"企业三要素校验失败\"]",
|
2627
2627
|
"member": "string",
|
2628
2628
|
"name": "ErrorMessages",
|
2629
2629
|
"output_required": false,
|
@@ -2672,7 +2672,7 @@
|
|
2672
2672
|
{
|
2673
2673
|
"disabled": false,
|
2674
2674
|
"document": "批量签署的合同流程ID数组。\n注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`",
|
2675
|
-
"example": "
|
2675
|
+
"example": "[\"yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH\"]",
|
2676
2676
|
"member": "string",
|
2677
2677
|
"name": "FlowIds",
|
2678
2678
|
"required": false,
|
@@ -2690,7 +2690,7 @@
|
|
2690
2690
|
{
|
2691
2691
|
"disabled": false,
|
2692
2692
|
"document": "签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)",
|
2693
|
-
"example": "
|
2693
|
+
"example": "https://jump.cn/jump",
|
2694
2694
|
"member": "string",
|
2695
2695
|
"name": "JumpUrl",
|
2696
2696
|
"required": false,
|
@@ -2717,7 +2717,7 @@
|
|
2717
2717
|
{
|
2718
2718
|
"disabled": false,
|
2719
2719
|
"document": "生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:\n<ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>\n<li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>\n注:\n`不指定该值时,默认为签署方自行选择。`",
|
2720
|
-
"example": "
|
2720
|
+
"example": "LoginWithoutMobile ",
|
2721
2721
|
"member": "uint64",
|
2722
2722
|
"name": "SignTypeSelector",
|
2723
2723
|
"required": false,
|
@@ -2744,7 +2744,7 @@
|
|
2744
2744
|
{
|
2745
2745
|
"disabled": false,
|
2746
2746
|
"document": "缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。\n\n注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`",
|
2747
|
-
"example": "
|
2747
|
+
"example": "false",
|
2748
2748
|
"member": "bool",
|
2749
2749
|
"name": "CacheApproverInfo",
|
2750
2750
|
"required": false,
|
@@ -2790,7 +2790,7 @@
|
|
2790
2790
|
{
|
2791
2791
|
"disabled": false,
|
2792
2792
|
"document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n注:`请确保和合同中填入的一致`, `除动态签署人场景外,此参数必填`",
|
2793
|
-
"example": "
|
2793
|
+
"example": "张三",
|
2794
2794
|
"member": "string",
|
2795
2795
|
"name": "Name",
|
2796
2796
|
"required": false,
|
@@ -2799,7 +2799,7 @@
|
|
2799
2799
|
{
|
2800
2800
|
"disabled": false,
|
2801
2801
|
"document": "手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`,`除动态签署人场景外,此参数必填`",
|
2802
|
-
"example": "
|
2802
|
+
"example": "18888888888",
|
2803
2803
|
"member": "string",
|
2804
2804
|
"name": "Mobile",
|
2805
2805
|
"required": false,
|
@@ -2817,7 +2817,7 @@
|
|
2817
2817
|
{
|
2818
2818
|
"disabled": false,
|
2819
2819
|
"document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
|
2820
|
-
"example": "
|
2820
|
+
"example": "ID_CARD",
|
2821
2821
|
"member": "string",
|
2822
2822
|
"name": "IdCardType",
|
2823
2823
|
"required": false,
|
@@ -2826,7 +2826,7 @@
|
|
2826
2826
|
{
|
2827
2827
|
"disabled": false,
|
2828
2828
|
"document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`请确保和合同中填入的一致`",
|
2829
|
-
"example": "
|
2829
|
+
"example": "37000019890303000X",
|
2830
2830
|
"member": "string",
|
2831
2831
|
"name": "IdCardNumber",
|
2832
2832
|
"required": false,
|
@@ -2835,7 +2835,7 @@
|
|
2835
2835
|
{
|
2836
2836
|
"disabled": false,
|
2837
2837
|
"document": "通知用户方式:\n<ul>\n<li>**NONE** : 不通知(默认)</li>\n<li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li>\n</ul>",
|
2838
|
-
"example": "
|
2838
|
+
"example": "SMS",
|
2839
2839
|
"member": "string",
|
2840
2840
|
"name": "NotifyType",
|
2841
2841
|
"required": false,
|
@@ -2844,7 +2844,7 @@
|
|
2844
2844
|
{
|
2845
2845
|
"disabled": false,
|
2846
2846
|
"document": "批量签署的合同流程ID数组。\n注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`",
|
2847
|
-
"example": "
|
2847
|
+
"example": "[\"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"]",
|
2848
2848
|
"member": "string",
|
2849
2849
|
"name": "FlowIds",
|
2850
2850
|
"required": false,
|
@@ -2853,7 +2853,7 @@
|
|
2853
2853
|
{
|
2854
2854
|
"disabled": false,
|
2855
2855
|
"document": "目标签署人的企业名称,签署人如果是企业员工身份,需要传此参数。\n\n注:\n<ul>\n<li>请确认该名称与企业营业执照中注册的名称一致。</li>\n<li>如果名称中包含英文括号(),请使用中文括号()代替。</li>\n<li>请确保此企业已完成腾讯电子签企业认证。</li>\n</ul>",
|
2856
|
-
"example": "
|
2856
|
+
"example": "张三示例企业",
|
2857
2857
|
"member": "string",
|
2858
2858
|
"name": "OrganizationName",
|
2859
2859
|
"required": false,
|
@@ -2862,7 +2862,7 @@
|
|
2862
2862
|
{
|
2863
2863
|
"disabled": false,
|
2864
2864
|
"document": "是否直接跳转至合同内容页面进行签署\n<ul>\n<li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>\n<li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>\n</ul>",
|
2865
|
-
"example": "
|
2865
|
+
"example": "true",
|
2866
2866
|
"member": "bool",
|
2867
2867
|
"name": "JumpToDetail",
|
2868
2868
|
"required": false,
|
@@ -2880,7 +2880,7 @@
|
|
2880
2880
|
{
|
2881
2881
|
"disabled": false,
|
2882
2882
|
"document": "签署完成后是否自动回跳\n<ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>\n\n注: \n1. 该参数<font color=\"red\">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效\n2. <font color=\"red\">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)\n3. <font color=\"red\">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font> ",
|
2883
|
-
"example": "
|
2883
|
+
"example": "true",
|
2884
2884
|
"member": "bool",
|
2885
2885
|
"name": "AutoJumpBack",
|
2886
2886
|
"required": false,
|
@@ -2889,7 +2889,7 @@
|
|
2889
2889
|
{
|
2890
2890
|
"disabled": false,
|
2891
2891
|
"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)。",
|
2892
|
-
"example": "
|
2892
|
+
"example": "WeChatOfficialAccounts",
|
2893
2893
|
"member": "string",
|
2894
2894
|
"name": "UrlUseEnv",
|
2895
2895
|
"required": false,
|
@@ -2904,7 +2904,7 @@
|
|
2904
2904
|
{
|
2905
2905
|
"disabled": false,
|
2906
2906
|
"document": "批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。\n\n注: \n1. 非小程序和APP集成使用\n2. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
|
2907
|
-
"example": "
|
2907
|
+
"example": "https://essurl.cn/zUFEye ",
|
2908
2908
|
"member": "string",
|
2909
2909
|
"name": "SignUrl",
|
2910
2910
|
"output_required": true,
|
@@ -2914,7 +2914,7 @@
|
|
2914
2914
|
{
|
2915
2915
|
"disabled": false,
|
2916
2916
|
"document": "链接过期时间以 Unix 时间戳格式表示,默认生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。",
|
2917
|
-
"example": "
|
2917
|
+
"example": "1736751627",
|
2918
2918
|
"member": "int64",
|
2919
2919
|
"name": "ExpiredTime",
|
2920
2920
|
"output_required": true,
|
@@ -2924,7 +2924,7 @@
|
|
2924
2924
|
{
|
2925
2925
|
"disabled": false,
|
2926
2926
|
"document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径\n\n注: \n1. 小程序和APP集成使用\n2. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
|
2927
|
-
"example": "
|
2927
|
+
"example": "pages/home/index?resourceId=xxx",
|
2928
2928
|
"member": "string",
|
2929
2929
|
"name": "MiniAppPath",
|
2930
2930
|
"output_required": true,
|
@@ -3006,7 +3006,7 @@
|
|
3006
3006
|
{
|
3007
3007
|
"disabled": false,
|
3008
3008
|
"document": "接口返回的文件转换任务Id,可以调用接口<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi\" target=\"_blank\">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。",
|
3009
|
-
"example": "
|
3009
|
+
"example": "20250113111955261408",
|
3010
3010
|
"member": "string",
|
3011
3011
|
"name": "TaskId",
|
3012
3012
|
"output_required": true,
|
@@ -3115,7 +3115,7 @@
|
|
3115
3115
|
{
|
3116
3116
|
"disabled": false,
|
3117
3117
|
"document": "合同流程的底层电子文档ID,为32位字符串。\n\n注:\n后续需用同样的FlowId再次调用[发起签署流程](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow),合同才能进入签署环节",
|
3118
|
-
"example": "
|
3118
|
+
"example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
|
3119
3119
|
"member": "string",
|
3120
3120
|
"name": "DocumentId",
|
3121
3121
|
"output_required": true,
|
@@ -3166,7 +3166,7 @@
|
|
3166
3166
|
{
|
3167
3167
|
"disabled": false,
|
3168
3168
|
"document": "合同流程ID,为32位字符串",
|
3169
|
-
"example": "
|
3169
|
+
"example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
|
3170
3170
|
"member": "string",
|
3171
3171
|
"name": "FlowId",
|
3172
3172
|
"required": true,
|
@@ -3208,7 +3208,7 @@
|
|
3208
3208
|
{
|
3209
3209
|
"disabled": false,
|
3210
3210
|
"document": "合同流程ID,为32位字符串",
|
3211
|
-
"example": "
|
3211
|
+
"example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
|
3212
3212
|
"member": "string",
|
3213
3213
|
"name": "FlowId",
|
3214
3214
|
"output_required": false,
|
@@ -3249,7 +3249,7 @@
|
|
3249
3249
|
{
|
3250
3250
|
"disabled": false,
|
3251
3251
|
"document": "WEB嵌入资源类型,支持以下类型\n<ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>\n<li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>\n<li>MODIFY_TEMPLATE:生成编辑模板的嵌入页面</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>",
|
3252
|
-
"example": "
|
3252
|
+
"example": "PREVIEW_FLOW",
|
3253
3253
|
"member": "string",
|
3254
3254
|
"name": "EmbedType",
|
3255
3255
|
"required": true,
|
@@ -3258,7 +3258,7 @@
|
|
3258
3258
|
{
|
3259
3259
|
"disabled": false,
|
3260
3260
|
"document": "WEB嵌入的业务资源ID\n\n当EmbedType取值\n<ul>\n<li>为PREVIEW_SEAL_DETAIL,必填,取值为印章id。</li>\n<li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li>\n<li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id。</li>\n<li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id。</li>\n</ul>\n\n注意:\n 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口[创建文件转换任务\n](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。",
|
3261
|
-
"example": "
|
3261
|
+
"example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
|
3262
3262
|
"member": "string",
|
3263
3263
|
"name": "BusinessId",
|
3264
3264
|
"required": false,
|
@@ -3309,7 +3309,7 @@
|
|
3309
3309
|
{
|
3310
3310
|
"disabled": false,
|
3311
3311
|
"document": "嵌入的web链接,有效期:5分钟\n<br/>EmbedType=PREVIEW_CC_FLOW,该url为h5链接",
|
3312
|
-
"example": "
|
3312
|
+
"example": "https://embed.beta.qian.tencent.cn/code=yDtwRUUckp7fyqz6UuQZAp18BNrB74xu",
|
3313
3313
|
"member": "string",
|
3314
3314
|
"name": "WebUrl",
|
3315
3315
|
"output_required": true,
|
@@ -3364,7 +3364,7 @@
|
|
3364
3364
|
{
|
3365
3365
|
"disabled": false,
|
3366
3366
|
"document": "二维码图片的Base64 注: `此二维码的有效时间为7天,过期后需要重新生成新的二维码图片`",
|
3367
|
-
"example": "
|
3367
|
+
"example": "5LqM57u056CB5Zu+54mH55qEQmFzZTY0",
|
3368
3368
|
"member": "string",
|
3369
3369
|
"name": "QrcodeBase64",
|
3370
3370
|
"output_required": false,
|
@@ -3395,7 +3395,7 @@
|
|
3395
3395
|
{
|
3396
3396
|
"disabled": false,
|
3397
3397
|
"document": "本企业员工的id,需要已实名,正常在职员工",
|
3398
|
-
"example": "
|
3398
|
+
"example": "[\"yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH\"]",
|
3399
3399
|
"member": "string",
|
3400
3400
|
"name": "UserIds",
|
3401
3401
|
"required": true,
|
@@ -3540,7 +3540,7 @@
|
|
3540
3540
|
{
|
3541
3541
|
"disabled": false,
|
3542
3542
|
"document": "合同流程ID,为32位字符串。\n建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
|
3543
|
-
"example": "
|
3543
|
+
"example": "yDt1JUUckp77a2tqUyEmko8RVpCEHoNA",
|
3544
3544
|
"member": "string",
|
3545
3545
|
"name": "FlowId",
|
3546
3546
|
"required": true,
|
@@ -3558,7 +3558,7 @@
|
|
3558
3558
|
{
|
3559
3559
|
"disabled": false,
|
3560
3560
|
"document": "链接/二维码的有效截止时间,格式为unix时间戳。最长不超过 2099年12月31日(4102415999)。\n默认值为有效期为当前时间后7天。",
|
3561
|
-
"example": "
|
3561
|
+
"example": "1736751627",
|
3562
3562
|
"member": "uint64",
|
3563
3563
|
"name": "ExpiredOn",
|
3564
3564
|
"required": false,
|
@@ -3593,7 +3593,7 @@
|
|
3593
3593
|
{
|
3594
3594
|
"disabled": false,
|
3595
3595
|
"document": "二维码和短链的过期时间戳,过期时间默认为生成链接后7天。",
|
3596
|
-
"example": "
|
3596
|
+
"example": "1736751627",
|
3597
3597
|
"member": "uint64",
|
3598
3598
|
"name": "ExpiredOn",
|
3599
3599
|
"output_required": false,
|
@@ -3963,7 +3963,7 @@
|
|
3963
3963
|
{
|
3964
3964
|
"disabled": false,
|
3965
3965
|
"document": "合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。",
|
3966
|
-
"example": "
|
3966
|
+
"example": "入职合同集",
|
3967
3967
|
"member": "string",
|
3968
3968
|
"name": "FlowGroupName",
|
3969
3969
|
"required": true,
|
@@ -4005,7 +4005,7 @@
|
|
4005
4005
|
{
|
4006
4006
|
"disabled": false,
|
4007
4007
|
"document": "合同(流程)组的合同组Id",
|
4008
|
-
"example": "
|
4008
|
+
"example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
|
4009
4009
|
"member": "string",
|
4010
4010
|
"name": "FlowGroupId",
|
4011
4011
|
"output_required": true,
|
@@ -4015,7 +4015,7 @@
|
|
4015
4015
|
{
|
4016
4016
|
"disabled": false,
|
4017
4017
|
"document": "合同(流程)组中子合同列表.",
|
4018
|
-
"example": "
|
4018
|
+
"example": "[\"yDt1JUUckp77a2tqUyEmko8RVpCEHoNA\"]",
|
4019
4019
|
"member": "string",
|
4020
4020
|
"name": "FlowIds",
|
4021
4021
|
"output_required": true,
|
@@ -4598,7 +4598,7 @@
|
|
4598
4598
|
{
|
4599
4599
|
"disabled": false,
|
4600
4600
|
"document": "合同流程ID,为32位字符串。\n<ul><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</li>\n<li>可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>",
|
4601
|
-
"example": "
|
4601
|
+
"example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
|
4602
4602
|
"member": "string",
|
4603
4603
|
"name": "FlowId",
|
4604
4604
|
"required": true,
|
@@ -4607,7 +4607,7 @@
|
|
4607
4607
|
{
|
4608
4608
|
"disabled": false,
|
4609
4609
|
"document": "企业内部审核结果\n<ul><li>PASS: 审核通过</li>\n<li>REJECT: 审核拒绝</li>\n<li>SIGN_REJECT:拒签(流程结束)</li></ul>",
|
4610
|
-
"example": "
|
4610
|
+
"example": "PASS",
|
4611
4611
|
"member": "string",
|
4612
4612
|
"name": "ReviewType",
|
4613
4613
|
"required": true,
|
@@ -4625,7 +4625,7 @@
|
|
4625
4625
|
{
|
4626
4626
|
"disabled": false,
|
4627
4627
|
"document": "审核节点的签署人标志,用于指定当前审核的签署方\n<ul><li>**如果签署审核节点是个人, 此参数必填**。</li></ul>",
|
4628
|
-
"example": "
|
4628
|
+
"example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
|
4629
4629
|
"member": "string",
|
4630
4630
|
"name": "RecipientId",
|
4631
4631
|
"required": false,
|
@@ -4634,7 +4634,7 @@
|
|
4634
4634
|
{
|
4635
4635
|
"disabled": false,
|
4636
4636
|
"document": "操作类型:(接口通过该字段区分不同的操作类型)\n\n<ul><li>SignReview: 签署审核(默认)</li>\n<li>CreateReview: 创建审核</li></ul>\n\n如果审核节点是个人,则操作类型只能为SignReview。",
|
4637
|
-
"example": "
|
4637
|
+
"example": "SignReview",
|
4638
4638
|
"member": "string",
|
4639
4639
|
"name": "OperateType",
|
4640
4640
|
"required": false,
|
@@ -4643,7 +4643,7 @@
|
|
4643
4643
|
{
|
4644
4644
|
"disabled": false,
|
4645
4645
|
"document": "审核结果原因\n<ul><li>字符串长度不超过200</li>\n<li>当ReviewType 是拒绝(REJECT) 时此字段必填。</li>\n<li>当ReviewType 是拒绝(SIGN_REJECT) 时此字段必填。</li></ul>\n\n",
|
4646
|
-
"example": "
|
4646
|
+
"example": "合同内容错误",
|
4647
4647
|
"member": "string",
|
4648
4648
|
"name": "ReviewMessage",
|
4649
4649
|
"required": false,
|
@@ -4696,7 +4696,7 @@
|
|
4696
4696
|
},
|
4697
4697
|
{
|
4698
4698
|
"disabled": false,
|
4699
|
-
"document": "流程签署人列表中,结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人,还需传递OrganizationName。\n\n注:\n1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。\n2. 生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。\n\n",
|
4699
|
+
"document": "流程签署人列表中,结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人,还需传递OrganizationName。\n\n此结构体和CreateFlow发起接口参与方结构体复用,除了上述参数外,可传递的参数有:\n1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。\n2. ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。\n3. SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。\n4. Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。\n\n注:\n1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。\n2. 生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。\n\n",
|
4700
4700
|
"example": "无",
|
4701
4701
|
"member": "FlowCreateApprover",
|
4702
4702
|
"name": "FlowApproverInfos",
|
@@ -4715,7 +4715,7 @@
|
|
4715
4715
|
{
|
4716
4716
|
"disabled": false,
|
4717
4717
|
"document": "签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href=\"https://qian.tencent.com/developers/company/openqianh5\" target=\"_blank\">跳转电子签H5</a>\n",
|
4718
|
-
"example": "
|
4718
|
+
"example": "https://jump.cn/jump",
|
4719
4719
|
"member": "string",
|
4720
4720
|
"name": "JumpUrl",
|
4721
4721
|
"required": false,
|
@@ -4770,7 +4770,7 @@
|
|
4770
4770
|
{
|
4771
4771
|
"disabled": false,
|
4772
4772
|
"document": "部门名称,最大长度为50个字符。",
|
4773
|
-
"example": "
|
4773
|
+
"example": "销售部门",
|
4774
4774
|
"member": "string",
|
4775
4775
|
"name": "DeptName",
|
4776
4776
|
"required": true,
|
@@ -4788,7 +4788,7 @@
|
|
4788
4788
|
{
|
4789
4789
|
"disabled": false,
|
4790
4790
|
"document": "电子签父部门ID。\n注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`",
|
4791
|
-
"example": "
|
4791
|
+
"example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
|
4792
4792
|
"member": "string",
|
4793
4793
|
"name": "ParentDeptId",
|
4794
4794
|
"required": false,
|
@@ -4797,7 +4797,7 @@
|
|
4797
4797
|
{
|
4798
4798
|
"disabled": false,
|
4799
4799
|
"document": "第三方平台中父部门ID。\n注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`",
|
4800
|
-
"example": "
|
4800
|
+
"example": "456",
|
4801
4801
|
"member": "string",
|
4802
4802
|
"name": "ParentDeptOpenId",
|
4803
4803
|
"required": false,
|
@@ -4806,7 +4806,7 @@
|
|
4806
4806
|
{
|
4807
4807
|
"disabled": false,
|
4808
4808
|
"document": "客户系统部门ID,最大长度为64个字符。",
|
4809
|
-
"example": "
|
4809
|
+
"example": "789",
|
4810
4810
|
"member": "string",
|
4811
4811
|
"name": "DeptOpenId",
|
4812
4812
|
"required": false,
|
@@ -4815,7 +4815,7 @@
|
|
4815
4815
|
{
|
4816
4816
|
"disabled": false,
|
4817
4817
|
"document": "排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。",
|
4818
|
-
"example": "
|
4818
|
+
"example": "1",
|
4819
4819
|
"member": "uint64",
|
4820
4820
|
"name": "OrderNo",
|
4821
4821
|
"required": false,
|
@@ -4830,7 +4830,7 @@
|
|
4830
4830
|
{
|
4831
4831
|
"disabled": false,
|
4832
4832
|
"document": "电子签部门ID。建议开发者保存此部门ID,方便后续查询或修改部门信息。",
|
4833
|
-
"example": "
|
4833
|
+
"example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
|
4834
4834
|
"member": "string",
|
4835
4835
|
"name": "DeptId",
|
4836
4836
|
"output_required": true,
|
@@ -4934,7 +4934,7 @@
|
|
4934
4934
|
{
|
4935
4935
|
"disabled": false,
|
4936
4936
|
"document": "角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。",
|
4937
|
-
"example": "
|
4937
|
+
"example": "销售分部角色",
|
4938
4938
|
"member": "string",
|
4939
4939
|
"name": "Name",
|
4940
4940
|
"required": true,
|
@@ -4952,7 +4952,7 @@
|
|
4952
4952
|
{
|
4953
4953
|
"disabled": false,
|
4954
4954
|
"document": "角色描述,最大长度为50个字符",
|
4955
|
-
"example": "
|
4955
|
+
"example": "销售分部角色",
|
4956
4956
|
"member": "string",
|
4957
4957
|
"name": "Description",
|
4958
4958
|
"required": false,
|
@@ -4961,7 +4961,7 @@
|
|
4961
4961
|
{
|
4962
4962
|
"disabled": false,
|
4963
4963
|
"document": "角色类型,0:saas角色,1:集团角色\n默认0,saas角色",
|
4964
|
-
"example": "
|
4964
|
+
"example": "0",
|
4965
4965
|
"member": "int64",
|
4966
4966
|
"name": "IsGroupRole",
|
4967
4967
|
"required": false,
|
@@ -4979,7 +4979,7 @@
|
|
4979
4979
|
{
|
4980
4980
|
"disabled": false,
|
4981
4981
|
"document": "集团角色的话,需要传递集团子企业列表,如果是全选,则传1",
|
4982
|
-
"example": "
|
4982
|
+
"example": "1",
|
4983
4983
|
"member": "string",
|
4984
4984
|
"name": "SubOrganizationIds",
|
4985
4985
|
"required": false,
|
@@ -5003,7 +5003,7 @@
|
|
5003
5003
|
{
|
5004
5004
|
"disabled": false,
|
5005
5005
|
"document": "角色id",
|
5006
|
-
"example": "
|
5006
|
+
"example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
|
5007
5007
|
"member": "string",
|
5008
5008
|
"name": "RoleId",
|
5009
5009
|
"output_required": false,
|
@@ -5034,7 +5034,7 @@
|
|
5034
5034
|
{
|
5035
5035
|
"disabled": false,
|
5036
5036
|
"document": "待激活成员企业ID集合",
|
5037
|
-
"example": "
|
5037
|
+
"example": "[\"yDt1JUUckp77a2tqUyEmko8RVpCEHoNA\"]",
|
5038
5038
|
"member": "string",
|
5039
5039
|
"name": "SubOrganizationIds",
|
5040
5040
|
"required": true,
|
@@ -5049,7 +5049,7 @@
|
|
5049
5049
|
{
|
5050
5050
|
"disabled": false,
|
5051
5051
|
"document": "激活失败的成员企业ID集合",
|
5052
|
-
"example": "
|
5052
|
+
"example": "[\"yDt1JUUckp77a2tqUyEmko8RVpCEHoNA\"]",
|
5053
5053
|
"member": "string",
|
5054
5054
|
"name": "FailedSubOrganizationIds",
|
5055
5055
|
"output_required": true,
|
@@ -5080,7 +5080,7 @@
|
|
5080
5080
|
{
|
5081
5081
|
"disabled": false,
|
5082
5082
|
"document": "绑定角色的用户id列表,不能重复,不能大于 100 个",
|
5083
|
-
"example": "
|
5083
|
+
"example": "[\"yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH\"]",
|
5084
5084
|
"member": "string",
|
5085
5085
|
"name": "UserIds",
|
5086
5086
|
"required": true,
|
@@ -5089,7 +5089,7 @@
|
|
5089
5089
|
{
|
5090
5090
|
"disabled": false,
|
5091
5091
|
"document": "绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取角色信息",
|
5092
|
-
"example": "
|
5092
|
+
"example": "[\"yDt1JUUckp77a2tqUyEmko8RVpCEHoNA\"]",
|
5093
5093
|
"member": "string",
|
5094
5094
|
"name": "RoleIds",
|
5095
5095
|
"required": true,
|
@@ -5253,7 +5253,7 @@
|
|
5253
5253
|
{
|
5254
5254
|
"disabled": false,
|
5255
5255
|
"document": "调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。\n回调的相关说明可参考开发者中心的<a href=\"https://qian.tencent.com/developers/company/callback_types_v2\" target=\"_blank\">回调通知</a>模块。",
|
5256
|
-
"example": "
|
5256
|
+
"example": "VXNlckRhdGE=",
|
5257
5257
|
"member": "string",
|
5258
5258
|
"name": "UserData",
|
5259
5259
|
"required": false,
|
@@ -5262,7 +5262,7 @@
|
|
5262
5262
|
{
|
5263
5263
|
"disabled": true,
|
5264
5264
|
"document": "已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置 \n<br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign\n<br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83\n",
|
5265
|
-
"example": "
|
5265
|
+
"example": "https://callback.cn/callback",
|
5266
5266
|
"member": "string",
|
5267
5267
|
"name": "CallbackUrl",
|
5268
5268
|
"required": false,
|
@@ -5289,7 +5289,7 @@
|
|
5289
5289
|
{
|
5290
5290
|
"disabled": false,
|
5291
5291
|
"document": "指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。",
|
5292
|
-
"example": "
|
5292
|
+
"example": "无",
|
5293
5293
|
"member": "ApproverComponentLimitType",
|
5294
5294
|
"name": "ApproverComponentLimitTypes",
|
5295
5295
|
"required": false,
|
@@ -5396,7 +5396,7 @@
|
|
5396
5396
|
{
|
5397
5397
|
"disabled": false,
|
5398
5398
|
"document": "授权书链接,有效期5分钟。",
|
5399
|
-
"example": "
|
5399
|
+
"example": "https://qian.tencent.cn/code=yDtwRUUckp7fyqz6UuQZAp18BNrB74xu",
|
5400
5400
|
"member": "string",
|
5401
5401
|
"name": "FileUrl",
|
5402
5402
|
"output_required": false,
|
@@ -6546,7 +6546,7 @@
|
|
6546
6546
|
{
|
6547
6547
|
"disabled": false,
|
6548
6548
|
"document": "调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。\n\n回调的相关说明可参考开发者中心的<a href=\"https://qian.tencent.com/developers/company/callback_types_v2\" target=\"_blank\">回调通知</a>模块。",
|
6549
|
-
"example": "
|
6549
|
+
"example": "VXNlckRhdGE=",
|
6550
6550
|
"member": "string",
|
6551
6551
|
"name": "UserData",
|
6552
6552
|
"required": false,
|
@@ -6561,7 +6561,7 @@
|
|
6561
6561
|
{
|
6562
6562
|
"disabled": false,
|
6563
6563
|
"document": "解除协议流程编号\n`注意:这里的流程编号对应的合同是本次发起的解除协议。`\n",
|
6564
|
-
"example": "
|
6564
|
+
"example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7",
|
6565
6565
|
"member": "string",
|
6566
6566
|
"name": "FlowId",
|
6567
6567
|
"output_required": true,
|
@@ -8940,7 +8940,7 @@
|
|
8940
8940
|
{
|
8941
8941
|
"disabled": false,
|
8942
8942
|
"document": "合同组ID,只有在查询合同组信息时才会返回。",
|
8943
|
-
"example": "
|
8943
|
+
"example": "yDt1iUUckp7xb05iUuWfBtZwW5IdVzLn",
|
8944
8944
|
"member": "string",
|
8945
8945
|
"name": "FlowGroupId",
|
8946
8946
|
"output_required": false,
|
@@ -8950,7 +8950,7 @@
|
|
8950
8950
|
{
|
8951
8951
|
"disabled": false,
|
8952
8952
|
"document": "合同组名称,只有在查询合同组信息时才会返回。",
|
8953
|
-
"example": "
|
8953
|
+
"example": "张三入职合同集",
|
8954
8954
|
"member": "string",
|
8955
8955
|
"name": "FlowGroupName",
|
8956
8956
|
"output_required": false,
|
@@ -10834,9 +10834,10 @@
|
|
10834
10834
|
{
|
10835
10835
|
"disabled": false,
|
10836
10836
|
"document": "查询过滤条件的Key",
|
10837
|
-
"example": "",
|
10837
|
+
"example": "Name",
|
10838
10838
|
"member": "string",
|
10839
10839
|
"name": "Key",
|
10840
|
+
"output_required": true,
|
10840
10841
|
"required": true,
|
10841
10842
|
"type": "string",
|
10842
10843
|
"value_allowed_null": false
|
@@ -10844,9 +10845,10 @@
|
|
10844
10845
|
{
|
10845
10846
|
"disabled": false,
|
10846
10847
|
"document": "查询过滤条件的Value列表",
|
10847
|
-
"example": "",
|
10848
|
+
"example": "[\"张三\"]",
|
10848
10849
|
"member": "string",
|
10849
10850
|
"name": "Values",
|
10851
|
+
"output_required": true,
|
10850
10852
|
"required": true,
|
10851
10853
|
"type": "list",
|
10852
10854
|
"value_allowed_null": false
|
@@ -11091,7 +11093,7 @@
|
|
11091
11093
|
{
|
11092
11094
|
"disabled": false,
|
11093
11095
|
"document": "签署节点ID,用于生成动态签署人链接完成领取。注:`生成动态签署人补充链接时必传。`",
|
11094
|
-
"example": "
|
11096
|
+
"example": "yDwJWUUcss36hUx8VMjPR4jOb5ugrMSx",
|
11095
11097
|
"member": "string",
|
11096
11098
|
"name": "RecipientId",
|
11097
11099
|
"required": false,
|
@@ -13057,7 +13059,7 @@
|
|
13057
13059
|
{
|
13058
13060
|
"disabled": false,
|
13059
13061
|
"document": "企业批量注册链接,根据Endpoint的不同设置,返回不同的链接地址。失效时间:7天\n跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表\n<table> <thead> <tr> <th>Endpoint</th> <th>示例</th> <th>链接有效期限</th> </tr> </thead> <tbody>\n <tr> <td>PC</td> <td>https://qian.tencent.com/console/batch-register?token=yDSx0UUgtjuaf4UEfd2MjCnfI1iuXFE6&orgName=批量认证线上测试企业9</td> <td>7天</td> </tr> \n<tr> <td>PC_SHORT_URL</td> <td>https://test.essurl.cn/8gDKUBAWK8</td> <td>7天</td> </tr> \n<tr> <td>APP</td> <td>/pages/guide/index?to=REGISTER_ENTERPRISE_FOR_BATCH&urlAuthToken=yDSx0UUgtjuaf4UEfd2MjCnfI1iuXFE6&orgName=批量认证线上测试企业9</td> <td>7天</td> </tr> </tbody> </table>\n注: \n`1.创建的链接应避免被转义,如:&被转义为\\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义`\n",
|
13060
|
-
"example": "
|
13062
|
+
"example": "https://test.essurl.cn/8gDKUBAWK8",
|
13061
13063
|
"member": "string",
|
13062
13064
|
"name": "AuthUrl",
|
13063
13065
|
"output_required": false,
|
@@ -13067,7 +13069,7 @@
|
|
13067
13069
|
{
|
13068
13070
|
"disabled": false,
|
13069
13071
|
"document": "企业批量注册的错误信息,例如:企业三要素不通过\t",
|
13070
|
-
"example": "
|
13072
|
+
"example": "企业三要素不通过",
|
13071
13073
|
"member": "string",
|
13072
13074
|
"name": "ErrorMessage",
|
13073
13075
|
"output_required": false,
|
@@ -14019,7 +14021,7 @@
|
|
14019
14021
|
{
|
14020
14022
|
"disabled": false,
|
14021
14023
|
"document": "签署控件类型,支持自定义企业签署方的签署控件类型\n<ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>\n<li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>",
|
14022
|
-
"example": "
|
14024
|
+
"example": "SIGN_SEAL",
|
14023
14025
|
"member": "string",
|
14024
14026
|
"name": "ApproverSignComponentType",
|
14025
14027
|
"required": false,
|
@@ -14884,7 +14886,7 @@
|
|
14884
14886
|
{
|
14885
14887
|
"disabled": false,
|
14886
14888
|
"document": "此模板的资源ID",
|
14887
|
-
"example": "
|
14889
|
+
"example": "[\"yDwJWUUcss36hUx8VMjPR4jOb5ugrMSx\"]",
|
14888
14890
|
"member": "string",
|
14889
14891
|
"name": "DocumentResourceIds",
|
14890
14892
|
"output_required": true,
|