tccli 3.0.1084.1__py2.py3-none-any.whl → 3.0.1085.1__py2.py3-none-any.whl

tccli/services/ess/v20201111/api.json

@@ -218,7 +218,7 @@
       "status": "online"
     },
     "CreateReleaseFlow": {
-      "document": "发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。\n解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。\n\n注意：\n<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>\n<li>只有原合同企业类型的参与人才能发起解除协议，<code>个人参与方不能发起解除协议</code>。</li>\n<li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>\n<li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>\n<li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>\n<li>在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。</li></ul>",
+      "document": "发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。\n解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。\n\n注意：\n<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>\n<li>只有原合同企业类型的参与人才能发起解除协议，<code>个人参与方不能发起解除协议</code>。</li>\n<li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>\n<li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>\n<li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>\n<li>在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。</li>\n<li>非原合同企业参与人发起解除协议时，需要有<code>解除合同的权限</code>。</li>\n</ul>",
       "input": "CreateReleaseFlowRequest",
       "name": "发起解除协议",
       "output": "CreateReleaseFlowResponse",
@@ -783,7 +783,7 @@
         },
         {
           "disabled": false,
-          "document": "您可以指定签署方签署合同的认证校验方式，可传递以下值：\n<ul><li>**1**：人脸认证，需进行人脸识别成功后才能签署合同；</li>\n<li>**2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；</li>\n<li>**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。</li></ul>\n\n注：\n1. 默认情况下，认证校验方式为人脸认证和签署密码两种形式\n2. 您可以传递多种值，表示可用多种认证校验方式\n3. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明",
+          "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)得到具体的支持说明",
           "example": "[1,2,3]",
           "member": "int64",
           "name": "ApproverSignTypes",
@@ -906,7 +906,7 @@
         },
         {
           "disabled": false,
-          "document": "签署人信息补充类型，默认无需补充。\n\n<ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li>\n</ul>",
+          "document": "签署人信息补充类型，默认无需补充。\n\n<ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li></ul>\n\n注：\n`使用动态签署人能力前，需登陆腾讯电子签控制台打开服务开关`",
           "example": "无",
           "member": "int64",
           "name": "FillType",
@@ -3390,19 +3390,19 @@
           "disabled": false,
           "document": "  禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”\n",
           "example": "无",
-          "member": "string",
+          "member": "bool",
           "name": "ForbidAddApprover",
           "required": false,
-          "type": "string"
+          "type": "bool"
         },
         {
           "disabled": false,
           "document": "  禁止设置设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板\n",
           "example": "无",
-          "member": "string",
+          "member": "bool",
           "name": "ForbidEditFlowProperties",
           "required": false,
-          "type": "string"
+          "type": "bool"
         },
         {
           "disabled": false,
@@ -8823,7 +8823,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:\n0：企业\n1：个人\n3：企业静默签署\n注：类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。\n7: 个人自动签署，适用于个人自动签场景。\n注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。",
+          "document": "在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：\n\n<ul><li> <b>0</b> :企业B端。</li>\n<li> <b>1</b> :个人C端。</li>\n<li> <b>3</b> :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考<a href=\"https://qian.tencent.com/developers/company/autosign_guide\" target=\"_blank\" rel=\"noopener noreferrer\">自动签署使用说明</a>文档。</li>\n<li> <b>7</b> :个人C端自动签署，适用于个人自动签场景。注: <b>个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。</b> </li></ul>",
           "example": "1",
           "member": "int64",
           "name": "ApproverType",
@@ -8850,7 +8850,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此合同签署方。\n\n在未指定签署人电子签UserId情况下，为必填参数\n",
+          "document": "签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。\n\n注：`在未指定签署人电子签UserId情况下，为必填参数`\n",
           "example": "无",
           "member": "string",
           "name": "ApproverMobile",
@@ -8859,7 +8859,7 @@
         },
         {
           "disabled": false,
-          "document": "证件类型，支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
+          "document": "证件类型，支持以下类型\n<ul><li><b>ID_CARD</b>: 居民身份证 (默认值)</li>\n<li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>\n<li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 港澳台居民居住证(格式同居民身份证)</li></ul>",
           "example": "ID_CARD",
           "member": "string",
           "name": "ApproverIdCardType",
@@ -8877,7 +8877,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。\n模板发起合同时，该参数为必填项。\n文件发起合同时，该参数无需传值。\n如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。",
+          "document": "签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。\n\n<b>模板发起合同时，该参数为必填项，可以通过[查询模版信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>\n<b>文件发起合同时，该参数无需传值。</b>\n\n如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。",
           "example": "无",
           "member": "string",
           "name": "RecipientId",
@@ -8886,7 +8886,7 @@
         },
         {
           "disabled": false,
-          "document": "签署意愿确认渠道，默认为WEIXINAPP:人脸识别\n\n注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置",
+          "document": "签署意愿确认渠道，默认为WEIXINAPP:人脸识别\n\n注: <font color=\"red\">将要废弃</font >, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`",
           "example": "[\"WEIXINAPP\"]",
           "member": "string",
           "name": "VerifyChannel",
@@ -8895,7 +8895,7 @@
         },
         {
           "disabled": false,
-          "document": "通知签署方经办人的方式,  有以下途径:\n<ul><li>  **sms**  :  (默认)短信</li>\n<li>   **none**   : 不通知</li></ul>\n\n注: `发起方也是签署方时不给此签署方发送短信`",
+          "document": "通知签署方经办人的方式,  有以下途径:\n<ul><li>  **sms**  :  (默认)短信</li>\n<li>   **none**   : 不通知</li></ul>\n\n注: `既是发起方又是签署方时，不给此签署方发送短信`",
           "example": "无",
           "member": "string",
           "name": "NotifyType",
@@ -8913,7 +8913,7 @@
         },
         {
           "disabled": false,
-          "document": "合同的强制预览时间：3~300s，未指定则按合同页数计算",
+          "document": "签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。\n\n若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：\n<ul>\n<li>合同页数少于等于2页，阅读时间为3秒；</li>\n<li>合同页数为3到5页，阅读时间为5秒；</li>\n<li>合同页数大于等于6页，阅读时间为10秒。</li>\n</ul>",
           "example": "无",
           "member": "uint64",
           "name": "PreReadTime",
@@ -8922,7 +8922,7 @@
         },
         {
           "disabled": false,
-          "document": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得\n\n注: `若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息`",
+          "document": "签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得\n\n注： \n如果传进来的<font color=\"red\">UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参</font>（会用此UserId实名的身份证和登录的手机号覆盖）",
           "example": "无",
           "member": "string",
           "name": "UserId",
@@ -8931,7 +8931,7 @@
         },
         {
           "disabled": false,
-          "document": "字段已经废弃，当前只支持true，默认为true",
+          "document": "<font color=\"red\">字段已经废弃</font>，当前只支持true，默认为true",
           "example": "无",
           "member": "bool",
           "name": "Required",
@@ -8985,7 +8985,7 @@
         },
         {
           "disabled": false,
-          "document": "签署ID\n- 发起流程时系统自动补充\n- 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息",
+          "document": "签署人的签署ID\n\n<ul>\n<li>在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。</li>\n<li>在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。</li>\n</ul>",
           "example": "无",
           "member": "string",
           "name": "SignId",
@@ -9021,7 +9021,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方控件类型为 SIGN_SIGNATURE时，可以指定签署方签名方式\n\tHANDWRITE – 手写签名\n\tOCR_ESIGN -- AI智能识别手写签名\n\tESIGN -- 个人印章类型\n\tSYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）",
+          "document": "当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：\n\n<ul><li> <b>HANDWRITE</b> :手写签名。</li>\n<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>\n<li> <b>ESIGN</b> :个人印章类型。</li>\n<li> <b>IMG_ESIGN</b>  : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>\n<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>\n\n各种签名的样式可以参考下图：\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)",
           "example": "无",
           "member": "string",
           "name": "ComponentLimitType",
@@ -9057,7 +9057,7 @@
         },
         {
           "disabled": false,
-          "document": "Deadline\n签署人的签署截止时间，格式为Unix标准时间戳（秒）\n\n注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
+          "document": "签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署\n\n注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`",
           "example": "1604912664",
           "member": "int64",
           "name": "Deadline",

tccli/services/essbasic/v20210526/api.json

@@ -155,7 +155,7 @@
       "status": "online"
     },
     "ChannelCreateReleaseFlow": {
-      "document": "发起解除协议的主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。\n解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。\n\n注意：\n<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>\n<li>只有原合同企业类型的参与人才能发起解除协议，<code>个人参与方不能发起解除协议</code>。</li>\n<li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>\n<li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>\n<li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>\n<li>在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。</li></ul>",
+      "document": "发起解除协议的主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。\n解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。\n\n注意：\n<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>\n<li>只有原合同企业类型的参与人才能发起解除协议，<code>个人参与方不能发起解除协议</code>。</li>\n<li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>\n<li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>\n<li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>\n<li>在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。</li>\n<li>非原合同企业参与人发起解除协议时，需要有<code>解除合同的权限</code>。</li>\n</ul>",
       "input": "ChannelCreateReleaseFlowRequest",
       "name": "发起解除协议",
       "output": "ChannelCreateReleaseFlowResponse",
@@ -662,7 +662,7 @@
         },
         {
           "disabled": false,
-          "document": "签署人信息补充类型，默认无需补充。\n\n<ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li>\n</ul>",
+          "document": "签署人信息补充类型，默认无需补充。\n\n<ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li></ul>\n\n注：\n`使用动态签署人能力前，需登陆腾讯电子签控制台打开服务开关`",
           "example": "无",
           "member": "int64",
           "name": "FillType",
@@ -6000,6 +6000,15 @@
           "required": false,
           "type": "string"
         },
+        {
+          "disabled": false,
+          "document": "子客企业员工的手机码,  支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配,  当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`",
+          "example": "18888888888",
+          "member": "string",
+          "name": "ProxyOperatorMobile",
+          "required": false,
+          "type": "string"
+        },
         {
           "disabled": false,
           "document": "Web控制台登录后进入的功能模块,  支持的模块包括：\n<ul>\n<li> **空值** :(默认)企业中心模块</li>\n<li> **DOCUMENT** :合同管理模块</li>\n<li> **TEMPLATE** :企业模板管理模块</li>\n<li> **SEAL** :印章管理模块</li>\n<li> **OPERATOR** :组织管理模块</li></ul>\n注意：\n1、如果EndPoint选择\"CHANNEL\"或\"APP\"，该参数仅支持传递\"SEAL\"，进入印章管理模块\n2、该参数**仅在企业和员工激活已经完成，登录控制台场景才生效**。",
@@ -8295,7 +8304,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方控件类型为 SIGN_SIGNATURE时，可以指定签署方签名方式\n\tHANDWRITE – 手写签名\n\tOCR_ESIGN -- AI智能识别手写签名\n\tESIGN -- 个人印章类型\n\tSYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）",
+          "document": "当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：\n\n<ul><li> <b>HANDWRITE</b> :手写签名。</li>\n<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>\n<li> <b>ESIGN</b> :个人印章类型。</li>\n<li> <b>IMG_ESIGN</b>  : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>\n<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>\n\n各种签名的样式可以参考下图：\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)",
           "example": "[\"OCR_ESIGN\"]",
           "member": "string",
           "name": "ComponentLimitType",
@@ -8349,7 +8358,7 @@
         },
         {
           "disabled": false,
-          "document": "签署人签署合同时的认证方式\n<ul><li> **1** :人脸认证</li>\n<li> **2** :签署密码</li>\n<li> **3** :运营商三要素</li></ul>\n\n默认为1(人脸认证 ),2(签署密码)\n\n注: \n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明",
+          "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)得到具体的支持说明",
           "example": "[1,2,3]",
           "member": "int64",
           "name": "ApproverSignTypes",

tccli/services/essbasic/v20210526/examples.json

@@ -394,7 +394,7 @@
         "title": "错误示例-解除协议中更换原合同个人类型的参与人"
       },
       {
-        "document": "1. 更换原合同中本方企业的参与人\n2. 给该企业参与人指定未自动签署(ApproverType 设置为 ENTERPRISESERVER)",
+        "document": "1. 更换原合同中本方企业的参与人\n2. 该企业参与人指定为自动签署(ApproverType 设置为 ENTERPRISESERVER)",
         "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n    \"Agent\": {\n        \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\n        \"ProxyOperator\": {\n            \"OpenId\": \"n9527\"\n        },\n        \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n    },\n    \"NeedRelievedFlowId\": \"yDR1AUUgygjazuesUuO4zjESPW4PkfNi\",\n    \"ReleasedApprovers\": [\n        {\n            \"Mobile\": \"13200000000\",\n            \"Name\": \"典子谦\",\n            \"ApproverNumber\": 2,\n            \"ApproverType\": \"ENTERPRISESERVER\",\n            \"OrganizationName\": \"典子谦示例企业\"\n        }\n    ],\n    \"ReliveInfo\": {\n        \"OriginalExpenseSettlement\": \"甲方需付给乙方以作赔偿\",\n        \"OriginalOtherSettlement\": \"无\",\n        \"OtherDeals\": \"无\",\n        \"Reason\": \"因为业务调整, 结束合作。\",\n        \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n    }\n}",
         "output": "{\n    \"Response\": {\n        \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n        \"RequestId\": \"s312334445587989\"\n    }\n}",
         "title": "发起解除协议（替换原流程中本企业的参与人并指定其为自动签署）"

tccli/services/faceid/v20180301/api.json

@@ -2692,7 +2692,7 @@
           "example": "23232323232",
           "member": "string",
           "name": "IdCard",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2702,7 +2702,7 @@
           "example": "王五",
           "member": "string",
           "name": "Name",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2712,7 +2712,7 @@
           "example": "0",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2722,7 +2722,7 @@
           "example": "成功",
           "member": "string",
           "name": "Description",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2732,7 +2732,7 @@
           "example": "97.7",
           "member": "float",
           "name": "Similarity",
-          "required": true,
+          "output_required": true,
           "type": "float",
           "value_allowed_null": false
         },
@@ -2742,7 +2742,7 @@
           "example": "xx",
           "member": "string",
           "name": "VideoBase64",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -2752,7 +2752,7 @@
           "example": "xx",
           "member": "string",
           "name": "BestFrameBase64",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -2762,17 +2762,17 @@
           "example": "xx",
           "member": "string",
           "name": "Extra",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
         {
           "disabled": false,
           "document": "设备风险标签，仅错误码返回1007（设备疑似被劫持）时返回风险标签。标签说明：\n202、5001：设备疑似被Root\n203、5004：设备疑似被注入\n205：设备疑似被Hook\n206：设备疑似虚拟运行环境\n5007、1005：设备疑似摄像头被劫持\n8000：设备疑似存在异常篡改行为\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "5004_202",
+          "example": "01",
           "member": "string",
           "name": "DeviceInfoTag",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -2782,7 +2782,7 @@
           "example": "02",
           "member": "string",
           "name": "RiskInfoTag",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -2825,7 +2825,7 @@
         },
         {
           "disabled": false,
-          "document": "描述当前请求所在设备的风险等级，共4级，详情如下： 1 - 安全 2 - 低风险 3 - 中风险 4 - 高危 ，-1表示未获取到风险等级\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "描述当前请求所在设备的风险等级，共4级，详情如下： 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ，-1表示未获取到风险等级\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "1",
           "member": "int64",
           "name": "DeviceInfoLevel",
@@ -2845,7 +2845,7 @@
         },
         {
           "disabled": false,
-          "document": "描述当前请求所在设备的相机指纹风险等级，共4级，详情如下： 1 - 安全 2 - 低风险 3 - 中风险 4 - 高危 ，-1表示未获取到风险等级\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "描述当前请求所在设备的相机指纹风险等级，共4级，详情如下： 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ，-1表示未获取到风险等级\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "1",
           "member": "int64",
           "name": "CameraInfoLevel",
@@ -2956,6 +2956,15 @@
           "name": "Encryption",
           "required": false,
           "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid） 自助接入里面创建，审核通过后即可调用。如有疑问，请添加腾讯云人脸核身小助手进行咨询。\n示例值：1",
+          "example": "1",
+          "member": "string",
+          "name": "RuleId",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -2969,6 +2978,7 @@
           "example": "asdasdadasdasd",
           "member": "string",
           "name": "FaceIdToken",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },

tccli/services/faceid/v20180301/examples.json

@@ -162,7 +162,7 @@
       {
         "document": "",
         "input": "https://faceid.tencentcloudapi.com/?Action=GetFaceIdResult\n&FaceIdToken=CE661F1A-0F1E-45BD-BE13-34C05CEA7681\n&<公共请求参数>",
-        "output": "{\n    \"Response\": {\n        \"Result\": \"0\",\n        \"Description\": \"成功\",\n        \"IdCard\": \"23232323232\",\n        \"Name\": \"王五\",\n        \"Similarity\": 97.7,\n        \"RequestId\": \"0f96cf39-a183-485c-ab29-8427ab81f9ae\",\n        \"Extra\": \"xx\",\n        \"VideoBase64\": \"xx\",\n        \"BestFrameBase64\": \"xx\",\n        \"DeviceInfoTag\": \"5007_1005\",\n        \"RiskInfoTag\": \"02\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"Result\": \"0\",\n        \"Description\": \"成功\",\n        \"IdCard\": \"23232323232\",\n        \"Name\": \"王五\",\n        \"Similarity\": 97.7,\n        \"RequestId\": \"0f96cf39-a183-485c-ab29-8427ab81f9ae\",\n        \"Extra\": \"\",\n        \"VideoBase64\": \"\",\n        \"BestFrameBase64\": \"\",\n        \"DeviceInfoTag\": \"01\",\n        \"RiskInfoTag\": \"02\"\n    }\n}",
         "title": "获取结果成功时"
       }
     ],