tccli 3.0.1248.1__py2.py3-none-any.whl → 3.0.1250.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/aiart/aiart_client.py +113 -7
  3. tccli/services/aiart/v20221229/api.json +191 -0
  4. tccli/services/aiart/v20221229/examples.json +16 -0
  5. tccli/services/batch/v20170312/api.json +1 -1
  6. tccli/services/cbs/v20170312/api.json +6 -0
  7. tccli/services/cdb/v20170320/api.json +9 -0
  8. tccli/services/cfw/v20190904/api.json +5 -3
  9. tccli/services/cmq/cmq_client.py +4 -799
  10. tccli/services/cmq/v20190304/api.json +135 -1329
  11. tccli/services/cmq/v20190304/examples.json +0 -120
  12. tccli/services/config/config_client.py +110 -4
  13. tccli/services/config/v20220802/api.json +374 -0
  14. tccli/services/config/v20220802/examples.json +16 -0
  15. tccli/services/cvm/v20170312/api.json +1 -1
  16. tccli/services/dc/v20180410/api.json +50 -48
  17. tccli/services/dc/v20180410/examples.json +8 -8
  18. tccli/services/ecm/v20190719/api.json +64 -62
  19. tccli/services/ecm/v20190719/examples.json +5 -5
  20. tccli/services/es/v20180416/api.json +10 -0
  21. tccli/services/ess/v20201111/api.json +163 -163
  22. tccli/services/ess/v20201111/examples.json +15 -21
  23. tccli/services/essbasic/v20210526/api.json +89 -89
  24. tccli/services/essbasic/v20210526/examples.json +2 -2
  25. tccli/services/hai/hai_client.py +60 -7
  26. tccli/services/hai/v20230812/api.json +195 -0
  27. tccli/services/hai/v20230812/examples.json +8 -0
  28. tccli/services/iotexplorer/iotexplorer_client.py +228 -16
  29. tccli/services/iotexplorer/v20190423/api.json +536 -0
  30. tccli/services/iotexplorer/v20190423/examples.json +32 -0
  31. tccli/services/iotvideo/iotvideo_client.py +53 -0
  32. tccli/services/iotvideo/v20211125/api.json +80 -0
  33. tccli/services/iotvideo/v20211125/examples.json +8 -0
  34. tccli/services/lkeap/v20240522/api.json +13 -13
  35. tccli/services/lkeap/v20240522/examples.json +2 -2
  36. tccli/services/mna/v20210119/api.json +24 -24
  37. tccli/services/mna/v20210119/examples.json +2 -2
  38. tccli/services/redis/v20180412/api.json +181 -181
  39. tccli/services/redis/v20180412/examples.json +1 -1
  40. tccli/services/sms/v20190711/api.json +48 -0
  41. tccli/services/sms/v20210111/api.json +48 -0
  42. tccli/services/tcb/v20180608/api.json +173 -145
  43. tccli/services/tcb/v20180608/examples.json +8 -8
  44. tccli/services/tcr/v20190924/api.json +5 -5
  45. tccli/services/tke/v20220501/api.json +1 -1
  46. tccli/services/trro/v20220325/api.json +71 -61
  47. tccli/services/trro/v20220325/examples.json +1 -1
  48. tccli/services/trtc/v20190722/api.json +114 -114
  49. tccli/services/tse/v20201207/api.json +18 -0
  50. tccli/services/vpc/v20170312/api.json +35 -33
  51. tccli/services/vpc/v20170312/examples.json +18 -18
  52. tccli/services/wedata/v20210820/api.json +80 -2
  53. tccli/services/wedata/v20210820/examples.json +1 -1
  54. {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/METADATA +2 -2
  55. {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/RECORD +58 -58
  56. {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/WHEEL +0 -0
  57. {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/entry_points.txt +0 -0
  58. {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/license_files/LICENSE +0 -0
@@ -85,7 +85,7 @@
85
85
  "status": "online"
86
86
  },
87
87
  "CreateDocument": {
88
- "document": "创建签署流程电子文档<br />\n\n### 调用流程\n该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow\" target=\"_blank\">创建签署流程</a>和<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/StartFlow\" target=\"_blank\">发起签署流程</a>接口使用。具体逻辑可以参考下图:\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)\n\n\n### 填充模板中定义的填写控件\n模板中配置的<font color=\"red\">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)\n\n填充的传参示例如下\n\n```\n request.FormFields = [{\n \"ComponentName\": \"项目的名字\",\n \"ComponentValue\": \"休闲山庄\"\n }, {\n \"ComponentName\": \"项目的地址\",\n \"ComponentValue\": \"凤凰山北侧\",\n }, {\n \"ComponentName\": \"范围\",\n \"ComponentValue\": \"凤凰山至107国道\",\n }, {\n \"ComponentName\": \"面积\",\n \"ComponentValue\": \"100亩\",\n }, {\n \"ComponentName\": \"基本情况\",\n \"ComponentValue\": \"完好\",\n }, , {\n \"ComponentName\": \"用途\",\n \"ComponentValue\": \"经营农家乐\",\n }\n ]\n```\n合成后合同样子示例\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)",
88
+ "document": "创建签署流程电子文档<br />\n\n### 调用流程\n该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow\" target=\"_blank\">创建签署流程</a>和<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/StartFlow\" target=\"_blank\">发起签署流程</a>接口使用。具体逻辑可以参考下图:\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)\n\n\n### 填充模板中定义的填写控件\n模板中配置的<font color=\"red\">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充。\n\n**<font color=\"red\">填充填写控件需要进行Pdf合成工作,文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83),建议在收到此回调后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口。</font>**\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)\n\n填充的传参示例如下\n\n```\n request.FormFields = [{\n \"ComponentName\": \"项目的名字\",\n \"ComponentValue\": \"休闲山庄\"\n }, {\n \"ComponentName\": \"项目的地址\",\n \"ComponentValue\": \"凤凰山北侧\",\n }, {\n \"ComponentName\": \"范围\",\n \"ComponentValue\": \"凤凰山至107国道\",\n }, {\n \"ComponentName\": \"面积\",\n \"ComponentValue\": \"100亩\",\n }, {\n \"ComponentName\": \"基本情况\",\n \"ComponentValue\": \"完好\",\n }, , {\n \"ComponentName\": \"用途\",\n \"ComponentValue\": \"经营农家乐\",\n }\n ]\n```\n合成后合同样子示例\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)",
89
89
  "input": "CreateDocumentRequest",
90
90
  "name": "模板发起合同-创建电子文档",
91
91
  "output": "CreateDocumentResponse",
@@ -470,7 +470,7 @@
470
470
  "status": "online"
471
471
  },
472
472
  "DescribeFlowComponents": {
473
- "document": "可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的具体内容。\n\n\n如下图模板所示,发起后对方填写后,可以获取红框中用户填写的信息。\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)",
473
+ "document": "您可以通过合同流程ID查询相关的<font color=\"red\"><b>填写控件</b></font>信息及其内容。这包括控件的归属方、控件的填写状态(是否已填写)以及具体的填写内容。\n\n无论是发起方还是签署方填写的控件,均包含在查询结果中。\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)\n\n\n### 2. 那些控件会出现在结果里边? \n**A.不返回的控件类型:**\n- 动态表格\n- 附件控件\n- 水印控件\n\n**B.返回的控件类型:**\n- 单行文本\n- 多行文本\n- 勾选框控件\n- 数字控件\n- 日期控件\n- 图片控件(图片下载地址)\n- 邮箱控件\n- 地址控件\n- 学历控件\n- 性别控件\n- 省市区控件",
474
474
  "input": "DescribeFlowComponentsRequest",
475
475
  "name": "查询合同的填写控件信息",
476
476
  "output": "DescribeFlowComponentsResponse",
@@ -3037,7 +3037,7 @@
3037
3037
  {
3038
3038
  "disabled": false,
3039
3039
  "document": "用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。\n\n[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/253071cc2f7becb063c7cf71b37b7861.png)",
3040
- "example": "",
3040
+ "example": "yDCj7UUckp4b4ga6UCJQtCwIZllHtJ6B",
3041
3041
  "member": "string",
3042
3042
  "name": "TemplateId",
3043
3043
  "required": true,
@@ -3046,7 +3046,7 @@
3046
3046
  {
3047
3047
  "disabled": false,
3048
3048
  "document": "合同流程ID,为32位字符串。\n此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。",
3049
- "example": "",
3049
+ "example": "yDCVNUUckpw3nnnyUVScgTvSA1IaZgM7",
3050
3050
  "member": "string",
3051
3051
  "name": "FlowId",
3052
3052
  "required": false,
@@ -3055,7 +3055,7 @@
3055
3055
  {
3056
3056
  "disabled": false,
3057
3057
  "document": "文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。",
3058
- "example": "",
3058
+ "example": "[\"入职合同\"]",
3059
3059
  "member": "string",
3060
3060
  "name": "FileNames",
3061
3061
  "required": false,
@@ -3073,7 +3073,7 @@
3073
3073
  {
3074
3074
  "disabled": false,
3075
3075
  "document": "是否为预览模式,取值如下:\n<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li> \n<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color=\"red\">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font> </li></ul>\n注: `当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,动态表格合成完后会触发文档合成完成的回调通知`",
3076
- "example": "",
3076
+ "example": "false",
3077
3077
  "member": "bool",
3078
3078
  "name": "NeedPreview",
3079
3079
  "required": false,
@@ -3082,7 +3082,7 @@
3082
3082
  {
3083
3083
  "disabled": false,
3084
3084
  "document": "预览模式下产生的预览链接类型 \n<ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>\n<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子。</li></ul>\n注: `1.此参数在NeedPreview 为true时有效`\n`2.动态表格控件不支持H5链接方式预览`",
3085
- "example": "",
3085
+ "example": "0",
3086
3086
  "member": "int64",
3087
3087
  "name": "PreviewType",
3088
3088
  "required": false,
@@ -3100,7 +3100,7 @@
3100
3100
  {
3101
3101
  "disabled": false,
3102
3102
  "document": "已废弃字段,客户端Token,保持接口幂等性,最大长度64个字符",
3103
- "example": "",
3103
+ "example": "yDSLMUUckpotxh18UEnJP33SwMj5LRdW",
3104
3104
  "member": "string",
3105
3105
  "name": "ClientToken",
3106
3106
  "required": false,
@@ -3124,23 +3124,23 @@
3124
3124
  },
3125
3125
  {
3126
3126
  "disabled": false,
3127
- "document": "合同预览链接URL。\n\n注: `1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL`\n`2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`\n注意:此字段可能返回 null,表示取不到有效值。",
3128
- "example": "",
3127
+ "document": "合同预览链接URL。\n\n注: `1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL`\n`2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,完整的预览链接需通过[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)获取。",
3128
+ "example": "https://qian.tencent.cn/4d0d6929-0b40",
3129
3129
  "member": "string",
3130
3130
  "name": "PreviewFileUrl",
3131
3131
  "output_required": true,
3132
3132
  "type": "string",
3133
- "value_allowed_null": true
3133
+ "value_allowed_null": false
3134
3134
  },
3135
3135
  {
3136
3136
  "disabled": false,
3137
- "document": "签署方信息,如角色ID、角色名称等\n注意:此字段可能返回 null,表示取不到有效值。",
3137
+ "document": "签署方信息,如角色ID、角色名称等",
3138
3138
  "example": "无",
3139
3139
  "member": "ApproverItem",
3140
3140
  "name": "Approvers",
3141
3141
  "output_required": false,
3142
3142
  "type": "list",
3143
- "value_allowed_null": true
3143
+ "value_allowed_null": false
3144
3144
  },
3145
3145
  {
3146
3146
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -3458,7 +3458,7 @@
3458
3458
  {
3459
3459
  "disabled": false,
3460
3460
  "document": "合同流程ID,为32位字符串。\n- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n- 可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。\n- <font color=\"red\">不建议继续使用</font>,请使用<a href=\"https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId来指定需要补充的合同id",
3461
- "example": "",
3461
+ "example": "yDtwLUUckp79ltk3UETpdnTykAcZdrFZ",
3462
3462
  "member": "string",
3463
3463
  "name": "FlowId",
3464
3464
  "required": false,
@@ -3467,7 +3467,7 @@
3467
3467
  {
3468
3468
  "disabled": false,
3469
3469
  "document": "签署人信息补充方式\n\n<ul><li>**0**: <font color=\"red\">或签合同</font>添加签署候选人,或签支持一个节点传多个签署人,不传值默认或签。\n注: `或签只支持企业签署方`</li>\n<li>**1**: <font color=\"red\">动态签署人合同</font>的添加签署候选人,支持企业或个人签署方。</li></ul>",
3470
- "example": "",
3470
+ "example": "0",
3471
3471
  "member": "int64",
3472
3472
  "name": "FillApproverType",
3473
3473
  "required": false,
@@ -3476,7 +3476,7 @@
3476
3476
  {
3477
3477
  "disabled": false,
3478
3478
  "document": "在可定制的企业微信通知中,发起人可以根据具体需求进行自定义设置。",
3479
- "example": "",
3479
+ "example": "总部集团",
3480
3480
  "member": "string",
3481
3481
  "name": "Initiator",
3482
3482
  "required": false,
@@ -3508,13 +3508,13 @@
3508
3508
  "members": [
3509
3509
  {
3510
3510
  "disabled": false,
3511
- "document": "批量补充签署人时,补充失败的报错说明\n\n注:`目前仅补充动态签署人时会返回补充失败的原因`\n注意:此字段可能返回 null,表示取不到有效值。",
3511
+ "document": "批量补充签署人时,补充失败的报错说明\n\n注:`目前仅补充动态签署人时会返回补充失败的原因`",
3512
3512
  "example": "无",
3513
3513
  "member": "FillError",
3514
3514
  "name": "FillError",
3515
3515
  "output_required": false,
3516
3516
  "type": "list",
3517
- "value_allowed_null": true
3517
+ "value_allowed_null": false
3518
3518
  },
3519
3519
  {
3520
3520
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -3828,7 +3828,7 @@
3828
3828
  {
3829
3829
  "disabled": false,
3830
3830
  "document": "合同流程ID,为32位字符串。\n建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n\n注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。\n\n[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
3831
- "example": "",
3831
+ "example": "yDtwLUUckp79lzviUuBHsZJEXIiDDqEV",
3832
3832
  "member": "string",
3833
3833
  "name": "FlowId",
3834
3834
  "output_required": true,
@@ -3837,23 +3837,23 @@
3837
3837
  },
3838
3838
  {
3839
3839
  "disabled": false,
3840
- "document": "合同预览链接URL。\n\n注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL\n注意:此字段可能返回 null,表示取不到有效值。",
3841
- "example": "",
3840
+ "document": "合同预览链接URL。\n\n注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL",
3841
+ "example": "https://qian.tencent.com/1234.jpg",
3842
3842
  "member": "string",
3843
3843
  "name": "PreviewUrl",
3844
3844
  "output_required": true,
3845
3845
  "type": "string",
3846
- "value_allowed_null": true
3846
+ "value_allowed_null": false
3847
3847
  },
3848
3848
  {
3849
3849
  "disabled": false,
3850
- "document": "签署方信息,如角色ID、角色名称等\n注意:此字段可能返回 null,表示取不到有效值。",
3850
+ "document": "签署方信息,如角色ID、角色名称等",
3851
3851
  "example": "无",
3852
3852
  "member": "ApproverItem",
3853
3853
  "name": "Approvers",
3854
3854
  "output_required": false,
3855
3855
  "type": "list",
3856
- "value_allowed_null": true
3856
+ "value_allowed_null": false
3857
3857
  },
3858
3858
  {
3859
3859
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -3879,7 +3879,7 @@
3879
3879
  {
3880
3880
  "disabled": false,
3881
3881
  "document": "合同流程ID,为32位字符串。\n可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
3882
- "example": "",
3882
+ "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8",
3883
3883
  "member": "string",
3884
3884
  "name": "FlowId",
3885
3885
  "required": true,
@@ -3911,13 +3911,13 @@
3911
3911
  "members": [
3912
3912
  {
3913
3913
  "disabled": false,
3914
- "document": "出证报告 ID,可用于<a href=\"https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport\" target=\"_blank\">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL\n注意:此字段可能返回 null,表示取不到有效值。",
3914
+ "document": "出证报告 ID,可用于<a href=\"https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport\" target=\"_blank\">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL",
3915
3915
  "example": "yDx************************AyF",
3916
3916
  "member": "string",
3917
3917
  "name": "ReportId",
3918
3918
  "output_required": true,
3919
3919
  "type": "string",
3920
- "value_allowed_null": true
3920
+ "value_allowed_null": false
3921
3921
  },
3922
3922
  {
3923
3923
  "disabled": false,
@@ -3932,7 +3932,7 @@
3932
3932
  {
3933
3933
  "disabled": true,
3934
3934
  "document": "此字段已经废除,不再使用.\n出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取\n注意:此字段可能返回 null,表示取不到有效值。",
3935
- "example": "https://file.xxx",
3935
+ "example": "https://file.cn/1.pdf",
3936
3936
  "member": "string",
3937
3937
  "name": "ReportUrl",
3938
3938
  "output_required": true,
@@ -4056,7 +4056,7 @@
4056
4056
  {
4057
4057
  "disabled": false,
4058
4058
  "document": "合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。",
4059
- "example": "",
4059
+ "example": "蔬菜采购",
4060
4060
  "member": "string",
4061
4061
  "name": "FlowGroupName",
4062
4062
  "required": true,
@@ -4097,23 +4097,23 @@
4097
4097
  "members": [
4098
4098
  {
4099
4099
  "disabled": false,
4100
- "document": "合同(流程)组的合同组Id\n注意:此字段可能返回 null,表示取不到有效值。",
4101
- "example": "",
4100
+ "document": "合同(流程)组的合同组Id",
4101
+ "example": "yDRSRUUgygj6qnyvUuO4zjE1vLuGdWjL",
4102
4102
  "member": "string",
4103
4103
  "name": "FlowGroupId",
4104
4104
  "output_required": true,
4105
4105
  "type": "string",
4106
- "value_allowed_null": true
4106
+ "value_allowed_null": false
4107
4107
  },
4108
4108
  {
4109
4109
  "disabled": false,
4110
- "document": "合同(流程)组中子合同列表.\n注意:此字段可能返回 null,表示取不到有效值。",
4111
- "example": "",
4110
+ "document": "合同(流程)组中子合同列表.",
4111
+ "example": "[\"yDw6yUUgyg3caowzUx4GQptRKfMnJqX8\"]",
4112
4112
  "member": "string",
4113
4113
  "name": "FlowIds",
4114
4114
  "output_required": true,
4115
4115
  "type": "list",
4116
- "value_allowed_null": true
4116
+ "value_allowed_null": false
4117
4117
  },
4118
4118
  {
4119
4119
  "disabled": false,
@@ -4426,7 +4426,7 @@
4426
4426
  {
4427
4427
  "disabled": false,
4428
4428
  "document": "合同流程描述信息(可自定义此描述),最大长度1000个字符。",
4429
- "example": "",
4429
+ "example": "2025年张三劳务合同",
4430
4430
  "member": "string",
4431
4431
  "name": "FlowDescription",
4432
4432
  "required": false,
@@ -4444,7 +4444,7 @@
4444
4444
  {
4445
4445
  "disabled": false,
4446
4446
  "document": "已经废弃字段,客户端Token,保持接口幂等性,最大长度64个字符",
4447
- "example": "",
4447
+ "example": "cdMyoi1W6hm99",
4448
4448
  "member": "string",
4449
4449
  "name": "ClientToken",
4450
4450
  "required": false,
@@ -4462,7 +4462,7 @@
4462
4462
  {
4463
4463
  "disabled": false,
4464
4464
  "document": "合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。\n\n到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。",
4465
- "example": "",
4465
+ "example": "1604912664",
4466
4466
  "member": "int64",
4467
4467
  "name": "RemindedOn",
4468
4468
  "required": false,
@@ -4471,7 +4471,7 @@
4471
4471
  {
4472
4472
  "disabled": false,
4473
4473
  "document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href=\"https://qian.tencent.com/developers/company/callback_types_v2\" target=\"_blank\">回调通知</a>模块。",
4474
- "example": "",
4474
+ "example": "55So5oi355qE5pWw5o2u",
4475
4475
  "member": "string",
4476
4476
  "name": "UserData",
4477
4477
  "required": false,
@@ -4534,7 +4534,7 @@
4534
4534
  {
4535
4535
  "disabled": true,
4536
4536
  "document": "暂未开放",
4537
- "example": "xxx",
4537
+ "example": "yDCjqUUckp4ts9piUrpXRFRicu5rxxHl",
4538
4538
  "member": "string",
4539
4539
  "name": "RelatedFlowId",
4540
4540
  "required": false,
@@ -4543,7 +4543,7 @@
4543
4543
  {
4544
4544
  "disabled": true,
4545
4545
  "document": "暂未开放",
4546
- "example": "",
4546
+ "example": "https://callback.qq.com/calback.php",
4547
4547
  "member": "string",
4548
4548
  "name": "CallbackUrl",
4549
4549
  "required": false,
@@ -4567,7 +4567,7 @@
4567
4567
  {
4568
4568
  "disabled": false,
4569
4569
  "document": "合同流程ID,为32位字符串。\n建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n\n注:\n此返回的合同流程ID,需再次调用<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument\" target=\"_blank\">创建电子文档</a>和<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/StartFlow\" target=\"_blank\">发起签署流程</a>接口将合同开始后,合同才能进入签署环节,[点击查看FlowId在控制台中的位置(只在进入签署环节后有效)](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)\n\n",
4570
- "example": "",
4570
+ "example": "yDSLHUUckpoy5mxuUxI88twxivJGeqf5",
4571
4571
  "member": "string",
4572
4572
  "name": "FlowId",
4573
4573
  "output_required": true,
@@ -5998,7 +5998,7 @@
5998
5998
  {
5999
5999
  "disabled": false,
6000
6000
  "document": "个人用户名称",
6001
- "example": "",
6001
+ "example": "张三",
6002
6002
  "member": "string",
6003
6003
  "name": "UserName",
6004
6004
  "required": true,
@@ -6007,7 +6007,7 @@
6007
6007
  {
6008
6008
  "disabled": false,
6009
6009
  "document": "证件类型,支持以下类型\n<ul><li> ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li> HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li> HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
6010
- "example": "",
6010
+ "example": "ID_CARD ",
6011
6011
  "member": "string",
6012
6012
  "name": "IdCardType",
6013
6013
  "required": true,
@@ -6016,7 +6016,7 @@
6016
6016
  {
6017
6017
  "disabled": false,
6018
6018
  "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
6019
- "example": "",
6019
+ "example": "620000198802020000",
6020
6020
  "member": "string",
6021
6021
  "name": "IdCardNumber",
6022
6022
  "required": true,
@@ -6058,43 +6058,43 @@
6058
6058
  },
6059
6059
  {
6060
6060
  "disabled": false,
6061
- "document": "个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。\n该编号会合成到个人用户证书证明图片。\n\n注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`\n注意:此字段可能返回 null,表示取不到有效值。",
6061
+ "document": "个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。\n该编号会合成到个人用户证书证明图片。\n\n注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`",
6062
6062
  "example": "23090411***877319694",
6063
6063
  "member": "string",
6064
6064
  "name": "ImageCertId",
6065
6065
  "output_required": false,
6066
6066
  "type": "string",
6067
- "value_allowed_null": true
6067
+ "value_allowed_null": false
6068
6068
  },
6069
6069
  {
6070
6070
  "disabled": false,
6071
- "document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。\n注意:此字段可能返回 null,表示取不到有效值。",
6071
+ "document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。",
6072
6072
  "example": "2206EB**4597742",
6073
6073
  "member": "string",
6074
6074
  "name": "SerialNumber",
6075
6075
  "output_required": false,
6076
6076
  "type": "string",
6077
- "value_allowed_null": true
6077
+ "value_allowed_null": false
6078
6078
  },
6079
6079
  {
6080
6080
  "disabled": false,
6081
- "document": "CA证书颁发时间,格式为Unix标准时间戳(秒) \n该时间格式化后会合成到个人用户证书证明图片\n注意:此字段可能返回 null,表示取不到有效值。",
6082
- "example": "",
6081
+ "document": "CA证书颁发时间,格式为Unix标准时间戳(秒) \n该时间格式化后会合成到个人用户证书证明图片",
6082
+ "example": "1736409770",
6083
6083
  "member": "uint64",
6084
6084
  "name": "ValidFrom",
6085
6085
  "output_required": false,
6086
6086
  "type": "int",
6087
- "value_allowed_null": true
6087
+ "value_allowed_null": false
6088
6088
  },
6089
6089
  {
6090
6090
  "disabled": false,
6091
- "document": "CA证书有效截止时间,格式为Unix标准时间戳(秒)\n该时间格式化后会合成到个人用户证书证明图片\n注意:此字段可能返回 null,表示取不到有效值。",
6092
- "example": "",
6091
+ "document": "CA证书有效截止时间,格式为Unix标准时间戳(秒)\n该时间格式化后会合成到个人用户证书证明图片",
6092
+ "example": "1736410075",
6093
6093
  "member": "uint64",
6094
6094
  "name": "ValidTo",
6095
6095
  "output_required": false,
6096
6096
  "type": "int",
6097
- "value_allowed_null": true
6097
+ "value_allowed_null": false
6098
6098
  },
6099
6099
  {
6100
6100
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -7006,7 +7006,7 @@
7006
7006
  {
7007
7007
  "disabled": false,
7008
7008
  "document": "通过文件上传时,服务端生成的电子印章上传图片的token\n",
7009
- "example": "",
7009
+ "example": "4GQptRKfMnJqX8",
7010
7010
  "member": "string",
7011
7011
  "name": "FileToken",
7012
7012
  "required": false,
@@ -7033,7 +7033,7 @@
7033
7033
  {
7034
7034
  "disabled": false,
7035
7035
  "document": "企业税号\n注:\n<ul>\n<li>1.印章类型SealType是INVOICE类型时,此参数才会生效</li>\n<li>2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号(<font color=\"red\">如果是通过授权书授权方式认证的企业,此参数必传不能为空</font>)</li>\n</ul>",
7036
- "example": "",
7036
+ "example": "lvCCkIZsXxFY",
7037
7037
  "member": "string",
7038
7038
  "name": "TaxIdentifyCode",
7039
7039
  "required": false,
@@ -7132,7 +7132,7 @@
7132
7132
  {
7133
7133
  "disabled": false,
7134
7134
  "document": "是否通知开通方,通知类型:<ul><li>默认为不通知开通方</li><li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>",
7135
- "example": "",
7135
+ "example": "SMS",
7136
7136
  "member": "string",
7137
7137
  "name": "NotifyType",
7138
7138
  "required": false,
@@ -7168,7 +7168,7 @@
7168
7168
  {
7169
7169
  "disabled": false,
7170
7170
  "document": "调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中,该字段的信息将原封不动地透传给贵方。 ",
7171
- "example": "",
7171
+ "example": "自定义数据",
7172
7172
  "member": "string",
7173
7173
  "name": "UserData",
7174
7174
  "required": false,
@@ -7193,7 +7193,7 @@
7193
7193
  {
7194
7194
  "disabled": false,
7195
7195
  "document": "腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用\n\n注: `如果获取的是H5链接, 则不会返回此值`",
7196
- "example": "",
7196
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
7197
7197
  "member": "string",
7198
7198
  "name": "AppId",
7199
7199
  "output_required": true,
@@ -7203,7 +7203,7 @@
7203
7203
  {
7204
7204
  "disabled": false,
7205
7205
  "document": "腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用\n\n注: `如果获取的是H5链接, 则不会返回此值`",
7206
- "example": "",
7206
+ "example": "gh_39a5d3de69fa",
7207
7207
  "member": "string",
7208
7208
  "name": "AppOriginalId",
7209
7209
  "output_required": true,
@@ -7213,7 +7213,7 @@
7213
7213
  {
7214
7214
  "disabled": false,
7215
7215
  "document": "腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用\n\n注: `如果获取的是H5链接, 则不会返回此值`",
7216
- "example": "",
7216
+ "example": "https://essurl.cn/x9nvWU8fTg",
7217
7217
  "member": "string",
7218
7218
  "name": "Path",
7219
7219
  "output_required": true,
@@ -7223,7 +7223,7 @@
7223
7223
  {
7224
7224
  "disabled": false,
7225
7225
  "document": "base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。\n\n注: `如果获取的是H5链接, 则不会返回此二维码图片`",
7226
- "example": "",
7226
+ "example": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW==",
7227
7227
  "member": "string",
7228
7228
  "name": "QrCode",
7229
7229
  "output_required": true,
@@ -7455,7 +7455,7 @@
7455
7455
  {
7456
7456
  "disabled": false,
7457
7457
  "document": "腾讯电子签小程序的实名认证链接。 如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。\n\n<b>1.如果EndPoint是APP</b>,\n得到的链接类似于<a href=\"\">pages/guide/index?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n<b>2.如果EndPoint是HTTP</b>,\n得到的链接类似于<a href=\"\">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署\n\n<b>3.如果EndPoint是HTTP_SHORT_URL</b>,\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署\n\n注: <font color=\"red\">生成的链路后面不能再增加参数</font>\n",
7458
- "example": "",
7458
+ "example": "https://essurl.cn/2n**42Nd",
7459
7459
  "member": "string",
7460
7460
  "name": "Url",
7461
7461
  "output_required": false,
@@ -7465,7 +7465,7 @@
7465
7465
  {
7466
7466
  "disabled": false,
7467
7467
  "document": "链接失效期限,为Unix时间戳(单位秒),有如下规则:\n\n<ul>\n<li>如果指定更换绑定手机号的用户(指定用户ID或姓名等信息),则设定的链接失效期限为7天后。</li>\n<li>如果没有指定更换绑定手机号的用户,则生成通用跳转到个人换手机号的界面,链接不会过期。</li>\n</ul>",
7468
- "example": "",
7468
+ "example": "1736416473",
7469
7469
  "member": "int64",
7470
7470
  "name": "ExpireTime",
7471
7471
  "output_required": false,
@@ -7496,7 +7496,7 @@
7496
7496
  {
7497
7497
  "disabled": false,
7498
7498
  "document": "要实名的姓名",
7499
- "example": "",
7499
+ "example": "真实姓名",
7500
7500
  "member": "string",
7501
7501
  "name": "Name",
7502
7502
  "required": false,
@@ -7505,7 +7505,7 @@
7505
7505
  {
7506
7506
  "disabled": false,
7507
7507
  "document": "要实名的身份证号码,\n身份证号码如果有x的话,统一传大写X",
7508
- "example": "",
7508
+ "example": "420520****8738",
7509
7509
  "member": "string",
7510
7510
  "name": "IdCardNumber",
7511
7511
  "required": false,
@@ -7514,7 +7514,7 @@
7514
7514
  {
7515
7515
  "disabled": false,
7516
7516
  "document": "证件类型,目前只支持身份证类型:ID_CARD",
7517
- "example": "",
7517
+ "example": "ID_CARD",
7518
7518
  "member": "string",
7519
7519
  "name": "IdCardType",
7520
7520
  "required": false,
@@ -7523,7 +7523,7 @@
7523
7523
  {
7524
7524
  "disabled": false,
7525
7525
  "document": "要实名的手机号,兼容带+86的格式",
7526
- "example": "",
7526
+ "example": "187****9032",
7527
7527
  "member": "string",
7528
7528
  "name": "Mobile",
7529
7529
  "required": false,
@@ -7532,7 +7532,7 @@
7532
7532
  {
7533
7533
  "disabled": false,
7534
7534
  "document": "实名完之后的跳转链接,最大长度1000个字符。\n链接类型请参考 <a href=\"https://qian.tencent.com/developers/company/openqianh5\" target=\"_blank\">跳转电子签H5</a>。\n\n注:此参数仅支持 Endpoint 为 <font color=\"red\">H5 或 H5_SHORT_URL </font>的时候传递\n",
7535
- "example": "",
7535
+ "example": "https://essurl.cn/x9nvWU8fTg",
7536
7536
  "member": "string",
7537
7537
  "name": "JumpUrl",
7538
7538
  "required": false,
@@ -7550,7 +7550,7 @@
7550
7550
  {
7551
7551
  "disabled": false,
7552
7552
  "document": "签署完成后是否自动回跳\n<ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul>\n\n注: \n1. 该参数<font color=\"red\">只针对APP类型(第三方APP或小程序跳转电子签小程序)场景</font> 的实名链接有效\n2. <font color=\"red\">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)\n3. <font color=\"red\">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font> ",
7553
- "example": "",
7553
+ "example": "false",
7554
7554
  "member": "bool",
7555
7555
  "name": "AutoJumpBack",
7556
7556
  "required": false,
@@ -7574,7 +7574,7 @@
7574
7574
  {
7575
7575
  "disabled": false,
7576
7576
  "document": "腾讯电子签小程序的实名认证链接。\n如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。\n\n<strong>1.如果EndPoint是APP</strong>:\n得到的链接类似于<a href=\"\">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n<strong>2.如果EndPoint是HTTP</strong>:\n得到的链接类似于 <a href=\"\">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署\n\n<strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署\n\n<strong>4.如果EndPoint是H5</strong>:\n得到的链接类似于 <a href=\"\">https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb</a>,点击后会跳转到腾讯电子签H5页面进行签署\n\n<strong>5.如果EndPoint是H5_SHORT_URL</strong>:\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签H5页面进行签署\n\n\n`注:` <font color=\"red\">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font>\n示例值:https://essurl.cn/2n**42Nd",
7577
- "example": "",
7577
+ "example": "https://essurl.cn/2n**42Nd",
7578
7578
  "member": "string",
7579
7579
  "name": "UserVerifyUrl",
7580
7580
  "output_required": true,
@@ -7584,7 +7584,7 @@
7584
7584
  {
7585
7585
  "disabled": false,
7586
7586
  "document": "链接过期时间,为Unix时间戳(单位为秒)。",
7587
- "example": "",
7587
+ "example": "1736416390",
7588
7588
  "member": "int64",
7589
7589
  "name": "ExpireTime",
7590
7590
  "output_required": true,
@@ -7594,7 +7594,7 @@
7594
7594
  {
7595
7595
  "disabled": false,
7596
7596
  "document": "小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回",
7597
- "example": "",
7597
+ "example": "gh_da88f6188665",
7598
7598
  "member": "string",
7599
7599
  "name": "MiniAppId",
7600
7600
  "output_required": true,
@@ -7625,7 +7625,7 @@
7625
7625
  {
7626
7626
  "disabled": false,
7627
7627
  "document": "主题类型,取值如下:\n<ul><li> **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置</li>\n</ul>",
7628
- "example": "",
7628
+ "example": "EMBED_WEB_THEME",
7629
7629
  "member": "string",
7630
7630
  "name": "ThemeType",
7631
7631
  "required": true,
@@ -7679,7 +7679,7 @@
7679
7679
  {
7680
7680
  "disabled": false,
7681
7681
  "document": "本企业员工的id,需要已实名,正常在职员工",
7682
- "example": "",
7682
+ "example": "yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E",
7683
7683
  "member": "string",
7684
7684
  "name": "UserIds",
7685
7685
  "required": true,
@@ -7733,7 +7733,7 @@
7733
7733
  {
7734
7734
  "disabled": false,
7735
7735
  "document": "电子签中的部门ID,通过<a href=\"https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments\" target=\"_blank\">DescribeIntegrationDepartments</a>接口可获得。",
7736
- "example": "",
7736
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
7737
7737
  "member": "string",
7738
7738
  "name": "DeptId",
7739
7739
  "required": true,
@@ -7751,7 +7751,7 @@
7751
7751
  {
7752
7752
  "disabled": false,
7753
7753
  "document": "交接部门ID。\n待删除部门中的合同、印章和模板数据,将会被交接至该部门ID下;若未填写则交接至公司根部门。",
7754
- "example": "",
7754
+ "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84",
7755
7755
  "member": "string",
7756
7756
  "name": "ReceiveDeptId",
7757
7757
  "required": false,
@@ -7842,7 +7842,7 @@
7842
7842
  {
7843
7843
  "disabled": false,
7844
7844
  "document": "角色id,可以通过DescribeIntegrationRoles接口获取角色信息",
7845
- "example": "",
7845
+ "example": "yDSxWUUckptu4clgUuLlo0OwJKbYCO48",
7846
7846
  "member": "string",
7847
7847
  "name": "RoleId",
7848
7848
  "required": true,
@@ -7875,7 +7875,7 @@
7875
7875
  {
7876
7876
  "disabled": false,
7877
7877
  "document": "角色id",
7878
- "example": "",
7878
+ "example": "yDSxWUUckptu4clgUuLlo0OwJKbYCO48",
7879
7879
  "member": "string",
7880
7880
  "name": "RoleId",
7881
7881
  "output_required": true,
@@ -8025,7 +8025,7 @@
8025
8025
  {
8026
8026
  "disabled": false,
8027
8027
  "document": "印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填",
8028
- "example": "",
8028
+ "example": "yDSxWUUckptu4clgUuLlo0OwJKbYCO48",
8029
8029
  "member": "string",
8030
8030
  "name": "PolicyIds",
8031
8031
  "required": false,
@@ -8034,7 +8034,7 @@
8034
8034
  {
8035
8035
  "disabled": false,
8036
8036
  "document": "电子印章ID,为32位字符串。\n建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。\n可登录腾讯电子签控制台,在 \"印章\"->\"印章中心\"选择查看的印章,在\"印章详情\" 中查看某个印章的SealId(在页面中展示为印章ID)。\n注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。",
8037
- "example": "",
8037
+ "example": "yDCZHUUnitvronUuNTdBrElW0gOVqCfy",
8038
8038
  "member": "string",
8039
8039
  "name": "SealId",
8040
8040
  "required": false,
@@ -8043,7 +8043,7 @@
8043
8043
  {
8044
8044
  "disabled": false,
8045
8045
  "document": "待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。\n可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查看某位员工的UserId(在页面中展示为用户ID)。",
8046
- "example": "",
8046
+ "example": "yDwcCUUgyg3tgmvhUEVzyNa15Zayy6Sf",
8047
8047
  "member": "string",
8048
8048
  "name": "UserIds",
8049
8049
  "required": false,
@@ -8142,7 +8142,7 @@
8142
8142
  {
8143
8143
  "disabled": false,
8144
8144
  "document": "通过接口CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任得到的任务Id",
8145
- "example": "",
8145
+ "example": "yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E",
8146
8146
  "member": "string",
8147
8147
  "name": "TaskId",
8148
8148
  "required": true,
@@ -8331,13 +8331,13 @@
8331
8331
  },
8332
8332
  {
8333
8333
  "disabled": false,
8334
- "document": "集团子企业套餐使用情况\n注意:此字段可能返回 null,表示取不到有效值。",
8334
+ "document": "集团子企业套餐使用情况",
8335
8335
  "example": "无",
8336
8336
  "member": "SubOrgBillSummary",
8337
8337
  "name": "SubOrgSummary",
8338
8338
  "output_required": true,
8339
8339
  "type": "list",
8340
- "value_allowed_null": true
8340
+ "value_allowed_null": false
8341
8341
  },
8342
8342
  {
8343
8343
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -8363,7 +8363,7 @@
8363
8363
  {
8364
8364
  "disabled": false,
8365
8365
  "document": "批量撤销任务编号,为32位字符串,通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。",
8366
- "example": "无",
8366
+ "example": "无yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E",
8367
8367
  "member": "string",
8368
8368
  "name": "TaskId",
8369
8369
  "required": true,
@@ -8387,7 +8387,7 @@
8387
8387
  {
8388
8388
  "disabled": false,
8389
8389
  "document": "批量撤销任务编号,为32位字符串,通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。",
8390
- "example": "",
8390
+ "example": "yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E",
8391
8391
  "member": "string",
8392
8392
  "name": "TaskId",
8393
8393
  "output_required": true,
@@ -8397,7 +8397,7 @@
8397
8397
  {
8398
8398
  "disabled": false,
8399
8399
  "document": "任务状态,需要关注的状态\n<ul><li>**PROCESSING** - 任务执行中</li>\n<li>**END** - 任务处理完成</li>\n<li>**TIMEOUT** 任务超时未处理完成,用户未在批量撤销链接有效期内操作</li></ul>",
8400
- "example": "",
8400
+ "example": "PROCESSING",
8401
8401
  "member": "string",
8402
8402
  "name": "TaskStatus",
8403
8403
  "output_required": true,
@@ -8407,7 +8407,7 @@
8407
8407
  {
8408
8408
  "disabled": false,
8409
8409
  "document": "批量撤销成功的签署流程编号",
8410
- "example": "",
8410
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
8411
8411
  "member": "string",
8412
8412
  "name": "SuccessFlowIds",
8413
8413
  "output_required": true,
@@ -8448,7 +8448,7 @@
8448
8448
  {
8449
8449
  "disabled": false,
8450
8450
  "document": "要查询的扩展服务类型。\n如下所示:\n<ul><li>OPEN_SERVER_SIGN:企业静默签署</li>\n<li>BATCH_SIGN:批量签署</li>\n</ul>\n",
8451
- "example": "\"\"",
8451
+ "example": "OPEN_SERVER_SIGN",
8452
8452
  "member": "string",
8453
8453
  "name": "ExtendServiceType",
8454
8454
  "required": false,
@@ -8466,7 +8466,7 @@
8466
8466
  {
8467
8467
  "disabled": false,
8468
8468
  "document": "指定每页返回的数据条数,和Offset参数配合使用。 注:`1.默认值为20,单页做大值为200。`\t",
8469
- "example": "",
8469
+ "example": "10",
8470
8470
  "member": "int64",
8471
8471
  "name": "Limit",
8472
8472
  "required": false,
@@ -8475,7 +8475,7 @@
8475
8475
  {
8476
8476
  "disabled": false,
8477
8477
  "document": "查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。 注:`1.offset从0开始,即第一页为0。` `2.默认从第一页返回。`\t",
8478
- "example": "",
8478
+ "example": "0",
8479
8479
  "member": "int64",
8480
8480
  "name": "Offset",
8481
8481
  "required": false,
@@ -8768,7 +8768,7 @@
8768
8768
  {
8769
8769
  "disabled": false,
8770
8770
  "document": "合同流程ID,为32位字符串。\n\n[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
8771
- "example": "",
8771
+ "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8",
8772
8772
  "member": "string",
8773
8773
  "name": "FlowId",
8774
8774
  "required": true,
@@ -8791,13 +8791,13 @@
8791
8791
  "members": [
8792
8792
  {
8793
8793
  "disabled": false,
8794
- "document": "合同流程关联的填写控件信息,包括填写控件的归属方以及是否填写等内容。\n注意:此字段可能返回 null,表示取不到有效值。",
8794
+ "document": "合同流程关联的填写控件信息,包括填写控件的归属方以及是否填写等内容。",
8795
8795
  "example": "无",
8796
8796
  "member": "RecipientComponentInfo",
8797
8797
  "name": "RecipientComponentInfos",
8798
8798
  "output_required": true,
8799
8799
  "type": "list",
8800
- "value_allowed_null": true
8800
+ "value_allowed_null": false
8801
8801
  },
8802
8802
  {
8803
8803
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -8823,7 +8823,7 @@
8823
8823
  {
8824
8824
  "disabled": false,
8825
8825
  "document": "签署报告编号, 由<a href=\"https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport\" target=\"_blank\">提交申请出证报告任务</a>产生",
8826
- "example": "",
8826
+ "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8",
8827
8827
  "member": "string",
8828
8828
  "name": "ReportId",
8829
8829
  "required": true,
@@ -8855,13 +8855,13 @@
8855
8855
  "members": [
8856
8856
  {
8857
8857
  "disabled": false,
8858
- "document": "出证报告PDF的下载 URL,`有效期为5分钟`,超过有效期后将无法再下载。\n注意:此字段可能返回 null,表示取不到有效值。",
8858
+ "document": "出证报告PDF的下载 URL,`有效期为5分钟`,超过有效期后将无法再下载。",
8859
8859
  "example": "https://file.ess.tencent.cn/file/yDwhIU*****kvSEnAV3Qyl2B/0/1.PDF?hkey=4a8ca49a66dc0b7651**5601d0e6b8aa9a86054c25",
8860
8860
  "member": "string",
8861
8861
  "name": "ReportUrl",
8862
8862
  "output_required": true,
8863
8863
  "type": "string",
8864
- "value_allowed_null": true
8864
+ "value_allowed_null": false
8865
8865
  },
8866
8866
  {
8867
8867
  "disabled": false,
@@ -9191,7 +9191,7 @@
9191
9191
  {
9192
9192
  "disabled": false,
9193
9193
  "document": "指定分页每页返回的数据条数,单页最大支持 20。",
9194
- "example": "",
9194
+ "example": "10",
9195
9195
  "member": "int64",
9196
9196
  "name": "Limit",
9197
9197
  "required": true,
@@ -9217,8 +9217,8 @@
9217
9217
  },
9218
9218
  {
9219
9219
  "disabled": false,
9220
- "document": "指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000。",
9221
- "example": "",
9220
+ "document": "偏移量,默认为0,最大20000。。关于<code>Offset</code>的更进一步介绍请参考 API <a href=\"https://cloud.tencent.com/document/api/213/15688\" target=\"_blank\">简介</a>中的相关小节。",
9221
+ "example": "0",
9222
9222
  "member": "int64",
9223
9223
  "name": "Offset",
9224
9224
  "required": false,
@@ -9232,23 +9232,23 @@
9232
9232
  "members": [
9233
9233
  {
9234
9234
  "disabled": false,
9235
- "document": "员工信息列表。\n注意:此字段可能返回 null,表示取不到有效值。",
9235
+ "document": "员工信息列表。",
9236
9236
  "example": "无",
9237
9237
  "member": "Staff",
9238
9238
  "name": "Employees",
9239
9239
  "output_required": true,
9240
9240
  "type": "list",
9241
- "value_allowed_null": true
9241
+ "value_allowed_null": false
9242
9242
  },
9243
9243
  {
9244
9244
  "disabled": false,
9245
- "document": "指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000。\n注意:此字段可能返回 null,表示取不到有效值。",
9245
+ "document": "偏移量",
9246
9246
  "example": "0",
9247
9247
  "member": "int64",
9248
9248
  "name": "Offset",
9249
9249
  "output_required": true,
9250
9250
  "type": "int",
9251
- "value_allowed_null": true
9251
+ "value_allowed_null": false
9252
9252
  },
9253
9253
  {
9254
9254
  "disabled": false,
@@ -9551,7 +9551,7 @@
9551
9551
  {
9552
9552
  "disabled": false,
9553
9553
  "document": "符合查询条件的资源实例总数量。\n注意:此字段可能返回 null,表示取不到有效值。",
9554
- "example": "",
9554
+ "example": "100",
9555
9555
  "member": "uint64",
9556
9556
  "name": "Total",
9557
9557
  "output_required": true,
@@ -9561,7 +9561,7 @@
9561
9561
  {
9562
9562
  "disabled": false,
9563
9563
  "document": "已授权待激活的子企业总数量\n注意:此字段可能返回 null,表示取不到有效值。",
9564
- "example": "",
9564
+ "example": "10",
9565
9565
  "member": "uint64",
9566
9566
  "name": "JoinedTotal",
9567
9567
  "output_required": true,
@@ -9571,7 +9571,7 @@
9571
9571
  {
9572
9572
  "disabled": true,
9573
9573
  "document": "已加入的企业数量(废弃,请使用ActivatedTotal)\n注意:此字段可能返回 null,表示取不到有效值。",
9574
- "example": "",
9574
+ "example": "10",
9575
9575
  "member": "uint64",
9576
9576
  "name": "ActivedTotal",
9577
9577
  "output_required": false,
@@ -9581,7 +9581,7 @@
9581
9581
  {
9582
9582
  "disabled": false,
9583
9583
  "document": "如果入参Export为 true 时使用,表示导出Excel的url\n注意:此字段可能返回 null,表示取不到有效值。",
9584
- "example": "",
9584
+ "example": "http://xxxx.com",
9585
9585
  "member": "string",
9586
9586
  "name": "ExportUrl",
9587
9587
  "output_required": true,
@@ -9601,7 +9601,7 @@
9601
9601
  {
9602
9602
  "disabled": false,
9603
9603
  "document": "已加入的子企业总数量\n注意:此字段可能返回 null,表示取不到有效值。",
9604
- "example": "",
9604
+ "example": "50",
9605
9605
  "member": "uint64",
9606
9606
  "name": "ActivatedTotal",
9607
9607
  "output_required": false,
@@ -9659,7 +9659,7 @@
9659
9659
  {
9660
9660
  "disabled": false,
9661
9661
  "document": "印章id,是否查询特定的印章(没有输入返回所有)",
9662
- "example": "",
9662
+ "example": "yDSxWUUckptu4clgUuLlo0OwJKbYCO48",
9663
9663
  "member": "string",
9664
9664
  "name": "SealId",
9665
9665
  "required": false,
@@ -9668,7 +9668,7 @@
9668
9668
  {
9669
9669
  "disabled": false,
9670
9670
  "document": "印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>ORGANIZATION_SEAL</strong>:企业印章(通过图片上传创建);</li> <li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> <li><strong>EMPLOYEE_QUALIFICATION_SEAL</strong>:员工执业章。</li> </ul>",
9671
- "example": "",
9671
+ "example": "OFFICIAL",
9672
9672
  "member": "string",
9673
9673
  "name": "SealTypes",
9674
9674
  "required": false,
@@ -9686,7 +9686,7 @@
9686
9686
  {
9687
9687
  "disabled": false,
9688
9688
  "document": "需查询的印章状态列表。\n<ul>\n<li>空:(默认)仅查询启用状态的印章;</li>\n<li><strong>ALL</strong>:查询所有状态的印章;</li>\n<li><strong>CHECKING</strong>:查询待审核的印章;</li>\n<li><strong>SUCCESS</strong>:查询启用状态的印章;</li>\n<li><strong>FAIL</strong>:查询印章审核拒绝的印章;</li>\n<li><strong>DISABLE</strong>:查询已停用的印章;</li>\n<li><strong>STOPPED</strong>:查询已终止的印章;</li>\n<li><strong>VOID</strong>:查询已作废的印章;</li>\n<li><strong>INVALID</strong>:查询已失效的印章。</li>\n</ul>",
9689
- "example": "",
9689
+ "example": "ALL",
9690
9690
  "member": "string",
9691
9691
  "name": "SealStatuses",
9692
9692
  "required": false,
@@ -9821,7 +9821,7 @@
9821
9821
  {
9822
9822
  "disabled": false,
9823
9823
  "document": "证书的Base64",
9824
- "example": "",
9824
+ "example": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW+jOBeA799fYXHfgtOkTSNgNJpRpZHmXVWaWWluHWOIVX8g22SdWe1/X9mAISXtMGSRCs7BfuxzfD5w0w+WM3AkSlMpsgjeJhEgAsuCiiqL/vz+dLONPuT/S7U5MfLtQIgBwHIm****************",
9825
9825
  "member": "string",
9826
9826
  "name": "Cert",
9827
9827
  "output_required": false,
@@ -9884,23 +9884,23 @@
9884
9884
  "members": [
9885
9885
  {
9886
9886
  "disabled": false,
9887
- "document": "核身视频结果。\n注意:此字段可能返回 null,表示取不到有效值。",
9887
+ "document": "核身视频结果。",
9888
9888
  "example": "无",
9889
9889
  "member": "DetectInfoVideoData",
9890
9890
  "name": "VideoData",
9891
9891
  "output_required": false,
9892
9892
  "type": "object",
9893
- "value_allowed_null": true
9893
+ "value_allowed_null": false
9894
9894
  },
9895
9895
  {
9896
9896
  "disabled": false,
9897
- "document": "意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
9897
+ "document": "意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。",
9898
9898
  "example": "无",
9899
9899
  "member": "IntentionQuestionResult",
9900
9900
  "name": "IntentionQuestionResult",
9901
9901
  "output_required": false,
9902
9902
  "type": "object",
9903
- "value_allowed_null": true
9903
+ "value_allowed_null": false
9904
9904
  },
9905
9905
  {
9906
9906
  "disabled": false,
@@ -10024,7 +10024,7 @@
10024
10024
  {
10025
10025
  "disabled": false,
10026
10026
  "document": "查询用户是否已开通自动签",
10027
- "example": "",
10027
+ "example": "true",
10028
10028
  "member": "bool",
10029
10029
  "name": "IsOpen",
10030
10030
  "output_required": true,
@@ -10054,7 +10054,7 @@
10054
10054
  {
10055
10055
  "disabled": false,
10056
10056
  "document": "设置用户开通自动签时是否绑定个人自动签账号许可。<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li><li>**1**: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul>",
10057
- "example": "",
10057
+ "example": "1",
10058
10058
  "member": "int64",
10059
10059
  "name": "LicenseType",
10060
10060
  "output_required": false,
@@ -10064,7 +10064,7 @@
10064
10064
  {
10065
10065
  "disabled": false,
10066
10066
  "document": "用户开通自动签指定使用的印章,为空则未设置印章,需重新进入开通链接设置印章。",
10067
- "example": "",
10067
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
10068
10068
  "member": "string",
10069
10069
  "name": "SealId",
10070
10070
  "output_required": false,
@@ -10095,7 +10095,7 @@
10095
10095
  {
10096
10096
  "disabled": false,
10097
10097
  "document": "姓名",
10098
- "example": "",
10098
+ "example": "张三",
10099
10099
  "member": "string",
10100
10100
  "name": "Name",
10101
10101
  "required": true,
@@ -10104,7 +10104,7 @@
10104
10104
  {
10105
10105
  "disabled": false,
10106
10106
  "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
10107
- "example": "",
10107
+ "example": "10101******",
10108
10108
  "member": "string",
10109
10109
  "name": "IdCardNumber",
10110
10110
  "required": true,
@@ -10113,7 +10113,7 @@
10113
10113
  {
10114
10114
  "disabled": false,
10115
10115
  "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
10116
- "example": "",
10116
+ "example": "ID_CARD",
10117
10117
  "member": "string",
10118
10118
  "name": "IdCardType",
10119
10119
  "required": true,
@@ -10860,7 +10860,7 @@
10860
10860
  {
10861
10861
  "disabled": false,
10862
10862
  "document": "签署时的相关信息\n注意:此字段可能返回 null,表示取不到有效值。",
10863
- "example": "",
10863
+ "example": "发起方因为【金额错误】撤销合同",
10864
10864
  "member": "string",
10865
10865
  "name": "ApproveMessage",
10866
10866
  "output_required": true,
@@ -10870,7 +10870,7 @@
10870
10870
  {
10871
10871
  "disabled": false,
10872
10872
  "document": "签署方姓名",
10873
- "example": "",
10873
+ "example": "典子谦",
10874
10874
  "member": "string",
10875
10875
  "name": "ApproveName",
10876
10876
  "output_required": true,
@@ -10880,7 +10880,7 @@
10880
10880
  {
10881
10881
  "disabled": false,
10882
10882
  "document": "签署方的签署状态\n0:还没有发起\n1:流程中 没有开始处理\n2:待签署\n3:已签署\n4:已拒绝\n5:已过期\n6:已撤销\n7:还没有预发起\n8:待填写\n9:因为各种原因而终止\n10:填写完成\n15:已解除\n19:转他人处理",
10883
- "example": "",
10883
+ "example": "10",
10884
10884
  "member": "int64",
10885
10885
  "name": "ApproveStatus",
10886
10886
  "output_required": true,
@@ -10900,7 +10900,7 @@
10900
10900
  {
10901
10901
  "disabled": false,
10902
10902
  "document": "客户自定义的用户ID\n注意:此字段可能返回 null,表示取不到有效值。",
10903
- "example": "",
10903
+ "example": "n9727",
10904
10904
  "member": "string",
10905
10905
  "name": "CustomUserId",
10906
10906
  "output_required": true,
@@ -10910,7 +10910,7 @@
10910
10910
  {
10911
10911
  "disabled": false,
10912
10912
  "document": "签署人手机号",
10913
- "example": "",
10913
+ "example": "13200000000",
10914
10914
  "member": "string",
10915
10915
  "name": "Mobile",
10916
10916
  "output_required": true,
@@ -10920,7 +10920,7 @@
10920
10920
  {
10921
10921
  "disabled": false,
10922
10922
  "document": "签署顺序,如果是有序签署,签署顺序从小到大",
10923
- "example": "",
10923
+ "example": "1",
10924
10924
  "member": "int64",
10925
10925
  "name": "SignOrder",
10926
10926
  "output_required": true,
@@ -10930,7 +10930,7 @@
10930
10930
  {
10931
10931
  "disabled": false,
10932
10932
  "document": "签署人签署时间,时间戳,单位秒",
10933
- "example": "",
10933
+ "example": "1736409770",
10934
10934
  "member": "int64",
10935
10935
  "name": "ApproveTime",
10936
10936
  "output_required": true,
@@ -10940,7 +10940,7 @@
10940
10940
  {
10941
10941
  "disabled": false,
10942
10942
  "document": "签署方类型,ORGANIZATION-企业员工,PERSON-个人,ENTERPRISESERVER-企业静默签\n注意:此字段可能返回 null,表示取不到有效值。",
10943
- "example": "",
10943
+ "example": "ORGANIZATION",
10944
10944
  "member": "string",
10945
10945
  "name": "ApproveType",
10946
10946
  "output_required": true,
@@ -10950,7 +10950,7 @@
10950
10950
  {
10951
10951
  "disabled": false,
10952
10952
  "document": "签署方侧用户来源,如WEWORKAPP-企业微信等\n注意:此字段可能返回 null,表示取不到有效值。",
10953
- "example": "",
10953
+ "example": "WEWORKAPP",
10954
10954
  "member": "string",
10955
10955
  "name": "ApproverSource",
10956
10956
  "output_required": true,
@@ -10960,7 +10960,7 @@
10960
10960
  {
10961
10961
  "disabled": false,
10962
10962
  "document": "客户自定义签署方标识\n注意:此字段可能返回 null,表示取不到有效值。",
10963
- "example": "",
10963
+ "example": "甲方",
10964
10964
  "member": "string",
10965
10965
  "name": "CustomApproverTag",
10966
10966
  "output_required": true,
@@ -10970,7 +10970,7 @@
10970
10970
  {
10971
10971
  "disabled": false,
10972
10972
  "document": "签署方企业Id\n注意:此字段可能返回 null,表示取不到有效值。",
10973
- "example": "",
10973
+ "example": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
10974
10974
  "member": "string",
10975
10975
  "name": "OrganizationId",
10976
10976
  "output_required": true,
@@ -10980,7 +10980,7 @@
10980
10980
  {
10981
10981
  "disabled": false,
10982
10982
  "document": "签署方企业名称\n注意:此字段可能返回 null,表示取不到有效值。",
10983
- "example": "",
10983
+ "example": "典子谦示例企业",
10984
10984
  "member": "string",
10985
10985
  "name": "OrganizationName",
10986
10986
  "output_required": true,
@@ -10990,7 +10990,7 @@
10990
10990
  {
10991
10991
  "disabled": false,
10992
10992
  "document": "签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。\n注意:此字段可能返回 null,表示取不到有效值。",
10993
- "example": "yDw**************************y0S",
10993
+ "example": " yDtwLUUckp79rcc2UuSIlvCCkIZsXxFY",
10994
10994
  "member": "string",
10995
10995
  "name": "SignId",
10996
10996
  "output_required": false,
@@ -11000,7 +11000,7 @@
11000
11000
  {
11001
11001
  "disabled": false,
11002
11002
  "document": "自定义签署人角色\n注意:此字段可能返回 null,表示取不到有效值。",
11003
- "example": "",
11003
+ "example": "甲方",
11004
11004
  "member": "string",
11005
11005
  "name": "ApproverRoleName",
11006
11006
  "output_required": false,
@@ -11010,7 +11010,7 @@
11010
11010
  {
11011
11011
  "disabled": false,
11012
11012
  "document": "模板配置中的参与方ID,与控件绑定",
11013
- "example": "",
11013
+ "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8",
11014
11014
  "member": "string",
11015
11015
  "name": "RecipientId",
11016
11016
  "output_required": true,
@@ -11858,8 +11858,8 @@
11858
11858
  "members": [
11859
11859
  {
11860
11860
  "disabled": false,
11861
- "document": "转换任务Id,通过接口<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>或<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateMergeFileTask\" target=\"_blank\">创建多文件转换任务接口</a>\n得到的转换任务id",
11862
- "example": "",
11861
+ "document": "转换任务Id,通过接口<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>得到的转换任务id",
11862
+ "example": "yDCZHUUnitvronUuNTdBrElW0gOVqCfy",
11863
11863
  "member": "string",
11864
11864
  "name": "TaskId",
11865
11865
  "required": true,
@@ -11901,7 +11901,7 @@
11901
11901
  {
11902
11902
  "disabled": false,
11903
11903
  "document": "任务Id",
11904
- "example": "",
11904
+ "example": "yDCZHUUnitvronUuNTdBrElW0gOVqCfy",
11905
11905
  "member": "string",
11906
11906
  "name": "TaskId",
11907
11907
  "output_required": true,
@@ -11911,7 +11911,7 @@
11911
11911
  {
11912
11912
  "disabled": false,
11913
11913
  "document": "任务状态,需要关注的状态\n<ul><li>**0** :NeedTranform - 任务已提交</li>\n<li>**4** :Processing - 文档转换中</li>\n<li>**8** :TaskEnd - 任务处理完成</li>\n<li>**-2** :DownloadFailed - 下载失败</li>\n<li>**-6** :ProcessFailed - 转换失败</li>\n<li>**-13**:ProcessTimeout - 转换文件超时</li></ul>",
11914
- "example": "",
11914
+ "example": "0",
11915
11915
  "member": "int64",
11916
11916
  "name": "TaskStatus",
11917
11917
  "output_required": true,
@@ -11921,7 +11921,7 @@
11921
11921
  {
11922
11922
  "disabled": false,
11923
11923
  "document": "状态描述,需要关注的状态\n<ul><li> **NeedTranform** : 任务已提交</li>\n<li> **Processing** : 文档转换中</li>\n<li> **TaskEnd** : 任务处理完成</li>\n<li> **DownloadFailed** : 下载失败</li>\n<li> **ProcessFailed** : 转换失败</li>\n<li> **ProcessTimeout** : 转换文件超时</li></ul>",
11924
- "example": "",
11924
+ "example": "任务处理完成",
11925
11925
  "member": "string",
11926
11926
  "name": "TaskMessage",
11927
11927
  "output_required": true,
@@ -11931,7 +11931,7 @@
11931
11931
  {
11932
11932
  "disabled": false,
11933
11933
  "document": "资源Id(即FileId),用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)",
11934
- "example": "",
11934
+ "example": "yDCYyUU5v4h32uUEp5vIWRaloaz5mYuu",
11935
11935
  "member": "string",
11936
11936
  "name": "ResourceId",
11937
11937
  "output_required": true,
@@ -12662,7 +12662,7 @@
12662
12662
  {
12663
12663
  "disabled": false,
12664
12664
  "document": "电子签部门ID,通过<a href=\"https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments\" target=\"_blank\">DescribeIntegrationDepartments</a>接口获得。",
12665
- "example": "",
12665
+ "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84",
12666
12666
  "member": "string",
12667
12667
  "name": "DeptId",
12668
12668
  "required": true,
@@ -12680,7 +12680,7 @@
12680
12680
  {
12681
12681
  "disabled": false,
12682
12682
  "document": "电子签父部门ID,通过<a href=\"https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments\" target=\"_blank\">DescribeIntegrationDepartments</a>接口获得。",
12683
- "example": "",
12683
+ "example": "732aaefa78c439d726f541b89c49e022",
12684
12684
  "member": "string",
12685
12685
  "name": "ParentDeptId",
12686
12686
  "required": false,
@@ -12689,7 +12689,7 @@
12689
12689
  {
12690
12690
  "disabled": false,
12691
12691
  "document": "部门名称,最大长度为50个字符。",
12692
- "example": "",
12692
+ "example": "人力资源",
12693
12693
  "member": "string",
12694
12694
  "name": "DeptName",
12695
12695
  "required": false,
@@ -12698,7 +12698,7 @@
12698
12698
  {
12699
12699
  "disabled": false,
12700
12700
  "document": "客户系统部门ID,最大长度为64个字符。",
12701
- "example": "",
12701
+ "example": "department_hr",
12702
12702
  "member": "string",
12703
12703
  "name": "DeptOpenId",
12704
12704
  "required": false,
@@ -12707,7 +12707,7 @@
12707
12707
  {
12708
12708
  "disabled": false,
12709
12709
  "document": "排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。",
12710
- "example": "",
12710
+ "example": "100",
12711
12711
  "member": "uint64",
12712
12712
  "name": "OrderNo",
12713
12713
  "required": false,
@@ -12734,7 +12734,7 @@
12734
12734
  {
12735
12735
  "disabled": false,
12736
12736
  "document": "角色Id,可通过接口 DescribeIntegrationRoles 查询获取",
12737
- "example": "",
12737
+ "example": "yDxD6UxwxNjUy0fKyKBk09rtshL0DBuA",
12738
12738
  "member": "string",
12739
12739
  "name": "RoleId",
12740
12740
  "required": true,
@@ -12743,7 +12743,7 @@
12743
12743
  {
12744
12744
  "disabled": false,
12745
12745
  "document": "角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。",
12746
- "example": "",
12746
+ "example": "角色_1",
12747
12747
  "member": "string",
12748
12748
  "name": "Name",
12749
12749
  "required": true,
@@ -12761,7 +12761,7 @@
12761
12761
  {
12762
12762
  "disabled": false,
12763
12763
  "document": "角色描述,最大长度为50个字符",
12764
- "example": "",
12764
+ "example": "这是一个角色描述",
12765
12765
  "member": "string",
12766
12766
  "name": "Description",
12767
12767
  "required": false,
@@ -12779,7 +12779,7 @@
12779
12779
  {
12780
12780
  "disabled": false,
12781
12781
  "document": "集团角色的话,需要传递集团子企业列表,如果是全选,则传1",
12782
- "example": "",
12782
+ "example": "732aaefa78c439d726f541b89c49e022",
12783
12783
  "member": "string",
12784
12784
  "name": "SubOrganizationIds",
12785
12785
  "required": false,
@@ -14581,7 +14581,7 @@
14581
14581
  {
14582
14582
  "disabled": false,
14583
14583
  "document": "若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:\n<ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>\n<li> **1** : 签署完成后通知对方来查看合同</li></ul>",
14584
- "example": "",
14584
+ "example": "0",
14585
14585
  "member": "int64",
14586
14586
  "name": "CcNotifyType",
14587
14587
  "required": false,
@@ -14596,7 +14596,7 @@
14596
14596
  {
14597
14597
  "disabled": false,
14598
14598
  "document": "发起成功后返回的状态,根据合同流程的不同,返回不同状态:\n<ul><li> **START** : 发起成功, 合同进入签署环节</li>\n<li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能,使用前请联系对接的客户经理沟通。`</li>\n<li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>",
14599
- "example": "",
14599
+ "example": "START",
14600
14600
  "member": "string",
14601
14601
  "name": "Status",
14602
14602
  "output_required": true,
@@ -15108,7 +15108,7 @@
15108
15108
  {
15109
15109
  "disabled": false,
15110
15110
  "document": "员工在腾讯电子签平台的唯一身份标识,为32位字符串。\n\n通过<a href=\"https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees\" target=\"_blank\">DescribeIntegrationEmployees</a>接口获取,也可登录腾讯电子签控制台查看\n![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)",
15111
- "example": "",
15111
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
15112
15112
  "member": "string",
15113
15113
  "name": "UserId",
15114
15114
  "required": true,
@@ -15117,7 +15117,7 @@
15117
15117
  {
15118
15118
  "disabled": false,
15119
15119
  "document": "员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。\n该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。",
15120
- "example": "",
15120
+ "example": "obLsS5TwNBM482wtEE7bQDSVoDdk",
15121
15121
  "member": "string",
15122
15122
  "name": "OpenId",
15123
15123
  "required": true,
@@ -15324,7 +15324,7 @@
15324
15324
  {
15325
15325
  "disabled": false,
15326
15326
  "document": "用户自定义ID数组,与上传文件一一对应\n\n注: `历史遗留问题,已经废弃,调用接口时不用赋值`",
15327
- "example": "",
15327
+ "example": "9b337a42",
15328
15328
  "member": "string",
15329
15329
  "name": "CustomIds",
15330
15330
  "required": false,
@@ -15517,7 +15517,7 @@
15517
15517
  {
15518
15518
  "disabled": false,
15519
15519
  "document": "合同流程ID,为32位字符串。\n可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
15520
- "example": "",
15520
+ "example": "yDwcCUUgyg3tgmvhUEVzyNa15Zayy6Sf",
15521
15521
  "member": "string",
15522
15522
  "name": "FlowId",
15523
15523
  "required": true,
@@ -15550,7 +15550,7 @@
15550
15550
  {
15551
15551
  "disabled": false,
15552
15552
  "document": "验签结果代码,代码的含义如下:\n\n<ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>\n<li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>\n<li>**3**:文件被篡改。</li>\n<li>**4**:异常:文件内没有签名域。</li>\n<li>**5**:异常:文件签名格式错误。</li></ul>",
15553
- "example": "",
15553
+ "example": "4",
15554
15554
  "member": "int64",
15555
15555
  "name": "VerifyResult",
15556
15556
  "output_required": true,
@@ -15570,7 +15570,7 @@
15570
15570
  {
15571
15571
  "disabled": false,
15572
15572
  "document": "验签序列号, 为11为数组组成的字符串",
15573
- "example": "",
15573
+ "example": "17364056473214",
15574
15574
  "member": "string",
15575
15575
  "name": "VerifySerialNo",
15576
15576
  "output_required": true,