tccli 3.0.1236.1__py2.py3-none-any.whl → 3.0.1238.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (149) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +3 -0
  3. tccli/services/aca/__init__.py +4 -0
  4. tccli/services/aca/aca_client.py +578 -0
  5. tccli/services/aca/v20210323/api.json +3715 -0
  6. tccli/services/aca/v20210323/examples.json +69 -0
  7. tccli/services/aiart/v20221229/api.json +18 -9
  8. tccli/services/aiart/v20221229/examples.json +2 -2
  9. tccli/services/apm/v20210622/api.json +25 -22
  10. tccli/services/apm/v20210622/examples.json +16 -22
  11. tccli/services/ba/v20200720/api.json +3 -2
  12. tccli/services/batch/v20170312/api.json +641 -566
  13. tccli/services/batch/v20170312/examples.json +7 -7
  14. tccli/services/bi/v20220105/api.json +9 -0
  15. tccli/services/billing/v20180709/api.json +2 -2
  16. tccli/services/bpaas/v20181217/examples.json +1 -1
  17. tccli/services/cam/v20190116/api.json +116 -99
  18. tccli/services/cam/v20190116/examples.json +11 -11
  19. tccli/services/ccc/v20200210/api.json +40 -1
  20. tccli/services/ccc/v20200210/examples.json +1 -1
  21. tccli/services/cdb/cdb_client.py +53 -0
  22. tccli/services/cdb/v20170320/api.json +257 -207
  23. tccli/services/cdb/v20170320/examples.json +18 -10
  24. tccli/services/cdwch/v20200915/api.json +6 -6
  25. tccli/services/cdwdoris/v20211228/api.json +16 -5
  26. tccli/services/cdwdoris/v20211228/examples.json +1 -1
  27. tccli/services/cfg/v20210820/api.json +29 -13
  28. tccli/services/cfg/v20210820/examples.json +1 -1
  29. tccli/services/cfs/v20190719/api.json +84 -84
  30. tccli/services/cfs/v20190719/examples.json +6 -6
  31. tccli/services/chdfs/v20201112/api.json +18 -17
  32. tccli/services/chdfs/v20201112/examples.json +2 -2
  33. tccli/services/clb/v20180317/api.json +184 -162
  34. tccli/services/cloudapp/v20220530/api.json +11 -1
  35. tccli/services/cloudapp/v20220530/examples.json +3 -3
  36. tccli/services/cloudaudit/v20190319/api.json +64 -53
  37. tccli/services/cloudaudit/v20190319/examples.json +5 -5
  38. tccli/services/cls/v20201016/api.json +21 -21
  39. tccli/services/cls/v20201016/examples.json +1 -1
  40. tccli/services/config/v20220802/api.json +2 -0
  41. tccli/services/config/v20220802/examples.json +2 -2
  42. tccli/services/cvm/v20170312/api.json +5 -5
  43. tccli/services/cynosdb/cynosdb_client.py +53 -0
  44. tccli/services/cynosdb/v20190107/api.json +110 -0
  45. tccli/services/cynosdb/v20190107/examples.json +8 -0
  46. tccli/services/dcdb/v20180411/api.json +390 -387
  47. tccli/services/dcdb/v20180411/examples.json +14 -14
  48. tccli/services/dlc/v20210125/api.json +162 -7
  49. tccli/services/dlc/v20210125/examples.json +1 -1
  50. tccli/services/domain/v20180808/api.json +55 -54
  51. tccli/services/domain/v20180808/examples.json +38 -32
  52. tccli/services/dsgc/v20190723/api.json +1796 -1623
  53. tccli/services/dsgc/v20190723/examples.json +217 -211
  54. tccli/services/dts/v20180330/api.json +143 -106
  55. tccli/services/dts/v20211206/api.json +57 -46
  56. tccli/services/dts/v20211206/examples.json +1 -1
  57. tccli/services/ecm/v20190719/api.json +6 -6
  58. tccli/services/emr/v20190103/api.json +80 -20
  59. tccli/services/ess/ess_client.py +118 -12
  60. tccli/services/ess/v20201111/api.json +320 -37
  61. tccli/services/ess/v20201111/examples.json +19 -3
  62. tccli/services/essbasic/essbasic_client.py +167 -8
  63. tccli/services/essbasic/v20210526/api.json +528 -55
  64. tccli/services/essbasic/v20210526/examples.json +46 -16
  65. tccli/services/facefusion/v20220927/api.json +12 -1
  66. tccli/services/fmu/v20191213/api.json +8 -8
  67. tccli/services/gaap/v20180529/api.json +200 -209
  68. tccli/services/gwlb/v20240906/api.json +16 -16
  69. tccli/services/gwlb/v20240906/examples.json +2 -2
  70. tccli/services/hai/v20230812/api.json +1 -1
  71. tccli/services/hunyuan/v20230901/api.json +6 -6
  72. tccli/services/iss/v20230517/api.json +11 -11
  73. tccli/services/iss/v20230517/examples.json +31 -31
  74. tccli/services/keewidb/v20220308/api.json +92 -82
  75. tccli/services/keewidb/v20220308/examples.json +5 -5
  76. tccli/services/lcic/v20220817/api.json +3 -3
  77. tccli/services/lcic/v20220817/examples.json +2 -2
  78. tccli/services/lighthouse/v20200324/api.json +18 -18
  79. tccli/services/lighthouse/v20200324/examples.json +6 -6
  80. tccli/services/live/v20180801/api.json +32 -14
  81. tccli/services/lke/v20231130/examples.json +1 -1
  82. tccli/services/mariadb/v20170312/api.json +285 -263
  83. tccli/services/mariadb/v20170312/examples.json +12 -12
  84. tccli/services/mongodb/v20180408/api.json +52 -40
  85. tccli/services/mongodb/v20180408/examples.json +4 -4
  86. tccli/services/mongodb/v20190725/api.json +119 -109
  87. tccli/services/mongodb/v20190725/examples.json +5 -5
  88. tccli/services/monitor/monitor_client.py +106 -0
  89. tccli/services/monitor/v20180724/api.json +222 -0
  90. tccli/services/monitor/v20180724/examples.json +17 -1
  91. tccli/services/mps/mps_client.py +228 -16
  92. tccli/services/mps/v20190612/api.json +385 -23
  93. tccli/services/mps/v20190612/examples.json +32 -0
  94. tccli/services/mqtt/v20240516/api.json +1 -1
  95. tccli/services/mqtt/v20240516/examples.json +1 -1
  96. tccli/services/msp/v20180319/api.json +2 -2
  97. tccli/services/ocr/v20181119/api.json +11 -1
  98. tccli/services/omics/v20221128/api.json +14 -2
  99. tccli/services/organization/v20210331/api.json +45 -18
  100. tccli/services/privatedns/v20201028/api.json +90 -81
  101. tccli/services/privatedns/v20201028/examples.json +18 -18
  102. tccli/services/pts/v20210728/api.json +8 -0
  103. tccli/services/redis/redis_client.py +106 -0
  104. tccli/services/redis/v20180412/api.json +178 -16
  105. tccli/services/redis/v20180412/examples.json +16 -0
  106. tccli/services/region/v20220627/api.json +5 -3
  107. tccli/services/region/v20220627/examples.json +1 -1
  108. tccli/services/ssl/v20191205/api.json +6 -4
  109. tccli/services/ssl/v20191205/examples.json +1 -1
  110. tccli/services/sts/v20180813/examples.json +1 -1
  111. tccli/services/tag/v20180813/api.json +4 -5
  112. tccli/services/tcb/v20180608/api.json +36 -16
  113. tccli/services/tdid/v20210519/api.json +30 -38
  114. tccli/services/tdid/v20210519/examples.json +5 -5
  115. tccli/services/tdmq/tdmq_client.py +53 -0
  116. tccli/services/tdmq/v20200217/api.json +64 -1
  117. tccli/services/tdmq/v20200217/examples.json +9 -1
  118. tccli/services/teo/teo_client.py +485 -8
  119. tccli/services/teo/v20220901/api.json +837 -39
  120. tccli/services/teo/v20220901/examples.json +108 -0
  121. tccli/services/thpc/v20211109/api.json +32 -34
  122. tccli/services/thpc/v20220401/api.json +31 -33
  123. tccli/services/thpc/v20230321/api.json +55 -57
  124. tccli/services/thpc/v20230321/examples.json +1 -1
  125. tccli/services/tiia/v20190529/api.json +307 -293
  126. tccli/services/tiia/v20190529/examples.json +41 -41
  127. tccli/services/tione/v20211111/api.json +4 -4
  128. tccli/services/tione/v20211111/examples.json +2 -2
  129. tccli/services/tke/v20180525/api.json +1 -1
  130. tccli/services/trocket/trocket_client.py +53 -0
  131. tccli/services/trocket/v20230308/api.json +119 -3
  132. tccli/services/trocket/v20230308/examples.json +14 -0
  133. tccli/services/tse/v20201207/api.json +188 -120
  134. tccli/services/tse/v20201207/examples.json +30 -30
  135. tccli/services/tsf/v20180326/api.json +826 -745
  136. tccli/services/tsf/v20180326/examples.json +99 -111
  137. tccli/services/vclm/v20240523/api.json +1 -1
  138. tccli/services/vdb/v20230616/api.json +80 -80
  139. tccli/services/vdb/v20230616/examples.json +1 -1
  140. tccli/services/vpc/v20170312/api.json +64 -44
  141. tccli/services/vpc/v20170312/examples.json +6 -6
  142. tccli/services/vrs/v20200824/api.json +3 -2
  143. tccli/services/wedata/v20210820/api.json +550 -40
  144. tccli/services/wedata/v20210820/examples.json +10 -4
  145. {tccli-3.0.1236.1.dist-info → tccli-3.0.1238.1.dist-info}/METADATA +2 -2
  146. {tccli-3.0.1236.1.dist-info → tccli-3.0.1238.1.dist-info}/RECORD +149 -145
  147. {tccli-3.0.1236.1.dist-info → tccli-3.0.1238.1.dist-info}/WHEEL +0 -0
  148. {tccli-3.0.1236.1.dist-info → tccli-3.0.1238.1.dist-info}/entry_points.txt +0 -0
  149. {tccli-3.0.1236.1.dist-info → tccli-3.0.1238.1.dist-info}/license_files/LICENSE +0 -0
@@ -71,7 +71,7 @@
71
71
  "status": "online"
72
72
  },
73
73
  "CreateBatchSignUrl": {
74
- "document": "通过此接口,可以创建小程序批量签署链接,个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。\n\n注意事项:\n- 使用此接口生成链接,需要贵企业先开通 <font color=\"red\">个人签署方仅校验手机号 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。\n- 生成批量签署链接时,<font color=\"red\">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人点击链接后需要输入短信验证码才能查看合同内容。\n- 企业员工批量签署链接:需要传入签署方所在企业名称,用户名字和手机号(或者身份证件信息)参数来生成签署链接。<font color=\"red\">该签署方企业必须已完成腾讯电子签企业认证</font>\n- 个人批量签署链接:需要传入签署方用户名字和手机号(或者身份证件信息)参数来生成签署链接。个人批量签署进行的合同的签名区, 全部变成<font color=\"red\">手写签名</font>(不管合同里边设置的签名限制)来进行。",
74
+ "document": "通过此接口,可以创建小程序批量签署链接,个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。\n\n注意事项:\n- 使用此接口生成链接,需要贵企业先开通 <font color=\"red\">个人签署方仅校验手机号 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。\n- 生成批量签署链接时,<font color=\"red\">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人点击链接后需要输入短信验证码才能查看合同内容。\n- 企业员工批量签署链接:需要传入签署方所在企业名称,用户名字和手机号(或者身份证件信息)参数来生成签署链接。<font color=\"red\">该签署方企业必须已完成腾讯电子签企业认证</font>\n- 个人批量签署链接:需要传入签署方用户名字和手机号(或者身份证件信息)参数来生成签署链接。个人批量签署进行的合同的签名区, 全部变成<font color=\"red\">手写签名</font>(不管合同里边设置的签名限制)来进行。\n- 不支持签署方含有签批控件,或设置了签署方在签署时自行添加签署控件功能的合同进行批量签署。",
75
75
  "input": "CreateBatchSignUrlRequest",
76
76
  "name": "获取跳转至腾讯电子签小程序的批量签署链接",
77
77
  "output": "CreateBatchSignUrlResponse",
@@ -245,6 +245,13 @@
245
245
  "output": "CreateMultiFlowSignQRCodeResponse",
246
246
  "status": "online"
247
247
  },
248
+ "CreateOrganizationAuthFile": {
249
+ "document": "生成合成后的各类企业授权书,包括:\n- 企业认证超管授权书\n- 超管变更授权书\n- 企业注销授权书\n\n注: 需自行保证传入真实的企业/法人/超管信息,否则后续的审核将会拒绝。",
250
+ "input": "CreateOrganizationAuthFileRequest",
251
+ "name": "生成企业授权书",
252
+ "output": "CreateOrganizationAuthFileResponse",
253
+ "status": "online"
254
+ },
248
255
  "CreateOrganizationAuthUrl": {
249
256
  "document": "本接口(CreateOrganizationAuthUrl)的主要功能是生成合作企业的认证链接。\n\n在生成链接的过程中,可以提供一部分已知信息,以便为对方进行认证流程提供便利。\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/7ec91b79a0a4860e77c9ff9f4a5f13ad/channel_SyncProxyOrganization2.png)\n\n\n- **企业统一社会信用代码**: 对应上图中的**1**\n- **企业名称**: 对应上图中的**2**\n- **企业法定代表人的名字**:对应上图中的**3**\n- **企业详细住所**:对应上图中的**4**\n\n\n\n\n<b>注</b>:此接口需要 <font color=\"red\"><b>购买单独的实名套餐包</b></font>方可调用,如有需求请联系对接人员评估",
250
257
  "input": "CreateOrganizationAuthUrlRequest",
@@ -514,7 +521,7 @@
514
521
  "DescribeOrganizationAuthStatus": {
515
522
  "document": "查询企业认证状态- 仅通过[CreateOrganizationAuthUrl](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl) 和[CreateBatchOrganizationRegistrationTasks](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)这两个接口进行引导认证的企业,调用方企业可以依据这个接口,查询认证状态。",
516
523
  "input": "DescribeOrganizationAuthStatusRequest",
517
- "name": "查询企业认证状态",
524
+ "name": "查询待认证企业认证状态",
518
525
  "output": "DescribeOrganizationAuthStatusResponse",
519
526
  "status": "online"
520
527
  },
@@ -532,6 +539,13 @@
532
539
  "output": "DescribeOrganizationSealsResponse",
533
540
  "status": "online"
534
541
  },
542
+ "DescribeOrganizationVerifyStatus": {
543
+ "document": "仅且仅能查询企业本身在电子签的认证状态",
544
+ "input": "DescribeOrganizationVerifyStatusRequest",
545
+ "name": "查询本企业认证状态",
546
+ "output": "DescribeOrganizationVerifyStatusResponse",
547
+ "status": "online"
548
+ },
535
549
  "DescribePersonCertificate": {
536
550
  "document": "此接口(DescribePersonCertificate)用于查询个人数字证书信息。<br />注:`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。`<br />`2.调用此接口需要开通白名单,使用前请联系相关人员开通白名单。`",
537
551
  "input": "DescribePersonCertificateRequest",
@@ -817,7 +831,7 @@
817
831
  },
818
832
  {
819
833
  "disabled": false,
820
- "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
834
+ "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
821
835
  "example": "350203180010069855",
822
836
  "member": "string",
823
837
  "name": "ApproverIdCardNumber",
@@ -916,7 +930,7 @@
916
930
  },
917
931
  {
918
932
  "disabled": false,
919
- "document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li>\n<li>**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)</li>\n<li>**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)</li></ul>\n\n\n默认为1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)\n\n注:\n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明\n3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>,至少需要再增加一种其他校验方式。\n4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用,其他端暂不支持。",
933
+ "document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li>\n<li>**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)</li>\n<li>**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)</li></ul>\n\n\n默认为:\n1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)\n\n注:\n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明\n3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>,至少需要再增加一种其他校验方式。\n4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用,其他端暂不支持。",
920
934
  "example": "[1,2,3]",
921
935
  "member": "int64",
922
936
  "name": "ApproverSignTypes",
@@ -2472,7 +2486,7 @@
2472
2486
  },
2473
2487
  {
2474
2488
  "disabled": false,
2475
- "document": "组织机构超管证件类型支持以下类型\n- ID_CARD : 居民身份证 (默认值)\n- HONGKONG_AND_MACAO : 港澳居民来往内地通行证\n- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)\n此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。",
2489
+ "document": "组织机构超管证件类型支持以下类型\n- ID_CARD : 中国大陆居民身份证 (默认值)\n- HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证\n- HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)\n此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。",
2476
2490
  "example": "ID_CARD",
2477
2491
  "member": "string",
2478
2492
  "name": "AdminIdCardType",
@@ -2793,7 +2807,7 @@
2793
2807
  },
2794
2808
  {
2795
2809
  "disabled": false,
2796
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
2810
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
2797
2811
  "example": "无",
2798
2812
  "member": "string",
2799
2813
  "name": "IdCardType",
@@ -2802,7 +2816,7 @@
2802
2816
  },
2803
2817
  {
2804
2818
  "disabled": false,
2805
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`请确保和合同中填入的一致`",
2819
+ "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`请确保和合同中填入的一致`",
2806
2820
  "example": "无",
2807
2821
  "member": "string",
2808
2822
  "name": "IdCardNumber",
@@ -5316,6 +5330,70 @@
5316
5330
  ],
5317
5331
  "type": "object"
5318
5332
  },
5333
+ "CreateOrganizationAuthFileRequest": {
5334
+ "document": "CreateOrganizationAuthFile请求参数结构体",
5335
+ "members": [
5336
+ {
5337
+ "disabled": false,
5338
+ "document": "企业授权书信息参数, 需要自行保证这些参数跟营业执照中的信息一致。",
5339
+ "example": "无",
5340
+ "member": "OrganizationCommonInfo",
5341
+ "name": "OrganizationCommonInfo",
5342
+ "required": true,
5343
+ "type": "object"
5344
+ },
5345
+ {
5346
+ "disabled": false,
5347
+ "document": "代理企业和员工的信息。<br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
5348
+ "example": "无",
5349
+ "member": "Agent",
5350
+ "name": "Agent",
5351
+ "required": false,
5352
+ "type": "object"
5353
+ },
5354
+ {
5355
+ "disabled": false,
5356
+ "document": "执行本接口操作的员工信息。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
5357
+ "example": "无",
5358
+ "member": "UserInfo",
5359
+ "name": "Operator",
5360
+ "required": false,
5361
+ "type": "object"
5362
+ },
5363
+ {
5364
+ "disabled": false,
5365
+ "document": "授权书类型:\n- 0: 企业认证超管授权书\n- 1: 超管变更授权书\n- 2: 企业注销授权书",
5366
+ "example": "0",
5367
+ "member": "uint64",
5368
+ "name": "Type",
5369
+ "required": false,
5370
+ "type": "int"
5371
+ }
5372
+ ],
5373
+ "type": "object"
5374
+ },
5375
+ "CreateOrganizationAuthFileResponse": {
5376
+ "document": "CreateOrganizationAuthFile返回参数结构体",
5377
+ "members": [
5378
+ {
5379
+ "disabled": false,
5380
+ "document": "授权书链接,有效期5分钟。",
5381
+ "example": "无",
5382
+ "member": "string",
5383
+ "name": "FileUrl",
5384
+ "output_required": false,
5385
+ "type": "string",
5386
+ "value_allowed_null": false
5387
+ },
5388
+ {
5389
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
5390
+ "member": "string",
5391
+ "name": "RequestId",
5392
+ "type": "string"
5393
+ }
5394
+ ],
5395
+ "type": "object"
5396
+ },
5319
5397
  "CreateOrganizationAuthUrlRequest": {
5320
5398
  "document": "CreateOrganizationAuthUrl请求参数结构体",
5321
5399
  "members": [
@@ -5411,7 +5489,7 @@
5411
5489
  },
5412
5490
  {
5413
5491
  "disabled": false,
5414
- "document": "认证人证件类型, 支持以下类型\n<ul><li><b>ID_CARD</b> : 中国大陆居民身份证 (默认值)</li>\n<li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>\n<li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
5492
+ "document": "认证人证件类型, 支持以下类型\n<ul><li><b>ID_CARD</b> : 中国大陆居民身份证 (默认值)</li>\n<li><b>HONGKONG_AND_MACAO</b> : 中国港澳居民来往内地通行证</li>\n<li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n",
5415
5493
  "example": "ID_CARD ",
5416
5494
  "member": "string",
5417
5495
  "name": "AdminIdCardType",
@@ -5901,7 +5979,7 @@
5901
5979
  },
5902
5980
  {
5903
5981
  "disabled": false,
5904
- "document": "证件类型,支持以下类型\n<ul><li> ID_CARD : 居民身份证 (默认值)</li>\n<li> HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li> HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
5982
+ "document": "证件类型,支持以下类型\n<ul><li> ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li> HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li> HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
5905
5983
  "example": "无",
5906
5984
  "member": "string",
5907
5985
  "name": "IdCardType",
@@ -5910,7 +5988,7 @@
5910
5988
  },
5911
5989
  {
5912
5990
  "disabled": false,
5913
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
5991
+ "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
5914
5992
  "example": "无",
5915
5993
  "member": "string",
5916
5994
  "name": "IdCardNumber",
@@ -6232,7 +6310,7 @@
6232
6310
  },
6233
6311
  {
6234
6312
  "disabled": false,
6235
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
6313
+ "document": "证件号码,应符合以下规则\n<ul><li> 中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
6236
6314
  "example": "无",
6237
6315
  "member": "string",
6238
6316
  "name": "IdCardNumber",
@@ -6259,7 +6337,7 @@
6259
6337
  },
6260
6338
  {
6261
6339
  "disabled": false,
6262
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
6340
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同 中国大陆居民身份证)</li></ul>",
6263
6341
  "example": "无",
6264
6342
  "member": "string",
6265
6343
  "name": "IdCardType",
@@ -6546,7 +6624,7 @@
6546
6624
  },
6547
6625
  {
6548
6626
  "disabled": false,
6549
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
6627
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
6550
6628
  "example": "ID_CARD",
6551
6629
  "member": "string",
6552
6630
  "name": "IdCardType",
@@ -6555,7 +6633,7 @@
6555
6633
  },
6556
6634
  {
6557
6635
  "disabled": false,
6558
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
6636
+ "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
6559
6637
  "example": "620000198802020000",
6560
6638
  "member": "string",
6561
6639
  "name": "IdCardNumber",
@@ -7017,7 +7095,7 @@
7017
7095
  },
7018
7096
  {
7019
7097
  "disabled": false,
7020
- "document": "是否通知开通方,通知类型:\n<ul><li>默认不设置为不通知开通方</li>\n<li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>",
7098
+ "document": "是否通知开通方,通知类型:<ul><li>默认为不通知开通方</li><li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>",
7021
7099
  "example": "无",
7022
7100
  "member": "string",
7023
7101
  "name": "NotifyType",
@@ -7298,7 +7376,7 @@
7298
7376
  },
7299
7377
  {
7300
7378
  "disabled": false,
7301
- "document": "要修改手机号用户的证件类型,\n目前支持的账号类型如下:\n\n<ul><li><b>ID_CARD </b>: (默认)中国大陆居民身份证 </li>\n<li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>\n<li><b>HONGKONG_MACAO_AND_TAIWAN </b>: 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
7379
+ "document": "要修改手机号用户的证件类型,\n目前支持的账号类型如下:\n\n<ul><li><b>ID_CARD </b>: (默认)中国大陆居民身份证 </li>\n<li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>\n<li><b>HONGKONG_MACAO_AND_TAIWAN </b>: 港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n",
7302
7380
  "example": "ID_CARD ",
7303
7381
  "member": "string",
7304
7382
  "name": "IdCardType",
@@ -7307,7 +7385,7 @@
7307
7385
  },
7308
7386
  {
7309
7387
  "disabled": false,
7310
- "document": "要修改手机号用户的身份证号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n如果没有传递 userId且 userAccountType 是 0 或者没有传递, 此参数为<b>必填项。</b>",
7388
+ "document": "要修改手机号用户的身份证号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n如果没有传递 userId且 userAccountType 是 0 或者没有传递, 此参数为<b>必填项。</b>",
7311
7389
  "example": "620000198802020000",
7312
7390
  "member": "string",
7313
7391
  "name": "IdCardNumber",
@@ -8884,7 +8962,7 @@
8884
8962
  },
8885
8963
  {
8886
8964
  "disabled": false,
8887
- "document": "搜索条件,本字段用于指定模板Id进行查询。\nKey:template-id Values:需要查询的模板Id列表",
8965
+ "document": "搜索条件,本字段用于指定模板Id进行查询。\n- Key:template-id Values:需要查询的模板Id列表\n- Key:template-name Values:需要查询的模板名称列表\n",
8888
8966
  "example": "Filters",
8889
8967
  "member": "Filter",
8890
8968
  "name": "Filters",
@@ -9613,6 +9691,52 @@
9613
9691
  ],
9614
9692
  "type": "object"
9615
9693
  },
9694
+ "DescribeOrganizationVerifyStatusRequest": {
9695
+ "document": "DescribeOrganizationVerifyStatus请求参数结构体",
9696
+ "members": [
9697
+ {
9698
+ "disabled": false,
9699
+ "document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
9700
+ "example": "无",
9701
+ "member": "UserInfo",
9702
+ "name": "Operator",
9703
+ "required": false,
9704
+ "type": "object"
9705
+ },
9706
+ {
9707
+ "disabled": false,
9708
+ "document": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。\t",
9709
+ "example": "无",
9710
+ "member": "Agent",
9711
+ "name": "Agent",
9712
+ "required": false,
9713
+ "type": "object"
9714
+ }
9715
+ ],
9716
+ "type": "object"
9717
+ },
9718
+ "DescribeOrganizationVerifyStatusResponse": {
9719
+ "document": "DescribeOrganizationVerifyStatus返回参数结构体",
9720
+ "members": [
9721
+ {
9722
+ "disabled": false,
9723
+ "document": "当前企业认证状态\n<ul>\n<li> <b>0 </b>:未认证</li>\n<li> <b>1 </b> : 认证中</li>\n<li> <b>2 </b> : 已认证</li>\n</ul>",
9724
+ "example": "0",
9725
+ "member": "uint64",
9726
+ "name": "VerifyStatus",
9727
+ "output_required": true,
9728
+ "type": "int",
9729
+ "value_allowed_null": false
9730
+ },
9731
+ {
9732
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
9733
+ "member": "string",
9734
+ "name": "RequestId",
9735
+ "type": "string"
9736
+ }
9737
+ ],
9738
+ "type": "object"
9739
+ },
9616
9740
  "DescribePersonCertificateRequest": {
9617
9741
  "document": "DescribePersonCertificate请求参数结构体",
9618
9742
  "members": [
@@ -9943,7 +10067,7 @@
9943
10067
  },
9944
10068
  {
9945
10069
  "disabled": false,
9946
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
10070
+ "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
9947
10071
  "example": "无",
9948
10072
  "member": "string",
9949
10073
  "name": "IdCardNumber",
@@ -9952,7 +10076,7 @@
9952
10076
  },
9953
10077
  {
9954
10078
  "disabled": false,
9955
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
10079
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
9956
10080
  "example": "无",
9957
10081
  "member": "string",
9958
10082
  "name": "IdCardType",
@@ -10547,7 +10671,7 @@
10547
10671
  },
10548
10672
  {
10549
10673
  "disabled": false,
10550
- "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
10674
+ "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
10551
10675
  "example": "无",
10552
10676
  "member": "string",
10553
10677
  "name": "ApproverIdCardNumber",
@@ -11091,7 +11215,7 @@
11091
11215
  },
11092
11216
  {
11093
11217
  "disabled": false,
11094
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
11218
+ "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
11095
11219
  "example": "620000198802020000",
11096
11220
  "member": "string",
11097
11221
  "name": "ApproverIdCardNumber",
@@ -12690,7 +12814,7 @@
12690
12814
  },
12691
12815
  {
12692
12816
  "disabled": false,
12693
- "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
12817
+ "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
12694
12818
  "example": "无",
12695
12819
  "member": "string",
12696
12820
  "name": "ApproverIdCardNumber",
@@ -12917,6 +13041,155 @@
12917
13041
  ],
12918
13042
  "usage": "out"
12919
13043
  },
13044
+ "OrganizationCommonInfo": {
13045
+ "document": "企业授权书信息参数, 需要保证这些参数跟营业执照中的信息一致。",
13046
+ "members": [
13047
+ {
13048
+ "disabled": false,
13049
+ "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。\n注意:此字段可能返回 null,表示取不到有效值。",
13050
+ "example": "无",
13051
+ "member": "string",
13052
+ "name": "OrganizationName",
13053
+ "output_required": false,
13054
+ "required": true,
13055
+ "type": "string",
13056
+ "value_allowed_null": true
13057
+ },
13058
+ {
13059
+ "disabled": false,
13060
+ "document": "组织机构企业统一社会信用代码。\n请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。\n注意:此字段可能返回 null,表示取不到有效值。",
13061
+ "example": "无",
13062
+ "member": "string",
13063
+ "name": "UniformSocialCreditCode",
13064
+ "output_required": false,
13065
+ "required": true,
13066
+ "type": "string",
13067
+ "value_allowed_null": true
13068
+ },
13069
+ {
13070
+ "disabled": false,
13071
+ "document": "组织机构法人的姓名。\n请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。\n注意:此字段可能返回 null,表示取不到有效值。",
13072
+ "example": "无",
13073
+ "member": "string",
13074
+ "name": "LegalName",
13075
+ "output_required": false,
13076
+ "required": true,
13077
+ "type": "string",
13078
+ "value_allowed_null": true
13079
+ },
13080
+ {
13081
+ "disabled": false,
13082
+ "document": "组织机构法人的证件类型\n注意:此字段可能返回 null,表示取不到有效值。",
13083
+ "example": "居民身份证",
13084
+ "member": "string",
13085
+ "name": "LegalIdCardType",
13086
+ "output_required": false,
13087
+ "required": false,
13088
+ "type": "string",
13089
+ "value_allowed_null": true
13090
+ },
13091
+ {
13092
+ "disabled": false,
13093
+ "document": "组织机构法人的证件号码\n注意:此字段可能返回 null,表示取不到有效值。",
13094
+ "example": "无",
13095
+ "member": "string",
13096
+ "name": "LegalIdCardNumber",
13097
+ "output_required": false,
13098
+ "required": false,
13099
+ "type": "string",
13100
+ "value_allowed_null": true
13101
+ },
13102
+ {
13103
+ "disabled": false,
13104
+ "document": "组织机构超管姓名。\n\n注意:此字段可能返回 null,表示取不到有效值。",
13105
+ "example": "无",
13106
+ "member": "string",
13107
+ "name": "AdminName",
13108
+ "output_required": false,
13109
+ "required": false,
13110
+ "type": "string",
13111
+ "value_allowed_null": true
13112
+ },
13113
+ {
13114
+ "disabled": false,
13115
+ "document": "组织机构超管手机号。\n\n注意:此字段可能返回 null,表示取不到有效值。",
13116
+ "example": "无",
13117
+ "member": "string",
13118
+ "name": "AdminMobile",
13119
+ "output_required": false,
13120
+ "required": false,
13121
+ "type": "string",
13122
+ "value_allowed_null": true
13123
+ },
13124
+ {
13125
+ "disabled": false,
13126
+ "document": "组织机构超管证件类型\n\n注意:此字段可能返回 null,表示取不到有效值。",
13127
+ "example": "居民身份证",
13128
+ "member": "string",
13129
+ "name": "AdminIdCardType",
13130
+ "output_required": false,
13131
+ "required": false,
13132
+ "type": "string",
13133
+ "value_allowed_null": true
13134
+ },
13135
+ {
13136
+ "disabled": false,
13137
+ "document": "组织机构超管证件号码\n\n注意:此字段可能返回 null,表示取不到有效值。",
13138
+ "example": "无",
13139
+ "member": "string",
13140
+ "name": "AdminIdCardNumber",
13141
+ "output_required": false,
13142
+ "required": false,
13143
+ "type": "string",
13144
+ "value_allowed_null": true
13145
+ },
13146
+ {
13147
+ "disabled": false,
13148
+ "document": "原超管姓名\n注意:此字段可能返回 null,表示取不到有效值。",
13149
+ "example": "无",
13150
+ "member": "string",
13151
+ "name": "OldAdminName",
13152
+ "output_required": false,
13153
+ "required": false,
13154
+ "type": "string",
13155
+ "value_allowed_null": true
13156
+ },
13157
+ {
13158
+ "disabled": false,
13159
+ "document": "原超管手机号\n注意:此字段可能返回 null,表示取不到有效值。",
13160
+ "example": "无",
13161
+ "member": "string",
13162
+ "name": "OldAdminMobile",
13163
+ "output_required": false,
13164
+ "required": false,
13165
+ "type": "string",
13166
+ "value_allowed_null": true
13167
+ },
13168
+ {
13169
+ "disabled": false,
13170
+ "document": "原超管证件类型",
13171
+ "example": "居民身份证",
13172
+ "member": "string",
13173
+ "name": "OldAdminIdCardType",
13174
+ "output_required": false,
13175
+ "required": false,
13176
+ "type": "string",
13177
+ "value_allowed_null": false
13178
+ },
13179
+ {
13180
+ "disabled": false,
13181
+ "document": "原超管证件号码",
13182
+ "example": "无",
13183
+ "member": "string",
13184
+ "name": "OldAdminIdCardNumber",
13185
+ "output_required": false,
13186
+ "required": false,
13187
+ "type": "string",
13188
+ "value_allowed_null": false
13189
+ }
13190
+ ],
13191
+ "usage": "both"
13192
+ },
12920
13193
  "OrganizationInfo": {
12921
13194
  "document": "机构信息",
12922
13195
  "members": [
@@ -13589,7 +13862,7 @@
13589
13862
  "example": "深圳市南山区高新区科技中一路腾讯大厦35层",
13590
13863
  "member": "string",
13591
13864
  "name": "Address",
13592
- "required": true,
13865
+ "required": false,
13593
13866
  "type": "string"
13594
13867
  },
13595
13868
  {
@@ -13630,7 +13903,7 @@
13630
13903
  },
13631
13904
  {
13632
13905
  "disabled": false,
13633
- "document": "认证人证件类型 \n支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
13906
+ "document": "认证人证件类型 \n支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n",
13634
13907
  "example": "无",
13635
13908
  "member": "string",
13636
13909
  "name": "AdminIdCardType",
@@ -13728,12 +14001,12 @@
13728
14001
  "usage": "in"
13729
14002
  },
13730
14003
  "RelieveInfo": {
13731
- "document": "解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。",
14004
+ "document": "解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。下面各种字段在解除协议中的位置参考:\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/5087164cfe5a15fa3ced3180842d5da9.png)",
13732
14005
  "members": [
13733
14006
  {
13734
14007
  "disabled": false,
13735
14008
  "document": "解除理由,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
13736
- "example": "",
14009
+ "example": "合同中的金额写错了",
13737
14010
  "member": "string",
13738
14011
  "name": "Reason",
13739
14012
  "required": true,
@@ -13742,7 +14015,7 @@
13742
14015
  {
13743
14016
  "disabled": false,
13744
14017
  "document": "解除后仍然有效的条款,保留条款,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。\n",
13745
- "example": "",
14018
+ "example": "买卖小狗的交易地点、小狗的品种",
13746
14019
  "member": "string",
13747
14020
  "name": "RemainInForceItem",
13748
14021
  "required": false,
@@ -13751,7 +14024,7 @@
13751
14024
  {
13752
14025
  "disabled": false,
13753
14026
  "document": "原合同事项处理-费用结算,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
13754
- "example": "",
14027
+ "example": "1000元",
13755
14028
  "member": "string",
13756
14029
  "name": "OriginalExpenseSettlement",
13757
14030
  "required": false,
@@ -13760,7 +14033,7 @@
13760
14033
  {
13761
14034
  "disabled": false,
13762
14035
  "document": "原合同事项处理-其他事项,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
13763
- "example": "",
14036
+ "example": "原合同中的补充条款依然生效",
13764
14037
  "member": "string",
13765
14038
  "name": "OriginalOtherSettlement",
13766
14039
  "required": false,
@@ -13768,8 +14041,8 @@
13768
14041
  },
13769
14042
  {
13770
14043
  "disabled": false,
13771
- "document": "其他约定,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
13772
- "example": "",
14044
+ "document": "其他约定(如约定的与解除协议存在冲突的,以【其他约定】为准),最大支持200个字,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
14045
+ "example": "解除后1天内部签署新的合同",
13773
14046
  "member": "string",
13774
14047
  "name": "OtherDeals",
13775
14048
  "required": false,
@@ -13973,6 +14246,16 @@
13973
14246
  "output_required": true,
13974
14247
  "type": "int",
13975
14248
  "value_allowed_null": false
14249
+ },
14250
+ {
14251
+ "disabled": false,
14252
+ "document": "微信小程序二维码",
14253
+ "example": "https://file.ess.tencent.cn/bresource/resource/resource/0/0.PNG?hkey=a976edda49eacc2b264c2df468c30fcd69023cd782421bdbedddf8a95c7859d4467844c38fb9ea20b47d4b2f89396717f8deac5dcb25f32d718f0c13b48f53a2f6f69096b3b301aad56de87d7a8499fe374e5e2891dd778bb0c82394640fe124be22c63ba4e022a046cbc298006d3341",
14254
+ "member": "string",
14255
+ "name": "WeixinQrCodeUrl",
14256
+ "output_required": true,
14257
+ "type": "string",
14258
+ "value_allowed_null": false
13976
14259
  }
13977
14260
  ],
13978
14261
  "usage": "out"
@@ -14925,7 +15208,7 @@
14925
15208
  },
14926
15209
  {
14927
15210
  "disabled": false,
14928
- "document": "文件名,最大长度不超过200字符",
15211
+ "document": "文件的名字。\n文件名的最大长度应不超过200个字符,并且文件名的后缀必须反映其文件类型。\n例如,PDF文件应以“.pdf”结尾,如“XXX.pdf”,而Word文件应以“.doc”或“.docx”结尾,如“XXX.doc”或“XXX.docx”。",
14929
15212
  "example": "test.pdf",
14930
15213
  "member": "string",
14931
15214
  "name": "FileName",
@@ -14958,7 +15241,7 @@
14958
15241
  },
14959
15242
  {
14960
15243
  "disabled": false,
14961
- "document": "上传文件内容数组,最多支持上传20个文件。",
15244
+ "document": "请上传文件内容数组,最多可上传20个文件。\n\n<b>所有文件必须符合<font color=\"red\">FileType</font>指定的文件类型。</b>",
14962
15245
  "example": "FileInfos",
14963
15246
  "member": "UploadFile",
14964
15247
  "name": "FileInfos",
@@ -15018,7 +15301,7 @@
15018
15301
  "members": [
15019
15302
  {
15020
15303
  "disabled": false,
15021
- "document": "文件资源ID数组,每个文件资源ID为32位字符串。\n建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID",
15304
+ "document": "文件资源ID数组,每个文件资源ID为32位字符串。\n建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。\n注:`有效期一个小时(超过一小时后系统不定期清理,会有部分时间差), 有效期内此文件id可以反复使用, 超过有效期无法使用`",
15022
15305
  "example": "yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT",
15023
15306
  "member": "string",
15024
15307
  "name": "FileIds",
@@ -15154,7 +15437,7 @@
15154
15437
  },
15155
15438
  {
15156
15439
  "disabled": false,
15157
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
15440
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
15158
15441
  "example": "ID_CARD",
15159
15442
  "member": "string",
15160
15443
  "name": "IdCardType",
@@ -15163,7 +15446,7 @@
15163
15446
  },
15164
15447
  {
15165
15448
  "disabled": false,
15166
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
15449
+ "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
15167
15450
  "example": "610*************1X",
15168
15451
  "member": "string",
15169
15452
  "name": "IdCardNumber",