tccli 3.0.1224.1__py2.py3-none-any.whl → 3.0.1225.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 +11 -0
- tccli/services/batch/v20170312/api.json +33 -11
- tccli/services/billing/v20180709/api.json +37 -7
- tccli/services/billing/v20180709/examples.json +2 -2
- tccli/services/cbs/v20170312/api.json +1 -1
- tccli/services/cvm/v20170312/api.json +33 -11
- tccli/services/cwp/v20180228/api.json +1 -1
- tccli/services/cynosdb/v20190107/api.json +4 -4
- tccli/services/ess/v20201111/api.json +2 -2
- tccli/services/ess/v20201111/examples.json +2 -2
- tccli/services/essbasic/v20210526/api.json +2 -2
- tccli/services/essbasic/v20210526/examples.json +2 -2
- tccli/services/iotexplorer/v20190423/api.json +11 -11
- tccli/services/live/live_client.py +460 -36
- tccli/services/live/v20180801/api.json +592 -3
- tccli/services/live/v20180801/examples.json +64 -0
- tccli/services/mrs/v20200910/api.json +4217 -4211
- tccli/services/mrs/v20200910/examples.json +14 -14
- tccli/services/ocr/ocr_client.py +0 -53
- tccli/services/ocr/v20181119/api.json +0 -162
- tccli/services/ocr/v20181119/examples.json +0 -8
- tccli/services/teo/teo_client.py +159 -0
- tccli/services/teo/v20220901/api.json +199 -0
- tccli/services/teo/v20220901/examples.json +36 -0
- {tccli-3.0.1224.1.dist-info → tccli-3.0.1225.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1224.1.dist-info → tccli-3.0.1225.1.dist-info}/RECORD +30 -30
- {tccli-3.0.1224.1.dist-info → tccli-3.0.1225.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1224.1.dist-info → tccli-3.0.1225.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1224.1.dist-info → tccli-3.0.1225.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -552,8 +552,8 @@
|
|
|
552
552
|
"title": "文件发起B2C合同，签署方设置签批控件"
|
|
553
553
|
},
|
|
554
554
|
{
|
|
555
|
-
"document": "
|
|
556
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxbTUyKQWPt5NUuO4zjEuyFAyOX3v9C\"\n },\n \"FlowName\": \"文件发起-签批\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"SignComponents\": [\n {\n \"ComponentId\": \"ComponentId_1\",\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentHeight\": 100\n },\n {\n \"ComponentId\": \"ComponentId_2\",\n \"ComponentPosY\": 360,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentHeight\": 50\n },\n {\n \"
|
|
555
|
+
"document": "1.通过PDF文件发起合同 \n2.使用关键字模式\n3.指定B端签署方为企业【典子谦示例企业】，经办人为【典子谦】 \n4.指定C端签署方为个人【张三】 \n5.B 端签署人 有两个签署控件， 分别是签名控件和签批控件(SIGN_VIRTUAL_COMBINATION)，其中签批控件包含四个子控件通过ComponentExtra指定， 但是关键字跟绝对定位的区别在于 关键字方式只用传递SIGN_VIRTUAL_COMBINATION 一个签署控件即可。\n6.C 端签署人 有一个签批控件(SIGN_VIRTUAL_COMBINATION)，使用默认签批控件",
|
|
556
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowByFiles\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxbTUyKQWPt5NUuO4zjEuyFAyOX3v9C\"\n },\n \"FlowName\": \"文件发起-签批\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"SignComponents\": [\n {\n \"ComponentId\": \"ComponentId_1\",\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentHeight\": 100\n },\n {\n \"ComponentId\": \"ComponentId_2\",\n \"ComponentPosY\": 360,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentHeight\": 50\n },\n {\n \"ComponentId\": \"甲方（盖章）\",\n \"ComponentType\": \"SIGN_VIRTUAL_COMBINATION\",\n \"ComponentHeight\": 600,\n \"ComponentWidth\": 400,\n \"ComponentRequired\": true,\n \"FileIndex\": 0,\n \"ComponentPage\": 7,\n \"ComponentPosY\": 0,\n \"ComponentPosX\": 0,\n \"RelativeLocation\": \"Below\",\n \"ComponentExtra\": \"{\\\"ChildrenComponents\\\":[{\\\"ComponentType\\\":\\\"SIGN_SIGNATURE\\\",\\\"ComponentName\\\":\\\"个人签名\\\",\\\"Placeholder\\\":\\\"请签名\\\",\\\"ComponentOffsetX\\\":10,\\\"ComponentOffsetY\\\":30,\\\"ComponentWidth\\\":119,\\\"ComponentHeight\\\":43,\\\"ComponentExtra\\\":\\\"{\\\\\\\"ComponentTypeLimit\\\\\\\":[\\\\\\\"SYSTEM_ESIGN\\\\\\\"]}\\\"},{\\\"ComponentType\\\":\\\"SIGN_SELECTOR\\\",\\\"ComponentName\\\":\\\"审批意见\\\",\\\"Placeholder\\\":\\\"\\\",\\\"ComponentOffsetX\\\":50,\\\"ComponentOffsetY\\\":130,\\\"ComponentWidth\\\":120,\\\"ComponentHeight\\\":43,\\\"ComponentExtra\\\":\\\"{\\\\\\\"Values\\\\\\\":[\\\\\\\"同意\\\\\\\",\\\\\\\"不同意\\\\\\\",\\\\\\\"待定\\\\\\\"],\\\\\\\"FontSize\\\\\\\":12,\\\\\\\"FontAlign\\\\\\\":\\\\\\\"Left\\\\\\\",\\\\\\\"Font\\\\\\\":\\\\\\\"黑体\\\\\\\",\\\\\\\"MultiSelect\\\\\\\":false}\\\"},{\\\"ComponentType\\\":\\\"SIGN_MULTI_LINE_TEXT\\\",\\\"ComponentName\\\":\\\"顺便留个言呗\\\",\\\"Placeholder\\\":\\\"\\\",\\\"ComponentOffsetX\\\":150,\\\"ComponentOffsetY\\\":300,\\\"ComponentWidth\\\":200,\\\"ComponentHeight\\\":86,\\\"ComponentExtra\\\":\\\"\\\"}]}\",\n \"GenerateMode\": \"KEYWORD\"\n }\n ]\n },\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"张三\",\n \"ApproverMobile\": \"18888888888\",\n \"SignComponents\": [\n {\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentPosX\": 160,\n \"ComponentHeight\": 100\n },\n {\n \"ComponentId\": \"已方（盖章）\",\n \"ComponentType\": \"SIGN_VIRTUAL_COMBINATION\",\n \"ComponentHeight\": 600,\n \"ComponentWidth\": 400,\n \"FileIndex\": 0,\n \"ComponentPage\": 7,\n \"ComponentPosY\": 0,\n \"ComponentPosX\": 0,\n \"ComponentRequired\": true,\n \"RelativeLocation\": \"Below\",\n \"GenerateMode\": \"KEYWORD\"\n }\n ]\n }\n ],\n \"FileIds\": [\n \"yDCWqUUckpve5id3U4f5EL77tlNh6zTZ\"\n ],\n \"Unordered\": true\n}",
|
|
557
557
|
"output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCdmUUckp7lfkotUyvGAviEmENDy2vV\",\n \"SignId\": \"yDCdmUUckp7lfkorUyvGAviC9bfPrgZE\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCdmUUckp7lfkoqUyvGAvi1LVH92Jy3\",\n \"SignId\": \"yDCdmUUckp7lfkolUyvGAvi86E6ZjRpX\"\n }\n ],\n \"FlowId\": \"yDCdmUUckp7lfko2UyvGAviyHgywsLpt\",\n \"PreviewUrl\": \"\",\n \"RequestId\": \"s1732096342358060984\"\n }\n}",
|
|
558
558
|
"title": "文件发起B2C合同，使用关键字方式，签署方设置签批控件"
|
|
559
559
|
}
|
|
@@ -5749,7 +5749,7 @@
|
|
|
5749
5749
|
},
|
|
5750
5750
|
{
|
|
5751
5751
|
"disabled": false,
|
|
5752
|
-
"document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li
|
|
5752
|
+
"document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n</ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
|
|
5753
5753
|
"example": "SIGN_SEAL",
|
|
5754
5754
|
"member": "string",
|
|
5755
5755
|
"name": "ComponentType",
|
|
@@ -5870,7 +5870,7 @@
|
|
|
5870
5870
|
},
|
|
5871
5871
|
{
|
|
5872
5872
|
"disabled": false,
|
|
5873
|
-
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :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类型时</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></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类型时</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
|
|
5873
|
+
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :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类型时</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></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类型时</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>\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\">\n <thead>\n <tr>\n <th>字段名称</th>\n <th>类型</th>\n <th>描述</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>ComponentType</td>\n <td>string</td>\n <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>\n </tr>\n <tr>\n <td>ComponentName</td>\n <td>string</td>\n <td>子控件名称</td>\n </tr>\n <tr>\n <td>Placeholder</td>\n <td>string</td>\n <td>子控件提示语</td>\n </tr>\n <tr>\n <td>ComponentOffsetX</td>\n <td>float</td>\n <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td>\n </tr>\n <tr>\n <td>ComponentOffsetY</td>\n <td>float</td>\n <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td>\n </tr>\n <tr>\n <td>ComponentWidth</td>\n <td>float</td>\n <td>控件宽</td>\n </tr>\n <tr>\n <td>ComponentHeight</td>\n <td>float</td>\n <td>控件高</td>\n </tr>\n <tr>\n <td>ComponentExtra</td>\n <td>string</td>\n <td>控件的附属信息，根据ComponentType设置</td>\n </tr>\n </tbody>\n</table>\n<b>参数样例</b>：\n```json\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```\n</ul>\n\n\n\n",
|
|
5874
5874
|
"example": "ComponentExtra",
|
|
5875
5875
|
"member": "string",
|
|
5876
5876
|
"name": "ComponentExtra",
|
|
@@ -288,8 +288,8 @@
|
|
|
288
288
|
"title": "文件发起 签署方含有签批控件"
|
|
289
289
|
},
|
|
290
290
|
{
|
|
291
|
-
"document": "
|
|
292
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowByFiles\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n }\n },\n \"FlowName\": \"文件发起-签批\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ORGANIZATION\",\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OpenId\": \"n9527\",\n \"Name\": \"典子谦\",\n \"Mobile\": \"13200000000\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"SignComponents\": [\n {\n \"FileIndex\": 0,\n \"GenerateMode\": \"KEYWORD\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"RelativeLocation\": \"Right\",\n \"ComponentId\": \"
|
|
291
|
+
"document": "1.通过PDF文件发起合同 \n2.使用的是关键字定位\n3.指定B端签署方为企业【典子谦示例企业】，经办人为【典子谦】 \n4.指定C端签署方为个人【张三】 \n5.B 端签署有签批控件(SIGN_VIRTUAL_COMBINATION)，其中签批控件包含四个子控件, 通过在 Component 中的 ComponentExtra:指定, 但是关键字跟绝对定位的区别在于 关键字方式只用传递SIGN_VIRTUAL_COMBINATION 一个签署控件即可\n6.C 端签署人 有一个签批控件(SIGN_VIRTUAL_COMBINATION),未传ComponentExtra,系统自动生成签批子控件.",
|
|
292
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowByFiles\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n }\n },\n \"FlowName\": \"文件发起-签批\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ORGANIZATION\",\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OpenId\": \"n9527\",\n \"Name\": \"典子谦\",\n \"Mobile\": \"13200000000\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"SignComponents\": [\n {\n \"FileIndex\": 0,\n \"GenerateMode\": \"KEYWORD\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"RelativeLocation\": \"Right\",\n \"ComponentId\": \"甲方（盖章）\",\n \"ComponentExtra\": \"{\\\"ChildrenComponents\\\":[{\\\"ComponentType\\\":\\\"SIGN_SIGNATURE\\\",\\\"ComponentName\\\":\\\"个人签名\\\",\\\"Placeholder\\\":\\\"请签名\\\",\\\"ComponentOffsetX\\\":10,\\\"ComponentOffsetY\\\":30,\\\"ComponentWidth\\\":119,\\\"ComponentHeight\\\":43,\\\"ComponentExtra\\\":\\\"{\\\\\\\"ComponentTypeLimit\\\\\\\":[\\\\\\\"SYSTEM_ESIGN\\\\\\\"]}\\\"},{\\\"ComponentType\\\":\\\"SIGN_SELECTOR\\\",\\\"ComponentName\\\":\\\"审批意见\\\",\\\"Placeholder\\\":\\\"\\\",\\\"ComponentOffsetX\\\":50,\\\"ComponentOffsetY\\\":130,\\\"ComponentWidth\\\":120,\\\"ComponentHeight\\\":43,\\\"ComponentExtra\\\":\\\"{\\\\\\\"Values\\\\\\\":[\\\\\\\"同意\\\\\\\",\\\\\\\"不同意\\\\\\\",\\\\\\\"待定\\\\\\\"],\\\\\\\"FontSize\\\\\\\":12,\\\\\\\"FontAlign\\\\\\\":\\\\\\\"Left\\\\\\\",\\\\\\\"Font\\\\\\\":\\\\\\\"黑体\\\\\\\",\\\\\\\"MultiSelect\\\\\\\":false}\\\"},{\\\"ComponentType\\\":\\\"SIGN_MULTI_LINE_TEXT\\\",\\\"ComponentName\\\":\\\"顺便留个言呗\\\",\\\"Placeholder\\\":\\\"\\\",\\\"ComponentOffsetX\\\":150,\\\"ComponentOffsetY\\\":300,\\\"ComponentWidth\\\":200,\\\"ComponentHeight\\\":86,\\\"ComponentExtra\\\":\\\"\\\"}]}\",\n \"ComponentHeight\": 234,\n \"ComponentPage\": 1,\n \"ComponentType\": \"SIGN_VIRTUAL_COMBINATION\",\n \"ComponentWidth\": 210,\n \"ComponentRequired\": false\n }\n ]\n },\n {\n \"ApproverType\": \"PERSON\",\n \"Name\": \"张三\",\n \"Mobile\": \"18888888888\",\n \"SignComponents\": [\n {\n \"FileIndex\": 0,\n \"GenerateMode\": \"KEYWORD\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"RelativeLocation\": \"Right\",\n \"ComponentId\": \"已方（盖章）\",\n \"ComponentHeight\": 234,\n \"ComponentPage\": 1,\n \"ComponentType\": \"SIGN_VIRTUAL_COMBINATION\",\n \"ComponentWidth\": 210,\n \"ComponentRequired\": false\n }\n ]\n }\n ],\n \"FileIds\": [\n \"yDCWqUUckpve5id3U4f5EL77tlNh6zTZ\"\n ],\n \"Unordered\": true\n}",
|
|
293
293
|
"output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCdoUUckp7ltep9Uyq2ikIypsCCIqXS\",\n \"SignId\": \"yDCdoUUckp7ltepxUyq2ikIE79iVjD2I\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCdoUUckp7ltep7Uyq2ikIuzVkVXNut\",\n \"SignId\": \"yDCdoUUckp7ltep4Uyq2ikI1baBbI9zJ\"\n }\n ],\n \"FlowId\": \"yDCdoUUckp7ltepfUyq2ikI8VC2s92zT\",\n \"RequestId\": \"s1732015258075060878\"\n }\n}",
|
|
294
294
|
"title": "文件发起 使用关键字定位 签署方含有签批控件"
|
|
295
295
|
}
|
|
@@ -1036,8 +1036,8 @@
|
|
|
1036
1036
|
"type": "int"
|
|
1037
1037
|
},
|
|
1038
1038
|
{
|
|
1039
|
-
"disabled":
|
|
1040
|
-
"document": "
|
|
1039
|
+
"disabled": true,
|
|
1040
|
+
"document": "参数已弃用，不用传参",
|
|
1041
1041
|
"example": "3edappId",
|
|
1042
1042
|
"member": "string",
|
|
1043
1043
|
"name": "MiniProgramAppId",
|
|
@@ -7349,7 +7349,7 @@
|
|
|
7349
7349
|
"document": "设备激活结果数据",
|
|
7350
7350
|
"members": [
|
|
7351
7351
|
{
|
|
7352
|
-
"disabled":
|
|
7352
|
+
"disabled": true,
|
|
7353
7353
|
"document": "模板ID\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
7354
7354
|
"example": "12374tg",
|
|
7355
7355
|
"member": "string",
|
|
@@ -9574,8 +9574,8 @@
|
|
|
9574
9574
|
"document": "GetTWeCallActiveStatus请求参数结构体",
|
|
9575
9575
|
"members": [
|
|
9576
9576
|
{
|
|
9577
|
-
"disabled":
|
|
9578
|
-
"document": "
|
|
9577
|
+
"disabled": true,
|
|
9578
|
+
"document": "参数已弃用，不用传参",
|
|
9579
9579
|
"example": "3edappId",
|
|
9580
9580
|
"member": "string",
|
|
9581
9581
|
"name": "MiniProgramAppId",
|
|
@@ -9620,12 +9620,12 @@
|
|
|
9620
9620
|
"document": "GetTWeCallPkgList请求参数结构体",
|
|
9621
9621
|
"members": [
|
|
9622
9622
|
{
|
|
9623
|
-
"disabled":
|
|
9623
|
+
"disabled": true,
|
|
9624
9624
|
"document": "appId",
|
|
9625
9625
|
"example": "3edappId",
|
|
9626
9626
|
"member": "string",
|
|
9627
9627
|
"name": "MiniProgramAppId",
|
|
9628
|
-
"required":
|
|
9628
|
+
"required": false,
|
|
9629
9629
|
"type": "string"
|
|
9630
9630
|
},
|
|
9631
9631
|
{
|
|
@@ -13289,7 +13289,7 @@
|
|
|
13289
13289
|
"document": "TWeCall设备激活信息",
|
|
13290
13290
|
"members": [
|
|
13291
13291
|
{
|
|
13292
|
-
"disabled":
|
|
13292
|
+
"disabled": true,
|
|
13293
13293
|
"document": "小程序ID\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
13294
13294
|
"example": "无",
|
|
13295
13295
|
"member": "string",
|
|
@@ -13375,8 +13375,8 @@
|
|
|
13375
13375
|
"value_allowed_null": true
|
|
13376
13376
|
},
|
|
13377
13377
|
{
|
|
13378
|
-
"disabled":
|
|
13379
|
-
"document": "小程序ID
|
|
13378
|
+
"disabled": true,
|
|
13379
|
+
"document": "小程序ID，参数已弃用，不用传参\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
13380
13380
|
"example": "无",
|
|
13381
13381
|
"member": "string",
|
|
13382
13382
|
"name": "ModelId",
|
|
@@ -13386,7 +13386,7 @@
|
|
|
13386
13386
|
"value_allowed_null": true
|
|
13387
13387
|
},
|
|
13388
13388
|
{
|
|
13389
|
-
"disabled":
|
|
13389
|
+
"disabled": true,
|
|
13390
13390
|
"document": "激活数\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
13391
13391
|
"example": "无",
|
|
13392
13392
|
"member": "int64",
|