tccli 3.0.830.1__py2.py3-none-any.whl → 3.0.832.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/__init__.py +3 -0
- tccli/services/asr/v20190614/api.json +4 -4
- tccli/services/bma/v20221115/api.json +9 -0
- tccli/services/bma/v20221115/examples.json +2 -2
- tccli/services/ccc/v20200210/api.json +9 -0
- tccli/services/ccc/v20200210/examples.json +2 -2
- tccli/services/cdc/v20201214/examples.json +1 -1
- tccli/services/ckafka/v20190819/api.json +1 -20
- tccli/services/ckafka/v20190819/examples.json +1 -1
- tccli/services/cwp/cwp_client.py +2179 -642
- tccli/services/cwp/v20180228/api.json +3069 -479
- tccli/services/cwp/v20180228/examples.json +247 -3
- tccli/services/dlc/dlc_client.py +341 -23
- tccli/services/dlc/v20210125/api.json +505 -0
- tccli/services/dlc/v20210125/examples.json +48 -0
- tccli/services/ess/ess_client.py +163 -4
- tccli/services/ess/v20201111/api.json +304 -0
- tccli/services/ess/v20201111/examples.json +24 -0
- tccli/services/essbasic/v20210526/api.json +68 -150
- tccli/services/essbasic/v20210526/examples.json +17 -17
- tccli/services/gme/gme_client.py +277 -12
- tccli/services/gme/v20180711/api.json +386 -0
- tccli/services/gme/v20180711/examples.json +40 -0
- tccli/services/intlpartnersmgt/__init__.py +4 -0
- tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +724 -0
- tccli/services/intlpartnersmgt/v20220928/api.json +1054 -0
- tccli/services/intlpartnersmgt/v20220928/examples.json +93 -0
- tccli/services/live/v20180801/api.json +10 -10
- tccli/services/live/v20180801/examples.json +3 -3
- tccli/services/tdmq/v20200217/api.json +23 -44
- tccli/services/tdmq/v20200217/examples.json +3 -3
- tccli/services/trtc/v20190722/api.json +2 -2
- tccli/services/tse/v20201207/api.json +42 -1
- {tccli-3.0.830.1.dist-info → tccli-3.0.832.1.dist-info}/METADATA +2 -2
- {tccli-3.0.830.1.dist-info → tccli-3.0.832.1.dist-info}/RECORD +40 -36
- {tccli-3.0.830.1.dist-info → tccli-3.0.832.1.dist-info}/LICENSE +0 -0
- {tccli-3.0.830.1.dist-info → tccli-3.0.832.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.830.1.dist-info → tccli-3.0.832.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.830.1.dist-info → tccli-3.0.832.1.dist-info}/top_level.txt +0 -0
@@ -29,7 +29,7 @@
|
|
29
29
|
"status": "online"
|
30
30
|
},
|
31
31
|
"ChannelCreateBoundFlows": {
|
32
|
-
"document": "此接口(ChannelCreateBoundFlows
|
32
|
+
"document": "此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。",
|
33
33
|
"input": "ChannelCreateBoundFlowsRequest",
|
34
34
|
"name": "领取未归属的合同",
|
35
35
|
"output": "ChannelCreateBoundFlowsResponse",
|
@@ -92,7 +92,7 @@
|
|
92
92
|
"status": "online"
|
93
93
|
},
|
94
94
|
"ChannelCreateSealPolicy": {
|
95
|
-
"document": "
|
95
|
+
"document": "将指定印章授权给第三方平台子客企业下的某些员工",
|
96
96
|
"input": "ChannelCreateSealPolicyRequest",
|
97
97
|
"name": "创建印章授权",
|
98
98
|
"output": "ChannelCreateSealPolicyResponse",
|
@@ -127,7 +127,7 @@
|
|
127
127
|
"status": "online"
|
128
128
|
},
|
129
129
|
"ChannelUpdateSealStatus": {
|
130
|
-
"document": "本接口(ChannelUpdateSealStatus
|
130
|
+
"document": "本接口(ChannelUpdateSealStatus)用于第三方应用平台为子客企业更新印章状态",
|
131
131
|
"input": "ChannelUpdateSealStatusRequest",
|
132
132
|
"name": "更新印章状态",
|
133
133
|
"output": "ChannelUpdateSealStatusResponse",
|
@@ -148,7 +148,7 @@
|
|
148
148
|
"status": "online"
|
149
149
|
},
|
150
150
|
"CreateConsoleLoginUrl": {
|
151
|
-
"document": "此接口(CreateConsoleLoginUrl
|
151
|
+
"document": "此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。\n若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)\n若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。\n若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。",
|
152
152
|
"input": "CreateConsoleLoginUrlRequest",
|
153
153
|
"name": "生成控制台、移动端链接",
|
154
154
|
"output": "CreateConsoleLoginUrlResponse",
|
@@ -162,9 +162,9 @@
|
|
162
162
|
"status": "online"
|
163
163
|
},
|
164
164
|
"CreateSealByImage": {
|
165
|
-
"document": "
|
165
|
+
"document": "通过图片为子客企业代创建印章,图片最大5MB",
|
166
166
|
"input": "CreateSealByImageRequest",
|
167
|
-
"name": "
|
167
|
+
"name": "通过图片为子客企业代创建印章",
|
168
168
|
"output": "CreateSealByImageResponse",
|
169
169
|
"status": "online"
|
170
170
|
},
|
@@ -204,16 +204,16 @@
|
|
204
204
|
"status": "online"
|
205
205
|
},
|
206
206
|
"DescribeTemplates": {
|
207
|
-
"document": "通过此接口(DescribeTemplates
|
207
|
+
"document": "通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板",
|
208
208
|
"input": "DescribeTemplatesRequest",
|
209
209
|
"name": "查询模板信息列表",
|
210
210
|
"output": "DescribeTemplatesResponse",
|
211
211
|
"status": "online"
|
212
212
|
},
|
213
213
|
"DescribeUsage": {
|
214
|
-
"document": "此接口(DescribeUsage
|
214
|
+
"document": "此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。\n 注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。",
|
215
215
|
"input": "DescribeUsageRequest",
|
216
|
-
"name": "
|
216
|
+
"name": "合同用量查询",
|
217
217
|
"output": "DescribeUsageResponse",
|
218
218
|
"status": "online"
|
219
219
|
},
|
@@ -232,9 +232,9 @@
|
|
232
232
|
"status": "online"
|
233
233
|
},
|
234
234
|
"OperateChannelTemplate": {
|
235
|
-
"document": "此接口(OperateChannelTemplate
|
235
|
+
"document": "此接口(OperateChannelTemplate)用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置,不会直接分配第三方应用平台模板给子客企业。\n1、OperateType=select时:\n查询第三方应用平台模板库\n2、OperateType=update或者delete时:\n对子客企业进行模板库中模板可见性的修改、删除操作。",
|
236
236
|
"input": "OperateChannelTemplateRequest",
|
237
|
-
"name": "
|
237
|
+
"name": "操作第三方应用平台企业模板",
|
238
238
|
"output": "OperateChannelTemplateResponse",
|
239
239
|
"status": "online"
|
240
240
|
},
|
@@ -246,14 +246,14 @@
|
|
246
246
|
"status": "online"
|
247
247
|
},
|
248
248
|
"SyncProxyOrganization": {
|
249
|
-
"document": "此接口(SyncProxyOrganization
|
249
|
+
"document": "此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。",
|
250
250
|
"input": "SyncProxyOrganizationRequest",
|
251
251
|
"name": "同步企业信息",
|
252
252
|
"output": "SyncProxyOrganizationResponse",
|
253
253
|
"status": "online"
|
254
254
|
},
|
255
255
|
"SyncProxyOrganizationOperators": {
|
256
|
-
"document": "此接口(SyncProxyOrganizationOperators
|
256
|
+
"document": "此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。\n若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。",
|
257
257
|
"input": "SyncProxyOrganizationOperatorsRequest",
|
258
258
|
"name": "同步企业经办人列表",
|
259
259
|
"output": "SyncProxyOrganizationOperatorsResponse",
|
@@ -278,7 +278,6 @@
|
|
278
278
|
"document": "应用相关信息",
|
279
279
|
"members": [
|
280
280
|
{
|
281
|
-
"default": "",
|
282
281
|
"document": "应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。",
|
283
282
|
"example": "无",
|
284
283
|
"member": "string",
|
@@ -288,8 +287,7 @@
|
|
288
287
|
"value_allowed_null": false
|
289
288
|
},
|
290
289
|
{
|
291
|
-
"
|
292
|
-
"document": "渠道平台自定义,对于渠道子客企业的唯一标识。一个渠道子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要渠道平台保存),最大64位字符串",
|
290
|
+
"document": "第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串",
|
293
291
|
"example": "无",
|
294
292
|
"member": "string",
|
295
293
|
"name": "ProxyOrganizationOpenId",
|
@@ -298,8 +296,7 @@
|
|
298
296
|
"value_allowed_null": false
|
299
297
|
},
|
300
298
|
{
|
301
|
-
"
|
302
|
-
"document": "渠道子客企业中的员工/经办人,通过渠道平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。",
|
299
|
+
"document": "第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。",
|
303
300
|
"example": "无",
|
304
301
|
"member": "UserInfo",
|
305
302
|
"name": "ProxyOperator",
|
@@ -308,8 +305,7 @@
|
|
308
305
|
"value_allowed_null": false
|
309
306
|
},
|
310
307
|
{
|
311
|
-
"
|
312
|
-
"document": "在子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。",
|
308
|
+
"document": "在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。",
|
313
309
|
"example": "无",
|
314
310
|
"member": "string",
|
315
311
|
"name": "ProxyAppId",
|
@@ -318,7 +314,6 @@
|
|
318
314
|
"value_allowed_null": false
|
319
315
|
},
|
320
316
|
{
|
321
|
-
"default": "",
|
322
317
|
"document": "内部参数,暂未开放使用",
|
323
318
|
"example": "无",
|
324
319
|
"member": "string",
|
@@ -890,7 +885,7 @@
|
|
890
885
|
"type": "string"
|
891
886
|
},
|
892
887
|
{
|
893
|
-
"document": "
|
888
|
+
"document": "业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN",
|
894
889
|
"example": "\"xxx\"",
|
895
890
|
"member": "string",
|
896
891
|
"name": "CustomerData",
|
@@ -1252,7 +1247,7 @@
|
|
1252
1247
|
"type": "list"
|
1253
1248
|
},
|
1254
1249
|
{
|
1255
|
-
"document": "回调地址,最大长度1000个字符\n
|
1250
|
+
"document": "回调地址,最大长度1000个字符\n不传默认使用第三方应用号配置的回调地址\n回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败",
|
1256
1251
|
"example": "无",
|
1257
1252
|
"member": "string",
|
1258
1253
|
"name": "CallbackUrl",
|
@@ -2065,7 +2060,7 @@
|
|
2065
2060
|
"value_allowed_null": false
|
2066
2061
|
},
|
2067
2062
|
{
|
2068
|
-
"document": "
|
2063
|
+
"document": "平台企业控件ID。\n如果不为空,属于平台企业预设控件;",
|
2069
2064
|
"example": "无",
|
2070
2065
|
"member": "string",
|
2071
2066
|
"name": "ChannelComponentId",
|
@@ -2366,7 +2361,7 @@
|
|
2366
2361
|
"value_allowed_null": false
|
2367
2362
|
},
|
2368
2363
|
{
|
2369
|
-
"document": "
|
2364
|
+
"document": "业务信息,限制1024字符",
|
2370
2365
|
"example": "[\"\",\"\"]",
|
2371
2366
|
"member": "string",
|
2372
2367
|
"name": "CustomerData",
|
@@ -2500,7 +2495,7 @@
|
|
2500
2495
|
"type": "string"
|
2501
2496
|
},
|
2502
2497
|
{
|
2503
|
-
"document": "签署链接生成类型,默认是 \"ALL\";\n\"ALL\":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;\n\"CHANNEL\"
|
2498
|
+
"document": "签署链接生成类型,默认是 \"ALL\";\n\"ALL\":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;\n\"CHANNEL\":第三方平台子客企业企业;\n\"NOT_CHANNEL\":非第三方平台子客企业企业;\n\"PERSON\":个人;\n\"FOLLOWER\":关注方,目前是合同抄送方;",
|
2504
2499
|
"example": "CHANNEL",
|
2505
2500
|
"member": "string",
|
2506
2501
|
"name": "GenerateType",
|
@@ -2508,7 +2503,7 @@
|
|
2508
2503
|
"type": "string"
|
2509
2504
|
},
|
2510
2505
|
{
|
2511
|
-
"document": "
|
2506
|
+
"document": "非第三方平台子客企业参与方的企业名称,GenerateType为\"NOT_CHANNEL\"时必填",
|
2512
2507
|
"example": "测试企业",
|
2513
2508
|
"member": "string",
|
2514
2509
|
"name": "OrganizationName",
|
@@ -2532,7 +2527,7 @@
|
|
2532
2527
|
"type": "string"
|
2533
2528
|
},
|
2534
2529
|
{
|
2535
|
-
"document": "
|
2530
|
+
"document": "第三方平台子客企业的企业OpenId,GenerateType为\"CHANNEL\"时必填",
|
2536
2531
|
"example": "xxx",
|
2537
2532
|
"member": "string",
|
2538
2533
|
"name": "OrganizationOpenId",
|
@@ -2540,7 +2535,7 @@
|
|
2540
2535
|
"type": "string"
|
2541
2536
|
},
|
2542
2537
|
{
|
2543
|
-
"document": "
|
2538
|
+
"document": "第三方平台子客企业参与人OpenId,GenerateType为\"CHANNEL\"时可用,指定到具体参与人, 仅展示已经实名的经办人信息",
|
2544
2539
|
"example": "xxx",
|
2545
2540
|
"member": "string",
|
2546
2541
|
"name": "OpenId",
|
@@ -2603,10 +2598,9 @@
|
|
2603
2598
|
"type": "object"
|
2604
2599
|
},
|
2605
2600
|
"Department": {
|
2606
|
-
"document": "
|
2601
|
+
"document": "第三方应用集成员工部门信息",
|
2607
2602
|
"members": [
|
2608
2603
|
{
|
2609
|
-
"default": "",
|
2610
2604
|
"document": "部门id\n注意:此字段可能返回 null,表示取不到有效值。",
|
2611
2605
|
"example": "无",
|
2612
2606
|
"member": "string",
|
@@ -2616,7 +2610,6 @@
|
|
2616
2610
|
"value_allowed_null": true
|
2617
2611
|
},
|
2618
2612
|
{
|
2619
|
-
"default": "",
|
2620
2613
|
"document": "部门名称\n注意:此字段可能返回 null,表示取不到有效值。",
|
2621
2614
|
"example": "无",
|
2622
2615
|
"member": "string",
|
@@ -2762,7 +2755,7 @@
|
|
2762
2755
|
"document": "DescribeFlowDetailInfo返回参数结构体",
|
2763
2756
|
"members": [
|
2764
2757
|
{
|
2765
|
-
"document": "
|
2758
|
+
"document": "第三方平台应用号Id",
|
2766
2759
|
"example": "无",
|
2767
2760
|
"member": "string",
|
2768
2761
|
"name": "ApplicationId",
|
@@ -2770,7 +2763,7 @@
|
|
2770
2763
|
"value_allowed_null": false
|
2771
2764
|
},
|
2772
2765
|
{
|
2773
|
-
"document": "
|
2766
|
+
"document": "第三方平台子客企业OpenId",
|
2774
2767
|
"example": "无",
|
2775
2768
|
"member": "string",
|
2776
2769
|
"name": "ProxyOrganizationOpenId",
|
@@ -2944,7 +2937,7 @@
|
|
2944
2937
|
"type": "bool"
|
2945
2938
|
},
|
2946
2939
|
{
|
2947
|
-
"document": "是否获取模板的PDF
|
2940
|
+
"document": "是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。",
|
2948
2941
|
"example": "无",
|
2949
2942
|
"member": "bool",
|
2950
2943
|
"name": "WithPdfUrl",
|
@@ -2952,7 +2945,7 @@
|
|
2952
2945
|
"type": "bool"
|
2953
2946
|
},
|
2954
2947
|
{
|
2955
|
-
"document": "
|
2948
|
+
"document": "模板ID",
|
2956
2949
|
"example": "无",
|
2957
2950
|
"member": "string",
|
2958
2951
|
"name": "ChannelTemplateId",
|
@@ -3034,7 +3027,7 @@
|
|
3034
3027
|
"type": "string"
|
3035
3028
|
},
|
3036
3029
|
{
|
3037
|
-
"document": "是否汇总数据,默认不汇总。\n
|
3030
|
+
"document": "是否汇总数据,默认不汇总。\n不汇总:返回在统计区间内第三方平台下所有企业的每日明细,即每个企业N条数据,N为统计天数;\n汇总:返回在统计区间内第三方平台下所有企业的汇总后数据,即每个企业一条数据;",
|
3038
3031
|
"example": "无",
|
3039
3032
|
"member": "bool",
|
3040
3033
|
"name": "NeedAggregate",
|
@@ -3203,7 +3196,6 @@
|
|
3203
3196
|
"document": "签署人的流程信息明细",
|
3204
3197
|
"members": [
|
3205
3198
|
{
|
3206
|
-
"default": "",
|
3207
3199
|
"document": "模板配置时候的签署人id,与控件绑定",
|
3208
3200
|
"example": "无",
|
3209
3201
|
"member": "string",
|
@@ -3213,8 +3205,7 @@
|
|
3213
3205
|
"value_allowed_null": false
|
3214
3206
|
},
|
3215
3207
|
{
|
3216
|
-
"
|
3217
|
-
"document": "渠道侧企业的第三方id\n注意:此字段可能返回 null,表示取不到有效值。",
|
3208
|
+
"document": "平台企业的第三方id\n注意:此字段可能返回 null,表示取不到有效值。",
|
3218
3209
|
"example": "无",
|
3219
3210
|
"member": "string",
|
3220
3211
|
"name": "ProxyOrganizationOpenId",
|
@@ -3223,8 +3214,7 @@
|
|
3223
3214
|
"value_allowed_null": true
|
3224
3215
|
},
|
3225
3216
|
{
|
3226
|
-
"
|
3227
|
-
"document": "渠道侧企业操作人的第三方id",
|
3217
|
+
"document": "平台企业操作人的第三方id",
|
3228
3218
|
"example": "无",
|
3229
3219
|
"member": "string",
|
3230
3220
|
"name": "ProxyOperatorOpenId",
|
@@ -3233,8 +3223,7 @@
|
|
3233
3223
|
"value_allowed_null": false
|
3234
3224
|
},
|
3235
3225
|
{
|
3236
|
-
"
|
3237
|
-
"document": "渠道侧企业名称",
|
3226
|
+
"document": "平台企业名称",
|
3238
3227
|
"example": "无",
|
3239
3228
|
"member": "string",
|
3240
3229
|
"name": "ProxyOrganizationName",
|
@@ -3243,7 +3232,6 @@
|
|
3243
3232
|
"value_allowed_null": false
|
3244
3233
|
},
|
3245
3234
|
{
|
3246
|
-
"default": "",
|
3247
3235
|
"document": "签署人手机号",
|
3248
3236
|
"example": "无",
|
3249
3237
|
"member": "string",
|
@@ -3253,7 +3241,6 @@
|
|
3253
3241
|
"value_allowed_null": false
|
3254
3242
|
},
|
3255
3243
|
{
|
3256
|
-
"default": "",
|
3257
3244
|
"document": "签署人签署顺序",
|
3258
3245
|
"example": "无",
|
3259
3246
|
"member": "int64",
|
@@ -3263,7 +3250,6 @@
|
|
3263
3250
|
"value_allowed_null": false
|
3264
3251
|
},
|
3265
3252
|
{
|
3266
|
-
"default": "",
|
3267
3253
|
"document": "签署人姓名\n注意:此字段可能返回 null,表示取不到有效值。",
|
3268
3254
|
"example": "无",
|
3269
3255
|
"member": "string",
|
@@ -3273,7 +3259,6 @@
|
|
3273
3259
|
"value_allowed_null": true
|
3274
3260
|
},
|
3275
3261
|
{
|
3276
|
-
"default": "",
|
3277
3262
|
"document": "当前签署人的状态\n注意:此字段可能返回 null,表示取不到有效值。",
|
3278
3263
|
"example": "无",
|
3279
3264
|
"member": "string",
|
@@ -3283,7 +3268,6 @@
|
|
3283
3268
|
"value_allowed_null": true
|
3284
3269
|
},
|
3285
3270
|
{
|
3286
|
-
"default": "",
|
3287
3271
|
"document": "签署人信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
3288
3272
|
"example": "无",
|
3289
3273
|
"member": "string",
|
@@ -3293,7 +3277,6 @@
|
|
3293
3277
|
"value_allowed_null": true
|
3294
3278
|
},
|
3295
3279
|
{
|
3296
|
-
"default": "",
|
3297
3280
|
"document": "签署人签署时间",
|
3298
3281
|
"example": "无",
|
3299
3282
|
"member": "int64",
|
@@ -3303,7 +3286,6 @@
|
|
3303
3286
|
"value_allowed_null": false
|
3304
3287
|
},
|
3305
3288
|
{
|
3306
|
-
"default": "",
|
3307
3289
|
"document": "参与者类型 (ORGANIZATION企业/PERSON个人)\n注意:此字段可能返回 null,表示取不到有效值。",
|
3308
3290
|
"example": "无",
|
3309
3291
|
"member": "string",
|
@@ -3316,7 +3298,7 @@
|
|
3316
3298
|
"usage": "out"
|
3317
3299
|
},
|
3318
3300
|
"FlowApproverInfo": {
|
3319
|
-
"document": "创建签署流程签署人入参。\n\n其中签署方FlowApproverInfo需要传递的参数\n非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识\n1-个人:Name、Mobile必传\n2
|
3301
|
+
"document": "创建签署流程签署人入参。\n\n其中签署方FlowApproverInfo需要传递的参数\n非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识\n1-个人:Name、Mobile必传\n2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;\n3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;\n4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。\n\nRecipientId参数:\n从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId",
|
3320
3302
|
"members": [
|
3321
3303
|
{
|
3322
3304
|
"document": "签署人姓名,最大长度50个字符",
|
@@ -3364,7 +3346,7 @@
|
|
3364
3346
|
"value_allowed_null": false
|
3365
3347
|
},
|
3366
3348
|
{
|
3367
|
-
"document": "
|
3349
|
+
"document": "指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。\n默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;",
|
3368
3350
|
"example": "false",
|
3369
3351
|
"member": "bool",
|
3370
3352
|
"name": "NotChannelOrganization",
|
@@ -3373,7 +3355,7 @@
|
|
3373
3355
|
"value_allowed_null": false
|
3374
3356
|
},
|
3375
3357
|
{
|
3376
|
-
"document": "用户侧第三方id,最大长度64个字符\n
|
3358
|
+
"document": "用户侧第三方id,最大长度64个字符\n当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程",
|
3377
3359
|
"example": "open_test_id",
|
3378
3360
|
"member": "string",
|
3379
3361
|
"name": "OpenId",
|
@@ -3382,7 +3364,7 @@
|
|
3382
3364
|
"value_allowed_null": false
|
3383
3365
|
},
|
3384
3366
|
{
|
3385
|
-
"document": "
|
3367
|
+
"document": "企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;",
|
3386
3368
|
"example": "\"xxx\"",
|
3387
3369
|
"member": "string",
|
3388
3370
|
"name": "OrganizationOpenId",
|
@@ -3629,7 +3611,6 @@
|
|
3629
3611
|
"document": "合同组中每个子合同的发起信息",
|
3630
3612
|
"members": [
|
3631
3613
|
{
|
3632
|
-
"default": "",
|
3633
3614
|
"document": "签署文件资源Id列表,目前仅支持单个文件",
|
3634
3615
|
"example": "[\"xxx\"]",
|
3635
3616
|
"member": "string",
|
@@ -3639,7 +3620,6 @@
|
|
3639
3620
|
"value_allowed_null": false
|
3640
3621
|
},
|
3641
3622
|
{
|
3642
|
-
"default": "",
|
3643
3623
|
"document": "签署流程名称,长度不超过200个字符",
|
3644
3624
|
"example": "\"xxx\"",
|
3645
3625
|
"member": "string",
|
@@ -3649,7 +3629,6 @@
|
|
3649
3629
|
"value_allowed_null": false
|
3650
3630
|
},
|
3651
3631
|
{
|
3652
|
-
"default": "",
|
3653
3632
|
"document": "签署流程签约方列表,最多不超过5个参与方",
|
3654
3633
|
"example": "无",
|
3655
3634
|
"member": "FlowApproverInfo",
|
@@ -3659,7 +3638,6 @@
|
|
3659
3638
|
"value_allowed_null": false
|
3660
3639
|
},
|
3661
3640
|
{
|
3662
|
-
"default": "",
|
3663
3641
|
"document": "签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年",
|
3664
3642
|
"example": "1662110622",
|
3665
3643
|
"member": "int64",
|
@@ -3669,7 +3647,6 @@
|
|
3669
3647
|
"value_allowed_null": false
|
3670
3648
|
},
|
3671
3649
|
{
|
3672
|
-
"default": "",
|
3673
3650
|
"document": "签署流程的描述,长度不超过1000个字符",
|
3674
3651
|
"example": "\"xxx\"",
|
3675
3652
|
"member": "string",
|
@@ -3679,7 +3656,6 @@
|
|
3679
3656
|
"value_allowed_null": false
|
3680
3657
|
},
|
3681
3658
|
{
|
3682
|
-
"default": "",
|
3683
3659
|
"document": "签署流程的类型,长度不超过255个字符",
|
3684
3660
|
"example": "\"xxx\"",
|
3685
3661
|
"member": "string",
|
@@ -3689,7 +3665,6 @@
|
|
3689
3665
|
"value_allowed_null": false
|
3690
3666
|
},
|
3691
3667
|
{
|
3692
|
-
"default": "",
|
3693
3668
|
"document": "签署流程回调地址,长度不超过255个字符",
|
3694
3669
|
"example": "\"xxx\"",
|
3695
3670
|
"member": "string",
|
@@ -3699,8 +3674,7 @@
|
|
3699
3674
|
"value_allowed_null": false
|
3700
3675
|
},
|
3701
3676
|
{
|
3702
|
-
"
|
3703
|
-
"document": "渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN",
|
3677
|
+
"document": "第三方应用的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN",
|
3704
3678
|
"example": "\"xxx\"",
|
3705
3679
|
"member": "string",
|
3706
3680
|
"name": "CustomerData",
|
@@ -3709,7 +3683,6 @@
|
|
3709
3683
|
"value_allowed_null": false
|
3710
3684
|
},
|
3711
3685
|
{
|
3712
|
-
"default": "",
|
3713
3686
|
"document": "合同签署顺序类型(无序签,顺序签),默认为false,即有序签署",
|
3714
3687
|
"example": "false",
|
3715
3688
|
"member": "bool",
|
@@ -3719,7 +3692,6 @@
|
|
3719
3692
|
"value_allowed_null": false
|
3720
3693
|
},
|
3721
3694
|
{
|
3722
|
-
"default": "",
|
3723
3695
|
"document": "合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始",
|
3724
3696
|
"example": "\"xxx\"",
|
3725
3697
|
"member": "string",
|
@@ -3729,7 +3701,6 @@
|
|
3729
3701
|
"value_allowed_null": false
|
3730
3702
|
},
|
3731
3703
|
{
|
3732
|
-
"default": "",
|
3733
3704
|
"document": "本企业(发起方企业)是否需要签署审批",
|
3734
3705
|
"example": "flase",
|
3735
3706
|
"member": "bool",
|
@@ -3742,10 +3713,9 @@
|
|
3742
3713
|
"usage": "in"
|
3743
3714
|
},
|
3744
3715
|
"FlowInfo": {
|
3745
|
-
"document": "此结构体 (FlowInfo) 用于描述签署流程信息。\n\n【数据表格传参说明】\n当模板的 ComponentType='DYNAMIC_TABLE'
|
3716
|
+
"document": "此结构体 (FlowInfo) 用于描述签署流程信息。\n\n【数据表格传参说明】\n当模板的 ComponentType='DYNAMIC_TABLE'时( 第三方应用集成或集成版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)\n输入示例1:\n\n```\n{\n \"headers\":[\n {\n \"content\":\"head1\"\n },\n {\n \"content\":\"head2\"\n },\n {\n \"content\":\"head3\"\n }\n ],\n \"rowCount\":3,\n \"body\":{\n \"cells\":[\n {\n \"rowStart\":1,\n \"rowEnd\":1,\n \"columnStart\":1,\n \"columnEnd\":1,\n \"content\":\"123\"\n },\n {\n \"rowStart\":2,\n \"rowEnd\":3,\n \"columnStart\":1,\n \"columnEnd\":2,\n \"content\":\"456\"\n },\n {\n \"rowStart\":3,\n \"rowEnd\":3,\n \"columnStart\":3,\n \"columnEnd\":3,\n \"content\":\"789\"\n }\n ]\n }\n}\n\n```\n\n输入示例2(表格表头宽度比例配置):\n\n```\n{\n \"headers\":[\n {\n \"content\":\"head1\",\n \"widthPercent\": 30\n },\n {\n \"content\":\"head2\",\n \"widthPercent\": 30\n },\n {\n \"content\":\"head3\",\n \"widthPercent\": 40\n }\n ],\n \"rowCount\":3,\n \"body\":{\n \"cells\":[\n {\n \"rowStart\":1,\n \"rowEnd\":1,\n \"columnStart\":1,\n \"columnEnd\":1,\n \"content\":\"123\"\n },\n {\n \"rowStart\":2,\n \"rowEnd\":3,\n \"columnStart\":1,\n \"columnEnd\":2,\n \"content\":\"456\"\n },\n {\n \"rowStart\":3,\n \"rowEnd\":3,\n \"columnStart\":3,\n \"columnEnd\":3,\n \"content\":\"789\"\n }\n ]\n }\n}\n\n```\n表格参数说明\n\n| 名称 | 类型 | 描述 |\n| ------------------- | ------- | ------------------------------------------------- |\n| headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |\n| rowCount | Integer | 表格内容最大行数 |\n| cells.N.rowStart | Integer | 单元格坐标:行起始index |\n| cells.N.rowEnd | Integer | 单元格坐标:行结束index |\n| cells.N.columnStart | Integer | 单元格坐标:列起始index |\n| cells.N.columnEnd | Integer | 单元格坐标:列结束index |\n| cells.N.content | String | 单元格内容,字数不超过100 |\n\n表格参数headers说明\n\n| 名称 | 类型 | 描述 |\n| ------------------- | ------- | ------------------------------------------------- |\n| widthPercent | Integer | 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35 |\n| content | String | 表头单元格内容,字数不超过100 |",
|
3746
3717
|
"members": [
|
3747
3718
|
{
|
3748
|
-
"default": "",
|
3749
3719
|
"document": "合同名字,最大长度200个字符",
|
3750
3720
|
"example": "签署流程名称",
|
3751
3721
|
"member": "string",
|
@@ -3755,7 +3725,6 @@
|
|
3755
3725
|
"value_allowed_null": false
|
3756
3726
|
},
|
3757
3727
|
{
|
3758
|
-
"default": "",
|
3759
3728
|
"document": "签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年",
|
3760
3729
|
"example": "截止时间",
|
3761
3730
|
"member": "int64",
|
@@ -3765,7 +3734,6 @@
|
|
3765
3734
|
"value_allowed_null": false
|
3766
3735
|
},
|
3767
3736
|
{
|
3768
|
-
"default": "",
|
3769
3737
|
"document": "模板ID",
|
3770
3738
|
"example": "模板Id数组",
|
3771
3739
|
"member": "string",
|
@@ -3775,7 +3743,6 @@
|
|
3775
3743
|
"value_allowed_null": false
|
3776
3744
|
},
|
3777
3745
|
{
|
3778
|
-
"default": "",
|
3779
3746
|
"document": "多个签署人信息,最大支持50个签署方",
|
3780
3747
|
"example": "签署人信息",
|
3781
3748
|
"member": "FlowApproverInfo",
|
@@ -3785,7 +3752,6 @@
|
|
3785
3752
|
"value_allowed_null": false
|
3786
3753
|
},
|
3787
3754
|
{
|
3788
|
-
"default": "",
|
3789
3755
|
"document": "表单K-V对列表",
|
3790
3756
|
"example": "表单K-V对列表",
|
3791
3757
|
"member": "FormField",
|
@@ -3795,7 +3761,6 @@
|
|
3795
3761
|
"value_allowed_null": false
|
3796
3762
|
},
|
3797
3763
|
{
|
3798
|
-
"default": "",
|
3799
3764
|
"document": "回调地址,最大长度1000个字符",
|
3800
3765
|
"example": "回调地址",
|
3801
3766
|
"member": "string",
|
@@ -3805,7 +3770,6 @@
|
|
3805
3770
|
"value_allowed_null": false
|
3806
3771
|
},
|
3807
3772
|
{
|
3808
|
-
"default": "",
|
3809
3773
|
"document": "合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符",
|
3810
3774
|
"example": "签署流程类型",
|
3811
3775
|
"member": "string",
|
@@ -3815,7 +3779,6 @@
|
|
3815
3779
|
"value_allowed_null": false
|
3816
3780
|
},
|
3817
3781
|
{
|
3818
|
-
"default": "",
|
3819
3782
|
"document": "合同描述,最大长度1000个字符",
|
3820
3783
|
"example": "签署流程详情",
|
3821
3784
|
"member": "string",
|
@@ -3825,8 +3788,7 @@
|
|
3825
3788
|
"value_allowed_null": false
|
3826
3789
|
},
|
3827
3790
|
{
|
3828
|
-
"
|
3829
|
-
"document": "渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN",
|
3791
|
+
"document": " 第三方应用平台的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN",
|
3830
3792
|
"example": "\"xxx\"",
|
3831
3793
|
"member": "string",
|
3832
3794
|
"name": "CustomerData",
|
@@ -3835,7 +3797,6 @@
|
|
3835
3797
|
"value_allowed_null": false
|
3836
3798
|
},
|
3837
3799
|
{
|
3838
|
-
"default": "",
|
3839
3800
|
"document": "合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始",
|
3840
3801
|
"example": "合同名称:{合同名称} {发起方企业} {发起方姓名};国家:中国;发起方:{发起方企业};签署方1: {签署方1企业};签署",
|
3841
3802
|
"member": "string",
|
@@ -3845,7 +3806,6 @@
|
|
3845
3806
|
"value_allowed_null": false
|
3846
3807
|
},
|
3847
3808
|
{
|
3848
|
-
"default": "",
|
3849
3809
|
"document": "被抄送人的信息列表,抄送功能暂不开放",
|
3850
3810
|
"example": "xxx",
|
3851
3811
|
"member": "CcInfo",
|
@@ -3855,7 +3815,6 @@
|
|
3855
3815
|
"value_allowed_null": false
|
3856
3816
|
},
|
3857
3817
|
{
|
3858
|
-
"default": "",
|
3859
3818
|
"document": "发起方企业的签署人进行签署操作是否需要企业内部审批。\n若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。\n\n注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。",
|
3860
3819
|
"example": "true",
|
3861
3820
|
"member": "bool",
|
@@ -4165,7 +4124,7 @@
|
|
4165
4124
|
"type": "string"
|
4166
4125
|
},
|
4167
4126
|
{
|
4168
|
-
"document": "
|
4127
|
+
"document": "第三方应用平台模板库模板唯一标识",
|
4169
4128
|
"example": "无",
|
4170
4129
|
"member": "string",
|
4171
4130
|
"name": "TemplateId",
|
@@ -4203,7 +4162,7 @@
|
|
4203
4162
|
"document": "OperateChannelTemplate返回参数结构体",
|
4204
4163
|
"members": [
|
4205
4164
|
{
|
4206
|
-
"document": "
|
4165
|
+
"document": "腾讯电子签颁发给第三方应用平台的应用ID\n注意:此字段可能返回 null,表示取不到有效值。",
|
4207
4166
|
"example": "无",
|
4208
4167
|
"member": "string",
|
4209
4168
|
"name": "AppId",
|
@@ -4211,7 +4170,7 @@
|
|
4211
4170
|
"value_allowed_null": true
|
4212
4171
|
},
|
4213
4172
|
{
|
4214
|
-
"document": "
|
4173
|
+
"document": "第三方应用平台模板库模板唯一标识\n注意:此字段可能返回 null,表示取不到有效值。",
|
4215
4174
|
"example": "无",
|
4216
4175
|
"member": "string",
|
4217
4176
|
"name": "TemplateId",
|
@@ -4523,8 +4482,7 @@
|
|
4523
4482
|
"document": "合作企业经办人列表信息",
|
4524
4483
|
"members": [
|
4525
4484
|
{
|
4526
|
-
"
|
4527
|
-
"document": "对应Agent-ProxyOperator-OpenId。渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串",
|
4485
|
+
"document": "对应Agent-ProxyOperator-OpenId。第三方应用平台自定义,对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串",
|
4528
4486
|
"example": "无",
|
4529
4487
|
"member": "string",
|
4530
4488
|
"name": "Id",
|
@@ -4533,7 +4491,6 @@
|
|
4533
4491
|
"value_allowed_null": false
|
4534
4492
|
},
|
4535
4493
|
{
|
4536
|
-
"default": "",
|
4537
4494
|
"document": "经办人姓名,最大长度50个字符",
|
4538
4495
|
"example": "无",
|
4539
4496
|
"member": "string",
|
@@ -4543,7 +4500,6 @@
|
|
4543
4500
|
"value_allowed_null": false
|
4544
4501
|
},
|
4545
4502
|
{
|
4546
|
-
"default": "",
|
4547
4503
|
"document": "经办人身份证件类型\n1.ID_CARD 居民身份证\n2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证\n3.HONGKONG_AND_MACAO 港澳居民来往内地通行证",
|
4548
4504
|
"example": "无",
|
4549
4505
|
"member": "string",
|
@@ -4553,7 +4509,6 @@
|
|
4553
4509
|
"value_allowed_null": false
|
4554
4510
|
},
|
4555
4511
|
{
|
4556
|
-
"default": "",
|
4557
4512
|
"document": "经办人证件号",
|
4558
4513
|
"example": "无",
|
4559
4514
|
"member": "string",
|
@@ -4563,7 +4518,6 @@
|
|
4563
4518
|
"value_allowed_null": false
|
4564
4519
|
},
|
4565
4520
|
{
|
4566
|
-
"default": "",
|
4567
4521
|
"document": "经办人手机号,大陆手机号输入11位,暂不支持海外手机号。",
|
4568
4522
|
"example": "无",
|
4569
4523
|
"member": "string",
|
@@ -4571,6 +4525,15 @@
|
|
4571
4525
|
"required": false,
|
4572
4526
|
"type": "string",
|
4573
4527
|
"value_allowed_null": false
|
4528
|
+
},
|
4529
|
+
{
|
4530
|
+
"document": "默认角色,值为以下三个对应的英文:\n业务管理员:admin\n经办人:channel-normal-operator\n业务员:channel-sales-man\n注意:此字段可能返回 null,表示取不到有效值。",
|
4531
|
+
"example": "无",
|
4532
|
+
"member": "string",
|
4533
|
+
"name": "DefaultRole",
|
4534
|
+
"required": false,
|
4535
|
+
"type": "string",
|
4536
|
+
"value_allowed_null": true
|
4574
4537
|
}
|
4575
4538
|
],
|
4576
4539
|
"usage": "in"
|
@@ -4672,10 +4635,9 @@
|
|
4672
4635
|
"usage": "both"
|
4673
4636
|
},
|
4674
4637
|
"ReleasedApprover": {
|
4675
|
-
"document": "解除协议的签署人,如不指定,默认使用待解除流程(即原流程)中的签署人。\n注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该签署人。\n\n如果需要指定B端(机构身份类型)签署人,其中ReleasedApprover需要传递的参数如下:\nApproverNumber, OrganizationName, ApproverType必传。\n对于其他身份标识\n-
|
4638
|
+
"document": "解除协议的签署人,如不指定,默认使用待解除流程(即原流程)中的签署人。\n注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该签署人。\n\n如果需要指定B端(机构身份类型)签署人,其中ReleasedApprover需要传递的参数如下:\nApproverNumber, OrganizationName, ApproverType必传。\n对于其他身份标识\n- 子客企业指定经办人:OpenId必传,OrganizationOpenId必传;\n- 非子客企业:Name、Mobile必传。",
|
4676
4639
|
"members": [
|
4677
4640
|
{
|
4678
|
-
"default": "",
|
4679
4641
|
"document": "企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符",
|
4680
4642
|
"example": "xxx",
|
4681
4643
|
"member": "string",
|
@@ -4685,7 +4647,6 @@
|
|
4685
4647
|
"value_allowed_null": false
|
4686
4648
|
},
|
4687
4649
|
{
|
4688
|
-
"default": "",
|
4689
4650
|
"document": "签署人在原流程中的签署人列表中的顺序序号(从0开始,按顺序依次递增),如果不清楚原流程中的签署人列表,可以通过DescribeFlows接口查看",
|
4690
4651
|
"example": "0",
|
4691
4652
|
"member": "uint64",
|
@@ -4695,7 +4656,6 @@
|
|
4695
4656
|
"value_allowed_null": false
|
4696
4657
|
},
|
4697
4658
|
{
|
4698
|
-
"default": "",
|
4699
4659
|
"document": "签署人类型,目前仅支持\nORGANIZATION-企业",
|
4700
4660
|
"example": "ORGANIZATION",
|
4701
4661
|
"member": "string",
|
@@ -4705,7 +4665,6 @@
|
|
4705
4665
|
"value_allowed_null": false
|
4706
4666
|
},
|
4707
4667
|
{
|
4708
|
-
"default": "",
|
4709
4668
|
"document": "签署人姓名,最大长度50个字符",
|
4710
4669
|
"example": "张三",
|
4711
4670
|
"member": "string",
|
@@ -4715,7 +4674,6 @@
|
|
4715
4674
|
"value_allowed_null": false
|
4716
4675
|
},
|
4717
4676
|
{
|
4718
|
-
"default": "",
|
4719
4677
|
"document": "签署人身份证件类型\n1.ID_CARD 居民身份证\n2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证\n3.HONGKONG_AND_MACAO 港澳居民来往内地通行证",
|
4720
4678
|
"example": "ID_CARD",
|
4721
4679
|
"member": "string",
|
@@ -4725,7 +4683,6 @@
|
|
4725
4683
|
"value_allowed_null": false
|
4726
4684
|
},
|
4727
4685
|
{
|
4728
|
-
"default": "",
|
4729
4686
|
"document": "签署人证件号",
|
4730
4687
|
"example": "110101192008317114",
|
4731
4688
|
"member": "string",
|
@@ -4735,7 +4692,6 @@
|
|
4735
4692
|
"value_allowed_null": false
|
4736
4693
|
},
|
4737
4694
|
{
|
4738
|
-
"default": "",
|
4739
4695
|
"document": "签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号",
|
4740
4696
|
"example": "13888888888",
|
4741
4697
|
"member": "string",
|
@@ -4745,8 +4701,7 @@
|
|
4745
4701
|
"value_allowed_null": false
|
4746
4702
|
},
|
4747
4703
|
{
|
4748
|
-
"
|
4749
|
-
"document": "企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符",
|
4704
|
+
"document": "企业签署方在同一第三方应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符",
|
4750
4705
|
"example": "xxx",
|
4751
4706
|
"member": "string",
|
4752
4707
|
"name": "OrganizationOpenId",
|
@@ -4755,8 +4710,7 @@
|
|
4755
4710
|
"value_allowed_null": false
|
4756
4711
|
},
|
4757
4712
|
{
|
4758
|
-
"
|
4759
|
-
"document": "用户侧第三方id,最大长度64个字符\n当签署方为同一渠道下的员工时,该字必传",
|
4713
|
+
"document": "用户侧第三方id,最大长度64个字符\n当签署方为同一第三方应用下的员工时,该字必传",
|
4760
4714
|
"example": "xxx",
|
4761
4715
|
"member": "string",
|
4762
4716
|
"name": "OpenId",
|
@@ -5220,10 +5174,9 @@
|
|
5220
5174
|
"usage": "out"
|
5221
5175
|
},
|
5222
5176
|
"StaffRole": {
|
5223
|
-
"document": "
|
5177
|
+
"document": "第三方应用集成员工角色信息",
|
5224
5178
|
"members": [
|
5225
5179
|
{
|
5226
|
-
"default": "",
|
5227
5180
|
"document": "角色id\n注意:此字段可能返回 null,表示取不到有效值。",
|
5228
5181
|
"example": "无",
|
5229
5182
|
"member": "string",
|
@@ -5233,7 +5186,6 @@
|
|
5233
5186
|
"value_allowed_null": true
|
5234
5187
|
},
|
5235
5188
|
{
|
5236
|
-
"default": "",
|
5237
5189
|
"document": "角色名称\n注意:此字段可能返回 null,表示取不到有效值。",
|
5238
5190
|
"example": "无",
|
5239
5191
|
"member": "string",
|
@@ -5349,7 +5301,7 @@
|
|
5349
5301
|
"type": "object"
|
5350
5302
|
},
|
5351
5303
|
{
|
5352
|
-
"document": "
|
5304
|
+
"document": "第三方平台子客企业名称,最大长度64个字符",
|
5353
5305
|
"example": "无",
|
5354
5306
|
"member": "string",
|
5355
5307
|
"name": "ProxyOrganizationName",
|
@@ -5365,7 +5317,7 @@
|
|
5365
5317
|
"type": "string"
|
5366
5318
|
},
|
5367
5319
|
{
|
5368
|
-
"document": "
|
5320
|
+
"document": "第三方平台子客企业统一社会信用代码,最大长度200个字符",
|
5369
5321
|
"example": "无",
|
5370
5322
|
"member": "string",
|
5371
5323
|
"name": "UniformSocialCreditCode",
|
@@ -5373,7 +5325,7 @@
|
|
5373
5325
|
"type": "string"
|
5374
5326
|
},
|
5375
5327
|
{
|
5376
|
-
"document": "
|
5328
|
+
"document": "第三方平台子客企业法人/负责人姓名",
|
5377
5329
|
"example": "无",
|
5378
5330
|
"member": "string",
|
5379
5331
|
"name": "ProxyLegalName",
|
@@ -5433,7 +5385,6 @@
|
|
5433
5385
|
"document": "此结构体 (TemplateInfo) 用于描述模板的信息。",
|
5434
5386
|
"members": [
|
5435
5387
|
{
|
5436
|
-
"default": "",
|
5437
5388
|
"document": "模板ID",
|
5438
5389
|
"example": "无",
|
5439
5390
|
"member": "string",
|
@@ -5443,7 +5394,6 @@
|
|
5443
5394
|
"value_allowed_null": false
|
5444
5395
|
},
|
5445
5396
|
{
|
5446
|
-
"default": "",
|
5447
5397
|
"document": "模板名字",
|
5448
5398
|
"example": "无",
|
5449
5399
|
"member": "string",
|
@@ -5453,7 +5403,6 @@
|
|
5453
5403
|
"value_allowed_null": false
|
5454
5404
|
},
|
5455
5405
|
{
|
5456
|
-
"default": "",
|
5457
5406
|
"document": "模板描述信息",
|
5458
5407
|
"example": "无",
|
5459
5408
|
"member": "string",
|
@@ -5463,7 +5412,6 @@
|
|
5463
5412
|
"value_allowed_null": false
|
5464
5413
|
},
|
5465
5414
|
{
|
5466
|
-
"default": "",
|
5467
5415
|
"document": "模板控件信息结构",
|
5468
5416
|
"example": "无",
|
5469
5417
|
"member": "Component",
|
@@ -5473,7 +5421,6 @@
|
|
5473
5421
|
"value_allowed_null": false
|
5474
5422
|
},
|
5475
5423
|
{
|
5476
|
-
"default": "",
|
5477
5424
|
"document": "模板中的流程参与人信息",
|
5478
5425
|
"example": "无",
|
5479
5426
|
"member": "Recipient",
|
@@ -5483,7 +5430,6 @@
|
|
5483
5430
|
"value_allowed_null": false
|
5484
5431
|
},
|
5485
5432
|
{
|
5486
|
-
"default": "",
|
5487
5433
|
"document": "签署区模板信息结构",
|
5488
5434
|
"example": "无",
|
5489
5435
|
"member": "Component",
|
@@ -5493,7 +5439,6 @@
|
|
5493
5439
|
"value_allowed_null": false
|
5494
5440
|
},
|
5495
5441
|
{
|
5496
|
-
"default": "",
|
5497
5442
|
"document": "模板类型:1-静默签;3-普通模板",
|
5498
5443
|
"example": "3",
|
5499
5444
|
"member": "int64",
|
@@ -5503,7 +5448,6 @@
|
|
5503
5448
|
"value_allowed_null": false
|
5504
5449
|
},
|
5505
5450
|
{
|
5506
|
-
"default": "",
|
5507
5451
|
"document": "是否是发起人 ,已弃用",
|
5508
5452
|
"example": "true",
|
5509
5453
|
"member": "bool",
|
@@ -5513,7 +5457,6 @@
|
|
5513
5457
|
"value_allowed_null": false
|
5514
5458
|
},
|
5515
5459
|
{
|
5516
|
-
"default": "",
|
5517
5460
|
"document": "模板的创建者信息",
|
5518
5461
|
"example": "无",
|
5519
5462
|
"member": "string",
|
@@ -5523,7 +5466,6 @@
|
|
5523
5466
|
"value_allowed_null": false
|
5524
5467
|
},
|
5525
5468
|
{
|
5526
|
-
"default": "",
|
5527
5469
|
"document": "模板创建的时间戳(精确到秒)",
|
5528
5470
|
"example": "无",
|
5529
5471
|
"member": "int64",
|
@@ -5533,7 +5475,6 @@
|
|
5533
5475
|
"value_allowed_null": false
|
5534
5476
|
},
|
5535
5477
|
{
|
5536
|
-
"default": "",
|
5537
5478
|
"document": "模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。\n注意:此字段可能返回 null,表示取不到有效值。",
|
5538
5479
|
"example": "无",
|
5539
5480
|
"member": "string",
|
@@ -5543,8 +5484,7 @@
|
|
5543
5484
|
"value_allowed_null": true
|
5544
5485
|
},
|
5545
5486
|
{
|
5546
|
-
"
|
5547
|
-
"document": "渠道版-模板PDF文件链接\n注意:此字段可能返回 null,表示取不到有效值。",
|
5487
|
+
"document": "第三方应用集成-模板PDF文件链接\n注意:此字段可能返回 null,表示取不到有效值。",
|
5548
5488
|
"example": "无",
|
5549
5489
|
"member": "string",
|
5550
5490
|
"name": "PdfUrl",
|
@@ -5553,8 +5493,7 @@
|
|
5553
5493
|
"value_allowed_null": true
|
5554
5494
|
},
|
5555
5495
|
{
|
5556
|
-
"
|
5557
|
-
"document": "关联的渠道模板ID",
|
5496
|
+
"document": "关联的平台企业模板ID",
|
5558
5497
|
"example": "无",
|
5559
5498
|
"member": "string",
|
5560
5499
|
"name": "ChannelTemplateId",
|
@@ -5563,8 +5502,7 @@
|
|
5563
5502
|
"value_allowed_null": false
|
5564
5503
|
},
|
5565
5504
|
{
|
5566
|
-
"
|
5567
|
-
"document": "关联的渠道模板名称\n注意:此字段可能返回 null,表示取不到有效值。",
|
5505
|
+
"document": "关联的平台企业模板名称\n注意:此字段可能返回 null,表示取不到有效值。",
|
5568
5506
|
"example": "无",
|
5569
5507
|
"member": "string",
|
5570
5508
|
"name": "ChannelTemplateName",
|
@@ -5573,8 +5511,7 @@
|
|
5573
5511
|
"value_allowed_null": true
|
5574
5512
|
},
|
5575
5513
|
{
|
5576
|
-
"
|
5577
|
-
"document": "0-需要渠道子客手动领取渠道的模板(默认); 1-渠道自动设置子客模板\n注意:此字段可能返回 null,表示取不到有效值。",
|
5514
|
+
"document": "0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板\n注意:此字段可能返回 null,表示取不到有效值。",
|
5578
5515
|
"example": "无",
|
5579
5516
|
"member": "int64",
|
5580
5517
|
"name": "ChannelAutoSave",
|
@@ -5583,7 +5520,6 @@
|
|
5583
5520
|
"value_allowed_null": true
|
5584
5521
|
},
|
5585
5522
|
{
|
5586
|
-
"default": "",
|
5587
5523
|
"document": "模板版本,全数字字符。默认为空,初始版本为yyyyMMdd001。\n注意:此字段可能返回 null,表示取不到有效值。",
|
5588
5524
|
"example": "无",
|
5589
5525
|
"member": "string",
|
@@ -5623,8 +5559,7 @@
|
|
5623
5559
|
"document": "UploadFiles请求参数结构体",
|
5624
5560
|
"members": [
|
5625
5561
|
{
|
5626
|
-
"
|
5627
|
-
"document": "应用相关信息,若是渠道版调用 appid 和proxyappid 必填",
|
5562
|
+
"document": "应用相关信息,若是第三方应用集成调用 appid 和proxyappid 必填",
|
5628
5563
|
"example": "无",
|
5629
5564
|
"member": "Agent",
|
5630
5565
|
"name": "Agent",
|
@@ -5632,7 +5567,6 @@
|
|
5632
5567
|
"type": "object"
|
5633
5568
|
},
|
5634
5569
|
{
|
5635
|
-
"default": "",
|
5636
5570
|
"document": "文件对应业务类型\n1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html\n2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html",
|
5637
5571
|
"example": "TEMPLATE",
|
5638
5572
|
"member": "string",
|
@@ -5641,7 +5575,6 @@
|
|
5641
5575
|
"type": "string"
|
5642
5576
|
},
|
5643
5577
|
{
|
5644
|
-
"default": "",
|
5645
5578
|
"document": "上传文件内容数组,最多支持20个文件",
|
5646
5579
|
"example": "FileInfos",
|
5647
5580
|
"member": "UploadFile",
|
@@ -5650,7 +5583,6 @@
|
|
5650
5583
|
"type": "list"
|
5651
5584
|
},
|
5652
5585
|
{
|
5653
|
-
"default": "",
|
5654
5586
|
"document": "操作者的信息",
|
5655
5587
|
"example": "无",
|
5656
5588
|
"member": "UserInfo",
|
@@ -5669,7 +5601,6 @@
|
|
5669
5601
|
"example": "无",
|
5670
5602
|
"member": "string",
|
5671
5603
|
"name": "FileIds",
|
5672
|
-
"required": true,
|
5673
5604
|
"type": "list",
|
5674
5605
|
"value_allowed_null": false
|
5675
5606
|
},
|
@@ -5678,7 +5609,6 @@
|
|
5678
5609
|
"example": "20",
|
5679
5610
|
"member": "int64",
|
5680
5611
|
"name": "TotalCount",
|
5681
|
-
"required": true,
|
5682
5612
|
"type": "int",
|
5683
5613
|
"value_allowed_null": false
|
5684
5614
|
},
|
@@ -5687,7 +5617,6 @@
|
|
5687
5617
|
"example": "无",
|
5688
5618
|
"member": "string",
|
5689
5619
|
"name": "FileUrls",
|
5690
|
-
"required": true,
|
5691
5620
|
"type": "list",
|
5692
5621
|
"value_allowed_null": false
|
5693
5622
|
},
|
@@ -5704,8 +5633,7 @@
|
|
5704
5633
|
"document": "用量明细",
|
5705
5634
|
"members": [
|
5706
5635
|
{
|
5707
|
-
"
|
5708
|
-
"document": "渠道侧合作企业唯一标识",
|
5636
|
+
"document": "子客企业唯一标识",
|
5709
5637
|
"example": "无",
|
5710
5638
|
"member": "string",
|
5711
5639
|
"name": "ProxyOrganizationOpenId",
|
@@ -5714,8 +5642,7 @@
|
|
5714
5642
|
"value_allowed_null": false
|
5715
5643
|
},
|
5716
5644
|
{
|
5717
|
-
"
|
5718
|
-
"document": "渠道侧合作企业名\n注意:此字段可能返回 null,表示取不到有效值。",
|
5645
|
+
"document": "子客企业名\n注意:此字段可能返回 null,表示取不到有效值。",
|
5719
5646
|
"example": "无",
|
5720
5647
|
"member": "string",
|
5721
5648
|
"name": "ProxyOrganizationName",
|
@@ -5724,7 +5651,6 @@
|
|
5724
5651
|
"value_allowed_null": true
|
5725
5652
|
},
|
5726
5653
|
{
|
5727
|
-
"default": "",
|
5728
5654
|
"document": "日期,当需要汇总数据时日期为空\n注意:此字段可能返回 null,表示取不到有效值。",
|
5729
5655
|
"example": "2021-08-31",
|
5730
5656
|
"member": "date",
|
@@ -5734,7 +5660,6 @@
|
|
5734
5660
|
"value_allowed_null": true
|
5735
5661
|
},
|
5736
5662
|
{
|
5737
|
-
"default": "",
|
5738
5663
|
"document": "消耗数量",
|
5739
5664
|
"example": "50",
|
5740
5665
|
"member": "uint64",
|
@@ -5744,7 +5669,6 @@
|
|
5744
5669
|
"value_allowed_null": false
|
5745
5670
|
},
|
5746
5671
|
{
|
5747
|
-
"default": "",
|
5748
5672
|
"document": "撤回数量\n注意:此字段可能返回 null,表示取不到有效值。",
|
5749
5673
|
"example": "1",
|
5750
5674
|
"member": "uint64",
|
@@ -5754,7 +5678,6 @@
|
|
5754
5678
|
"value_allowed_null": true
|
5755
5679
|
},
|
5756
5680
|
{
|
5757
|
-
"default": "",
|
5758
5681
|
"document": "消耗渠道\n注意:此字段可能返回 null,表示取不到有效值。",
|
5759
5682
|
"example": "企业版",
|
5760
5683
|
"member": "string",
|
@@ -5770,8 +5693,7 @@
|
|
5770
5693
|
"document": "接口调用者信息",
|
5771
5694
|
"members": [
|
5772
5695
|
{
|
5773
|
-
"
|
5774
|
-
"document": "渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串",
|
5696
|
+
"document": "第三方应用平台自定义,对应第三方平台子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串",
|
5775
5697
|
"example": "无",
|
5776
5698
|
"member": "string",
|
5777
5699
|
"name": "OpenId",
|
@@ -5780,7 +5702,6 @@
|
|
5780
5702
|
"value_allowed_null": false
|
5781
5703
|
},
|
5782
5704
|
{
|
5783
|
-
"default": "",
|
5784
5705
|
"document": "内部参数,暂未开放使用",
|
5785
5706
|
"example": "无",
|
5786
5707
|
"member": "string",
|
@@ -5790,7 +5711,6 @@
|
|
5790
5711
|
"value_allowed_null": false
|
5791
5712
|
},
|
5792
5713
|
{
|
5793
|
-
"default": "",
|
5794
5714
|
"document": "内部参数,暂未开放使用",
|
5795
5715
|
"example": "无",
|
5796
5716
|
"member": "string",
|
@@ -5800,7 +5720,6 @@
|
|
5800
5720
|
"value_allowed_null": false
|
5801
5721
|
},
|
5802
5722
|
{
|
5803
|
-
"default": "",
|
5804
5723
|
"document": "内部参数,暂未开放使用",
|
5805
5724
|
"example": "无",
|
5806
5725
|
"member": "string",
|
@@ -5810,7 +5729,6 @@
|
|
5810
5729
|
"value_allowed_null": false
|
5811
5730
|
},
|
5812
5731
|
{
|
5813
|
-
"default": "",
|
5814
5732
|
"document": "内部参数,暂未开放使用",
|
5815
5733
|
"example": "无",
|
5816
5734
|
"member": "string",
|