tccli 3.0.990.1__py2.py3-none-any.whl → 3.0.992.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/examples/car/v20220110/DestroySession.md +1 -1
- tccli/examples/cls/v20201016/CheckFunction.md +25 -0
- tccli/examples/ess/v20201111/DescribeBillUsageDetail.md +108 -0
- tccli/examples/essbasic/v20210526/ChannelCreatePreparedPersonalEsign.md +92 -0
- tccli/examples/essbasic/v20210526/ChannelCreateReleaseFlow.md +94 -19
- tccli/examples/essbasic/v20210526/ChannelCreateSealPolicy.md +88 -0
- tccli/examples/essbasic/v20210526/ChannelDescribeEmployees.md +85 -45
- tccli/examples/essbasic/v20210526/DescribeBillUsageDetail.md +69 -0
- tccli/examples/essbasic/v20210526/SyncProxyOrganization.md +9 -9
- tccli/examples/mna/v20210119/GetNetMonitor.md +228 -0
- tccli/examples/ocr/v20181119/VatInvoiceVerifyNew.md +4 -0
- tccli/examples/tdmq/v20200217/DescribeRocketMQCluster.md +4 -4
- tccli/examples/teo/v20220901/BindSharedCNAME.md +48 -0
- tccli/examples/teo/v20220901/CreateSharedCNAME.md +4 -4
- tccli/examples/teo/v20220901/DeleteSharedCNAME.md +21 -0
- tccli/examples/waf/v20180125/DescribeCCRuleList.md +16 -2
- tccli/examples/waf/v20180125/DescribeModuleStatus.md +9 -1
- tccli/examples/waf/v20180125/ModifyModuleStatus.md +9 -1
- tccli/services/aiart/v20221229/api.json +2 -2
- tccli/services/car/v20220110/api.json +2 -2
- tccli/services/car/v20220110/examples.json +1 -1
- tccli/services/clb/v20180317/api.json +1 -1
- tccli/services/cls/cls_client.py +53 -0
- tccli/services/cls/v20201016/api.json +72 -0
- tccli/services/cls/v20201016/examples.json +8 -0
- tccli/services/ess/ess_client.py +53 -0
- tccli/services/ess/v20201111/api.json +228 -3
- tccli/services/ess/v20201111/examples.json +20 -0
- tccli/services/essbasic/v20210526/api.json +38 -29
- tccli/services/essbasic/v20210526/examples.json +51 -15
- tccli/services/mna/mna_client.py +53 -0
- tccli/services/mna/v20210119/api.json +142 -0
- tccli/services/mna/v20210119/examples.json +8 -0
- tccli/services/ocr/v20181119/api.json +65 -25
- tccli/services/ocr/v20181119/examples.json +1 -1
- tccli/services/tdmq/v20200217/api.json +107 -38
- tccli/services/tdmq/v20200217/examples.json +3 -3
- tccli/services/teo/teo_client.py +114 -8
- tccli/services/teo/v20220901/api.json +127 -4
- tccli/services/teo/v20220901/examples.json +26 -4
- tccli/services/waf/v20180125/api.json +194 -5
- tccli/services/waf/v20180125/examples.json +5 -5
- {tccli-3.0.990.1.dist-info → tccli-3.0.992.1.dist-info}/METADATA +2 -2
- {tccli-3.0.990.1.dist-info → tccli-3.0.992.1.dist-info}/RECORD +48 -42
- {tccli-3.0.990.1.dist-info → tccli-3.0.992.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.990.1.dist-info → tccli-3.0.992.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.990.1.dist-info → tccli-3.0.992.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -225,9 +225,9 @@
|
|
|
225
225
|
"status": "online"
|
|
226
226
|
},
|
|
227
227
|
"ChannelDescribeEmployees": {
|
|
228
|
-
"document": "
|
|
228
|
+
"document": "获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息，支持设置过滤条件以筛选员工查询结果。\n\n**注**:通过<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganizationOperators\" target=\"_blank\">企业员工新增或离职</a>接口增加的新员工或者离职的员工也会在列表中。",
|
|
229
229
|
"input": "ChannelDescribeEmployeesRequest",
|
|
230
|
-
"name": "
|
|
230
|
+
"name": "查询企业员工列表",
|
|
231
231
|
"output": "ChannelDescribeEmployeesResponse",
|
|
232
232
|
"status": "online"
|
|
233
233
|
},
|
|
@@ -407,14 +407,14 @@
|
|
|
407
407
|
"status": "online"
|
|
408
408
|
},
|
|
409
409
|
"SyncProxyOrganization": {
|
|
410
|
-
"document": "此接口（SyncProxyOrganization
|
|
410
|
+
"document": "此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。\n\n注意：\n\n- **需要在<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl\" target=\"_blank\">生成子客登录链接</a>前同步的企业信息**, 否则会出现信息同步没有用的情形\n- **企业信息需要和营业执照信息对应**, 否则会出现激活过程验证不通过的问题\n\n\n\n\n- **企业统一社会信用代码**: 对应上图中的**1**\n- **第三方平台子客企业名称**: 对应上图中的**2**\n- **企业法定代表人的名字**:对应上图中的**3**\n- **企业详细住所**:对应上图中的**4**",
|
|
411
411
|
"input": "SyncProxyOrganizationRequest",
|
|
412
412
|
"name": "同步企业信息",
|
|
413
413
|
"output": "SyncProxyOrganizationResponse",
|
|
414
414
|
"status": "online"
|
|
415
415
|
},
|
|
416
416
|
"SyncProxyOrganizationOperators": {
|
|
417
|
-
"document": "此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。 \n\n-
|
|
417
|
+
"document": "此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。 \n\n- **新增员工的场景**: 提前导入员工列表, 然后调用<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl\" target=\"_blank\">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署\n\n- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**\n\n\n\n**注**: \n- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理\n- <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职\n- 新增员工的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖",
|
|
418
418
|
"input": "SyncProxyOrganizationOperatorsRequest",
|
|
419
419
|
"name": "企业员工新增或离职",
|
|
420
420
|
"output": "SyncProxyOrganizationOperatorsResponse",
|
|
@@ -436,11 +436,11 @@
|
|
|
436
436
|
},
|
|
437
437
|
"objects": {
|
|
438
438
|
"Agent": {
|
|
439
|
-
"document": "
|
|
439
|
+
"document": "应用相关信息, 整体应用的层级图如下\n\n\n\n注:\n 1. `不同的业务系统可以采用不同的应用，不同应用下的数据是隔离的, 应用A中的某个企业已经实名, 在应用B中此企业还需要重新认证`",
|
|
440
440
|
"members": [
|
|
441
441
|
{
|
|
442
442
|
"disabled": false,
|
|
443
|
-
"document": "
|
|
443
|
+
"document": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:\n\n",
|
|
444
444
|
"example": "无",
|
|
445
445
|
"member": "string",
|
|
446
446
|
"name": "AppId",
|
|
@@ -467,7 +467,7 @@
|
|
|
467
467
|
},
|
|
468
468
|
{
|
|
469
469
|
"disabled": false,
|
|
470
|
-
"document": "
|
|
470
|
+
"document": "**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。",
|
|
471
471
|
"example": "无",
|
|
472
472
|
"member": "string",
|
|
473
473
|
"name": "ProxyAppId",
|
|
@@ -2684,7 +2684,7 @@
|
|
|
2684
2684
|
"members": [
|
|
2685
2685
|
{
|
|
2686
2686
|
"disabled": false,
|
|
2687
|
-
"document": "
|
|
2687
|
+
"document": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
|
|
2688
2688
|
"example": "无",
|
|
2689
2689
|
"member": "Agent",
|
|
2690
2690
|
"name": "Agent",
|
|
@@ -2702,7 +2702,7 @@
|
|
|
2702
2702
|
},
|
|
2703
2703
|
{
|
|
2704
2704
|
"disabled": false,
|
|
2705
|
-
"document": "
|
|
2705
|
+
"document": "证件号码, 应符合以下规则\n<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>\n<li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>",
|
|
2706
2706
|
"example": "无",
|
|
2707
2707
|
"member": "string",
|
|
2708
2708
|
"name": "IdCardNumber",
|
|
@@ -2711,7 +2711,7 @@
|
|
|
2711
2711
|
},
|
|
2712
2712
|
{
|
|
2713
2713
|
"disabled": false,
|
|
2714
|
-
"document": "
|
|
2714
|
+
"document": "电子印章名字，1-50个中文字符\n注:`同一企业下电子印章名字不能相同`",
|
|
2715
2715
|
"example": "无",
|
|
2716
2716
|
"member": "string",
|
|
2717
2717
|
"name": "SealName",
|
|
@@ -2720,7 +2720,7 @@
|
|
|
2720
2720
|
},
|
|
2721
2721
|
{
|
|
2722
2722
|
"disabled": false,
|
|
2723
|
-
"document": "
|
|
2723
|
+
"document": "电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式。\n\n",
|
|
2724
2724
|
"example": "无",
|
|
2725
2725
|
"member": "string",
|
|
2726
2726
|
"name": "SealImage",
|
|
@@ -2729,7 +2729,7 @@
|
|
|
2729
2729
|
},
|
|
2730
2730
|
{
|
|
2731
2731
|
"disabled": false,
|
|
2732
|
-
"document": "
|
|
2732
|
+
"document": "执行本接口操作的员工信息。\n注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
|
|
2733
2733
|
"example": "无",
|
|
2734
2734
|
"member": "UserInfo",
|
|
2735
2735
|
"name": "Operator",
|
|
@@ -2738,7 +2738,7 @@
|
|
|
2738
2738
|
},
|
|
2739
2739
|
{
|
|
2740
2740
|
"disabled": false,
|
|
2741
|
-
"document": "
|
|
2741
|
+
"document": "证件类型，支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE : 其他</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
|
|
2742
2742
|
"example": "无",
|
|
2743
2743
|
"member": "string",
|
|
2744
2744
|
"name": "IdCardType",
|
|
@@ -2789,7 +2789,7 @@
|
|
|
2789
2789
|
"members": [
|
|
2790
2790
|
{
|
|
2791
2791
|
"disabled": false,
|
|
2792
|
-
"document": "
|
|
2792
|
+
"document": "电子印章ID，为32位字符串。\n建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。\n可登录腾讯电子签控制台，在 \"印章\"->\"印章中心\"选择查看的印章，在\"印章详情\" 中查看某个印章的SealId(在页面中展示为印章ID)。",
|
|
2793
2793
|
"example": "无",
|
|
2794
2794
|
"member": "string",
|
|
2795
2795
|
"name": "SealId",
|
|
@@ -2838,7 +2838,7 @@
|
|
|
2838
2838
|
},
|
|
2839
2839
|
{
|
|
2840
2840
|
"disabled": false,
|
|
2841
|
-
"document": "
|
|
2841
|
+
"document": "指定解除协议的签署人，如不指定，则默认使用原流程的签署人。 <br/>\n如需更换原合同中的企业端签署人，可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href=\"https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/\">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号，默认从0开始，顺序递增)<br/>\n\n注意：\n<ul>\n<li>只能更换自己企业的签署人，不支持更换个人类型或者其他企业的签署人</li>\n<li>可以不指定替换签署人，使用原流程的签署人</li>\n</ul>",
|
|
2842
2842
|
"example": "无",
|
|
2843
2843
|
"member": "ReleasedApprover",
|
|
2844
2844
|
"name": "ReleasedApprovers",
|
|
@@ -2984,7 +2984,7 @@
|
|
|
2984
2984
|
"members": [
|
|
2985
2985
|
{
|
|
2986
2986
|
"disabled": false,
|
|
2987
|
-
"document": "
|
|
2987
|
+
"document": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。\n\n此接口下面信息必填。\n\n渠道应用标识: Agent.AppId\n第三方平台子客企业标识: Agent.ProxyOrganizationOpenId\n第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId\n第三方平台子客企业和员工必须已经经过实名认证。",
|
|
2988
2988
|
"example": "无",
|
|
2989
2989
|
"member": "Agent",
|
|
2990
2990
|
"name": "Agent",
|
|
@@ -2993,7 +2993,7 @@
|
|
|
2993
2993
|
},
|
|
2994
2994
|
{
|
|
2995
2995
|
"disabled": false,
|
|
2996
|
-
"document": "
|
|
2996
|
+
"document": "电子印章ID，为32位字符串。\n建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。\n可登录腾讯电子签控制台，在 \"印章\"->\"印章中心\"选择查看的印章，在\"印章详情\" 中查看某个印章的SealId(在页面中展示为印章ID)。",
|
|
2997
2997
|
"example": "无",
|
|
2998
2998
|
"member": "string",
|
|
2999
2999
|
"name": "SealId",
|
|
@@ -3002,7 +3002,7 @@
|
|
|
3002
3002
|
},
|
|
3003
3003
|
{
|
|
3004
3004
|
"disabled": false,
|
|
3005
|
-
"document": "指定待授权的用户ID数组,电子签的用户ID\n可以填写OpenId，系统会通过组织+渠道+OpenId查询得到UserId进行授权。",
|
|
3005
|
+
"document": "\n员工在腾讯电子签平台的唯一身份标识，为32位字符串。\n可登录腾讯电子签控制台，在 \"更多能力\"->\"组织管理\" 中查看某位员工的UserId(在页面中展示为用户ID)。\n员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。\n该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。\n指定待授权的用户ID数组,电子签的用户ID\n可以填写OpenId，系统会通过组织+渠道+OpenId查询得到UserId进行授权。",
|
|
3006
3006
|
"example": "无",
|
|
3007
3007
|
"member": "string",
|
|
3008
3008
|
"name": "UserIds",
|
|
@@ -3628,7 +3628,7 @@
|
|
|
3628
3628
|
},
|
|
3629
3629
|
{
|
|
3630
3630
|
"disabled": false,
|
|
3631
|
-
"document": "查询的关键字段，支持Key-Values查询。可选键值如下：\n<ul>\n <li>Key:**\"Status\"
|
|
3631
|
+
"document": "查询的关键字段，支持Key-Values查询。可选键值如下：\n<ul>\n <li>Key:**\"Status\"**，Values: **[\"IsVerified\"]**, 查询已实名的员工</li>\n <li>Key:**\"Status\"**，Values: **[\"QuiteJob\"]**, 查询离职员工</li>\n <li>Key:**\"StaffOpenId\"**，Values: **[\"OpenId1\",\"OpenId2\",...]**, 根据第三方系统用户OpenId查询员工</li>\n</ul>\n注: `同名字的Key的过滤条件会冲突, 只能填写一个`",
|
|
3632
3632
|
"example": "无",
|
|
3633
3633
|
"member": "Filter",
|
|
3634
3634
|
"name": "Filters",
|
|
@@ -3637,7 +3637,7 @@
|
|
|
3637
3637
|
},
|
|
3638
3638
|
{
|
|
3639
3639
|
"disabled": false,
|
|
3640
|
-
"document": "
|
|
3640
|
+
"document": "指定分页返回第几页的数据，如果不传默认返回第一页。\n页码从 0 开始，即首页为 0，最大20000。",
|
|
3641
3641
|
"example": "无",
|
|
3642
3642
|
"member": "int64",
|
|
3643
3643
|
"name": "Offset",
|
|
@@ -7921,7 +7921,7 @@
|
|
|
7921
7921
|
},
|
|
7922
7922
|
{
|
|
7923
7923
|
"disabled": false,
|
|
7924
|
-
"document": "申请证书的主体的名字\n\n如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下\n**企业**: ESS
|
|
7924
|
+
"document": "申请证书的主体的名字\n\n如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下\n**企业**: ESS@企业名称@平台生成的数字编码\n**个人**: ESS@个人姓名@证件号@平台生成的数字编码\n\n如果在其他平台签署的, 主体的名字参考其他平台的说明",
|
|
7925
7925
|
"example": "ESS@张三@37000019890303000X@808854",
|
|
7926
7926
|
"member": "string",
|
|
7927
7927
|
"name": "SignerName",
|
|
@@ -8508,7 +8508,7 @@
|
|
|
8508
8508
|
},
|
|
8509
8509
|
{
|
|
8510
8510
|
"disabled": false,
|
|
8511
|
-
"document": "指定签署人类型，目前支持\n<ul><li> **ORGANIZATION
|
|
8511
|
+
"document": "指定签署人类型，目前支持\n<ul><li> **ORGANIZATION**：企业(默认值)</li>\n<li> **ENTERPRISESERVER**：企业静默签</li></ul>",
|
|
8512
8512
|
"example": "ORGANIZATION",
|
|
8513
8513
|
"member": "string",
|
|
8514
8514
|
"name": "ApproverType",
|
|
@@ -8526,7 +8526,7 @@
|
|
|
8526
8526
|
},
|
|
8527
8527
|
{
|
|
8528
8528
|
"disabled": false,
|
|
8529
|
-
"document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD : 居民身份证
|
|
8529
|
+
"document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD : 居民身份证(默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
|
|
8530
8530
|
"example": "ID_CARD",
|
|
8531
8531
|
"member": "string",
|
|
8532
8532
|
"name": "IdCardType",
|
|
@@ -8535,7 +8535,7 @@
|
|
|
8535
8535
|
},
|
|
8536
8536
|
{
|
|
8537
8537
|
"disabled": false,
|
|
8538
|
-
"document": "证件号码，应符合以下规则\n<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X
|
|
8538
|
+
"document": "证件号码，应符合以下规则\n<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>\n<li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母(但“I”、“O”除外)，后7位为阿拉伯数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>",
|
|
8539
8539
|
"example": "620000198802020000",
|
|
8540
8540
|
"member": "string",
|
|
8541
8541
|
"name": "IdCardNumber",
|
|
@@ -9192,7 +9192,7 @@
|
|
|
9192
9192
|
"members": [
|
|
9193
9193
|
{
|
|
9194
9194
|
"disabled": false,
|
|
9195
|
-
"document": "
|
|
9195
|
+
"document": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: Agent.AppId</li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>\n</ul>\n",
|
|
9196
9196
|
"example": "无",
|
|
9197
9197
|
"member": "Agent",
|
|
9198
9198
|
"name": "Agent",
|
|
@@ -9201,7 +9201,7 @@
|
|
|
9201
9201
|
},
|
|
9202
9202
|
{
|
|
9203
9203
|
"disabled": false,
|
|
9204
|
-
"document": "
|
|
9204
|
+
"document": "第三方平台子客企业名称，请确认该名称与企业营业执照中注册的名称一致。\n注: `如果名称中包含英文括号()，请使用中文括号（）代替。`",
|
|
9205
9205
|
"example": "无",
|
|
9206
9206
|
"member": "string",
|
|
9207
9207
|
"name": "ProxyOrganizationName",
|
|
@@ -9228,7 +9228,7 @@
|
|
|
9228
9228
|
},
|
|
9229
9229
|
{
|
|
9230
9230
|
"disabled": false,
|
|
9231
|
-
"document": "
|
|
9231
|
+
"document": "第三方平台子客企业法定代表人的名字",
|
|
9232
9232
|
"example": "无",
|
|
9233
9233
|
"member": "string",
|
|
9234
9234
|
"name": "ProxyLegalName",
|
|
@@ -9246,7 +9246,7 @@
|
|
|
9246
9246
|
},
|
|
9247
9247
|
{
|
|
9248
9248
|
"disabled": false,
|
|
9249
|
-
"document": "
|
|
9249
|
+
"document": "第三方平台子客企业法定代表人的证件类型，支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>\n注: `现在仅支持ID_CARD居民身份证类型`",
|
|
9250
9250
|
"example": "无",
|
|
9251
9251
|
"member": "string",
|
|
9252
9252
|
"name": "ProxyLegalIdCardType",
|
|
@@ -9255,12 +9255,21 @@
|
|
|
9255
9255
|
},
|
|
9256
9256
|
{
|
|
9257
9257
|
"disabled": false,
|
|
9258
|
-
"document": "
|
|
9258
|
+
"document": "第三方平台子客企业法定代表人的证件号码, 应符合以下规则\n<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li></ul>",
|
|
9259
9259
|
"example": "无",
|
|
9260
9260
|
"member": "string",
|
|
9261
9261
|
"name": "ProxyLegalIdCardNumber",
|
|
9262
9262
|
"required": false,
|
|
9263
9263
|
"type": "string"
|
|
9264
|
+
},
|
|
9265
|
+
{
|
|
9266
|
+
"disabled": false,
|
|
9267
|
+
"document": "第三方平台子客企业详细住所，最大长度500个字符\n\n注：`需要符合省市区详情的格式例如： XX省XX市XX区街道具体地址`",
|
|
9268
|
+
"example": "深圳市南山区高新区科技中一路腾讯大厦35层",
|
|
9269
|
+
"member": "string",
|
|
9270
|
+
"name": "ProxyAddress",
|
|
9271
|
+
"required": false,
|
|
9272
|
+
"type": "string"
|
|
9264
9273
|
}
|
|
9265
9274
|
],
|
|
9266
9275
|
"type": "object"
|
|
@@ -258,20 +258,44 @@
|
|
|
258
258
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePreparedPersonalEsign\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"Agent\": {\n \"AppId\": \"abc\",\n \"ProxyOrganizationOpenId\": \"abc\",\n \"ProxyOperator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"ProxyAppId\": \"abc\",\n \"ProxyOrganizationId\": \"abc\"\n },\n \"UserName\": \"印章归属个人姓名\",\n \"IdCardType\": \"\",\n \"IdCardNumber\": \"身份证件号码\",\n \"SealImage\": \"印章图片Base64\",\n \"SealName\": \"我的印章名称\",\n \"Mobile\": \"135*111\",\n \"EnableAutoSign\": true\n}",
|
|
259
259
|
"output": "{\n \"Response\": {\n \"SealId\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
|
260
260
|
"title": "通过准备好的个人印章图片创建印章"
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"document": "参数IdCardNumber不能为空",
|
|
264
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePreparedPersonalEsign\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"Agent\": {\n \"AppId\": \"abc\",\n \"ProxyOrganizationOpenId\": \"abc\",\n \"ProxyOperator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"ProxyAppId\": \"abc\",\n \"ProxyOrganizationId\": \"abc\"\n },\n \"UserName\": \"abc\",\n \"IdCardType\": \"abc\",\n \"IdCardNumber\": \"\",\n \"SealName\": \"abc\",\n \"SealImage\": \"abc\",\n \"SealImageCompress\": true,\n \"Mobile\": \"abc\",\n \"EnableAutoSign\": true,\n \"LicenseType\": 0\n}",
|
|
265
|
+
"output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue\",\n \"Message\": \"参数IdCardNumber不能为空\"\n },\n \"RequestId\": \"abc\"\n }\n}",
|
|
266
|
+
"title": "参数IdCardNumber不能为空"
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"document": "参数UserName不能为空",
|
|
270
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePreparedPersonalEsign\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"Agent\": {\n \"AppId\": \"abc\",\n \"ProxyOrganizationOpenId\": \"abc\",\n \"ProxyOperator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"ProxyAppId\": \"abc\",\n \"ProxyOrganizationId\": \"abc\"\n },\n \"UserName\": \"\",\n \"IdCardType\": \"abc\",\n \"IdCardNumber\": \"abc\",\n \"SealName\": \"abc\",\n \"SealImage\": \"abc\",\n \"SealImageCompress\": true,\n \"Mobile\": \"abc\",\n \"EnableAutoSign\": true,\n \"LicenseType\": 0\n}",
|
|
271
|
+
"output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue\",\n \"Message\": \"参数UserName不能为空\"\n },\n \"RequestId\": \"xxxx111xxxx\"\n }\n}",
|
|
272
|
+
"title": "参数UserName不能为空"
|
|
261
273
|
}
|
|
262
274
|
],
|
|
263
275
|
"ChannelCreateReleaseFlow": [
|
|
276
|
+
{
|
|
277
|
+
"document": "1. 使用本企业的签署人\n2. 包含了详细的解除内容\n3. 替换原流程中本企业的签署人\n4. 被替换的原流程中的签署人ApproverNumber=1(即第二个签署人，在原流程签署人列表中的第二位)\n\n扩展信息：\n针对ApproverNumber举个例子，\n例如在原流程中共有三个签署人(a, b, c)，\n那么a是第一位(ApproverNumber=0)，b是第二位(ApproverNumber=1)，c是第三位(ApproverNumber=2)，\n注意这里的顺序不是签署顺序，仅仅是签署人列表中的自然顺序，签署人列表的获取可以参考DescribeFlowDetailInfo接口。",
|
|
278
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n \"ReleasedApprovers\": [\n {\n \"ApproverNumber\": 1,\n \"Name\": \"典子谦\",\n \"Mobile\": \"13200000000\",\n \"ApproverType\": \"ORGANIZATION\",\n \"OrganizationName\": \"典子谦示例企业\"\n }\n ],\n \"ReliveInfo\": {\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\",\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿。\",\n \"OriginalOtherSettlement\": \"无\",\n \"OtherDeals\": \"无\"\n }\n}",
|
|
279
|
+
"output": "{\n \"Response\": {\n \"FlowId\": \"yDwFdUUckps******xAhL7zuaIwkMth4\",\n \"RequestId\": \"s1669**2203341\"\n }\n}",
|
|
280
|
+
"title": "发起解除协议(使用本企业的签署人，替换用原流程中本企业的签署人)"
|
|
281
|
+
},
|
|
282
|
+
{
|
|
283
|
+
"document": "1. 更换原合同中本方企业的参与人\n2. 给该企业参与人指定自定义的角色名称(通过设置ApproverSignRole)\n3. 给该企业参与人指定签署控件类型为手写签名(通过设置ApproverSignComponentType)",
|
|
284
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n \"ReleasedApprovers\": [\n {\n \"ApproverNumber\": 1,\n \"ApproverSignComponentType\": \"SIGN_SIGNATURE\",\n \"ApproverSignRole\": \"自定义的签署方角色(供应商)\",\n \"ApproverType\": \"ORGANIZATION\",\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"OrganizationName\": \"典子谦示例企业\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿。\",\n \"OriginalOtherSettlement\": \"无\",\n \"OtherDeals\": \"无\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
|
|
285
|
+
"output": "{\n \"Response\": {\n \"FlowId\": \"yDwgkUU7y***********zWBfv\",\n \"RequestId\": \"s168809**839\"\n }\n}",
|
|
286
|
+
"title": "发起解除协议(替换原流程中本企业的参与人并指定签署人角色、签署控件)"
|
|
287
|
+
},
|
|
264
288
|
{
|
|
265
289
|
"document": "1. 使用原流程的签署人\n2. 包含了详细的解除内容",
|
|
266
290
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n \"ReliveInfo\": {\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\",\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿。\",\n \"OriginalOtherSettlement\": \"无\",\n \"OtherDeals\": \"无\"\n }\n}",
|
|
267
291
|
"output": "{\n \"Response\": {\n \"FlowId\": \"yDwFdUUckps******xAhL7zuaIwkMth\",\n \"RequestId\": \"s1669**2203341\"\n }\n}",
|
|
268
|
-
"title": "
|
|
292
|
+
"title": "发起解除协议(默认情况，使用原流程的签署人)"
|
|
269
293
|
},
|
|
270
294
|
{
|
|
271
|
-
"document": "1.
|
|
272
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"
|
|
273
|
-
"output": "{\n \"Response\": {\n \"
|
|
274
|
-
"title": "
|
|
295
|
+
"document": "1. 解除某个包含个人类型签署人的合同\n2. 更换其他个人类型签署人作为解除协议的参与人",
|
|
296
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"NeedRelievedFlowId\": \"yDR1AUUgygjazuesUuO4zjESPW4PkfNi\",\n \"ReleasedApprovers\": [\n {\n \"ApproverNumber\": 2,\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"15100000000\",\n \"Name\": \"李四\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"无\",\n \"OtherDeals\": \"无\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
|
|
297
|
+
"output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation\",\n \"Message\": \"不能更换非企业签署人身份信息\"\n },\n \"RequestId\": \"s16939***23898\"\n }\n}",
|
|
298
|
+
"title": "错误示例-解除协议中更换原合同个人类型的参与人"
|
|
275
299
|
}
|
|
276
300
|
],
|
|
277
301
|
"ChannelCreateRole": [
|
|
@@ -294,6 +318,18 @@
|
|
|
294
318
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateSealPolicy\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"yDxAyUyK****cb7u0jQn0Zh7f7\",\n \"ProxyOperator\": {\n \"OpenId\": \"732aaef****541b89c49e0cc\"\n },\n \"AppId\": \"ed68bc6***********0214e4e\"\n },\n \"SealId\": \"yDRTZxxxxxJNR\",\n \"UserIds\": [\n \"yDdzlxxxxxopk\"\n ]\n}",
|
|
295
319
|
"output": "{\n \"Response\": {\n \"UserIds\": [\n \"yDdzlxxxxxopk\"\n ],\n \"RequestId\": \"fdasfavdavxxxx\"\n }\n}",
|
|
296
320
|
"title": "创建印章授权"
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"document": "授权时，找不到对应的 UserId",
|
|
324
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateSealPolicy\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"abc\",\n \"ProxyOrganizationOpenId\": \"abc\",\n \"ProxyOperator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"ProxyAppId\": \"abc\",\n \"ProxyOrganizationId\": \"abc\"\n },\n \"SealId\": \"abc\",\n \"UserIds\": [\n \"abc\",\n \"xxxid\"\n ],\n \"Operator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"Organization\": {\n \"OrganizationId\": \"abc\",\n \"Channel\": \"abc\",\n \"OrganizationOpenId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n }\n}",
|
|
325
|
+
"output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameter.ParamError\",\n \"Message\": \"无效的授权用户Id\"\n },\n \"RequestId\": \"abc\"\n }\n}",
|
|
326
|
+
"title": "授权时，找不到对应的 UserId"
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"document": "授权时，缺少印章ID",
|
|
330
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateSealPolicy\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"abc\",\n \"ProxyOrganizationOpenId\": \"abc\",\n \"ProxyOperator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"ProxyAppId\": \"abc\",\n \"ProxyOrganizationId\": \"abc\"\n },\n \"SealId\": \"\",\n \"UserIds\": [\n \"abc\"\n ],\n \"Operator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"Organization\": {\n \"OrganizationId\": \"abc\",\n \"Channel\": \"abc\",\n \"OrganizationOpenId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n }\n}",
|
|
331
|
+
"output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameter.ParamError\",\n \"Message\": \"缺失印章ID\"\n },\n \"RequestId\": \"abc\"\n }\n}",
|
|
332
|
+
"title": "授权时，缺少印章ID"
|
|
297
333
|
}
|
|
298
334
|
],
|
|
299
335
|
"ChannelCreateUserAutoSignEnableUrl": [
|
|
@@ -384,16 +420,16 @@
|
|
|
384
420
|
],
|
|
385
421
|
"ChannelDescribeEmployees": [
|
|
386
422
|
{
|
|
387
|
-
"document": "
|
|
388
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelDescribeEmployees\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"
|
|
389
|
-
"output": "{\n \"Response\": {\n \"Employees\": [\n {\n \"
|
|
390
|
-
"title": "
|
|
423
|
+
"document": "Filter参数Key设置为\"Status\",Values设置为\"IsVerified\"表示查询已实名员工",
|
|
424
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelDescribeEmployees\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyAppId\": \"\"\n },\n \"Filters\": [\n {\n \"Key\": \"Status\",\n \"Values\": [\n \"IsVerified\"\n ]\n }\n ],\n \"Offset\": 0,\n \"Limit\": 20\n}",
|
|
425
|
+
"output": "{\n \"Response\": {\n \"Employees\": [\n {\n \"UserId\": \"yDSLNUUckpossi8fUy98I4ESq4EmlpEd\",\n \"DisplayName\": \"张三\",\n \"Mobile\": \"18888888888\",\n \"Email\": \"\",\n \"OpenId\": \"n02468\",\n \"Roles\": [\n {\n \"RoleId\": \"yDSLOUUckpojqpkmUEJmzYK68ctIyPFp\",\n \"RoleName\": \"业务员\"\n }\n ],\n \"Department\": {\n \"DepartmentId\": \"\",\n \"DepartmentName\": \"\"\n },\n \"Verified\": true,\n \"CreatedOn\": 1699087891,\n \"VerifiedOn\": 1699088080,\n \"QuiteJob\": 0\n },\n {\n \"UserId\": \"yDwi0UUckpohyi32UEdhBFEEbigdd0Dd\",\n \"DisplayName\": \"李四\",\n \"Mobile\": \"15100000000\",\n \"Email\": \"\",\n \"OpenId\": \"n123456\",\n \"Roles\": [\n {\n \"RoleId\": \"69997f600a7c8e9accc71f4241a8a091\",\n \"RoleName\": \"超级管理员\"\n }\n ],\n \"Department\": {\n \"DepartmentId\": \"\",\n \"DepartmentName\": \"\"\n },\n \"Verified\": true,\n \"CreatedOn\": 1698814301,\n \"VerifiedOn\": 1698814443,\n \"QuiteJob\": 0\n }\n ],\n \"Offset\": 0,\n \"Limit\": 20,\n \"TotalCount\": 2,\n \"RequestId\": \"e0461ce0-455c-410b-873b-f33de95f281f\"\n }\n}",
|
|
426
|
+
"title": "查询已实名员工列表"
|
|
391
427
|
},
|
|
392
428
|
{
|
|
393
|
-
"document": "
|
|
394
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelDescribeEmployees\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"
|
|
395
|
-
"output": "{\n \"Response\": {\n \"
|
|
396
|
-
"title": "
|
|
429
|
+
"document": "Filter参数Key设置为\"StaffOpenId\",Values设置为员工的OpenId列表",
|
|
430
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelDescribeEmployees\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyAppId\": \"\"\n },\n \"Filters\": [\n {\n \"Key\": \"StaffOpenId\",\n \"Values\": [\n \"n02468\",\n \"n123456\"\n ]\n }\n ],\n \"Offset\": 0,\n \"Limit\": 20\n}",
|
|
431
|
+
"output": "{\n \"Response\": {\n \"Employees\": [\n {\n \"UserId\": \"\",\n \"DisplayName\": \"张三\",\n \"Mobile\": \"18888888888\",\n \"Email\": \"\",\n \"OpenId\": \"n02468\",\n \"Roles\": [],\n \"Department\": {\n \"DepartmentId\": \"\",\n \"DepartmentName\": \"\"\n },\n \"Verified\": false,\n \"CreatedOn\": 1699095474,\n \"VerifiedOn\": 0,\n \"QuiteJob\": 0\n },\n {\n \"UserId\": \"\",\n \"DisplayName\": \"李四\",\n \"Mobile\": \"15100000000\",\n \"Email\": \"\",\n \"OpenId\": \"n123456\",\n \"Roles\": [],\n \"Department\": {\n \"DepartmentId\": \"\",\n \"DepartmentName\": \"\"\n },\n \"Verified\": false,\n \"CreatedOn\": 1699095486,\n \"VerifiedOn\": 0,\n \"QuiteJob\": 1\n }\n ],\n \"Offset\": 0,\n \"Limit\": 20,\n \"TotalCount\": 2,\n \"RequestId\": \"4ab55898-527c-47d1-a2bd-79b81471b563\"\n }\n}",
|
|
432
|
+
"title": "查询某几个员工列表"
|
|
397
433
|
}
|
|
398
434
|
],
|
|
399
435
|
"ChannelDescribeFlowComponents": [
|
|
@@ -737,8 +773,8 @@
|
|
|
737
773
|
"SyncProxyOrganization": [
|
|
738
774
|
{
|
|
739
775
|
"document": "同步企业信息",
|
|
740
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SyncProxyOrganization\n<公共请求参数>\n\n{\n \"ProxyOrganizationName\": \"
|
|
741
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
776
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SyncProxyOrganization\n<公共请求参数>\n\n{\n \"ProxyOrganizationName\": \"典子谦示例企业\",\n \"UniformSocialCreditCode\": \"BOLIU101304662708A \",\n \"BusinessLicense\": \"aHR0cHM6Ly9jYXBpLndvYS5jb20vhaWwlM0ZpZCUzRGVzc2Jhc2ljJTI2dGFiJTNEYXBp..图片base64省略\",\n \"ProxyLegalName\": \"典子谦\",\n \"ProxyLegalIdCardType\": \"ID_CARD\",\n \"ProxyLegalIdCardNumber\": \"620000198802020000\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"n31517\"\n },\n \"ProxyOrganizationOpenId\": \"org_zhansan\",\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\"\n }\n}",
|
|
777
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"8fb09e62-9642-44c8-992b-ddd6e5086293\"\n }\n}",
|
|
742
778
|
"title": "同步企业信息"
|
|
743
779
|
}
|
|
744
780
|
],
|
tccli/services/mna/mna_client.py
CHANGED
|
@@ -17,6 +17,58 @@ from tencentcloud.mna.v20210119 import models as models_v20210119
|
|
|
17
17
|
from jmespath import search
|
|
18
18
|
import time
|
|
19
19
|
|
|
20
|
+
def doGetNetMonitor(args, parsed_globals):
|
|
21
|
+
g_param = parse_global_arg(parsed_globals)
|
|
22
|
+
|
|
23
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
|
24
|
+
cred = credential.CVMRoleCredential()
|
|
25
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
|
26
|
+
cred = credential.STSAssumeRoleCredential(
|
|
27
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
|
28
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')]
|
|
29
|
+
)
|
|
30
|
+
elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
|
|
31
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
|
32
|
+
else:
|
|
33
|
+
cred = credential.Credential(
|
|
34
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
|
35
|
+
)
|
|
36
|
+
http_profile = HttpProfile(
|
|
37
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
|
38
|
+
reqMethod="POST",
|
|
39
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
|
40
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
|
41
|
+
)
|
|
42
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
|
43
|
+
if g_param[OptionsDefine.Language]:
|
|
44
|
+
profile.language = g_param[OptionsDefine.Language]
|
|
45
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
|
46
|
+
client = mod.MnaClient(cred, g_param[OptionsDefine.Region], profile)
|
|
47
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
|
48
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
|
49
|
+
model = models.GetNetMonitorRequest()
|
|
50
|
+
model.from_json_string(json.dumps(args))
|
|
51
|
+
start_time = time.time()
|
|
52
|
+
while True:
|
|
53
|
+
rsp = client.GetNetMonitor(model)
|
|
54
|
+
result = rsp.to_json_string()
|
|
55
|
+
try:
|
|
56
|
+
json_obj = json.loads(result)
|
|
57
|
+
except TypeError as e:
|
|
58
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
|
59
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
|
60
|
+
break
|
|
61
|
+
cur_time = time.time()
|
|
62
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
|
63
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
|
64
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
|
65
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
|
66
|
+
else:
|
|
67
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
|
68
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
|
69
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
|
70
|
+
|
|
71
|
+
|
|
20
72
|
def doGetStatisticData(args, parsed_globals):
|
|
21
73
|
g_param = parse_global_arg(parsed_globals)
|
|
22
74
|
|
|
@@ -704,6 +756,7 @@ MODELS_MAP = {
|
|
|
704
756
|
}
|
|
705
757
|
|
|
706
758
|
ACTION_MAP = {
|
|
759
|
+
"GetNetMonitor": doGetNetMonitor,
|
|
707
760
|
"GetStatisticData": doGetStatisticData,
|
|
708
761
|
"AddDevice": doAddDevice,
|
|
709
762
|
"CreateQos": doCreateQos,
|