tccli 3.0.1252.1__py2.py3-none-any.whl → 3.0.1254.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/apm/v20210622/api.json +298 -300
- tccli/services/apm/v20210622/examples.json +4 -4
- tccli/services/autoscaling/v20180419/api.json +72 -0
- tccli/services/ca/v20230228/api.json +16 -16
- tccli/services/cat/v20180409/api.json +4 -4
- tccli/services/cdwdoris/v20211228/api.json +441 -408
- tccli/services/cdwdoris/v20211228/examples.json +53 -35
- tccli/services/clb/v20180317/api.json +88 -6
- tccli/services/clb/v20180317/examples.json +4 -4
- tccli/services/cvm/cvm_client.py +121 -68
- tccli/services/cvm/v20170312/api.json +55 -3
- tccli/services/cvm/v20170312/examples.json +8 -0
- tccli/services/dc/v20180410/api.json +21 -2
- tccli/services/dc/v20180410/examples.json +2 -2
- tccli/services/dcdb/v20180411/api.json +1 -1
- tccli/services/dcdb/v20180411/examples.json +1 -1
- tccli/services/dlc/v20210125/api.json +53 -4
- tccli/services/emr/v20190103/api.json +161 -141
- tccli/services/ess/v20201111/api.json +6 -6
- tccli/services/ess/v20201111/examples.json +9 -9
- tccli/services/essbasic/v20210526/api.json +7 -7
- tccli/services/hunyuan/v20230901/api.json +27 -7
- tccli/services/hunyuan/v20230901/examples.json +1 -1
- tccli/services/lcic/v20220817/api.json +4 -4
- tccli/services/lke/v20231130/api.json +16 -7
- tccli/services/lkeap/v20240522/api.json +2 -2
- tccli/services/mariadb/v20170312/api.json +1 -1
- tccli/services/mariadb/v20170312/examples.json +1 -1
- tccli/services/mna/v20210119/api.json +36 -36
- tccli/services/monitor/v20180724/api.json +32 -32
- tccli/services/mps/v20190612/api.json +4 -4
- tccli/services/ocr/v20181119/api.json +28 -0
- tccli/services/ssl/v20191205/api.json +9 -0
- tccli/services/tchd/v20230306/api.json +3 -3
- tccli/services/teo/v20220901/api.json +26 -14
- tccli/services/tiw/v20190919/api.json +1 -1
- tccli/services/vod/v20180717/api.json +3 -3
- tccli/services/vpc/v20170312/api.json +39 -36366
- tccli/services/vpc/v20170312/examples.json +5 -3513
- tccli/services/vpc/vpc_client.py +4 -20462
- tccli/services/wedata/v20210820/api.json +437 -8
- tccli/services/wedata/v20210820/examples.json +10 -2
- tccli/services/wedata/wedata_client.py +57 -4
- {tccli-3.0.1252.1.dist-info → tccli-3.0.1254.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1252.1.dist-info → tccli-3.0.1254.1.dist-info}/RECORD +49 -49
- {tccli-3.0.1252.1.dist-info → tccli-3.0.1254.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1252.1.dist-info → tccli-3.0.1254.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1252.1.dist-info → tccli-3.0.1254.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -2078,7 +2078,7 @@
|
|
|
2078
2078
|
},
|
|
2079
2079
|
{
|
|
2080
2080
|
"disabled": false,
|
|
2081
|
-
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围6 :24</li>\n<li> <b>Opacity</b>： 透明度，范围0 :1</li>\n<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>\n<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>：`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li
|
|
2081
|
+
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围6 :24</li>\n<li> <b>Opacity</b>： 透明度，范围0 :1</li>\n<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>\n<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>：`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n\n",
|
|
2082
2082
|
"example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}",
|
|
2083
2083
|
"member": "string",
|
|
2084
2084
|
"name": "ComponentExtra",
|
|
@@ -2247,7 +2247,7 @@
|
|
|
2247
2247
|
},
|
|
2248
2248
|
{
|
|
2249
2249
|
"disabled": false,
|
|
2250
|
-
"document": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围\n\n1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型\n\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li
|
|
2250
|
+
"document": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围\n\n1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型\n\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n\n**注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`**\n\n\n2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）\n\n<ul><li>HANDWRITE : 需要实时手写的手写签名</li>\n<li>HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li>OCR_ESIGN : OCR印章（智慧手写签名）</li>\n<li>ESIGN : 个人印章</li>\n<li>SYSTEM_ESIGN : 系统印章</li></ul>\n\n3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。",
|
|
2251
2251
|
"example": "OFFICIAL",
|
|
2252
2252
|
"member": "string",
|
|
2253
2253
|
"name": "ComponentValue",
|
|
@@ -3027,7 +3027,7 @@
|
|
|
3027
3027
|
"members": [
|
|
3028
3028
|
{
|
|
3029
3029
|
"disabled": false,
|
|
3030
|
-
"document": "
|
|
3030
|
+
"document": "本合同的发起人，<a href=\"https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png\" target=\"_blank\">点击查看合同发起人展示的位置</a>\n\n注：支持填入集团子公司经办人 userId代发合同。",
|
|
3031
3031
|
"example": "无",
|
|
3032
3032
|
"member": "UserInfo",
|
|
3033
3033
|
"name": "Operator",
|
|
@@ -3614,7 +3614,7 @@
|
|
|
3614
3614
|
"members": [
|
|
3615
3615
|
{
|
|
3616
3616
|
"disabled": false,
|
|
3617
|
-
"document": "
|
|
3617
|
+
"document": "本合同的发起人 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png\" target=\"_blank\">点击查看合同发起人展示的位置</a>\n\n注： 支持填入集团子公司经办人 userId 代发合同。\n",
|
|
3618
3618
|
"example": "无",
|
|
3619
3619
|
"member": "UserInfo",
|
|
3620
3620
|
"name": "Operator",
|
|
@@ -4398,7 +4398,7 @@
|
|
|
4398
4398
|
"members": [
|
|
4399
4399
|
{
|
|
4400
4400
|
"disabled": false,
|
|
4401
|
-
"document": "
|
|
4401
|
+
"document": "本合同的发起人，<a href=\"https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png\" target=\"_blank\">点击查看合同发起人展示的位置</a>\n\n注： 支持填入集团子公司经办人 userId 代发合同。",
|
|
4402
4402
|
"example": "无",
|
|
4403
4403
|
"member": "UserInfo",
|
|
4404
4404
|
"name": "Operator",
|
|
@@ -14546,7 +14546,7 @@
|
|
|
14546
14546
|
"members": [
|
|
14547
14547
|
{
|
|
14548
14548
|
"disabled": false,
|
|
14549
|
-
"document": "
|
|
14549
|
+
"document": "本合同的发起人，<a href=\"https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png\" target=\"_blank\">点击查看合同发起人展示的位置</a>",
|
|
14550
14550
|
"example": "无",
|
|
14551
14551
|
"member": "UserInfo",
|
|
14552
14552
|
"name": "Operator",
|
|
@@ -997,43 +997,43 @@
|
|
|
997
997
|
"CreateReleaseFlow": [
|
|
998
998
|
{
|
|
999
999
|
"document": "1. 解除某个签署完成的合同\n2. 主企业代子企业操作(通过指定Agent中的ProxyOrganizationId)",
|
|
1000
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"Agent\": {\n \"ProxyOrganizationId\": \"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"RelievedApproverReceiptId\": \"yDRSRUUgygj6rqouUuO4zjESlnSFPcIE\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"
|
|
1000
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"Agent\": {\n \"ProxyOrganizationId\": \"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"RelievedApproverReceiptId\": \"yDRSRUUgygj6rqouUuO4zjESlnSFPcIE\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
|
|
1001
1001
|
"output": "{\n \"Response\": {\n \"FlowId\": \"yDwJBUUc***uxAppfh2XR\",\n \"RequestId\": \"s1693969234439636483\"\n }\n}",
|
|
1002
1002
|
"title": "发起解除协议（主代子场景）"
|
|
1003
1003
|
},
|
|
1004
1004
|
{
|
|
1005
1005
|
"document": "1.使用原流程的签署人\n2.包含了详细的解除内容",
|
|
1006
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"xxxOUUgyxxxxEWA0dddl\"\n },\n \"NeedRelievedFlowId\": \"xxxnGUUgygkgi7fdUx6JlVOE0wzdddd\",\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"
|
|
1006
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"xxxOUUgyxxxxEWA0dddl\"\n },\n \"NeedRelievedFlowId\": \"xxxnGUUgygkgi7fdUx6JlVOE0wzdddd\",\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\",\n \"Reason\": \"因为业务调整,结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
|
|
1007
1007
|
"output": "{\n \"Response\": {\n \"FlowId\": \"yDwnGUUgygkgi7fdUx6JlVOE0wzmtxxx\",\n \"RequestId\": \"s18776xxx345780\"\n }\n}",
|
|
1008
1008
|
"title": "发起解除协议（默认情况，使用原流程的签署人）"
|
|
1009
1009
|
},
|
|
1010
1010
|
{
|
|
1011
1011
|
"document": "1. 解除某个包含个人类型签署人的合同\n2. 更换其他个人类型签署人作为解除协议的参与人",
|
|
1012
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"NeedRelievedFlowId\": \"yDR1AUUgygjazuesUuO4zjESPW4PkfNi\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"15100000000\",\n \"Name\": \"李四\",\n \"RelievedApproverReceiptId\": \"yDwFdUUckpsvi8mpUEn0aFR1tWzReoTk\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"
|
|
1012
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"NeedRelievedFlowId\": \"yDR1AUUgygjazuesUuO4zjESPW4PkfNi\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"15100000000\",\n \"Name\": \"李四\",\n \"RelievedApproverReceiptId\": \"yDwFdUUckpsvi8mpUEn0aFR1tWzReoTk\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
|
|
1013
1013
|
"output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation\",\n \"Message\": \"不能更换非企业签署人身份信息\"\n },\n \"RequestId\": \"s16939xxx23898\"\n }\n}",
|
|
1014
1014
|
"title": "错误示例-解除协议中更换原合同个人类型的参与人"
|
|
1015
1015
|
},
|
|
1016
1016
|
{
|
|
1017
1017
|
"document": "1. 更换原合同中的企业参与人(通过指定ReleasedApprovers中的RelievedApproverReceiptId)\n2. 在解除协议中记录下原合同ID(通过设置UserData字段)",
|
|
1018
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"UserData\": \"{\\\"OriginalFlowId\\\":\\\"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\\\"}\",\n \"NeedRelievedFlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"RelievedApproverReceiptId\": \"yDRSRUUgygj6rqouUuO4zjESlnSFPcIE\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"
|
|
1018
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"UserData\": \"{\\\"OriginalFlowId\\\":\\\"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\\\"}\",\n \"NeedRelievedFlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"RelievedApproverReceiptId\": \"yDRSRUUgygj6rqouUuO4zjESlnSFPcIE\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
|
|
1019
1019
|
"output": "{\n \"Response\": {\n \"FlowId\": \"yDwJBUUc***uxAppfh2XR\",\n \"RequestId\": \"s1693969233639636483\"\n }\n}",
|
|
1020
1020
|
"title": "发起解除协议（记录下原合同与解除协议的映射关系）"
|
|
1021
1021
|
},
|
|
1022
1022
|
{
|
|
1023
1023
|
"document": "1. 更换原合同中本方企业的参与人\n2. 给该企业参与人指定自动签署(ApproverType 设置为 ENTERPRISESERVER)",
|
|
1024
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"RelievedApproverReceiptId\": \"yDRSRUUgygj6rqouUuO4zjESlnSFPcIE\",\n \"ApproverType\": \"ENTERPRISESERVER\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方以作赔偿\",\n \"OriginalOtherSettlement\": \"
|
|
1024
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"RelievedApproverReceiptId\": \"yDRSRUUgygj6rqouUuO4zjESlnSFPcIE\",\n \"ApproverType\": \"ENTERPRISESERVER\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方以作赔偿\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
|
|
1025
1025
|
"output": "{\n \"Response\": {\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"RequestId\": \"s312334445587989\"\n }\n}",
|
|
1026
1026
|
"title": "发起解除协议（替换原流程中本企业的参与人并指定其为自动签署）"
|
|
1027
1027
|
},
|
|
1028
1028
|
{
|
|
1029
1029
|
"document": "发起解除协议（使用本企业的签署人，替换用原流程中本企业的签署人）\n",
|
|
1030
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxjOUUgydjxxxxxjEWA07rC2xl\"\n },\n \"NeedRelievedFlowId\": \"yDwnGUUgygkgi7fdUx6JlVOE0wxxxxx\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"1870000000\",\n \"Name\": \"典子谦\",\n \"RelievedApproverReceiptId\": \"yDRscUUgyg1zr7vjUyJ8QKxxxxxxx\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"
|
|
1030
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxjOUUgydjxxxxxjEWA07rC2xl\"\n },\n \"NeedRelievedFlowId\": \"yDwnGUUgygkgi7fdUx6JlVOE0wxxxxx\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"1870000000\",\n \"Name\": \"典子谦\",\n \"RelievedApproverReceiptId\": \"yDRscUUgyg1zr7vjUyJ8QKxxxxxxx\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\",\n \"Reason\": \"因为业务调整,结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
|
|
1031
1031
|
"output": "{\n \"Response\": {\n \"FlowId\": \"yDRscAABDg1zr7vjUyJ8QKxxxxxxx\",\n \"RequestId\": \"s1989876373464\"\n }\n}",
|
|
1032
1032
|
"title": "发起解除协议（使用本企业的签署人，替换用原流程中本企业的签署人）"
|
|
1033
1033
|
},
|
|
1034
1034
|
{
|
|
1035
1035
|
"document": "1. 更换原合同中本方企业的参与人\n2. 给该企业参与人指定自定义的角色名称(通过设置ApproverSignRole)\n3. 给该企业参与人指定签署控件类型为手写签名(通过设置ApproverSignComponentType)",
|
|
1036
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"RelievedApproverReceiptId\": \"yDRSRUUgygj6rqouUuO4zjESlnSFPcIE\",\n \"ApproverSignRole\": \"自定义的签署方角色(供应商)\",\n \"ApproverSignComponentType\": \"SIGN_SIGNATURE\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方以作赔偿\",\n \"OriginalOtherSettlement\": \"
|
|
1036
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReleaseFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"RelievedApproverReceiptId\": \"yDRSRUUgygj6rqouUuO4zjESlnSFPcIE\",\n \"ApproverSignRole\": \"自定义的签署方角色(供应商)\",\n \"ApproverSignComponentType\": \"SIGN_SIGNATURE\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方以作赔偿\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
|
|
1037
1037
|
"output": "{\n \"Response\": {\n \"FlowId\": \"yDwgkUU7y***********zWBfv\",\n \"RequestId\": \"s1688099393764508839\"\n }\n}",
|
|
1038
1038
|
"title": "发起解除协议（替换原流程中本企业的参与人并指定签署人角色、签署控件）"
|
|
1039
1039
|
}
|
|
@@ -1129,8 +1129,8 @@
|
|
|
1129
1129
|
"CreateSealPolicy": [
|
|
1130
1130
|
{
|
|
1131
1131
|
"document": "给指定人员下发印章授权",
|
|
1132
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSealPolicy\n<公共请求参数>\n\n{\n \"SealId\": \"
|
|
1133
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
1132
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSealPolicy\n<公共请求参数>\n\n{\n \"SealId\": \"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\",\n \"Policy\": \"\",\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"Expired\": 1736906734,\n \"Users\": [\n {\n \"UserId\": \"yDRSRUUgygj6rqouUuO4zjESlnSFPcIE\"\n }\n ]\n}",
|
|
1133
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"49500cb4-ca5e-4da0-93fb-e15f3a710ed7 \",\n \"UserIds\": []\n }\n}",
|
|
1134
1134
|
"title": "印章授权申请下发"
|
|
1135
1135
|
}
|
|
1136
1136
|
],
|
|
@@ -2394,7 +2394,7 @@
|
|
|
2394
2394
|
"members": [
|
|
2395
2395
|
{
|
|
2396
2396
|
"disabled": false,
|
|
2397
|
-
"document": "
|
|
2397
|
+
"document": "合同的发起企业和发起人信息，<a href=\"https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png\" target=\"_blank\">点击查看合同发起企业和人展示的位置</a>\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: Agent.AppId</li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>\n<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>\n</ul>",
|
|
2398
2398
|
"example": "无",
|
|
2399
2399
|
"member": "Agent",
|
|
2400
2400
|
"name": "Agent",
|
|
@@ -2676,7 +2676,7 @@
|
|
|
2676
2676
|
},
|
|
2677
2677
|
{
|
|
2678
2678
|
"disabled": false,
|
|
2679
|
-
"document": "
|
|
2679
|
+
"document": "合同的发起企业和发起人信息，<a href=\"https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png\" target=\"_blank\">点击查看合同发起企业和人展示的位置</a>\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: <a href=\"https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png\" target=\"_blank\">Agent.AppId</a></li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>\n<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>\n</ul>\n\n合同的发起企业和发起人必需已经完成实名，并加入企业",
|
|
2680
2680
|
"example": "无",
|
|
2681
2681
|
"member": "Agent",
|
|
2682
2682
|
"name": "Agent",
|
|
@@ -2760,7 +2760,7 @@
|
|
|
2760
2760
|
"members": [
|
|
2761
2761
|
{
|
|
2762
2762
|
"disabled": false,
|
|
2763
|
-
"document": "
|
|
2763
|
+
"document": "合同的发起企业和发起人信息，<a href=\"https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png\" target=\"_blank\">点击查看合同发起企业和人展示的位置</a>\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: <a href=\"https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png\" target=\"_blank\">Agent.AppId</a></li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>\n<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>\n</ul>\n\n合同的发起企业和发起人必需已经完成实名，并加入企业",
|
|
2764
2764
|
"example": "无",
|
|
2765
2765
|
"member": "Agent",
|
|
2766
2766
|
"name": "Agent",
|
|
@@ -6084,7 +6084,7 @@
|
|
|
6084
6084
|
},
|
|
6085
6085
|
{
|
|
6086
6086
|
"disabled": false,
|
|
6087
|
-
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li
|
|
6087
|
+
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：\n<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>\n<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>\n<b>参数样例</b>：`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n\n<pre>\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}</pre>\n</ul>\n\n\n\n",
|
|
6088
6088
|
"example": "ComponentExtra",
|
|
6089
6089
|
"member": "string",
|
|
6090
6090
|
"name": "ComponentExtra",
|
|
@@ -6264,7 +6264,7 @@
|
|
|
6264
6264
|
},
|
|
6265
6265
|
{
|
|
6266
6266
|
"disabled": false,
|
|
6267
|
-
"document": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围\n\n1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型\n\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li
|
|
6267
|
+
"document": "签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围\n\n1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型\n\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n\n注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`\n\n2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）\n\n<ul><li>HANDWRITE : 需要实时手写的手写签名</li>\n<li>HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li>OCR_ESIGN : OCR印章（智慧手写签名）</li>\n<li>ESIGN : 个人印章</li>\n<li>SYSTEM_ESIGN : 系统印章</li></ul>\n\n3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。",
|
|
6268
6268
|
"example": "[\"HANDWRITE\", \"ESIGN\"]",
|
|
6269
6269
|
"member": "string",
|
|
6270
6270
|
"name": "ComponentValue",
|
|
@@ -6728,7 +6728,7 @@
|
|
|
6728
6728
|
"members": [
|
|
6729
6729
|
{
|
|
6730
6730
|
"disabled": false,
|
|
6731
|
-
"document": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: Agent.AppId</li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>\n<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>\n</ul>注:\n`1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 `\n`2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 `\n`3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `",
|
|
6731
|
+
"document": "关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: <a href=\"https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png\" target=\"_blank\">Agent.AppId</a></li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>\n<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>\n</ul>注:\n`1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 `\n`2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 `\n`3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `",
|
|
6732
6732
|
"example": "无",
|
|
6733
6733
|
"member": "Agent",
|
|
6734
6734
|
"name": "Agent",
|
|
@@ -7227,7 +7227,7 @@
|
|
|
7227
7227
|
"members": [
|
|
7228
7228
|
{
|
|
7229
7229
|
"disabled": false,
|
|
7230
|
-
"document": "
|
|
7230
|
+
"document": "合同的发起企业和发起人信息，<a href=\"https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png\" target=\"_blank\">点击查看合同发起企业和人展示的位置</a>\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: <a href=\"https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png\" target=\"_blank\">Agent.AppId</a></li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>\n<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>\n</ul>",
|
|
7231
7231
|
"example": "无",
|
|
7232
7232
|
"member": "Agent",
|
|
7233
7233
|
"name": "Agent",
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"status": "online"
|
|
9
9
|
},
|
|
10
10
|
"ChatCompletions": {
|
|
11
|
-
"document": "腾讯混元大模型是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。\n\n 1. 本接口暂不支持返回图片内容。\n 2. 默认该接口下单账号限制并发数为 5 路，如您有提高并发限制的需求请 [购买](https://buy.cloud.tencent.com/hunyuan) 。\n 3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。\n 4. 我们推荐您使用 API Explorer，方便快速地在线调试接口和下载各语言的示例代码，[点击打开](https://console.cloud.tencent.com/api/explorer?Product=hunyuan&Version=2023-09-01&Action=ChatCompletions)。",
|
|
11
|
+
"document": "如需使用OpenAI兼容接口， 请参考文档：[OpenAI 兼容接口](https://cloud.tencent.com/document/product/1729/111007)\n\n腾讯混元大模型是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。\n\n 1. 本接口暂不支持返回图片内容。\n 2. 默认该接口下单账号限制并发数为 5 路，如您有提高并发限制的需求请 [购买](https://buy.cloud.tencent.com/hunyuan) 。\n 3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。\n 4. 我们推荐您使用 API Explorer，方便快速地在线调试接口和下载各语言的示例代码，[点击打开](https://console.cloud.tencent.com/api/explorer?Product=hunyuan&Version=2023-09-01&Action=ChatCompletions)。",
|
|
12
12
|
"input": "ChatCompletionsRequest",
|
|
13
13
|
"name": "对话",
|
|
14
14
|
"output": "ChatCompletionsResponse",
|
|
@@ -326,7 +326,7 @@
|
|
|
326
326
|
},
|
|
327
327
|
{
|
|
328
328
|
"disabled": false,
|
|
329
|
-
"document": "
|
|
329
|
+
"document": "自定义结束生成字符串\n\n调用 OpenAI 的接口时，如果您指定了 `stop` 参数, 模型会停止在匹配到 `stop` 的内容之前。\n在调用混元接口时，会停止在匹配到 `stop` 的内容之后。\n\n**说明：**\n未来我们可能会修改此行为以便和 OpenAI 保持一致。\n但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。",
|
|
330
330
|
"example": "无",
|
|
331
331
|
"member": "string",
|
|
332
332
|
"name": "Stop",
|
|
@@ -1250,7 +1250,7 @@
|
|
|
1250
1250
|
{
|
|
1251
1251
|
"disabled": false,
|
|
1252
1252
|
"document": "消息列表",
|
|
1253
|
-
"example": "
|
|
1253
|
+
"example": "无",
|
|
1254
1254
|
"member": "ThreadMessage",
|
|
1255
1255
|
"name": "Data",
|
|
1256
1256
|
"output_required": false,
|
|
@@ -1258,7 +1258,7 @@
|
|
|
1258
1258
|
"value_allowed_null": false
|
|
1259
1259
|
},
|
|
1260
1260
|
{
|
|
1261
|
-
"disabled":
|
|
1261
|
+
"disabled": true,
|
|
1262
1262
|
"document": "第一条消息 ID\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
1263
1263
|
"example": "msg_UT0ERwQZyW6uOYsrxl2Fho7f",
|
|
1264
1264
|
"member": "string",
|
|
@@ -1268,9 +1268,9 @@
|
|
|
1268
1268
|
"value_allowed_null": true
|
|
1269
1269
|
},
|
|
1270
1270
|
{
|
|
1271
|
-
"disabled":
|
|
1272
|
-
"document": "
|
|
1273
|
-
"example": "
|
|
1271
|
+
"disabled": true,
|
|
1272
|
+
"document": "已废弃\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
1273
|
+
"example": "0",
|
|
1274
1274
|
"member": "int64",
|
|
1275
1275
|
"name": "LastID",
|
|
1276
1276
|
"output_required": false,
|
|
@@ -1297,6 +1297,26 @@
|
|
|
1297
1297
|
"type": "string",
|
|
1298
1298
|
"value_allowed_null": false
|
|
1299
1299
|
},
|
|
1300
|
+
{
|
|
1301
|
+
"disabled": false,
|
|
1302
|
+
"document": "第一条消息 ID",
|
|
1303
|
+
"example": "msg_UT0ERwQZyW6uOYsrxl2Fho7f",
|
|
1304
|
+
"member": "string",
|
|
1305
|
+
"name": "FirstMsgID",
|
|
1306
|
+
"output_required": false,
|
|
1307
|
+
"type": "string",
|
|
1308
|
+
"value_allowed_null": false
|
|
1309
|
+
},
|
|
1310
|
+
{
|
|
1311
|
+
"disabled": false,
|
|
1312
|
+
"document": "最后一条消息 ID",
|
|
1313
|
+
"example": "msg_kP6Xm8FC0NchARWC5cNF2IU0",
|
|
1314
|
+
"member": "string",
|
|
1315
|
+
"name": "LastMsgID",
|
|
1316
|
+
"output_required": false,
|
|
1317
|
+
"type": "string",
|
|
1318
|
+
"value_allowed_null": false
|
|
1319
|
+
},
|
|
1300
1320
|
{
|
|
1301
1321
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header \"X-TC-RequestId\" 中。",
|
|
1302
1322
|
"member": "string",
|
|
@@ -138,7 +138,7 @@
|
|
|
138
138
|
{
|
|
139
139
|
"document": "获取会话消息列表",
|
|
140
140
|
"input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetThreadMessageList\n<公共请求参数>\n\n{\n \"ThreadID\": \"thread_QPH2Z6DpBhc46V3ylE1JEqTv\"\n}",
|
|
141
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"4809bed2-f1ca-4d72-b097-bd528184825d\",\n \"Data\": [\n {\n \"ID\": \"msg_jtO6oVZmFtIi4T43eswXk6lJ\",\n \"Object\": \"thread.message\",\n \"CreatedAt\": 1727303115,\n \"ThreadID\": \"thread_QPH2Z6DpBhc46V3ylE1JEqTv\",\n \"Status\": \"completed\",\n \"InCompleteDetails\": {\n \"Reason\": \"\"\n },\n \"CompletedAt\": 1727331915,\n \"InCompleteAt\": null,\n \"Role\": \"assistant\",\n \"Content\": [\n {\n \"Index\": 0,\n \"Type\": \"text\",\n \"Text\": {\n \"Value\": \"您好！非常高兴与您交流，今天有什么有趣的事情想和我分享呢\"\n }\n }\n ],\n \"AssistantID\": \"\",\n \"RunID\": \"run_XmeUGzgrzTE82Yh7p8mZWRcJ\",\n \"Attachments\": null,\n \"Metadata\": {}\n },\n {\n \"ID\": \"msg_oJBEpYDXDZw5epfQYNrJEEJa\",\n \"Object\": \"thread.message\",\n \"CreatedAt\": 1727303115,\n \"ThreadID\": \"thread_QPH2Z6DpBhc46V3ylE1JEqTv\",\n \"Status\": \"completed\",\n \"InCompleteDetails\": {\n \"Reason\": \"\"\n },\n \"CompletedAt\": 1727331915,\n \"InCompleteAt\": null,\n \"Role\": \"user\",\n \"Content\": [\n {\n \"Index\": 0,\n \"Type\": \"text\",\n \"Text\": {\n \"Value\": \"你好\"\n }\n }\n ],\n \"AssistantID\": \"\",\n \"RunID\": \"run_XmeUGzgrzTE82Yh7p8mZWRcJ\",\n \"Attachments\": null,\n \"Metadata\": {}\n }\n ],\n \"
|
|
141
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"4809bed2-f1ca-4d72-b097-bd528184825d\",\n \"Data\": [\n {\n \"ID\": \"msg_jtO6oVZmFtIi4T43eswXk6lJ\",\n \"Object\": \"thread.message\",\n \"CreatedAt\": 1727303115,\n \"ThreadID\": \"thread_QPH2Z6DpBhc46V3ylE1JEqTv\",\n \"Status\": \"completed\",\n \"InCompleteDetails\": {\n \"Reason\": \"\"\n },\n \"CompletedAt\": 1727331915,\n \"InCompleteAt\": null,\n \"Role\": \"assistant\",\n \"Content\": [\n {\n \"Index\": 0,\n \"Type\": \"text\",\n \"Text\": {\n \"Value\": \"您好！非常高兴与您交流，今天有什么有趣的事情想和我分享呢\"\n }\n }\n ],\n \"AssistantID\": \"\",\n \"RunID\": \"run_XmeUGzgrzTE82Yh7p8mZWRcJ\",\n \"Attachments\": null,\n \"Metadata\": {}\n },\n {\n \"ID\": \"msg_oJBEpYDXDZw5epfQYNrJEEJa\",\n \"Object\": \"thread.message\",\n \"CreatedAt\": 1727303115,\n \"ThreadID\": \"thread_QPH2Z6DpBhc46V3ylE1JEqTv\",\n \"Status\": \"completed\",\n \"InCompleteDetails\": {\n \"Reason\": \"\"\n },\n \"CompletedAt\": 1727331915,\n \"InCompleteAt\": null,\n \"Role\": \"user\",\n \"Content\": [\n {\n \"Index\": 0,\n \"Type\": \"text\",\n \"Text\": {\n \"Value\": \"你好\"\n }\n }\n ],\n \"AssistantID\": \"\",\n \"RunID\": \"run_XmeUGzgrzTE82Yh7p8mZWRcJ\",\n \"Attachments\": null,\n \"Metadata\": {}\n }\n ],\n \"FirstMsgID\": \"msg_jtO6oVZmFtIi4T43eswXk6lJ\",\n \"LastMsgID\": \"msg_oJBEpYDXDZw5epfQYNrJEEJa\",\n \"HasMore\": false,\n \"Object\": \"list\"\n }\n}",
|
|
142
142
|
"title": "获取会话消息列表"
|
|
143
143
|
}
|
|
144
144
|
],
|
|
@@ -304,7 +304,7 @@
|
|
|
304
304
|
"EndRoom": {
|
|
305
305
|
"document": "结束房间的直播",
|
|
306
306
|
"input": "EndRoomRequest",
|
|
307
|
-
"name": "
|
|
307
|
+
"name": "结束直播",
|
|
308
308
|
"output": "EndRoomResponse",
|
|
309
309
|
"status": "online"
|
|
310
310
|
},
|
|
@@ -444,7 +444,7 @@
|
|
|
444
444
|
"StartRoom": {
|
|
445
445
|
"document": "开始房间的直播。 说明：开始房间接口调用之前需要有用户进入课堂初始化课堂信息。",
|
|
446
446
|
"input": "StartRoomRequest",
|
|
447
|
-
"name": "
|
|
447
|
+
"name": "开始直播",
|
|
448
448
|
"output": "StartRoomResponse",
|
|
449
449
|
"status": "online"
|
|
450
450
|
},
|
|
@@ -6270,7 +6270,7 @@
|
|
|
6270
6270
|
},
|
|
6271
6271
|
{
|
|
6272
6272
|
"disabled": false,
|
|
6273
|
-
"document": "
|
|
6273
|
+
"document": "对应用户昵称。对应修改用户信息下“nickname“字段，在修改用户信息时，可以对该字段进行调整，从而更改用户的昵称。",
|
|
6274
6274
|
"example": "nickname",
|
|
6275
6275
|
"member": "string",
|
|
6276
6276
|
"name": "Name",
|
|
@@ -6279,7 +6279,7 @@
|
|
|
6279
6279
|
},
|
|
6280
6280
|
{
|
|
6281
6281
|
"disabled": false,
|
|
6282
|
-
"document": "用户在客户系统的Id，需要在同一应用下唯一。入参为空时默认赋值为UserId
|
|
6282
|
+
"document": "用户在客户系统的Id，需要在同一应用下唯一。入参为空时默认赋值为UserId。",
|
|
6283
6283
|
"example": "id12345",
|
|
6284
6284
|
"member": "string",
|
|
6285
6285
|
"name": "OriginId",
|
|
@@ -2478,7 +2478,7 @@
|
|
|
2478
2478
|
{
|
|
2479
2479
|
"disabled": false,
|
|
2480
2480
|
"document": "应用ID",
|
|
2481
|
-
"example": "
|
|
2481
|
+
"example": "1844287616635371520",
|
|
2482
2482
|
"member": "string",
|
|
2483
2483
|
"name": "BotBizId",
|
|
2484
2484
|
"required": true,
|
|
@@ -2487,7 +2487,7 @@
|
|
|
2487
2487
|
{
|
|
2488
2488
|
"disabled": false,
|
|
2489
2489
|
"document": "拒答问题\n\n",
|
|
2490
|
-
"example": "
|
|
2490
|
+
"example": "你是谁你来自哪里你要到哪里去",
|
|
2491
2491
|
"member": "string",
|
|
2492
2492
|
"name": "Question",
|
|
2493
2493
|
"required": true,
|
|
@@ -2495,8 +2495,8 @@
|
|
|
2495
2495
|
},
|
|
2496
2496
|
{
|
|
2497
2497
|
"disabled": false,
|
|
2498
|
-
"document": "拒答问题来源的数据源唯一id
|
|
2499
|
-
"example": "
|
|
2498
|
+
"document": "拒答问题来源的数据源唯一id， - 拒答来源于不满意回复 2 - 拒答来源于手动添加",
|
|
2499
|
+
"example": "2",
|
|
2500
2500
|
"member": "uint64",
|
|
2501
2501
|
"name": "BusinessSource",
|
|
2502
2502
|
"required": true,
|
|
@@ -4309,7 +4309,7 @@
|
|
|
4309
4309
|
"members": [
|
|
4310
4310
|
{
|
|
4311
4311
|
"disabled": false,
|
|
4312
|
-
"document": "
|
|
4312
|
+
"document": "应用ID",
|
|
4313
4313
|
"example": "无",
|
|
4314
4314
|
"member": "string",
|
|
4315
4315
|
"name": "BotBizId",
|
|
@@ -4334,7 +4334,7 @@
|
|
|
4334
4334
|
},
|
|
4335
4335
|
{
|
|
4336
4336
|
"disabled": false,
|
|
4337
|
-
"document": "发布状态",
|
|
4337
|
+
"document": "发布状态 ， 1-待发布 , 2-发布中 , 3-发布成功 , 4-发布失败 , 5-审核中 , 6-审核成功 , 7-审核失败 , 8-发布成功回调处理中 , 9-发布暂停 , 10-申诉审核中 , 11-申诉审核通过 , 12-申诉审核不通过",
|
|
4338
4338
|
"example": "无",
|
|
4339
4339
|
"member": "int64",
|
|
4340
4340
|
"name": "Status",
|
|
@@ -4344,7 +4344,7 @@
|
|
|
4344
4344
|
},
|
|
4345
4345
|
{
|
|
4346
4346
|
"disabled": false,
|
|
4347
|
-
"document": "
|
|
4347
|
+
"document": "是否编辑过, 当为true的时候表示可以发布",
|
|
4348
4348
|
"example": "无",
|
|
4349
4349
|
"member": "bool",
|
|
4350
4350
|
"name": "IsUpdated",
|
|
@@ -11364,6 +11364,15 @@
|
|
|
11364
11364
|
"name": "QueryAnswer",
|
|
11365
11365
|
"required": false,
|
|
11366
11366
|
"type": "string"
|
|
11367
|
+
},
|
|
11368
|
+
{
|
|
11369
|
+
"disabled": false,
|
|
11370
|
+
"document": "查询类型 filename 名称、 attribute 标签",
|
|
11371
|
+
"example": "无",
|
|
11372
|
+
"member": "string",
|
|
11373
|
+
"name": "QueryType",
|
|
11374
|
+
"required": false,
|
|
11375
|
+
"type": "string"
|
|
11367
11376
|
}
|
|
11368
11377
|
],
|
|
11369
11378
|
"usage": "in"
|
|
@@ -399,7 +399,7 @@
|
|
|
399
399
|
"members": [
|
|
400
400
|
{
|
|
401
401
|
"disabled": false,
|
|
402
|
-
"document": "文件类型。\n\n**支持的文件类型：**\n- `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB`、`BMP`、`GIF`、`WEBP`、`HEIC`、`EPS`、`ICNS`、`IM`、`PCX`、`PPM`、`TIFF`、`XBM`、`HEIF`、`JP2`\n\n**支持的文件大小：**\n - `PDF
|
|
402
|
+
"document": "文件类型。\n\n**支持的文件类型：**\n- `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB`、`BMP`、`GIF`、`WEBP`、`HEIC`、`EPS`、`ICNS`、`IM`、`PCX`、`PPM`、`TIFF`、`XBM`、`HEIF`、`JP2`\n\n**支持的文件大小：**\n - `PDF` 最大500M\n - `DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M\n - `TXT`、`MD` 最大10M\n - 其他 最大20M\n",
|
|
403
403
|
"example": "PDF",
|
|
404
404
|
"member": "string",
|
|
405
405
|
"name": "FileType",
|
|
@@ -523,7 +523,7 @@
|
|
|
523
523
|
"members": [
|
|
524
524
|
{
|
|
525
525
|
"disabled": false,
|
|
526
|
-
"document": "文件类型。\n\n**支持的文件类型：**\n- `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB`\n\n**支持的文件大小：**\n - `PDF
|
|
526
|
+
"document": "文件类型。\n\n**支持的文件类型：**\n- `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB`\n\n**支持的文件大小：**\n - `PDF` 最大500M\n - `DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M\n - `TXT`、`MD` 最大10M\n - 其他 最大20M\n",
|
|
527
527
|
"example": "PDF",
|
|
528
528
|
"member": "string",
|
|
529
529
|
"name": "FileType",
|
|
@@ -1130,7 +1130,7 @@
|
|
|
1130
1130
|
{
|
|
1131
1131
|
"disabled": false,
|
|
1132
1132
|
"document": "使用GetPublicKey返回的RSA2048公钥加密后的密码",
|
|
1133
|
-
"example": "
|
|
1133
|
+
"example": "MTIzNDU2Nzg5MTA=",
|
|
1134
1134
|
"member": "string",
|
|
1135
1135
|
"name": "EncryptedPassword",
|
|
1136
1136
|
"required": false,
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"CreateAccount": [
|
|
52
52
|
{
|
|
53
53
|
"document": "在tdsql-fdpjf5zh实例中创建可读写账号testuser1，密码为1234qweri#",
|
|
54
|
-
"input": "POST / HTTP/1.1\nHost: mariadb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAccount\n<公共请求参数>\n\n{\n \"UserName\": \"testuser1\",\n \"Description\": \"
|
|
54
|
+
"input": "POST / HTTP/1.1\nHost: mariadb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAccount\n<公共请求参数>\n\n{\n \"UserName\": \"testuser1\",\n \"Description\": \"测试账号\",\n \"InstanceId\": \"tdsql-fdpjf5zh\",\n \"ReadOnly\": \"0\",\n \"Host\": \"172.17.%\",\n \"Password\": \"1234qweri#\"\n}",
|
|
55
55
|
"output": "{\n \"Response\": {\n \"RequestId\": \"2cc4e4dc-c3e9-4858-ab80-03e3526cf24d\",\n \"InstanceId\": \"tdsql-fdpjf5zh\",\n \"UserName\": \"testuser1\",\n \"Host\": \"172.17.%\",\n \"ReadOnly\": 0\n }\n}",
|
|
56
56
|
"title": "为云数据库实例创建访问账号"
|
|
57
57
|
}
|