tccli 3.0.1153.1__py2.py3-none-any.whl → 3.0.1155.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.
Files changed (36) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/billing/v20180709/api.json +1 -1
  3. tccli/services/ccc/v20200210/api.json +3 -3
  4. tccli/services/cdb/v20170320/api.json +1 -1
  5. tccli/services/ckafka/ckafka_client.py +65 -12
  6. tccli/services/ckafka/v20190819/api.json +134 -0
  7. tccli/services/ckafka/v20190819/examples.json +8 -0
  8. tccli/services/clb/v20180317/api.json +1 -1
  9. tccli/services/cloudapp/v20220530/api.json +3 -3
  10. tccli/services/cvm/cvm_client.py +110 -4
  11. tccli/services/cvm/v20170312/api.json +95 -0
  12. tccli/services/cvm/v20170312/examples.json +16 -0
  13. tccli/services/cynosdb/cynosdb_client.py +110 -4
  14. tccli/services/cynosdb/v20190107/api.json +192 -0
  15. tccli/services/cynosdb/v20190107/examples.json +16 -0
  16. tccli/services/es/v20180416/api.json +36 -0
  17. tccli/services/ess/v20201111/api.json +10 -10
  18. tccli/services/essbasic/v20210526/api.json +17 -17
  19. tccli/services/essbasic/v20210526/examples.json +3 -3
  20. tccli/services/faceid/v20180301/api.json +5 -5
  21. tccli/services/hunyuan/v20230901/api.json +79 -4
  22. tccli/services/lighthouse/v20200324/api.json +2 -2
  23. tccli/services/live/v20180801/api.json +1 -1
  24. tccli/services/lke/v20231130/api.json +3 -3
  25. tccli/services/mna/mna_client.py +322 -4
  26. tccli/services/mna/v20210119/api.json +435 -0
  27. tccli/services/mna/v20210119/examples.json +48 -0
  28. tccli/services/oceanus/v20190422/api.json +20 -0
  29. tccli/services/tke/v20180525/api.json +4 -4
  30. tccli/services/trtc/v20190722/api.json +2 -2
  31. tccli/services/vpc/v20170312/api.json +10 -10
  32. {tccli-3.0.1153.1.dist-info → tccli-3.0.1155.1.dist-info}/METADATA +2 -2
  33. {tccli-3.0.1153.1.dist-info → tccli-3.0.1155.1.dist-info}/RECORD +36 -36
  34. {tccli-3.0.1153.1.dist-info → tccli-3.0.1155.1.dist-info}/WHEEL +0 -0
  35. {tccli-3.0.1153.1.dist-info → tccli-3.0.1155.1.dist-info}/entry_points.txt +0 -0
  36. {tccli-3.0.1153.1.dist-info → tccli-3.0.1155.1.dist-info}/license_files/LICENSE +0 -0
@@ -71,7 +71,7 @@
71
71
  "status": "online"
72
72
  },
73
73
  "CreateEmbedWebUrl": {
74
- "document": "本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:\n1. 创建印章\n2. 创建模板\n3. 修改模板\n4. 预览模板\n5. 预览合同流程\n\n用户可以通过这些链接快速将其集成到自己的系统中。",
74
+ "document": "本接口(CreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:\n1. 创建印章\n2. 创建模板\n3. 修改模板\n4. 预览模板\n5. 预览合同流程\n\n预览模板的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)\n\n预览合同流程的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)",
75
75
  "input": "CreateEmbedWebUrlRequest",
76
76
  "name": "获取其他可嵌入web页面",
77
77
  "output": "CreateEmbedWebUrlResponse",
@@ -225,7 +225,7 @@
225
225
  "status": "online"
226
226
  },
227
227
  "CreateOrganizationBatchSignUrl": {
228
- "document": "使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>\n附注:\n- 员工必须需作为批量签署合同的签署方,or或签合同的候选人之一。\n- 对于本方企业:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。\n- 若要生成他发企业签署链接:应传RecipientIds,且制定的合同必须是接口调用方发起的。\n- 支持待签署、待填写状态的合同生成签署链接。",
228
+ "document": "使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>\n\n注:\n<ul>\n<li>员工必须需作为批量签署合同的签署方,或者是或签合同的候选人之一。</li>\n<li><b>本方企业签署链接</b>:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。</li>\n<li><b>他方企业签署链接</b>:传RecipientIds,且必须是合同发起方调用此接口。打开链接后需要他方签署人登录电子签系统。(<b>如果签署人没有加入对方企业则会引导加入;如果对方企业还没有注册认证,会引导企业注册和认证</b>)</li>\n<li>只支持待签署、待填写状态的合同生成签署链接。</li>\n</ul>\n\n签署的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/a4754bc835a3f837ddec1e28b02ed9c0.png)",
229
229
  "input": "CreateOrganizationBatchSignUrlRequest",
230
230
  "name": "获取企业签署合同web页面",
231
231
  "output": "CreateOrganizationBatchSignUrlResponse",
@@ -253,7 +253,7 @@
253
253
  "status": "online"
254
254
  },
255
255
  "CreatePrepareFlow": {
256
- "document": "创建发起流程web页面\n<br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。\n<br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。",
256
+ "document": "创建发起流程Web页面,通过该接口可以获取发起流程的可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。在页面上完成签署控件等信息的编辑与确认后,可快速发起流程。\n\n <br/>注意:调用接口后,<font color=\"red\">流程不会立即发起,需在嵌入页面上点击【发起合同】按钮来发起流程</font>。\n\n嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)",
257
257
  "input": "CreatePrepareFlowRequest",
258
258
  "name": "创建发起流程web页面",
259
259
  "output": "CreatePrepareFlowResponse",
@@ -547,9 +547,9 @@
547
547
  "status": "online"
548
548
  },
549
549
  "ModifyFlowDeadline": {
550
- "document": "在已发起的签署流程中,支持对签署截止日期进行延期操作,主要涉及以下两个维度:\n1. 合同(流程)维度:只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。\n2. 签署人维度:需要传递流程ID和签署人ID。此操作将对签署人进行延期操作,尤其对于有序的合同(流程),签署截止时间不能超过后一位合同(流程)签署人的流程截止时间。\n\n此接口有如下限制条件:\n1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。\n2. 在延长整个签署流程时,签署流程应至少还有一方未签署(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态)。\n3. 在延长整个签署流程时,新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。\n4. 在延长签署方的截止时间时,签署方不能处于流程完结或已终止状态(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。\n5. 在延长签署方的截止时间时,签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同,还应早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。\n6. 不支持操作合同组合同。",
550
+ "document": "在已启动的签署流程中,可对签署截止日期进行延期操作,主要分为以下两个层面:\n1. <b> 合同(流程)层面</b>:仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。\n2. <b> 签署人层面</b> :需提供流程ID和签署人ID。此操作针对特定签署人进行延期,特别是对于有序合同(流程),签署截止时间不得超过后续签署人的流程截止时间。\n\n此接口存在以下限制:\n1. 执行操作的员工须为<font color=\"red\">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。\n2. 延长整个签署流程时,<font color=\"red\">应至少有一方尚未签署</font>(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。\n3. 延长整个签署流程时,新的签署截止日期应晚于已设定的签署截止日期和当前日期。\n4. 延长签署方截止时间时,<font color=\"red\">签署方不能处于流程完结或已终止状态</font>(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。\n5. 延长签署方截止时间时,新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同,还需早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。\n6. <font color=\"red\">不支持操作合同组合同</font>。\n\n合同(流程)层面 截止时间控制台展示的位置:\n![image](https://qcloudimg.tencent-cloud.cn/raw/265b130136bf6e8f01f5880438467dfb.png)",
551
551
  "input": "ModifyFlowDeadlineRequest",
552
- "name": "管理签署流程截止时间",
552
+ "name": "修改签署流程截止时间",
553
553
  "output": "ModifyFlowDeadlineResponse",
554
554
  "status": "online"
555
555
  },
@@ -867,7 +867,7 @@
867
867
  },
868
868
  {
869
869
  "disabled": false,
870
- "document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>\n\n默认为1(人脸认证 ),2(签署密码),3(运营商三要素)\n\n注:\n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n3. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明",
870
+ "document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li></ul>\n\n默认为1(人脸认证 ),2(签署密码),3(运营商三要素)\n\n注:\n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n3. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明",
871
871
  "example": "[1,2,3]",
872
872
  "member": "int64",
873
873
  "name": "ApproverSignTypes",
@@ -2668,7 +2668,7 @@
2668
2668
  "members": [
2669
2669
  {
2670
2670
  "disabled": false,
2671
- "document": "执行本接口操作的员工信息。\n<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。",
2671
+ "document": "执行本接口操作的员工信息。\n<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
2672
2672
  "example": "无",
2673
2673
  "member": "UserInfo",
2674
2674
  "name": "Operator",
@@ -2722,7 +2722,7 @@
2722
2722
  },
2723
2723
  {
2724
2724
  "disabled": false,
2725
- "document": "用户自定义参数\n<ul>\n<li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li>\n<li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li>\n<li>支持的格式:json字符串的BASE64编码字符串</li>\n<li>示例:<ul>\n <li>json字符串:{\"ComeFrom\":\"xxx\"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li>\n <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li>\n</ul>\n</li>\n</ul>",
2725
+ "document": "<ul> <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li> <li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li> <li>支持的格式:json字符串的BASE64编码字符串</li> <li>示例:<ul> <li>json字符串:{\"ComeFrom\":\"xxx\"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li> <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li> </ul> </li> </ul>",
2726
2726
  "example": "eyJDb21lRnJvbSI6IuadpeiHqnh4eOWFrOWPuOeahOaooeeJiCJ9",
2727
2727
  "member": "string",
2728
2728
  "name": "UserData",
@@ -4973,7 +4973,7 @@
4973
4973
  },
4974
4974
  {
4975
4975
  "disabled": false,
4976
- "document": "员工在腾讯电子签平台的独特身份标识,为32位字符串。\n您可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查阅某位员工的UserId(在页面中显示为用户ID)。\nUserId必须是传入合同(FlowId)中的签署人。\n- 1. 若UserId为空,Name和Mobile 必须提供。\n- 2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。",
4976
+ "document": "员工在腾讯电子签平台的独特身份标识,为32位字符串。\n您可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查阅某位员工的UserId(在页面中显示为用户ID)。\nUserId必须是传入合同(FlowId)中的签署人。\n\n<ul>\n<li>1. 若UserId为空,Name和Mobile 必须提供。</li>\n<li>2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。</li>\n</ul>",
4977
4977
  "example": "无",
4978
4978
  "member": "string",
4979
4979
  "name": "UserId",
@@ -10238,7 +10238,7 @@
10238
10238
  },
10239
10239
  {
10240
10240
  "disabled": false,
10241
- "document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>\n注:\n<ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>\n<li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>\n\n注:\n`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
10241
+ "document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li></ul>\n注:\n<ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>\n<li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>\n\n注:\n`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
10242
10242
  "example": "[1,2]",
10243
10243
  "member": "uint64",
10244
10244
  "name": "ApproverSignTypes",
@@ -43,7 +43,7 @@
43
43
  "status": "online"
44
44
  },
45
45
  "ChannelCreateBatchSignUrl": {
46
- "document": "通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注:\n- 使用此接口生成链接,需要提前开通 `使用手机号验证签署方身份` 功能,在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n- 个人用户批量签署,需要传Name,Mobile,IdCardNumber(IdCardType) 参数。\n- saas企业员工用户批量签署,在传递了姓名等基本信息参数的情况下,还需要传OrganizationName(参与方所在企业名称)参数生成签署链接,<font color=\"red\">请确保此企业已完成腾讯电子签企业认证</font>。\n- 子客企业员工用户批签签署,需要传递员工OpenId和子客企业的OrganizationOpenId。<font color=\"red\">请确保此OrganizationOpenId对应子客已经认证,且OpenId对应员工此子客下已经实名</font>。Name,Mobile, IdCard等信息此时可以不传,系统会查询此OpenId实名信息自动补充。\n- 生成批量签署链接时,合同目标参与方状态需为<font color=\"red\">待签署</font>状态。\n- 个人批量签署进行的合同的签名区, 全部变成<font color=\"red\">手写签名</font>(不管合同里边设置的签名限制)来进行。",
46
+ "document": "通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注:\n- 使用此接口生成链接,需要提前开通 `使用手机号验证签署方身份` 功能,在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n- 个人用户批量签署,需要传Name,Mobile,IdCardNumber(IdCardType) 参数。\n- saas企业员工用户批量签署,在传递了姓名等基本信息参数的情况下,还需要传OrganizationName(参与方所在企业名称)参数生成签署链接,<font color=\"red\">请确保此企业已完成腾讯电子签企业认证</font>。\n- 子客企业员工用户批量签署,需要传递员工OpenId和子客企业的OrganizationOpenId。<font color=\"red\">请确保此OrganizationOpenId对应子客已经认证,且OpenId对应员工此子客下已经实名</font>。Name,Mobile, IdCard等信息此时可以不传,系统会查询此OpenId实名信息自动补充。\n- 生成批量签署链接时,合同目标参与方状态需为<font color=\"red\">待签署</font>状态。\n- 个人批量签署进行的合同的签名区, 全部变成<font color=\"red\">手写签名</font>(不管合同里边设置的签名限制)来进行。",
47
47
  "input": "ChannelCreateBatchSignUrlRequest",
48
48
  "name": "获取跳转至腾讯电子签小程序的批量签署链接",
49
49
  "output": "ChannelCreateBatchSignUrlResponse",
@@ -64,7 +64,7 @@
64
64
  "status": "online"
65
65
  },
66
66
  "ChannelCreateEmbedWebUrl": {
67
- "document": "本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接\n\n本接口下面功能的签署页面链接的生成\n- 创建印章\n- 创建模板\n- 修改模板\n- 预览模板\n- 预览合同流程",
67
+ "document": "本接口(ChannelCreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:\n1. 创建印章\n2. 创建模板\n3. 修改模板\n4. 预览模板\n5. 预览合同流程\n\n预览模板的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)\n\n预览合同流程的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)",
68
68
  "input": "ChannelCreateEmbedWebUrlRequest",
69
69
  "name": "获取常规模块嵌入页面链接",
70
70
  "output": "ChannelCreateEmbedWebUrlResponse",
@@ -127,7 +127,7 @@
127
127
  "status": "online"
128
128
  },
129
129
  "ChannelCreateOrganizationBatchSignUrl": {
130
- "document": "通过此接口,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。\n\n注:\n- 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。\n- 仅支持传入待签署或者待领取的合同,待填写暂不支持。\n- 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章、签批控件等。",
130
+ "document": "通过此接口,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。\n\n注:\n- 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。\n- 仅支持传入待签署或者待领取的合同,待填写暂不支持。\n- 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章、签批控件等。\n\n签署的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/a4754bc835a3f837ddec1e28b02ed9c0.png)",
131
131
  "input": "ChannelCreateOrganizationBatchSignUrlRequest",
132
132
  "name": "获取企业签署合同web页面",
133
133
  "output": "ChannelCreateOrganizationBatchSignUrlResponse",
@@ -316,9 +316,9 @@
316
316
  "status": "online"
317
317
  },
318
318
  "CreateBatchOrganizationRegistrationTasks": {
319
- "document": "本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接\n该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.\n\n批量创建链接有以下限制:\n1. 单次最多创建10个子客。\n2. 一天同一家企业最多创建8000个子客。\n3. 同一批创建的子客不能重复 其中包括 企业名称,企业统一信用代码,子客经办人openId。\n4. 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置\n\n注: 1. 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>\n\n**腾讯电子签小程序的AppID 和 原始Id如下:**\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
319
+ "document": "该接口用于批量创建企业认证链接, 可以支持PC浏览器,H5和小程序三种途径。\n此接口为异步提交任务接口,需要与[查询子企业批量认证链接](https://qcloudimg.tencent-cloud.cn/raw/1d3737991b2a3be78002bd78a47d6917.png)配合使用,整体流程如下图。\n![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)\n\n\n\n**注意**\n\n1. 单次最多创建10个子企业。\n2. 一天内,同一家企业最多创建8000个子企业。\n3. 同一批创建的子客户不能重复,包括企业名称、企业统一信用代码和子客户经办人openId。\n4. 跳转到小程序的实现,请参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式)。如何配置跳转电子签小程序,可参考:<a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n\n\n\n**腾讯电子签小程序的AppID 和 原始Id如下:**\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
320
320
  "input": "CreateBatchOrganizationRegistrationTasksRequest",
321
- "name": "创建企业批量认证链接",
321
+ "name": "提交子企业批量认证链接创建任务",
322
322
  "output": "CreateBatchOrganizationRegistrationTasksResponse",
323
323
  "status": "online"
324
324
  },
@@ -337,7 +337,7 @@
337
337
  "status": "online"
338
338
  },
339
339
  "CreateConsoleLoginUrl": {
340
- "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)\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4\" target=\"_blank\">【生成子客登录链接】代码编写 & 子企业认证示例</a><br>",
340
+ "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)\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4\" target=\"_blank\">【生成子客登录链接】代码编写 & 子企业认证示例</a><br>",
341
341
  "input": "CreateConsoleLoginUrlRequest",
342
342
  "name": "生成子客登录链接",
343
343
  "output": "CreateConsoleLoginUrlResponse",
@@ -400,9 +400,9 @@
400
400
  "status": "online"
401
401
  },
402
402
  "DescribeBatchOrganizationRegistrationUrls": {
403
- "document": "此接口用于获取企业批量认证异步任务的状态及结果。\n\n前提条件:已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口,并得到了任务Id。\n\n异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间",
403
+ "document": "此接口用于获取企业批量认证异步任务的状态及结果。需要先调用接口<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks\" target=\"_blank\">提交子企业批量认证链接创建任务</a>获取到任务ID,然后再调用此接口获取到各个子企业的注册认证链接。整体流程如下图。\n![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)\n\n\n注:\n`异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间`",
404
404
  "input": "DescribeBatchOrganizationRegistrationUrlsRequest",
405
- "name": "查询企业批量认证链接",
405
+ "name": "查询子企业批量认证链接",
406
406
  "output": "DescribeBatchOrganizationRegistrationUrlsResponse",
407
407
  "status": "online"
408
408
  },
@@ -491,9 +491,9 @@
491
491
  "status": "online"
492
492
  },
493
493
  "ModifyFlowDeadline": {
494
- "document": "在已发起的签署流程中,支持对签署截止日期进行延期操作,主要涉及以下两个维度:\n1. 合同(流程)维度:只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。\n2. 签署人维度:需要传递流程ID和签署人ID。此操作将对签署人进行延期操作,尤其对于有序的合同(流程),签署截止时间不能超过后一位合同(流程)签署人的流程截止时间。\n\n此接口有如下限制条件:\n1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。\n2. 在延长整个签署流程时,签署流程应至少还有一方未签署(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态)。\n3. 在延长整个签署流程时,新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。\n4. 在延长签署方的截止时间时,签署方不能处于流程完结或已终止状态(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。\n5. 在延长签署方的截止时间时,签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同,还应早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。\n6. 不支持操作合同组合同。",
494
+ "document": "在已启动的签署流程中,可对签署截止日期进行延期操作,主要分为以下两个层面:\n1. <b> 合同(流程)层面</b>:仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。\n2. <b> 签署人层面</b> :需提供流程ID和签署人ID。此操作针对特定签署人进行延期,特别是对于有序合同(流程),签署截止时间不得超过后续签署人的流程截止时间。\n\n此接口存在以下限制:\n1. 执行操作的员工须为<font color=\"red\">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。\n2. 延长整个签署流程时,<font color=\"red\">应至少有一方尚未签署</font>(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。\n3. 延长整个签署流程时,新的签署截止日期应晚于已设定的签署截止日期和当前日期。\n4. 延长签署方截止时间时,<font color=\"red\">签署方不能处于流程完结或已终止状态</font>(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。\n5. 延长签署方截止时间时,新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同,还需早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。\n6. <font color=\"red\">不支持操作合同组合同</font>。\n\n合同(流程)层面截止时间子企业控制台展示的位置:\n![image](https://qcloudimg.tencent-cloud.cn/raw/f0f88c0eb49a926da9a86e5a6e9efa8b.png)",
495
495
  "input": "ModifyFlowDeadlineRequest",
496
- "name": "管理签署流程截止时间",
496
+ "name": "修改签署流程截止时间",
497
497
  "output": "ModifyFlowDeadlineResponse",
498
498
  "status": "online"
499
499
  },
@@ -5855,7 +5855,7 @@
5855
5855
  },
5856
5856
  {
5857
5857
  "disabled": false,
5858
- "document": "当前应用下子客的组织机构注册信息。\n一次最多支持10条认证流",
5858
+ "document": "当前应用下子企业的组织机构注册信息。最多支持查询10子企业。",
5859
5859
  "example": "无",
5860
5860
  "member": "RegistrationOrganizationInfo",
5861
5861
  "name": "RegistrationOrganizations",
@@ -5864,7 +5864,7 @@
5864
5864
  },
5865
5865
  {
5866
5866
  "disabled": false,
5867
- "document": "生成链接的类型:\n<ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>\n<li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>\n<li>**SHORT_URL**:H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>\n<li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>\n<li>**H5**:第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>\n<li>**SHORT_H5**:第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li></ul>\n示例值:PC\n",
5867
+ "document": "生成链接的类型:\n<ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>\n<li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>\n<li>**SHORT_URL**:H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>\n<li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>\n<li>**H5**:第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>\n<li>**SHORT_H5**:第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li></ul>\n\n",
5868
5868
  "example": "PC",
5869
5869
  "member": "string",
5870
5870
  "name": "Endpoint",
@@ -5879,7 +5879,7 @@
5879
5879
  "members": [
5880
5880
  {
5881
5881
  "disabled": false,
5882
- "document": "生成注册链接的任务Id,\n根据这个id调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接,进入认证流程\n若存在其中任意一条链接错误,则返回具体的错误描述, 不会返回TaskId",
5882
+ "document": "生成注册链接的任务ID,后序根据这个任务ID调用<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls\" target=\"_blank\">查询子企业批量认证链接</a>获取生成的链接,发给对应的客户使用。\n\n注:`如果有错误,则不会返回任务ID`",
5883
5883
  "example": "无",
5884
5884
  "member": "string",
5885
5885
  "name": "TaskId",
@@ -5889,7 +5889,7 @@
5889
5889
  },
5890
5890
  {
5891
5891
  "disabled": false,
5892
- "document": "批量生成企业认证链接的详细错误信息,\n顺序与输入参数保持一致。\n若企业认证均成功生成,则不返回错误信息;\n若存在任何错误,则返回具体的错误描述。",
5892
+ "document": "批量生成企业认证链接的详细错误信息,顺序与输入参数子企业列表顺序一致。\n<ul>\n<li>如果所有企业认证链接都成功生成,将不返回错误信息</li>\n<li>如果存在任何错误,将返回具体的错误描述。(没有错误的企业返回空字符串)</li>\n</ul>",
5893
5893
  "example": "无",
5894
5894
  "member": "string",
5895
5895
  "name": "ErrorMessages",
@@ -7139,7 +7139,7 @@
7139
7139
  },
7140
7140
  {
7141
7141
  "disabled": false,
7142
- "document": "通过接口CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任得到的任务Id",
7142
+ "document": "通过接口<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks\" target=\"_blank\">提交子企业批量认证链接创建任务</a>调用得到的任务ID。",
7143
7143
  "example": "无",
7144
7144
  "member": "string",
7145
7145
  "name": "TaskId",
@@ -7154,7 +7154,7 @@
7154
7154
  "members": [
7155
7155
  {
7156
7156
  "disabled": false,
7157
- "document": "企业批量注册链接信息",
7157
+ "document": "子企业注册认证的的链接列表",
7158
7158
  "example": "无",
7159
7159
  "member": "OrganizationAuthUrl",
7160
7160
  "name": "OrganizationAuthUrls",
@@ -8670,7 +8670,7 @@
8670
8670
  },
8671
8671
  {
8672
8672
  "disabled": false,
8673
- "document": "签署人签署合同时的认证方式\n<ul><li> **1** :人脸认证</li>\n<li> **2** :签署密码</li>\n<li> **3** :运营商三要素</li></ul>\n\n默认为1(人脸认证 ),2(签署密码),3(运营商三要素)\n\n注: \n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明",
8673
+ "document": "签署人签署合同时的认证方式\n<ul><li> **1** :人脸认证</li>\n<li> **2** :签署密码</li>\n<li> **3** :运营商三要素(如果是港澳台客户,建议不要选择这个)</li></ul>\n\n默认为1(人脸认证 ),2(签署密码),3(运营商三要素)\n\n注: \n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明",
8674
8674
  "example": "[1,2,3]",
8675
8675
  "member": "int64",
8676
8676
  "name": "ApproverSignTypes",
@@ -896,9 +896,9 @@
896
896
  ],
897
897
  "DescribeBatchOrganizationRegistrationUrls": [
898
898
  {
899
- "document": "",
900
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBatchOrganizationRegistrationUrls\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"ceshi\"\n },\n \"ProxyOrganizationOpenId\": \"ceshi_org\",\n \"AppId\": \"60e16350b0361c888ecb30477d2c16e9\"\n },\n \"TaskId\": \"yDSxSUUxxxxxxxx21JXBlJZsaj\"\n}",
901
- "output": "{\n \"Response\": {\n \"OrganizationAuthUrls\": [\n {\n \"AuthUrl\": \"https://test.qian.tencent.cn/console/batch-register?token=yDxxxxxxxxxgENliu9LD&orgName=典子谦批量认证企业\",\n \"ErrorMessage\": \"\"\n }\n ],\n \"RequestId\": \"s1702447767875624775\"\n }\n}",
899
+ "document": "1. 通过【提交子企业批量认证链接创建任务】接口提交了【典子谦示例企业】和【张三示例企业】两个企业的认证链接创建任务返回任务ID:yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\n2. 调用此接口用任务ID生成这两个企业的注册认证链接 ",
900
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBatchOrganizationRegistrationUrls\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n }\n },\n \"TaskId\": \"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"\n}",
901
+ "output": "{\n \"Response\": {\n \"OrganizationAuthUrls\": [\n {\n \"AuthUrl\": \"https://test.qian.tencent.cn/console/batch-register?token=yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF&orgName=典子谦示例企业\",\n \"ErrorMessage\": \"\"\n },\n {\n \"AuthUrl\": \"https://test.qian.tencent.cn/console/batch-register?token=yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP&orgName=张三示例企业\",\n \"ErrorMessage\": \"\"\n }\n ],\n \"RequestId\": \"s1702447767875624775\"\n }\n}",
902
902
  "title": "查询批量企业认证"
903
903
  }
904
904
  ],
@@ -978,11 +978,11 @@
978
978
  "members": [
979
979
  {
980
980
  "disabled": false,
981
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 一致\n-1: 不一致\n不收费结果码:\n-2: 非法身份证号(长度、校验位等不正确)\n-3: 非法姓名(长度、格式等不正确)\n-4: 非法有效期(长度、格式等不正确)\n-5: 身份信息无效\n-6: 证件库服务异常\n-7: 证件库中无此身份证记录",
981
+ "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 一致\n-1: 不一致\n不收费结果码:\n-2: 非法身份证号(长度、校验位等不正确)\n-3: 非法姓名(长度、格式等不正确)\n-4: 非法有效期(长度、格式等不正确)\n-5: 身份信息无效\n-6: 证件库服务异常\n-7: 证件库中无此身份证记录\n-8: 认证次数超过当日限制,请次日重试",
982
982
  "example": "\"0\"",
983
983
  "member": "string",
984
984
  "name": "Result",
985
- "required": true,
985
+ "output_required": true,
986
986
  "type": "string",
987
987
  "value_allowed_null": false
988
988
  },
@@ -992,7 +992,7 @@
992
992
  "example": "核验一致",
993
993
  "member": "string",
994
994
  "name": "Description",
995
- "required": true,
995
+ "output_required": true,
996
996
  "type": "string",
997
997
  "value_allowed_null": false
998
998
  },
@@ -1043,7 +1043,7 @@
1043
1043
  "members": [
1044
1044
  {
1045
1045
  "disabled": false,
1046
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 验证结果一致\n1: 验证结果不一致\n不收费结果码:\n-1:查无记录\n-2:引擎未知错误\n-3:引擎服务异常\n-4:姓名校验不通过\n-5:手机号码不合法",
1046
+ "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 验证结果一致\n1: 验证结果不一致\n不收费结果码:\n-1:查无记录\n-2:引擎未知错误\n-3:引擎服务异常\n-4:姓名校验不通过\n-5:手机号码不合法\n-6: 认证次数超过当日限制,请次日重试",
1047
1047
  "example": "0",
1048
1048
  "member": "string",
1049
1049
  "name": "Result",
@@ -4945,7 +4945,7 @@
4945
4945
  "members": [
4946
4946
  {
4947
4947
  "disabled": false,
4948
- "document": "认证结果码:\n收费结果码\n0: 三要素信息一致\n-4: 三要素信息不一致\n不收费结果码\n-6: 手机号码不合法\n-7: 身份证号码有误\n-8: 姓名校验不通过\n-9: 没有记录\n-11: 验证中心服务繁忙",
4948
+ "document": "认证结果码:\n收费结果码\n0: 三要素信息一致\n-4: 三要素信息不一致\n不收费结果码\n-6: 手机号码不合法\n-7: 身份证号码有误\n-8: 姓名校验不通过\n-9: 没有记录\n-11: 验证中心服务繁忙\n-12: 认证次数超过当日限制,请次日重试",
4949
4949
  "example": "0",
4950
4950
  "member": "string",
4951
4951
  "name": "Result",
@@ -8,7 +8,7 @@
8
8
  "status": "online"
9
9
  },
10
10
  "GetEmbedding": {
11
- "document": "腾讯混元 Embedding 接口,可以将文本转化为高质量的向量数据。",
11
+ "document": "腾讯混元 Embedding 接口,可以将文本转化为高质量的向量数据。向量维度为1024维。",
12
12
  "input": "GetEmbeddingRequest",
13
13
  "name": "hunyuan-embedding",
14
14
  "output": "GetEmbeddingResponse",
@@ -142,6 +142,15 @@
142
142
  "name": "CustomTool",
143
143
  "required": false,
144
144
  "type": "object"
145
+ },
146
+ {
147
+ "disabled": false,
148
+ "document": "默认是false,在值为true且命中搜索时,接口会返回SearchInfo",
149
+ "example": "false",
150
+ "member": "bool",
151
+ "name": "SearchInfo",
152
+ "required": false,
153
+ "type": "bool"
145
154
  }
146
155
  ],
147
156
  "type": "object"
@@ -219,6 +228,16 @@
219
228
  "type": "string",
220
229
  "value_allowed_null": false
221
230
  },
231
+ {
232
+ "disabled": false,
233
+ "document": "搜索结果信息",
234
+ "example": "无",
235
+ "member": "SearchInfo",
236
+ "name": "SearchInfo",
237
+ "output_required": false,
238
+ "type": "object",
239
+ "value_allowed_null": false
240
+ },
222
241
  {
223
242
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header \"X-TC-RequestId\" 中。",
224
243
  "member": "string",
@@ -706,12 +725,68 @@
706
725
  ],
707
726
  "type": "object"
708
727
  },
728
+ "SearchInfo": {
729
+ "document": "搜索结果信息",
730
+ "members": [
731
+ {
732
+ "disabled": false,
733
+ "document": "搜索引文信息\n注意:此字段可能返回 null,表示取不到有效值。",
734
+ "example": "无",
735
+ "member": "SearchResult",
736
+ "name": "SearchResults",
737
+ "output_required": false,
738
+ "required": false,
739
+ "type": "list",
740
+ "value_allowed_null": true
741
+ }
742
+ ],
743
+ "usage": "both"
744
+ },
745
+ "SearchResult": {
746
+ "document": "搜索引文信息",
747
+ "members": [
748
+ {
749
+ "disabled": false,
750
+ "document": "搜索引文序号\n注意:此字段可能返回 null,表示取不到有效值。",
751
+ "example": "无",
752
+ "member": "string",
753
+ "name": "Index",
754
+ "output_required": false,
755
+ "required": false,
756
+ "type": "string",
757
+ "value_allowed_null": true
758
+ },
759
+ {
760
+ "disabled": false,
761
+ "document": "搜索引文标题\n注意:此字段可能返回 null,表示取不到有效值。",
762
+ "example": "无",
763
+ "member": "string",
764
+ "name": "Title",
765
+ "output_required": false,
766
+ "required": false,
767
+ "type": "string",
768
+ "value_allowed_null": true
769
+ },
770
+ {
771
+ "disabled": false,
772
+ "document": "搜索引文链接\n注意:此字段可能返回 null,表示取不到有效值。",
773
+ "example": "无",
774
+ "member": "string",
775
+ "name": "Url",
776
+ "output_required": false,
777
+ "required": false,
778
+ "type": "string",
779
+ "value_allowed_null": true
780
+ }
781
+ ],
782
+ "usage": "both"
783
+ },
709
784
  "SubmitHunyuanImageJobRequest": {
710
785
  "document": "SubmitHunyuanImageJob请求参数结构体",
711
786
  "members": [
712
787
  {
713
788
  "disabled": false,
714
- "document": "文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空,推荐使用中文。最多可传100个 utf-8 字符。",
789
+ "document": "文本描述。 \n算法将根据输入的文本智能生成与之相关的图像。 \n不能为空,推荐使用中文。最多可传1024个 utf-8 字符。",
715
790
  "example": "雨中, 竹林, 小路",
716
791
  "member": "string",
717
792
  "name": "Prompt",
@@ -802,7 +877,7 @@
802
877
  },
803
878
  {
804
879
  "disabled": false,
805
- "document": "绘画风格。\n请在 [智能文生图风格列表](https://cloud.tencent.com/document/product/1668/86249) 中选择期望的风格,传入风格编号。\n推荐使用且只使用一种风格。不传默认使用201(日系动漫风格)。",
880
+ "document": "绘画风格。\n请在 [文生图轻量版风格列表](https://cloud.tencent.com/document/product/1729/108992) 中选择期望的风格,传入风格编号。不传默认使用201(日系动漫风格)。",
806
881
  "example": "无",
807
882
  "member": "string",
808
883
  "name": "Style",
@@ -844,7 +919,7 @@
844
919
  "members": [
845
920
  {
846
921
  "disabled": false,
847
- "document": "根据入参 RspImgType 填入不同,返回不同的内容。如果传入 base64 则返回生成图 Base64 编码。如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。",
922
+ "document": "根据入参 RspImgType 填入不同,返回不同的内容。\n如果传入 base64 则返回生成图 Base64 编码。\n如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。",
848
923
  "example": "url",
849
924
  "member": "string",
850
925
  "name": "ResultImage",
@@ -4559,7 +4559,7 @@
4559
4559
  "example": "4",
4560
4560
  "member": "int64",
4561
4561
  "name": "TotalCount",
4562
- "required": true,
4562
+ "output_required": true,
4563
4563
  "type": "int",
4564
4564
  "value_allowed_null": false
4565
4565
  },
@@ -4569,7 +4569,7 @@
4569
4569
  "example": "无",
4570
4570
  "member": "RegionInfo",
4571
4571
  "name": "RegionSet",
4572
- "required": true,
4572
+ "output_required": true,
4573
4573
  "type": "list",
4574
4574
  "value_allowed_null": false
4575
4575
  },
@@ -162,7 +162,7 @@
162
162
  "status": "online"
163
163
  },
164
164
  "CreateRecordTask": {
165
- "document": "创建一个在指定时间启动、结束的录制任务,并使用指定录制模板ID对应的配置进行录制。\n- 使用前提\n1. 录制文件存放于点播平台,所以用户如需使用录制功能,需首先自行开通点播服务。\n2. 录制文件存放后相关费用(含存储以及下行播放流量)按照点播平台计费方式收取,具体请参考[对应文档](https://cloud.tencent.com/document/product/266/2837)。\n- 注意事项\n1. 断流会结束当前录制并生成录制文件。在结束时间到达之前任务仍然有效,期间只要正常推流都会正常录制,与是否多次推、断流无关。\n2. 使用上避免创建时间段相互重叠的录制任务。若同一条流当前存在多个时段重叠的任务,为避免重复录制系统将启动最多3个录制任务。\n3. 创建的录制任务记录在平台侧只保留3个月。\n4. 当前录制任务管理API([CreateRecordTask](https://cloud.tencent.com/document/product/267/45983)/[StopRecordTask](https://cloud.tencent.com/document/product/267/45981)/[DeleteRecordTask](https://cloud.tencent.com/document/product/267/45982))与旧API(CreateLiveRecord/StopLiveRecord/DeleteLiveRecord)不兼容,两套接口不能混用。\n5. 避免 创建录制任务 与 推流 操作同时进行,可能导致因录制任务未生效而引起任务延迟启动问题,两者操作间隔建议大于3秒。",
165
+ "document": "创建一个在指定时间启动、结束的录制任务,并使用指定录制模板ID对应的配置进行录制。\n- 使用前提\n1. 录制文件存放于点播平台或对象存储内,所以用户如需使用录制功能,需首先自行开通点播服务或对象存储服务。\n2. 录制文件存放后相关费用(含存储以及下行播放流量)按照点播平台计费方式收取,具体请参考[对应文档](https://cloud.tencent.com/document/product/266/2837)。\n- 注意事项\n1. 断流会结束当前录制并生成录制文件。在结束时间到达之前任务仍然有效,期间只要正常推流都会正常录制,与是否多次推、断流无关。\n2. 使用上避免创建时间段相互重叠的录制任务。若同一条流当前存在多个时段重叠的任务,为避免重复录制系统将启动最多3个录制任务。\n3. 创建的录制任务记录在平台侧只保留3个月。\n4. 当前录制任务管理API([CreateRecordTask](https://cloud.tencent.com/document/product/267/45983)/[StopRecordTask](https://cloud.tencent.com/document/product/267/45981)/[DeleteRecordTask](https://cloud.tencent.com/document/product/267/45982))与旧API(CreateLiveRecord/StopLiveRecord/DeleteLiveRecord)不兼容,两套接口不能混用。\n5. 避免 创建录制任务 与 推流 操作同时进行,可能导致因录制任务未生效而引起任务延迟启动问题,两者操作间隔建议大于3秒。",
166
166
  "input": "CreateRecordTaskRequest",
167
167
  "name": "创建录制任务(新)",
168
168
  "output": "CreateRecordTaskResponse",
@@ -5059,7 +5059,7 @@
5059
5059
  {
5060
5060
  "disabled": false,
5061
5061
  "document": "任务类型",
5062
- "example": "ModifyAttributeLabel",
5062
+ "example": "编辑标签任务类型:ModifyAttributeLabel 导出标签任务类型:ExportAttributeLabel",
5063
5063
  "member": "string",
5064
5064
  "name": "TaskType",
5065
5065
  "required": true,
@@ -5093,7 +5093,7 @@
5093
5093
  {
5094
5094
  "disabled": false,
5095
5095
  "document": "任务类型",
5096
- "example": "ModifyAttributeLabel",
5096
+ "example": "编辑标签任务类型:ModifyAttributeLabel 导出标签任务类型:ExportAttributeLabel",
5097
5097
  "member": "string",
5098
5098
  "name": "TaskType",
5099
5099
  "output_required": false,
@@ -5103,7 +5103,7 @@
5103
5103
  {
5104
5104
  "disabled": false,
5105
5105
  "document": "任务状态\n注意:此字段可能返回 null,表示取不到有效值。",
5106
- "example": "RUNNING",
5106
+ "example": "执行中:RUNNING 成功:SUCCESS 失败:FAILED 等待中:PENDING",
5107
5107
  "member": "string",
5108
5108
  "name": "Status",
5109
5109
  "output_required": false,