tccli 3.0.1038.1__py2.py3-none-any.whl → 3.0.1040.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 (50) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/billing/v20180709/DescribeDosageDetailList.md +63 -0
  3. tccli/examples/cdb/v20170320/DeleteAuditRuleTemplates.md +1 -1
  4. tccli/examples/cfw/v20190904/DescribeIdsWhiteRule.md +10 -0
  5. tccli/examples/essbasic/v20210526/CreateChannelOrganizationInfoChangeUrl.md +22 -20
  6. tccli/examples/essbasic/v20210526/CreateConsoleLoginUrl.md +45 -9
  7. tccli/examples/tdmq/v20200217/ModifyEnvironmentRole.md +4 -4
  8. tccli/examples/teo/v20220901/CreatePlanForZone.md +1 -1
  9. tccli/examples/tione/v20211111/DescribeLatestTrainingMetrics.md +8 -2
  10. tccli/examples/tione/v20211111/DescribeNotebooks.md +15 -2
  11. tccli/examples/trtc/v20190722/StartStreamIngest.md +4 -4
  12. tccli/examples/vod/v20180717/ComposeMedia.md +6 -6
  13. tccli/examples/vod/v20180717/CreateCLSLogset.md +21 -0
  14. tccli/examples/vod/v20180717/CreateCLSTopic.md +23 -0
  15. tccli/examples/vod/v20180717/DeleteCLSTopic.md +20 -0
  16. tccli/examples/vod/v20180717/DescribeCLSLogsets.md +26 -0
  17. tccli/examples/vod/v20180717/DescribeCLSPushTargets.md +38 -0
  18. tccli/examples/vod/v20180717/DescribeCLSTopics.md +31 -0
  19. tccli/examples/vod/v20180717/SetCLSPushTarget.md +25 -0
  20. tccli/services/billing/billing_client.py +61 -8
  21. tccli/services/billing/v20180709/api.json +323 -0
  22. tccli/services/billing/v20180709/examples.json +8 -0
  23. tccli/services/cdb/v20170320/examples.json +1 -1
  24. tccli/services/cdn/v20180606/api.json +1 -1
  25. tccli/services/cfs/v20190719/api.json +9 -0
  26. tccli/services/cfw/v20190904/api.json +76 -0
  27. tccli/services/cfw/v20190904/examples.json +1 -1
  28. tccli/services/clb/v20180317/api.json +1 -1
  29. tccli/services/ess/v20201111/api.json +1 -1
  30. tccli/services/essbasic/v20210526/api.json +39 -30
  31. tccli/services/essbasic/v20210526/examples.json +25 -19
  32. tccli/services/hunyuan/v20230901/api.json +1 -1
  33. tccli/services/mps/v20190612/api.json +40 -2
  34. tccli/services/mrs/v20200910/api.json +24 -24
  35. tccli/services/tat/v20201028/api.json +1 -1
  36. tccli/services/tdmq/v20200217/examples.json +2 -2
  37. tccli/services/teo/v20220901/api.json +36 -19
  38. tccli/services/teo/v20220901/examples.json +1 -1
  39. tccli/services/tione/v20211111/api.json +205 -75
  40. tccli/services/tione/v20211111/examples.json +2 -2
  41. tccli/services/trtc/v20190722/api.json +25 -7
  42. tccli/services/trtc/v20190722/examples.json +2 -2
  43. tccli/services/vod/v20180717/api.json +555 -0
  44. tccli/services/vod/v20180717/examples.json +57 -1
  45. tccli/services/vod/vod_client.py +375 -4
  46. {tccli-3.0.1038.1.dist-info → tccli-3.0.1040.1.dist-info}/METADATA +2 -2
  47. {tccli-3.0.1038.1.dist-info → tccli-3.0.1040.1.dist-info}/RECORD +50 -42
  48. {tccli-3.0.1038.1.dist-info → tccli-3.0.1040.1.dist-info}/WHEEL +0 -0
  49. {tccli-3.0.1038.1.dist-info → tccli-3.0.1040.1.dist-info}/entry_points.txt +0 -0
  50. {tccli-3.0.1038.1.dist-info → tccli-3.0.1040.1.dist-info}/license_files/LICENSE +0 -0
@@ -1682,7 +1682,7 @@
1682
1682
  },
1683
1683
  {
1684
1684
  "disabled": false,
1685
- "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为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>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![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)\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>:` \"{\"PageRange\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`",
1685
+ "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为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>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![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)\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>:` \"{\"PageRange\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
1686
1686
  "example": "无",
1687
1687
  "member": "string",
1688
1688
  "name": "ComponentExtra",
@@ -141,7 +141,7 @@
141
141
  "status": "online"
142
142
  },
143
143
  "ChannelCreatePrepareFlow": {
144
- "document": "通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。\n\n注意:\n1. 只支持PC浏览器操作使用\n\n嵌入的页面样式如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)",
144
+ "document": "通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。\n\n注意:\n1. 只支持PC浏览器操作使用\n\n**嵌入式签署人-各种场景传参说明**:\n\n<table>\n<thead>\n<tr>\n<th>场景编号</th>\n<th>可作为签署方的类型</th>\n<th>签署方传参说明</th>\n</tr>\n</thead>\n\n<tbody>\n<tr>\n<td>场景一</td>\n<td>第三方子企业A员工</td>\n<td>OpenId、OrganizationName、OrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>\n</tr>\n<tr>\n<td>场景二</td>\n<td>第三方子企业B员工</td>\n<td>OpenId、OrganizationOpenId、OrganizationName必传, ApproverType设置为ORGANIZATION</td>\n</tr>\n<tr>\n<td>场景三</td>\n<td>SaaS平台企业员工</td>\n<td>Name、Mobile、OrganizationName必传,NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>\n</tr>\n<tr>\n<td>场景四</td>\n<td>个人/自然人</td>\n<td>Name、Mobile必传, ApproverType设置为PERSON</td>\n</tr>\n</tbody>\n</table>\n\n嵌入的页面样式如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)",
145
145
  "input": "ChannelCreatePrepareFlowRequest",
146
146
  "name": "获取发起合同嵌入链接",
147
147
  "output": "ChannelCreatePrepareFlowResponse",
@@ -316,14 +316,14 @@
316
316
  "status": "online"
317
317
  },
318
318
  "CreateChannelOrganizationInfoChangeUrl": {
319
- "document": "此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接(需要在移动端打开,会跳转到微信小程序),支持创建企业超管变更链接或企业基础信息变更链接,通过入参 ChangeType 指定。\n\n\n<h3 id=\"1-企业超管变更\">1. 企业超管变更</h3>\n\n<p>换成企业的其他员工来当超管</p>\n\n<h3 id=\"2-企业基础信息变更\">2. 企业基础信息变更</h3>\n\n<h4 id=\"可以变动\">可以变动</h4>\n\n<ul>\n<li>企业名称<br>\n</li>\n<li>法定代表人姓名(新法人有邀请链接)<br>\n</li>\n<li>企业地址和所在地</li>\n</ul>\n\n<h4 id=\"不可变动\">不可变动</h4>\n\n<ul>\n<li>统一社会信用代码<br>\n</li>\n<li>企业主体类型</li>\n</ul>\n\n<p>如果企业名称变动会引起下面的变动</p>\n\n<ul>\n<li>合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>\n<li>印章: 会删除所有的印章所有的机构公章,合同专用章,财务专用章和人事专用章, 然后用新企业名称生成新的机构公章,合同专用章,财务专用章和人事专用章, 而法人章不会处理</li>\n<li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>\n</ul>\n\n\n注意: \n1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”\n2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管",
319
+ "document": "此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接。\n\n<h3 id=\"1\">支持变更链接类型,通过入参 Endpoint 指定,默认为WEIXINAPP。</h3>\n\n<h4 id=\"WEIXINAPP\">WEIXINAPP</h4>\n<p>创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。</p>\n\n<h4 id=\"APP\">APP</h4>\n<p>创建变更小程序链接,可从第三方APP跳转到微信腾讯电子签小程序进行更换。</p>\n\n\n<h3 id=\"2\">支持创建企业超管变更链接或企业基础信息变更链接,通过入参 ChangeType 指定。</h3>\n\n<h4 id=\"1-企业超管变更\">1. 企业超管变更</h4>\n\n<p>换成企业的其他员工来当超管</p>\n\n<h4 id=\"2-企业基础信息变更\">2. 企业基础信息变更</h4>\n\n<h5 id=\"可以变动\">可以变动</h5>\n\n<ul>\n<li>企业名称<br>\n</li>\n<li>法定代表人姓名(新法人有邀请链接)<br>\n</li>\n<li>企业地址和所在地</li>\n</ul>\n\n<h5 id=\"不可变动\">不可变动</h5>\n\n<ul>\n<li>统一社会信用代码<br>\n</li>\n<li>企业主体类型</li>\n</ul>\n\n<p>如果企业名称变动会引起下面的变动</p>\n\n<ul>\n<li>合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>\n<li>印章: 会删除所有的印章所有的机构公章,合同专用章,财务专用章和人事专用章, 然后用新企业名称生成新的机构公章,合同专用章,财务专用章和人事专用章, 而法人章不会处理</li>\n<li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>\n</ul>\n\n\n注意: \n1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”\n2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管",
320
320
  "input": "CreateChannelOrganizationInfoChangeUrlRequest",
321
321
  "name": "获取变更企业信息电子签小程序链接",
322
322
  "output": "CreateChannelOrganizationInfoChangeUrlResponse",
323
323
  "status": "online"
324
324
  },
325
325
  "CreateConsoleLoginUrl": {
326
- "document": "此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。\n\nWeb链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:\n<table>\n<thead>\n<tr>\n<th>子客企业状态</th>\n<th>子客企业员工状态</th>\n<th>点击链接进入的流程</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>企业未激活</td>\n<td>员工未认证</td>\n<td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工未认证</td>\n<td>进入员认证并加入企业流程</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工已认证</td>\n<td>进入子客企业Web控制台</td>\n</tr>\n</tbody>\n</table>\n如果是企业激活流程,需要注意如下情况:\n\n1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。\n2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。\n\n系统的渠道企业, 应用, 子客企业, 子客员工的组织形式\n![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)",
326
+ "document": "此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。\n\nWeb链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:\n<table>\n<thead>\n<tr>\n<th>子客企业状态</th>\n<th>子客企业员工状态</th>\n<th>点击链接进入的流程</th>\n<th>视频样例</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>企业未激活</td>\n<td>员工未认证</td>\n<td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>\n<td><a href=\"https://dyn.ess.tencent.cn/guide/apivideo/CreateConsoleLoginUrl_noverify.mp4\" target=\"_blank\">打开</a></td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工未认证</td>\n<td>进入员认证并加入企业流程</td>\n<td>-</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工已认证</td>\n<td>进入子客企业Web控制台</td>\n<td>-</td>\n</tr>\n</tbody>\n</table>\n如果是企业激活流程,需要注意如下情况:\n\n1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。\n2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。\n\n系统的渠道企业, 应用, 子客企业, 子客员工的组织形式\n![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)",
327
327
  "input": "CreateConsoleLoginUrlRequest",
328
328
  "name": "生成子客登录链接",
329
329
  "output": "CreateConsoleLoginUrlResponse",
@@ -5297,7 +5297,7 @@
5297
5297
  "members": [
5298
5298
  {
5299
5299
  "disabled": false,
5300
- "document": "控件编号\n\nCreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充\n\n注:\n当GenerateMode=KEYWORD时,通过\"^\"来决定是否使用关键字整词匹配能力。\n例:当GenerateMode=KEYWORD时,如果传入关键字\"^甲方签署^\",则会在PDF文件中有且仅有\"甲方签署\"关键字的地方进行对应操作。\n如传入的关键字为\"甲方签署\",则PDF文件中每个出现关键字的位置都会执行相应操作。\n\n创建控件时,此值为空\n查询时返回完整结构",
5300
+ "document": "控件唯一ID。\n\n**在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。\n\n**在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。\n\n例:\n\n- 如传入的关键字<font color=\"red\">\"^甲方签署^\"</font >,则会在PDF文件中有且仅有\"甲方签署\"关键字的地方(<font color=\"red\">前后不能有其他字符</font >)进行对应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">前后可以有其他字符</font >)都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"^甲方签署</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">前面不能有其他字符</font >)都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署^</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">后面不能有其他字符</font >)都会执行相应操作。\n\n\n注:`控件ID可以在一个PDF中不可重复`\n",
5301
5301
  "example": "ComponentId",
5302
5302
  "member": "string",
5303
5303
  "name": "ComponentId",
@@ -5308,7 +5308,7 @@
5308
5308
  },
5309
5309
  {
5310
5310
  "disabled": false,
5311
- "document": "如果是Component控件类型,则可选的字段为:\nTEXT - 普通文本控件,输入文本字符串;\nMULTI_LINE_TEXT - 多行文本控件,输入文本字符串;\nCHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;\nFILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;\nDYNAMIC_TABLE - 动态表格控件;\nATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分割;\nSELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;\nDATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;\nDISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;\n\n如果是SignComponent控件类型,则可选的字段为\nSIGN_SEAL - 签署印章控件;\nSIGN_DATE - 签署日期控件;\nSIGN_SIGNATURE - 用户签名控件;\nSIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);\nSIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight\nSIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;\nSIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。\n\n表单域的控件不能作为印章和签名控件",
5311
+ "document": "**如果是Component填写控件类型,则可选的字段为**:\n\n<ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>\n<li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>\n<li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>\n<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>\n\n**如果是SignComponent签署控件类型,则可选的字段为**\n\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n注:` 表单域的控件不能作为印章和签名控件`",
5312
5312
  "example": "SIGN_SEAL",
5313
5313
  "member": "string",
5314
5314
  "name": "ComponentType",
@@ -5319,7 +5319,7 @@
5319
5319
  },
5320
5320
  {
5321
5321
  "disabled": false,
5322
- "document": "控件简称,不超过30个字符",
5322
+ "document": "**在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。\n\n**在表单域定位方式下**,ComponentName不仅为控件名,也是表单域名称。\n\n注:`控件名可以在一个PDF中可以重复`\n",
5323
5323
  "example": "ComponentName",
5324
5324
  "member": "string",
5325
5325
  "name": "ComponentName",
@@ -5330,7 +5330,7 @@
5330
5330
  },
5331
5331
  {
5332
5332
  "disabled": false,
5333
- "document": "控件是否为必填项,\n默认为false-非必填",
5333
+ "document": "如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填\n<ul><li>false(默认):可以不填写</li>\n<li>true :必须填写此填写控件</li></ul>\n如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响",
5334
5334
  "example": "false",
5335
5335
  "member": "bool",
5336
5336
  "name": "ComponentRequired",
@@ -5341,7 +5341,7 @@
5341
5341
  },
5342
5342
  {
5343
5343
  "disabled": false,
5344
- "document": "控件关联的参与方ID,对应Recipient结构体中的RecipientId\t",
5344
+ "document": "**在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**",
5345
5345
  "example": "ComponentRecipientId",
5346
5346
  "member": "string",
5347
5347
  "name": "ComponentRecipientId",
@@ -5352,7 +5352,7 @@
5352
5352
  },
5353
5353
  {
5354
5354
  "disabled": false,
5355
- "document": "控件所属文件的序号 (文档中文件的排列序号,从0开始)",
5355
+ "document": "<font color=\"red\">【暂未使用】</font>控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0",
5356
5356
  "example": "0",
5357
5357
  "member": "int64",
5358
5358
  "name": "FileIndex",
@@ -5363,7 +5363,7 @@
5363
5363
  },
5364
5364
  {
5365
5365
  "disabled": false,
5366
- "document": "控件生成的方式:\nNORMAL - 普通控件\nFIELD - 表单域\nKEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)",
5366
+ "document": "控件生成的方式:\n<ul><li> <b>NORMAL</b> : 绝对定位控件</li>\n<li> <b>FIELD</b> : 表单域</li>\n<li> <b>KEYWORD</b> : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)</li></ul>",
5367
5367
  "example": "NORMAL",
5368
5368
  "member": "string",
5369
5369
  "name": "GenerateMode",
@@ -5374,7 +5374,7 @@
5374
5374
  },
5375
5375
  {
5376
5376
  "disabled": false,
5377
- "document": "参数控件宽度,默认100,单位px\n表单域和关键字转换控件不用填",
5377
+ "document": "**在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。\n",
5378
5378
  "example": "10",
5379
5379
  "member": "float",
5380
5380
  "name": "ComponentWidth",
@@ -5385,7 +5385,7 @@
5385
5385
  },
5386
5386
  {
5387
5387
  "disabled": false,
5388
- "document": "参数控件高度,默认100,单位px\n表单域和关键字转换控件不用填",
5388
+ "document": "**在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。\n",
5389
5389
  "example": "10",
5390
5390
  "member": "float",
5391
5391
  "name": "ComponentHeight",
@@ -5396,7 +5396,7 @@
5396
5396
  },
5397
5397
  {
5398
5398
  "disabled": false,
5399
- "document": "参数控件所在页码,从1开始",
5399
+ "document": "**在绝对定位方式方式下**,指定控件所在PDF文件上的页码\n\n注:\n1. 页码编号是从<font color=\"red\">1</font>开始编号的。\n2. <font color=\"red\">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。",
5400
5400
  "example": "0",
5401
5401
  "member": "int64",
5402
5402
  "name": "ComponentPage",
@@ -5407,7 +5407,7 @@
5407
5407
  },
5408
5408
  {
5409
5409
  "disabled": false,
5410
- "document": "参数控件X位置,单位px",
5410
+ "document": "**在绝对定位方式和关键字定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。",
5411
5411
  "example": "10",
5412
5412
  "member": "float",
5413
5413
  "name": "ComponentPosX",
@@ -5418,7 +5418,7 @@
5418
5418
  },
5419
5419
  {
5420
5420
  "disabled": false,
5421
- "document": "参数控件Y位置,单位px",
5421
+ "document": "**在绝对定位方式和关键字定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。",
5422
5422
  "example": "10",
5423
5423
  "member": "float",
5424
5424
  "name": "ComponentPosY",
@@ -5429,7 +5429,7 @@
5429
5429
  },
5430
5430
  {
5431
5431
  "disabled": false,
5432
- "document": "扩展参数:\n为JSON格式。\n不同类型的控件会有部分非通用参数\n\nComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:\n1 Font:目前只支持黑体、宋体\n2 FontSize 范围12-72\n3 FontAlign Left/Right/Center,左对齐/居中/右对齐\n4 FontColor:字符串类型,格式为RGB颜色数字\n参数样例:{\\\"FontColor\\\":\\\"255,0,0\\\",\\\"FontSize\\\":12}\n\nComponentType为FILL_IMAGE时,支持以下参数:\nNotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中\nFillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放\n\nComponentType为SIGN_SIGNATURE类型可以控制签署方式\n{“ComponentTypeLimit”: [“xxx”]}\nxxx可以为:\nHANDWRITE 手写签名\nOCR_ESIGN -- AI智能识别手写签名\nESIGN -- 个人印章类型\nSYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)\n如:{ComponentTypeLimit”: [SYSTEM_ESIGN]}\n\nComponentType为SIGN_DATE时,支持以下参数:\n1 Font:字符串类型目前只支持\"黑体\"、\"宋体\",如果不填默认为\"黑体\"\n2 FontSize 数字类型,范围6-72,默认值为12\n3 FontAlign 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐\n4 Format 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。\n5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n参数样例: \"ComponentExtra\": \"{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"\n\nComponentType为SIGN_SEAL类型时,支持以下参数:\n1.PageRangesPageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)\n参数样例: \"ComponentExtra\":\"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"",
5432
+ "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为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>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![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)\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>:` \"{\"PageRange\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
5433
5433
  "example": "ComponentExtra",
5434
5434
  "member": "string",
5435
5435
  "name": "ComponentExtra",
@@ -5440,7 +5440,7 @@
5440
5440
  },
5441
5441
  {
5442
5442
  "disabled": false,
5443
- "document": "控件填充vaule,ComponentType和传入值类型对应关系:\nTEXT - 文本内容\nMULTI_LINE_TEXT - 文本内容\nCHECK_BOX - true/false\nFILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取\nSELECTOR - 选项值\nDATE - 默认是格式化为xxxx年xx月xx日\nDYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo\nSIGN_SEAL - 印章ID\nSIGN_PAGING_SEAL - 可以指定印章ID\n\n控件值约束说明:\n企业全称控件:\n 约束:企业名称中文字符中文括号\n 检查正则表达式:/^[\\u3400-\\u4dbf\\u4e00-\\u9fa5()]+$/\n\n统一社会信用代码控件:\n 检查正则表达式:/^[A-Z0-9]{1,18}$/\n\n法人名称控件:\n 约束:最大50个字符,2到25个汉字或者1到50个字母\n 检查正则表达式:/^([\\u3400-\\u4dbf\\u4e00-\\u9fa5.·]{2,25}|[a-zA-Z·,\\s-]{1,50})$/\n\n签署意见控件:\n 约束:签署意见最大长度为50字符\n\n签署人手机号控件:\n 约束:国内手机号 13,14,15,16,17,18,19号段长度11位\n\n签署人身份证控件:\n 约束:合法的身份证号码检查\n\n控件名称:\n 约束:控件名称最大长度为20字符\n\n单行文本控件:\n 约束:只允许输入中文,英文,数字,中英文标点符号\n\n多行文本控件:\n 约束:只允许输入中文,英文,数字,中英文标点符号\n\n勾选框控件:\n 约束:选择填字符串true,不选填字符串false\n\n选择器控件:\n 约束:同单行文本控件约束,填写选择值中的字符串\n\n数字控件:\n 约束:请输入有效的数字(可带小数点) \n 检查正则表达式:/^(-|\\+)?\\d+(\\.\\d+)?$/\n\n日期控件:\n 约束:格式:yyyy年mm月dd日\n\n附件控件:\n 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件\n\n图片控件:\n 约束:JPG或PNG图片,填写上传的图片资源ID\n\n邮箱控件:\n 约束:请输入有效的邮箱地址, w3c标准\n 检查正则表达式:/^([A-Za-z0-9_\\-.!#$%&])+@([A-Za-z0-9_\\-.])+\\.([A-Za-z]{2,4})$/\n 参考:https://emailregex.com/\n\n地址控件:\n 同单行文本控件约束\n\n省市区控件:\n 同单行文本控件约束\n\n性别控件:\n 同单行文本控件约束,填写选择值中的字符串\n\n学历控件:\n 同单行文本控件约束,填写选择值中的字符串",
5443
+ "document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>\n<li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取</li></ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>\n注: `部分特殊控件需要在控制台配置模板形式创建`",
5444
5444
  "example": "ComponentValue",
5445
5445
  "member": "string",
5446
5446
  "name": "ComponentValue",
@@ -5451,7 +5451,7 @@
5451
5451
  },
5452
5452
  {
5453
5453
  "disabled": false,
5454
- "document": "日期签署控件的字号,默认为 12\n\n签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小",
5454
+ "document": "<font color=\"red\">【暂未使用】</font>日期签署控件的字号,默认为 12",
5455
5455
  "example": "12",
5456
5456
  "member": "int64",
5457
5457
  "name": "ComponentDateFontSize",
@@ -5462,7 +5462,7 @@
5462
5462
  },
5463
5463
  {
5464
5464
  "disabled": false,
5465
- "document": "控件所属文档的Id, 模板相关接口为空值",
5465
+ "document": "<font color=\"red\">【暂未使用】</font>控件归属的文档的ID, **发起合同时候不要填写此字段留空即可**",
5466
5466
  "example": "c17bdf9c2a7bdcb32611f4d0200fee3d",
5467
5467
  "member": "string",
5468
5468
  "name": "DocumentId",
@@ -5473,7 +5473,7 @@
5473
5473
  },
5474
5474
  {
5475
5475
  "disabled": false,
5476
- "document": "控件描述,不超过30个字符",
5476
+ "document": "<font color=\"red\">【暂未使用】</font>控件描述,用户自定义,不影响合同发起流程",
5477
5477
  "example": "Desc",
5478
5478
  "member": "string",
5479
5479
  "name": "ComponentDescription",
@@ -5484,7 +5484,7 @@
5484
5484
  },
5485
5485
  {
5486
5486
  "disabled": false,
5487
- "document": "指定关键字时横坐标偏移量,单位pt",
5487
+ "document": "**如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。\n注意: `向左调整设置为负数, 向右调整设置成正数`",
5488
5488
  "example": "无",
5489
5489
  "member": "float",
5490
5490
  "name": "OffsetX",
@@ -5495,7 +5495,7 @@
5495
5495
  },
5496
5496
  {
5497
5497
  "disabled": false,
5498
- "document": "指定关键字时纵坐标偏移量,单位pt",
5498
+ "document": "**如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。\n注意: `向上调整设置为负数, 向下调整设置成正数`",
5499
5499
  "example": "无",
5500
5500
  "member": "float",
5501
5501
  "name": "OffsetY",
@@ -5506,7 +5506,7 @@
5506
5506
  },
5507
5507
  {
5508
5508
  "disabled": false,
5509
- "document": "平台企业控件ID。\n如果不为空,属于平台企业预设控件;",
5509
+ "document": "<font color=\"red\">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识",
5510
5510
  "example": "无",
5511
5511
  "member": "string",
5512
5512
  "name": "ChannelComponentId",
@@ -5517,7 +5517,7 @@
5517
5517
  },
5518
5518
  {
5519
5519
  "disabled": false,
5520
- "document": "指定关键字排序规则,\nPositive-正序,\nReverse-倒序。\n传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。\n传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。",
5520
+ "document": "**如果控件是关键字定位方式**,指定关键字排序规则时,可以选择Positive或Reverse两种排序方式。\n<ul><li> <b>Positive</b> :表示正序,即根据关键字在PDF文件内的顺序进行排列</li>\n<li> <b>Reverse</b> :表示倒序,即根据关键字在PDF文件内的反序进行排列</li></ul>\n\n在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。",
5521
5521
  "example": "Positive\\Reverse",
5522
5522
  "member": "string",
5523
5523
  "name": "KeywordOrder",
@@ -5528,7 +5528,7 @@
5528
5528
  },
5529
5529
  {
5530
5530
  "disabled": false,
5531
- "document": "指定关键字页码。\n指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来",
5531
+ "document": "**如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
5532
5532
  "example": "无",
5533
5533
  "member": "int64",
5534
5534
  "name": "KeywordPage",
@@ -5539,7 +5539,7 @@
5539
5539
  },
5540
5540
  {
5541
5541
  "disabled": false,
5542
- "document": "关键字位置模式,\nMiddle-居中,\nBelow-正下方,\nRight-正右方,\nLowerRight-右上角,\nUpperRight-右下角。\n示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方",
5542
+ "document": "**如果控件是关键字定位方式**,关键字生成的区域的对齐方式, 可以设置下面的值\n<ul><li> <b>Middle</b> :居中</li>\n<li> <b>Below</b> :正下方</li>\n<li> <b>Right</b> :正右方</li>\n<li> <b>LowerRight</b> :右上角</li>\n<li> <b>UpperRight</b> :右下角。</li></ul>\n示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方",
5543
5543
  "example": "无",
5544
5544
  "member": "string",
5545
5545
  "name": "RelativeLocation",
@@ -5550,7 +5550,7 @@
5550
5550
  },
5551
5551
  {
5552
5552
  "disabled": false,
5553
- "document": "关键字索引,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。\n示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。",
5553
+ "document": "**如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。\n\n注意:关键字索引是从0开始计数的",
5554
5554
  "example": "无",
5555
5555
  "member": "int64",
5556
5556
  "name": "KeywordIndexes",
@@ -5561,7 +5561,7 @@
5561
5561
  },
5562
5562
  {
5563
5563
  "disabled": false,
5564
- "document": "填写提示的内容\n注意:此字段可能返回 null,表示取不到有效值。",
5564
+ "document": "填写控件在腾讯电子签小程序填写界面展示的提示信息,例如,在身份证号码填写控件中,提示信息可以设置成“请输入18位身份证号码”。\n注:`签署控件设置此字段无效`\n注意:此字段可能返回 null,表示取不到有效值。",
5565
5565
  "example": "无",
5566
5566
  "member": "string",
5567
5567
  "name": "Placeholder",
@@ -5572,7 +5572,7 @@
5572
5572
  },
5573
5573
  {
5574
5574
  "disabled": false,
5575
- "document": "是否锁定控件值不允许编辑(嵌入式发起使用) <br/>默认false:不锁定控件值,允许在页面编辑控件值\t\n注意:此字段可能返回 null,表示取不到有效值。",
5575
+ "document": "**web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑\n<ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>\n<li>true:锁定控件值,在页面编辑控件值</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
5576
5576
  "example": "无",
5577
5577
  "member": "bool",
5578
5578
  "name": "LockComponentValue",
@@ -5583,7 +5583,7 @@
5583
5583
  },
5584
5584
  {
5585
5585
  "disabled": false,
5586
- "document": "是否禁止移动和删除控件 <br/>默认false,不禁止移动和删除控件\t\n注意:此字段可能返回 null,表示取不到有效值。",
5586
+ "document": "**web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件\n<ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>\n<li> <b>true</b> : 可以移动和删除控件</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
5587
5587
  "example": "无",
5588
5588
  "member": "bool",
5589
5589
  "name": "ForbidMoveAndDelete",
@@ -5779,6 +5779,15 @@
5779
5779
  "name": "ChangeType",
5780
5780
  "required": true,
5781
5781
  "type": "int"
5782
+ },
5783
+ {
5784
+ "disabled": false,
5785
+ "document": "变更链接类型:\n<ul>\n<li>**WEIXINAPP** : 创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。(默认)</li>\n<li>**APP** : 创建变更小程序链接,可从第三方APP跳转到微信腾讯电子签小程序进行更换。</li>\n</ul>",
5786
+ "example": "无",
5787
+ "member": "string",
5788
+ "name": "Endpoint",
5789
+ "required": false,
5790
+ "type": "string"
5782
5791
  }
5783
5792
  ],
5784
5793
  "type": "object"
@@ -277,7 +277,7 @@
277
277
  "ChannelCreatePrepareFlow": [
278
278
  {
279
279
  "document": "",
280
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n\n\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"5d18c1c4c8926cd11\"\n },\n \"ProxyOrganizationOpenId\": \"572c69xxxxxx245e4\",\n \"AppId\": \"yDRsbUUgxxxx7ZfBvipOMJ\"\n },\n \"ResourceId\": \"yDwqFUUckp3em41rUwWPgIBjsYgG5bba\",\n \"ResourceType\": 2,\n \"FlowInfo\": {\n \"FlowName\": \"第三方预发起合同-跳过文件上传\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FlowDescription\": \"\",\n \"Deadline\": 0, \n \"Unordered\": false,\n \"IntelligentStatus\": \"CLOSE\",\n \"FormFields\": [],\n \"NeedCreateReview\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"CcInfos\": []\n },\n \"FlowOption\": {\n \"CanEditFlow\": true,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": false,\n \"HideShowFlowType\": false,\n \"HideShowDeadline\": false,\n \"ForbidEditFillComponent\": false,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"FlowApproverList\": [\n {\n \"ApproverType\": 0,\n \"NotChannelOrganization\": false,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n131517\",\n \"ApproverOption\": { \"CanEditApprover\": true },\n \"IsFullText\": true,\n \"PreReadTime\": 0\n\n },\n {\n \"ApproverType\": 1,\n \"ApproverIdCardType\": \"\",\n \"ApproverName\": \"里斯\",\n \"NotChannelOrganization\":false,\n \"ApproverMobile\": \"13312312312\",\n \"IsFullText\": true,\n \"PreReadTime\": 0\n }\n ]\n}",
280
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"Agent\":{\n \"ProxyOperator\":{\n \"OpenId\":\"5d18c1c4c8926cd11\"\n },\n \"ProxyOrganizationOpenId\":\"572c69xxxxxx245e4\",\n \"AppId\":\"yDRsbUUgxxxx7ZfBvipOMJ\"\n },\n \"ResourceId\":\"yDwqFUUckp3em41rUwWPgIBjsYgG5bba\",\n \"ResourceType\":2,\n \"FlowInfo\":{\n \"FlowName\":\"第三方预发起合同-跳过文件上传\",\n \"FlowType\":\"第三方嵌入式文件发起合同\",\n \"FlowDescription\":\"\",\n \"Deadline\":0,\n \"Unordered\":false,\n \"IntelligentStatus\":\"CLOSE\",\n \"FormFields\":[\n\n ],\n \"NeedCreateReview\":false,\n \"NeedSignReview\":false,\n \"UserData\":\"\",\n \"CcInfos\":[\n\n ]\n },\n \"FlowOption\":{\n \"CanEditFlow\":true,\n \"CanEditFormField\":true,\n \"HideShowFlowName\":false,\n \"HideShowFlowType\":false,\n \"HideShowDeadline\":false,\n \"ForbidEditFillComponent\":false,\n \"CustomCreateFlowDescription\":\"\"\n },\n \"FlowApproverList\":[\n {\n \"ApproverType\":0,\n \"NotChannelOrganization\":false,\n \"OrganizationOpenId\":\"org_dianziqian\",\n \"OrganizationName\":\"典子谦示例企业\",\n \"OpenId\":\"n131517\",\n \"ApproverOption\":{\n \"CanEditApprover\":true\n },\n \"IsFullText\":true,\n \"PreReadTime\":0\n },\n {\n \"ApproverType\":1,\n \"ApproverIdCardType\":\"\",\n \"ApproverName\":\"里斯\",\n \"NotChannelOrganization\":false,\n \"ApproverMobile\":\"13312312312\",\n \"IsFullText\":true,\n \"PreReadTime\":0\n }\n ]\n}",
281
281
  "output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb\",\n \"PreviewFlowUrl\": \"\",\n \"RequestId\": \"c52aaa17-3f81-4640-be03-fca0a553d2e3\"\n }\n}",
282
282
  "title": "文件发起-跳过文件上传"
283
283
  },
@@ -613,37 +613,43 @@
613
613
  }
614
614
  ],
615
615
  "CreateChannelOrganizationInfoChangeUrl": [
616
- {
617
- "document": "设置changeType为2,创建企业信息变更链接。",
618
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateChannelOrganizationInfoChangeUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwFoUUckpsomwx1UyhWGhIR2RkhOj2\",\n \"ProxyOrganizationOpenId\": \"ess_open_organization_1\",\n \"ProxyOperator\": {\n \"OpenId\": \"openid1\"\n }\n },\n \"ChangeType\": 2\n}",
619
- "output": "{\n \"Response\": {\n \"ExpiredTime\": 1695798606,\n \"RequestId\": \"38be082e-08c4-4f37-a0b7-cd47cf9982b5\",\n \"Url\": \"https://test.essurl.cn/CvEXWU6RkKW\"\n }\n}",
620
- "title": "创建企业信息变更链接"
621
- },
622
- {
623
- "document": "设置changeType为1,创建企业超管变更链接",
624
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateChannelOrganizationInfoChangeUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwFoUUckpsomwx1UyhWGhIR2RkhOj2\",\n \"ProxyOrganizationOpenId\": \"ess_open_organization_1\",\n \"ProxyOperator\": {\n \"OpenId\": \"openid1\"\n }\n },\n \"ChangeType\": 1\n}",
625
- "output": "{\n \"Response\": {\n \"ExpiredTime\": 1695798287,\n \"RequestId\": \"3bff7e92-76f8-4e09-85df-e7cb982cb454\",\n \"Url\": \"https://test.essurl.cn/zG0sxU6zl\"\n }\n}",
626
- "title": "创建超管变更链接"
627
- },
628
616
  {
629
617
  "document": "设置changeType为3,接口将返回错误信息。",
630
618
  "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateChannelOrganizationInfoChangeUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwFoUUckpsomwx1UyhWGhIR2RkhOj2\",\n \"ProxyOrganizationOpenId\": \"ess_open_organization_1\",\n \"ProxyOperator\": {\n \"OpenId\": \"openid1\"\n }\n },\n \"ChangeType\": 3\n}",
631
619
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameter.ParamError\",\n \"Message\": \"不支持的变更类型:3,请确认后重新\"\n },\n \"RequestId\": \"30cc3f4a-8f8c-4ec7-a6fb-66a82590c546\"\n }\n}",
632
620
  "title": "错误示例-变更类型不合法"
621
+ },
622
+ {
623
+ "document": "设置changeType为2,创建企业信息变更链接。",
624
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateChannelOrganizationInfoChangeUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwFoUUckpsomwx1UyhWGhIR2RkhOj2\",\n \"ProxyOrganizationOpenId\": \"ess_open_organization_1\",\n \"ProxyOperator\": {\n \"OpenId\": \"openid1\"\n }\n },\n \"ChangeType\": 2,\n \"Endpoint\": \"WEIXINAPP\"\n}",
625
+ "output": "{\n \"Response\": {\n \"ExpiredTime\": 1695798606,\n \"RequestId\": \"38be082e-08c4-4f37-a0b7-cd47cf9982b5\",\n \"Url\": \"https://test.essurl.cn/CvEXWU6RkKW\"\n }\n}",
626
+ "title": "创建企业信息变更链接(短链)"
627
+ },
628
+ {
629
+ "document": "设置changeType为1,创建企业超管变更小程序链接链接",
630
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateChannelOrganizationInfoChangeUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwFoUUckpsomwx1UyhWGhIR2RkhOj2\",\n \"ProxyOrganizationOpenId\": \"ess_open_organization_1\",\n \"ProxyOperator\": {\n \"OpenId\": \"openid1\"\n }\n },\n \"ChangeType\": 1,\n \"Endpoint\": \"APP\"\n}",
631
+ "output": "{\n \"Response\": {\n \"ExpiredTime\": 1695798287,\n \"RequestId\": \"3bff7e92-76f8-4e09-85df-e7cb982cb454\",\n \"Url\": \"/pages/guide/index?to=CHANGE_SUPER_ADMIN&organizationId=yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF&channelType=test&adminName=张*&legalName=李*&expireTime=1695798287\"\n }\n}",
632
+ "title": "创建超管变更链接(小程序链接)"
633
633
  }
634
634
  ],
635
635
  "CreateConsoleLoginUrl": [
636
- {
637
- "document": "生成默认的控制台链接",
638
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsoleLoginUrl\n<公共请求参数>\n\n{\n \"ProxyOrganizationName\": \"典子谦示例企业\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"AppId\": \"yDRSRUUgygj6qnwfUuO4zjEwc193c2hH\"\n }\n}",
639
- "output": "{\n \"Response\": {\n \"ConsoleUrl\": \"https://xxx.xxxx.tencent.com/?channel=PROXYCHANNEL&expiredTime=1631712951&code=123456asdfghjk&menuStatus=ENABLE\",\n \"IsActivated\": false,\n \"ProxyOperatorIsVerified\": false,\n \"RequestId\": \"s16221***14775648\"\n }\n}",
640
- "title": "生成默认的控制台链接"
641
- },
642
636
  {
643
637
  "document": "生成到模板详情的控制台链接",
644
638
  "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsoleLoginUrl\n<公共请求参数>\n\n{\n \"ProxyOrganizationName\": \"典子谦示例企业\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"AppId\": \"yDRSRUUgygj6qnwfUuO4zjEwc193c2hH\"\n },\n \"Module\": \"TEMPLATE\",\n \"ModuleId\": \"yDwFdUUckpsvet4jUEn0aFRxtu5TdalM\",\n \"MenuStatus\": \"ENABLE\"\n}",
645
639
  "output": "{\n \"Response\": {\n \"ConsoleUrl\": \"https://es*.ap*.tencent.com/template-preview?channel=PROXYCHANNEL&expiredTime=1631712951&code=123456asdfghjk&templateId=yDxlzxxxoTxQfVnyxs&menuStatus=ENABLE\",\n \"IsActivated\": false,\n \"ProxyOperatorIsVerified\": false,\n \"RequestId\": \"s16221***14775648\"\n }\n}",
646
640
  "title": "生成到模板详情的控制台链接"
641
+ },
642
+ {
643
+ "document": "如果<b>典子谦示例企业的员工张三已经完成了认证和加入企业</b>, 此时给典子谦示例企业的员工张三生成登录的PC控制台的链接\n\n典子谦示例企业的定义标识为:org_dianziqian\n员工张三定义员工标识为:n9527\n",
644
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsoleLoginUrl\n<公共请求参数>\n\n{\n \"ProxyOrganizationName\": \"典子谦示例企业\",\n \"ProxyOperatorName\": \"张三\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"AppId\": \"yDRSRUUgygj6qnwfUuO4zjEwc193c2hH\"\n }\n}",
645
+ "output": "{\n \"Response\": {\n \"ConsoleUrl\": \"https://xxx.xxxx.tencent.com/?channel=PROXYCHANNEL&expiredTime=1631712951&code=123456asdfghjk&menuStatus=ENABLE\",\n \"IsActivated\": false,\n \"ProxyOperatorIsVerified\": false,\n \"RequestId\": \"s16221***14775648\"\n }\n}",
646
+ "title": "生成默认的控制台登录链接"
647
+ },
648
+ {
649
+ "document": "如果<b>典子谦示例企业的员工张三还没有认证</b>, 此时给典子谦示例企业的员工张三生成企业认证和个人认证的PC链接\n\n典子谦示例企业的定义标识为:org_dianziqian\n员工张三定义员工标识为:n9527\n",
650
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsoleLoginUrl\n<公共请求参数>\n\n{\n \"ProxyOrganizationName\": \"典子谦示例企业\",\n \"ProxyOperatorName\": \"张三\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"AppId\": \"yDRSRUUgygj6qnwfUuO4zjEwc193c2hH\"\n }\n}",
651
+ "output": "{\n \"Response\": {\n \"ConsoleUrl\": \"https://xxx.xxxx.tencent.com/?channel=PROXYCHANNEL&expiredTime=1631712951&code=123456asdfghjk&menuStatus=ENABLE\",\n \"IsActivated\": false,\n \"ProxyOperatorIsVerified\": false,\n \"RequestId\": \"s16221***14775648\"\n }\n}",
652
+ "title": "生成默认的控制台认证链接"
647
653
  }
648
654
  ],
649
655
  "CreateFlowGroupSignReview": [
@@ -41,7 +41,7 @@
41
41
  "members": [
42
42
  {
43
43
  "disabled": false,
44
- "document": "聊天上下文信息。\n说明:\n1.长度最多为40, 按对话时间从旧到新在数组中排列。\n2.Message的Role当前可选值:user、assistant,其中,user和assistant需要交替出现(一问一答),最后一个为user提问, 且Content不能为空。\n3.Messages中Content总长度不超过16000 token,超过则会截断最前面的内容,只保留尾部内容。建议不超过4000 token。",
44
+ "document": "聊天上下文信息。\n说明:\n1.长度最多为40, 按对话时间从旧到新在数组中排列。\n2.Message的Role当前可选值:system、user、assistant,其中,system角色是可选的,如果存在,必须位于列表的最开始。user和assistant需要交替出现(一问一答),最后一个为user提问, 且Content不能为空。\n3.Messages中Content总长度不超过16000 token,超过则会截断最前面的内容,只保留尾部内容。建议不超过4000 token。",
45
45
  "example": "无",
46
46
  "member": "Message",
47
47
  "name": "Messages",
@@ -2703,6 +2703,16 @@
2703
2703
  "output_required": true,
2704
2704
  "type": "object",
2705
2705
  "value_allowed_null": true
2706
+ },
2707
+ {
2708
+ "disabled": false,
2709
+ "document": "任务进度。\n注意:此字段可能返回 null,表示取不到有效值。",
2710
+ "example": "100",
2711
+ "member": "uint64",
2712
+ "name": "Progress",
2713
+ "output_required": false,
2714
+ "type": "int",
2715
+ "value_allowed_null": true
2706
2716
  }
2707
2717
  ],
2708
2718
  "usage": "out"
@@ -3824,6 +3834,16 @@
3824
3834
  "output_required": true,
3825
3835
  "type": "object",
3826
3836
  "value_allowed_null": true
3837
+ },
3838
+ {
3839
+ "disabled": false,
3840
+ "document": "任务进度。\n注意:此字段可能返回 null,表示取不到有效值。",
3841
+ "example": "100",
3842
+ "member": "uint64",
3843
+ "name": "Progress",
3844
+ "output_required": false,
3845
+ "type": "int",
3846
+ "value_allowed_null": true
3827
3847
  }
3828
3848
  ],
3829
3849
  "usage": "out"
@@ -5900,7 +5920,7 @@
5900
5920
  "members": [
5901
5921
  {
5902
5922
  "disabled": false,
5903
- "document": "音频流的编码格式。\n当外层参数 Container 为 mp3 时,可选值为:\n<li>libmp3lame。</li>\n当外层参数 Container 为 ogg 或 flac 时,可选值为:\n<li>flac。</li>\n当外层参数 Container 为 m4a 时,可选值为:\n<li>libfdk_aac;</li>\n<li>libmp3lame;</li>\n<li>ac3。</li>\n当外层参数 Container 为 mp4 或 flv 时,可选值为:\n<li>libfdk_aac:更适合 mp4;</li>\n<li>libmp3lame:更适合 flv。</li>\n当外层参数 Container 为 hls 时,可选值为:\n<li>libfdk_aac;</li>\n<li>libmp3lame。</li>",
5923
+ "document": "音频流的编码格式。\n当不需要对音频进行转码时,可选值为:\n<li>copy。</li>\n当外层参数 Container 为 mp3 时,可选值为:\n<li>libmp3lame。</li>\n当外层参数 Container 为 ogg 或 flac 时,可选值为:\n<li>flac。</li>\n当外层参数 Container 为 m4a 时,可选值为:\n<li>libfdk_aac;</li>\n<li>libmp3lame;</li>\n<li>ac3。</li>\n当外层参数 Container 为 mp4 或 flv 时,可选值为:\n<li>libfdk_aac:更适合 mp4;</li>\n<li>libmp3lame:更适合 flv;</li>\n<li>mp2。</li>\n当外层参数 Container 为 hls 时,可选值为:\n<li>libfdk_aac;</li>\n<li>libmp3lame。</li>",
5904
5924
  "example": "libfdk_aac",
5905
5925
  "member": "string",
5906
5926
  "name": "Codec",
@@ -5950,7 +5970,7 @@
5950
5970
  "members": [
5951
5971
  {
5952
5972
  "disabled": false,
5953
- "document": "音频流的编码格式。\n当外层参数 Container 为 mp3 时,可选值为:\n<li>libmp3lame。</li>\n当外层参数 Container 为 ogg 或 flac 时,可选值为:\n<li>flac。</li>\n当外层参数 Container 为 m4a 时,可选值为:\n<li>libfdk_aac;</li>\n<li>libmp3lame;</li>\n<li>ac3。</li>\n当外层参数 Container 为 mp4 或 flv 时,可选值为:\n<li>libfdk_aac:更适合 mp4;</li>\n<li>libmp3lame:更适合 flv;</li>\n<li>mp2。</li>\n当外层参数 Container 为 hls 时,可选值为:\n<li>libfdk_aac;</li>\n<li>libmp3lame。</li>\n注意:此字段可能返回 null,表示取不到有效值。",
5973
+ "document": "音频流的编码格式。\n当不需要对音频进行转码时,可选值为:\n<li>copy。</li>\n当外层参数 Container 为 mp3 时,可选值为:\n<li>libmp3lame。</li>\n当外层参数 Container 为 ogg 或 flac 时,可选值为:\n<li>flac。</li>\n当外层参数 Container 为 m4a 时,可选值为:\n<li>libfdk_aac;</li>\n<li>libmp3lame;</li>\n<li>ac3。</li>\n当外层参数 Container 为 mp4 或 flv 时,可选值为:\n<li>libfdk_aac:更适合 mp4;</li>\n<li>libmp3lame:更适合 flv;</li>\n<li>mp2。</li>\n当外层参数 Container 为 hls 时,可选值为:\n<li>libfdk_aac;</li>\n<li>libmp3lame。</li>\n注意:此字段可能返回 null,表示取不到有效值。",
5954
5974
  "example": "libmp3lame",
5955
5975
  "member": "string",
5956
5976
  "name": "Codec",
@@ -6384,6 +6404,15 @@
6384
6404
  "name": "AudioChannel",
6385
6405
  "required": false,
6386
6406
  "type": "int"
6407
+ },
6408
+ {
6409
+ "disabled": false,
6410
+ "document": "参考码率,单位 kbps,范围:26~10000。\n如果设置,编码时会尽量按该码率进行编码。\n如果不设置,服务将根据音频参数自动采用合适的码率。",
6411
+ "example": "无",
6412
+ "member": "int64",
6413
+ "name": "Bitrate",
6414
+ "required": false,
6415
+ "type": "int"
6387
6416
  }
6388
6417
  ],
6389
6418
  "usage": "in"
@@ -7098,6 +7127,15 @@
7098
7127
  "name": "Fps",
7099
7128
  "required": false,
7100
7129
  "type": "int"
7130
+ },
7131
+ {
7132
+ "disabled": false,
7133
+ "document": "参考码率,单位 kbps,范围:50~35000。\n如果设置,编码时会尽量按该码率进行编码。\n如果不设置,服务将通过画面复杂度自动采用合适的码率。",
7134
+ "example": "无",
7135
+ "member": "int64",
7136
+ "name": "Bitrate",
7137
+ "required": false,
7138
+ "type": "int"
7101
7139
  }
7102
7140
  ],
7103
7141
  "usage": "in"