tccli 3.0.1115.1__py2.py3-none-any.whl → 3.0.1117.1__py2.py3-none-any.whl

tccli/services/domain/v20180808/examples.json

@@ -8,6 +8,14 @@
         "title": "批量域名信息修改"
       }
     ],
+    "BidDetailPage": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BidDetailPage\n<公共请求参数>\n\n{\n    \"BusinessId\": \"abc\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Domain\": \"abc\",\n        \"CurrentPrice\": 0,\n        \"BidPrice\": 0,\n        \"CurrentPriceScope\": 0,\n        \"PriceScope\": [\n            {\n                \"MaxPrice\": 0,\n                \"MinPrice\": 0,\n                \"Price\": 0,\n                \"DepositPrice\": 0\n            }\n        ],\n        \"DepositPrice\": 0,\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "预释放详情页出价"
+      }
+    ],
     "BidPreDomains": [
       {
         "document": "成功示例",
@@ -16,6 +24,14 @@
         "title": "请求成功示例"
       }
     ],
+    "BiddingPreRelease": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BiddingPreRelease\n<公共请求参数>\n\n{\n    \"BusinessId\": \"abc\",\n    \"Price\": 0\n}",
+        "output": "{\n    \"Response\": {\n        \"IsNeedPay\": true,\n        \"BillingParam\": \"abc\",\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "预释放出价"
+      }
+    ],
     "CheckBatchStatus": [
       {
         "document": "",
@@ -72,6 +88,14 @@
         "title": "创建模板"
       }
     ],
+    "DeleteBidding": [
+      {
+        "document": "删除记录",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteBidding\n<公共请求参数>\n\n{}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"e5ae6a11-ad75-4196-8176-9d72bc287eda\"\n    }\n}",
+        "title": "删除记录"
+      }
+    ],
     "DeleteCustomDnsHost": [
       {
         "document": "",
@@ -104,6 +128,14 @@
         "title": "删除信息模板"
       }
     ],
+    "DescribeAuctionList": [
+      {
+        "document": "竞价列表",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAuctionList\n<公共请求参数>\n\n{\n    \"BusinessId\": \"P0011702284530637838\"\n}",
+        "output": "{\n    \"Response\": {\n        \"AuctionList\": [],\n        \"RequestId\": \"a5fa0a46-0d19-4225-bbbc-ee64c9206210\",\n        \"TotalCount\": 0\n    }\n}",
+        "title": "获取竞价列表示例"
+      }
+    ],
     "DescribeBatchOperationLogDetails": [
       {
         "document": "",
@@ -120,6 +152,54 @@
         "title": "批量操作日志"
       }
     ],
+    "DescribeBiddingAppointDetail": [
+      {
+        "document": "我预定的域名-预约详情",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingAppointDetail\n<公共请求参数>\n\n{}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"e0d60073-3fbb-4216-ba20-7ccad80d030a\",\n        \"Status\": 7\n    }\n}",
+        "title": "我预定的域名-预约详情"
+      }
+    ],
+    "DescribeBiddingAppointList": [
+      {
+        "document": "我的预约列表",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingAppointList\n<公共请求参数>\n\n{\n    \"PageSize\": 20\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"02f51803-507c-40ad-b26a-9a0178fa7ffc\"\n    }\n}",
+        "title": "我的预约列表"
+      }
+    ],
+    "DescribeBiddingDetail": [
+      {
+        "document": "我竞价的域名-竞价详情",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingDetail\n<公共请求参数>\n\n{}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"5fdc5b55-514b-42f8-85a3-e269db61f752\"\n    }\n}",
+        "title": "我竞价的域名-竞价详情"
+      }
+    ],
+    "DescribeBiddingList": [
+      {
+        "document": "我的竞价列表",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingList\n<公共请求参数>\n\n{\n    \"PageSize\": 20\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"560e00d9-ddf1-4d4b-a3d8-461eb8c8e40c\"\n    }\n}",
+        "title": "我的竞价列表"
+      }
+    ],
+    "DescribeBiddingSuccessfulDetail": [
+      {
+        "document": "我得标的域名-得标详情",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingSuccessfulDetail\n<公共请求参数>\n\n{}",
+        "output": "{\n    \"Response\": {\n        \"BiddingBondRefund\": \"no\",\n        \"RequestId\": \"7a179528-6d80-495b-8e6c-14b935eccec9\",\n        \"Status\": 5\n    }\n}",
+        "title": "我得标的域名-得标详情"
+      }
+    ],
+    "DescribeBiddingSuccessfulList": [
+      {
+        "document": "我得标的域名",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBiddingSuccessfulList\n<公共请求参数>\n\n{\n    \"PageSize\": 10\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"340187d9-be66-43e7-a837-80049dad20ec\"\n    }\n}",
+        "title": "我得标的域名"
+      }
+    ],
     "DescribeCustomDnsHostSet": [
       {
         "document": "",
@@ -160,6 +240,14 @@
         "title": "域名详情"
       }
     ],
+    "DescribePayWaitDetail": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePayWaitDetail\n<公共请求参数>\n\n{\n    \"BusinessId\": \"abc\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Domain\": \"abc\",\n        \"Status\": \"abc\",\n        \"EndTime\": \"abc\",\n        \"RegTime\": \"abc\",\n        \"Price\": 0,\n        \"RetDeposit\": 0,\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "等待支付详情接口"
+      }
+    ],
     "DescribePhoneEmailList": [
       {
         "document": "默认",
@@ -168,6 +256,14 @@
         "title": "获取已验证的手机邮箱列表"
       }
     ],
+    "DescribePreAuctionList": [
+      {
+        "document": "竞价列表",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePreAuctionList\n<公共请求参数>\n\n{}",
+        "output": "{\n    \"Response\": {\n        \"PreAuctionList\": [\n            {\n                \"BidCount\": 2,\n                \"BiddingTime\": \"2023-12-23 11:15:05\",\n                \"BusinessId\": \"P0011702999097821031\",\n                \"Domain\": \"test-buy-003.com.cn\",\n                \"Op\": \"noAction\",\n                \"Price\": 500\n            }\n        ],\n        \"RequestId\": \"ff5583d9-bd93-444e-b252-3b36f28e0a67\",\n        \"TotalCount\": 1\n    }\n}",
+        "title": "请求成功示例"
+      }
+    ],
     "DescribePreDomainList": [
       {
         "document": "",
@@ -176,6 +272,14 @@
         "title": "成功示例"
       }
     ],
+    "DescribePreReleaseList": [
+      {
+        "document": "列表数据",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePreReleaseList\n<公共请求参数>\n\n{}",
+        "output": "{\n    \"Response\": {\n        \"PreReleaseList\": [\n            {\n                \"BusinessId\": \"P0011703064185349649\",\n                \"CurrentPeople\": 1,\n                \"DelTime\": \"2024-01-16 00:00:00\",\n                \"Domain\": \"099hq.net\",\n                \"IsAppoint\": false,\n                \"IsFollow\": false,\n                \"Price\": 102,\n                \"RegTime\": \"2020-01-01 00:00:00\",\n                \"ReservationTime\": \"2023-12-31 07:32:05\"\n            },\n            {\n                \"BusinessId\": \"P0011703067801554141\",\n                \"CurrentPeople\": 1,\n                \"DelTime\": \"2024-01-16 00:00:00\",\n                \"Domain\": \"095hq.net\",\n                \"IsAppoint\": false,\n                \"IsFollow\": false,\n                \"Price\": 102,\n                \"RegTime\": \"2020-01-01 00:00:00\",\n                \"ReservationTime\": \"2023-12-31 07:32:05\"\n            },\n            {\n                \"BusinessId\": \"P0011702284530637838\",\n                \"CurrentPeople\": 2,\n                \"DelTime\": \"2024-01-16 00:00:00\",\n                \"Domain\": \"091hq.net\",\n                \"IsAppoint\": false,\n                \"IsFollow\": false,\n                \"Price\": 102,\n                \"RegTime\": \"2020-01-01 00:00:00\",\n                \"ReservationTime\": \"2023-12-31 07:32:05\"\n            }\n        ],\n        \"RequestId\": \"543393c3-28c3-4de0-8535-1256fe004410\",\n        \"TotalCount\": 3\n    }\n}",
+        "title": "请求成功示例"
+      }
+    ],
     "DescribeReservedBidInfo": [
       {
         "document": "成功示例",
@@ -222,6 +326,14 @@
         "title": "请求成功"
       }
     ],
+    "DescribeUnPreDomainDetail": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: domain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUnPreDomainDetail\n<公共请求参数>\n\n{\n    \"Domain\": \"abc\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Domain\": \"abc\",\n        \"PreCount\": 0,\n        \"RegTime\": \"abc\",\n        \"DeleteTime\": \"abc\",\n        \"ExpireTime\": \"abc\",\n        \"Status\": \"abc\",\n        \"CurrentPrice\": 0,\n        \"AppointBondPrice\": 0,\n        \"IsAppoint\": true,\n        \"BusinessId\": \"abc\",\n        \"IsDomainUser\": true,\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "查询预释放未预约域名详情接口"
+      }
+    ],
     "ModifyCustomDnsHost": [
       {
         "document": "",

tccli/services/dts/v20211206/api.json

@@ -2172,7 +2172,7 @@
         },
         {
           "disabled": false,
-          "document": "源端数据库类型,如mysql,cynosdbmysql,tdapg,tdpg,tdsqlmysql等",
+          "document": "源端数据库类型,如mysql,cynosdbmysql,tdapg,tdpg,tdsqlmysql,tdstore等",
           "example": "mysql",
           "member": "string",
           "name": "SrcDatabaseType",
@@ -2190,7 +2190,7 @@
         },
         {
           "disabled": false,
-          "document": "目标端数据库类型,如mysql,cynosdbmysql,tdapg,tdpg,tdsqlmysql,kafka等",
+          "document": "目标端数据库类型,如mysql,cynosdbmysql,tdapg,tdpg,tdsqlmysql,kafka,tdstore等",
           "example": "mysql",
           "member": "string",
           "name": "DstDatabaseType",

tccli/services/ess/v20201111/api.json

@@ -50,7 +50,7 @@
       "status": "online"
     },
     "CreateBatchSignUrl": {
-      "document": "通过此接口，可以创建小程序批量签署链接，个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。\n\n注意事项：\n- 使用此接口生成链接，需要贵企业先开通 <font color=\"red\">使用手机号验证签署方身份 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。\n- 生成批量签署链接时，<font color=\"red\">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人人点击链接后需要输入短信验证码才能查看合同内容。\n- 企业员工批量签署链接：需要传入签署方所在企业名称，用户名字和手机号（或者身份证件信息）参数来生成签署链接。<font color=\"red\">该签署方企业必须已完成腾讯电子签企业认证</font>\n- 个人批量签署链接：需要传入签署方用户名字和手机号（或者身份证件信息）参数来生成签署链接。<font color=\"red\">签名区仅支持手写签名</font>",
+      "document": "通过此接口，可以创建小程序批量签署链接，个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。\n\n注意事项：\n- 使用此接口生成链接，需要贵企业先开通 <font color=\"red\">使用手机号验证签署方身份 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。\n- 生成批量签署链接时，<font color=\"red\">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人点击链接后需要输入短信验证码才能查看合同内容。\n- 企业员工批量签署链接：需要传入签署方所在企业名称，用户名字和手机号（或者身份证件信息）参数来生成签署链接。<font color=\"red\">该签署方企业必须已完成腾讯电子签企业认证</font>\n- 个人批量签署链接：需要传入签署方用户名字和手机号（或者身份证件信息）参数来生成签署链接。<font color=\"red\">签名区仅支持手写签名</font>",
       "input": "CreateBatchSignUrlRequest",
       "name": "获取跳转至腾讯电子签小程序的批量签署链接",
       "output": "CreateBatchSignUrlResponse",
@@ -731,7 +731,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD 居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
+          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD 中国大陆居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
           "example": "ID_CARD",
           "member": "string",
           "name": "ApproverIdCardType",
@@ -1731,7 +1731,7 @@
         },
         {
           "disabled": false,
-          "document": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码\n\n注：\n1. 页码编号是从<font color=\"red\">1</font>开始编号的。\n2.  <font color=\"red\">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。",
+          "document": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码\n**在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。\n\n注：\n1. 页码编号是从<font color=\"red\">1</font>开始编号的。\n2.  <font color=\"red\">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。",
           "example": "无",
           "member": "int64",
           "name": "ComponentPage",
@@ -1852,7 +1852,7 @@
         },
         {
           "disabled": false,
-          "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，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</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注：   `部分特殊控件需要在控制台配置模板形式创建`",
+          "document": "控件填充vaule，ComponentType和传入值类型对应关系：\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容，可以用  \\n 来控制换行位置 </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日（例如2024年05年28日）</li>\n<li> <b>SIGN_SEAL</b> : 印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</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注：   `部分特殊控件需要在控制台配置模板形式创建`",
           "example": "无",
           "member": "string",
           "name": "ComponentValue",
@@ -2291,7 +2291,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。\n\n注：`请确保和合同中填入的一致`",
+          "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。\n\n注：`请确保和合同中填入的一致`, `除动态签署人场景外，此参数必填`",
           "example": "无",
           "member": "string",
           "name": "Name",
@@ -2300,7 +2300,7 @@
         },
         {
           "disabled": false,
-          "document": "手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注：`请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`",
+          "document": "手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注：`请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`",
           "example": "无",
           "member": "string",
           "name": "Mobile",
@@ -2318,7 +2318,7 @@
         },
         {
           "disabled": false,
-          "document": "证件类型，支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n\n注：`请确保和合同中填入的一致`",
+          "document": "证件类型，支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n\n注：`请确保和合同中填入的一致`",
           "example": "无",
           "member": "string",
           "name": "IdCardType",
@@ -4605,7 +4605,7 @@
         },
         {
           "disabled": false,
-          "document": "认证人证件类型\n支持以下类型\n<ul><li>ID_CARD : 居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
+          "document": "认证人证件类型\n支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
           "example": "无",
           "member": "string",
           "name": "AdminIdCardType",
@@ -5333,7 +5333,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>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
           "example": "无",
           "member": "string",
           "name": "IdCardType",
@@ -9174,7 +9174,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD 居民身份证</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `1.其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`\n`2.补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
+          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD 中国大陆居民身份证</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `1.其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`\n`2.补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
           "example": "ID_CARD",
           "member": "string",
           "name": "ApproverIdCardType",
@@ -10257,7 +10257,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "控件填充vaule，ComponentType和传入值类型对应关系：\nTEXT ：  文本内容\nMULTI_LINE_TEXT ：文本内容\nCHECK_BOX ：true/false\nFILL_IMAGE、ATTACHMENT ： 附件的FileId，需要通过UploadFiles接口上传获取\nSELECTOR ： 选项值\nDYNAMIC_TABLE ：传入json格式的表格内容，具体见数据结构[点击查看](https://qian.tencent.com/developers/company/dynamic_table)",
+          "document": "控件填充vaule，ComponentType和传入值类型对应关系：\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用  \\n 来控制换行位置</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日（例如：2024年05月28日）</li>\n</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",
           "example": "ComponentValue",
           "member": "string",
           "name": "ComponentValue",
@@ -11289,7 +11289,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD 居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
+          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD 中国大陆居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
           "example": "ID_CARD",
           "member": "string",
           "name": "ApproverIdCardType",
@@ -13725,7 +13725,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>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
           "example": "ID_CARD",
           "member": "string",
           "name": "IdCardType",

tccli/services/essbasic/v20210526/api.json

@@ -43,7 +43,7 @@
       "status": "online"
     },
     "ChannelCreateBatchSignUrl": {
-      "document": "通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注：\n- 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n- 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。暂时仅支持给`自建应用集成企业` 生成员工批签链接，不支持子客企业。\n- 个人批量签署，签名区`仅支持手写签名`。",
+      "document": "通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注：\n- 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n- 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。暂时仅支持给`自建应用集成企业` 生成员工批签链接，不支持子客企业。\n- 生成批量签署链接时，合同目标参与方状态需为`待签署`状态。\n- 个人批量签署，签名区`仅支持手写签名`。",
       "input": "ChannelCreateBatchSignUrlRequest",
       "name": "获取跳转至腾讯电子签小程序的批量签署链接",
       "output": "ChannelCreateBatchSignUrlResponse",
@@ -1665,7 +1665,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。\n\n注：`请确保和合同中填入的一致`",
+          "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。\n\n注：`请确保和合同中填入的一致`，`除动态签署人场景外，此参数必填`",
           "example": "无",
           "member": "string",
           "name": "Name",
@@ -1674,7 +1674,7 @@
         },
         {
           "disabled": false,
-          "document": "手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注：`请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`",
+          "document": "手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注：`请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`",
           "example": "无",
           "member": "string",
           "name": "Mobile",
@@ -1692,7 +1692,7 @@
         },
         {
           "disabled": false,
-          "document": "证件类型，支持以下类型\n<ul><li>**ID_CARD** : 居民身份证 (默认值)</li>\n<li>**HONGKONG_AND_MACAO** : 港澳居民来往内地通行证</li>\n<li>**HONGKONG_MACAO_AND_TAIWAN** : 港澳台居民居住证(格式同居民身份证)</li></ul>\n\n注：`请确保和合同中填入的一致`",
+          "document": "证件类型，支持以下类型\n<ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>\n<li>**HONGKONG_AND_MACAO** : 港澳居民来往内地通行证</li>\n<li>**HONGKONG_MACAO_AND_TAIWAN** : 港澳台居民居住证(格式同居民身份证)</li></ul>\n\n注：`请确保和合同中填入的一致`",
           "example": "无",
           "member": "string",
           "name": "IdCardType",
@@ -3158,7 +3158,7 @@
         },
         {
           "disabled": false,
-          "document": "证件类型，支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE : 其他</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
+          "document": "证件类型，支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE : 其他</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
           "example": "无",
           "member": "string",
           "name": "IdCardType",
@@ -5561,8 +5561,8 @@
         },
         {
           "disabled": false,
-          "document": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码\n\n注：\n1. 页码编号是从<font color=\"red\">1</font>开始编号的。\n2.  <font color=\"red\">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。",
-          "example": "0",
+          "document": "**在绝对定位方式方式下**，指定控件所在PDF文件上的页码\n**在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。\n\n注：\n1. 页码编号是从<font color=\"red\">1</font>开始编号的。\n2.  <font color=\"red\">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。",
+          "example": "1",
           "member": "int64",
           "name": "ComponentPage",
           "output_required": true,
@@ -5605,7 +5605,7 @@
         },
         {
           "disabled": false,
-          "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，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</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注：   `部分特殊控件需要在控制台配置模板形式创建`",
+          "document": "控件填充vaule，ComponentType和传入值类型对应关系：\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用  \\n 来控制换行位置</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日（例如：2024年05月28日）</li>\n<li> <b>SIGN_SEAL</b> : 印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</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注：   `部分特殊控件需要在控制台配置模板形式创建`",
           "example": "ComponentValue",
           "member": "string",
           "name": "ComponentValue",
@@ -7966,7 +7966,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD 居民身份证</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `1.其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`\n`2.补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
+          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD 中国大陆居民身份证</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `1.其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`\n`2.补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
           "example": "ID_CARD",
           "member": "string",
           "name": "ApproverIdCardType",
@@ -8242,7 +8242,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD : 居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE : 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
+          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE : 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
           "example": "ID_CARD",
           "member": "string",
           "name": "IdCardType",
@@ -9080,7 +9080,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "控件填充值，ComponentType和传入值格式对应关系如下：\n<ul>\n<li>TEXT - 普通文本控件，需输入文本字符串；</li>\n<li>MULTI_LINE_TEXT - 多行文本控件，需输入文本字符串；</li>\n<li>CHECK_BOX - 勾选框控件，若选中需填写ComponentValue，填写 true或者 false 字符串；</li>\n<li>FILL_IMAGE - 图片控件，需填写ComponentValue为图片的资源 ID；</li>\n<li>DYNAMIC_TABLE - 动态表格控件；</li>\n<li>ATTACHMENT - 附件控件，需填写ComponentValue为附件图片的资源 ID列表，以逗号分割；</li>\n<li>DATE - 日期控件；格式为 <b>xxxx年xx月xx日</b> 字符串；</li>\n<li>DISTRICT - 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容；</li>\n</ul>\n",
+          "document": "控件填充值，ComponentType和传入值格式对应关系如下：\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用  \\n 来控制换行位置</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/partner/dynamic_table)</li>\n<li> <b>DATE</b> : 格式化：xxxx年xx月xx日（例如：2024年05月28日）</li>\n<li> <b>DISTRICT </b> : 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容</li>\n</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",
           "example": "Name",
           "member": "string",
           "name": "ComponentValue",
@@ -9548,7 +9548,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD 居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
+          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD 中国大陆居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`",
           "example": "ID_CARD",
           "member": "string",
           "name": "ApproverIdCardType",
@@ -10325,7 +10325,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD : 居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
+          "document": "签署方经办人的证件类型，支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证  (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
           "example": "ID_CARD ",
           "member": "string",
           "name": "IdCardType",
@@ -11428,7 +11428,7 @@
         },
         {
           "disabled": false,
-          "document": "第三方平台子客企业法定代表人的证件类型，支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>\n注: `现在仅支持ID_CARD居民身份证类型`",
+          "document": "第三方平台子客企业法定代表人的证件类型，支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li></ul>\n注: `现在仅支持ID_CARD居民身份证类型`",
           "example": "无",
           "member": "string",
           "name": "ProxyLegalIdCardType",
@@ -11911,7 +11911,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>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
           "example": "ID_CARD",
           "member": "string",
           "name": "IdCardType",

tccli/services/gs/v20191118/api.json

@@ -77,7 +77,7 @@
         {
           "disabled": false,
           "document": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）",
-          "example": "xxx",
+          "example": "xyz789",
           "member": "string",
           "name": "UserId",
           "required": true,
@@ -113,7 +113,7 @@
         {
           "disabled": false,
           "document": "客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空",
-          "example": "xxx",
+          "example": "e30=",
           "member": "string",
           "name": "ClientSession",
           "required": false,
@@ -203,7 +203,7 @@
         {
           "disabled": false,
           "document": "【互动云游】游戏主机用户ID",
-          "example": "xxx",
+          "example": "abc123",
           "member": "string",
           "name": "HostUserId",
           "required": false,
@@ -245,18 +245,20 @@
         {
           "disabled": false,
           "document": "服务端session信息，返回给JSSDK",
-          "example": "xxx",
+          "example": "e30=",
           "member": "string",
           "name": "ServerSession",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "【已废弃】",
-          "example": "xx",
+          "example": "1",
           "member": "string",
           "name": "RoleNumber",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -266,6 +268,7 @@
           "example": "Player",
           "member": "string",
           "name": "Role",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -464,7 +467,7 @@
         {
           "disabled": false,
           "document": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）",
-          "example": "xxx",
+          "example": "xyz789",
           "member": "string",
           "name": "UserId",
           "required": true,
@@ -473,7 +476,7 @@
         {
           "disabled": false,
           "document": "【多人游戏】游戏主机用户ID",
-          "example": "无",
+          "example": "abc123",
           "member": "string",
           "name": "HostUserId",
           "required": false,
@@ -581,7 +584,7 @@
         {
           "disabled": false,
           "document": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）",
-          "example": "xxx",
+          "example": "xyz789",
           "member": "string",
           "name": "UserId",
           "required": true,

tccli/services/hai/v20230812/examples.json

@@ -43,7 +43,7 @@
     "DescribeServiceLoginSettings": [
       {
         "document": "查询实例hai-xxxxxxxx包含的服务登录配置",
-        "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeServiceLoginSettings\n<公共请求参数>\n\n{\n    \"InstanceId\": \"hai-xxxxxxxx\",\n    \"ServiceName\": \"jupyter\"\n}",
+        "input": "POST / HTTP/1.1\nHost: hai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeServiceLoginSettings\n<公共请求参数>\n\n{\n    \"InstanceId\": \"hai-xxxxxxxx\",\n    \"ServiceName\": \"jupyter\"\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"73956f5a-0f0e-4e60-ba7d-d555bcefe27b\",\n        \"LoginSettings\": [\n            {\n                \"ServiceName\": \"jupyter\",\n                \"Url\": \"http://1.14.52.185:80?40a0153b6c8ff839b2b83f9a3918daa55facad3c3e7a9b4a0e2377bd08f4aaa2\"\n            }\n        ]\n    }\n}",
         "title": "查询实例hai-xxxxxxxx包含的服务登录配置"
       }