tencentcloud-sdk-nodejs-essbasic 4.0.476 → 4.0.477

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.
@@ -1,1249 +1,1239 @@
1
1
  /**
2
- * 资源链接信息
2
+ * SyncProxyOrganization返回参数结构体
3
3
  */
4
- export interface ResourceUrlInfo {
5
- /**
6
- * 资源链接地址,过期时间5分钟
7
- 注意:此字段可能返回 null,表示取不到有效值。
8
- */
9
- Url: string;
10
- /**
11
- * 资源名称
12
- 注意:此字段可能返回 null,表示取不到有效值。
13
- */
14
- Name: string;
4
+ export interface SyncProxyOrganizationResponse {
15
5
  /**
16
- * 资源类型
17
- 注意:此字段可能返回 null,表示取不到有效值。
18
- */
19
- Type: string;
6
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7
+ */
8
+ RequestId?: string;
20
9
  }
21
10
  /**
22
- * 合同文件验签单个结果结构体
11
+ * ChannelCreateConvertTaskApi返回参数结构体
23
12
  */
24
- export interface PdfVerifyResult {
25
- /**
26
- * 验签结果
27
- */
28
- VerifyResult: number;
29
- /**
30
- * 签署平台
31
- */
32
- SignPlatform: string;
13
+ export interface ChannelCreateConvertTaskApiResponse {
33
14
  /**
34
- * 签署人名称
15
+ * 任务id
35
16
  */
36
- SignerName: string;
17
+ TaskId: string;
37
18
  /**
38
- * 签署时间
19
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
39
20
  */
40
- SignTime: number;
21
+ RequestId?: string;
22
+ }
23
+ /**
24
+ * ChannelBatchCancelFlows返回参数结构体
25
+ */
26
+ export interface ChannelBatchCancelFlowsResponse {
41
27
  /**
42
- * 签名算法
28
+ * 签署流程批量撤销失败原因,错误信息与流程Id一一对应,如果部分流程不可撤销,不会返回错误信息,只会撤销可撤销流程
43
29
  */
44
- SignAlgorithm: string;
30
+ FailMessages: Array<string>;
45
31
  /**
46
- * 签名证书序列号
32
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
47
33
  */
48
- CertSn: string;
34
+ RequestId?: string;
35
+ }
36
+ /**
37
+ * 渠道版员工部门信息
38
+ */
39
+ export interface Department {
49
40
  /**
50
- * 证书起始时间
51
- */
52
- CertNotBefore: number;
41
+ * 部门id
42
+ 注意:此字段可能返回 null,表示取不到有效值。
43
+ */
44
+ DepartmentId: string;
53
45
  /**
54
- * 证书过期时间
55
- */
56
- CertNotAfter: number;
46
+ * 部门名称
47
+ 注意:此字段可能返回 null,表示取不到有效值。
48
+ */
49
+ DepartmentName: string;
50
+ }
51
+ /**
52
+ * ChannelCreateFlowSignReview请求参数结构体
53
+ */
54
+ export interface ChannelCreateFlowSignReviewRequest {
57
55
  /**
58
- * 签名类型
56
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
59
57
  */
60
- SignType: number;
58
+ Agent: Agent;
61
59
  /**
62
- * 签名域横坐标
60
+ * 签署流程编号
63
61
  */
64
- ComponentPosX: number;
62
+ FlowId: string;
65
63
  /**
66
- * 签名域纵坐标
67
- */
68
- ComponentPosY: number;
64
+ * 企业内部审核结果
65
+ PASS: 通过
66
+ REJECT: 拒绝
67
+ SIGN_REJECT:拒签(流程结束)
68
+ */
69
+ ReviewType: string;
69
70
  /**
70
- * 签名域宽度
71
- */
72
- ComponentWidth: number;
71
+ * 审核原因
72
+ 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
73
+ */
74
+ ReviewMessage?: string;
75
+ }
76
+ /**
77
+ * 授权出错信息
78
+ */
79
+ export interface AuthFailMessage {
73
80
  /**
74
- * 签名域高度
81
+ * 合作企业Id
75
82
  */
76
- ComponentHeight: number;
83
+ ProxyOrganizationOpenId: string;
77
84
  /**
78
- * 签名域所在页码
85
+ * 出错信息
79
86
  */
80
- ComponentPage: number;
87
+ Message: string;
81
88
  }
82
89
  /**
83
- * 创建签署流程签署人入参。
84
-
85
- 其中签署方FlowApproverInfo需要传递的参数
86
- 非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
87
- 1-个人:Name、Mobile必传
88
- 2-渠道子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
89
- 3-渠道合作企业不指定经办人:(暂不支持)
90
- 4-非渠道合作企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
91
-
92
- RecipientId参数:
93
- 从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
90
+ * DescribeFlowDetailInfo请求参数结构体
94
91
  */
95
- export interface FlowApproverInfo {
92
+ export interface DescribeFlowDetailInfoRequest {
96
93
  /**
97
- * 签署人姓名,最大长度50个字符
94
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
98
95
  */
99
- Name?: string;
96
+ Agent: Agent;
100
97
  /**
101
- * 经办人身份证件类型
102
- 1.ID_CARD 居民身份证
103
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
104
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
98
+ * 合同(流程)编号数组,最多支持100个。
99
+ (备注:该参数和合同组编号必须二选一)
105
100
  */
106
- IdCardType?: string;
101
+ FlowIds?: Array<string>;
107
102
  /**
108
- * 经办人证件号
103
+ * 操作者的信息
109
104
  */
110
- IdCardNumber?: string;
105
+ Operator?: UserInfo;
111
106
  /**
112
- * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
107
+ * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
113
108
  */
114
- Mobile?: string;
109
+ FlowGroupId?: string;
110
+ }
111
+ /**
112
+ * UploadFiles请求参数结构体
113
+ */
114
+ export interface UploadFilesRequest {
115
115
  /**
116
- * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
116
+ * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
117
117
  */
118
- OrganizationName?: string;
118
+ Agent: Agent;
119
119
  /**
120
- * 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
121
- 默认为false,即签署人位于同一个渠道应用号下;
120
+ * 文件对应业务类型
121
+ 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
122
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
122
123
  */
123
- NotChannelOrganization?: boolean;
124
+ BusinessType: string;
124
125
  /**
125
- * 用户侧第三方id,最大长度64个字符
126
+ * 上传文件内容数组,最多支持20个文件
126
127
  */
127
- OpenId?: string;
128
+ FileInfos?: Array<UploadFile>;
128
129
  /**
129
- * 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
130
+ * 操作者的信息
130
131
  */
131
- OrganizationOpenId?: string;
132
+ Operator?: UserInfo;
133
+ }
134
+ /**
135
+ * DescribeResourceUrlsByFlows请求参数结构体
136
+ */
137
+ export interface DescribeResourceUrlsByFlowsRequest {
132
138
  /**
133
- * 签署人类型,PERSON-个人;
134
- PERSON_AUTO_SIGN-个人自动签;
135
- ORGANIZATION-企业;
136
- ENTERPRISESERVER-企业静默签;
137
- 注:ENTERPRISESERVER 类型仅用于使用文件创建签署流程(ChannelCreateFlowByFiles)接口;
139
+ * 渠道应用相关信息。
140
+ 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
138
141
  */
139
- ApproverType?: string;
140
- /**
141
- * 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
142
- */
143
- RecipientId?: string;
144
- /**
145
- * 签署截止时间,默认一年
146
- */
147
- Deadline?: number;
148
- /**
149
- * 签署完回调url,最大长度1000个字符
150
- */
151
- CallbackUrl?: string;
152
- /**
153
- * 使用PDF文件直接发起合同时,签署人指定的签署控件
154
- */
155
- SignComponents?: Array<Component>;
156
- /**
157
- * 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
158
- */
159
- ComponentLimitType?: Array<string>;
160
- /**
161
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
162
- */
163
- PreReadTime?: number;
164
- /**
165
- * 签署完前端跳转的url,暂未使用
166
- */
167
- JumpUrl?: string;
142
+ Agent: Agent;
168
143
  /**
169
- * 签署人个性化能力值
144
+ * 查询资源所对应的签署流程Id,最多支持50个
170
145
  */
171
- ApproverOption?: ApproverOption;
146
+ FlowIds?: Array<string>;
172
147
  /**
173
- * 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
148
+ * 操作者的信息
174
149
  */
175
- ApproverNeedSignReview?: boolean;
150
+ Operator?: UserInfo;
176
151
  }
177
152
  /**
178
- * ChannelCreateConvertTaskApi返回参数结构体
153
+ * CreateSealByImage返回参数结构体
179
154
  */
180
- export interface ChannelCreateConvertTaskApiResponse {
155
+ export interface CreateSealByImageResponse {
181
156
  /**
182
- * 任务id
157
+ * 印章id
183
158
  */
184
- TaskId: string;
159
+ SealId: string;
185
160
  /**
186
161
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
187
162
  */
188
163
  RequestId?: string;
189
164
  }
190
165
  /**
191
- * OperateChannelTemplate请求参数结构体
166
+ * OperateChannelTemplate返回参数结构体
192
167
  */
193
- export interface OperateChannelTemplateRequest {
194
- /**
195
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
196
- */
197
- Agent: Agent;
168
+ export interface OperateChannelTemplateResponse {
198
169
  /**
199
- * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
200
- */
201
- OperateType: string;
170
+ * 腾讯电子签颁发给渠道的应用ID
171
+ 注意:此字段可能返回 null,表示取不到有效值。
172
+ */
173
+ AppId: string;
202
174
  /**
203
- * 渠道方模板库模板唯一标识
204
- */
175
+ * 渠道方模板库模板唯一标识
176
+ 注意:此字段可能返回 null,表示取不到有效值。
177
+ */
205
178
  TemplateId: string;
206
179
  /**
207
- * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
208
- */
209
- ProxyOrganizationOpenIds?: string;
210
- /**
211
- * 模板可见性, 全部可见-"all", 部分可见-"part"
212
- */
213
- AuthTag?: string;
180
+ * 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
181
+ 注意:此字段可能返回 null,表示取不到有效值。
182
+ */
183
+ OperateResult: string;
214
184
  /**
215
- * 操作者的信息
185
+ * 模板可见性, 全部可见-"all", 部分可见-"part"
186
+ 注意:此字段可能返回 null,表示取不到有效值。
187
+ */
188
+ AuthTag: string;
189
+ /**
190
+ * 合作企业方第三方机构唯一标识数据
191
+ 注意:此字段可能返回 null,表示取不到有效值。
192
+ */
193
+ ProxyOrganizationOpenIds: Array<string>;
194
+ /**
195
+ * 操作失败信息数组
196
+ 注意:此字段可能返回 null,表示取不到有效值。
197
+ */
198
+ FailMessageList: Array<AuthFailMessage>;
199
+ /**
200
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
216
201
  */
217
- Operator?: UserInfo;
202
+ RequestId?: string;
218
203
  }
219
204
  /**
220
- * 此结构体 (TemplateInfo) 用于描述模板的信息。
205
+ * 合同组中每个子合同的发起信息
221
206
  */
222
- export interface TemplateInfo {
207
+ export interface FlowFileInfo {
223
208
  /**
224
- * 模板ID
209
+ * 签署文件资源Id列表,目前仅支持单个文件
225
210
  */
226
- TemplateId: string;
211
+ FileIds: Array<string>;
227
212
  /**
228
- * 模板名字
213
+ * 签署流程名称,长度不超过200个字符
229
214
  */
230
- TemplateName: string;
215
+ FlowName: string;
231
216
  /**
232
- * 模板描述信息
217
+ * 签署流程签约方列表,最多不超过5个参与方
233
218
  */
234
- Description: string;
219
+ FlowApprovers: Array<FlowApproverInfo>;
235
220
  /**
236
- * 模板控件信息结构
221
+ * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
237
222
  */
238
- Components: Array<Component>;
223
+ Deadline?: number;
239
224
  /**
240
- * 签署区模板信息结构
225
+ * 签署流程的描述,长度不超过1000个字符
241
226
  */
242
- SignComponents: Array<Component>;
227
+ FlowDescription?: string;
243
228
  /**
244
- * 模板中的流程参与人信息
229
+ * 签署流程的类型,长度不超过255个字符
245
230
  */
246
- Recipients: Array<Recipient>;
231
+ FlowType?: string;
247
232
  /**
248
- * 模板类型:1-静默签;3-普通模板
233
+ * 签署流程回调地址,长度不超过255个字符
249
234
  */
250
- TemplateType: number;
235
+ CallbackUrl?: string;
251
236
  /**
252
- * 是否是发起人 ,已弃用
237
+ * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
253
238
  */
254
- IsPromoter: boolean;
239
+ CustomerData?: string;
255
240
  /**
256
- * 模板的创建者信息
241
+ * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
257
242
  */
258
- Creator: string;
243
+ Unordered?: boolean;
259
244
  /**
260
- * 模板创建的时间戳(精确到秒)
245
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
261
246
  */
262
- CreatedOn: number;
247
+ CustomShowMap?: string;
248
+ /**
249
+ * 本企业(发起方企业)是否需要签署审批
250
+ */
251
+ NeedSignReview?: boolean;
263
252
  }
264
253
  /**
265
- * ChannelDescribeEmployees请求参数结构体
254
+ * CreateConsoleLoginUrl返回参数结构体
266
255
  */
267
- export interface ChannelDescribeEmployeesRequest {
268
- /**
269
- * 返回最大数量,最大为20
270
- */
271
- Limit: number;
272
- /**
273
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
274
- */
275
- Agent?: Agent;
256
+ export interface CreateConsoleLoginUrlResponse {
276
257
  /**
277
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
278
- 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
258
+ * 子客Web控制台url,此链接5分钟内有效,且只能访问一次。同时需要注意:
259
+ 1. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接);
260
+ 2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
279
261
  */
280
- Filters?: Array<Filter>;
281
- /**
282
- * 偏移量,默认为0,最大为20000
283
- */
284
- Offset?: number;
262
+ ConsoleUrl: string;
285
263
  /**
286
- * 操作者的信息
264
+ * 渠道子客企业是否已开通腾讯电子签
287
265
  */
288
- Operator?: UserInfo;
289
- }
290
- /**
291
- * SyncProxyOrganization返回参数结构体
292
- */
293
- export interface SyncProxyOrganizationResponse {
266
+ IsActivated: boolean;
294
267
  /**
295
268
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
296
269
  */
297
270
  RequestId?: string;
298
271
  }
299
272
  /**
300
- * ChannelCreateFlowGroupByFiles返回参数结构体
273
+ * SyncProxyOrganization请求参数结构体
301
274
  */
302
- export interface ChannelCreateFlowGroupByFilesResponse {
275
+ export interface SyncProxyOrganizationRequest {
303
276
  /**
304
- * 合同组ID
305
- 注意:此字段可能返回 null,表示取不到有效值。
277
+ * 应用信息
278
+ 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
306
279
  */
307
- FlowGroupId: string;
280
+ Agent: Agent;
308
281
  /**
309
- * 子合同ID列表
310
- 注意:此字段可能返回 null,表示取不到有效值。
311
- */
312
- FlowIds: Array<string>;
282
+ * 渠道侧合作企业名称,最大长度64个字符
283
+ */
284
+ ProxyOrganizationName: string;
313
285
  /**
314
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
286
+ * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
315
287
  */
316
- RequestId?: string;
317
- }
318
- /**
319
- * GetDownloadFlowUrl返回参数结构体
320
- */
321
- export interface GetDownloadFlowUrlResponse {
288
+ BusinessLicense?: string;
322
289
  /**
323
- * 合同(流程)下载地址
290
+ * 渠道侧合作企业统一社会信用代码,最大长度200个字符
324
291
  */
325
- DownLoadUrl: string;
292
+ UniformSocialCreditCode?: string;
326
293
  /**
327
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
294
+ * 操作者的信息
328
295
  */
329
- RequestId?: string;
296
+ Operator?: UserInfo;
330
297
  }
331
298
  /**
332
- * DescribeTemplates返回参数结构体
299
+ * CreateSealByImage请求参数结构体
333
300
  */
334
- export interface DescribeTemplatesResponse {
335
- /**
336
- * 模板详情
337
- */
338
- Templates: Array<TemplateInfo>;
301
+ export interface CreateSealByImageRequest {
339
302
  /**
340
- * 查询总数
303
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
341
304
  */
342
- TotalCount: number;
305
+ Agent: Agent;
343
306
  /**
344
- * 查询数量
307
+ * 印章名称,最大长度不超过30字符
345
308
  */
346
- Limit: number;
309
+ SealName: string;
347
310
  /**
348
- * 查询起始偏移
311
+ * 印章图片base64
349
312
  */
350
- Offset: number;
313
+ SealImage: string;
351
314
  /**
352
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
315
+ * 操作者的信息
353
316
  */
354
- RequestId?: string;
317
+ Operator?: UserInfo;
355
318
  }
356
319
  /**
357
- * DescribeResourceUrlsByFlows返回参数结构体
320
+ * PrepareFlows请求参数结构体
358
321
  */
359
- export interface DescribeResourceUrlsByFlowsResponse {
322
+ export interface PrepareFlowsRequest {
360
323
  /**
361
- * 签署流程资源对应链接信息
324
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
362
325
  */
363
- FlowResourceUrlInfos: Array<FlowResourceUrlInfo>;
364
- /**
365
- * 创建消息,对应多个合同ID,
366
- 成功为“”,创建失败则对应失败消息
367
- */
368
- ErrorMessages: Array<string>;
326
+ Agent: Agent;
369
327
  /**
370
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
328
+ * 多个合同(签署流程)信息,最大支持20个签署流程。
371
329
  */
372
- RequestId?: string;
373
- }
374
- /**
375
- * ChannelCreateMultiFlowSignQRCode返回参数结构体
376
- */
377
- export interface ChannelCreateMultiFlowSignQRCodeResponse {
330
+ FlowInfos: Array<FlowInfo>;
378
331
  /**
379
- * 签署二维码对象
332
+ * 操作完成后的跳转地址,最大长度200
380
333
  */
381
- QrCode: SignQrCode;
334
+ JumpUrl: string;
382
335
  /**
383
- * 签署链接对象
336
+ * 操作者的信息
384
337
  */
385
- SignUrls: SignUrl;
338
+ Operator?: UserInfo;
339
+ }
340
+ /**
341
+ * ChannelCancelFlow返回参数结构体
342
+ */
343
+ export interface ChannelCancelFlowResponse {
386
344
  /**
387
345
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
388
346
  */
389
347
  RequestId?: string;
390
348
  }
391
349
  /**
392
- * 签署人个性化能力信息
350
+ * 签署流程下载信息
393
351
  */
394
- export interface ApproverOption {
352
+ export interface DownloadFlowInfo {
395
353
  /**
396
- * 是否隐藏一键签署 false-不隐藏,默认 true-隐藏
354
+ * 文件夹名称
397
355
  */
398
- HideOneKeySign?: boolean;
356
+ FileName: string;
357
+ /**
358
+ * 签署流程的标识数组
359
+ */
360
+ FlowIdList: Array<string>;
399
361
  }
400
362
  /**
401
- * 签署参与者信息
363
+ * ChannelCreateConvertTaskApi请求参数结构体
402
364
  */
403
- export interface Recipient {
365
+ export interface ChannelCreateConvertTaskApiRequest {
404
366
  /**
405
- * 签署人唯一标识
367
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
406
368
  */
407
- RecipientId?: string;
369
+ Agent: Agent;
408
370
  /**
409
- * 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
371
+ * 资源类型 取值范围doc,docx,html,excel之一
410
372
  */
411
- RecipientType?: string;
373
+ ResourceType: string;
412
374
  /**
413
- * 描述
375
+ * 资源名称,长度限制为256字符
414
376
  */
415
- Description?: string;
377
+ ResourceName: string;
416
378
  /**
417
- * 签署方备注信息
379
+ * 资源Id,通过UploadFiles获取
418
380
  */
419
- RoleName?: string;
381
+ ResourceId: string;
420
382
  /**
421
- * 是否需要校验
383
+ * 操作者信息
422
384
  */
423
- RequireValidation?: boolean;
385
+ Operator?: UserInfo;
424
386
  /**
425
- * 是否必须填写
387
+ * 暂未开放
426
388
  */
427
- RequireSign?: boolean;
389
+ Organization?: OrganizationInfo;
390
+ }
391
+ /**
392
+ * ChannelCreateFlowByFiles请求参数结构体
393
+ */
394
+ export interface ChannelCreateFlowByFilesRequest {
428
395
  /**
429
- * 签署类型
396
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
430
397
  */
431
- SignType?: number;
398
+ Agent?: Agent;
432
399
  /**
433
- * 签署顺序:数字越小优先级越高
400
+ * 签署流程名称,长度不超过200个字符
434
401
  */
435
- RoutingOrder?: number;
402
+ FlowName?: string;
436
403
  /**
437
- * 是否是发起方
404
+ * 签署流程签约方列表,最多不超过5个参与方
438
405
  */
439
- IsPromoter?: boolean;
440
- }
441
- /**
442
- * 渠道版员工部门信息
443
- */
444
- export interface Department {
445
- /**
446
- * 部门id
447
- 注意:此字段可能返回 null,表示取不到有效值。
448
- */
449
- DepartmentId: string;
450
- /**
451
- * 部门名称
452
- 注意:此字段可能返回 null,表示取不到有效值。
453
- */
454
- DepartmentName: string;
455
- }
456
- /**
457
- * OperateChannelTemplate返回参数结构体
458
- */
459
- export interface OperateChannelTemplateResponse {
460
- /**
461
- * 腾讯电子签颁发给渠道的应用ID
462
- 注意:此字段可能返回 null,表示取不到有效值。
463
- */
464
- AppId: string;
465
- /**
466
- * 渠道方模板库模板唯一标识
467
- 注意:此字段可能返回 null,表示取不到有效值。
468
- */
469
- TemplateId: string;
470
- /**
471
- * 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
472
- 注意:此字段可能返回 null,表示取不到有效值。
473
- */
474
- OperateResult: string;
475
- /**
476
- * 模板可见性, 全部可见-"all", 部分可见-"part"
477
- 注意:此字段可能返回 null,表示取不到有效值。
478
- */
479
- AuthTag: string;
480
- /**
481
- * 合作企业方第三方机构唯一标识数据
482
- 注意:此字段可能返回 null,表示取不到有效值。
483
- */
484
- ProxyOrganizationOpenIds: Array<string>;
485
- /**
486
- * 操作失败信息数组
487
- 注意:此字段可能返回 null,表示取不到有效值。
488
- */
489
- FailMessageList: Array<AuthFailMessage>;
406
+ FlowApprovers?: Array<FlowApproverInfo>;
490
407
  /**
491
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
408
+ * 签署文件资源Id列表,目前仅支持单个文件
492
409
  */
493
- RequestId?: string;
494
- }
495
- /**
496
- * 渠道版员工角色信息
497
- */
498
- export interface StaffRole {
499
- /**
500
- * 角色id
501
- 注意:此字段可能返回 null,表示取不到有效值。
502
- */
503
- RoleId: string;
504
- /**
505
- * 角色名称
506
- 注意:此字段可能返回 null,表示取不到有效值。
507
- */
508
- RoleName: string;
509
- }
510
- /**
511
- * CreateSignUrls返回参数结构体
512
- */
513
- export interface CreateSignUrlsResponse {
410
+ FileIds?: Array<string>;
514
411
  /**
515
- * 签署参与者签署H5链接信息数组
412
+ * 签署文件中的发起方的填写控件,需要在发起的时候进行填充
516
413
  */
517
- SignUrlInfos: Array<SignUrlInfo>;
414
+ Components?: Array<Component>;
518
415
  /**
519
- * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
416
+ * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
520
417
  */
521
- ErrorMessages: Array<string>;
418
+ Deadline?: number;
522
419
  /**
523
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
420
+ * 签署流程回调地址,长度不超过255个字符
524
421
  */
525
- RequestId?: string;
526
- }
527
- /**
528
- * CreateSignUrls请求参数结构体
529
- */
530
- export interface CreateSignUrlsRequest {
422
+ CallbackUrl?: string;
531
423
  /**
532
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
424
+ * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
533
425
  */
534
- Agent: Agent;
426
+ Unordered?: boolean;
535
427
  /**
536
- * 签署流程编号数组,最多支持100个。(备注:该参数和合同组编号必须二选一)
428
+ * 签署流程的类型,长度不超过255个字符
537
429
  */
538
- FlowIds?: Array<string>;
430
+ FlowType?: string;
539
431
  /**
540
- * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
432
+ * 签署流程的描述,长度不超过1000个字符
541
433
  */
542
- FlowGroupId?: string;
434
+ FlowDescription?: string;
543
435
  /**
544
- * 签署链接类型:“WEIXINAPP”-短链直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;"LONGURL2WEIXINAPP"-长链接跳转小程序;默认“WEIXINAPP”类型,即跳转至小程序;
436
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
545
437
  */
546
- Endpoint?: string;
438
+ CustomShowMap?: string;
547
439
  /**
548
- * 签署链接生成类型,默认是 "ALL";
549
- "ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
550
- "CHANNEL":渠道合作企业;
551
- "NOT_CHANNEL":非渠道合作企业;
552
- "PERSON":个人;
553
- "FOLLOWER":关注方,目前是合同抄送方;
554
- */
555
- GenerateType?: string;
440
+ * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
441
+ */
442
+ CustomerData?: string;
556
443
  /**
557
- * 非渠道合作企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
444
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
558
445
  */
559
- OrganizationName?: string;
446
+ NeedSignReview?: boolean;
560
447
  /**
561
- * 参与人姓名,GenerateType为"PERSON"时必填
448
+ * 操作者的信息
562
449
  */
563
- Name?: string;
450
+ Operator?: UserInfo;
564
451
  /**
565
- * 参与人手机号;
566
- GenerateType为"PERSON"或"FOLLOWER"时必填
452
+ * 签署人校验方式
453
+ VerifyCheck: 人脸识别(默认)
454
+ MobileCheck:手机号验证
455
+ 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
567
456
  */
568
- Mobile?: string;
457
+ ApproverVerifyType?: string;
458
+ }
459
+ /**
460
+ * 应用相关信息
461
+ */
462
+ export interface Agent {
569
463
  /**
570
- * 渠道合作企业的企业IdGenerateType为"CHANNEL"时必填
464
+ * 腾讯电子签颁发给渠道的应用ID32位字符串
571
465
  */
572
- OrganizationOpenId?: string;
466
+ AppId: string;
573
467
  /**
574
- * 渠道合作企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人
468
+ * 渠道/平台合作企业的企业ID,最大64位字符串
575
469
  */
576
- OpenId?: string;
470
+ ProxyOrganizationOpenId?: string;
577
471
  /**
578
- * Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
472
+ * 渠道/平台合作企业经办人(操作员)
579
473
  */
580
- AutoJumpBack?: boolean;
474
+ ProxyOperator?: UserInfo;
581
475
  /**
582
- * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
476
+ * 腾讯电子签颁发给渠道侧合作企业的应用ID
583
477
  */
584
- JumpUrl?: string;
478
+ ProxyAppId?: string;
585
479
  /**
586
- * 操作者的信息
480
+ * 内部参数,腾讯电子签颁发给渠道侧合作企业的企业ID,不需要传
587
481
  */
588
- Operator?: UserInfo;
482
+ ProxyOrganizationId?: string;
589
483
  }
590
484
  /**
591
- * ChannelCreateMultiFlowSignQRCode请求参数结构体
485
+ * 签署人的流程信息明细
592
486
  */
593
- export interface ChannelCreateMultiFlowSignQRCodeRequest {
487
+ export interface FlowApproverDetail {
594
488
  /**
595
- * 渠道应用相关信息。
596
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
489
+ * 模板配置时候的签署人id,与控件绑定
490
+ */
491
+ ReceiptId: string;
492
+ /**
493
+ * 渠道侧企业的第三方id
494
+ 注意:此字段可能返回 null,表示取不到有效值。
597
495
  */
598
- Agent: Agent;
496
+ ProxyOrganizationOpenId: string;
599
497
  /**
600
- * 模版ID
498
+ * 渠道侧企业操作人的第三方id
601
499
  */
602
- TemplateId: string;
500
+ ProxyOperatorOpenId: string;
603
501
  /**
604
- * 签署流程名称,最大长度200个字符。
502
+ * 渠道侧企业名称
605
503
  */
606
- FlowName: string;
504
+ ProxyOrganizationName: string;
607
505
  /**
608
- * 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
506
+ * 签署人手机号
609
507
  */
610
- MaxFlowNum?: number;
508
+ Mobile: string;
611
509
  /**
612
- * 签署流程有效天数 默认7天 最高设置不超过30天
510
+ * 签署人签署顺序
613
511
  */
614
- FlowEffectiveDay?: number;
512
+ SignOrder: number;
615
513
  /**
616
- * 二维码有效天数 默认7天 最高设置不超过90天
617
- */
618
- QrEffectiveDay?: number;
514
+ * 签署人姓名
515
+ 注意:此字段可能返回 null,表示取不到有效值。
516
+ */
517
+ ApproveName: string;
619
518
  /**
620
- * 限制二维码用户条件
621
- */
622
- Restrictions?: Array<ApproverRestriction>;
519
+ * 当前签署人的状态
520
+ 注意:此字段可能返回 null,表示取不到有效值。
521
+ */
522
+ ApproveStatus: string;
623
523
  /**
624
- * 回调地址,最大长度1000个字符
625
- 不传默认使用渠道应用号配置的回调地址
626
- 回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
524
+ * 签署人信息
525
+ 注意:此字段可能返回 null,表示取不到有效值。
627
526
  */
628
- CallbackUrl?: string;
527
+ ApproveMessage: string;
629
528
  /**
630
- * 用户信息
529
+ * 签署人签署时间
631
530
  */
632
- Operator?: UserInfo;
531
+ ApproveTime: number;
633
532
  /**
634
- * 限制二维码用户条件(已弃用)
635
- */
636
- ApproverRestrictions?: ApproverRestriction;
533
+ * 参与者类型 (ORGANIZATION企业/PERSON个人)
534
+ 注意:此字段可能返回 null,表示取不到有效值。
535
+ */
536
+ ApproveType: string;
637
537
  }
638
538
  /**
639
- * 授权出错信息
539
+ * ChannelCreateFlowGroupByFiles请求参数结构体
640
540
  */
641
- export interface AuthFailMessage {
541
+ export interface ChannelCreateFlowGroupByFilesRequest {
642
542
  /**
643
- * 合作企业Id
543
+ * 每个子合同的发起所需的信息,数量限制2-100
644
544
  */
645
- ProxyOrganizationOpenId: string;
545
+ FlowFileInfos: Array<FlowFileInfo>;
646
546
  /**
647
- * 出错信息
547
+ * 合同组名称,长度不超过200个字符
648
548
  */
649
- Message: string;
650
- }
651
- /**
652
- * DescribeFlowDetailInfo请求参数结构体
653
- */
654
- export interface DescribeFlowDetailInfoRequest {
549
+ FlowGroupName: string;
655
550
  /**
656
551
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
657
552
  */
658
- Agent: Agent;
659
- /**
660
- * 合同(流程)编号数组,最多支持100个。
661
- (备注:该参数和合同组编号必须二选一)
662
- */
663
- FlowIds?: Array<string>;
553
+ Agent?: Agent;
664
554
  /**
665
555
  * 操作者的信息
666
556
  */
667
557
  Operator?: UserInfo;
668
- /**
669
- * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
670
- */
671
- FlowGroupId?: string;
672
558
  }
673
559
  /**
674
- * ChannelGetTaskResultApi返回参数结构体
560
+ * 复杂文档合成任务的任务信息
675
561
  */
676
- export interface ChannelGetTaskResultApiResponse {
677
- /**
678
- * 任务Id
679
- */
680
- TaskId: string;
562
+ export interface TaskInfo {
681
563
  /**
682
- * 任务状态,需要关注的状态
683
- 0 :NeedTranform - 任务已提交
684
- 4 :Processing - 文档转换中
685
- 8 :TaskEnd - 任务处理完成
686
- -2 :DownloadFailed - 下载失败
687
- -6 :ProcessFailed - 转换失败
688
- -13:ProcessTimeout - 转换文件超时
564
+ * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
565
+ 注意:此字段可能返回 null,表示取不到有效值。
689
566
  */
690
- TaskStatus: number;
567
+ TaskId: string;
691
568
  /**
692
- * 状态描述,需要关注的状态
693
- NeedTranform - 任务已提交
694
- Processing - 文档转换中
695
- TaskEnd - 任务处理完成
696
- DownloadFailed - 下载失败
697
- ProcessFailed - 转换失败
698
- ProcessTimeout - 转换文件超时
569
+ * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
570
+ 注意:此字段可能返回 null,表示取不到有效值。
699
571
  */
700
- TaskMessage: string;
572
+ TaskStatus: string;
573
+ }
574
+ /**
575
+ * 资源链接信息
576
+ */
577
+ export interface ResourceUrlInfo {
701
578
  /**
702
- * 资源Id,也是FileId,用于文件发起使用
703
- */
704
- ResourceId: string;
579
+ * 资源链接地址,过期时间5分钟
580
+ 注意:此字段可能返回 null,表示取不到有效值。
581
+ */
582
+ Url: string;
705
583
  /**
706
- * 预览文件Url,有效期30分钟
584
+ * 资源名称
707
585
  注意:此字段可能返回 null,表示取不到有效值。
708
586
  */
709
- PreviewUrl: string;
587
+ Name: string;
710
588
  /**
711
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
712
- */
713
- RequestId?: string;
589
+ * 资源类型
590
+ 注意:此字段可能返回 null,表示取不到有效值。
591
+ */
592
+ Type: string;
714
593
  }
715
594
  /**
716
- * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
595
+ * 创建签署流程签署人入参。
596
+
597
+ 其中签署方FlowApproverInfo需要传递的参数
598
+ 非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
599
+ 1-个人:Name、Mobile必传
600
+ 2-渠道子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
601
+ 3-渠道合作企业不指定经办人:(暂不支持)
602
+ 4-非渠道合作企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
603
+
604
+ RecipientId参数:
605
+ 从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
717
606
  */
718
- export interface UploadFile {
607
+ export interface FlowApproverInfo {
719
608
  /**
720
- * Base64编码后的文件内容
609
+ * 签署人姓名,最大长度50个字符
721
610
  */
722
- FileBody: string;
611
+ Name?: string;
723
612
  /**
724
- * 文件名
613
+ * 经办人身份证件类型
614
+ 1.ID_CARD 居民身份证
615
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
616
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
617
+ */
618
+ IdCardType?: string;
619
+ /**
620
+ * 经办人证件号
725
621
  */
726
- FileName?: string;
727
- }
728
- /**
729
- * 合同组中每个子合同的发起信息
730
- */
731
- export interface FlowFileInfo {
622
+ IdCardNumber?: string;
732
623
  /**
733
- * 签署文件资源Id列表,目前仅支持单个文件
624
+ * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
734
625
  */
735
- FileIds: Array<string>;
626
+ Mobile?: string;
736
627
  /**
737
- * 签署流程名称,长度不超过200个字符
628
+ * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
738
629
  */
739
- FlowName: string;
630
+ OrganizationName?: string;
740
631
  /**
741
- * 签署流程签约方列表,最多不超过5个参与方
632
+ * 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
633
+ 默认为false,即签署人位于同一个渠道应用号下;
634
+ */
635
+ NotChannelOrganization?: boolean;
636
+ /**
637
+ * 用户侧第三方id,最大长度64个字符
742
638
  */
743
- FlowApprovers: Array<FlowApproverInfo>;
639
+ OpenId?: string;
744
640
  /**
745
- * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
641
+ * 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
746
642
  */
747
- Deadline?: number;
643
+ OrganizationOpenId?: string;
748
644
  /**
749
- * 签署流程的描述,长度不超过1000个字符
645
+ * 签署人类型,PERSON-个人;
646
+ PERSON_AUTO_SIGN-个人自动签;
647
+ ORGANIZATION-企业;
648
+ ENTERPRISESERVER-企业静默签;
649
+ 注:ENTERPRISESERVER 类型仅用于使用文件创建签署流程(ChannelCreateFlowByFiles)接口;
650
+ */
651
+ ApproverType?: string;
652
+ /**
653
+ * 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
750
654
  */
751
- FlowDescription?: string;
655
+ RecipientId?: string;
752
656
  /**
753
- * 签署流程的类型,长度不超过255个字符
657
+ * 签署截止时间,默认一年
754
658
  */
755
- FlowType?: string;
659
+ Deadline?: number;
756
660
  /**
757
- * 签署流程回调地址,长度不超过255个字符
661
+ * 签署完回调url,最大长度1000个字符
758
662
  */
759
663
  CallbackUrl?: string;
760
664
  /**
761
- * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
665
+ * 使用PDF文件直接发起合同时,签署人指定的签署控件
762
666
  */
763
- CustomerData?: string;
667
+ SignComponents?: Array<Component>;
764
668
  /**
765
- * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
669
+ * 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
766
670
  */
767
- Unordered?: boolean;
671
+ ComponentLimitType?: Array<string>;
768
672
  /**
769
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
673
+ * 合同的强制预览时间:3~300s,未指定则按合同页数计算
770
674
  */
771
- CustomShowMap?: string;
675
+ PreReadTime?: number;
772
676
  /**
773
- * 本企业(发起方企业)是否需要签署审批
677
+ * 签署完前端跳转的url,暂未使用
774
678
  */
775
- NeedSignReview?: boolean;
679
+ JumpUrl?: string;
680
+ /**
681
+ * 签署人个性化能力值
682
+ */
683
+ ApproverOption?: ApproverOption;
684
+ /**
685
+ * 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
686
+ */
687
+ ApproverNeedSignReview?: boolean;
776
688
  }
777
689
  /**
778
- * ChannelGetTaskResultApi请求参数结构体
690
+ * PrepareFlows返回参数结构体
779
691
  */
780
- export interface ChannelGetTaskResultApiRequest {
692
+ export interface PrepareFlowsResponse {
781
693
  /**
782
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
694
+ * 待发起文件确认页
783
695
  */
784
- Agent: Agent;
696
+ ConfirmUrl: string;
785
697
  /**
786
- * 任务Id,通过ChannelCreateConvertTaskApi接口获得
698
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
787
699
  */
788
- TaskId: string;
700
+ RequestId?: string;
701
+ }
702
+ /**
703
+ * 此结构体 (TemplateInfo) 用于描述模板的信息。
704
+ */
705
+ export interface TemplateInfo {
789
706
  /**
790
- * 操作者的信息
707
+ * 模板ID
791
708
  */
792
- Operator?: UserInfo;
709
+ TemplateId: string;
793
710
  /**
794
- * 暂未开放
711
+ * 模板名字
795
712
  */
796
- Organization?: OrganizationInfo;
713
+ TemplateName: string;
714
+ /**
715
+ * 模板描述信息
716
+ */
717
+ Description: string;
718
+ /**
719
+ * 模板控件信息结构
720
+ */
721
+ Components: Array<Component>;
722
+ /**
723
+ * 签署区模板信息结构
724
+ */
725
+ SignComponents: Array<Component>;
726
+ /**
727
+ * 模板中的流程参与人信息
728
+ */
729
+ Recipients: Array<Recipient>;
730
+ /**
731
+ * 模板类型:1-静默签;3-普通模板
732
+ */
733
+ TemplateType: number;
734
+ /**
735
+ * 是否是发起人 ,已弃用
736
+ */
737
+ IsPromoter: boolean;
738
+ /**
739
+ * 模板的创建者信息
740
+ */
741
+ Creator: string;
742
+ /**
743
+ * 模板创建的时间戳(精确到秒)
744
+ */
745
+ CreatedOn: number;
797
746
  }
798
747
  /**
799
- * ChannelVerifyPdf返回参数结构体
748
+ * GetDownloadFlowUrl返回参数结构体
800
749
  */
801
- export interface ChannelVerifyPdfResponse {
750
+ export interface GetDownloadFlowUrlResponse {
802
751
  /**
803
- * 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
752
+ * 合同(流程)下载地址
804
753
  */
805
- VerifyResult: number;
806
- /**
807
- * 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域
808
- ;5-文件签名格式错误
809
- */
810
- PdfVerifyResults: Array<PdfVerifyResult>;
754
+ DownLoadUrl: string;
811
755
  /**
812
756
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
813
757
  */
814
758
  RequestId?: string;
815
759
  }
816
760
  /**
817
- * 签署链接内容
761
+ * DescribeTemplates返回参数结构体
818
762
  */
819
- export interface SignUrlInfo {
763
+ export interface DescribeTemplatesResponse {
820
764
  /**
821
- * 签署链接,过期时间为30天
822
- 注意:此字段可能返回 null,表示取不到有效值。
823
- */
824
- SignUrl: string;
765
+ * 模板详情
766
+ */
767
+ Templates: Array<TemplateInfo>;
825
768
  /**
826
- * 合同过期时间
827
- 注意:此字段可能返回 null,表示取不到有效值。
828
- */
829
- Deadline: number;
769
+ * 查询总数
770
+ */
771
+ TotalCount: number;
830
772
  /**
831
- * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
832
- 注意:此字段可能返回 null,表示取不到有效值。
833
- */
834
- SignOrder: number;
773
+ * 查询数量
774
+ */
775
+ Limit: number;
835
776
  /**
836
- * 签署人编号
777
+ * 查询起始偏移
778
+ */
779
+ Offset: number;
780
+ /**
781
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
782
+ */
783
+ RequestId?: string;
784
+ }
785
+ /**
786
+ * 渠道版员工角色信息
787
+ */
788
+ export interface StaffRole {
789
+ /**
790
+ * 角色id
837
791
  注意:此字段可能返回 null,表示取不到有效值。
838
792
  */
839
- SignId: string;
793
+ RoleId: string;
840
794
  /**
841
- * 自定义用户编号
795
+ * 角色名称
842
796
  注意:此字段可能返回 null,表示取不到有效值。
843
797
  */
844
- CustomUserId: string;
798
+ RoleName: string;
799
+ }
800
+ /**
801
+ * ChannelVerifyPdf请求参数结构体
802
+ */
803
+ export interface ChannelVerifyPdfRequest {
845
804
  /**
846
- * 用户姓名
847
- 注意:此字段可能返回 null,表示取不到有效值。
848
- */
849
- Name: string;
805
+ * 合同Id,流程Id
806
+ */
807
+ FlowId: string;
850
808
  /**
851
- * 用户手机号码
852
- 注意:此字段可能返回 null,表示取不到有效值。
853
- */
854
- Mobile: string;
809
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
810
+ */
811
+ Agent?: Agent;
855
812
  /**
856
- * 签署参与者机构名字
857
- 注意:此字段可能返回 null,表示取不到有效值。
858
- */
859
- OrganizationName: string;
813
+ * 操作者的信息
814
+ */
815
+ Operator?: UserInfo;
816
+ }
817
+ /**
818
+ * ChannelVerifyPdf返回参数结构体
819
+ */
820
+ export interface ChannelVerifyPdfResponse {
860
821
  /**
861
- * 参与者类型:
862
- ORGANIZATION 企业经办人
863
- PERSON 自然人
864
- 注意:此字段可能返回 null,表示取不到有效值。
865
- */
866
- ApproverType: string;
822
+ * 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
823
+ */
824
+ VerifyResult: number;
867
825
  /**
868
- * 经办人身份证号
869
- 注意:此字段可能返回 null,表示取不到有效值。
826
+ * 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域
827
+ ;5-文件签名格式错误
870
828
  */
871
- IdCardNumber: string;
829
+ PdfVerifyResults: Array<PdfVerifyResult>;
872
830
  /**
873
- * 签署链接对应流程Id
874
- 注意:此字段可能返回 null,表示取不到有效值。
875
- */
876
- FlowId: string;
831
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
832
+ */
833
+ RequestId?: string;
834
+ }
835
+ /**
836
+ * CreateConsoleLoginUrl请求参数结构体
837
+ */
838
+ export interface CreateConsoleLoginUrlRequest {
877
839
  /**
878
- * 企业经办人 用户在渠道的编号
879
- 注意:此字段可能返回 null,表示取不到有效值。
840
+ * 应用信息
841
+ 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
880
842
  */
881
- OpenId: string;
843
+ Agent: Agent;
882
844
  /**
883
- * 合同组签署链接对应的合同组id
884
- 注意:此字段可能返回 null,表示取不到有效值。
885
- */
886
- FlowGroupId: string;
845
+ * 渠道子客企业名称,最大长度64个字符
846
+ */
847
+ ProxyOrganizationName: string;
848
+ /**
849
+ * 渠道子客企业经办人的姓名,最大长度50个字符
850
+ */
851
+ ProxyOperatorName?: string;
852
+ /**
853
+ * 控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
854
+ */
855
+ Module?: string;
856
+ /**
857
+ * 控制台指定模块Id
858
+ */
859
+ ModuleId?: string;
860
+ /**
861
+ * 渠道子客企业统一社会信用代码,最大长度200个字符
862
+ */
863
+ UniformSocialCreditCode?: string;
864
+ /**
865
+ * 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
866
+ */
867
+ MenuStatus?: string;
868
+ /**
869
+ * 操作者的信息
870
+ */
871
+ Operator?: UserInfo;
887
872
  }
888
873
  /**
889
- * 此结构体 (Component) 用于描述控件属性。
890
-
891
- 在通过文件发起合同时,对应的component有三种定位方式
892
- 1. 绝对定位方式
893
- 2. 表单域(FIELD)定位方式
894
- 3. 关键字(KEYWORD)定位方式
895
- 可以参考官网说明
896
- https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
874
+ * 机构信息
897
875
  */
898
- export interface Component {
876
+ export interface OrganizationInfo {
899
877
  /**
900
- * 控件编号
901
-
902
- CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
903
-
904
- 注:
905
- 当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
906
- 例:
907
- 当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
908
- 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
909
-
910
- 创建控件时,此值为空
911
- 查询时返回完整结构
912
- */
913
- ComponentId?: string;
878
+ * 用户在渠道的机构编号
879
+ */
880
+ OrganizationOpenId: string;
914
881
  /**
915
- * 如果是Component控件类型,则可选的字段为:
916
- TEXT - 普通文本控件;
917
- MULTI_LINE_TEXT - 多行文本控件;
918
- CHECK_BOX - 勾选框控件;
919
- FILL_IMAGE - 图片控件;
920
- DYNAMIC_TABLE - 动态表格控件;
921
- ATTACHMENT - 附件控件;
922
- SELECTOR - 选择器控件;
923
- DATE - 日期控件;默认是格式化为xxxx年xx月xx日
924
-
925
- 如果是SignComponent控件类型,则可选的字段为
926
- SIGN_SEAL - 签署印章控件;
927
- SIGN_DATE - 签署日期控件;
928
- SIGN_SIGNATURE - 用户签名控件;
929
- SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
930
- SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
931
-
932
- 表单域的控件不能作为印章和签名控件
933
- */
934
- ComponentType?: string;
882
+ * 用户真实的IP
883
+ */
884
+ ClientIp: string;
935
885
  /**
936
- * 控件简称,不能超过30个字符
886
+ * 机构的代理IP
937
887
  */
938
- ComponentName?: string;
888
+ ProxyIp: string;
939
889
  /**
940
- * 定义控件是否为必填项,默认为false
890
+ * 机构在平台的编号
941
891
  */
942
- ComponentRequired?: boolean;
892
+ OrganizationId?: string;
943
893
  /**
944
- * 控件关联的签署方id
894
+ * 用户渠道
945
895
  */
946
- ComponentRecipientId?: string;
896
+ Channel?: string;
897
+ }
898
+ /**
899
+ * 合同文件验签单个结果结构体
900
+ */
901
+ export interface PdfVerifyResult {
947
902
  /**
948
- * 控件所属文件的序号 (文档中文件的排列序号,从0开始)
903
+ * 验签结果
949
904
  */
950
- FileIndex?: number;
905
+ VerifyResult: number;
951
906
  /**
952
- * 控件生成的方式:
953
- NORMAL - 普通控件
954
- FIELD - 表单域
955
- KEYWORD - 关键字
956
- */
957
- GenerateMode?: string;
907
+ * 签署平台
908
+ */
909
+ SignPlatform: string;
958
910
  /**
959
- * 参数控件宽度,默认100,单位px
960
- 表单域和关键字转换控件不用填
961
- */
962
- ComponentWidth?: number;
911
+ * 签署人名称
912
+ */
913
+ SignerName: string;
963
914
  /**
964
- * 参数控件高度,默认100,单位px
965
- 表单域和关键字转换控件不用填
966
- */
967
- ComponentHeight?: number;
915
+ * 签署时间
916
+ */
917
+ SignTime: number;
968
918
  /**
969
- * 参数控件所在页码,从1开始
919
+ * 签名算法
970
920
  */
971
- ComponentPage?: number;
921
+ SignAlgorithm: string;
972
922
  /**
973
- * 参数控件X位置,单位px
923
+ * 签名证书序列号
974
924
  */
975
- ComponentPosX?: number;
925
+ CertSn: string;
976
926
  /**
977
- * 参数控件Y位置,单位px
927
+ * 证书起始时间
978
928
  */
979
- ComponentPosY?: number;
929
+ CertNotBefore: number;
980
930
  /**
981
- * 参数控件样式,json格式表述
982
- 不同类型的控件会有部分非通用参数
983
- TEXT/MULTI_LINE_TEXT控件可以指定
984
- 1 Font:目前只支持黑体、宋体
985
- 2 FontSize: 范围12-72
986
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
987
- 例如:{"FontSize":12}
988
- */
989
- ComponentExtra?: string;
931
+ * 证书过期时间
932
+ */
933
+ CertNotAfter: number;
990
934
  /**
991
- * 控件填充vaule,ComponentType和传入值类型对应关系:
992
- TEXT - 文本内容
993
- MULTI_LINE_TEXT - 文本内容
994
- CHECK_BOX - true/false
995
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
996
- SELECTOR - 选项值
997
- DATE - 默认是格式化为xxxx年xx月xx日
998
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
999
- SIGN_SEAL - 印章ID
1000
- SIGN_PAGING_SEAL - 可以指定印章ID
1001
- */
1002
- ComponentValue?: string;
935
+ * 签名类型
936
+ */
937
+ SignType: number;
1003
938
  /**
1004
- * 日期签署控件的字号,默认为 12
1005
-
1006
- 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
1007
- */
1008
- ComponentDateFontSize?: number;
939
+ * 签名域横坐标
940
+ */
941
+ ComponentPosX: number;
1009
942
  /**
1010
- * 控件所属文档的Id, 模块相关接口为空值
943
+ * 签名域纵坐标
1011
944
  */
1012
- DocumentId?: string;
945
+ ComponentPosY: number;
1013
946
  /**
1014
- * 控件描述,不能超过30个字符
947
+ * 签名域宽度
1015
948
  */
1016
- ComponentDescription?: string;
949
+ ComponentWidth: number;
1017
950
  /**
1018
- * 指定关键字时横坐标偏移量,单位pt
951
+ * 签名域高度
1019
952
  */
1020
- OffsetX?: number;
953
+ ComponentHeight: number;
1021
954
  /**
1022
- * 指定关键字时纵坐标偏移量,单位pt
955
+ * 签名域所在页码
1023
956
  */
1024
- OffsetY?: number;
957
+ ComponentPage: number;
1025
958
  }
1026
959
  /**
1027
- * GetDownloadFlowUrl请求参数结构体
960
+ * ChannelCancelMultiFlowSignQRCode请求参数结构体
1028
961
  */
1029
- export interface GetDownloadFlowUrlRequest {
962
+ export interface ChannelCancelMultiFlowSignQRCodeRequest {
1030
963
  /**
1031
964
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1032
965
  */
1033
966
  Agent: Agent;
1034
967
  /**
1035
- * 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
968
+ * 二维码id
1036
969
  */
1037
- DownLoadFlows?: Array<DownloadFlowInfo>;
970
+ QrCodeId: string;
1038
971
  /**
1039
- * 操作者的信息
972
+ * 用户信息
1040
973
  */
1041
974
  Operator?: UserInfo;
1042
975
  }
1043
976
  /**
1044
- * ChannelBatchCancelFlows请求参数结构体
977
+ * ChannelDescribeOrganizationSeals请求参数结构体
1045
978
  */
1046
- export interface ChannelBatchCancelFlowsRequest {
979
+ export interface ChannelDescribeOrganizationSealsRequest {
1047
980
  /**
1048
981
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1049
982
  */
1050
983
  Agent: Agent;
1051
984
  /**
1052
- * 签署流程Id数组,最多100个,超过100不处理
985
+ * 返回最大数量,最大为100
1053
986
  */
1054
- FlowIds: Array<string>;
987
+ Limit: number;
1055
988
  /**
1056
- * 撤销理由
989
+ * 偏移量,默认为0,最大为20000
1057
990
  */
1058
- CancelMessage?: string;
991
+ Offset?: number;
1059
992
  /**
1060
- * 撤销理由自定义格式;选项:
1061
- 0 默认格式
1062
- 1 只保留身份信息:展示为【发起方】
1063
- 2 保留身份信息+企业名称:展示为【发起方xxx公司】
1064
- 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
1065
- */
1066
- CancelMessageFormat?: number;
993
+ * 查询信息类型,为0时不返回授权用户,为1时返回
994
+ */
995
+ InfoType?: number;
1067
996
  /**
1068
- * 操作人信息
997
+ * 印章id(没有输入返回所有)
1069
998
  */
1070
- Operator?: UserInfo;
999
+ SealId?: string;
1071
1000
  }
1072
1001
  /**
1073
- * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
1002
+ * DescribeUsage请求参数结构体
1074
1003
  */
1075
- export interface FlowDetailInfo {
1004
+ export interface DescribeUsageRequest {
1076
1005
  /**
1077
- * 合同(流程)的Id
1006
+ * 应用信息
1078
1007
  */
1079
- FlowId: string;
1008
+ Agent: Agent;
1080
1009
  /**
1081
- * 合同(流程)的名字
1010
+ * 开始时间,例如:2021-03-21
1082
1011
  */
1083
- FlowName: string;
1012
+ StartDate: string;
1084
1013
  /**
1085
- * 合同(流程)的类型
1014
+ * 结束时间,例如:2021-06-21;
1015
+ 开始时间到结束时间的区间长度小于等于90天。
1016
+ */
1017
+ EndDate: string;
1018
+ /**
1019
+ * 是否汇总数据,默认不汇总。
1020
+ 不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
1021
+ 汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
1022
+ */
1023
+ NeedAggregate?: boolean;
1024
+ /**
1025
+ * 单次返回的最多条目数量。默认为1000,且不能超过1000。
1086
1026
  */
1087
- FlowType: string;
1027
+ Limit?: number;
1088
1028
  /**
1089
- * 合同(流程)的状态
1029
+ * 偏移量,默认是0。
1090
1030
  */
1091
- FlowStatus: string;
1031
+ Offset?: number;
1092
1032
  /**
1093
- * 合同(流程)的信息
1033
+ * 操作者的信息
1094
1034
  */
1095
- FlowMessage: string;
1035
+ Operator?: UserInfo;
1036
+ }
1037
+ /**
1038
+ * 此结构 (FormField) 用于描述内容控件填充结构。
1039
+
1040
+ */
1041
+ export interface FormField {
1042
+ /**
1043
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
1044
+ TEXT - 文本内容
1045
+ MULTI_LINE_TEXT - 文本内容
1046
+ CHECK_BOX - true/false
1047
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1048
+ SELECTOR - 选项值
1049
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
1050
+ */
1051
+ ComponentValue: string;
1052
+ /**
1053
+ * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
1054
+ CreateFlowsByTemplates 接口不使用此字段。
1055
+ 注意:此字段可能返回 null,表示取不到有效值。
1056
+ */
1057
+ ComponentId?: string;
1058
+ /**
1059
+ * 控件的名字,跟ComponentId二选一,不能全为空
1060
+ 注意:此字段可能返回 null,表示取不到有效值。
1061
+ */
1062
+ ComponentName?: string;
1063
+ }
1064
+ /**
1065
+ * 此结构体 (FlowInfo) 用于描述签署流程信息。
1066
+
1067
+ 【动态表格传参说明】
1068
+ 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
1069
+ 输入示例
1070
+
1071
+ ```
1072
+ {
1073
+ "headers":[
1074
+ {
1075
+ "content":"head1"
1076
+ },
1077
+ {
1078
+ "content":"head2"
1079
+ },
1080
+ {
1081
+ "content":"head3"
1082
+ }
1083
+ ],
1084
+ "rowCount":3,
1085
+ "body":{
1086
+ "cells":[
1087
+ {
1088
+ "rowStart":1,
1089
+ "rowEnd":1,
1090
+ "columnStart":1,
1091
+ "columnEnd":1,
1092
+ "content":"123"
1093
+ },
1094
+ {
1095
+ "rowStart":2,
1096
+ "rowEnd":3,
1097
+ "columnStart":1,
1098
+ "columnEnd":2,
1099
+ "content":"456"
1100
+ },
1101
+ {
1102
+ "rowStart":3,
1103
+ "rowEnd":3,
1104
+ "columnStart":3,
1105
+ "columnEnd":3,
1106
+ "content":"789"
1107
+ }
1108
+ ]
1109
+ }
1110
+ }
1111
+
1112
+ ```
1113
+
1114
+ 表格参数说明
1115
+
1116
+ | 名称 | 类型 | 描述 |
1117
+ | ------------------- | ------- | ------------------------------------------------- |
1118
+ | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
1119
+ | rowCount | Integer | 表格内容最大行数 |
1120
+ | cells.N.rowStart | Integer | 单元格坐标:行起始index |
1121
+ | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
1122
+ | cells.N.columnStart | Integer | 单元格坐标:列起始index |
1123
+ | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
1124
+ | cells.N.content | String | 单元格内容,字数不超过100 |
1125
+
1126
+ */
1127
+ export interface FlowInfo {
1096
1128
  /**
1097
- * 合同(流程)的创建时间戳
1129
+ * 合同名字,最大长度200个字符
1098
1130
  */
1099
- CreateOn: number;
1131
+ FlowName: string;
1100
1132
  /**
1101
- * 合同(流程)的签署截止时间戳
1133
+ * 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
1102
1134
  */
1103
- DeadLine: number;
1135
+ Deadline: number;
1104
1136
  /**
1105
- * 用户自定义数据
1137
+ * 模板ID
1106
1138
  */
1107
- CustomData: string;
1139
+ TemplateId?: string;
1108
1140
  /**
1109
- * 合同(流程)的签署人数组
1141
+ * 多个签署人信息,最大支持50个签署方
1110
1142
  */
1111
- FlowApproverInfos: Array<FlowApproverDetail>;
1112
- }
1113
- /**
1114
- * 同步经办人失败原因
1115
- */
1116
- export interface SyncFailReason {
1143
+ FlowApprovers?: Array<FlowApproverInfo>;
1117
1144
  /**
1118
- * 经办人Id
1145
+ * 表单K-V对列表
1119
1146
  */
1120
- Id: string;
1121
- /**
1122
- * 失败原因
1123
- 例如:Id不符合规范、证件号码不合法等
1124
- 注意:此字段可能返回 null,表示取不到有效值。
1125
- */
1126
- Message: string;
1127
- }
1128
- /**
1129
- * CreateConsoleLoginUrl请求参数结构体
1130
- */
1131
- export interface CreateConsoleLoginUrlRequest {
1132
- /**
1133
- * 应用信息
1134
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
1135
- */
1136
- Agent: Agent;
1147
+ FormFields?: Array<FormField>;
1137
1148
  /**
1138
- * 渠道子客企业名称,最大长度64个字符
1149
+ * 回调地址,最大长度1000个字符
1139
1150
  */
1140
- ProxyOrganizationName: string;
1151
+ CallbackUrl?: string;
1141
1152
  /**
1142
- * 渠道子客企业经办人的姓名,最大长度50个字符
1153
+ * 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
1143
1154
  */
1144
- ProxyOperatorName?: string;
1155
+ FlowType?: string;
1145
1156
  /**
1146
- * 控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
1157
+ * 合同描述,最大长度1000个字符
1147
1158
  */
1148
- Module?: string;
1159
+ FlowDescription?: string;
1149
1160
  /**
1150
- * 控制台指定模块Id
1161
+ * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1151
1162
  */
1152
- ModuleId?: string;
1163
+ CustomerData?: string;
1153
1164
  /**
1154
- * 渠道子客企业统一社会信用代码,最大长度200个字符
1165
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1155
1166
  */
1156
- UniformSocialCreditCode?: string;
1167
+ CustomShowMap?: string;
1157
1168
  /**
1158
- * 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
1169
+ * 被抄送人的信息列表,抄送功能暂不开放
1159
1170
  */
1160
- MenuStatus?: string;
1171
+ CcInfos?: Array<CcInfo>;
1161
1172
  /**
1162
- * 操作者的信息
1163
- */
1164
- Operator?: UserInfo;
1173
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
1174
+ 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1175
+
1176
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1177
+ */
1178
+ NeedSignReview?: boolean;
1165
1179
  }
1166
1180
  /**
1167
- * 机构信息
1181
+ * 接口调用者信息
1168
1182
  */
1169
- export interface OrganizationInfo {
1183
+ export interface UserInfo {
1170
1184
  /**
1171
- * 用户在渠道的机构编号
1185
+ * 用户在渠道的编号,最大64位字符串
1172
1186
  */
1173
- OrganizationOpenId: string;
1187
+ OpenId?: string;
1174
1188
  /**
1175
- * 用户真实的IP
1189
+ * 用户的来源渠道
1176
1190
  */
1177
- ClientIp: string;
1191
+ Channel?: string;
1178
1192
  /**
1179
- * 机构的代理IP
1193
+ * 自定义用户编号
1180
1194
  */
1181
- ProxyIp: string;
1195
+ CustomUserId?: string;
1182
1196
  /**
1183
- * 机构在平台的编号
1197
+ * 用户真实IP
1184
1198
  */
1185
- OrganizationId?: string;
1199
+ ClientIp?: string;
1186
1200
  /**
1187
- * 用户渠道
1201
+ * 用户代理IP
1188
1202
  */
1189
- Channel?: string;
1203
+ ProxyIp?: string;
1190
1204
  }
1191
1205
  /**
1192
- * CreateFlowsByTemplates返回参数结构体
1206
+ * DescribeFlowDetailInfo返回参数结构体
1193
1207
  */
1194
- export interface CreateFlowsByTemplatesResponse {
1208
+ export interface DescribeFlowDetailInfoResponse {
1195
1209
  /**
1196
- * 多个合同ID
1210
+ * 渠道侧应用号Id
1197
1211
  */
1198
- FlowIds: Array<string>;
1212
+ ApplicationId: string;
1199
1213
  /**
1200
- * 渠道的业务信息,限制1024字符
1214
+ * 渠道侧企业第三方Id
1201
1215
  */
1202
- CustomerData: Array<string>;
1216
+ ProxyOrganizationOpenId: string;
1203
1217
  /**
1204
- * 创建消息,对应多个合同ID,
1205
- 成功为“”,创建失败则对应失败消息
1218
+ * 合同(签署流程)的具体详细描述信息
1219
+ 注意:此字段可能返回 null,表示取不到有效值。
1206
1220
  */
1207
- ErrorMessages: Array<string>;
1221
+ FlowInfo: Array<FlowDetailInfo>;
1208
1222
  /**
1209
- * 预览模式下返回的预览文件url数组
1210
- */
1211
- PreviewUrls: Array<string>;
1223
+ * 合同组编号
1224
+ 注意:此字段可能返回 null,表示取不到有效值。
1225
+ */
1226
+ FlowGroupId: string;
1212
1227
  /**
1213
- * 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
1214
- 如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
1228
+ * 合同组名称
1229
+ 注意:此字段可能返回 null,表示取不到有效值。
1215
1230
  */
1216
- TaskInfos: Array<TaskInfo>;
1231
+ FlowGroupName: string;
1217
1232
  /**
1218
1233
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1219
1234
  */
1220
1235
  RequestId?: string;
1221
1236
  }
1222
- /**
1223
- * ChannelCreateFlowSignReview请求参数结构体
1224
- */
1225
- export interface ChannelCreateFlowSignReviewRequest {
1226
- /**
1227
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1228
- */
1229
- Agent: Agent;
1230
- /**
1231
- * 签署流程编号
1232
- */
1233
- FlowId: string;
1234
- /**
1235
- * 企业内部审核结果
1236
- PASS: 通过
1237
- REJECT: 拒绝
1238
- SIGN_REJECT:拒签(流程结束)
1239
- */
1240
- ReviewType: string;
1241
- /**
1242
- * 审核原因
1243
- 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
1244
- */
1245
- ReviewMessage?: string;
1246
- }
1247
1237
  /**
1248
1238
  * DescribeUsage返回参数结构体
1249
1239
  */
@@ -1263,552 +1253,561 @@ export interface DescribeUsageResponse {
1263
1253
  RequestId?: string;
1264
1254
  }
1265
1255
  /**
1266
- * 合作企业经办人列表信息
1256
+ * 企业员工信息
1267
1257
  */
1268
- export interface ProxyOrganizationOperator {
1258
+ export interface Staff {
1269
1259
  /**
1270
- * 经办人ID(渠道颁发),最大长度64个字符
1260
+ * 员工在电子签平台的id
1271
1261
  */
1272
- Id: string;
1262
+ UserId: string;
1273
1263
  /**
1274
- * 经办人姓名,最大长度50个字符
1264
+ * 显示的员工名
1275
1265
  */
1276
- Name?: string;
1277
- /**
1278
- * 经办人身份证件类型
1279
- 1.ID_CARD 居民身份证
1280
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
1281
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
1282
- */
1283
- IdCardType?: string;
1266
+ DisplayName: string;
1284
1267
  /**
1285
- * 经办人证件号
1268
+ * 员工手机号
1286
1269
  */
1287
- IdCardNumber?: string;
1270
+ Mobile: string;
1288
1271
  /**
1289
- * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
1290
- */
1291
- Mobile?: string;
1292
- }
1293
- /**
1294
- * SyncProxyOrganizationOperators返回参数结构体
1295
- */
1296
- export interface SyncProxyOrganizationOperatorsResponse {
1272
+ * 员工邮箱
1273
+ 注意:此字段可能返回 null,表示取不到有效值。
1274
+ */
1275
+ Email: string;
1297
1276
  /**
1298
- * Status 同步状态,全部同步失败接口会直接报错
1299
- 1-成功
1300
- 2-部分成功
1277
+ * 员工在第三方平台id
1301
1278
  注意:此字段可能返回 null,表示取不到有效值。
1302
1279
  */
1303
- Status: number;
1280
+ OpenId: string;
1304
1281
  /**
1305
- * 同步失败经办人及其失败原因
1282
+ * 员工角色
1306
1283
  注意:此字段可能返回 null,表示取不到有效值。
1307
1284
  */
1308
- FailedList: Array<SyncFailReason>;
1285
+ Roles: Array<StaffRole>;
1309
1286
  /**
1310
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1287
+ * 员工部门
1288
+ 注意:此字段可能返回 null,表示取不到有效值。
1289
+ */
1290
+ Department: Department;
1291
+ /**
1292
+ * 员工是否实名
1311
1293
  */
1312
- RequestId?: string;
1313
- }
1314
- /**
1315
- * CreateSealByImage返回参数结构体
1316
- */
1317
- export interface CreateSealByImageResponse {
1294
+ Verified: boolean;
1318
1295
  /**
1319
- * 印章id
1296
+ * 员工创建时间戳
1320
1297
  */
1321
- SealId: string;
1298
+ CreatedOn: number;
1322
1299
  /**
1323
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1300
+ * 员工实名时间戳
1324
1301
  */
1325
- RequestId?: string;
1302
+ VerifiedOn: number;
1326
1303
  }
1327
1304
  /**
1328
- * ChannelVerifyPdf请求参数结构体
1305
+ * ChannelDescribeEmployees请求参数结构体
1329
1306
  */
1330
- export interface ChannelVerifyPdfRequest {
1307
+ export interface ChannelDescribeEmployeesRequest {
1331
1308
  /**
1332
- * 合同Id,流程Id
1309
+ * 返回最大数量,最大为20
1333
1310
  */
1334
- FlowId: string;
1311
+ Limit: number;
1335
1312
  /**
1336
1313
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1337
1314
  */
1338
1315
  Agent?: Agent;
1316
+ /**
1317
+ * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
1318
+ 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
1319
+ */
1320
+ Filters?: Array<Filter>;
1321
+ /**
1322
+ * 偏移量,默认为0,最大为20000
1323
+ */
1324
+ Offset?: number;
1339
1325
  /**
1340
1326
  * 操作者的信息
1341
1327
  */
1342
1328
  Operator?: UserInfo;
1343
1329
  }
1344
1330
  /**
1345
- * DescribeResourceUrlsByFlows请求参数结构体
1331
+ * 授权用户
1346
1332
  */
1347
- export interface DescribeResourceUrlsByFlowsRequest {
1348
- /**
1349
- * 渠道应用相关信息。
1350
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1351
- */
1352
- Agent: Agent;
1353
- /**
1354
- * 查询资源所对应的签署流程Id,最多支持50个
1355
- */
1356
- FlowIds?: Array<string>;
1333
+ export interface AuthorizedUser {
1357
1334
  /**
1358
- * 操作者的信息
1335
+ * 用户openid
1359
1336
  */
1360
- Operator?: UserInfo;
1337
+ OpenId: string;
1361
1338
  }
1362
1339
  /**
1363
- * 流程对应资源链接信息
1340
+ * DescribeResourceUrlsByFlows返回参数结构体
1364
1341
  */
1365
- export interface FlowResourceUrlInfo {
1342
+ export interface DescribeResourceUrlsByFlowsResponse {
1366
1343
  /**
1367
- * 流程对应Id
1368
- 注意:此字段可能返回 null,表示取不到有效值。
1369
- */
1370
- FlowId: string;
1344
+ * 签署流程资源对应链接信息
1345
+ */
1346
+ FlowResourceUrlInfos: Array<FlowResourceUrlInfo>;
1371
1347
  /**
1372
- * 流程对应资源链接信息数组
1373
- 注意:此字段可能返回 null,表示取不到有效值。
1348
+ * 创建消息,对应多个合同ID,
1349
+ 成功为“”,创建失败则对应失败消息
1374
1350
  */
1375
- ResourceUrlInfos: Array<ResourceUrlInfo>;
1351
+ ErrorMessages: Array<string>;
1352
+ /**
1353
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1354
+ */
1355
+ RequestId?: string;
1376
1356
  }
1377
1357
  /**
1378
- * ChannelCancelFlow请求参数结构体
1358
+ * SyncProxyOrganizationOperators请求参数结构体
1379
1359
  */
1380
- export interface ChannelCancelFlowRequest {
1360
+ export interface SyncProxyOrganizationOperatorsRequest {
1381
1361
  /**
1382
- * 签署流程编号
1362
+ * 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
1383
1363
  */
1384
- FlowId: string;
1364
+ Agent: Agent;
1385
1365
  /**
1386
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1366
+ * 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
1387
1367
  */
1388
- Agent?: Agent;
1368
+ OperatorType: string;
1389
1369
  /**
1390
- * 撤回原因,最大不超过200字符
1370
+ * 经办人信息列表,最大长度200
1391
1371
  */
1392
- CancelMessage?: string;
1372
+ ProxyOrganizationOperators: Array<ProxyOrganizationOperator>;
1393
1373
  /**
1394
1374
  * 操作者的信息
1395
1375
  */
1396
1376
  Operator?: UserInfo;
1397
- /**
1398
- * 撤销理由自定义格式;选项:
1399
- 0 默认格式
1400
- 1 只保留身份信息:展示为【发起方】
1401
- 2 保留身份信息+企业名称:展示为【发起方xxx公司】
1402
- 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
1403
- */
1404
- CancelMessageFormat?: number;
1405
1377
  }
1406
1378
  /**
1407
- * DescribeTemplates请求参数结构体
1379
+ * CreateSignUrls请求参数结构体
1408
1380
  */
1409
- export interface DescribeTemplatesRequest {
1381
+ export interface CreateSignUrlsRequest {
1410
1382
  /**
1411
1383
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1412
1384
  */
1413
1385
  Agent: Agent;
1414
1386
  /**
1415
- * 模板唯一标识,查询单个模板时使用
1387
+ * 签署流程编号数组,最多支持100个。(备注:该参数和合同组编号必须二选一)
1416
1388
  */
1417
- TemplateId?: string;
1389
+ FlowIds?: Array<string>;
1418
1390
  /**
1419
- * 查询内容:0-模板列表及详情(默认),1-仅模板列表
1391
+ * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
1420
1392
  */
1421
- ContentType?: number;
1393
+ FlowGroupId?: string;
1422
1394
  /**
1423
- * 查询个数,默认20,最大100;在查询列表的时候有效
1395
+ * 签署链接类型:“WEIXINAPP”-短链直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;"LONGURL2WEIXINAPP"-长链接跳转小程序;默认“WEIXINAPP”类型,即跳转至小程序;
1424
1396
  */
1425
- Limit?: number;
1397
+ Endpoint?: string;
1426
1398
  /**
1427
- * 查询偏移位置,默认0;在查询列表的时候有效
1428
- */
1429
- Offset?: number;
1399
+ * 签署链接生成类型,默认是 "ALL";
1400
+ "ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
1401
+ "CHANNEL":渠道合作企业;
1402
+ "NOT_CHANNEL":非渠道合作企业;
1403
+ "PERSON":个人;
1404
+ "FOLLOWER":关注方,目前是合同抄送方;
1405
+ */
1406
+ GenerateType?: string;
1430
1407
  /**
1431
- * 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
1408
+ * 非渠道合作企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
1432
1409
  */
1433
- QueryAllComponents?: boolean;
1410
+ OrganizationName?: string;
1434
1411
  /**
1435
- * 模糊搜索模板名称,最大长度200
1412
+ * 参与人姓名,GenerateType为"PERSON"时必填
1436
1413
  */
1437
- TemplateName?: string;
1414
+ Name?: string;
1438
1415
  /**
1439
- * 操作者的信息
1416
+ * 参与人手机号;
1417
+ GenerateType为"PERSON"或"FOLLOWER"时必填
1418
+ */
1419
+ Mobile?: string;
1420
+ /**
1421
+ * 渠道合作企业的企业Id,GenerateType为"CHANNEL"时必填
1440
1422
  */
1441
- Operator?: UserInfo;
1442
- }
1443
- /**
1444
- * SyncProxyOrganizationOperators请求参数结构体
1445
- */
1446
- export interface SyncProxyOrganizationOperatorsRequest {
1423
+ OrganizationOpenId?: string;
1447
1424
  /**
1448
- * 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
1425
+ * 渠道合作企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人
1449
1426
  */
1450
- Agent: Agent;
1427
+ OpenId?: string;
1451
1428
  /**
1452
- * 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
1429
+ * Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
1453
1430
  */
1454
- OperatorType: string;
1431
+ AutoJumpBack?: boolean;
1455
1432
  /**
1456
- * 经办人信息列表,最大长度200
1433
+ * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
1457
1434
  */
1458
- ProxyOrganizationOperators: Array<ProxyOrganizationOperator>;
1435
+ JumpUrl?: string;
1459
1436
  /**
1460
1437
  * 操作者的信息
1461
1438
  */
1462
1439
  Operator?: UserInfo;
1463
1440
  }
1464
1441
  /**
1465
- * CreateConsoleLoginUrl返回参数结构体
1442
+ * ChannelCreateMultiFlowSignQRCode请求参数结构体
1466
1443
  */
1467
- export interface CreateConsoleLoginUrlResponse {
1444
+ export interface ChannelCreateMultiFlowSignQRCodeRequest {
1468
1445
  /**
1469
- * 子客Web控制台url,此链接5分钟内有效,且只能访问一次。同时需要注意:
1470
- 1. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接);
1471
- 2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
1446
+ * 渠道应用相关信息。
1447
+ 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
1472
1448
  */
1473
- ConsoleUrl: string;
1449
+ Agent: Agent;
1474
1450
  /**
1475
- * 渠道子客企业是否已开通腾讯电子签
1451
+ * 模版ID
1476
1452
  */
1477
- IsActivated: boolean;
1453
+ TemplateId: string;
1478
1454
  /**
1479
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1455
+ * 签署流程名称,最大长度200个字符。
1480
1456
  */
1481
- RequestId?: string;
1482
- }
1483
- /**
1484
- * CreateFlowsByTemplates请求参数结构体
1485
- */
1486
- export interface CreateFlowsByTemplatesRequest {
1457
+ FlowName: string;
1487
1458
  /**
1488
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1459
+ * 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
1489
1460
  */
1490
- Agent: Agent;
1461
+ MaxFlowNum?: number;
1491
1462
  /**
1492
- * 多个合同(签署流程)信息,最多支持20个
1463
+ * 签署流程有效天数 默认7天 最高设置不超过30天
1493
1464
  */
1494
- FlowInfos: Array<FlowInfo>;
1465
+ FlowEffectiveDay?: number;
1495
1466
  /**
1496
- * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls(此Url返回的是PDF文件流 );
1497
- 预览链接有效期300秒;
1498
- 同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
1467
+ * 二维码有效天数 默认7天 最高设置不超过90天
1468
+ */
1469
+ QrEffectiveDay?: number;
1470
+ /**
1471
+ * 限制二维码用户条件
1472
+ */
1473
+ Restrictions?: Array<ApproverRestriction>;
1474
+ /**
1475
+ * 回调地址,最大长度1000个字符
1476
+ 不传默认使用渠道应用号配置的回调地址
1477
+ 回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
1499
1478
  */
1500
- NeedPreview?: boolean;
1479
+ CallbackUrl?: string;
1501
1480
  /**
1502
- * 操作者的信息
1481
+ * 用户信息
1503
1482
  */
1504
1483
  Operator?: UserInfo;
1484
+ /**
1485
+ * 限制二维码用户条件(已弃用)
1486
+ */
1487
+ ApproverRestrictions?: ApproverRestriction;
1505
1488
  }
1506
1489
  /**
1507
- * 此结构体 (Filter) 用于描述查询过滤条件。
1490
+ * 一码多扫签署二维码对象
1508
1491
  */
1509
- export interface Filter {
1492
+ export interface SignQrCode {
1510
1493
  /**
1511
- * 查询过滤条件的Key
1494
+ * 二维码id
1512
1495
  */
1513
- Key: string;
1496
+ QrCodeId: string;
1514
1497
  /**
1515
- * 查询过滤条件的Value列表
1498
+ * 二维码url
1516
1499
  */
1517
- Values: Array<string>;
1500
+ QrCodeUrl: string;
1501
+ /**
1502
+ * 二维码过期时间
1503
+ */
1504
+ ExpiredTime: number;
1518
1505
  }
1519
1506
  /**
1520
- * SyncProxyOrganization请求参数结构体
1507
+ * ChannelGetTaskResultApi请求参数结构体
1521
1508
  */
1522
- export interface SyncProxyOrganizationRequest {
1509
+ export interface ChannelGetTaskResultApiRequest {
1523
1510
  /**
1524
- * 应用信息
1525
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
1526
- */
1511
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1512
+ */
1527
1513
  Agent: Agent;
1528
1514
  /**
1529
- * 渠道侧合作企业名称,最大长度64个字符
1515
+ * 任务Id,通过ChannelCreateConvertTaskApi接口获得
1530
1516
  */
1531
- ProxyOrganizationName: string;
1517
+ TaskId: string;
1532
1518
  /**
1533
- * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
1519
+ * 操作者的信息
1534
1520
  */
1535
- BusinessLicense?: string;
1521
+ Operator?: UserInfo;
1536
1522
  /**
1537
- * 渠道侧合作企业统一社会信用代码,最大长度200个字符
1523
+ * 暂未开放
1538
1524
  */
1539
- UniformSocialCreditCode?: string;
1525
+ Organization?: OrganizationInfo;
1526
+ }
1527
+ /**
1528
+ * 签署链接内容
1529
+ */
1530
+ export interface SignUrlInfo {
1531
+ /**
1532
+ * 签署链接,过期时间为30天
1533
+ 注意:此字段可能返回 null,表示取不到有效值。
1534
+ */
1535
+ SignUrl: string;
1536
+ /**
1537
+ * 合同过期时间
1538
+ 注意:此字段可能返回 null,表示取不到有效值。
1539
+ */
1540
+ Deadline: number;
1541
+ /**
1542
+ * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
1543
+ 注意:此字段可能返回 null,表示取不到有效值。
1544
+ */
1545
+ SignOrder: number;
1546
+ /**
1547
+ * 签署人编号
1548
+ 注意:此字段可能返回 null,表示取不到有效值。
1549
+ */
1550
+ SignId: string;
1551
+ /**
1552
+ * 自定义用户编号
1553
+ 注意:此字段可能返回 null,表示取不到有效值。
1554
+ */
1555
+ CustomUserId: string;
1556
+ /**
1557
+ * 用户姓名
1558
+ 注意:此字段可能返回 null,表示取不到有效值。
1559
+ */
1560
+ Name: string;
1561
+ /**
1562
+ * 用户手机号码
1563
+ 注意:此字段可能返回 null,表示取不到有效值。
1564
+ */
1565
+ Mobile: string;
1566
+ /**
1567
+ * 签署参与者机构名字
1568
+ 注意:此字段可能返回 null,表示取不到有效值。
1569
+ */
1570
+ OrganizationName: string;
1571
+ /**
1572
+ * 参与者类型:
1573
+ ORGANIZATION 企业经办人
1574
+ PERSON 自然人
1575
+ 注意:此字段可能返回 null,表示取不到有效值。
1576
+ */
1577
+ ApproverType: string;
1578
+ /**
1579
+ * 经办人身份证号
1580
+ 注意:此字段可能返回 null,表示取不到有效值。
1581
+ */
1582
+ IdCardNumber: string;
1583
+ /**
1584
+ * 签署链接对应流程Id
1585
+ 注意:此字段可能返回 null,表示取不到有效值。
1586
+ */
1587
+ FlowId: string;
1540
1588
  /**
1541
- * 操作者的信息
1542
- */
1543
- Operator?: UserInfo;
1589
+ * 企业经办人 用户在渠道的编号
1590
+ 注意:此字段可能返回 null,表示取不到有效值。
1591
+ */
1592
+ OpenId: string;
1593
+ /**
1594
+ * 合同组签署链接对应的合同组id
1595
+ 注意:此字段可能返回 null,表示取不到有效值。
1596
+ */
1597
+ FlowGroupId: string;
1544
1598
  }
1545
1599
  /**
1546
- * CreateSealByImage请求参数结构体
1600
+ * CreateFlowsByTemplates返回参数结构体
1547
1601
  */
1548
- export interface CreateSealByImageRequest {
1549
- /**
1550
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1551
- */
1552
- Agent: Agent;
1602
+ export interface CreateFlowsByTemplatesResponse {
1553
1603
  /**
1554
- * 印章名称,最大长度不超过30字符
1604
+ * 多个合同ID
1555
1605
  */
1556
- SealName: string;
1606
+ FlowIds: Array<string>;
1557
1607
  /**
1558
- * 印章图片base64
1608
+ * 渠道的业务信息,限制1024字符
1559
1609
  */
1560
- SealImage: string;
1610
+ CustomerData: Array<string>;
1561
1611
  /**
1562
- * 操作者的信息
1563
- */
1564
- Operator?: UserInfo;
1565
- }
1566
- /**
1567
- * 一码多扫签署二维码对象
1568
- */
1569
- export interface SignQrCode {
1612
+ * 创建消息,对应多个合同ID,
1613
+ 成功为“”,创建失败则对应失败消息
1614
+ */
1615
+ ErrorMessages: Array<string>;
1570
1616
  /**
1571
- * 二维码id
1617
+ * 预览模式下返回的预览文件url数组
1572
1618
  */
1573
- QrCodeId: string;
1619
+ PreviewUrls: Array<string>;
1574
1620
  /**
1575
- * 二维码url
1576
- */
1577
- QrCodeUrl: string;
1621
+ * 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
1622
+ 如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
1623
+ */
1624
+ TaskInfos: Array<TaskInfo>;
1578
1625
  /**
1579
- * 二维码过期时间
1626
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1580
1627
  */
1581
- ExpiredTime: number;
1628
+ RequestId?: string;
1582
1629
  }
1583
1630
  /**
1584
- * 一码多扫签署二维码签署信息
1631
+ * 签署参与者信息
1585
1632
  */
1586
- export interface SignUrl {
1633
+ export interface Recipient {
1587
1634
  /**
1588
- * 小程序签署链接
1635
+ * 签署人唯一标识
1589
1636
  */
1590
- AppSignUrl: string;
1637
+ RecipientId?: string;
1591
1638
  /**
1592
- * 签署链接有效时间
1639
+ * 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
1593
1640
  */
1594
- EffectiveTime: string;
1641
+ RecipientType?: string;
1595
1642
  /**
1596
- * 移动端签署链接
1643
+ * 描述
1597
1644
  */
1598
- HttpSignUrl: string;
1599
- }
1600
- /**
1601
- * ChannelBatchCancelFlows返回参数结构体
1602
- */
1603
- export interface ChannelBatchCancelFlowsResponse {
1645
+ Description?: string;
1604
1646
  /**
1605
- * 签署流程批量撤销失败原因,错误信息与流程Id一一对应,如果部分流程不可撤销,不会返回错误信息,只会撤销可撤销流程
1647
+ * 签署方备注信息
1606
1648
  */
1607
- FailMessages: Array<string>;
1649
+ RoleName?: string;
1608
1650
  /**
1609
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1651
+ * 是否需要校验
1610
1652
  */
1611
- RequestId?: string;
1612
- }
1613
- /**
1614
- * PrepareFlows请求参数结构体
1615
- */
1616
- export interface PrepareFlowsRequest {
1653
+ RequireValidation?: boolean;
1617
1654
  /**
1618
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1655
+ * 是否必须填写
1619
1656
  */
1620
- Agent: Agent;
1657
+ RequireSign?: boolean;
1621
1658
  /**
1622
- * 多个合同(签署流程)信息,最大支持20个签署流程。
1659
+ * 签署类型
1623
1660
  */
1624
- FlowInfos: Array<FlowInfo>;
1661
+ SignType?: number;
1625
1662
  /**
1626
- * 操作完成后的跳转地址,最大长度200
1663
+ * 签署顺序:数字越小优先级越高
1627
1664
  */
1628
- JumpUrl: string;
1665
+ RoutingOrder?: number;
1629
1666
  /**
1630
- * 操作者的信息
1667
+ * 是否是发起方
1631
1668
  */
1632
- Operator?: UserInfo;
1669
+ IsPromoter?: boolean;
1633
1670
  }
1634
1671
  /**
1635
- * 用量明细
1672
+ * SyncProxyOrganizationOperators返回参数结构体
1636
1673
  */
1637
- export interface UsageDetail {
1638
- /**
1639
- * 渠道侧合作企业唯一标识
1640
- */
1641
- ProxyOrganizationOpenId: string;
1642
- /**
1643
- * 渠道侧合作企业名
1644
- 注意:此字段可能返回 null,表示取不到有效值。
1645
- */
1646
- ProxyOrganizationName: string;
1674
+ export interface SyncProxyOrganizationOperatorsResponse {
1647
1675
  /**
1648
- * 日期,当需要汇总数据时日期为空
1676
+ * Status 同步状态,全部同步失败接口会直接报错
1677
+ 1-成功
1678
+ 2-部分成功
1649
1679
  注意:此字段可能返回 null,表示取不到有效值。
1650
1680
  */
1651
- Date: string;
1652
- /**
1653
- * 消耗数量
1654
- */
1655
- Usage: number;
1681
+ Status: number;
1656
1682
  /**
1657
- * 撤回数量
1683
+ * 同步失败经办人及其失败原因
1658
1684
  注意:此字段可能返回 null,表示取不到有效值。
1659
1685
  */
1660
- Cancel: number;
1661
- }
1662
- /**
1663
- * ChannelCreateBatchCancelFlowUrl返回参数结构体
1664
- */
1665
- export interface ChannelCreateBatchCancelFlowUrlResponse {
1666
- /**
1667
- * 批量撤销url
1668
- */
1669
- BatchCancelFlowUrl: string;
1670
- /**
1671
- * 签署流程批量撤销失败原因
1672
- */
1673
- FailMessages: Array<string>;
1674
- /**
1675
- * 签署撤销url过期时间-年月日-时分秒
1676
- */
1677
- UrlExpireOn: string;
1686
+ FailedList: Array<SyncFailReason>;
1678
1687
  /**
1679
1688
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1680
1689
  */
1681
1690
  RequestId?: string;
1682
1691
  }
1683
1692
  /**
1684
- * ChannelCancelFlow返回参数结构体
1693
+ * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
1685
1694
  */
1686
- export interface ChannelCancelFlowResponse {
1695
+ export interface FlowDetailInfo {
1687
1696
  /**
1688
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1697
+ * 合同(流程)的Id
1689
1698
  */
1690
- RequestId?: string;
1691
- }
1692
- /**
1693
- * 签署流程下载信息
1694
- */
1695
- export interface DownloadFlowInfo {
1699
+ FlowId: string;
1696
1700
  /**
1697
- * 文件夹名称
1701
+ * 合同(流程)的名字
1698
1702
  */
1699
- FileName: string;
1703
+ FlowName: string;
1700
1704
  /**
1701
- * 签署流程的标识数组
1705
+ * 合同(流程)的类型
1702
1706
  */
1703
- FlowIdList: Array<string>;
1704
- }
1705
- /**
1706
- * ChannelCancelMultiFlowSignQRCode请求参数结构体
1707
- */
1708
- export interface ChannelCancelMultiFlowSignQRCodeRequest {
1707
+ FlowType: string;
1709
1708
  /**
1710
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1709
+ * 合同(流程)的状态
1711
1710
  */
1712
- Agent: Agent;
1711
+ FlowStatus: string;
1713
1712
  /**
1714
- * 二维码id
1713
+ * 合同(流程)的信息
1715
1714
  */
1716
- QrCodeId: string;
1715
+ FlowMessage: string;
1717
1716
  /**
1718
- * 用户信息
1717
+ * 合同(流程)的创建时间戳
1719
1718
  */
1720
- Operator?: UserInfo;
1721
- }
1722
- /**
1723
- * PrepareFlows返回参数结构体
1724
- */
1725
- export interface PrepareFlowsResponse {
1719
+ CreateOn: number;
1726
1720
  /**
1727
- * 待发起文件确认页
1721
+ * 合同(流程)的签署截止时间戳
1728
1722
  */
1729
- ConfirmUrl: string;
1723
+ DeadLine: number;
1730
1724
  /**
1731
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1725
+ * 用户自定义数据
1732
1726
  */
1733
- RequestId?: string;
1727
+ CustomData: string;
1728
+ /**
1729
+ * 合同(流程)的签署人数组
1730
+ */
1731
+ FlowApproverInfos: Array<FlowApproverDetail>;
1734
1732
  }
1735
1733
  /**
1736
- * ChannelDescribeEmployees返回参数结构体
1734
+ * 流程对应资源链接信息
1737
1735
  */
1738
- export interface ChannelDescribeEmployeesResponse {
1736
+ export interface FlowResourceUrlInfo {
1739
1737
  /**
1740
- * 员工数据列表
1738
+ * 流程对应Id
1741
1739
  注意:此字段可能返回 null,表示取不到有效值。
1742
1740
  */
1743
- Employees: Array<Staff>;
1741
+ FlowId: string;
1744
1742
  /**
1745
- * 偏移量,默认为0,最大为20000
1743
+ * 流程对应资源链接信息数组
1746
1744
  注意:此字段可能返回 null,表示取不到有效值。
1747
1745
  */
1748
- Offset: number;
1749
- /**
1750
- * 返回最大数量,最大为20
1751
- */
1752
- Limit: number;
1746
+ ResourceUrlInfos: Array<ResourceUrlInfo>;
1747
+ }
1748
+ /**
1749
+ * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
1750
+ */
1751
+ export interface UploadFile {
1753
1752
  /**
1754
- * 符合条件的员工数量
1753
+ * Base64编码后的文件内容
1755
1754
  */
1756
- TotalCount: number;
1755
+ FileBody: string;
1757
1756
  /**
1758
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1757
+ * 文件名
1759
1758
  */
1760
- RequestId?: string;
1759
+ FileName?: string;
1761
1760
  }
1762
1761
  /**
1763
- * 复杂文档合成任务的任务信息
1762
+ * 此结构体 (Filter) 用于描述查询过滤条件。
1764
1763
  */
1765
- export interface TaskInfo {
1764
+ export interface Filter {
1766
1765
  /**
1767
- * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
1768
- 注意:此字段可能返回 null,表示取不到有效值。
1769
- */
1770
- TaskId: string;
1766
+ * 查询过滤条件的Key
1767
+ */
1768
+ Key: string;
1771
1769
  /**
1772
- * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
1773
- 注意:此字段可能返回 null,表示取不到有效值。
1774
- */
1775
- TaskStatus: string;
1770
+ * 查询过滤条件的Value列表
1771
+ */
1772
+ Values: Array<string>;
1776
1773
  }
1777
1774
  /**
1778
- * DescribeUsage请求参数结构体
1775
+ * CreateSignUrls返回参数结构体
1779
1776
  */
1780
- export interface DescribeUsageRequest {
1777
+ export interface CreateSignUrlsResponse {
1781
1778
  /**
1782
- * 应用信息
1779
+ * 签署参与者签署H5链接信息数组
1783
1780
  */
1784
- Agent: Agent;
1781
+ SignUrlInfos: Array<SignUrlInfo>;
1785
1782
  /**
1786
- * 开始时间,例如:2021-03-21
1783
+ * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
1787
1784
  */
1788
- StartDate: string;
1785
+ ErrorMessages: Array<string>;
1789
1786
  /**
1790
- * 结束时间,例如:2021-06-21;
1791
- 开始时间到结束时间的区间长度小于等于90天。
1792
- */
1793
- EndDate: string;
1787
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1788
+ */
1789
+ RequestId?: string;
1790
+ }
1791
+ /**
1792
+ * UploadFiles返回参数结构体
1793
+ */
1794
+ export interface UploadFilesResponse {
1794
1795
  /**
1795
- * 是否汇总数据,默认不汇总。
1796
- 不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
1797
- 汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
1798
- */
1799
- NeedAggregate?: boolean;
1796
+ * 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
1797
+ */
1798
+ FileIds: Array<string>;
1800
1799
  /**
1801
- * 单次返回的最多条目数量。默认为1000,且不能超过1000。
1800
+ * 上传成功文件数量
1802
1801
  */
1803
- Limit?: number;
1802
+ TotalCount: number;
1804
1803
  /**
1805
- * 偏移量,默认是0。
1804
+ * 文件Url
1806
1805
  */
1807
- Offset?: number;
1806
+ FileUrls: Array<string>;
1808
1807
  /**
1809
- * 操作者的信息
1808
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1810
1809
  */
1811
- Operator?: UserInfo;
1810
+ RequestId?: string;
1812
1811
  }
1813
1812
  /**
1814
1813
  * ChannelCreateBatchCancelFlowUrl请求参数结构体
@@ -1849,147 +1848,271 @@ export interface ApproverRestriction {
1849
1848
  IdCardNumber?: string;
1850
1849
  }
1851
1850
  /**
1852
- * ChannelCreateFlowByFiles请求参数结构体
1851
+ * 合作企业经办人列表信息
1853
1852
  */
1854
- export interface ChannelCreateFlowByFilesRequest {
1855
- /**
1856
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1857
- */
1858
- Agent?: Agent;
1853
+ export interface ProxyOrganizationOperator {
1859
1854
  /**
1860
- * 签署流程名称,长度不超过200个字符
1855
+ * 经办人ID(渠道颁发),最大长度64个字符
1861
1856
  */
1862
- FlowName?: string;
1857
+ Id: string;
1863
1858
  /**
1864
- * 签署流程签约方列表,最多不超过5个参与方
1859
+ * 经办人姓名,最大长度50个字符
1865
1860
  */
1866
- FlowApprovers?: Array<FlowApproverInfo>;
1861
+ Name?: string;
1867
1862
  /**
1868
- * 签署文件资源Id列表,目前仅支持单个文件
1869
- */
1870
- FileIds?: Array<string>;
1863
+ * 经办人身份证件类型
1864
+ 1.ID_CARD 居民身份证
1865
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
1866
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
1867
+ */
1868
+ IdCardType?: string;
1871
1869
  /**
1872
- * 签署文件中的发起方的填写控件,需要在发起的时候进行填充
1870
+ * 经办人证件号
1873
1871
  */
1874
- Components?: Array<Component>;
1872
+ IdCardNumber?: string;
1875
1873
  /**
1876
- * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
1874
+ * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
1877
1875
  */
1878
- Deadline?: number;
1876
+ Mobile?: string;
1877
+ }
1878
+ /**
1879
+ * ChannelCreateFlowByFiles返回参数结构体
1880
+ */
1881
+ export interface ChannelCreateFlowByFilesResponse {
1879
1882
  /**
1880
- * 签署流程回调地址,长度不超过255个字符
1881
- */
1882
- CallbackUrl?: string;
1883
+ * 合同签署流程ID
1884
+ 注意:此字段可能返回 null,表示取不到有效值。
1885
+ */
1886
+ FlowId: string;
1883
1887
  /**
1884
- * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
1888
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1885
1889
  */
1886
- Unordered?: boolean;
1890
+ RequestId?: string;
1891
+ }
1892
+ /**
1893
+ * ChannelCreateFlowSignReview返回参数结构体
1894
+ */
1895
+ export interface ChannelCreateFlowSignReviewResponse {
1887
1896
  /**
1888
- * 签署流程的类型,长度不超过255个字符
1897
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1889
1898
  */
1890
- FlowType?: string;
1899
+ RequestId?: string;
1900
+ }
1901
+ /**
1902
+ * ChannelDescribeOrganizationSeals返回参数结构体
1903
+ */
1904
+ export interface ChannelDescribeOrganizationSealsResponse {
1891
1905
  /**
1892
- * 签署流程的描述,长度不超过1000个字符
1906
+ * 在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多
1893
1907
  */
1894
- FlowDescription?: string;
1908
+ TotalCount: number;
1895
1909
  /**
1896
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1910
+ * 查询到的印章结果数组
1897
1911
  */
1898
- CustomShowMap?: string;
1912
+ Seals: Array<OccupiedSeal>;
1899
1913
  /**
1900
- * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1914
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1901
1915
  */
1902
- CustomerData?: string;
1916
+ RequestId?: string;
1917
+ }
1918
+ /**
1919
+ * ChannelCancelMultiFlowSignQRCode返回参数结构体
1920
+ */
1921
+ export interface ChannelCancelMultiFlowSignQRCodeResponse {
1903
1922
  /**
1904
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1923
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1905
1924
  */
1906
- NeedSignReview?: boolean;
1925
+ RequestId?: string;
1926
+ }
1927
+ /**
1928
+ * ChannelCreateFlowGroupByFiles返回参数结构体
1929
+ */
1930
+ export interface ChannelCreateFlowGroupByFilesResponse {
1907
1931
  /**
1908
- * 操作者的信息
1909
- */
1910
- Operator?: UserInfo;
1932
+ * 合同组ID
1933
+ 注意:此字段可能返回 null,表示取不到有效值。
1934
+ */
1935
+ FlowGroupId: string;
1911
1936
  /**
1912
- * 签署人校验方式
1913
- VerifyCheck: 人脸识别(默认)
1914
- MobileCheck:手机号验证
1915
- 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
1937
+ * 子合同ID列表
1938
+ 注意:此字段可能返回 null,表示取不到有效值。
1916
1939
  */
1917
- ApproverVerifyType?: string;
1940
+ FlowIds: Array<string>;
1941
+ /**
1942
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1943
+ */
1944
+ RequestId?: string;
1918
1945
  }
1919
1946
  /**
1920
- * ChannelCreateFlowByFiles返回参数结构体
1947
+ * ChannelCreateMultiFlowSignQRCode返回参数结构体
1921
1948
  */
1922
- export interface ChannelCreateFlowByFilesResponse {
1949
+ export interface ChannelCreateMultiFlowSignQRCodeResponse {
1923
1950
  /**
1924
- * 合同签署流程ID
1925
- 注意:此字段可能返回 null,表示取不到有效值。
1926
- */
1927
- FlowId: string;
1951
+ * 签署二维码对象
1952
+ */
1953
+ QrCode: SignQrCode;
1954
+ /**
1955
+ * 签署链接对象
1956
+ */
1957
+ SignUrls: SignUrl;
1928
1958
  /**
1929
1959
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1930
1960
  */
1931
1961
  RequestId?: string;
1932
1962
  }
1933
1963
  /**
1934
- * UploadFiles返回参数结构体
1964
+ * 签署人个性化能力信息
1935
1965
  */
1936
- export interface UploadFilesResponse {
1966
+ export interface ApproverOption {
1937
1967
  /**
1938
- * 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
1968
+ * 是否隐藏一键签署 false-不隐藏,默认 true-隐藏
1939
1969
  */
1940
- FileIds: Array<string>;
1970
+ HideOneKeySign?: boolean;
1971
+ }
1972
+ /**
1973
+ * ChannelGetTaskResultApi返回参数结构体
1974
+ */
1975
+ export interface ChannelGetTaskResultApiResponse {
1941
1976
  /**
1942
- * 上传成功文件数量
1977
+ * 任务Id
1943
1978
  */
1944
- TotalCount: number;
1979
+ TaskId: string;
1945
1980
  /**
1946
- * 文件Url
1981
+ * 任务状态,需要关注的状态
1982
+ 0 :NeedTranform - 任务已提交
1983
+ 4 :Processing - 文档转换中
1984
+ 8 :TaskEnd - 任务处理完成
1985
+ -2 :DownloadFailed - 下载失败
1986
+ -6 :ProcessFailed - 转换失败
1987
+ -13:ProcessTimeout - 转换文件超时
1988
+ */
1989
+ TaskStatus: number;
1990
+ /**
1991
+ * 状态描述,需要关注的状态
1992
+ NeedTranform - 任务已提交
1993
+ Processing - 文档转换中
1994
+ TaskEnd - 任务处理完成
1995
+ DownloadFailed - 下载失败
1996
+ ProcessFailed - 转换失败
1997
+ ProcessTimeout - 转换文件超时
1998
+ */
1999
+ TaskMessage: string;
2000
+ /**
2001
+ * 资源Id,也是FileId,用于文件发起使用
1947
2002
  */
1948
- FileUrls: Array<string>;
2003
+ ResourceId: string;
2004
+ /**
2005
+ * 预览文件Url,有效期30分钟
2006
+ 注意:此字段可能返回 null,表示取不到有效值。
2007
+ */
2008
+ PreviewUrl: string;
1949
2009
  /**
1950
2010
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1951
2011
  */
1952
2012
  RequestId?: string;
1953
2013
  }
1954
2014
  /**
1955
- * ChannelCreateFlowSignReview返回参数结构体
2015
+ * 此结构体 (Component) 用于描述控件属性。
2016
+
2017
+ 在通过文件发起合同时,对应的component有三种定位方式
2018
+ 1. 绝对定位方式
2019
+ 2. 表单域(FIELD)定位方式
2020
+ 3. 关键字(KEYWORD)定位方式
2021
+ 可以参考官网说明
2022
+ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
1956
2023
  */
1957
- export interface ChannelCreateFlowSignReviewResponse {
2024
+ export interface Component {
1958
2025
  /**
1959
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2026
+ * 控件编号
2027
+
2028
+ CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
2029
+
2030
+ 注:
2031
+ 当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
2032
+ 例:
2033
+ 当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
2034
+ 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
2035
+
2036
+ 创建控件时,此值为空
2037
+ 查询时返回完整结构
2038
+ */
2039
+ ComponentId?: string;
2040
+ /**
2041
+ * 如果是Component控件类型,则可选的字段为:
2042
+ TEXT - 普通文本控件;
2043
+ MULTI_LINE_TEXT - 多行文本控件;
2044
+ CHECK_BOX - 勾选框控件;
2045
+ FILL_IMAGE - 图片控件;
2046
+ DYNAMIC_TABLE - 动态表格控件;
2047
+ ATTACHMENT - 附件控件;
2048
+ SELECTOR - 选择器控件;
2049
+ DATE - 日期控件;默认是格式化为xxxx年xx月xx日
2050
+
2051
+ 如果是SignComponent控件类型,则可选的字段为
2052
+ SIGN_SEAL - 签署印章控件;
2053
+ SIGN_DATE - 签署日期控件;
2054
+ SIGN_SIGNATURE - 用户签名控件;
2055
+ SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
2056
+ SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
2057
+
2058
+ 表单域的控件不能作为印章和签名控件
2059
+ */
2060
+ ComponentType?: string;
2061
+ /**
2062
+ * 控件简称,不能超过30个字符
2063
+ */
2064
+ ComponentName?: string;
2065
+ /**
2066
+ * 定义控件是否为必填项,默认为false
1960
2067
  */
1961
- RequestId?: string;
1962
- }
1963
- /**
1964
- * 应用相关信息
1965
- */
1966
- export interface Agent {
2068
+ ComponentRequired?: boolean;
1967
2069
  /**
1968
- * 腾讯电子签颁发给渠道的应用ID,32位字符串
2070
+ * 控件关联的签署方id
1969
2071
  */
1970
- AppId: string;
2072
+ ComponentRecipientId?: string;
1971
2073
  /**
1972
- * 渠道/平台合作企业的企业ID,最大64位字符串
2074
+ * 控件所属文件的序号 (文档中文件的排列序号,从0开始)
1973
2075
  */
1974
- ProxyOrganizationOpenId?: string;
2076
+ FileIndex?: number;
1975
2077
  /**
1976
- * 渠道/平台合作企业经办人(操作员)
2078
+ * 控件生成的方式:
2079
+ NORMAL - 普通控件
2080
+ FIELD - 表单域
2081
+ KEYWORD - 关键字
2082
+ */
2083
+ GenerateMode?: string;
2084
+ /**
2085
+ * 参数控件宽度,默认100,单位px
2086
+ 表单域和关键字转换控件不用填
2087
+ */
2088
+ ComponentWidth?: number;
2089
+ /**
2090
+ * 参数控件高度,默认100,单位px
2091
+ 表单域和关键字转换控件不用填
2092
+ */
2093
+ ComponentHeight?: number;
2094
+ /**
2095
+ * 参数控件所在页码,从1开始
1977
2096
  */
1978
- ProxyOperator?: UserInfo;
2097
+ ComponentPage?: number;
1979
2098
  /**
1980
- * 腾讯电子签颁发给渠道侧合作企业的应用ID
2099
+ * 参数控件X位置,单位px
1981
2100
  */
1982
- ProxyAppId?: string;
2101
+ ComponentPosX?: number;
1983
2102
  /**
1984
- * 内部参数,腾讯电子签颁发给渠道侧合作企业的企业ID,不需要传
2103
+ * 参数控件Y位置,单位px
1985
2104
  */
1986
- ProxyOrganizationId?: string;
1987
- }
1988
- /**
1989
- * 此结构 (FormField) 用于描述内容控件填充结构。
1990
-
1991
- */
1992
- export interface FormField {
2105
+ ComponentPosY?: number;
2106
+ /**
2107
+ * 参数控件样式,json格式表述
2108
+ 不同类型的控件会有部分非通用参数
2109
+ TEXT/MULTI_LINE_TEXT控件可以指定
2110
+ 1 Font:目前只支持黑体、宋体
2111
+ 2 FontSize: 范围12-72
2112
+ 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
2113
+ 例如:{"FontSize":12}
2114
+ */
2115
+ ComponentExtra?: string;
1993
2116
  /**
1994
2117
  * 控件填充vaule,ComponentType和传入值类型对应关系:
1995
2118
  TEXT - 文本内容
@@ -1997,385 +2120,363 @@ export interface FormField {
1997
2120
  CHECK_BOX - true/false
1998
2121
  FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1999
2122
  SELECTOR - 选项值
2123
+ DATE - 默认是格式化为xxxx年xx月xx日
2000
2124
  DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
2125
+ SIGN_SEAL - 印章ID
2126
+ SIGN_PAGING_SEAL - 可以指定印章ID
2001
2127
  */
2002
- ComponentValue: string;
2003
- /**
2004
- * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
2005
- CreateFlowsByTemplates 接口不使用此字段。
2006
- 注意:此字段可能返回 null,表示取不到有效值。
2007
- */
2008
- ComponentId?: string;
2128
+ ComponentValue?: string;
2009
2129
  /**
2010
- * 控件的名字,跟ComponentId二选一,不能全为空
2011
- 注意:此字段可能返回 null,表示取不到有效值。
2130
+ * 日期签署控件的字号,默认为 12
2131
+
2132
+ 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
2012
2133
  */
2013
- ComponentName?: string;
2014
- }
2015
- /**
2016
- * 接口调用者信息
2017
- */
2018
- export interface UserInfo {
2019
- /**
2020
- * 用户在渠道的编号,最大64位字符串
2021
- */
2022
- OpenId?: string;
2134
+ ComponentDateFontSize?: number;
2023
2135
  /**
2024
- * 用户的来源渠道
2136
+ * 控件所属文档的Id, 模块相关接口为空值
2025
2137
  */
2026
- Channel?: string;
2138
+ DocumentId?: string;
2027
2139
  /**
2028
- * 自定义用户编号
2140
+ * 控件描述,不能超过30个字符
2029
2141
  */
2030
- CustomUserId?: string;
2142
+ ComponentDescription?: string;
2031
2143
  /**
2032
- * 用户真实IP
2144
+ * 指定关键字时横坐标偏移量,单位pt
2033
2145
  */
2034
- ClientIp?: string;
2146
+ OffsetX?: number;
2035
2147
  /**
2036
- * 用户代理IP
2148
+ * 指定关键字时纵坐标偏移量,单位pt
2037
2149
  */
2038
- ProxyIp?: string;
2150
+ OffsetY?: number;
2039
2151
  }
2040
2152
  /**
2041
- * ChannelCreateConvertTaskApi请求参数结构体
2153
+ * GetDownloadFlowUrl请求参数结构体
2042
2154
  */
2043
- export interface ChannelCreateConvertTaskApiRequest {
2155
+ export interface GetDownloadFlowUrlRequest {
2044
2156
  /**
2045
2157
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2046
2158
  */
2047
2159
  Agent: Agent;
2048
2160
  /**
2049
- * 资源类型 取值范围doc,docx,html,excel之一
2050
- */
2051
- ResourceType: string;
2052
- /**
2053
- * 资源名称,长度限制为256字符
2054
- */
2055
- ResourceName: string;
2056
- /**
2057
- * 资源Id,通过UploadFiles获取
2161
+ * 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
2058
2162
  */
2059
- ResourceId: string;
2163
+ DownLoadFlows?: Array<DownloadFlowInfo>;
2060
2164
  /**
2061
- * 操作者信息
2165
+ * 操作者的信息
2062
2166
  */
2063
2167
  Operator?: UserInfo;
2064
- /**
2065
- * 暂未开放
2066
- */
2067
- Organization?: OrganizationInfo;
2068
2168
  }
2069
2169
  /**
2070
- * 签署人的流程信息明细
2170
+ * ChannelBatchCancelFlows请求参数结构体
2071
2171
  */
2072
- export interface FlowApproverDetail {
2073
- /**
2074
- * 模板配置时候的签署人id,与控件绑定
2075
- */
2076
- ReceiptId: string;
2077
- /**
2078
- * 渠道侧企业的第三方id
2079
- 注意:此字段可能返回 null,表示取不到有效值。
2080
- */
2081
- ProxyOrganizationOpenId: string;
2082
- /**
2083
- * 渠道侧企业操作人的第三方id
2084
- */
2085
- ProxyOperatorOpenId: string;
2172
+ export interface ChannelBatchCancelFlowsRequest {
2086
2173
  /**
2087
- * 渠道侧企业名称
2174
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2088
2175
  */
2089
- ProxyOrganizationName: string;
2176
+ Agent: Agent;
2090
2177
  /**
2091
- * 签署人手机号
2178
+ * 签署流程Id数组,最多100个,超过100不处理
2092
2179
  */
2093
- Mobile: string;
2180
+ FlowIds: Array<string>;
2094
2181
  /**
2095
- * 签署人签署顺序
2182
+ * 撤销理由
2096
2183
  */
2097
- SignOrder: number;
2184
+ CancelMessage?: string;
2098
2185
  /**
2099
- * 签署人姓名
2100
- 注意:此字段可能返回 null,表示取不到有效值。
2186
+ * 撤销理由自定义格式;选项:
2187
+ 0 默认格式
2188
+ 1 只保留身份信息:展示为【发起方】
2189
+ 2 保留身份信息+企业名称:展示为【发起方xxx公司】
2190
+ 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
2101
2191
  */
2102
- ApproveName: string;
2192
+ CancelMessageFormat?: number;
2103
2193
  /**
2104
- * 当前签署人的状态
2105
- 注意:此字段可能返回 null,表示取不到有效值。
2106
- */
2107
- ApproveStatus: string;
2194
+ * 操作人信息
2195
+ */
2196
+ Operator?: UserInfo;
2197
+ }
2198
+ /**
2199
+ * 一码多扫签署二维码签署信息
2200
+ */
2201
+ export interface SignUrl {
2108
2202
  /**
2109
- * 签署人信息
2110
- 注意:此字段可能返回 null,表示取不到有效值。
2111
- */
2112
- ApproveMessage: string;
2203
+ * 小程序签署链接
2204
+ */
2205
+ AppSignUrl: string;
2113
2206
  /**
2114
- * 签署人签署时间
2207
+ * 签署链接有效时间
2115
2208
  */
2116
- ApproveTime: number;
2209
+ EffectiveTime: string;
2117
2210
  /**
2118
- * 参与者类型 (ORGANIZATION企业/PERSON个人)
2119
- 注意:此字段可能返回 null,表示取不到有效值。
2120
- */
2121
- ApproveType: string;
2211
+ * 移动端签署链接
2212
+ */
2213
+ HttpSignUrl: string;
2122
2214
  }
2123
2215
  /**
2124
- * 此结构体 (FlowInfo) 用于描述签署流程信息。
2125
-
2126
- 【动态表格传参说明】
2127
- 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
2128
- 输入示例
2129
-
2130
- ```
2131
- {
2132
- "headers":[
2133
- {
2134
- "content":"head1"
2135
- },
2136
- {
2137
- "content":"head2"
2138
- },
2139
- {
2140
- "content":"head3"
2141
- }
2142
- ],
2143
- "rowCount":3,
2144
- "body":{
2145
- "cells":[
2146
- {
2147
- "rowStart":1,
2148
- "rowEnd":1,
2149
- "columnStart":1,
2150
- "columnEnd":1,
2151
- "content":"123"
2152
- },
2153
- {
2154
- "rowStart":2,
2155
- "rowEnd":3,
2156
- "columnStart":1,
2157
- "columnEnd":2,
2158
- "content":"456"
2159
- },
2160
- {
2161
- "rowStart":3,
2162
- "rowEnd":3,
2163
- "columnStart":3,
2164
- "columnEnd":3,
2165
- "content":"789"
2166
- }
2167
- ]
2168
- }
2169
- }
2170
-
2171
- ```
2172
-
2173
- 表格参数说明
2174
-
2175
- | 名称 | 类型 | 描述 |
2176
- | ------------------- | ------- | ------------------------------------------------- |
2177
- | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
2178
- | rowCount | Integer | 表格内容最大行数 |
2179
- | cells.N.rowStart | Integer | 单元格坐标:行起始index |
2180
- | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
2181
- | cells.N.columnStart | Integer | 单元格坐标:列起始index |
2182
- | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
2183
- | cells.N.content | String | 单元格内容,字数不超过100 |
2184
-
2216
+ * ChannelCancelFlow请求参数结构体
2185
2217
  */
2186
- export interface FlowInfo {
2218
+ export interface ChannelCancelFlowRequest {
2187
2219
  /**
2188
- * 合同名字,最大长度200个字符
2220
+ * 签署流程编号
2189
2221
  */
2190
- FlowName: string;
2222
+ FlowId: string;
2191
2223
  /**
2192
- * 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
2224
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2193
2225
  */
2194
- Deadline: number;
2226
+ Agent?: Agent;
2195
2227
  /**
2196
- * 模板ID
2228
+ * 撤回原因,最大不超过200字符
2197
2229
  */
2198
- TemplateId?: string;
2230
+ CancelMessage?: string;
2199
2231
  /**
2200
- * 多个签署人信息,最大支持50个签署方
2232
+ * 操作者的信息
2201
2233
  */
2202
- FlowApprovers?: Array<FlowApproverInfo>;
2234
+ Operator?: UserInfo;
2203
2235
  /**
2204
- * 表单K-V对列表
2236
+ * 撤销理由自定义格式;选项:
2237
+ 0 默认格式
2238
+ 1 只保留身份信息:展示为【发起方】
2239
+ 2 保留身份信息+企业名称:展示为【发起方xxx公司】
2240
+ 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
2241
+ */
2242
+ CancelMessageFormat?: number;
2243
+ }
2244
+ /**
2245
+ * DescribeTemplates请求参数结构体
2246
+ */
2247
+ export interface DescribeTemplatesRequest {
2248
+ /**
2249
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2205
2250
  */
2206
- FormFields?: Array<FormField>;
2251
+ Agent: Agent;
2207
2252
  /**
2208
- * 回调地址,最大长度1000个字符
2253
+ * 模板唯一标识,查询单个模板时使用
2209
2254
  */
2210
- CallbackUrl?: string;
2255
+ TemplateId?: string;
2211
2256
  /**
2212
- * 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
2257
+ * 查询内容:0-模板列表及详情(默认),1-仅模板列表
2213
2258
  */
2214
- FlowType?: string;
2259
+ ContentType?: number;
2215
2260
  /**
2216
- * 合同描述,最大长度1000个字符
2261
+ * 查询个数,默认20,最大100;在查询列表的时候有效
2217
2262
  */
2218
- FlowDescription?: string;
2263
+ Limit?: number;
2219
2264
  /**
2220
- * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
2265
+ * 查询偏移位置,默认0;在查询列表的时候有效
2221
2266
  */
2222
- CustomerData?: string;
2267
+ Offset?: number;
2223
2268
  /**
2224
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
2269
+ * 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
2225
2270
  */
2226
- CustomShowMap?: string;
2271
+ QueryAllComponents?: boolean;
2227
2272
  /**
2228
- * 被抄送人的信息列表,抄送功能暂不开放
2273
+ * 模糊搜索模板名称,最大长度200
2229
2274
  */
2230
- CcInfos?: Array<CcInfo>;
2275
+ TemplateName?: string;
2231
2276
  /**
2232
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。
2233
- 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
2234
-
2235
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2236
- */
2237
- NeedSignReview?: boolean;
2277
+ * 操作者的信息
2278
+ */
2279
+ Operator?: UserInfo;
2238
2280
  }
2239
2281
  /**
2240
- * ChannelCreateFlowGroupByFiles请求参数结构体
2282
+ * 持有的电子印章信息
2241
2283
  */
2242
- export interface ChannelCreateFlowGroupByFilesRequest {
2284
+ export interface OccupiedSeal {
2243
2285
  /**
2244
- * 每个子合同的发起所需的信息,数量限制2-100
2286
+ * 电子印章编号
2245
2287
  */
2246
- FlowFileInfos: Array<FlowFileInfo>;
2288
+ SealId: string;
2247
2289
  /**
2248
- * 合同组名称,长度不超过200个字符
2290
+ * 电子印章名称
2249
2291
  */
2250
- FlowGroupName: string;
2292
+ SealName: string;
2251
2293
  /**
2252
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2294
+ * 电子印章授权时间戳
2253
2295
  */
2254
- Agent?: Agent;
2296
+ CreateOn: number;
2255
2297
  /**
2256
- * 操作者的信息
2298
+ * 电子印章授权人
2257
2299
  */
2258
- Operator?: UserInfo;
2259
- }
2260
- /**
2261
- * UploadFiles请求参数结构体
2262
- */
2263
- export interface UploadFilesRequest {
2300
+ Creator: string;
2264
2301
  /**
2265
- * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
2302
+ * 电子印章策略Id
2266
2303
  */
2267
- Agent: Agent;
2304
+ SealPolicyId: string;
2268
2305
  /**
2269
- * 文件对应业务类型
2270
- 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
2271
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
2306
+ * 印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)
2307
+ */
2308
+ SealStatus: string;
2309
+ /**
2310
+ * 审核失败原因
2311
+ 注意:此字段可能返回 null,表示取不到有效值。
2272
2312
  */
2273
- BusinessType: string;
2313
+ FailReason: string;
2274
2314
  /**
2275
- * 上传文件内容数组,最多支持20个文件
2315
+ * 印章图片url,5分钟内有效
2276
2316
  */
2277
- FileInfos?: Array<UploadFile>;
2317
+ Url: string;
2278
2318
  /**
2279
- * 操作者的信息
2319
+ * 印章类型
2280
2320
  */
2281
- Operator?: UserInfo;
2321
+ SealType: string;
2322
+ /**
2323
+ * 用印申请是否为永久授权
2324
+ */
2325
+ IsAllTime: boolean;
2326
+ /**
2327
+ * 授权人列表
2328
+ */
2329
+ AuthorizedUsers: Array<AuthorizedUser>;
2282
2330
  }
2283
2331
  /**
2284
- * 企业员工信息
2332
+ * CreateFlowsByTemplates请求参数结构体
2285
2333
  */
2286
- export interface Staff {
2334
+ export interface CreateFlowsByTemplatesRequest {
2287
2335
  /**
2288
- * 员工在电子签平台的id
2336
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2289
2337
  */
2290
- UserId: string;
2338
+ Agent: Agent;
2291
2339
  /**
2292
- * 显示的员工名
2340
+ * 多个合同(签署流程)信息,最多支持20个
2293
2341
  */
2294
- DisplayName: string;
2342
+ FlowInfos: Array<FlowInfo>;
2295
2343
  /**
2296
- * 员工手机号
2344
+ * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls(此Url返回的是PDF文件流 );
2345
+ 预览链接有效期300秒;
2346
+ 同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
2347
+ */
2348
+ NeedPreview?: boolean;
2349
+ /**
2350
+ * 操作者的信息
2297
2351
  */
2298
- Mobile: string;
2352
+ Operator?: UserInfo;
2353
+ }
2354
+ /**
2355
+ * 用量明细
2356
+ */
2357
+ export interface UsageDetail {
2299
2358
  /**
2300
- * 员工邮箱
2301
- 注意:此字段可能返回 null,表示取不到有效值。
2302
- */
2303
- Email: string;
2359
+ * 渠道侧合作企业唯一标识
2360
+ */
2361
+ ProxyOrganizationOpenId: string;
2304
2362
  /**
2305
- * 员工在第三方平台id
2363
+ * 渠道侧合作企业名
2306
2364
  注意:此字段可能返回 null,表示取不到有效值。
2307
2365
  */
2308
- OpenId: string;
2366
+ ProxyOrganizationName: string;
2309
2367
  /**
2310
- * 员工角色
2368
+ * 日期,当需要汇总数据时日期为空
2311
2369
  注意:此字段可能返回 null,表示取不到有效值。
2312
2370
  */
2313
- Roles: Array<StaffRole>;
2371
+ Date: string;
2314
2372
  /**
2315
- * 员工部门
2373
+ * 消耗数量
2374
+ */
2375
+ Usage: number;
2376
+ /**
2377
+ * 撤回数量
2316
2378
  注意:此字段可能返回 null,表示取不到有效值。
2317
2379
  */
2318
- Department: Department;
2380
+ Cancel: number;
2381
+ }
2382
+ /**
2383
+ * ChannelCreateBatchCancelFlowUrl返回参数结构体
2384
+ */
2385
+ export interface ChannelCreateBatchCancelFlowUrlResponse {
2319
2386
  /**
2320
- * 员工是否实名
2387
+ * 批量撤销url
2321
2388
  */
2322
- Verified: boolean;
2389
+ BatchCancelFlowUrl: string;
2323
2390
  /**
2324
- * 员工创建时间戳
2391
+ * 签署流程批量撤销失败原因
2325
2392
  */
2326
- CreatedOn: number;
2393
+ FailMessages: Array<string>;
2327
2394
  /**
2328
- * 员工实名时间戳
2395
+ * 签署撤销url过期时间-年月日-时分秒
2329
2396
  */
2330
- VerifiedOn: number;
2331
- }
2332
- /**
2333
- * 抄送信息
2334
- */
2335
- export interface CcInfo {
2397
+ UrlExpireOn: string;
2336
2398
  /**
2337
- * 被抄送人手机号,大陆11位手机号
2399
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2338
2400
  */
2339
- Mobile?: string;
2401
+ RequestId?: string;
2340
2402
  }
2341
2403
  /**
2342
- * ChannelCancelMultiFlowSignQRCode返回参数结构体
2404
+ * OperateChannelTemplate请求参数结构体
2343
2405
  */
2344
- export interface ChannelCancelMultiFlowSignQRCodeResponse {
2406
+ export interface OperateChannelTemplateRequest {
2345
2407
  /**
2346
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2408
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2347
2409
  */
2348
- RequestId?: string;
2410
+ Agent: Agent;
2411
+ /**
2412
+ * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
2413
+ */
2414
+ OperateType: string;
2415
+ /**
2416
+ * 渠道方模板库模板唯一标识
2417
+ */
2418
+ TemplateId: string;
2419
+ /**
2420
+ * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
2421
+ */
2422
+ ProxyOrganizationOpenIds?: string;
2423
+ /**
2424
+ * 模板可见性, 全部可见-"all", 部分可见-"part"
2425
+ */
2426
+ AuthTag?: string;
2427
+ /**
2428
+ * 操作者的信息
2429
+ */
2430
+ Operator?: UserInfo;
2349
2431
  }
2350
2432
  /**
2351
- * DescribeFlowDetailInfo返回参数结构体
2433
+ * 同步经办人失败原因
2352
2434
  */
2353
- export interface DescribeFlowDetailInfoResponse {
2354
- /**
2355
- * 渠道侧应用号Id
2356
- */
2357
- ApplicationId: string;
2435
+ export interface SyncFailReason {
2358
2436
  /**
2359
- * 渠道侧企业第三方Id
2437
+ * 经办人Id
2360
2438
  */
2361
- ProxyOrganizationOpenId: string;
2439
+ Id: string;
2362
2440
  /**
2363
- * 合同(签署流程)的具体详细描述信息
2441
+ * 失败原因
2442
+ 例如:Id不符合规范、证件号码不合法等
2364
2443
  注意:此字段可能返回 null,表示取不到有效值。
2365
2444
  */
2366
- FlowInfo: Array<FlowDetailInfo>;
2445
+ Message: string;
2446
+ }
2447
+ /**
2448
+ * ChannelDescribeEmployees返回参数结构体
2449
+ */
2450
+ export interface ChannelDescribeEmployeesResponse {
2367
2451
  /**
2368
- * 合同组编号
2452
+ * 员工数据列表
2369
2453
  注意:此字段可能返回 null,表示取不到有效值。
2370
2454
  */
2371
- FlowGroupId: string;
2455
+ Employees: Array<Staff>;
2372
2456
  /**
2373
- * 合同组名称
2457
+ * 偏移量,默认为0,最大为20000
2374
2458
  注意:此字段可能返回 null,表示取不到有效值。
2375
2459
  */
2376
- FlowGroupName: string;
2460
+ Offset: number;
2461
+ /**
2462
+ * 返回最大数量,最大为20
2463
+ */
2464
+ Limit: number;
2465
+ /**
2466
+ * 符合条件的员工数量
2467
+ */
2468
+ TotalCount: number;
2377
2469
  /**
2378
2470
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2379
2471
  */
2380
2472
  RequestId?: string;
2381
2473
  }
2474
+ /**
2475
+ * 抄送信息
2476
+ */
2477
+ export interface CcInfo {
2478
+ /**
2479
+ * 被抄送人手机号,大陆11位手机号
2480
+ */
2481
+ Mobile?: string;
2482
+ }