tccli 3.0.922.1__py2.py3-none-any.whl → 3.0.924.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 (110) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/apigateway/v20180808/DescribeServicesStatus.md +33 -19
  3. tccli/examples/cdb/v20170320/CreateDBInstance.md +2 -2
  4. tccli/examples/ckafka/v20190819/CreateAcl.md +4 -1
  5. tccli/examples/clb/v20180317/CloneLoadBalancer.md +3 -3
  6. tccli/examples/clb/v20180317/DescribeListeners.md +49 -127
  7. tccli/examples/clb/v20180317/DescribeLoadBalancers.md +578 -158
  8. tccli/examples/cls/v20201016/CreateScheduledSql.md +13 -11
  9. tccli/examples/cls/v20201016/DeleteScheduledSql.md +2 -2
  10. tccli/examples/cls/v20201016/DescribeConfigs.md +2 -1
  11. tccli/examples/cls/v20201016/DescribeKafkaConsumer.md +23 -0
  12. tccli/examples/cls/v20201016/DescribeScheduledSqlInfo.md +22 -19
  13. tccli/examples/cls/v20201016/ModifyKafkaConsumer.md +21 -0
  14. tccli/examples/cls/v20201016/ModifyScheduledSql.md +11 -9
  15. tccli/examples/cynosdb/v20190107/DescribeAccounts.md +10 -10
  16. tccli/examples/cynosdb/v20190107/DescribeClusterDetail.md +77 -65
  17. tccli/examples/ess/v20201111/CancelUserAutoSignEnableUrl.md +1 -1
  18. tccli/examples/ess/v20201111/CreateBatchCancelFlowUrl.md +5 -4
  19. tccli/examples/ess/v20201111/CreateUserAutoSignEnableUrl.md +2 -2
  20. tccli/examples/ess/v20201111/DescribeFlowBriefs.md +6 -2
  21. tccli/examples/ess/v20201111/DescribeFlowEvidenceReport.md +1 -1
  22. tccli/examples/ess/v20201111/DescribeFlowInfo.md +24 -38
  23. tccli/examples/ess/v20201111/DescribeUserAutoSignStatus.md +1 -1
  24. tccli/examples/ess/v20201111/GetTaskResultApi.md +2 -2
  25. tccli/examples/essbasic/v20210526/ChannelBatchCancelFlows.md +5 -5
  26. tccli/examples/essbasic/v20210526/ChannelCreateBatchCancelFlowUrl.md +10 -8
  27. tccli/examples/essbasic/v20210526/ChannelCreateFlowSignUrl.md +9 -8
  28. tccli/examples/essbasic/v20210526/ChannelCreateWebThemeConfig.md +7 -6
  29. tccli/examples/essbasic/v20210526/DescribeFlowDetailInfo.md +19 -30
  30. tccli/examples/essbasic/v20210526/DescribeTemplates.md +13 -4
  31. tccli/examples/essbasic/v20210526/OperateChannelTemplate.md +2 -2
  32. tccli/examples/lcic/v20220817/DescribeRoom.md +2 -0
  33. tccli/examples/mna/v20210119/GetDevices.md +9 -16
  34. tccli/examples/mna/v20210119/UpdateDevice.md +7 -10
  35. tccli/examples/ms/v20180408/CreateEncryptInstance.md +30 -30
  36. tccli/examples/ms/v20180408/CreateOrderInstance.md +2 -2
  37. tccli/examples/ms/v20180408/DescribeEncryptInstances.md +73 -65
  38. tccli/examples/ms/v20180408/DescribeEncryptPlan.md +34 -34
  39. tccli/examples/ms/v20180408/DescribeOrderInstances.md +1 -1
  40. tccli/examples/oceanus/v20190422/CreateJobConfig.md +1 -1
  41. tccli/examples/tdmq/v20200217/CreateRocketMQVipInstance.md +28 -0
  42. tccli/examples/tione/v20211111/CreateNotebook.md +62 -0
  43. tccli/examples/tione/v20211111/CreateNotebookImage.md +18 -0
  44. tccli/examples/tione/v20211111/DeleteNotebook.md +20 -0
  45. tccli/examples/tione/v20211111/DeleteNotebookImageRecord.md +18 -0
  46. tccli/examples/tione/v20211111/DescribeNotebook.md +70 -0
  47. tccli/examples/tione/v20211111/DescribeNotebookImageKernels.md +23 -0
  48. tccli/examples/tione/v20211111/DescribeNotebookImageRecords.md +28 -0
  49. tccli/examples/tione/v20211111/DescribeNotebooks.md +77 -0
  50. tccli/examples/tione/v20211111/ModifyNotebook.md +64 -0
  51. tccli/examples/tione/v20211111/ModifyNotebookTags.md +22 -0
  52. tccli/examples/tione/v20211111/StartNotebook.md +20 -0
  53. tccli/examples/tione/v20211111/StopCreatingImage.md +18 -0
  54. tccli/examples/tione/v20211111/StopNotebook.md +20 -0
  55. tccli/examples/vpc/v20170312/CreateVpnGateway.md +20 -26
  56. tccli/examples/waf/v20180125/GetAttackHistogram.md +142 -0
  57. tccli/services/apigateway/v20180808/api.json +119 -12
  58. tccli/services/apigateway/v20180808/examples.json +4 -4
  59. tccli/services/asr/v20190614/api.json +1 -1
  60. tccli/services/cdb/v20170320/api.json +101 -90
  61. tccli/services/cdb/v20170320/examples.json +2 -2
  62. tccli/services/cdn/v20180606/api.json +59 -6
  63. tccli/services/ckafka/v20190819/api.json +10 -10
  64. tccli/services/ckafka/v20190819/examples.json +1 -1
  65. tccli/services/clb/v20180317/api.json +221 -68
  66. tccli/services/clb/v20180317/examples.json +10 -10
  67. tccli/services/cls/cls_client.py +110 -4
  68. tccli/services/cls/v20201016/api.json +330 -115
  69. tccli/services/cls/v20201016/examples.json +23 -7
  70. tccli/services/cynosdb/v20190107/api.json +82 -31
  71. tccli/services/cynosdb/v20190107/examples.json +3 -3
  72. tccli/services/dlc/v20210125/api.json +11 -11
  73. tccli/services/emr/v20190103/api.json +10 -0
  74. tccli/services/ess/v20201111/api.json +519 -142
  75. tccli/services/ess/v20201111/examples.json +9 -9
  76. tccli/services/essbasic/v20210526/api.json +195 -126
  77. tccli/services/essbasic/v20210526/examples.json +13 -13
  78. tccli/services/faceid/v20180301/api.json +21 -16
  79. tccli/services/lcic/v20220817/api.json +10 -0
  80. tccli/services/lcic/v20220817/examples.json +2 -2
  81. tccli/services/live/v20180801/api.json +42 -22
  82. tccli/services/mna/v20210119/api.json +11 -12
  83. tccli/services/mna/v20210119/examples.json +4 -4
  84. tccli/services/mps/v20190612/api.json +142 -61
  85. tccli/services/ms/v20180408/api.json +92 -19
  86. tccli/services/ms/v20180408/examples.json +31 -31
  87. tccli/services/nlp/v20190408/api.json +2 -1
  88. tccli/services/oceanus/v20190422/api.json +355 -41
  89. tccli/services/oceanus/v20190422/examples.json +1 -1
  90. tccli/services/ocr/ocr_client.py +4 -110
  91. tccli/services/ocr/v20181119/api.json +0 -315
  92. tccli/services/ocr/v20181119/examples.json +0 -16
  93. tccli/services/tdmq/tdmq_client.py +53 -0
  94. tccli/services/tdmq/v20200217/api.json +126 -0
  95. tccli/services/tdmq/v20200217/examples.json +8 -0
  96. tccli/services/teo/v20220901/api.json +18 -18
  97. tccli/services/tione/tione_client.py +987 -298
  98. tccli/services/tione/v20211111/api.json +1784 -20
  99. tccli/services/tione/v20211111/examples.json +104 -0
  100. tccli/services/tts/v20190823/api.json +1 -1
  101. tccli/services/vpc/v20170312/api.json +45 -65
  102. tccli/services/vpc/v20170312/examples.json +3 -3
  103. tccli/services/waf/v20180125/api.json +111 -0
  104. tccli/services/waf/v20180125/examples.json +8 -0
  105. tccli/services/waf/waf_client.py +57 -4
  106. {tccli-3.0.922.1.dist-info → tccli-3.0.924.1.dist-info}/METADATA +2 -2
  107. {tccli-3.0.922.1.dist-info → tccli-3.0.924.1.dist-info}/RECORD +110 -93
  108. {tccli-3.0.922.1.dist-info → tccli-3.0.924.1.dist-info}/WHEEL +0 -0
  109. {tccli-3.0.922.1.dist-info → tccli-3.0.924.1.dist-info}/entry_points.txt +0 -0
  110. {tccli-3.0.922.1.dist-info → tccli-3.0.924.1.dist-info}/license_files/LICENSE +0 -0
@@ -162,7 +162,7 @@
162
162
  "status": "online"
163
163
  },
164
164
  "CreatePrepareFlow": {
165
- "document": "创建快速发起流程\n适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.\n注:该接口文件的resourceId 是通过上传文件之后获取的。",
165
+ "document": "创建快速发起流程\n<br/>适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.\n<br/>注:该接口文件的resourceId 是通过上传文件之后获取的。",
166
166
  "input": "CreatePrepareFlowRequest",
167
167
  "name": "获取发起合同web页面",
168
168
  "output": "CreatePrepareFlowResponse",
@@ -260,7 +260,7 @@
260
260
  "status": "online"
261
261
  },
262
262
  "DescribeFlowBriefs": {
263
- "document": "查询流程摘要\n适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。\n日调用量限制:10W",
263
+ "document": "查询流程基础信息\n适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。\n每个企业限制日调用量限制:10W, 当当日超过此限制后再调用接口返回错误",
264
264
  "input": "DescribeFlowBriefsRequest",
265
265
  "name": "查询流程摘要",
266
266
  "output": "DescribeFlowBriefsResponse",
@@ -288,7 +288,7 @@
288
288
  "status": "online"
289
289
  },
290
290
  "DescribeFlowTemplates": {
291
- "document": "本接口用于查询本企业模板列表。\n\n当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。\n\n> **适用场景** \n> 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。 \n> 一个模板通常会包含以下结构信息\n>- 模板基本信息\n>- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方\n>- 填写控件 Components\n>- 签署控件 SignComponents\n>- 生成模板的文件基础信息 FileInfos",
291
+ "document": "本接口用于查询本企业模板列表。\n\n当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。\n\n> **适用场景** \n>\n> 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。 \n> 一个模板通常会包含以下结构信息\n>- 模板基本信息\n>- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方\n>- 填写控件 Components\n>- 签署控件 SignComponents\n>- 生成模板的文件基础信息 FileInfos",
292
292
  "input": "DescribeFlowTemplatesRequest",
293
293
  "name": "查询模板",
294
294
  "output": "DescribeFlowTemplatesResponse",
@@ -358,7 +358,7 @@
358
358
  "status": "online"
359
359
  },
360
360
  "GetTaskResultApi": {
361
- "document": "通过发起转换任务接口(CreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。<br/>\n大文件转换所需的时间可能会比较长。",
361
+ "document": "查询转换任务的状态。转换任务Id通过发起转换任务接口(CreateConvertTaskApi)获取。\n注意:大文件转换所需的时间可能会比较长。",
362
362
  "input": "GetTaskResultApiRequest",
363
363
  "name": "查询转换任务状态",
364
364
  "output": "GetTaskResultApiResponse",
@@ -393,7 +393,7 @@
393
393
  "status": "online"
394
394
  },
395
395
  "UpdateIntegrationEmployees": {
396
- "document": "更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号",
396
+ "document": "更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。\n可进行批量操作,Employees中的userID与openID二选一必填",
397
397
  "input": "UpdateIntegrationEmployeesRequest",
398
398
  "name": "更新企业员工信息",
399
399
  "output": "UpdateIntegrationEmployeesResponse",
@@ -767,58 +767,54 @@
767
767
  "member": "UserThreeFactor",
768
768
  "name": "UserInfo",
769
769
  "required": true,
770
- "type": "object",
771
- "value_allowed_null": true
770
+ "type": "object"
772
771
  },
773
772
  {
774
773
  "disabled": false,
775
- "document": "接受自动签开启的回调地址。需要保证post返回200",
774
+ "document": "接受回调URL地址。支持http://或者https://协议\n\nPost数据到此地址后后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败",
776
775
  "example": "无",
776
+ "is_base64": false,
777
777
  "member": "string",
778
778
  "name": "CallbackUrl",
779
779
  "required": true,
780
- "type": "string",
781
- "value_allowed_null": true
780
+ "type": "string"
782
781
  },
783
782
  {
784
783
  "disabled": false,
785
- "document": "是否回调证书信息,默认false-不需要",
784
+ "document": "是否回调证书信息\nfalse-不需要 (默认值)\ntrue-需要",
786
785
  "example": "无",
787
786
  "member": "bool",
788
787
  "name": "CertInfoCallback",
789
788
  "required": false,
790
- "type": "bool",
791
- "value_allowed_null": true
789
+ "type": "bool"
792
790
  },
793
791
  {
794
792
  "disabled": false,
795
- "document": "是否支持用户自定义签名印章,默认false-不需要",
793
+ "document": "是否支持用户自定义签名印章\nfalse-不需要(默认)\ntrue-需要",
796
794
  "example": "无",
797
795
  "member": "bool",
798
796
  "name": "UserDefineSeal",
799
797
  "required": false,
800
- "type": "bool",
801
- "value_allowed_null": true
798
+ "type": "bool"
802
799
  },
803
800
  {
804
801
  "disabled": false,
805
- "document": "是否需要回调的时候返回印章(签名) 图片的 base64,默认false-不需要",
802
+ "document": "是否需要回调的时候返回印章(签名) 图片的 base64\n\nfalse-不需要(默认)\ntrue-需要(",
806
803
  "example": "无",
807
804
  "member": "bool",
808
805
  "name": "SealImgCallback",
809
806
  "required": false,
810
- "type": "bool",
811
- "value_allowed_null": true
807
+ "type": "bool"
812
808
  },
813
809
  {
814
810
  "disabled": false,
815
- "document": "开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。",
811
+ "document": "开通时候的验证方式, 分布为\n\nWEIXINAPP : 微信人脸识别\nINSIGHT : 慧眼人脸认别\nTELECOM : 运营商三要素验证\n\n如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。\n\n如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。",
816
812
  "example": "无",
813
+ "is_base64": false,
817
814
  "member": "string",
818
815
  "name": "VerifyChannels",
819
816
  "required": false,
820
- "type": "list",
821
- "value_allowed_null": true
817
+ "type": "list"
822
818
  }
823
819
  ],
824
820
  "usage": "in"
@@ -1089,6 +1085,7 @@
1089
1085
  "disabled": false,
1090
1086
  "document": "操作人信息,UseId必填\t",
1091
1087
  "example": "无",
1088
+ "is_base64": false,
1092
1089
  "member": "UserInfo",
1093
1090
  "name": "Operator",
1094
1091
  "required": true,
@@ -1098,6 +1095,7 @@
1098
1095
  "disabled": false,
1099
1096
  "document": "自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方",
1100
1097
  "example": "无",
1098
+ "is_base64": false,
1101
1099
  "member": "string",
1102
1100
  "name": "SceneKey",
1103
1101
  "required": true,
@@ -1107,6 +1105,7 @@
1107
1105
  "disabled": false,
1108
1106
  "document": "指定撤销链接的用户指定撤销链接的用户信息,包含姓名、证件类型、证件号码。\n",
1109
1107
  "example": "无",
1108
+ "is_base64": false,
1110
1109
  "member": "UserThreeFactor",
1111
1110
  "name": "UserInfo",
1112
1111
  "required": true,
@@ -1179,12 +1178,13 @@
1179
1178
  "usage": "in"
1180
1179
  },
1181
1180
  "Component": {
1182
- "document": "模板控件信息",
1181
+ "document": "模板/流程中控件信息,可以是填充控件或签署控件",
1183
1182
  "members": [
1184
1183
  {
1185
1184
  "disabled": false,
1186
1185
  "document": "如果是Component填写控件类型,则可选的字段为:\nTEXT - 普通文本控件,输入文本字符串;\nMULTI_LINE_TEXT - 多行文本控件,输入文本字符串;\nCHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;\nFILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;\nDYNAMIC_TABLE - 动态表格控件;\nATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;\nSELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;\nDATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;\nDISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;\n\n如果是SignComponent签署控件类型,则可选的字段为\nSIGN_SEAL - 签署印章控件;\nSIGN_DATE - 签署日期控件;\nSIGN_SIGNATURE - 用户签名控件;\nSIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);\nSIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight\nSIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;\nSIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。\n\n表单域的控件不能作为印章和签名控件",
1187
1186
  "example": "无",
1187
+ "is_base64": false,
1188
1188
  "member": "string",
1189
1189
  "name": "ComponentType",
1190
1190
  "output_required": true,
@@ -1194,7 +1194,7 @@
1194
1194
  },
1195
1195
  {
1196
1196
  "disabled": false,
1197
- "document": "控件所属文件的序号(取值为:0-N)。目前单文件的情况下,值是0",
1197
+ "document": "控件所属文件的序号(取值为:0-N)。\n目前单文件的情况下,值是0",
1198
1198
  "example": "无",
1199
1199
  "member": "int64",
1200
1200
  "name": "FileIndex",
@@ -1260,8 +1260,9 @@
1260
1260
  },
1261
1261
  {
1262
1262
  "disabled": false,
1263
- "document": "查询时返回控件唯一Id。使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字",
1263
+ "document": "控件唯一ID。\n或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字",
1264
1264
  "example": "无",
1265
+ "is_base64": false,
1265
1266
  "member": "string",
1266
1267
  "name": "ComponentId",
1267
1268
  "output_required": true,
@@ -1271,8 +1272,9 @@
1271
1272
  },
1272
1273
  {
1273
1274
  "disabled": false,
1274
- "document": "查询时返回控件名。使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称",
1275
+ "document": "控件名。\n或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称",
1275
1276
  "example": "无",
1277
+ "is_base64": false,
1276
1278
  "member": "string",
1277
1279
  "name": "ComponentName",
1278
1280
  "output_required": true,
@@ -1282,7 +1284,7 @@
1282
1284
  },
1283
1285
  {
1284
1286
  "disabled": false,
1285
- "document": "是否必选,默认为false",
1287
+ "document": "是否必选,默认为false-非必选",
1286
1288
  "example": "无",
1287
1289
  "member": "bool",
1288
1290
  "name": "ComponentRequired",
@@ -1293,8 +1295,9 @@
1293
1295
  },
1294
1296
  {
1295
1297
  "disabled": false,
1296
- "document": "控件关联的签署人ID",
1298
+ "document": "控件关联的参与方ID,对应Recipient结构体中的RecipientId",
1297
1299
  "example": "无",
1300
+ "is_base64": false,
1298
1301
  "member": "string",
1299
1302
  "name": "ComponentRecipientId",
1300
1303
  "output_required": true,
@@ -1306,6 +1309,7 @@
1306
1309
  "disabled": false,
1307
1310
  "document": "扩展参数:\n为JSON格式。\n\nComponentType为FILL_IMAGE时,支持以下参数:\nNotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中\nFillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放\n\nComponentType为SIGN_SIGNATURE类型可以控制签署方式\n{“ComponentTypeLimit”: [“xxx”]}\nxxx可以为:\nHANDWRITE – 手写签名\nOCR_ESIGN -- AI智能识别手写签名\nESIGN -- 个人印章类型\nSYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)\n如:{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}\n\nComponentType为SIGN_DATE时,支持以下参数:\n1 Font:字符串类型目前只支持\"黑体\"、\"宋体\",如果不填默认为\"黑体\"\n2 FontSize: 数字类型,范围6-72,默认值为12\n3 FontAlign: 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐\n4 Format: 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。\n5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n参数样例: \"ComponentExtra\": \"{\\\"Format\\\":“yyyy m d”,\\\"FontSize\\\":12,\\\"Gaps\\\":\\\"2,2\\\", \\\"FontAlign\\\":\\\"Right\\\"}\"\n\nComponentType为SIGN_SEAL类型时,支持以下参数:\n1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)\n参数样例:\"ComponentExtra\":\"{\\\"PageRanges\\\":[{\\\"BeginPage\\\":1,\\\"EndPage\\\":-1}]}\"",
1308
1311
  "example": "无",
1312
+ "is_base64": false,
1309
1313
  "member": "string",
1310
1314
  "name": "ComponentExtra",
1311
1315
  "output_required": true,
@@ -1315,7 +1319,7 @@
1315
1319
  },
1316
1320
  {
1317
1321
  "disabled": false,
1318
- "document": "是否是表单域类型,默认不false-不是\n注意:此字段可能返回 null,表示取不到有效值。",
1322
+ "document": "是否是表单域类型,默认false-不是\n注意:此字段可能返回 null,表示取不到有效值。",
1319
1323
  "example": "无",
1320
1324
  "member": "bool",
1321
1325
  "name": "IsFormType",
@@ -1328,6 +1332,7 @@
1328
1332
  "disabled": false,
1329
1333
  "document": "控件填充vaule,ComponentType和传入值类型对应关系:\nTEXT - 文本内容\nMULTI_LINE_TEXT - 文本内容\nCHECK_BOX - true/false\nFILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取\nSELECTOR - 选项值\nDYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo\nDATE - 默认是格式化为xxxx年xx月xx日\nSIGN_SEAL - 印章ID,于控制台查询获取\nSIGN_PAGING_SEAL - 可以指定印章ID,于控制台查询获取\n\n控件值约束说明:\n企业全称控件:\n 约束:企业名称中文字符中文括号\n 检查正则表达式:/^[\\u3400-\\u4dbf\\u4e00-\\u9fa5()]+$/\n\n统一社会信用代码控件:\n 检查正则表达式:/^[A-Z0-9]{1,18}$/\n\n法人名称控件:\n 约束:最大50个字符,2到25个汉字或者1到50个字母\n 检查正则表达式:/^([\\u3400-\\u4dbf\\u4e00-\\u9fa5.·]{2,25}|[a-zA-Z·,\\s-]{1,50})$/\n\n签署意见控件:\n 约束:签署意见最大长度为50字符\n\n签署人手机号控件:\n 约束:国内手机号 13,14,15,16,17,18,19号段长度11位\n\n签署人身份证控件:\n 约束:合法的身份证号码检查\n\n控件名称:\n 约束:控件名称最大长度为20字符\n\n单行文本控件:\n 约束:只允许输入中文,英文,数字,中英文标点符号\n\n多行文本控件:\n 约束:只允许输入中文,英文,数字,中英文标点符号\n\n勾选框控件:\n 约束:选择填字符串true,不选填字符串false\n\n选择器控件:\n 约束:同单行文本控件约束,填写选择值中的字符串\n\n数字控件:\n 约束:请输入有效的数字(可带小数点) \n 检查正则表达式:/^(-|\\+)?\\d+(\\.\\d+)?$/\n\n日期控件:\n 约束:格式:yyyy年mm月dd日\n\n附件控件:\n 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件\n\n图片控件:\n 约束:JPG或PNG图片,填写上传的图片资源ID\n\n邮箱控件:\n 约束:请输入有效的邮箱地址, w3c标准\n 检查正则表达式:/^([A-Za-z0-9_\\-.!#$%&])+@([A-Za-z0-9_\\-.])+\\.([A-Za-z]{2,4})$/\n 参考:https://emailregex.com/\n\n地址控件:\n 同单行文本控件约束\n\n省市区控件:\n 同单行文本控件约束\n\n性别控件:\n 同单行文本控件约束,填写选择值中的字符串\n\n学历控件:\n 同单行文本控件约束,填写选择值中的字符串",
1330
1334
  "example": "无",
1335
+ "is_base64": false,
1331
1336
  "member": "string",
1332
1337
  "name": "ComponentValue",
1333
1338
  "output_required": true,
@@ -1339,6 +1344,7 @@
1339
1344
  "disabled": false,
1340
1345
  "document": "NORMAL 正常模式,使用坐标制定签署控件位置\nFIELD 表单域,需使用ComponentName指定表单域名称\nKEYWORD 关键字,使用ComponentId指定关键字",
1341
1346
  "example": "无",
1347
+ "is_base64": false,
1342
1348
  "member": "string",
1343
1349
  "name": "GenerateMode",
1344
1350
  "output_required": true,
@@ -1359,8 +1365,9 @@
1359
1365
  },
1360
1366
  {
1361
1367
  "disabled": false,
1362
- "document": "第三方应用集成平台模板控件 id 标识",
1368
+ "document": "第三方应用集成平台模板控件 ID 标识",
1363
1369
  "example": "无",
1370
+ "is_base64": false,
1364
1371
  "member": "string",
1365
1372
  "name": "ChannelComponentId",
1366
1373
  "output_required": true,
@@ -1392,7 +1399,7 @@
1392
1399
  },
1393
1400
  {
1394
1401
  "disabled": false,
1395
- "document": "第三方应用集成中子客企业控件来源。0-平台指定;1-用户自定义",
1402
+ "document": "第三方应用集成中子客企业控件来源。\n0-平台指定;\n1-用户自定义",
1396
1403
  "example": "无",
1397
1404
  "member": "uint64",
1398
1405
  "name": "ChannelComponentSource",
@@ -1403,8 +1410,9 @@
1403
1410
  },
1404
1411
  {
1405
1412
  "disabled": false,
1406
- "document": "指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。\n传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。",
1413
+ "document": "指定关键字排序规则,Positive-正序,Reverse-倒序。\n传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。\n传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。",
1407
1414
  "example": "Positive\\Reverse",
1415
+ "is_base64": false,
1408
1416
  "member": "string",
1409
1417
  "name": "KeywordOrder",
1410
1418
  "output_required": true,
@@ -1414,7 +1422,7 @@
1414
1422
  },
1415
1423
  {
1416
1424
  "disabled": false,
1417
- "document": "指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来",
1425
+ "document": "指定关键字页码。\n指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来",
1418
1426
  "example": "无",
1419
1427
  "member": "int64",
1420
1428
  "name": "KeywordPage",
@@ -1425,8 +1433,9 @@
1425
1433
  },
1426
1434
  {
1427
1435
  "disabled": false,
1428
- "document": "关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方",
1436
+ "document": "关键字位置模式,\nMiddle-居中,\nBelow-正下方,\nRight-正右方,\nLowerRight-右上角,\nUpperRight-右下角。\n示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方",
1429
1437
  "example": "无",
1438
+ "is_base64": false,
1430
1439
  "member": "string",
1431
1440
  "name": "RelativeLocation",
1432
1441
  "output_required": true,
@@ -1436,7 +1445,7 @@
1436
1445
  },
1437
1446
  {
1438
1447
  "disabled": false,
1439
- "document": "关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。",
1448
+ "document": "关键字索引。\n如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。\n示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。",
1440
1449
  "example": "无",
1441
1450
  "member": "int64",
1442
1451
  "name": "KeywordIndexes",
@@ -1444,6 +1453,28 @@
1444
1453
  "required": false,
1445
1454
  "type": "list",
1446
1455
  "value_allowed_null": false
1456
+ },
1457
+ {
1458
+ "disabled": false,
1459
+ "document": "是否锁定控件值不允许编辑(嵌入式发起使用)\n<br/>默认false:不锁定控件值,允许在页面编辑控件值\n注意:此字段可能返回 null,表示取不到有效值。",
1460
+ "example": "无",
1461
+ "member": "bool",
1462
+ "name": "LockComponentValue",
1463
+ "output_required": false,
1464
+ "required": false,
1465
+ "type": "bool",
1466
+ "value_allowed_null": true
1467
+ },
1468
+ {
1469
+ "disabled": false,
1470
+ "document": "是否禁止移动和删除控件\n<br/>默认false,不禁止移动和删除控件\n注意:此字段可能返回 null,表示取不到有效值。",
1471
+ "example": "无",
1472
+ "member": "bool",
1473
+ "name": "ForbidMoveAndDelete",
1474
+ "output_required": false,
1475
+ "required": false,
1476
+ "type": "bool",
1477
+ "value_allowed_null": true
1447
1478
  }
1448
1479
  ],
1449
1480
  "usage": "both"
@@ -1455,6 +1486,7 @@
1455
1486
  "disabled": false,
1456
1487
  "document": "调用方用户信息,userId 必填",
1457
1488
  "example": "无",
1489
+ "is_base64": false,
1458
1490
  "member": "UserInfo",
1459
1491
  "name": "Operator",
1460
1492
  "required": true,
@@ -1462,8 +1494,9 @@
1462
1494
  },
1463
1495
  {
1464
1496
  "disabled": false,
1465
- "document": "需要执行撤回的签署流程id数组,最多100",
1497
+ "document": "需要执行撤回的流程(合同)的编号列表,最多100个.\n列表中的流程(合同)编号不要重复.",
1466
1498
  "example": "无",
1499
+ "is_base64": false,
1467
1500
  "member": "string",
1468
1501
  "name": "FlowIds",
1469
1502
  "required": true,
@@ -1473,6 +1506,7 @@
1473
1506
  "disabled": false,
1474
1507
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填\n",
1475
1508
  "example": "无",
1509
+ "is_base64": false,
1476
1510
  "member": "Agent",
1477
1511
  "name": "Agent",
1478
1512
  "required": false,
@@ -1496,7 +1530,7 @@
1496
1530
  },
1497
1531
  {
1498
1532
  "disabled": false,
1499
- "document": "签署流程撤回失败信息",
1533
+ "document": "签署流程撤回失败信息\n数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错",
1500
1534
  "example": "无",
1501
1535
  "member": "string",
1502
1536
  "name": "FailMessages",
@@ -1506,7 +1540,7 @@
1506
1540
  },
1507
1541
  {
1508
1542
  "disabled": false,
1509
- "document": "签署连接过期时间字符串:年月日-时分秒",
1543
+ "document": "签署连接过期时间字符串:年月日-时分秒\n\n例如:2023-07-28 17:25:59",
1510
1544
  "example": "无",
1511
1545
  "member": "string",
1512
1546
  "name": "UrlExpireOn",
@@ -1790,7 +1824,7 @@
1790
1824
  },
1791
1825
  {
1792
1826
  "disabled": false,
1793
- "document": "WEB嵌入资源类型。\n<br/>CREATE_SEAL: 创建印章\n<br/>PREVIEW_SEAL_LIST:预览印章列表\n<br/>PREVIEW_SEAL_DETAIL:预览印章详情\n<br/>EXTEND_SERVICE:拓展服务\n",
1827
+ "document": "WEB嵌入资源类型。\n<br/>CREATE_SEAL: 创建印章\n<br/>PREVIEW_SEAL_LIST:预览印章列表\n<br/>PREVIEW_SEAL_DETAIL:预览印章详情\n<br/>EXTEND_SERVICE:拓展服务\n<br/>PREVIEW_FLOW:预览合同\n<br/>PREVIEW_FLOW_DETAIL:查看合同详情",
1794
1828
  "example": "无",
1795
1829
  "is_base64": false,
1796
1830
  "member": "string",
@@ -1827,6 +1861,16 @@
1827
1861
  "name": "Reviewer",
1828
1862
  "required": false,
1829
1863
  "type": "object"
1864
+ },
1865
+ {
1866
+ "disabled": false,
1867
+ "document": "个性化参数",
1868
+ "example": "无",
1869
+ "is_base64": false,
1870
+ "member": "EmbedUrlOption",
1871
+ "name": "Option",
1872
+ "required": false,
1873
+ "type": "object"
1830
1874
  }
1831
1875
  ],
1832
1876
  "type": "object"
@@ -2389,6 +2433,94 @@
2389
2433
  ],
2390
2434
  "type": "object"
2391
2435
  },
2436
+ "CreateFlowOption": {
2437
+ "document": "创建合同个性化参数",
2438
+ "members": [
2439
+ {
2440
+ "disabled": false,
2441
+ "document": "是否允许修改发起合同时确认弹窗的合同信息(合同名称、合同类型、签署截止时间),若不允许编辑,则表单字段将被禁止输入。\n<br/>true:允许编辑(默认),<br/>false:不允许编辑<br/>默认:false:不允许编辑",
2442
+ "example": "true",
2443
+ "member": "bool",
2444
+ "name": "CanEditFlow",
2445
+ "required": false,
2446
+ "type": "bool"
2447
+ },
2448
+ {
2449
+ "disabled": false,
2450
+ "document": "是否允许编辑模版控件\n<br/>true:允许编辑模版控件信息\n<br/>false:不允许编辑模版控件信息\n<br/>默认false:不允许编辑模版控件信息",
2451
+ "example": "true",
2452
+ "member": "bool",
2453
+ "name": "CanEditFormField",
2454
+ "required": false,
2455
+ "type": "bool"
2456
+ },
2457
+ {
2458
+ "disabled": false,
2459
+ "document": "发起页面隐藏合同名称展示\n<br/>true:发起页面隐藏合同名称展示\n<br/>false:发起页面不隐藏合同名称展示\n<br/>默认false:发起页面不隐藏合同名称展示",
2460
+ "example": "true",
2461
+ "member": "bool",
2462
+ "name": "HideShowFlowName",
2463
+ "required": false,
2464
+ "type": "bool"
2465
+ },
2466
+ {
2467
+ "disabled": false,
2468
+ "document": "发起页面隐藏合同类型展示\n<br/>true:发起页面隐藏合同类型展示\n<br/>false:发起页面不隐藏合同类型展示\n<br/>默认false:发起页面不隐藏合同类型展示\n",
2469
+ "example": "true",
2470
+ "member": "bool",
2471
+ "name": "HideShowFlowType",
2472
+ "required": false,
2473
+ "type": "bool"
2474
+ },
2475
+ {
2476
+ "disabled": false,
2477
+ "document": "发起页面隐藏合同截止日期展示\n<br/>true:发起页面隐藏合同截止日期展示\n<br/>false:发起页面不隐藏合同截止日期展示\n<br/>默认false:发起页面不隐藏合同截止日期展示",
2478
+ "example": "true",
2479
+ "member": "bool",
2480
+ "name": "HideShowDeadline",
2481
+ "required": false,
2482
+ "type": "bool"
2483
+ },
2484
+ {
2485
+ "disabled": false,
2486
+ "document": "发起页面允许跳过添加签署人环节\n<br/>true:发起页面允许跳过添加签署人环节\n<br/>false:发起页面不允许跳过添加签署人环节\n<br/>默认false:发起页面不允许跳过添加签署人环节\n",
2487
+ "example": "true",
2488
+ "member": "bool",
2489
+ "name": "CanSkipAddApprover",
2490
+ "required": false,
2491
+ "type": "bool"
2492
+ },
2493
+ {
2494
+ "disabled": false,
2495
+ "document": "文件发起页面跳过文件上传步骤\n<br/>true:文件发起页面跳过文件上传步骤\n<br/>false:文件发起页面不跳过文件上传步骤\n<br/>默认false:文件发起页面不跳过文件上传步骤",
2496
+ "example": "true",
2497
+ "member": "bool",
2498
+ "name": "SkipUploadFile",
2499
+ "required": false,
2500
+ "type": "bool"
2501
+ },
2502
+ {
2503
+ "disabled": false,
2504
+ "document": "禁止编辑填写控件\n<br/>true:禁止编辑填写控件\n<br/>false:允许编辑填写控件\n<br/>默认false:允许编辑填写控件",
2505
+ "example": "true",
2506
+ "member": "bool",
2507
+ "name": "ForbidEditFillComponent",
2508
+ "required": false,
2509
+ "type": "bool"
2510
+ },
2511
+ {
2512
+ "disabled": false,
2513
+ "document": "定制化发起合同弹窗的描述信息,描述信息最长500\n",
2514
+ "example": "“”",
2515
+ "is_base64": false,
2516
+ "member": "string",
2517
+ "name": "CustomCreateFlowDescription",
2518
+ "required": false,
2519
+ "type": "string"
2520
+ }
2521
+ ],
2522
+ "usage": "in"
2523
+ },
2392
2524
  "CreateFlowRemindsRequest": {
2393
2525
  "document": "CreateFlowReminds请求参数结构体",
2394
2526
  "members": [
@@ -2632,6 +2764,7 @@
2632
2764
  "disabled": false,
2633
2765
  "document": "调用方用户信息,userId 必填",
2634
2766
  "example": "无",
2767
+ "is_base64": false,
2635
2768
  "member": "UserInfo",
2636
2769
  "name": "Operator",
2637
2770
  "required": true,
@@ -2641,6 +2774,7 @@
2641
2774
  "disabled": false,
2642
2775
  "document": "签署流程编号",
2643
2776
  "example": "无",
2777
+ "is_base64": false,
2644
2778
  "member": "string",
2645
2779
  "name": "FlowId",
2646
2780
  "required": true,
@@ -2650,6 +2784,7 @@
2650
2784
  "disabled": false,
2651
2785
  "document": "企业内部审核结果\nPASS: 通过 \nREJECT: 拒绝",
2652
2786
  "example": "无",
2787
+ "is_base64": false,
2653
2788
  "member": "string",
2654
2789
  "name": "ReviewType",
2655
2790
  "required": true,
@@ -2659,6 +2794,7 @@
2659
2794
  "disabled": false,
2660
2795
  "document": "审核原因 \n当ReviewType 是REJECT 时此字段必填,字符串长度不超过200",
2661
2796
  "example": "无",
2797
+ "is_base64": false,
2662
2798
  "member": "string",
2663
2799
  "name": "ReviewMessage",
2664
2800
  "required": false,
@@ -2668,6 +2804,7 @@
2668
2804
  "disabled": false,
2669
2805
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
2670
2806
  "example": "无",
2807
+ "is_base64": false,
2671
2808
  "member": "Agent",
2672
2809
  "name": "Agent",
2673
2810
  "required": false,
@@ -2677,6 +2814,7 @@
2677
2814
  "disabled": false,
2678
2815
  "document": "审核签署节点使用 非必填 如果填写则审核该签署节点。给个人审核时必填。",
2679
2816
  "example": "无",
2817
+ "is_base64": false,
2680
2818
  "member": "string",
2681
2819
  "name": "RecipientId",
2682
2820
  "required": false,
@@ -2684,8 +2822,9 @@
2684
2822
  },
2685
2823
  {
2686
2824
  "disabled": false,
2687
- "document": "操作类型:(接口通过该字段区分操作类型)\n\nSignReview:签署审核\nCreateReview:发起审核\n\n默认:SignReview;SignReview:签署审核\n\n该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程\n若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)",
2825
+ "document": "操作类型:(接口通过该字段区分操作类型)\n\nSignReview:签署审核\nCreateReview:发起审核\n\n默认:SignReview;SignReview:签署审核\n\n该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程\n若发起个人审核,则指定该字段为:SignReview",
2688
2826
  "example": "无",
2827
+ "is_base64": false,
2689
2828
  "member": "string",
2690
2829
  "name": "OperateType",
2691
2830
  "required": false,
@@ -3253,7 +3392,7 @@
3253
3392
  },
3254
3393
  {
3255
3394
  "disabled": false,
3256
- "document": "是否顺序签署(true:无序签,false:顺序签)",
3395
+ "document": "是否顺序签署\ntrue:无序签\nfalse:顺序签",
3257
3396
  "example": "true",
3258
3397
  "is_base64": false,
3259
3398
  "member": "bool",
@@ -3263,7 +3402,7 @@
3263
3402
  },
3264
3403
  {
3265
3404
  "disabled": false,
3266
- "document": "签署流程的签署截止时间。\n值为unix时间戳,精确到秒,不传默认为当前时间一年后",
3405
+ "document": "签署流程的签署截止时间。\n值为unix时间戳,精确到秒\n不传默认为当前时间一年后",
3267
3406
  "example": "无",
3268
3407
  "is_base64": false,
3269
3408
  "member": "int64",
@@ -3273,7 +3412,7 @@
3273
3412
  },
3274
3413
  {
3275
3414
  "disabled": false,
3276
- "document": "用户自定义合同类型",
3415
+ "document": "用户自定义合同类型Id\n该id为电子签企业内的合同类型id",
3277
3416
  "example": "无",
3278
3417
  "is_base64": false,
3279
3418
  "member": "string",
@@ -3293,7 +3432,7 @@
3293
3432
  },
3294
3433
  {
3295
3434
  "disabled": false,
3296
- "document": "打开智能添加填写区(默认开启,打开:\"OPEN\" 关闭:\"CLOSE\")",
3435
+ "document": "打开智能添加填写区\n(默认开启,打开:\"OPEN\"\n 关闭:\"CLOSE\"",
3297
3436
  "example": "OPEN",
3298
3437
  "is_base64": false,
3299
3438
  "member": "string",
@@ -3301,6 +3440,86 @@
3301
3440
  "required": false,
3302
3441
  "type": "string"
3303
3442
  },
3443
+ {
3444
+ "disabled": false,
3445
+ "document": "资源类型,\n1:文件,\n2:模板\n不传默认为1:文件\n目前仅支持文件",
3446
+ "example": "1",
3447
+ "is_base64": false,
3448
+ "member": "int64",
3449
+ "name": "ResourceType",
3450
+ "required": false,
3451
+ "type": "int"
3452
+ },
3453
+ {
3454
+ "disabled": false,
3455
+ "document": "发起方填写控件\n该类型控件由发起方完成填写",
3456
+ "example": "无",
3457
+ "is_base64": false,
3458
+ "member": "Component",
3459
+ "name": "Components",
3460
+ "required": false,
3461
+ "type": "object"
3462
+ },
3463
+ {
3464
+ "disabled": false,
3465
+ "document": "发起合同个性化参数\n用于满足创建及页面操作过程中的个性化要求\n具体定制化内容详见数据接口说明",
3466
+ "example": "无",
3467
+ "is_base64": false,
3468
+ "member": "CreateFlowOption",
3469
+ "name": "FlowOption",
3470
+ "required": false,
3471
+ "type": "object"
3472
+ },
3473
+ {
3474
+ "disabled": false,
3475
+ "document": "是否开启发起方签署审核\ntrue:开启发起方签署审核\nfalse:不开启发起方签署审核\n默认false:不开启发起方签署审核",
3476
+ "example": "无",
3477
+ "is_base64": false,
3478
+ "member": "bool",
3479
+ "name": "NeedSignReview",
3480
+ "required": false,
3481
+ "type": "bool"
3482
+ },
3483
+ {
3484
+ "disabled": false,
3485
+ "document": "开启发起方发起合同审核\ntrue:开启发起方发起合同审核\nfalse:不开启发起方发起合同审核\n默认false:不开启发起方发起合同审核",
3486
+ "example": "无",
3487
+ "is_base64": false,
3488
+ "member": "bool",
3489
+ "name": "NeedCreateReview",
3490
+ "required": false,
3491
+ "type": "bool"
3492
+ },
3493
+ {
3494
+ "disabled": false,
3495
+ "document": "用户自定义参数",
3496
+ "example": "无",
3497
+ "is_base64": false,
3498
+ "member": "string",
3499
+ "name": "UserData",
3500
+ "required": false,
3501
+ "type": "string"
3502
+ },
3503
+ {
3504
+ "disabled": false,
3505
+ "document": "合同id,用于通过已web页面发起的合同id快速生成一个web发起合同链接",
3506
+ "example": "无",
3507
+ "is_base64": false,
3508
+ "member": "string",
3509
+ "name": "FlowId",
3510
+ "required": false,
3511
+ "type": "string"
3512
+ },
3513
+ {
3514
+ "disabled": false,
3515
+ "document": "合同类型名称\n该字段用于客户自定义合同类型\n建议使用时指定合同类型,便于之后合同分类以及查看",
3516
+ "example": "\"劳动合同\"",
3517
+ "is_base64": false,
3518
+ "member": "string",
3519
+ "name": "FlowType",
3520
+ "required": false,
3521
+ "type": "string"
3522
+ },
3304
3523
  {
3305
3524
  "disabled": false,
3306
3525
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填\t",
@@ -3478,6 +3697,7 @@
3478
3697
  "disabled": false,
3479
3698
  "document": "调用方用户信息,userId 必填",
3480
3699
  "example": "无",
3700
+ "is_base64": false,
3481
3701
  "member": "UserInfo",
3482
3702
  "name": "Operator",
3483
3703
  "required": true,
@@ -3487,6 +3707,7 @@
3487
3707
  "disabled": false,
3488
3708
  "document": "待解除的签署流程编号(即原签署流程的编号)",
3489
3709
  "example": "无",
3710
+ "is_base64": false,
3490
3711
  "member": "string",
3491
3712
  "name": "NeedRelievedFlowId",
3492
3713
  "required": true,
@@ -3496,6 +3717,7 @@
3496
3717
  "disabled": false,
3497
3718
  "document": "解除协议内容",
3498
3719
  "example": "无",
3720
+ "is_base64": false,
3499
3721
  "member": "RelieveInfo",
3500
3722
  "name": "ReliveInfo",
3501
3723
  "required": true,
@@ -3505,6 +3727,7 @@
3505
3727
  "disabled": false,
3506
3728
  "document": "非必须,解除协议的本企业签署人列表,\n默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人\n解除协议的签署人数量不能多于原流程的签署人数量",
3507
3729
  "example": "无",
3730
+ "is_base64": false,
3508
3731
  "member": "ReleasedApprover",
3509
3732
  "name": "ReleasedApprovers",
3510
3733
  "required": false,
@@ -3514,6 +3737,7 @@
3514
3737
  "disabled": false,
3515
3738
  "document": "签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后",
3516
3739
  "example": "1604912664",
3740
+ "is_base64": false,
3517
3741
  "member": "int64",
3518
3742
  "name": "Deadline",
3519
3743
  "required": false,
@@ -3523,6 +3747,7 @@
3523
3747
  "disabled": false,
3524
3748
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
3525
3749
  "example": "无",
3750
+ "is_base64": false,
3526
3751
  "member": "Agent",
3527
3752
  "name": "Agent",
3528
3753
  "required": false,
@@ -3618,7 +3843,7 @@
3618
3843
  },
3619
3844
  {
3620
3845
  "disabled": false,
3621
- "document": "合同组ID",
3846
+ "document": "合同组ID ",
3622
3847
  "example": "无",
3623
3848
  "is_base64": false,
3624
3849
  "member": "string",
@@ -3638,7 +3863,7 @@
3638
3863
  },
3639
3864
  {
3640
3865
  "disabled": false,
3641
- "document": "是否自动回跳 true:是, false:否。该参数只针对\"APP\" 类型的签署链接有效",
3866
+ "document": "是否自动回跳\ntrue:是,\nfalse:否。\n该参数只针对\"APP\" 类型的签署链接有效",
3642
3867
  "example": "false",
3643
3868
  "is_base64": false,
3644
3869
  "member": "bool",
@@ -3984,6 +4209,7 @@
3984
4209
  "disabled": false,
3985
4210
  "document": "操作人信息,UserId必填",
3986
4211
  "example": "无",
4212
+ "is_base64": false,
3987
4213
  "member": "UserInfo",
3988
4214
  "name": "Operator",
3989
4215
  "required": true,
@@ -3993,6 +4219,7 @@
3993
4219
  "disabled": false,
3994
4220
  "document": "自动签场景:\nE_PRESCRIPTION_AUTO_SIGN 电子处方",
3995
4221
  "example": "无",
4222
+ "is_base64": false,
3996
4223
  "member": "string",
3997
4224
  "name": "SceneKey",
3998
4225
  "required": true,
@@ -4002,6 +4229,7 @@
4002
4229
  "disabled": false,
4003
4230
  "document": "自动签开通,签署相关配置",
4004
4231
  "example": "无",
4232
+ "is_base64": false,
4005
4233
  "member": "AutoSignConfig",
4006
4234
  "name": "AutoSignConfig",
4007
4235
  "required": true,
@@ -4009,8 +4237,9 @@
4009
4237
  },
4010
4238
  {
4011
4239
  "disabled": false,
4012
- "document": "链接类型,空-默认小程序端链接,H5SIGN-h5端链接",
4240
+ "document": "链接类型,\n空-默认小程序端链接\nH5SIGN-h5端链接",
4013
4241
  "example": "无",
4242
+ "is_base64": false,
4014
4243
  "member": "string",
4015
4244
  "name": "UrlType",
4016
4245
  "required": false,
@@ -4018,8 +4247,9 @@
4018
4247
  },
4019
4248
  {
4020
4249
  "disabled": false,
4021
- "document": "通知类型,默认不填为不通知开通方,填写 SMS 为短信通知。",
4250
+ "document": "通知类型\n\n默认不设置为不通知开通方,\nSMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。",
4022
4251
  "example": "无",
4252
+ "is_base64": false,
4023
4253
  "member": "string",
4024
4254
  "name": "NotifyType",
4025
4255
  "required": false,
@@ -4027,8 +4257,9 @@
4027
4257
  },
4028
4258
  {
4029
4259
  "disabled": false,
4030
- "document": "若上方填写为 SMS,则此处为手机号",
4260
+ "document": "如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项",
4031
4261
  "example": "无",
4262
+ "is_base64": false,
4032
4263
  "member": "string",
4033
4264
  "name": "NotifyAddress",
4034
4265
  "required": false,
@@ -4038,6 +4269,7 @@
4038
4269
  "disabled": false,
4039
4270
  "document": "链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为30天。如果不传,默认有效期为7天。",
4040
4271
  "example": "无",
4272
+ "is_base64": false,
4041
4273
  "member": "int64",
4042
4274
  "name": "ExpiredTime",
4043
4275
  "required": false,
@@ -4047,6 +4279,7 @@
4047
4279
  "disabled": false,
4048
4280
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
4049
4281
  "example": "无",
4282
+ "is_base64": false,
4050
4283
  "member": "Agent",
4051
4284
  "name": "Agent",
4052
4285
  "required": false,
@@ -4100,7 +4333,7 @@
4100
4333
  },
4101
4334
  {
4102
4335
  "disabled": false,
4103
- "document": "base64格式跳转二维码",
4336
+ "document": "base64格式跳转二维码,可以通过微信扫描后跳转到业务界面",
4104
4337
  "example": "无",
4105
4338
  "member": "string",
4106
4339
  "name": "QrCode",
@@ -4432,29 +4665,31 @@
4432
4665
  "document": "集成版员工部门信息",
4433
4666
  "members": [
4434
4667
  {
4435
- "default": "",
4436
4668
  "disabled": false,
4437
4669
  "document": "部门id",
4438
4670
  "example": "无",
4671
+ "is_base64": false,
4439
4672
  "member": "string",
4440
4673
  "name": "DepartmentId",
4441
- "required": true,
4674
+ "output_required": true,
4675
+ "required": false,
4442
4676
  "type": "string",
4443
4677
  "value_allowed_null": false
4444
4678
  },
4445
4679
  {
4446
- "default": "",
4447
4680
  "disabled": false,
4448
4681
  "document": "部门名称",
4449
4682
  "example": "无",
4683
+ "is_base64": false,
4450
4684
  "member": "string",
4451
4685
  "name": "DepartmentName",
4452
- "required": true,
4686
+ "output_required": true,
4687
+ "required": false,
4453
4688
  "type": "string",
4454
4689
  "value_allowed_null": false
4455
4690
  }
4456
4691
  ],
4457
- "usage": "out"
4692
+ "usage": "both"
4458
4693
  },
4459
4694
  "DescribeExtendedServiceAuthInfosRequest": {
4460
4695
  "document": "DescribeExtendedServiceAuthInfos请求参数结构体",
@@ -4654,6 +4889,7 @@
4654
4889
  "disabled": false,
4655
4890
  "document": "调用方用户信息,userId 必填",
4656
4891
  "example": "无",
4892
+ "is_base64": false,
4657
4893
  "member": "UserInfo",
4658
4894
  "name": "Operator",
4659
4895
  "required": true,
@@ -4663,6 +4899,7 @@
4663
4899
  "disabled": false,
4664
4900
  "document": "需要查询的流程ID列表,限制最大100个",
4665
4901
  "example": "无",
4902
+ "is_base64": false,
4666
4903
  "member": "string",
4667
4904
  "name": "FlowIds",
4668
4905
  "required": true,
@@ -4672,6 +4909,7 @@
4672
4909
  "disabled": false,
4673
4910
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
4674
4911
  "example": "无",
4912
+ "is_base64": false,
4675
4913
  "member": "Agent",
4676
4914
  "name": "Agent",
4677
4915
  "required": false,
@@ -4689,6 +4927,7 @@
4689
4927
  "example": "无",
4690
4928
  "member": "FlowBrief",
4691
4929
  "name": "FlowBriefs",
4930
+ "output_required": true,
4692
4931
  "type": "list",
4693
4932
  "value_allowed_null": false
4694
4933
  },
@@ -4762,6 +5001,7 @@
4762
5001
  "disabled": false,
4763
5002
  "document": "调用方用户信息,userId 必填",
4764
5003
  "example": "无",
5004
+ "is_base64": false,
4765
5005
  "member": "UserInfo",
4766
5006
  "name": "Operator",
4767
5007
  "required": true,
@@ -4771,6 +5011,7 @@
4771
5011
  "disabled": false,
4772
5012
  "document": "出证报告编号",
4773
5013
  "example": "无",
5014
+ "is_base64": false,
4774
5015
  "member": "string",
4775
5016
  "name": "ReportId",
4776
5017
  "required": true,
@@ -4780,6 +5021,7 @@
4780
5021
  "disabled": false,
4781
5022
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填\n",
4782
5023
  "example": "无",
5024
+ "is_base64": false,
4783
5025
  "member": "Agent",
4784
5026
  "name": "Agent",
4785
5027
  "required": false,
@@ -4793,7 +5035,7 @@
4793
5035
  "members": [
4794
5036
  {
4795
5037
  "disabled": false,
4796
- "document": "报告 URL\n注意:此字段可能返回 null,表示取不到有效值。",
5038
+ "document": "出证报告PDF的下载 URL\n注意:此字段可能返回 null,表示取不到有效值。",
4797
5039
  "example": "https://file.xxx",
4798
5040
  "member": "string",
4799
5041
  "name": "ReportUrl",
@@ -4803,7 +5045,7 @@
4803
5045
  },
4804
5046
  {
4805
5047
  "disabled": false,
4806
- "document": "执行中:EvidenceStatusExecuting\n成功:EvidenceStatusSuccess\n失败:EvidenceStatusFailed",
5048
+ "document": "出证任务执行的状态, 分布表示下面的含义\n\nEvidenceStatusExecuting 出证任务在执行中\nEvidenceStatusSuccess 出证任务执行成功\nEvidenceStatusFailed 出征任务执行失败",
4807
5049
  "example": "EvidenceStatusExecuting",
4808
5050
  "member": "string",
4809
5051
  "name": "Status",
@@ -4827,6 +5069,7 @@
4827
5069
  "disabled": false,
4828
5070
  "document": "调用方用户信息,userId 必填",
4829
5071
  "example": "无",
5072
+ "is_base64": false,
4830
5073
  "member": "UserInfo",
4831
5074
  "name": "Operator",
4832
5075
  "required": false,
@@ -4834,8 +5077,9 @@
4834
5077
  },
4835
5078
  {
4836
5079
  "disabled": false,
4837
- "document": "需要查询的流程ID列表,限制最大100",
5080
+ "document": "需要查询的流程ID列表,限制最大100个\n\n如果查询合同组的信息,不要传此参数",
4838
5081
  "example": "无",
5082
+ "is_base64": false,
4839
5083
  "member": "string",
4840
5084
  "name": "FlowIds",
4841
5085
  "required": false,
@@ -4845,6 +5089,7 @@
4845
5089
  "disabled": false,
4846
5090
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
4847
5091
  "example": "无",
5092
+ "is_base64": false,
4848
5093
  "member": "Agent",
4849
5094
  "name": "Agent",
4850
5095
  "required": false,
@@ -4852,8 +5097,9 @@
4852
5097
  },
4853
5098
  {
4854
5099
  "disabled": false,
4855
- "document": "合同组ID",
5100
+ "document": "合同组ID, 如果传此参数会忽略FlowIds入参\n 所以如传此参数不要传FlowIds参数\n",
4856
5101
  "example": "无",
5102
+ "is_base64": false,
4857
5103
  "member": "string",
4858
5104
  "name": "FlowGroupId",
4859
5105
  "required": false,
@@ -4909,7 +5155,7 @@
4909
5155
  "members": [
4910
5156
  {
4911
5157
  "disabled": false,
4912
- "document": "调用方员工/经办人信息\nUserId 必填,在企业控制台组织架构中可以查到员工的UserId\n注:请保证对应",
5158
+ "document": "调用方员工/经办人信息\nUserId 必填,在企业控制台组织架构中可以查到员工的UserId\n注:请保证员工有相关的角色权限",
4913
5159
  "example": "无",
4914
5160
  "is_base64": false,
4915
5161
  "member": "UserInfo",
@@ -5630,6 +5876,7 @@
5630
5876
  "disabled": false,
5631
5877
  "document": "操作人信息,UserId必填",
5632
5878
  "example": "无",
5879
+ "is_base64": false,
5633
5880
  "member": "UserInfo",
5634
5881
  "name": "Operator",
5635
5882
  "required": true,
@@ -5639,6 +5886,7 @@
5639
5886
  "disabled": false,
5640
5887
  "document": "自动签场景:\nE_PRESCRIPTION_AUTO_SIGN 电子处方",
5641
5888
  "example": "无",
5889
+ "is_base64": false,
5642
5890
  "member": "string",
5643
5891
  "name": "SceneKey",
5644
5892
  "required": true,
@@ -5646,8 +5894,9 @@
5646
5894
  },
5647
5895
  {
5648
5896
  "disabled": false,
5649
- "document": "查询开启状态的用户信息",
5897
+ "document": "要查询开启状态的用户信息",
5650
5898
  "example": "无",
5899
+ "is_base64": false,
5651
5900
  "member": "UserThreeFactor",
5652
5901
  "name": "UserInfo",
5653
5902
  "required": true,
@@ -5657,6 +5906,7 @@
5657
5906
  "disabled": false,
5658
5907
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填",
5659
5908
  "example": "无",
5909
+ "is_base64": false,
5660
5910
  "member": "Agent",
5661
5911
  "name": "Agent",
5662
5912
  "required": false,
@@ -5670,7 +5920,7 @@
5670
5920
  "members": [
5671
5921
  {
5672
5922
  "disabled": false,
5673
- "document": "是否已开通自动签",
5923
+ "document": "查询用户是否已开通自动签",
5674
5924
  "example": "无",
5675
5925
  "member": "bool",
5676
5926
  "name": "IsOpen",
@@ -5680,7 +5930,7 @@
5680
5930
  },
5681
5931
  {
5682
5932
  "disabled": false,
5683
- "document": "自动签许可生效时间。当且仅当已开通自动签时有值。",
5933
+ "document": "自动签许可生效时间。当且仅当已开通自动签时有值。\n\n值为unix时间戳,单位为秒。",
5684
5934
  "example": "1684412179",
5685
5935
  "member": "int64",
5686
5936
  "name": "LicenseFrom",
@@ -5690,7 +5940,7 @@
5690
5940
  },
5691
5941
  {
5692
5942
  "disabled": false,
5693
- "document": "自动签许可到期时间。当且仅当已开通自动签时有值。",
5943
+ "document": "自动签许可到期时间。当且仅当已开通自动签时有值。\n值为unix时间戳,单位为秒。",
5694
5944
  "example": "1715948179",
5695
5945
  "member": "int64",
5696
5946
  "name": "LicenseTo",
@@ -5761,6 +6011,30 @@
5761
6011
  ],
5762
6012
  "type": "object"
5763
6013
  },
6014
+ "EmbedUrlOption": {
6015
+ "document": "个性化参数",
6016
+ "members": [
6017
+ {
6018
+ "disabled": false,
6019
+ "document": "合同详情预览,允许展示控件信息\n<br/>true:允许在合同详情页展示控件\n<br/>false:不允许在合同详情页展示控件\n<br/>默认false,合同详情页不展示控件",
6020
+ "example": "true",
6021
+ "member": "bool",
6022
+ "name": "ShowFlowDetailComponent",
6023
+ "required": false,
6024
+ "type": "bool"
6025
+ },
6026
+ {
6027
+ "disabled": false,
6028
+ "document": "模版预览,允许展示模版控件信息\n<br/>true:允许在模版预览页展示控件\n<br/>false:不允许在模版预览页展示控件\n<br/>默认false,模版预览页不展示控件",
6029
+ "example": "true",
6030
+ "member": "bool",
6031
+ "name": "ShowTemplateComponent",
6032
+ "required": false,
6033
+ "type": "bool"
6034
+ }
6035
+ ],
6036
+ "usage": "in"
6037
+ },
5764
6038
  "ExtendAuthInfo": {
5765
6039
  "document": "授权服务信息",
5766
6040
  "members": [
@@ -5999,7 +6273,7 @@
5999
6273
  "members": [
6000
6274
  {
6001
6275
  "disabled": false,
6002
- "document": "文件Id",
6276
+ "document": "文件ID",
6003
6277
  "example": "无",
6004
6278
  "is_base64": false,
6005
6279
  "member": "string",
@@ -6034,7 +6308,7 @@
6034
6308
  },
6035
6309
  {
6036
6310
  "disabled": false,
6037
- "document": "文件上传时间,10位时间戳(精确到秒)",
6311
+ "document": "文件上传时间,格式为Unix标准时间戳(秒)",
6038
6312
  "example": "无",
6039
6313
  "member": "int64",
6040
6314
  "name": "CreatedOn",
@@ -6073,7 +6347,7 @@
6073
6347
  "usage": "out"
6074
6348
  },
6075
6349
  "FillApproverInfo": {
6076
- "document": "补充签署人信息\n- RecipientId 必须指定\n- 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填\n- 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填",
6350
+ "document": "补充签署人信息\n- RecipientId 必须指定\n- 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP\n- 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空",
6077
6351
  "members": [
6078
6352
  {
6079
6353
  "disabled": false,
@@ -6087,7 +6361,7 @@
6087
6361
  },
6088
6362
  {
6089
6363
  "disabled": false,
6090
- "document": "签署人来源\nWEWORKAPP: 企业微信",
6364
+ "document": "签署人来源\nWEWORKAPP: 企业微信\n<br/>仅【企微或签】时指定WEWORKAPP",
6091
6365
  "example": "WEWORKAPP",
6092
6366
  "is_base64": false,
6093
6367
  "member": "string",
@@ -6097,7 +6371,7 @@
6097
6371
  },
6098
6372
  {
6099
6373
  "disabled": false,
6100
- "document": "企业自定义账号ID\nWEWORKAPP场景下指企业自有应用获取企微明文的userid",
6374
+ "document": "企业自定义账号ID\n<br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid",
6101
6375
  "example": "zhangsan",
6102
6376
  "is_base64": false,
6103
6377
  "member": "string",
@@ -6421,7 +6695,7 @@
6421
6695
  "example": "xxx",
6422
6696
  "member": "string",
6423
6697
  "name": "FlowId",
6424
- "required": true,
6698
+ "output_required": true,
6425
6699
  "type": "string",
6426
6700
  "value_allowed_null": false
6427
6701
  },
@@ -6431,7 +6705,7 @@
6431
6705
  "example": "xxx",
6432
6706
  "member": "string",
6433
6707
  "name": "FlowName",
6434
- "required": true,
6708
+ "output_required": true,
6435
6709
  "type": "string",
6436
6710
  "value_allowed_null": false
6437
6711
  },
@@ -6441,7 +6715,7 @@
6441
6715
  "example": "xxx",
6442
6716
  "member": "string",
6443
6717
  "name": "FlowDescription",
6444
- "required": true,
6718
+ "output_required": true,
6445
6719
  "type": "string",
6446
6720
  "value_allowed_null": true
6447
6721
  },
@@ -6451,7 +6725,7 @@
6451
6725
  "example": "xxx",
6452
6726
  "member": "string",
6453
6727
  "name": "FlowType",
6454
- "required": true,
6728
+ "output_required": true,
6455
6729
  "type": "string",
6456
6730
  "value_allowed_null": false
6457
6731
  },
@@ -6461,7 +6735,7 @@
6461
6735
  "example": "xxx",
6462
6736
  "member": "int64",
6463
6737
  "name": "FlowStatus",
6464
- "required": true,
6738
+ "output_required": true,
6465
6739
  "type": "int",
6466
6740
  "value_allowed_null": true
6467
6741
  },
@@ -6471,17 +6745,17 @@
6471
6745
  "example": "0",
6472
6746
  "member": "int64",
6473
6747
  "name": "CreatedOn",
6474
- "required": true,
6748
+ "output_required": true,
6475
6749
  "type": "int",
6476
6750
  "value_allowed_null": true
6477
6751
  },
6478
6752
  {
6479
6753
  "disabled": false,
6480
- "document": "拒签或者取消的原因描述\n注意:此字段可能返回 null,表示取不到有效值。",
6754
+ "document": "当合同被拒签或者取消后(当FlowStatus=3或者FlowStatus=6的时候)\n此字段展示拒签或者取消的原因描述\n\n注意:此字段可能返回 null,表示取不到有效值。",
6481
6755
  "example": "xxx",
6482
6756
  "member": "string",
6483
6757
  "name": "FlowMessage",
6484
- "required": true,
6758
+ "output_required": true,
6485
6759
  "type": "string",
6486
6760
  "value_allowed_null": true
6487
6761
  },
@@ -6491,7 +6765,7 @@
6491
6765
  "example": "无",
6492
6766
  "member": "string",
6493
6767
  "name": "Creator",
6494
- "required": false,
6768
+ "output_required": true,
6495
6769
  "type": "string",
6496
6770
  "value_allowed_null": true
6497
6771
  },
@@ -6501,7 +6775,7 @@
6501
6775
  "example": "无",
6502
6776
  "member": "int64",
6503
6777
  "name": "Deadline",
6504
- "required": false,
6778
+ "output_required": true,
6505
6779
  "type": "int",
6506
6780
  "value_allowed_null": true
6507
6781
  }
@@ -6522,7 +6796,7 @@
6522
6796
  },
6523
6797
  {
6524
6798
  "disabled": false,
6525
- "document": "如果签署方为企业,需要填入企业全称",
6799
+ "document": "签署人企业名称\n<br/>当approverType=1 或 approverType=3时,必须指定\n\n",
6526
6800
  "example": "无",
6527
6801
  "is_base64": false,
6528
6802
  "member": "string",
@@ -6532,7 +6806,7 @@
6532
6806
  },
6533
6807
  {
6534
6808
  "disabled": false,
6535
- "document": "签署方经办人姓名",
6809
+ "document": "签署方经办人姓名\n<br/>在未指定签署人电子签UserId情况下,为必填参数",
6536
6810
  "example": "无",
6537
6811
  "is_base64": false,
6538
6812
  "member": "string",
@@ -6542,7 +6816,7 @@
6542
6816
  },
6543
6817
  {
6544
6818
  "disabled": false,
6545
- "document": "签署方经办人手机号码",
6819
+ "document": "签署方经办人手机号码\n<br/>在未指定签署人电子签UserId情况下,为必填参数\n",
6546
6820
  "example": "无",
6547
6821
  "is_base64": false,
6548
6822
  "member": "string",
@@ -6572,7 +6846,7 @@
6572
6846
  },
6573
6847
  {
6574
6848
  "disabled": false,
6575
- "document": "签署方经办人在模板中的参与方ID",
6849
+ "document": "签署方经办人在模板中的参与方ID\n<br/>模版发起合同时,该参数为必填项\n<br/>文件发起合同是,该参数无序传值\n",
6576
6850
  "example": "无",
6577
6851
  "is_base64": false,
6578
6852
  "member": "string",
@@ -6592,7 +6866,7 @@
6592
6866
  },
6593
6867
  {
6594
6868
  "disabled": false,
6595
- "document": "是否发送短信,sms--短信通知,none--不通知,默认为sms;发起方=签署方时不发送短信",
6869
+ "document": "是否发送短信\n<br/>sms--短信通知\n<br/>none--不通知\n<br/>默认为sms\n<br/>发起方=签署方时不发送短信",
6596
6870
  "example": "无",
6597
6871
  "is_base64": false,
6598
6872
  "member": "string",
@@ -6620,7 +6894,7 @@
6620
6894
  },
6621
6895
  {
6622
6896
  "disabled": false,
6623
- "document": "签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个。",
6897
+ "document": "签署方经办人的电子签用户ID\n<br/>当未指定签署人姓名+手机号的情况下,该字段毕传\n",
6624
6898
  "example": "无",
6625
6899
  "is_base64": false,
6626
6900
  "member": "string",
@@ -6639,7 +6913,7 @@
6639
6913
  },
6640
6914
  {
6641
6915
  "disabled": false,
6642
- "document": "签署人用户来源,企微侧用户请传入:WEWORKAPP",
6916
+ "document": "签署人用户来源\n<br/>企微侧用户请传入:WEWORKAPP",
6643
6917
  "example": "无",
6644
6918
  "is_base64": false,
6645
6919
  "member": "string",
@@ -6649,7 +6923,7 @@
6649
6923
  },
6650
6924
  {
6651
6925
  "disabled": false,
6652
- "document": "企业签署方或签标识,客户自定义,64位长度。用于发起含有或签签署人的合同。或签参与人必须有此字段。合同内不同或签参与人CustomApproverTag需要保证唯一。如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP",
6926
+ "document": "企业签署方或签标识,客户自定义,64位长度\n<br>用于发起含有或签签署人的合同。或签参与人必须有此字段。\n<br/>合同内不同或签参与人CustomApproverTag需要保证唯一。\n<br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP",
6653
6927
  "example": "无",
6654
6928
  "is_base64": false,
6655
6929
  "member": "string",
@@ -6697,7 +6971,7 @@
6697
6971
  },
6698
6972
  {
6699
6973
  "disabled": false,
6700
- "document": "当前签署方进行签署操作是否需要企业内部审批,true 则为需要。为个人签署方时则由发起方企业审核。",
6974
+ "document": "当前签署方进行签署操作是否需要企业内部审批\n<br>true 则为需要\n<br/>false,无序企业内部审批(默认)\n<br/>为个人签署方时则由发起方企业审核。",
6701
6975
  "example": "无",
6702
6976
  "member": "bool",
6703
6977
  "name": "ApproverNeedSignReview",
@@ -6706,7 +6980,7 @@
6706
6980
  },
6707
6981
  {
6708
6982
  "disabled": false,
6709
- "document": "签署人签署控件",
6983
+ "document": "签署人签署控件\n<br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置",
6710
6984
  "example": "无",
6711
6985
  "member": "Component",
6712
6986
  "name": "SignComponents",
@@ -6715,7 +6989,7 @@
6715
6989
  },
6716
6990
  {
6717
6991
  "disabled": false,
6718
- "document": "签署人填写控件",
6992
+ "document": "签署人填写控件\n<br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置",
6719
6993
  "example": "无",
6720
6994
  "member": "Component",
6721
6995
  "name": "Components",
@@ -7056,8 +7330,9 @@
7056
7330
  "members": [
7057
7331
  {
7058
7332
  "disabled": false,
7059
- "document": "任务Id,通过CreateConvertTaskApi得到",
7333
+ "document": "任务Id,通过接口CreateConvertTaskApi或CreateMergeFileTask得到的返回任务id",
7060
7334
  "example": "无",
7335
+ "is_base64": false,
7061
7336
  "member": "string",
7062
7337
  "name": "TaskId",
7063
7338
  "required": true,
@@ -7067,6 +7342,7 @@
7067
7342
  "disabled": false,
7068
7343
  "document": "操作人信息,UserId必填",
7069
7344
  "example": "无",
7345
+ "is_base64": false,
7070
7346
  "member": "UserInfo",
7071
7347
  "name": "Operator",
7072
7348
  "required": false,
@@ -7076,6 +7352,7 @@
7076
7352
  "disabled": true,
7077
7353
  "document": "应用号信息",
7078
7354
  "example": "无",
7355
+ "is_base64": false,
7079
7356
  "member": "Agent",
7080
7357
  "name": "Agent",
7081
7358
  "required": false,
@@ -7085,6 +7362,7 @@
7085
7362
  "disabled": true,
7086
7363
  "document": "暂未开放",
7087
7364
  "example": "无",
7365
+ "is_base64": false,
7088
7366
  "member": "OrganizationInfo",
7089
7367
  "name": "Organization",
7090
7368
  "required": false,
@@ -7102,6 +7380,7 @@
7102
7380
  "example": "无",
7103
7381
  "member": "string",
7104
7382
  "name": "TaskId",
7383
+ "output_required": true,
7105
7384
  "type": "string",
7106
7385
  "value_allowed_null": false
7107
7386
  },
@@ -7111,6 +7390,7 @@
7111
7390
  "example": "无",
7112
7391
  "member": "int64",
7113
7392
  "name": "TaskStatus",
7393
+ "output_required": true,
7114
7394
  "type": "int",
7115
7395
  "value_allowed_null": false
7116
7396
  },
@@ -7120,15 +7400,17 @@
7120
7400
  "example": "无",
7121
7401
  "member": "string",
7122
7402
  "name": "TaskMessage",
7403
+ "output_required": true,
7123
7404
  "type": "string",
7124
7405
  "value_allowed_null": false
7125
7406
  },
7126
7407
  {
7127
7408
  "disabled": false,
7128
- "document": "资源Id,也是FileId,用于文件发起使用",
7409
+ "document": "资源Id,也是FileId,用于文件发起时使用",
7129
7410
  "example": "无",
7130
7411
  "member": "string",
7131
7412
  "name": "ResourceId",
7413
+ "output_required": true,
7132
7414
  "type": "string",
7133
7415
  "value_allowed_null": false
7134
7416
  },
@@ -7752,7 +8034,7 @@
7752
8034
  "example": "无",
7753
8035
  "member": "int64",
7754
8036
  "name": "VerifyResult",
7755
- "required": true,
8037
+ "output_required": true,
7756
8038
  "type": "int",
7757
8039
  "value_allowed_null": false
7758
8040
  },
@@ -7762,7 +8044,7 @@
7762
8044
  "example": "无",
7763
8045
  "member": "string",
7764
8046
  "name": "SignPlatform",
7765
- "required": true,
8047
+ "output_required": true,
7766
8048
  "type": "string",
7767
8049
  "value_allowed_null": false
7768
8050
  },
@@ -7772,7 +8054,7 @@
7772
8054
  "example": "无",
7773
8055
  "member": "string",
7774
8056
  "name": "SignerName",
7775
- "required": true,
8057
+ "output_required": true,
7776
8058
  "type": "string",
7777
8059
  "value_allowed_null": false
7778
8060
  },
@@ -7782,7 +8064,7 @@
7782
8064
  "example": "无",
7783
8065
  "member": "int64",
7784
8066
  "name": "SignTime",
7785
- "required": true,
8067
+ "output_required": true,
7786
8068
  "type": "int",
7787
8069
  "value_allowed_null": false
7788
8070
  },
@@ -7792,7 +8074,7 @@
7792
8074
  "example": "无",
7793
8075
  "member": "string",
7794
8076
  "name": "SignAlgorithm",
7795
- "required": true,
8077
+ "output_required": true,
7796
8078
  "type": "string",
7797
8079
  "value_allowed_null": false
7798
8080
  },
@@ -7802,27 +8084,27 @@
7802
8084
  "example": "无",
7803
8085
  "member": "string",
7804
8086
  "name": "CertSn",
7805
- "required": true,
8087
+ "output_required": true,
7806
8088
  "type": "string",
7807
8089
  "value_allowed_null": false
7808
8090
  },
7809
8091
  {
7810
8092
  "disabled": false,
7811
- "document": "证书起始时间戳,单位秒",
8093
+ "document": "证书起始时间戳,单位毫秒",
7812
8094
  "example": "无",
7813
8095
  "member": "int64",
7814
8096
  "name": "CertNotBefore",
7815
- "required": true,
8097
+ "output_required": true,
7816
8098
  "type": "int",
7817
8099
  "value_allowed_null": false
7818
8100
  },
7819
8101
  {
7820
8102
  "disabled": false,
7821
- "document": "证书过期时间戳,单位秒",
8103
+ "document": "证书过期时间戳,单位毫秒",
7822
8104
  "example": "无",
7823
8105
  "member": "int64",
7824
8106
  "name": "CertNotAfter",
7825
- "required": true,
8107
+ "output_required": true,
7826
8108
  "type": "int",
7827
8109
  "value_allowed_null": false
7828
8110
  },
@@ -7832,7 +8114,7 @@
7832
8114
  "example": "无",
7833
8115
  "member": "float",
7834
8116
  "name": "ComponentPosX",
7835
- "required": true,
8117
+ "output_required": true,
7836
8118
  "type": "float",
7837
8119
  "value_allowed_null": false
7838
8120
  },
@@ -7842,7 +8124,7 @@
7842
8124
  "example": "无",
7843
8125
  "member": "float",
7844
8126
  "name": "ComponentPosY",
7845
- "required": true,
8127
+ "output_required": true,
7846
8128
  "type": "float",
7847
8129
  "value_allowed_null": false
7848
8130
  },
@@ -7852,7 +8134,7 @@
7852
8134
  "example": "无",
7853
8135
  "member": "float",
7854
8136
  "name": "ComponentWidth",
7855
- "required": true,
8137
+ "output_required": true,
7856
8138
  "type": "float",
7857
8139
  "value_allowed_null": false
7858
8140
  },
@@ -7862,7 +8144,7 @@
7862
8144
  "example": "无",
7863
8145
  "member": "float",
7864
8146
  "name": "ComponentHeight",
7865
- "required": true,
8147
+ "output_required": true,
7866
8148
  "type": "float",
7867
8149
  "value_allowed_null": false
7868
8150
  },
@@ -7872,7 +8154,7 @@
7872
8154
  "example": "无",
7873
8155
  "member": "int64",
7874
8156
  "name": "ComponentPage",
7875
- "required": true,
8157
+ "output_required": true,
7876
8158
  "type": "int",
7877
8159
  "value_allowed_null": false
7878
8160
  }
@@ -7880,24 +8162,28 @@
7880
8162
  "usage": "out"
7881
8163
  },
7882
8164
  "Recipient": {
7883
- "document": "签署参与者信息",
8165
+ "document": "流程中参与方的信息结构",
7884
8166
  "members": [
7885
8167
  {
7886
8168
  "disabled": false,
7887
- "document": "签署参与者ID",
8169
+ "document": "签署参与者ID,唯一标识",
7888
8170
  "example": "无",
8171
+ "is_base64": false,
7889
8172
  "member": "string",
7890
8173
  "name": "RecipientId",
8174
+ "output_required": true,
7891
8175
  "required": false,
7892
8176
  "type": "string",
7893
8177
  "value_allowed_null": false
7894
8178
  },
7895
8179
  {
7896
8180
  "disabled": false,
7897
- "document": "参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方",
8181
+ "document": "参与者类型。\n默认为空。\nENTERPRISE-企业;\nINDIVIDUAL-个人;\nPROMOTER-发起方",
7898
8182
  "example": "ENTERPRISE",
8183
+ "is_base64": false,
7899
8184
  "member": "string",
7900
8185
  "name": "RecipientType",
8186
+ "output_required": true,
7901
8187
  "required": false,
7902
8188
  "type": "string",
7903
8189
  "value_allowed_null": false
@@ -7906,8 +8192,10 @@
7906
8192
  "disabled": false,
7907
8193
  "document": "描述信息",
7908
8194
  "example": "无",
8195
+ "is_base64": false,
7909
8196
  "member": "string",
7910
8197
  "name": "Description",
8198
+ "output_required": true,
7911
8199
  "required": false,
7912
8200
  "type": "string",
7913
8201
  "value_allowed_null": false
@@ -7916,48 +8204,54 @@
7916
8204
  "disabled": false,
7917
8205
  "document": "角色名称",
7918
8206
  "example": "无",
8207
+ "is_base64": false,
7919
8208
  "member": "string",
7920
8209
  "name": "RoleName",
8210
+ "output_required": true,
7921
8211
  "required": false,
7922
8212
  "type": "string",
7923
8213
  "value_allowed_null": false
7924
8214
  },
7925
8215
  {
7926
8216
  "disabled": false,
7927
- "document": "是否需要验证,默认为false",
8217
+ "document": "是否需要验证,\n默认为false-不需要验证",
7928
8218
  "example": "无",
7929
8219
  "member": "bool",
7930
8220
  "name": "RequireValidation",
8221
+ "output_required": true,
7931
8222
  "required": false,
7932
8223
  "type": "bool",
7933
8224
  "value_allowed_null": false
7934
8225
  },
7935
8226
  {
7936
8227
  "disabled": false,
7937
- "document": "是否需要签署,默认为true",
8228
+ "document": "是否需要签署,\n默认为true-需要签署",
7938
8229
  "example": "无",
7939
8230
  "member": "bool",
7940
8231
  "name": "RequireSign",
8232
+ "output_required": true,
7941
8233
  "required": false,
7942
8234
  "type": "bool",
7943
8235
  "value_allowed_null": false
7944
8236
  },
7945
8237
  {
7946
8238
  "disabled": false,
7947
- "document": "添加序列,0~N",
8239
+ "document": "此参与方添加的顺序,从0~N",
7948
8240
  "example": "无",
7949
8241
  "member": "int64",
7950
8242
  "name": "RoutingOrder",
8243
+ "output_required": true,
7951
8244
  "required": false,
7952
8245
  "type": "int",
7953
8246
  "value_allowed_null": false
7954
8247
  },
7955
8248
  {
7956
8249
  "disabled": false,
7957
- "document": "是否需要发送,默认为true",
8250
+ "document": "是否需要发送,\n默认为true-需要发送",
7958
8251
  "example": "无",
7959
8252
  "member": "bool",
7960
8253
  "name": "RequireDelivery",
8254
+ "output_required": true,
7961
8255
  "required": false,
7962
8256
  "type": "bool",
7963
8257
  "value_allowed_null": false
@@ -7966,8 +8260,10 @@
7966
8260
  "disabled": false,
7967
8261
  "document": "邮箱地址",
7968
8262
  "example": "无",
8263
+ "is_base64": false,
7969
8264
  "member": "string",
7970
8265
  "name": "Email",
8266
+ "output_required": true,
7971
8267
  "required": false,
7972
8268
  "type": "string",
7973
8269
  "value_allowed_null": false
@@ -7976,38 +8272,46 @@
7976
8272
  "disabled": false,
7977
8273
  "document": "电话号码",
7978
8274
  "example": "无",
8275
+ "is_base64": false,
7979
8276
  "member": "string",
7980
8277
  "name": "Mobile",
8278
+ "output_required": true,
7981
8279
  "required": false,
7982
8280
  "type": "string",
7983
8281
  "value_allowed_null": false
7984
8282
  },
7985
8283
  {
7986
8284
  "disabled": false,
7987
- "document": "关联的用户ID",
8285
+ "document": "关联的用户ID,电子签系统的用户ID",
7988
8286
  "example": "无",
8287
+ "is_base64": false,
7989
8288
  "member": "string",
7990
8289
  "name": "UserId",
8290
+ "output_required": true,
7991
8291
  "required": false,
7992
8292
  "type": "string",
7993
8293
  "value_allowed_null": false
7994
8294
  },
7995
8295
  {
7996
8296
  "disabled": false,
7997
- "document": "发送方式。默认为EMAIL。EMAIL-邮件;MOBILE-手机短信;WECHAT-微信通知",
8297
+ "document": "发送方式,默认为EMAIL。\nEMAIL-邮件;\nMOBILE-手机短信;\nWECHAT-微信通知",
7998
8298
  "example": "EMAIL",
8299
+ "is_base64": false,
7999
8300
  "member": "string",
8000
8301
  "name": "DeliveryMethod",
8302
+ "output_required": true,
8001
8303
  "required": false,
8002
8304
  "type": "string",
8003
8305
  "value_allowed_null": false
8004
8306
  },
8005
8307
  {
8006
8308
  "disabled": false,
8007
- "document": "附属信息",
8309
+ "document": "参与方的一些附属信息,json格式",
8008
8310
  "example": "无",
8311
+ "is_base64": false,
8009
8312
  "member": "string",
8010
8313
  "name": "RecipientExtra",
8314
+ "output_required": true,
8011
8315
  "required": false,
8012
8316
  "type": "string",
8013
8317
  "value_allowed_null": false
@@ -8104,6 +8408,7 @@
8104
8408
  "disabled": false,
8105
8409
  "document": "签署人姓名,最大长度50个字符\n",
8106
8410
  "example": "无",
8411
+ "is_base64": false,
8107
8412
  "member": "string",
8108
8413
  "name": "Name",
8109
8414
  "required": true,
@@ -8113,6 +8418,7 @@
8113
8418
  "disabled": false,
8114
8419
  "document": "签署人手机号",
8115
8420
  "example": "无",
8421
+ "is_base64": false,
8116
8422
  "member": "string",
8117
8423
  "name": "Mobile",
8118
8424
  "required": true,
@@ -8122,6 +8428,7 @@
8122
8428
  "disabled": false,
8123
8429
  "document": "要替换的参与人在原合同参与人列表中的签署人编号,通过DescribeFlowInfo 接口获取(即FlowDetailInfos. FlowApproverInfos 结构中的ReceiptId )",
8124
8430
  "example": "无",
8431
+ "is_base64": false,
8125
8432
  "member": "string",
8126
8433
  "name": "RelievedApproverReceiptId",
8127
8434
  "required": true,
@@ -8131,6 +8438,7 @@
8131
8438
  "disabled": false,
8132
8439
  "document": "指定签署人类型,目前仅支持\nORGANIZATION-企业\nENTERPRISESERVER-企业静默签",
8133
8440
  "example": "无",
8441
+ "is_base64": false,
8134
8442
  "member": "string",
8135
8443
  "name": "ApproverType",
8136
8444
  "required": false,
@@ -8140,6 +8448,7 @@
8140
8448
  "disabled": false,
8141
8449
  "document": "签署控件类型,支持自定义企业签署方的签署控件为“印章”或“签名”\n- SIGN_SEAL-默认为印章控件类型\n- SIGN_SIGNATURE-手写签名控件类型",
8142
8450
  "example": "无",
8451
+ "is_base64": false,
8143
8452
  "member": "string",
8144
8453
  "name": "ApproverSignComponentType",
8145
8454
  "required": false,
@@ -8147,8 +8456,9 @@
8147
8456
  },
8148
8457
  {
8149
8458
  "disabled": false,
8150
- "document": "签署方自定义控件别名,最大长度20个字符",
8459
+ "document": "参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方, 依次类推. 如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字符",
8151
8460
  "example": "无",
8461
+ "is_base64": false,
8152
8462
  "member": "string",
8153
8463
  "name": "ApproverSignRole",
8154
8464
  "required": false,
@@ -8274,8 +8584,39 @@
8274
8584
  "usage": "in"
8275
8585
  },
8276
8586
  "SealInfo": {
8277
- "document": "模板结构体中的印章信息",
8278
- "members": [],
8587
+ "document": "模板中指定的印章信息",
8588
+ "members": [
8589
+ {
8590
+ "disabled": false,
8591
+ "document": "印章ID\n注意:此字段可能返回 null,表示取不到有效值。",
8592
+ "example": "无",
8593
+ "member": "string",
8594
+ "name": "SealId",
8595
+ "output_required": true,
8596
+ "type": "string",
8597
+ "value_allowed_null": true
8598
+ },
8599
+ {
8600
+ "disabled": false,
8601
+ "document": "印章类型。LEGAL_PERSON_SEAL: 法定代表人章;\nORGANIZATIONSEAL:企业印章;\nOFFICIAL:企业公章;\nCONTRACT:合同专用章\n注意:此字段可能返回 null,表示取不到有效值。",
8602
+ "example": "无",
8603
+ "member": "string",
8604
+ "name": "SealType",
8605
+ "output_required": true,
8606
+ "type": "string",
8607
+ "value_allowed_null": true
8608
+ },
8609
+ {
8610
+ "disabled": false,
8611
+ "document": "印章名称\n注意:此字段可能返回 null,表示取不到有效值。",
8612
+ "example": "无",
8613
+ "member": "string",
8614
+ "name": "SealName",
8615
+ "output_required": true,
8616
+ "type": "string",
8617
+ "value_allowed_null": true
8618
+ }
8619
+ ],
8279
8620
  "usage": "out"
8280
8621
  },
8281
8622
  "SignQrCode": {
@@ -8517,29 +8858,31 @@
8517
8858
  "document": "集成版企业角色信息",
8518
8859
  "members": [
8519
8860
  {
8520
- "default": "",
8521
8861
  "disabled": false,
8522
8862
  "document": "角色id\n注意:此字段可能返回 null,表示取不到有效值。",
8523
8863
  "example": "无",
8864
+ "is_base64": false,
8524
8865
  "member": "string",
8525
8866
  "name": "RoleId",
8526
- "required": true,
8867
+ "output_required": true,
8868
+ "required": false,
8527
8869
  "type": "string",
8528
8870
  "value_allowed_null": true
8529
8871
  },
8530
8872
  {
8531
- "default": "",
8532
8873
  "disabled": false,
8533
8874
  "document": "角色名称\n注意:此字段可能返回 null,表示取不到有效值。",
8534
8875
  "example": "无",
8876
+ "is_base64": false,
8535
8877
  "member": "string",
8536
8878
  "name": "RoleName",
8537
- "required": true,
8879
+ "output_required": true,
8880
+ "required": false,
8538
8881
  "type": "string",
8539
8882
  "value_allowed_null": true
8540
8883
  }
8541
8884
  ],
8542
- "usage": "out"
8885
+ "usage": "both"
8543
8886
  },
8544
8887
  "StartFlowRequest": {
8545
8888
  "document": "StartFlow请求参数结构体",
@@ -8745,24 +9088,28 @@
8745
9088
  "usage": "out"
8746
9089
  },
8747
9090
  "TemplateInfo": {
8748
- "document": "企业模板的信息结构",
9091
+ "document": "此结构体 (TemplateInfo) 用于描述模板的信息。\n\n> **模板组成** \n>\n> 一个模板通常会包含以下结构信息\n>- 模板基本信息\n>- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方\n>- 填写控件 Components\n>- 签署控件 SignComponents\n>- 生成模板的文件基础信息 FileInfos",
8749
9092
  "members": [
8750
9093
  {
8751
9094
  "disabled": false,
8752
- "document": "模板ID",
9095
+ "document": "模板ID,模板的唯一标识",
8753
9096
  "example": "无",
9097
+ "is_base64": false,
8754
9098
  "member": "string",
8755
9099
  "name": "TemplateId",
9100
+ "output_required": true,
8756
9101
  "required": false,
8757
9102
  "type": "string",
8758
9103
  "value_allowed_null": false
8759
9104
  },
8760
9105
  {
8761
9106
  "disabled": false,
8762
- "document": "模板名字",
9107
+ "document": "模板名",
8763
9108
  "example": "无",
9109
+ "is_base64": false,
8764
9110
  "member": "string",
8765
9111
  "name": "TemplateName",
9112
+ "output_required": true,
8766
9113
  "required": false,
8767
9114
  "type": "string",
8768
9115
  "value_allowed_null": false
@@ -8771,8 +9118,10 @@
8771
9118
  "disabled": false,
8772
9119
  "document": "模板描述信息",
8773
9120
  "example": "无",
9121
+ "is_base64": false,
8774
9122
  "member": "string",
8775
9123
  "name": "Description",
9124
+ "output_required": true,
8776
9125
  "required": false,
8777
9126
  "type": "string",
8778
9127
  "value_allowed_null": false
@@ -8781,18 +9130,21 @@
8781
9130
  "disabled": false,
8782
9131
  "document": "模板关联的资源ID列表",
8783
9132
  "example": "无",
9133
+ "is_base64": false,
8784
9134
  "member": "string",
8785
9135
  "name": "DocumentResourceIds",
9136
+ "output_required": true,
8786
9137
  "required": false,
8787
9138
  "type": "list",
8788
9139
  "value_allowed_null": false
8789
9140
  },
8790
9141
  {
8791
9142
  "disabled": false,
8792
- "document": "返回的文件信息结构",
9143
+ "document": "生成模板的文件基础信息",
8793
9144
  "example": "无",
8794
9145
  "member": "FileInfo",
8795
9146
  "name": "FileInfos",
9147
+ "output_required": true,
8796
9148
  "required": false,
8797
9149
  "type": "list",
8798
9150
  "value_allowed_null": false
@@ -8801,118 +9153,133 @@
8801
9153
  "disabled": false,
8802
9154
  "document": "附件关联的资源ID",
8803
9155
  "example": "无",
9156
+ "is_base64": false,
8804
9157
  "member": "string",
8805
9158
  "name": "AttachmentResourceIds",
9159
+ "output_required": true,
8806
9160
  "required": false,
8807
9161
  "type": "list",
8808
9162
  "value_allowed_null": false
8809
9163
  },
8810
9164
  {
8811
9165
  "disabled": false,
8812
- "document": "签署顺序",
9166
+ "document": "签署顺序\n无序 -1\n有序为序列数字 0,1,2",
8813
9167
  "example": "无",
8814
9168
  "member": "int64",
8815
9169
  "name": "SignOrder",
9170
+ "output_required": true,
8816
9171
  "required": false,
8817
9172
  "type": "list",
8818
9173
  "value_allowed_null": false
8819
9174
  },
8820
9175
  {
8821
9176
  "disabled": false,
8822
- "document": "签署参与者的信息",
9177
+ "document": "模板中的签署参与方列表",
8823
9178
  "example": "无",
8824
9179
  "member": "Recipient",
8825
9180
  "name": "Recipients",
9181
+ "output_required": true,
8826
9182
  "required": false,
8827
9183
  "type": "list",
8828
9184
  "value_allowed_null": false
8829
9185
  },
8830
9186
  {
8831
9187
  "disabled": false,
8832
- "document": "模板信息结构",
9188
+ "document": "模板的填充控件列表",
8833
9189
  "example": "无",
8834
9190
  "member": "Component",
8835
9191
  "name": "Components",
9192
+ "output_required": true,
8836
9193
  "required": false,
8837
9194
  "type": "list",
8838
9195
  "value_allowed_null": false
8839
9196
  },
8840
9197
  {
8841
9198
  "disabled": false,
8842
- "document": "签署区模板信息结构",
9199
+ "document": "模板中的签署控件列表",
8843
9200
  "example": "无",
8844
9201
  "member": "Component",
8845
9202
  "name": "SignComponents",
9203
+ "output_required": true,
8846
9204
  "required": false,
8847
9205
  "type": "list",
8848
9206
  "value_allowed_null": false
8849
9207
  },
8850
9208
  {
8851
9209
  "disabled": false,
8852
- "document": "模板状态(-1:不可用;0:草稿态;1:正式态)",
9210
+ "document": "模板状态\n-1:不可用\n0:草稿态\n1:正式态,可以正常使用",
8853
9211
  "example": "无",
8854
9212
  "member": "int64",
8855
9213
  "name": "Status",
9214
+ "output_required": true,
8856
9215
  "required": false,
8857
9216
  "type": "int",
8858
9217
  "value_allowed_null": false
8859
9218
  },
8860
9219
  {
8861
9220
  "disabled": false,
8862
- "document": "模板的创建人UserId",
9221
+ "document": "模板的创建者信息,电子签系统用户ID",
8863
9222
  "example": "无",
9223
+ "is_base64": false,
8864
9224
  "member": "string",
8865
9225
  "name": "Creator",
9226
+ "output_required": true,
8866
9227
  "required": false,
8867
9228
  "type": "string",
8868
9229
  "value_allowed_null": false
8869
9230
  },
8870
9231
  {
8871
9232
  "disabled": false,
8872
- "document": "模板创建的时间戳,单位秒",
9233
+ "document": "模板创建的时间戳,格式为Unix标准时间戳(秒)",
8873
9234
  "example": "无",
8874
9235
  "member": "int64",
8875
9236
  "name": "CreatedOn",
9237
+ "output_required": true,
8876
9238
  "required": false,
8877
9239
  "type": "int",
8878
9240
  "value_allowed_null": false
8879
9241
  },
8880
9242
  {
8881
9243
  "disabled": false,
8882
- "document": "发起人角色信息",
9244
+ "document": "发起方参与信息Promoter",
8883
9245
  "example": "无",
8884
9246
  "member": "Recipient",
8885
9247
  "name": "Promoter",
9248
+ "output_required": true,
8886
9249
  "required": false,
8887
9250
  "type": "object",
8888
9251
  "value_allowed_null": false
8889
9252
  },
8890
9253
  {
8891
9254
  "disabled": false,
8892
- "document": "模板类型\n取值:\n1 静默签,\n3 普通模板",
9255
+ "document": "模板类型:\n1 静默签,\n3 普通模板",
8893
9256
  "example": "无",
8894
9257
  "member": "int64",
8895
9258
  "name": "TemplateType",
9259
+ "output_required": true,
8896
9260
  "required": false,
8897
9261
  "type": "int",
8898
9262
  "value_allowed_null": false
8899
9263
  },
8900
9264
  {
8901
9265
  "disabled": false,
8902
- "document": "模板可用状态,取值:1启用(默认),2停用",
9266
+ "document": "模板可用状态:\n1 启用(默认)\n2 停用",
8903
9267
  "example": "无",
8904
9268
  "member": "int64",
8905
9269
  "name": "Available",
9270
+ "output_required": true,
8906
9271
  "required": false,
8907
9272
  "type": "int",
8908
9273
  "value_allowed_null": false
8909
9274
  },
8910
9275
  {
8911
9276
  "disabled": false,
8912
- "document": "创建模板的机构id",
9277
+ "document": "创建模板的企业ID,电子签的机构ID",
8913
9278
  "example": "无",
9279
+ "is_base64": false,
8914
9280
  "member": "string",
8915
9281
  "name": "OrganizationId",
9282
+ "output_required": true,
8916
9283
  "required": false,
8917
9284
  "type": "string",
8918
9285
  "value_allowed_null": false
@@ -8921,8 +9288,10 @@
8921
9288
  "disabled": false,
8922
9289
  "document": "模板预览链接,有效时间5分钟\n注意:此字段可能返回 null,表示取不到有效值。",
8923
9290
  "example": "无",
9291
+ "is_base64": false,
8924
9292
  "member": "string",
8925
9293
  "name": "PreviewUrl",
9294
+ "output_required": true,
8926
9295
  "required": false,
8927
9296
  "type": "string",
8928
9297
  "value_allowed_null": true
@@ -8931,18 +9300,21 @@
8931
9300
  "disabled": false,
8932
9301
  "document": "模板版本。默认为空时,全数字字符,初始版本为yyyyMMdd001。\n注意:此字段可能返回 null,表示取不到有效值。",
8933
9302
  "example": "无",
9303
+ "is_base64": false,
8934
9304
  "member": "string",
8935
9305
  "name": "TemplateVersion",
9306
+ "output_required": true,
8936
9307
  "required": false,
8937
9308
  "type": "string",
8938
9309
  "value_allowed_null": true
8939
9310
  },
8940
9311
  {
8941
9312
  "disabled": false,
8942
- "document": "模板是否已发布。true-已发布;false-未发布\n注意:此字段可能返回 null,表示取不到有效值。",
9313
+ "document": "模板是否已发布:\ntrue-已发布\nfalse-未发布\n注意:此字段可能返回 null,表示取不到有效值。",
8943
9314
  "example": "无",
8944
9315
  "member": "bool",
8945
9316
  "name": "Published",
9317
+ "output_required": true,
8946
9318
  "required": false,
8947
9319
  "type": "bool",
8948
9320
  "value_allowed_null": true
@@ -8953,6 +9325,7 @@
8953
9325
  "example": "无",
8954
9326
  "member": "SealInfo",
8955
9327
  "name": "TemplateSeals",
9328
+ "output_required": true,
8956
9329
  "required": false,
8957
9330
  "type": "list",
8958
9331
  "value_allowed_null": true
@@ -8963,6 +9336,7 @@
8963
9336
  "example": "无",
8964
9337
  "member": "SealInfo",
8965
9338
  "name": "Seals",
9339
+ "output_required": true,
8966
9340
  "required": false,
8967
9341
  "type": "list",
8968
9342
  "value_allowed_null": true
@@ -9043,8 +9417,9 @@
9043
9417
  "members": [
9044
9418
  {
9045
9419
  "disabled": false,
9046
- "document": "操作人信息,userId必填",
9420
+ "document": "当前用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为YUFU;",
9047
9421
  "example": "无",
9422
+ "is_base64": false,
9048
9423
  "member": "UserInfo",
9049
9424
  "name": "Operator",
9050
9425
  "required": true,
@@ -9054,6 +9429,7 @@
9054
9429
  "disabled": false,
9055
9430
  "document": "员工信息,不超过100个。\n根据UserId或OpenId更新员工,必填一个,优先UserId。\n可更新Mobile、DisplayName、Email和Department.DepartmentId字段,其他字段暂不支持",
9056
9431
  "example": "无",
9432
+ "is_base64": false,
9057
9433
  "member": "Staff",
9058
9434
  "name": "Employees",
9059
9435
  "required": true,
@@ -9063,6 +9439,7 @@
9063
9439
  "disabled": false,
9064
9440
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id",
9065
9441
  "example": "无",
9442
+ "is_base64": false,
9066
9443
  "member": "Agent",
9067
9444
  "name": "Agent",
9068
9445
  "required": false,