tencentcloud-sdk-nodejs-essbasic 4.0.397 → 4.0.431
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.
- package/CHANGELOG.md +5389 -0
- package/README.md +3 -3
- package/SERVICE_CHANGELOG.md +3620 -52
- package/package.json +1 -1
- package/products.md +92 -92
- package/src/services/essbasic/index.ts +9 -6
- package/src/services/essbasic/v20201222/essbasic_client.ts +456 -611
- package/src/services/essbasic/v20201222/essbasic_models.ts +2565 -2438
- package/src/services/essbasic/v20201222/index.ts +3 -3
- package/src/services/essbasic/v20210526/essbasic_client.ts +218 -211
- package/src/services/essbasic/v20210526/essbasic_models.ts +1736 -1225
- package/src/services/essbasic/v20210526/index.ts +3 -3
- package/tencentcloud/services/essbasic/v20201222/essbasic_client.d.ts +89 -89
- package/tencentcloud/services/essbasic/v20201222/essbasic_client.js +89 -89
- package/tencentcloud/services/essbasic/v20201222/essbasic_models.d.ts +1454 -1454
- package/tencentcloud/services/essbasic/v20201222/index.js +1 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +73 -48
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +97 -62
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +1111 -724
- package/tencentcloud/services/essbasic/v20210526/index.js +1 -1
|
@@ -3,19 +3,19 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface ResourceUrlInfo {
|
|
5
5
|
/**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
6
|
+
* 资源链接地址,过期时间5分钟
|
|
7
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
8
|
+
*/
|
|
9
9
|
Url: string;
|
|
10
10
|
/**
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
* 资源名称
|
|
12
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
13
|
+
*/
|
|
14
14
|
Name: string;
|
|
15
15
|
/**
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
* 资源类型
|
|
17
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
18
|
+
*/
|
|
19
19
|
Type: string;
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
@@ -23,8 +23,8 @@ export interface ResourceUrlInfo {
|
|
|
23
23
|
*/
|
|
24
24
|
export interface SyncProxyOrganizationResponse {
|
|
25
25
|
/**
|
|
26
|
-
|
|
27
|
-
|
|
26
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
27
|
+
*/
|
|
28
28
|
RequestId?: string;
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
@@ -32,175 +32,199 @@ export interface SyncProxyOrganizationResponse {
|
|
|
32
32
|
*/
|
|
33
33
|
export interface FlowApproverInfo {
|
|
34
34
|
/**
|
|
35
|
-
|
|
36
|
-
|
|
35
|
+
* 签署人姓名,最大长度50个字符
|
|
36
|
+
*/
|
|
37
37
|
Name?: string;
|
|
38
38
|
/**
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
39
|
+
* 经办人身份证件类型
|
|
40
|
+
1.ID_CARD 居民身份证
|
|
41
|
+
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
42
|
+
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
43
|
+
*/
|
|
44
44
|
IdCardType?: string;
|
|
45
45
|
/**
|
|
46
|
-
|
|
47
|
-
|
|
46
|
+
* 经办人证件号
|
|
47
|
+
*/
|
|
48
48
|
IdCardNumber?: string;
|
|
49
49
|
/**
|
|
50
|
-
|
|
51
|
-
|
|
50
|
+
* 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
|
|
51
|
+
*/
|
|
52
52
|
Mobile?: string;
|
|
53
53
|
/**
|
|
54
|
-
|
|
55
|
-
|
|
54
|
+
* 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
55
|
+
*/
|
|
56
56
|
OrganizationName?: string;
|
|
57
57
|
/**
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
58
|
+
* 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
59
|
+
默认为false,即签署人位于同一个渠道应用号下;
|
|
60
|
+
*/
|
|
61
61
|
NotChannelOrganization?: boolean;
|
|
62
62
|
/**
|
|
63
|
-
|
|
64
|
-
|
|
63
|
+
* 用户侧第三方id,最大长度64个字符
|
|
64
|
+
*/
|
|
65
65
|
OpenId?: string;
|
|
66
66
|
/**
|
|
67
|
-
|
|
68
|
-
|
|
67
|
+
* 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
68
|
+
*/
|
|
69
69
|
OrganizationOpenId?: string;
|
|
70
70
|
/**
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
71
|
+
* 签署人类型,PERSON-个人;
|
|
72
|
+
PERSON_AUTO_SIGN-个人自动签;
|
|
73
|
+
ORGANIZATION-企业;
|
|
74
|
+
ENTERPRISESERVER-企业静默签;
|
|
75
|
+
注:ENTERPRISESERVER 类型仅用于使用文件创建签署流程(ChannelCreateFlowByFiles)接口;并且仅能指定发起方企业签署方为静默签署;
|
|
76
|
+
*/
|
|
77
77
|
ApproverType?: string;
|
|
78
78
|
/**
|
|
79
|
-
|
|
80
|
-
|
|
79
|
+
* 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
|
80
|
+
*/
|
|
81
81
|
RecipientId?: string;
|
|
82
82
|
/**
|
|
83
|
-
|
|
84
|
-
|
|
83
|
+
* 签署截止时间,默认一年
|
|
84
|
+
*/
|
|
85
85
|
Deadline?: number;
|
|
86
86
|
/**
|
|
87
|
-
|
|
88
|
-
|
|
87
|
+
* 签署完回调url,最大长度1000个字符
|
|
88
|
+
*/
|
|
89
89
|
CallbackUrl?: string;
|
|
90
90
|
/**
|
|
91
|
-
|
|
92
|
-
|
|
91
|
+
* 使用PDF文件直接发起合同时,签署人指定的签署控件
|
|
92
|
+
*/
|
|
93
93
|
SignComponents?: Array<Component>;
|
|
94
94
|
/**
|
|
95
|
-
|
|
96
|
-
|
|
95
|
+
* 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
|
|
96
|
+
*/
|
|
97
97
|
ComponentLimitType?: Array<string>;
|
|
98
98
|
/**
|
|
99
|
-
|
|
100
|
-
|
|
99
|
+
* 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
|
100
|
+
*/
|
|
101
101
|
PreReadTime?: number;
|
|
102
102
|
/**
|
|
103
|
-
|
|
104
|
-
|
|
103
|
+
* 签署完前端跳转的url,暂未使用
|
|
104
|
+
*/
|
|
105
105
|
JumpUrl?: string;
|
|
106
106
|
}
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
* ChannelCreateConvertTaskApi返回参数结构体
|
|
109
109
|
*/
|
|
110
|
-
export interface
|
|
110
|
+
export interface ChannelCreateConvertTaskApiResponse {
|
|
111
111
|
/**
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
112
|
+
* 任务id
|
|
113
|
+
*/
|
|
114
|
+
TaskId: string;
|
|
115
115
|
/**
|
|
116
|
-
|
|
117
|
-
|
|
116
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
117
|
+
*/
|
|
118
118
|
RequestId?: string;
|
|
119
119
|
}
|
|
120
120
|
/**
|
|
121
|
-
*
|
|
121
|
+
* OperateChannelTemplate请求参数结构体
|
|
122
122
|
*/
|
|
123
|
-
export interface
|
|
123
|
+
export interface OperateChannelTemplateRequest {
|
|
124
124
|
/**
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
125
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
126
|
+
*/
|
|
127
|
+
Agent: Agent;
|
|
128
128
|
/**
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
129
|
+
* 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
|
|
130
|
+
*/
|
|
131
|
+
OperateType: string;
|
|
132
132
|
/**
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
137
|
-
*/
|
|
138
|
-
IdCardType?: string;
|
|
133
|
+
* 渠道方模板库模板唯一标识
|
|
134
|
+
*/
|
|
135
|
+
TemplateId: string;
|
|
139
136
|
/**
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
137
|
+
* 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
|
|
138
|
+
*/
|
|
139
|
+
ProxyOrganizationOpenIds?: string;
|
|
143
140
|
/**
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
141
|
+
* 模板可见性, 全部可见-"all", 部分可见-"part"
|
|
142
|
+
*/
|
|
143
|
+
AuthTag?: string;
|
|
144
|
+
/**
|
|
145
|
+
* 操作者的信息
|
|
146
|
+
*/
|
|
147
|
+
Operator?: UserInfo;
|
|
147
148
|
}
|
|
148
149
|
/**
|
|
149
150
|
* 此结构体 (TemplateInfo) 用于描述模板的信息。
|
|
150
151
|
*/
|
|
151
152
|
export interface TemplateInfo {
|
|
152
153
|
/**
|
|
153
|
-
|
|
154
|
-
|
|
154
|
+
* 模板ID
|
|
155
|
+
*/
|
|
155
156
|
TemplateId: string;
|
|
156
157
|
/**
|
|
157
|
-
|
|
158
|
-
|
|
158
|
+
* 模板名字
|
|
159
|
+
*/
|
|
159
160
|
TemplateName: string;
|
|
160
161
|
/**
|
|
161
|
-
|
|
162
|
-
|
|
162
|
+
* 模板描述信息
|
|
163
|
+
*/
|
|
163
164
|
Description: string;
|
|
164
165
|
/**
|
|
165
|
-
|
|
166
|
-
|
|
166
|
+
* 模板控件信息结构
|
|
167
|
+
*/
|
|
167
168
|
Components: Array<Component>;
|
|
168
169
|
/**
|
|
169
|
-
|
|
170
|
-
|
|
170
|
+
* 签署区模板信息结构
|
|
171
|
+
*/
|
|
171
172
|
SignComponents: Array<Component>;
|
|
172
173
|
/**
|
|
173
|
-
|
|
174
|
-
|
|
174
|
+
* 模板中的流程参与人信息
|
|
175
|
+
*/
|
|
175
176
|
Recipients: Array<Recipient>;
|
|
176
177
|
/**
|
|
177
|
-
|
|
178
|
-
|
|
178
|
+
* 模板类型:1-静默签;3-普通模板
|
|
179
|
+
*/
|
|
179
180
|
TemplateType: number;
|
|
180
181
|
/**
|
|
181
|
-
|
|
182
|
-
|
|
182
|
+
* 是否是发起人
|
|
183
|
+
*/
|
|
183
184
|
IsPromoter: boolean;
|
|
184
185
|
/**
|
|
185
|
-
|
|
186
|
-
|
|
186
|
+
* 模板的创建者信息
|
|
187
|
+
*/
|
|
187
188
|
Creator: string;
|
|
188
189
|
/**
|
|
189
|
-
|
|
190
|
-
|
|
190
|
+
* 模板创建的时间戳(精确到秒)
|
|
191
|
+
*/
|
|
191
192
|
CreatedOn: number;
|
|
192
193
|
}
|
|
194
|
+
/**
|
|
195
|
+
* UploadFiles请求参数结构体
|
|
196
|
+
*/
|
|
197
|
+
export interface UploadFilesRequest {
|
|
198
|
+
/**
|
|
199
|
+
* 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
|
|
200
|
+
*/
|
|
201
|
+
Agent: Agent;
|
|
202
|
+
/**
|
|
203
|
+
* 文件对应业务类型,用于区分文件存储路径:
|
|
204
|
+
1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
|
|
205
|
+
2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
|
|
206
|
+
*/
|
|
207
|
+
BusinessType: string;
|
|
208
|
+
/**
|
|
209
|
+
* 上传文件内容数组,最多支持20个文件
|
|
210
|
+
*/
|
|
211
|
+
FileInfos?: Array<UploadFile>;
|
|
212
|
+
/**
|
|
213
|
+
* 操作者的信息
|
|
214
|
+
*/
|
|
215
|
+
Operator?: UserInfo;
|
|
216
|
+
}
|
|
193
217
|
/**
|
|
194
218
|
* GetDownloadFlowUrl返回参数结构体
|
|
195
219
|
*/
|
|
196
220
|
export interface GetDownloadFlowUrlResponse {
|
|
197
221
|
/**
|
|
198
|
-
|
|
199
|
-
|
|
222
|
+
* 合同(流程)下载地址
|
|
223
|
+
*/
|
|
200
224
|
DownLoadUrl: string;
|
|
201
225
|
/**
|
|
202
|
-
|
|
203
|
-
|
|
226
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
227
|
+
*/
|
|
204
228
|
RequestId?: string;
|
|
205
229
|
}
|
|
206
230
|
/**
|
|
@@ -208,17 +232,17 @@ export interface GetDownloadFlowUrlResponse {
|
|
|
208
232
|
*/
|
|
209
233
|
export interface DescribeResourceUrlsByFlowsResponse {
|
|
210
234
|
/**
|
|
211
|
-
|
|
212
|
-
|
|
235
|
+
* 签署流程资源对应链接信息
|
|
236
|
+
*/
|
|
213
237
|
FlowResourceUrlInfos: Array<FlowResourceUrlInfo>;
|
|
214
238
|
/**
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
239
|
+
* 创建消息,对应多个合同ID,
|
|
240
|
+
成功为“”,创建失败则对应失败消息
|
|
241
|
+
*/
|
|
218
242
|
ErrorMessages: Array<string>;
|
|
219
243
|
/**
|
|
220
|
-
|
|
221
|
-
|
|
244
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
245
|
+
*/
|
|
222
246
|
RequestId?: string;
|
|
223
247
|
}
|
|
224
248
|
/**
|
|
@@ -226,12 +250,16 @@ export interface DescribeResourceUrlsByFlowsResponse {
|
|
|
226
250
|
*/
|
|
227
251
|
export interface ChannelCreateMultiFlowSignQRCodeResponse {
|
|
228
252
|
/**
|
|
229
|
-
|
|
230
|
-
|
|
253
|
+
* 签署二维码对象
|
|
254
|
+
*/
|
|
231
255
|
QrCode: SignQrCode;
|
|
232
256
|
/**
|
|
233
|
-
|
|
234
|
-
|
|
257
|
+
* 签署链接对象
|
|
258
|
+
*/
|
|
259
|
+
SignUrls: SignUrl;
|
|
260
|
+
/**
|
|
261
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
262
|
+
*/
|
|
235
263
|
RequestId?: string;
|
|
236
264
|
}
|
|
237
265
|
/**
|
|
@@ -239,40 +267,40 @@ export interface ChannelCreateMultiFlowSignQRCodeResponse {
|
|
|
239
267
|
*/
|
|
240
268
|
export interface Recipient {
|
|
241
269
|
/**
|
|
242
|
-
|
|
243
|
-
|
|
270
|
+
* 签署人唯一标识
|
|
271
|
+
*/
|
|
244
272
|
RecipientId?: string;
|
|
245
273
|
/**
|
|
246
|
-
|
|
247
|
-
|
|
274
|
+
* 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
|
|
275
|
+
*/
|
|
248
276
|
RecipientType?: string;
|
|
249
277
|
/**
|
|
250
|
-
|
|
251
|
-
|
|
278
|
+
* 描述
|
|
279
|
+
*/
|
|
252
280
|
Description?: string;
|
|
253
281
|
/**
|
|
254
|
-
|
|
255
|
-
|
|
282
|
+
* 签署方备注信息
|
|
283
|
+
*/
|
|
256
284
|
RoleName?: string;
|
|
257
285
|
/**
|
|
258
|
-
|
|
259
|
-
|
|
286
|
+
* 是否需要校验
|
|
287
|
+
*/
|
|
260
288
|
RequireValidation?: boolean;
|
|
261
289
|
/**
|
|
262
|
-
|
|
263
|
-
|
|
290
|
+
* 是否必须填写
|
|
291
|
+
*/
|
|
264
292
|
RequireSign?: boolean;
|
|
265
293
|
/**
|
|
266
|
-
|
|
267
|
-
|
|
294
|
+
* 签署类型
|
|
295
|
+
*/
|
|
268
296
|
SignType?: number;
|
|
269
297
|
/**
|
|
270
|
-
|
|
271
|
-
|
|
298
|
+
* 签署顺序:数字越小优先级越高
|
|
299
|
+
*/
|
|
272
300
|
RoutingOrder?: number;
|
|
273
301
|
/**
|
|
274
|
-
|
|
275
|
-
|
|
302
|
+
* 是否是发起方
|
|
303
|
+
*/
|
|
276
304
|
IsPromoter?: boolean;
|
|
277
305
|
}
|
|
278
306
|
/**
|
|
@@ -280,24 +308,24 @@ export interface Recipient {
|
|
|
280
308
|
*/
|
|
281
309
|
export interface DescribeTemplatesResponse {
|
|
282
310
|
/**
|
|
283
|
-
|
|
284
|
-
|
|
311
|
+
* 模板详情
|
|
312
|
+
*/
|
|
285
313
|
Templates: Array<TemplateInfo>;
|
|
286
314
|
/**
|
|
287
|
-
|
|
288
|
-
|
|
315
|
+
* 查询总数
|
|
316
|
+
*/
|
|
289
317
|
TotalCount: number;
|
|
290
318
|
/**
|
|
291
|
-
|
|
292
|
-
|
|
319
|
+
* 查询数量
|
|
320
|
+
*/
|
|
293
321
|
Limit: number;
|
|
294
322
|
/**
|
|
295
|
-
|
|
296
|
-
|
|
323
|
+
* 查询起始偏移
|
|
324
|
+
*/
|
|
297
325
|
Offset: number;
|
|
298
326
|
/**
|
|
299
|
-
|
|
300
|
-
|
|
327
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
328
|
+
*/
|
|
301
329
|
RequestId?: string;
|
|
302
330
|
}
|
|
303
331
|
/**
|
|
@@ -305,38 +333,55 @@ export interface DescribeTemplatesResponse {
|
|
|
305
333
|
*/
|
|
306
334
|
export interface OperateChannelTemplateResponse {
|
|
307
335
|
/**
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
336
|
+
* 腾讯电子签颁发给渠道的应用ID
|
|
337
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
338
|
+
*/
|
|
311
339
|
AppId: string;
|
|
312
340
|
/**
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
341
|
+
* 渠道方模板库模板唯一标识
|
|
342
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
343
|
+
*/
|
|
316
344
|
TemplateId: string;
|
|
317
345
|
/**
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
346
|
+
* 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
|
|
347
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
348
|
+
*/
|
|
321
349
|
OperateResult: string;
|
|
322
350
|
/**
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
351
|
+
* 模板可见性, 全部可见-"all", 部分可见-"part"
|
|
352
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
353
|
+
*/
|
|
326
354
|
AuthTag: string;
|
|
327
355
|
/**
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
356
|
+
* 合作企业方第三方机构唯一标识数据
|
|
357
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
358
|
+
*/
|
|
331
359
|
ProxyOrganizationOpenIds: Array<string>;
|
|
332
360
|
/**
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
361
|
+
* 操作失败信息数组
|
|
362
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
363
|
+
*/
|
|
336
364
|
FailMessageList: Array<AuthFailMessage>;
|
|
337
365
|
/**
|
|
338
|
-
|
|
339
|
-
|
|
366
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
367
|
+
*/
|
|
368
|
+
RequestId?: string;
|
|
369
|
+
}
|
|
370
|
+
/**
|
|
371
|
+
* CreateSignUrls返回参数结构体
|
|
372
|
+
*/
|
|
373
|
+
export interface CreateSignUrlsResponse {
|
|
374
|
+
/**
|
|
375
|
+
* 签署参与者签署H5链接信息数组
|
|
376
|
+
*/
|
|
377
|
+
SignUrlInfos: Array<SignUrlInfo>;
|
|
378
|
+
/**
|
|
379
|
+
* 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
|
|
380
|
+
*/
|
|
381
|
+
ErrorMessages: Array<string>;
|
|
382
|
+
/**
|
|
383
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
384
|
+
*/
|
|
340
385
|
RequestId?: string;
|
|
341
386
|
}
|
|
342
387
|
/**
|
|
@@ -344,58 +389,58 @@ export interface OperateChannelTemplateResponse {
|
|
|
344
389
|
*/
|
|
345
390
|
export interface CreateSignUrlsRequest {
|
|
346
391
|
/**
|
|
347
|
-
|
|
348
|
-
|
|
392
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
393
|
+
*/
|
|
349
394
|
Agent: Agent;
|
|
350
395
|
/**
|
|
351
|
-
|
|
352
|
-
|
|
396
|
+
* 签署流程编号数组,最多支持100个。
|
|
397
|
+
*/
|
|
353
398
|
FlowIds: Array<string>;
|
|
354
399
|
/**
|
|
355
|
-
|
|
356
|
-
|
|
400
|
+
* 签署链接类型:“WEIXINAPP”-直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;默认“WEIXINAPP”类型,即跳转至小程序;
|
|
401
|
+
*/
|
|
357
402
|
Endpoint?: string;
|
|
358
403
|
/**
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
404
|
+
* 签署链接生成类型,默认是 "ALL";
|
|
405
|
+
"ALL":全部签署方签署链接;
|
|
406
|
+
"CHANNEL":渠道合作企业;
|
|
407
|
+
"NOT_CHANNEL":非渠道合作企业;
|
|
408
|
+
"PERSON":个人;
|
|
409
|
+
"FOLLOWER":关注方,目前是合同抄送方;
|
|
410
|
+
*/
|
|
366
411
|
GenerateType?: string;
|
|
367
412
|
/**
|
|
368
|
-
|
|
369
|
-
|
|
413
|
+
* 非渠道合作企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
|
|
414
|
+
*/
|
|
370
415
|
OrganizationName?: string;
|
|
371
416
|
/**
|
|
372
|
-
|
|
373
|
-
|
|
417
|
+
* 参与人姓名,GenerateType为"PERSON"时必填
|
|
418
|
+
*/
|
|
374
419
|
Name?: string;
|
|
375
420
|
/**
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
421
|
+
* 参与人手机号;
|
|
422
|
+
GenerateType为"PERSON"或"FOLLOWER"时必填
|
|
423
|
+
*/
|
|
379
424
|
Mobile?: string;
|
|
380
425
|
/**
|
|
381
|
-
|
|
382
|
-
|
|
426
|
+
* 渠道合作企业的企业Id,GenerateType为"CHANNEL"时必填
|
|
427
|
+
*/
|
|
383
428
|
OrganizationOpenId?: string;
|
|
384
429
|
/**
|
|
385
|
-
|
|
386
|
-
|
|
430
|
+
* 渠道合作企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人
|
|
431
|
+
*/
|
|
387
432
|
OpenId?: string;
|
|
388
433
|
/**
|
|
389
|
-
|
|
390
|
-
|
|
434
|
+
* Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
|
|
435
|
+
*/
|
|
391
436
|
AutoJumpBack?: boolean;
|
|
392
437
|
/**
|
|
393
|
-
|
|
394
|
-
|
|
438
|
+
* 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
|
|
439
|
+
*/
|
|
395
440
|
JumpUrl?: string;
|
|
396
441
|
/**
|
|
397
|
-
|
|
398
|
-
|
|
442
|
+
* 操作者的信息
|
|
443
|
+
*/
|
|
399
444
|
Operator?: UserInfo;
|
|
400
445
|
}
|
|
401
446
|
/**
|
|
@@ -403,39 +448,43 @@ export interface CreateSignUrlsRequest {
|
|
|
403
448
|
*/
|
|
404
449
|
export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
405
450
|
/**
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
451
|
+
* 渠道应用相关信息。
|
|
452
|
+
此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
|
|
453
|
+
*/
|
|
409
454
|
Agent: Agent;
|
|
410
455
|
/**
|
|
411
|
-
|
|
412
|
-
|
|
456
|
+
* 模版ID
|
|
457
|
+
*/
|
|
413
458
|
TemplateId: string;
|
|
414
459
|
/**
|
|
415
|
-
|
|
416
|
-
|
|
460
|
+
* 签署流程名称,最大长度200个字符。
|
|
461
|
+
*/
|
|
417
462
|
FlowName: string;
|
|
418
463
|
/**
|
|
419
|
-
|
|
420
|
-
|
|
464
|
+
* 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
|
|
465
|
+
*/
|
|
421
466
|
MaxFlowNum?: number;
|
|
422
467
|
/**
|
|
423
|
-
|
|
424
|
-
|
|
468
|
+
* 签署流程有效天数 默认7天 最高设置不超过30天
|
|
469
|
+
*/
|
|
425
470
|
FlowEffectiveDay?: number;
|
|
426
471
|
/**
|
|
427
|
-
|
|
428
|
-
|
|
472
|
+
* 二维码有效天数 默认7天 最高设置不超过90天
|
|
473
|
+
*/
|
|
429
474
|
QrEffectiveDay?: number;
|
|
430
475
|
/**
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
476
|
+
* 回调地址,最大长度1000个字符
|
|
477
|
+
不传默认使用渠道应用号配置的回调地址
|
|
478
|
+
回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
|
479
|
+
*/
|
|
435
480
|
CallbackUrl?: string;
|
|
436
481
|
/**
|
|
437
|
-
|
|
438
|
-
|
|
482
|
+
* 限制二维码用户条件
|
|
483
|
+
*/
|
|
484
|
+
ApproverRestrictions?: ApproverRestriction;
|
|
485
|
+
/**
|
|
486
|
+
* 用户信息
|
|
487
|
+
*/
|
|
439
488
|
Operator?: UserInfo;
|
|
440
489
|
}
|
|
441
490
|
/**
|
|
@@ -443,206 +492,268 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
443
492
|
*/
|
|
444
493
|
export interface AuthFailMessage {
|
|
445
494
|
/**
|
|
446
|
-
|
|
447
|
-
|
|
495
|
+
* 合作企业Id
|
|
496
|
+
*/
|
|
448
497
|
ProxyOrganizationOpenId: string;
|
|
449
498
|
/**
|
|
450
|
-
|
|
451
|
-
|
|
499
|
+
* 出错信息
|
|
500
|
+
*/
|
|
452
501
|
Message: string;
|
|
453
502
|
}
|
|
503
|
+
/**
|
|
504
|
+
* CreateChannelFlowEvidenceReport请求参数结构体
|
|
505
|
+
*/
|
|
506
|
+
export interface CreateChannelFlowEvidenceReportRequest {
|
|
507
|
+
/**
|
|
508
|
+
* 签署流程编号
|
|
509
|
+
*/
|
|
510
|
+
FlowId: string;
|
|
511
|
+
/**
|
|
512
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
|
|
513
|
+
*/
|
|
514
|
+
Agent: Agent;
|
|
515
|
+
/**
|
|
516
|
+
* 操作者的信息
|
|
517
|
+
*/
|
|
518
|
+
Operator?: UserInfo;
|
|
519
|
+
}
|
|
454
520
|
/**
|
|
455
521
|
* DescribeFlowDetailInfo请求参数结构体
|
|
456
522
|
*/
|
|
457
523
|
export interface DescribeFlowDetailInfoRequest {
|
|
458
524
|
/**
|
|
459
|
-
|
|
460
|
-
|
|
525
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
526
|
+
*/
|
|
461
527
|
Agent: Agent;
|
|
462
528
|
/**
|
|
463
|
-
|
|
464
|
-
|
|
529
|
+
* 合同(流程)编号数组,最多支持100个。
|
|
530
|
+
*/
|
|
465
531
|
FlowIds: Array<string>;
|
|
466
532
|
/**
|
|
467
|
-
|
|
468
|
-
|
|
533
|
+
* 操作者的信息
|
|
534
|
+
*/
|
|
469
535
|
Operator?: UserInfo;
|
|
470
536
|
}
|
|
471
537
|
/**
|
|
472
|
-
*
|
|
538
|
+
* ChannelGetTaskResultApi返回参数结构体
|
|
473
539
|
*/
|
|
474
|
-
export interface
|
|
475
|
-
/**
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
/**
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
540
|
+
export interface ChannelGetTaskResultApiResponse {
|
|
541
|
+
/**
|
|
542
|
+
* 任务Id
|
|
543
|
+
*/
|
|
544
|
+
TaskId: string;
|
|
545
|
+
/**
|
|
546
|
+
* 任务状态,需要关注的状态
|
|
547
|
+
0 :NeedTranform - 任务已提交
|
|
548
|
+
4 :Processing - 文档转换中
|
|
549
|
+
8 :TaskEnd - 任务处理完成
|
|
550
|
+
-2 :DownloadFailed - 下载失败
|
|
551
|
+
-6 :ProcessFailed - 转换失败
|
|
552
|
+
-13:ProcessTimeout - 转换文件超时
|
|
553
|
+
*/
|
|
554
|
+
TaskStatus: number;
|
|
555
|
+
/**
|
|
556
|
+
* 状态描述,需要关注的状态
|
|
557
|
+
NeedTranform - 任务已提交
|
|
558
|
+
Processing - 文档转换中
|
|
559
|
+
TaskEnd - 任务处理完成
|
|
560
|
+
DownloadFailed - 下载失败
|
|
561
|
+
ProcessFailed - 转换失败
|
|
562
|
+
ProcessTimeout - 转换文件超时
|
|
563
|
+
*/
|
|
564
|
+
TaskMessage: string;
|
|
565
|
+
/**
|
|
566
|
+
* 资源Id,也是FileId,用于文件发起使用
|
|
567
|
+
*/
|
|
568
|
+
ResourceId: string;
|
|
569
|
+
/**
|
|
570
|
+
* 预览文件Url,有效期30分钟
|
|
571
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
572
|
+
*/
|
|
573
|
+
PreviewUrl: string;
|
|
574
|
+
/**
|
|
575
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
576
|
+
*/
|
|
577
|
+
RequestId?: string;
|
|
487
578
|
}
|
|
488
579
|
/**
|
|
489
|
-
*
|
|
580
|
+
* 合作企业经办人列表信息
|
|
490
581
|
*/
|
|
491
|
-
export interface
|
|
582
|
+
export interface ProxyOrganizationOperator {
|
|
492
583
|
/**
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
584
|
+
* 经办人ID(渠道颁发),最大长度64个字符
|
|
585
|
+
*/
|
|
586
|
+
Id: string;
|
|
496
587
|
/**
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
*/
|
|
501
|
-
BusinessType: string;
|
|
588
|
+
* 经办人姓名,最大长度50个字符
|
|
589
|
+
*/
|
|
590
|
+
Name?: string;
|
|
502
591
|
/**
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
592
|
+
* 经办人身份证件类型
|
|
593
|
+
1.ID_CARD 居民身份证
|
|
594
|
+
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
595
|
+
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
596
|
+
*/
|
|
597
|
+
IdCardType?: string;
|
|
506
598
|
/**
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
599
|
+
* 经办人证件号
|
|
600
|
+
*/
|
|
601
|
+
IdCardNumber?: string;
|
|
602
|
+
/**
|
|
603
|
+
* 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
|
|
604
|
+
*/
|
|
605
|
+
Mobile?: string;
|
|
510
606
|
}
|
|
511
607
|
/**
|
|
512
|
-
*
|
|
608
|
+
* ChannelGetTaskResultApi请求参数结构体
|
|
513
609
|
*/
|
|
514
|
-
export interface
|
|
610
|
+
export interface ChannelGetTaskResultApiRequest {
|
|
515
611
|
/**
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
*/
|
|
612
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
613
|
+
*/
|
|
519
614
|
Agent: Agent;
|
|
520
615
|
/**
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
616
|
+
* 任务Id,通过ChannelCreateConvertTaskApi接口获得
|
|
617
|
+
*/
|
|
618
|
+
TaskId: string;
|
|
524
619
|
/**
|
|
525
|
-
|
|
526
|
-
|
|
620
|
+
* 操作者的信息
|
|
621
|
+
*/
|
|
527
622
|
Operator?: UserInfo;
|
|
623
|
+
/**
|
|
624
|
+
* 暂未开放
|
|
625
|
+
*/
|
|
626
|
+
Organization?: OrganizationInfo;
|
|
528
627
|
}
|
|
529
628
|
/**
|
|
530
629
|
* 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
|
|
531
630
|
*/
|
|
532
631
|
export interface UploadFile {
|
|
533
632
|
/**
|
|
534
|
-
|
|
535
|
-
|
|
633
|
+
* Base64编码后的文件内容
|
|
634
|
+
*/
|
|
536
635
|
FileBody: string;
|
|
537
636
|
/**
|
|
538
|
-
|
|
539
|
-
|
|
637
|
+
* 文件名
|
|
638
|
+
*/
|
|
540
639
|
FileName?: string;
|
|
541
640
|
}
|
|
542
641
|
/**
|
|
543
642
|
* 此结构体 (Component) 用于描述控件属性。
|
|
643
|
+
|
|
544
644
|
*/
|
|
545
645
|
export interface Component {
|
|
546
646
|
/**
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
647
|
+
* 控件编号
|
|
648
|
+
|
|
649
|
+
注:
|
|
650
|
+
当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
|
|
651
|
+
例:
|
|
652
|
+
当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
|
|
653
|
+
如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
|
|
654
|
+
|
|
655
|
+
创建控件时,此值为空
|
|
656
|
+
查询时返回完整结构
|
|
657
|
+
*/
|
|
558
658
|
ComponentId?: string;
|
|
559
659
|
/**
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
660
|
+
* 如果是Component控件类型,则可选的字段为:
|
|
661
|
+
TEXT - 普通文本控件;
|
|
662
|
+
MULTI_LINE_TEXT - 多行文本控件;
|
|
663
|
+
CHECK_BOX - 勾选框控件;
|
|
664
|
+
FILL_IMAGE - 图片控件;
|
|
665
|
+
DYNAMIC_TABLE - 动态表格控件;
|
|
666
|
+
ATTACHMENT - 附件控件;
|
|
667
|
+
SELECTOR - 选择器控件;
|
|
668
|
+
|
|
669
|
+
如果是SignComponent控件类型,则可选的字段为
|
|
670
|
+
SIGN_SEAL - 签署印章控件;
|
|
671
|
+
SIGN_DATE - 签署日期控件;
|
|
672
|
+
SIGN_SIGNATURE - 用户签名控件;
|
|
673
|
+
SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
|
|
674
|
+
|
|
675
|
+
表单域的控件不能作为印章和签名控件
|
|
676
|
+
*/
|
|
571
677
|
ComponentType?: string;
|
|
572
678
|
/**
|
|
573
|
-
|
|
574
|
-
|
|
679
|
+
* 控件简称,不能超过30个字符
|
|
680
|
+
*/
|
|
575
681
|
ComponentName?: string;
|
|
576
682
|
/**
|
|
577
|
-
|
|
578
|
-
|
|
683
|
+
* 定义控件是否为必填项,默认为false
|
|
684
|
+
*/
|
|
579
685
|
ComponentRequired?: boolean;
|
|
580
686
|
/**
|
|
581
|
-
|
|
582
|
-
|
|
687
|
+
* 控件所属文件的序号 (文档中文件的排列序号,从0开始)
|
|
688
|
+
*/
|
|
583
689
|
FileIndex?: number;
|
|
584
690
|
/**
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
691
|
+
* 控件生成的方式:
|
|
692
|
+
NORMAL - 普通控件
|
|
693
|
+
FIELD - 表单域
|
|
694
|
+
KEYWORD - 关键字
|
|
695
|
+
*/
|
|
590
696
|
GenerateMode?: string;
|
|
591
697
|
/**
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
698
|
+
* 参数控件宽度,默认100,单位px
|
|
699
|
+
表单域和关键字转换控件不用填
|
|
700
|
+
*/
|
|
595
701
|
ComponentWidth?: number;
|
|
596
702
|
/**
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
703
|
+
* 参数控件高度,默认100,单位px
|
|
704
|
+
表单域和关键字转换控件不用填
|
|
705
|
+
*/
|
|
600
706
|
ComponentHeight?: number;
|
|
601
707
|
/**
|
|
602
|
-
|
|
603
|
-
|
|
708
|
+
* 参数控件所在页码,从1开始
|
|
709
|
+
*/
|
|
604
710
|
ComponentPage?: number;
|
|
605
711
|
/**
|
|
606
|
-
|
|
607
|
-
|
|
712
|
+
* 参数控件X位置,单位px
|
|
713
|
+
*/
|
|
608
714
|
ComponentPosX?: number;
|
|
609
715
|
/**
|
|
610
|
-
|
|
611
|
-
|
|
716
|
+
* 参数控件Y位置,单位px
|
|
717
|
+
*/
|
|
612
718
|
ComponentPosY?: number;
|
|
613
719
|
/**
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
720
|
+
* 参数控件样式,json格式表述
|
|
721
|
+
不同类型的控件会有部分非通用参数
|
|
722
|
+
TEXT控件可以指定字体
|
|
723
|
+
例如:{"FontSize":12}
|
|
724
|
+
*/
|
|
619
725
|
ComponentExtra?: string;
|
|
620
726
|
/**
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
727
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
728
|
+
TEXT - 文本内容
|
|
729
|
+
MULTI_LINE_TEXT - 文本内容
|
|
730
|
+
CHECK_BOX - true/false
|
|
731
|
+
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
732
|
+
SELECTOR - 选项值
|
|
733
|
+
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
734
|
+
*/
|
|
624
735
|
ComponentValue?: string;
|
|
625
736
|
/**
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
737
|
+
* 日期签署控件的字号,默认为 12
|
|
738
|
+
|
|
739
|
+
签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
|
|
740
|
+
*/
|
|
630
741
|
ComponentDateFontSize?: number;
|
|
631
742
|
/**
|
|
632
|
-
|
|
633
|
-
|
|
743
|
+
* 控件所属文档的Id, 模块相关接口为空值
|
|
744
|
+
*/
|
|
634
745
|
DocumentId?: string;
|
|
635
746
|
/**
|
|
636
|
-
|
|
637
|
-
|
|
747
|
+
* 控件描述,不能超过30个字符
|
|
748
|
+
*/
|
|
638
749
|
ComponentDescription?: string;
|
|
639
750
|
/**
|
|
640
|
-
|
|
641
|
-
|
|
751
|
+
* 指定关键字时横坐标偏移量,单位pt
|
|
752
|
+
*/
|
|
642
753
|
OffsetX?: number;
|
|
643
754
|
/**
|
|
644
|
-
|
|
645
|
-
|
|
755
|
+
* 指定关键字时纵坐标偏移量,单位pt
|
|
756
|
+
*/
|
|
646
757
|
OffsetY?: number;
|
|
647
758
|
}
|
|
648
759
|
/**
|
|
@@ -650,16 +761,16 @@ export interface Component {
|
|
|
650
761
|
*/
|
|
651
762
|
export interface GetDownloadFlowUrlRequest {
|
|
652
763
|
/**
|
|
653
|
-
|
|
654
|
-
|
|
764
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
765
|
+
*/
|
|
655
766
|
Agent: Agent;
|
|
656
767
|
/**
|
|
657
|
-
|
|
658
|
-
|
|
768
|
+
* 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
|
|
769
|
+
*/
|
|
659
770
|
DownLoadFlows?: Array<DownloadFlowInfo>;
|
|
660
771
|
/**
|
|
661
|
-
|
|
662
|
-
|
|
772
|
+
* 操作者的信息
|
|
773
|
+
*/
|
|
663
774
|
Operator?: UserInfo;
|
|
664
775
|
}
|
|
665
776
|
/**
|
|
@@ -667,40 +778,40 @@ export interface GetDownloadFlowUrlRequest {
|
|
|
667
778
|
*/
|
|
668
779
|
export interface FlowDetailInfo {
|
|
669
780
|
/**
|
|
670
|
-
|
|
671
|
-
|
|
781
|
+
* 合同(流程)的Id
|
|
782
|
+
*/
|
|
672
783
|
FlowId: string;
|
|
673
784
|
/**
|
|
674
|
-
|
|
675
|
-
|
|
785
|
+
* 合同(流程)的名字
|
|
786
|
+
*/
|
|
676
787
|
FlowName: string;
|
|
677
788
|
/**
|
|
678
|
-
|
|
679
|
-
|
|
789
|
+
* 合同(流程)的类型
|
|
790
|
+
*/
|
|
680
791
|
FlowType: string;
|
|
681
792
|
/**
|
|
682
|
-
|
|
683
|
-
|
|
793
|
+
* 合同(流程)的状态
|
|
794
|
+
*/
|
|
684
795
|
FlowStatus: string;
|
|
685
796
|
/**
|
|
686
|
-
|
|
687
|
-
|
|
797
|
+
* 合同(流程)的信息
|
|
798
|
+
*/
|
|
688
799
|
FlowMessage: string;
|
|
689
800
|
/**
|
|
690
|
-
|
|
691
|
-
|
|
801
|
+
* 合同(流程)的创建时间戳
|
|
802
|
+
*/
|
|
692
803
|
CreateOn: number;
|
|
693
804
|
/**
|
|
694
|
-
|
|
695
|
-
|
|
805
|
+
* 合同(流程)的签署截止时间戳
|
|
806
|
+
*/
|
|
696
807
|
DeadLine: number;
|
|
697
808
|
/**
|
|
698
|
-
|
|
699
|
-
|
|
809
|
+
* 用户自定义数据
|
|
810
|
+
*/
|
|
700
811
|
CustomData: string;
|
|
701
812
|
/**
|
|
702
|
-
|
|
703
|
-
|
|
813
|
+
* 合同(流程)的签署人数组
|
|
814
|
+
*/
|
|
704
815
|
FlowApproverInfos: Array<FlowApproverDetail>;
|
|
705
816
|
}
|
|
706
817
|
/**
|
|
@@ -708,84 +819,137 @@ export interface FlowDetailInfo {
|
|
|
708
819
|
*/
|
|
709
820
|
export interface CreateConsoleLoginUrlRequest {
|
|
710
821
|
/**
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
822
|
+
* 应用信息
|
|
823
|
+
此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
|
|
824
|
+
*/
|
|
714
825
|
Agent: Agent;
|
|
715
826
|
/**
|
|
716
|
-
|
|
717
|
-
|
|
827
|
+
* 渠道侧合作企业名称,最大长度64个字符
|
|
828
|
+
*/
|
|
718
829
|
ProxyOrganizationName: string;
|
|
719
830
|
/**
|
|
720
|
-
|
|
721
|
-
|
|
831
|
+
* 渠道侧合作企业经办人的姓名,最大长度50个字符
|
|
832
|
+
*/
|
|
722
833
|
ProxyOperatorName?: string;
|
|
723
834
|
/**
|
|
724
|
-
|
|
725
|
-
|
|
835
|
+
* 控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
|
|
836
|
+
*/
|
|
726
837
|
Module?: string;
|
|
727
838
|
/**
|
|
728
|
-
|
|
729
|
-
|
|
839
|
+
* 控制台指定模块Id
|
|
840
|
+
*/
|
|
730
841
|
ModuleId?: string;
|
|
731
842
|
/**
|
|
732
|
-
|
|
733
|
-
|
|
843
|
+
* 渠道侧合作企业统一社会信用代码,最大长度200个字符
|
|
844
|
+
*/
|
|
734
845
|
UniformSocialCreditCode?: string;
|
|
735
846
|
/**
|
|
736
|
-
|
|
737
|
-
|
|
847
|
+
* 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
|
|
848
|
+
*/
|
|
738
849
|
MenuStatus?: string;
|
|
739
850
|
/**
|
|
740
|
-
|
|
741
|
-
|
|
851
|
+
* 操作者的信息
|
|
852
|
+
*/
|
|
742
853
|
Operator?: UserInfo;
|
|
743
854
|
}
|
|
855
|
+
/**
|
|
856
|
+
* 机构信息
|
|
857
|
+
*/
|
|
858
|
+
export interface OrganizationInfo {
|
|
859
|
+
/**
|
|
860
|
+
* 用户在渠道的机构编号
|
|
861
|
+
*/
|
|
862
|
+
OrganizationOpenId: string;
|
|
863
|
+
/**
|
|
864
|
+
* 用户真实的IP
|
|
865
|
+
*/
|
|
866
|
+
ClientIp: string;
|
|
867
|
+
/**
|
|
868
|
+
* 机构的代理IP
|
|
869
|
+
*/
|
|
870
|
+
ProxyIp: string;
|
|
871
|
+
/**
|
|
872
|
+
* 机构在平台的编号
|
|
873
|
+
*/
|
|
874
|
+
OrganizationId?: string;
|
|
875
|
+
/**
|
|
876
|
+
* 用户渠道
|
|
877
|
+
*/
|
|
878
|
+
Channel?: string;
|
|
879
|
+
}
|
|
744
880
|
/**
|
|
745
881
|
* CreateFlowsByTemplates返回参数结构体
|
|
746
882
|
*/
|
|
747
883
|
export interface CreateFlowsByTemplatesResponse {
|
|
748
884
|
/**
|
|
749
|
-
|
|
750
|
-
|
|
885
|
+
* 多个合同ID
|
|
886
|
+
*/
|
|
751
887
|
FlowIds: Array<string>;
|
|
752
888
|
/**
|
|
753
|
-
|
|
754
|
-
|
|
889
|
+
* 渠道的业务信息,限制1024字符
|
|
890
|
+
*/
|
|
755
891
|
CustomerData: Array<string>;
|
|
756
892
|
/**
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
893
|
+
* 创建消息,对应多个合同ID,
|
|
894
|
+
成功为“”,创建失败则对应失败消息
|
|
895
|
+
*/
|
|
760
896
|
ErrorMessages: Array<string>;
|
|
761
897
|
/**
|
|
762
|
-
|
|
763
|
-
|
|
898
|
+
* 预览模式下返回的预览文件url数组
|
|
899
|
+
*/
|
|
764
900
|
PreviewUrls: Array<string>;
|
|
765
901
|
/**
|
|
766
|
-
|
|
767
|
-
|
|
902
|
+
* 复杂文档合成任务的任务信息数组
|
|
903
|
+
*/
|
|
904
|
+
TaskInfos: Array<TaskInfo>;
|
|
905
|
+
/**
|
|
906
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
907
|
+
*/
|
|
768
908
|
RequestId?: string;
|
|
769
909
|
}
|
|
910
|
+
/**
|
|
911
|
+
* ChannelCreateFlowSignReview请求参数结构体
|
|
912
|
+
*/
|
|
913
|
+
export interface ChannelCreateFlowSignReviewRequest {
|
|
914
|
+
/**
|
|
915
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
916
|
+
*/
|
|
917
|
+
Agent: Agent;
|
|
918
|
+
/**
|
|
919
|
+
* 签署流程编号
|
|
920
|
+
*/
|
|
921
|
+
FlowId: string;
|
|
922
|
+
/**
|
|
923
|
+
* 企业内部审核结果
|
|
924
|
+
PASS: 通过
|
|
925
|
+
REJECT: 拒绝
|
|
926
|
+
*/
|
|
927
|
+
ReviewType: string;
|
|
928
|
+
/**
|
|
929
|
+
* 审核原因
|
|
930
|
+
当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
|
|
931
|
+
*/
|
|
932
|
+
ReviewMessage?: string;
|
|
933
|
+
}
|
|
770
934
|
/**
|
|
771
935
|
* PrepareFlows请求参数结构体
|
|
772
936
|
*/
|
|
773
937
|
export interface PrepareFlowsRequest {
|
|
774
938
|
/**
|
|
775
|
-
|
|
776
|
-
|
|
939
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
940
|
+
*/
|
|
777
941
|
Agent: Agent;
|
|
778
942
|
/**
|
|
779
|
-
|
|
780
|
-
|
|
943
|
+
* 多个合同(签署流程)信息,最大支持20个签署流程。
|
|
944
|
+
*/
|
|
781
945
|
FlowInfos: Array<FlowInfo>;
|
|
782
946
|
/**
|
|
783
|
-
|
|
784
|
-
|
|
947
|
+
* 操作完成后的跳转地址,最大长度200
|
|
948
|
+
*/
|
|
785
949
|
JumpUrl: string;
|
|
786
950
|
/**
|
|
787
|
-
|
|
788
|
-
|
|
951
|
+
* 操作者的信息
|
|
952
|
+
*/
|
|
789
953
|
Operator?: UserInfo;
|
|
790
954
|
}
|
|
791
955
|
/**
|
|
@@ -793,20 +957,20 @@ export interface PrepareFlowsRequest {
|
|
|
793
957
|
*/
|
|
794
958
|
export interface SyncProxyOrganizationOperatorsResponse {
|
|
795
959
|
/**
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
960
|
+
* Status 同步状态,全部同步失败接口会直接报错
|
|
961
|
+
1-成功
|
|
962
|
+
2-部分成功
|
|
963
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
964
|
+
*/
|
|
801
965
|
Status: number;
|
|
802
966
|
/**
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
967
|
+
* 同步失败经办人及其失败原因
|
|
968
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
969
|
+
*/
|
|
806
970
|
FailedList: Array<SyncFailReason>;
|
|
807
971
|
/**
|
|
808
|
-
|
|
809
|
-
|
|
972
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
973
|
+
*/
|
|
810
974
|
RequestId?: string;
|
|
811
975
|
}
|
|
812
976
|
/**
|
|
@@ -814,27 +978,44 @@ export interface SyncProxyOrganizationOperatorsResponse {
|
|
|
814
978
|
*/
|
|
815
979
|
export interface CreateSealByImageResponse {
|
|
816
980
|
/**
|
|
817
|
-
|
|
818
|
-
|
|
981
|
+
* 印章id
|
|
982
|
+
*/
|
|
819
983
|
SealId: string;
|
|
820
984
|
/**
|
|
821
|
-
|
|
822
|
-
|
|
985
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
986
|
+
*/
|
|
823
987
|
RequestId?: string;
|
|
824
988
|
}
|
|
989
|
+
/**
|
|
990
|
+
* 一码多扫签署二维码签署信息
|
|
991
|
+
*/
|
|
992
|
+
export interface SignUrl {
|
|
993
|
+
/**
|
|
994
|
+
* 小程序签署链接
|
|
995
|
+
*/
|
|
996
|
+
AppSignUrl: string;
|
|
997
|
+
/**
|
|
998
|
+
* 签署链接有效时间
|
|
999
|
+
*/
|
|
1000
|
+
EffectiveTime: string;
|
|
1001
|
+
/**
|
|
1002
|
+
* 移动端签署链接
|
|
1003
|
+
*/
|
|
1004
|
+
HttpSignUrl: string;
|
|
1005
|
+
}
|
|
825
1006
|
/**
|
|
826
1007
|
* 流程对应资源链接信息
|
|
827
1008
|
*/
|
|
828
1009
|
export interface FlowResourceUrlInfo {
|
|
829
1010
|
/**
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
1011
|
+
* 流程对应Id
|
|
1012
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1013
|
+
*/
|
|
833
1014
|
FlowId: string;
|
|
834
1015
|
/**
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
1016
|
+
* 流程对应资源链接信息数组
|
|
1017
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1018
|
+
*/
|
|
838
1019
|
ResourceUrlInfos: Array<ResourceUrlInfo>;
|
|
839
1020
|
}
|
|
840
1021
|
/**
|
|
@@ -842,28 +1023,28 @@ export interface FlowResourceUrlInfo {
|
|
|
842
1023
|
*/
|
|
843
1024
|
export interface DescribeTemplatesRequest {
|
|
844
1025
|
/**
|
|
845
|
-
|
|
846
|
-
|
|
1026
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1027
|
+
*/
|
|
847
1028
|
Agent: Agent;
|
|
848
1029
|
/**
|
|
849
|
-
|
|
850
|
-
|
|
1030
|
+
* 模板唯一标识
|
|
1031
|
+
*/
|
|
851
1032
|
TemplateId?: string;
|
|
852
1033
|
/**
|
|
853
|
-
|
|
854
|
-
|
|
1034
|
+
* 查询内容:0-模板列表及详情(默认),1-仅模板列表
|
|
1035
|
+
*/
|
|
855
1036
|
ContentType?: number;
|
|
856
1037
|
/**
|
|
857
|
-
|
|
858
|
-
|
|
1038
|
+
* 查询个数,默认20,最大100
|
|
1039
|
+
*/
|
|
859
1040
|
Limit?: number;
|
|
860
1041
|
/**
|
|
861
|
-
|
|
862
|
-
|
|
1042
|
+
* 查询偏移位置,默认0
|
|
1043
|
+
*/
|
|
863
1044
|
Offset?: number;
|
|
864
1045
|
/**
|
|
865
|
-
|
|
866
|
-
|
|
1046
|
+
* 操作者的信息
|
|
1047
|
+
*/
|
|
867
1048
|
Operator?: UserInfo;
|
|
868
1049
|
}
|
|
869
1050
|
/**
|
|
@@ -871,20 +1052,20 @@ export interface DescribeTemplatesRequest {
|
|
|
871
1052
|
*/
|
|
872
1053
|
export interface SyncProxyOrganizationOperatorsRequest {
|
|
873
1054
|
/**
|
|
874
|
-
|
|
875
|
-
|
|
1055
|
+
* 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
|
|
1056
|
+
*/
|
|
876
1057
|
Agent: Agent;
|
|
877
1058
|
/**
|
|
878
|
-
|
|
879
|
-
|
|
1059
|
+
* 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
|
|
1060
|
+
*/
|
|
880
1061
|
OperatorType: string;
|
|
881
1062
|
/**
|
|
882
|
-
|
|
883
|
-
|
|
1063
|
+
* 经办人信息列表,最大长度200
|
|
1064
|
+
*/
|
|
884
1065
|
ProxyOrganizationOperators: Array<ProxyOrganizationOperator>;
|
|
885
1066
|
/**
|
|
886
|
-
|
|
887
|
-
|
|
1067
|
+
* 操作者的信息
|
|
1068
|
+
*/
|
|
888
1069
|
Operator?: UserInfo;
|
|
889
1070
|
}
|
|
890
1071
|
/**
|
|
@@ -892,17 +1073,17 @@ export interface SyncProxyOrganizationOperatorsRequest {
|
|
|
892
1073
|
*/
|
|
893
1074
|
export interface CreateConsoleLoginUrlResponse {
|
|
894
1075
|
/**
|
|
895
|
-
|
|
896
|
-
|
|
1076
|
+
* 控制台url,此链接5分钟内有效,且只能访问一次
|
|
1077
|
+
*/
|
|
897
1078
|
ConsoleUrl: string;
|
|
898
1079
|
/**
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
1080
|
+
* 渠道合作企业是否认证开通腾讯电子签。
|
|
1081
|
+
当渠道合作企业未完成认证开通腾讯电子签,建议先调用同步企业信息(SyncProxyOrganization)和同步经办人信息(SyncProxyOrganizationOperators)接口成功后再跳转到登录页面。
|
|
1082
|
+
*/
|
|
902
1083
|
IsActivated: boolean;
|
|
903
1084
|
/**
|
|
904
|
-
|
|
905
|
-
|
|
1085
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1086
|
+
*/
|
|
906
1087
|
RequestId?: string;
|
|
907
1088
|
}
|
|
908
1089
|
/**
|
|
@@ -910,21 +1091,21 @@ export interface CreateConsoleLoginUrlResponse {
|
|
|
910
1091
|
*/
|
|
911
1092
|
export interface CreateFlowsByTemplatesRequest {
|
|
912
1093
|
/**
|
|
913
|
-
|
|
914
|
-
|
|
1094
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1095
|
+
*/
|
|
915
1096
|
Agent: Agent;
|
|
916
1097
|
/**
|
|
917
|
-
|
|
918
|
-
|
|
1098
|
+
* 多个合同(签署流程)信息,最多支持20个
|
|
1099
|
+
*/
|
|
919
1100
|
FlowInfos: Array<FlowInfo>;
|
|
920
1101
|
/**
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
1102
|
+
* 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,则返回PreviewUrls;
|
|
1103
|
+
预览链接有效期300秒;
|
|
1104
|
+
*/
|
|
924
1105
|
NeedPreview?: boolean;
|
|
925
1106
|
/**
|
|
926
|
-
|
|
927
|
-
|
|
1107
|
+
* 操作者的信息
|
|
1108
|
+
*/
|
|
928
1109
|
Operator?: UserInfo;
|
|
929
1110
|
}
|
|
930
1111
|
/**
|
|
@@ -932,25 +1113,25 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
932
1113
|
*/
|
|
933
1114
|
export interface SyncProxyOrganizationRequest {
|
|
934
1115
|
/**
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
1116
|
+
* 应用信息
|
|
1117
|
+
此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
|
|
1118
|
+
*/
|
|
938
1119
|
Agent: Agent;
|
|
939
1120
|
/**
|
|
940
|
-
|
|
941
|
-
|
|
1121
|
+
* 渠道侧合作企业名称,最大长度64个字符
|
|
1122
|
+
*/
|
|
942
1123
|
ProxyOrganizationName: string;
|
|
943
1124
|
/**
|
|
944
|
-
|
|
945
|
-
|
|
1125
|
+
* 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
|
|
1126
|
+
*/
|
|
946
1127
|
BusinessLicense?: string;
|
|
947
1128
|
/**
|
|
948
|
-
|
|
949
|
-
|
|
1129
|
+
* 渠道侧合作企业统一社会信用代码,最大长度200个字符
|
|
1130
|
+
*/
|
|
950
1131
|
UniformSocialCreditCode?: string;
|
|
951
1132
|
/**
|
|
952
|
-
|
|
953
|
-
|
|
1133
|
+
* 操作者的信息
|
|
1134
|
+
*/
|
|
954
1135
|
Operator?: UserInfo;
|
|
955
1136
|
}
|
|
956
1137
|
/**
|
|
@@ -958,63 +1139,55 @@ export interface SyncProxyOrganizationRequest {
|
|
|
958
1139
|
*/
|
|
959
1140
|
export interface CreateSealByImageRequest {
|
|
960
1141
|
/**
|
|
961
|
-
|
|
962
|
-
|
|
1142
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1143
|
+
*/
|
|
963
1144
|
Agent: Agent;
|
|
964
1145
|
/**
|
|
965
|
-
|
|
966
|
-
|
|
1146
|
+
* 印章名称,最大长度不超过30字符
|
|
1147
|
+
*/
|
|
967
1148
|
SealName: string;
|
|
968
1149
|
/**
|
|
969
|
-
|
|
970
|
-
|
|
1150
|
+
* 印章图片base64
|
|
1151
|
+
*/
|
|
971
1152
|
SealImage: string;
|
|
972
1153
|
/**
|
|
973
|
-
|
|
974
|
-
|
|
1154
|
+
* 操作者的信息
|
|
1155
|
+
*/
|
|
975
1156
|
Operator?: UserInfo;
|
|
976
1157
|
}
|
|
977
1158
|
/**
|
|
978
|
-
*
|
|
1159
|
+
* 一码多扫签署二维码对象
|
|
979
1160
|
*/
|
|
980
|
-
export interface
|
|
981
|
-
/**
|
|
982
|
-
* 用户在渠道的编号
|
|
983
|
-
*/
|
|
984
|
-
OpenId?: string;
|
|
985
|
-
/**
|
|
986
|
-
* 用户的来源渠道
|
|
987
|
-
*/
|
|
988
|
-
Channel?: string;
|
|
1161
|
+
export interface SignQrCode {
|
|
989
1162
|
/**
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
1163
|
+
* 二维码id
|
|
1164
|
+
*/
|
|
1165
|
+
QrCodeId: string;
|
|
993
1166
|
/**
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
1167
|
+
* 二维码url
|
|
1168
|
+
*/
|
|
1169
|
+
QrCodeUrl: string;
|
|
997
1170
|
/**
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1171
|
+
* 二维码过期时间
|
|
1172
|
+
*/
|
|
1173
|
+
ExpiredTime: number;
|
|
1001
1174
|
}
|
|
1002
1175
|
/**
|
|
1003
1176
|
* DescribeUsage返回参数结构体
|
|
1004
1177
|
*/
|
|
1005
1178
|
export interface DescribeUsageResponse {
|
|
1006
1179
|
/**
|
|
1007
|
-
|
|
1008
|
-
|
|
1180
|
+
* 用量明细条数
|
|
1181
|
+
*/
|
|
1009
1182
|
Total: number;
|
|
1010
1183
|
/**
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1184
|
+
* 用量明细
|
|
1185
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1186
|
+
*/
|
|
1014
1187
|
Details: Array<UsageDetail>;
|
|
1015
1188
|
/**
|
|
1016
|
-
|
|
1017
|
-
|
|
1189
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1190
|
+
*/
|
|
1018
1191
|
RequestId?: string;
|
|
1019
1192
|
}
|
|
1020
1193
|
/**
|
|
@@ -1022,73 +1195,66 @@ export interface DescribeUsageResponse {
|
|
|
1022
1195
|
*/
|
|
1023
1196
|
export interface UsageDetail {
|
|
1024
1197
|
/**
|
|
1025
|
-
|
|
1026
|
-
|
|
1198
|
+
* 渠道侧合作企业唯一标识
|
|
1199
|
+
*/
|
|
1027
1200
|
ProxyOrganizationOpenId: string;
|
|
1028
1201
|
/**
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1202
|
+
* 渠道侧合作企业名
|
|
1203
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1204
|
+
*/
|
|
1032
1205
|
ProxyOrganizationName: string;
|
|
1033
1206
|
/**
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1207
|
+
* 日期,当需要汇总数据时日期为空
|
|
1208
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1209
|
+
*/
|
|
1037
1210
|
Date: string;
|
|
1038
1211
|
/**
|
|
1039
|
-
|
|
1040
|
-
|
|
1212
|
+
* 消耗数量
|
|
1213
|
+
*/
|
|
1041
1214
|
Usage: number;
|
|
1042
1215
|
/**
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1216
|
+
* 撤回数量
|
|
1217
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1218
|
+
*/
|
|
1046
1219
|
Cancel: number;
|
|
1047
1220
|
}
|
|
1048
1221
|
/**
|
|
1049
|
-
*
|
|
1222
|
+
* ChannelCreateBatchCancelFlowUrl返回参数结构体
|
|
1050
1223
|
*/
|
|
1051
|
-
export interface
|
|
1224
|
+
export interface ChannelCreateBatchCancelFlowUrlResponse {
|
|
1052
1225
|
/**
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1226
|
+
* 批量撤销url
|
|
1227
|
+
*/
|
|
1228
|
+
BatchCancelFlowUrl: string;
|
|
1056
1229
|
/**
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1230
|
+
* 签署流程批量撤销失败原因
|
|
1231
|
+
*/
|
|
1232
|
+
FailMessages: Array<string>;
|
|
1060
1233
|
/**
|
|
1061
|
-
|
|
1062
|
-
|
|
1234
|
+
* 签署撤销url过期时间-年月日-时分秒
|
|
1235
|
+
*/
|
|
1236
|
+
UrlExpireOn: string;
|
|
1237
|
+
/**
|
|
1238
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1239
|
+
*/
|
|
1063
1240
|
RequestId?: string;
|
|
1064
1241
|
}
|
|
1065
1242
|
/**
|
|
1066
|
-
*
|
|
1243
|
+
* DescribeResourceUrlsByFlows请求参数结构体
|
|
1067
1244
|
*/
|
|
1068
|
-
export interface
|
|
1245
|
+
export interface DescribeResourceUrlsByFlowsRequest {
|
|
1069
1246
|
/**
|
|
1070
|
-
|
|
1071
|
-
|
|
1247
|
+
* 渠道应用相关信息。
|
|
1248
|
+
此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1249
|
+
*/
|
|
1072
1250
|
Agent: Agent;
|
|
1073
1251
|
/**
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
/**
|
|
1078
|
-
* 渠道方模板库模板唯一标识
|
|
1079
|
-
*/
|
|
1080
|
-
TemplateId: string;
|
|
1081
|
-
/**
|
|
1082
|
-
* 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
|
|
1083
|
-
*/
|
|
1084
|
-
ProxyOrganizationOpenIds?: string;
|
|
1085
|
-
/**
|
|
1086
|
-
* 模板可见性, 全部可见-"all", 部分可见-"part"
|
|
1087
|
-
*/
|
|
1088
|
-
AuthTag?: string;
|
|
1252
|
+
* 查询资源所对应的签署流程Id,最多支持50个。
|
|
1253
|
+
*/
|
|
1254
|
+
FlowIds?: Array<string>;
|
|
1089
1255
|
/**
|
|
1090
|
-
|
|
1091
|
-
|
|
1256
|
+
* 操作者的信息
|
|
1257
|
+
*/
|
|
1092
1258
|
Operator?: UserInfo;
|
|
1093
1259
|
}
|
|
1094
1260
|
/**
|
|
@@ -1096,12 +1262,12 @@ export interface OperateChannelTemplateRequest {
|
|
|
1096
1262
|
*/
|
|
1097
1263
|
export interface DownloadFlowInfo {
|
|
1098
1264
|
/**
|
|
1099
|
-
|
|
1100
|
-
|
|
1265
|
+
* 文件夹名称
|
|
1266
|
+
*/
|
|
1101
1267
|
FileName: string;
|
|
1102
1268
|
/**
|
|
1103
|
-
|
|
1104
|
-
|
|
1269
|
+
* 签署流程的标识数组
|
|
1270
|
+
*/
|
|
1105
1271
|
FlowIdList: Array<string>;
|
|
1106
1272
|
}
|
|
1107
1273
|
/**
|
|
@@ -1109,124 +1275,192 @@ export interface DownloadFlowInfo {
|
|
|
1109
1275
|
*/
|
|
1110
1276
|
export interface ChannelCancelMultiFlowSignQRCodeRequest {
|
|
1111
1277
|
/**
|
|
1112
|
-
|
|
1113
|
-
|
|
1278
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1279
|
+
*/
|
|
1114
1280
|
Agent: Agent;
|
|
1115
1281
|
/**
|
|
1116
|
-
|
|
1117
|
-
|
|
1282
|
+
* 二维码id
|
|
1283
|
+
*/
|
|
1118
1284
|
QrCodeId: string;
|
|
1119
1285
|
/**
|
|
1120
|
-
|
|
1121
|
-
|
|
1286
|
+
* 用户信息
|
|
1287
|
+
*/
|
|
1122
1288
|
Operator?: UserInfo;
|
|
1123
1289
|
}
|
|
1290
|
+
/**
|
|
1291
|
+
* CreateChannelFlowEvidenceReport返回参数结构体
|
|
1292
|
+
*/
|
|
1293
|
+
export interface CreateChannelFlowEvidenceReportResponse {
|
|
1294
|
+
/**
|
|
1295
|
+
* 出证报告 URL(有效五分钟)
|
|
1296
|
+
*/
|
|
1297
|
+
ReportUrl: string;
|
|
1298
|
+
/**
|
|
1299
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1300
|
+
*/
|
|
1301
|
+
RequestId?: string;
|
|
1302
|
+
}
|
|
1124
1303
|
/**
|
|
1125
1304
|
* 同步经办人失败原因
|
|
1126
1305
|
*/
|
|
1127
1306
|
export interface SyncFailReason {
|
|
1128
1307
|
/**
|
|
1129
|
-
|
|
1130
|
-
|
|
1308
|
+
* 经办人Id
|
|
1309
|
+
*/
|
|
1131
1310
|
Id: string;
|
|
1132
1311
|
/**
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1312
|
+
* 失败原因
|
|
1313
|
+
例如:Id不符合规范、证件号码不合法等
|
|
1314
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1315
|
+
*/
|
|
1137
1316
|
Message: string;
|
|
1138
1317
|
}
|
|
1318
|
+
/**
|
|
1319
|
+
* PrepareFlows返回参数结构体
|
|
1320
|
+
*/
|
|
1321
|
+
export interface PrepareFlowsResponse {
|
|
1322
|
+
/**
|
|
1323
|
+
* 待发起文件确认页
|
|
1324
|
+
*/
|
|
1325
|
+
ConfirmUrl: string;
|
|
1326
|
+
/**
|
|
1327
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1328
|
+
*/
|
|
1329
|
+
RequestId?: string;
|
|
1330
|
+
}
|
|
1139
1331
|
/**
|
|
1140
1332
|
* DescribeUsage请求参数结构体
|
|
1141
1333
|
*/
|
|
1142
1334
|
export interface DescribeUsageRequest {
|
|
1143
1335
|
/**
|
|
1144
|
-
|
|
1145
|
-
|
|
1336
|
+
* 应用信息
|
|
1337
|
+
*/
|
|
1146
1338
|
Agent: Agent;
|
|
1147
1339
|
/**
|
|
1148
|
-
|
|
1149
|
-
|
|
1340
|
+
* 开始时间,例如:2021-03-21
|
|
1341
|
+
*/
|
|
1150
1342
|
StartDate: string;
|
|
1151
1343
|
/**
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1344
|
+
* 结束时间,例如:2021-06-21;
|
|
1345
|
+
开始时间到结束时间的区间长度小于等于90天。
|
|
1346
|
+
*/
|
|
1155
1347
|
EndDate: string;
|
|
1156
1348
|
/**
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1349
|
+
* 是否汇总数据,默认不汇总。
|
|
1350
|
+
不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
|
|
1351
|
+
汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
|
|
1352
|
+
*/
|
|
1161
1353
|
NeedAggregate?: boolean;
|
|
1162
1354
|
/**
|
|
1163
|
-
|
|
1164
|
-
|
|
1355
|
+
* 单次返回的最多条目数量。默认为1000,且不能超过1000。
|
|
1356
|
+
*/
|
|
1165
1357
|
Limit?: number;
|
|
1166
1358
|
/**
|
|
1167
|
-
|
|
1168
|
-
|
|
1359
|
+
* 偏移量,默认是0。
|
|
1360
|
+
*/
|
|
1169
1361
|
Offset?: number;
|
|
1170
1362
|
/**
|
|
1171
|
-
|
|
1172
|
-
|
|
1363
|
+
* 操作者的信息
|
|
1364
|
+
*/
|
|
1173
1365
|
Operator?: UserInfo;
|
|
1174
1366
|
}
|
|
1367
|
+
/**
|
|
1368
|
+
* ChannelCreateBatchCancelFlowUrl请求参数结构体
|
|
1369
|
+
*/
|
|
1370
|
+
export interface ChannelCreateBatchCancelFlowUrlRequest {
|
|
1371
|
+
/**
|
|
1372
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1373
|
+
*/
|
|
1374
|
+
Agent: Agent;
|
|
1375
|
+
/**
|
|
1376
|
+
* 签署流程Id数组
|
|
1377
|
+
*/
|
|
1378
|
+
FlowIds: Array<string>;
|
|
1379
|
+
/**
|
|
1380
|
+
* 操作人信息
|
|
1381
|
+
*/
|
|
1382
|
+
Operator?: UserInfo;
|
|
1383
|
+
}
|
|
1384
|
+
/**
|
|
1385
|
+
* 指定签署人限制项
|
|
1386
|
+
*/
|
|
1387
|
+
export interface ApproverRestriction {
|
|
1388
|
+
/**
|
|
1389
|
+
* 指定签署人名字
|
|
1390
|
+
*/
|
|
1391
|
+
Name?: string;
|
|
1392
|
+
/**
|
|
1393
|
+
* 指定签署人手机号
|
|
1394
|
+
*/
|
|
1395
|
+
Mobile?: string;
|
|
1396
|
+
/**
|
|
1397
|
+
* 指定签署人证件类型
|
|
1398
|
+
*/
|
|
1399
|
+
IdCardType?: string;
|
|
1400
|
+
/**
|
|
1401
|
+
* 指定签署人证件号码
|
|
1402
|
+
*/
|
|
1403
|
+
IdCardNumber?: string;
|
|
1404
|
+
}
|
|
1175
1405
|
/**
|
|
1176
1406
|
* ChannelCreateFlowByFiles请求参数结构体
|
|
1177
1407
|
*/
|
|
1178
1408
|
export interface ChannelCreateFlowByFilesRequest {
|
|
1179
1409
|
/**
|
|
1180
|
-
|
|
1181
|
-
|
|
1410
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1411
|
+
*/
|
|
1182
1412
|
Agent?: Agent;
|
|
1183
1413
|
/**
|
|
1184
|
-
|
|
1185
|
-
|
|
1414
|
+
* 签署流程名称,长度不超过200个字符
|
|
1415
|
+
*/
|
|
1186
1416
|
FlowName?: string;
|
|
1187
1417
|
/**
|
|
1188
|
-
|
|
1189
|
-
|
|
1418
|
+
* 签署流程签约方列表,最多不超过5个参与方
|
|
1419
|
+
*/
|
|
1190
1420
|
FlowApprovers?: Array<FlowApproverInfo>;
|
|
1191
1421
|
/**
|
|
1192
|
-
|
|
1193
|
-
|
|
1422
|
+
* 签署文件资源Id列表,目前仅支持单个文件
|
|
1423
|
+
*/
|
|
1194
1424
|
FileIds?: Array<string>;
|
|
1195
1425
|
/**
|
|
1196
|
-
|
|
1197
|
-
|
|
1426
|
+
* 签署文件中的控件,如:填写控件等
|
|
1427
|
+
*/
|
|
1198
1428
|
Components?: Array<Component>;
|
|
1199
1429
|
/**
|
|
1200
|
-
|
|
1201
|
-
|
|
1430
|
+
* 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
|
|
1431
|
+
*/
|
|
1202
1432
|
Deadline?: number;
|
|
1203
1433
|
/**
|
|
1204
|
-
|
|
1205
|
-
|
|
1434
|
+
* 签署流程回调地址,长度不超过255个字符
|
|
1435
|
+
*/
|
|
1206
1436
|
CallbackUrl?: string;
|
|
1207
1437
|
/**
|
|
1208
|
-
|
|
1209
|
-
|
|
1438
|
+
* 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
|
|
1439
|
+
*/
|
|
1210
1440
|
Unordered?: boolean;
|
|
1211
1441
|
/**
|
|
1212
|
-
|
|
1213
|
-
|
|
1442
|
+
* 签署流程的类型,长度不超过255个字符
|
|
1443
|
+
*/
|
|
1214
1444
|
FlowType?: string;
|
|
1215
1445
|
/**
|
|
1216
|
-
|
|
1217
|
-
|
|
1446
|
+
* 签署流程的描述,长度不超过1000个字符
|
|
1447
|
+
*/
|
|
1218
1448
|
FlowDescription?: string;
|
|
1219
1449
|
/**
|
|
1220
|
-
|
|
1221
|
-
|
|
1450
|
+
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
1451
|
+
*/
|
|
1222
1452
|
CustomShowMap?: string;
|
|
1223
1453
|
/**
|
|
1224
|
-
|
|
1225
|
-
|
|
1454
|
+
* 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
1455
|
+
*/
|
|
1226
1456
|
CustomerData?: string;
|
|
1227
1457
|
/**
|
|
1228
|
-
|
|
1229
|
-
|
|
1458
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
1459
|
+
*/
|
|
1460
|
+
NeedSignReview?: boolean;
|
|
1461
|
+
/**
|
|
1462
|
+
* 操作者的信息
|
|
1463
|
+
*/
|
|
1230
1464
|
Operator?: UserInfo;
|
|
1231
1465
|
}
|
|
1232
1466
|
/**
|
|
@@ -1234,13 +1468,13 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
1234
1468
|
*/
|
|
1235
1469
|
export interface ChannelCreateFlowByFilesResponse {
|
|
1236
1470
|
/**
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1471
|
+
* 合同签署流程ID
|
|
1472
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1473
|
+
*/
|
|
1240
1474
|
FlowId: string;
|
|
1241
1475
|
/**
|
|
1242
|
-
|
|
1243
|
-
|
|
1476
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1477
|
+
*/
|
|
1244
1478
|
RequestId?: string;
|
|
1245
1479
|
}
|
|
1246
1480
|
/**
|
|
@@ -1248,20 +1482,29 @@ export interface ChannelCreateFlowByFilesResponse {
|
|
|
1248
1482
|
*/
|
|
1249
1483
|
export interface UploadFilesResponse {
|
|
1250
1484
|
/**
|
|
1251
|
-
|
|
1252
|
-
|
|
1485
|
+
* 文件id数组,有效期一个小时
|
|
1486
|
+
*/
|
|
1253
1487
|
FileIds: Array<string>;
|
|
1254
1488
|
/**
|
|
1255
|
-
|
|
1256
|
-
|
|
1489
|
+
* 上传成功文件数量
|
|
1490
|
+
*/
|
|
1257
1491
|
TotalCount: number;
|
|
1258
1492
|
/**
|
|
1259
|
-
|
|
1260
|
-
|
|
1493
|
+
* 文件Url
|
|
1494
|
+
*/
|
|
1261
1495
|
FileUrls: Array<string>;
|
|
1262
1496
|
/**
|
|
1263
|
-
|
|
1264
|
-
|
|
1497
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1498
|
+
*/
|
|
1499
|
+
RequestId?: string;
|
|
1500
|
+
}
|
|
1501
|
+
/**
|
|
1502
|
+
* ChannelCreateFlowSignReview返回参数结构体
|
|
1503
|
+
*/
|
|
1504
|
+
export interface ChannelCreateFlowSignReviewResponse {
|
|
1505
|
+
/**
|
|
1506
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1507
|
+
*/
|
|
1265
1508
|
RequestId?: string;
|
|
1266
1509
|
}
|
|
1267
1510
|
/**
|
|
@@ -1269,222 +1512,366 @@ export interface UploadFilesResponse {
|
|
|
1269
1512
|
*/
|
|
1270
1513
|
export interface Agent {
|
|
1271
1514
|
/**
|
|
1272
|
-
|
|
1273
|
-
|
|
1515
|
+
* 腾讯电子签颁发给渠道的应用ID,32位字符串
|
|
1516
|
+
*/
|
|
1274
1517
|
AppId: string;
|
|
1275
1518
|
/**
|
|
1276
|
-
|
|
1277
|
-
|
|
1519
|
+
* 渠道/平台合作企业的企业ID,最大64位字符串
|
|
1520
|
+
*/
|
|
1278
1521
|
ProxyOrganizationOpenId?: string;
|
|
1279
1522
|
/**
|
|
1280
|
-
|
|
1281
|
-
|
|
1523
|
+
* 渠道/平台合作企业经办人(操作员)
|
|
1524
|
+
*/
|
|
1282
1525
|
ProxyOperator?: UserInfo;
|
|
1283
1526
|
/**
|
|
1284
|
-
|
|
1285
|
-
|
|
1527
|
+
* 腾讯电子签颁发给渠道侧合作企业的应用ID
|
|
1528
|
+
*/
|
|
1286
1529
|
ProxyAppId?: string;
|
|
1287
1530
|
/**
|
|
1288
|
-
|
|
1289
|
-
|
|
1531
|
+
* 内部参数,腾讯电子签颁发给渠道侧合作企业的企业ID,不需要传
|
|
1532
|
+
*/
|
|
1290
1533
|
ProxyOrganizationId?: string;
|
|
1291
1534
|
}
|
|
1292
1535
|
/**
|
|
1293
1536
|
* 此结构 (FormField) 用于描述内容控件填充结构。
|
|
1537
|
+
|
|
1294
1538
|
*/
|
|
1295
1539
|
export interface FormField {
|
|
1296
1540
|
/**
|
|
1297
|
-
|
|
1298
|
-
|
|
1541
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
1542
|
+
TEXT - 文本内容
|
|
1543
|
+
MULTI_LINE_TEXT - 文本内容
|
|
1544
|
+
CHECK_BOX - true/false
|
|
1545
|
+
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
1546
|
+
SELECTOR - 选项值
|
|
1547
|
+
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
1548
|
+
*/
|
|
1299
1549
|
ComponentValue: string;
|
|
1300
1550
|
/**
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1551
|
+
* 表单域或控件的ID,跟ComponentName二选一,不能全为空;
|
|
1552
|
+
CreateFlowsByTemplates 接口不使用此字段。
|
|
1553
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1554
|
+
*/
|
|
1304
1555
|
ComponentId?: string;
|
|
1305
1556
|
/**
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1557
|
+
* 控件的名字,跟ComponentId二选一,不能全为空
|
|
1558
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1559
|
+
*/
|
|
1309
1560
|
ComponentName?: string;
|
|
1310
1561
|
}
|
|
1562
|
+
/**
|
|
1563
|
+
* 接口调用者信息
|
|
1564
|
+
*/
|
|
1565
|
+
export interface UserInfo {
|
|
1566
|
+
/**
|
|
1567
|
+
* 用户在渠道的编号,最大64位字符串
|
|
1568
|
+
*/
|
|
1569
|
+
OpenId?: string;
|
|
1570
|
+
/**
|
|
1571
|
+
* 用户的来源渠道
|
|
1572
|
+
*/
|
|
1573
|
+
Channel?: string;
|
|
1574
|
+
/**
|
|
1575
|
+
* 自定义用户编号
|
|
1576
|
+
*/
|
|
1577
|
+
CustomUserId?: string;
|
|
1578
|
+
/**
|
|
1579
|
+
* 用户真实IP
|
|
1580
|
+
*/
|
|
1581
|
+
ClientIp?: string;
|
|
1582
|
+
/**
|
|
1583
|
+
* 用户代理IP
|
|
1584
|
+
*/
|
|
1585
|
+
ProxyIp?: string;
|
|
1586
|
+
}
|
|
1587
|
+
/**
|
|
1588
|
+
* ChannelCreateConvertTaskApi请求参数结构体
|
|
1589
|
+
*/
|
|
1590
|
+
export interface ChannelCreateConvertTaskApiRequest {
|
|
1591
|
+
/**
|
|
1592
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1593
|
+
*/
|
|
1594
|
+
Agent: Agent;
|
|
1595
|
+
/**
|
|
1596
|
+
* 资源类型 取值范围doc,docx,html之一
|
|
1597
|
+
*/
|
|
1598
|
+
ResourceType: string;
|
|
1599
|
+
/**
|
|
1600
|
+
* 资源名称,长度限制为256字符
|
|
1601
|
+
*/
|
|
1602
|
+
ResourceName: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* 资源Id,通过UploadFiles获取
|
|
1605
|
+
*/
|
|
1606
|
+
ResourceId: string;
|
|
1607
|
+
/**
|
|
1608
|
+
* 操作者信息
|
|
1609
|
+
*/
|
|
1610
|
+
Operator?: UserInfo;
|
|
1611
|
+
/**
|
|
1612
|
+
* 暂未开放
|
|
1613
|
+
*/
|
|
1614
|
+
Organization?: OrganizationInfo;
|
|
1615
|
+
}
|
|
1311
1616
|
/**
|
|
1312
1617
|
* 签署人的流程信息明细
|
|
1313
1618
|
*/
|
|
1314
1619
|
export interface FlowApproverDetail {
|
|
1315
1620
|
/**
|
|
1316
|
-
|
|
1317
|
-
|
|
1621
|
+
* 模板配置时候的签署人id,与控件绑定
|
|
1622
|
+
*/
|
|
1318
1623
|
ReceiptId: string;
|
|
1319
1624
|
/**
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1625
|
+
* 渠道侧企业的第三方id
|
|
1626
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1627
|
+
*/
|
|
1323
1628
|
ProxyOrganizationOpenId: string;
|
|
1324
1629
|
/**
|
|
1325
|
-
|
|
1326
|
-
|
|
1630
|
+
* 渠道侧企业操作人的第三方id
|
|
1631
|
+
*/
|
|
1327
1632
|
ProxyOperatorOpenId: string;
|
|
1328
1633
|
/**
|
|
1329
|
-
|
|
1330
|
-
|
|
1634
|
+
* 渠道侧企业名称
|
|
1635
|
+
*/
|
|
1331
1636
|
ProxyOrganizationName: string;
|
|
1332
1637
|
/**
|
|
1333
|
-
|
|
1334
|
-
|
|
1638
|
+
* 签署人手机号
|
|
1639
|
+
*/
|
|
1335
1640
|
Mobile: string;
|
|
1336
1641
|
/**
|
|
1337
|
-
|
|
1338
|
-
|
|
1642
|
+
* 签署人签署顺序
|
|
1643
|
+
*/
|
|
1339
1644
|
SignOrder: number;
|
|
1340
1645
|
/**
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1646
|
+
* 签署人姓名
|
|
1647
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1648
|
+
*/
|
|
1344
1649
|
ApproveName: string;
|
|
1345
1650
|
/**
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1651
|
+
* 当前签署人的状态
|
|
1652
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1653
|
+
*/
|
|
1349
1654
|
ApproveStatus: string;
|
|
1350
1655
|
/**
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1656
|
+
* 签署人信息
|
|
1657
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1658
|
+
*/
|
|
1354
1659
|
ApproveMessage: string;
|
|
1355
1660
|
/**
|
|
1356
|
-
|
|
1357
|
-
|
|
1661
|
+
* 签署人签署时间
|
|
1662
|
+
*/
|
|
1358
1663
|
ApproveTime: number;
|
|
1359
1664
|
/**
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1665
|
+
* 参与者类型 (ORGANIZATION企业/PERSON个人)
|
|
1666
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1667
|
+
*/
|
|
1363
1668
|
ApproveType: string;
|
|
1364
1669
|
}
|
|
1365
1670
|
/**
|
|
1366
1671
|
* 此结构体 (FlowInfo) 用于描述签署流程信息。
|
|
1672
|
+
|
|
1673
|
+
【动态表格传参说明】
|
|
1674
|
+
当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
|
|
1675
|
+
输入示例
|
|
1676
|
+
|
|
1677
|
+
```
|
|
1678
|
+
{
|
|
1679
|
+
"headers":[
|
|
1680
|
+
{
|
|
1681
|
+
"content":"head1"
|
|
1682
|
+
},
|
|
1683
|
+
{
|
|
1684
|
+
"content":"head2"
|
|
1685
|
+
},
|
|
1686
|
+
{
|
|
1687
|
+
"content":"head3"
|
|
1688
|
+
}
|
|
1689
|
+
],
|
|
1690
|
+
"rowCount":3,
|
|
1691
|
+
"body":{
|
|
1692
|
+
"cells":[
|
|
1693
|
+
{
|
|
1694
|
+
"rowStart":1,
|
|
1695
|
+
"rowEnd":1,
|
|
1696
|
+
"columnStart":1,
|
|
1697
|
+
"columnEnd":1,
|
|
1698
|
+
"content":"123"
|
|
1699
|
+
},
|
|
1700
|
+
{
|
|
1701
|
+
"rowStart":2,
|
|
1702
|
+
"rowEnd":3,
|
|
1703
|
+
"columnStart":1,
|
|
1704
|
+
"columnEnd":2,
|
|
1705
|
+
"content":"456"
|
|
1706
|
+
},
|
|
1707
|
+
{
|
|
1708
|
+
"rowStart":3,
|
|
1709
|
+
"rowEnd":3,
|
|
1710
|
+
"columnStart":3,
|
|
1711
|
+
"columnEnd":3,
|
|
1712
|
+
"content":"789"
|
|
1713
|
+
}
|
|
1714
|
+
]
|
|
1715
|
+
}
|
|
1716
|
+
}
|
|
1717
|
+
|
|
1718
|
+
```
|
|
1719
|
+
|
|
1720
|
+
表格参数说明
|
|
1721
|
+
|
|
1722
|
+
| 名称 | 类型 | 描述 |
|
|
1723
|
+
| ------------------- | ------- | ------------------------------------------------- |
|
|
1724
|
+
| headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
|
|
1725
|
+
| rowCount | Integer | 表格内容最大行数 |
|
|
1726
|
+
| cells.N.rowStart | Integer | 单元格坐标:行起始index |
|
|
1727
|
+
| cells.N.rowEnd | Integer | 单元格坐标:行结束index |
|
|
1728
|
+
| cells.N.columnStart | Integer | 单元格坐标:列起始index |
|
|
1729
|
+
| cells.N.columnEnd | Integer | 单元格坐标:列结束index |
|
|
1730
|
+
| cells.N.content | String | 单元格内容,字数不超过100 |
|
|
1731
|
+
|
|
1367
1732
|
*/
|
|
1368
1733
|
export interface FlowInfo {
|
|
1369
1734
|
/**
|
|
1370
|
-
|
|
1371
|
-
|
|
1735
|
+
* 合同名字,最大长度200个字符
|
|
1736
|
+
*/
|
|
1372
1737
|
FlowName: string;
|
|
1373
1738
|
/**
|
|
1374
|
-
|
|
1375
|
-
|
|
1739
|
+
* 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
|
|
1740
|
+
*/
|
|
1376
1741
|
Deadline: number;
|
|
1377
1742
|
/**
|
|
1378
|
-
|
|
1379
|
-
|
|
1743
|
+
* 模板ID
|
|
1744
|
+
*/
|
|
1380
1745
|
TemplateId?: string;
|
|
1381
1746
|
/**
|
|
1382
|
-
|
|
1383
|
-
|
|
1747
|
+
* 多个签署人信息,最大支持50个签署方
|
|
1748
|
+
*/
|
|
1384
1749
|
FlowApprovers?: Array<FlowApproverInfo>;
|
|
1385
1750
|
/**
|
|
1386
|
-
|
|
1387
|
-
|
|
1751
|
+
* 表单K-V对列表
|
|
1752
|
+
*/
|
|
1388
1753
|
FormFields?: Array<FormField>;
|
|
1389
1754
|
/**
|
|
1390
|
-
|
|
1391
|
-
|
|
1755
|
+
* 回调地址,最大长度1000个字符
|
|
1756
|
+
*/
|
|
1392
1757
|
CallbackUrl?: string;
|
|
1393
1758
|
/**
|
|
1394
|
-
|
|
1395
|
-
|
|
1759
|
+
* 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
|
|
1760
|
+
*/
|
|
1396
1761
|
FlowType?: string;
|
|
1397
1762
|
/**
|
|
1398
|
-
|
|
1399
|
-
|
|
1763
|
+
* 合同描述,最大长度1000个字符
|
|
1764
|
+
*/
|
|
1400
1765
|
FlowDescription?: string;
|
|
1401
1766
|
/**
|
|
1402
|
-
|
|
1403
|
-
|
|
1767
|
+
* 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
1768
|
+
*/
|
|
1404
1769
|
CustomerData?: string;
|
|
1405
1770
|
/**
|
|
1406
|
-
|
|
1407
|
-
|
|
1771
|
+
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
1772
|
+
*/
|
|
1408
1773
|
CustomShowMap?: string;
|
|
1409
1774
|
/**
|
|
1410
|
-
|
|
1411
|
-
|
|
1775
|
+
* 被抄送人的信息列表,抄送功能暂不开放
|
|
1776
|
+
*/
|
|
1412
1777
|
CcInfos?: Array<CcInfo>;
|
|
1778
|
+
/**
|
|
1779
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。
|
|
1780
|
+
若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
1781
|
+
|
|
1782
|
+
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
1783
|
+
*/
|
|
1784
|
+
NeedSignReview?: boolean;
|
|
1413
1785
|
}
|
|
1414
1786
|
/**
|
|
1415
1787
|
* 签署链接内容
|
|
1416
1788
|
*/
|
|
1417
1789
|
export interface SignUrlInfo {
|
|
1418
1790
|
/**
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1791
|
+
* 签署链接
|
|
1792
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1793
|
+
*/
|
|
1422
1794
|
SignUrl: string;
|
|
1423
1795
|
/**
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1796
|
+
* 链接失效时间,默认30分钟
|
|
1797
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1798
|
+
*/
|
|
1427
1799
|
Deadline: number;
|
|
1428
1800
|
/**
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1801
|
+
* 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
|
|
1802
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1803
|
+
*/
|
|
1432
1804
|
SignOrder: number;
|
|
1433
1805
|
/**
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1806
|
+
* 签署人编号
|
|
1807
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1808
|
+
*/
|
|
1437
1809
|
SignId: string;
|
|
1438
1810
|
/**
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1811
|
+
* 自定义用户编号
|
|
1812
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1813
|
+
*/
|
|
1442
1814
|
CustomUserId: string;
|
|
1443
1815
|
/**
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1816
|
+
* 用户姓名
|
|
1817
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1818
|
+
*/
|
|
1447
1819
|
Name: string;
|
|
1448
1820
|
/**
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1821
|
+
* 用户手机号码
|
|
1822
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1823
|
+
*/
|
|
1452
1824
|
Mobile: string;
|
|
1453
1825
|
/**
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1826
|
+
* 签署参与者机构名字
|
|
1827
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1828
|
+
*/
|
|
1457
1829
|
OrganizationName: string;
|
|
1458
1830
|
/**
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1831
|
+
* 参与者类型:
|
|
1832
|
+
ORGANIZATION 企业经办人
|
|
1833
|
+
PERSON 自然人
|
|
1834
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1835
|
+
*/
|
|
1464
1836
|
ApproverType: string;
|
|
1465
1837
|
/**
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1838
|
+
* 经办人身份证号
|
|
1839
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1840
|
+
*/
|
|
1469
1841
|
IdCardNumber: string;
|
|
1470
1842
|
/**
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1843
|
+
* 签署链接对应流程Id
|
|
1844
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1845
|
+
*/
|
|
1474
1846
|
FlowId: string;
|
|
1475
1847
|
/**
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1848
|
+
* 企业经办人 用户在渠道的编号
|
|
1849
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1850
|
+
*/
|
|
1479
1851
|
OpenId: string;
|
|
1480
1852
|
}
|
|
1853
|
+
/**
|
|
1854
|
+
* 复杂文档合成任务的任务信息
|
|
1855
|
+
*/
|
|
1856
|
+
export interface TaskInfo {
|
|
1857
|
+
/**
|
|
1858
|
+
* 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
|
|
1859
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1860
|
+
*/
|
|
1861
|
+
TaskId: string;
|
|
1862
|
+
/**
|
|
1863
|
+
* 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
|
|
1864
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1865
|
+
*/
|
|
1866
|
+
TaskStatus: string;
|
|
1867
|
+
}
|
|
1481
1868
|
/**
|
|
1482
1869
|
* 抄送信息
|
|
1483
1870
|
*/
|
|
1484
1871
|
export interface CcInfo {
|
|
1485
1872
|
/**
|
|
1486
|
-
|
|
1487
|
-
|
|
1873
|
+
* 被抄送人手机号,大陆11位手机号
|
|
1874
|
+
*/
|
|
1488
1875
|
Mobile?: string;
|
|
1489
1876
|
}
|
|
1490
1877
|
/**
|
|
@@ -1492,8 +1879,8 @@ export interface CcInfo {
|
|
|
1492
1879
|
*/
|
|
1493
1880
|
export interface ChannelCancelMultiFlowSignQRCodeResponse {
|
|
1494
1881
|
/**
|
|
1495
|
-
|
|
1496
|
-
|
|
1882
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1883
|
+
*/
|
|
1497
1884
|
RequestId?: string;
|
|
1498
1885
|
}
|
|
1499
1886
|
/**
|
|
@@ -1501,20 +1888,20 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
|
|
|
1501
1888
|
*/
|
|
1502
1889
|
export interface DescribeFlowDetailInfoResponse {
|
|
1503
1890
|
/**
|
|
1504
|
-
|
|
1505
|
-
|
|
1891
|
+
* 渠道侧应用号Id
|
|
1892
|
+
*/
|
|
1506
1893
|
ApplicationId: string;
|
|
1507
1894
|
/**
|
|
1508
|
-
|
|
1509
|
-
|
|
1895
|
+
* 渠道侧企业第三方Id
|
|
1896
|
+
*/
|
|
1510
1897
|
ProxyOrganizationOpenId: string;
|
|
1511
1898
|
/**
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1899
|
+
* 合同(签署流程)的具体详细描述信息
|
|
1900
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1901
|
+
*/
|
|
1515
1902
|
FlowInfo: Array<FlowDetailInfo>;
|
|
1516
1903
|
/**
|
|
1517
|
-
|
|
1518
|
-
|
|
1904
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1905
|
+
*/
|
|
1519
1906
|
RequestId?: string;
|
|
1520
1907
|
}
|