tencentcloud-sdk-nodejs-essbasic 4.0.618 → 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 +252 -0
- package/SERVICE_CHANGELOG.md +301 -151
- package/package.json +1 -1
- package/products.md +18 -18
- package/src/services/essbasic/v20201222/essbasic_models.ts +164 -602
- package/src/services/essbasic/v20210526/essbasic_client.ts +1 -1
- package/src/services/essbasic/v20210526/essbasic_models.ts +356 -822
- package/tencentcloud/services/essbasic/v20201222/essbasic_models.d.ts +164 -164
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +356 -299
|
@@ -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-否
|
|
@@ -444,6 +448,7 @@ export interface ChannelDeleteRoleUsersRequest {
|
|
|
444
448
|
UserIds?: Array<string>;
|
|
445
449
|
/**
|
|
446
450
|
* 操作人信息
|
|
451
|
+
* @deprecated
|
|
447
452
|
*/
|
|
448
453
|
Operator?: UserInfo;
|
|
449
454
|
/**
|
|
@@ -469,9 +474,9 @@ export interface ChannelCreateUserRolesResponse {
|
|
|
469
474
|
*/
|
|
470
475
|
export interface SyncProxyOrganizationRequest {
|
|
471
476
|
/**
|
|
472
|
-
|
|
477
|
+
* 应用信息
|
|
473
478
|
此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
|
|
474
|
-
|
|
479
|
+
*/
|
|
475
480
|
Agent: Agent;
|
|
476
481
|
/**
|
|
477
482
|
* 第三方平台子客企业名称,最大长度64个字符
|
|
@@ -491,6 +496,7 @@ export interface SyncProxyOrganizationRequest {
|
|
|
491
496
|
ProxyLegalName?: string;
|
|
492
497
|
/**
|
|
493
498
|
* 暂未开放
|
|
499
|
+
* @deprecated
|
|
494
500
|
*/
|
|
495
501
|
Operator?: UserInfo;
|
|
496
502
|
}
|
|
@@ -532,10 +538,12 @@ export interface ChannelCreatePrepareFlowRequest {
|
|
|
532
538
|
NeedPreview?: boolean;
|
|
533
539
|
/**
|
|
534
540
|
* 企业机构信息,不用传
|
|
541
|
+
* @deprecated
|
|
535
542
|
*/
|
|
536
543
|
Organization?: OrganizationInfo;
|
|
537
544
|
/**
|
|
538
545
|
* 操作人(用户)信息,不用传
|
|
546
|
+
* @deprecated
|
|
539
547
|
*/
|
|
540
548
|
Operator?: UserInfo;
|
|
541
549
|
}
|
|
@@ -557,9 +565,9 @@ export interface ChannelCreateFlowRemindsRequest {
|
|
|
557
565
|
*/
|
|
558
566
|
export interface ChannelCreateSealPolicyResponse {
|
|
559
567
|
/**
|
|
560
|
-
|
|
568
|
+
* 最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的。
|
|
561
569
|
请求参数填写OpenId时,返回授权成功的 Openid。
|
|
562
|
-
|
|
570
|
+
*/
|
|
563
571
|
UserIds?: Array<string>;
|
|
564
572
|
/**
|
|
565
573
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -609,9 +617,9 @@ export interface FlowApproverUrlInfo {
|
|
|
609
617
|
*/
|
|
610
618
|
Mobile: string;
|
|
611
619
|
/**
|
|
612
|
-
|
|
620
|
+
* 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
|
|
613
621
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
614
|
-
|
|
622
|
+
*/
|
|
615
623
|
LongUrl?: string;
|
|
616
624
|
}
|
|
617
625
|
/**
|
|
@@ -623,7 +631,7 @@ export interface ChannelCreateConvertTaskApiRequest {
|
|
|
623
631
|
*/
|
|
624
632
|
Agent: Agent;
|
|
625
633
|
/**
|
|
626
|
-
* 资源类型
|
|
634
|
+
* 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
|
|
627
635
|
*/
|
|
628
636
|
ResourceType: string;
|
|
629
637
|
/**
|
|
@@ -636,10 +644,12 @@ export interface ChannelCreateConvertTaskApiRequest {
|
|
|
636
644
|
ResourceId: string;
|
|
637
645
|
/**
|
|
638
646
|
* 调用方用户信息,不用传
|
|
647
|
+
* @deprecated
|
|
639
648
|
*/
|
|
640
649
|
Operator?: UserInfo;
|
|
641
650
|
/**
|
|
642
651
|
* 暂未开放
|
|
652
|
+
* @deprecated
|
|
643
653
|
*/
|
|
644
654
|
Organization?: OrganizationInfo;
|
|
645
655
|
}
|
|
@@ -700,11 +710,11 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
700
710
|
*/
|
|
701
711
|
NeedSignReview?: boolean;
|
|
702
712
|
/**
|
|
703
|
-
|
|
713
|
+
* 签署人校验方式
|
|
704
714
|
VerifyCheck: 人脸识别(默认)
|
|
705
715
|
MobileCheck:手机号验证
|
|
706
716
|
参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
|
707
|
-
|
|
717
|
+
*/
|
|
708
718
|
ApproverVerifyType?: string;
|
|
709
719
|
/**
|
|
710
720
|
* 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
|
|
@@ -724,6 +734,7 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
724
734
|
AutoSignScene?: string;
|
|
725
735
|
/**
|
|
726
736
|
* 操作者的信息,不用传
|
|
737
|
+
* @deprecated
|
|
727
738
|
*/
|
|
728
739
|
Operator?: UserInfo;
|
|
729
740
|
}
|
|
@@ -732,19 +743,19 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
732
743
|
*/
|
|
733
744
|
export interface ChannelRole {
|
|
734
745
|
/**
|
|
735
|
-
|
|
746
|
+
* 角色id
|
|
736
747
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
737
|
-
|
|
748
|
+
*/
|
|
738
749
|
RoleId?: string;
|
|
739
750
|
/**
|
|
740
|
-
|
|
751
|
+
* 角色名
|
|
741
752
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
742
|
-
|
|
753
|
+
*/
|
|
743
754
|
RoleName?: string;
|
|
744
755
|
/**
|
|
745
|
-
|
|
756
|
+
* 角色状态:1-启用;2-禁用
|
|
746
757
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
747
|
-
|
|
758
|
+
*/
|
|
748
759
|
RoleStatus?: number;
|
|
749
760
|
}
|
|
750
761
|
/**
|
|
@@ -756,9 +767,9 @@ export interface FlowApproverDetail {
|
|
|
756
767
|
*/
|
|
757
768
|
ReceiptId: string;
|
|
758
769
|
/**
|
|
759
|
-
|
|
770
|
+
* 平台企业的第三方id
|
|
760
771
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
761
|
-
|
|
772
|
+
*/
|
|
762
773
|
ProxyOrganizationOpenId: string;
|
|
763
774
|
/**
|
|
764
775
|
* 平台企业操作人的第三方id
|
|
@@ -777,12 +788,12 @@ export interface FlowApproverDetail {
|
|
|
777
788
|
*/
|
|
778
789
|
SignOrder: number;
|
|
779
790
|
/**
|
|
780
|
-
|
|
791
|
+
* 签署人姓名
|
|
781
792
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
782
|
-
|
|
793
|
+
*/
|
|
783
794
|
ApproveName: string;
|
|
784
795
|
/**
|
|
785
|
-
|
|
796
|
+
* 当前签署人的状态, 状态如下
|
|
786
797
|
|
|
787
798
|
PENDING 流程等待中
|
|
788
799
|
FILLPENDING 待填写状态
|
|
@@ -798,21 +809,21 @@ export interface FlowApproverDetail {
|
|
|
798
809
|
RELIEVED 已经解除
|
|
799
810
|
|
|
800
811
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
801
|
-
|
|
812
|
+
*/
|
|
802
813
|
ApproveStatus: string;
|
|
803
814
|
/**
|
|
804
|
-
|
|
815
|
+
* 签署人信息
|
|
805
816
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
806
|
-
|
|
817
|
+
*/
|
|
807
818
|
ApproveMessage: string;
|
|
808
819
|
/**
|
|
809
820
|
* 签署人签署时间戳,单位秒
|
|
810
821
|
*/
|
|
811
822
|
ApproveTime: number;
|
|
812
823
|
/**
|
|
813
|
-
|
|
824
|
+
* 参与者类型 (ORGANIZATION企业/PERSON个人)
|
|
814
825
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
815
|
-
|
|
826
|
+
*/
|
|
816
827
|
ApproveType: string;
|
|
817
828
|
}
|
|
818
829
|
/**
|
|
@@ -824,9 +835,9 @@ export interface DescribeResourceUrlsByFlowsResponse {
|
|
|
824
835
|
*/
|
|
825
836
|
FlowResourceUrlInfos?: Array<FlowResourceUrlInfo>;
|
|
826
837
|
/**
|
|
827
|
-
|
|
838
|
+
* 创建消息,对应多个合同ID,
|
|
828
839
|
成功为“”,创建失败则对应失败消息
|
|
829
|
-
|
|
840
|
+
*/
|
|
830
841
|
ErrorMessages?: Array<string>;
|
|
831
842
|
/**
|
|
832
843
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -850,14 +861,15 @@ export interface ChannelCreateFlowGroupByFilesRequest {
|
|
|
850
861
|
*/
|
|
851
862
|
Agent?: Agent;
|
|
852
863
|
/**
|
|
853
|
-
|
|
864
|
+
* 签署人校验方式
|
|
854
865
|
VerifyCheck: 人脸识别(默认)
|
|
855
866
|
MobileCheck:手机号验证
|
|
856
867
|
参数说明:若选择后者,未实名的个人签署方查看合同时,无需进行人脸识别实名认证(但签署合同时仍然需要人脸实名),该能力仅适用于个人签署方。
|
|
857
|
-
|
|
868
|
+
*/
|
|
858
869
|
ApproverVerifyType?: string;
|
|
859
870
|
/**
|
|
860
871
|
* 操作者的信息,此参数不用传
|
|
872
|
+
* @deprecated
|
|
861
873
|
*/
|
|
862
874
|
Operator?: UserInfo;
|
|
863
875
|
}
|
|
@@ -874,19 +886,19 @@ export interface DescribeFlowDetailInfoResponse {
|
|
|
874
886
|
*/
|
|
875
887
|
ProxyOrganizationOpenId?: string;
|
|
876
888
|
/**
|
|
877
|
-
|
|
889
|
+
* 合同(签署流程)的具体详细描述信息
|
|
878
890
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
879
|
-
|
|
891
|
+
*/
|
|
880
892
|
FlowInfo?: Array<FlowDetailInfo>;
|
|
881
893
|
/**
|
|
882
|
-
|
|
894
|
+
* 合同组编号
|
|
883
895
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
884
|
-
|
|
896
|
+
*/
|
|
885
897
|
FlowGroupId?: string;
|
|
886
898
|
/**
|
|
887
|
-
|
|
899
|
+
* 合同组名称
|
|
888
900
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
889
|
-
|
|
901
|
+
*/
|
|
890
902
|
FlowGroupName?: string;
|
|
891
903
|
/**
|
|
892
904
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -898,19 +910,19 @@ export interface DescribeFlowDetailInfoResponse {
|
|
|
898
910
|
*/
|
|
899
911
|
export interface ResourceUrlInfo {
|
|
900
912
|
/**
|
|
901
|
-
|
|
913
|
+
* 资源链接地址,过期时间5分钟
|
|
902
914
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
903
|
-
|
|
915
|
+
*/
|
|
904
916
|
Url: string;
|
|
905
917
|
/**
|
|
906
|
-
|
|
918
|
+
* 资源名称
|
|
907
919
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
908
|
-
|
|
920
|
+
*/
|
|
909
921
|
Name: string;
|
|
910
922
|
/**
|
|
911
|
-
|
|
923
|
+
* 资源类型
|
|
912
924
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
913
|
-
|
|
925
|
+
*/
|
|
914
926
|
Type: string;
|
|
915
927
|
}
|
|
916
928
|
/**
|
|
@@ -930,13 +942,14 @@ export interface ChannelDescribeRolesRequest {
|
|
|
930
942
|
*/
|
|
931
943
|
Limit: string;
|
|
932
944
|
/**
|
|
933
|
-
|
|
945
|
+
* 查询的关键字段:
|
|
934
946
|
Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
|
|
935
947
|
Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
|
|
936
|
-
|
|
948
|
+
*/
|
|
937
949
|
Filters?: Array<Filter>;
|
|
938
950
|
/**
|
|
939
951
|
* 操作人信息
|
|
952
|
+
* @deprecated
|
|
940
953
|
*/
|
|
941
954
|
Operator?: UserInfo;
|
|
942
955
|
}
|
|
@@ -987,6 +1000,7 @@ export interface TemplateInfo {
|
|
|
987
1000
|
TemplateType: number;
|
|
988
1001
|
/**
|
|
989
1002
|
* 是否是发起人 ,已弃用
|
|
1003
|
+
* @deprecated
|
|
990
1004
|
*/
|
|
991
1005
|
IsPromoter?: boolean;
|
|
992
1006
|
/**
|
|
@@ -998,38 +1012,38 @@ export interface TemplateInfo {
|
|
|
998
1012
|
*/
|
|
999
1013
|
CreatedOn: number;
|
|
1000
1014
|
/**
|
|
1001
|
-
|
|
1015
|
+
* 模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回,有效期5分钟。
|
|
1002
1016
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1003
|
-
|
|
1017
|
+
*/
|
|
1004
1018
|
PreviewUrl: string;
|
|
1005
1019
|
/**
|
|
1006
|
-
|
|
1020
|
+
* 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回(此功能开放需要联系客户经理),有效期5分钟。
|
|
1007
1021
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1008
|
-
|
|
1022
|
+
*/
|
|
1009
1023
|
PdfUrl: string;
|
|
1010
1024
|
/**
|
|
1011
1025
|
* 关联的第三方应用平台企业模板ID
|
|
1012
1026
|
*/
|
|
1013
1027
|
ChannelTemplateId: string;
|
|
1014
1028
|
/**
|
|
1015
|
-
|
|
1029
|
+
* 关联的三方应用平台平台企业模板名称
|
|
1016
1030
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1017
|
-
|
|
1031
|
+
*/
|
|
1018
1032
|
ChannelTemplateName: string;
|
|
1019
1033
|
/**
|
|
1020
|
-
|
|
1034
|
+
* 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
|
|
1021
1035
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1022
|
-
|
|
1036
|
+
*/
|
|
1023
1037
|
ChannelAutoSave: number;
|
|
1024
1038
|
/**
|
|
1025
|
-
|
|
1039
|
+
* 模板版本,全数字字符。默认为空,初始版本为yyyyMMdd001。
|
|
1026
1040
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1027
|
-
|
|
1041
|
+
*/
|
|
1028
1042
|
TemplateVersion: string;
|
|
1029
1043
|
/**
|
|
1030
|
-
|
|
1044
|
+
* 模板可用状态,取值:1启用(默认),2停用
|
|
1031
1045
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1032
|
-
|
|
1046
|
+
*/
|
|
1033
1047
|
Available?: number;
|
|
1034
1048
|
}
|
|
1035
1049
|
/**
|
|
@@ -1067,6 +1081,7 @@ export interface Agent {
|
|
|
1067
1081
|
ProxyAppId?: string;
|
|
1068
1082
|
/**
|
|
1069
1083
|
* 内部参数,暂未开放使用
|
|
1084
|
+
* @deprecated
|
|
1070
1085
|
*/
|
|
1071
1086
|
ProxyOrganizationId?: string;
|
|
1072
1087
|
}
|
|
@@ -1141,14 +1156,14 @@ export interface DescribeTemplatesResponse {
|
|
|
1141
1156
|
*/
|
|
1142
1157
|
export interface StaffRole {
|
|
1143
1158
|
/**
|
|
1144
|
-
|
|
1159
|
+
* 角色id
|
|
1145
1160
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1146
|
-
|
|
1161
|
+
*/
|
|
1147
1162
|
RoleId: string;
|
|
1148
1163
|
/**
|
|
1149
|
-
|
|
1164
|
+
* 角色名称
|
|
1150
1165
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1151
|
-
|
|
1166
|
+
*/
|
|
1152
1167
|
RoleName: string;
|
|
1153
1168
|
}
|
|
1154
1169
|
/**
|
|
@@ -1165,6 +1180,7 @@ export interface ChannelVerifyPdfRequest {
|
|
|
1165
1180
|
Agent?: Agent;
|
|
1166
1181
|
/**
|
|
1167
1182
|
* 暂未开放
|
|
1183
|
+
* @deprecated
|
|
1168
1184
|
*/
|
|
1169
1185
|
Operator?: UserInfo;
|
|
1170
1186
|
}
|
|
@@ -1182,6 +1198,7 @@ export interface CreateChannelFlowEvidenceReportRequest {
|
|
|
1182
1198
|
FlowId: string;
|
|
1183
1199
|
/**
|
|
1184
1200
|
* 暂未开放
|
|
1201
|
+
* @deprecated
|
|
1185
1202
|
*/
|
|
1186
1203
|
Operator?: UserInfo;
|
|
1187
1204
|
}
|
|
@@ -1207,9 +1224,9 @@ export interface ChannelVerifyPdfResponse {
|
|
|
1207
1224
|
*/
|
|
1208
1225
|
export interface CreateConsoleLoginUrlRequest {
|
|
1209
1226
|
/**
|
|
1210
|
-
|
|
1227
|
+
* 应用信息
|
|
1211
1228
|
此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
|
|
1212
|
-
|
|
1229
|
+
*/
|
|
1213
1230
|
Agent: Agent;
|
|
1214
1231
|
/**
|
|
1215
1232
|
* 子客企业名称,最大长度64个字符
|
|
@@ -1249,6 +1266,7 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
1249
1266
|
AuthorizationTypes?: Array<number>;
|
|
1250
1267
|
/**
|
|
1251
1268
|
* 暂未开放
|
|
1269
|
+
* @deprecated
|
|
1252
1270
|
*/
|
|
1253
1271
|
Operator?: UserInfo;
|
|
1254
1272
|
}
|
|
@@ -1270,10 +1288,12 @@ export interface OrganizationInfo {
|
|
|
1270
1288
|
Channel?: string;
|
|
1271
1289
|
/**
|
|
1272
1290
|
* 用户真实的IP
|
|
1291
|
+
* @deprecated
|
|
1273
1292
|
*/
|
|
1274
1293
|
ClientIp?: string;
|
|
1275
1294
|
/**
|
|
1276
1295
|
* 机构的代理IP
|
|
1296
|
+
* @deprecated
|
|
1277
1297
|
*/
|
|
1278
1298
|
ProxyIp?: string;
|
|
1279
1299
|
}
|
|
@@ -1282,71 +1302,72 @@ export interface OrganizationInfo {
|
|
|
1282
1302
|
*/
|
|
1283
1303
|
export interface SignUrlInfo {
|
|
1284
1304
|
/**
|
|
1285
|
-
|
|
1305
|
+
* 签署链接,过期时间为30天
|
|
1286
1306
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1287
|
-
|
|
1307
|
+
*/
|
|
1288
1308
|
SignUrl: string;
|
|
1289
1309
|
/**
|
|
1290
|
-
|
|
1310
|
+
* 合同过期时间戳,单位秒
|
|
1291
1311
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1292
|
-
|
|
1312
|
+
*/
|
|
1293
1313
|
Deadline: number;
|
|
1294
1314
|
/**
|
|
1295
|
-
|
|
1315
|
+
* 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
|
|
1296
1316
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1297
|
-
|
|
1317
|
+
*/
|
|
1298
1318
|
SignOrder: number;
|
|
1299
1319
|
/**
|
|
1300
|
-
|
|
1320
|
+
* 签署人编号
|
|
1301
1321
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1302
|
-
|
|
1322
|
+
*/
|
|
1303
1323
|
SignId: string;
|
|
1304
1324
|
/**
|
|
1305
|
-
|
|
1325
|
+
* 自定义用户编号
|
|
1306
1326
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1307
|
-
|
|
1327
|
+
* @deprecated
|
|
1328
|
+
*/
|
|
1308
1329
|
CustomUserId?: string;
|
|
1309
1330
|
/**
|
|
1310
|
-
|
|
1331
|
+
* 用户姓名
|
|
1311
1332
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1312
|
-
|
|
1333
|
+
*/
|
|
1313
1334
|
Name: string;
|
|
1314
1335
|
/**
|
|
1315
|
-
|
|
1336
|
+
* 用户手机号码
|
|
1316
1337
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1317
|
-
|
|
1338
|
+
*/
|
|
1318
1339
|
Mobile: string;
|
|
1319
1340
|
/**
|
|
1320
|
-
|
|
1341
|
+
* 签署参与者机构名字
|
|
1321
1342
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1322
|
-
|
|
1343
|
+
*/
|
|
1323
1344
|
OrganizationName: string;
|
|
1324
1345
|
/**
|
|
1325
|
-
|
|
1346
|
+
* 参与者类型:
|
|
1326
1347
|
ORGANIZATION 企业经办人
|
|
1327
1348
|
PERSON 自然人
|
|
1328
1349
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1329
|
-
|
|
1350
|
+
*/
|
|
1330
1351
|
ApproverType: string;
|
|
1331
1352
|
/**
|
|
1332
|
-
|
|
1353
|
+
* 经办人身份证号
|
|
1333
1354
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1334
|
-
|
|
1355
|
+
*/
|
|
1335
1356
|
IdCardNumber: string;
|
|
1336
1357
|
/**
|
|
1337
|
-
|
|
1358
|
+
* 签署链接对应流程Id
|
|
1338
1359
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1339
|
-
|
|
1360
|
+
*/
|
|
1340
1361
|
FlowId: string;
|
|
1341
1362
|
/**
|
|
1342
|
-
|
|
1363
|
+
* 企业经办人 用户在渠道的编号
|
|
1343
1364
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1344
|
-
|
|
1365
|
+
*/
|
|
1345
1366
|
OpenId: string;
|
|
1346
1367
|
/**
|
|
1347
|
-
|
|
1368
|
+
* 合同组签署链接对应的合同组id
|
|
1348
1369
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1349
|
-
|
|
1370
|
+
*/
|
|
1350
1371
|
FlowGroupId: string;
|
|
1351
1372
|
}
|
|
1352
1373
|
/**
|
|
@@ -1390,9 +1411,9 @@ export interface CommonFlowApprover {
|
|
|
1390
1411
|
*/
|
|
1391
1412
|
ApproverMobile?: string;
|
|
1392
1413
|
/**
|
|
1393
|
-
|
|
1414
|
+
* 签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId
|
|
1394
1415
|
注意:模板发起时该字段必填
|
|
1395
|
-
|
|
1416
|
+
*/
|
|
1396
1417
|
RecipientId?: string;
|
|
1397
1418
|
/**
|
|
1398
1419
|
* 签署前置条件:阅读时长限制,不传默认10s,最大300s,最小3s
|
|
@@ -1486,6 +1507,7 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
|
|
|
1486
1507
|
QrCodeId: string;
|
|
1487
1508
|
/**
|
|
1488
1509
|
* 暂未开放
|
|
1510
|
+
* @deprecated
|
|
1489
1511
|
*/
|
|
1490
1512
|
Operator?: UserInfo;
|
|
1491
1513
|
}
|
|
@@ -1498,10 +1520,10 @@ export interface UploadFilesRequest {
|
|
|
1498
1520
|
*/
|
|
1499
1521
|
Agent: Agent;
|
|
1500
1522
|
/**
|
|
1501
|
-
|
|
1523
|
+
* 文件对应业务类型
|
|
1502
1524
|
1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
|
|
1503
1525
|
2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
|
|
1504
|
-
|
|
1526
|
+
*/
|
|
1505
1527
|
BusinessType: string;
|
|
1506
1528
|
/**
|
|
1507
1529
|
* 上传文件内容数组,最多支持20个文件
|
|
@@ -1509,6 +1531,7 @@ export interface UploadFilesRequest {
|
|
|
1509
1531
|
FileInfos?: Array<UploadFile>;
|
|
1510
1532
|
/**
|
|
1511
1533
|
* 操作者的信息
|
|
1534
|
+
* @deprecated
|
|
1512
1535
|
*/
|
|
1513
1536
|
Operator?: UserInfo;
|
|
1514
1537
|
}
|
|
@@ -1537,14 +1560,14 @@ export interface ChannelDescribeOrganizationSealsRequest {
|
|
|
1537
1560
|
*/
|
|
1538
1561
|
SealId?: string;
|
|
1539
1562
|
/**
|
|
1540
|
-
|
|
1563
|
+
* 印章类型列表(都是组织机构印章)。
|
|
1541
1564
|
为空时查询所有类型的印章。
|
|
1542
1565
|
目前支持以下类型:
|
|
1543
1566
|
OFFICIAL:企业公章;
|
|
1544
1567
|
CONTRACT:合同专用章;
|
|
1545
1568
|
ORGANIZATION_SEAL:企业印章(图片上传创建);
|
|
1546
1569
|
LEGAL_PERSON_SEAL:法定代表人章
|
|
1547
|
-
|
|
1570
|
+
*/
|
|
1548
1571
|
SealTypes?: Array<string>;
|
|
1549
1572
|
}
|
|
1550
1573
|
/**
|
|
@@ -1560,15 +1583,15 @@ export interface DescribeUsageRequest {
|
|
|
1560
1583
|
*/
|
|
1561
1584
|
StartDate: string;
|
|
1562
1585
|
/**
|
|
1563
|
-
|
|
1586
|
+
* 结束时间,例如:2021-06-21;
|
|
1564
1587
|
开始时间到结束时间的区间长度小于等于90天。
|
|
1565
|
-
|
|
1588
|
+
*/
|
|
1566
1589
|
EndDate: string;
|
|
1567
1590
|
/**
|
|
1568
|
-
|
|
1591
|
+
* 是否汇总数据,默认不汇总。
|
|
1569
1592
|
不汇总:返回在统计区间内第三方平台下所有企业的每日明细,即每个企业N条数据,N为统计天数;
|
|
1570
1593
|
汇总:返回在统计区间内第三方平台下所有企业的汇总后数据,即每个企业一条数据;
|
|
1571
|
-
|
|
1594
|
+
*/
|
|
1572
1595
|
NeedAggregate?: boolean;
|
|
1573
1596
|
/**
|
|
1574
1597
|
* 单次返回的最多条目数量。默认为1000,且不能超过1000。
|
|
@@ -1580,6 +1603,7 @@ export interface DescribeUsageRequest {
|
|
|
1580
1603
|
Offset?: number;
|
|
1581
1604
|
/**
|
|
1582
1605
|
* 暂未开放
|
|
1606
|
+
* @deprecated
|
|
1583
1607
|
*/
|
|
1584
1608
|
Operator?: UserInfo;
|
|
1585
1609
|
}
|
|
@@ -1588,11 +1612,11 @@ export interface DescribeUsageRequest {
|
|
|
1588
1612
|
*/
|
|
1589
1613
|
export interface DescribeExtendedServiceAuthInfoRequest {
|
|
1590
1614
|
/**
|
|
1591
|
-
|
|
1615
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
|
|
1592
1616
|
|
|
1593
1617
|
注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
|
|
1594
1618
|
|
|
1595
|
-
|
|
1619
|
+
*/
|
|
1596
1620
|
Agent: Agent;
|
|
1597
1621
|
}
|
|
1598
1622
|
/**
|
|
@@ -1600,25 +1624,25 @@ export interface DescribeExtendedServiceAuthInfoRequest {
|
|
|
1600
1624
|
*/
|
|
1601
1625
|
export interface FormField {
|
|
1602
1626
|
/**
|
|
1603
|
-
|
|
1627
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
1604
1628
|
TEXT - 文本内容
|
|
1605
1629
|
MULTI_LINE_TEXT - 文本内容
|
|
1606
1630
|
CHECK_BOX - true/false
|
|
1607
1631
|
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
1608
1632
|
SELECTOR - 选项值
|
|
1609
1633
|
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo
|
|
1610
|
-
|
|
1634
|
+
*/
|
|
1611
1635
|
ComponentValue: string;
|
|
1612
1636
|
/**
|
|
1613
|
-
|
|
1637
|
+
* 表单域或控件的ID,跟ComponentName二选一,不能全为空;
|
|
1614
1638
|
CreateFlowsByTemplates 接口不使用此字段。
|
|
1615
1639
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1616
|
-
|
|
1640
|
+
*/
|
|
1617
1641
|
ComponentId?: string;
|
|
1618
1642
|
/**
|
|
1619
|
-
|
|
1643
|
+
* 控件的名字,跟ComponentId二选一,不能全为空
|
|
1620
1644
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1621
|
-
|
|
1645
|
+
*/
|
|
1622
1646
|
ComponentName?: string;
|
|
1623
1647
|
}
|
|
1624
1648
|
/**
|
|
@@ -1783,11 +1807,11 @@ export interface FlowInfo {
|
|
|
1783
1807
|
*/
|
|
1784
1808
|
CcInfos?: Array<CcInfo>;
|
|
1785
1809
|
/**
|
|
1786
|
-
|
|
1810
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。
|
|
1787
1811
|
若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
1788
1812
|
|
|
1789
1813
|
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
1790
|
-
|
|
1814
|
+
*/
|
|
1791
1815
|
NeedSignReview?: boolean;
|
|
1792
1816
|
/**
|
|
1793
1817
|
* 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
|
|
@@ -1808,18 +1832,22 @@ export interface UserInfo {
|
|
|
1808
1832
|
OpenId?: string;
|
|
1809
1833
|
/**
|
|
1810
1834
|
* 内部参数,暂未开放使用
|
|
1835
|
+
* @deprecated
|
|
1811
1836
|
*/
|
|
1812
1837
|
Channel?: string;
|
|
1813
1838
|
/**
|
|
1814
1839
|
* 内部参数,暂未开放使用
|
|
1840
|
+
* @deprecated
|
|
1815
1841
|
*/
|
|
1816
1842
|
CustomUserId?: string;
|
|
1817
1843
|
/**
|
|
1818
1844
|
* 内部参数,暂未开放使用
|
|
1845
|
+
* @deprecated
|
|
1819
1846
|
*/
|
|
1820
1847
|
ClientIp?: string;
|
|
1821
1848
|
/**
|
|
1822
1849
|
* 内部参数,暂未开放使用
|
|
1850
|
+
* @deprecated
|
|
1823
1851
|
*/
|
|
1824
1852
|
ProxyIp?: string;
|
|
1825
1853
|
}
|
|
@@ -1828,14 +1856,14 @@ export interface UserInfo {
|
|
|
1828
1856
|
*/
|
|
1829
1857
|
export interface TaskInfo {
|
|
1830
1858
|
/**
|
|
1831
|
-
|
|
1859
|
+
* 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
|
|
1832
1860
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1833
|
-
|
|
1861
|
+
*/
|
|
1834
1862
|
TaskId: string;
|
|
1835
1863
|
/**
|
|
1836
|
-
|
|
1864
|
+
* 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
|
|
1837
1865
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1838
|
-
|
|
1866
|
+
*/
|
|
1839
1867
|
TaskStatus: string;
|
|
1840
1868
|
}
|
|
1841
1869
|
/**
|
|
@@ -1847,9 +1875,9 @@ export interface DescribeUsageResponse {
|
|
|
1847
1875
|
*/
|
|
1848
1876
|
Total?: number;
|
|
1849
1877
|
/**
|
|
1850
|
-
|
|
1878
|
+
* 用量明细
|
|
1851
1879
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1852
|
-
|
|
1880
|
+
*/
|
|
1853
1881
|
Details?: Array<UsageDetail>;
|
|
1854
1882
|
/**
|
|
1855
1883
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1873,24 +1901,24 @@ export interface Staff {
|
|
|
1873
1901
|
*/
|
|
1874
1902
|
Mobile: string;
|
|
1875
1903
|
/**
|
|
1876
|
-
|
|
1904
|
+
* 员工邮箱
|
|
1877
1905
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1878
|
-
|
|
1906
|
+
*/
|
|
1879
1907
|
Email: string;
|
|
1880
1908
|
/**
|
|
1881
|
-
|
|
1909
|
+
* 员工在第三方应用平台的用户ID
|
|
1882
1910
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1883
|
-
|
|
1911
|
+
*/
|
|
1884
1912
|
OpenId: string;
|
|
1885
1913
|
/**
|
|
1886
|
-
|
|
1914
|
+
* 员工角色
|
|
1887
1915
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1888
|
-
|
|
1916
|
+
*/
|
|
1889
1917
|
Roles: Array<StaffRole>;
|
|
1890
1918
|
/**
|
|
1891
|
-
|
|
1919
|
+
* 员工部门
|
|
1892
1920
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1893
|
-
|
|
1921
|
+
*/
|
|
1894
1922
|
Department: Department;
|
|
1895
1923
|
/**
|
|
1896
1924
|
* 员工是否实名
|
|
@@ -1914,9 +1942,9 @@ export interface Staff {
|
|
|
1914
1942
|
*/
|
|
1915
1943
|
export interface ChannelCreateBoundFlowsRequest {
|
|
1916
1944
|
/**
|
|
1917
|
-
|
|
1945
|
+
* 应用信息
|
|
1918
1946
|
此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
|
|
1919
|
-
|
|
1947
|
+
*/
|
|
1920
1948
|
Agent: Agent;
|
|
1921
1949
|
/**
|
|
1922
1950
|
* 领取的合同id列表
|
|
@@ -1924,6 +1952,7 @@ export interface ChannelCreateBoundFlowsRequest {
|
|
|
1924
1952
|
FlowIds?: Array<string>;
|
|
1925
1953
|
/**
|
|
1926
1954
|
* 暂未开放
|
|
1955
|
+
* @deprecated
|
|
1927
1956
|
*/
|
|
1928
1957
|
Operator?: UserInfo;
|
|
1929
1958
|
}
|
|
@@ -1940,10 +1969,10 @@ export interface ChannelDescribeEmployeesRequest {
|
|
|
1940
1969
|
*/
|
|
1941
1970
|
Agent?: Agent;
|
|
1942
1971
|
/**
|
|
1943
|
-
|
|
1972
|
+
* 查询过滤实名用户,Key为Status,Values为["IsVerified"]
|
|
1944
1973
|
根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
|
|
1945
1974
|
查询离职员工时,Key为Status,Values为["QuiteJob"]
|
|
1946
|
-
|
|
1975
|
+
*/
|
|
1947
1976
|
Filters?: Array<Filter>;
|
|
1948
1977
|
/**
|
|
1949
1978
|
* 偏移量,默认为0,最大为20000
|
|
@@ -1951,6 +1980,7 @@ export interface ChannelDescribeEmployeesRequest {
|
|
|
1951
1980
|
Offset?: number;
|
|
1952
1981
|
/**
|
|
1953
1982
|
* 暂未开放
|
|
1983
|
+
* @deprecated
|
|
1954
1984
|
*/
|
|
1955
1985
|
Operator?: UserInfo;
|
|
1956
1986
|
}
|
|
@@ -1994,6 +2024,7 @@ export interface SyncProxyOrganizationOperatorsRequest {
|
|
|
1994
2024
|
ProxyOrganizationOperators: Array<ProxyOrganizationOperator>;
|
|
1995
2025
|
/**
|
|
1996
2026
|
* 暂未开放
|
|
2027
|
+
* @deprecated
|
|
1997
2028
|
*/
|
|
1998
2029
|
Operator?: UserInfo;
|
|
1999
2030
|
}
|
|
@@ -2018,13 +2049,13 @@ export interface CreateSignUrlsRequest {
|
|
|
2018
2049
|
*/
|
|
2019
2050
|
Endpoint?: string;
|
|
2020
2051
|
/**
|
|
2021
|
-
|
|
2052
|
+
* 签署链接生成类型,默认是 "ALL";
|
|
2022
2053
|
"ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
|
|
2023
2054
|
"CHANNEL":第三方平台子客企业企业;
|
|
2024
2055
|
"NOT_CHANNEL":非第三方平台子客企业企业;
|
|
2025
2056
|
"PERSON":个人;
|
|
2026
2057
|
"FOLLOWER":关注方,目前是合同抄送方;
|
|
2027
|
-
|
|
2058
|
+
*/
|
|
2028
2059
|
GenerateType?: string;
|
|
2029
2060
|
/**
|
|
2030
2061
|
* 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
|
|
@@ -2035,9 +2066,9 @@ export interface CreateSignUrlsRequest {
|
|
|
2035
2066
|
*/
|
|
2036
2067
|
Name?: string;
|
|
2037
2068
|
/**
|
|
2038
|
-
|
|
2069
|
+
* 参与人手机号;
|
|
2039
2070
|
GenerateType为"PERSON"或"FOLLOWER"时必填
|
|
2040
|
-
|
|
2071
|
+
*/
|
|
2041
2072
|
Mobile?: string;
|
|
2042
2073
|
/**
|
|
2043
2074
|
* 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
|
|
@@ -2057,6 +2088,7 @@ export interface CreateSignUrlsRequest {
|
|
|
2057
2088
|
JumpUrl?: string;
|
|
2058
2089
|
/**
|
|
2059
2090
|
* 暂未开放
|
|
2091
|
+
* @deprecated
|
|
2060
2092
|
*/
|
|
2061
2093
|
Operator?: UserInfo;
|
|
2062
2094
|
}
|
|
@@ -2065,9 +2097,9 @@ export interface CreateSignUrlsRequest {
|
|
|
2065
2097
|
*/
|
|
2066
2098
|
export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
2067
2099
|
/**
|
|
2068
|
-
|
|
2100
|
+
* 应用相关信息。
|
|
2069
2101
|
此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
|
|
2070
|
-
|
|
2102
|
+
*/
|
|
2071
2103
|
Agent: Agent;
|
|
2072
2104
|
/**
|
|
2073
2105
|
* 模版ID
|
|
@@ -2094,17 +2126,19 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
2094
2126
|
*/
|
|
2095
2127
|
Restrictions?: Array<ApproverRestriction>;
|
|
2096
2128
|
/**
|
|
2097
|
-
|
|
2129
|
+
* 回调地址,最大长度1000个字符
|
|
2098
2130
|
不传默认使用第三方应用号配置的回调地址
|
|
2099
2131
|
回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
|
2100
|
-
|
|
2132
|
+
*/
|
|
2101
2133
|
CallbackUrl?: string;
|
|
2102
2134
|
/**
|
|
2103
2135
|
* 限制二维码用户条件(已弃用)
|
|
2136
|
+
* @deprecated
|
|
2104
2137
|
*/
|
|
2105
2138
|
ApproverRestrictions?: ApproverRestriction;
|
|
2106
2139
|
/**
|
|
2107
2140
|
* 暂未开放
|
|
2141
|
+
* @deprecated
|
|
2108
2142
|
*/
|
|
2109
2143
|
Operator?: UserInfo;
|
|
2110
2144
|
}
|
|
@@ -2144,11 +2178,11 @@ export interface FlowApproverInfo {
|
|
|
2144
2178
|
*/
|
|
2145
2179
|
Name?: string;
|
|
2146
2180
|
/**
|
|
2147
|
-
|
|
2181
|
+
* 签署人身份证件类型
|
|
2148
2182
|
1.ID_CARD 居民身份证
|
|
2149
2183
|
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
2150
2184
|
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2151
|
-
|
|
2185
|
+
*/
|
|
2152
2186
|
IdCardType?: string;
|
|
2153
2187
|
/**
|
|
2154
2188
|
* 签署人证件号
|
|
@@ -2163,26 +2197,26 @@ export interface FlowApproverInfo {
|
|
|
2163
2197
|
*/
|
|
2164
2198
|
OrganizationName?: string;
|
|
2165
2199
|
/**
|
|
2166
|
-
|
|
2200
|
+
* 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
2167
2201
|
默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
|
|
2168
|
-
|
|
2202
|
+
*/
|
|
2169
2203
|
NotChannelOrganization?: boolean;
|
|
2170
2204
|
/**
|
|
2171
|
-
|
|
2205
|
+
* 用户侧第三方id,最大长度64个字符
|
|
2172
2206
|
当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
|
|
2173
|
-
|
|
2207
|
+
*/
|
|
2174
2208
|
OpenId?: string;
|
|
2175
2209
|
/**
|
|
2176
2210
|
* 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
2177
2211
|
*/
|
|
2178
2212
|
OrganizationOpenId?: string;
|
|
2179
2213
|
/**
|
|
2180
|
-
|
|
2214
|
+
* 签署人类型
|
|
2181
2215
|
PERSON-个人/自然人;
|
|
2182
2216
|
PERSON_AUTO_SIGN-个人自动签(定制化场景下使用);
|
|
2183
2217
|
ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
|
|
2184
2218
|
ENTERPRISESERVER-企业静默签(文件发起时的企业静默签字)。
|
|
2185
|
-
|
|
2219
|
+
*/
|
|
2186
2220
|
ApproverType?: string;
|
|
2187
2221
|
/**
|
|
2188
2222
|
* 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
|
@@ -2194,6 +2228,7 @@ export interface FlowApproverInfo {
|
|
|
2194
2228
|
Deadline?: number;
|
|
2195
2229
|
/**
|
|
2196
2230
|
* 签署完回调url,最大长度1000个字符
|
|
2231
|
+
* @deprecated
|
|
2197
2232
|
*/
|
|
2198
2233
|
CallbackUrl?: string;
|
|
2199
2234
|
/**
|
|
@@ -2201,9 +2236,9 @@ export interface FlowApproverInfo {
|
|
|
2201
2236
|
*/
|
|
2202
2237
|
SignComponents?: Array<Component>;
|
|
2203
2238
|
/**
|
|
2204
|
-
|
|
2239
|
+
* 个人签署方指定签署控件类型,目前支持:OCR_ESIGN -AI智慧手写签名
|
|
2205
2240
|
HANDWRITE -手写签名
|
|
2206
|
-
|
|
2241
|
+
*/
|
|
2207
2242
|
ComponentLimitType?: Array<string>;
|
|
2208
2243
|
/**
|
|
2209
2244
|
* 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
|
@@ -2222,20 +2257,20 @@ export interface FlowApproverInfo {
|
|
|
2222
2257
|
*/
|
|
2223
2258
|
ApproverNeedSignReview?: boolean;
|
|
2224
2259
|
/**
|
|
2225
|
-
|
|
2260
|
+
* 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
|
|
2226
2261
|
查看合同的认证方式 Flow层级的优先于approver层级的
|
|
2227
|
-
|
|
2262
|
+
*/
|
|
2228
2263
|
ApproverVerifyTypes?: Array<number>;
|
|
2229
2264
|
/**
|
|
2230
|
-
|
|
2265
|
+
* 签署人签署合同时的认证方式
|
|
2231
2266
|
1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
|
|
2232
|
-
|
|
2267
|
+
*/
|
|
2233
2268
|
ApproverSignTypes?: Array<number>;
|
|
2234
2269
|
/**
|
|
2235
|
-
|
|
2270
|
+
* 签署ID
|
|
2236
2271
|
- 发起流程时系统自动补充
|
|
2237
2272
|
- 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
|
|
2238
|
-
|
|
2273
|
+
*/
|
|
2239
2274
|
SignId?: string;
|
|
2240
2275
|
}
|
|
2241
2276
|
/**
|
|
@@ -2252,10 +2287,12 @@ export interface ChannelGetTaskResultApiRequest {
|
|
|
2252
2287
|
TaskId: string;
|
|
2253
2288
|
/**
|
|
2254
2289
|
* 操作者的信息,不用传
|
|
2290
|
+
* @deprecated
|
|
2255
2291
|
*/
|
|
2256
2292
|
Operator?: UserInfo;
|
|
2257
2293
|
/**
|
|
2258
2294
|
* 暂未开放
|
|
2295
|
+
* @deprecated
|
|
2259
2296
|
*/
|
|
2260
2297
|
Organization?: OrganizationInfo;
|
|
2261
2298
|
}
|
|
@@ -2276,7 +2313,7 @@ export interface FlowDetailInfo {
|
|
|
2276
2313
|
*/
|
|
2277
2314
|
FlowType: string;
|
|
2278
2315
|
/**
|
|
2279
|
-
|
|
2316
|
+
* 合同(流程)的状态, 状态如下
|
|
2280
2317
|
|
|
2281
2318
|
INIT 还没发起
|
|
2282
2319
|
PART 部分签署
|
|
@@ -2286,7 +2323,7 @@ export interface FlowDetailInfo {
|
|
|
2286
2323
|
CANCEL 取消
|
|
2287
2324
|
RELIEVED 解除
|
|
2288
2325
|
|
|
2289
|
-
|
|
2326
|
+
*/
|
|
2290
2327
|
FlowStatus: string;
|
|
2291
2328
|
/**
|
|
2292
2329
|
* 合同(流程)的信息
|
|
@@ -2330,18 +2367,18 @@ export interface CreateFlowsByTemplatesResponse {
|
|
|
2330
2367
|
*/
|
|
2331
2368
|
CustomerData?: Array<string>;
|
|
2332
2369
|
/**
|
|
2333
|
-
|
|
2370
|
+
* 创建消息,对应多个合同ID,
|
|
2334
2371
|
成功为“”,创建失败则对应失败消息
|
|
2335
|
-
|
|
2372
|
+
*/
|
|
2336
2373
|
ErrorMessages?: Array<string>;
|
|
2337
2374
|
/**
|
|
2338
2375
|
* 预览模式下返回的预览文件url数组
|
|
2339
2376
|
*/
|
|
2340
2377
|
PreviewUrls?: Array<string>;
|
|
2341
2378
|
/**
|
|
2342
|
-
|
|
2379
|
+
* 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
|
|
2343
2380
|
如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
|
|
2344
|
-
|
|
2381
|
+
*/
|
|
2345
2382
|
TaskInfos?: Array<TaskInfo>;
|
|
2346
2383
|
/**
|
|
2347
2384
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2362,6 +2399,7 @@ export interface DescribeChannelFlowEvidenceReportRequest {
|
|
|
2362
2399
|
ReportId: string;
|
|
2363
2400
|
/**
|
|
2364
2401
|
* 暂未开放
|
|
2402
|
+
* @deprecated
|
|
2365
2403
|
*/
|
|
2366
2404
|
Operator?: UserInfo;
|
|
2367
2405
|
}
|
|
@@ -2370,16 +2408,16 @@ export interface DescribeChannelFlowEvidenceReportRequest {
|
|
|
2370
2408
|
*/
|
|
2371
2409
|
export interface SyncProxyOrganizationOperatorsResponse {
|
|
2372
2410
|
/**
|
|
2373
|
-
|
|
2411
|
+
* Status 同步状态,全部同步失败接口会直接报错
|
|
2374
2412
|
1-成功
|
|
2375
2413
|
2-部分成功
|
|
2376
2414
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2377
|
-
|
|
2415
|
+
*/
|
|
2378
2416
|
Status?: number;
|
|
2379
2417
|
/**
|
|
2380
|
-
|
|
2418
|
+
* 同步失败经办人及其失败原因
|
|
2381
2419
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2382
|
-
|
|
2420
|
+
*/
|
|
2383
2421
|
FailedList?: Array<SyncFailReason>;
|
|
2384
2422
|
/**
|
|
2385
2423
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2391,14 +2429,14 @@ export interface SyncProxyOrganizationOperatorsResponse {
|
|
|
2391
2429
|
*/
|
|
2392
2430
|
export interface FailedCreateRoleData {
|
|
2393
2431
|
/**
|
|
2394
|
-
|
|
2432
|
+
* 用户userId
|
|
2395
2433
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2396
|
-
|
|
2434
|
+
*/
|
|
2397
2435
|
UserId?: string;
|
|
2398
2436
|
/**
|
|
2399
|
-
|
|
2437
|
+
* 角色RoleId列表
|
|
2400
2438
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2401
|
-
|
|
2439
|
+
*/
|
|
2402
2440
|
RoleIds?: Array<string>;
|
|
2403
2441
|
}
|
|
2404
2442
|
/**
|
|
@@ -2406,14 +2444,14 @@ export interface FailedCreateRoleData {
|
|
|
2406
2444
|
*/
|
|
2407
2445
|
export interface FlowResourceUrlInfo {
|
|
2408
2446
|
/**
|
|
2409
|
-
|
|
2447
|
+
* 流程对应Id
|
|
2410
2448
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2411
|
-
|
|
2449
|
+
*/
|
|
2412
2450
|
FlowId: string;
|
|
2413
2451
|
/**
|
|
2414
|
-
|
|
2452
|
+
* 流程对应资源链接信息数组
|
|
2415
2453
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2416
|
-
|
|
2454
|
+
*/
|
|
2417
2455
|
ResourceUrlInfos: Array<ResourceUrlInfo>;
|
|
2418
2456
|
}
|
|
2419
2457
|
/**
|
|
@@ -2434,33 +2472,33 @@ export interface UploadFile {
|
|
|
2434
2472
|
*/
|
|
2435
2473
|
export interface ExtentServiceAuthInfo {
|
|
2436
2474
|
/**
|
|
2437
|
-
|
|
2475
|
+
* 扩展服务类型
|
|
2438
2476
|
AUTO_SIGN 企业静默签(自动签署)
|
|
2439
2477
|
OVERSEA_SIGN 企业与港澳台居民*签署合同
|
|
2440
2478
|
MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
|
|
2441
2479
|
PAGING_SEAL 骑缝章
|
|
2442
2480
|
DOWNLOAD_FLOW 授权平台企业下载合同
|
|
2443
|
-
|
|
2481
|
+
*/
|
|
2444
2482
|
Type?: string;
|
|
2445
2483
|
/**
|
|
2446
2484
|
* 扩展服务名称
|
|
2447
2485
|
*/
|
|
2448
2486
|
Name?: string;
|
|
2449
2487
|
/**
|
|
2450
|
-
|
|
2488
|
+
* 服务状态
|
|
2451
2489
|
ENABLE 开启
|
|
2452
2490
|
DISABLE 关闭
|
|
2453
|
-
|
|
2491
|
+
*/
|
|
2454
2492
|
Status?: string;
|
|
2455
2493
|
/**
|
|
2456
|
-
|
|
2494
|
+
* 最近操作人第三方应用平台的用户openid
|
|
2457
2495
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2458
|
-
|
|
2496
|
+
*/
|
|
2459
2497
|
OperatorOpenId?: string;
|
|
2460
2498
|
/**
|
|
2461
|
-
|
|
2499
|
+
* 最近操作时间戳,单位秒
|
|
2462
2500
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2463
|
-
|
|
2501
|
+
*/
|
|
2464
2502
|
OperateOn?: number;
|
|
2465
2503
|
}
|
|
2466
2504
|
/**
|
|
@@ -2496,21 +2534,21 @@ export interface ReleasedApprover {
|
|
|
2496
2534
|
*/
|
|
2497
2535
|
ApproverNumber: number;
|
|
2498
2536
|
/**
|
|
2499
|
-
|
|
2537
|
+
* 签署人类型,目前仅支持
|
|
2500
2538
|
ORGANIZATION-企业
|
|
2501
2539
|
ENTERPRISESERVER-企业静默签
|
|
2502
|
-
|
|
2540
|
+
*/
|
|
2503
2541
|
ApproverType: string;
|
|
2504
2542
|
/**
|
|
2505
2543
|
* 签署人姓名,最大长度50个字符
|
|
2506
2544
|
*/
|
|
2507
2545
|
Name?: string;
|
|
2508
2546
|
/**
|
|
2509
|
-
|
|
2547
|
+
* 签署人身份证件类型
|
|
2510
2548
|
1.ID_CARD 居民身份证
|
|
2511
2549
|
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
2512
2550
|
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2513
|
-
|
|
2551
|
+
*/
|
|
2514
2552
|
IdCardType?: string;
|
|
2515
2553
|
/**
|
|
2516
2554
|
* 签署人证件号
|
|
@@ -2525,9 +2563,9 @@ export interface ReleasedApprover {
|
|
|
2525
2563
|
*/
|
|
2526
2564
|
OrganizationOpenId?: string;
|
|
2527
2565
|
/**
|
|
2528
|
-
|
|
2566
|
+
* 用户侧第三方id,最大长度64个字符
|
|
2529
2567
|
当签署方为同一第三方应用下的员工时,该字必传
|
|
2530
|
-
|
|
2568
|
+
*/
|
|
2531
2569
|
OpenId?: string;
|
|
2532
2570
|
}
|
|
2533
2571
|
/**
|
|
@@ -2582,6 +2620,7 @@ export interface ChannelCreateBatchCancelFlowUrlRequest {
|
|
|
2582
2620
|
FlowIds: Array<string>;
|
|
2583
2621
|
/**
|
|
2584
2622
|
* 暂未开放
|
|
2623
|
+
* @deprecated
|
|
2585
2624
|
*/
|
|
2586
2625
|
Operator?: UserInfo;
|
|
2587
2626
|
}
|
|
@@ -2624,6 +2663,7 @@ export interface PrepareFlowsRequest {
|
|
|
2624
2663
|
JumpUrl: string;
|
|
2625
2664
|
/**
|
|
2626
2665
|
* 暂未开放
|
|
2666
|
+
* @deprecated
|
|
2627
2667
|
*/
|
|
2628
2668
|
Operator?: UserInfo;
|
|
2629
2669
|
}
|
|
@@ -2632,9 +2672,9 @@ export interface PrepareFlowsRequest {
|
|
|
2632
2672
|
*/
|
|
2633
2673
|
export interface ChannelCreateFlowByFilesResponse {
|
|
2634
2674
|
/**
|
|
2635
|
-
|
|
2675
|
+
* 合同签署流程ID
|
|
2636
2676
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2637
|
-
|
|
2677
|
+
*/
|
|
2638
2678
|
FlowId?: string;
|
|
2639
2679
|
/**
|
|
2640
2680
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2710,9 +2750,9 @@ export interface ChannelDescribeRolesResponse {
|
|
|
2710
2750
|
*/
|
|
2711
2751
|
TotalCount?: number;
|
|
2712
2752
|
/**
|
|
2713
|
-
|
|
2753
|
+
* 角色信息
|
|
2714
2754
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2715
|
-
|
|
2755
|
+
*/
|
|
2716
2756
|
ChannelRoles?: Array<ChannelRole>;
|
|
2717
2757
|
/**
|
|
2718
2758
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2745,10 +2785,12 @@ export interface ChannelCreateReleaseFlowRequest {
|
|
|
2745
2785
|
CallbackUrl?: string;
|
|
2746
2786
|
/**
|
|
2747
2787
|
* 暂未开放
|
|
2788
|
+
* @deprecated
|
|
2748
2789
|
*/
|
|
2749
2790
|
Organization?: OrganizationInfo;
|
|
2750
2791
|
/**
|
|
2751
2792
|
* 暂未开放
|
|
2793
|
+
* @deprecated
|
|
2752
2794
|
*/
|
|
2753
2795
|
Operator?: UserInfo;
|
|
2754
2796
|
}
|
|
@@ -2757,14 +2799,14 @@ export interface ChannelCreateReleaseFlowRequest {
|
|
|
2757
2799
|
*/
|
|
2758
2800
|
export interface ChannelCreateFlowGroupByFilesResponse {
|
|
2759
2801
|
/**
|
|
2760
|
-
|
|
2802
|
+
* 合同组ID
|
|
2761
2803
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2762
|
-
|
|
2804
|
+
*/
|
|
2763
2805
|
FlowGroupId?: string;
|
|
2764
2806
|
/**
|
|
2765
|
-
|
|
2807
|
+
* 子合同ID列表
|
|
2766
2808
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2767
|
-
|
|
2809
|
+
*/
|
|
2768
2810
|
FlowIds?: Array<string>;
|
|
2769
2811
|
/**
|
|
2770
2812
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2819,11 +2861,11 @@ export interface ProxyOrganizationOperator {
|
|
|
2819
2861
|
*/
|
|
2820
2862
|
Name?: string;
|
|
2821
2863
|
/**
|
|
2822
|
-
|
|
2864
|
+
* 经办人身份证件类型
|
|
2823
2865
|
1.ID_CARD 居民身份证
|
|
2824
2866
|
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
2825
2867
|
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2826
|
-
|
|
2868
|
+
*/
|
|
2827
2869
|
IdCardType?: string;
|
|
2828
2870
|
/**
|
|
2829
2871
|
* 经办人证件号
|
|
@@ -2834,11 +2876,11 @@ export interface ProxyOrganizationOperator {
|
|
|
2834
2876
|
*/
|
|
2835
2877
|
Mobile?: string;
|
|
2836
2878
|
/**
|
|
2837
|
-
|
|
2879
|
+
* 默认角色,值为以下三个对应的英文:
|
|
2838
2880
|
业务管理员:admin
|
|
2839
2881
|
经办人:channel-normal-operator
|
|
2840
2882
|
业务员:channel-sales-man
|
|
2841
|
-
|
|
2883
|
+
*/
|
|
2842
2884
|
DefaultRole?: string;
|
|
2843
2885
|
}
|
|
2844
2886
|
/**
|
|
@@ -2846,12 +2888,12 @@ export interface ProxyOrganizationOperator {
|
|
|
2846
2888
|
*/
|
|
2847
2889
|
export interface ModifyExtendedServiceResponse {
|
|
2848
2890
|
/**
|
|
2849
|
-
|
|
2891
|
+
* 操作跳转链接,有效期24小时
|
|
2850
2892
|
若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
|
|
2851
2893
|
|
|
2852
2894
|
当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
|
|
2853
2895
|
返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。
|
|
2854
|
-
|
|
2896
|
+
*/
|
|
2855
2897
|
OperateUrl?: string;
|
|
2856
2898
|
/**
|
|
2857
2899
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2880,6 +2922,7 @@ export interface ChannelCreateUserRolesRequest {
|
|
|
2880
2922
|
OpenIds?: Array<string>;
|
|
2881
2923
|
/**
|
|
2882
2924
|
* 操作者信息
|
|
2925
|
+
* @deprecated
|
|
2883
2926
|
*/
|
|
2884
2927
|
Operator?: UserInfo;
|
|
2885
2928
|
}
|
|
@@ -2892,34 +2935,35 @@ export interface ChannelGetTaskResultApiResponse {
|
|
|
2892
2935
|
*/
|
|
2893
2936
|
TaskId?: string;
|
|
2894
2937
|
/**
|
|
2895
|
-
|
|
2938
|
+
* 任务状态,需要关注的状态
|
|
2896
2939
|
0 :NeedTranform - 任务已提交
|
|
2897
2940
|
4 :Processing - 文档转换中
|
|
2898
2941
|
8 :TaskEnd - 任务处理完成
|
|
2899
2942
|
-2 :DownloadFailed - 下载失败
|
|
2900
2943
|
-6 :ProcessFailed - 转换失败
|
|
2901
2944
|
-13:ProcessTimeout - 转换文件超时
|
|
2902
|
-
|
|
2945
|
+
*/
|
|
2903
2946
|
TaskStatus?: number;
|
|
2904
2947
|
/**
|
|
2905
|
-
|
|
2948
|
+
* 状态描述,需要关注的状态
|
|
2906
2949
|
NeedTranform - 任务已提交
|
|
2907
2950
|
Processing - 文档转换中
|
|
2908
2951
|
TaskEnd - 任务处理完成
|
|
2909
2952
|
DownloadFailed - 下载失败
|
|
2910
2953
|
ProcessFailed - 转换失败
|
|
2911
2954
|
ProcessTimeout - 转换文件超时
|
|
2912
|
-
|
|
2955
|
+
*/
|
|
2913
2956
|
TaskMessage?: string;
|
|
2914
2957
|
/**
|
|
2915
2958
|
* 资源Id,也是FileId,用于文件发起使用
|
|
2916
2959
|
*/
|
|
2917
2960
|
ResourceId?: string;
|
|
2918
2961
|
/**
|
|
2919
|
-
|
|
2962
|
+
* 预览文件Url,有效期30分钟
|
|
2920
2963
|
当前字段返回为空,发起的时候,将ResourceId 放入发起即可
|
|
2921
2964
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2922
|
-
|
|
2965
|
+
* @deprecated
|
|
2966
|
+
*/
|
|
2923
2967
|
PreviewUrl?: string;
|
|
2924
2968
|
/**
|
|
2925
2969
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2947,7 +2991,7 @@ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.
|
|
|
2947
2991
|
*/
|
|
2948
2992
|
export interface Component {
|
|
2949
2993
|
/**
|
|
2950
|
-
|
|
2994
|
+
* 控件编号
|
|
2951
2995
|
|
|
2952
2996
|
CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
|
|
2953
2997
|
|
|
@@ -2959,10 +3003,10 @@ export interface Component {
|
|
|
2959
3003
|
|
|
2960
3004
|
创建控件时,此值为空
|
|
2961
3005
|
查询时返回完整结构
|
|
2962
|
-
|
|
3006
|
+
*/
|
|
2963
3007
|
ComponentId?: string;
|
|
2964
3008
|
/**
|
|
2965
|
-
|
|
3009
|
+
* 如果是Component控件类型,则可选的字段为:
|
|
2966
3010
|
TEXT - 普通文本控件,输入文本字符串;
|
|
2967
3011
|
MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
|
|
2968
3012
|
CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
|
|
@@ -2983,7 +3027,7 @@ export interface Component {
|
|
|
2983
3027
|
SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
|
|
2984
3028
|
|
|
2985
3029
|
表单域的控件不能作为印章和签名控件
|
|
2986
|
-
|
|
3030
|
+
*/
|
|
2987
3031
|
ComponentType?: string;
|
|
2988
3032
|
/**
|
|
2989
3033
|
* 控件简称,不能超过30个字符
|
|
@@ -3002,21 +3046,21 @@ export interface Component {
|
|
|
3002
3046
|
*/
|
|
3003
3047
|
FileIndex?: number;
|
|
3004
3048
|
/**
|
|
3005
|
-
|
|
3049
|
+
* 控件生成的方式:
|
|
3006
3050
|
NORMAL - 普通控件
|
|
3007
3051
|
FIELD - 表单域
|
|
3008
3052
|
KEYWORD - 关键字
|
|
3009
|
-
|
|
3053
|
+
*/
|
|
3010
3054
|
GenerateMode?: string;
|
|
3011
3055
|
/**
|
|
3012
|
-
|
|
3056
|
+
* 参数控件宽度,默认100,单位px
|
|
3013
3057
|
表单域和关键字转换控件不用填
|
|
3014
|
-
|
|
3058
|
+
*/
|
|
3015
3059
|
ComponentWidth?: number;
|
|
3016
3060
|
/**
|
|
3017
|
-
|
|
3061
|
+
* 参数控件高度,默认100,单位px
|
|
3018
3062
|
表单域和关键字转换控件不用填
|
|
3019
|
-
|
|
3063
|
+
*/
|
|
3020
3064
|
ComponentHeight?: number;
|
|
3021
3065
|
/**
|
|
3022
3066
|
* 参数控件所在页码,从1开始
|
|
@@ -3031,7 +3075,7 @@ export interface Component {
|
|
|
3031
3075
|
*/
|
|
3032
3076
|
ComponentPosY?: number;
|
|
3033
3077
|
/**
|
|
3034
|
-
|
|
3078
|
+
* 参数控件样式,json格式表述
|
|
3035
3079
|
|
|
3036
3080
|
不同类型的控件会有部分非通用参数
|
|
3037
3081
|
|
|
@@ -3064,10 +3108,10 @@ export interface Component {
|
|
|
3064
3108
|
如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
|
|
3065
3109
|
特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
|
|
3066
3110
|
参数样例: "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}",
|
|
3067
|
-
|
|
3111
|
+
*/
|
|
3068
3112
|
ComponentExtra?: string;
|
|
3069
3113
|
/**
|
|
3070
|
-
|
|
3114
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
3071
3115
|
TEXT - 文本内容
|
|
3072
3116
|
MULTI_LINE_TEXT - 文本内容
|
|
3073
3117
|
CHECK_BOX - true/false
|
|
@@ -3143,13 +3187,13 @@ export interface Component {
|
|
|
3143
3187
|
|
|
3144
3188
|
学历控件:
|
|
3145
3189
|
同单行文本控件约束,填写选择值中的字符串
|
|
3146
|
-
|
|
3190
|
+
*/
|
|
3147
3191
|
ComponentValue?: string;
|
|
3148
3192
|
/**
|
|
3149
|
-
|
|
3193
|
+
* 日期签署控件的字号,默认为 12
|
|
3150
3194
|
|
|
3151
3195
|
签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
|
|
3152
|
-
|
|
3196
|
+
*/
|
|
3153
3197
|
ComponentDateFontSize?: number;
|
|
3154
3198
|
/**
|
|
3155
3199
|
* 控件所属文档的Id, 模块相关接口为空值
|
|
@@ -3168,14 +3212,14 @@ export interface Component {
|
|
|
3168
3212
|
*/
|
|
3169
3213
|
OffsetY?: number;
|
|
3170
3214
|
/**
|
|
3171
|
-
|
|
3215
|
+
* 平台企业控件ID。
|
|
3172
3216
|
如果不为空,属于平台企业预设控件;
|
|
3173
|
-
|
|
3217
|
+
*/
|
|
3174
3218
|
ChannelComponentId?: string;
|
|
3175
3219
|
/**
|
|
3176
|
-
|
|
3220
|
+
* 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
|
|
3177
3221
|
传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
|
|
3178
|
-
|
|
3222
|
+
*/
|
|
3179
3223
|
KeywordOrder?: string;
|
|
3180
3224
|
/**
|
|
3181
3225
|
* 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
|
|
@@ -3190,9 +3234,9 @@ export interface Component {
|
|
|
3190
3234
|
*/
|
|
3191
3235
|
KeywordIndexes?: Array<number>;
|
|
3192
3236
|
/**
|
|
3193
|
-
|
|
3237
|
+
* 填写提示的内容
|
|
3194
3238
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3195
|
-
|
|
3239
|
+
*/
|
|
3196
3240
|
Placeholder?: string;
|
|
3197
3241
|
}
|
|
3198
3242
|
/**
|
|
@@ -3209,6 +3253,7 @@ export interface GetDownloadFlowUrlRequest {
|
|
|
3209
3253
|
DownLoadFlows?: Array<DownloadFlowInfo>;
|
|
3210
3254
|
/**
|
|
3211
3255
|
* 操作者的信息,不用传
|
|
3256
|
+
* @deprecated
|
|
3212
3257
|
*/
|
|
3213
3258
|
Operator?: UserInfo;
|
|
3214
3259
|
}
|
|
@@ -3242,15 +3287,16 @@ export interface ChannelBatchCancelFlowsRequest {
|
|
|
3242
3287
|
*/
|
|
3243
3288
|
CancelMessage?: string;
|
|
3244
3289
|
/**
|
|
3245
|
-
|
|
3290
|
+
* 撤销理由自定义格式;选项:
|
|
3246
3291
|
0 默认格式
|
|
3247
3292
|
1 只保留身份信息:展示为【发起方】
|
|
3248
3293
|
2 保留身份信息+企业名称:展示为【发起方xxx公司】
|
|
3249
3294
|
3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
|
|
3250
|
-
|
|
3295
|
+
*/
|
|
3251
3296
|
CancelMessageFormat?: number;
|
|
3252
3297
|
/**
|
|
3253
3298
|
* 暂未开放
|
|
3299
|
+
* @deprecated
|
|
3254
3300
|
*/
|
|
3255
3301
|
Operator?: UserInfo;
|
|
3256
3302
|
}
|
|
@@ -3276,6 +3322,7 @@ export interface ChannelUpdateSealStatusRequest {
|
|
|
3276
3322
|
Reason?: string;
|
|
3277
3323
|
/**
|
|
3278
3324
|
* 操作者的信息
|
|
3325
|
+
* @deprecated
|
|
3279
3326
|
*/
|
|
3280
3327
|
Operator?: UserInfo;
|
|
3281
3328
|
}
|
|
@@ -3313,15 +3360,16 @@ export interface ChannelCancelFlowRequest {
|
|
|
3313
3360
|
*/
|
|
3314
3361
|
CancelMessage?: string;
|
|
3315
3362
|
/**
|
|
3316
|
-
|
|
3363
|
+
* 撤销理由自定义格式;选项:
|
|
3317
3364
|
0 默认格式
|
|
3318
3365
|
1 只保留身份信息:展示为【发起方】
|
|
3319
3366
|
2 保留身份信息+企业名称:展示为【发起方xxx公司】
|
|
3320
3367
|
3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
|
|
3321
|
-
|
|
3368
|
+
*/
|
|
3322
3369
|
CancelMessageFormat?: number;
|
|
3323
3370
|
/**
|
|
3324
3371
|
* 暂未开放
|
|
3372
|
+
* @deprecated
|
|
3325
3373
|
*/
|
|
3326
3374
|
Operator?: UserInfo;
|
|
3327
3375
|
}
|
|
@@ -3371,6 +3419,7 @@ export interface DescribeTemplatesRequest {
|
|
|
3371
3419
|
ChannelTemplateId?: string;
|
|
3372
3420
|
/**
|
|
3373
3421
|
* 操作者的信息
|
|
3422
|
+
* @deprecated
|
|
3374
3423
|
*/
|
|
3375
3424
|
Operator?: UserInfo;
|
|
3376
3425
|
}
|
|
@@ -3412,16 +3461,18 @@ export interface ChannelCreateSealPolicyRequest {
|
|
|
3412
3461
|
*/
|
|
3413
3462
|
SealId: string;
|
|
3414
3463
|
/**
|
|
3415
|
-
|
|
3464
|
+
* 指定待授权的用户ID数组,电子签的用户ID
|
|
3416
3465
|
可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权。
|
|
3417
|
-
|
|
3466
|
+
*/
|
|
3418
3467
|
UserIds: Array<string>;
|
|
3419
3468
|
/**
|
|
3420
3469
|
* 操作人(用户)信息,不用传
|
|
3470
|
+
* @deprecated
|
|
3421
3471
|
*/
|
|
3422
3472
|
Operator?: UserInfo;
|
|
3423
3473
|
/**
|
|
3424
3474
|
* 企业机构信息,不用传
|
|
3475
|
+
* @deprecated
|
|
3425
3476
|
*/
|
|
3426
3477
|
Organization?: OrganizationInfo;
|
|
3427
3478
|
}
|
|
@@ -3454,9 +3505,9 @@ export interface OccupiedSeal {
|
|
|
3454
3505
|
*/
|
|
3455
3506
|
SealStatus: string;
|
|
3456
3507
|
/**
|
|
3457
|
-
|
|
3508
|
+
* 审核失败原因
|
|
3458
3509
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3459
|
-
|
|
3510
|
+
*/
|
|
3460
3511
|
FailReason: string;
|
|
3461
3512
|
/**
|
|
3462
3513
|
* 印章图片url,5分钟内有效
|
|
@@ -3488,10 +3539,10 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
3488
3539
|
*/
|
|
3489
3540
|
FlowInfos: Array<FlowInfo>;
|
|
3490
3541
|
/**
|
|
3491
|
-
|
|
3542
|
+
* 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls;
|
|
3492
3543
|
预览链接有效期300秒;
|
|
3493
3544
|
同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
|
|
3494
|
-
|
|
3545
|
+
*/
|
|
3495
3546
|
NeedPreview?: boolean;
|
|
3496
3547
|
/**
|
|
3497
3548
|
* 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
|
|
@@ -3499,6 +3550,7 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
3499
3550
|
PreviewType?: number;
|
|
3500
3551
|
/**
|
|
3501
3552
|
* 操作者的信息,不用传
|
|
3553
|
+
* @deprecated
|
|
3502
3554
|
*/
|
|
3503
3555
|
Operator?: UserInfo;
|
|
3504
3556
|
}
|
|
@@ -3511,28 +3563,28 @@ export interface UsageDetail {
|
|
|
3511
3563
|
*/
|
|
3512
3564
|
ProxyOrganizationOpenId: string;
|
|
3513
3565
|
/**
|
|
3514
|
-
|
|
3566
|
+
* 子客企业名
|
|
3515
3567
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3516
|
-
|
|
3568
|
+
*/
|
|
3517
3569
|
ProxyOrganizationName: string;
|
|
3518
3570
|
/**
|
|
3519
|
-
|
|
3571
|
+
* 日期,当需要汇总数据时日期为空
|
|
3520
3572
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3521
|
-
|
|
3573
|
+
*/
|
|
3522
3574
|
Date: string;
|
|
3523
3575
|
/**
|
|
3524
3576
|
* 消耗数量
|
|
3525
3577
|
*/
|
|
3526
3578
|
Usage: number;
|
|
3527
3579
|
/**
|
|
3528
|
-
|
|
3580
|
+
* 撤回数量
|
|
3529
3581
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3530
|
-
|
|
3582
|
+
*/
|
|
3531
3583
|
Cancel: number;
|
|
3532
3584
|
/**
|
|
3533
|
-
|
|
3585
|
+
* 消耗渠道
|
|
3534
3586
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3535
|
-
|
|
3587
|
+
*/
|
|
3536
3588
|
FlowChannel: string;
|
|
3537
3589
|
}
|
|
3538
3590
|
/**
|
|
@@ -3582,6 +3634,7 @@ export interface OperateChannelTemplateRequest {
|
|
|
3582
3634
|
AuthTag?: string;
|
|
3583
3635
|
/**
|
|
3584
3636
|
* 暂未开放
|
|
3637
|
+
* @deprecated
|
|
3585
3638
|
*/
|
|
3586
3639
|
Operator?: UserInfo;
|
|
3587
3640
|
}
|
|
@@ -3590,20 +3643,20 @@ export interface OperateChannelTemplateRequest {
|
|
|
3590
3643
|
*/
|
|
3591
3644
|
export interface CreateChannelFlowEvidenceReportResponse {
|
|
3592
3645
|
/**
|
|
3593
|
-
|
|
3646
|
+
* 出证报告 ID,用于查询出证报告接口DescribeChannelFlowEvidenceReport时用到
|
|
3594
3647
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3595
|
-
|
|
3648
|
+
*/
|
|
3596
3649
|
ReportId?: string;
|
|
3597
3650
|
/**
|
|
3598
|
-
|
|
3651
|
+
* 执行中:EvidenceStatusExecuting
|
|
3599
3652
|
成功:EvidenceStatusSuccess
|
|
3600
3653
|
失败:EvidenceStatusFailed
|
|
3601
|
-
|
|
3654
|
+
*/
|
|
3602
3655
|
Status?: string;
|
|
3603
3656
|
/**
|
|
3604
|
-
|
|
3657
|
+
* 废除,字段无效
|
|
3605
3658
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3606
|
-
|
|
3659
|
+
*/
|
|
3607
3660
|
ReportUrl?: string;
|
|
3608
3661
|
/**
|
|
3609
3662
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -3619,10 +3672,10 @@ export interface SyncFailReason {
|
|
|
3619
3672
|
*/
|
|
3620
3673
|
Id: string;
|
|
3621
3674
|
/**
|
|
3622
|
-
|
|
3675
|
+
* 失败原因
|
|
3623
3676
|
例如:Id不符合规范、证件号码不合法等
|
|
3624
3677
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3625
|
-
|
|
3678
|
+
*/
|
|
3626
3679
|
Message: string;
|
|
3627
3680
|
}
|
|
3628
3681
|
/**
|
|
@@ -3630,14 +3683,14 @@ export interface SyncFailReason {
|
|
|
3630
3683
|
*/
|
|
3631
3684
|
export interface ChannelDescribeEmployeesResponse {
|
|
3632
3685
|
/**
|
|
3633
|
-
|
|
3686
|
+
* 员工数据列表
|
|
3634
3687
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3635
|
-
|
|
3688
|
+
*/
|
|
3636
3689
|
Employees?: Array<Staff>;
|
|
3637
3690
|
/**
|
|
3638
|
-
|
|
3691
|
+
* 偏移量,默认为0,最大为20000
|
|
3639
3692
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3640
|
-
|
|
3693
|
+
*/
|
|
3641
3694
|
Offset?: number;
|
|
3642
3695
|
/**
|
|
3643
3696
|
* 返回最大数量,最大为20
|
|
@@ -3670,15 +3723,15 @@ export interface ChannelCreateReleaseFlowResponse {
|
|
|
3670
3723
|
*/
|
|
3671
3724
|
export interface DescribeChannelFlowEvidenceReportResponse {
|
|
3672
3725
|
/**
|
|
3673
|
-
|
|
3726
|
+
* 出证报告 URL
|
|
3674
3727
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3675
|
-
|
|
3728
|
+
*/
|
|
3676
3729
|
ReportUrl?: string;
|
|
3677
3730
|
/**
|
|
3678
|
-
|
|
3731
|
+
* 执行中:EvidenceStatusExecuting
|
|
3679
3732
|
成功:EvidenceStatusSuccess
|
|
3680
3733
|
失败:EvidenceStatusFailed
|
|
3681
|
-
|
|
3734
|
+
*/
|
|
3682
3735
|
Status?: string;
|
|
3683
3736
|
/**
|
|
3684
3737
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -3703,6 +3756,7 @@ export interface CreateSealByImageRequest {
|
|
|
3703
3756
|
SealImage: string;
|
|
3704
3757
|
/**
|
|
3705
3758
|
* 操作者的信息
|
|
3759
|
+
* @deprecated
|
|
3706
3760
|
*/
|
|
3707
3761
|
Operator?: UserInfo;
|
|
3708
3762
|
}
|
|
@@ -3733,10 +3787,12 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
3733
3787
|
FlowApproverInfos: Array<FlowApproverInfo>;
|
|
3734
3788
|
/**
|
|
3735
3789
|
* 用户信息,暂未开放
|
|
3790
|
+
* @deprecated
|
|
3736
3791
|
*/
|
|
3737
3792
|
Operator?: UserInfo;
|
|
3738
3793
|
/**
|
|
3739
3794
|
* 机构信息,暂未开放
|
|
3795
|
+
* @deprecated
|
|
3740
3796
|
*/
|
|
3741
3797
|
Organization?: OrganizationInfo;
|
|
3742
3798
|
}
|
|
@@ -3745,9 +3801,9 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
3745
3801
|
*/
|
|
3746
3802
|
export interface DescribeExtendedServiceAuthInfoResponse {
|
|
3747
3803
|
/**
|
|
3748
|
-
|
|
3804
|
+
* 企业扩展服务授权信息
|
|
3749
3805
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3750
|
-
|
|
3806
|
+
*/
|
|
3751
3807
|
AuthInfo?: Array<ExtentServiceAuthInfo>;
|
|
3752
3808
|
/**
|
|
3753
3809
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -3776,6 +3832,7 @@ export interface ChannelCreateEmbedWebUrlRequest {
|
|
|
3776
3832
|
HiddenComponents?: boolean;
|
|
3777
3833
|
/**
|
|
3778
3834
|
* 渠道操作者信息
|
|
3835
|
+
* @deprecated
|
|
3779
3836
|
*/
|
|
3780
3837
|
Operator?: UserInfo;
|
|
3781
3838
|
}
|
|
@@ -3792,14 +3849,14 @@ export interface CcInfo {
|
|
|
3792
3849
|
*/
|
|
3793
3850
|
Name?: string;
|
|
3794
3851
|
/**
|
|
3795
|
-
|
|
3852
|
+
* 被抄送人类型
|
|
3796
3853
|
0--个人. 1--员工
|
|
3797
|
-
|
|
3854
|
+
*/
|
|
3798
3855
|
CcType?: number;
|
|
3799
3856
|
/**
|
|
3800
|
-
|
|
3857
|
+
* 被抄送人权限
|
|
3801
3858
|
0--可查看
|
|
3802
3859
|
1--可查看也可下载
|
|
3803
|
-
|
|
3860
|
+
*/
|
|
3804
3861
|
CcPermission?: number;
|
|
3805
3862
|
}
|