tccli 3.0.1237.1__py2.py3-none-any.whl → 3.0.1239.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 (146) 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 +10 -7
  10. tccli/services/batch/v20170312/api.json +641 -566
  11. tccli/services/batch/v20170312/examples.json +7 -7
  12. tccli/services/bi/v20220105/api.json +9 -0
  13. tccli/services/bpaas/v20181217/examples.json +1 -1
  14. tccli/services/cam/v20190116/api.json +32 -30
  15. tccli/services/cam/v20190116/examples.json +4 -4
  16. tccli/services/ccc/v20200210/api.json +31 -1
  17. tccli/services/ccc/v20200210/examples.json +1 -1
  18. tccli/services/cdb/v20170320/api.json +944 -856
  19. tccli/services/cdb/v20170320/examples.json +47 -47
  20. tccli/services/cdwch/v20200915/api.json +6 -6
  21. tccli/services/cdwdoris/v20211228/api.json +32 -12
  22. tccli/services/cdwdoris/v20211228/examples.json +1 -1
  23. tccli/services/cfg/v20210820/api.json +8 -13
  24. tccli/services/cfg/v20210820/examples.json +1 -1
  25. tccli/services/cfs/v20190719/api.json +84 -84
  26. tccli/services/cfs/v20190719/examples.json +6 -6
  27. tccli/services/chdfs/v20201112/api.json +113 -95
  28. tccli/services/chdfs/v20201112/examples.json +16 -16
  29. tccli/services/clb/v20180317/api.json +186 -164
  30. tccli/services/cloudapp/v20220530/api.json +1 -1
  31. tccli/services/cloudapp/v20220530/examples.json +3 -3
  32. tccli/services/cloudaudit/v20190319/api.json +21 -17
  33. tccli/services/cloudaudit/v20190319/examples.json +3 -3
  34. tccli/services/cls/v20201016/api.json +21 -21
  35. tccli/services/cls/v20201016/examples.json +1 -1
  36. tccli/services/config/v20220802/api.json +2 -0
  37. tccli/services/config/v20220802/examples.json +2 -2
  38. tccli/services/cynosdb/v20190107/api.json +370 -365
  39. tccli/services/cynosdb/v20190107/examples.json +39 -39
  40. tccli/services/dbbrain/v20191016/api.json +206 -188
  41. tccli/services/dbbrain/v20191016/examples.json +10 -10
  42. tccli/services/dbbrain/v20210527/api.json +274 -267
  43. tccli/services/dbbrain/v20210527/examples.json +25 -25
  44. tccli/services/dc/v20180410/api.json +101 -41
  45. tccli/services/dc/v20180410/examples.json +5 -5
  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 +37 -37
  51. tccli/services/domain/v20180808/examples.json +16 -10
  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 +152 -115
  55. tccli/services/dts/v20180330/examples.json +4 -4
  56. tccli/services/dts/v20211206/api.json +83 -72
  57. tccli/services/dts/v20211206/examples.json +5 -5
  58. tccli/services/eb/v20210416/api.json +2 -2
  59. tccli/services/eb/v20210416/examples.json +2 -2
  60. tccli/services/ecm/v20190719/api.json +273 -230
  61. tccli/services/ecm/v20190719/examples.json +21 -21
  62. tccli/services/emr/v20190103/api.json +80 -20
  63. tccli/services/ess/ess_client.py +61 -8
  64. tccli/services/ess/v20201111/api.json +287 -39
  65. tccli/services/ess/v20201111/examples.json +11 -3
  66. tccli/services/essbasic/essbasic_client.py +167 -8
  67. tccli/services/essbasic/v20210526/api.json +545 -54
  68. tccli/services/essbasic/v20210526/examples.json +46 -16
  69. tccli/services/facefusion/v20220927/api.json +14 -3
  70. tccli/services/fmu/v20191213/api.json +8 -8
  71. tccli/services/gaap/v20180529/api.json +222 -231
  72. tccli/services/hai/v20230812/api.json +1 -1
  73. tccli/services/hunyuan/v20230901/api.json +21 -2
  74. tccli/services/iss/v20230517/api.json +11 -11
  75. tccli/services/iss/v20230517/examples.json +31 -31
  76. tccli/services/keewidb/v20220308/api.json +92 -82
  77. tccli/services/keewidb/v20220308/examples.json +5 -5
  78. tccli/services/lcic/v20220817/api.json +1 -1
  79. tccli/services/lighthouse/v20200324/api.json +22 -22
  80. tccli/services/lighthouse/v20200324/examples.json +5 -5
  81. tccli/services/live/v20180801/api.json +87 -69
  82. tccli/services/live/v20180801/examples.json +37 -37
  83. tccli/services/lke/v20231130/examples.json +1 -1
  84. tccli/services/mariadb/v20170312/api.json +285 -263
  85. tccli/services/mariadb/v20170312/examples.json +12 -12
  86. tccli/services/mongodb/v20180408/api.json +104 -104
  87. tccli/services/mongodb/v20190725/api.json +116 -103
  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 +16 -0
  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/msp/v20180319/api.json +2 -2
  95. tccli/services/ocr/v20181119/api.json +13 -3
  96. tccli/services/ocr/v20181119/examples.json +1 -1
  97. tccli/services/omics/v20221128/api.json +14 -2
  98. tccli/services/organization/v20210331/api.json +45 -18
  99. tccli/services/privatedns/v20201028/api.json +90 -81
  100. tccli/services/privatedns/v20201028/examples.json +18 -18
  101. tccli/services/redis/redis_client.py +106 -0
  102. tccli/services/redis/v20180412/api.json +179 -17
  103. tccli/services/redis/v20180412/examples.json +16 -0
  104. tccli/services/region/v20220627/api.json +5 -3
  105. tccli/services/region/v20220627/examples.json +1 -1
  106. tccli/services/sqlserver/v20180328/api.json +611 -450
  107. tccli/services/sqlserver/v20180328/examples.json +16 -16
  108. tccli/services/ssl/v20191205/api.json +6 -4
  109. tccli/services/tag/v20180813/api.json +4 -5
  110. tccli/services/tbaas/v20180416/api.json +47 -49
  111. tccli/services/tbaas/v20180416/examples.json +4 -4
  112. tccli/services/tcb/v20180608/api.json +36 -16
  113. tccli/services/tdmq/tdmq_client.py +106 -0
  114. tccli/services/tdmq/v20200217/api.json +125 -1
  115. tccli/services/tdmq/v20200217/examples.json +17 -1
  116. tccli/services/teo/teo_client.py +485 -8
  117. tccli/services/teo/v20220901/api.json +837 -39
  118. tccli/services/teo/v20220901/examples.json +108 -0
  119. tccli/services/thpc/v20211109/api.json +32 -34
  120. tccli/services/thpc/v20220401/api.json +31 -33
  121. tccli/services/thpc/v20230321/api.json +55 -57
  122. tccli/services/thpc/v20230321/examples.json +1 -1
  123. tccli/services/tiia/v20190529/api.json +307 -293
  124. tccli/services/tiia/v20190529/examples.json +41 -41
  125. tccli/services/tione/v20211111/api.json +4 -4
  126. tccli/services/tione/v20211111/examples.json +2 -2
  127. tccli/services/tke/v20180525/api.json +1 -1
  128. tccli/services/trocket/trocket_client.py +224 -12
  129. tccli/services/trocket/v20230308/api.json +787 -147
  130. tccli/services/trocket/v20230308/examples.json +38 -0
  131. tccli/services/tse/v20201207/api.json +188 -120
  132. tccli/services/tse/v20201207/examples.json +30 -30
  133. tccli/services/tsf/v20180326/api.json +864 -781
  134. tccli/services/tsf/v20180326/examples.json +114 -126
  135. tccli/services/vclm/v20240523/api.json +1 -1
  136. tccli/services/vdb/v20230616/api.json +80 -80
  137. tccli/services/vdb/v20230616/examples.json +1 -1
  138. tccli/services/vod/v20180717/api.json +21 -3
  139. tccli/services/vod/v20180717/examples.json +2 -2
  140. tccli/services/vpc/v20170312/api.json +45 -44
  141. tccli/services/vpc/v20170312/examples.json +9 -9
  142. {tccli-3.0.1237.1.dist-info → tccli-3.0.1239.1.dist-info}/METADATA +2 -2
  143. {tccli-3.0.1237.1.dist-info → tccli-3.0.1239.1.dist-info}/RECORD +146 -142
  144. {tccli-3.0.1237.1.dist-info → tccli-3.0.1239.1.dist-info}/WHEEL +0 -0
  145. {tccli-3.0.1237.1.dist-info → tccli-3.0.1239.1.dist-info}/entry_points.txt +0 -0
  146. {tccli-3.0.1237.1.dist-info → tccli-3.0.1239.1.dist-info}/license_files/LICENSE +0 -0
@@ -1,5 +1,12 @@
1
1
  {
2
2
  "actions": {
3
+ "ArchiveDynamicFlow": {
4
+ "document": "该接口用于结束动态签署方2.0的合同流程。\n\n\n**功能开通**\n- 动态签署方2.0功能的使用需要先<font color=\"red\">联系产品经理开通模块化计费功能</font>,然后到控制台中打开此功能。详细的使用说明请参考<a href=\"https://qian.tencent.com/developers/company/dynamic_signer_v2\" target=\"_blank\">动态签署方2.0</a>文档。\n\n**使用条件**\n- 此接口只能在<font color=\"red\">合同处于非终态且<b>所有的签署方都已经完成签署</b></font>。一旦合同进入终态(例如:过期、拒签、撤销或者调用过此接口成功过),将无法通过此接口结束合同流程。",
5
+ "input": "ArchiveDynamicFlowRequest",
6
+ "name": "结束动态签署流程",
7
+ "output": "ArchiveDynamicFlowResponse",
8
+ "status": "online"
9
+ },
3
10
  "ChannelBatchCancelFlows": {
4
11
  "document": "通过合同编号批量撤销合同,单次最多支持撤销100份合同。\n\n适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。\n\n- **可撤回合同状态**:未全部签署完成\n- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。\n\n批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。\n\n\n注:\n- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>\n- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow\" target=\"_blank\">发起解除合同流程接口</a>\n- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>\n- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。",
5
12
  "input": "ChannelBatchCancelFlowsRequest",
@@ -43,7 +50,7 @@
43
50
  "status": "online"
44
51
  },
45
52
  "ChannelCreateBatchSignUrl": {
46
- "document": "通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注:\n- 使用此接口生成链接,需要提前开通 `个人签署方仅校验手机号` 功能,在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 个人参与方点击链接后需短信验证码才能查看合同内容。\n- 个人用户批量签署,需要传Name,Mobile,IdCardNumber(IdCardType) 参数。\n- saas企业员工用户批量签署,在传递了姓名等基本信息参数的情况下,还需要传OrganizationName(参与方所在企业名称)参数生成签署链接,<font color=\"red\">请确保此企业已完成腾讯电子签企业认证</font>。\n- 子客企业员工用户批量签署,需要传递员工OpenId和子客企业的OrganizationOpenId。<font color=\"red\">请确保此OrganizationOpenId对应子客已经认证,且OpenId对应员工此子客下已经实名</font>。Name,Mobile, IdCard等信息此时可以不传,系统会查询此OpenId实名信息自动补充。\n- 生成批量签署链接时,合同目标参与方状态需为<font color=\"red\">待签署</font>状态。\n- 个人批量签署进行的合同的签名区, 全部变成<font color=\"red\">手写签名</font>(不管合同里边设置的签名限制)来进行。",
53
+ "document": "通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注:\n- 使用此接口生成链接,需要提前开通 `个人签署方仅校验手机号` 功能,在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 个人参与方点击链接后需短信验证码才能查看合同内容。\n- 个人用户批量签署,需要传Name,Mobile,IdCardNumber(IdCardType) 参数。\n- saas企业员工用户批量签署,在传递了姓名等基本信息参数的情况下,还需要传OrganizationName(参与方所在企业名称)参数生成签署链接,<font color=\"red\">请确保此企业已完成腾讯电子签企业认证</font>。\n- 子客企业员工用户批量签署,需要传递员工OpenId和子客企业的OrganizationOpenId。<font color=\"red\">请确保此OrganizationOpenId对应子客已经认证,且OpenId对应员工此子客下已经实名</font>。Name,Mobile, IdCard等信息此时可以不传,系统会查询此OpenId实名信息自动补充。\n- 生成批量签署链接时,合同目标参与方状态需为<font color=\"red\">待签署</font>状态。\n- 个人批量签署进行的合同的签名区, 全部变成<font color=\"red\">手写签名</font>(不管合同里边设置的签名限制)来进行。\n- 不支持签署方含有签批控件,或设置了签署方在签署时自行添加签署控件功能的合同进行批量签署。",
47
54
  "input": "ChannelCreateBatchSignUrlRequest",
48
55
  "name": "获取跳转至腾讯电子签小程序的批量签署链接",
49
56
  "output": "ChannelCreateBatchSignUrlResponse",
@@ -63,6 +70,13 @@
63
70
  "output": "ChannelCreateConvertTaskApiResponse",
64
71
  "status": "online"
65
72
  },
73
+ "ChannelCreateDynamicFlowApprover": {
74
+ "document": "接口(ChannelCreateDynamicFlowApprover)用来补充<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles\" target=\"_blank\">用PDF文件创建签署流程</a>发起的动态合同的签署人信息\n**注**: \n<ul>\n<li>此接口需要保证:渠道企业已开启:模块化计费能力,</li>\n<li>此接口需要保证:渠道应用已开启:动态签署人2.0能力</li>\n<li>此接口需要保证:合同发起时指定开启了动态合同</li>\n<li>此接口补充的动态签署人传参规则,请参考接口:<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles\" target=\"_blank\">用PDF文件创建签署流程</a>的签署人传参规则</li>\n</ul>",
75
+ "input": "ChannelCreateDynamicFlowApproverRequest",
76
+ "name": "渠道版补充动态合同签署人接口",
77
+ "output": "ChannelCreateDynamicFlowApproverResponse",
78
+ "status": "online"
79
+ },
66
80
  "ChannelCreateEmbedWebUrl": {
67
81
  "document": "本接口(ChannelCreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:\n1. 创建印章\n2. 创建模板\n3. 修改模板\n4. 预览模板\n5. 预览合同流程\n\n预览模板的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)\n\n预览合同流程的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)",
68
82
  "input": "ChannelCreateEmbedWebUrlRequest",
@@ -406,6 +420,13 @@
406
420
  "output": "CreateLegalSealQrCodeResponse",
407
421
  "status": "online"
408
422
  },
423
+ "CreateOrganizationAuthFile": {
424
+ "document": "生成合成后的各类企业授权书,包括:\n- 企业认证超管授权书\n- 超管变更授权书\n- 企业注销授权书\n\n注: 需自行保证传入真实的企业/法人/超管信息,否则后续的审核将会拒绝。",
425
+ "input": "CreateOrganizationAuthFileRequest",
426
+ "name": "生成企业授权书",
427
+ "output": "CreateOrganizationAuthFileResponse",
428
+ "status": "online"
429
+ },
409
430
  "CreatePartnerAutoSignAuthUrl": {
410
431
  "document": "创建一个用于他方自动签授权的链接(可选择他方授权或我方授权)。通过这个链接,合作方企业可以直接进入小程序,进行自动签授权操作。\n\n如果授权企业尚未开通企业自动签功能,该链接还将引导他们首先开通本企业的自动签服务\n\n\n注: \n1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)\n2. 已经在授权中或者授权成功的企业,无法重复授权\n3. 授权企业和被授权企业必须都是已认证企业\n4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。\n\n**该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**\n![image](https://qcloudimg.tencent-cloud.cn/raw/091823fd4f02af7dda416fa10ca65f2d.png)",
411
432
  "input": "CreatePartnerAutoSignAuthUrlRequest",
@@ -790,6 +811,62 @@
790
811
  ],
791
812
  "usage": "in"
792
813
  },
814
+ "ArchiveDynamicFlowRequest": {
815
+ "document": "ArchiveDynamicFlow请求参数结构体",
816
+ "members": [
817
+ {
818
+ "disabled": false,
819
+ "document": "关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: Agent.AppId</li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>\n<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>\n</ul>\n第三方平台子客企业和员工必须已经过实名认证",
820
+ "example": "无",
821
+ "member": "Agent",
822
+ "name": "Agent",
823
+ "required": true,
824
+ "type": "object"
825
+ },
826
+ {
827
+ "disabled": false,
828
+ "document": "合同流程ID",
829
+ "example": "\"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\"",
830
+ "member": "string",
831
+ "name": "FlowId",
832
+ "required": true,
833
+ "type": "string"
834
+ }
835
+ ],
836
+ "type": "object"
837
+ },
838
+ "ArchiveDynamicFlowResponse": {
839
+ "document": "ArchiveDynamicFlow返回参数结构体",
840
+ "members": [
841
+ {
842
+ "disabled": false,
843
+ "document": "合同流程ID",
844
+ "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
845
+ "member": "string",
846
+ "name": "FlowId",
847
+ "output_required": false,
848
+ "type": "string",
849
+ "value_allowed_null": false
850
+ },
851
+ {
852
+ "disabled": false,
853
+ "document": "动态签署人的参与人信息",
854
+ "example": "无",
855
+ "member": "ChannelArchiveDynamicApproverData",
856
+ "name": "Approvers",
857
+ "output_required": false,
858
+ "type": "list",
859
+ "value_allowed_null": false
860
+ },
861
+ {
862
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
863
+ "member": "string",
864
+ "name": "RequestId",
865
+ "type": "string"
866
+ }
867
+ ],
868
+ "type": "object"
869
+ },
793
870
  "AuthFailMessage": {
794
871
  "document": "授权出错信息",
795
872
  "members": [
@@ -1173,6 +1250,34 @@
1173
1250
  ],
1174
1251
  "usage": "in"
1175
1252
  },
1253
+ "ChannelArchiveDynamicApproverData": {
1254
+ "document": "动态签署2.0合同参与人信息",
1255
+ "members": [
1256
+ {
1257
+ "disabled": false,
1258
+ "document": "签署方唯一编号,一个全局唯一的标识符,不同的流程不会出现冲突。 可以使用签署方的唯一编号来生成签署链接(也可以通过RecipientId来生成签署链接)。\t",
1259
+ "example": "06f2bc0f1772d8deac2f92b5df61a5ac",
1260
+ "member": "string",
1261
+ "name": "SignId",
1262
+ "output_required": false,
1263
+ "required": false,
1264
+ "type": "string",
1265
+ "value_allowed_null": false
1266
+ },
1267
+ {
1268
+ "disabled": false,
1269
+ "document": "签署方角色编号,签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。 填写控件和签署控件都与特定的角色编号关联。\t",
1270
+ "example": "yDwhSUUckp3lqxlpUu6Ni3SvjJPoxxxx",
1271
+ "member": "string",
1272
+ "name": "RecipientId",
1273
+ "output_required": false,
1274
+ "required": false,
1275
+ "type": "string",
1276
+ "value_allowed_null": false
1277
+ }
1278
+ ],
1279
+ "usage": "both"
1280
+ },
1176
1281
  "ChannelBatchCancelFlowsRequest": {
1177
1282
  "document": "ChannelBatchCancelFlows请求参数结构体",
1178
1283
  "members": [
@@ -1787,7 +1892,7 @@
1787
1892
  },
1788
1893
  {
1789
1894
  "disabled": false,
1790
- "document": "证件类型,支持以下类型\n<ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>\n<li>**HONGKONG_AND_MACAO** : 港澳居民来往内地通行证</li>\n<li>**HONGKONG_MACAO_AND_TAIWAN** : 港澳台居民居住证(格式同居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
1895
+ "document": "证件类型,支持以下类型\n<ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>\n<li>**HONGKONG_AND_MACAO** : 中国港澳居民来往内地通行证</li>\n<li>**HONGKONG_MACAO_AND_TAIWAN** : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
1791
1896
  "example": "无",
1792
1897
  "member": "string",
1793
1898
  "name": "IdCardType",
@@ -1796,7 +1901,7 @@
1796
1901
  },
1797
1902
  {
1798
1903
  "disabled": false,
1799
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`请确保和合同中填入的一致`",
1904
+ "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`请确保和合同中填入的一致`",
1800
1905
  "example": "无",
1801
1906
  "member": "string",
1802
1907
  "name": "IdCardNumber",
@@ -1874,6 +1979,15 @@
1874
1979
  "name": "AutoJumpBack",
1875
1980
  "required": false,
1876
1981
  "type": "bool"
1982
+ },
1983
+ {
1984
+ "disabled": false,
1985
+ "document": "签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。\n\n在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。\n\n参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。",
1986
+ "example": "无",
1987
+ "member": "string",
1988
+ "name": "UrlUseEnv",
1989
+ "required": false,
1990
+ "type": "string"
1877
1991
  }
1878
1992
  ],
1879
1993
  "type": "object"
@@ -2047,6 +2161,52 @@
2047
2161
  ],
2048
2162
  "type": "object"
2049
2163
  },
2164
+ "ChannelCreateDynamicFlowApproverRequest": {
2165
+ "document": "ChannelCreateDynamicFlowApprover请求参数结构体",
2166
+ "members": [
2167
+ {
2168
+ "disabled": false,
2169
+ "document": "动态合同信息\n",
2170
+ "example": "无",
2171
+ "member": "DynamicFlowInfo",
2172
+ "name": "FillDynamicFlowList",
2173
+ "required": true,
2174
+ "type": "list"
2175
+ },
2176
+ {
2177
+ "disabled": false,
2178
+ "document": "关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证\t",
2179
+ "example": "无",
2180
+ "member": "Agent",
2181
+ "name": "Agent",
2182
+ "required": false,
2183
+ "type": "object"
2184
+ }
2185
+ ],
2186
+ "type": "object"
2187
+ },
2188
+ "ChannelCreateDynamicFlowApproverResponse": {
2189
+ "document": "ChannelCreateDynamicFlowApprover返回参数结构体",
2190
+ "members": [
2191
+ {
2192
+ "disabled": false,
2193
+ "document": "动态合同补充结果列表",
2194
+ "example": "无",
2195
+ "member": "DynamicFlowResult",
2196
+ "name": "DynamicFlowResultList",
2197
+ "output_required": false,
2198
+ "type": "list",
2199
+ "value_allowed_null": false
2200
+ },
2201
+ {
2202
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2203
+ "member": "string",
2204
+ "name": "RequestId",
2205
+ "type": "string"
2206
+ }
2207
+ ],
2208
+ "type": "object"
2209
+ },
2050
2210
  "ChannelCreateEmbedWebUrlRequest": {
2051
2211
  "document": "ChannelCreateEmbedWebUrl请求参数结构体",
2052
2212
  "members": [
@@ -2316,7 +2476,7 @@
2316
2476
  {
2317
2477
  "disabled": false,
2318
2478
  "document": "您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:\n<ul><li>{合同名称} </li>\n<li>{发起方企业} </li>\n<li>{发起方姓名} </li>\n<li>{签署方N企业}</li>\n<li>{签署方N姓名}</li></ul>\n其中,N表示签署方的编号,从1开始,不能超过签署人的数量。\n\n例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子\n\n合同名称:租房合同 \n发起方:腾讯公司(张三) \n签署方:李四\n\n",
2319
- "example": "合同名称:{合同名称} {发起方企业} {发起方姓名};国家:中国;发起方:{发起方企业};签署方1: {签署方1企业};签署",
2479
+ "example": "合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}",
2320
2480
  "member": "string",
2321
2481
  "name": "CustomShowMap",
2322
2482
  "required": false,
@@ -2420,6 +2580,15 @@
2420
2580
  "name": "PreviewType",
2421
2581
  "required": false,
2422
2582
  "type": "int"
2583
+ },
2584
+ {
2585
+ "disabled": false,
2586
+ "document": "是否开启动态合同(动态签署人2.0)\n<ul><li> **false** :(默认) 不开启动态合同(动态签署人2.0)</li>\n<li> **true** :开启动态合同(动态签署人2.0),发起后可继续追加合同签署人</li></ul>\n",
2587
+ "example": "false",
2588
+ "member": "bool",
2589
+ "name": "OpenDynamicFlow",
2590
+ "required": false,
2591
+ "type": "bool"
2423
2592
  }
2424
2593
  ],
2425
2594
  "type": "object"
@@ -2450,7 +2619,7 @@
2450
2619
  {
2451
2620
  "disabled": false,
2452
2621
  "document": "预览链接,有效期5分钟\n注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL",
2453
- "example": "https://embed.qian.tencent.cn/document-url-preview?channel=PROXYCHANNEL&scene=SINGLEPAGE&code=yDAY0UUckp7ouj3qU3GpRQCZvA3aO2l0&codeType=QUICK&businessType=RESOURCE&businessId=yDCY0UUckp7oucf2UxAAGY1RtjPw9Pyt",
2622
+ "example": "https://embed.qian.tencent.cn/document-url-preview?channel=PROXYCHANNEL&scene=SINGLEPAGE&code=yDAY0UUckp7ouj3qU3GpRQCZvA3aO2l0",
2454
2623
  "member": "string",
2455
2624
  "name": "PreviewUrl",
2456
2625
  "output_required": false,
@@ -3308,7 +3477,7 @@
3308
3477
  },
3309
3478
  {
3310
3479
  "disabled": false,
3311
- "document": "证件号码, 应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
3480
+ "document": "证件号码, 应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
3312
3481
  "example": "无",
3313
3482
  "member": "string",
3314
3483
  "name": "IdCardNumber",
@@ -3344,7 +3513,7 @@
3344
3513
  },
3345
3514
  {
3346
3515
  "disabled": false,
3347
- "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注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
3516
+ "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注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
3348
3517
  "example": "无",
3349
3518
  "member": "string",
3350
3519
  "name": "IdCardType",
@@ -5670,7 +5839,7 @@
5670
5839
  },
5671
5840
  {
5672
5841
  "disabled": false,
5673
- "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注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
5842
+ "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注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
5674
5843
  "example": "ID_CARD ",
5675
5844
  "member": "string",
5676
5845
  "name": "ApproverIdCardType",
@@ -5679,7 +5848,7 @@
5679
5848
  },
5680
5849
  {
5681
5850
  "disabled": false,
5682
- "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。\n</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
5851
+ "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。\n</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
5683
5852
  "example": "110101192008317114",
5684
5853
  "member": "string",
5685
5854
  "name": "ApproverIdCardNumber",
@@ -6650,7 +6819,7 @@
6650
6819
  },
6651
6820
  {
6652
6821
  "disabled": false,
6653
- "document": "子客经办人身份证\n注意:`如果已同步,这里非空会更新同步的经办人身份证号,暂时只支持居民身份证类型`。",
6822
+ "document": "子客经办人身份证\n注意:`如果已同步,这里非空会更新同步的经办人身份证号,暂时只支持中国大陆居民身份证类型`。",
6654
6823
  "example": "无",
6655
6824
  "member": "string",
6656
6825
  "name": "ProxyOperatorIdCardNumber",
@@ -7169,6 +7338,61 @@
7169
7338
  ],
7170
7339
  "type": "object"
7171
7340
  },
7341
+ "CreateOrganizationAuthFileRequest": {
7342
+ "document": "CreateOrganizationAuthFile请求参数结构体",
7343
+ "members": [
7344
+ {
7345
+ "disabled": false,
7346
+ "document": "关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: Agent.AppId</li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>\n<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>\n</ul>\n第三方平台子客企业和员工必须已经经过实名认证",
7347
+ "example": "无",
7348
+ "member": "Agent",
7349
+ "name": "Agent",
7350
+ "required": true,
7351
+ "type": "object"
7352
+ },
7353
+ {
7354
+ "disabled": false,
7355
+ "document": "企业授权书信息参数, 需要自行保证这些参数跟营业执照中的信息一致。",
7356
+ "example": "无",
7357
+ "member": "OrganizationCommonInfo",
7358
+ "name": "OrganizationCommonInfo",
7359
+ "required": false,
7360
+ "type": "object"
7361
+ },
7362
+ {
7363
+ "disabled": false,
7364
+ "document": "授权书类型:\n- 0: 企业认证超管授权书\n- 1: 超管变更授权书\n- 2: 企业注销授权书",
7365
+ "example": "无",
7366
+ "member": "uint64",
7367
+ "name": "Type",
7368
+ "required": false,
7369
+ "type": "int"
7370
+ }
7371
+ ],
7372
+ "type": "object"
7373
+ },
7374
+ "CreateOrganizationAuthFileResponse": {
7375
+ "document": "CreateOrganizationAuthFile返回参数结构体",
7376
+ "members": [
7377
+ {
7378
+ "disabled": false,
7379
+ "document": "授权书链接,有效期5分钟。\n注意:此字段可能返回 null,表示取不到有效值。",
7380
+ "example": "无",
7381
+ "member": "string",
7382
+ "name": "FileUrl",
7383
+ "output_required": true,
7384
+ "type": "string",
7385
+ "value_allowed_null": true
7386
+ },
7387
+ {
7388
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
7389
+ "member": "string",
7390
+ "name": "RequestId",
7391
+ "type": "string"
7392
+ }
7393
+ ],
7394
+ "type": "object"
7395
+ },
7172
7396
  "CreatePartnerAutoSignAuthUrlRequest": {
7173
7397
  "document": "CreatePartnerAutoSignAuthUrl请求参数结构体",
7174
7398
  "members": [
@@ -7294,7 +7518,7 @@
7294
7518
  },
7295
7519
  {
7296
7520
  "disabled": false,
7297
- "document": "证件类型,支持以下类型<ul><li> ID_CARD : 居民身份证 (默认值)</li><li> HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li><li> HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
7521
+ "document": "证件类型,支持以下类型<ul><li> ID_CARD : 中国大陆居民身份证 (默认值)</li><li> HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li> HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
7298
7522
  "example": "无",
7299
7523
  "member": "string",
7300
7524
  "name": "IdCardType",
@@ -7303,7 +7527,7 @@
7303
7527
  },
7304
7528
  {
7305
7529
  "disabled": false,
7306
- "document": "证件号码,应符合以下规则<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
7530
+ "document": "证件号码,应符合以下规则<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
7307
7531
  "example": "无",
7308
7532
  "member": "string",
7309
7533
  "name": "IdCardNumber",
@@ -7589,7 +7813,7 @@
7589
7813
  },
7590
7814
  {
7591
7815
  "disabled": false,
7592
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
7816
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
7593
7817
  "example": "ID_CARD",
7594
7818
  "member": "string",
7595
7819
  "name": "IdCardType",
@@ -7598,7 +7822,7 @@
7598
7822
  },
7599
7823
  {
7600
7824
  "disabled": false,
7601
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
7825
+ "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
7602
7826
  "example": "620000198802020000",
7603
7827
  "member": "string",
7604
7828
  "name": "IdCardNumber",
@@ -7676,6 +7900,15 @@
7676
7900
  "name": "FlowGroupUrlInfo",
7677
7901
  "required": false,
7678
7902
  "type": "object"
7903
+ },
7904
+ {
7905
+ "disabled": false,
7906
+ "document": "签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。\n\n在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。\n\n参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。\n\n",
7907
+ "example": "无",
7908
+ "member": "string",
7909
+ "name": "UrlUseEnv",
7910
+ "required": false,
7911
+ "type": "string"
7679
7912
  }
7680
7913
  ],
7681
7914
  "type": "object"
@@ -8782,6 +9015,110 @@
8782
9015
  ],
8783
9016
  "usage": "in"
8784
9017
  },
9018
+ "DynamicFlowApproverResult": {
9019
+ "document": "动态合同签署人结果",
9020
+ "members": [
9021
+ {
9022
+ "disabled": false,
9023
+ "document": "签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;\t",
9024
+ "example": "无",
9025
+ "member": "string",
9026
+ "name": "RecipientId",
9027
+ "output_required": true,
9028
+ "type": "string",
9029
+ "value_allowed_null": false
9030
+ },
9031
+ {
9032
+ "disabled": false,
9033
+ "document": "签署ID - 发起流程时系统自动补充 - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息\t",
9034
+ "example": "无",
9035
+ "member": "string",
9036
+ "name": "SignId",
9037
+ "output_required": true,
9038
+ "type": "string",
9039
+ "value_allowed_null": false
9040
+ },
9041
+ {
9042
+ "disabled": false,
9043
+ "document": "签署人状态信息",
9044
+ "example": "无",
9045
+ "member": "int64",
9046
+ "name": "ApproverStatus",
9047
+ "output_required": true,
9048
+ "type": "int",
9049
+ "value_allowed_null": false
9050
+ }
9051
+ ],
9052
+ "usage": "out"
9053
+ },
9054
+ "DynamicFlowInfo": {
9055
+ "document": "动态合同信息",
9056
+ "members": [
9057
+ {
9058
+ "disabled": false,
9059
+ "document": "合同流程ID,为32位字符串。 - 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 - 可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。 - <font color=\"red\">不建议继续使用</font>,请使用<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId指定合同\t",
9060
+ "example": "无",
9061
+ "member": "string",
9062
+ "name": "FlowId",
9063
+ "required": true,
9064
+ "type": "string"
9065
+ },
9066
+ {
9067
+ "disabled": false,
9068
+ "document": "合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。\t",
9069
+ "example": "无",
9070
+ "member": "FlowApproverInfo",
9071
+ "name": "FlowApprovers",
9072
+ "required": true,
9073
+ "type": "list"
9074
+ },
9075
+ {
9076
+ "disabled": false,
9077
+ "document": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传: <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul> 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`\t",
9078
+ "example": "E_PRESCRIPTION_AUTO_SIGN\t",
9079
+ "member": "string",
9080
+ "name": "AutoSignScene",
9081
+ "required": false,
9082
+ "type": "string"
9083
+ },
9084
+ {
9085
+ "disabled": false,
9086
+ "document": "签署人校验方式 VerifyCheck: 人脸识别(默认) MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。\t",
9087
+ "example": "无",
9088
+ "member": "string",
9089
+ "name": "ApproverVerifyType",
9090
+ "required": false,
9091
+ "type": "string"
9092
+ }
9093
+ ],
9094
+ "usage": "in"
9095
+ },
9096
+ "DynamicFlowResult": {
9097
+ "document": "动态合同补充签署人结果",
9098
+ "members": [
9099
+ {
9100
+ "disabled": false,
9101
+ "document": "合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)\t",
9102
+ "example": "无",
9103
+ "member": "string",
9104
+ "name": "FlowId",
9105
+ "output_required": false,
9106
+ "type": "string",
9107
+ "value_allowed_null": false
9108
+ },
9109
+ {
9110
+ "disabled": false,
9111
+ "document": "动态合同签署人补充结果信息列表",
9112
+ "example": "无",
9113
+ "member": "DynamicFlowApproverResult",
9114
+ "name": "DynamicFlowApproverList",
9115
+ "output_required": false,
9116
+ "type": "list",
9117
+ "value_allowed_null": false
9118
+ }
9119
+ ],
9120
+ "usage": "out"
9121
+ },
8785
9122
  "EmbedUrlOption": {
8786
9123
  "document": "创建嵌入式页面url个性化参数",
8787
9124
  "members": [
@@ -8965,7 +9302,7 @@
8965
9302
  },
8966
9303
  {
8967
9304
  "disabled": false,
8968
- "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注: `1.其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`\n`2.补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
9305
+ "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注: `1.其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`\n`2.补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
8969
9306
  "example": "ID_CARD",
8970
9307
  "member": "string",
8971
9308
  "name": "ApproverIdCardType",
@@ -8974,7 +9311,7 @@
8974
9311
  },
8975
9312
  {
8976
9313
  "disabled": false,
8977
- "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
9314
+ "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
8978
9315
  "example": "无",
8979
9316
  "member": "string",
8980
9317
  "name": "ApproverIdCardNumber",
@@ -9261,7 +9598,7 @@
9261
9598
  },
9262
9599
  {
9263
9600
  "disabled": false,
9264
- "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注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
9601
+ "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注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
9265
9602
  "example": "ID_CARD",
9266
9603
  "member": "string",
9267
9604
  "name": "IdCardType",
@@ -9270,7 +9607,7 @@
9270
9607
  },
9271
9608
  {
9272
9609
  "disabled": false,
9273
- "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
9610
+ "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
9274
9611
  "example": "110101192008317114",
9275
9612
  "member": "string",
9276
9613
  "name": "IdCardNumber",
@@ -9423,7 +9760,7 @@
9423
9760
  },
9424
9761
  {
9425
9762
  "disabled": false,
9426
- "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默认为1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)\n\n注: \n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明\n3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>,至少需要再增加一种其他校验方式。\n4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用,其他端暂不支持。",
9763
+ "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默认为:\n1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)\n\n注: \n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明\n3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>,至少需要再增加一种其他校验方式。\n4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用,其他端暂不支持。",
9427
9764
  "example": "[1,2,3]",
9428
9765
  "member": "int64",
9429
9766
  "name": "ApproverSignTypes",
@@ -10594,7 +10931,7 @@
10594
10931
  },
10595
10932
  {
10596
10933
  "disabled": false,
10597
- "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注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
10934
+ "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注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
10598
10935
  "example": "ID_CARD",
10599
10936
  "member": "string",
10600
10937
  "name": "ApproverIdCardType",
@@ -10603,7 +10940,7 @@
10603
10940
  },
10604
10941
  {
10605
10942
  "disabled": false,
10606
- "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
10943
+ "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
10607
10944
  "example": "620000198802020000",
10608
10945
  "member": "string",
10609
10946
  "name": "ApproverIdCardNumber",
@@ -10905,6 +11242,155 @@
10905
11242
  ],
10906
11243
  "usage": "out"
10907
11244
  },
11245
+ "OrganizationCommonInfo": {
11246
+ "document": "企业认证信息参数, 需要保证这些参数跟营业执照中的信息一致。",
11247
+ "members": [
11248
+ {
11249
+ "disabled": false,
11250
+ "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。\n注意:此字段可能返回 null,表示取不到有效值。",
11251
+ "example": "无",
11252
+ "member": "string",
11253
+ "name": "OrganizationName",
11254
+ "output_required": false,
11255
+ "required": true,
11256
+ "type": "string",
11257
+ "value_allowed_null": true
11258
+ },
11259
+ {
11260
+ "disabled": false,
11261
+ "document": "组织机构企业统一社会信用代码。\n请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。\n注意:此字段可能返回 null,表示取不到有效值。",
11262
+ "example": "无",
11263
+ "member": "string",
11264
+ "name": "UniformSocialCreditCode",
11265
+ "output_required": false,
11266
+ "required": true,
11267
+ "type": "string",
11268
+ "value_allowed_null": true
11269
+ },
11270
+ {
11271
+ "disabled": false,
11272
+ "document": "组织机构法人的姓名。\n请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。\n注意:此字段可能返回 null,表示取不到有效值。",
11273
+ "example": "无",
11274
+ "member": "string",
11275
+ "name": "LegalName",
11276
+ "output_required": false,
11277
+ "required": true,
11278
+ "type": "string",
11279
+ "value_allowed_null": true
11280
+ },
11281
+ {
11282
+ "disabled": false,
11283
+ "document": "组织机构法人的证件类型\n注意:此字段可能返回 null,表示取不到有效值。",
11284
+ "example": "居民身份证",
11285
+ "member": "string",
11286
+ "name": "LegalIdCardType",
11287
+ "output_required": false,
11288
+ "required": false,
11289
+ "type": "string",
11290
+ "value_allowed_null": true
11291
+ },
11292
+ {
11293
+ "disabled": false,
11294
+ "document": "组织机构法人的证件号码\n注意:此字段可能返回 null,表示取不到有效值。",
11295
+ "example": "无",
11296
+ "member": "string",
11297
+ "name": "LegalIdCardNumber",
11298
+ "output_required": false,
11299
+ "required": false,
11300
+ "type": "string",
11301
+ "value_allowed_null": true
11302
+ },
11303
+ {
11304
+ "disabled": false,
11305
+ "document": "组织机构超管姓名。\n\n注意:此字段可能返回 null,表示取不到有效值。",
11306
+ "example": "无",
11307
+ "member": "string",
11308
+ "name": "AdminName",
11309
+ "output_required": false,
11310
+ "required": false,
11311
+ "type": "string",
11312
+ "value_allowed_null": true
11313
+ },
11314
+ {
11315
+ "disabled": false,
11316
+ "document": "组织机构超管手机号。\n\n注意:此字段可能返回 null,表示取不到有效值。",
11317
+ "example": "无",
11318
+ "member": "string",
11319
+ "name": "AdminMobile",
11320
+ "output_required": false,
11321
+ "required": false,
11322
+ "type": "string",
11323
+ "value_allowed_null": true
11324
+ },
11325
+ {
11326
+ "disabled": false,
11327
+ "document": "组织机构超管证件类型\n\n注意:此字段可能返回 null,表示取不到有效值。",
11328
+ "example": "居民身份证",
11329
+ "member": "string",
11330
+ "name": "AdminIdCardType",
11331
+ "output_required": false,
11332
+ "required": false,
11333
+ "type": "string",
11334
+ "value_allowed_null": true
11335
+ },
11336
+ {
11337
+ "disabled": false,
11338
+ "document": "组织机构超管证件号码\n\n注意:此字段可能返回 null,表示取不到有效值。",
11339
+ "example": "无",
11340
+ "member": "string",
11341
+ "name": "AdminIdCardNumber",
11342
+ "output_required": false,
11343
+ "required": false,
11344
+ "type": "string",
11345
+ "value_allowed_null": true
11346
+ },
11347
+ {
11348
+ "disabled": false,
11349
+ "document": "原超管姓名\n注意:此字段可能返回 null,表示取不到有效值。",
11350
+ "example": "无",
11351
+ "member": "string",
11352
+ "name": "OldAdminName",
11353
+ "output_required": false,
11354
+ "required": false,
11355
+ "type": "string",
11356
+ "value_allowed_null": true
11357
+ },
11358
+ {
11359
+ "disabled": false,
11360
+ "document": "原超管手机号\n注意:此字段可能返回 null,表示取不到有效值。",
11361
+ "example": "无",
11362
+ "member": "string",
11363
+ "name": "OldAdminMobile",
11364
+ "output_required": false,
11365
+ "required": false,
11366
+ "type": "string",
11367
+ "value_allowed_null": true
11368
+ },
11369
+ {
11370
+ "disabled": false,
11371
+ "document": "原超管证件类型\n注意:此字段可能返回 null,表示取不到有效值。",
11372
+ "example": "居民身份证",
11373
+ "member": "string",
11374
+ "name": "OldAdminIdCardType",
11375
+ "output_required": false,
11376
+ "required": false,
11377
+ "type": "string",
11378
+ "value_allowed_null": true
11379
+ },
11380
+ {
11381
+ "disabled": false,
11382
+ "document": "原超管证件号码\n注意:此字段可能返回 null,表示取不到有效值。",
11383
+ "example": "无",
11384
+ "member": "string",
11385
+ "name": "OldAdminIdCardNumber",
11386
+ "output_required": false,
11387
+ "required": false,
11388
+ "type": "string",
11389
+ "value_allowed_null": true
11390
+ }
11391
+ ],
11392
+ "usage": "both"
11393
+ },
10908
11394
  "OrganizationInfo": {
10909
11395
  "document": "机构信息",
10910
11396
  "members": [
@@ -11371,7 +11857,7 @@
11371
11857
  },
11372
11858
  {
11373
11859
  "disabled": false,
11374
- "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
11860
+ "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n",
11375
11861
  "example": "ID_CARD ",
11376
11862
  "member": "string",
11377
11863
  "name": "IdCardType",
@@ -11646,7 +12132,7 @@
11646
12132
  "example": "深圳市南山区高新区科技中一路腾讯大厦35层",
11647
12133
  "member": "string",
11648
12134
  "name": "Address",
11649
- "required": true,
12135
+ "required": false,
11650
12136
  "type": "string"
11651
12137
  },
11652
12138
  {
@@ -11678,7 +12164,7 @@
11678
12164
  },
11679
12165
  {
11680
12166
  "disabled": false,
11681
- "document": "经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
12167
+ "document": "经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n",
11682
12168
  "example": "无",
11683
12169
  "member": "string",
11684
12170
  "name": "AdminIdCardType",
@@ -11765,7 +12251,7 @@
11765
12251
  },
11766
12252
  {
11767
12253
  "disabled": false,
11768
- "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证(默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
12254
+ "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证(默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
11769
12255
  "example": "ID_CARD",
11770
12256
  "member": "string",
11771
12257
  "name": "IdCardType",
@@ -11774,7 +12260,7 @@
11774
12260
  },
11775
12261
  {
11776
12262
  "disabled": false,
11777
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。\n</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
12263
+ "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。\n</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
11778
12264
  "example": "620000198802020000",
11779
12265
  "member": "string",
11780
12266
  "name": "IdCardNumber",
@@ -11848,57 +12334,52 @@
11848
12334
  "usage": "in"
11849
12335
  },
11850
12336
  "RelieveInfo": {
11851
- "document": "解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。",
12337
+ "document": "解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。下面各种字段在解除协议中的位置参考:\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/5087164cfe5a15fa3ced3180842d5da9.png)",
11852
12338
  "members": [
11853
12339
  {
11854
12340
  "disabled": false,
11855
- "document": "解除理由,最大支持200个字",
11856
- "example": "xxx",
12341
+ "document": "解除理由,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
12342
+ "example": "合同中的金额写错了",
11857
12343
  "member": "string",
11858
12344
  "name": "Reason",
11859
12345
  "required": true,
11860
- "type": "string",
11861
- "value_allowed_null": false
12346
+ "type": "string"
11862
12347
  },
11863
12348
  {
11864
12349
  "disabled": false,
11865
- "document": "解除后仍然有效的条款,保留条款,最大支持200个字",
11866
- "example": "xxx",
12350
+ "document": "解除后仍然有效的条款,保留条款,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。\n",
12351
+ "example": "买卖小狗的交易地点、小狗的品种",
11867
12352
  "member": "string",
11868
12353
  "name": "RemainInForceItem",
11869
12354
  "required": false,
11870
- "type": "string",
11871
- "value_allowed_null": false
12355
+ "type": "string"
11872
12356
  },
11873
12357
  {
11874
12358
  "disabled": false,
11875
- "document": "原合同事项处理-费用结算,最大支持200个字",
11876
- "example": "xxx",
12359
+ "document": "原合同事项处理-费用结算,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
12360
+ "example": "1000元",
11877
12361
  "member": "string",
11878
12362
  "name": "OriginalExpenseSettlement",
11879
12363
  "required": false,
11880
- "type": "string",
11881
- "value_allowed_null": false
12364
+ "type": "string"
11882
12365
  },
11883
12366
  {
11884
12367
  "disabled": false,
11885
- "document": "原合同事项处理-其他事项,最大支持200个字",
11886
- "example": "xxx",
12368
+ "document": "原合同事项处理-其他事项,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
12369
+ "example": "原合同中的补充条款依然生效",
11887
12370
  "member": "string",
11888
12371
  "name": "OriginalOtherSettlement",
11889
12372
  "required": false,
11890
- "type": "string",
11891
- "value_allowed_null": false
12373
+ "type": "string"
11892
12374
  },
11893
12375
  {
11894
12376
  "disabled": false,
11895
- "document": "其他约定,最大支持200个字",
11896
- "example": "xxx",
12377
+ "document": "其他约定(如约定的与解除协议存在冲突的,以【其他约定】为准),最大支持200个字,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
12378
+ "example": "解除后1天内部签署新的合同",
11897
12379
  "member": "string",
11898
12380
  "name": "OtherDeals",
11899
12381
  "required": false,
11900
- "type": "string",
11901
- "value_allowed_null": false
12382
+ "type": "string"
11902
12383
  }
11903
12384
  ],
11904
12385
  "usage": "in"
@@ -12007,6 +12488,16 @@
12007
12488
  "output_required": true,
12008
12489
  "type": "int",
12009
12490
  "value_allowed_null": false
12491
+ },
12492
+ {
12493
+ "disabled": false,
12494
+ "document": "微信小程序二维码",
12495
+ "example": "https://file.ess.tencent.cn/bresource/resource/resource/0/0.PNG?hkey=a976edda49eacc2b264c2df468c30fcd69023cd782421bdbedddf8a95c7859d4467844c38fb9ea20b47d4b2f89396717f8deac5dcb25f32d718f0c13b48f53a2f6f69096b3b301aad56de87d7a8499fe374e5e2891dd778bb0c82394640fe124be22c63ba4e022a046cbc298006d3341",
12496
+ "member": "string",
12497
+ "name": "WeixinQrCodeUrl",
12498
+ "output_required": true,
12499
+ "type": "string",
12500
+ "value_allowed_null": false
12010
12501
  }
12011
12502
  ],
12012
12503
  "usage": "out"
@@ -12494,7 +12985,7 @@
12494
12985
  },
12495
12986
  {
12496
12987
  "disabled": false,
12497
- "document": "第三方平台子客企业法定代表人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li></ul>\n注: `现在仅支持ID_CARD居民身份证类型`",
12988
+ "document": "第三方平台子客企业法定代表人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li></ul>\n注: `现在仅支持ID_CARD中国大陆居民身份证类型`",
12498
12989
  "example": "无",
12499
12990
  "member": "string",
12500
12991
  "name": "ProxyLegalIdCardType",
@@ -12503,7 +12994,7 @@
12503
12994
  },
12504
12995
  {
12505
12996
  "disabled": false,
12506
- "document": "第三方平台子客企业法定代表人的证件号码, 应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>",
12997
+ "document": "第三方平台子客企业法定代表人的证件号码, 应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>",
12507
12998
  "example": "无",
12508
12999
  "member": "string",
12509
13000
  "name": "ProxyLegalIdCardNumber",
@@ -12750,7 +13241,7 @@
12750
13241
  },
12751
13242
  {
12752
13243
  "disabled": false,
12753
- "document": "文件名,最大长度不超过200字符",
13244
+ "document": "文件的名字。\n文件名的最大长度应不超过200个字符,并且文件名的后缀必须反映其文件类型。\n例如,PDF文件应以“.pdf”结尾,如“XXX.pdf”,而Word文件应以“.doc”或“.docx”结尾,如“XXX.doc”或“XXX.docx”。",
12754
13245
  "example": "无",
12755
13246
  "member": "string",
12756
13247
  "name": "FileName",
@@ -12783,7 +13274,7 @@
12783
13274
  },
12784
13275
  {
12785
13276
  "disabled": false,
12786
- "document": "上传文件内容数组,最多支持上传20个文件。",
13277
+ "document": "上传文件内容数组,一次最多可上传20个文件。\n\n<b>若上传多个文件,所有文件必须为相同类型</b>,例如全部为PDF或全部为Word文件。不支持混合文件类型的上传。",
12787
13278
  "example": "FileInfos",
12788
13279
  "member": "UploadFile",
12789
13280
  "name": "FileInfos",
@@ -12817,7 +13308,7 @@
12817
13308
  },
12818
13309
  {
12819
13310
  "disabled": false,
12820
- "document": "文件资源ID数组,每个文件资源ID为32位字符串。\n建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。\n注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用`",
13311
+ "document": "文件资源ID数组,每个文件资源ID为32位字符串。\n建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。\n注:`有效期一个小时(超过一小时后系统不定期清理,会有部分时间差), 有效期内此文件id可以反复使用, 超过有效期无法使用`",
12821
13312
  "example": "无",
12822
13313
  "member": "string",
12823
13314
  "name": "FileIds",
@@ -12975,7 +13466,7 @@
12975
13466
  },
12976
13467
  {
12977
13468
  "disabled": false,
12978
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
13469
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
12979
13470
  "example": "ID_CARD",
12980
13471
  "member": "string",
12981
13472
  "name": "IdCardType",
@@ -12984,7 +13475,7 @@
12984
13475
  },
12985
13476
  {
12986
13477
  "disabled": false,
12987
- "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
13478
+ "document": "证件号码,应符合以下规则\n<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
12988
13479
  "example": "620000198802020000",
12989
13480
  "member": "string",
12990
13481
  "name": "IdCardNumber",