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