tccli 3.0.1328.1__py2.py3-none-any.whl → 3.0.1331.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/autoscaling/v20180419/api.json +3 -3
- tccli/services/autoscaling/v20180419/examples.json +1 -1
- tccli/services/btoe/v20210514/api.json +26 -26
- tccli/services/cbs/v20170312/api.json +13 -13
- tccli/services/ccc/ccc_client.py +53 -0
- tccli/services/ccc/v20200210/api.json +105 -0
- tccli/services/ccc/v20200210/examples.json +8 -0
- tccli/services/cdn/v20180606/api.json +3 -3
- tccli/services/cdn/v20180606/examples.json +4 -4
- tccli/services/cdwch/v20200915/api.json +3 -3
- tccli/services/cdwch/v20200915/examples.json +1 -1
- tccli/services/ckafka/v20190819/api.json +9 -0
- tccli/services/clb/v20180317/api.json +18 -0
- tccli/services/dbbrain/v20210527/api.json +1 -0
- tccli/services/dnspod/dnspod_client.py +106 -0
- tccli/services/dnspod/v20210323/api.json +509 -2
- tccli/services/dnspod/v20210323/examples.json +17 -1
- tccli/services/emr/v20190103/api.json +1 -1
- tccli/services/ess/v20201111/api.json +13 -4
- tccli/services/essbasic/v20210526/api.json +15 -6
- tccli/services/essbasic/v20210526/examples.json +3 -3
- tccli/services/faceid/v20180301/api.json +49 -4
- tccli/services/gs/gs_client.py +53 -0
- tccli/services/gs/v20191118/api.json +62 -9
- tccli/services/gs/v20191118/examples.json +8 -0
- tccli/services/hai/hai_client.py +110 -4
- tccli/services/hai/v20230812/api.json +105 -0
- tccli/services/hai/v20230812/examples.json +16 -0
- tccli/services/ioa/ioa_client.py +106 -0
- tccli/services/ioa/v20220601/api.json +428 -0
- tccli/services/ioa/v20220601/examples.json +22 -0
- tccli/services/iotexplorer/v20190423/api.json +61 -10
- tccli/services/iotexplorer/v20190423/examples.json +1 -1
- tccli/services/lighthouse/v20200324/api.json +1 -1
- tccli/services/lke/lke_client.py +383 -12
- tccli/services/lke/v20231130/api.json +950 -24
- tccli/services/lke/v20231130/examples.json +60 -4
- tccli/services/lowcode/v20210108/api.json +41 -1
- tccli/services/lowcode/v20210108/examples.json +2 -2
- tccli/services/mps/v20190612/api.json +11 -0
- tccli/services/ocr/ocr_client.py +532 -320
- tccli/services/ocr/v20181119/api.json +651 -74
- tccli/services/ocr/v20181119/examples.json +32 -0
- tccli/services/postgres/v20170312/api.json +1 -1
- tccli/services/sms/v20190711/api.json +4 -4
- tccli/services/sms/v20210111/api.json +4 -4
- tccli/services/sqlserver/v20180328/api.json +29 -2
- tccli/services/ssl/v20191205/api.json +79 -0
- tccli/services/ssl/v20191205/examples.json +6 -6
- tccli/services/tcss/tcss_client.py +57 -4
- tccli/services/tcss/v20201101/api.json +79 -0
- tccli/services/tcss/v20201101/examples.json +8 -0
- tccli/services/teo/v20220901/api.json +1 -1
- tccli/services/tke/tke_client.py +53 -0
- tccli/services/tke/v20180525/api.json +59 -1
- tccli/services/tke/v20180525/examples.json +4 -4
- tccli/services/tke/v20220501/api.json +61 -0
- tccli/services/tke/v20220501/examples.json +8 -0
- tccli/services/trtc/trtc_client.py +216 -4
- tccli/services/trtc/v20190722/api.json +430 -1
- tccli/services/trtc/v20190722/examples.json +32 -0
- tccli/services/vm/v20210922/api.json +16 -20
- tccli/services/vod/v20180717/api.json +25 -13
- tccli/services/vod/v20180717/examples.json +2 -2
- tccli/services/wedata/v20210820/api.json +4144 -447
- tccli/services/wedata/v20210820/examples.json +52 -10
- tccli/services/wedata/wedata_client.py +403 -85
- {tccli-3.0.1328.1.dist-info → tccli-3.0.1331.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1328.1.dist-info → tccli-3.0.1331.1.dist-info}/RECORD +73 -73
- {tccli-3.0.1328.1.dist-info → tccli-3.0.1331.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1328.1.dist-info → tccli-3.0.1331.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1328.1.dist-info → tccli-3.0.1331.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -694,7 +694,7 @@
|
|
|
694
694
|
"status": "online"
|
|
695
695
|
},
|
|
696
696
|
"OperateTemplate": {
|
|
697
|
-
"document": "此接口（OperateTemplate）用于对企业自有模板进行管理操作，所有操作都会有对应的回调触发，具体参考回调文档 <a href=\"https://qian.tencent.com/developers/company/callback_types_templates\" target=\"_blank\">模板操作相关回调</a>\n\n\n# 支持的操作\n## 1. 删除模板 (OperateType=DELETE)\n此操作会将模板从企业自有模板中彻底删除，若要保留模板而不删除，可将模板停用。\n\n## 2. 启用模板 (OperateType=ENABLE)\n此操作是将已停用的模板启用，操作幂等，若模板已启用，接口不报错。\n\n## 3. 停用模板 (OperateType=DISABLE)\n
|
|
697
|
+
"document": "此接口（OperateTemplate）用于对企业自有模板进行管理操作，所有操作都会有对应的回调触发，具体参考回调文档 <a href=\"https://qian.tencent.com/developers/company/callback_types_templates\" target=\"_blank\">模板操作相关回调</a>\n\n\n# 支持的操作\n## 1. 删除模板 (OperateType=DELETE)\n此操作会将模板从企业自有模板中彻底删除，若要保留模板而不删除，可将模板停用。\n\n## 2. 启用模板 (OperateType=ENABLE)\n此操作是将已停用的模板启用，操作幂等，若模板已启用，接口不报错。\n\n## 3. 停用模板 (OperateType=DISABLE)\n此操作是将已启用的模板停用，操作幂等，若模板已停用，接口不报错，停用后，无法通过此模板发起合同，已发起的合同不受影响。\n\n## 4. 复制模板 (OperateType=COPY)\n此操作将复制一个完全一样的模板，仅支持修改模板名称，若要修改其他模板内容，需到腾讯电子签控制台操作。",
|
|
698
698
|
"input": "OperateTemplateRequest",
|
|
699
699
|
"name": "企业模板管理",
|
|
700
700
|
"output": "OperateTemplateResponse",
|
|
@@ -2155,7 +2155,7 @@
|
|
|
2155
2155
|
},
|
|
2156
2156
|
{
|
|
2157
2157
|
"disabled": false,
|
|
2158
|
-
"document": "\n**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :24</li>\n<li> <b>Opacity</b>： 透明度，范围0 :1</li>\n<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>\n<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>：`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、\"仿宋\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n
|
|
2158
|
+
"document": "\n**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :24</li>\n<li> <b>Opacity</b>： 透明度，范围0 :1</li>\n<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>\n<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>：`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SELECTOR时</font>，支持以下参数：\n<ul><li> <b>WordWrap</b>：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成</li>\n</ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、\"仿宋\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n",
|
|
2159
2159
|
"example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}",
|
|
2160
2160
|
"member": "string",
|
|
2161
2161
|
"name": "ComponentExtra",
|
|
@@ -3007,6 +3007,15 @@
|
|
|
3007
3007
|
"name": "CanBatchReject",
|
|
3008
3008
|
"required": false,
|
|
3009
3009
|
"type": "bool"
|
|
3010
|
+
},
|
|
3011
|
+
{
|
|
3012
|
+
"disabled": false,
|
|
3013
|
+
"document": "是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注：`1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果有签名控件，则会使用用户首次选择的签名类型签署所有含有签名控件的合同。`",
|
|
3014
|
+
"example": "false",
|
|
3015
|
+
"member": "bool",
|
|
3016
|
+
"name": "CanSkipReadFlow",
|
|
3017
|
+
"required": false,
|
|
3018
|
+
"type": "bool"
|
|
3010
3019
|
}
|
|
3011
3020
|
],
|
|
3012
3021
|
"type": "object"
|
|
@@ -6602,7 +6611,7 @@
|
|
|
6602
6611
|
{
|
|
6603
6612
|
"disabled": false,
|
|
6604
6613
|
"document": "资源类型，取值有： <ul><li> **1**：模板</li> <li> **2**：文件</li></ul>",
|
|
6605
|
-
"example": "
|
|
6614
|
+
"example": "2",
|
|
6606
6615
|
"member": "int64",
|
|
6607
6616
|
"name": "ResourceType",
|
|
6608
6617
|
"required": true,
|
|
@@ -13914,7 +13923,7 @@
|
|
|
13914
13923
|
},
|
|
13915
13924
|
{
|
|
13916
13925
|
"disabled": false,
|
|
13917
|
-
"document": "操作类型，可取值如下:\n<ul>\n<li>DELETE: 删除</li>\n<li>ENABLE: 启用</li>\n<li>DISABLE: 停用</li>\n</ul>",
|
|
13926
|
+
"document": "操作类型，可取值如下:\n<ul>\n<li>DELETE: 删除</li>\n<li>ENABLE: 启用</li>\n<li>DISABLE: 停用</li>\n<li>COPY: 复制新建</li>\n</ul>",
|
|
13918
13927
|
"example": "DELETE",
|
|
13919
13928
|
"member": "string",
|
|
13920
13929
|
"name": "OperateType",
|
|
@@ -603,7 +603,7 @@
|
|
|
603
603
|
"status": "online"
|
|
604
604
|
},
|
|
605
605
|
"OperateTemplate": {
|
|
606
|
-
"document": "此接口（OperateTemplate）用于对企业自有模板进行管理操作，所有操作都会有对应的回调触发，具体参考回调文档 <a href=\"https://qian.tencent.com/developers/partner/callback_types_templates\" target=\"_blank\">模板操作相关回调</a>\n\n# 支持的操作\n## 1. 删除模板 (OperateType=DELETE)\n此操作会将模板从企业自有模板中彻底删除，若要保留模板而不删除，可将模板停用。\n\n## 2. 启用模板 (OperateType=ENABLE)\n此操作是将已停用的模板启用，操作幂等，若模板已启用，接口不报错。\n\n## 3. 停用模板 (OperateType=DISABLE)\n
|
|
606
|
+
"document": "此接口（OperateTemplate）用于对企业自有模板进行管理操作，所有操作都会有对应的回调触发，具体参考回调文档 <a href=\"https://qian.tencent.com/developers/partner/callback_types_templates\" target=\"_blank\">模板操作相关回调</a>\n\n# 支持的操作\n## 1. 删除模板 (OperateType=DELETE)\n此操作会将模板从企业自有模板中彻底删除，若要保留模板而不删除，可将模板停用。\n\n## 2. 启用模板 (OperateType=ENABLE)\n此操作是将已停用的模板启用，操作幂等，若模板已启用，接口不报错。\n\n## 3. 停用模板 (OperateType=DISABLE)\n此操作是将已启用的模板停用，操作幂等，若模板已停用，接口不报错，停用后，无法通过此模板发起合同，已发起的合同不受影响。\n\n## 4. 复制模板 (OperateType=COPY)\n此操作将复制一个完全一样的模板，仅支持修改模板名称，若要修改其他模板内容，需到腾讯电子签控制台操作。",
|
|
607
607
|
"input": "OperateTemplateRequest",
|
|
608
608
|
"name": "企业模板管理",
|
|
609
609
|
"output": "OperateTemplateResponse",
|
|
@@ -2093,6 +2093,15 @@
|
|
|
2093
2093
|
"name": "CanBatchReject",
|
|
2094
2094
|
"required": false,
|
|
2095
2095
|
"type": "bool"
|
|
2096
|
+
},
|
|
2097
|
+
{
|
|
2098
|
+
"disabled": false,
|
|
2099
|
+
"document": "是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注：`1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果有签名控件，则会使用用户首次选择的签名类型签署所有含有签名控件的合同。`",
|
|
2100
|
+
"example": "false",
|
|
2101
|
+
"member": "bool",
|
|
2102
|
+
"name": "CanSkipReadFlow",
|
|
2103
|
+
"required": false,
|
|
2104
|
+
"type": "bool"
|
|
2096
2105
|
}
|
|
2097
2106
|
],
|
|
2098
2107
|
"type": "object"
|
|
@@ -3463,7 +3472,7 @@
|
|
|
3463
3472
|
{
|
|
3464
3473
|
"disabled": false,
|
|
3465
3474
|
"document": "资源类型，取值有： <ul><li> **1**：模板</li> <li> **2**：文件</li></ul>",
|
|
3466
|
-
"example": "
|
|
3475
|
+
"example": "2",
|
|
3467
3476
|
"member": "int64",
|
|
3468
3477
|
"name": "ResourceType",
|
|
3469
3478
|
"required": true,
|
|
@@ -3562,8 +3571,8 @@
|
|
|
3562
3571
|
"type": "object"
|
|
3563
3572
|
},
|
|
3564
3573
|
{
|
|
3565
|
-
"disabled":
|
|
3566
|
-
"document": "
|
|
3574
|
+
"disabled": true,
|
|
3575
|
+
"document": "已废弃，请用FlowInfo.Approvers",
|
|
3567
3576
|
"example": "无",
|
|
3568
3577
|
"member": "CommonFlowApprover",
|
|
3569
3578
|
"name": "FlowApproverList",
|
|
@@ -6272,7 +6281,7 @@
|
|
|
6272
6281
|
},
|
|
6273
6282
|
{
|
|
6274
6283
|
"disabled": false,
|
|
6275
|
-
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、仿宋，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：\n<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>\n<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>\n<b>参数样例</b>：`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n\n<pre>\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}</pre>\n</ul>\n\n
|
|
6284
|
+
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SELECTOR时</font>，支持以下参数：\n<ul><li> <b>WordWrap</b>：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成</li>\n</ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、仿宋，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：\n<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>\n<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>\n<b>参数样例</b>：`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n\n<pre>\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}</pre>\n</ul>\n\n",
|
|
6276
6285
|
"example": "ComponentExtra",
|
|
6277
6286
|
"member": "string",
|
|
6278
6287
|
"name": "ComponentExtra",
|
|
@@ -11888,7 +11897,7 @@
|
|
|
11888
11897
|
},
|
|
11889
11898
|
{
|
|
11890
11899
|
"disabled": false,
|
|
11891
|
-
"document": "操作类型，可取值如下:\n<ul>\n<li>DELETE: 删除</li>\n<li>ENABLE: 启用</li>\n<li>DISABLE: 停用</li>\n</ul>",
|
|
11900
|
+
"document": "操作类型，可取值如下:\n<ul>\n<li>DELETE: 删除</li>\n<li>ENABLE: 启用</li>\n<li>DISABLE: 停用</li>\n<li>COPY: 复制新建</li>\n</ul>",
|
|
11892
11901
|
"example": "DELETE",
|
|
11893
11902
|
"member": "string",
|
|
11894
11903
|
"name": "OperateType",
|
|
@@ -467,19 +467,19 @@
|
|
|
467
467
|
"ChannelCreatePrepareFlow": [
|
|
468
468
|
{
|
|
469
469
|
"document": "",
|
|
470
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"5d18c1c4c8926cd11\"\n },\n \"ProxyOrganizationOpenId\": \"572c69xxxxxx245e4\",\n \"AppId\": \"yDRsbUUgxxxx7ZfBvipOMJ\"\n },\n \"ResourceId\": \"yDwqFUUckp3em41rUwWPgIBjsYgG5bba\",\n \"ResourceType\": 2,\n \"FlowInfo\": {\n \"FlowName\": \"第三方预发起合同-跳过文件上传\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FlowDescription\": \"\",\n \"Deadline\": 0,\n \"
|
|
470
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"5d18c1c4c8926cd11\"\n },\n \"ProxyOrganizationOpenId\": \"572c69xxxxxx245e4\",\n \"AppId\": \"yDRsbUUgxxxx7ZfBvipOMJ\"\n },\n \"ResourceId\": \"yDwqFUUckp3em41rUwWPgIBjsYgG5bba\",\n \"ResourceType\": 2,\n \"FlowInfo\": {\n \"FlowName\": \"第三方预发起合同-跳过文件上传\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FlowDescription\": \"\",\n \"Deadline\": 0,\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"NotChannelOrganization\": false,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n131517\",\n \"ApproverOption\": {\n \"CanEditApprover\": true\n },\n \"IsFullText\": true,\n \"PreReadTime\": 0\n },\n {\n \"ApproverType\": 1,\n \"ApproverIdCardType\": \"\",\n \"ApproverName\": \"里斯\",\n \"NotChannelOrganization\": false,\n \"ApproverMobile\": \"13312312312\",\n \"IsFullText\": true,\n \"PreReadTime\": 0\n }\n ],\n \"Unordered\": false,\n \"IntelligentStatus\": \"CLOSE\",\n \"FormFields\": [\n\n ],\n \"NeedCreateReview\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"CcInfos\": [\n\n ]\n },\n \"FlowOption\": {\n \"CanEditFlow\": true,\n \"CanEditFormField\": true,\n \"HideShowFlowName\": false,\n \"HideShowFlowType\": false,\n \"HideShowDeadline\": false,\n \"ForbidEditFillComponent\": false,\n \"SkipUploadFile\": true,\n \"CustomCreateFlowDescription\": \"\"\n }\n}",
|
|
471
471
|
"output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb\",\n \"PreviewFlowUrl\": \"\",\n \"FlowId\": \"yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT\",\n \"RequestId\": \"c52aaa17-3f81-4640-be03-fca0a553d2e3\"\n }\n}",
|
|
472
472
|
"title": "文件发起-跳过文件上传"
|
|
473
473
|
},
|
|
474
474
|
{
|
|
475
475
|
"document": "1.这是一个B2C的合同模板， 创建发起合同签署链接，只指定一个子企业的参与方\n2.FlowApproverList参数指定的参与方不能更改， 未指定的参与方可以修改\n<img src=\"https://qcloudimg.tencent-cloud.cn/raw/f51c3d969db0093300094a22c6c01555.png\" />\n",
|
|
476
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"zhansan\"\n }\n },\n \"ResourceId\": \"yDSL6UUckpo6ynynUx47m3cSKQavf88Q\",\n \"ResourceType\": 1,\n \"FlowInfo\": {\n \"FlowName\": \"2024典子谦入职合同\",\n \"FlowType\": \"入职合同\",\n \"FlowDescription\": \"2024典子谦入职合同\",\n \"Deadline\": 1706335491
|
|
476
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"zhansan\"\n }\n },\n \"ResourceId\": \"yDSL6UUckpo6ynynUx47m3cSKQavf88Q\",\n \"ResourceType\": 1,\n \"FlowInfo\": {\n \"FlowName\": \"2024典子谦入职合同\",\n \"FlowType\": \"入职合同\",\n \"FlowDescription\": \"2024典子谦入职合同\",\n \"Deadline\": 1706335491,\n \"Approvers\": [\n {\n \"NotChannelOrganization\": false,\n \"ApproverType\": 0,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n9527\",\n \"RecipientId\": \"yDSL6UUckpo6am9jUuRHYOWRfZbRAhm6\"\n }\n ]\n }\n}",
|
|
477
477
|
"output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?code=yDCNBUUckpvlzt0sUypjGZRCTkEHyRh6\",\n \"PreviewFlowUrl\": \"\",\n \"FlowId\": \"yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT\",\n \"RequestId\": \"296e3cfb-504e-494d-a86c-75101a87c09e\"\n }\n}",
|
|
478
478
|
"title": "创建发起合同签署链接-模板发起（固定一个参与方）"
|
|
479
479
|
},
|
|
480
480
|
{
|
|
481
481
|
"document": "1.创建发起合同签署链接， 提前定义两个签署人， 分别是 B端渠道子客企业的员工和C端为张三这个自然人\n2.FlowApproverList参数指定的参与方不能更改\n<img src=\"https://qcloudimg.tencent-cloud.cn/raw/935a3cebf2881b25c1d87e234a303a13.png\" />\n",
|
|
482
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"ResourceId\": \"yDSL6UUckpo6ynynUx47m3cSKQavf88Q\",\n \"ResourceType\": 1,\n \"FlowInfo\": {\n \"FlowName\": \"典子谦入职合同(17:53:30)\",\n \"FlowType\": \"入职合同\",\n \"FlowDescription\": \"2024典子谦入职合同\",\n \"Deadline\": 1701679610
|
|
482
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"ResourceId\": \"yDSL6UUckpo6ynynUx47m3cSKQavf88Q\",\n \"ResourceType\": 1,\n \"FlowInfo\": {\n \"FlowName\": \"典子谦入职合同(17:53:30)\",\n \"FlowType\": \"入职合同\",\n \"FlowDescription\": \"2024典子谦入职合同\",\n \"Deadline\": 1701679610,\n \"Approvers\": [\n {\n \"NotChannelOrganization\": false,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n131517\",\n \"RecipientId\": \"yDSL6UUckpo6am9jUuRHYOWRfZbRAhm6\"\n },\n {\n \"ApproverType\": 1,\n \"NotChannelOrganization\": false,\n \"ApproverName\": \"张三\",\n \"ApproverMobile\": \"1850000000\",\n \"RecipientId\": \"yDSL6UUckpo6am9qUuRHYOWwmX5rZGCX\"\n }\n ]\n },\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"110101200610116558\"\n }\n }\n}",
|
|
483
483
|
"output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb\",\n \"PreviewFlowUrl\": \"\",\n \"FlowId\": \"yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT\",\n \"RequestId\": \"c52aaa17-3f81-4640-be03-fca0a553d2e3\"\n }\n}",
|
|
484
484
|
"title": "创建发起合同签署链接-模板发起（固定所有的参与方）"
|
|
485
485
|
}
|
|
@@ -321,7 +321,7 @@
|
|
|
321
321
|
"members": [
|
|
322
322
|
{
|
|
323
323
|
"disabled": false,
|
|
324
|
-
"document": "认证结果码。\n- 计费结果码：\n '0': '认证通过'。\n '-1': '认证未通过'。\n '-4': '持卡人信息有误'。\n '-5': '未开通无卡支付'。\n '-6': '此卡被没收'。\n '-7': '无效卡号'。\n '-8': '此卡无对应发卡行'。\n '-9': '该卡未初始化或睡眠卡'。\n '-10': '作弊卡、吞卡'。\n '-11': '此卡已挂失'。\n '-12': '该卡已过期'。\n '-13': '受限制的卡'。\n '-14': '密码错误次数超限'。\n '-15': '发卡行不支持此交易'。\n\n- 不计费结果码：\n '-2': '姓名校验不通过'。\n '-3': '
|
|
324
|
+
"document": "认证结果码。\n- 计费结果码：\n '0': '认证通过'。\n '-1': '认证未通过'。\n '-4': '持卡人信息有误'。\n '-5': '未开通无卡支付'。\n '-6': '此卡被没收'。\n '-7': '无效卡号'。\n '-8': '此卡无对应发卡行'。\n '-9': '该卡未初始化或睡眠卡'。\n '-10': '作弊卡、吞卡'。\n '-11': '此卡已挂失'。\n '-12': '该卡已过期'。\n '-13': '受限制的卡'。\n '-14': '密码错误次数超限'。\n '-15': '发卡行不支持此交易'。\n '-18': '卡状态异常或卡号错误'。\n\n- 不计费结果码：\n '-2': '姓名校验不通过'。\n '-3': '银行卡号格式有误'。\n '-16': '验证中心服务繁忙'。\n '-17': '验证次数超限，请次日重试'。\n",
|
|
325
325
|
"example": "0",
|
|
326
326
|
"member": "string",
|
|
327
327
|
"name": "Result",
|
|
@@ -413,7 +413,7 @@
|
|
|
413
413
|
"members": [
|
|
414
414
|
{
|
|
415
415
|
"disabled": false,
|
|
416
|
-
"document": "认证结果码。\n- 收费结果码：\n'0': '认证通过'。\n'-1': '认证未通过'。\n'-6': '持卡人信息有误'。\n'-7': '未开通无卡支付'。\n'-8': '此卡被没收'。\n'-9': '无效卡号'。\n'-10': '此卡无对应发卡行'。\n'-11': '该卡未初始化或睡眠卡'。\n'-12': '作弊卡、吞卡'。\n'-13': '此卡已挂失'。\n'-14': '该卡已过期'。\n'-15': '受限制的卡'。\n'-16': '密码错误次数超限'。\n'-17': '发卡行不支持此交易'。\n\n- 不收费结果码：\n'-2': '姓名校验不通过'。\n'-3': '身份证号码有误'。\n'-4': '
|
|
416
|
+
"document": "认证结果码。\n- 收费结果码：\n'0': '认证通过'。\n'-1': '认证未通过'。\n'-6': '持卡人信息有误'。\n'-7': '未开通无卡支付'。\n'-8': '此卡被没收'。\n'-9': '无效卡号'。\n'-10': '此卡无对应发卡行'。\n'-11': '该卡未初始化或睡眠卡'。\n'-12': '作弊卡、吞卡'。\n'-13': '此卡已挂失'。\n'-14': '该卡已过期'。\n'-15': '受限制的卡'。\n'-16': '密码错误次数超限'。\n'-17': '发卡行不支持此交易'。\n'-21': '卡状态异常或卡号错误'。\n\n- 不收费结果码：\n'-2': '姓名校验不通过'。\n'-3': '身份证号码有误'。\n'-4': '银行卡号格式有误'。\n'-5': '手机号码不合法'。\n'-18': '验证中心服务繁忙'。\n'-19': '验证次数超限，请次日重试'。\n'-20': '该证件号暂不支持核验，当前仅支持二代身份证'。",
|
|
417
417
|
"example": "0",
|
|
418
418
|
"member": "string",
|
|
419
419
|
"name": "Result",
|
|
@@ -496,7 +496,7 @@
|
|
|
496
496
|
"members": [
|
|
497
497
|
{
|
|
498
498
|
"disabled": false,
|
|
499
|
-
"document": "认证结果码。\n- 收费结果码：\n'0': '认证通过'。\n'-1': '认证未通过'。\n'-5': '持卡人信息有误'。\n'-6': '未开通无卡支付'。\n'-7': '此卡被没收'。\n'-8': '无效卡号'。\n'-9': '此卡无对应发卡行'。\n'-10': '该卡未初始化或睡眠卡'。\n'-11': '作弊卡、吞卡'。\n'-12': '此卡已挂失'。\n'-13': '该卡已过期'。\n'-14': '受限制的卡'。\n'-15': '密码错误次数超限'。\n'-16': '发卡行不支持此交易'。\n\n- 不收费结果码：\n'-2': '姓名校验不通过'。\n'-3': '身份证号码有误'。\n'-4': '
|
|
499
|
+
"document": "认证结果码。\n- 收费结果码：\n'0': '认证通过'。\n'-1': '认证未通过'。\n'-5': '持卡人信息有误'。\n'-6': '未开通无卡支付'。\n'-7': '此卡被没收'。\n'-8': '无效卡号'。\n'-9': '此卡无对应发卡行'。\n'-10': '该卡未初始化或睡眠卡'。\n'-11': '作弊卡、吞卡'。\n'-12': '此卡已挂失'。\n'-13': '该卡已过期'。\n'-14': '受限制的卡'。\n'-15': '密码错误次数超限'。\n'-16': '发卡行不支持此交易'。\n'-20': '卡状态异常或卡号错误'。\n\n- 不收费结果码：\n'-2': '姓名校验不通过'。\n'-3': '身份证号码有误'。\n'-4': '银行卡号格式有误'。\n'-17': '验证中心服务繁忙'。\n'-18': '验证次数超限，请次日重试'。\n'-19': '该证件号暂不支持核验，当前仅支持二代身份证'。\t",
|
|
500
500
|
"example": "0",
|
|
501
501
|
"member": "string",
|
|
502
502
|
"name": "Result",
|
|
@@ -658,7 +658,7 @@
|
|
|
658
658
|
"members": [
|
|
659
659
|
{
|
|
660
660
|
"disabled": false,
|
|
661
|
-
"document": "认证结果码，收费情况如下。\n- 收费结果码：\n0: 查询成功\n-1: 未查到信息\n\n- 不收费结果码：\n-2：验证中心服务繁忙\n-3：银行卡不存在\n-4：认证次数超过当日限制，请次日重试\n",
|
|
661
|
+
"document": "认证结果码，收费情况如下。\n- 收费结果码：\n0: 查询成功\n-1: 未查到信息\n-5: 卡号无效\n\n- 不收费结果码：\n-2：验证中心服务繁忙\n-3：银行卡不存在\n-4：认证次数超过当日限制，请次日重试\n-6: 暂不支持该银行卡种\n",
|
|
662
662
|
"example": "0",
|
|
663
663
|
"member": "string",
|
|
664
664
|
"name": "Result",
|
|
@@ -1898,6 +1898,16 @@
|
|
|
1898
1898
|
"output_required": true,
|
|
1899
1899
|
"type": "string",
|
|
1900
1900
|
"value_allowed_null": true
|
|
1901
|
+
},
|
|
1902
|
+
{
|
|
1903
|
+
"disabled": false,
|
|
1904
|
+
"document": "当次token中所有用户活体视频的COS存储路径，仅当您开启数据存储服务且“IsReturnAllVideo”入参取值为true 时返回。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
1905
|
+
"example": "无",
|
|
1906
|
+
"member": "VideoDetailData",
|
|
1907
|
+
"name": "LivenessVideos",
|
|
1908
|
+
"output_required": false,
|
|
1909
|
+
"type": "list",
|
|
1910
|
+
"value_allowed_null": true
|
|
1901
1911
|
}
|
|
1902
1912
|
],
|
|
1903
1913
|
"usage": "out"
|
|
@@ -2229,6 +2239,15 @@
|
|
|
2229
2239
|
"name": "IsEncryptResponse",
|
|
2230
2240
|
"required": false,
|
|
2231
2241
|
"type": "bool"
|
|
2242
|
+
},
|
|
2243
|
+
{
|
|
2244
|
+
"disabled": false,
|
|
2245
|
+
"document": "是否需要返回认证中间过程的刷脸重试视频，默认不开启，多段视频需要存储到COS空间中，因此开启后还需要额外开启数据存储服务才可生效。详见[数据存储指引](https://cloud.tencent.com/document/product/1007/104229)。",
|
|
2246
|
+
"example": "false",
|
|
2247
|
+
"member": "bool",
|
|
2248
|
+
"name": "IsReturnAllVideo",
|
|
2249
|
+
"required": false,
|
|
2250
|
+
"type": "bool"
|
|
2232
2251
|
}
|
|
2233
2252
|
],
|
|
2234
2253
|
"type": "object"
|
|
@@ -5197,6 +5216,32 @@
|
|
|
5197
5216
|
],
|
|
5198
5217
|
"usage": "in"
|
|
5199
5218
|
},
|
|
5219
|
+
"VideoDetailData": {
|
|
5220
|
+
"document": "核身过程视频信息。",
|
|
5221
|
+
"members": [
|
|
5222
|
+
{
|
|
5223
|
+
"disabled": false,
|
|
5224
|
+
"document": "本次活体一比一请求的唯一标记。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5225
|
+
"example": "AE13A3B3-F276-4C65-9BC9-1FE137851581",
|
|
5226
|
+
"member": "string",
|
|
5227
|
+
"name": "Seq",
|
|
5228
|
+
"output_required": false,
|
|
5229
|
+
"type": "string",
|
|
5230
|
+
"value_allowed_null": true
|
|
5231
|
+
},
|
|
5232
|
+
{
|
|
5233
|
+
"disabled": false,
|
|
5234
|
+
"document": "活体视频的base64编码。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5235
|
+
"example": "/9j/4AAQSkZJRg.....s97n//2Q==",
|
|
5236
|
+
"member": "string",
|
|
5237
|
+
"name": "Video",
|
|
5238
|
+
"output_required": false,
|
|
5239
|
+
"type": "string",
|
|
5240
|
+
"value_allowed_null": true
|
|
5241
|
+
}
|
|
5242
|
+
],
|
|
5243
|
+
"usage": "out"
|
|
5244
|
+
},
|
|
5200
5245
|
"WeChatBillDetail": {
|
|
5201
5246
|
"document": "账单详情",
|
|
5202
5247
|
"members": [
|
tccli/services/gs/gs_client.py
CHANGED
|
@@ -1785,6 +1785,58 @@ def doResetAndroidInstances(args, parsed_globals):
|
|
|
1785
1785
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
|
1786
1786
|
|
|
1787
1787
|
|
|
1788
|
+
def doDistributePhotoToAndroidInstances(args, parsed_globals):
|
|
1789
|
+
g_param = parse_global_arg(parsed_globals)
|
|
1790
|
+
|
|
1791
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
|
1792
|
+
cred = credential.CVMRoleCredential()
|
|
1793
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
|
1794
|
+
cred = credential.STSAssumeRoleCredential(
|
|
1795
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
|
1796
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
|
1797
|
+
)
|
|
1798
|
+
elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
|
|
1799
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
|
1800
|
+
else:
|
|
1801
|
+
cred = credential.Credential(
|
|
1802
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
|
1803
|
+
)
|
|
1804
|
+
http_profile = HttpProfile(
|
|
1805
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
|
1806
|
+
reqMethod="POST",
|
|
1807
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
|
1808
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
|
1809
|
+
)
|
|
1810
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
|
1811
|
+
if g_param[OptionsDefine.Language]:
|
|
1812
|
+
profile.language = g_param[OptionsDefine.Language]
|
|
1813
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
|
1814
|
+
client = mod.GsClient(cred, g_param[OptionsDefine.Region], profile)
|
|
1815
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
|
1816
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
|
1817
|
+
model = models.DistributePhotoToAndroidInstancesRequest()
|
|
1818
|
+
model.from_json_string(json.dumps(args))
|
|
1819
|
+
start_time = time.time()
|
|
1820
|
+
while True:
|
|
1821
|
+
rsp = client.DistributePhotoToAndroidInstances(model)
|
|
1822
|
+
result = rsp.to_json_string()
|
|
1823
|
+
try:
|
|
1824
|
+
json_obj = json.loads(result)
|
|
1825
|
+
except TypeError as e:
|
|
1826
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
|
1827
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
|
1828
|
+
break
|
|
1829
|
+
cur_time = time.time()
|
|
1830
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
|
1831
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
|
1832
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
|
1833
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
|
1834
|
+
else:
|
|
1835
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
|
1836
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
|
1837
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
|
1838
|
+
|
|
1839
|
+
|
|
1788
1840
|
def doStartPublishStreamToCSS(args, parsed_globals):
|
|
1789
1841
|
g_param = parse_global_arg(parsed_globals)
|
|
1790
1842
|
|
|
@@ -3754,6 +3806,7 @@ ACTION_MAP = {
|
|
|
3754
3806
|
"DescribeAndroidInstances": doDescribeAndroidInstances,
|
|
3755
3807
|
"UploadFilesToAndroidInstances": doUploadFilesToAndroidInstances,
|
|
3756
3808
|
"ResetAndroidInstances": doResetAndroidInstances,
|
|
3809
|
+
"DistributePhotoToAndroidInstances": doDistributePhotoToAndroidInstances,
|
|
3757
3810
|
"StartPublishStreamToCSS": doStartPublishStreamToCSS,
|
|
3758
3811
|
"DescribeAndroidApps": doDescribeAndroidApps,
|
|
3759
3812
|
"ModifyAndroidInstanceInformation": doModifyAndroidInstanceInformation,
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
"status": "online"
|
|
58
58
|
},
|
|
59
59
|
"CreateAndroidInstanceLabel": {
|
|
60
|
-
"document": "
|
|
60
|
+
"document": "创建安卓实例标签",
|
|
61
61
|
"input": "CreateAndroidInstanceLabelRequest",
|
|
62
62
|
"name": "创建安卓实例标签",
|
|
63
63
|
"output": "CreateAndroidInstanceLabelResponse",
|
|
@@ -127,7 +127,7 @@
|
|
|
127
127
|
"status": "online"
|
|
128
128
|
},
|
|
129
129
|
"DeleteAndroidInstanceLabel": {
|
|
130
|
-
"document": "
|
|
130
|
+
"document": "删除安卓实例标签",
|
|
131
131
|
"input": "DeleteAndroidInstanceLabelRequest",
|
|
132
132
|
"name": "删除安卓实例标签",
|
|
133
133
|
"output": "DeleteAndroidInstanceLabelResponse",
|
|
@@ -155,7 +155,7 @@
|
|
|
155
155
|
"status": "online"
|
|
156
156
|
},
|
|
157
157
|
"DescribeAndroidInstanceLabels": {
|
|
158
|
-
"document": "
|
|
158
|
+
"document": "查询安卓实例标签",
|
|
159
159
|
"input": "DescribeAndroidInstanceLabelsRequest",
|
|
160
160
|
"name": "查询安卓实例标签",
|
|
161
161
|
"output": "DescribeAndroidInstanceLabelsResponse",
|
|
@@ -217,6 +217,13 @@
|
|
|
217
217
|
"output": "DistributeFileToAndroidInstancesResponse",
|
|
218
218
|
"status": "online"
|
|
219
219
|
},
|
|
220
|
+
"DistributePhotoToAndroidInstances": {
|
|
221
|
+
"document": "将一张照片批量分发到多个实例的相册中，一次接口调用触发一次照片分发，一次照片分发只会从公网下载一次，然后照片会走内网分发到实例列表中的实例。",
|
|
222
|
+
"input": "DistributePhotoToAndroidInstancesRequest",
|
|
223
|
+
"name": "分发照片到安卓实例相册",
|
|
224
|
+
"output": "DistributePhotoToAndroidInstancesResponse",
|
|
225
|
+
"status": "online"
|
|
226
|
+
},
|
|
220
227
|
"EnableAndroidInstancesApp": {
|
|
221
228
|
"document": "批量启用安卓实例应用",
|
|
222
229
|
"input": "EnableAndroidInstancesAppRequest",
|
|
@@ -253,7 +260,7 @@
|
|
|
253
260
|
"status": "online"
|
|
254
261
|
},
|
|
255
262
|
"InstallAndroidInstancesAppWithURL": {
|
|
256
|
-
"document": "安装安卓实例应用",
|
|
263
|
+
"document": "通过 URL 安装安卓实例应用",
|
|
257
264
|
"input": "InstallAndroidInstancesAppWithURLRequest",
|
|
258
265
|
"name": "通过 URL 安装安卓实例应用",
|
|
259
266
|
"output": "InstallAndroidInstancesAppWithURLResponse",
|
|
@@ -302,7 +309,7 @@
|
|
|
302
309
|
"status": "online"
|
|
303
310
|
},
|
|
304
311
|
"ModifyAndroidInstancesLabels": {
|
|
305
|
-
"document": "
|
|
312
|
+
"document": "批量修改安卓实例的标签",
|
|
306
313
|
"input": "ModifyAndroidInstancesLabelsRequest",
|
|
307
314
|
"name": "批量修改安卓实例的标签",
|
|
308
315
|
"output": "ModifyAndroidInstancesLabelsResponse",
|
|
@@ -358,7 +365,7 @@
|
|
|
358
365
|
"status": "online"
|
|
359
366
|
},
|
|
360
367
|
"RestartAndroidInstancesApp": {
|
|
361
|
-
"document": "
|
|
368
|
+
"document": "重启安卓实例应用",
|
|
362
369
|
"input": "RestartAndroidInstancesAppRequest",
|
|
363
370
|
"name": "重启安卓实例应用",
|
|
364
371
|
"output": "RestartAndroidInstancesAppResponse",
|
|
@@ -393,7 +400,7 @@
|
|
|
393
400
|
"status": "online"
|
|
394
401
|
},
|
|
395
402
|
"StartAndroidInstances": {
|
|
396
|
-
"document": "
|
|
403
|
+
"document": "开机安卓实例",
|
|
397
404
|
"input": "StartAndroidInstancesRequest",
|
|
398
405
|
"name": "开机安卓实例",
|
|
399
406
|
"output": "StartAndroidInstancesResponse",
|
|
@@ -421,7 +428,7 @@
|
|
|
421
428
|
"status": "online"
|
|
422
429
|
},
|
|
423
430
|
"StopAndroidInstances": {
|
|
424
|
-
"document": "
|
|
431
|
+
"document": "关机安卓实例",
|
|
425
432
|
"input": "StopAndroidInstancesRequest",
|
|
426
433
|
"name": "关机安卓实例",
|
|
427
434
|
"output": "StopAndroidInstancesResponse",
|
|
@@ -3053,7 +3060,7 @@
|
|
|
3053
3060
|
},
|
|
3054
3061
|
{
|
|
3055
3062
|
"disabled": false,
|
|
3056
|
-
"document": "字段过滤器。Filter 的 Name 有以下值：\nName：实例名称\nUserId：实例用户ID",
|
|
3063
|
+
"document": "字段过滤器。Filter 的 Name 有以下值：\nName：实例名称\nUserId：实例用户ID\nHostSerialNumber：宿主机序列号\nHostServerSerialNumber：机箱序列号",
|
|
3057
3064
|
"example": "无",
|
|
3058
3065
|
"member": "Filter",
|
|
3059
3066
|
"name": "Filters",
|
|
@@ -3295,6 +3302,52 @@
|
|
|
3295
3302
|
],
|
|
3296
3303
|
"type": "object"
|
|
3297
3304
|
},
|
|
3305
|
+
"DistributePhotoToAndroidInstancesRequest": {
|
|
3306
|
+
"document": "DistributePhotoToAndroidInstances请求参数结构体",
|
|
3307
|
+
"members": [
|
|
3308
|
+
{
|
|
3309
|
+
"disabled": false,
|
|
3310
|
+
"document": "安卓实例 ID 列表",
|
|
3311
|
+
"example": "[\"cai_xxx\"]",
|
|
3312
|
+
"member": "string",
|
|
3313
|
+
"name": "AndroidInstanceIds",
|
|
3314
|
+
"required": true,
|
|
3315
|
+
"type": "list"
|
|
3316
|
+
},
|
|
3317
|
+
{
|
|
3318
|
+
"disabled": false,
|
|
3319
|
+
"document": "照片下载 URL",
|
|
3320
|
+
"example": "https://xxx",
|
|
3321
|
+
"member": "string",
|
|
3322
|
+
"name": "PhotoURL",
|
|
3323
|
+
"required": true,
|
|
3324
|
+
"type": "string"
|
|
3325
|
+
}
|
|
3326
|
+
],
|
|
3327
|
+
"type": "object"
|
|
3328
|
+
},
|
|
3329
|
+
"DistributePhotoToAndroidInstancesResponse": {
|
|
3330
|
+
"document": "DistributePhotoToAndroidInstances返回参数结构体",
|
|
3331
|
+
"members": [
|
|
3332
|
+
{
|
|
3333
|
+
"disabled": false,
|
|
3334
|
+
"document": "实例任务集合",
|
|
3335
|
+
"example": "无",
|
|
3336
|
+
"member": "AndroidInstanceTask",
|
|
3337
|
+
"name": "TaskSet",
|
|
3338
|
+
"output_required": true,
|
|
3339
|
+
"type": "list",
|
|
3340
|
+
"value_allowed_null": false
|
|
3341
|
+
},
|
|
3342
|
+
{
|
|
3343
|
+
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
3344
|
+
"member": "string",
|
|
3345
|
+
"name": "RequestId",
|
|
3346
|
+
"type": "string"
|
|
3347
|
+
}
|
|
3348
|
+
],
|
|
3349
|
+
"type": "object"
|
|
3350
|
+
},
|
|
3298
3351
|
"EnableAndroidInstancesAppRequest": {
|
|
3299
3352
|
"document": "EnableAndroidInstancesApp请求参数结构体",
|
|
3300
3353
|
"members": [
|