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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (50) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/aiart/v20221229/api.json +13 -4
  3. tccli/services/bi/v20220105/api.json +6 -6
  4. tccli/services/cat/v20180409/api.json +25 -24
  5. tccli/services/cat/v20180409/examples.json +17 -17
  6. tccli/services/ccc/ccc_client.py +53 -0
  7. tccli/services/ccc/v20200210/api.json +89 -0
  8. tccli/services/ccc/v20200210/examples.json +8 -0
  9. tccli/services/cdb/v20170320/api.json +12 -0
  10. tccli/services/cdn/v20180606/api.json +1 -1
  11. tccli/services/cdwdoris/v20211228/api.json +233 -193
  12. tccli/services/cdwdoris/v20211228/examples.json +6 -6
  13. tccli/services/cloudaudit/v20190319/api.json +2 -2
  14. tccli/services/cloudaudit/v20190319/examples.json +2 -2
  15. tccli/services/config/v20220802/api.json +20 -9
  16. tccli/services/config/v20220802/examples.json +1 -1
  17. tccli/services/dc/v20180410/api.json +13 -11
  18. tccli/services/dc/v20180410/examples.json +8 -2
  19. tccli/services/emr/v20190103/api.json +26 -21
  20. tccli/services/emr/v20190103/examples.json +2 -2
  21. tccli/services/ess/v20201111/api.json +474 -467
  22. tccli/services/ess/v20201111/examples.json +10 -10
  23. tccli/services/essbasic/v20210526/api.json +405 -408
  24. tccli/services/essbasic/v20210526/examples.json +12 -12
  25. tccli/services/hunyuan/v20230901/api.json +22 -0
  26. tccli/services/lcic/v20220817/api.json +1 -1
  27. tccli/services/monitor/v20180724/api.json +68 -50
  28. tccli/services/monitor/v20180724/examples.json +22 -22
  29. tccli/services/mps/mps_client.py +379 -61
  30. tccli/services/mps/v20190612/api.json +495 -13
  31. tccli/services/mps/v20190612/examples.json +48 -0
  32. tccli/services/nlp/v20190408/api.json +1 -1
  33. tccli/services/ocr/v20181119/api.json +7 -7
  34. tccli/services/ocr/v20181119/examples.json +6 -6
  35. tccli/services/pts/v20210728/api.json +589 -497
  36. tccli/services/pts/v20210728/examples.json +17 -17
  37. tccli/services/rum/v20210622/api.json +79 -19
  38. tccli/services/ssl/v20191205/api.json +3 -3
  39. tccli/services/ssl/v20191205/examples.json +1 -1
  40. tccli/services/teo/v20220901/api.json +10 -10
  41. tccli/services/trtc/v20190722/api.json +11 -0
  42. tccli/services/tse/v20201207/api.json +10 -0
  43. tccli/services/vpc/v20170312/api.json +1 -1
  44. tccli/services/wedata/v20210820/api.json +382 -96
  45. tccli/services/wedata/v20210820/examples.json +1 -1
  46. {tccli-3.0.1250.1.dist-info → tccli-3.0.1252.1.dist-info}/METADATA +2 -2
  47. {tccli-3.0.1250.1.dist-info → tccli-3.0.1252.1.dist-info}/RECORD +50 -50
  48. {tccli-3.0.1250.1.dist-info → tccli-3.0.1252.1.dist-info}/WHEEL +0 -0
  49. {tccli-3.0.1250.1.dist-info → tccli-3.0.1252.1.dist-info}/entry_points.txt +0 -0
  50. {tccli-3.0.1250.1.dist-info → tccli-3.0.1252.1.dist-info}/license_files/LICENSE +0 -0
@@ -609,7 +609,7 @@
609
609
  {
610
610
  "disabled": false,
611
611
  "document": "应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)",
612
- "example": "",
612
+ "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
613
613
  "member": "string",
614
614
  "name": "AppId",
615
615
  "required": true,
@@ -618,7 +618,7 @@
618
618
  {
619
619
  "disabled": false,
620
620
  "document": "第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串",
621
- "example": "",
621
+ "example": "org_dianziqian",
622
622
  "member": "string",
623
623
  "name": "ProxyOrganizationOpenId",
624
624
  "required": false,
@@ -636,7 +636,7 @@
636
636
  {
637
637
  "disabled": false,
638
638
  "document": "**不用填写**,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。",
639
- "example": "",
639
+ "example": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68",
640
640
  "member": "string",
641
641
  "name": "ProxyAppId",
642
642
  "required": false,
@@ -660,7 +660,7 @@
660
660
  {
661
661
  "disabled": false,
662
662
  "document": "签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。",
663
- "example": "",
663
+ "example": "yDRscUUgyg3zr9vfUyJ8QKwCN7z9YcOh",
664
664
  "member": "string",
665
665
  "name": "RecipientId",
666
666
  "required": true,
@@ -669,7 +669,7 @@
669
669
  {
670
670
  "disabled": false,
671
671
  "document": "签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。\n\n签名方式:\n<ul>\n<li>HANDWRITE-手写签名</li>\n<li>ESIGN-个人印章类型</li>\n<li>OCR_ESIGN-AI智能识别手写签名</li>\n<li>SYSTEM_ESIGN-系统签名</li>\n</ul>",
672
- "example": "",
672
+ "example": "[\"HANDWRITE\", \"SYSTEM_ESIGN\"]",
673
673
  "member": "string",
674
674
  "name": "Values",
675
675
  "required": false,
@@ -684,7 +684,7 @@
684
684
  {
685
685
  "disabled": false,
686
686
  "document": "签署方唯一编号\n\n在<a href=\"https://qian.tencent.com/developers/company/dynamic_signer\" target=\"_blank\">动态补充签署人</a>场景下,可以用此编号确定参与方\n注意:此字段可能返回 null,表示取不到有效值。",
687
- "example": "",
687
+ "example": "yDCNsUUckpvs1o70UuxBSommqdahMmPb",
688
688
  "member": "string",
689
689
  "name": "SignId",
690
690
  "output_required": false,
@@ -694,7 +694,7 @@
694
694
  {
695
695
  "disabled": false,
696
696
  "document": "签署方角色编号\n\n在<a href=\"https://qian.tencent.com/developers/company/dynamic_signer\" target=\"_blank\">动态补充签署人</a>场景下,可以用此编号确定参与方\n注意:此字段可能返回 null,表示取不到有效值。",
697
- "example": "",
697
+ "example": "yDRSOUUgygqno04sUuO4zjEugoGg49nT",
698
698
  "member": "string",
699
699
  "name": "RecipientId",
700
700
  "output_required": false,
@@ -704,7 +704,7 @@
704
704
  {
705
705
  "disabled": false,
706
706
  "document": "签署方角色名称\n注意:此字段可能返回 null,表示取不到有效值。",
707
- "example": "",
707
+ "example": "企业签署方1",
708
708
  "member": "string",
709
709
  "name": "ApproverRoleName",
710
710
  "output_required": false,
@@ -747,7 +747,7 @@
747
747
  {
748
748
  "disabled": false,
749
749
  "document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** : 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>\n\n注:\n`使用动态签署人能力前,需登陆腾讯电子签控制台打开服务开关`",
750
- "example": "",
750
+ "example": "1",
751
751
  "member": "int64",
752
752
  "name": "FillType",
753
753
  "required": false,
@@ -756,7 +756,7 @@
756
756
  {
757
757
  "disabled": false,
758
758
  "document": "签署人阅读合同限制参数\n <br/>取值:\n<ul>\n<li> LimitReadTimeAndBottom,阅读合同必须限制阅读时长并且必须阅读到底</li>\n<li> LimitReadTime,阅读合同仅限制阅读时长</li>\n<li> LimitBottom,阅读合同仅限制必须阅读到底</li>\n<li> NoReadTimeAndBottom,阅读合同不限制阅读时长且不限制阅读到底(白名单功能,请联系客户经理开白使用)</li>\n</ul>",
759
- "example": "",
759
+ "example": "LimitBottom",
760
760
  "member": "string",
761
761
  "name": "FlowReadLimit",
762
762
  "required": false,
@@ -892,7 +892,7 @@
892
892
  {
893
893
  "disabled": false,
894
894
  "document": "错误信息",
895
- "example": "",
895
+ "example": "非渠道合作企业openId",
896
896
  "member": "string",
897
897
  "name": "Message",
898
898
  "output_required": true,
@@ -908,7 +908,7 @@
908
908
  {
909
909
  "disabled": false,
910
910
  "document": "扩展服务类型,和入参一致\t\n注意:此字段可能返回 null,表示取不到有效值。",
911
- "example": "",
911
+ "example": "BATCH_SIGN",
912
912
  "member": "string",
913
913
  "name": "Type",
914
914
  "output_required": false,
@@ -919,7 +919,7 @@
919
919
  {
920
920
  "disabled": false,
921
921
  "document": "扩展服务名称\t\n注意:此字段可能返回 null,表示取不到有效值。",
922
- "example": "",
922
+ "example": "批量签署",
923
923
  "member": "string",
924
924
  "name": "Name",
925
925
  "output_required": false,
@@ -952,7 +952,7 @@
952
952
  {
953
953
  "disabled": false,
954
954
  "document": "授权员工列表总数\t\n注意:此字段可能返回 null,表示取不到有效值。",
955
- "example": "",
955
+ "example": "1",
956
956
  "member": "int64",
957
957
  "name": "AuthUserTotal",
958
958
  "output_required": false,
@@ -963,7 +963,7 @@
963
963
  {
964
964
  "disabled": false,
965
965
  "document": "授权企业列表总数\t\n注意:此字段可能返回 null,表示取不到有效值。",
966
- "example": "",
966
+ "example": "1",
967
967
  "member": "int64",
968
968
  "name": "AuthOrganizationTotal",
969
969
  "output_required": false,
@@ -980,10 +980,10 @@
980
980
  {
981
981
  "disabled": false,
982
982
  "document": "第三方应用平台的用户openid",
983
- "example": "",
983
+ "example": "xxxtest1",
984
984
  "member": "string",
985
985
  "name": "OpenId",
986
- "required": true,
986
+ "output_required": true,
987
987
  "type": "string",
988
988
  "value_allowed_null": false
989
989
  }
@@ -1005,7 +1005,7 @@
1005
1005
  {
1006
1006
  "disabled": false,
1007
1007
  "document": "是否回调证书信息:\n<ul><li>**false**: 不需要(默认)</li>\n<li>**true**:需要</li></ul>",
1008
- "example": "",
1008
+ "example": "true",
1009
1009
  "member": "bool",
1010
1010
  "name": "CertInfoCallback",
1011
1011
  "required": false,
@@ -1014,7 +1014,7 @@
1014
1014
  {
1015
1015
  "disabled": false,
1016
1016
  "document": "是否支持用户自定义签名印章:\n<ul><li>**false**: 不能自己定义(默认)</li>\n<li>**true**: 可以自己定义</li></ul>",
1017
- "example": "",
1017
+ "example": "false",
1018
1018
  "member": "bool",
1019
1019
  "name": "UserDefineSeal",
1020
1020
  "required": false,
@@ -1023,7 +1023,7 @@
1023
1023
  {
1024
1024
  "disabled": false,
1025
1025
  "document": "回调中是否需要自动签将要使用的印章(签名)图片的 base64:\n<ul><li>**false**: 不需要(默认)</li>\n<li>**true**: 需要</li></ul>",
1026
- "example": "",
1026
+ "example": "false",
1027
1027
  "member": "bool",
1028
1028
  "name": "SealImgCallback",
1029
1029
  "required": false,
@@ -1041,7 +1041,7 @@
1041
1041
  {
1042
1042
  "disabled": false,
1043
1043
  "document": "开通时候的身份验证方式, 取值为:\n<ul><li>**WEIXINAPP** : 微信人脸识别</li>\n<li>**INSIGHT** : 慧眼人脸认别</li>\n<li>**TELECOM** : 运营商三要素验证</li></ul>\n注:\n<ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>\n<li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>",
1044
- "example": "",
1044
+ "example": "[\"TELECOM\"]",
1045
1045
  "member": "string",
1046
1046
  "name": "VerifyChannels",
1047
1047
  "required": false,
@@ -1050,7 +1050,7 @@
1050
1050
  {
1051
1051
  "disabled": false,
1052
1052
  "document": "设置用户开通自动签时是否绑定个人自动签账号许可。\n\n<ul><li><b>1</b>: (默认)不绑定自动签账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul>",
1053
- "example": "",
1053
+ "example": "1",
1054
1054
  "member": "int64",
1055
1055
  "name": "LicenseType",
1056
1056
  "required": false,
@@ -1059,7 +1059,7 @@
1059
1059
  {
1060
1060
  "disabled": false,
1061
1061
  "document": "开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。\n\n注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`\n\n跳转场景:\n<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>\n<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。`APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考:<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>,<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>\n\n成功结果返回:\n若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,例如:qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess",
1062
- "example": "",
1062
+ "example": "https://YOUR_CUSTOM_URL/xxxx",
1063
1063
  "member": "string",
1064
1064
  "name": "JumpUrl",
1065
1065
  "required": false,
@@ -1119,7 +1119,7 @@
1119
1119
  {
1120
1120
  "disabled": false,
1121
1121
  "document": "是否打开智能添加填写区(默认开启,打开:\"OPEN\" 关闭:\"CLOSE\")",
1122
- "example": "",
1122
+ "example": "CLOSE",
1123
1123
  "member": "string",
1124
1124
  "name": "IntelligentStatus",
1125
1125
  "required": false,
@@ -1137,7 +1137,7 @@
1137
1137
  {
1138
1138
  "disabled": false,
1139
1139
  "document": "发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:\n<ul><li> **false**:(默认)不需要审批,直接签署。</li>\n<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>\n企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果\n<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>\n<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>\n注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`",
1140
- "example": "",
1140
+ "example": "false",
1141
1141
  "member": "bool",
1142
1142
  "name": "NeedSignReview",
1143
1143
  "required": false,
@@ -1164,7 +1164,7 @@
1164
1164
  {
1165
1165
  "disabled": false,
1166
1166
  "document": "发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。\n\n若设置为true,发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。\n\n",
1167
- "example": "",
1167
+ "example": "false",
1168
1168
  "member": "bool",
1169
1169
  "name": "NeedCreateReview",
1170
1170
  "required": false,
@@ -1197,7 +1197,7 @@
1197
1197
  {
1198
1198
  "disabled": false,
1199
1199
  "document": "签署流程编号,为32位字符串",
1200
- "example": "",
1200
+ "example": "yDCNGUUckpvjdelbUuyImI9pY8I5Mep9",
1201
1201
  "member": "string",
1202
1202
  "name": "FlowId",
1203
1203
  "output_required": true,
@@ -1207,7 +1207,7 @@
1207
1207
  {
1208
1208
  "disabled": false,
1209
1209
  "document": "撤销失败原因",
1210
- "example": "",
1210
+ "example": "合同当前状态不支持撤销",
1211
1211
  "member": "string",
1212
1212
  "name": "Reason",
1213
1213
  "output_required": false,
@@ -1320,7 +1320,7 @@
1320
1320
  {
1321
1321
  "disabled": false,
1322
1322
  "document": "撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:\n\n**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同\n**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同\n**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同\n**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同\n\n注: `CancelMessage为撤销当前合同的理由`\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png)\n\n",
1323
- "example": "",
1323
+ "example": "1",
1324
1324
  "member": "int64",
1325
1325
  "name": "CancelMessageFormat",
1326
1326
  "required": false,
@@ -1344,7 +1344,7 @@
1344
1344
  {
1345
1345
  "disabled": false,
1346
1346
  "document": "签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为\"\", 失败则对应失败原因\n\n注: `如果全部撤销成功, 此数组为空数组`",
1347
- "example": "",
1347
+ "example": "[\"合同流程Id:yDmFdUUckpsvi8mpUEn0aFR1tWzReolk,无法撤回,错误信息:合同当前状态不支持撤销\",\"\"]",
1348
1348
  "member": "string",
1349
1349
  "name": "FailMessages",
1350
1350
  "output_required": true,
@@ -1354,7 +1354,7 @@
1354
1354
  {
1355
1355
  "disabled": false,
1356
1356
  "document": "批量撤销任务编号,为32位字符串,可用于[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)\n",
1357
- "example": "",
1357
+ "example": "yDCVWUUckpwk3b05UyEZnO0xOn4snWWY",
1358
1358
  "member": "string",
1359
1359
  "name": "TaskId",
1360
1360
  "output_required": true,
@@ -1476,7 +1476,7 @@
1476
1476
  {
1477
1477
  "disabled": false,
1478
1478
  "document": "备注",
1479
- "example": "",
1479
+ "example": "用户计费使用情况详情备注",
1480
1480
  "member": "string",
1481
1481
  "name": "Remark",
1482
1482
  "output_required": false,
@@ -1519,7 +1519,7 @@
1519
1519
  {
1520
1520
  "disabled": false,
1521
1521
  "document": "撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:\n\n**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同\n**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同\n**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同\n**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同\n\n注: `CancelMessage为撤销当前合同的理由`\n\n![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)",
1522
- "example": "",
1522
+ "example": "1",
1523
1523
  "member": "int64",
1524
1524
  "name": "CancelMessageFormat",
1525
1525
  "required": false,
@@ -1564,7 +1564,7 @@
1564
1564
  {
1565
1565
  "disabled": false,
1566
1566
  "document": "需要取消的签署码ID,为32位字符串。由[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回",
1567
- "example": "",
1567
+ "example": "yDSLZUUckpooi1ltUxCsD3RSTG9BEWhR",
1568
1568
  "member": "string",
1569
1569
  "name": "QrCodeId",
1570
1570
  "required": true,
@@ -1618,7 +1618,7 @@
1618
1618
  {
1619
1619
  "disabled": false,
1620
1620
  "document": "自动签使用的场景值, 可以选择的场景值如下:\n<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>",
1621
- "example": "",
1621
+ "example": "E_PRESCRIPTION_AUTO_SIGN",
1622
1622
  "member": "string",
1623
1623
  "name": "SceneKey",
1624
1624
  "required": true,
@@ -2230,7 +2230,7 @@
2230
2230
  },
2231
2231
  {
2232
2232
  "disabled": false,
2233
- "document": "要生成WEB嵌入界面的类型, 可以选择的值如下: \n\n<ul>\n<li>CREATE_SEAL: 生成创建印章的嵌入页面</li>\n<li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>\n<li>MODIFY_TEMPLATE:生成修改模板的嵌入页面</li>\n<li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>\n<li>PREVIEW_FLOW:生成预览合同文档的嵌入页面(支持移动端)</li>\n<li>PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面(仅支持PC端)</li>\n<li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>\n<li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>\n<li>EXTEND_SERVICE:生成扩展服务的嵌入页面</li>\n</ul>",
2233
+ "document": "要生成WEB嵌入界面的类型, 可以选择的值如下: \n\n<ul>\n<li>CREATE_SEAL: 生成创建印章的嵌入页面</li>\n<li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>\n<li>MODIFY_TEMPLATE:生成修改模板的嵌入页面</li>\n<li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>\n<li>PREVIEW_FLOW:生成预览合同文档的嵌入页面(H5链接,支持移动端的浏览器中打开)</li>\n<li>PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面(仅支持PC的浏览器中打开)</li>\n<li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>\n<li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>\n<li>EXTEND_SERVICE:生成扩展服务的嵌入页面</li>\n</ul>",
2234
2234
  "example": "MODIFY_TEMPLATE",
2235
2235
  "member": "string",
2236
2236
  "name": "EmbedType",
@@ -2981,7 +2981,7 @@
2981
2981
  },
2982
2982
  {
2983
2983
  "disabled": false,
2984
- "document": "流程签署人列表,其中结构体的ApproverType必传。\n若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。\n若为子客企业签署方则需传OpenId、OrganizationOpenId,其他可不传。\n\n注:\n`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`\n`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`",
2984
+ "document": "流程签署人列表,其中结构体的ApproverType必传。\n若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。\n若为子客企业签署方则需传OpenId、OrganizationOpenId,其他可不传。\n\n此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:\n1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。\n2. ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。\n3. SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。\n4. Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。\n\n注:\n`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`\n`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`",
2985
2985
  "example": "无",
2986
2986
  "member": "FlowApproverInfo",
2987
2987
  "name": "FlowApproverInfos",
@@ -3009,7 +3009,7 @@
3009
3009
  {
3010
3010
  "disabled": false,
3011
3011
  "document": "签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href=\"https://qian.tencent.com/developers/company/openqianh5\" target=\"_blank\">跳转电子签H5</a>\n",
3012
- "example": "",
3012
+ "example": "https://YOUR_CUSTOM_URL/xxxx",
3013
3013
  "member": "string",
3014
3014
  "name": "JumpUrl",
3015
3015
  "required": false,
@@ -3018,7 +3018,7 @@
3018
3018
  {
3019
3019
  "disabled": false,
3020
3020
  "document": "链接类型,支持指定以下类型\n<ul><li>0 : 签署链接 (默认值)</li>\n<li>1 : 预览链接</li></ul>\n注:\n`1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`\n`2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`",
3021
- "example": "",
3021
+ "example": "1",
3022
3022
  "member": "int64",
3023
3023
  "name": "UrlType",
3024
3024
  "required": false,
@@ -3154,7 +3154,7 @@
3154
3154
  {
3155
3155
  "disabled": false,
3156
3156
  "document": "禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。",
3157
- "example": "",
3157
+ "example": "true",
3158
3158
  "member": "bool",
3159
3159
  "name": "ForbidPersonalMultipleSign",
3160
3160
  "required": false,
@@ -3219,7 +3219,7 @@
3219
3219
  {
3220
3220
  "disabled": false,
3221
3221
  "document": "请指定需执行批量签署的流程ID,数量范围为1-100。 您可登录腾讯电子签控制台,浏览 \"合同\"->\"合同中心\" 以查阅某一合同的FlowId(在页面中显示为合同ID)。 用户将利用链接对这些合同实施批量操作。\t",
3222
- "example": "",
3222
+ "example": "[yDxxxxxxxxxxxxxxxxxxxxxxxx]",
3223
3223
  "member": "string",
3224
3224
  "name": "FlowIds",
3225
3225
  "required": false,
@@ -3228,7 +3228,7 @@
3228
3228
  {
3229
3229
  "disabled": false,
3230
3230
  "document": "第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。\n\n<ul>\n<li>1. 若OpenId为空,Name和Mobile 必须提供。</li>\n<li>2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。\t</li>\n</ul>",
3231
- "example": "",
3231
+ "example": "user_open_id",
3232
3232
  "member": "string",
3233
3233
  "name": "OpenId",
3234
3234
  "required": false,
@@ -3237,7 +3237,7 @@
3237
3237
  {
3238
3238
  "disabled": false,
3239
3239
  "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n注:`请确保和合同中填入的一致`",
3240
- "example": "",
3240
+ "example": "张三",
3241
3241
  "member": "string",
3242
3242
  "name": "Name",
3243
3243
  "required": false,
@@ -3246,7 +3246,7 @@
3246
3246
  {
3247
3247
  "disabled": false,
3248
3248
  "document": "员工手机号,必须与姓名一起使用。 如果OpenId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。\t",
3249
- "example": "",
3249
+ "example": "13800000000",
3250
3250
  "member": "string",
3251
3251
  "name": "Mobile",
3252
3252
  "required": false,
@@ -3261,7 +3261,7 @@
3261
3261
  {
3262
3262
  "disabled": false,
3263
3263
  "document": "批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。\t",
3264
- "example": "",
3264
+ "example": "https://embed.test.qian.tencent.cn/console/?channel=PROXYCHANNEL&expiredTime=1695805069&code=xxxxx&menuStatus=ENABLE&token=xxxx",
3265
3265
  "member": "string",
3266
3266
  "name": "SignUrl",
3267
3267
  "output_required": true,
@@ -3271,7 +3271,7 @@
3271
3271
  {
3272
3272
  "disabled": false,
3273
3273
  "document": "链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。",
3274
- "example": "",
3274
+ "example": "1695805069",
3275
3275
  "member": "int64",
3276
3276
  "name": "ExpiredTime",
3277
3277
  "output_required": true,
@@ -3308,7 +3308,7 @@
3308
3308
  {
3309
3309
  "disabled": false,
3310
3310
  "document": "二维码下载链接",
3311
- "example": "",
3311
+ "example": "https://dyn.ess.tencent.cn/imgs/channelQrCodes/QrCode/yDw7aUUggsxcdcdnkncdkFtHhG1fJeu.png",
3312
3312
  "member": "string",
3313
3313
  "name": "QrCodeUrl",
3314
3314
  "output_required": false,
@@ -3318,7 +3318,7 @@
3318
3318
  {
3319
3319
  "disabled": false,
3320
3320
  "document": "二维码失效时间 UNIX 时间戳 精确到秒",
3321
- "example": "",
3321
+ "example": "1684401637",
3322
3322
  "member": "int64",
3323
3323
  "name": "ExpiredTime",
3324
3324
  "output_required": false,
@@ -3340,7 +3340,7 @@
3340
3340
  {
3341
3341
  "disabled": false,
3342
3342
  "document": "资源类型,取值有:\n<ul><li> **1**:模板</li>\n<li> **2**:文件(默认值)</li></ul>",
3343
- "example": "",
3343
+ "example": "2",
3344
3344
  "member": "int64",
3345
3345
  "name": "ResourceType",
3346
3346
  "required": true,
@@ -3367,7 +3367,7 @@
3367
3367
  {
3368
3368
  "disabled": false,
3369
3369
  "document": "资源id,与ResourceType相对应,取值范围:\n<ul>\n<li>文件Id(通过UploadFiles获取文件资源Id)</li>\n<li>模板Id(通过控制台创建模板后获取模板Id)</li>\n</ul>\n注意:需要同时设置 ResourceType 参数指定资源类型",
3370
- "example": "",
3370
+ "example": "yDwqFUUckp3em41rUwWPgIBjsYgG5bba",
3371
3371
  "member": "string",
3372
3372
  "name": "ResourceId",
3373
3373
  "required": false,
@@ -3394,7 +3394,7 @@
3394
3394
  {
3395
3395
  "disabled": false,
3396
3396
  "document": "合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接\n注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`",
3397
- "example": "",
3397
+ "example": "yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT",
3398
3398
  "member": "string",
3399
3399
  "name": "FlowId",
3400
3400
  "required": false,
@@ -3436,7 +3436,7 @@
3436
3436
  {
3437
3437
  "disabled": false,
3438
3438
  "document": "发起的合同嵌入链接, 可以直接点击进入进行合同发起, 有效期为5分钟",
3439
- "example": "",
3439
+ "example": "https://embed.beta.qian.tencent.cn/contract-create?code=yDCNBUUckpvlzt0sUypjGZRCTkEHyRh6",
3440
3440
  "member": "string",
3441
3441
  "name": "PrepareFlowUrl",
3442
3442
  "output_required": true,
@@ -3446,7 +3446,7 @@
3446
3446
  {
3447
3447
  "disabled": false,
3448
3448
  "document": "合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果, 有效期为5分钟",
3449
- "example": "",
3449
+ "example": "embed.beta.qian.tencent.cn/xxxxx(后省略)",
3450
3450
  "member": "string",
3451
3451
  "name": "PreviewFlowUrl",
3452
3452
  "output_required": true,
@@ -3456,7 +3456,7 @@
3456
3456
  {
3457
3457
  "disabled": false,
3458
3458
  "document": "发起的合同临时Id, 只有当点击进入链接,成功发起合同后, 此Id才有效",
3459
- "example": "",
3459
+ "example": "yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT",
3460
3460
  "member": "string",
3461
3461
  "name": "FlowId",
3462
3462
  "output_required": false,
@@ -3487,7 +3487,7 @@
3487
3487
  {
3488
3488
  "disabled": false,
3489
3489
  "document": "个人用户姓名",
3490
- "example": "",
3490
+ "example": "张三",
3491
3491
  "member": "string",
3492
3492
  "name": "UserName",
3493
3493
  "required": true,
@@ -3496,7 +3496,7 @@
3496
3496
  {
3497
3497
  "disabled": false,
3498
3498
  "document": "证件号码, 应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
3499
- "example": "",
3499
+ "example": "620000198802020000",
3500
3500
  "member": "string",
3501
3501
  "name": "IdCardNumber",
3502
3502
  "required": true,
@@ -3505,7 +3505,7 @@
3505
3505
  {
3506
3506
  "disabled": false,
3507
3507
  "document": "电子印章名字,1-50个中文字符\n注:`同一企业下电子印章名字不能相同`",
3508
- "example": "",
3508
+ "example": "我的印章名称",
3509
3509
  "member": "string",
3510
3510
  "name": "SealName",
3511
3511
  "required": true,
@@ -3514,7 +3514,7 @@
3514
3514
  {
3515
3515
  "disabled": false,
3516
3516
  "document": "电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式。\n\n",
3517
- "example": "",
3517
+ "example": "aHR0cHM6Ly9jYXBpLndvYS5jb20vhaWwlM0ZpZCUzRGVzc2Jhc2ljJTI2dGFiJTNEYXBp..图片base64省略",
3518
3518
  "member": "string",
3519
3519
  "name": "SealImage",
3520
3520
  "required": true,
@@ -3532,7 +3532,7 @@
3532
3532
  {
3533
3533
  "disabled": false,
3534
3534
  "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>\n<li>OTHER_CARD_TYPE : 其他</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
3535
- "example": "",
3535
+ "example": "ID_CARD",
3536
3536
  "member": "string",
3537
3537
  "name": "IdCardType",
3538
3538
  "required": false,
@@ -3541,7 +3541,7 @@
3541
3541
  {
3542
3542
  "disabled": false,
3543
3543
  "document": "是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。",
3544
- "example": "",
3544
+ "example": "false",
3545
3545
  "member": "bool",
3546
3546
  "name": "SealImageCompress",
3547
3547
  "required": false,
@@ -3550,7 +3550,7 @@
3550
3550
  {
3551
3551
  "disabled": false,
3552
3552
  "document": "手机号码;当需要开通自动签时,该参数必传",
3553
- "example": "",
3553
+ "example": "18888888888",
3554
3554
  "member": "string",
3555
3555
  "name": "Mobile",
3556
3556
  "required": false,
@@ -3559,7 +3559,7 @@
3559
3559
  {
3560
3560
  "disabled": false,
3561
3561
  "document": "此字段已废弃,请勿继续使用。",
3562
- "example": "",
3562
+ "example": "字段已废弃",
3563
3563
  "member": "bool",
3564
3564
  "name": "EnableAutoSign",
3565
3565
  "required": false,
@@ -3568,7 +3568,7 @@
3568
3568
  {
3569
3569
  "disabled": false,
3570
3570
  "document": "设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减\t",
3571
- "example": "",
3571
+ "example": "0",
3572
3572
  "member": "int64",
3573
3573
  "name": "LicenseType",
3574
3574
  "required": false,
@@ -3592,7 +3592,7 @@
3592
3592
  {
3593
3593
  "disabled": false,
3594
3594
  "document": "电子印章ID,为32位字符串。\n建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。\n可登录腾讯电子签控制台,在 \"印章\"->\"印章中心\"选择查看的印章,在\"印章详情\" 中查看某个印章的SealId(在页面中展示为印章ID)。",
3595
- "example": "",
3595
+ "example": "yDCYIUUckp7t75mxUxAAGY1B8z3p0AIA",
3596
3596
  "member": "string",
3597
3597
  "name": "SealId",
3598
3598
  "output_required": true,
@@ -3686,7 +3686,7 @@
3686
3686
  {
3687
3687
  "disabled": false,
3688
3688
  "document": "调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。\n\n回调的相关说明可参考开发者中心的<a href=\"https://qian.tencent.com/developers/company/callback_types_v2\" target=\"_blank\">回调通知</a>模块。",
3689
- "example": "",
3689
+ "example": "eyJDb21lRnJvbSI6Inh4eCJ9",
3690
3690
  "member": "string",
3691
3691
  "name": "UserData",
3692
3692
  "required": false,
@@ -3723,7 +3723,7 @@
3723
3723
  {
3724
3724
  "disabled": false,
3725
3725
  "document": "角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。",
3726
- "example": "",
3726
+ "example": "张三",
3727
3727
  "member": "string",
3728
3728
  "name": "Name",
3729
3729
  "required": true,
@@ -3741,7 +3741,7 @@
3741
3741
  {
3742
3742
  "disabled": false,
3743
3743
  "document": "角色描述,最大长度为50个字符",
3744
- "example": "",
3744
+ "example": "这是一个XXXX角色",
3745
3745
  "member": "string",
3746
3746
  "name": "Description",
3747
3747
  "required": false,
@@ -3765,7 +3765,7 @@
3765
3765
  {
3766
3766
  "disabled": false,
3767
3767
  "document": "角色id",
3768
- "example": "",
3768
+ "example": "abc8jkkjds***121212",
3769
3769
  "member": "string",
3770
3770
  "name": "RoleId",
3771
3771
  "output_required": false,
@@ -3796,7 +3796,7 @@
3796
3796
  {
3797
3797
  "disabled": false,
3798
3798
  "document": "电子印章ID,为32位字符串。\n建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。\n可登录腾讯电子签控制台,在 \"印章\"->\"印章中心\"选择查看的印章,在\"印章详情\" 中查看某个印章的SealId(在页面中展示为印章ID)。",
3799
- "example": "",
3799
+ "example": "yDRTZxxxxxJNR",
3800
3800
  "member": "string",
3801
3801
  "name": "SealId",
3802
3802
  "required": true,
@@ -3805,7 +3805,7 @@
3805
3805
  {
3806
3806
  "disabled": false,
3807
3807
  "document": "\n员工在腾讯电子签平台的唯一身份标识,为32位字符串。\n可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查看某位员工的UserId(在页面中展示为用户ID)。\n员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。\n该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。\n指定待授权的用户ID数组,电子签的用户ID\n可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权。",
3808
- "example": "",
3808
+ "example": "[yDdzlxxxxxopk]",
3809
3809
  "member": "string",
3810
3810
  "name": "UserIds",
3811
3811
  "required": true,
@@ -3838,7 +3838,7 @@
3838
3838
  {
3839
3839
  "disabled": false,
3840
3840
  "document": "最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的。\n请求参数填写OpenId时,返回授权成功的 Openid。",
3841
- "example": "",
3841
+ "example": "[yDdzlxxxxxopk]",
3842
3842
  "member": "string",
3843
3843
  "name": "UserIds",
3844
3844
  "output_required": true,
@@ -3905,7 +3905,7 @@
3905
3905
  {
3906
3906
  "disabled": false,
3907
3907
  "document": "是否通知开通方,通知类型:<ul><li>默认为不通知开通方</li><li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>",
3908
- "example": "",
3908
+ "example": "SMS",
3909
3909
  "member": "string",
3910
3910
  "name": "NotifyType",
3911
3911
  "required": false,
@@ -3923,7 +3923,7 @@
3923
3923
  {
3924
3924
  "disabled": false,
3925
3925
  "document": "链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`",
3926
- "example": "",
3926
+ "example": "1693290580",
3927
3927
  "member": "int64",
3928
3928
  "name": "ExpiredTime",
3929
3929
  "required": false,
@@ -3932,7 +3932,7 @@
3932
3932
  {
3933
3933
  "disabled": false,
3934
3934
  "document": "调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中,该字段的信息将原封不动地透传给贵方。 ",
3935
- "example": "",
3935
+ "example": "MTIzNDU2Nzg5",
3936
3936
  "member": "string",
3937
3937
  "name": "UserData",
3938
3938
  "required": false,
@@ -3957,7 +3957,7 @@
3957
3957
  {
3958
3958
  "disabled": false,
3959
3959
  "document": "腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用\n\n注: `如果获取的是H5链接, 则不会返回此值`",
3960
- "example": "",
3960
+ "example": "wxa02378y4jruwye1d",
3961
3961
  "member": "string",
3962
3962
  "name": "AppId",
3963
3963
  "output_required": true,
@@ -3967,7 +3967,7 @@
3967
3967
  {
3968
3968
  "disabled": false,
3969
3969
  "document": "腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用\n\n注: `如果获取的是H5链接, 则不会返回此值`",
3970
- "example": "",
3970
+ "example": "gh_da87293fsd87987",
3971
3971
  "member": "string",
3972
3972
  "name": "AppOriginalId",
3973
3973
  "output_required": true,
@@ -3977,7 +3977,7 @@
3977
3977
  {
3978
3978
  "disabled": false,
3979
3979
  "document": "腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用\n\n注: `如果获取的是H5链接, 则不会返回此值`",
3980
- "example": "",
3980
+ "example": "page?abc=123&def=456",
3981
3981
  "member": "string",
3982
3982
  "name": "Path",
3983
3983
  "output_required": true,
@@ -3987,7 +3987,7 @@
3987
3987
  {
3988
3988
  "disabled": false,
3989
3989
  "document": "base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。\n\n注: `如果获取的是H5链接, 则不会返回此二维码图片`",
3990
- "example": "",
3990
+ "example": "EBAQAAAAAAAAAAAQIDBAUGBwgJCgsQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCN",
3991
3991
  "member": "string",
3992
3992
  "name": "QrCode",
3993
3993
  "output_required": true,
@@ -3997,7 +3997,7 @@
3997
3997
  {
3998
3998
  "disabled": false,
3999
3999
  "document": "返回的链接类型\n<ul><li> 空: 默认小程序端链接</li>\n<li> **H5SIGN** : h5端链接</li></ul>",
4000
- "example": "",
4000
+ "example": "H5SIGN",
4001
4001
  "member": "string",
4002
4002
  "name": "UrlType",
4003
4003
  "output_required": true,
@@ -4055,7 +4055,7 @@
4055
4055
  {
4056
4056
  "disabled": false,
4057
4057
  "document": "链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`",
4058
- "example": "",
4058
+ "example": "1695783727",
4059
4059
  "member": "int64",
4060
4060
  "name": "ExpiredTime",
4061
4061
  "required": false,
@@ -4070,7 +4070,7 @@
4070
4070
  {
4071
4071
  "disabled": false,
4072
4072
  "document": "腾讯电子签小程序的AppId,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。",
4073
- "example": "",
4073
+ "example": "wxa023******e1d",
4074
4074
  "member": "string",
4075
4075
  "name": "AppId",
4076
4076
  "output_required": false,
@@ -4080,7 +4080,7 @@
4080
4080
  {
4081
4081
  "disabled": false,
4082
4082
  "document": "腾讯电子签小程序的原始Id,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。",
4083
- "example": "",
4083
+ "example": "gh_da87*******987",
4084
4084
  "member": "string",
4085
4085
  "name": "AppOriginalId",
4086
4086
  "output_required": false,
@@ -4100,7 +4100,7 @@
4100
4100
  {
4101
4101
  "disabled": false,
4102
4102
  "document": "腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。",
4103
- "example": "",
4103
+ "example": "page?abc=123&def=456",
4104
4104
  "member": "string",
4105
4105
  "name": "Path",
4106
4106
  "output_required": false,
@@ -4110,7 +4110,7 @@
4110
4110
  {
4111
4111
  "disabled": false,
4112
4112
  "document": "base64格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。",
4113
- "example": "",
4113
+ "example": "EBAQAAAAAAAAAAAQIDBAUGBwgxxxxxwAEEQUSITFBBhNRYQcicRQygZGhCCN",
4114
4114
  "member": "string",
4115
4115
  "name": "QrCode",
4116
4116
  "output_required": false,
@@ -4141,7 +4141,7 @@
4141
4141
  {
4142
4142
  "disabled": false,
4143
4143
  "document": "绑定角色的角色id列表,最多 100 个",
4144
- "example": "",
4144
+ "example": "[ywk9kdki323****k239239]",
4145
4145
  "member": "string",
4146
4146
  "name": "RoleIds",
4147
4147
  "required": true,
@@ -4150,7 +4150,7 @@
4150
4150
  {
4151
4151
  "disabled": false,
4152
4152
  "document": "电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数,最多 100 个",
4153
- "example": "",
4153
+ "example": "[ywksdkj1001***103kd]",
4154
4154
  "member": "string",
4155
4155
  "name": "UserIds",
4156
4156
  "required": false,
@@ -4159,7 +4159,7 @@
4159
4159
  {
4160
4160
  "disabled": false,
4161
4161
  "document": "客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数,最多 100 个",
4162
- "example": "",
4162
+ "example": "[test_openid]",
4163
4163
  "member": "string",
4164
4164
  "name": "OpenIds",
4165
4165
  "required": false,
@@ -4214,7 +4214,7 @@
4214
4214
  {
4215
4215
  "disabled": false,
4216
4216
  "document": "主题类型<br/>EMBED_WEB_THEME:嵌入式主题\n<ul>\n<li>EMBED_WEB_THEME,web页面嵌入的主题风格配置</li>\n<li>COMPANY_AUTHENTICATE,子客认证主题配置, 对当前第三方应用号生效,\n目前支持的有,背景图替换,隐藏企业认证页面导航栏和隐藏企业认证顶部logo</li>\n</ul>",
4217
- "example": "",
4217
+ "example": "EMBED_WEB_THEME",
4218
4218
  "member": "string",
4219
4219
  "name": "ThemeType",
4220
4220
  "required": true,
@@ -4259,7 +4259,7 @@
4259
4259
  {
4260
4260
  "disabled": false,
4261
4261
  "document": "角色id,最多20个",
4262
- "example": "",
4262
+ "example": "[yDxZ1UyKQDSIMfUuO4zjEw2TyqzKEs16]",
4263
4263
  "member": "string",
4264
4264
  "name": "RoleIds",
4265
4265
  "required": true,
@@ -4295,7 +4295,7 @@
4295
4295
  {
4296
4296
  "disabled": false,
4297
4297
  "document": "角色Id(非超管或法人角色Id)",
4298
- "example": "",
4298
+ "example": "ywkdkfd****sdkljfks",
4299
4299
  "member": "string",
4300
4300
  "name": "RoleId",
4301
4301
  "required": true,
@@ -4304,7 +4304,7 @@
4304
4304
  {
4305
4305
  "disabled": false,
4306
4306
  "document": "电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数,最多两百",
4307
- "example": "",
4307
+ "example": "[ywd8k13jkds****39kdf]",
4308
4308
  "member": "string",
4309
4309
  "name": "UserIds",
4310
4310
  "required": false,
@@ -4322,7 +4322,7 @@
4322
4322
  {
4323
4323
  "disabled": false,
4324
4324
  "document": "客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数,最多两百",
4325
- "example": "",
4325
+ "example": "[test_openid1, test_openid2]",
4326
4326
  "member": "string",
4327
4327
  "name": "OpenIds",
4328
4328
  "required": false,
@@ -4337,7 +4337,7 @@
4337
4337
  {
4338
4338
  "disabled": false,
4339
4339
  "document": "角色id",
4340
- "example": "",
4340
+ "example": "ywkdkfd****sdkljfks",
4341
4341
  "member": "string",
4342
4342
  "name": "RoleId",
4343
4343
  "output_required": true,
@@ -4368,7 +4368,7 @@
4368
4368
  {
4369
4369
  "disabled": false,
4370
4370
  "document": "操作的印章ID",
4371
- "example": "",
4371
+ "example": "yDRSRUUgygj******uO4zjEuBzwyiofZ",
4372
4372
  "member": "string",
4373
4373
  "name": "SealId",
4374
4374
  "required": true,
@@ -4377,7 +4377,7 @@
4377
4377
  {
4378
4378
  "disabled": false,
4379
4379
  "document": "需要删除授权的用户ID数组,可以传入电子签系统用户ID或OpenId。\n注: \n1. `填写OpenId时,系统会通过组织+渠道+OpenId查询得到对应的UserId进行授权取消操作`",
4380
- "example": "",
4380
+ "example": "[yDxbWUyKQDx7OZUuO4zjESvEkRMHc55R]",
4381
4381
  "member": "string",
4382
4382
  "name": "UserIds",
4383
4383
  "required": true,
@@ -4600,7 +4600,7 @@
4600
4600
  {
4601
4601
  "disabled": false,
4602
4602
  "document": "指定分页每页返回的数据条数,单页最大支持 20。",
4603
- "example": "",
4603
+ "example": "10",
4604
4604
  "member": "int64",
4605
4605
  "name": "Limit",
4606
4606
  "required": true,
@@ -4618,7 +4618,7 @@
4618
4618
  {
4619
4619
  "disabled": false,
4620
4620
  "document": "指定分页返回第几页的数据,如果不传默认返回第一页。\n页码从 0 开始,即首页为 0,最大20000。",
4621
- "example": "",
4621
+ "example": "0",
4622
4622
  "member": "int64",
4623
4623
  "name": "Offset",
4624
4624
  "required": false,
@@ -4641,28 +4641,28 @@
4641
4641
  "members": [
4642
4642
  {
4643
4643
  "disabled": false,
4644
- "document": "员工信息列表。\n注意:此字段可能返回 null,表示取不到有效值。",
4644
+ "document": "员工信息列表。",
4645
4645
  "example": "无",
4646
4646
  "member": "Staff",
4647
4647
  "name": "Employees",
4648
4648
  "output_required": true,
4649
4649
  "type": "list",
4650
- "value_allowed_null": true
4650
+ "value_allowed_null": false
4651
4651
  },
4652
4652
  {
4653
4653
  "disabled": false,
4654
- "document": "指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000。\n注意:此字段可能返回 null,表示取不到有效值。",
4655
- "example": "",
4654
+ "document": "指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000",
4655
+ "example": "0",
4656
4656
  "member": "int64",
4657
4657
  "name": "Offset",
4658
4658
  "output_required": true,
4659
4659
  "type": "int",
4660
- "value_allowed_null": true
4660
+ "value_allowed_null": false
4661
4661
  },
4662
4662
  {
4663
4663
  "disabled": false,
4664
4664
  "document": "指定分页每页返回的数据条数,单页最大支持 20。",
4665
- "example": "",
4665
+ "example": "10",
4666
4666
  "member": "int64",
4667
4667
  "name": "Limit",
4668
4668
  "output_required": true,
@@ -4672,7 +4672,7 @@
4672
4672
  {
4673
4673
  "disabled": false,
4674
4674
  "document": "符合条件的员工数量。",
4675
- "example": "",
4675
+ "example": "1",
4676
4676
  "member": "int64",
4677
4677
  "name": "TotalCount",
4678
4678
  "output_required": true,
@@ -4703,7 +4703,7 @@
4703
4703
  {
4704
4704
  "disabled": false,
4705
4705
  "document": "需要获取填写控件填写内容的合同流程ID",
4706
- "example": "",
4706
+ "example": "yDSLZUUckpotjxzmUuyfZGu1pDwX4bPk",
4707
4707
  "member": "string",
4708
4708
  "name": "FlowId",
4709
4709
  "required": true,
@@ -4850,7 +4850,7 @@
4850
4850
  {
4851
4851
  "disabled": false,
4852
4852
  "document": "指定每页返回的数据条数,和Offset参数配合使用,单页最大200。\n\n注: `因为历史原因, 此字段为字符串类型`",
4853
- "example": "",
4853
+ "example": "10",
4854
4854
  "member": "string",
4855
4855
  "name": "Limit",
4856
4856
  "required": true,
@@ -4868,7 +4868,7 @@
4868
4868
  {
4869
4869
  "disabled": false,
4870
4870
  "document": "查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。\n\n注:\n1.`offset从0开始,即第一页为0。`\n2.`默认从第一页返回。`",
4871
- "example": "",
4871
+ "example": "0",
4872
4872
  "member": "uint64",
4873
4873
  "name": "Offset",
4874
4874
  "required": false,
@@ -4892,7 +4892,7 @@
4892
4892
  {
4893
4893
  "disabled": false,
4894
4894
  "document": "查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。",
4895
- "example": "",
4895
+ "example": "0",
4896
4896
  "member": "uint64",
4897
4897
  "name": "Offset",
4898
4898
  "output_required": true,
@@ -4902,7 +4902,7 @@
4902
4902
  {
4903
4903
  "disabled": false,
4904
4904
  "document": "指定每页返回的数据条数,和Offset参数配合使用,单页最大200。",
4905
- "example": "",
4905
+ "example": "10",
4906
4906
  "member": "uint64",
4907
4907
  "name": "Limit",
4908
4908
  "output_required": true,
@@ -4912,7 +4912,7 @@
4912
4912
  {
4913
4913
  "disabled": false,
4914
4914
  "document": "查询角色的总数量",
4915
- "example": "",
4915
+ "example": "1",
4916
4916
  "member": "uint64",
4917
4917
  "name": "TotalCount",
4918
4918
  "output_required": true,
@@ -4921,13 +4921,13 @@
4921
4921
  },
4922
4922
  {
4923
4923
  "disabled": false,
4924
- "document": "查询的角色信息列表\n注意:此字段可能返回 null,表示取不到有效值。",
4924
+ "document": "查询的角色信息列表",
4925
4925
  "example": "无",
4926
4926
  "member": "ChannelRole",
4927
4927
  "name": "ChannelRoles",
4928
4928
  "output_required": true,
4929
4929
  "type": "list",
4930
- "value_allowed_null": true
4930
+ "value_allowed_null": false
4931
4931
  },
4932
4932
  {
4933
4933
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -4976,23 +4976,23 @@
4976
4976
  "members": [
4977
4977
  {
4978
4978
  "disabled": false,
4979
- "document": "核身视频结果。\n注意:此字段可能返回 null,表示取不到有效值。",
4979
+ "document": "核身视频结果。",
4980
4980
  "example": "无",
4981
4981
  "member": "DetectInfoVideoData",
4982
4982
  "name": "VideoData",
4983
4983
  "output_required": false,
4984
4984
  "type": "object",
4985
- "value_allowed_null": true
4985
+ "value_allowed_null": false
4986
4986
  },
4987
4987
  {
4988
4988
  "disabled": false,
4989
- "document": "意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
4989
+ "document": "意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。",
4990
4990
  "example": "无",
4991
4991
  "member": "IntentionQuestionResult",
4992
4992
  "name": "IntentionQuestionResult",
4993
4993
  "output_required": false,
4994
4994
  "type": "object",
4995
- "value_allowed_null": true
4995
+ "value_allowed_null": false
4996
4996
  },
4997
4997
  {
4998
4998
  "disabled": false,
@@ -5186,7 +5186,7 @@
5186
5186
  {
5187
5187
  "disabled": false,
5188
5188
  "document": "转换任务Id,通过接口<a href=\"https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>得到的转换任务id",
5189
- "example": "yDwivUUckpo2v2bhUx8pIP8vBdA0hGSe",
5189
+ "example": "20250113111955261408",
5190
5190
  "member": "string",
5191
5191
  "name": "TaskId",
5192
5192
  "required": true,
@@ -5258,13 +5258,13 @@
5258
5258
  },
5259
5259
  {
5260
5260
  "disabled": true,
5261
- "document": "预览文件Url,有效期30分钟 \n当前字段返回为空,发起的时候,将ResourceId 放入发起即可\n注意:此字段可能返回 null,表示取不到有效值。",
5262
- "example": "http://xxx.com",
5261
+ "document": "预览文件Url,有效期30分钟 \n当前字段返回为空,发起的时候,将ResourceId 放入发起即可",
5262
+ "example": "http://xxx.com/1.jpg",
5263
5263
  "member": "string",
5264
5264
  "name": "PreviewUrl",
5265
5265
  "output_required": true,
5266
5266
  "type": "string",
5267
- "value_allowed_null": true
5267
+ "value_allowed_null": false
5268
5268
  },
5269
5269
  {
5270
5270
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -5332,7 +5332,7 @@
5332
5332
  {
5333
5333
  "disabled": false,
5334
5334
  "document": "角色id",
5335
- "example": "",
5335
+ "example": "189756**32",
5336
5336
  "member": "string",
5337
5337
  "name": "RoleId",
5338
5338
  "output_required": false,
@@ -5387,7 +5387,7 @@
5387
5387
  {
5388
5388
  "disabled": false,
5389
5389
  "document": "企业的统一社会信用代码",
5390
- "example": "",
5390
+ "example": "X1440101304662708B",
5391
5391
  "member": "string",
5392
5392
  "name": "UnifiedSocialCreditCode",
5393
5393
  "output_required": false,
@@ -5486,7 +5486,7 @@
5486
5486
  {
5487
5487
  "disabled": false,
5488
5488
  "document": "账号到期时间,时间戳",
5489
- "example": "",
5489
+ "example": "1702366386",
5490
5490
  "member": "int64",
5491
5491
  "name": "LicenseExpireTime",
5492
5492
  "output_required": false,
@@ -5512,7 +5512,7 @@
5512
5512
  {
5513
5513
  "disabled": false,
5514
5514
  "document": "自动签使用的场景值, 可以选择的场景值如下:\n<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>",
5515
- "example": "",
5515
+ "example": "E_PRESCRIPTION_AUTO_SIGN",
5516
5516
  "member": "string",
5517
5517
  "name": "SceneKey",
5518
5518
  "required": true,
@@ -5545,7 +5545,7 @@
5545
5545
  {
5546
5546
  "disabled": false,
5547
5547
  "document": "续期成功后自动签许可到期时间。当且仅当已通过许可开通自动签时有值。\n\n值为unix时间戳,单位为秒。",
5548
- "example": "",
5548
+ "example": "1716884877",
5549
5549
  "member": "int64",
5550
5550
  "name": "LicenseTo",
5551
5551
  "output_required": false,
@@ -5587,7 +5587,7 @@
5587
5587
  {
5588
5588
  "disabled": false,
5589
5589
  "document": "此角色状态\n1: 已经启用\n2: 已经禁用",
5590
- "example": "",
5590
+ "example": "1",
5591
5591
  "member": "uint64",
5592
5592
  "name": "RoleStatus",
5593
5593
  "output_required": true,
@@ -5631,7 +5631,7 @@
5631
5631
  {
5632
5632
  "disabled": false,
5633
5633
  "document": "印章ID",
5634
- "example": "",
5634
+ "example": "yDRTZxxxxxJNR",
5635
5635
  "member": "string",
5636
5636
  "name": "SealId",
5637
5637
  "required": true,
@@ -5676,7 +5676,7 @@
5676
5676
  {
5677
5677
  "disabled": false,
5678
5678
  "document": "合同流程ID,为32位字符串。",
5679
- "example": "",
5679
+ "example": "yDSLWUUckposmpkvUyb9xvpEQeni94od",
5680
5680
  "member": "string",
5681
5681
  "name": "FlowId",
5682
5682
  "required": true,
@@ -5709,7 +5709,7 @@
5709
5709
  {
5710
5710
  "disabled": false,
5711
5711
  "document": "验签结果代码,代码的含义如下:\n\n<ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>\n<li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>\n<li>**3**:文件被篡改。</li>\n<li>**4**:异常:文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>\n<li>**5**:异常:文件签名格式错误。</li></ul>",
5712
- "example": "",
5712
+ "example": "4",
5713
5713
  "member": "int64",
5714
5714
  "name": "VerifyResult",
5715
5715
  "output_required": true,
@@ -5729,7 +5729,7 @@
5729
5729
  {
5730
5730
  "disabled": false,
5731
5731
  "document": "验签序列号, 为11为数组组成的字符串",
5732
- "example": "",
5732
+ "example": "16992542542544",
5733
5733
  "member": "string",
5734
5734
  "name": "VerifySerialNo",
5735
5735
  "output_required": false,
@@ -5761,12 +5761,11 @@
5761
5761
  {
5762
5762
  "disabled": false,
5763
5763
  "document": "是否允许修改签署人信息",
5764
- "example": "",
5764
+ "example": "true",
5765
5765
  "member": "bool",
5766
5766
  "name": "CanEditApprover",
5767
5767
  "required": false,
5768
- "type": "bool",
5769
- "value_allowed_null": true
5768
+ "type": "bool"
5770
5769
  }
5771
5770
  ],
5772
5771
  "usage": "in"
@@ -6141,7 +6140,7 @@
6141
6140
  {
6142
6141
  "disabled": false,
6143
6142
  "document": "**如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。\n注意: `向左调整设置为负数, 向右调整设置成正数`",
6144
- "example": "",
6143
+ "example": "0",
6145
6144
  "member": "float",
6146
6145
  "name": "OffsetX",
6147
6146
  "output_required": true,
@@ -6152,7 +6151,7 @@
6152
6151
  {
6153
6152
  "disabled": false,
6154
6153
  "document": "**如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。\n注意: `向上调整设置为负数, 向下调整设置成正数`",
6155
- "example": "",
6154
+ "example": "0",
6156
6155
  "member": "float",
6157
6156
  "name": "OffsetY",
6158
6157
  "output_required": true,
@@ -6163,7 +6162,7 @@
6163
6162
  {
6164
6163
  "disabled": false,
6165
6164
  "document": "<font color=\"red\">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识",
6166
- "example": "",
6165
+ "example": "componentId1",
6167
6166
  "member": "string",
6168
6167
  "name": "ChannelComponentId",
6169
6168
  "output_required": true,
@@ -6185,7 +6184,7 @@
6185
6184
  {
6186
6185
  "disabled": false,
6187
6186
  "document": "**如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
6188
- "example": "",
6187
+ "example": "0",
6189
6188
  "member": "int64",
6190
6189
  "name": "KeywordPage",
6191
6190
  "output_required": true,
@@ -6196,7 +6195,7 @@
6196
6195
  {
6197
6196
  "disabled": false,
6198
6197
  "document": "**如果控件是关键字定位方式**,关键字生成的区域的对齐方式, 可以设置下面的值\n<ul><li> <b>Middle</b> :居中</li>\n<li> <b>Below</b> :正下方</li>\n<li> <b>Right</b> :正右方</li>\n<li> <b>LowerRight</b> :右下角</li>\n<li> <b>UpperRight</b> :右上角。</li></ul>\n示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方",
6199
- "example": "",
6198
+ "example": "Middle",
6200
6199
  "member": "string",
6201
6200
  "name": "RelativeLocation",
6202
6201
  "output_required": true,
@@ -6207,7 +6206,7 @@
6207
6206
  {
6208
6207
  "disabled": false,
6209
6208
  "document": "**如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。\n\n注意:关键字索引是从0开始计数的",
6210
- "example": "",
6209
+ "example": "[0]",
6211
6210
  "member": "int64",
6212
6211
  "name": "KeywordIndexes",
6213
6212
  "output_required": true,
@@ -6218,7 +6217,7 @@
6218
6217
  {
6219
6218
  "disabled": false,
6220
6219
  "document": "填写控件在腾讯电子签小程序填写界面展示的提示信息,例如,在身份证号码填写控件中,提示信息可以设置成“请输入18位身份证号码”。\n注:`签署控件设置此字段无效`\n注意:此字段可能返回 null,表示取不到有效值。",
6221
- "example": "",
6220
+ "example": "请签名",
6222
6221
  "member": "string",
6223
6222
  "name": "Placeholder",
6224
6223
  "output_required": true,
@@ -6229,7 +6228,7 @@
6229
6228
  {
6230
6229
  "disabled": false,
6231
6230
  "document": "**web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑\n<ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>\n<li>true:锁定控件值,在页面编辑控件值</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
6232
- "example": "",
6231
+ "example": "false",
6233
6232
  "member": "bool",
6234
6233
  "name": "LockComponentValue",
6235
6234
  "output_required": false,
@@ -6240,7 +6239,7 @@
6240
6239
  {
6241
6240
  "disabled": false,
6242
6241
  "document": "**web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件\n<ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>\n<li> <b>true</b> : 可以移动和删除控件</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
6243
- "example": "",
6242
+ "example": "false",
6244
6243
  "member": "bool",
6245
6244
  "name": "ForbidMoveAndDelete",
6246
6245
  "output_required": false,
@@ -6257,7 +6256,7 @@
6257
6256
  {
6258
6257
  "disabled": false,
6259
6258
  "document": "控件类型,支持以下类型\n<ul><li>SIGN_SEAL : 印章控件</li>\n<li>SIGN_PAGING_SEAL : 骑缝章控件</li>\n<li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>\n<li>SIGN_SIGNATURE : 用户签名控件</li></ul>",
6260
- "example": "",
6259
+ "example": "SIGN_SEAL",
6261
6260
  "member": "string",
6262
6261
  "name": "ComponentType",
6263
6262
  "required": true,
@@ -6266,7 +6265,7 @@
6266
6265
  {
6267
6266
  "disabled": false,
6268
6267
  "document": "签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围\n\n1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)或者以下印章类型\n\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\n注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`\n\n2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)\n\n<ul><li>HANDWRITE : 需要实时手写的手写签名</li>\n<li>HANDWRITTEN_ESIGN : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li>OCR_ESIGN : OCR印章(智慧手写签名)</li>\n<li>ESIGN : 个人印章</li>\n<li>SYSTEM_ESIGN : 系统印章</li></ul>\n\n3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。",
6269
- "example": "",
6268
+ "example": "[\"HANDWRITE\", \"ESIGN\"]",
6270
6269
  "member": "string",
6271
6270
  "name": "ComponentValue",
6272
6271
  "required": false,
@@ -6290,7 +6289,7 @@
6290
6289
  {
6291
6290
  "disabled": false,
6292
6291
  "document": "初始化操作类型\n<ul>\n<li>CREATE_SEAL : 创建印章</li>\n<li>OPEN_AUTO_SIGN :开通企业自动签署</li>\n<li>PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权自动签</li>\n</ul>",
6293
- "example": "",
6292
+ "example": "[OPEN_AUTO_SIGN, AUTH_JOIN_ORGANIZATION_GROUP, CREATE_SEAL]",
6294
6293
  "member": "string",
6295
6294
  "name": "OperateTypes",
6296
6295
  "required": true,
@@ -6299,7 +6298,7 @@
6299
6298
  {
6300
6299
  "disabled": false,
6301
6300
  "document": "批量操作的企业列表在第三方平台的企业Id列表,即ProxyOrganizationOpenId列表,最大支持50个",
6302
- "example": "",
6301
+ "example": "[tencent-testorg-cd, tencent-testorg-ca]",
6303
6302
  "member": "string",
6304
6303
  "name": "ProxyOrganizationOpenIds",
6305
6304
  "required": true,
@@ -6308,7 +6307,7 @@
6308
6307
  {
6309
6308
  "disabled": false,
6310
6309
  "document": "当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权自动签时传true。\n![image](https://qcloudimg.tencent-cloud.cn/raw/f9aba7c999a6d79ada20b4384520e120.png)",
6311
- "example": "",
6310
+ "example": "false",
6312
6311
  "member": "bool",
6313
6312
  "name": "IsAuthorizePlatformApplication",
6314
6313
  "required": false,
@@ -6317,7 +6316,7 @@
6317
6316
  {
6318
6317
  "disabled": false,
6319
6318
  "document": "被授权的合作方企业在第三方平台子客企业标识,即ProxyOrganizationOpenId,当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权自动签时必传。\n\n\n",
6320
- "example": "",
6319
+ "example": "org_dianziqian",
6321
6320
  "member": "string",
6322
6321
  "name": "AuthorizedProxyOrganizationOpenId",
6323
6322
  "required": false,
@@ -6342,7 +6341,7 @@
6342
6341
  {
6343
6342
  "disabled": false,
6344
6343
  "document": "操作长链,有效时间为7天",
6345
- "example": "",
6344
+ "example": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=BATCH_INITIALIZATION_ORGANIZATIONS&shortKey=yDCHpURDfyLc5LgBhXb6",
6346
6345
  "member": "string",
6347
6346
  "name": "OperateLongUrl",
6348
6347
  "output_required": true,
@@ -6362,7 +6361,7 @@
6362
6361
  {
6363
6362
  "disabled": false,
6364
6363
  "document": "操作二维码,有效时间为7天",
6365
- "example": "",
6364
+ "example": "https://dyn.ess.tencent.cn/imgs/qrcode_urls/batch_initialization_organizations/yDCHHUUckpacc9ijUuXGmVcuzZCNH5pF.png",
6366
6365
  "member": "string",
6367
6366
  "name": "QRCodeUrl",
6368
6367
  "output_required": true,
@@ -6417,7 +6416,7 @@
6417
6416
  {
6418
6417
  "disabled": false,
6419
6418
  "document": "生成注册链接的任务ID,后序根据这个任务ID, 调用<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls\" target=\"_blank\">查询子企业批量认证链接</a>获取生成的链接,发给对应的客户使用。\n\n注:`如果有错误,则不会返回任务ID`",
6420
- "example": "",
6419
+ "example": "thisisataskid",
6421
6420
  "member": "string",
6422
6421
  "name": "TaskId",
6423
6422
  "output_required": false,
@@ -6427,7 +6426,7 @@
6427
6426
  {
6428
6427
  "disabled": false,
6429
6428
  "document": "批量生成企业认证链接的详细错误信息,顺序与输入参数子企业列表顺序一致。\n<ul>\n<li>如果所有企业认证链接都成功生成,将不返回错误信息</li>\n<li>如果存在任何错误,将返回具体的错误描述。(没有错误的企业返回空字符串)</li>\n</ul>",
6430
- "example": "",
6429
+ "example": "[\"第【1】条注册信息参数错误,地址参数不正确,请确认后再试\", \"第【2】条注册信息参数错误,地址参数不正确,请确认后再试\"]",
6431
6430
  "member": "string",
6432
6431
  "name": "ErrorMessages",
6433
6432
  "output_required": false,
@@ -6490,17 +6489,17 @@
6490
6489
  "members": [
6491
6490
  {
6492
6491
  "disabled": false,
6493
- "document": "出证报告 ID,可用于<a href=\"https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport\" target=\"_blank\">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL\n注意:此字段可能返回 null,表示取不到有效值。",
6492
+ "document": "出证报告 ID,可用于<a href=\"https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport\" target=\"_blank\">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL",
6494
6493
  "example": "yDSLVUUckpo3nva8UEnf33kvzHQ19GcL",
6495
6494
  "member": "string",
6496
6495
  "name": "ReportId",
6497
6496
  "output_required": true,
6498
6497
  "type": "string",
6499
- "value_allowed_null": true
6498
+ "value_allowed_null": false
6500
6499
  },
6501
6500
  {
6502
6501
  "disabled": false,
6503
- "document": "出证任务执行的状态, 状态含义如下:\n\n<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>\n<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>\n<li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>",
6502
+ "document": "出证任务执行的状态, 状态含义如下:\n\n<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>\n<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>\n<li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>",
6504
6503
  "example": "EvidenceStatusExecuting",
6505
6504
  "member": "string",
6506
6505
  "name": "Status",
@@ -6510,13 +6509,13 @@
6510
6509
  },
6511
6510
  {
6512
6511
  "disabled": false,
6513
- "document": "废除,字段无效\n注意:此字段可能返回 null,表示取不到有效值。",
6514
- "example": "",
6512
+ "document": "废除,字段无效",
6513
+ "example": "废除,字段无效",
6515
6514
  "member": "string",
6516
6515
  "name": "ReportUrl",
6517
6516
  "output_required": true,
6518
6517
  "type": "string",
6519
- "value_allowed_null": true
6518
+ "value_allowed_null": false
6520
6519
  },
6521
6520
  {
6522
6521
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -6551,7 +6550,7 @@
6551
6550
  {
6552
6551
  "disabled": false,
6553
6552
  "document": "变更链接类型:\n<ul>\n<li>**WEIXINAPP** : 创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。(默认)</li>\n<li>**APP** : 创建变更小程序链接,可从第三方App或者小程序跳转到微信腾讯电子签小程序进行更换。</li>\n</ul>",
6554
- "example": "",
6553
+ "example": "APP",
6555
6554
  "member": "string",
6556
6555
  "name": "Endpoint",
6557
6556
  "required": false,
@@ -6607,7 +6606,7 @@
6607
6606
  {
6608
6607
  "disabled": false,
6609
6608
  "document": "要进行激活或者续期的子客企业OrganizationOpenId列表,请确保所有列出的子客企业均已完成认证。",
6610
- "example": "",
6609
+ "example": "[org_zhangsan, org_lisi]",
6611
6610
  "member": "string",
6612
6611
  "name": "SubOrganizationOpenIds",
6613
6612
  "required": false,
@@ -6616,7 +6615,7 @@
6616
6615
  {
6617
6616
  "disabled": false,
6618
6617
  "document": "操作类型,可以选择如下:\n\n**false**:(默认)激活子客企业\n**true**:续期子客企业\n",
6619
- "example": "",
6618
+ "example": "true",
6620
6619
  "member": "bool",
6621
6620
  "name": "Renew",
6622
6621
  "required": false,
@@ -6748,7 +6747,7 @@
6748
6747
  {
6749
6748
  "disabled": false,
6750
6749
  "document": "子客企业统一社会信用代码,最大长度200个字符\n注意:`如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效`。",
6751
- "example": "",
6750
+ "example": "9XXXXXXXXXXXXXXXX1",
6752
6751
  "member": "string",
6753
6752
  "name": "UniformSocialCreditCode",
6754
6753
  "required": false,
@@ -6811,7 +6810,7 @@
6811
6810
  {
6812
6811
  "disabled": false,
6813
6812
  "document": "触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:\n<ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>",
6814
- "example": "",
6813
+ "example": "VERIFIED",
6815
6814
  "member": "string",
6816
6815
  "name": "AutoJumpBackEvent",
6817
6816
  "required": false,
@@ -6820,7 +6819,7 @@
6820
6819
  {
6821
6820
  "disabled": false,
6822
6821
  "document": "可选的此企业允许的授权方式, 可以设置的方式有:\n<ul><li>1:上传授权书</li>\n<li>2:转法定代表人授权</li>\n<li>4:企业实名认证(信任第三方认证源)(此项有排他性, 选择后不能增添其他的方式)</li></ul>\n注:<ul>\n<li>未选择信任第三方认证源时,如果是法人进行企业激活,仅支持法人扫脸直接授权,该配置不对此法人生效`</li>\n<li>选择信任第三方认证源时,请先通过<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganization\" target=\"_blank\">同步企业信息</a>接口同步信息。</li>\n<li>该参数仅在企业未激活时生效</li>\n</ul>",
6823
- "example": "",
6822
+ "example": "[1, 2, 4]",
6824
6823
  "member": "int64",
6825
6824
  "name": "AuthorizationTypes",
6826
6825
  "required": false,
@@ -6838,7 +6837,7 @@
6838
6837
  {
6839
6838
  "disabled": false,
6840
6839
  "document": "子客经办人身份证\n注意:`如果已同步,这里非空会更新同步的经办人身份证号,暂时只支持中国大陆居民身份证类型`。",
6841
- "example": "",
6840
+ "example": "620000198802020000",
6842
6841
  "member": "string",
6843
6842
  "name": "ProxyOperatorIdCardNumber",
6844
6843
  "required": false,
@@ -6865,7 +6864,7 @@
6865
6864
  {
6866
6865
  "disabled": false,
6867
6866
  "document": "是否自动激活子客企业,有下面两种选项:\n\n**false(默认设置)**:不自动激活子客户。您需要通过控制台或调用[激活或者续期子企业](https://qian.tencent.com/developers/partnerApis/accounts/CreateChannelSubOrganizationActive)接口手动完成激活过程。\n\n**true**:若持有的许可证充足,子客户企业注册完成后将自动激活,无需手动操作或访问控制台。\n\n<b>注</b>:如果<b>应用扩展服务</b>中的<b>自动激活子客企业</b>为打开态, 则忽略本接口的AutoActive这个参数(若持有的许可证充足,子客户企业注册完成后将自动激活),具体位置参考下图:\n![image](https://qcloudimg.tencent-cloud.cn/raw/c3639b05503d3735bac483d17aa6b0a3.png)",
6868
- "example": "",
6867
+ "example": "false",
6869
6868
  "member": "bool",
6870
6869
  "name": "AutoActive",
6871
6870
  "required": false,
@@ -6874,7 +6873,7 @@
6874
6873
  {
6875
6874
  "disabled": false,
6876
6875
  "document": "营业执照正面照(支持PNG或JPG格式)需以base64格式提供,且文件大小不得超过5MB。",
6877
- "example": "",
6876
+ "example": "aHR0cHM6Ly9jYXBpLndvYS5jb20vhaWwlM0ZpZCUzRGVzc2Jhc2ljJTI2dGFiJTNEYXBp..图片base64省略",
6878
6877
  "member": "string",
6879
6878
  "name": "BusinessLicense",
6880
6879
  "required": false,
@@ -6901,7 +6900,7 @@
6901
6900
  {
6902
6901
  "disabled": false,
6903
6902
  "document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。\n p.s. 如果上传授权书 ,需遵循以下条件 \n1. 超管的信息(超管姓名,超管手机号)必须为必填参数。 \n2. 认证方式AuthorizationTypes必须只能是上传授权书方式\t",
6904
- "example": "",
6903
+ "example": "[\"/9j/4A5IWWEAgABA*********\"]",
6905
6904
  "member": "string",
6906
6905
  "name": "PowerOfAttorneys",
6907
6906
  "required": false,
@@ -6925,7 +6924,7 @@
6925
6924
  {
6926
6925
  "disabled": false,
6927
6926
  "document": "跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表\n<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5/WEIXIN_QRCODE_URL</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5/WEIXIN_QRCODE_URL</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP/H5/SHORT_H5/WEIXIN_QRCODE_URL</td> <td>30天</td> </tr> </tbody> </table>\n\n注: \n1. <font color=\"red\">链接仅单次有效</font>,每次登录需要需要重新创建新的链接\n2. 创建的链接应避免被转义,如:&被转义为\\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义\n3. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)\n",
6928
- "example": "",
6927
+ "example": "https://es*.ap*.tencent.com/template-preview?channel=PROXYCHANNEL&expiredTime=1631712951&code=123456asdfghjk&templateId=yDxlzxxxoTxQfVnyxs&menuStatus=ENABLE",
6929
6928
  "member": "string",
6930
6929
  "name": "ConsoleUrl",
6931
6930
  "output_required": true,
@@ -6935,7 +6934,7 @@
6935
6934
  {
6936
6935
  "disabled": false,
6937
6936
  "document": "子客企业是否已开通腾讯电子签,\n<ul><li> **true** :已经开通腾讯电子签</li>\n<li> **false** :还未开通腾讯电子签</li></ul>\n\n注:`企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断,非企业名称或者社会信用代码`",
6938
- "example": "",
6937
+ "example": "false",
6939
6938
  "member": "bool",
6940
6939
  "name": "IsActivated",
6941
6940
  "output_required": true,
@@ -6945,7 +6944,7 @@
6945
6944
  {
6946
6945
  "disabled": false,
6947
6946
  "document": "当前经办人是否已认证并加入功能\n<ul><li> **true** : 已经认证加入公司</li>\n<li> **false** : 还未认证加入公司</li></ul>\n注意:**员工是否实名是根据Agent.ProxyOperator.OpenId判断,非经办人姓名**",
6948
- "example": "",
6947
+ "example": "false",
6949
6948
  "member": "bool",
6950
6949
  "name": "ProxyOperatorIsVerified",
6951
6950
  "output_required": true,
@@ -6991,7 +6990,7 @@
6991
6990
  {
6992
6991
  "disabled": false,
6993
6992
  "document": "二维码图片的Base64 注: `此二维码的有效时间为7天,过期后需要重新生成新的二维码图片`",
6994
- "example": "",
6993
+ "example": "/9j/2wCEAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQ(剩余的其他图片base64字符串省略)",
6995
6994
  "member": "string",
6996
6995
  "name": "QrcodeBase64",
6997
6996
  "output_required": false,
@@ -7022,7 +7021,7 @@
7022
7021
  {
7023
7022
  "disabled": false,
7024
7023
  "document": "合同流程ID,为32位字符串。建议开发者妥善保存此流程ID,以便于顺利进行后续操作。可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
7025
- "example": "",
7024
+ "example": "yDCANUUc************SI8fHrn0LCd",
7026
7025
  "member": "string",
7027
7026
  "name": "FlowId",
7028
7027
  "required": true,
@@ -7031,7 +7030,7 @@
7031
7030
  {
7032
7031
  "disabled": false,
7033
7032
  "document": "链接/二维码的有效截止时间,格式为unix时间戳。最长不超过 2099年12月31日(4102415999)。\n默认值为有效期为当前时间后7天。",
7034
- "example": "",
7033
+ "example": "1719463451",
7035
7034
  "member": "uint64",
7036
7035
  "name": "ExpiredOn",
7037
7036
  "required": false,
@@ -7066,7 +7065,7 @@
7066
7065
  {
7067
7066
  "disabled": false,
7068
7067
  "document": "二维码和短链的过期时间戳,过期时间默认为生成链接后7天。",
7069
- "example": "",
7068
+ "example": "1719463451",
7070
7069
  "member": "uint64",
7071
7070
  "name": "ExpiredOn",
7072
7071
  "output_required": false,
@@ -7424,8 +7423,8 @@
7424
7423
  },
7425
7424
  {
7426
7425
  "disabled": false,
7427
- "document": "授权书类型:\n- 0: 企业认证超管授权书\n- 1: 超管变更授权书\n- 2: 企业注销授权书",
7428
- "example": "",
7426
+ "document": "授权书类型:\n\n<ul><li>0: 企业认证超管授权书</li><li>1: 超管变更授权书</li><li>2: 企业注销授权书</li></ul>",
7427
+ "example": "1",
7429
7428
  "member": "uint64",
7430
7429
  "name": "Type",
7431
7430
  "required": false,
@@ -7439,13 +7438,13 @@
7439
7438
  "members": [
7440
7439
  {
7441
7440
  "disabled": false,
7442
- "document": "授权书链接,有效期5分钟。\n注意:此字段可能返回 null,表示取不到有效值。",
7443
- "example": "",
7441
+ "document": "授权书链接,有效期5分钟。",
7442
+ "example": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.PDF?hkey=22c08eb99607114(后省略)",
7444
7443
  "member": "string",
7445
7444
  "name": "FileUrl",
7446
7445
  "output_required": true,
7447
7446
  "type": "string",
7448
- "value_allowed_null": true
7447
+ "value_allowed_null": false
7449
7448
  },
7450
7449
  {
7451
7450
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -7471,7 +7470,7 @@
7471
7470
  {
7472
7471
  "disabled": false,
7473
7472
  "document": "被授企业id/授权方企业id(即OrganizationId),如果是企业之间授权和AuthorizedOrganizationName二选一传入。\n\n注:`被授权企业必须和当前企业在同一应用号下`",
7474
- "example": "",
7473
+ "example": "yDwFdUUckxxxxxxxxxxxxxXbsvN43W6Kax",
7475
7474
  "member": "string",
7476
7475
  "name": "AuthorizedOrganizationId",
7477
7476
  "required": false,
@@ -7480,7 +7479,7 @@
7480
7479
  {
7481
7480
  "disabled": false,
7482
7481
  "document": "被授企业名称/授权方企业的名字,如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。\n\n注: \n1. 如果名称中包含英文括号(),请使用中文括号()代替。\n2. 被授权企业必须和当前企业在同一应用号下",
7483
- "example": "",
7482
+ "example": "王五示例企业",
7484
7483
  "member": "string",
7485
7484
  "name": "AuthorizedOrganizationName",
7486
7485
  "required": false,
@@ -7489,7 +7488,7 @@
7489
7488
  {
7490
7489
  "disabled": false,
7491
7490
  "document": "是否给平台应用授权\n\n<ul>\n<li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li>\n<li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li>\n</ul>\n\n 注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单,请联系运营经理开通。",
7492
- "example": "",
7491
+ "example": "false",
7493
7492
  "member": "bool",
7494
7493
  "name": "PlatformAppAuthorization",
7495
7494
  "required": false,
@@ -7498,7 +7497,7 @@
7498
7497
  {
7499
7498
  "disabled": false,
7500
7499
  "document": "在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:\n\n<ul>\n<li><strong>OFFICIAL</strong>:企业公章,用于代表企业对外的正式文件和重要事务的认证。</li>\n<li><strong>CONTRACT</strong>:合同专用章,专门用于签署各类合同。</li>\n<li><strong>FINANCE</strong>:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。</li>\n<li><strong>PERSONNEL</strong>:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li>\n</ul>",
7501
- "example": "",
7500
+ "example": "[OFFICIAL, FINANCE]",
7502
7501
  "member": "string",
7503
7502
  "name": "SealTypes",
7504
7503
  "required": false,
@@ -7507,7 +7506,7 @@
7507
7506
  {
7508
7507
  "disabled": false,
7509
7508
  "document": "在处理授权关系时,授权的方向\n<ul>\n<li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>\n<li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>\n</ul>",
7510
- "example": "",
7509
+ "example": "false",
7511
7510
  "member": "bool",
7512
7511
  "name": "AuthToMe",
7513
7512
  "required": false,
@@ -7521,18 +7520,18 @@
7521
7520
  "members": [
7522
7521
  {
7523
7522
  "disabled": false,
7524
- "document": "授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。\n注意:此字段可能返回 null,表示取不到有效值。",
7525
- "example": "",
7523
+ "document": "授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime",
7524
+ "example": "https://essurl.cn/003hGUFil8",
7526
7525
  "member": "string",
7527
7526
  "name": "Url",
7528
7527
  "output_required": true,
7529
7528
  "type": "string",
7530
- "value_allowed_null": true
7529
+ "value_allowed_null": false
7531
7530
  },
7532
7531
  {
7533
7532
  "disabled": false,
7534
7533
  "document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径\n",
7535
- "example": "",
7534
+ "example": "/pages/guide/index?shortKey=002XCUHfPi",
7536
7535
  "member": "string",
7537
7536
  "name": "MiniAppPath",
7538
7537
  "output_required": false,
@@ -7542,7 +7541,7 @@
7542
7541
  {
7543
7542
  "disabled": false,
7544
7543
  "document": "链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。",
7545
- "example": "",
7544
+ "example": "1702982931",
7546
7545
  "member": "int64",
7547
7546
  "name": "ExpireTime",
7548
7547
  "output_required": false,
@@ -7573,7 +7572,7 @@
7573
7572
  {
7574
7573
  "disabled": false,
7575
7574
  "document": "个人用户名称",
7576
- "example": "",
7575
+ "example": "典子谦",
7577
7576
  "member": "string",
7578
7577
  "name": "UserName",
7579
7578
  "required": true,
@@ -7582,7 +7581,7 @@
7582
7581
  {
7583
7582
  "disabled": false,
7584
7583
  "document": "证件类型,支持以下类型<ul><li> ID_CARD : 中国大陆居民身份证 (默认值)</li><li> HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li> HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>",
7585
- "example": "",
7584
+ "example": "ID_CARD",
7586
7585
  "member": "string",
7587
7586
  "name": "IdCardType",
7588
7587
  "required": true,
@@ -7591,7 +7590,7 @@
7591
7590
  {
7592
7591
  "disabled": false,
7593
7592
  "document": "证件号码,应符合以下规则<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
7594
- "example": "",
7593
+ "example": "620000198802020000",
7595
7594
  "member": "string",
7596
7595
  "name": "IdCardNumber",
7597
7596
  "required": true,
@@ -7624,43 +7623,43 @@
7624
7623
  },
7625
7624
  {
7626
7625
  "disabled": false,
7627
- "document": "个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。该编号会合成到个人用户证书证明图片。注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`\n注意:此字段可能返回 null,表示取不到有效值。",
7626
+ "document": "个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。该编号会合成到个人用户证书证明图片。注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`",
7628
7627
  "example": "23090411***877319694",
7629
7628
  "member": "string",
7630
7629
  "name": "ImageCertId",
7631
7630
  "output_required": false,
7632
7631
  "type": "string",
7633
- "value_allowed_null": true
7632
+ "value_allowed_null": false
7634
7633
  },
7635
7634
  {
7636
7635
  "disabled": false,
7637
- "document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。\n注意:此字段可能返回 null,表示取不到有效值。",
7636
+ "document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。",
7638
7637
  "example": "2206EB**4597742",
7639
7638
  "member": "string",
7640
7639
  "name": "SerialNumber",
7641
7640
  "output_required": false,
7642
7641
  "type": "string",
7643
- "value_allowed_null": true
7642
+ "value_allowed_null": false
7644
7643
  },
7645
7644
  {
7646
7645
  "disabled": false,
7647
- "document": "CA证书颁发时间,格式为Unix标准时间戳(秒) 该时间格式化后会合成到个人用户证书证明图片\n注意:此字段可能返回 null,表示取不到有效值。",
7648
- "example": "",
7646
+ "document": "CA证书颁发时间,格式为Unix标准时间戳(秒) 该时间格式化后会合成到个人用户证书证明图片",
7647
+ "example": "1692788219",
7649
7648
  "member": "uint64",
7650
7649
  "name": "ValidFrom",
7651
7650
  "output_required": false,
7652
7651
  "type": "int",
7653
- "value_allowed_null": true
7652
+ "value_allowed_null": false
7654
7653
  },
7655
7654
  {
7656
7655
  "disabled": false,
7657
- "document": "CA证书有效截止时间,格式为Unix标准时间戳(秒)该时间格式化后会合成到个人用户证书证明图片\n注意:此字段可能返回 null,表示取不到有效值。",
7658
- "example": "",
7656
+ "document": "CA证书有效截止时间,格式为Unix标准时间戳(秒)该时间格式化后会合成到个人用户证书证明图片",
7657
+ "example": "1724324219",
7659
7658
  "member": "uint64",
7660
7659
  "name": "ValidTo",
7661
7660
  "output_required": false,
7662
7661
  "type": "int",
7663
- "value_allowed_null": true
7662
+ "value_allowed_null": false
7664
7663
  },
7665
7664
  {
7666
7665
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -7686,7 +7685,7 @@
7686
7685
  {
7687
7686
  "disabled": false,
7688
7687
  "document": "电子印章名字,1-50个中文字符\n注:`同一企业下电子印章名字不能相同`",
7689
- "example": "",
7688
+ "example": "合同专用章",
7690
7689
  "member": "string",
7691
7690
  "name": "SealName",
7692
7691
  "required": true,
@@ -7695,7 +7694,7 @@
7695
7694
  {
7696
7695
  "disabled": false,
7697
7696
  "document": "电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式\n\n注: `通过图片创建的电子印章,需电子签平台人工审核`\n\n",
7698
- "example": "",
7697
+ "example": "iVBORw0KGgoAAAANSUhEUgAAAGwAAABuCAYAAADCrvbGAAABW2lDZXE15yz3uZ6TErkJggg....(图片base64省略)",
7699
7698
  "member": "string",
7700
7699
  "name": "SealImage",
7701
7700
  "required": false,
@@ -7713,7 +7712,7 @@
7713
7712
  {
7714
7713
  "disabled": false,
7715
7714
  "document": "电子印章生成方式\n<ul>\n<li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li>\n<li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li>\n</ul>",
7716
- "example": "",
7715
+ "example": "SealGenerateSourceSystem",
7717
7716
  "member": "string",
7718
7717
  "name": "GenerateSource",
7719
7718
  "required": false,
@@ -7758,7 +7757,7 @@
7758
7757
  {
7759
7758
  "disabled": false,
7760
7759
  "document": "企业税号\n\n注:\n<ul>\n<li>1.印章类型SealType是INVOICE类型时,此参数才会生效</li>\n<li>2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号(<font color=\"red\">如果是通过授权书授权方式认证的企业,此参数必传不能为空</font>)</li>\n</ul>",
7761
- "example": "",
7760
+ "example": "91278105MA00123456",
7762
7761
  "member": "string",
7763
7762
  "name": "TaxIdentifyCode",
7764
7763
  "required": false,
@@ -7773,7 +7772,7 @@
7773
7772
  {
7774
7773
  "disabled": false,
7775
7774
  "document": "电子印章ID,为32位字符串。\n建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。",
7776
- "example": "",
7775
+ "example": "429b82b4xxxx0a90d45c715bad7",
7777
7776
  "member": "string",
7778
7777
  "name": "SealId",
7779
7778
  "output_required": true,
@@ -7782,13 +7781,13 @@
7782
7781
  },
7783
7782
  {
7784
7783
  "disabled": false,
7785
- "document": "电子印章预览链接地址,地址默认失效时间为24小时。\n\n注:`图片上传生成的电子印章无预览链接地址`\n注意:此字段可能返回 null,表示取不到有效值。",
7784
+ "document": "电子印章预览链接地址,地址默认失效时间为24小时。\n\n注:`图片上传生成的电子印章无预览链接地址`",
7786
7785
  "example": "https://file.ess.tencent.cn/bresource/resource/resource/0/0.PNG?hkey=a6cdd6******64d4",
7787
7786
  "member": "string",
7788
7787
  "name": "ImageUrl",
7789
7788
  "output_required": false,
7790
7789
  "type": "string",
7791
- "value_allowed_null": true
7790
+ "value_allowed_null": false
7792
7791
  },
7793
7792
  {
7794
7793
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -7823,7 +7822,7 @@
7823
7822
  {
7824
7823
  "disabled": false,
7825
7824
  "document": "合同组编号\n注:`该参数和合同流程ID数组必须二选一`",
7826
- "example": "",
7825
+ "example": "yDCVAUUckpwa592pUxoLjOlRVS9Zgusf",
7827
7826
  "member": "string",
7828
7827
  "name": "FlowGroupId",
7829
7828
  "required": false,
@@ -7940,7 +7939,7 @@
7940
7939
  {
7941
7940
  "disabled": false,
7942
7941
  "document": "生成的签署链接在签署页面隐藏的按钮列表,可设置如下:\n\n<ul><li> **0** :合同签署页面更多操作按钮</li>\n<li> **1** :合同签署页面更多操作的拒绝签署按钮</li>\n<li> **2** :合同签署页面更多操作的转他人处理按钮</li>\n<li> **3** :签署成功页的查看详情按钮</li></ul>\n\n注: `字段为数组, 可以传值隐藏多个按钮`",
7943
- "example": "",
7942
+ "example": "[0, 1, 2]",
7944
7943
  "member": "int64",
7945
7944
  "name": "Hides",
7946
7945
  "required": false,
@@ -7949,7 +7948,7 @@
7949
7948
  {
7950
7949
  "disabled": false,
7951
7950
  "document": "参与方角色ID,用于生成动态签署人链接完成领取。\n\n注:`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`,",
7952
- "example": "",
7951
+ "example": "[\"yDCVAUUckpwa59riUxoLjOluu9cf6B3s\"]",
7953
7952
  "member": "string",
7954
7953
  "name": "RecipientIds",
7955
7954
  "required": false,
@@ -7967,7 +7966,7 @@
7967
7966
  {
7968
7967
  "disabled": false,
7969
7968
  "document": "<font color=\"red\">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。 \n\n参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。",
7970
- "example": "",
7969
+ "example": "WeChatOfficialAccounts",
7971
7970
  "member": "string",
7972
7971
  "name": "UrlUseEnv",
7973
7972
  "required": false,
@@ -8044,7 +8043,7 @@
8044
8043
  {
8045
8044
  "disabled": false,
8046
8045
  "document": "清除认证流产生的错误信息",
8047
- "example": "",
8046
+ "example": "错误信息",
8048
8047
  "member": "string",
8049
8048
  "name": "Errormessage",
8050
8049
  "output_required": false,
@@ -8125,20 +8124,20 @@
8125
8124
  {
8126
8125
  "disabled": false,
8127
8126
  "document": "部门id\n注意:此字段可能返回 null,表示取不到有效值。",
8128
- "example": "",
8127
+ "example": "dp**155f2",
8129
8128
  "member": "string",
8130
8129
  "name": "DepartmentId",
8131
- "required": true,
8130
+ "output_required": true,
8132
8131
  "type": "string",
8133
8132
  "value_allowed_null": true
8134
8133
  },
8135
8134
  {
8136
8135
  "disabled": false,
8137
8136
  "document": "部门名称\n注意:此字段可能返回 null,表示取不到有效值。",
8138
- "example": "",
8137
+ "example": "测试部门",
8139
8138
  "member": "string",
8140
8139
  "name": "DepartmentName",
8141
- "required": true,
8140
+ "output_required": true,
8142
8141
  "type": "string",
8143
8142
  "value_allowed_null": true
8144
8143
  }
@@ -8160,7 +8159,7 @@
8160
8159
  {
8161
8160
  "disabled": false,
8162
8161
  "document": "通过接口<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks\" target=\"_blank\">提交子企业批量认证链接创建任务</a>调用得到的任务ID。",
8163
- "example": "",
8162
+ "example": "yDSxSUUxxxxxxxx21JXBlJZsaj",
8164
8163
  "member": "string",
8165
8164
  "name": "TaskId",
8166
8165
  "required": true,
@@ -8206,7 +8205,7 @@
8206
8205
  {
8207
8206
  "disabled": false,
8208
8207
  "document": "批量撤销任务编号,为32位字符串,通过接口[批量撤销合同流程](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows)或者[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl)获得。",
8209
- "example": "",
8208
+ "example": "yDCVWUUckpwkjgiuUWGW8cRAzd84BVQa",
8210
8209
  "member": "string",
8211
8210
  "name": "TaskId",
8212
8211
  "required": true,
@@ -8221,7 +8220,7 @@
8221
8220
  {
8222
8221
  "disabled": false,
8223
8222
  "document": "批量撤销任务编号,为32位字符串。",
8224
- "example": "",
8223
+ "example": "yDCVWUUckpwkjgiuUWGW7cRAzd93BVQa",
8225
8224
  "member": "string",
8226
8225
  "name": "TaskId",
8227
8226
  "output_required": true,
@@ -8231,7 +8230,7 @@
8231
8230
  {
8232
8231
  "disabled": false,
8233
8232
  "document": "任务状态,需要关注的状态<ul><li>**PROCESSING** - 任务执行中</li><li>**END** - 任务处理完成</li><li>**TIMEOUT** 任务超时未处理完成,用户未在批量撤销链接有效期内操作</li></ul>",
8234
- "example": "",
8233
+ "example": "END",
8235
8234
  "member": "string",
8236
8235
  "name": "TaskStatus",
8237
8236
  "output_required": true,
@@ -8241,7 +8240,7 @@
8241
8240
  {
8242
8241
  "disabled": false,
8243
8242
  "document": "批量撤销成功的签署流程编号",
8244
- "example": "",
8243
+ "example": "[yDCN0UUckpvhnc6uUuyImI98ydIEe4bX]",
8245
8244
  "member": "string",
8246
8245
  "name": "SuccessFlowIds",
8247
8246
  "output_required": true,
@@ -8282,7 +8281,7 @@
8282
8281
  {
8283
8282
  "disabled": false,
8284
8283
  "document": "签署报告编号, 由<a href=\"https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport\" target=\"_blank\">提交申请出证报告任务</a>产生",
8285
- "example": "",
8284
+ "example": "yDSLVUUckpo3nva8UEnf33kvzHQ19GcL",
8286
8285
  "member": "string",
8287
8286
  "name": "ReportId",
8288
8287
  "required": true,
@@ -8300,7 +8299,7 @@
8300
8299
  {
8301
8300
  "disabled": false,
8302
8301
  "document": "指定申请的报告类型,可选类型如下:\n<ul><li> **0** :合同签署报告(默认)</li>\n<li> **1** :公证处核验报告</li></ul>",
8303
- "example": "",
8302
+ "example": "0",
8304
8303
  "member": "int64",
8305
8304
  "name": "ReportType",
8306
8305
  "required": false,
@@ -8314,17 +8313,17 @@
8314
8313
  "members": [
8315
8314
  {
8316
8315
  "disabled": false,
8317
- "document": "出证报告PDF的下载 URL,有效期为5分钟,超过有效期后将无法再下载。\n注意:此字段可能返回 null,表示取不到有效值。",
8316
+ "document": "出证报告PDF的下载 URL,有效期为5分钟,超过有效期后将无法再下载。",
8318
8317
  "example": "https://file.ess.tencent.cn/file/yDwhIU*****kvSEnAV3Qyl2B/0/1.PDF?hkey=4a8ca49a66dc0b7651**5601d0e6b8aa9a86054c25",
8319
8318
  "member": "string",
8320
8319
  "name": "ReportUrl",
8321
8320
  "output_required": true,
8322
8321
  "type": "string",
8323
- "value_allowed_null": true
8322
+ "value_allowed_null": false
8324
8323
  },
8325
8324
  {
8326
8325
  "disabled": false,
8327
- "document": "出证任务执行的状态, 状态含义如下:\n\n<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>\n<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>\n<li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>",
8326
+ "document": "出证任务执行的状态, 状态含义如下:\n\n<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>\n<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>\n<li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>",
8328
8327
  "example": "EvidenceStatusExecuting",
8329
8328
  "member": "string",
8330
8329
  "name": "Status",
@@ -8546,13 +8545,13 @@
8546
8545
  "members": [
8547
8546
  {
8548
8547
  "disabled": false,
8549
- "document": "服务授权的信息列表,根据查询类型返回特定扩展服务的开通和授权状况。\n注意:此字段可能返回 null,表示取不到有效值。",
8548
+ "document": "服务授权的信息列表,根据查询类型返回特定扩展服务的开通和授权状况。",
8550
8549
  "example": "无",
8551
8550
  "member": "AuthInfoDetail",
8552
8551
  "name": "AuthInfoDetail",
8553
8552
  "output_required": true,
8554
8553
  "type": "object",
8555
- "value_allowed_null": true
8554
+ "value_allowed_null": false
8556
8555
  },
8557
8556
  {
8558
8557
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -8583,13 +8582,13 @@
8583
8582
  "members": [
8584
8583
  {
8585
8584
  "disabled": false,
8586
- "document": "服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。\n注意:此字段可能返回 null,表示取不到有效值。",
8585
+ "document": "服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。",
8587
8586
  "example": "无",
8588
8587
  "member": "ExtentServiceAuthInfo",
8589
8588
  "name": "AuthInfo",
8590
8589
  "output_required": true,
8591
8590
  "type": "list",
8592
- "value_allowed_null": true
8591
+ "value_allowed_null": false
8593
8592
  },
8594
8593
  {
8595
8594
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -8667,33 +8666,33 @@
8667
8666
  },
8668
8667
  {
8669
8668
  "disabled": false,
8670
- "document": "合同流程的详细信息。\n如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。\n注意:此字段可能返回 null,表示取不到有效值。",
8669
+ "document": "合同流程的详细信息。\n如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。",
8671
8670
  "example": "无",
8672
8671
  "member": "FlowDetailInfo",
8673
8672
  "name": "FlowInfo",
8674
8673
  "output_required": true,
8675
8674
  "type": "list",
8676
- "value_allowed_null": true
8675
+ "value_allowed_null": false
8677
8676
  },
8678
8677
  {
8679
8678
  "disabled": false,
8680
- "document": "合同组ID,只有在查询合同组信息时才会返回。\n注意:此字段可能返回 null,表示取不到有效值。",
8679
+ "document": "合同组ID,只有在查询合同组信息时才会返回。",
8681
8680
  "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
8682
8681
  "member": "string",
8683
8682
  "name": "FlowGroupId",
8684
8683
  "output_required": true,
8685
8684
  "type": "string",
8686
- "value_allowed_null": true
8685
+ "value_allowed_null": false
8687
8686
  },
8688
8687
  {
8689
8688
  "disabled": false,
8690
- "document": "合同组名称,只有在查询合同组信息时才会返回。\n注意:此字段可能返回 null,表示取不到有效值。",
8689
+ "document": "合同组名称,只有在查询合同组信息时才会返回。",
8691
8690
  "example": "合同组名称-1",
8692
8691
  "member": "string",
8693
8692
  "name": "FlowGroupName",
8694
8693
  "output_required": true,
8695
8694
  "type": "string",
8696
- "value_allowed_null": true
8695
+ "value_allowed_null": false
8697
8696
  },
8698
8697
  {
8699
8698
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -9019,13 +9018,13 @@
9019
9018
  },
9020
9019
  {
9021
9020
  "disabled": false,
9022
- "document": "用量明细\n注意:此字段可能返回 null,表示取不到有效值。",
9021
+ "document": "用量明细",
9023
9022
  "example": "无",
9024
9023
  "member": "UsageDetail",
9025
9024
  "name": "Details",
9026
9025
  "output_required": true,
9027
9026
  "type": "list",
9028
- "value_allowed_null": true
9027
+ "value_allowed_null": false
9029
9028
  },
9030
9029
  {
9031
9030
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -9042,7 +9041,7 @@
9042
9041
  {
9043
9042
  "disabled": false,
9044
9043
  "document": "活体视频的base64编码,mp4格式\n\n注:`需进行base64解码获取活体视频文件`\n注意:此字段可能返回 null,表示取不到有效值。",
9045
- "example": "",
9044
+ "example": "AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB",
9046
9045
  "member": "string",
9047
9046
  "name": "LiveNessVideo",
9048
9047
  "output_required": false,
@@ -9084,7 +9083,7 @@
9084
9083
  {
9085
9084
  "disabled": false,
9086
9085
  "document": "签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;\t",
9087
- "example": "",
9086
+ "example": "yDCYrUUckp7wh61iUugjySLvo742CmF8",
9088
9087
  "member": "string",
9089
9088
  "name": "RecipientId",
9090
9089
  "output_required": true,
@@ -9094,7 +9093,7 @@
9094
9093
  {
9095
9094
  "disabled": false,
9096
9095
  "document": "签署ID - 发起流程时系统自动补充 - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息\t",
9097
- "example": "",
9096
+ "example": "yDCYrUUckp7wh61fUugjySLSpPqQKwDk",
9098
9097
  "member": "string",
9099
9098
  "name": "SignId",
9100
9099
  "output_required": true,
@@ -9104,7 +9103,7 @@
9104
9103
  {
9105
9104
  "disabled": false,
9106
9105
  "document": "签署人状态信息",
9107
- "example": "",
9106
+ "example": "2",
9108
9107
  "member": "int64",
9109
9108
  "name": "ApproverStatus",
9110
9109
  "output_required": true,
@@ -9120,7 +9119,7 @@
9120
9119
  {
9121
9120
  "disabled": false,
9122
9121
  "document": "合同流程ID,为32位字符串。 - 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 - 可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。 - <font color=\"red\">不建议继续使用</font>,请使用<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/\" target=\"_blank\">补充签署人结构体</a>中的FlowId指定合同\t",
9123
- "example": "",
9122
+ "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
9124
9123
  "member": "string",
9125
9124
  "name": "FlowId",
9126
9125
  "required": true,
@@ -9147,7 +9146,7 @@
9147
9146
  {
9148
9147
  "disabled": false,
9149
9148
  "document": "签署人校验方式 VerifyCheck: 人脸识别(默认) MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。\t",
9150
- "example": "",
9149
+ "example": "VerifyCheck",
9151
9150
  "member": "string",
9152
9151
  "name": "ApproverVerifyType",
9153
9152
  "required": false,
@@ -9162,7 +9161,7 @@
9162
9161
  {
9163
9162
  "disabled": false,
9164
9163
  "document": "合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)\t",
9165
- "example": "",
9164
+ "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
9166
9165
  "member": "string",
9167
9166
  "name": "FlowId",
9168
9167
  "output_required": false,
@@ -9251,7 +9250,7 @@
9251
9250
  {
9252
9251
  "disabled": false,
9253
9252
  "document": "操作扩展服务的操作人第三方应用平台的用户openid\n注意:此字段可能返回 null,表示取不到有效值。",
9254
- "example": "",
9253
+ "example": "admin-open-id",
9255
9254
  "member": "string",
9256
9255
  "name": "OperatorOpenId",
9257
9256
  "output_required": true,
@@ -9261,7 +9260,7 @@
9261
9260
  {
9262
9261
  "disabled": false,
9263
9262
  "document": "扩展服务的操作时间,格式为Unix标准时间戳(秒)。\t\n注意:此字段可能返回 null,表示取不到有效值。",
9264
- "example": "",
9263
+ "example": "1693557098",
9265
9264
  "member": "int64",
9266
9265
  "name": "OperateOn",
9267
9266
  "output_required": true,
@@ -9277,20 +9276,20 @@
9277
9276
  {
9278
9277
  "disabled": false,
9279
9278
  "document": "用户userId\n注意:此字段可能返回 null,表示取不到有效值。",
9280
- "example": "",
9279
+ "example": "yDwgKUUc********QZD2cds",
9281
9280
  "member": "string",
9282
9281
  "name": "UserId",
9283
- "required": false,
9282
+ "output_required": true,
9284
9283
  "type": "string",
9285
9284
  "value_allowed_null": true
9286
9285
  },
9287
9286
  {
9288
9287
  "disabled": false,
9289
9288
  "document": "角色RoleId列表\n注意:此字段可能返回 null,表示取不到有效值。",
9290
- "example": "",
9289
+ "example": "[\"yDwgKUUc**********QZxjcvkf\"]",
9291
9290
  "member": "string",
9292
9291
  "name": "RoleIds",
9293
- "required": false,
9292
+ "output_required": true,
9294
9293
  "type": "list",
9295
9294
  "value_allowed_null": true
9296
9295
  }
@@ -9303,7 +9302,7 @@
9303
9302
  {
9304
9303
  "disabled": false,
9305
9304
  "document": "签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。\n",
9306
- "example": "",
9305
+ "example": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR",
9307
9306
  "member": "string",
9308
9307
  "name": "RecipientId",
9309
9308
  "required": true,
@@ -9312,7 +9311,7 @@
9312
9311
  {
9313
9312
  "disabled": false,
9314
9313
  "document": "指定企业经办签署人OpenId",
9315
- "example": "",
9314
+ "example": "n9527",
9316
9315
  "member": "string",
9317
9316
  "name": "OpenId",
9318
9317
  "required": false,
@@ -9321,7 +9320,7 @@
9321
9320
  {
9322
9321
  "disabled": false,
9323
9322
  "document": "签署人姓名",
9324
- "example": "",
9323
+ "example": "张三",
9325
9324
  "member": "string",
9326
9325
  "name": "ApproverName",
9327
9326
  "required": false,
@@ -9330,7 +9329,7 @@
9330
9329
  {
9331
9330
  "disabled": false,
9332
9331
  "document": "签署人手机号码",
9333
- "example": "",
9332
+ "example": "18888888888",
9334
9333
  "member": "string",
9335
9334
  "name": "ApproverMobile",
9336
9335
  "required": false,
@@ -9339,7 +9338,7 @@
9339
9338
  {
9340
9339
  "disabled": false,
9341
9340
  "document": "企业名称",
9342
- "example": "",
9341
+ "example": "张三示例公司",
9343
9342
  "member": "string",
9344
9343
  "name": "OrganizationName",
9345
9344
  "required": false,
@@ -9348,7 +9347,7 @@
9348
9347
  {
9349
9348
  "disabled": false,
9350
9349
  "document": "企业OpenId",
9351
- "example": "",
9350
+ "example": "org_dianziqian",
9352
9351
  "member": "string",
9353
9352
  "name": "OrganizationOpenId",
9354
9353
  "required": false,
@@ -9357,7 +9356,7 @@
9357
9356
  {
9358
9357
  "disabled": false,
9359
9358
  "document": "签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,OrganizationOpenId 必传",
9360
- "example": "",
9359
+ "example": "false",
9361
9360
  "member": "bool",
9362
9361
  "name": "NotChannelOrganization",
9363
9362
  "required": false,
@@ -9375,7 +9374,7 @@
9375
9374
  {
9376
9375
  "disabled": false,
9377
9376
  "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
9378
- "example": "",
9377
+ "example": "620000198802020000",
9379
9378
  "member": "string",
9380
9379
  "name": "ApproverIdCardNumber",
9381
9380
  "required": false,
@@ -9399,7 +9398,7 @@
9399
9398
  {
9400
9399
  "disabled": false,
9401
9400
  "document": "为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。\n注意:此字段可能返回 null,表示取不到有效值。",
9402
- "example": "",
9401
+ "example": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc",
9403
9402
  "member": "string",
9404
9403
  "name": "RecipientId",
9405
9404
  "output_required": false,
@@ -9409,7 +9408,7 @@
9409
9408
  {
9410
9409
  "disabled": false,
9411
9410
  "document": "补充失败错误说明\n注意:此字段可能返回 null,表示取不到有效值。",
9412
- "example": "",
9411
+ "example": "个人信息已补充,请勿重复补充",
9413
9412
  "member": "string",
9414
9413
  "name": "ErrMessage",
9415
9414
  "output_required": false,
@@ -9419,7 +9418,7 @@
9419
9418
  {
9420
9419
  "disabled": false,
9421
9420
  "document": "合同流程ID,为32位字符串。\t\n注意:此字段可能返回 null,表示取不到有效值。",
9422
- "example": "",
9421
+ "example": "yDCZHUUnitvronUuNTdBrElW0gOVqCfy",
9423
9422
  "member": "string",
9424
9423
  "name": "FlowId",
9425
9424
  "output_required": false,
@@ -9491,22 +9490,20 @@
9491
9490
  {
9492
9491
  "disabled": false,
9493
9492
  "document": "查询过滤条件的Key",
9494
- "example": "",
9493
+ "example": "IsReturnPermissionGroup",
9495
9494
  "member": "string",
9496
9495
  "name": "Key",
9497
9496
  "required": true,
9498
- "type": "string",
9499
- "value_allowed_null": false
9497
+ "type": "string"
9500
9498
  },
9501
9499
  {
9502
9500
  "disabled": false,
9503
9501
  "document": "查询过滤条件的Value列表",
9504
- "example": "",
9502
+ "example": "[\"0\"]",
9505
9503
  "member": "string",
9506
9504
  "name": "Values",
9507
9505
  "required": true,
9508
- "type": "list",
9509
- "value_allowed_null": false
9506
+ "type": "list"
9510
9507
  }
9511
9508
  ],
9512
9509
  "usage": "in"
@@ -9567,7 +9564,7 @@
9567
9564
  {
9568
9565
  "disabled": false,
9569
9566
  "document": "签署顺序,如果是有序签署,签署顺序从小到大",
9570
- "example": "",
9567
+ "example": "0",
9571
9568
  "member": "int64",
9572
9569
  "name": "SignOrder",
9573
9570
  "output_required": true,
@@ -9597,7 +9594,7 @@
9597
9594
  {
9598
9595
  "disabled": false,
9599
9596
  "document": "签署人拒签等情况的时候填写的原因\n注意:此字段可能返回 null,表示取不到有效值。",
9600
- "example": "",
9597
+ "example": "拒签时补充原因",
9601
9598
  "member": "string",
9602
9599
  "name": "ApproveMessage",
9603
9600
  "output_required": true,
@@ -9843,7 +9840,7 @@
9843
9840
  {
9844
9841
  "disabled": false,
9845
9842
  "document": "签署ID\n- 发起流程时系统自动补充\n- 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息",
9846
- "example": "",
9843
+ "example": "06f2bc0f1772d8deac2f92b5df61a5ac",
9847
9844
  "member": "string",
9848
9845
  "name": "SignId",
9849
9846
  "required": false,
@@ -9870,7 +9867,7 @@
9870
9867
  {
9871
9868
  "disabled": false,
9872
9869
  "document": "可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。\n\n注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`",
9873
- "example": "",
9870
+ "example": "乙方",
9874
9871
  "member": "string",
9875
9872
  "name": "ApproverRoleName",
9876
9873
  "required": false,
@@ -9921,7 +9918,7 @@
9921
9918
  {
9922
9919
  "disabled": false,
9923
9920
  "document": "合同编号\n注意:此字段可能返回 null,表示取不到有效值。",
9924
- "example": "",
9921
+ "example": "yDt1iUUckp7xb05iUuWfBtZwW5IdVzLn",
9925
9922
  "member": "string",
9926
9923
  "name": "FlowId",
9927
9924
  "output_required": false,
@@ -10012,7 +10009,7 @@
10012
10009
  {
10013
10010
  "disabled": false,
10014
10011
  "document": "签署节点ID,用于生成动态签署人链接完成领取。注:`生成动态签署人补充链接时必传。`",
10015
- "example": "",
10012
+ "example": "yDt1iUUckp7xb05iUuWfBtZwW5IdVzLn",
10016
10013
  "member": "string",
10017
10014
  "name": "RecipientId",
10018
10015
  "required": false,
@@ -10072,7 +10069,7 @@
10072
10069
  {
10073
10070
  "disabled": false,
10074
10071
  "document": "合同流程当前的签署状态, 会存在下列的状态值\n<ul><li> **INIT** :合同创建</li>\n<li> **PART** :合同签署中(至少有一个签署方已经签署)</li>\n<li> **REJECT** :合同拒签</li>\n<li> **ALL** :合同签署完成</li>\n<li> **DEADLINE** :合同流签(合同过期)</li>\n<li> **CANCEL** :合同撤回</li>\n<li> **RELIEVED** :解除协议(已解除)</li></ul>\n ",
10075
- "example": "",
10072
+ "example": "ALL",
10076
10073
  "member": "string",
10077
10074
  "name": "FlowStatus",
10078
10075
  "output_required": true,
@@ -10082,7 +10079,7 @@
10082
10079
  {
10083
10080
  "disabled": false,
10084
10081
  "document": "当合同流程状态为已拒签(即 FlowStatus=REJECT)或已撤销(即 FlowStatus=CANCEL )时,此字段 FlowMessage 为拒签或撤销原因。",
10085
- "example": "",
10082
+ "example": "发起方以“合同内容错误”撤销当前合同",
10086
10083
  "member": "string",
10087
10084
  "name": "FlowMessage",
10088
10085
  "output_required": true,
@@ -10112,7 +10109,7 @@
10112
10109
  {
10113
10110
  "disabled": false,
10114
10111
  "document": "调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 1000长度。\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。",
10115
- "example": "",
10112
+ "example": "Q3VzdG9tRGF0YQ==",
10116
10113
  "member": "string",
10117
10114
  "name": "CustomData",
10118
10115
  "output_required": true,
@@ -10158,7 +10155,7 @@
10158
10155
  {
10159
10156
  "disabled": false,
10160
10157
  "document": "签署文件资源Id列表,目前仅支持单个文件",
10161
- "example": "[\"xxx\"]",
10158
+ "example": "[\"yDt1iUUckp7xb05iUuWfBtZwW5IdVzLn\"]",
10162
10159
  "member": "string",
10163
10160
  "name": "FileIds",
10164
10161
  "required": true,
@@ -10167,7 +10164,7 @@
10167
10164
  {
10168
10165
  "disabled": false,
10169
10166
  "document": "签署流程名称,长度不超过200个字符",
10170
- "example": "\"xxx\"",
10167
+ "example": "张三的入职合同",
10171
10168
  "member": "string",
10172
10169
  "name": "FlowName",
10173
10170
  "required": true,
@@ -10194,7 +10191,7 @@
10194
10191
  {
10195
10192
  "disabled": false,
10196
10193
  "document": "签署流程的描述,长度不超过1000个字符",
10197
- "example": "\"xxx\"",
10194
+ "example": "张三的入职合同(2025)",
10198
10195
  "member": "string",
10199
10196
  "name": "FlowDescription",
10200
10197
  "required": false,
@@ -10203,7 +10200,7 @@
10203
10200
  {
10204
10201
  "disabled": false,
10205
10202
  "document": "签署流程的类型,长度不超过255个字符",
10206
- "example": "\"xxx\"",
10203
+ "example": "入职合同",
10207
10204
  "member": "string",
10208
10205
  "name": "FlowType",
10209
10206
  "required": false,
@@ -10212,7 +10209,7 @@
10212
10209
  {
10213
10210
  "disabled": true,
10214
10211
  "document": "已废弃,请使用【应用号配置】中的回调地址统一接收消息",
10215
- "example": "\"xxx\"",
10212
+ "example": "https://callback.cn/callback",
10216
10213
  "member": "string",
10217
10214
  "name": "CallbackUrl",
10218
10215
  "required": false,
@@ -10220,8 +10217,8 @@
10220
10217
  },
10221
10218
  {
10222
10219
  "disabled": false,
10223
- "document": "第三方应用的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN",
10224
- "example": "\"xxx\"",
10220
+ "document": "第三方应用的业务信息,最大长度1000个字符。",
10221
+ "example": "56ys5LiJ5pa55bqU55So55qE5Lia5Yqh5L+h5oGv77yM5pyA5aSn6ZW/5bqmMTAwMOS4quWtl+espuOAgg==",
10225
10222
  "member": "string",
10226
10223
  "name": "CustomerData",
10227
10224
  "required": false,
@@ -10248,7 +10245,7 @@
10248
10245
  {
10249
10246
  "disabled": false,
10250
10247
  "document": "合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始",
10251
- "example": "\"xxx\"",
10248
+ "example": "合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬!;净重: 100吨;品类: 铁矿石",
10252
10249
  "member": "string",
10253
10250
  "name": "CustomShowMap",
10254
10251
  "required": false,
@@ -10290,7 +10287,7 @@
10290
10287
  {
10291
10288
  "disabled": false,
10292
10289
  "document": "签署节点ID,用于生成动态签署人链接完成领取。注:`生成动态签署人补充链接时必传。`",
10293
- "example": "",
10290
+ "example": "yDt1JUUckp77a2tqUyEmko8RVpCEHoNA",
10294
10291
  "member": "string",
10295
10292
  "name": "RecipientId",
10296
10293
  "required": false,
@@ -10511,7 +10508,7 @@
10511
10508
  {
10512
10509
  "disabled": false,
10513
10510
  "document": "合同流程的ID\n注意:此字段可能返回 null,表示取不到有效值。",
10514
- "example": "xxx",
10511
+ "example": "yDt1JUUckp77a2tqUyEmko8RVpCEHoNA",
10515
10512
  "member": "string",
10516
10513
  "name": "FlowId",
10517
10514
  "output_required": true,
@@ -10642,7 +10639,7 @@
10642
10639
  {
10643
10640
  "disabled": false,
10644
10641
  "document": "授权企业openid,\n注意:此字段可能返回 null,表示取不到有效值。",
10645
- "example": "",
10642
+ "example": "org_zhangsan",
10646
10643
  "member": "string",
10647
10644
  "name": "OrganizationOpenId",
10648
10645
  "output_required": false,
@@ -10653,7 +10650,7 @@
10653
10650
  {
10654
10651
  "disabled": false,
10655
10652
  "document": "授权企业名称\t\n注意:此字段可能返回 null,表示取不到有效值。",
10656
- "example": "",
10653
+ "example": "张三示例企业",
10657
10654
  "member": "string",
10658
10655
  "name": "OrganizationName",
10659
10656
  "output_required": false,
@@ -10664,7 +10661,7 @@
10664
10661
  {
10665
10662
  "disabled": false,
10666
10663
  "document": "被授权企业openid,\n注意:此字段可能返回 null,表示取不到有效值。",
10667
- "example": "",
10664
+ "example": "org_lisi",
10668
10665
  "member": "string",
10669
10666
  "name": "AuthorizedOrganizationOpenId",
10670
10667
  "output_required": false,
@@ -10675,7 +10672,7 @@
10675
10672
  {
10676
10673
  "disabled": false,
10677
10674
  "document": "被授权企业名称\t\n注意:此字段可能返回 null,表示取不到有效值。",
10678
- "example": "",
10675
+ "example": "李四示例企业",
10679
10676
  "member": "string",
10680
10677
  "name": "AuthorizedOrganizationName",
10681
10678
  "output_required": false,
@@ -10686,7 +10683,7 @@
10686
10683
  {
10687
10684
  "disabled": false,
10688
10685
  "document": "授权时间,格式为时间戳,单位s\t\n注意:此字段可能返回 null,表示取不到有效值。",
10689
- "example": "",
10686
+ "example": "1736751627",
10690
10687
  "member": "int64",
10691
10688
  "name": "AuthorizeTime",
10692
10689
  "output_required": false,
@@ -10703,7 +10700,7 @@
10703
10700
  {
10704
10701
  "disabled": false,
10705
10702
  "document": "第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。\n\n\n注意:此字段可能返回 null,表示取不到有效值。",
10706
- "example": "",
10703
+ "example": "n9527",
10707
10704
  "member": "string",
10708
10705
  "name": "OpenId",
10709
10706
  "output_required": false,
@@ -10784,7 +10781,7 @@
10784
10781
  {
10785
10782
  "disabled": false,
10786
10783
  "document": "视频base64编码(其中包含全程提示文本和点头音频,mp4格式)\n注意:此字段可能返回 null,表示取不到有效值。",
10787
- "example": "",
10784
+ "example": "6Zeu6aKY5ZKM5Zue562U6Z+z6aKR77yMbXA05qC85byP77yJ",
10788
10785
  "member": "string",
10789
10786
  "name": "Video",
10790
10787
  "output_required": false,
@@ -10824,7 +10821,7 @@
10824
10821
  {
10825
10822
  "disabled": false,
10826
10823
  "document": "视频base64(其中包含全程问题和回答音频,mp4格式)\n\n注:`需进行base64解码获取视频文件`\n注意:此字段可能返回 null,表示取不到有效值。",
10827
- "example": "",
10824
+ "example": "6Zeu6aKY5ZKM5Zue562U6Z+z6aKR77yMbXA05qC85byP77yJ",
10828
10825
  "member": "string",
10829
10826
  "name": "Video",
10830
10827
  "output_required": false,
@@ -10834,7 +10831,7 @@
10834
10831
  {
10835
10832
  "disabled": false,
10836
10833
  "document": " 和答案匹配结果列表\n注意:此字段可能返回 null,表示取不到有效值。",
10837
- "example": "",
10834
+ "example": "[\"0\"]",
10838
10835
  "member": "string",
10839
10836
  "name": "ResultCode",
10840
10837
  "output_required": false,
@@ -10844,7 +10841,7 @@
10844
10841
  {
10845
10842
  "disabled": false,
10846
10843
  "document": "回答问题语音识别结果列表\n注意:此字段可能返回 null,表示取不到有效值。",
10847
- "example": "",
10844
+ "example": "[\"同意\"]",
10848
10845
  "member": "string",
10849
10846
  "name": "AsrResult",
10850
10847
  "output_required": false,
@@ -10978,7 +10975,7 @@
10978
10975
  {
10979
10976
  "disabled": false,
10980
10977
  "document": "签署方经办人的类型,支持以下类型\n<ul><li> ORGANIZATION 企业(含企业自动签)</li>\n<li>PERSON 个人(含个人自动签)</li></ul>",
10981
- "example": "",
10978
+ "example": "ORGANIZATION ",
10982
10979
  "member": "string",
10983
10980
  "name": "ApproverType",
10984
10981
  "required": true,
@@ -10987,7 +10984,7 @@
10987
10984
  {
10988
10985
  "disabled": false,
10989
10986
  "document": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。",
10990
- "example": "",
10987
+ "example": "张三",
10991
10988
  "member": "string",
10992
10989
  "name": "ApproverName",
10993
10990
  "required": true,
@@ -10996,7 +10993,7 @@
10996
10993
  {
10997
10994
  "disabled": false,
10998
10995
  "document": "签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。",
10999
- "example": "",
10996
+ "example": "18888888888",
11000
10997
  "member": "string",
11001
10998
  "name": "ApproverMobile",
11002
10999
  "required": false,
@@ -11023,7 +11020,7 @@
11023
11020
  {
11024
11021
  "disabled": false,
11025
11022
  "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。\n如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。\n",
11026
- "example": "",
11023
+ "example": "张三示例企业",
11027
11024
  "member": "string",
11028
11025
  "name": "OrganizationName",
11029
11026
  "required": false,
@@ -11038,7 +11035,7 @@
11038
11035
  {
11039
11036
  "disabled": false,
11040
11037
  "document": "电子印章编号",
11041
- "example": "",
11038
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
11042
11039
  "member": "string",
11043
11040
  "name": "SealId",
11044
11041
  "output_required": true,
@@ -11048,7 +11045,7 @@
11048
11045
  {
11049
11046
  "disabled": false,
11050
11047
  "document": "电子印章名称",
11051
- "example": "",
11048
+ "example": "张三示例企业公章",
11052
11049
  "member": "string",
11053
11050
  "name": "SealName",
11054
11051
  "output_required": true,
@@ -11058,7 +11055,7 @@
11058
11055
  {
11059
11056
  "disabled": false,
11060
11057
  "document": "电子印章授权时间戳,单位秒",
11061
- "example": "",
11058
+ "example": "1736751627",
11062
11059
  "member": "int64",
11063
11060
  "name": "CreateOn",
11064
11061
  "output_required": true,
@@ -11068,7 +11065,7 @@
11068
11065
  {
11069
11066
  "disabled": false,
11070
11067
  "document": "电子印章授权人,电子签的UserId",
11071
- "example": "",
11068
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
11072
11069
  "member": "string",
11073
11070
  "name": "Creator",
11074
11071
  "output_required": true,
@@ -11078,7 +11075,7 @@
11078
11075
  {
11079
11076
  "disabled": false,
11080
11077
  "document": "电子印章策略Id",
11081
- "example": "",
11078
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
11082
11079
  "member": "string",
11083
11080
  "name": "SealPolicyId",
11084
11081
  "output_required": true,
@@ -11088,7 +11085,7 @@
11088
11085
  {
11089
11086
  "disabled": false,
11090
11087
  "document": "印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)",
11091
- "example": "",
11088
+ "example": "SUCCESS",
11092
11089
  "member": "string",
11093
11090
  "name": "SealStatus",
11094
11091
  "output_required": true,
@@ -11098,7 +11095,7 @@
11098
11095
  {
11099
11096
  "disabled": false,
11100
11097
  "document": "审核失败原因\n注意:此字段可能返回 null,表示取不到有效值。",
11101
- "example": "",
11098
+ "example": "印章中企业不相符",
11102
11099
  "member": "string",
11103
11100
  "name": "FailReason",
11104
11101
  "output_required": true,
@@ -11108,7 +11105,7 @@
11108
11105
  {
11109
11106
  "disabled": false,
11110
11107
  "document": "印章图片url,5分钟内有效",
11111
- "example": "",
11108
+ "example": "https://file.cn/sealid.jpg",
11112
11109
  "member": "string",
11113
11110
  "name": "Url",
11114
11111
  "output_required": true,
@@ -11118,7 +11115,7 @@
11118
11115
  {
11119
11116
  "disabled": false,
11120
11117
  "document": "电子印章类型 , 可选类型如下: \n<ul><li>**OFFICIAL**: (默认)公章</li>\n<li>**CONTRACT**: 合同专用章;</li>\n<li>**FINANCE**: 财务专用章;</li>\n<li>**PERSONNEL**: 人事专用章</li>\n<li>**INVOICE**: 发票专用章</li>\n</ul>",
11121
- "example": "",
11118
+ "example": "OFFICIAL",
11122
11119
  "member": "string",
11123
11120
  "name": "SealType",
11124
11121
  "output_required": true,
@@ -11128,7 +11125,7 @@
11128
11125
  {
11129
11126
  "disabled": false,
11130
11127
  "document": "用印申请是否为永久授权",
11131
- "example": "",
11128
+ "example": "true",
11132
11129
  "member": "bool",
11133
11130
  "name": "IsAllTime",
11134
11131
  "output_required": true,
@@ -11222,63 +11219,63 @@
11222
11219
  "members": [
11223
11220
  {
11224
11221
  "disabled": false,
11225
- "document": "第三方应用平台的应用ID\n注意:此字段可能返回 null,表示取不到有效值。",
11222
+ "document": "第三方应用平台的应用ID",
11226
11223
  "example": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
11227
11224
  "member": "string",
11228
11225
  "name": "AppId",
11229
11226
  "output_required": true,
11230
11227
  "type": "string",
11231
- "value_allowed_null": true
11228
+ "value_allowed_null": false
11232
11229
  },
11233
11230
  {
11234
11231
  "disabled": false,
11235
- "document": "合同模板ID\n注意:此字段可能返回 null,表示取不到有效值。",
11232
+ "document": "合同模板ID",
11236
11233
  "example": "yDwivUUckpo2g6ugUu4sxH2i15SY0OZY",
11237
11234
  "member": "string",
11238
11235
  "name": "TemplateId",
11239
11236
  "output_required": true,
11240
11237
  "type": "string",
11241
- "value_allowed_null": true
11238
+ "value_allowed_null": false
11242
11239
  },
11243
11240
  {
11244
11241
  "disabled": false,
11245
- "document": "描述模板可见性更改的结果。\n<ul>\n<li>all-success: 全部成功</li>\n<li>part-success: 部分成功,失败的会在FailMessageList中展示</li>\n<li>fail:全部失败, 失败的会在FailMessageList中展示</li>\n</ul>\n注意:此字段可能返回 null,表示取不到有效值。",
11242
+ "document": "描述模板可见性更改的结果。\n<ul>\n<li>all-success: 全部成功</li>\n<li>part-success: 部分成功,失败的会在FailMessageList中展示</li>\n<li>fail:全部失败, 失败的会在FailMessageList中展示</li>\n</ul>",
11246
11243
  "example": "all-success",
11247
11244
  "member": "string",
11248
11245
  "name": "OperateResult",
11249
11246
  "output_required": true,
11250
11247
  "type": "string",
11251
- "value_allowed_null": true
11248
+ "value_allowed_null": false
11252
11249
  },
11253
11250
  {
11254
11251
  "disabled": false,
11255
- "document": "模板可见范围:\n**all**: 所有本第三方应用合作企业可见\n**part**: 指定的本第三方应用合作企业\n注意:此字段可能返回 null,表示取不到有效值。",
11252
+ "document": "模板可见范围:\n**all**: 所有本第三方应用合作企业可见\n**part**: 指定的本第三方应用合作企业",
11256
11253
  "example": "all",
11257
11254
  "member": "string",
11258
11255
  "name": "AuthTag",
11259
11256
  "output_required": true,
11260
11257
  "type": "string",
11261
- "value_allowed_null": true
11258
+ "value_allowed_null": false
11262
11259
  },
11263
11260
  {
11264
11261
  "disabled": false,
11265
- "document": "第三方平台子客企业标识列表\n注意:此字段可能返回 null,表示取不到有效值。",
11262
+ "document": "第三方平台子客企业标识列表",
11266
11263
  "example": "[\"org_zhangsan\"]",
11267
11264
  "member": "string",
11268
11265
  "name": "ProxyOrganizationOpenIds",
11269
11266
  "output_required": true,
11270
11267
  "type": "list",
11271
- "value_allowed_null": true
11268
+ "value_allowed_null": false
11272
11269
  },
11273
11270
  {
11274
11271
  "disabled": false,
11275
- "document": "操作失败信息数组\n注意:此字段可能返回 null,表示取不到有效值。",
11272
+ "document": "操作失败信息数组",
11276
11273
  "example": "无",
11277
11274
  "member": "AuthFailMessage",
11278
11275
  "name": "FailMessageList",
11279
11276
  "output_required": true,
11280
11277
  "type": "list",
11281
- "value_allowed_null": true
11278
+ "value_allowed_null": false
11282
11279
  },
11283
11280
  {
11284
11281
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -11295,7 +11292,7 @@
11295
11292
  {
11296
11293
  "disabled": false,
11297
11294
  "document": "跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表\n<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> </tbody> </table>\n注: \n`1.链接仅单次有效,每次登录需要需要重新创建新的链接`\n`2.创建的链接应避免被转义,如:&被转义为\\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义`\n",
11298
- "example": "",
11295
+ "example": "https://essurl.cn/dNwuUBJ2C2",
11299
11296
  "member": "string",
11300
11297
  "name": "AuthUrl",
11301
11298
  "output_required": false,
@@ -11305,7 +11302,7 @@
11305
11302
  {
11306
11303
  "disabled": false,
11307
11304
  "document": "企业批量注册的错误信息,例如:企业三要素不通过",
11308
- "example": "",
11305
+ "example": "企业三要素不通过",
11309
11306
  "member": "string",
11310
11307
  "name": "ErrorMessage",
11311
11308
  "output_required": false,
@@ -11354,7 +11351,7 @@
11354
11351
  {
11355
11352
  "disabled": false,
11356
11353
  "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。\n注意:此字段可能返回 null,表示取不到有效值。",
11357
- "example": "",
11354
+ "example": "张三示例企业",
11358
11355
  "member": "string",
11359
11356
  "name": "OrganizationName",
11360
11357
  "output_required": false,
@@ -11365,7 +11362,7 @@
11365
11362
  {
11366
11363
  "disabled": false,
11367
11364
  "document": "组织机构企业统一社会信用代码。\n请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。\n注意:此字段可能返回 null,表示取不到有效值。",
11368
- "example": "",
11365
+ "example": "37000019890303000X",
11369
11366
  "member": "string",
11370
11367
  "name": "UniformSocialCreditCode",
11371
11368
  "output_required": false,
@@ -11376,7 +11373,7 @@
11376
11373
  {
11377
11374
  "disabled": false,
11378
11375
  "document": "组织机构法人的姓名。\n请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。\n注意:此字段可能返回 null,表示取不到有效值。",
11379
- "example": "",
11376
+ "example": "张三",
11380
11377
  "member": "string",
11381
11378
  "name": "LegalName",
11382
11379
  "output_required": false,
@@ -11398,7 +11395,7 @@
11398
11395
  {
11399
11396
  "disabled": false,
11400
11397
  "document": "组织机构法人的证件号码\n注意:此字段可能返回 null,表示取不到有效值。",
11401
- "example": "",
11398
+ "example": "37000019890303000X",
11402
11399
  "member": "string",
11403
11400
  "name": "LegalIdCardNumber",
11404
11401
  "output_required": false,
@@ -11409,7 +11406,7 @@
11409
11406
  {
11410
11407
  "disabled": false,
11411
11408
  "document": "组织机构超管姓名。\n\n注意:此字段可能返回 null,表示取不到有效值。",
11412
- "example": "",
11409
+ "example": "张三",
11413
11410
  "member": "string",
11414
11411
  "name": "AdminName",
11415
11412
  "output_required": false,
@@ -11420,7 +11417,7 @@
11420
11417
  {
11421
11418
  "disabled": false,
11422
11419
  "document": "组织机构超管手机号。\n\n注意:此字段可能返回 null,表示取不到有效值。",
11423
- "example": "",
11420
+ "example": "18888888888",
11424
11421
  "member": "string",
11425
11422
  "name": "AdminMobile",
11426
11423
  "output_required": false,
@@ -11442,7 +11439,7 @@
11442
11439
  {
11443
11440
  "disabled": false,
11444
11441
  "document": "组织机构超管证件号码\n\n注意:此字段可能返回 null,表示取不到有效值。",
11445
- "example": "",
11442
+ "example": "37000019890303000X",
11446
11443
  "member": "string",
11447
11444
  "name": "AdminIdCardNumber",
11448
11445
  "output_required": false,
@@ -11453,7 +11450,7 @@
11453
11450
  {
11454
11451
  "disabled": false,
11455
11452
  "document": "原超管姓名\n注意:此字段可能返回 null,表示取不到有效值。",
11456
- "example": "",
11453
+ "example": "李四",
11457
11454
  "member": "string",
11458
11455
  "name": "OldAdminName",
11459
11456
  "output_required": false,
@@ -11464,7 +11461,7 @@
11464
11461
  {
11465
11462
  "disabled": false,
11466
11463
  "document": "原超管手机号\n注意:此字段可能返回 null,表示取不到有效值。",
11467
- "example": "",
11464
+ "example": "15100000000",
11468
11465
  "member": "string",
11469
11466
  "name": "OldAdminMobile",
11470
11467
  "output_required": false,
@@ -11486,7 +11483,7 @@
11486
11483
  {
11487
11484
  "disabled": false,
11488
11485
  "document": "原超管证件号码\n注意:此字段可能返回 null,表示取不到有效值。",
11489
- "example": "",
11486
+ "example": "65000019870404000X",
11490
11487
  "member": "string",
11491
11488
  "name": "OldAdminIdCardNumber",
11492
11489
  "output_required": false,
@@ -11705,7 +11702,7 @@
11705
11702
  {
11706
11703
  "disabled": false,
11707
11704
  "document": "权限名称\n注意:此字段可能返回 null,表示取不到有效值。",
11708
- "example": "",
11705
+ "example": "费用管理",
11709
11706
  "member": "string",
11710
11707
  "name": "Name",
11711
11708
  "output_required": false,
@@ -11716,7 +11713,7 @@
11716
11713
  {
11717
11714
  "disabled": false,
11718
11715
  "document": "权限key\n注意:此字段可能返回 null,表示取不到有效值。",
11719
- "example": "",
11716
+ "example": "BillManagement",
11720
11717
  "member": "string",
11721
11718
  "name": "Key",
11722
11719
  "output_required": false,
@@ -11727,7 +11724,7 @@
11727
11724
  {
11728
11725
  "disabled": false,
11729
11726
  "document": "权限类型 1前端,2后端\n注意:此字段可能返回 null,表示取不到有效值。",
11730
- "example": "",
11727
+ "example": "1",
11731
11728
  "member": "int64",
11732
11729
  "name": "Type",
11733
11730
  "output_required": false,
@@ -11738,7 +11735,7 @@
11738
11735
  {
11739
11736
  "disabled": false,
11740
11737
  "document": "是否隐藏\n注意:此字段可能返回 null,表示取不到有效值。",
11741
- "example": "",
11738
+ "example": "0",
11742
11739
  "member": "int64",
11743
11740
  "name": "Hide",
11744
11741
  "output_required": false,
@@ -11749,7 +11746,7 @@
11749
11746
  {
11750
11747
  "disabled": false,
11751
11748
  "document": "数据权限标签 1:表示根节点,2:表示叶子结点\n注意:此字段可能返回 null,表示取不到有效值。",
11752
- "example": "",
11749
+ "example": "0",
11753
11750
  "member": "int64",
11754
11751
  "name": "DataLabel",
11755
11752
  "output_required": false,
@@ -11760,7 +11757,7 @@
11760
11757
  {
11761
11758
  "disabled": false,
11762
11759
  "document": "数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权\n注意:此字段可能返回 null,表示取不到有效值。",
11763
- "example": "",
11760
+ "example": "0",
11764
11761
  "member": "int64",
11765
11762
  "name": "DataType",
11766
11763
  "output_required": false,
@@ -11771,7 +11768,7 @@
11771
11768
  {
11772
11769
  "disabled": false,
11773
11770
  "document": "数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己\n注意:此字段可能返回 null,表示取不到有效值。",
11774
- "example": "",
11771
+ "example": "0",
11775
11772
  "member": "int64",
11776
11773
  "name": "DataRange",
11777
11774
  "output_required": false,
@@ -11782,7 +11779,7 @@
11782
11779
  {
11783
11780
  "disabled": false,
11784
11781
  "document": "关联权限, 表示这个功能权限要受哪个数据权限管控\n注意:此字段可能返回 null,表示取不到有效值。",
11785
- "example": "",
11782
+ "example": "FlowsManagement",
11786
11783
  "member": "string",
11787
11784
  "name": "DataTo",
11788
11785
  "output_required": false,
@@ -11793,7 +11790,7 @@
11793
11790
  {
11794
11791
  "disabled": false,
11795
11792
  "document": "父级权限key\n注意:此字段可能返回 null,表示取不到有效值。",
11796
- "example": "",
11793
+ "example": "FlowsManagement",
11797
11794
  "member": "string",
11798
11795
  "name": "ParentKey",
11799
11796
  "output_required": false,
@@ -11804,7 +11801,7 @@
11804
11801
  {
11805
11802
  "disabled": false,
11806
11803
  "document": "是否选中\n注意:此字段可能返回 null,表示取不到有效值。",
11807
- "example": "",
11804
+ "example": "false",
11808
11805
  "member": "bool",
11809
11806
  "name": "IsChecked",
11810
11807
  "output_required": false,
@@ -11832,7 +11829,7 @@
11832
11829
  {
11833
11830
  "disabled": false,
11834
11831
  "document": "权限组名称\n注意:此字段可能返回 null,表示取不到有效值。",
11835
- "example": "",
11832
+ "example": "费用中心",
11836
11833
  "member": "string",
11837
11834
  "name": "GroupName",
11838
11835
  "output_required": false,
@@ -11843,7 +11840,7 @@
11843
11840
  {
11844
11841
  "disabled": false,
11845
11842
  "document": "权限组key\n注意:此字段可能返回 null,表示取不到有效值。",
11846
- "example": "",
11843
+ "example": "bill",
11847
11844
  "member": "string",
11848
11845
  "name": "GroupKey",
11849
11846
  "output_required": false,
@@ -11854,7 +11851,7 @@
11854
11851
  {
11855
11852
  "disabled": false,
11856
11853
  "document": "是否隐藏分组,0否1是\n注意:此字段可能返回 null,表示取不到有效值。",
11857
- "example": "",
11854
+ "example": "0",
11858
11855
  "member": "int64",
11859
11856
  "name": "Hide",
11860
11857
  "output_required": false,
@@ -11973,7 +11970,7 @@
11973
11970
  {
11974
11971
  "disabled": false,
11975
11972
  "document": "经办人证件号",
11976
- "example": "",
11973
+ "example": "37000019890303000X",
11977
11974
  "member": "string",
11978
11975
  "name": "IdCardNumber",
11979
11976
  "required": false,
@@ -12006,7 +12003,7 @@
12006
12003
  {
12007
12004
  "disabled": false,
12008
12005
  "document": "合同参与方的角色ID",
12009
- "example": "ed68bc6904fbd4795b4658c480214e4e",
12006
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
12010
12007
  "member": "string",
12011
12008
  "name": "RecipientId",
12012
12009
  "output_required": true,
@@ -12028,7 +12025,7 @@
12028
12025
  {
12029
12026
  "disabled": false,
12030
12027
  "document": "合同参与方的角色描述,长度不能超过100,只能由中文、字母、数字和下划线组成。",
12031
- "example": "",
12028
+ "example": "本合同的卖方",
12032
12029
  "member": "string",
12033
12030
  "name": "Description",
12034
12031
  "output_required": true,
@@ -12127,7 +12124,7 @@
12127
12124
  {
12128
12125
  "disabled": false,
12129
12126
  "document": "签署方是否可以转他人处理\n\n<ul><li> **false** : ( 默认)可以转他人处理</li>\n<li> **true** :不可以转他人处理</li></ul>",
12130
- "example": "",
12127
+ "example": "false",
12131
12128
  "member": "bool",
12132
12129
  "name": "NoTransfer",
12133
12130
  "output_required": false,
@@ -12190,7 +12187,7 @@
12190
12187
  {
12191
12188
  "disabled": false,
12192
12189
  "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。",
12193
- "example": "",
12190
+ "example": "张三示例企业",
12194
12191
  "member": "string",
12195
12192
  "name": "OrganizationName",
12196
12193
  "required": true,
@@ -12199,7 +12196,7 @@
12199
12196
  {
12200
12197
  "disabled": false,
12201
12198
  "document": "机构在贵司业务系统中的唯一标识,用于与腾讯电子签企业账号进行映射,确保在同一应用内不会出现重复。\n该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。",
12202
- "example": "",
12199
+ "example": "org_zhangsan",
12203
12200
  "member": "string",
12204
12201
  "name": "OrganizationOpenId",
12205
12202
  "required": true,
@@ -12208,7 +12205,7 @@
12208
12205
  {
12209
12206
  "disabled": false,
12210
12207
  "document": "员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一应用内不会出现重复。\n该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。",
12211
- "example": "",
12208
+ "example": "zhangsan",
12212
12209
  "member": "string",
12213
12210
  "name": "OpenId",
12214
12211
  "required": true,
@@ -12217,7 +12214,7 @@
12217
12214
  {
12218
12215
  "disabled": false,
12219
12216
  "document": "组织机构企业统一社会信用代码。\n请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。",
12220
- "example": "",
12217
+ "example": "91110108772551611J",
12221
12218
  "member": "string",
12222
12219
  "name": "UniformSocialCreditCode",
12223
12220
  "required": true,
@@ -12226,7 +12223,7 @@
12226
12223
  {
12227
12224
  "disabled": false,
12228
12225
  "document": "组织机构法人的姓名。\n请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。",
12229
- "example": "",
12226
+ "example": "张三",
12230
12227
  "member": "string",
12231
12228
  "name": "LegalName",
12232
12229
  "required": true,
@@ -12244,7 +12241,7 @@
12244
12241
  {
12245
12242
  "disabled": false,
12246
12243
  "document": "组织机构超管姓名。\n在注册流程中,必须是超管本人进行操作。\n如果法人作为超管管理组织机构,超管姓名就是法人姓名",
12247
- "example": "",
12244
+ "example": "张三",
12248
12245
  "member": "string",
12249
12246
  "name": "AdminName",
12250
12247
  "required": false,
@@ -12253,7 +12250,7 @@
12253
12250
  {
12254
12251
  "disabled": false,
12255
12252
  "document": "组织机构超管手机号。\n在注册流程中,这个手机号必须跟操作人在电子签注册的个人手机号一致。",
12256
- "example": "",
12253
+ "example": "18888888888",
12257
12254
  "member": "string",
12258
12255
  "name": "AdminMobile",
12259
12256
  "required": false,
@@ -12262,7 +12259,7 @@
12262
12259
  {
12263
12260
  "disabled": false,
12264
12261
  "document": "可选的此企业允许的授权方式, 可以设置的方式有:\n1:上传授权书\n2:法人授权超管\n5:授权书+对公打款\n\n\n注:\n`1. 当前仅支持一种认证方式`\n`2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`\n`3. 如果当前操作人是法人,则是法人认证`",
12265
- "example": "",
12262
+ "example": "[1]",
12266
12263
  "member": "uint64",
12267
12264
  "name": "AuthorizationTypes",
12268
12265
  "required": false,
@@ -12271,7 +12268,7 @@
12271
12268
  {
12272
12269
  "disabled": false,
12273
12270
  "document": "经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n",
12274
- "example": "",
12271
+ "example": "ID_CARD",
12275
12272
  "member": "string",
12276
12273
  "name": "AdminIdCardType",
12277
12274
  "required": false,
@@ -12280,7 +12277,7 @@
12280
12277
  {
12281
12278
  "disabled": false,
12282
12279
  "document": "经办人的证件号",
12283
- "example": "",
12280
+ "example": "37000019890303000X",
12284
12281
  "member": "string",
12285
12282
  "name": "AdminIdCardNumber",
12286
12283
  "required": false,
@@ -12289,7 +12286,7 @@
12289
12286
  {
12290
12287
  "disabled": false,
12291
12288
  "document": "营业执照正面照(PNG或JPG) base64格式, 大小不超过5M",
12292
- "example": "",
12289
+ "example": "ykgYmFzZTY05qC85byPLCDlpKflsI/kuI3otoXov4c1TQ==",
12293
12290
  "member": "string",
12294
12291
  "name": "BusinessLicense",
12295
12292
  "required": false,
@@ -12298,7 +12295,7 @@
12298
12295
  {
12299
12296
  "disabled": false,
12300
12297
  "document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。\np.s. 如果上传授权书 ,需遵循以下条件\n1. 超管的信息(超管姓名,超管身份证,超管手机号)必须为必填参数。\n2. 超管的个人身份必须在电子签已经实名。\n2. 认证方式AuthorizationTypes必须只能是上传授权书方式 \n",
12301
- "example": "",
12298
+ "example": "[\"5o6I5p2D5LmmKFBOR+aIlkpQR+aIllBERikgYmFzZTY05qC85byP\"]",
12302
12299
  "member": "string",
12303
12300
  "name": "PowerOfAttorneys",
12304
12301
  "required": false,
@@ -12307,7 +12304,7 @@
12307
12304
  {
12308
12305
  "disabled": false,
12309
12306
  "document": "认证完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 [跳转电子签H5](https://qian.tencent.com/developers/company/openqianh5/)",
12310
- "example": "",
12307
+ "example": "https://jump.cn/jump",
12311
12308
  "member": "string",
12312
12309
  "name": "AutoJumpUrl",
12313
12310
  "required": false,
@@ -12412,7 +12409,7 @@
12412
12409
  {
12413
12410
  "disabled": false,
12414
12411
  "document": "签署控件类型,支持自定义企业签署方的签署控件类型\n<ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>\n<li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>",
12415
- "example": "",
12412
+ "example": "SIGN_SEAL",
12416
12413
  "member": "string",
12417
12414
  "name": "ApproverSignComponentType",
12418
12415
  "required": false,
@@ -12430,7 +12427,7 @@
12430
12427
  {
12431
12428
  "disabled": false,
12432
12429
  "document": "印章Id,签署控件类型为印章时,用于指定本企业签署方在解除协议中使用那个印章进行签署",
12433
- "example": "",
12430
+ "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7",
12434
12431
  "member": "string",
12435
12432
  "name": "ApproverSignSealId",
12436
12433
  "required": false,
@@ -12506,7 +12503,7 @@
12506
12503
  {
12507
12504
  "disabled": false,
12508
12505
  "document": "合同流程ID,为32位字符串。\t",
12509
- "example": "yDwxxxxxxxW72Qaxm\t",
12506
+ "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7",
12510
12507
  "member": "string",
12511
12508
  "name": "FlowId",
12512
12509
  "output_required": true,
@@ -12516,7 +12513,7 @@
12516
12513
  {
12517
12514
  "disabled": false,
12518
12515
  "document": "在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。\t",
12519
- "example": "\"\"",
12516
+ "example": "今天已经催办过了",
12520
12517
  "member": "string",
12521
12518
  "name": "RemindMessage",
12522
12519
  "output_required": true,
@@ -12740,7 +12737,7 @@
12740
12737
  {
12741
12738
  "disabled": false,
12742
12739
  "document": "经办人身份证号\n注意:此字段可能返回 null,表示取不到有效值。",
12743
- "example": "",
12740
+ "example": "37000019890303000X",
12744
12741
  "member": "string",
12745
12742
  "name": "IdCardNumber",
12746
12743
  "output_required": true,
@@ -12796,7 +12793,7 @@
12796
12793
  {
12797
12794
  "disabled": false,
12798
12795
  "document": "员工在电子签平台的用户ID",
12799
- "example": "",
12796
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
12800
12797
  "member": "string",
12801
12798
  "name": "UserId",
12802
12799
  "output_required": true,
@@ -12806,7 +12803,7 @@
12806
12803
  {
12807
12804
  "disabled": false,
12808
12805
  "document": "显示的员工名\n注意:2024-07-08 及之后创建的应用号,该字段返回的是打码信息",
12809
- "example": "",
12806
+ "example": "张三",
12810
12807
  "member": "string",
12811
12808
  "name": "DisplayName",
12812
12809
  "output_required": true,
@@ -12816,7 +12813,7 @@
12816
12813
  {
12817
12814
  "disabled": false,
12818
12815
  "document": "员工手机号\n注意:2024-07-08 及之后创建的应用号,该字段返回的是打码信息",
12819
- "example": "",
12816
+ "example": "18888888888",
12820
12817
  "member": "string",
12821
12818
  "name": "Mobile",
12822
12819
  "output_required": true,
@@ -12826,7 +12823,7 @@
12826
12823
  {
12827
12824
  "disabled": false,
12828
12825
  "document": "员工邮箱\n注意:此字段可能返回 null,表示取不到有效值。",
12829
- "example": "",
12826
+ "example": "zhansan@qq.com",
12830
12827
  "member": "string",
12831
12828
  "name": "Email",
12832
12829
  "output_required": true,
@@ -12836,7 +12833,7 @@
12836
12833
  {
12837
12834
  "disabled": false,
12838
12835
  "document": "员工在第三方应用平台的用户ID\n注意:此字段可能返回 null,表示取不到有效值。",
12839
- "example": "",
12836
+ "example": "zhansan",
12840
12837
  "member": "string",
12841
12838
  "name": "OpenId",
12842
12839
  "output_required": true,
@@ -12866,7 +12863,7 @@
12866
12863
  {
12867
12864
  "disabled": false,
12868
12865
  "document": "员工是否实名",
12869
- "example": "",
12866
+ "example": "true",
12870
12867
  "member": "bool",
12871
12868
  "name": "Verified",
12872
12869
  "output_required": true,
@@ -12876,7 +12873,7 @@
12876
12873
  {
12877
12874
  "disabled": false,
12878
12875
  "document": "员工创建时间戳,单位秒",
12879
- "example": "",
12876
+ "example": "1736751627",
12880
12877
  "member": "int64",
12881
12878
  "name": "CreatedOn",
12882
12879
  "output_required": true,
@@ -12886,7 +12883,7 @@
12886
12883
  {
12887
12884
  "disabled": false,
12888
12885
  "document": "员工实名时间戳,单位秒",
12889
- "example": "",
12886
+ "example": "1736751627",
12890
12887
  "member": "int64",
12891
12888
  "name": "VerifiedOn",
12892
12889
  "output_required": true,
@@ -12896,7 +12893,7 @@
12896
12893
  {
12897
12894
  "disabled": false,
12898
12895
  "document": "员工是否离职:0-未离职,1-离职",
12899
- "example": "",
12896
+ "example": "0",
12900
12897
  "member": "int64",
12901
12898
  "name": "QuiteJob",
12902
12899
  "output_required": true,
@@ -12912,20 +12909,20 @@
12912
12909
  {
12913
12910
  "disabled": false,
12914
12911
  "document": "角色id\n注意:此字段可能返回 null,表示取不到有效值。",
12915
- "example": "",
12912
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
12916
12913
  "member": "string",
12917
12914
  "name": "RoleId",
12918
- "required": true,
12915
+ "output_required": true,
12919
12916
  "type": "string",
12920
12917
  "value_allowed_null": true
12921
12918
  },
12922
12919
  {
12923
12920
  "disabled": false,
12924
12921
  "document": "角色名称\n注意:此字段可能返回 null,表示取不到有效值。",
12925
- "example": "",
12922
+ "example": "企业超级管理员",
12926
12923
  "member": "string",
12927
12924
  "name": "RoleName",
12928
- "required": true,
12925
+ "output_required": true,
12929
12926
  "type": "string",
12930
12927
  "value_allowed_null": true
12931
12928
  }
@@ -13005,23 +13002,23 @@
13005
13002
  "members": [
13006
13003
  {
13007
13004
  "disabled": false,
13008
- "document": " 同步的状态, 全部同步失败接口是接口会直接报错\n\n<ul><li> **1** :全部成功</li>\n<li> **2** :部分成功</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
13005
+ "document": " 同步的状态, 全部同步失败接口是接口会直接报错\n\n<ul><li> **1** :全部成功</li>\n<li> **2** :部分成功</li></ul>",
13009
13006
  "example": "1",
13010
13007
  "member": "int64",
13011
13008
  "name": "Status",
13012
13009
  "output_required": true,
13013
13010
  "type": "int",
13014
- "value_allowed_null": true
13011
+ "value_allowed_null": false
13015
13012
  },
13016
13013
  {
13017
13014
  "disabled": false,
13018
- "document": "同步失败员工ID及其失败原因\n注意:此字段可能返回 null,表示取不到有效值。",
13015
+ "document": "同步失败员工ID及其失败原因",
13019
13016
  "example": "无",
13020
13017
  "member": "SyncFailReason",
13021
13018
  "name": "FailedList",
13022
13019
  "output_required": true,
13023
13020
  "type": "list",
13024
- "value_allowed_null": true
13021
+ "value_allowed_null": false
13025
13022
  },
13026
13023
  {
13027
13024
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -13047,7 +13044,7 @@
13047
13044
  {
13048
13045
  "disabled": false,
13049
13046
  "document": "第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。\n注: `如果名称中包含英文括号(),请使用中文括号()代替。`",
13050
- "example": "",
13047
+ "example": "张三示例企业",
13051
13048
  "member": "string",
13052
13049
  "name": "ProxyOrganizationName",
13053
13050
  "required": true,
@@ -13056,7 +13053,7 @@
13056
13053
  {
13057
13054
  "disabled": false,
13058
13055
  "document": "营业执照正面照(PNG或JPG) base64格式, 大小不超过5M",
13059
- "example": "",
13056
+ "example": "aHR0cHM6Ly9jYXBpLndvYS5jb20vhaWwlM0ZpZCUzRGVzc2Jhc2ljJTI2dGFiJTNEYXBp..图片base64省略",
13060
13057
  "member": "string",
13061
13058
  "name": "BusinessLicense",
13062
13059
  "required": false,
@@ -13065,7 +13062,7 @@
13065
13062
  {
13066
13063
  "disabled": false,
13067
13064
  "document": "第三方平台子客企业统一社会信用代码,最大长度200个字符",
13068
- "example": "",
13065
+ "example": "BOLIU101304662708A",
13069
13066
  "member": "string",
13070
13067
  "name": "UniformSocialCreditCode",
13071
13068
  "required": false,
@@ -13074,7 +13071,7 @@
13074
13071
  {
13075
13072
  "disabled": false,
13076
13073
  "document": "第三方平台子客企业法定代表人的名字",
13077
- "example": "",
13074
+ "example": "张三",
13078
13075
  "member": "string",
13079
13076
  "name": "ProxyLegalName",
13080
13077
  "required": false,
@@ -13092,7 +13089,7 @@
13092
13089
  {
13093
13090
  "disabled": false,
13094
13091
  "document": "第三方平台子客企业法定代表人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li></ul>\n注: `现在仅支持ID_CARD中国大陆居民身份证类型`",
13095
- "example": "",
13092
+ "example": "ID_CARD",
13096
13093
  "member": "string",
13097
13094
  "name": "ProxyLegalIdCardType",
13098
13095
  "required": false,
@@ -13101,7 +13098,7 @@
13101
13098
  {
13102
13099
  "disabled": false,
13103
13100
  "document": "第三方平台子客企业法定代表人的证件号码, 应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>",
13104
- "example": "",
13101
+ "example": "620000198802020000",
13105
13102
  "member": "string",
13106
13103
  "name": "ProxyLegalIdCardNumber",
13107
13104
  "required": false,
@@ -13137,10 +13134,10 @@
13137
13134
  {
13138
13135
  "disabled": false,
13139
13136
  "document": "合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息\n注意:此字段可能返回 null,表示取不到有效值。",
13140
- "example": "\"xxx\"",
13137
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
13141
13138
  "member": "string",
13142
13139
  "name": "TaskId",
13143
- "required": true,
13140
+ "output_required": true,
13144
13141
  "type": "string",
13145
13142
  "value_allowed_null": true
13146
13143
  },
@@ -13150,7 +13147,7 @@
13150
13147
  "example": "NOTREADY",
13151
13148
  "member": "string",
13152
13149
  "name": "TaskStatus",
13153
- "required": true,
13150
+ "output_required": true,
13154
13151
  "type": "string",
13155
13152
  "value_allowed_null": true
13156
13153
  }
@@ -13273,7 +13270,7 @@
13273
13270
  {
13274
13271
  "disabled": false,
13275
13272
  "document": "第三方应用集成-模板PDF文件链接,有效期5分钟。\n请求参数WithPdfUrl=true时返回\n(此功能开放需要联系客户经理)。\n注意:此字段可能返回 null,表示取不到有效值。",
13276
- "example": "",
13273
+ "example": "https://file.cn/resource.pdf",
13277
13274
  "member": "string",
13278
13275
  "name": "PdfUrl",
13279
13276
  "output_required": true,
@@ -13339,7 +13336,7 @@
13339
13336
  {
13340
13337
  "disabled": false,
13341
13338
  "document": "Base64编码后的文件内容",
13342
- "example": "",
13339
+ "example": "QmFzZTY057yW56CB5ZCO55qE5paH5Lu25YaF5a65",
13343
13340
  "member": "string",
13344
13341
  "name": "FileBody",
13345
13342
  "required": true,
@@ -13348,7 +13345,7 @@
13348
13345
  {
13349
13346
  "disabled": false,
13350
13347
  "document": "文件的名字。\n文件名的最大长度应不超过200个字符,并且文件名的后缀必须反映其文件类型。\n例如,PDF文件应以“.pdf”结尾,如“XXX.pdf”,而Word文件应以“.doc”或“.docx”结尾,如“XXX.doc”或“XXX.docx”。",
13351
- "example": "",
13348
+ "example": "入职合同.PDF",
13352
13349
  "member": "string",
13353
13350
  "name": "FileName",
13354
13351
  "required": false,
@@ -13415,7 +13412,7 @@
13415
13412
  {
13416
13413
  "disabled": false,
13417
13414
  "document": "文件资源ID数组,每个文件资源ID为32位字符串。\n建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。\n注:`有效期一个小时(超过一小时后系统不定期清理,会有部分时间差), 有效期内此文件id可以反复使用, 超过有效期无法使用`",
13418
- "example": "",
13415
+ "example": "[\"yDwivUUckpo2v2b8Ux8pIP8CvvGGWvIs\"]",
13419
13416
  "member": "string",
13420
13417
  "name": "FileIds",
13421
13418
  "output_required": true,
@@ -13425,7 +13422,7 @@
13425
13422
  {
13426
13423
  "disabled": false,
13427
13424
  "document": "对应上传文件的下载链接,过期时间5分钟",
13428
- "example": "",
13425
+ "example": "[\"https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.PDF?hkey=d13d83**c14\"]",
13429
13426
  "member": "string",
13430
13427
  "name": "FileUrls",
13431
13428
  "output_required": true,
@@ -13447,7 +13444,7 @@
13447
13444
  {
13448
13445
  "disabled": false,
13449
13446
  "document": "子客企业标识",
13450
- "example": "",
13447
+ "example": "org_zhangsan",
13451
13448
  "member": "string",
13452
13449
  "name": "ProxyOrganizationOpenId",
13453
13450
  "output_required": true,
@@ -13457,7 +13454,7 @@
13457
13454
  {
13458
13455
  "disabled": false,
13459
13456
  "document": "子客企业名\n注意:此字段可能返回 null,表示取不到有效值。",
13460
- "example": "",
13457
+ "example": "张三示例企业",
13461
13458
  "member": "string",
13462
13459
  "name": "ProxyOrganizationName",
13463
13460
  "output_required": true,
@@ -13513,7 +13510,7 @@
13513
13510
  {
13514
13511
  "disabled": false,
13515
13512
  "document": "第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。\n\n\n注意:\n1. OpenId在子客企业对应一个真实员工,**本应用唯一, 不可重复使用**,最大64位字符串\n2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId\n3. **员工加入企业后**, 可以通过<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl\" target=\"_blank\">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/bb67fb66c926759df3a0af5838fdafd5.png)",
13516
- "example": "",
13513
+ "example": "n9527",
13517
13514
  "member": "string",
13518
13515
  "name": "OpenId",
13519
13516
  "required": false,
@@ -13615,7 +13612,7 @@
13615
13612
  {
13616
13613
  "disabled": false,
13617
13614
  "document": "企业认证页背景图(base64图片)\n",
13618
- "example": "",
13615
+ "example": "5LyB5Lia6K6k6K+B6aG16IOM5pmv5Zu+77yIYmFzZTY05Zu+54mH77yJ",
13619
13616
  "member": "string",
13620
13617
  "name": "AuthenticateBackground",
13621
13618
  "required": false,