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
@@ -57,7 +57,7 @@
57
57
  "status": "online"
58
58
  },
59
59
  "CreateBatchOrganizationRegistrationTasks": {
60
- "document": "本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接\n该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.\n\n批量创建链接有以下限制:\n\n1. 单次最多创建10个企业。\n2. 一天同一家企业最多创建8000家企业。\n3. 同一批创建的企业不能重复 其中包括 企业名称,企业统一信用代码\n4. 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置\n\n注:\n\n1. **此接口需要购买单独的实名套餐包方可调用,如有需求请联系对接人员评估**\n \n2. 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>\n \n\n**腾讯电子签小程序的AppID 和 原始Id如下:**\n\n| 小程序 | AppID | 原始ID |\n| --- | --- | --- |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
60
+ "document": "本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接\n该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.\n\n批量创建链接有以下限制:\n\n1. 单次最多创建10个企业。\n2. 一天同一家企业最多创建8000家企业。\n3. 同一批创建的企业不能重复 其中包括 企业名称,企业统一信用代码\n4. 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置\n\n注:\n\n1. 此接口需要 <font color=\"red\"><b>购买单独的实名套餐包</b></font>方可调用,如有需求请联系对接人员评估\n \n2. 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>\n \n\n**腾讯电子签小程序的AppID 和 原始Id如下:**\n\n| 小程序 | AppID | 原始ID |\n| --- | --- | --- |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
61
61
  "input": "CreateBatchOrganizationRegistrationTasksRequest",
62
62
  "name": "创建企业批量认证链接",
63
63
  "output": "CreateBatchOrganizationRegistrationTasksResponse",
@@ -686,7 +686,7 @@
686
686
  {
687
687
  "disabled": false,
688
688
  "document": "超管名\n注意:此字段可能返回 null,表示取不到有效值。",
689
- "example": "",
689
+ "example": "张三",
690
690
  "member": "string",
691
691
  "name": "Name",
692
692
  "output_required": true,
@@ -696,7 +696,7 @@
696
696
  {
697
697
  "disabled": false,
698
698
  "document": "超管手机号,打码显示\n示例值:138****1569\n\n注意:此字段可能返回 null,表示取不到有效值。",
699
- "example": "",
699
+ "example": "18888888888",
700
700
  "member": "string",
701
701
  "name": "Mobile",
702
702
  "output_required": true,
@@ -730,7 +730,7 @@
730
730
  {
731
731
  "disabled": false,
732
732
  "document": "被代理机构在电子签平台的机构编号,集团代理下场景必传",
733
- "example": "",
733
+ "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7",
734
734
  "member": "string",
735
735
  "name": "ProxyOrganizationId",
736
736
  "required": false,
@@ -754,7 +754,7 @@
754
754
  {
755
755
  "disabled": false,
756
756
  "document": "签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。",
757
- "example": "",
757
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
758
758
  "member": "string",
759
759
  "name": "RecipientId",
760
760
  "required": true,
@@ -763,7 +763,7 @@
763
763
  {
764
764
  "disabled": false,
765
765
  "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>",
766
- "example": "",
766
+ "example": "[\"HANDWRITE\"]",
767
767
  "member": "string",
768
768
  "name": "Values",
769
769
  "required": true,
@@ -778,7 +778,7 @@
778
778
  {
779
779
  "disabled": false,
780
780
  "document": "在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:\n**0**:企业\n**1**:个人\n**3**:企业静默签署\n注:`类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。`\n**7**: 个人自动签署,适用于个人自动签场景。\n注: `个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。`",
781
- "example": "",
781
+ "example": "0",
782
782
  "member": "int64",
783
783
  "name": "ApproverType",
784
784
  "required": true,
@@ -787,7 +787,7 @@
787
787
  {
788
788
  "disabled": false,
789
789
  "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。",
790
- "example": "",
790
+ "example": "张三",
791
791
  "member": "string",
792
792
  "name": "ApproverName",
793
793
  "required": false,
@@ -796,7 +796,7 @@
796
796
  {
797
797
  "disabled": false,
798
798
  "document": "签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此合同签署方。",
799
- "example": "",
799
+ "example": "18888888888",
800
800
  "member": "string",
801
801
  "name": "ApproverMobile",
802
802
  "required": false,
@@ -805,7 +805,7 @@
805
805
  {
806
806
  "disabled": false,
807
807
  "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。\n如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。\n",
808
- "example": "",
808
+ "example": "张三示例企业",
809
809
  "member": "string",
810
810
  "name": "OrganizationName",
811
811
  "required": false,
@@ -886,7 +886,7 @@
886
886
  {
887
887
  "disabled": false,
888
888
  "document": "签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得\n\n注: \n如果传进来的<font color=\"red\">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)",
889
- "example": "",
889
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
890
890
  "member": "string",
891
891
  "name": "UserId",
892
892
  "required": false,
@@ -895,7 +895,7 @@
895
895
  {
896
896
  "disabled": false,
897
897
  "document": "在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。",
898
- "example": "",
898
+ "example": "WEWORKAPP",
899
899
  "member": "string",
900
900
  "name": "ApproverSource",
901
901
  "required": false,
@@ -904,7 +904,7 @@
904
904
  {
905
905
  "disabled": false,
906
906
  "document": "在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。\n所有参与或签的人员均需具备该标识。\n注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。\n如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。",
907
- "example": "",
907
+ "example": "n9527",
908
908
  "member": "string",
909
909
  "name": "CustomApproverTag",
910
910
  "required": false,
@@ -940,7 +940,7 @@
940
940
  {
941
941
  "disabled": false,
942
942
  "document": "此签署人(员工或者个人)签署前,是否需要发起方企业审批,取值如下:\n<ul><li>**false**:(默认)不需要审批,直接签署。</li>\n<li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>\n企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果\n<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>\n<li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>\n\n注:`此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同`\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png)",
943
- "example": "",
943
+ "example": "false",
944
944
  "member": "bool",
945
945
  "name": "ApproverNeedSignReview",
946
946
  "required": false,
@@ -958,7 +958,7 @@
958
958
  {
959
959
  "disabled": false,
960
960
  "document": "签署须知:支持传入富文本,最长字数:500个中文字符",
961
- "example": "",
961
+ "example": "这个合同不能截图转发",
962
962
  "member": "string",
963
963
  "name": "SignInstructionContent",
964
964
  "required": false,
@@ -1000,7 +1000,7 @@
1000
1000
  {
1001
1001
  "disabled": false,
1002
1002
  "document": "签署方唯一编号\n注意:此字段可能返回 null,表示取不到有效值。",
1003
- "example": "",
1003
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
1004
1004
  "member": "string",
1005
1005
  "name": "SignId",
1006
1006
  "output_required": false,
@@ -1010,7 +1010,7 @@
1010
1010
  {
1011
1011
  "disabled": false,
1012
1012
  "document": "签署方角色编号\n注意:此字段可能返回 null,表示取不到有效值。",
1013
- "example": "",
1013
+ "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
1014
1014
  "member": "string",
1015
1015
  "name": "RecipientId",
1016
1016
  "output_required": false,
@@ -1020,7 +1020,7 @@
1020
1020
  {
1021
1021
  "disabled": false,
1022
1022
  "document": "签署方角色名称\n注意:此字段可能返回 null,表示取不到有效值。",
1023
- "example": "",
1023
+ "example": "甲方",
1024
1024
  "member": "string",
1025
1025
  "name": "ApproverRoleName",
1026
1026
  "output_required": false,
@@ -1063,7 +1063,7 @@
1063
1063
  {
1064
1064
  "disabled": false,
1065
1065
  "document": "签署人信息补充类型,默认无需补充。\n\n<ul><li> **1** : 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>\n\n注:\n`使用动态签署人能力前,需登陆腾讯电子签控制台打开服务开关`",
1066
- "example": "",
1066
+ "example": "1",
1067
1067
  "member": "int64",
1068
1068
  "name": "FillType",
1069
1069
  "required": false,
@@ -1072,7 +1072,7 @@
1072
1072
  {
1073
1073
  "disabled": false,
1074
1074
  "document": "签署人阅读合同限制参数\n <br/>取值:\n<ul>\n<li> LimitReadTimeAndBottom,阅读合同必须限制阅读时长并且必须阅读到底</li>\n<li> LimitReadTime,阅读合同仅限制阅读时长</li>\n<li> LimitBottom,阅读合同仅限制必须阅读到底</li>\n<li> NoReadTimeAndBottom,阅读合同不限制阅读时长且不限制阅读到底(白名单功能,请联系客户经理开白使用)</li>\n</ul>",
1075
- "example": "",
1075
+ "example": "3",
1076
1076
  "member": "string",
1077
1077
  "name": "FlowReadLimit",
1078
1078
  "required": false,
@@ -1235,7 +1235,7 @@
1235
1235
  {
1236
1236
  "disabled": false,
1237
1237
  "document": "扩展服务类型,和入参一致\n注意:此字段可能返回 null,表示取不到有效值。",
1238
- "example": "",
1238
+ "example": "OPEN_SERVER_SIGN",
1239
1239
  "member": "string",
1240
1240
  "name": "Type",
1241
1241
  "output_required": false,
@@ -1246,7 +1246,7 @@
1246
1246
  {
1247
1247
  "disabled": false,
1248
1248
  "document": "扩展服务名称\n注意:此字段可能返回 null,表示取不到有效值。",
1249
- "example": "",
1249
+ "example": "企业静默签(自动签署)",
1250
1250
  "member": "string",
1251
1251
  "name": "Name",
1252
1252
  "output_required": false,
@@ -1279,7 +1279,7 @@
1279
1279
  {
1280
1280
  "disabled": false,
1281
1281
  "document": "授权员工列表总数\n注意:此字段可能返回 null,表示取不到有效值。",
1282
- "example": "",
1282
+ "example": "0",
1283
1283
  "member": "int64",
1284
1284
  "name": "AuthUserTotal",
1285
1285
  "output_required": false,
@@ -1290,7 +1290,7 @@
1290
1290
  {
1291
1291
  "disabled": false,
1292
1292
  "document": "授权企业列表总数\n注意:此字段可能返回 null,表示取不到有效值。",
1293
- "example": "",
1293
+ "example": "1",
1294
1294
  "member": "int64",
1295
1295
  "name": "AuthOrganizationTotal",
1296
1296
  "output_required": false,
@@ -1353,10 +1353,10 @@
1353
1353
  {
1354
1354
  "disabled": false,
1355
1355
  "document": "电子签系统中的用户id",
1356
- "example": "",
1356
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
1357
1357
  "member": "string",
1358
1358
  "name": "UserId",
1359
- "required": true,
1359
+ "output_required": true,
1360
1360
  "type": "string",
1361
1361
  "value_allowed_null": false
1362
1362
  }
@@ -1378,7 +1378,7 @@
1378
1378
  {
1379
1379
  "disabled": false,
1380
1380
  "document": "是否回调证书信息:\n<ul><li>**false**: 不需要(默认)</li>\n<li>**true**:需要</li></ul>",
1381
- "example": "",
1381
+ "example": "false",
1382
1382
  "member": "bool",
1383
1383
  "name": "CertInfoCallback",
1384
1384
  "required": false,
@@ -1387,7 +1387,7 @@
1387
1387
  {
1388
1388
  "disabled": false,
1389
1389
  "document": "是否支持用户自定义签名印章:\n<ul><li>**false**: 不能自己定义(默认)</li>\n<li>**true**: 可以自己定义</li></ul>",
1390
- "example": "",
1390
+ "example": "false",
1391
1391
  "member": "bool",
1392
1392
  "name": "UserDefineSeal",
1393
1393
  "required": false,
@@ -1396,7 +1396,7 @@
1396
1396
  {
1397
1397
  "disabled": false,
1398
1398
  "document": "回调中是否需要自动签将要使用的印章(签名) 图片的 base64:\n<ul><li>**false**: 不需要(默认)</li>\n<li>**true**: 需要</li></ul>",
1399
- "example": "",
1399
+ "example": "false",
1400
1400
  "member": "bool",
1401
1401
  "name": "SealImgCallback",
1402
1402
  "required": false,
@@ -1414,7 +1414,7 @@
1414
1414
  {
1415
1415
  "disabled": false,
1416
1416
  "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>",
1417
- "example": "",
1417
+ "example": "[\"WEIXINAPP\"]",
1418
1418
  "member": "string",
1419
1419
  "name": "VerifyChannels",
1420
1420
  "required": false,
@@ -1423,7 +1423,7 @@
1423
1423
  {
1424
1424
  "disabled": false,
1425
1425
  "document": "设置用户自动签合同的扣费方式。\n\n<ul><li><b>1</b>: (默认)使用合同份额进行扣减</li></ul>",
1426
- "example": "",
1426
+ "example": "1",
1427
1427
  "member": "int64",
1428
1428
  "name": "LicenseType",
1429
1429
  "required": false,
@@ -1432,7 +1432,7 @@
1432
1432
  {
1433
1433
  "disabled": false,
1434
1434
  "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",
1435
- "example": "",
1435
+ "example": "https://jump.cn/jump",
1436
1436
  "member": "string",
1437
1437
  "name": "JumpUrl",
1438
1438
  "required": false,
@@ -1486,7 +1486,7 @@
1486
1486
  },
1487
1487
  {
1488
1488
  "disabled": false,
1489
- "document": "当前合同状态,如下是状态码对应的状态。\n<ul>\n<li>**0**: 还没有发起</li>\n<li>**1**: 等待签署</li>\n<li>**2**: 部分签署 </li>\n<li>**3**: 拒签</li>\n<li>**4**: 已签署 </li>\n<li>**5**: 已过期 </li>\n<li>**6**: 已撤销 </li>\n<li>**7**: 还没有预发起</li>\n<li>**8**: 等待填写</li>\n<li>**9**: 部分填写 </li>\n<li>**10**: 拒填</li>\n<li>**11**: 已解除</li>\n</ul>",
1489
+ "document": "当前合同状态,如下是状态码对应的状态。\n<ul>\n<li>**0**: 还没有发起</li>\n<li>**1**: 等待签署</li>\n<li>**2**: 部分签署 </li>\n<li>**3**: 拒签</li>\n<li>**4**: 已签署 </li>\n<li>**5**: 已过期 </li>\n<li>**6**: 已撤销 </li>\n<li>**7**: 还没有预发起</li>\n<li>**8**: 等待填写</li>\n<li>**9**: 部分填写 </li>\n<li>**10**: 拒签</li>\n<li>**11**: 已解除</li>\n</ul>",
1490
1490
  "example": "4",
1491
1491
  "member": "int64",
1492
1492
  "name": "Status",
@@ -1547,7 +1547,7 @@
1547
1547
  {
1548
1548
  "disabled": false,
1549
1549
  "document": "备注",
1550
- "example": "",
1550
+ "example": "备注",
1551
1551
  "member": "string",
1552
1552
  "name": "Remark",
1553
1553
  "output_required": false,
@@ -1572,7 +1572,7 @@
1572
1572
  {
1573
1573
  "disabled": false,
1574
1574
  "document": "员工在腾讯电子签平台的唯一身份标识,为32位字符串。\n\n通过<a href=\"https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees\" target=\"_blank\">DescribeIntegrationEmployees</a>接口获取,也可登录腾讯电子签控制台查看\n![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)",
1575
- "example": "",
1575
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
1576
1576
  "member": "string",
1577
1577
  "name": "UserId",
1578
1578
  "required": true,
@@ -1581,7 +1581,7 @@
1581
1581
  {
1582
1582
  "disabled": false,
1583
1583
  "document": "员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。",
1584
- "example": "",
1584
+ "example": "n9527",
1585
1585
  "member": "string",
1586
1586
  "name": "OpenId",
1587
1587
  "required": true,
@@ -1605,7 +1605,7 @@
1605
1605
  {
1606
1606
  "disabled": false,
1607
1607
  "document": "绑定是否成功。\n<ul><li>**0**:失败</li><li>**1**:成功</li></ul>",
1608
- "example": "",
1608
+ "example": "1",
1609
1609
  "member": "int64",
1610
1610
  "name": "Status",
1611
1611
  "output_required": true,
@@ -1715,7 +1715,7 @@
1715
1715
  {
1716
1716
  "disabled": false,
1717
1717
  "document": "合同流程ID,为32位字符串。",
1718
- "example": "",
1718
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
1719
1719
  "member": "string",
1720
1720
  "name": "FlowId",
1721
1721
  "output_required": true,
@@ -1726,7 +1726,7 @@
1726
1726
  {
1727
1727
  "disabled": false,
1728
1728
  "document": "撤销失败原因",
1729
- "example": "",
1729
+ "example": "合同已经过期",
1730
1730
  "member": "string",
1731
1731
  "name": "Reason",
1732
1732
  "output_required": false,
@@ -1851,7 +1851,7 @@
1851
1851
  {
1852
1852
  "disabled": false,
1853
1853
  "document": "自动签使用的场景值, 可以选择的场景值如下:\n<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>",
1854
- "example": "",
1854
+ "example": "E_PRESCRIPTION_AUTO_SIGN",
1855
1855
  "member": "string",
1856
1856
  "name": "SceneKey",
1857
1857
  "required": true,
@@ -1958,7 +1958,7 @@
1958
1958
  {
1959
1959
  "disabled": false,
1960
1960
  "document": "**在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。\n",
1961
- "example": "",
1961
+ "example": "43",
1962
1962
  "member": "float",
1963
1963
  "name": "ComponentHeight",
1964
1964
  "output_required": true,
@@ -1969,7 +1969,7 @@
1969
1969
  {
1970
1970
  "disabled": false,
1971
1971
  "document": "**在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。\n",
1972
- "example": "",
1972
+ "example": "119",
1973
1973
  "member": "float",
1974
1974
  "name": "ComponentWidth",
1975
1975
  "output_required": true,
@@ -1980,7 +1980,7 @@
1980
1980
  {
1981
1981
  "disabled": false,
1982
1982
  "document": "**在绝对定位方式方式下**,指定控件所在PDF文件上的页码\n**在使用文件发起的情况下**,绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码,使用负数时,页码从最后一页开始。例如:ComponentPage设置为-1,即代表在PDF文件的最后一页,以此类推。\n\n注:\n1. 页码编号是从<font color=\"red\">1</font>开始编号的。\n2. <font color=\"red\">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。",
1983
- "example": "",
1983
+ "example": "1",
1984
1984
  "member": "int64",
1985
1985
  "name": "ComponentPage",
1986
1986
  "output_required": true,
@@ -1991,7 +1991,7 @@
1991
1991
  {
1992
1992
  "disabled": false,
1993
1993
  "document": "**在绝对定位方式和关键字定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。",
1994
- "example": "",
1994
+ "example": "100",
1995
1995
  "member": "float",
1996
1996
  "name": "ComponentPosX",
1997
1997
  "output_required": true,
@@ -2002,7 +2002,7 @@
2002
2002
  {
2003
2003
  "disabled": false,
2004
2004
  "document": "**在绝对定位方式和关键字定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。",
2005
- "example": "",
2005
+ "example": "100",
2006
2006
  "member": "float",
2007
2007
  "name": "ComponentPosY",
2008
2008
  "output_required": true,
@@ -2024,7 +2024,7 @@
2024
2024
  {
2025
2025
  "disabled": false,
2026
2026
  "document": "控件生成的方式:\n<ul><li> <b>NORMAL</b> : 绝对定位控件</li>\n<li> <b>FIELD</b> : 表单域</li>\n<li> <b>KEYWORD</b> : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)</li></ul>",
2027
- "example": "",
2027
+ "example": "NORMAL",
2028
2028
  "member": "string",
2029
2029
  "name": "GenerateMode",
2030
2030
  "output_required": true,
@@ -2035,7 +2035,7 @@
2035
2035
  {
2036
2036
  "disabled": false,
2037
2037
  "document": "控件唯一ID。\n\n**在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。\n\n**在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。\n\n例:\n\n- 如传入的关键字<font color=\"red\">\"^甲方签署^\"</font >,则会在PDF文件中有且仅有\"甲方签署\"关键字的地方(<font color=\"red\">前后不能有其他字符</font >)进行对应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">前后可以有其他字符</font >)都会执行相应操作。\n\n\n注:`控件ID可以在一个PDF中不可重复`\n\n<a href=\"https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png\" target=\"_blank\">点击查看ComponentId在模板编辑页面的位置</a>\n",
2038
- "example": "",
2038
+ "example": "ComponentId_01",
2039
2039
  "member": "string",
2040
2040
  "name": "ComponentId",
2041
2041
  "output_required": true,
@@ -2057,7 +2057,7 @@
2057
2057
  {
2058
2058
  "disabled": false,
2059
2059
  "document": "如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填\n<ul><li>false(默认):可以不填写</li>\n<li>true :必须填写此填写控件</li></ul>\n如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响",
2060
- "example": "",
2060
+ "example": "true",
2061
2061
  "member": "bool",
2062
2062
  "name": "ComponentRequired",
2063
2063
  "output_required": true,
@@ -2068,7 +2068,7 @@
2068
2068
  {
2069
2069
  "disabled": false,
2070
2070
  "document": "**在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**",
2071
- "example": "",
2071
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
2072
2072
  "member": "string",
2073
2073
  "name": "ComponentRecipientId",
2074
2074
  "output_required": true,
@@ -2079,7 +2079,7 @@
2079
2079
  {
2080
2080
  "disabled": false,
2081
2081
  "document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围6 :24</li>\n<li> <b>Opacity</b>: 透明度,范围0 :1</li>\n<li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>\n<li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>:`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>,可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n\n",
2082
- "example": "",
2082
+ "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}",
2083
2083
  "member": "string",
2084
2084
  "name": "ComponentExtra",
2085
2085
  "output_required": true,
@@ -2090,7 +2090,7 @@
2090
2090
  {
2091
2091
  "disabled": false,
2092
2092
  "document": "**在通过接口拉取控件信息场景下**,为出参参数,此控件是否通过表单域定位方式生成,默认false-不是,**发起合同时候不要填写此字段留空即可**",
2093
- "example": "",
2093
+ "example": "false",
2094
2094
  "member": "bool",
2095
2095
  "name": "IsFormType",
2096
2096
  "output_required": true,
@@ -2101,7 +2101,7 @@
2101
2101
  {
2102
2102
  "disabled": false,
2103
2103
  "document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容,可以用 \\n 来控制换行位置 </li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 格式化为:xxxx年xx月xx日(例如2024年05年28日)</li>\n<li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li></ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>\n注: `部分特殊控件需要在控制台配置模板形式创建`",
2104
- "example": "",
2104
+ "example": "100元",
2105
2105
  "member": "string",
2106
2106
  "name": "ComponentValue",
2107
2107
  "output_required": true,
@@ -2112,7 +2112,7 @@
2112
2112
  {
2113
2113
  "disabled": false,
2114
2114
  "document": "**如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。\n注意: `向左调整设置为负数, 向右调整设置成正数`\n注意:此字段可能返回 null,表示取不到有效值。",
2115
- "example": "",
2115
+ "example": "10",
2116
2116
  "member": "float",
2117
2117
  "name": "OffsetX",
2118
2118
  "output_required": true,
@@ -2123,7 +2123,7 @@
2123
2123
  {
2124
2124
  "disabled": false,
2125
2125
  "document": "**如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。\n注意: `向上调整设置为负数, 向下调整设置成正数`\n注意:此字段可能返回 null,表示取不到有效值。",
2126
- "example": "",
2126
+ "example": "10",
2127
2127
  "member": "float",
2128
2128
  "name": "OffsetY",
2129
2129
  "output_required": true,
@@ -2145,7 +2145,7 @@
2145
2145
  {
2146
2146
  "disabled": false,
2147
2147
  "document": "**如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。",
2148
- "example": "",
2148
+ "example": "1",
2149
2149
  "member": "int64",
2150
2150
  "name": "KeywordPage",
2151
2151
  "output_required": true,
@@ -2156,7 +2156,7 @@
2156
2156
  {
2157
2157
  "disabled": false,
2158
2158
  "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,则印章在关键字的正下方",
2159
- "example": "",
2159
+ "example": "LowerRight",
2160
2160
  "member": "string",
2161
2161
  "name": "RelativeLocation",
2162
2162
  "output_required": true,
@@ -2167,7 +2167,7 @@
2167
2167
  {
2168
2168
  "disabled": false,
2169
2169
  "document": "**如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。\n\n注意:关键字索引是从0开始计数的",
2170
- "example": "",
2170
+ "example": "0",
2171
2171
  "member": "int64",
2172
2172
  "name": "KeywordIndexes",
2173
2173
  "output_required": true,
@@ -2178,7 +2178,7 @@
2178
2178
  {
2179
2179
  "disabled": false,
2180
2180
  "document": "**web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑\n<ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>\n<li>true:锁定控件值,在页面编辑控件值</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
2181
- "example": "",
2181
+ "example": "false",
2182
2182
  "member": "bool",
2183
2183
  "name": "LockComponentValue",
2184
2184
  "output_required": false,
@@ -2189,7 +2189,7 @@
2189
2189
  {
2190
2190
  "disabled": false,
2191
2191
  "document": "**web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件\n<ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>\n<li> <b>true</b> : 可以移动和删除控件</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
2192
- "example": "",
2192
+ "example": "false",
2193
2193
  "member": "bool",
2194
2194
  "name": "ForbidMoveAndDelete",
2195
2195
  "output_required": false,
@@ -2200,7 +2200,7 @@
2200
2200
  {
2201
2201
  "disabled": false,
2202
2202
  "document": "<font color=\"red\">【暂未使用】</font>日期签署控件的字号,默认为 12",
2203
- "example": "",
2203
+ "example": "12",
2204
2204
  "member": "int64",
2205
2205
  "name": "ComponentDateFontSize",
2206
2206
  "output_required": true,
@@ -2211,7 +2211,7 @@
2211
2211
  {
2212
2212
  "disabled": false,
2213
2213
  "document": "<font color=\"red\">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识",
2214
- "example": "",
2214
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
2215
2215
  "member": "string",
2216
2216
  "name": "ChannelComponentId",
2217
2217
  "output_required": true,
@@ -2222,7 +2222,7 @@
2222
2222
  {
2223
2223
  "disabled": false,
2224
2224
  "document": "<font color=\"red\">【暂未使用】</font>第三方应用集成中子客企业控件来源。\n<ul><li> <b>0</b> :平台指定;</li>\n<li> <b>1</b> :用户自定义</li></ul>",
2225
- "example": "",
2225
+ "example": "0",
2226
2226
  "member": "uint64",
2227
2227
  "name": "ChannelComponentSource",
2228
2228
  "output_required": true,
@@ -2239,7 +2239,7 @@
2239
2239
  {
2240
2240
  "disabled": false,
2241
2241
  "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>",
2242
- "example": "",
2242
+ "example": "SIGN_PAGING_SEAL ",
2243
2243
  "member": "string",
2244
2244
  "name": "ComponentType",
2245
2245
  "required": true,
@@ -2248,7 +2248,7 @@
2248
2248
  {
2249
2249
  "disabled": false,
2250
2250
  "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\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 时无需传递此参数。",
2251
- "example": "",
2251
+ "example": "OFFICIAL",
2252
2252
  "member": "string",
2253
2253
  "name": "ComponentValue",
2254
2254
  "required": false,
@@ -2272,7 +2272,7 @@
2272
2272
  {
2273
2273
  "disabled": false,
2274
2274
  "document": "需要执行撤回的流程(合同)的编号列表,最多100个.\n列表中的流程(合同)编号不要重复.",
2275
- "example": "",
2275
+ "example": "[\"yDt1JUUckp77a2omUyEmko88eg49PTsN\"]",
2276
2276
  "member": "string",
2277
2277
  "name": "FlowIds",
2278
2278
  "required": true,
@@ -2296,7 +2296,7 @@
2296
2296
  {
2297
2297
  "disabled": false,
2298
2298
  "document": "批量撤回签署流程链接",
2299
- "example": "",
2299
+ "example": "https://qian.tencent.cn/code=yDtwRUUckp7fyqz6UuQZAp18BNrB74xu",
2300
2300
  "member": "string",
2301
2301
  "name": "BatchCancelFlowUrl",
2302
2302
  "output_required": true,
@@ -2306,7 +2306,7 @@
2306
2306
  {
2307
2307
  "disabled": false,
2308
2308
  "document": "签署流程撤回失败信息\n数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错",
2309
- "example": "",
2309
+ "example": "[\"合同已经过期\"]",
2310
2310
  "member": "string",
2311
2311
  "name": "FailMessages",
2312
2312
  "output_required": true,
@@ -2315,8 +2315,8 @@
2315
2315
  },
2316
2316
  {
2317
2317
  "disabled": false,
2318
- "document": "签署连接过期时间字符串:年月日-时分秒\n\n例如:2023-07-28 17:25:59",
2319
- "example": "",
2318
+ "document": "签署连接过期时间字符串:年月日-时分秒\n",
2319
+ "example": "2023-07-28 17:25:59",
2320
2320
  "member": "string",
2321
2321
  "name": "UrlExpireOn",
2322
2322
  "output_required": true,
@@ -2326,7 +2326,7 @@
2326
2326
  {
2327
2327
  "disabled": false,
2328
2328
  "document": "批量撤销任务编号,为32位字符串,可用于[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/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)",
2329
- "example": "",
2329
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
2330
2330
  "member": "string",
2331
2331
  "name": "TaskId",
2332
2332
  "output_required": true,
@@ -2357,7 +2357,7 @@
2357
2357
  {
2358
2358
  "disabled": false,
2359
2359
  "document": "初始化操作类型\n<ul>\n<li>CREATE_SEAL : 创建印章</li>\n<li>AUTH_JOIN_ORGANIZATION_GROUP : 加入集团企业</li>\n<li>OPEN_AUTO_SIGN :开通企业自动签署</li>\n<li>PARTNER_AUTO_SIGN_AUTH :合作方企业授权自动签</li>\n</ul>",
2360
- "example": "",
2360
+ "example": "[\"CREATE_SEAL \"]",
2361
2361
  "member": "string",
2362
2362
  "name": "OperateTypes",
2363
2363
  "required": true,
@@ -2366,7 +2366,7 @@
2366
2366
  {
2367
2367
  "disabled": false,
2368
2368
  "document": "批量操作的企业Id列表,最大支持50个",
2369
- "example": "",
2369
+ "example": "[\"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"]",
2370
2370
  "member": "string",
2371
2371
  "name": "OrganizationIds",
2372
2372
  "required": true,
@@ -2384,7 +2384,7 @@
2384
2384
  {
2385
2385
  "disabled": false,
2386
2386
  "document": "被授权的合作方企业在电子签的企业电子签账号,当操作类型包含 PARTNER_AUTO_SIGN_AUTH (合作方企业授权自动签)时必传。\n\n企业电子签账号可在[电子签的网页端](https://qian.tencent.com/console/company-settings/company-center) ,于企业设置-企业信息菜单栏下复制获取。\n\n![企业电子签账号](https://qcloudimg.tencent-cloud.cn/raw/4e6b30ee92f00671f7f1c5bd127c27db.png)",
2387
- "example": "",
2387
+ "example": "yDt1JUUckp77a2tqUyEmko8RVpCEHoNA",
2388
2388
  "member": "string",
2389
2389
  "name": "AuthorizedOrganizationId",
2390
2390
  "required": false,
@@ -2399,7 +2399,7 @@
2399
2399
  {
2400
2400
  "disabled": false,
2401
2401
  "document": "小程序路径",
2402
- "example": "",
2402
+ "example": "pages/home/index?code=001XzUF",
2403
2403
  "member": "string",
2404
2404
  "name": "MiniAppPath",
2405
2405
  "output_required": true,
@@ -2409,7 +2409,7 @@
2409
2409
  {
2410
2410
  "disabled": false,
2411
2411
  "document": "操作长链",
2412
- "example": "",
2412
+ "example": "https://embed.beta.qian.tencent.cn/code=yDtwRUUckp7fyqz6UuQZAp18BNrB74xu",
2413
2413
  "member": "string",
2414
2414
  "name": "OperateLongUrl",
2415
2415
  "output_required": true,
@@ -2419,7 +2419,7 @@
2419
2419
  {
2420
2420
  "disabled": false,
2421
2421
  "document": "操作短链",
2422
- "example": "",
2422
+ "example": "https://essurl.cn/001XzUF",
2423
2423
  "member": "string",
2424
2424
  "name": "OperateShortUrl",
2425
2425
  "output_required": true,
@@ -2429,7 +2429,7 @@
2429
2429
  {
2430
2430
  "disabled": false,
2431
2431
  "document": "操作二维码",
2432
- "example": "",
2432
+ "example": "https://file.cn/qrcode.jpg",
2433
2433
  "member": "string",
2434
2434
  "name": "QRCodeUrl",
2435
2435
  "output_required": true,
@@ -2514,7 +2514,7 @@
2514
2514
  {
2515
2515
  "disabled": false,
2516
2516
  "document": "要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**QR_CODE**: 跳转电子签小程序的http_url的二维码形式, 可以在页面展示适合此类型</li></ul>",
2517
- "example": "",
2517
+ "example": "HTTP",
2518
2518
  "member": "string",
2519
2519
  "name": "Endpoint",
2520
2520
  "required": false,
@@ -2539,7 +2539,7 @@
2539
2539
  {
2540
2540
  "disabled": false,
2541
2541
  "document": "认证流认证失败信息",
2542
- "example": "",
2542
+ "example": "[\"企业三要素校验失败\"]",
2543
2543
  "member": "string",
2544
2544
  "name": "ErrorMessages",
2545
2545
  "output_required": false,
@@ -2549,7 +2549,7 @@
2549
2549
  {
2550
2550
  "disabled": false,
2551
2551
  "document": "链接过期时间,为 7 天后,创建时间,格式为Unix标准时间戳(秒)。",
2552
- "example": "",
2552
+ "example": "1736751627",
2553
2553
  "member": "uint64",
2554
2554
  "name": "ExpireTime",
2555
2555
  "output_required": false,
@@ -2613,7 +2613,7 @@
2613
2613
  {
2614
2614
  "disabled": false,
2615
2615
  "document": "生成注册链接的任务Id,\n根据这个id, 调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接,进入认证流程",
2616
- "example": "",
2616
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
2617
2617
  "member": "string",
2618
2618
  "name": "TaskId",
2619
2619
  "output_required": false,
@@ -2623,7 +2623,7 @@
2623
2623
  {
2624
2624
  "disabled": false,
2625
2625
  "document": "批量生成企业认证链接的详细错误信息,\n顺序与输入参数保持一致。\n若企业认证均成功生成,则不返回错误信息;\n若存在任何错误,则返回具体的错误描述。",
2626
- "example": "",
2626
+ "example": "[\"企业三要素校验失败\"]",
2627
2627
  "member": "string",
2628
2628
  "name": "ErrorMessages",
2629
2629
  "output_required": false,
@@ -2672,7 +2672,7 @@
2672
2672
  {
2673
2673
  "disabled": false,
2674
2674
  "document": "批量签署的合同流程ID数组。\n注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`",
2675
- "example": "",
2675
+ "example": "[\"yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH\"]",
2676
2676
  "member": "string",
2677
2677
  "name": "FlowIds",
2678
2678
  "required": false,
@@ -2690,7 +2690,7 @@
2690
2690
  {
2691
2691
  "disabled": false,
2692
2692
  "document": "签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)",
2693
- "example": "",
2693
+ "example": "https://jump.cn/jump",
2694
2694
  "member": "string",
2695
2695
  "name": "JumpUrl",
2696
2696
  "required": false,
@@ -2717,7 +2717,7 @@
2717
2717
  {
2718
2718
  "disabled": false,
2719
2719
  "document": "生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:\n<ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>\n<li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>\n注:\n`不指定该值时,默认为签署方自行选择。`",
2720
- "example": "0",
2720
+ "example": "LoginWithoutMobile ",
2721
2721
  "member": "uint64",
2722
2722
  "name": "SignTypeSelector",
2723
2723
  "required": false,
@@ -2744,7 +2744,7 @@
2744
2744
  {
2745
2745
  "disabled": false,
2746
2746
  "document": "缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。\n\n注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`",
2747
- "example": "",
2747
+ "example": "false",
2748
2748
  "member": "bool",
2749
2749
  "name": "CacheApproverInfo",
2750
2750
  "required": false,
@@ -2790,7 +2790,7 @@
2790
2790
  {
2791
2791
  "disabled": false,
2792
2792
  "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n注:`请确保和合同中填入的一致`, `除动态签署人场景外,此参数必填`",
2793
- "example": "",
2793
+ "example": "张三",
2794
2794
  "member": "string",
2795
2795
  "name": "Name",
2796
2796
  "required": false,
@@ -2799,7 +2799,7 @@
2799
2799
  {
2800
2800
  "disabled": false,
2801
2801
  "document": "手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`,`除动态签署人场景外,此参数必填`",
2802
- "example": "",
2802
+ "example": "18888888888",
2803
2803
  "member": "string",
2804
2804
  "name": "Mobile",
2805
2805
  "required": false,
@@ -2817,7 +2817,7 @@
2817
2817
  {
2818
2818
  "disabled": false,
2819
2819
  "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
2820
- "example": "",
2820
+ "example": "ID_CARD",
2821
2821
  "member": "string",
2822
2822
  "name": "IdCardType",
2823
2823
  "required": false,
@@ -2826,7 +2826,7 @@
2826
2826
  {
2827
2827
  "disabled": false,
2828
2828
  "document": "证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`请确保和合同中填入的一致`",
2829
- "example": "",
2829
+ "example": "37000019890303000X",
2830
2830
  "member": "string",
2831
2831
  "name": "IdCardNumber",
2832
2832
  "required": false,
@@ -2835,7 +2835,7 @@
2835
2835
  {
2836
2836
  "disabled": false,
2837
2837
  "document": "通知用户方式:\n<ul>\n<li>**NONE** : 不通知(默认)</li>\n<li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li>\n</ul>",
2838
- "example": "",
2838
+ "example": "SMS",
2839
2839
  "member": "string",
2840
2840
  "name": "NotifyType",
2841
2841
  "required": false,
@@ -2844,7 +2844,7 @@
2844
2844
  {
2845
2845
  "disabled": false,
2846
2846
  "document": "批量签署的合同流程ID数组。\n注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`",
2847
- "example": "",
2847
+ "example": "[\"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"]",
2848
2848
  "member": "string",
2849
2849
  "name": "FlowIds",
2850
2850
  "required": false,
@@ -2853,7 +2853,7 @@
2853
2853
  {
2854
2854
  "disabled": false,
2855
2855
  "document": "目标签署人的企业名称,签署人如果是企业员工身份,需要传此参数。\n\n注:\n<ul>\n<li>请确认该名称与企业营业执照中注册的名称一致。</li>\n<li>如果名称中包含英文括号(),请使用中文括号()代替。</li>\n<li>请确保此企业已完成腾讯电子签企业认证。</li>\n</ul>",
2856
- "example": "",
2856
+ "example": "张三示例企业",
2857
2857
  "member": "string",
2858
2858
  "name": "OrganizationName",
2859
2859
  "required": false,
@@ -2862,7 +2862,7 @@
2862
2862
  {
2863
2863
  "disabled": false,
2864
2864
  "document": "是否直接跳转至合同内容页面进行签署\n<ul>\n<li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>\n<li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>\n</ul>",
2865
- "example": "",
2865
+ "example": "true",
2866
2866
  "member": "bool",
2867
2867
  "name": "JumpToDetail",
2868
2868
  "required": false,
@@ -2880,7 +2880,7 @@
2880
2880
  {
2881
2881
  "disabled": false,
2882
2882
  "document": "签署完成后是否自动回跳\n<ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>\n\n注: \n1. 该参数<font color=\"red\">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效\n2. <font color=\"red\">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)\n3. <font color=\"red\">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font> ",
2883
- "example": "false",
2883
+ "example": "true",
2884
2884
  "member": "bool",
2885
2885
  "name": "AutoJumpBack",
2886
2886
  "required": false,
@@ -2889,7 +2889,7 @@
2889
2889
  {
2890
2890
  "disabled": false,
2891
2891
  "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)。",
2892
- "example": "",
2892
+ "example": "WeChatOfficialAccounts",
2893
2893
  "member": "string",
2894
2894
  "name": "UrlUseEnv",
2895
2895
  "required": false,
@@ -2904,7 +2904,7 @@
2904
2904
  {
2905
2905
  "disabled": false,
2906
2906
  "document": "批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。\n\n注: \n1. 非小程序和APP集成使用\n2. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
2907
- "example": "",
2907
+ "example": "https://essurl.cn/zUFEye ",
2908
2908
  "member": "string",
2909
2909
  "name": "SignUrl",
2910
2910
  "output_required": true,
@@ -2914,7 +2914,7 @@
2914
2914
  {
2915
2915
  "disabled": false,
2916
2916
  "document": "链接过期时间以 Unix 时间戳格式表示,默认生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。",
2917
- "example": "",
2917
+ "example": "1736751627",
2918
2918
  "member": "int64",
2919
2919
  "name": "ExpiredTime",
2920
2920
  "output_required": true,
@@ -2924,7 +2924,7 @@
2924
2924
  {
2925
2925
  "disabled": false,
2926
2926
  "document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径\n\n注: \n1. 小程序和APP集成使用\n2. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
2927
- "example": "",
2927
+ "example": "pages/home/index?resourceId=xxx",
2928
2928
  "member": "string",
2929
2929
  "name": "MiniAppPath",
2930
2930
  "output_required": true,
@@ -3006,7 +3006,7 @@
3006
3006
  {
3007
3007
  "disabled": false,
3008
3008
  "document": "接口返回的文件转换任务Id,可以调用接口<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi\" target=\"_blank\">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。",
3009
- "example": "",
3009
+ "example": "20250113111955261408",
3010
3010
  "member": "string",
3011
3011
  "name": "TaskId",
3012
3012
  "output_required": true,
@@ -3115,7 +3115,7 @@
3115
3115
  {
3116
3116
  "disabled": false,
3117
3117
  "document": "合同流程的底层电子文档ID,为32位字符串。\n\n注:\n后续需用同样的FlowId再次调用[发起签署流程](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow),合同才能进入签署环节",
3118
- "example": "",
3118
+ "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
3119
3119
  "member": "string",
3120
3120
  "name": "DocumentId",
3121
3121
  "output_required": true,
@@ -3166,7 +3166,7 @@
3166
3166
  {
3167
3167
  "disabled": false,
3168
3168
  "document": "合同流程ID,为32位字符串",
3169
- "example": "",
3169
+ "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
3170
3170
  "member": "string",
3171
3171
  "name": "FlowId",
3172
3172
  "required": true,
@@ -3208,7 +3208,7 @@
3208
3208
  {
3209
3209
  "disabled": false,
3210
3210
  "document": "合同流程ID,为32位字符串",
3211
- "example": "",
3211
+ "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
3212
3212
  "member": "string",
3213
3213
  "name": "FlowId",
3214
3214
  "output_required": false,
@@ -3249,7 +3249,7 @@
3249
3249
  {
3250
3250
  "disabled": false,
3251
3251
  "document": "WEB嵌入资源类型,支持以下类型\n<ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>\n<li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>\n<li>MODIFY_TEMPLATE:生成编辑模板的嵌入页面</li>\n<li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>\n<li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>\n<li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>\n<li>EXTEND_SERVICE:生成拓展服务的嵌入页面</li>\n<li>PREVIEW_FLOW:生成预览合同的嵌入页面(支持移动端)</li>\n<li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面(仅支持PC端)</li></ul>",
3252
- "example": "",
3252
+ "example": "PREVIEW_FLOW",
3253
3253
  "member": "string",
3254
3254
  "name": "EmbedType",
3255
3255
  "required": true,
@@ -3258,7 +3258,7 @@
3258
3258
  {
3259
3259
  "disabled": false,
3260
3260
  "document": "WEB嵌入的业务资源ID\n\n当EmbedType取值\n<ul>\n<li>为PREVIEW_SEAL_DETAIL,必填,取值为印章id。</li>\n<li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li>\n<li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id。</li>\n<li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id。</li>\n</ul>\n\n注意:\n 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口[创建文件转换任务\n](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。",
3261
- "example": "",
3261
+ "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
3262
3262
  "member": "string",
3263
3263
  "name": "BusinessId",
3264
3264
  "required": false,
@@ -3309,7 +3309,7 @@
3309
3309
  {
3310
3310
  "disabled": false,
3311
3311
  "document": "嵌入的web链接,有效期:5分钟\n<br/>EmbedType=PREVIEW_CC_FLOW,该url为h5链接",
3312
- "example": "",
3312
+ "example": "https://embed.beta.qian.tencent.cn/code=yDtwRUUckp7fyqz6UuQZAp18BNrB74xu",
3313
3313
  "member": "string",
3314
3314
  "name": "WebUrl",
3315
3315
  "output_required": true,
@@ -3364,7 +3364,7 @@
3364
3364
  {
3365
3365
  "disabled": false,
3366
3366
  "document": "二维码图片的Base64 注: `此二维码的有效时间为7天,过期后需要重新生成新的二维码图片`",
3367
- "example": "",
3367
+ "example": "5LqM57u056CB5Zu+54mH55qEQmFzZTY0",
3368
3368
  "member": "string",
3369
3369
  "name": "QrcodeBase64",
3370
3370
  "output_required": false,
@@ -3395,7 +3395,7 @@
3395
3395
  {
3396
3396
  "disabled": false,
3397
3397
  "document": "本企业员工的id,需要已实名,正常在职员工",
3398
- "example": "",
3398
+ "example": "[\"yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH\"]",
3399
3399
  "member": "string",
3400
3400
  "name": "UserIds",
3401
3401
  "required": true,
@@ -3540,7 +3540,7 @@
3540
3540
  {
3541
3541
  "disabled": false,
3542
3542
  "document": "合同流程ID,为32位字符串。\n建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。",
3543
- "example": "",
3543
+ "example": "yDt1JUUckp77a2tqUyEmko8RVpCEHoNA",
3544
3544
  "member": "string",
3545
3545
  "name": "FlowId",
3546
3546
  "required": true,
@@ -3558,7 +3558,7 @@
3558
3558
  {
3559
3559
  "disabled": false,
3560
3560
  "document": "链接/二维码的有效截止时间,格式为unix时间戳。最长不超过 2099年12月31日(4102415999)。\n默认值为有效期为当前时间后7天。",
3561
- "example": "",
3561
+ "example": "1736751627",
3562
3562
  "member": "uint64",
3563
3563
  "name": "ExpiredOn",
3564
3564
  "required": false,
@@ -3593,7 +3593,7 @@
3593
3593
  {
3594
3594
  "disabled": false,
3595
3595
  "document": "二维码和短链的过期时间戳,过期时间默认为生成链接后7天。",
3596
- "example": "",
3596
+ "example": "1736751627",
3597
3597
  "member": "uint64",
3598
3598
  "name": "ExpiredOn",
3599
3599
  "output_required": false,
@@ -3921,7 +3921,7 @@
3921
3921
  },
3922
3922
  {
3923
3923
  "disabled": false,
3924
- "document": "出证任务执行的状态, 状态含义如下:\n\n<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>\n<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>\n<li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>",
3924
+ "document": "出证任务执行的状态, 状态含义如下:\n\n<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>\n<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>\n<li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>",
3925
3925
  "example": "EvidenceStatusExecuting",
3926
3926
  "member": "string",
3927
3927
  "name": "Status",
@@ -3931,13 +3931,13 @@
3931
3931
  },
3932
3932
  {
3933
3933
  "disabled": true,
3934
- "document": "此字段已经废除,不再使用.\n出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取\n注意:此字段可能返回 null,表示取不到有效值。",
3934
+ "document": "此字段已经废除,不再使用.\n出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取",
3935
3935
  "example": "https://file.cn/1.pdf",
3936
3936
  "member": "string",
3937
3937
  "name": "ReportUrl",
3938
3938
  "output_required": true,
3939
3939
  "type": "string",
3940
- "value_allowed_null": true
3940
+ "value_allowed_null": false
3941
3941
  },
3942
3942
  {
3943
3943
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -3963,7 +3963,7 @@
3963
3963
  {
3964
3964
  "disabled": false,
3965
3965
  "document": "合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。",
3966
- "example": "",
3966
+ "example": "入职合同集",
3967
3967
  "member": "string",
3968
3968
  "name": "FlowGroupName",
3969
3969
  "required": true,
@@ -4005,7 +4005,7 @@
4005
4005
  {
4006
4006
  "disabled": false,
4007
4007
  "document": "合同(流程)组的合同组Id",
4008
- "example": "",
4008
+ "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
4009
4009
  "member": "string",
4010
4010
  "name": "FlowGroupId",
4011
4011
  "output_required": true,
@@ -4015,7 +4015,7 @@
4015
4015
  {
4016
4016
  "disabled": false,
4017
4017
  "document": "合同(流程)组中子合同列表.",
4018
- "example": "",
4018
+ "example": "[\"yDt1JUUckp77a2tqUyEmko8RVpCEHoNA\"]",
4019
4019
  "member": "string",
4020
4020
  "name": "FlowIds",
4021
4021
  "output_required": true,
@@ -4284,7 +4284,7 @@
4284
4284
  {
4285
4285
  "disabled": false,
4286
4286
  "document": "定制化发起合同弹窗的描述信息,描述信息最长500字符\n",
4287
- "example": "\"\"",
4287
+ "example": "\"合同不能转发和截图\"",
4288
4288
  "member": "string",
4289
4289
  "name": "CustomCreateFlowDescription",
4290
4290
  "required": false,
@@ -4293,7 +4293,7 @@
4293
4293
  {
4294
4294
  "disabled": false,
4295
4295
  "document": " 禁止添加签署方,若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”\n",
4296
- "example": "",
4296
+ "example": "true",
4297
4297
  "member": "bool",
4298
4298
  "name": "ForbidAddApprover",
4299
4299
  "required": false,
@@ -4302,7 +4302,7 @@
4302
4302
  {
4303
4303
  "disabled": false,
4304
4304
  "document": " 禁止设置设置签署流程属性 (顺序、合同签署认证方式等),若为true则在发起流程的可嵌入页面隐藏签署流程设置面板\n",
4305
- "example": "",
4305
+ "example": "true",
4306
4306
  "member": "bool",
4307
4307
  "name": "ForbidEditFlowProperties",
4308
4308
  "required": false,
@@ -4311,7 +4311,7 @@
4311
4311
  {
4312
4312
  "disabled": false,
4313
4313
  "document": "在发起流程的可嵌入页面要隐藏的控件列表,和 ShowComponentTypes 参数 只能二选一使用,具体的控件类型如下\n<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>\n<li>SIGN_SEAL : 企业印章</li>\n<li>SIGN_PAGING_SEAL : 骑缝章</li>\n<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>\n<li>SIGN_APPROVE : 签批</li>\n<li>SIGN_OPINION : 签署意见</li>\n<li>BUSI-FULL-NAME : 企业全称</li>\n<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>\n<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>\n<li>PERSONAL-NAME : 签署人姓名</li>\n<li>PERSONAL-MOBILE : 签署人手机号</li>\n<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>\n<li>PERSONAL-IDCARD : 签署人证件号</li>\n<li>TEXT : 单行文本</li>\n<li>MULTI_LINE_TEXT : 多行文本</li>\n<li>CHECK_BOX : 勾选框</li>\n<li>SELECTOR : 选择器</li>\n<li>DIGIT : 数字</li>\n<li>DATE : 日期</li>\n<li>FILL_IMAGE : 图片</li>\n<li>ATTACHMENT : 附件</li>\n<li>EMAIL : 邮箱</li>\n<li>LOCATION : 地址</li>\n<li>EDUCATION : 学历</li>\n<li>GENDER : 性别</li>\n<li>DISTRICT : 省市区</li></ul>",
4314
- "example": "",
4314
+ "example": "[\"MULTI_LINE_TEXT\"]",
4315
4315
  "member": "string",
4316
4316
  "name": "HideComponentTypes",
4317
4317
  "required": false,
@@ -4320,7 +4320,7 @@
4320
4320
  {
4321
4321
  "disabled": false,
4322
4322
  "document": "在发起流程的可嵌入页面要显示的控件列表,和 HideComponentTypes 参数 只能二选一使用,具体的控件类型如下\n<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>\n<li>SIGN_SEAL : 企业印章</li>\n<li>SIGN_PAGING_SEAL : 骑缝章</li>\n<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>\n<li>SIGN_APPROVE : 签批</li>\n<li>SIGN_OPINION : 签署意见</li>\n<li>BUSI-FULL-NAME : 企业全称</li>\n<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>\n<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>\n<li>PERSONAL-NAME : 签署人姓名</li>\n<li>PERSONAL-MOBILE : 签署人手机号</li>\n<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>\n<li>PERSONAL-IDCARD : 签署人证件号</li>\n<li>TEXT : 单行文本</li>\n<li>MULTI_LINE_TEXT : 多行文本</li>\n<li>CHECK_BOX : 勾选框</li>\n<li>SELECTOR : 选择器</li>\n<li>DIGIT : 数字</li>\n<li>DATE : 日期</li>\n<li>FILL_IMAGE : 图片</li>\n<li>ATTACHMENT : 附件</li>\n<li>EMAIL : 邮箱</li>\n<li>LOCATION : 地址</li>\n<li>EDUCATION : 学历</li>\n<li>GENDER : 性别</li>\n<li>DISTRICT : 省市区</li></ul>",
4323
- "example": "",
4323
+ "example": "[\"MULTI_LINE_TEXT\"]",
4324
4324
  "member": "string",
4325
4325
  "name": "ShowComponentTypes",
4326
4326
  "required": false,
@@ -4598,7 +4598,7 @@
4598
4598
  {
4599
4599
  "disabled": false,
4600
4600
  "document": "合同流程ID,为32位字符串。\n<ul><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</li>\n<li>可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>",
4601
- "example": "",
4601
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
4602
4602
  "member": "string",
4603
4603
  "name": "FlowId",
4604
4604
  "required": true,
@@ -4607,7 +4607,7 @@
4607
4607
  {
4608
4608
  "disabled": false,
4609
4609
  "document": "企业内部审核结果\n<ul><li>PASS: 审核通过</li>\n<li>REJECT: 审核拒绝</li>\n<li>SIGN_REJECT:拒签(流程结束)</li></ul>",
4610
- "example": "",
4610
+ "example": "PASS",
4611
4611
  "member": "string",
4612
4612
  "name": "ReviewType",
4613
4613
  "required": true,
@@ -4625,7 +4625,7 @@
4625
4625
  {
4626
4626
  "disabled": false,
4627
4627
  "document": "审核节点的签署人标志,用于指定当前审核的签署方\n<ul><li>**如果签署审核节点是个人, 此参数必填**。</li></ul>",
4628
- "example": "",
4628
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
4629
4629
  "member": "string",
4630
4630
  "name": "RecipientId",
4631
4631
  "required": false,
@@ -4634,7 +4634,7 @@
4634
4634
  {
4635
4635
  "disabled": false,
4636
4636
  "document": "操作类型:(接口通过该字段区分不同的操作类型)\n\n<ul><li>SignReview: 签署审核(默认)</li>\n<li>CreateReview: 创建审核</li></ul>\n\n如果审核节点是个人,则操作类型只能为SignReview。",
4637
- "example": "",
4637
+ "example": "SignReview",
4638
4638
  "member": "string",
4639
4639
  "name": "OperateType",
4640
4640
  "required": false,
@@ -4643,7 +4643,7 @@
4643
4643
  {
4644
4644
  "disabled": false,
4645
4645
  "document": "审核结果原因\n<ul><li>字符串长度不超过200</li>\n<li>当ReviewType 是拒绝(REJECT) 时此字段必填。</li>\n<li>当ReviewType 是拒绝(SIGN_REJECT) 时此字段必填。</li></ul>\n\n",
4646
- "example": "",
4646
+ "example": "合同内容错误",
4647
4647
  "member": "string",
4648
4648
  "name": "ReviewMessage",
4649
4649
  "required": false,
@@ -4696,7 +4696,7 @@
4696
4696
  },
4697
4697
  {
4698
4698
  "disabled": false,
4699
- "document": "流程签署人列表中,结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人,还需传递OrganizationName。\n\n注:\n1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。\n2. 生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。\n\n",
4699
+ "document": "流程签署人列表中,结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人,还需传递OrganizationName。\n\n此结构体和CreateFlow发起接口参与方结构体复用,除了上述参数外,可传递的参数有:\n1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。\n2. ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。\n3. SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。\n4. Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。\n\n注:\n1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。\n2. 生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。\n\n",
4700
4700
  "example": "无",
4701
4701
  "member": "FlowCreateApprover",
4702
4702
  "name": "FlowApproverInfos",
@@ -4715,7 +4715,7 @@
4715
4715
  {
4716
4716
  "disabled": false,
4717
4717
  "document": "签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href=\"https://qian.tencent.com/developers/company/openqianh5\" target=\"_blank\">跳转电子签H5</a>\n",
4718
- "example": "",
4718
+ "example": "https://jump.cn/jump",
4719
4719
  "member": "string",
4720
4720
  "name": "JumpUrl",
4721
4721
  "required": false,
@@ -4770,7 +4770,7 @@
4770
4770
  {
4771
4771
  "disabled": false,
4772
4772
  "document": "部门名称,最大长度为50个字符。",
4773
- "example": "",
4773
+ "example": "销售部门",
4774
4774
  "member": "string",
4775
4775
  "name": "DeptName",
4776
4776
  "required": true,
@@ -4788,7 +4788,7 @@
4788
4788
  {
4789
4789
  "disabled": false,
4790
4790
  "document": "电子签父部门ID。\n注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`",
4791
- "example": "",
4791
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
4792
4792
  "member": "string",
4793
4793
  "name": "ParentDeptId",
4794
4794
  "required": false,
@@ -4797,7 +4797,7 @@
4797
4797
  {
4798
4798
  "disabled": false,
4799
4799
  "document": "第三方平台中父部门ID。\n注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`",
4800
- "example": "",
4800
+ "example": "456",
4801
4801
  "member": "string",
4802
4802
  "name": "ParentDeptOpenId",
4803
4803
  "required": false,
@@ -4806,7 +4806,7 @@
4806
4806
  {
4807
4807
  "disabled": false,
4808
4808
  "document": "客户系统部门ID,最大长度为64个字符。",
4809
- "example": "",
4809
+ "example": "789",
4810
4810
  "member": "string",
4811
4811
  "name": "DeptOpenId",
4812
4812
  "required": false,
@@ -4815,7 +4815,7 @@
4815
4815
  {
4816
4816
  "disabled": false,
4817
4817
  "document": "排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。",
4818
- "example": "",
4818
+ "example": "1",
4819
4819
  "member": "uint64",
4820
4820
  "name": "OrderNo",
4821
4821
  "required": false,
@@ -4830,7 +4830,7 @@
4830
4830
  {
4831
4831
  "disabled": false,
4832
4832
  "document": "电子签部门ID。建议开发者保存此部门ID,方便后续查询或修改部门信息。",
4833
- "example": "",
4833
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
4834
4834
  "member": "string",
4835
4835
  "name": "DeptId",
4836
4836
  "output_required": true,
@@ -4934,7 +4934,7 @@
4934
4934
  {
4935
4935
  "disabled": false,
4936
4936
  "document": "角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。",
4937
- "example": "",
4937
+ "example": "销售分部角色",
4938
4938
  "member": "string",
4939
4939
  "name": "Name",
4940
4940
  "required": true,
@@ -4952,7 +4952,7 @@
4952
4952
  {
4953
4953
  "disabled": false,
4954
4954
  "document": "角色描述,最大长度为50个字符",
4955
- "example": "",
4955
+ "example": "销售分部角色",
4956
4956
  "member": "string",
4957
4957
  "name": "Description",
4958
4958
  "required": false,
@@ -4961,7 +4961,7 @@
4961
4961
  {
4962
4962
  "disabled": false,
4963
4963
  "document": "角色类型,0:saas角色,1:集团角色\n默认0,saas角色",
4964
- "example": "",
4964
+ "example": "0",
4965
4965
  "member": "int64",
4966
4966
  "name": "IsGroupRole",
4967
4967
  "required": false,
@@ -4979,7 +4979,7 @@
4979
4979
  {
4980
4980
  "disabled": false,
4981
4981
  "document": "集团角色的话,需要传递集团子企业列表,如果是全选,则传1",
4982
- "example": "",
4982
+ "example": "1",
4983
4983
  "member": "string",
4984
4984
  "name": "SubOrganizationIds",
4985
4985
  "required": false,
@@ -5003,7 +5003,7 @@
5003
5003
  {
5004
5004
  "disabled": false,
5005
5005
  "document": "角色id",
5006
- "example": "",
5006
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
5007
5007
  "member": "string",
5008
5008
  "name": "RoleId",
5009
5009
  "output_required": false,
@@ -5034,7 +5034,7 @@
5034
5034
  {
5035
5035
  "disabled": false,
5036
5036
  "document": "待激活成员企业ID集合",
5037
- "example": "",
5037
+ "example": "[\"yDt1JUUckp77a2tqUyEmko8RVpCEHoNA\"]",
5038
5038
  "member": "string",
5039
5039
  "name": "SubOrganizationIds",
5040
5040
  "required": true,
@@ -5049,7 +5049,7 @@
5049
5049
  {
5050
5050
  "disabled": false,
5051
5051
  "document": "激活失败的成员企业ID集合",
5052
- "example": "",
5052
+ "example": "[\"yDt1JUUckp77a2tqUyEmko8RVpCEHoNA\"]",
5053
5053
  "member": "string",
5054
5054
  "name": "FailedSubOrganizationIds",
5055
5055
  "output_required": true,
@@ -5080,7 +5080,7 @@
5080
5080
  {
5081
5081
  "disabled": false,
5082
5082
  "document": "绑定角色的用户id列表,不能重复,不能大于 100 个",
5083
- "example": "",
5083
+ "example": "[\"yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH\"]",
5084
5084
  "member": "string",
5085
5085
  "name": "UserIds",
5086
5086
  "required": true,
@@ -5089,7 +5089,7 @@
5089
5089
  {
5090
5090
  "disabled": false,
5091
5091
  "document": "绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取角色信息",
5092
- "example": "",
5092
+ "example": "[\"yDt1JUUckp77a2tqUyEmko8RVpCEHoNA\"]",
5093
5093
  "member": "string",
5094
5094
  "name": "RoleIds",
5095
5095
  "required": true,
@@ -5253,7 +5253,7 @@
5253
5253
  {
5254
5254
  "disabled": false,
5255
5255
  "document": "调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。\n回调的相关说明可参考开发者中心的<a href=\"https://qian.tencent.com/developers/company/callback_types_v2\" target=\"_blank\">回调通知</a>模块。",
5256
- "example": "",
5256
+ "example": "VXNlckRhdGE=",
5257
5257
  "member": "string",
5258
5258
  "name": "UserData",
5259
5259
  "required": false,
@@ -5262,7 +5262,7 @@
5262
5262
  {
5263
5263
  "disabled": true,
5264
5264
  "document": "已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置 \n<br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign\n<br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83\n",
5265
- "example": "",
5265
+ "example": "https://callback.cn/callback",
5266
5266
  "member": "string",
5267
5267
  "name": "CallbackUrl",
5268
5268
  "required": false,
@@ -5289,7 +5289,7 @@
5289
5289
  {
5290
5290
  "disabled": false,
5291
5291
  "document": "指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。",
5292
- "example": "[ { \"RecipientId\": \"yDwJNUUckpkojrssUxTFHk6xvcX2xigb\", \"Values\": [ \"HANDWRITE\", \"SYSTEM_ESIGN\" ] }, { \"RecipientId\": \"yDwJNUUckpkojrsqUxTFHk6yndh20CpW\", \"Values\": [ \"OCR_ESIGN\" ] } ]",
5292
+ "example": "",
5293
5293
  "member": "ApproverComponentLimitType",
5294
5294
  "name": "ApproverComponentLimitTypes",
5295
5295
  "required": false,
@@ -5396,7 +5396,7 @@
5396
5396
  {
5397
5397
  "disabled": false,
5398
5398
  "document": "授权书链接,有效期5分钟。",
5399
- "example": "",
5399
+ "example": "https://qian.tencent.cn/code=yDtwRUUckp7fyqz6UuQZAp18BNrB74xu",
5400
5400
  "member": "string",
5401
5401
  "name": "FileUrl",
5402
5402
  "output_required": false,
@@ -5517,7 +5517,7 @@
5517
5517
  {
5518
5518
  "disabled": false,
5519
5519
  "document": "对方打开链接认证时,对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>",
5520
- "example": "",
5520
+ "example": "false",
5521
5521
  "member": "bool",
5522
5522
  "name": "UniformSocialCreditCodeSame",
5523
5523
  "required": false,
@@ -5526,7 +5526,7 @@
5526
5526
  {
5527
5527
  "disabled": false,
5528
5528
  "document": "对方打开链接认证时,法人姓名是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>\n\np.s. 仅在法人姓名不为空时有效",
5529
- "example": "",
5529
+ "example": "false",
5530
5530
  "member": "bool",
5531
5531
  "name": "LegalNameSame",
5532
5532
  "required": false,
@@ -5535,7 +5535,7 @@
5535
5535
  {
5536
5536
  "disabled": false,
5537
5537
  "document": "对方打开链接认证时,认证人姓名是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>\n\np.s. 仅在认证人姓名不为空时有效",
5538
- "example": "",
5538
+ "example": "false",
5539
5539
  "member": "bool",
5540
5540
  "name": "AdminNameSame",
5541
5541
  "required": false,
@@ -5544,7 +5544,7 @@
5544
5544
  {
5545
5545
  "disabled": false,
5546
5546
  "document": "对方打开链接认证时,认证人居民身份证件号是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>\n\np.s. 仅在认证人身份证号不为空时有效\n",
5547
- "example": "",
5547
+ "example": "false",
5548
5548
  "member": "bool",
5549
5549
  "name": "AdminIdCardNumberSame",
5550
5550
  "required": false,
@@ -5553,7 +5553,7 @@
5553
5553
  {
5554
5554
  "disabled": false,
5555
5555
  "document": "对方打开链接认证时,认证人手机号是否要与接口传递上来的保持一致。<ul>\n<li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li>\n<li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li>\n</ul>\n\np.s. 仅在认证人手机号不为空时有效",
5556
- "example": "",
5556
+ "example": "false",
5557
5557
  "member": "bool",
5558
5558
  "name": "AdminMobileSame",
5559
5559
  "required": false,
@@ -5562,7 +5562,7 @@
5562
5562
  {
5563
5563
  "disabled": false,
5564
5564
  "document": "对方打开链接认证时,企业名称是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>\n\n\np.s. 仅在企业名称不为空时有效",
5565
- "example": "",
5565
+ "example": "false",
5566
5566
  "member": "bool",
5567
5567
  "name": "OrganizationNameSame",
5568
5568
  "required": false,
@@ -5571,7 +5571,7 @@
5571
5571
  {
5572
5572
  "disabled": false,
5573
5573
  "document": "营业执照正面照(支持PNG或JPG格式)需以base64格式提供,且文件大小不得超过5MB。",
5574
- "example": "",
5574
+ "example": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW==",
5575
5575
  "member": "string",
5576
5576
  "name": "BusinessLicense",
5577
5577
  "required": false,
@@ -5580,7 +5580,7 @@
5580
5580
  {
5581
5581
  "disabled": false,
5582
5582
  "document": "跳转链接类型:\n\n<ul>\n<li><b>PC</b>:适用于PC端的认证链接</li>\n<li><b>APP</b>:用于全屏或半屏跳转的小程序链接</li>\n<li><b>SHORT_URL</b>:跳转小程序的链接的短链形式</li>\n<li><b>H5</b>:适用于H5页面的认证链接</li>\n<li><b>SHORT_H5</b>:H5认证链接的短链形式</li>\n</ul>\n",
5583
- "example": "",
5583
+ "example": "PC",
5584
5584
  "member": "string",
5585
5585
  "name": "Endpoint",
5586
5586
  "required": false,
@@ -5598,7 +5598,7 @@
5598
5598
  {
5599
5599
  "disabled": false,
5600
5600
  "document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。 \n授权书可以通过接口[生成企业授权书](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthFile) 来获得。\np.s. 如果上传授权书 ,需遵循以下条件 \n1. 超管的信息(超管姓名,超管手机号)必须为必填参数。\n2. 认证方式AuthorizationTypes必须只能是上传授权书方式 ",
5601
- "example": "",
5601
+ "example": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW",
5602
5602
  "member": "string",
5603
5603
  "name": "PowerOfAttorneys",
5604
5604
  "required": false,
@@ -5654,7 +5654,7 @@
5654
5654
  {
5655
5655
  "disabled": false,
5656
5656
  "document": "请指定需执行批量签署的流程ID,数量范围为1-100。\n您可登录腾讯电子签控制台,浏览 \"合同\"->\"合同中心\" 以查阅某一合同的FlowId(在页面中显示为合同ID)。\n用户将利用链接对这些合同实施批量操作。",
5657
- "example": "",
5657
+ "example": "[\"yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw\"]",
5658
5658
  "member": "string",
5659
5659
  "name": "FlowIds",
5660
5660
  "required": true,
@@ -5672,7 +5672,7 @@
5672
5672
  {
5673
5673
  "disabled": false,
5674
5674
  "document": "员工在腾讯电子签平台的独特身份标识,为32位字符串。\n您可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查阅某位员工的UserId(在页面中显示为用户ID)。\nUserId必须是传入合同(FlowId)中的签署人。\n\n<ul>\n<li>1. 若UserId为空,Name和Mobile 必须提供。</li>\n<li>2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。</li>\n</ul>",
5675
- "example": "",
5675
+ "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84",
5676
5676
  "member": "string",
5677
5677
  "name": "UserId",
5678
5678
  "required": false,
@@ -5681,7 +5681,7 @@
5681
5681
  {
5682
5682
  "disabled": false,
5683
5683
  "document": "员工姓名,必须与手机号码一起使用。\n如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。",
5684
- "example": "",
5684
+ "example": "张三",
5685
5685
  "member": "string",
5686
5686
  "name": "Name",
5687
5687
  "required": false,
@@ -5690,7 +5690,7 @@
5690
5690
  {
5691
5691
  "disabled": false,
5692
5692
  "document": "员工手机号,必须与姓名一起使用。\n 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。",
5693
- "example": "",
5693
+ "example": "187****7192",
5694
5694
  "member": "string",
5695
5695
  "name": "Mobile",
5696
5696
  "required": false,
@@ -5699,7 +5699,7 @@
5699
5699
  {
5700
5700
  "disabled": false,
5701
5701
  "document": "为签署方经办人在签署合同中的参与方ID,必须与参数FlowIds数组一一对应。\n您可以通过查询合同接口(DescribeFlowInfo)查询此参数。\n若传了此参数,则可以不传 UserId, Name, Mobile等参数",
5702
- "example": "",
5702
+ "example": "yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E",
5703
5703
  "member": "string",
5704
5704
  "name": "RecipientIds",
5705
5705
  "required": false,
@@ -5714,7 +5714,7 @@
5714
5714
  {
5715
5715
  "disabled": false,
5716
5716
  "document": "批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。",
5717
- "example": "",
5717
+ "example": "https://essurl.cn/bR8**HA",
5718
5718
  "member": "string",
5719
5719
  "name": "SignUrl",
5720
5720
  "output_required": true,
@@ -5724,7 +5724,7 @@
5724
5724
  {
5725
5725
  "disabled": false,
5726
5726
  "document": "链接过期截止时间,格式为Unix标准时间戳(秒),默认为7天后截止。",
5727
- "example": "",
5727
+ "example": "1736478119",
5728
5728
  "member": "int64",
5729
5729
  "name": "ExpiredTime",
5730
5730
  "output_required": true,
@@ -5755,7 +5755,7 @@
5755
5755
  {
5756
5756
  "disabled": false,
5757
5757
  "document": "到期时间(以秒为单位的时间戳),其上限为30天的有效期限。",
5758
- "example": "",
5758
+ "example": "1736494983",
5759
5759
  "member": "int64",
5760
5760
  "name": "ExpireTime",
5761
5761
  "required": true,
@@ -5770,7 +5770,7 @@
5770
5770
  {
5771
5771
  "disabled": false,
5772
5772
  "document": "加入集团二维码链接,子企业的管理员可以直接扫码进入。\n注意:1. 该链接有效期时间为ExpireTime,同时需要注意保密,不要外泄给无关用户。2. 该链接不支持小程序嵌入,仅支持<b>移动端浏览器</b>打开。3. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
5773
- "example": "",
5773
+ "example": "https://essurl.cn/Y9b**O",
5774
5774
  "member": "string",
5775
5775
  "name": "Link",
5776
5776
  "output_required": true,
@@ -5780,7 +5780,7 @@
5780
5780
  {
5781
5781
  "disabled": false,
5782
5782
  "document": "到期时间(以秒为单位的时间戳)",
5783
- "example": "",
5783
+ "example": "1736495023",
5784
5784
  "member": "int64",
5785
5785
  "name": "ExpireTime",
5786
5786
  "output_required": true,
@@ -5790,7 +5790,7 @@
5790
5790
  {
5791
5791
  "disabled": false,
5792
5792
  "document": "加入集团短链接。\n注意:\n1. 该链接有效期时间为ExpireTime,同时需要注意保密,不要外泄给无关用户。\n2. 该链接不支持小程序嵌入,仅支持<b>移动端浏览器</b>打开。\n3. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
5793
- "example": "",
5793
+ "example": "https://essurl.cn/Rg0**Q",
5794
5794
  "member": "string",
5795
5795
  "name": "JumpUrl",
5796
5796
  "output_required": true,
@@ -5800,7 +5800,7 @@
5800
5800
  {
5801
5801
  "disabled": false,
5802
5802
  "document": "腾讯电子签小程序加入集团链接。\n\n<li>小程序和APP集成使用</li>\n<li>得到的链接类似于`pages/guide?shortKey=yDw***k1xFc5`, 用法可以参考:<a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\" target=\"_blank\">跳转电子签小程序</a></li>\n\n\n注: <font color=\"red\">生成的链路后面不能再增加参数</font>",
5803
- "example": "",
5803
+ "example": "gh_da88f6188665",
5804
5804
  "member": "string",
5805
5805
  "name": "MiniAppPath",
5806
5806
  "output_required": false,
@@ -5905,7 +5905,7 @@
5905
5905
  {
5906
5906
  "disabled": false,
5907
5907
  "document": "被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入",
5908
- "example": "",
5908
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
5909
5909
  "member": "string",
5910
5910
  "name": "AuthorizedOrganizationId",
5911
5911
  "required": false,
@@ -5914,7 +5914,7 @@
5914
5914
  {
5915
5915
  "disabled": false,
5916
5916
  "document": "被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。\n注: `如果名称中包含英文括号(),请使用中文括号()代替。`",
5917
- "example": "",
5917
+ "example": "企业名称",
5918
5918
  "member": "string",
5919
5919
  "name": "AuthorizedOrganizationName",
5920
5920
  "required": false,
@@ -5923,7 +5923,7 @@
5923
5923
  {
5924
5924
  "disabled": false,
5925
5925
  "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>",
5926
- "example": "",
5926
+ "example": "OFFICIAL",
5927
5927
  "member": "string",
5928
5928
  "name": "SealTypes",
5929
5929
  "required": false,
@@ -5932,7 +5932,7 @@
5932
5932
  {
5933
5933
  "disabled": false,
5934
5934
  "document": "在处理授权关系时,授权的方向\n<ul>\n<li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>\n<li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>\n</ul>",
5935
- "example": "",
5935
+ "example": "false",
5936
5936
  "member": "bool",
5937
5937
  "name": "AuthToMe",
5938
5938
  "required": false,
@@ -5947,7 +5947,7 @@
5947
5947
  {
5948
5948
  "disabled": false,
5949
5949
  "document": "授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。",
5950
- "example": "",
5950
+ "example": "https://essurl.cn/x9nvWU8fTg",
5951
5951
  "member": "string",
5952
5952
  "name": "Url",
5953
5953
  "output_required": false,
@@ -5957,7 +5957,7 @@
5957
5957
  {
5958
5958
  "disabled": false,
5959
5959
  "document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径",
5960
- "example": "",
5960
+ "example": "pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3",
5961
5961
  "member": "string",
5962
5962
  "name": "MiniAppPath",
5963
5963
  "output_required": false,
@@ -5967,7 +5967,7 @@
5967
5967
  {
5968
5968
  "disabled": false,
5969
5969
  "document": "链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。",
5970
- "example": "",
5970
+ "example": "1736477236",
5971
5971
  "member": "int64",
5972
5972
  "name": "ExpireTime",
5973
5973
  "output_required": false,
@@ -6120,7 +6120,7 @@
6120
6120
  {
6121
6121
  "disabled": false,
6122
6122
  "document": "资源id,与ResourceType相对应,取值范围:\n<ul>\n<li>文件Id(通过UploadFiles获取文件资源Id)</li>\n<li>模板Id(通过控制台创建模板后获取模板Id)</li>\n</ul>\n注意:需要同时设置 ResourceType 参数指定资源类型",
6123
- "example": "",
6123
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
6124
6124
  "member": "string",
6125
6125
  "name": "ResourceId",
6126
6126
  "required": true,
@@ -6129,7 +6129,7 @@
6129
6129
  {
6130
6130
  "disabled": false,
6131
6131
  "document": "自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。\n\n该名称还将用于合同签署完成后文件下载的默认文件名称。",
6132
- "example": "",
6132
+ "example": "合同名称",
6133
6133
  "member": "string",
6134
6134
  "name": "FlowName",
6135
6135
  "required": true,
@@ -6156,7 +6156,7 @@
6156
6156
  {
6157
6157
  "disabled": false,
6158
6158
  "document": "合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。\n",
6159
- "example": "",
6159
+ "example": "1736477282",
6160
6160
  "member": "int64",
6161
6161
  "name": "Deadline",
6162
6162
  "required": false,
@@ -6165,7 +6165,7 @@
6165
6165
  {
6166
6166
  "disabled": false,
6167
6167
  "document": "用户自定义合同类型Id\n\n该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取\n注: `该参数如果和FlowType同时传,以该参数优先生效`",
6168
- "example": "",
6168
+ "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84",
6169
6169
  "member": "string",
6170
6170
  "name": "UserFlowTypeId",
6171
6171
  "required": false,
@@ -6219,7 +6219,7 @@
6219
6219
  {
6220
6220
  "disabled": false,
6221
6221
  "document": "发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:\n<ul><li> **false**:(默认)不需要审批,直接签署。</li>\n<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>\n企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果\n<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>\n<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>\n注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`",
6222
- "example": "",
6222
+ "example": "false",
6223
6223
  "member": "bool",
6224
6224
  "name": "NeedSignReview",
6225
6225
  "required": false,
@@ -6228,7 +6228,7 @@
6228
6228
  {
6229
6229
  "disabled": false,
6230
6230
  "document": "发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。\n\n若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。\n\n",
6231
- "example": "",
6231
+ "example": "false",
6232
6232
  "member": "bool",
6233
6233
  "name": "NeedCreateReview",
6234
6234
  "required": false,
@@ -6237,7 +6237,7 @@
6237
6237
  {
6238
6238
  "disabled": false,
6239
6239
  "document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href=\"https://qian.tencent.com/developers/company/callback_types_v2\" target=\"_blank\">回调通知</a>模块。",
6240
- "example": "",
6240
+ "example": "自定义数据",
6241
6241
  "member": "string",
6242
6242
  "name": "UserData",
6243
6243
  "required": false,
@@ -6255,7 +6255,7 @@
6255
6255
  {
6256
6256
  "disabled": false,
6257
6257
  "document": "合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接\n注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`",
6258
- "example": "",
6258
+ "example": "yDwcCUUgyg3tgmvhUEVzyNa15Zayy6Sf",
6259
6259
  "member": "string",
6260
6260
  "name": "FlowId",
6261
6261
  "required": false,
@@ -6297,7 +6297,7 @@
6297
6297
  {
6298
6298
  "disabled": false,
6299
6299
  "document": "发起流程的web页面链接,有效期5分钟",
6300
- "example": "",
6300
+ "example": "https://embed.test.qian.tencent.cn//contract-details?embed=1&code=yDwFJUUckpsm2e3xU6LVMFEMw1e4YIkb&channel=TENCENTCLOUD&businessId=yDwFFUUckps75s4pUEmvMvC8iyRPYukZ&businessType=DOCUMENT&scene=SINGLEPAGE",
6301
6301
  "member": "string",
6302
6302
  "name": "Url",
6303
6303
  "output_required": true,
@@ -6307,7 +6307,7 @@
6307
6307
  {
6308
6308
  "disabled": false,
6309
6309
  "document": "创建的合同id(还未实际发起),每次调用会生成新的id,用户可以记录此字段对应后续页面发起的合同,若在页面上未成功发起,则此字段无效。",
6310
- "example": "",
6310
+ "example": "yDwcCUUgyg3tgmvhUEVzyNa15Zayy6Sf",
6311
6311
  "member": "string",
6312
6312
  "name": "FlowId",
6313
6313
  "output_required": false,
@@ -6329,7 +6329,7 @@
6329
6329
  {
6330
6330
  "disabled": false,
6331
6331
  "document": "个人用户姓名",
6332
- "example": "",
6332
+ "example": "张三",
6333
6333
  "member": "string",
6334
6334
  "name": "UserName",
6335
6335
  "required": true,
@@ -6338,7 +6338,7 @@
6338
6338
  {
6339
6339
  "disabled": false,
6340
6340
  "document": "证件号码,应符合以下规则\n<ul><li> 中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
6341
- "example": "",
6341
+ "example": "420528****1929",
6342
6342
  "member": "string",
6343
6343
  "name": "IdCardNumber",
6344
6344
  "required": true,
@@ -6347,7 +6347,7 @@
6347
6347
  {
6348
6348
  "disabled": false,
6349
6349
  "document": "印章名称,长度1-50个字。",
6350
- "example": "",
6350
+ "example": "财务章",
6351
6351
  "member": "string",
6352
6352
  "name": "SealName",
6353
6353
  "required": true,
@@ -6365,7 +6365,7 @@
6365
6365
  {
6366
6366
  "disabled": false,
6367
6367
  "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同 中国大陆居民身份证)</li></ul>",
6368
- "example": "",
6368
+ "example": "ID_CARD",
6369
6369
  "member": "string",
6370
6370
  "name": "IdCardType",
6371
6371
  "required": false,
@@ -6374,7 +6374,7 @@
6374
6374
  {
6375
6375
  "disabled": true,
6376
6376
  "document": "印章图片的base64\n注:已废弃\n请先通过UploadFiles接口上传文件,获取 FileId",
6377
- "example": "",
6377
+ "example": "已废弃",
6378
6378
  "member": "string",
6379
6379
  "name": "SealImage",
6380
6380
  "required": false,
@@ -6383,7 +6383,7 @@
6383
6383
  {
6384
6384
  "disabled": false,
6385
6385
  "document": "是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。",
6386
- "example": "",
6386
+ "example": "false",
6387
6387
  "member": "bool",
6388
6388
  "name": "SealImageCompress",
6389
6389
  "required": false,
@@ -6392,7 +6392,7 @@
6392
6392
  {
6393
6393
  "disabled": false,
6394
6394
  "document": "手机号码;当需要开通自动签时,该参数必传",
6395
- "example": "",
6395
+ "example": "187****7831",
6396
6396
  "member": "string",
6397
6397
  "name": "Mobile",
6398
6398
  "required": false,
@@ -6401,7 +6401,7 @@
6401
6401
  {
6402
6402
  "disabled": false,
6403
6403
  "document": "此字段已废弃,请勿继续使用。",
6404
- "example": "",
6404
+ "example": "false",
6405
6405
  "member": "bool",
6406
6406
  "name": "EnableAutoSign",
6407
6407
  "required": false,
@@ -6428,7 +6428,7 @@
6428
6428
  {
6429
6429
  "disabled": false,
6430
6430
  "document": "印章图片文件 id\n取值:\n填写的FileId通过UploadFiles接口上传文件获取。",
6431
- "example": "",
6431
+ "example": "false",
6432
6432
  "member": "string",
6433
6433
  "name": "FileId",
6434
6434
  "required": false,
@@ -6446,7 +6446,7 @@
6446
6446
  {
6447
6447
  "disabled": false,
6448
6448
  "document": "设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减\t",
6449
- "example": "",
6449
+ "example": "0",
6450
6450
  "member": "int64",
6451
6451
  "name": "LicenseType",
6452
6452
  "required": false,
@@ -6470,7 +6470,7 @@
6470
6470
  {
6471
6471
  "disabled": false,
6472
6472
  "document": "导入生成的印章ID,为32位字符串。\n建议开发者保存此印章ID,开头实名认证后,通过此 ID查询导入的印章。",
6473
- "example": "",
6473
+ "example": "yDCZHUUnitvronUuNTdBrElW0gOVqCfy",
6474
6474
  "member": "string",
6475
6475
  "name": "SealId",
6476
6476
  "output_required": true,
@@ -6546,7 +6546,7 @@
6546
6546
  {
6547
6547
  "disabled": false,
6548
6548
  "document": "调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。\n\n回调的相关说明可参考开发者中心的<a href=\"https://qian.tencent.com/developers/company/callback_types_v2\" target=\"_blank\">回调通知</a>模块。",
6549
- "example": "",
6549
+ "example": "VXNlckRhdGE=",
6550
6550
  "member": "string",
6551
6551
  "name": "UserData",
6552
6552
  "required": false,
@@ -6561,7 +6561,7 @@
6561
6561
  {
6562
6562
  "disabled": false,
6563
6563
  "document": "解除协议流程编号\n`注意:这里的流程编号对应的合同是本次发起的解除协议。`\n",
6564
- "example": "",
6564
+ "example": "yDtwEUUckp7f87yrUygaLZxYk2SEodS7",
6565
6565
  "member": "string",
6566
6566
  "name": "FlowId",
6567
6567
  "output_required": true,
@@ -6583,7 +6583,7 @@
6583
6583
  {
6584
6584
  "disabled": false,
6585
6585
  "document": "<ul>\n <li>0 : 发起审批成功页面(通过接口<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/CreatePrepareFlow/\" target=\"_blank\">创建发起流程web页面</a>发起时设置了NeedCreateReview参数为true)</li>\n</ul>",
6586
- "example": "",
6586
+ "example": "0",
6587
6587
  "member": "int64",
6588
6588
  "name": "Type",
6589
6589
  "required": true,
@@ -6592,7 +6592,7 @@
6592
6592
  {
6593
6593
  "disabled": false,
6594
6594
  "document": "结果页标题,不超过50字",
6595
- "example": "",
6595
+ "example": "发起成功",
6596
6596
  "member": "string",
6597
6597
  "name": "Title",
6598
6598
  "required": true,
@@ -6601,7 +6601,7 @@
6601
6601
  {
6602
6602
  "disabled": false,
6603
6603
  "document": "结果页描述,不超过200字",
6604
- "example": "",
6604
+ "example": "发起成功",
6605
6605
  "member": "string",
6606
6606
  "name": "Description",
6607
6607
  "required": false,
@@ -6733,7 +6733,7 @@
6733
6733
  {
6734
6734
  "disabled": false,
6735
6735
  "document": "签署节点ID,用于生成动态签署人链接完成领取。\n\n注:`生成动态签署人补充链接时必传。`",
6736
- "example": "",
6736
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
6737
6737
  "member": "string",
6738
6738
  "name": "RecipientId",
6739
6739
  "required": false,
@@ -6751,7 +6751,7 @@
6751
6751
  {
6752
6752
  "disabled": false,
6753
6753
  "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)。",
6754
- "example": "",
6754
+ "example": "WeChatOfficialAccounts",
6755
6755
  "member": "string",
6756
6756
  "name": "UrlUseEnv",
6757
6757
  "required": false,
@@ -6776,7 +6776,7 @@
6776
6776
  {
6777
6777
  "disabled": false,
6778
6778
  "document": "二维码,在生成动态签署人跳转封面页链接时返回",
6779
- "example": "",
6779
+ "example": "https://essurl.cn/wq**81uj",
6780
6780
  "member": "string",
6781
6781
  "name": "SchemeQrcodeUrl",
6782
6782
  "output_required": false,
@@ -6816,7 +6816,7 @@
6816
6816
  {
6817
6817
  "disabled": false,
6818
6818
  "document": "电子印章ID,为32位字符串。\n建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。\n可登录腾讯电子签控制台,在 \"印章\"->\"印章中心\"选择查看的印章,在\"印章详情\" 中查看某个印章的SealId(在页面中展示为印章ID)。",
6819
- "example": "",
6819
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
6820
6820
  "member": "string",
6821
6821
  "name": "SealId",
6822
6822
  "required": true,
@@ -6825,7 +6825,7 @@
6825
6825
  {
6826
6826
  "disabled": false,
6827
6827
  "document": "授权有效期,时间戳秒级。可以传0,代表有效期到2099年12月12日23点59分59秒。",
6828
- "example": "",
6828
+ "example": "1736478409",
6829
6829
  "member": "int64",
6830
6830
  "name": "Expired",
6831
6831
  "required": true,
@@ -6834,7 +6834,7 @@
6834
6834
  {
6835
6835
  "disabled": false,
6836
6836
  "document": "需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填,跟上面的Users同时起作用",
6837
- "example": "",
6837
+ "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84",
6838
6838
  "member": "string",
6839
6839
  "name": "UserIds",
6840
6840
  "required": false,
@@ -6843,7 +6843,7 @@
6843
6843
  {
6844
6844
  "disabled": false,
6845
6845
  "document": "印章授权内容",
6846
- "example": "",
6846
+ "example": "印章授权内容",
6847
6847
  "member": "string",
6848
6848
  "name": "Policy",
6849
6849
  "required": false,
@@ -6867,7 +6867,7 @@
6867
6867
  {
6868
6868
  "disabled": false,
6869
6869
  "document": "最终授权成功的用户ID,在腾讯电子签平台的唯一身份标识,为32位字符串。\n可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查看某位员工的UserId(在页面中展示为用户ID)。",
6870
- "example": "",
6870
+ "example": "yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84",
6871
6871
  "member": "string",
6872
6872
  "name": "UserIds",
6873
6873
  "output_required": true,
@@ -7306,7 +7306,7 @@
7306
7306
  {
7307
7307
  "disabled": false,
7308
7308
  "document": "腾讯电子签小程序的AppId,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。",
7309
- "example": "",
7309
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
7310
7310
  "member": "string",
7311
7311
  "name": "AppId",
7312
7312
  "output_required": false,
@@ -7316,7 +7316,7 @@
7316
7316
  {
7317
7317
  "disabled": false,
7318
7318
  "document": "腾讯电子签小程序的原始Id,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。",
7319
- "example": "",
7319
+ "example": "gh_da88f6188665",
7320
7320
  "member": "string",
7321
7321
  "name": "AppOriginalId",
7322
7322
  "output_required": false,
@@ -7336,7 +7336,7 @@
7336
7336
  {
7337
7337
  "disabled": false,
7338
7338
  "document": "腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。",
7339
- "example": "",
7339
+ "example": "pages/home/index",
7340
7340
  "member": "string",
7341
7341
  "name": "Path",
7342
7342
  "output_required": false,
@@ -7346,7 +7346,7 @@
7346
7346
  {
7347
7347
  "disabled": false,
7348
7348
  "document": "base64格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。",
7349
- "example": "",
7349
+ "example": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW==",
7350
7350
  "member": "string",
7351
7351
  "name": "QrCode",
7352
7352
  "output_required": false,
@@ -7917,7 +7917,7 @@
7917
7917
  {
7918
7918
  "disabled": false,
7919
7919
  "document": "清除认证流产生的错误信息",
7920
- "example": "",
7920
+ "example": "企业认证不存在",
7921
7921
  "member": "string",
7922
7922
  "name": "Errormessage",
7923
7923
  "output_required": false,
@@ -8865,7 +8865,7 @@
8865
8865
  },
8866
8866
  {
8867
8867
  "disabled": false,
8868
- "document": "出证任务执行的状态, 状态含义如下:\n\n<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>\n<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>\n<li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>",
8868
+ "document": "出证任务执行的状态, 状态含义如下:\n\n<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>\n<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>\n<li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>",
8869
8869
  "example": "EvidenceStatusExecuting",
8870
8870
  "member": "string",
8871
8871
  "name": "Status",
@@ -8940,7 +8940,7 @@
8940
8940
  {
8941
8941
  "disabled": false,
8942
8942
  "document": "合同组ID,只有在查询合同组信息时才会返回。",
8943
- "example": "",
8943
+ "example": "yDt1iUUckp7xb05iUuWfBtZwW5IdVzLn",
8944
8944
  "member": "string",
8945
8945
  "name": "FlowGroupId",
8946
8946
  "output_required": false,
@@ -8950,7 +8950,7 @@
8950
8950
  {
8951
8951
  "disabled": false,
8952
8952
  "document": "合同组名称,只有在查询合同组信息时才会返回。",
8953
- "example": "",
8953
+ "example": "张三入职合同集",
8954
8954
  "member": "string",
8955
8955
  "name": "FlowGroupName",
8956
8956
  "output_required": false,
@@ -8990,7 +8990,7 @@
8990
8990
  {
8991
8991
  "disabled": false,
8992
8992
  "document": "查询内容控制\n\n<ul><li>**0**:模板列表及详情(默认)</li>\n<li>**1**:仅模板列表</li></ul>",
8993
- "example": "",
8993
+ "example": "1",
8994
8994
  "member": "int64",
8995
8995
  "name": "ContentType",
8996
8996
  "required": false,
@@ -9026,7 +9026,7 @@
9026
9026
  {
9027
9027
  "disabled": false,
9028
9028
  "document": "通过指定[第三方应用的应用号(ApplicationId)](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png),您可以查询<a href=\"https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png\" target=\"_blank\">【应用模板库管理】</a>中某个第三方应用下的模板。\n\n<p><strong>注意事项:</strong></p>\n<ul><li>当 <strong>ApplicationId</strong> 为空时(默认),系统将查询<a href=\"https://qcloudimg.tencent-cloud.cn/raw/376943a1d472393dd5388592f2e85ee5.png\" target=\"_blank\">平台企业的所有模板</a>(自建应用使用的模板)。</li><li>当 <strong>ApplicationId</strong> 不为空时,系统将从<a href=\"https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png\" target=\"_blank\">【应用模板库管理】</a>中查询该特定应用下的模板(分享给第三方应用子企业的模板)。</li></ul>",
9029
- "example": "",
9029
+ "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8",
9030
9030
  "member": "string",
9031
9031
  "name": "ApplicationId",
9032
9032
  "required": false,
@@ -9035,7 +9035,7 @@
9035
9035
  {
9036
9036
  "disabled": true,
9037
9037
  "document": "默认为false,查询SaaS模板库列表;\n为true,查询第三方应用集成平台企业模板库管理列表",
9038
- "example": "",
9038
+ "example": "false",
9039
9039
  "member": "bool",
9040
9040
  "name": "IsChannel",
9041
9041
  "required": false,
@@ -9062,7 +9062,7 @@
9062
9062
  {
9063
9063
  "disabled": false,
9064
9064
  "document": "是否获取模板预览链接。\n\n<ul><li><strong>false</strong>:不获取(默认)</li><li><strong>true</strong>:需要获取</li></ul>\n设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。",
9065
- "example": "",
9065
+ "example": "false",
9066
9066
  "member": "bool",
9067
9067
  "name": "WithPreviewUrl",
9068
9068
  "required": false,
@@ -9118,7 +9118,7 @@
9118
9118
  {
9119
9119
  "disabled": false,
9120
9120
  "document": "查询类型,支持以下类型:\n<ul><li>**0**:查询单个部门节点列表,不包含子节点部门信息</li>\n<li>**1**:查询单个部门节点级一级子节点部门信息列表</li></ul>",
9121
- "example": "",
9121
+ "example": "1",
9122
9122
  "member": "uint64",
9123
9123
  "name": "QueryType",
9124
9124
  "required": true,
@@ -9136,7 +9136,7 @@
9136
9136
  {
9137
9137
  "disabled": false,
9138
9138
  "document": "查询的部门ID。\n注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`",
9139
- "example": "",
9139
+ "example": "yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw",
9140
9140
  "member": "string",
9141
9141
  "name": "DeptId",
9142
9142
  "required": false,
@@ -9145,7 +9145,7 @@
9145
9145
  {
9146
9146
  "disabled": false,
9147
9147
  "document": "查询的客户系统部门ID。\n注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`",
9148
- "example": "",
9148
+ "example": "dept_open_id_test",
9149
9149
  "member": "string",
9150
9150
  "name": "DeptOpenId",
9151
9151
  "required": false,
@@ -9294,7 +9294,7 @@
9294
9294
  {
9295
9295
  "disabled": false,
9296
9296
  "document": "指定分页每页返回的数据条数,单页最大支持 200。",
9297
- "example": "",
9297
+ "example": "10",
9298
9298
  "member": "uint64",
9299
9299
  "name": "Limit",
9300
9300
  "required": true,
@@ -9321,7 +9321,7 @@
9321
9321
  {
9322
9322
  "disabled": false,
9323
9323
  "document": "OFFSET 用于指定查询结果的偏移量,如果不传默认偏移为0,最大2000。\n分页参数, 需要limit, offset 配合使用\n例如:\n您希望得到第三页的数据, 且每页限制最多10条\n您可以使用 LIMIT 10 OFFSET 20\n",
9324
- "example": "",
9324
+ "example": "0",
9325
9325
  "member": "uint64",
9326
9326
  "name": "Offset",
9327
9327
  "required": false,
@@ -9397,7 +9397,7 @@
9397
9397
  {
9398
9398
  "disabled": false,
9399
9399
  "document": "组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号(),请使用中文括号()代替。",
9400
- "example": "",
9400
+ "example": "测试企业",
9401
9401
  "member": "string",
9402
9402
  "name": "OrganizationName",
9403
9403
  "required": false,
@@ -9406,7 +9406,7 @@
9406
9406
  {
9407
9407
  "disabled": false,
9408
9408
  "document": "企业统一社会信用代码\n注意:OrganizationName和UniformSocialCreditCode不能同时为空",
9409
- "example": "",
9409
+ "example": "JHVSH21******",
9410
9410
  "member": "string",
9411
9411
  "name": "UniformSocialCreditCode",
9412
9412
  "required": false,
@@ -9415,7 +9415,7 @@
9415
9415
  {
9416
9416
  "disabled": false,
9417
9417
  "document": "法人姓名",
9418
- "example": "",
9418
+ "example": "张三",
9419
9419
  "member": "string",
9420
9420
  "name": "LegalName",
9421
9421
  "required": false,
@@ -9430,7 +9430,7 @@
9430
9430
  {
9431
9431
  "disabled": false,
9432
9432
  "document": "企业是否已认证",
9433
- "example": "",
9433
+ "example": "true",
9434
9434
  "member": "bool",
9435
9435
  "name": "IsVerified",
9436
9436
  "output_required": true,
@@ -9440,7 +9440,7 @@
9440
9440
  {
9441
9441
  "disabled": false,
9442
9442
  "document": "企业认证状态 0-未认证 1-认证中 2-已认证",
9443
- "example": "",
9443
+ "example": "1",
9444
9444
  "member": "int64",
9445
9445
  "name": "AuthStatus",
9446
9446
  "output_required": true,
@@ -9460,7 +9460,7 @@
9460
9460
  {
9461
9461
  "disabled": false,
9462
9462
  "document": "企业在腾讯电子签平台的唯一身份标识,为32位字符串。\n可登录腾讯电子签控制台,在 \"更多\"->\"企业设置\"->\"企业中心\"- 中查看企业电子签账号。\np.s. 只有当前企业认证成功的时候返回",
9463
- "example": "",
9463
+ "example": "yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E",
9464
9464
  "member": "string",
9465
9465
  "name": "OrganizationId",
9466
9466
  "output_required": false,
@@ -10150,7 +10150,7 @@
10150
10150
  {
10151
10151
  "disabled": false,
10152
10152
  "document": "活体视频的base64编码,mp4格式\n\n注:`需进行base64解码获取活体视频文件`\n注意:此字段可能返回 null,表示取不到有效值。",
10153
- "example": "",
10153
+ "example": "5rS75L2T6KeG6aKR55qEYmFzZTY057yW56CB77yMbXA05qC85byP",
10154
10154
  "member": "string",
10155
10155
  "name": "LiveNessVideo",
10156
10156
  "output_required": false,
@@ -10220,7 +10220,7 @@
10220
10220
  {
10221
10221
  "disabled": false,
10222
10222
  "document": "签署方角色编号,签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。\n\n填写控件和签署控件都与特定的角色编号关联。\n\n在进行新增签署方操作时,建议记录下该签署方的角色编号。后续可以拉取流程信息,用来判断该签署方的当前状态。\n\n注意:此字段可能返回 null,表示取不到有效值。",
10223
- "example": "",
10223
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
10224
10224
  "member": "string",
10225
10225
  "name": "RecipientId",
10226
10226
  "output_required": false,
@@ -10231,7 +10231,7 @@
10231
10231
  {
10232
10232
  "disabled": false,
10233
10233
  "document": "签署方唯一编号,一个全局唯一的标识符,不同的流程不会出现冲突。\n\n可以使用签署方的唯一编号来生成签署链接(也可以通过RecipientId来生成签署链接)。\n注意:此字段可能返回 null,表示取不到有效值。",
10234
- "example": "",
10234
+ "example": "yDt1JUUckp77a2tqUyEmko8RVpCEHoNA",
10235
10235
  "member": "string",
10236
10236
  "name": "SignId",
10237
10237
  "output_required": false,
@@ -10242,7 +10242,7 @@
10242
10242
  {
10243
10243
  "disabled": false,
10244
10244
  "document": "签署方当前状态,会出现下面的状态\n\n2:待签署\n3:已签署\n4:已拒绝\n5:已过期\n6:已撤销\n8:待填写\n9:因为各种原因(签署人改名等)而终止\n10:填写完成\n15:已解除\n19:转他人处理\n注意:此字段可能返回 null,表示取不到有效值。",
10245
- "example": "",
10245
+ "example": "2",
10246
10246
  "member": "int64",
10247
10247
  "name": "ApproverStatus",
10248
10248
  "output_required": false,
@@ -10364,7 +10364,7 @@
10364
10364
  {
10365
10365
  "disabled": false,
10366
10366
  "document": "印章来源类型\n注意:此字段可能返回 null,表示取不到有效值。",
10367
- "example": "",
10367
+ "example": "GENERATE",
10368
10368
  "member": "string",
10369
10369
  "name": "GenerateType",
10370
10370
  "output_required": false,
@@ -10375,7 +10375,7 @@
10375
10375
  {
10376
10376
  "disabled": false,
10377
10377
  "document": "印章来源类型描述\n注意:此字段可能返回 null,表示取不到有效值。",
10378
- "example": "",
10378
+ "example": "深圳电子印章",
10379
10379
  "member": "string",
10380
10380
  "name": "GenerateTypeDesc",
10381
10381
  "output_required": false,
@@ -10386,7 +10386,7 @@
10386
10386
  {
10387
10387
  "disabled": false,
10388
10388
  "document": "印章来源logo\n注意:此字段可能返回 null,表示取不到有效值。",
10389
- "example": "",
10389
+ "example": "https://file.cn/sist-seal-logo-alpha.png",
10390
10390
  "member": "string",
10391
10391
  "name": "GenerateTypeLogo",
10392
10392
  "output_required": false,
@@ -10403,20 +10403,20 @@
10403
10403
  {
10404
10404
  "disabled": false,
10405
10405
  "document": "用户userId\n注意:此字段可能返回 null,表示取不到有效值。",
10406
- "example": "",
10406
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
10407
10407
  "member": "string",
10408
10408
  "name": "UserId",
10409
- "required": false,
10409
+ "output_required": true,
10410
10410
  "type": "string",
10411
10411
  "value_allowed_null": true
10412
10412
  },
10413
10413
  {
10414
10414
  "disabled": false,
10415
10415
  "document": "角色id列表\n注意:此字段可能返回 null,表示取不到有效值。",
10416
- "example": "",
10416
+ "example": "[\"yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH\"]",
10417
10417
  "member": "string",
10418
10418
  "name": "RoleIds",
10419
- "required": false,
10419
+ "output_required": true,
10420
10420
  "type": "list",
10421
10421
  "value_allowed_null": true
10422
10422
  }
@@ -10429,7 +10429,7 @@
10429
10429
  {
10430
10430
  "disabled": false,
10431
10431
  "document": "员工名",
10432
- "example": "",
10432
+ "example": "张三",
10433
10433
  "member": "string",
10434
10434
  "name": "DisplayName",
10435
10435
  "output_required": true,
@@ -10439,7 +10439,7 @@
10439
10439
  {
10440
10440
  "disabled": false,
10441
10441
  "document": "员工手机号",
10442
- "example": "",
10442
+ "example": "18888888888",
10443
10443
  "member": "string",
10444
10444
  "name": "Mobile",
10445
10445
  "output_required": true,
@@ -10449,7 +10449,7 @@
10449
10449
  {
10450
10450
  "disabled": false,
10451
10451
  "document": "传入的企微账号id",
10452
- "example": "",
10452
+ "example": "oDjGHs-1yCnGrRovBj2yHij5JAAA",
10453
10453
  "member": "string",
10454
10454
  "name": "WeworkOpenId",
10455
10455
  "output_required": false,
@@ -10459,7 +10459,7 @@
10459
10459
  {
10460
10460
  "disabled": false,
10461
10461
  "document": "失败原因",
10462
- "example": "",
10462
+ "example": "手机号已经被占用",
10463
10463
  "member": "string",
10464
10464
  "name": "Reason",
10465
10465
  "output_required": true,
@@ -10475,30 +10475,30 @@
10475
10475
  {
10476
10476
  "disabled": false,
10477
10477
  "document": "员工在电子签的userId\n注意:此字段可能返回 null,表示取不到有效值。",
10478
- "example": "",
10478
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
10479
10479
  "member": "string",
10480
10480
  "name": "UserId",
10481
- "required": true,
10481
+ "output_required": true,
10482
10482
  "type": "string",
10483
10483
  "value_allowed_null": true
10484
10484
  },
10485
10485
  {
10486
10486
  "disabled": false,
10487
10487
  "document": "员工在第三方平台的openId\n注意:此字段可能返回 null,表示取不到有效值。",
10488
- "example": "",
10488
+ "example": "n9527",
10489
10489
  "member": "string",
10490
10490
  "name": "OpenId",
10491
- "required": true,
10491
+ "output_required": true,
10492
10492
  "type": "string",
10493
10493
  "value_allowed_null": true
10494
10494
  },
10495
10495
  {
10496
10496
  "disabled": false,
10497
10497
  "document": "失败原因",
10498
- "example": "",
10498
+ "example": "员工是公司的超级管理员",
10499
10499
  "member": "string",
10500
10500
  "name": "Reason",
10501
- "required": true,
10501
+ "output_required": true,
10502
10502
  "type": "string",
10503
10503
  "value_allowed_null": false
10504
10504
  }
@@ -10511,7 +10511,7 @@
10511
10511
  {
10512
10512
  "disabled": false,
10513
10513
  "document": "用户传入的名称",
10514
- "example": "",
10514
+ "example": "张三",
10515
10515
  "member": "string",
10516
10516
  "name": "DisplayName",
10517
10517
  "output_required": true,
@@ -10521,7 +10521,7 @@
10521
10521
  {
10522
10522
  "disabled": false,
10523
10523
  "document": "用户传入的手机号,明文展示",
10524
- "example": "",
10524
+ "example": "18888888888",
10525
10525
  "member": "string",
10526
10526
  "name": "Mobile",
10527
10527
  "output_required": true,
@@ -10531,7 +10531,7 @@
10531
10531
  {
10532
10532
  "disabled": false,
10533
10533
  "document": "失败原因",
10534
- "example": "",
10534
+ "example": "手机号已经被占用",
10535
10535
  "member": "string",
10536
10536
  "name": "Reason",
10537
10537
  "output_required": true,
@@ -10541,7 +10541,7 @@
10541
10541
  {
10542
10542
  "disabled": false,
10543
10543
  "document": "员工在腾讯电子签平台的唯一身份标识,为32位字符串。\n可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查看某位员工的UserId(在页面中展示为用户ID)。",
10544
- "example": "",
10544
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
10545
10545
  "member": "string",
10546
10546
  "name": "UserId",
10547
10547
  "output_required": true,
@@ -10551,7 +10551,7 @@
10551
10551
  {
10552
10552
  "disabled": false,
10553
10553
  "document": "员工在第三方平台的openId",
10554
- "example": "",
10554
+ "example": "n9527",
10555
10555
  "member": "string",
10556
10556
  "name": "OpenId",
10557
10557
  "output_required": true,
@@ -10567,7 +10567,7 @@
10567
10567
  {
10568
10568
  "disabled": false,
10569
10569
  "document": "文件ID",
10570
- "example": "",
10570
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
10571
10571
  "member": "string",
10572
10572
  "name": "FileId",
10573
10573
  "output_required": true,
@@ -10578,7 +10578,7 @@
10578
10578
  {
10579
10579
  "disabled": false,
10580
10580
  "document": "文件名",
10581
- "example": "",
10581
+ "example": "入职合同.PDF",
10582
10582
  "member": "string",
10583
10583
  "name": "FileName",
10584
10584
  "output_required": true,
@@ -10589,7 +10589,7 @@
10589
10589
  {
10590
10590
  "disabled": false,
10591
10591
  "document": "文件大小,单位为Byte",
10592
- "example": "",
10592
+ "example": "534543",
10593
10593
  "member": "int64",
10594
10594
  "name": "FileSize",
10595
10595
  "output_required": true,
@@ -10600,7 +10600,7 @@
10600
10600
  {
10601
10601
  "disabled": false,
10602
10602
  "document": "文件上传时间,格式为Unix标准时间戳(秒)",
10603
- "example": "",
10603
+ "example": "1736751627",
10604
10604
  "member": "int64",
10605
10605
  "name": "CreatedOn",
10606
10606
  "output_required": true,
@@ -10617,7 +10617,7 @@
10617
10617
  {
10618
10618
  "disabled": false,
10619
10619
  "document": "下载文件的URL,有效期为输入的UrlTtl,默认5分钟",
10620
- "example": "",
10620
+ "example": "https://file.cn/resourceId.pdf",
10621
10621
  "member": "string",
10622
10622
  "name": "Url",
10623
10623
  "output_required": true,
@@ -10628,7 +10628,7 @@
10628
10628
  {
10629
10629
  "disabled": false,
10630
10630
  "document": "下载文件的附加信息。如果是pdf文件,会返回pdf文件每页的有效高宽\n注意:此字段可能返回 null,表示取不到有效值。",
10631
- "example": "",
10631
+ "example": "{\"width\":595.3,\"height\":841.9}",
10632
10632
  "member": "string",
10633
10633
  "name": "Option",
10634
10634
  "output_required": true,
@@ -10690,7 +10690,7 @@
10690
10690
  {
10691
10691
  "disabled": false,
10692
10692
  "document": "补充企业动态签署人时,需要指定对应企业名称",
10693
- "example": "",
10693
+ "example": "张三示例企业",
10694
10694
  "member": "string",
10695
10695
  "name": "OrganizationName",
10696
10696
  "required": false,
@@ -10708,7 +10708,7 @@
10708
10708
  {
10709
10709
  "disabled": false,
10710
10710
  "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>\n\n注:`补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
10711
- "example": "",
10711
+ "example": "37000019890303000X",
10712
10712
  "member": "string",
10713
10713
  "name": "ApproverIdCardNumber",
10714
10714
  "required": false,
@@ -10732,7 +10732,7 @@
10732
10732
  {
10733
10733
  "disabled": false,
10734
10734
  "document": "为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。\n注意:此字段可能返回 null,表示取不到有效值。",
10735
- "example": "",
10735
+ "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
10736
10736
  "member": "string",
10737
10737
  "name": "RecipientId",
10738
10738
  "output_required": false,
@@ -10742,7 +10742,7 @@
10742
10742
  {
10743
10743
  "disabled": false,
10744
10744
  "document": "补充失败错误说明\n注意:此字段可能返回 null,表示取不到有效值。",
10745
- "example": "",
10745
+ "example": "已经是合同的参与人",
10746
10746
  "member": "string",
10747
10747
  "name": "ErrMessage",
10748
10748
  "output_required": false,
@@ -10752,7 +10752,7 @@
10752
10752
  {
10753
10753
  "disabled": false,
10754
10754
  "document": "合同流程ID,为32位字符串。\t\n注意:此字段可能返回 null,表示取不到有效值。",
10755
- "example": "",
10755
+ "example": "yDt1iUUckp7xb05iUuWfBtZwW5IdVzLn",
10756
10756
  "member": "string",
10757
10757
  "name": "FlowId",
10758
10758
  "output_required": false,
@@ -10768,60 +10768,60 @@
10768
10768
  {
10769
10769
  "disabled": false,
10770
10770
  "document": "控件Id\n注意:此字段可能返回 null,表示取不到有效值。",
10771
- "example": "",
10771
+ "example": "component_01",
10772
10772
  "member": "string",
10773
10773
  "name": "ComponentId",
10774
- "required": false,
10774
+ "output_required": true,
10775
10775
  "type": "string",
10776
10776
  "value_allowed_null": true
10777
10777
  },
10778
10778
  {
10779
10779
  "disabled": false,
10780
10780
  "document": "控件名称\n注意:此字段可能返回 null,表示取不到有效值。",
10781
- "example": "",
10781
+ "example": "地址",
10782
10782
  "member": "string",
10783
10783
  "name": "ComponentName",
10784
- "required": false,
10784
+ "output_required": true,
10785
10785
  "type": "string",
10786
10786
  "value_allowed_null": true
10787
10787
  },
10788
10788
  {
10789
10789
  "disabled": false,
10790
10790
  "document": "控件填写状态;0-未填写;1-已填写\n注意:此字段可能返回 null,表示取不到有效值。",
10791
- "example": "",
10791
+ "example": "1",
10792
10792
  "member": "string",
10793
10793
  "name": "ComponentFillStatus",
10794
- "required": false,
10794
+ "output_required": true,
10795
10795
  "type": "string",
10796
10796
  "value_allowed_null": true
10797
10797
  },
10798
10798
  {
10799
10799
  "disabled": false,
10800
10800
  "document": "控件填写内容\n注意:此字段可能返回 null,表示取不到有效值。",
10801
- "example": "",
10801
+ "example": "深圳市南山区腾讯大厦",
10802
10802
  "member": "string",
10803
10803
  "name": "ComponentValue",
10804
- "required": false,
10804
+ "output_required": true,
10805
10805
  "type": "string",
10806
10806
  "value_allowed_null": true
10807
10807
  },
10808
10808
  {
10809
10809
  "disabled": false,
10810
10810
  "document": "控件所属参与方Id\n注意:此字段可能返回 null,表示取不到有效值。",
10811
- "example": "",
10811
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
10812
10812
  "member": "string",
10813
10813
  "name": "ComponentRecipientId",
10814
- "required": false,
10814
+ "output_required": true,
10815
10815
  "type": "string",
10816
10816
  "value_allowed_null": true
10817
10817
  },
10818
10818
  {
10819
10819
  "disabled": false,
10820
10820
  "document": "图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。\n注意:此字段可能返回 null,表示取不到有效值。",
10821
- "example": "",
10821
+ "example": "https://file.cn/resourceId.jpg",
10822
10822
  "member": "string",
10823
10823
  "name": "ImageUrl",
10824
- "required": false,
10824
+ "output_required": true,
10825
10825
  "type": "string",
10826
10826
  "value_allowed_null": true
10827
10827
  }
@@ -10834,9 +10834,10 @@
10834
10834
  {
10835
10835
  "disabled": false,
10836
10836
  "document": "查询过滤条件的Key",
10837
- "example": "",
10837
+ "example": "Name",
10838
10838
  "member": "string",
10839
10839
  "name": "Key",
10840
+ "output_required": true,
10840
10841
  "required": true,
10841
10842
  "type": "string",
10842
10843
  "value_allowed_null": false
@@ -10844,9 +10845,10 @@
10844
10845
  {
10845
10846
  "disabled": false,
10846
10847
  "document": "查询过滤条件的Value列表",
10847
- "example": "",
10848
+ "example": "[\"张三\"]",
10848
10849
  "member": "string",
10849
10850
  "name": "Values",
10851
+ "output_required": true,
10850
10852
  "required": true,
10851
10853
  "type": "list",
10852
10854
  "value_allowed_null": false
@@ -11091,7 +11093,7 @@
11091
11093
  {
11092
11094
  "disabled": false,
11093
11095
  "document": "签署节点ID,用于生成动态签署人链接完成领取。注:`生成动态签署人补充链接时必传。`",
11094
- "example": "",
11096
+ "example": "yDwJWUUcss36hUx8VMjPR4jOb5ugrMSx",
11095
11097
  "member": "string",
11096
11098
  "name": "RecipientId",
11097
11099
  "required": false,
@@ -11226,7 +11228,7 @@
11226
11228
  {
11227
11229
  "disabled": false,
11228
11230
  "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。\n\n注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时,必须指定`\n\n",
11229
- "example": "",
11231
+ "example": "张三示例企业",
11230
11232
  "member": "string",
11231
11233
  "name": "OrganizationName",
11232
11234
  "required": false,
@@ -11235,7 +11237,7 @@
11235
11237
  {
11236
11238
  "disabled": false,
11237
11239
  "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n在未指定签署人电子签UserId情况下,为必填参数",
11238
- "example": "",
11240
+ "example": "张三",
11239
11241
  "member": "string",
11240
11242
  "name": "ApproverName",
11241
11243
  "required": false,
@@ -11244,7 +11246,7 @@
11244
11246
  {
11245
11247
  "disabled": false,
11246
11248
  "document": "签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。\n\n注:`在未指定签署人电子签UserId情况下,为必填参数`\n",
11247
- "example": "",
11249
+ "example": "18888888888",
11248
11250
  "member": "string",
11249
11251
  "name": "ApproverMobile",
11250
11252
  "required": false,
@@ -11271,7 +11273,7 @@
11271
11273
  {
11272
11274
  "disabled": false,
11273
11275
  "document": "签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。\n\n<b>模板发起合同时,该参数为必填项,可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>\n<b>文件发起合同时,该参数无需传值。</b>\n\n如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。",
11274
- "example": "",
11276
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
11275
11277
  "member": "string",
11276
11278
  "name": "RecipientId",
11277
11279
  "required": false,
@@ -11289,7 +11291,7 @@
11289
11291
  {
11290
11292
  "disabled": false,
11291
11293
  "document": "通知签署方经办人的方式, 有以下途径:\n<ul><li> **sms** : (默认)短信</li>\n<li> **none** : 不通知</li></ul>\n\n注: `既是发起方又是签署方时,不给此签署方发送短信`",
11292
- "example": "",
11294
+ "example": "none",
11293
11295
  "member": "string",
11294
11296
  "name": "NotifyType",
11295
11297
  "required": false,
@@ -11298,7 +11300,7 @@
11298
11300
  {
11299
11301
  "disabled": false,
11300
11302
  "document": "合同强制需要阅读全文,无需传此参数",
11301
- "example": "",
11303
+ "example": "true",
11302
11304
  "member": "bool",
11303
11305
  "name": "IsFullText",
11304
11306
  "required": false,
@@ -11307,7 +11309,7 @@
11307
11309
  {
11308
11310
  "disabled": false,
11309
11311
  "document": "签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。\n\n若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:\n<ul>\n<li>合同页数少于等于2页,阅读时间为3秒;</li>\n<li>合同页数为3到5页,阅读时间为5秒;</li>\n<li>合同页数大于等于6页,阅读时间为10秒。</li>\n</ul>",
11310
- "example": "",
11312
+ "example": "3",
11311
11313
  "member": "uint64",
11312
11314
  "name": "PreReadTime",
11313
11315
  "required": false,
@@ -11316,7 +11318,7 @@
11316
11318
  {
11317
11319
  "disabled": false,
11318
11320
  "document": "签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得\n\n注: \n如果传进来的<font color=\"red\">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)",
11319
- "example": "",
11321
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
11320
11322
  "member": "string",
11321
11323
  "name": "UserId",
11322
11324
  "required": false,
@@ -11325,7 +11327,7 @@
11325
11327
  {
11326
11328
  "disabled": false,
11327
11329
  "document": "<font color=\"red\">字段已经废弃</font>,当前只支持true,默认为true",
11328
- "example": "",
11330
+ "example": "true",
11329
11331
  "member": "bool",
11330
11332
  "name": "Required",
11331
11333
  "required": false,
@@ -11334,7 +11336,7 @@
11334
11336
  {
11335
11337
  "disabled": false,
11336
11338
  "document": "在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。",
11337
- "example": "",
11339
+ "example": "WEWORKAPP",
11338
11340
  "member": "string",
11339
11341
  "name": "ApproverSource",
11340
11342
  "required": false,
@@ -11343,7 +11345,7 @@
11343
11345
  {
11344
11346
  "disabled": false,
11345
11347
  "document": "在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。\n所有参与或签的人员均需具备该标识。\n注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。\n如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。",
11346
- "example": "",
11348
+ "example": "n9527",
11347
11349
  "member": "string",
11348
11350
  "name": "CustomApproverTag",
11349
11351
  "required": false,
@@ -11379,7 +11381,7 @@
11379
11381
  {
11380
11382
  "disabled": false,
11381
11383
  "document": "签署人的签署ID\n\n<ul>\n<li>在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数,电子签后台系统会自动生成。</li>\n<li>在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时,可以通过查询详情接口获取签署人的SignId,然后可以将此值传入,为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。</li>\n</ul>",
11382
- "example": "",
11384
+ "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
11383
11385
  "member": "string",
11384
11386
  "name": "SignId",
11385
11387
  "required": false,
@@ -11388,7 +11390,7 @@
11388
11390
  {
11389
11391
  "disabled": false,
11390
11392
  "document": "此签署人(员工或者个人)签署时,是否需要发起方企业审批,取值如下:\n<ul><li>**false**:(默认)不需要审批,直接签署。</li>\n<li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>\n企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果\n<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>\n<li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>\n\n注:`此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同`\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png)",
11391
- "example": "",
11393
+ "example": "true",
11392
11394
  "member": "bool",
11393
11395
  "name": "ApproverNeedSignReview",
11394
11396
  "required": false,
@@ -11415,7 +11417,7 @@
11415
11417
  {
11416
11418
  "disabled": false,
11417
11419
  "document": "当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时,可以指定签署方签名方式。如果不指定,签署人可以使用所有的签名类型,可指定的签名类型包括:\n\n<ul><li> <b>HANDWRITE</b> :需要实时手写的手写签名。</li>\n<li> <b>HANDWRITTEN_ESIGN</b> :长效手写签名, 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>\n<li> <b>ESIGN</b> :个人印章类型。</li>\n<li> <b>IMG_ESIGN</b> : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>\n<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>\n\n各种签名的样式可以参考下图:\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)",
11418
- "example": "",
11420
+ "example": "[\"HANDWRITE\"]",
11419
11421
  "member": "string",
11420
11422
  "name": "ComponentLimitType",
11421
11423
  "required": false,
@@ -11599,7 +11601,7 @@
11599
11601
  {
11600
11602
  "disabled": false,
11601
11603
  "document": "签署节点ID,用于生成动态签署人链接完成领取。注:`生成动态签署人补充链接时必传。`",
11602
- "example": "",
11604
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
11603
11605
  "member": "string",
11604
11606
  "name": "RecipientId",
11605
11607
  "required": false,
@@ -11640,7 +11642,7 @@
11640
11642
  {
11641
11643
  "disabled": false,
11642
11644
  "document": "合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。\n该名称还将用于合同签署完成后的下载文件名。",
11643
- "example": "",
11645
+ "example": "2025入职合同",
11644
11646
  "member": "string",
11645
11647
  "name": "FlowName",
11646
11648
  "required": true,
@@ -11658,7 +11660,7 @@
11658
11660
  {
11659
11661
  "disabled": false,
11660
11662
  "document": "文件资源ID,通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得,为32位字符串。\n建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。",
11661
- "example": "",
11663
+ "example": "[\"yDt1JUUckp77a2omUyEmko88eg49PTsN\"]",
11662
11664
  "member": "string",
11663
11665
  "name": "FileIds",
11664
11666
  "required": false,
@@ -11667,7 +11669,7 @@
11667
11669
  {
11668
11670
  "disabled": false,
11669
11671
  "document": "合同模板ID,为32位字符串。\n建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。\n可登录腾讯电子签控制台,在 \"模板\"->\"模板中心\"->\"列表展示设置\"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。",
11670
- "example": "",
11672
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
11671
11673
  "member": "string",
11672
11674
  "name": "TemplateId",
11673
11675
  "required": false,
@@ -11675,8 +11677,8 @@
11675
11677
  },
11676
11678
  {
11677
11679
  "disabled": false,
11678
- "document": "签署流程的类型(如销售合同/入职合同等),最大长度200个字符\n示例值:劳务合同",
11679
- "example": "",
11680
+ "document": "签署流程的类型(如销售合同/入职合同等),最大长度200个字符",
11681
+ "example": "劳务合同",
11680
11682
  "member": "string",
11681
11683
  "name": "FlowType",
11682
11684
  "required": false,
@@ -11685,7 +11687,7 @@
11685
11687
  {
11686
11688
  "disabled": false,
11687
11689
  "document": "签署流程描述,最大长度1000个字符",
11688
- "example": "",
11690
+ "example": "2025入职合同",
11689
11691
  "member": "string",
11690
11692
  "name": "FlowDescription",
11691
11693
  "required": false,
@@ -11694,7 +11696,7 @@
11694
11696
  {
11695
11697
  "disabled": false,
11696
11698
  "document": "签署流程的签署截止时间。\n\n值为unix时间戳,精确到秒,不传默认为当前时间一年后\n示例值:1604912664",
11697
- "example": "",
11699
+ "example": "1736751627",
11698
11700
  "member": "int64",
11699
11701
  "name": "Deadline",
11700
11702
  "required": false,
@@ -11712,7 +11714,7 @@
11712
11714
  {
11713
11715
  "disabled": false,
11714
11716
  "document": "调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。\n回调的相关说明可参考开发者中心的<a href=\"https://qian.tencent.com/developers/company/callback_types_v2\" target=\"_blank\">回调通知</a>模块。",
11715
- "example": "",
11717
+ "example": "VXNlckRhdGE=",
11716
11718
  "member": "string",
11717
11719
  "name": "UserData",
11718
11720
  "required": false,
@@ -11721,7 +11723,7 @@
11721
11723
  {
11722
11724
  "disabled": false,
11723
11725
  "document": "发送类型:\ntrue:无序签\nfalse:有序签\n注:默认为false(有序签),请和模板中的配置保持一致\n示例值:true",
11724
- "example": "",
11726
+ "example": "true",
11725
11727
  "member": "bool",
11726
11728
  "name": "Unordered",
11727
11729
  "required": false,
@@ -11739,7 +11741,7 @@
11739
11741
  {
11740
11742
  "disabled": false,
11741
11743
  "document": "发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。\n若设置为true,审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。\n\n注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。\n示例值:true",
11742
- "example": "",
11744
+ "example": "true",
11743
11745
  "member": "bool",
11744
11746
  "name": "NeedSignReview",
11745
11747
  "required": false,
@@ -11747,8 +11749,8 @@
11747
11749
  },
11748
11750
  {
11749
11751
  "disabled": false,
11750
- "document": "个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN\n示例值:E_PRESCRIPTION_AUTO_SIGN",
11751
- "example": "",
11752
+ "document": "个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN\n",
11753
+ "example": "E_PRESCRIPTION_AUTO_SIGN",
11752
11754
  "member": "string",
11753
11755
  "name": "AutoSignScene",
11754
11756
  "required": false,
@@ -11772,7 +11774,7 @@
11772
11774
  {
11773
11775
  "disabled": false,
11774
11776
  "document": "签署人校验方式,支持以下类型\n<ul><li>VerifyCheck : 人脸识别 (默认值)</li>\n<li>MobileCheck : 手机号验证</li></ul>\n参数说明:此参数仅在合同组文件发起有效,可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。",
11775
- "example": "",
11777
+ "example": "VerifyCheck ",
11776
11778
  "member": "string",
11777
11779
  "name": "ApproverVerifyType",
11778
11780
  "required": false,
@@ -11781,7 +11783,7 @@
11781
11783
  {
11782
11784
  "disabled": false,
11783
11785
  "document": "发起合同(流程)组本方企业经办人通知方式\n签署通知类型,支持以下类型\n<ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>",
11784
- "example": "",
11786
+ "example": "none ",
11785
11787
  "member": "string",
11786
11788
  "name": "SelfOrganizationApproverNotifyType",
11787
11789
  "required": false,
@@ -11790,7 +11792,7 @@
11790
11792
  {
11791
11793
  "disabled": false,
11792
11794
  "document": "发起合同(流程)组他方经办人通知方式\n签署通知类型,支持以下类型\n<ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>",
11793
- "example": "",
11795
+ "example": "none",
11794
11796
  "member": "string",
11795
11797
  "name": "OtherApproverNotifyType",
11796
11798
  "required": false,
@@ -11953,7 +11955,7 @@
11953
11955
  {
11954
11956
  "disabled": false,
11955
11957
  "document": "成员企业名\n注意:此字段可能返回 null,表示取不到有效值。",
11956
- "example": "",
11958
+ "example": "张三示例企业",
11957
11959
  "member": "string",
11958
11960
  "name": "Name",
11959
11961
  "output_required": true,
@@ -11963,7 +11965,7 @@
11963
11965
  {
11964
11966
  "disabled": false,
11965
11967
  "document": "成员企业别名\n注意:此字段可能返回 null,表示取不到有效值。",
11966
- "example": "",
11968
+ "example": "张三示例企业",
11967
11969
  "member": "string",
11968
11970
  "name": "Alias",
11969
11971
  "output_required": true,
@@ -11973,7 +11975,7 @@
11973
11975
  {
11974
11976
  "disabled": false,
11975
11977
  "document": "成员企业id,为 32 位字符串,可在电子签PC 控制台,企业设置->企业电子签账号 获取\n注意:此字段可能返回 null,表示取不到有效值。",
11976
- "example": "",
11978
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
11977
11979
  "member": "string",
11978
11980
  "name": "OrganizationId",
11979
11981
  "output_required": true,
@@ -11983,7 +11985,7 @@
11983
11985
  {
11984
11986
  "disabled": false,
11985
11987
  "document": "记录更新时间, unix时间戳,单位秒\n注意:此字段可能返回 null,表示取不到有效值。",
11986
- "example": "",
11988
+ "example": "1736751627",
11987
11989
  "member": "uint64",
11988
11990
  "name": "UpdateTime",
11989
11991
  "output_required": true,
@@ -11993,7 +11995,7 @@
11993
11995
  {
11994
11996
  "disabled": false,
11995
11997
  "document": "成员企业加入集团的当前状态\n<ul><li> **1**:待授权</li>\n<li> **2**:已授权待激活</li>\n<li> **3**:拒绝授权</li>\n<li> **4**:已解除</li>\n<li> **5**:已加入</li>\n</ul>\n\n注意:此字段可能返回 null,表示取不到有效值。",
11996
- "example": "",
11998
+ "example": "5",
11997
11999
  "member": "uint64",
11998
12000
  "name": "Status",
11999
12001
  "output_required": true,
@@ -12003,7 +12005,7 @@
12003
12005
  {
12004
12006
  "disabled": false,
12005
12007
  "document": "是否为集团主企业\n注意:此字段可能返回 null,表示取不到有效值。",
12006
- "example": "",
12008
+ "example": "false",
12007
12009
  "member": "bool",
12008
12010
  "name": "IsMainOrganization",
12009
12011
  "output_required": true,
@@ -12013,7 +12015,7 @@
12013
12015
  {
12014
12016
  "disabled": false,
12015
12017
  "document": "企业社会信用代码\n注意:此字段可能返回 null,表示取不到有效值。",
12016
- "example": "",
12018
+ "example": "91110108772551611J",
12017
12019
  "member": "string",
12018
12020
  "name": "IdCardNumber",
12019
12021
  "output_required": true,
@@ -12033,7 +12035,7 @@
12033
12035
  {
12034
12036
  "disabled": false,
12035
12037
  "document": "企业许可证Id,此字段暂时不需要关注\n注意:此字段可能返回 null,表示取不到有效值。",
12036
- "example": "",
12038
+ "example": "企业许可证Id",
12037
12039
  "member": "string",
12038
12040
  "name": "License",
12039
12041
  "output_required": true,
@@ -12043,7 +12045,7 @@
12043
12045
  {
12044
12046
  "disabled": false,
12045
12047
  "document": "企业许可证过期时间,unix时间戳,单位秒\n注意:此字段可能返回 null,表示取不到有效值。",
12046
- "example": "",
12048
+ "example": "1736751627",
12047
12049
  "member": "uint64",
12048
12050
  "name": "LicenseExpireTime",
12049
12051
  "output_required": true,
@@ -12053,7 +12055,7 @@
12053
12055
  {
12054
12056
  "disabled": false,
12055
12057
  "document": "成员企业加入集团时间,unix时间戳,单位秒\n注意:此字段可能返回 null,表示取不到有效值。",
12056
- "example": "",
12058
+ "example": "1736751627",
12057
12059
  "member": "uint64",
12058
12060
  "name": "JoinTime",
12059
12061
  "output_required": true,
@@ -12063,7 +12065,7 @@
12063
12065
  {
12064
12066
  "disabled": false,
12065
12067
  "document": "是否使用自建审批流引擎(即不是企微审批流引擎)\n<ul><li> **true**:是</li>\n<li> **false**:否</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
12066
- "example": "",
12068
+ "example": "trye",
12067
12069
  "member": "bool",
12068
12070
  "name": "FlowEngineEnable",
12069
12071
  "output_required": true,
@@ -12079,7 +12081,7 @@
12079
12081
  {
12080
12082
  "disabled": false,
12081
12083
  "document": "授权企业id\n注意:此字段可能返回 null,表示取不到有效值。",
12082
- "example": "",
12084
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
12083
12085
  "member": "string",
12084
12086
  "name": "OrganizationId",
12085
12087
  "output_required": false,
@@ -12090,7 +12092,7 @@
12090
12092
  {
12091
12093
  "disabled": false,
12092
12094
  "document": "授权企业名称\n注意:此字段可能返回 null,表示取不到有效值。",
12093
- "example": "",
12095
+ "example": "张三示例企业",
12094
12096
  "member": "string",
12095
12097
  "name": "OrganizationName",
12096
12098
  "output_required": false,
@@ -12101,7 +12103,7 @@
12101
12103
  {
12102
12104
  "disabled": false,
12103
12105
  "document": "被授权企业id\n注意:此字段可能返回 null,表示取不到有效值。",
12104
- "example": "",
12106
+ "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8",
12105
12107
  "member": "string",
12106
12108
  "name": "AuthorizedOrganizationId",
12107
12109
  "output_required": false,
@@ -12112,7 +12114,7 @@
12112
12114
  {
12113
12115
  "disabled": false,
12114
12116
  "document": "被授权企业名称\n注意:此字段可能返回 null,表示取不到有效值。",
12115
- "example": "",
12117
+ "example": "李四示例企业",
12116
12118
  "member": "string",
12117
12119
  "name": "AuthorizedOrganizationName",
12118
12120
  "output_required": false,
@@ -12123,7 +12125,7 @@
12123
12125
  {
12124
12126
  "disabled": false,
12125
12127
  "document": "授权模板id(仅当授权方式为模板授权时有值)\n注意:此字段可能返回 null,表示取不到有效值。",
12126
- "example": "",
12128
+ "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
12127
12129
  "member": "string",
12128
12130
  "name": "TemplateId",
12129
12131
  "output_required": false,
@@ -12134,7 +12136,7 @@
12134
12136
  {
12135
12137
  "disabled": false,
12136
12138
  "document": "授权模板名称(仅当授权方式为模板授权时有值)\n注意:此字段可能返回 null,表示取不到有效值。",
12137
- "example": "",
12139
+ "example": "入职合同",
12138
12140
  "member": "string",
12139
12141
  "name": "TemplateName",
12140
12142
  "output_required": false,
@@ -12145,7 +12147,7 @@
12145
12147
  {
12146
12148
  "disabled": false,
12147
12149
  "document": "授权时间,格式为时间戳,单位s\n注意:此字段可能返回 null,表示取不到有效值。",
12148
- "example": "",
12150
+ "example": "1736751627",
12149
12151
  "member": "int64",
12150
12152
  "name": "AuthorizeTime",
12151
12153
  "output_required": false,
@@ -12162,7 +12164,7 @@
12162
12164
  {
12163
12165
  "disabled": false,
12164
12166
  "document": "员工在腾讯电子签平台的唯一身份标识,为32位字符串。\n注意:此字段可能返回 null,表示取不到有效值。",
12165
- "example": "",
12167
+ "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8",
12166
12168
  "member": "string",
12167
12169
  "name": "UserId",
12168
12170
  "output_required": true,
@@ -12173,7 +12175,7 @@
12173
12175
  {
12174
12176
  "disabled": false,
12175
12177
  "document": "当前员工的归属情况,可能值是:\nMainOrg:在集团企业的场景下,返回此值代表是归属主企业\nCurrentOrg:在普通企业场景下返回此值;或者在集团企业的场景下,返回此值代表归属子企业\n注意:此字段可能返回 null,表示取不到有效值。",
12176
- "example": "",
12178
+ "example": "MainOrg",
12177
12179
  "member": "string",
12178
12180
  "name": "BelongTo",
12179
12181
  "output_required": true,
@@ -12184,7 +12186,7 @@
12184
12186
  {
12185
12187
  "disabled": false,
12186
12188
  "document": "集团主企业id,当前企业为集团子企业时,该字段有值\n注意:此字段可能返回 null,表示取不到有效值。",
12187
- "example": "",
12189
+ "example": "yDt1JUUckp77a2omUyEmko88eg49PTsN",
12188
12190
  "member": "string",
12189
12191
  "name": "MainOrganizationId",
12190
12192
  "output_required": false,
@@ -12201,7 +12203,7 @@
12201
12203
  {
12202
12204
  "disabled": false,
12203
12205
  "document": "角色id\n注意:此字段可能返回 null,表示取不到有效值。",
12204
- "example": "",
12206
+ "example": "caf2d1eab2632cd84a66593a23b769d9",
12205
12207
  "member": "string",
12206
12208
  "name": "RoleId",
12207
12209
  "output_required": true,
@@ -12211,7 +12213,7 @@
12211
12213
  {
12212
12214
  "disabled": false,
12213
12215
  "document": "角色名\n注意:此字段可能返回 null,表示取不到有效值。",
12214
- "example": "",
12216
+ "example": "超级管理员",
12215
12217
  "member": "string",
12216
12218
  "name": "RoleName",
12217
12219
  "output_required": true,
@@ -12221,7 +12223,7 @@
12221
12223
  {
12222
12224
  "disabled": false,
12223
12225
  "document": "角色状态,1-启用,2-禁用\n注意:此字段可能返回 null,表示取不到有效值。",
12224
- "example": "",
12226
+ "example": "1",
12225
12227
  "member": "uint64",
12226
12228
  "name": "RoleStatus",
12227
12229
  "output_required": true,
@@ -12231,7 +12233,7 @@
12231
12233
  {
12232
12234
  "disabled": false,
12233
12235
  "document": "是否是集团角色,true-是,false-否\n注意:此字段可能返回 null,表示取不到有效值。",
12234
- "example": "",
12236
+ "example": "false",
12235
12237
  "member": "bool",
12236
12238
  "name": "IsGroupRole",
12237
12239
  "output_required": true,
@@ -12241,7 +12243,7 @@
12241
12243
  {
12242
12244
  "disabled": false,
12243
12245
  "document": "管辖的子企业列表\n注意:此字段可能返回 null,表示取不到有效值。",
12244
- "example": "",
12246
+ "example": "[\"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"]",
12245
12247
  "member": "string",
12246
12248
  "name": "SubOrgIdList",
12247
12249
  "output_required": true,
@@ -12387,7 +12389,7 @@
12387
12389
  {
12388
12390
  "disabled": false,
12389
12391
  "document": "视频base64编码(其中包含全程提示文本和点头音频,mp4格式)\n注意:此字段可能返回 null,表示取不到有效值。",
12390
- "example": "",
12392
+ "example": "AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1wN",
12391
12393
  "member": "string",
12392
12394
  "name": "Video",
12393
12395
  "output_required": false,
@@ -12427,7 +12429,7 @@
12427
12429
  {
12428
12430
  "disabled": false,
12429
12431
  "document": "视频base64(其中包含全程问题和回答音频,mp4格式)\n\n注:`需进行base64解码获取视频文件`\n注意:此字段可能返回 null,表示取不到有效值。",
12430
- "example": "",
12432
+ "example": "6KeG6aKRYmFzZTY0",
12431
12433
  "member": "string",
12432
12434
  "name": "Video",
12433
12435
  "output_required": false,
@@ -12437,7 +12439,7 @@
12437
12439
  {
12438
12440
  "disabled": false,
12439
12441
  "document": " 和答案匹配结果列表\n注意:此字段可能返回 null,表示取不到有效值。",
12440
- "example": "",
12442
+ "example": "[\"0\"]",
12441
12443
  "member": "string",
12442
12444
  "name": "ResultCode",
12443
12445
  "output_required": false,
@@ -12447,7 +12449,7 @@
12447
12449
  {
12448
12450
  "disabled": false,
12449
12451
  "document": "回答问题语音识别结果列表\n注意:此字段可能返回 null,表示取不到有效值。",
12450
- "example": "",
12452
+ "example": "[\"同意\"]",
12451
12453
  "member": "string",
12452
12454
  "name": "AsrResult",
12453
12455
  "output_required": false,
@@ -12803,7 +12805,7 @@
12803
12805
  {
12804
12806
  "disabled": false,
12805
12807
  "document": "角色id",
12806
- "example": "",
12808
+ "example": "yDxD6UxwxNjUy0fKyKBk09rtshL0DBuA",
12807
12809
  "member": "string",
12808
12810
  "name": "RoleId",
12809
12811
  "output_required": false,
@@ -12825,7 +12827,7 @@
12825
12827
  {
12826
12828
  "disabled": false,
12827
12829
  "document": "签署方经办人的类型,支持以下类型\n<ul><li> ORGANIZATION 企业(含企业自动签)</li>\n<li>PERSON 个人(含个人自动签)</li></ul>",
12828
- "example": "",
12830
+ "example": "ORGANIZATION",
12829
12831
  "member": "string",
12830
12832
  "name": "ApproverType",
12831
12833
  "required": true,
@@ -12834,7 +12836,7 @@
12834
12836
  {
12835
12837
  "disabled": false,
12836
12838
  "document": "签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。",
12837
- "example": "",
12839
+ "example": "张三",
12838
12840
  "member": "string",
12839
12841
  "name": "ApproverName",
12840
12842
  "required": true,
@@ -12843,7 +12845,7 @@
12843
12845
  {
12844
12846
  "disabled": false,
12845
12847
  "document": "签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。",
12846
- "example": "",
12848
+ "example": "18888888888",
12847
12849
  "member": "string",
12848
12850
  "name": "ApproverMobile",
12849
12851
  "required": false,
@@ -12861,7 +12863,7 @@
12861
12863
  {
12862
12864
  "disabled": false,
12863
12865
  "document": "签署方经办人的证件号码,应符合以下规则\n<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>\n<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>\n<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
12864
- "example": "",
12866
+ "example": "37000019890303000X",
12865
12867
  "member": "string",
12866
12868
  "name": "ApproverIdCardNumber",
12867
12869
  "required": false,
@@ -12870,7 +12872,7 @@
12870
12872
  {
12871
12873
  "disabled": false,
12872
12874
  "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。\n如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。\n",
12873
- "example": "",
12875
+ "example": "张三示例企业",
12874
12876
  "member": "string",
12875
12877
  "name": "OrganizationName",
12876
12878
  "required": false,
@@ -12885,7 +12887,7 @@
12885
12887
  {
12886
12888
  "disabled": false,
12887
12889
  "document": "电子印章编号",
12888
- "example": "",
12890
+ "example": "yDtwLUUckp79rcc2UuSIlvCCkIZsXxFY",
12889
12891
  "member": "string",
12890
12892
  "name": "SealId",
12891
12893
  "output_required": true,
@@ -12895,7 +12897,7 @@
12895
12897
  {
12896
12898
  "disabled": false,
12897
12899
  "document": "电子印章名称",
12898
- "example": "",
12900
+ "example": "张三示例企业公章",
12899
12901
  "member": "string",
12900
12902
  "name": "SealName",
12901
12903
  "output_required": true,
@@ -12905,7 +12907,7 @@
12905
12907
  {
12906
12908
  "disabled": false,
12907
12909
  "document": "电子印章授权时间戳,单位秒",
12908
- "example": "",
12910
+ "example": "1736751627",
12909
12911
  "member": "int64",
12910
12912
  "name": "CreateOn",
12911
12913
  "output_required": true,
@@ -12915,7 +12917,7 @@
12915
12917
  {
12916
12918
  "disabled": false,
12917
12919
  "document": "电子印章授权人的UserId",
12918
- "example": "",
12920
+ "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8",
12919
12921
  "member": "string",
12920
12922
  "name": "Creator",
12921
12923
  "output_required": true,
@@ -12925,7 +12927,7 @@
12925
12927
  {
12926
12928
  "disabled": false,
12927
12929
  "document": "电子印章策略Id",
12928
- "example": "",
12930
+ "example": "yDRIOUUja5b90Uy0fKyKFCQryVc5qKxW",
12929
12931
  "member": "string",
12930
12932
  "name": "SealPolicyId",
12931
12933
  "output_required": true,
@@ -12935,7 +12937,7 @@
12935
12937
  {
12936
12938
  "disabled": false,
12937
12939
  "document": "印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)",
12938
- "example": "",
12940
+ "example": "SUCCESS",
12939
12941
  "member": "string",
12940
12942
  "name": "SealStatus",
12941
12943
  "output_required": true,
@@ -12945,7 +12947,7 @@
12945
12947
  {
12946
12948
  "disabled": false,
12947
12949
  "document": "审核失败原因\n注意:此字段可能返回 null,表示取不到有效值。",
12948
- "example": "",
12950
+ "example": "印章错误",
12949
12951
  "member": "string",
12950
12952
  "name": "FailReason",
12951
12953
  "output_required": true,
@@ -12955,7 +12957,7 @@
12955
12957
  {
12956
12958
  "disabled": false,
12957
12959
  "document": "印章图片url,5分钟内有效",
12958
- "example": "",
12960
+ "example": "https://file.cn/sealid.jpg",
12959
12961
  "member": "string",
12960
12962
  "name": "Url",
12961
12963
  "output_required": true,
@@ -12965,7 +12967,7 @@
12965
12967
  {
12966
12968
  "disabled": false,
12967
12969
  "document": "印章类型,OFFICIAL-企业公章, CONTRACT-合同专用章,ORGANIZATIONSEAL-企业印章(本地上传印章类型),LEGAL_PERSON_SEAL-法人印章",
12968
- "example": "",
12970
+ "example": "OFFICIAL",
12969
12971
  "member": "string",
12970
12972
  "name": "SealType",
12971
12973
  "output_required": true,
@@ -12975,7 +12977,7 @@
12975
12977
  {
12976
12978
  "disabled": false,
12977
12979
  "document": "用印申请是否为永久授权,true-是,false-否",
12978
- "example": "",
12980
+ "example": "true",
12979
12981
  "member": "bool",
12980
12982
  "name": "IsAllTime",
12981
12983
  "output_required": true,
@@ -13057,7 +13059,7 @@
13057
13059
  {
13058
13060
  "disabled": false,
13059
13061
  "document": "企业批量注册链接,根据Endpoint的不同设置,返回不同的链接地址。失效时间:7天\n跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表\n<table> <thead> <tr> <th>Endpoint</th> <th>示例</th> <th>链接有效期限</th> </tr> </thead> <tbody>\n <tr> <td>PC</td> <td>https://qian.tencent.com/console/batch-register?token=yDSx0UUgtjuaf4UEfd2MjCnfI1iuXFE6&orgName=批量认证线上测试企业9</td> <td>7天</td> </tr> \n<tr> <td>PC_SHORT_URL</td> <td>https://test.essurl.cn/8gDKUBAWK8</td> <td>7天</td> </tr> \n<tr> <td>APP</td> <td>/pages/guide/index?to=REGISTER_ENTERPRISE_FOR_BATCH&urlAuthToken=yDSx0UUgtjuaf4UEfd2MjCnfI1iuXFE6&orgName=批量认证线上测试企业9</td> <td>7天</td> </tr> </tbody> </table>\n注: \n`1.创建的链接应避免被转义,如:&被转义为\\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义`\n",
13060
- "example": "",
13062
+ "example": "https://test.essurl.cn/8gDKUBAWK8",
13061
13063
  "member": "string",
13062
13064
  "name": "AuthUrl",
13063
13065
  "output_required": false,
@@ -13067,7 +13069,7 @@
13067
13069
  {
13068
13070
  "disabled": false,
13069
13071
  "document": "企业批量注册的错误信息,例如:企业三要素不通过\t",
13070
- "example": "",
13072
+ "example": "企业三要素不通过",
13071
13073
  "member": "string",
13072
13074
  "name": "ErrorMessage",
13073
13075
  "output_required": false,
@@ -13093,7 +13095,7 @@
13093
13095
  {
13094
13096
  "disabled": false,
13095
13097
  "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。\n注意:此字段可能返回 null,表示取不到有效值。",
13096
- "example": "",
13098
+ "example": "张三示例企业",
13097
13099
  "member": "string",
13098
13100
  "name": "OrganizationName",
13099
13101
  "output_required": false,
@@ -13104,7 +13106,7 @@
13104
13106
  {
13105
13107
  "disabled": false,
13106
13108
  "document": "组织机构企业统一社会信用代码。\n请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。\n注意:此字段可能返回 null,表示取不到有效值。",
13107
- "example": "",
13109
+ "example": "37000019890303000X",
13108
13110
  "member": "string",
13109
13111
  "name": "UniformSocialCreditCode",
13110
13112
  "output_required": false,
@@ -13115,7 +13117,7 @@
13115
13117
  {
13116
13118
  "disabled": false,
13117
13119
  "document": "组织机构法人的姓名。\n请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。\n注意:此字段可能返回 null,表示取不到有效值。",
13118
- "example": "",
13120
+ "example": "张三",
13119
13121
  "member": "string",
13120
13122
  "name": "LegalName",
13121
13123
  "output_required": false,
@@ -13137,7 +13139,7 @@
13137
13139
  {
13138
13140
  "disabled": false,
13139
13141
  "document": "组织机构法人的证件号码\n注意:此字段可能返回 null,表示取不到有效值。",
13140
- "example": "",
13142
+ "example": "37000019890303000X",
13141
13143
  "member": "string",
13142
13144
  "name": "LegalIdCardNumber",
13143
13145
  "output_required": false,
@@ -13148,7 +13150,7 @@
13148
13150
  {
13149
13151
  "disabled": false,
13150
13152
  "document": "组织机构超管姓名。\n\n注意:此字段可能返回 null,表示取不到有效值。",
13151
- "example": "",
13153
+ "example": "张三",
13152
13154
  "member": "string",
13153
13155
  "name": "AdminName",
13154
13156
  "output_required": false,
@@ -13159,7 +13161,7 @@
13159
13161
  {
13160
13162
  "disabled": false,
13161
13163
  "document": "组织机构超管手机号。\n\n注意:此字段可能返回 null,表示取不到有效值。",
13162
- "example": "",
13164
+ "example": "18888888888",
13163
13165
  "member": "string",
13164
13166
  "name": "AdminMobile",
13165
13167
  "output_required": false,
@@ -13181,7 +13183,7 @@
13181
13183
  {
13182
13184
  "disabled": false,
13183
13185
  "document": "组织机构超管证件号码\n\n注意:此字段可能返回 null,表示取不到有效值。",
13184
- "example": "",
13186
+ "example": "37000019890303000X",
13185
13187
  "member": "string",
13186
13188
  "name": "AdminIdCardNumber",
13187
13189
  "output_required": false,
@@ -13192,7 +13194,7 @@
13192
13194
  {
13193
13195
  "disabled": false,
13194
13196
  "document": "原超管姓名\n注意:此字段可能返回 null,表示取不到有效值。",
13195
- "example": "",
13197
+ "example": "李四",
13196
13198
  "member": "string",
13197
13199
  "name": "OldAdminName",
13198
13200
  "output_required": false,
@@ -13203,7 +13205,7 @@
13203
13205
  {
13204
13206
  "disabled": false,
13205
13207
  "document": "原超管手机号\n注意:此字段可能返回 null,表示取不到有效值。",
13206
- "example": "",
13208
+ "example": "15100000000",
13207
13209
  "member": "string",
13208
13210
  "name": "OldAdminMobile",
13209
13211
  "output_required": false,
@@ -13225,7 +13227,7 @@
13225
13227
  {
13226
13228
  "disabled": false,
13227
13229
  "document": "原超管证件号码",
13228
- "example": "",
13230
+ "example": "65000019870404000X",
13229
13231
  "member": "string",
13230
13232
  "name": "OldAdminIdCardNumber",
13231
13233
  "output_required": false,
@@ -13298,7 +13300,7 @@
13298
13300
  {
13299
13301
  "disabled": false,
13300
13302
  "document": "验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。",
13301
- "example": "",
13303
+ "example": "1",
13302
13304
  "member": "int64",
13303
13305
  "name": "VerifyResult",
13304
13306
  "output_required": true,
@@ -13308,7 +13310,7 @@
13308
13310
  {
13309
13311
  "disabled": false,
13310
13312
  "document": "签署平台\n如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,\n如果文件不在腾讯电子签平台签署,则为**其他平台**。",
13311
- "example": "",
13313
+ "example": "腾讯电子签",
13312
13314
  "member": "string",
13313
13315
  "name": "SignPlatform",
13314
13316
  "output_required": true,
@@ -13318,7 +13320,7 @@
13318
13320
  {
13319
13321
  "disabled": false,
13320
13322
  "document": "申请证书的主体的名字\n\n如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下\n**企业**: ESS@企业名称@编码\n**个人**: ESS@个人姓名@证件号@808854\n\n如果在其他平台签署的, 主体的名字参考其他平台的说明",
13321
- "example": "",
13323
+ "example": "ESS@典子谦示例企业@382919",
13322
13324
  "member": "string",
13323
13325
  "name": "SignerName",
13324
13326
  "output_required": true,
@@ -13328,7 +13330,7 @@
13328
13330
  {
13329
13331
  "disabled": false,
13330
13332
  "document": "签署时间的Unix时间戳,单位毫秒",
13331
- "example": "",
13333
+ "example": "1699252042000",
13332
13334
  "member": "int64",
13333
13335
  "name": "SignTime",
13334
13336
  "output_required": true,
@@ -13338,7 +13340,7 @@
13338
13340
  {
13339
13341
  "disabled": false,
13340
13342
  "document": "证书签名算法, 如SHA1withRSA等算法",
13341
- "example": "",
13343
+ "example": "SHA1withRSA",
13342
13344
  "member": "string",
13343
13345
  "name": "SignAlgorithm",
13344
13346
  "output_required": true,
@@ -13348,7 +13350,7 @@
13348
13350
  {
13349
13351
  "disabled": false,
13350
13352
  "document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。",
13351
- "example": "",
13353
+ "example": "6c8e2911fadf70ea",
13352
13354
  "member": "string",
13353
13355
  "name": "CertSn",
13354
13356
  "output_required": true,
@@ -13358,7 +13360,7 @@
13358
13360
  {
13359
13361
  "disabled": false,
13360
13362
  "document": "证书起始时间的Unix时间戳,单位毫秒",
13361
- "example": "",
13363
+ "example": "1699006057000",
13362
13364
  "member": "int64",
13363
13365
  "name": "CertNotBefore",
13364
13366
  "output_required": true,
@@ -13368,7 +13370,7 @@
13368
13370
  {
13369
13371
  "disabled": false,
13370
13372
  "document": "证书过期时间的时间戳,单位毫秒",
13371
- "example": "",
13373
+ "example": "1730542057000",
13372
13374
  "member": "int64",
13373
13375
  "name": "CertNotAfter",
13374
13376
  "output_required": true,
@@ -13378,7 +13380,7 @@
13378
13380
  {
13379
13381
  "disabled": false,
13380
13382
  "document": "签名域横坐标,单位px",
13381
- "example": "",
13383
+ "example": "361.0799865722656",
13382
13384
  "member": "float",
13383
13385
  "name": "ComponentPosX",
13384
13386
  "output_required": true,
@@ -13388,7 +13390,7 @@
13388
13390
  {
13389
13391
  "disabled": false,
13390
13392
  "document": "签名域纵坐标,单位px",
13391
- "example": "",
13393
+ "example": "481.6199951171875",
13392
13394
  "member": "float",
13393
13395
  "name": "ComponentPosY",
13394
13396
  "output_required": true,
@@ -13398,7 +13400,7 @@
13398
13400
  {
13399
13401
  "disabled": false,
13400
13402
  "document": "签名域宽度,单位px",
13401
- "example": "",
13403
+ "example": "119",
13402
13404
  "member": "float",
13403
13405
  "name": "ComponentWidth",
13404
13406
  "output_required": true,
@@ -13408,7 +13410,7 @@
13408
13410
  {
13409
13411
  "disabled": false,
13410
13412
  "document": "签名域高度,单位px",
13411
- "example": "",
13413
+ "example": "14",
13412
13414
  "member": "float",
13413
13415
  "name": "ComponentHeight",
13414
13416
  "output_required": true,
@@ -13418,7 +13420,7 @@
13418
13420
  {
13419
13421
  "disabled": false,
13420
13422
  "document": "签名域所在页码,1~N",
13421
- "example": "",
13423
+ "example": "1",
13422
13424
  "member": "int64",
13423
13425
  "name": "ComponentPage",
13424
13426
  "output_required": true,
@@ -13434,7 +13436,7 @@
13434
13436
  {
13435
13437
  "disabled": false,
13436
13438
  "document": "权限名称\n注意:此字段可能返回 null,表示取不到有效值。",
13437
- "example": "",
13439
+ "example": "订单管理",
13438
13440
  "member": "string",
13439
13441
  "name": "Name",
13440
13442
  "output_required": false,
@@ -13445,7 +13447,7 @@
13445
13447
  {
13446
13448
  "disabled": false,
13447
13449
  "document": "权限key\n注意:此字段可能返回 null,表示取不到有效值。",
13448
- "example": "",
13450
+ "example": "BillOrderManagement",
13449
13451
  "member": "string",
13450
13452
  "name": "Key",
13451
13453
  "output_required": false,
@@ -13456,7 +13458,7 @@
13456
13458
  {
13457
13459
  "disabled": false,
13458
13460
  "document": "权限类型 1前端,2后端\n注意:此字段可能返回 null,表示取不到有效值。",
13459
- "example": "",
13461
+ "example": "2",
13460
13462
  "member": "int64",
13461
13463
  "name": "Type",
13462
13464
  "output_required": false,
@@ -13467,7 +13469,7 @@
13467
13469
  {
13468
13470
  "disabled": false,
13469
13471
  "document": "是否隐藏\n注意:此字段可能返回 null,表示取不到有效值。",
13470
- "example": "",
13472
+ "example": "1",
13471
13473
  "member": "int64",
13472
13474
  "name": "Hide",
13473
13475
  "output_required": false,
@@ -13478,7 +13480,7 @@
13478
13480
  {
13479
13481
  "disabled": false,
13480
13482
  "document": "数据权限标签 1:表示根节点,2:表示叶子结点\n注意:此字段可能返回 null,表示取不到有效值。",
13481
- "example": "",
13483
+ "example": "0",
13482
13484
  "member": "int64",
13483
13485
  "name": "DataLabel",
13484
13486
  "output_required": false,
@@ -13489,7 +13491,7 @@
13489
13491
  {
13490
13492
  "disabled": false,
13491
13493
  "document": "数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权\n注意:此字段可能返回 null,表示取不到有效值。",
13492
- "example": "",
13494
+ "example": "0",
13493
13495
  "member": "int64",
13494
13496
  "name": "DataType",
13495
13497
  "output_required": false,
@@ -13500,7 +13502,7 @@
13500
13502
  {
13501
13503
  "disabled": false,
13502
13504
  "document": "数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己\n注意:此字段可能返回 null,表示取不到有效值。",
13503
- "example": "",
13505
+ "example": "0",
13504
13506
  "member": "int64",
13505
13507
  "name": "DataRange",
13506
13508
  "output_required": false,
@@ -13511,7 +13513,7 @@
13511
13513
  {
13512
13514
  "disabled": false,
13513
13515
  "document": "关联权限, 表示这个功能权限要受哪个数据权限管控\n注意:此字段可能返回 null,表示取不到有效值。",
13514
- "example": "",
13516
+ "example": "FlowsManagement",
13515
13517
  "member": "string",
13516
13518
  "name": "DataTo",
13517
13519
  "output_required": false,
@@ -13522,7 +13524,7 @@
13522
13524
  {
13523
13525
  "disabled": false,
13524
13526
  "document": "父级权限key\n注意:此字段可能返回 null,表示取不到有效值。",
13525
- "example": "",
13527
+ "example": "BillInvoiceManagement",
13526
13528
  "member": "string",
13527
13529
  "name": "ParentKey",
13528
13530
  "output_required": false,
@@ -13533,7 +13535,7 @@
13533
13535
  {
13534
13536
  "disabled": false,
13535
13537
  "document": "是否选中\n注意:此字段可能返回 null,表示取不到有效值。",
13536
- "example": "",
13538
+ "example": "false",
13537
13539
  "member": "bool",
13538
13540
  "name": "IsChecked",
13539
13541
  "output_required": false,
@@ -13561,7 +13563,7 @@
13561
13563
  {
13562
13564
  "disabled": false,
13563
13565
  "document": "权限组名称\n注意:此字段可能返回 null,表示取不到有效值。",
13564
- "example": "",
13566
+ "example": "费用中心",
13565
13567
  "member": "string",
13566
13568
  "name": "GroupName",
13567
13569
  "output_required": false,
@@ -13572,7 +13574,7 @@
13572
13574
  {
13573
13575
  "disabled": false,
13574
13576
  "document": "权限组key\n注意:此字段可能返回 null,表示取不到有效值。",
13575
- "example": "",
13577
+ "example": "bill",
13576
13578
  "member": "string",
13577
13579
  "name": "GroupKey",
13578
13580
  "output_required": false,
@@ -13583,7 +13585,7 @@
13583
13585
  {
13584
13586
  "disabled": false,
13585
13587
  "document": "是否隐藏分组,0否1是\n注意:此字段可能返回 null,表示取不到有效值。",
13586
- "example": "",
13588
+ "example": "false",
13587
13589
  "member": "int64",
13588
13590
  "name": "Hide",
13589
13591
  "output_required": false,
@@ -13611,7 +13613,7 @@
13611
13613
  {
13612
13614
  "disabled": false,
13613
13615
  "document": "签署参与者ID,唯一标识",
13614
- "example": "",
13616
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
13615
13617
  "member": "string",
13616
13618
  "name": "RecipientId",
13617
13619
  "output_required": true,
@@ -13633,7 +13635,7 @@
13633
13635
  {
13634
13636
  "disabled": false,
13635
13637
  "document": "描述信息",
13636
- "example": "",
13638
+ "example": "合同的甲方",
13637
13639
  "member": "string",
13638
13640
  "name": "Description",
13639
13641
  "output_required": true,
@@ -13644,7 +13646,7 @@
13644
13646
  {
13645
13647
  "disabled": false,
13646
13648
  "document": "角色名称",
13647
- "example": "",
13649
+ "example": "甲方",
13648
13650
  "member": "string",
13649
13651
  "name": "RoleName",
13650
13652
  "output_required": true,
@@ -13655,7 +13657,7 @@
13655
13657
  {
13656
13658
  "disabled": false,
13657
13659
  "document": "是否需要验证,\n默认为false-不需要验证",
13658
- "example": "",
13660
+ "example": "true",
13659
13661
  "member": "bool",
13660
13662
  "name": "RequireValidation",
13661
13663
  "output_required": true,
@@ -13666,7 +13668,7 @@
13666
13668
  {
13667
13669
  "disabled": false,
13668
13670
  "document": "是否需要签署,\n默认为true-需要签署",
13669
- "example": "",
13671
+ "example": "true",
13670
13672
  "member": "bool",
13671
13673
  "name": "RequireSign",
13672
13674
  "output_required": true,
@@ -13677,7 +13679,7 @@
13677
13679
  {
13678
13680
  "disabled": false,
13679
13681
  "document": "此参与方添加的顺序,从0~N",
13680
- "example": "",
13682
+ "example": "1",
13681
13683
  "member": "int64",
13682
13684
  "name": "RoutingOrder",
13683
13685
  "output_required": true,
@@ -13688,7 +13690,7 @@
13688
13690
  {
13689
13691
  "disabled": false,
13690
13692
  "document": "是否需要发送,\n默认为true-需要发送",
13691
- "example": "",
13693
+ "example": "true",
13692
13694
  "member": "bool",
13693
13695
  "name": "RequireDelivery",
13694
13696
  "output_required": true,
@@ -13699,7 +13701,7 @@
13699
13701
  {
13700
13702
  "disabled": false,
13701
13703
  "document": "邮箱地址",
13702
- "example": "",
13704
+ "example": "zhangsang@qq.com",
13703
13705
  "member": "string",
13704
13706
  "name": "Email",
13705
13707
  "output_required": true,
@@ -13710,7 +13712,7 @@
13710
13712
  {
13711
13713
  "disabled": false,
13712
13714
  "document": "电话号码",
13713
- "example": "",
13715
+ "example": "18888888888",
13714
13716
  "member": "string",
13715
13717
  "name": "Mobile",
13716
13718
  "output_required": true,
@@ -13721,7 +13723,7 @@
13721
13723
  {
13722
13724
  "disabled": false,
13723
13725
  "document": "关联的用户ID,电子签系统的用户ID",
13724
- "example": "",
13726
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
13725
13727
  "member": "string",
13726
13728
  "name": "UserId",
13727
13729
  "output_required": true,
@@ -13743,7 +13745,7 @@
13743
13745
  {
13744
13746
  "disabled": false,
13745
13747
  "document": "参与方的一些附属信息,json格式",
13746
- "example": "",
13748
+ "example": "{\"userData\":\"xxxx\"}",
13747
13749
  "member": "string",
13748
13750
  "name": "RecipientExtra",
13749
13751
  "output_required": true,
@@ -13754,7 +13756,7 @@
13754
13756
  {
13755
13757
  "disabled": false,
13756
13758
  "document": "签署人查看合同校验方式, 支持的类型如下:\n<ul><li> 1 :实名认证查看</li>\n<li> 2 :手机号校验查看</li></ul>",
13757
- "example": "",
13759
+ "example": "[1]",
13758
13760
  "member": "int64",
13759
13761
  "name": "ApproverVerifyTypes",
13760
13762
  "output_required": true,
@@ -13765,7 +13767,7 @@
13765
13767
  {
13766
13768
  "disabled": false,
13767
13769
  "document": "签署人进行合同签署时的认证方式,支持的类型如下:\n<ul><li> 1 :人脸认证</li>\n<li> 2 :签署密码</li>\n<li> 3 :运营商三要素认证</li>\n<li> 4 :UKey认证</li>\n<li> 5 :设备指纹识别</li>\n<li> 6 :设备面容识别</li></ul>",
13768
- "example": "",
13770
+ "example": "[1]",
13769
13771
  "member": "int64",
13770
13772
  "name": "ApproverSignTypes",
13771
13773
  "output_required": true,
@@ -13776,7 +13778,7 @@
13776
13778
  {
13777
13779
  "disabled": false,
13778
13780
  "document": "签署方是否可以转他人处理\n\n<ul><li> **false** : ( 默认)可以转他人处理</li>\n<li> **true** :不可以转他人处理</li></ul>",
13779
- "example": "",
13781
+ "example": "true",
13780
13782
  "member": "bool",
13781
13783
  "name": "NoTransfer",
13782
13784
  "output_required": false,
@@ -13793,7 +13795,7 @@
13793
13795
  {
13794
13796
  "disabled": false,
13795
13797
  "document": "签署方经办人在合同流程中的参与方ID,与控件绑定,是控件的归属方\n注意:此字段可能返回 null,表示取不到有效值。",
13796
- "example": "",
13798
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
13797
13799
  "member": "string",
13798
13800
  "name": "RecipientId",
13799
13801
  "output_required": false,
@@ -13803,7 +13805,7 @@
13803
13805
  {
13804
13806
  "disabled": false,
13805
13807
  "document": "参与方填写状态\n<ul>\n<li>**空值** : 此参与方没有填写控件</li>\n<li>**0**: 未填写, 表示此参与方还没有填写合同的填写控件</li>\n<li>**1**: 已填写, 表示此参与方已经填写所有的填写控件</li></ul>\n\n注意:此字段可能返回 null,表示取不到有效值。",
13806
- "example": "",
13808
+ "example": "1",
13807
13809
  "member": "string",
13808
13810
  "name": "RecipientFillStatus",
13809
13811
  "output_required": false,
@@ -13813,7 +13815,7 @@
13813
13815
  {
13814
13816
  "disabled": false,
13815
13817
  "document": "是否为发起方\n<ul><li>true-发起方</li>\n<li>false-参与方</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
13816
- "example": "",
13818
+ "example": "true",
13817
13819
  "member": "bool",
13818
13820
  "name": "IsPromoter",
13819
13821
  "output_required": false,
@@ -13839,7 +13841,7 @@
13839
13841
  {
13840
13842
  "disabled": false,
13841
13843
  "document": "法人姓名\n注意:此字段可能返回 null,表示取不到有效值。",
13842
- "example": "",
13844
+ "example": "张三",
13843
13845
  "member": "string",
13844
13846
  "name": "LegalName",
13845
13847
  "output_required": false,
@@ -13861,7 +13863,7 @@
13861
13863
  {
13862
13864
  "disabled": false,
13863
13865
  "document": "社会统一信用代码\n注意:此字段可能返回 null,表示取不到有效值。",
13864
- "example": "",
13866
+ "example": "91110108772551611J",
13865
13867
  "member": "string",
13866
13868
  "name": "UnifiedSocialCreditCode",
13867
13869
  "output_required": false,
@@ -13878,7 +13880,7 @@
13878
13880
  {
13879
13881
  "disabled": false,
13880
13882
  "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。",
13881
- "example": "",
13883
+ "example": "张三示例企业",
13882
13884
  "member": "string",
13883
13885
  "name": "OrganizationName",
13884
13886
  "required": true,
@@ -13887,7 +13889,7 @@
13887
13889
  {
13888
13890
  "disabled": false,
13889
13891
  "document": "组织机构企业统一社会信用代码。\n请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。",
13890
- "example": "",
13892
+ "example": "91110108772551611J",
13891
13893
  "member": "string",
13892
13894
  "name": "UniformSocialCreditCode",
13893
13895
  "required": true,
@@ -13896,7 +13898,7 @@
13896
13898
  {
13897
13899
  "disabled": false,
13898
13900
  "document": "组织机构法人的姓名。\n请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。",
13899
- "example": "",
13901
+ "example": "张三",
13900
13902
  "member": "string",
13901
13903
  "name": "LegalName",
13902
13904
  "required": true,
@@ -13914,7 +13916,7 @@
13914
13916
  {
13915
13917
  "disabled": false,
13916
13918
  "document": "组织机构超管姓名。\n在注册流程中,必须是超管本人进行操作。\n如果法人做为超管管理组织机构,超管姓名就是法人姓名\n如果入参中传递超管授权书PowerOfAttorneys,则此参数为必填参数。",
13917
- "example": "",
13919
+ "example": "张三",
13918
13920
  "member": "string",
13919
13921
  "name": "AdminName",
13920
13922
  "required": false,
@@ -13923,7 +13925,7 @@
13923
13925
  {
13924
13926
  "disabled": false,
13925
13927
  "document": "组织机构超管手机号。\n在注册流程中,这个手机号必须跟操作人在电子签注册的个人手机号一致。\n如果入参中传递超管授权书PowerOfAttorneys,则此参数为必填参数",
13926
- "example": "",
13928
+ "example": "18888888888",
13927
13929
  "member": "string",
13928
13930
  "name": "AdminMobile",
13929
13931
  "required": false,
@@ -13932,7 +13934,7 @@
13932
13934
  {
13933
13935
  "disabled": false,
13934
13936
  "document": "可选的此企业允许的授权方式, 可以设置的方式有:\n1:上传授权书\n2:法人授权超管\n5:授权书+对公打款\n\n\n注:\n`1. 当前仅支持一种认证方式`\n`2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`\n`3. 如果当前操作人是法人,则是法人认证`",
13935
- "example": "",
13937
+ "example": "[1]",
13936
13938
  "member": "uint64",
13937
13939
  "name": "AuthorizationTypes",
13938
13940
  "required": false,
@@ -13941,7 +13943,7 @@
13941
13943
  {
13942
13944
  "disabled": false,
13943
13945
  "document": "认证人身份证号,如果入参中传递超管授权书PowerOfAttorneys,则此参数为必填参数\n",
13944
- "example": "",
13946
+ "example": "37000019890303000X",
13945
13947
  "member": "string",
13946
13948
  "name": "AdminIdCardNumber",
13947
13949
  "required": false,
@@ -13950,7 +13952,7 @@
13950
13952
  {
13951
13953
  "disabled": false,
13952
13954
  "document": "认证人证件类型 \n支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>\n",
13953
- "example": "",
13955
+ "example": "ID_CARD",
13954
13956
  "member": "string",
13955
13957
  "name": "AdminIdCardType",
13956
13958
  "required": false,
@@ -13959,7 +13961,7 @@
13959
13961
  {
13960
13962
  "disabled": false,
13961
13963
  "document": "营业执照正面照(PNG或JPG) base64格式, 大小不超过5M",
13962
- "example": "",
13964
+ "example": "6JCl5Lia5omn54Wn5q2j6Z2i54Wn",
13963
13965
  "member": "string",
13964
13966
  "name": "BusinessLicense",
13965
13967
  "required": false,
@@ -13968,7 +13970,7 @@
13968
13970
  {
13969
13971
  "disabled": false,
13970
13972
  "document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。\np.s. 如果上传授权书 ,需遵循以下条件\n1. 超管的信息(超管姓名,超管手机号)必须为必填参数。\n2. 超管的个人身份必须在电子签已经实名。\n2. 认证方式AuthorizationTypes必须只能是上传授权书方式 \n",
13971
- "example": "",
13973
+ "example": "5o6I5p2D5LmmKFBOR+aIlkpQR+aIllBERikgYmFzZTY05qC85byP",
13972
13974
  "member": "string",
13973
13975
  "name": "PowerOfAttorneys",
13974
13976
  "required": false,
@@ -14019,7 +14021,7 @@
14019
14021
  {
14020
14022
  "disabled": false,
14021
14023
  "document": "签署控件类型,支持自定义企业签署方的签署控件类型\n<ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>\n<li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>",
14022
- "example": "",
14024
+ "example": "SIGN_SEAL",
14023
14025
  "member": "string",
14024
14026
  "name": "ApproverSignComponentType",
14025
14027
  "required": false,
@@ -14037,7 +14039,7 @@
14037
14039
  {
14038
14040
  "disabled": false,
14039
14041
  "document": "印章Id,签署控件类型为印章时,用于指定本企业签署方在解除协议中使用那个印章进行签署",
14040
- "example": "",
14042
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
14041
14043
  "member": "string",
14042
14044
  "name": "ApproverSignSealId",
14043
14045
  "required": false,
@@ -14046,7 +14048,7 @@
14046
14048
  {
14047
14049
  "disabled": false,
14048
14050
  "document": "要更换的原合同参与人RecipientId编号。(可通过接口<a href=\"https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/\">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>",
14049
- "example": "",
14051
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
14050
14052
  "member": "string",
14051
14053
  "name": "RelievedApproverRecipientId",
14052
14054
  "required": false,
@@ -14122,7 +14124,7 @@
14122
14124
  {
14123
14125
  "disabled": false,
14124
14126
  "document": "合同流程ID,为32位字符串。",
14125
- "example": "yDwxxxxxxxW72Qaxm",
14127
+ "example": "yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH",
14126
14128
  "member": "string",
14127
14129
  "name": "FlowId",
14128
14130
  "output_required": true,
@@ -14132,7 +14134,7 @@
14132
14134
  {
14133
14135
  "disabled": false,
14134
14136
  "document": "在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。",
14135
- "example": "\"\"",
14137
+ "example": "今天已经催办过了",
14136
14138
  "member": "string",
14137
14139
  "name": "RemindMessage",
14138
14140
  "output_required": true,
@@ -14212,7 +14214,7 @@
14212
14214
  {
14213
14215
  "disabled": false,
14214
14216
  "document": "姓名",
14215
- "example": "",
14217
+ "example": "张三",
14216
14218
  "member": "string",
14217
14219
  "name": "Name",
14218
14220
  "required": false,
@@ -14221,7 +14223,7 @@
14221
14223
  {
14222
14224
  "disabled": false,
14223
14225
  "document": "手机号",
14224
- "example": "",
14226
+ "example": "18888888888",
14225
14227
  "member": "string",
14226
14228
  "name": "Mobile",
14227
14229
  "required": false,
@@ -14236,7 +14238,7 @@
14236
14238
  {
14237
14239
  "disabled": false,
14238
14240
  "document": "印章ID\n注意:此字段可能返回 null,表示取不到有效值。",
14239
- "example": "",
14241
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
14240
14242
  "member": "string",
14241
14243
  "name": "SealId",
14242
14244
  "output_required": true,
@@ -14247,7 +14249,7 @@
14247
14249
  {
14248
14250
  "disabled": false,
14249
14251
  "document": "印章类型。LEGAL_PERSON_SEAL: 法定代表人章;\nORGANIZATIONSEAL:企业印章;\nOFFICIAL:企业公章;\nCONTRACT:合同专用章\n注意:此字段可能返回 null,表示取不到有效值。",
14250
- "example": "",
14252
+ "example": "OFFICIAL",
14251
14253
  "member": "string",
14252
14254
  "name": "SealType",
14253
14255
  "output_required": true,
@@ -14258,7 +14260,7 @@
14258
14260
  {
14259
14261
  "disabled": false,
14260
14262
  "document": "印章名称\n注意:此字段可能返回 null,表示取不到有效值。",
14261
- "example": "",
14263
+ "example": "张三示例企业公章",
14262
14264
  "member": "string",
14263
14265
  "name": "SealName",
14264
14266
  "output_required": true,
@@ -14670,7 +14672,7 @@
14670
14672
  {
14671
14673
  "disabled": false,
14672
14674
  "document": "员工名",
14673
- "example": "",
14675
+ "example": "张三",
14674
14676
  "member": "string",
14675
14677
  "name": "DisplayName",
14676
14678
  "output_required": true,
@@ -14680,7 +14682,7 @@
14680
14682
  {
14681
14683
  "disabled": false,
14682
14684
  "document": "员工手机号",
14683
- "example": "",
14685
+ "example": "18888888888",
14684
14686
  "member": "string",
14685
14687
  "name": "Mobile",
14686
14688
  "output_required": true,
@@ -14690,7 +14692,7 @@
14690
14692
  {
14691
14693
  "disabled": false,
14692
14694
  "document": "员工在电子签平台的id",
14693
- "example": "",
14695
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
14694
14696
  "member": "string",
14695
14697
  "name": "UserId",
14696
14698
  "output_required": true,
@@ -14700,7 +14702,7 @@
14700
14702
  {
14701
14703
  "disabled": false,
14702
14704
  "document": "提示,当创建已存在未实名用户时,该字段有值\n注意:此字段可能返回 null,表示取不到有效值。",
14703
- "example": "",
14705
+ "example": "张三已经注册了",
14704
14706
  "member": "string",
14705
14707
  "name": "Note",
14706
14708
  "output_required": true,
@@ -14710,7 +14712,7 @@
14710
14712
  {
14711
14713
  "disabled": false,
14712
14714
  "document": "传入的企微账号id",
14713
- "example": "",
14715
+ "example": "oDjGHs-1yCnGrRovBj2yHij5JAAA",
14714
14716
  "member": "string",
14715
14717
  "name": "WeworkOpenId",
14716
14718
  "output_required": false,
@@ -14720,7 +14722,7 @@
14720
14722
  {
14721
14723
  "disabled": false,
14722
14724
  "document": "员工邀请返回链接 根据入参的 InvitationNotifyType 和 Endpoint 返回链接 <table><tbody><tr><td>链接类型</td><td>有效期</td><td>示例</td></tr><tr><td>HTTP_SHORT_URL(短链)</td><td>一天</td><td>https://test.essurl.cn/fvG7UBEd0F</td></tr><tr><td>HTTP(长链)</td><td>一天</td><td>https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=USER_VERIFY&verifyToken=yDCVbUUckpwocmfpUySko7IS83LTV0u0&expireTime=1710840183</td></tr><tr><td>H5</td><td>30 天</td><td>https://quick.test.qian.tencent.cn/guide?Code=yDCVbUUckpwtvxqoUbTw4VBBjLbfAtW7&CodeType=QUICK&shortKey=yDCVbUY7lhqV7mZlCL2d</td></tr><tr><td>APP</td><td>一天</td><td>/pages/guide/index?to=USER_VERIFY&verifyToken=yDCVbUUckpwocm96UySko7ISvEIZH7Yz&expireTime=1710840455 </td></tr></tbody></table>",
14723
- "example": "",
14725
+ "example": "https://test.essurl.cn/fvG7UBEd0F",
14724
14726
  "member": "string",
14725
14727
  "name": "Url",
14726
14728
  "output_required": false,
@@ -14736,30 +14738,30 @@
14736
14738
  {
14737
14739
  "disabled": false,
14738
14740
  "document": "员工名",
14739
- "example": "",
14741
+ "example": "张三",
14740
14742
  "member": "string",
14741
14743
  "name": "DisplayName",
14742
- "required": true,
14744
+ "output_required": true,
14743
14745
  "type": "string",
14744
14746
  "value_allowed_null": false
14745
14747
  },
14746
14748
  {
14747
14749
  "disabled": false,
14748
14750
  "document": "员工手机号",
14749
- "example": "",
14751
+ "example": "18888888888",
14750
14752
  "member": "string",
14751
14753
  "name": "Mobile",
14752
- "required": true,
14754
+ "output_required": true,
14753
14755
  "type": "string",
14754
14756
  "value_allowed_null": false
14755
14757
  },
14756
14758
  {
14757
14759
  "disabled": false,
14758
14760
  "document": "员工在电子签平台的id",
14759
- "example": "",
14761
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
14760
14762
  "member": "string",
14761
14763
  "name": "UserId",
14762
- "required": true,
14764
+ "output_required": true,
14763
14765
  "type": "string",
14764
14766
  "value_allowed_null": false
14765
14767
  }
@@ -14772,7 +14774,7 @@
14772
14774
  {
14773
14775
  "disabled": false,
14774
14776
  "document": "传入的用户名称",
14775
- "example": "",
14777
+ "example": "张三",
14776
14778
  "member": "string",
14777
14779
  "name": "DisplayName",
14778
14780
  "output_required": true,
@@ -14782,7 +14784,7 @@
14782
14784
  {
14783
14785
  "disabled": false,
14784
14786
  "document": "传入的手机号,没有打码",
14785
- "example": "",
14787
+ "example": "13200000000",
14786
14788
  "member": "string",
14787
14789
  "name": "Mobile",
14788
14790
  "output_required": true,
@@ -14792,7 +14794,7 @@
14792
14794
  {
14793
14795
  "disabled": false,
14794
14796
  "document": "员工在腾讯电子签平台的唯一身份标识,为32位字符串。\n可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查看某位员工的UserId(在页面中展示为用户ID)。",
14795
- "example": "",
14797
+ "example": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
14796
14798
  "member": "string",
14797
14799
  "name": "UserId",
14798
14800
  "output_required": true,
@@ -14801,8 +14803,8 @@
14801
14803
  },
14802
14804
  {
14803
14805
  "disabled": false,
14804
- "document": "H5端员工实名链接\n\n只有入参 InvitationNotifyType = H5的时候才会进行返回。",
14805
- "example": "",
14806
+ "document": "H5端员工实名链接\n只有入参 InvitationNotifyType = H5的时候才会进行返回。",
14807
+ "example": "https://jump.cn/success",
14806
14808
  "member": "string",
14807
14809
  "name": "Url",
14808
14810
  "output_required": false,
@@ -14884,7 +14886,7 @@
14884
14886
  {
14885
14887
  "disabled": false,
14886
14888
  "document": "此模板的资源ID",
14887
- "example": "",
14889
+ "example": "[\"yDwJWUUcss36hUx8VMjPR4jOb5ugrMSx\"]",
14888
14890
  "member": "string",
14889
14891
  "name": "DocumentResourceIds",
14890
14892
  "output_required": true,
@@ -14906,7 +14908,7 @@
14906
14908
  {
14907
14909
  "disabled": false,
14908
14910
  "document": "此模板里边附件的资源ID",
14909
- "example": "",
14911
+ "example": "[\"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"]",
14910
14912
  "member": "string",
14911
14913
  "name": "AttachmentResourceIds",
14912
14914
  "output_required": true,
@@ -14928,7 +14930,7 @@
14928
14930
  {
14929
14931
  "disabled": false,
14930
14932
  "document": "此模板的状态可以分为以下几种:\n\n<b>-1</b>:不可用状态。\n<b>0</b>:草稿态,即模板正在编辑或未发布状态。\n<b>1</b>:正式态,只有正式态的模板才可以发起合同。",
14931
- "example": "",
14933
+ "example": "1",
14932
14934
  "member": "int64",
14933
14935
  "name": "Status",
14934
14936
  "output_required": true,
@@ -14950,7 +14952,7 @@
14950
14952
  {
14951
14953
  "disabled": false,
14952
14954
  "document": "模板创建的时间戳,格式为Unix标准时间戳(秒)",
14953
- "example": "",
14955
+ "example": "1736751627",
14954
14956
  "member": "int64",
14955
14957
  "name": "CreatedOn",
14956
14958
  "output_required": true,
@@ -14972,7 +14974,7 @@
14972
14974
  {
14973
14975
  "disabled": false,
14974
14976
  "document": "模板类型可以分为以下两种:\n\n<b>1</b>:带有本企业自动签署的模板,即签署过程无需签署人手动操作,系统自动完成签署。\n<b>3</b>:普通模板,即签署人需要手动进行签署操作。",
14975
- "example": "",
14977
+ "example": "1",
14976
14978
  "member": "int64",
14977
14979
  "name": "TemplateType",
14978
14980
  "output_required": true,
@@ -14983,7 +14985,7 @@
14983
14985
  {
14984
14986
  "disabled": false,
14985
14987
  "document": "模板可用状态可以分为以下两种:\n\n<b>1</b>:(默认)启用状态,即模板可以正常使用。\n<b>2</b>:停用状态,即模板暂时无法使用。\n\n可到控制台启停模板",
14986
- "example": "",
14988
+ "example": "1",
14987
14989
  "member": "int64",
14988
14990
  "name": "Available",
14989
14991
  "output_required": true,
@@ -14994,7 +14996,7 @@
14994
14996
  {
14995
14997
  "disabled": false,
14996
14998
  "document": "创建模板的企业ID,电子签的机构ID",
14997
- "example": "",
14999
+ "example": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
14998
15000
  "member": "string",
14999
15001
  "name": "OrganizationId",
15000
15002
  "output_required": true,
@@ -15005,7 +15007,7 @@
15005
15007
  {
15006
15008
  "disabled": false,
15007
15009
  "document": "模板创建人用户ID",
15008
- "example": "",
15010
+ "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8",
15009
15011
  "member": "string",
15010
15012
  "name": "CreatorId",
15011
15013
  "output_required": true,
@@ -15049,7 +15051,7 @@
15049
15051
  {
15050
15052
  "disabled": false,
15051
15053
  "document": "模板是否已发布可以分为以下两种状态:\n\n<b>true</b>:已发布状态,表示该模板已经发布并可以正常使用。\n<b>false</b>:未发布状态,表示该模板还未发布,无法使用。\n注意:此字段可能返回 null,表示取不到有效值。",
15052
- "example": "",
15054
+ "example": "true",
15053
15055
  "member": "bool",
15054
15056
  "name": "Published",
15055
15057
  "output_required": true,
@@ -15060,7 +15062,7 @@
15060
15062
  {
15061
15063
  "disabled": false,
15062
15064
  "document": "<b>集体账号场景下</b>: 集团账号分享给子企业的模板的来源模板ID。\n注意:此字段可能返回 null,表示取不到有效值。",
15063
- "example": "",
15065
+ "example": "yDtwLUUckp79rcc2UuSIlvCCkIZsXxFY",
15064
15066
  "member": "string",
15065
15067
  "name": "ShareTemplateId",
15066
15068
  "output_required": true,
@@ -15255,7 +15257,7 @@
15255
15257
  {
15256
15258
  "disabled": false,
15257
15259
  "document": "Base64编码后的文件内容",
15258
- "example": "",
15260
+ "example": "6KaB5pS+5paH5Lu255qE5YaF5a65",
15259
15261
  "member": "string",
15260
15262
  "name": "FileBody",
15261
15263
  "required": true,
@@ -15428,9 +15430,10 @@
15428
15430
  {
15429
15431
  "disabled": false,
15430
15432
  "document": "用户在平台的编号",
15431
- "example": "",
15433
+ "example": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8",
15432
15434
  "member": "string",
15433
15435
  "name": "UserId",
15436
+ "output_required": true,
15434
15437
  "required": false,
15435
15438
  "type": "string",
15436
15439
  "value_allowed_null": false
@@ -15441,6 +15444,7 @@
15441
15444
  "example": "无",
15442
15445
  "member": "string",
15443
15446
  "name": "Channel",
15447
+ "output_required": true,
15444
15448
  "required": false,
15445
15449
  "type": "string",
15446
15450
  "value_allowed_null": false
@@ -15451,6 +15455,7 @@
15451
15455
  "example": "无",
15452
15456
  "member": "string",
15453
15457
  "name": "OpenId",
15458
+ "output_required": true,
15454
15459
  "required": false,
15455
15460
  "type": "string",
15456
15461
  "value_allowed_null": false
@@ -15461,6 +15466,7 @@
15461
15466
  "example": "无",
15462
15467
  "member": "string",
15463
15468
  "name": "ClientIp",
15469
+ "output_required": true,
15464
15470
  "required": false,
15465
15471
  "type": "string",
15466
15472
  "value_allowed_null": false
@@ -15471,6 +15477,7 @@
15471
15477
  "example": "无",
15472
15478
  "member": "string",
15473
15479
  "name": "ProxyIp",
15480
+ "output_required": true,
15474
15481
  "required": false,
15475
15482
  "type": "string",
15476
15483
  "value_allowed_null": false