tencentcloud-sdk-nodejs-essbasic 4.0.617 → 4.0.619
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +556 -0
- package/SERVICE_CHANGELOG.md +677 -22
- package/package.json +1 -1
- package/products.md +33 -33
- package/src/services/essbasic/v20201222/essbasic_models.ts +164 -602
- package/src/services/essbasic/v20210526/essbasic_client.ts +3 -3
- package/src/services/essbasic/v20210526/essbasic_models.ts +370 -826
- package/tencentcloud/services/essbasic/v20201222/essbasic_models.d.ts +164 -164
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +3 -3
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +3 -3
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +370 -305
|
@@ -46,16 +46,18 @@ export interface ChannelDeleteSealPoliciesRequest {
|
|
|
46
46
|
*/
|
|
47
47
|
SealId: string;
|
|
48
48
|
/**
|
|
49
|
-
|
|
49
|
+
* 指定用户ID数组,电子签系统用户ID
|
|
50
50
|
可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权取消。
|
|
51
|
-
|
|
51
|
+
*/
|
|
52
52
|
UserIds: Array<string>;
|
|
53
53
|
/**
|
|
54
54
|
* 组织机构信息,不用传
|
|
55
|
+
* @deprecated
|
|
55
56
|
*/
|
|
56
57
|
Organization?: OrganizationInfo;
|
|
57
58
|
/**
|
|
58
59
|
* 操作人(用户)信息,不用传
|
|
60
|
+
* @deprecated
|
|
59
61
|
*/
|
|
60
62
|
Operator?: UserInfo;
|
|
61
63
|
}
|
|
@@ -77,14 +79,14 @@ export interface ChannelBatchCancelFlowsResponse {
|
|
|
77
79
|
*/
|
|
78
80
|
export interface Department {
|
|
79
81
|
/**
|
|
80
|
-
|
|
82
|
+
* 部门id
|
|
81
83
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
82
|
-
|
|
84
|
+
*/
|
|
83
85
|
DepartmentId: string;
|
|
84
86
|
/**
|
|
85
|
-
|
|
87
|
+
* 部门名称
|
|
86
88
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
87
|
-
|
|
89
|
+
*/
|
|
88
90
|
DepartmentName: string;
|
|
89
91
|
}
|
|
90
92
|
/**
|
|
@@ -109,27 +111,27 @@ export interface ChannelCreateFlowSignReviewRequest {
|
|
|
109
111
|
*/
|
|
110
112
|
FlowId: string;
|
|
111
113
|
/**
|
|
112
|
-
|
|
114
|
+
* 企业内部审核结果
|
|
113
115
|
PASS: 通过
|
|
114
116
|
REJECT: 拒绝
|
|
115
117
|
SIGN_REJECT:拒签(流程结束)
|
|
116
|
-
|
|
118
|
+
*/
|
|
117
119
|
ReviewType: string;
|
|
118
120
|
/**
|
|
119
|
-
|
|
121
|
+
* 审核原因
|
|
120
122
|
当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
|
|
121
|
-
|
|
123
|
+
*/
|
|
122
124
|
ReviewMessage?: string;
|
|
123
125
|
/**
|
|
124
126
|
* 签署节点审核时需要指定
|
|
125
127
|
*/
|
|
126
128
|
RecipientId?: string;
|
|
127
129
|
/**
|
|
128
|
-
|
|
130
|
+
* 操作类型,默认:SignReview;SignReview:签署审核,CreateReview:发起审核
|
|
129
131
|
注:接口通过该字段区分操作类型
|
|
130
132
|
该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
|
|
131
133
|
若想使用发起审核,请指定该字段为:CreateReview
|
|
132
|
-
|
|
134
|
+
*/
|
|
133
135
|
OperateType?: string;
|
|
134
136
|
}
|
|
135
137
|
/**
|
|
@@ -154,9 +156,9 @@ export interface DescribeFlowDetailInfoRequest {
|
|
|
154
156
|
*/
|
|
155
157
|
Agent: Agent;
|
|
156
158
|
/**
|
|
157
|
-
|
|
159
|
+
* 合同(流程)编号数组,最多支持100个。
|
|
158
160
|
(备注:该参数和合同组编号必须二选一)
|
|
159
|
-
|
|
161
|
+
*/
|
|
160
162
|
FlowIds?: Array<string>;
|
|
161
163
|
/**
|
|
162
164
|
* 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
|
|
@@ -164,6 +166,7 @@ export interface DescribeFlowDetailInfoRequest {
|
|
|
164
166
|
FlowGroupId?: string;
|
|
165
167
|
/**
|
|
166
168
|
* 暂未开放
|
|
169
|
+
* @deprecated
|
|
167
170
|
*/
|
|
168
171
|
Operator?: UserInfo;
|
|
169
172
|
}
|
|
@@ -172,25 +175,25 @@ export interface DescribeFlowDetailInfoRequest {
|
|
|
172
175
|
*/
|
|
173
176
|
export interface ModifyExtendedServiceRequest {
|
|
174
177
|
/**
|
|
175
|
-
|
|
178
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
176
179
|
|
|
177
180
|
注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
|
|
178
|
-
|
|
181
|
+
*/
|
|
179
182
|
Agent: Agent;
|
|
180
183
|
/**
|
|
181
|
-
|
|
184
|
+
* 扩展服务类型
|
|
182
185
|
AUTO_SIGN 企业静默签(自动签署)
|
|
183
186
|
OVERSEA_SIGN 企业与港澳台居民*签署合同
|
|
184
187
|
MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
|
|
185
188
|
PAGING_SEAL 骑缝章
|
|
186
189
|
DOWNLOAD_FLOW 授权渠道下载合同
|
|
187
|
-
|
|
190
|
+
*/
|
|
188
191
|
ServiceType: string;
|
|
189
192
|
/**
|
|
190
|
-
|
|
193
|
+
* 操作类型
|
|
191
194
|
OPEN:开通
|
|
192
195
|
CLOSE:关闭
|
|
193
|
-
|
|
196
|
+
*/
|
|
194
197
|
Operate: string;
|
|
195
198
|
}
|
|
196
199
|
/**
|
|
@@ -198,9 +201,9 @@ export interface ModifyExtendedServiceRequest {
|
|
|
198
201
|
*/
|
|
199
202
|
export interface DescribeResourceUrlsByFlowsRequest {
|
|
200
203
|
/**
|
|
201
|
-
|
|
204
|
+
* 应用相关信息。
|
|
202
205
|
此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
203
|
-
|
|
206
|
+
*/
|
|
204
207
|
Agent: Agent;
|
|
205
208
|
/**
|
|
206
209
|
* 查询资源所对应的签署流程Id,最多支持50个
|
|
@@ -208,6 +211,7 @@ export interface DescribeResourceUrlsByFlowsRequest {
|
|
|
208
211
|
FlowIds?: Array<string>;
|
|
209
212
|
/**
|
|
210
213
|
* 操作者的信息,不用传
|
|
214
|
+
* @deprecated
|
|
211
215
|
*/
|
|
212
216
|
Operator?: UserInfo;
|
|
213
217
|
}
|
|
@@ -259,34 +263,34 @@ export interface CreateSealByImageResponse {
|
|
|
259
263
|
*/
|
|
260
264
|
export interface OperateChannelTemplateResponse {
|
|
261
265
|
/**
|
|
262
|
-
|
|
266
|
+
* 腾讯电子签颁发给第三方应用平台的应用ID
|
|
263
267
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
264
|
-
|
|
268
|
+
*/
|
|
265
269
|
AppId?: string;
|
|
266
270
|
/**
|
|
267
|
-
|
|
271
|
+
* 第三方应用平台模板库模板唯一标识
|
|
268
272
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
269
|
-
|
|
273
|
+
*/
|
|
270
274
|
TemplateId?: string;
|
|
271
275
|
/**
|
|
272
|
-
|
|
276
|
+
* 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
|
|
273
277
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
274
|
-
|
|
278
|
+
*/
|
|
275
279
|
OperateResult?: string;
|
|
276
280
|
/**
|
|
277
|
-
|
|
281
|
+
* 模板可见性, 全部可见-"all", 部分可见-"part"
|
|
278
282
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
279
|
-
|
|
283
|
+
*/
|
|
280
284
|
AuthTag?: string;
|
|
281
285
|
/**
|
|
282
|
-
|
|
286
|
+
* 合作企业方第三方机构唯一标识数据
|
|
283
287
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
284
|
-
|
|
288
|
+
*/
|
|
285
289
|
ProxyOrganizationOpenIds?: Array<string>;
|
|
286
290
|
/**
|
|
287
|
-
|
|
291
|
+
* 操作失败信息数组
|
|
288
292
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
289
|
-
|
|
293
|
+
*/
|
|
290
294
|
FailMessageList?: Array<AuthFailMessage>;
|
|
291
295
|
/**
|
|
292
296
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -405,13 +409,13 @@ export interface BaseFlowInfo {
|
|
|
405
409
|
*/
|
|
406
410
|
export interface CreateConsoleLoginUrlResponse {
|
|
407
411
|
/**
|
|
408
|
-
|
|
412
|
+
* 子客企业Web控制台url注意事项:
|
|
409
413
|
1. 所有类型的链接在企业未认证/员工未认证完成时,只要在有效期内(一年)都可以访问
|
|
410
414
|
2. 若企业认证完成且员工认证完成后,重新获取pc端的链接5分钟之内有效,且只能访问一次
|
|
411
415
|
3. 若企业认证完成且员工认证完成后,重新获取H5/APP的链接只要在有效期内(一年)都可以访问
|
|
412
416
|
4. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接)
|
|
413
417
|
5. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
|
|
414
|
-
|
|
418
|
+
*/
|
|
415
419
|
ConsoleUrl?: string;
|
|
416
420
|
/**
|
|
417
421
|
* 子客企业是否已开通腾讯电子签,true-是,false-否
|
|
@@ -439,13 +443,18 @@ export interface ChannelDeleteRoleUsersRequest {
|
|
|
439
443
|
*/
|
|
440
444
|
RoleId: string;
|
|
441
445
|
/**
|
|
442
|
-
*
|
|
446
|
+
* 电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数
|
|
443
447
|
*/
|
|
444
|
-
UserIds
|
|
448
|
+
UserIds?: Array<string>;
|
|
445
449
|
/**
|
|
446
450
|
* 操作人信息
|
|
451
|
+
* @deprecated
|
|
447
452
|
*/
|
|
448
453
|
Operator?: UserInfo;
|
|
454
|
+
/**
|
|
455
|
+
* 客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数
|
|
456
|
+
*/
|
|
457
|
+
OpenIds?: Array<string>;
|
|
449
458
|
}
|
|
450
459
|
/**
|
|
451
460
|
* ChannelCreateUserRoles返回参数结构体
|
|
@@ -465,9 +474,9 @@ export interface ChannelCreateUserRolesResponse {
|
|
|
465
474
|
*/
|
|
466
475
|
export interface SyncProxyOrganizationRequest {
|
|
467
476
|
/**
|
|
468
|
-
|
|
477
|
+
* 应用信息
|
|
469
478
|
此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
|
|
470
|
-
|
|
479
|
+
*/
|
|
471
480
|
Agent: Agent;
|
|
472
481
|
/**
|
|
473
482
|
* 第三方平台子客企业名称,最大长度64个字符
|
|
@@ -487,6 +496,7 @@ export interface SyncProxyOrganizationRequest {
|
|
|
487
496
|
ProxyLegalName?: string;
|
|
488
497
|
/**
|
|
489
498
|
* 暂未开放
|
|
499
|
+
* @deprecated
|
|
490
500
|
*/
|
|
491
501
|
Operator?: UserInfo;
|
|
492
502
|
}
|
|
@@ -528,10 +538,12 @@ export interface ChannelCreatePrepareFlowRequest {
|
|
|
528
538
|
NeedPreview?: boolean;
|
|
529
539
|
/**
|
|
530
540
|
* 企业机构信息,不用传
|
|
541
|
+
* @deprecated
|
|
531
542
|
*/
|
|
532
543
|
Organization?: OrganizationInfo;
|
|
533
544
|
/**
|
|
534
545
|
* 操作人(用户)信息,不用传
|
|
546
|
+
* @deprecated
|
|
535
547
|
*/
|
|
536
548
|
Operator?: UserInfo;
|
|
537
549
|
}
|
|
@@ -553,9 +565,9 @@ export interface ChannelCreateFlowRemindsRequest {
|
|
|
553
565
|
*/
|
|
554
566
|
export interface ChannelCreateSealPolicyResponse {
|
|
555
567
|
/**
|
|
556
|
-
|
|
568
|
+
* 最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的。
|
|
557
569
|
请求参数填写OpenId时,返回授权成功的 Openid。
|
|
558
|
-
|
|
570
|
+
*/
|
|
559
571
|
UserIds?: Array<string>;
|
|
560
572
|
/**
|
|
561
573
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -605,9 +617,9 @@ export interface FlowApproverUrlInfo {
|
|
|
605
617
|
*/
|
|
606
618
|
Mobile: string;
|
|
607
619
|
/**
|
|
608
|
-
|
|
620
|
+
* 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
|
|
609
621
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
610
|
-
|
|
622
|
+
*/
|
|
611
623
|
LongUrl?: string;
|
|
612
624
|
}
|
|
613
625
|
/**
|
|
@@ -619,7 +631,7 @@ export interface ChannelCreateConvertTaskApiRequest {
|
|
|
619
631
|
*/
|
|
620
632
|
Agent: Agent;
|
|
621
633
|
/**
|
|
622
|
-
* 资源类型
|
|
634
|
+
* 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
|
|
623
635
|
*/
|
|
624
636
|
ResourceType: string;
|
|
625
637
|
/**
|
|
@@ -632,10 +644,12 @@ export interface ChannelCreateConvertTaskApiRequest {
|
|
|
632
644
|
ResourceId: string;
|
|
633
645
|
/**
|
|
634
646
|
* 调用方用户信息,不用传
|
|
647
|
+
* @deprecated
|
|
635
648
|
*/
|
|
636
649
|
Operator?: UserInfo;
|
|
637
650
|
/**
|
|
638
651
|
* 暂未开放
|
|
652
|
+
* @deprecated
|
|
639
653
|
*/
|
|
640
654
|
Organization?: OrganizationInfo;
|
|
641
655
|
}
|
|
@@ -696,11 +710,11 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
696
710
|
*/
|
|
697
711
|
NeedSignReview?: boolean;
|
|
698
712
|
/**
|
|
699
|
-
|
|
713
|
+
* 签署人校验方式
|
|
700
714
|
VerifyCheck: 人脸识别(默认)
|
|
701
715
|
MobileCheck:手机号验证
|
|
702
716
|
参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
|
703
|
-
|
|
717
|
+
*/
|
|
704
718
|
ApproverVerifyType?: string;
|
|
705
719
|
/**
|
|
706
720
|
* 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
|
|
@@ -720,6 +734,7 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
720
734
|
AutoSignScene?: string;
|
|
721
735
|
/**
|
|
722
736
|
* 操作者的信息,不用传
|
|
737
|
+
* @deprecated
|
|
723
738
|
*/
|
|
724
739
|
Operator?: UserInfo;
|
|
725
740
|
}
|
|
@@ -728,19 +743,19 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
728
743
|
*/
|
|
729
744
|
export interface ChannelRole {
|
|
730
745
|
/**
|
|
731
|
-
|
|
746
|
+
* 角色id
|
|
732
747
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
733
|
-
|
|
748
|
+
*/
|
|
734
749
|
RoleId?: string;
|
|
735
750
|
/**
|
|
736
|
-
|
|
751
|
+
* 角色名
|
|
737
752
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
738
|
-
|
|
753
|
+
*/
|
|
739
754
|
RoleName?: string;
|
|
740
755
|
/**
|
|
741
|
-
|
|
756
|
+
* 角色状态:1-启用;2-禁用
|
|
742
757
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
743
|
-
|
|
758
|
+
*/
|
|
744
759
|
RoleStatus?: number;
|
|
745
760
|
}
|
|
746
761
|
/**
|
|
@@ -752,9 +767,9 @@ export interface FlowApproverDetail {
|
|
|
752
767
|
*/
|
|
753
768
|
ReceiptId: string;
|
|
754
769
|
/**
|
|
755
|
-
|
|
770
|
+
* 平台企业的第三方id
|
|
756
771
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
757
|
-
|
|
772
|
+
*/
|
|
758
773
|
ProxyOrganizationOpenId: string;
|
|
759
774
|
/**
|
|
760
775
|
* 平台企业操作人的第三方id
|
|
@@ -773,12 +788,12 @@ export interface FlowApproverDetail {
|
|
|
773
788
|
*/
|
|
774
789
|
SignOrder: number;
|
|
775
790
|
/**
|
|
776
|
-
|
|
791
|
+
* 签署人姓名
|
|
777
792
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
778
|
-
|
|
793
|
+
*/
|
|
779
794
|
ApproveName: string;
|
|
780
795
|
/**
|
|
781
|
-
|
|
796
|
+
* 当前签署人的状态, 状态如下
|
|
782
797
|
|
|
783
798
|
PENDING 流程等待中
|
|
784
799
|
FILLPENDING 待填写状态
|
|
@@ -794,21 +809,21 @@ export interface FlowApproverDetail {
|
|
|
794
809
|
RELIEVED 已经解除
|
|
795
810
|
|
|
796
811
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
797
|
-
|
|
812
|
+
*/
|
|
798
813
|
ApproveStatus: string;
|
|
799
814
|
/**
|
|
800
|
-
|
|
815
|
+
* 签署人信息
|
|
801
816
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
802
|
-
|
|
817
|
+
*/
|
|
803
818
|
ApproveMessage: string;
|
|
804
819
|
/**
|
|
805
820
|
* 签署人签署时间戳,单位秒
|
|
806
821
|
*/
|
|
807
822
|
ApproveTime: number;
|
|
808
823
|
/**
|
|
809
|
-
|
|
824
|
+
* 参与者类型 (ORGANIZATION企业/PERSON个人)
|
|
810
825
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
811
|
-
|
|
826
|
+
*/
|
|
812
827
|
ApproveType: string;
|
|
813
828
|
}
|
|
814
829
|
/**
|
|
@@ -820,9 +835,9 @@ export interface DescribeResourceUrlsByFlowsResponse {
|
|
|
820
835
|
*/
|
|
821
836
|
FlowResourceUrlInfos?: Array<FlowResourceUrlInfo>;
|
|
822
837
|
/**
|
|
823
|
-
|
|
838
|
+
* 创建消息,对应多个合同ID,
|
|
824
839
|
成功为“”,创建失败则对应失败消息
|
|
825
|
-
|
|
840
|
+
*/
|
|
826
841
|
ErrorMessages?: Array<string>;
|
|
827
842
|
/**
|
|
828
843
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -846,14 +861,15 @@ export interface ChannelCreateFlowGroupByFilesRequest {
|
|
|
846
861
|
*/
|
|
847
862
|
Agent?: Agent;
|
|
848
863
|
/**
|
|
849
|
-
|
|
864
|
+
* 签署人校验方式
|
|
850
865
|
VerifyCheck: 人脸识别(默认)
|
|
851
866
|
MobileCheck:手机号验证
|
|
852
867
|
参数说明:若选择后者,未实名的个人签署方查看合同时,无需进行人脸识别实名认证(但签署合同时仍然需要人脸实名),该能力仅适用于个人签署方。
|
|
853
|
-
|
|
868
|
+
*/
|
|
854
869
|
ApproverVerifyType?: string;
|
|
855
870
|
/**
|
|
856
871
|
* 操作者的信息,此参数不用传
|
|
872
|
+
* @deprecated
|
|
857
873
|
*/
|
|
858
874
|
Operator?: UserInfo;
|
|
859
875
|
}
|
|
@@ -870,19 +886,19 @@ export interface DescribeFlowDetailInfoResponse {
|
|
|
870
886
|
*/
|
|
871
887
|
ProxyOrganizationOpenId?: string;
|
|
872
888
|
/**
|
|
873
|
-
|
|
889
|
+
* 合同(签署流程)的具体详细描述信息
|
|
874
890
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
875
|
-
|
|
891
|
+
*/
|
|
876
892
|
FlowInfo?: Array<FlowDetailInfo>;
|
|
877
893
|
/**
|
|
878
|
-
|
|
894
|
+
* 合同组编号
|
|
879
895
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
880
|
-
|
|
896
|
+
*/
|
|
881
897
|
FlowGroupId?: string;
|
|
882
898
|
/**
|
|
883
|
-
|
|
899
|
+
* 合同组名称
|
|
884
900
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
885
|
-
|
|
901
|
+
*/
|
|
886
902
|
FlowGroupName?: string;
|
|
887
903
|
/**
|
|
888
904
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -894,19 +910,19 @@ export interface DescribeFlowDetailInfoResponse {
|
|
|
894
910
|
*/
|
|
895
911
|
export interface ResourceUrlInfo {
|
|
896
912
|
/**
|
|
897
|
-
|
|
913
|
+
* 资源链接地址,过期时间5分钟
|
|
898
914
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
899
|
-
|
|
915
|
+
*/
|
|
900
916
|
Url: string;
|
|
901
917
|
/**
|
|
902
|
-
|
|
918
|
+
* 资源名称
|
|
903
919
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
904
|
-
|
|
920
|
+
*/
|
|
905
921
|
Name: string;
|
|
906
922
|
/**
|
|
907
|
-
|
|
923
|
+
* 资源类型
|
|
908
924
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
909
|
-
|
|
925
|
+
*/
|
|
910
926
|
Type: string;
|
|
911
927
|
}
|
|
912
928
|
/**
|
|
@@ -926,13 +942,14 @@ export interface ChannelDescribeRolesRequest {
|
|
|
926
942
|
*/
|
|
927
943
|
Limit: string;
|
|
928
944
|
/**
|
|
929
|
-
|
|
945
|
+
* 查询的关键字段:
|
|
930
946
|
Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
|
|
931
947
|
Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
|
|
932
|
-
|
|
948
|
+
*/
|
|
933
949
|
Filters?: Array<Filter>;
|
|
934
950
|
/**
|
|
935
951
|
* 操作人信息
|
|
952
|
+
* @deprecated
|
|
936
953
|
*/
|
|
937
954
|
Operator?: UserInfo;
|
|
938
955
|
}
|
|
@@ -983,6 +1000,7 @@ export interface TemplateInfo {
|
|
|
983
1000
|
TemplateType: number;
|
|
984
1001
|
/**
|
|
985
1002
|
* 是否是发起人 ,已弃用
|
|
1003
|
+
* @deprecated
|
|
986
1004
|
*/
|
|
987
1005
|
IsPromoter?: boolean;
|
|
988
1006
|
/**
|
|
@@ -994,38 +1012,38 @@ export interface TemplateInfo {
|
|
|
994
1012
|
*/
|
|
995
1013
|
CreatedOn: number;
|
|
996
1014
|
/**
|
|
997
|
-
|
|
1015
|
+
* 模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回,有效期5分钟。
|
|
998
1016
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
999
|
-
|
|
1017
|
+
*/
|
|
1000
1018
|
PreviewUrl: string;
|
|
1001
1019
|
/**
|
|
1002
|
-
|
|
1020
|
+
* 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回(此功能开放需要联系客户经理),有效期5分钟。
|
|
1003
1021
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1004
|
-
|
|
1022
|
+
*/
|
|
1005
1023
|
PdfUrl: string;
|
|
1006
1024
|
/**
|
|
1007
1025
|
* 关联的第三方应用平台企业模板ID
|
|
1008
1026
|
*/
|
|
1009
1027
|
ChannelTemplateId: string;
|
|
1010
1028
|
/**
|
|
1011
|
-
|
|
1029
|
+
* 关联的三方应用平台平台企业模板名称
|
|
1012
1030
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1013
|
-
|
|
1031
|
+
*/
|
|
1014
1032
|
ChannelTemplateName: string;
|
|
1015
1033
|
/**
|
|
1016
|
-
|
|
1034
|
+
* 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
|
|
1017
1035
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1018
|
-
|
|
1036
|
+
*/
|
|
1019
1037
|
ChannelAutoSave: number;
|
|
1020
1038
|
/**
|
|
1021
|
-
|
|
1039
|
+
* 模板版本,全数字字符。默认为空,初始版本为yyyyMMdd001。
|
|
1022
1040
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1023
|
-
|
|
1041
|
+
*/
|
|
1024
1042
|
TemplateVersion: string;
|
|
1025
1043
|
/**
|
|
1026
|
-
|
|
1044
|
+
* 模板可用状态,取值:1启用(默认),2停用
|
|
1027
1045
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1028
|
-
|
|
1046
|
+
*/
|
|
1029
1047
|
Available?: number;
|
|
1030
1048
|
}
|
|
1031
1049
|
/**
|
|
@@ -1063,6 +1081,7 @@ export interface Agent {
|
|
|
1063
1081
|
ProxyAppId?: string;
|
|
1064
1082
|
/**
|
|
1065
1083
|
* 内部参数,暂未开放使用
|
|
1084
|
+
* @deprecated
|
|
1066
1085
|
*/
|
|
1067
1086
|
ProxyOrganizationId?: string;
|
|
1068
1087
|
}
|
|
@@ -1137,14 +1156,14 @@ export interface DescribeTemplatesResponse {
|
|
|
1137
1156
|
*/
|
|
1138
1157
|
export interface StaffRole {
|
|
1139
1158
|
/**
|
|
1140
|
-
|
|
1159
|
+
* 角色id
|
|
1141
1160
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1142
|
-
|
|
1161
|
+
*/
|
|
1143
1162
|
RoleId: string;
|
|
1144
1163
|
/**
|
|
1145
|
-
|
|
1164
|
+
* 角色名称
|
|
1146
1165
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1147
|
-
|
|
1166
|
+
*/
|
|
1148
1167
|
RoleName: string;
|
|
1149
1168
|
}
|
|
1150
1169
|
/**
|
|
@@ -1161,6 +1180,7 @@ export interface ChannelVerifyPdfRequest {
|
|
|
1161
1180
|
Agent?: Agent;
|
|
1162
1181
|
/**
|
|
1163
1182
|
* 暂未开放
|
|
1183
|
+
* @deprecated
|
|
1164
1184
|
*/
|
|
1165
1185
|
Operator?: UserInfo;
|
|
1166
1186
|
}
|
|
@@ -1178,6 +1198,7 @@ export interface CreateChannelFlowEvidenceReportRequest {
|
|
|
1178
1198
|
FlowId: string;
|
|
1179
1199
|
/**
|
|
1180
1200
|
* 暂未开放
|
|
1201
|
+
* @deprecated
|
|
1181
1202
|
*/
|
|
1182
1203
|
Operator?: UserInfo;
|
|
1183
1204
|
}
|
|
@@ -1203,9 +1224,9 @@ export interface ChannelVerifyPdfResponse {
|
|
|
1203
1224
|
*/
|
|
1204
1225
|
export interface CreateConsoleLoginUrlRequest {
|
|
1205
1226
|
/**
|
|
1206
|
-
|
|
1227
|
+
* 应用信息
|
|
1207
1228
|
此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
|
|
1208
|
-
|
|
1229
|
+
*/
|
|
1209
1230
|
Agent: Agent;
|
|
1210
1231
|
/**
|
|
1211
1232
|
* 子客企业名称,最大长度64个字符
|
|
@@ -1245,6 +1266,7 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
1245
1266
|
AuthorizationTypes?: Array<number>;
|
|
1246
1267
|
/**
|
|
1247
1268
|
* 暂未开放
|
|
1269
|
+
* @deprecated
|
|
1248
1270
|
*/
|
|
1249
1271
|
Operator?: UserInfo;
|
|
1250
1272
|
}
|
|
@@ -1266,10 +1288,12 @@ export interface OrganizationInfo {
|
|
|
1266
1288
|
Channel?: string;
|
|
1267
1289
|
/**
|
|
1268
1290
|
* 用户真实的IP
|
|
1291
|
+
* @deprecated
|
|
1269
1292
|
*/
|
|
1270
1293
|
ClientIp?: string;
|
|
1271
1294
|
/**
|
|
1272
1295
|
* 机构的代理IP
|
|
1296
|
+
* @deprecated
|
|
1273
1297
|
*/
|
|
1274
1298
|
ProxyIp?: string;
|
|
1275
1299
|
}
|
|
@@ -1278,71 +1302,72 @@ export interface OrganizationInfo {
|
|
|
1278
1302
|
*/
|
|
1279
1303
|
export interface SignUrlInfo {
|
|
1280
1304
|
/**
|
|
1281
|
-
|
|
1305
|
+
* 签署链接,过期时间为30天
|
|
1282
1306
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1283
|
-
|
|
1307
|
+
*/
|
|
1284
1308
|
SignUrl: string;
|
|
1285
1309
|
/**
|
|
1286
|
-
|
|
1310
|
+
* 合同过期时间戳,单位秒
|
|
1287
1311
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1288
|
-
|
|
1312
|
+
*/
|
|
1289
1313
|
Deadline: number;
|
|
1290
1314
|
/**
|
|
1291
|
-
|
|
1315
|
+
* 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
|
|
1292
1316
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1293
|
-
|
|
1317
|
+
*/
|
|
1294
1318
|
SignOrder: number;
|
|
1295
1319
|
/**
|
|
1296
|
-
|
|
1320
|
+
* 签署人编号
|
|
1297
1321
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1298
|
-
|
|
1322
|
+
*/
|
|
1299
1323
|
SignId: string;
|
|
1300
1324
|
/**
|
|
1301
|
-
|
|
1325
|
+
* 自定义用户编号
|
|
1302
1326
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1303
|
-
|
|
1327
|
+
* @deprecated
|
|
1328
|
+
*/
|
|
1304
1329
|
CustomUserId?: string;
|
|
1305
1330
|
/**
|
|
1306
|
-
|
|
1331
|
+
* 用户姓名
|
|
1307
1332
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1308
|
-
|
|
1333
|
+
*/
|
|
1309
1334
|
Name: string;
|
|
1310
1335
|
/**
|
|
1311
|
-
|
|
1336
|
+
* 用户手机号码
|
|
1312
1337
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1313
|
-
|
|
1338
|
+
*/
|
|
1314
1339
|
Mobile: string;
|
|
1315
1340
|
/**
|
|
1316
|
-
|
|
1341
|
+
* 签署参与者机构名字
|
|
1317
1342
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1318
|
-
|
|
1343
|
+
*/
|
|
1319
1344
|
OrganizationName: string;
|
|
1320
1345
|
/**
|
|
1321
|
-
|
|
1346
|
+
* 参与者类型:
|
|
1322
1347
|
ORGANIZATION 企业经办人
|
|
1323
1348
|
PERSON 自然人
|
|
1324
1349
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1325
|
-
|
|
1350
|
+
*/
|
|
1326
1351
|
ApproverType: string;
|
|
1327
1352
|
/**
|
|
1328
|
-
|
|
1353
|
+
* 经办人身份证号
|
|
1329
1354
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1330
|
-
|
|
1355
|
+
*/
|
|
1331
1356
|
IdCardNumber: string;
|
|
1332
1357
|
/**
|
|
1333
|
-
|
|
1358
|
+
* 签署链接对应流程Id
|
|
1334
1359
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1335
|
-
|
|
1360
|
+
*/
|
|
1336
1361
|
FlowId: string;
|
|
1337
1362
|
/**
|
|
1338
|
-
|
|
1363
|
+
* 企业经办人 用户在渠道的编号
|
|
1339
1364
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1340
|
-
|
|
1365
|
+
*/
|
|
1341
1366
|
OpenId: string;
|
|
1342
1367
|
/**
|
|
1343
|
-
|
|
1368
|
+
* 合同组签署链接对应的合同组id
|
|
1344
1369
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1345
|
-
|
|
1370
|
+
*/
|
|
1346
1371
|
FlowGroupId: string;
|
|
1347
1372
|
}
|
|
1348
1373
|
/**
|
|
@@ -1386,9 +1411,9 @@ export interface CommonFlowApprover {
|
|
|
1386
1411
|
*/
|
|
1387
1412
|
ApproverMobile?: string;
|
|
1388
1413
|
/**
|
|
1389
|
-
|
|
1414
|
+
* 签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId
|
|
1390
1415
|
注意:模板发起时该字段必填
|
|
1391
|
-
|
|
1416
|
+
*/
|
|
1392
1417
|
RecipientId?: string;
|
|
1393
1418
|
/**
|
|
1394
1419
|
* 签署前置条件:阅读时长限制,不传默认10s,最大300s,最小3s
|
|
@@ -1482,6 +1507,7 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
|
|
|
1482
1507
|
QrCodeId: string;
|
|
1483
1508
|
/**
|
|
1484
1509
|
* 暂未开放
|
|
1510
|
+
* @deprecated
|
|
1485
1511
|
*/
|
|
1486
1512
|
Operator?: UserInfo;
|
|
1487
1513
|
}
|
|
@@ -1494,10 +1520,10 @@ export interface UploadFilesRequest {
|
|
|
1494
1520
|
*/
|
|
1495
1521
|
Agent: Agent;
|
|
1496
1522
|
/**
|
|
1497
|
-
|
|
1523
|
+
* 文件对应业务类型
|
|
1498
1524
|
1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
|
|
1499
1525
|
2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
|
|
1500
|
-
|
|
1526
|
+
*/
|
|
1501
1527
|
BusinessType: string;
|
|
1502
1528
|
/**
|
|
1503
1529
|
* 上传文件内容数组,最多支持20个文件
|
|
@@ -1505,6 +1531,7 @@ export interface UploadFilesRequest {
|
|
|
1505
1531
|
FileInfos?: Array<UploadFile>;
|
|
1506
1532
|
/**
|
|
1507
1533
|
* 操作者的信息
|
|
1534
|
+
* @deprecated
|
|
1508
1535
|
*/
|
|
1509
1536
|
Operator?: UserInfo;
|
|
1510
1537
|
}
|
|
@@ -1533,14 +1560,14 @@ export interface ChannelDescribeOrganizationSealsRequest {
|
|
|
1533
1560
|
*/
|
|
1534
1561
|
SealId?: string;
|
|
1535
1562
|
/**
|
|
1536
|
-
|
|
1563
|
+
* 印章类型列表(都是组织机构印章)。
|
|
1537
1564
|
为空时查询所有类型的印章。
|
|
1538
1565
|
目前支持以下类型:
|
|
1539
1566
|
OFFICIAL:企业公章;
|
|
1540
1567
|
CONTRACT:合同专用章;
|
|
1541
1568
|
ORGANIZATION_SEAL:企业印章(图片上传创建);
|
|
1542
1569
|
LEGAL_PERSON_SEAL:法定代表人章
|
|
1543
|
-
|
|
1570
|
+
*/
|
|
1544
1571
|
SealTypes?: Array<string>;
|
|
1545
1572
|
}
|
|
1546
1573
|
/**
|
|
@@ -1556,15 +1583,15 @@ export interface DescribeUsageRequest {
|
|
|
1556
1583
|
*/
|
|
1557
1584
|
StartDate: string;
|
|
1558
1585
|
/**
|
|
1559
|
-
|
|
1586
|
+
* 结束时间,例如:2021-06-21;
|
|
1560
1587
|
开始时间到结束时间的区间长度小于等于90天。
|
|
1561
|
-
|
|
1588
|
+
*/
|
|
1562
1589
|
EndDate: string;
|
|
1563
1590
|
/**
|
|
1564
|
-
|
|
1591
|
+
* 是否汇总数据,默认不汇总。
|
|
1565
1592
|
不汇总:返回在统计区间内第三方平台下所有企业的每日明细,即每个企业N条数据,N为统计天数;
|
|
1566
1593
|
汇总:返回在统计区间内第三方平台下所有企业的汇总后数据,即每个企业一条数据;
|
|
1567
|
-
|
|
1594
|
+
*/
|
|
1568
1595
|
NeedAggregate?: boolean;
|
|
1569
1596
|
/**
|
|
1570
1597
|
* 单次返回的最多条目数量。默认为1000,且不能超过1000。
|
|
@@ -1576,6 +1603,7 @@ export interface DescribeUsageRequest {
|
|
|
1576
1603
|
Offset?: number;
|
|
1577
1604
|
/**
|
|
1578
1605
|
* 暂未开放
|
|
1606
|
+
* @deprecated
|
|
1579
1607
|
*/
|
|
1580
1608
|
Operator?: UserInfo;
|
|
1581
1609
|
}
|
|
@@ -1584,11 +1612,11 @@ export interface DescribeUsageRequest {
|
|
|
1584
1612
|
*/
|
|
1585
1613
|
export interface DescribeExtendedServiceAuthInfoRequest {
|
|
1586
1614
|
/**
|
|
1587
|
-
|
|
1615
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
|
|
1588
1616
|
|
|
1589
1617
|
注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
|
|
1590
1618
|
|
|
1591
|
-
|
|
1619
|
+
*/
|
|
1592
1620
|
Agent: Agent;
|
|
1593
1621
|
}
|
|
1594
1622
|
/**
|
|
@@ -1596,25 +1624,25 @@ export interface DescribeExtendedServiceAuthInfoRequest {
|
|
|
1596
1624
|
*/
|
|
1597
1625
|
export interface FormField {
|
|
1598
1626
|
/**
|
|
1599
|
-
|
|
1627
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
1600
1628
|
TEXT - 文本内容
|
|
1601
1629
|
MULTI_LINE_TEXT - 文本内容
|
|
1602
1630
|
CHECK_BOX - true/false
|
|
1603
1631
|
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
1604
1632
|
SELECTOR - 选项值
|
|
1605
1633
|
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo
|
|
1606
|
-
|
|
1634
|
+
*/
|
|
1607
1635
|
ComponentValue: string;
|
|
1608
1636
|
/**
|
|
1609
|
-
|
|
1637
|
+
* 表单域或控件的ID,跟ComponentName二选一,不能全为空;
|
|
1610
1638
|
CreateFlowsByTemplates 接口不使用此字段。
|
|
1611
1639
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1612
|
-
|
|
1640
|
+
*/
|
|
1613
1641
|
ComponentId?: string;
|
|
1614
1642
|
/**
|
|
1615
|
-
|
|
1643
|
+
* 控件的名字,跟ComponentId二选一,不能全为空
|
|
1616
1644
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1617
|
-
|
|
1645
|
+
*/
|
|
1618
1646
|
ComponentName?: string;
|
|
1619
1647
|
}
|
|
1620
1648
|
/**
|
|
@@ -1779,11 +1807,11 @@ export interface FlowInfo {
|
|
|
1779
1807
|
*/
|
|
1780
1808
|
CcInfos?: Array<CcInfo>;
|
|
1781
1809
|
/**
|
|
1782
|
-
|
|
1810
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。
|
|
1783
1811
|
若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
1784
1812
|
|
|
1785
1813
|
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
1786
|
-
|
|
1814
|
+
*/
|
|
1787
1815
|
NeedSignReview?: boolean;
|
|
1788
1816
|
/**
|
|
1789
1817
|
* 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
|
|
@@ -1804,18 +1832,22 @@ export interface UserInfo {
|
|
|
1804
1832
|
OpenId?: string;
|
|
1805
1833
|
/**
|
|
1806
1834
|
* 内部参数,暂未开放使用
|
|
1835
|
+
* @deprecated
|
|
1807
1836
|
*/
|
|
1808
1837
|
Channel?: string;
|
|
1809
1838
|
/**
|
|
1810
1839
|
* 内部参数,暂未开放使用
|
|
1840
|
+
* @deprecated
|
|
1811
1841
|
*/
|
|
1812
1842
|
CustomUserId?: string;
|
|
1813
1843
|
/**
|
|
1814
1844
|
* 内部参数,暂未开放使用
|
|
1845
|
+
* @deprecated
|
|
1815
1846
|
*/
|
|
1816
1847
|
ClientIp?: string;
|
|
1817
1848
|
/**
|
|
1818
1849
|
* 内部参数,暂未开放使用
|
|
1850
|
+
* @deprecated
|
|
1819
1851
|
*/
|
|
1820
1852
|
ProxyIp?: string;
|
|
1821
1853
|
}
|
|
@@ -1824,14 +1856,14 @@ export interface UserInfo {
|
|
|
1824
1856
|
*/
|
|
1825
1857
|
export interface TaskInfo {
|
|
1826
1858
|
/**
|
|
1827
|
-
|
|
1859
|
+
* 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
|
|
1828
1860
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1829
|
-
|
|
1861
|
+
*/
|
|
1830
1862
|
TaskId: string;
|
|
1831
1863
|
/**
|
|
1832
|
-
|
|
1864
|
+
* 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
|
|
1833
1865
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1834
|
-
|
|
1866
|
+
*/
|
|
1835
1867
|
TaskStatus: string;
|
|
1836
1868
|
}
|
|
1837
1869
|
/**
|
|
@@ -1843,9 +1875,9 @@ export interface DescribeUsageResponse {
|
|
|
1843
1875
|
*/
|
|
1844
1876
|
Total?: number;
|
|
1845
1877
|
/**
|
|
1846
|
-
|
|
1878
|
+
* 用量明细
|
|
1847
1879
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1848
|
-
|
|
1880
|
+
*/
|
|
1849
1881
|
Details?: Array<UsageDetail>;
|
|
1850
1882
|
/**
|
|
1851
1883
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1869,24 +1901,24 @@ export interface Staff {
|
|
|
1869
1901
|
*/
|
|
1870
1902
|
Mobile: string;
|
|
1871
1903
|
/**
|
|
1872
|
-
|
|
1904
|
+
* 员工邮箱
|
|
1873
1905
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1874
|
-
|
|
1906
|
+
*/
|
|
1875
1907
|
Email: string;
|
|
1876
1908
|
/**
|
|
1877
|
-
|
|
1909
|
+
* 员工在第三方应用平台的用户ID
|
|
1878
1910
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1879
|
-
|
|
1911
|
+
*/
|
|
1880
1912
|
OpenId: string;
|
|
1881
1913
|
/**
|
|
1882
|
-
|
|
1914
|
+
* 员工角色
|
|
1883
1915
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1884
|
-
|
|
1916
|
+
*/
|
|
1885
1917
|
Roles: Array<StaffRole>;
|
|
1886
1918
|
/**
|
|
1887
|
-
|
|
1919
|
+
* 员工部门
|
|
1888
1920
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1889
|
-
|
|
1921
|
+
*/
|
|
1890
1922
|
Department: Department;
|
|
1891
1923
|
/**
|
|
1892
1924
|
* 员工是否实名
|
|
@@ -1910,9 +1942,9 @@ export interface Staff {
|
|
|
1910
1942
|
*/
|
|
1911
1943
|
export interface ChannelCreateBoundFlowsRequest {
|
|
1912
1944
|
/**
|
|
1913
|
-
|
|
1945
|
+
* 应用信息
|
|
1914
1946
|
此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
|
|
1915
|
-
|
|
1947
|
+
*/
|
|
1916
1948
|
Agent: Agent;
|
|
1917
1949
|
/**
|
|
1918
1950
|
* 领取的合同id列表
|
|
@@ -1920,6 +1952,7 @@ export interface ChannelCreateBoundFlowsRequest {
|
|
|
1920
1952
|
FlowIds?: Array<string>;
|
|
1921
1953
|
/**
|
|
1922
1954
|
* 暂未开放
|
|
1955
|
+
* @deprecated
|
|
1923
1956
|
*/
|
|
1924
1957
|
Operator?: UserInfo;
|
|
1925
1958
|
}
|
|
@@ -1936,10 +1969,10 @@ export interface ChannelDescribeEmployeesRequest {
|
|
|
1936
1969
|
*/
|
|
1937
1970
|
Agent?: Agent;
|
|
1938
1971
|
/**
|
|
1939
|
-
|
|
1972
|
+
* 查询过滤实名用户,Key为Status,Values为["IsVerified"]
|
|
1940
1973
|
根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
|
|
1941
1974
|
查询离职员工时,Key为Status,Values为["QuiteJob"]
|
|
1942
|
-
|
|
1975
|
+
*/
|
|
1943
1976
|
Filters?: Array<Filter>;
|
|
1944
1977
|
/**
|
|
1945
1978
|
* 偏移量,默认为0,最大为20000
|
|
@@ -1947,6 +1980,7 @@ export interface ChannelDescribeEmployeesRequest {
|
|
|
1947
1980
|
Offset?: number;
|
|
1948
1981
|
/**
|
|
1949
1982
|
* 暂未开放
|
|
1983
|
+
* @deprecated
|
|
1950
1984
|
*/
|
|
1951
1985
|
Operator?: UserInfo;
|
|
1952
1986
|
}
|
|
@@ -1990,6 +2024,7 @@ export interface SyncProxyOrganizationOperatorsRequest {
|
|
|
1990
2024
|
ProxyOrganizationOperators: Array<ProxyOrganizationOperator>;
|
|
1991
2025
|
/**
|
|
1992
2026
|
* 暂未开放
|
|
2027
|
+
* @deprecated
|
|
1993
2028
|
*/
|
|
1994
2029
|
Operator?: UserInfo;
|
|
1995
2030
|
}
|
|
@@ -2014,13 +2049,13 @@ export interface CreateSignUrlsRequest {
|
|
|
2014
2049
|
*/
|
|
2015
2050
|
Endpoint?: string;
|
|
2016
2051
|
/**
|
|
2017
|
-
|
|
2052
|
+
* 签署链接生成类型,默认是 "ALL";
|
|
2018
2053
|
"ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
|
|
2019
2054
|
"CHANNEL":第三方平台子客企业企业;
|
|
2020
2055
|
"NOT_CHANNEL":非第三方平台子客企业企业;
|
|
2021
2056
|
"PERSON":个人;
|
|
2022
2057
|
"FOLLOWER":关注方,目前是合同抄送方;
|
|
2023
|
-
|
|
2058
|
+
*/
|
|
2024
2059
|
GenerateType?: string;
|
|
2025
2060
|
/**
|
|
2026
2061
|
* 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
|
|
@@ -2031,9 +2066,9 @@ export interface CreateSignUrlsRequest {
|
|
|
2031
2066
|
*/
|
|
2032
2067
|
Name?: string;
|
|
2033
2068
|
/**
|
|
2034
|
-
|
|
2069
|
+
* 参与人手机号;
|
|
2035
2070
|
GenerateType为"PERSON"或"FOLLOWER"时必填
|
|
2036
|
-
|
|
2071
|
+
*/
|
|
2037
2072
|
Mobile?: string;
|
|
2038
2073
|
/**
|
|
2039
2074
|
* 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
|
|
@@ -2053,6 +2088,7 @@ export interface CreateSignUrlsRequest {
|
|
|
2053
2088
|
JumpUrl?: string;
|
|
2054
2089
|
/**
|
|
2055
2090
|
* 暂未开放
|
|
2091
|
+
* @deprecated
|
|
2056
2092
|
*/
|
|
2057
2093
|
Operator?: UserInfo;
|
|
2058
2094
|
}
|
|
@@ -2061,9 +2097,9 @@ export interface CreateSignUrlsRequest {
|
|
|
2061
2097
|
*/
|
|
2062
2098
|
export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
2063
2099
|
/**
|
|
2064
|
-
|
|
2100
|
+
* 应用相关信息。
|
|
2065
2101
|
此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
|
|
2066
|
-
|
|
2102
|
+
*/
|
|
2067
2103
|
Agent: Agent;
|
|
2068
2104
|
/**
|
|
2069
2105
|
* 模版ID
|
|
@@ -2090,17 +2126,19 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
2090
2126
|
*/
|
|
2091
2127
|
Restrictions?: Array<ApproverRestriction>;
|
|
2092
2128
|
/**
|
|
2093
|
-
|
|
2129
|
+
* 回调地址,最大长度1000个字符
|
|
2094
2130
|
不传默认使用第三方应用号配置的回调地址
|
|
2095
2131
|
回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
|
2096
|
-
|
|
2132
|
+
*/
|
|
2097
2133
|
CallbackUrl?: string;
|
|
2098
2134
|
/**
|
|
2099
2135
|
* 限制二维码用户条件(已弃用)
|
|
2136
|
+
* @deprecated
|
|
2100
2137
|
*/
|
|
2101
2138
|
ApproverRestrictions?: ApproverRestriction;
|
|
2102
2139
|
/**
|
|
2103
2140
|
* 暂未开放
|
|
2141
|
+
* @deprecated
|
|
2104
2142
|
*/
|
|
2105
2143
|
Operator?: UserInfo;
|
|
2106
2144
|
}
|
|
@@ -2140,11 +2178,11 @@ export interface FlowApproverInfo {
|
|
|
2140
2178
|
*/
|
|
2141
2179
|
Name?: string;
|
|
2142
2180
|
/**
|
|
2143
|
-
|
|
2181
|
+
* 签署人身份证件类型
|
|
2144
2182
|
1.ID_CARD 居民身份证
|
|
2145
2183
|
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
2146
2184
|
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2147
|
-
|
|
2185
|
+
*/
|
|
2148
2186
|
IdCardType?: string;
|
|
2149
2187
|
/**
|
|
2150
2188
|
* 签署人证件号
|
|
@@ -2159,26 +2197,26 @@ export interface FlowApproverInfo {
|
|
|
2159
2197
|
*/
|
|
2160
2198
|
OrganizationName?: string;
|
|
2161
2199
|
/**
|
|
2162
|
-
|
|
2200
|
+
* 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
2163
2201
|
默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
|
|
2164
|
-
|
|
2202
|
+
*/
|
|
2165
2203
|
NotChannelOrganization?: boolean;
|
|
2166
2204
|
/**
|
|
2167
|
-
|
|
2205
|
+
* 用户侧第三方id,最大长度64个字符
|
|
2168
2206
|
当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
|
|
2169
|
-
|
|
2207
|
+
*/
|
|
2170
2208
|
OpenId?: string;
|
|
2171
2209
|
/**
|
|
2172
2210
|
* 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
2173
2211
|
*/
|
|
2174
2212
|
OrganizationOpenId?: string;
|
|
2175
2213
|
/**
|
|
2176
|
-
|
|
2214
|
+
* 签署人类型
|
|
2177
2215
|
PERSON-个人/自然人;
|
|
2178
2216
|
PERSON_AUTO_SIGN-个人自动签(定制化场景下使用);
|
|
2179
2217
|
ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
|
|
2180
2218
|
ENTERPRISESERVER-企业静默签(文件发起时的企业静默签字)。
|
|
2181
|
-
|
|
2219
|
+
*/
|
|
2182
2220
|
ApproverType?: string;
|
|
2183
2221
|
/**
|
|
2184
2222
|
* 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
|
@@ -2190,6 +2228,7 @@ export interface FlowApproverInfo {
|
|
|
2190
2228
|
Deadline?: number;
|
|
2191
2229
|
/**
|
|
2192
2230
|
* 签署完回调url,最大长度1000个字符
|
|
2231
|
+
* @deprecated
|
|
2193
2232
|
*/
|
|
2194
2233
|
CallbackUrl?: string;
|
|
2195
2234
|
/**
|
|
@@ -2197,9 +2236,9 @@ export interface FlowApproverInfo {
|
|
|
2197
2236
|
*/
|
|
2198
2237
|
SignComponents?: Array<Component>;
|
|
2199
2238
|
/**
|
|
2200
|
-
|
|
2239
|
+
* 个人签署方指定签署控件类型,目前支持:OCR_ESIGN -AI智慧手写签名
|
|
2201
2240
|
HANDWRITE -手写签名
|
|
2202
|
-
|
|
2241
|
+
*/
|
|
2203
2242
|
ComponentLimitType?: Array<string>;
|
|
2204
2243
|
/**
|
|
2205
2244
|
* 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
|
@@ -2218,20 +2257,20 @@ export interface FlowApproverInfo {
|
|
|
2218
2257
|
*/
|
|
2219
2258
|
ApproverNeedSignReview?: boolean;
|
|
2220
2259
|
/**
|
|
2221
|
-
|
|
2260
|
+
* 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
|
|
2222
2261
|
查看合同的认证方式 Flow层级的优先于approver层级的
|
|
2223
|
-
|
|
2262
|
+
*/
|
|
2224
2263
|
ApproverVerifyTypes?: Array<number>;
|
|
2225
2264
|
/**
|
|
2226
|
-
|
|
2265
|
+
* 签署人签署合同时的认证方式
|
|
2227
2266
|
1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
|
|
2228
|
-
|
|
2267
|
+
*/
|
|
2229
2268
|
ApproverSignTypes?: Array<number>;
|
|
2230
2269
|
/**
|
|
2231
|
-
|
|
2270
|
+
* 签署ID
|
|
2232
2271
|
- 发起流程时系统自动补充
|
|
2233
2272
|
- 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
|
|
2234
|
-
|
|
2273
|
+
*/
|
|
2235
2274
|
SignId?: string;
|
|
2236
2275
|
}
|
|
2237
2276
|
/**
|
|
@@ -2248,10 +2287,12 @@ export interface ChannelGetTaskResultApiRequest {
|
|
|
2248
2287
|
TaskId: string;
|
|
2249
2288
|
/**
|
|
2250
2289
|
* 操作者的信息,不用传
|
|
2290
|
+
* @deprecated
|
|
2251
2291
|
*/
|
|
2252
2292
|
Operator?: UserInfo;
|
|
2253
2293
|
/**
|
|
2254
2294
|
* 暂未开放
|
|
2295
|
+
* @deprecated
|
|
2255
2296
|
*/
|
|
2256
2297
|
Organization?: OrganizationInfo;
|
|
2257
2298
|
}
|
|
@@ -2272,7 +2313,7 @@ export interface FlowDetailInfo {
|
|
|
2272
2313
|
*/
|
|
2273
2314
|
FlowType: string;
|
|
2274
2315
|
/**
|
|
2275
|
-
|
|
2316
|
+
* 合同(流程)的状态, 状态如下
|
|
2276
2317
|
|
|
2277
2318
|
INIT 还没发起
|
|
2278
2319
|
PART 部分签署
|
|
@@ -2282,7 +2323,7 @@ export interface FlowDetailInfo {
|
|
|
2282
2323
|
CANCEL 取消
|
|
2283
2324
|
RELIEVED 解除
|
|
2284
2325
|
|
|
2285
|
-
|
|
2326
|
+
*/
|
|
2286
2327
|
FlowStatus: string;
|
|
2287
2328
|
/**
|
|
2288
2329
|
* 合同(流程)的信息
|
|
@@ -2326,18 +2367,18 @@ export interface CreateFlowsByTemplatesResponse {
|
|
|
2326
2367
|
*/
|
|
2327
2368
|
CustomerData?: Array<string>;
|
|
2328
2369
|
/**
|
|
2329
|
-
|
|
2370
|
+
* 创建消息,对应多个合同ID,
|
|
2330
2371
|
成功为“”,创建失败则对应失败消息
|
|
2331
|
-
|
|
2372
|
+
*/
|
|
2332
2373
|
ErrorMessages?: Array<string>;
|
|
2333
2374
|
/**
|
|
2334
2375
|
* 预览模式下返回的预览文件url数组
|
|
2335
2376
|
*/
|
|
2336
2377
|
PreviewUrls?: Array<string>;
|
|
2337
2378
|
/**
|
|
2338
|
-
|
|
2379
|
+
* 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
|
|
2339
2380
|
如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
|
|
2340
|
-
|
|
2381
|
+
*/
|
|
2341
2382
|
TaskInfos?: Array<TaskInfo>;
|
|
2342
2383
|
/**
|
|
2343
2384
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2358,6 +2399,7 @@ export interface DescribeChannelFlowEvidenceReportRequest {
|
|
|
2358
2399
|
ReportId: string;
|
|
2359
2400
|
/**
|
|
2360
2401
|
* 暂未开放
|
|
2402
|
+
* @deprecated
|
|
2361
2403
|
*/
|
|
2362
2404
|
Operator?: UserInfo;
|
|
2363
2405
|
}
|
|
@@ -2366,16 +2408,16 @@ export interface DescribeChannelFlowEvidenceReportRequest {
|
|
|
2366
2408
|
*/
|
|
2367
2409
|
export interface SyncProxyOrganizationOperatorsResponse {
|
|
2368
2410
|
/**
|
|
2369
|
-
|
|
2411
|
+
* Status 同步状态,全部同步失败接口会直接报错
|
|
2370
2412
|
1-成功
|
|
2371
2413
|
2-部分成功
|
|
2372
2414
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2373
|
-
|
|
2415
|
+
*/
|
|
2374
2416
|
Status?: number;
|
|
2375
2417
|
/**
|
|
2376
|
-
|
|
2418
|
+
* 同步失败经办人及其失败原因
|
|
2377
2419
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2378
|
-
|
|
2420
|
+
*/
|
|
2379
2421
|
FailedList?: Array<SyncFailReason>;
|
|
2380
2422
|
/**
|
|
2381
2423
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2387,14 +2429,14 @@ export interface SyncProxyOrganizationOperatorsResponse {
|
|
|
2387
2429
|
*/
|
|
2388
2430
|
export interface FailedCreateRoleData {
|
|
2389
2431
|
/**
|
|
2390
|
-
|
|
2432
|
+
* 用户userId
|
|
2391
2433
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2392
|
-
|
|
2434
|
+
*/
|
|
2393
2435
|
UserId?: string;
|
|
2394
2436
|
/**
|
|
2395
|
-
|
|
2437
|
+
* 角色RoleId列表
|
|
2396
2438
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2397
|
-
|
|
2439
|
+
*/
|
|
2398
2440
|
RoleIds?: Array<string>;
|
|
2399
2441
|
}
|
|
2400
2442
|
/**
|
|
@@ -2402,14 +2444,14 @@ export interface FailedCreateRoleData {
|
|
|
2402
2444
|
*/
|
|
2403
2445
|
export interface FlowResourceUrlInfo {
|
|
2404
2446
|
/**
|
|
2405
|
-
|
|
2447
|
+
* 流程对应Id
|
|
2406
2448
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2407
|
-
|
|
2449
|
+
*/
|
|
2408
2450
|
FlowId: string;
|
|
2409
2451
|
/**
|
|
2410
|
-
|
|
2452
|
+
* 流程对应资源链接信息数组
|
|
2411
2453
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2412
|
-
|
|
2454
|
+
*/
|
|
2413
2455
|
ResourceUrlInfos: Array<ResourceUrlInfo>;
|
|
2414
2456
|
}
|
|
2415
2457
|
/**
|
|
@@ -2430,33 +2472,33 @@ export interface UploadFile {
|
|
|
2430
2472
|
*/
|
|
2431
2473
|
export interface ExtentServiceAuthInfo {
|
|
2432
2474
|
/**
|
|
2433
|
-
|
|
2475
|
+
* 扩展服务类型
|
|
2434
2476
|
AUTO_SIGN 企业静默签(自动签署)
|
|
2435
2477
|
OVERSEA_SIGN 企业与港澳台居民*签署合同
|
|
2436
2478
|
MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
|
|
2437
2479
|
PAGING_SEAL 骑缝章
|
|
2438
2480
|
DOWNLOAD_FLOW 授权平台企业下载合同
|
|
2439
|
-
|
|
2481
|
+
*/
|
|
2440
2482
|
Type?: string;
|
|
2441
2483
|
/**
|
|
2442
2484
|
* 扩展服务名称
|
|
2443
2485
|
*/
|
|
2444
2486
|
Name?: string;
|
|
2445
2487
|
/**
|
|
2446
|
-
|
|
2488
|
+
* 服务状态
|
|
2447
2489
|
ENABLE 开启
|
|
2448
2490
|
DISABLE 关闭
|
|
2449
|
-
|
|
2491
|
+
*/
|
|
2450
2492
|
Status?: string;
|
|
2451
2493
|
/**
|
|
2452
|
-
|
|
2494
|
+
* 最近操作人第三方应用平台的用户openid
|
|
2453
2495
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2454
|
-
|
|
2496
|
+
*/
|
|
2455
2497
|
OperatorOpenId?: string;
|
|
2456
2498
|
/**
|
|
2457
|
-
|
|
2499
|
+
* 最近操作时间戳,单位秒
|
|
2458
2500
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2459
|
-
|
|
2501
|
+
*/
|
|
2460
2502
|
OperateOn?: number;
|
|
2461
2503
|
}
|
|
2462
2504
|
/**
|
|
@@ -2492,21 +2534,21 @@ export interface ReleasedApprover {
|
|
|
2492
2534
|
*/
|
|
2493
2535
|
ApproverNumber: number;
|
|
2494
2536
|
/**
|
|
2495
|
-
|
|
2537
|
+
* 签署人类型,目前仅支持
|
|
2496
2538
|
ORGANIZATION-企业
|
|
2497
2539
|
ENTERPRISESERVER-企业静默签
|
|
2498
|
-
|
|
2540
|
+
*/
|
|
2499
2541
|
ApproverType: string;
|
|
2500
2542
|
/**
|
|
2501
2543
|
* 签署人姓名,最大长度50个字符
|
|
2502
2544
|
*/
|
|
2503
2545
|
Name?: string;
|
|
2504
2546
|
/**
|
|
2505
|
-
|
|
2547
|
+
* 签署人身份证件类型
|
|
2506
2548
|
1.ID_CARD 居民身份证
|
|
2507
2549
|
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
2508
2550
|
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2509
|
-
|
|
2551
|
+
*/
|
|
2510
2552
|
IdCardType?: string;
|
|
2511
2553
|
/**
|
|
2512
2554
|
* 签署人证件号
|
|
@@ -2521,9 +2563,9 @@ export interface ReleasedApprover {
|
|
|
2521
2563
|
*/
|
|
2522
2564
|
OrganizationOpenId?: string;
|
|
2523
2565
|
/**
|
|
2524
|
-
|
|
2566
|
+
* 用户侧第三方id,最大长度64个字符
|
|
2525
2567
|
当签署方为同一第三方应用下的员工时,该字必传
|
|
2526
|
-
|
|
2568
|
+
*/
|
|
2527
2569
|
OpenId?: string;
|
|
2528
2570
|
}
|
|
2529
2571
|
/**
|
|
@@ -2578,6 +2620,7 @@ export interface ChannelCreateBatchCancelFlowUrlRequest {
|
|
|
2578
2620
|
FlowIds: Array<string>;
|
|
2579
2621
|
/**
|
|
2580
2622
|
* 暂未开放
|
|
2623
|
+
* @deprecated
|
|
2581
2624
|
*/
|
|
2582
2625
|
Operator?: UserInfo;
|
|
2583
2626
|
}
|
|
@@ -2620,6 +2663,7 @@ export interface PrepareFlowsRequest {
|
|
|
2620
2663
|
JumpUrl: string;
|
|
2621
2664
|
/**
|
|
2622
2665
|
* 暂未开放
|
|
2666
|
+
* @deprecated
|
|
2623
2667
|
*/
|
|
2624
2668
|
Operator?: UserInfo;
|
|
2625
2669
|
}
|
|
@@ -2628,9 +2672,9 @@ export interface PrepareFlowsRequest {
|
|
|
2628
2672
|
*/
|
|
2629
2673
|
export interface ChannelCreateFlowByFilesResponse {
|
|
2630
2674
|
/**
|
|
2631
|
-
|
|
2675
|
+
* 合同签署流程ID
|
|
2632
2676
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2633
|
-
|
|
2677
|
+
*/
|
|
2634
2678
|
FlowId?: string;
|
|
2635
2679
|
/**
|
|
2636
2680
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2706,9 +2750,9 @@ export interface ChannelDescribeRolesResponse {
|
|
|
2706
2750
|
*/
|
|
2707
2751
|
TotalCount?: number;
|
|
2708
2752
|
/**
|
|
2709
|
-
|
|
2753
|
+
* 角色信息
|
|
2710
2754
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2711
|
-
|
|
2755
|
+
*/
|
|
2712
2756
|
ChannelRoles?: Array<ChannelRole>;
|
|
2713
2757
|
/**
|
|
2714
2758
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2741,10 +2785,12 @@ export interface ChannelCreateReleaseFlowRequest {
|
|
|
2741
2785
|
CallbackUrl?: string;
|
|
2742
2786
|
/**
|
|
2743
2787
|
* 暂未开放
|
|
2788
|
+
* @deprecated
|
|
2744
2789
|
*/
|
|
2745
2790
|
Organization?: OrganizationInfo;
|
|
2746
2791
|
/**
|
|
2747
2792
|
* 暂未开放
|
|
2793
|
+
* @deprecated
|
|
2748
2794
|
*/
|
|
2749
2795
|
Operator?: UserInfo;
|
|
2750
2796
|
}
|
|
@@ -2753,14 +2799,14 @@ export interface ChannelCreateReleaseFlowRequest {
|
|
|
2753
2799
|
*/
|
|
2754
2800
|
export interface ChannelCreateFlowGroupByFilesResponse {
|
|
2755
2801
|
/**
|
|
2756
|
-
|
|
2802
|
+
* 合同组ID
|
|
2757
2803
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2758
|
-
|
|
2804
|
+
*/
|
|
2759
2805
|
FlowGroupId?: string;
|
|
2760
2806
|
/**
|
|
2761
|
-
|
|
2807
|
+
* 子合同ID列表
|
|
2762
2808
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2763
|
-
|
|
2809
|
+
*/
|
|
2764
2810
|
FlowIds?: Array<string>;
|
|
2765
2811
|
/**
|
|
2766
2812
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2815,11 +2861,11 @@ export interface ProxyOrganizationOperator {
|
|
|
2815
2861
|
*/
|
|
2816
2862
|
Name?: string;
|
|
2817
2863
|
/**
|
|
2818
|
-
|
|
2864
|
+
* 经办人身份证件类型
|
|
2819
2865
|
1.ID_CARD 居民身份证
|
|
2820
2866
|
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
2821
2867
|
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2822
|
-
|
|
2868
|
+
*/
|
|
2823
2869
|
IdCardType?: string;
|
|
2824
2870
|
/**
|
|
2825
2871
|
* 经办人证件号
|
|
@@ -2830,11 +2876,11 @@ export interface ProxyOrganizationOperator {
|
|
|
2830
2876
|
*/
|
|
2831
2877
|
Mobile?: string;
|
|
2832
2878
|
/**
|
|
2833
|
-
|
|
2879
|
+
* 默认角色,值为以下三个对应的英文:
|
|
2834
2880
|
业务管理员:admin
|
|
2835
2881
|
经办人:channel-normal-operator
|
|
2836
2882
|
业务员:channel-sales-man
|
|
2837
|
-
|
|
2883
|
+
*/
|
|
2838
2884
|
DefaultRole?: string;
|
|
2839
2885
|
}
|
|
2840
2886
|
/**
|
|
@@ -2842,12 +2888,12 @@ export interface ProxyOrganizationOperator {
|
|
|
2842
2888
|
*/
|
|
2843
2889
|
export interface ModifyExtendedServiceResponse {
|
|
2844
2890
|
/**
|
|
2845
|
-
|
|
2891
|
+
* 操作跳转链接,有效期24小时
|
|
2846
2892
|
若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
|
|
2847
2893
|
|
|
2848
2894
|
当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
|
|
2849
2895
|
返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。
|
|
2850
|
-
|
|
2896
|
+
*/
|
|
2851
2897
|
OperateUrl?: string;
|
|
2852
2898
|
/**
|
|
2853
2899
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2862,16 +2908,21 @@ export interface ChannelCreateUserRolesRequest {
|
|
|
2862
2908
|
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
|
|
2863
2909
|
*/
|
|
2864
2910
|
Agent: Agent;
|
|
2865
|
-
/**
|
|
2866
|
-
* 绑定角色的员工id列表,电子签的UserId
|
|
2867
|
-
*/
|
|
2868
|
-
UserIds: Array<string>;
|
|
2869
2911
|
/**
|
|
2870
2912
|
* 绑定角色的角色id列表
|
|
2871
2913
|
*/
|
|
2872
2914
|
RoleIds: Array<string>;
|
|
2915
|
+
/**
|
|
2916
|
+
* 电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数
|
|
2917
|
+
*/
|
|
2918
|
+
UserIds?: Array<string>;
|
|
2919
|
+
/**
|
|
2920
|
+
* 客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数
|
|
2921
|
+
*/
|
|
2922
|
+
OpenIds?: Array<string>;
|
|
2873
2923
|
/**
|
|
2874
2924
|
* 操作者信息
|
|
2925
|
+
* @deprecated
|
|
2875
2926
|
*/
|
|
2876
2927
|
Operator?: UserInfo;
|
|
2877
2928
|
}
|
|
@@ -2884,34 +2935,35 @@ export interface ChannelGetTaskResultApiResponse {
|
|
|
2884
2935
|
*/
|
|
2885
2936
|
TaskId?: string;
|
|
2886
2937
|
/**
|
|
2887
|
-
|
|
2938
|
+
* 任务状态,需要关注的状态
|
|
2888
2939
|
0 :NeedTranform - 任务已提交
|
|
2889
2940
|
4 :Processing - 文档转换中
|
|
2890
2941
|
8 :TaskEnd - 任务处理完成
|
|
2891
2942
|
-2 :DownloadFailed - 下载失败
|
|
2892
2943
|
-6 :ProcessFailed - 转换失败
|
|
2893
2944
|
-13:ProcessTimeout - 转换文件超时
|
|
2894
|
-
|
|
2945
|
+
*/
|
|
2895
2946
|
TaskStatus?: number;
|
|
2896
2947
|
/**
|
|
2897
|
-
|
|
2948
|
+
* 状态描述,需要关注的状态
|
|
2898
2949
|
NeedTranform - 任务已提交
|
|
2899
2950
|
Processing - 文档转换中
|
|
2900
2951
|
TaskEnd - 任务处理完成
|
|
2901
2952
|
DownloadFailed - 下载失败
|
|
2902
2953
|
ProcessFailed - 转换失败
|
|
2903
2954
|
ProcessTimeout - 转换文件超时
|
|
2904
|
-
|
|
2955
|
+
*/
|
|
2905
2956
|
TaskMessage?: string;
|
|
2906
2957
|
/**
|
|
2907
2958
|
* 资源Id,也是FileId,用于文件发起使用
|
|
2908
2959
|
*/
|
|
2909
2960
|
ResourceId?: string;
|
|
2910
2961
|
/**
|
|
2911
|
-
|
|
2962
|
+
* 预览文件Url,有效期30分钟
|
|
2912
2963
|
当前字段返回为空,发起的时候,将ResourceId 放入发起即可
|
|
2913
2964
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2914
|
-
|
|
2965
|
+
* @deprecated
|
|
2966
|
+
*/
|
|
2915
2967
|
PreviewUrl?: string;
|
|
2916
2968
|
/**
|
|
2917
2969
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2939,7 +2991,7 @@ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.
|
|
|
2939
2991
|
*/
|
|
2940
2992
|
export interface Component {
|
|
2941
2993
|
/**
|
|
2942
|
-
|
|
2994
|
+
* 控件编号
|
|
2943
2995
|
|
|
2944
2996
|
CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
|
|
2945
2997
|
|
|
@@ -2951,10 +3003,10 @@ export interface Component {
|
|
|
2951
3003
|
|
|
2952
3004
|
创建控件时,此值为空
|
|
2953
3005
|
查询时返回完整结构
|
|
2954
|
-
|
|
3006
|
+
*/
|
|
2955
3007
|
ComponentId?: string;
|
|
2956
3008
|
/**
|
|
2957
|
-
|
|
3009
|
+
* 如果是Component控件类型,则可选的字段为:
|
|
2958
3010
|
TEXT - 普通文本控件,输入文本字符串;
|
|
2959
3011
|
MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
|
|
2960
3012
|
CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
|
|
@@ -2975,7 +3027,7 @@ export interface Component {
|
|
|
2975
3027
|
SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
|
|
2976
3028
|
|
|
2977
3029
|
表单域的控件不能作为印章和签名控件
|
|
2978
|
-
|
|
3030
|
+
*/
|
|
2979
3031
|
ComponentType?: string;
|
|
2980
3032
|
/**
|
|
2981
3033
|
* 控件简称,不能超过30个字符
|
|
@@ -2994,21 +3046,21 @@ export interface Component {
|
|
|
2994
3046
|
*/
|
|
2995
3047
|
FileIndex?: number;
|
|
2996
3048
|
/**
|
|
2997
|
-
|
|
3049
|
+
* 控件生成的方式:
|
|
2998
3050
|
NORMAL - 普通控件
|
|
2999
3051
|
FIELD - 表单域
|
|
3000
3052
|
KEYWORD - 关键字
|
|
3001
|
-
|
|
3053
|
+
*/
|
|
3002
3054
|
GenerateMode?: string;
|
|
3003
3055
|
/**
|
|
3004
|
-
|
|
3056
|
+
* 参数控件宽度,默认100,单位px
|
|
3005
3057
|
表单域和关键字转换控件不用填
|
|
3006
|
-
|
|
3058
|
+
*/
|
|
3007
3059
|
ComponentWidth?: number;
|
|
3008
3060
|
/**
|
|
3009
|
-
|
|
3061
|
+
* 参数控件高度,默认100,单位px
|
|
3010
3062
|
表单域和关键字转换控件不用填
|
|
3011
|
-
|
|
3063
|
+
*/
|
|
3012
3064
|
ComponentHeight?: number;
|
|
3013
3065
|
/**
|
|
3014
3066
|
* 参数控件所在页码,从1开始
|
|
@@ -3023,7 +3075,7 @@ export interface Component {
|
|
|
3023
3075
|
*/
|
|
3024
3076
|
ComponentPosY?: number;
|
|
3025
3077
|
/**
|
|
3026
|
-
|
|
3078
|
+
* 参数控件样式,json格式表述
|
|
3027
3079
|
|
|
3028
3080
|
不同类型的控件会有部分非通用参数
|
|
3029
3081
|
|
|
@@ -3056,10 +3108,10 @@ export interface Component {
|
|
|
3056
3108
|
如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
|
|
3057
3109
|
特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
|
|
3058
3110
|
参数样例: "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}",
|
|
3059
|
-
|
|
3111
|
+
*/
|
|
3060
3112
|
ComponentExtra?: string;
|
|
3061
3113
|
/**
|
|
3062
|
-
|
|
3114
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
3063
3115
|
TEXT - 文本内容
|
|
3064
3116
|
MULTI_LINE_TEXT - 文本内容
|
|
3065
3117
|
CHECK_BOX - true/false
|
|
@@ -3135,13 +3187,13 @@ export interface Component {
|
|
|
3135
3187
|
|
|
3136
3188
|
学历控件:
|
|
3137
3189
|
同单行文本控件约束,填写选择值中的字符串
|
|
3138
|
-
|
|
3190
|
+
*/
|
|
3139
3191
|
ComponentValue?: string;
|
|
3140
3192
|
/**
|
|
3141
|
-
|
|
3193
|
+
* 日期签署控件的字号,默认为 12
|
|
3142
3194
|
|
|
3143
3195
|
签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
|
|
3144
|
-
|
|
3196
|
+
*/
|
|
3145
3197
|
ComponentDateFontSize?: number;
|
|
3146
3198
|
/**
|
|
3147
3199
|
* 控件所属文档的Id, 模块相关接口为空值
|
|
@@ -3160,14 +3212,14 @@ export interface Component {
|
|
|
3160
3212
|
*/
|
|
3161
3213
|
OffsetY?: number;
|
|
3162
3214
|
/**
|
|
3163
|
-
|
|
3215
|
+
* 平台企业控件ID。
|
|
3164
3216
|
如果不为空,属于平台企业预设控件;
|
|
3165
|
-
|
|
3217
|
+
*/
|
|
3166
3218
|
ChannelComponentId?: string;
|
|
3167
3219
|
/**
|
|
3168
|
-
|
|
3220
|
+
* 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
|
|
3169
3221
|
传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
|
|
3170
|
-
|
|
3222
|
+
*/
|
|
3171
3223
|
KeywordOrder?: string;
|
|
3172
3224
|
/**
|
|
3173
3225
|
* 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
|
|
@@ -3182,9 +3234,9 @@ export interface Component {
|
|
|
3182
3234
|
*/
|
|
3183
3235
|
KeywordIndexes?: Array<number>;
|
|
3184
3236
|
/**
|
|
3185
|
-
|
|
3237
|
+
* 填写提示的内容
|
|
3186
3238
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3187
|
-
|
|
3239
|
+
*/
|
|
3188
3240
|
Placeholder?: string;
|
|
3189
3241
|
}
|
|
3190
3242
|
/**
|
|
@@ -3201,6 +3253,7 @@ export interface GetDownloadFlowUrlRequest {
|
|
|
3201
3253
|
DownLoadFlows?: Array<DownloadFlowInfo>;
|
|
3202
3254
|
/**
|
|
3203
3255
|
* 操作者的信息,不用传
|
|
3256
|
+
* @deprecated
|
|
3204
3257
|
*/
|
|
3205
3258
|
Operator?: UserInfo;
|
|
3206
3259
|
}
|
|
@@ -3234,15 +3287,16 @@ export interface ChannelBatchCancelFlowsRequest {
|
|
|
3234
3287
|
*/
|
|
3235
3288
|
CancelMessage?: string;
|
|
3236
3289
|
/**
|
|
3237
|
-
|
|
3290
|
+
* 撤销理由自定义格式;选项:
|
|
3238
3291
|
0 默认格式
|
|
3239
3292
|
1 只保留身份信息:展示为【发起方】
|
|
3240
3293
|
2 保留身份信息+企业名称:展示为【发起方xxx公司】
|
|
3241
3294
|
3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
|
|
3242
|
-
|
|
3295
|
+
*/
|
|
3243
3296
|
CancelMessageFormat?: number;
|
|
3244
3297
|
/**
|
|
3245
3298
|
* 暂未开放
|
|
3299
|
+
* @deprecated
|
|
3246
3300
|
*/
|
|
3247
3301
|
Operator?: UserInfo;
|
|
3248
3302
|
}
|
|
@@ -3268,6 +3322,7 @@ export interface ChannelUpdateSealStatusRequest {
|
|
|
3268
3322
|
Reason?: string;
|
|
3269
3323
|
/**
|
|
3270
3324
|
* 操作者的信息
|
|
3325
|
+
* @deprecated
|
|
3271
3326
|
*/
|
|
3272
3327
|
Operator?: UserInfo;
|
|
3273
3328
|
}
|
|
@@ -3305,15 +3360,16 @@ export interface ChannelCancelFlowRequest {
|
|
|
3305
3360
|
*/
|
|
3306
3361
|
CancelMessage?: string;
|
|
3307
3362
|
/**
|
|
3308
|
-
|
|
3363
|
+
* 撤销理由自定义格式;选项:
|
|
3309
3364
|
0 默认格式
|
|
3310
3365
|
1 只保留身份信息:展示为【发起方】
|
|
3311
3366
|
2 保留身份信息+企业名称:展示为【发起方xxx公司】
|
|
3312
3367
|
3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
|
|
3313
|
-
|
|
3368
|
+
*/
|
|
3314
3369
|
CancelMessageFormat?: number;
|
|
3315
3370
|
/**
|
|
3316
3371
|
* 暂未开放
|
|
3372
|
+
* @deprecated
|
|
3317
3373
|
*/
|
|
3318
3374
|
Operator?: UserInfo;
|
|
3319
3375
|
}
|
|
@@ -3363,6 +3419,7 @@ export interface DescribeTemplatesRequest {
|
|
|
3363
3419
|
ChannelTemplateId?: string;
|
|
3364
3420
|
/**
|
|
3365
3421
|
* 操作者的信息
|
|
3422
|
+
* @deprecated
|
|
3366
3423
|
*/
|
|
3367
3424
|
Operator?: UserInfo;
|
|
3368
3425
|
}
|
|
@@ -3404,16 +3461,18 @@ export interface ChannelCreateSealPolicyRequest {
|
|
|
3404
3461
|
*/
|
|
3405
3462
|
SealId: string;
|
|
3406
3463
|
/**
|
|
3407
|
-
|
|
3464
|
+
* 指定待授权的用户ID数组,电子签的用户ID
|
|
3408
3465
|
可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权。
|
|
3409
|
-
|
|
3466
|
+
*/
|
|
3410
3467
|
UserIds: Array<string>;
|
|
3411
3468
|
/**
|
|
3412
3469
|
* 操作人(用户)信息,不用传
|
|
3470
|
+
* @deprecated
|
|
3413
3471
|
*/
|
|
3414
3472
|
Operator?: UserInfo;
|
|
3415
3473
|
/**
|
|
3416
3474
|
* 企业机构信息,不用传
|
|
3475
|
+
* @deprecated
|
|
3417
3476
|
*/
|
|
3418
3477
|
Organization?: OrganizationInfo;
|
|
3419
3478
|
}
|
|
@@ -3446,9 +3505,9 @@ export interface OccupiedSeal {
|
|
|
3446
3505
|
*/
|
|
3447
3506
|
SealStatus: string;
|
|
3448
3507
|
/**
|
|
3449
|
-
|
|
3508
|
+
* 审核失败原因
|
|
3450
3509
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3451
|
-
|
|
3510
|
+
*/
|
|
3452
3511
|
FailReason: string;
|
|
3453
3512
|
/**
|
|
3454
3513
|
* 印章图片url,5分钟内有效
|
|
@@ -3480,10 +3539,10 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
3480
3539
|
*/
|
|
3481
3540
|
FlowInfos: Array<FlowInfo>;
|
|
3482
3541
|
/**
|
|
3483
|
-
|
|
3542
|
+
* 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls;
|
|
3484
3543
|
预览链接有效期300秒;
|
|
3485
3544
|
同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
|
|
3486
|
-
|
|
3545
|
+
*/
|
|
3487
3546
|
NeedPreview?: boolean;
|
|
3488
3547
|
/**
|
|
3489
3548
|
* 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
|
|
@@ -3491,6 +3550,7 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
3491
3550
|
PreviewType?: number;
|
|
3492
3551
|
/**
|
|
3493
3552
|
* 操作者的信息,不用传
|
|
3553
|
+
* @deprecated
|
|
3494
3554
|
*/
|
|
3495
3555
|
Operator?: UserInfo;
|
|
3496
3556
|
}
|
|
@@ -3503,28 +3563,28 @@ export interface UsageDetail {
|
|
|
3503
3563
|
*/
|
|
3504
3564
|
ProxyOrganizationOpenId: string;
|
|
3505
3565
|
/**
|
|
3506
|
-
|
|
3566
|
+
* 子客企业名
|
|
3507
3567
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3508
|
-
|
|
3568
|
+
*/
|
|
3509
3569
|
ProxyOrganizationName: string;
|
|
3510
3570
|
/**
|
|
3511
|
-
|
|
3571
|
+
* 日期,当需要汇总数据时日期为空
|
|
3512
3572
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3513
|
-
|
|
3573
|
+
*/
|
|
3514
3574
|
Date: string;
|
|
3515
3575
|
/**
|
|
3516
3576
|
* 消耗数量
|
|
3517
3577
|
*/
|
|
3518
3578
|
Usage: number;
|
|
3519
3579
|
/**
|
|
3520
|
-
|
|
3580
|
+
* 撤回数量
|
|
3521
3581
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3522
|
-
|
|
3582
|
+
*/
|
|
3523
3583
|
Cancel: number;
|
|
3524
3584
|
/**
|
|
3525
|
-
|
|
3585
|
+
* 消耗渠道
|
|
3526
3586
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3527
|
-
|
|
3587
|
+
*/
|
|
3528
3588
|
FlowChannel: string;
|
|
3529
3589
|
}
|
|
3530
3590
|
/**
|
|
@@ -3574,6 +3634,7 @@ export interface OperateChannelTemplateRequest {
|
|
|
3574
3634
|
AuthTag?: string;
|
|
3575
3635
|
/**
|
|
3576
3636
|
* 暂未开放
|
|
3637
|
+
* @deprecated
|
|
3577
3638
|
*/
|
|
3578
3639
|
Operator?: UserInfo;
|
|
3579
3640
|
}
|
|
@@ -3582,20 +3643,20 @@ export interface OperateChannelTemplateRequest {
|
|
|
3582
3643
|
*/
|
|
3583
3644
|
export interface CreateChannelFlowEvidenceReportResponse {
|
|
3584
3645
|
/**
|
|
3585
|
-
|
|
3646
|
+
* 出证报告 ID,用于查询出证报告接口DescribeChannelFlowEvidenceReport时用到
|
|
3586
3647
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3587
|
-
|
|
3648
|
+
*/
|
|
3588
3649
|
ReportId?: string;
|
|
3589
3650
|
/**
|
|
3590
|
-
|
|
3651
|
+
* 执行中:EvidenceStatusExecuting
|
|
3591
3652
|
成功:EvidenceStatusSuccess
|
|
3592
3653
|
失败:EvidenceStatusFailed
|
|
3593
|
-
|
|
3654
|
+
*/
|
|
3594
3655
|
Status?: string;
|
|
3595
3656
|
/**
|
|
3596
|
-
|
|
3657
|
+
* 废除,字段无效
|
|
3597
3658
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3598
|
-
|
|
3659
|
+
*/
|
|
3599
3660
|
ReportUrl?: string;
|
|
3600
3661
|
/**
|
|
3601
3662
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -3611,10 +3672,10 @@ export interface SyncFailReason {
|
|
|
3611
3672
|
*/
|
|
3612
3673
|
Id: string;
|
|
3613
3674
|
/**
|
|
3614
|
-
|
|
3675
|
+
* 失败原因
|
|
3615
3676
|
例如:Id不符合规范、证件号码不合法等
|
|
3616
3677
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3617
|
-
|
|
3678
|
+
*/
|
|
3618
3679
|
Message: string;
|
|
3619
3680
|
}
|
|
3620
3681
|
/**
|
|
@@ -3622,14 +3683,14 @@ export interface SyncFailReason {
|
|
|
3622
3683
|
*/
|
|
3623
3684
|
export interface ChannelDescribeEmployeesResponse {
|
|
3624
3685
|
/**
|
|
3625
|
-
|
|
3686
|
+
* 员工数据列表
|
|
3626
3687
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3627
|
-
|
|
3688
|
+
*/
|
|
3628
3689
|
Employees?: Array<Staff>;
|
|
3629
3690
|
/**
|
|
3630
|
-
|
|
3691
|
+
* 偏移量,默认为0,最大为20000
|
|
3631
3692
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3632
|
-
|
|
3693
|
+
*/
|
|
3633
3694
|
Offset?: number;
|
|
3634
3695
|
/**
|
|
3635
3696
|
* 返回最大数量,最大为20
|
|
@@ -3662,15 +3723,15 @@ export interface ChannelCreateReleaseFlowResponse {
|
|
|
3662
3723
|
*/
|
|
3663
3724
|
export interface DescribeChannelFlowEvidenceReportResponse {
|
|
3664
3725
|
/**
|
|
3665
|
-
|
|
3726
|
+
* 出证报告 URL
|
|
3666
3727
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3667
|
-
|
|
3728
|
+
*/
|
|
3668
3729
|
ReportUrl?: string;
|
|
3669
3730
|
/**
|
|
3670
|
-
|
|
3731
|
+
* 执行中:EvidenceStatusExecuting
|
|
3671
3732
|
成功:EvidenceStatusSuccess
|
|
3672
3733
|
失败:EvidenceStatusFailed
|
|
3673
|
-
|
|
3734
|
+
*/
|
|
3674
3735
|
Status?: string;
|
|
3675
3736
|
/**
|
|
3676
3737
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -3695,6 +3756,7 @@ export interface CreateSealByImageRequest {
|
|
|
3695
3756
|
SealImage: string;
|
|
3696
3757
|
/**
|
|
3697
3758
|
* 操作者的信息
|
|
3759
|
+
* @deprecated
|
|
3698
3760
|
*/
|
|
3699
3761
|
Operator?: UserInfo;
|
|
3700
3762
|
}
|
|
@@ -3725,10 +3787,12 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
3725
3787
|
FlowApproverInfos: Array<FlowApproverInfo>;
|
|
3726
3788
|
/**
|
|
3727
3789
|
* 用户信息,暂未开放
|
|
3790
|
+
* @deprecated
|
|
3728
3791
|
*/
|
|
3729
3792
|
Operator?: UserInfo;
|
|
3730
3793
|
/**
|
|
3731
3794
|
* 机构信息,暂未开放
|
|
3795
|
+
* @deprecated
|
|
3732
3796
|
*/
|
|
3733
3797
|
Organization?: OrganizationInfo;
|
|
3734
3798
|
}
|
|
@@ -3737,9 +3801,9 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
3737
3801
|
*/
|
|
3738
3802
|
export interface DescribeExtendedServiceAuthInfoResponse {
|
|
3739
3803
|
/**
|
|
3740
|
-
|
|
3804
|
+
* 企业扩展服务授权信息
|
|
3741
3805
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3742
|
-
|
|
3806
|
+
*/
|
|
3743
3807
|
AuthInfo?: Array<ExtentServiceAuthInfo>;
|
|
3744
3808
|
/**
|
|
3745
3809
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -3768,6 +3832,7 @@ export interface ChannelCreateEmbedWebUrlRequest {
|
|
|
3768
3832
|
HiddenComponents?: boolean;
|
|
3769
3833
|
/**
|
|
3770
3834
|
* 渠道操作者信息
|
|
3835
|
+
* @deprecated
|
|
3771
3836
|
*/
|
|
3772
3837
|
Operator?: UserInfo;
|
|
3773
3838
|
}
|
|
@@ -3784,14 +3849,14 @@ export interface CcInfo {
|
|
|
3784
3849
|
*/
|
|
3785
3850
|
Name?: string;
|
|
3786
3851
|
/**
|
|
3787
|
-
|
|
3852
|
+
* 被抄送人类型
|
|
3788
3853
|
0--个人. 1--员工
|
|
3789
|
-
|
|
3854
|
+
*/
|
|
3790
3855
|
CcType?: number;
|
|
3791
3856
|
/**
|
|
3792
|
-
|
|
3857
|
+
* 被抄送人权限
|
|
3793
3858
|
0--可查看
|
|
3794
3859
|
1--可查看也可下载
|
|
3795
|
-
|
|
3860
|
+
*/
|
|
3796
3861
|
CcPermission?: number;
|
|
3797
3862
|
}
|