tencentcloud-sdk-nodejs 4.0.476 → 4.0.478

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.
Files changed (90) hide show
  1. package/CHANGELOG.md +595 -0
  2. package/SERVICE_CHANGELOG.md +707 -199
  3. package/package.json +1 -1
  4. package/products.md +25 -25
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_models.ts +64 -0
  7. package/src/services/apigateway/v20180808/apigateway_client.ts +18 -4
  8. package/src/services/apigateway/v20180808/apigateway_models.ts +161 -61
  9. package/src/services/cat/v20180409/cat_client.ts +18 -6
  10. package/src/services/cat/v20180409/cat_models.ts +25 -0
  11. package/src/services/ccc/v20200210/ccc_client.ts +1 -0
  12. package/src/services/ccc/v20200210/ccc_models.ts +23 -0
  13. package/src/services/cfs/v20190719/cfs_client.ts +1 -1
  14. package/src/services/cwp/v20180228/cwp_models.ts +9 -1
  15. package/src/services/dts/v20211206/dts_models.ts +2 -2
  16. package/src/services/ess/v20201111/ess_client.ts +77 -62
  17. package/src/services/ess/v20201111/ess_models.ts +1412 -1290
  18. package/src/services/essbasic/v20210526/essbasic_client.ts +86 -71
  19. package/src/services/essbasic/v20210526/essbasic_models.ts +1572 -1451
  20. package/src/services/live/v20180801/live_models.ts +36 -3
  21. package/src/services/mariadb/v20170312/mariadb_client.ts +12 -0
  22. package/src/services/mariadb/v20170312/mariadb_models.ts +25 -0
  23. package/src/services/mps/v20190612/mps_models.ts +47 -4
  24. package/src/services/ms/v20180408/ms_client.ts +8 -8
  25. package/src/services/ms/v20180408/ms_models.ts +1 -1
  26. package/src/services/ocr/v20181119/ocr_models.ts +3 -0
  27. package/src/services/redis/v20180412/redis_client.ts +1 -1
  28. package/src/services/redis/v20180412/redis_models.ts +8 -3
  29. package/src/services/tcr/v20190924/tcr_models.ts +5 -0
  30. package/src/services/tem/v20210701/tem_models.ts +12 -0
  31. package/src/services/teo/v20220901/teo_client.ts +3 -2
  32. package/src/services/teo/v20220901/teo_models.ts +110 -42
  33. package/src/services/tiia/v20190529/tiia_client.ts +26 -11
  34. package/src/services/tiia/v20190529/tiia_models.ts +79 -25
  35. package/src/services/tke/v20180525/tke_models.ts +2 -2
  36. package/src/services/vod/v20180717/vod_models.ts +10 -3
  37. package/src/services/wedata/v20210820/wedata_client.ts +1518 -451
  38. package/src/services/wedata/v20210820/wedata_models.ts +7670 -2230
  39. package/tencentcloud/common/sdk_version.d.ts +1 -1
  40. package/tencentcloud/common/sdk_version.js +1 -1
  41. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +52 -0
  42. package/tencentcloud/services/apigateway/v20180808/apigateway_client.d.ts +5 -1
  43. package/tencentcloud/services/apigateway/v20180808/apigateway_client.js +6 -0
  44. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +138 -54
  45. package/tencentcloud/services/cat/v20180409/cat_client.d.ts +7 -3
  46. package/tencentcloud/services/cat/v20180409/cat_client.js +9 -3
  47. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +22 -0
  48. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +20 -0
  49. package/tencentcloud/services/cfs/v20190719/cfs_client.d.ts +1 -1
  50. package/tencentcloud/services/cfs/v20190719/cfs_client.js +1 -1
  51. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +8 -1
  52. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +2 -2
  53. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +6 -1
  54. package/tencentcloud/services/ess/v20201111/ess_client.js +7 -0
  55. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +1249 -1147
  56. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +9 -4
  57. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +11 -4
  58. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +1454 -1353
  59. package/tencentcloud/services/live/v20180801/live_models.d.ts +32 -3
  60. package/tencentcloud/services/mariadb/v20170312/mariadb_client.d.ts +5 -1
  61. package/tencentcloud/services/mariadb/v20170312/mariadb_client.js +6 -0
  62. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +22 -0
  63. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +41 -4
  64. package/tencentcloud/services/ms/v20180408/ms_client.d.ts +8 -8
  65. package/tencentcloud/services/ms/v20180408/ms_client.js +8 -8
  66. package/tencentcloud/services/ms/v20180408/ms_models.d.ts +1 -1
  67. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +3 -0
  68. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +1 -1
  69. package/tencentcloud/services/redis/v20180412/redis_client.js +1 -1
  70. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +7 -3
  71. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +4 -0
  72. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +10 -0
  73. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +2 -2
  74. package/tencentcloud/services/teo/v20220901/teo_client.js +2 -2
  75. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +98 -41
  76. package/tencentcloud/services/tiia/v20190529/tiia_client.d.ts +12 -6
  77. package/tencentcloud/services/tiia/v20190529/tiia_client.js +14 -6
  78. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +70 -23
  79. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +2 -2
  80. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +9 -3
  81. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +446 -102
  82. package/tencentcloud/services/wedata/v20210820/wedata_client.js +688 -172
  83. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +6601 -2011
  84. package/test/apigateway.v20180808.test.js +10 -0
  85. package/test/cat.v20180409.test.js +12 -2
  86. package/test/ess.v20201111.test.js +10 -0
  87. package/test/essbasic.v20210526.test.js +12 -2
  88. package/test/mariadb.v20170312.test.js +10 -0
  89. package/test/tiia.v20190529.test.js +12 -2
  90. package/test/wedata.v20210820.test.js +955 -95
@@ -1,920 +1,871 @@
1
1
  /**
2
- * 合同文件验签单个结果结构体
2
+ * CancelFlow返回参数结构体
3
3
  */
4
- export interface PdfVerifyResult {
5
- /**
6
- * 验签结果
7
- */
8
- VerifyResult: number;
9
- /**
10
- * 签署平台
11
- */
12
- SignPlatform: string;
13
- /**
14
- * 签署人名称
15
- */
16
- SignerName: string;
17
- /**
18
- * 签署时间
19
- */
20
- SignTime: number;
4
+ export interface CancelFlowResponse {
21
5
  /**
22
- * 签名算法
6
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
23
7
  */
24
- SignAlgorithm: string;
8
+ RequestId?: string;
9
+ }
10
+ /**
11
+ * 集成版员工部门信息
12
+ */
13
+ export interface Department {
25
14
  /**
26
- * 签名证书序列号
15
+ * 部门id
27
16
  */
28
- CertSn: string;
17
+ DepartmentId: string;
29
18
  /**
30
- * 证书起始时间
19
+ * 部门名称
31
20
  */
32
- CertNotBefore: number;
21
+ DepartmentName: string;
22
+ }
23
+ /**
24
+ * CreateSchemeUrl请求参数结构体
25
+ */
26
+ export interface CreateSchemeUrlRequest {
33
27
  /**
34
- * 证书过期时间
28
+ * 调用方用户信息,userId 必填
35
29
  */
36
- CertNotAfter: number;
30
+ Operator: UserInfo;
37
31
  /**
38
- * 签名域横坐标
32
+ * 企业名称
39
33
  */
40
- ComponentPosX: number;
34
+ OrganizationName?: string;
41
35
  /**
42
- * 签名域纵坐标
36
+ * 姓名,最大长度50个字符
43
37
  */
44
- ComponentPosY: number;
38
+ Name?: string;
45
39
  /**
46
- * 签名域宽度
40
+ * 手机号,大陆手机号11位
47
41
  */
48
- ComponentWidth: number;
42
+ Mobile?: string;
49
43
  /**
50
- * 签名域高度
44
+ * 链接类型
45
+ HTTP:跳转电子签小程序的http_url,
46
+ APP:第三方APP或小程序跳转电子签小程序的path。
47
+ 默认为HTTP类型
51
48
  */
52
- ComponentHeight: number;
49
+ EndPoint?: string;
53
50
  /**
54
- * 签名域所在页码
51
+ * 签署流程编号 (PathType=1时必传)
55
52
  */
56
- ComponentPage: number;
57
- }
58
- /**
59
- * CancelMultiFlowSignQRCode请求参数结构体
60
- */
61
- export interface CancelMultiFlowSignQRCodeRequest {
53
+ FlowId?: string;
62
54
  /**
63
- * 用户信息
55
+ * 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
64
56
  */
65
- Operator: UserInfo;
57
+ PathType?: number;
66
58
  /**
67
- * 二维码id
59
+ * 是否自动回跳 true:是, false:否。该参数只针对"APP" 类型的签署链接有效
68
60
  */
69
- QrCodeId: string;
61
+ AutoJumpBack?: boolean;
70
62
  /**
71
- * 应用信息
63
+ * 应用相关信息
72
64
  */
73
65
  Agent?: Agent;
74
66
  }
75
67
  /**
76
- * CreateFlowEvidenceReport返回参数结构体
68
+ * CreateFlowApprovers返回参数结构体
77
69
  */
78
- export interface CreateFlowEvidenceReportResponse {
79
- /**
80
- * 出证报告 URL(有效期5分钟)
81
- */
82
- ReportUrl: string;
70
+ export interface CreateFlowApproversResponse {
83
71
  /**
84
72
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
85
73
  */
86
74
  RequestId?: string;
87
75
  }
88
76
  /**
89
- * CreateFlow请求参数结构体
77
+ * UploadFiles请求参数结构体
90
78
  */
91
- export interface CreateFlowRequest {
79
+ export interface UploadFilesRequest {
92
80
  /**
93
- * 调用方用户信息,userId 必填
81
+ * 文件对应业务类型
82
+ 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
83
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
84
+ 3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
94
85
  */
95
- Operator: UserInfo;
86
+ BusinessType: string;
96
87
  /**
97
- * 签署流程名称,最大长度200个字符
88
+ * 调用方信息
98
89
  */
99
- FlowName: string;
90
+ Caller?: Caller;
100
91
  /**
101
- * 签署流程参与者信息,最大限制50方
92
+ * 上传文件内容数组,最多支持20个文件
102
93
  */
103
- Approvers: Array<FlowCreateApprover>;
94
+ FileInfos?: Array<UploadFile>;
104
95
  /**
105
- * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
96
+ * 不再使用,上传文件链接数组,最多支持20个URL
106
97
  */
107
- FlowType?: string;
98
+ FileUrls?: string;
108
99
  /**
109
- * 客户端Token,保持接口幂等性,最大长度64个字符
100
+ * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
101
+ true--是,处理置白
102
+ false--否,不处理
110
103
  */
111
- ClientToken?: string;
104
+ CoverRect?: boolean;
112
105
  /**
113
- * 暂未开放
106
+ * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
107
+ 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
114
108
  */
115
- RelatedFlowId?: string;
109
+ FileType?: string;
116
110
  /**
117
- * 签署流程的签署截止时间。
118
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
111
+ * 用户自定义ID数组,与上传文件一一对应
119
112
  */
120
- DeadLine?: number;
113
+ CustomIds?: Array<string>;
114
+ }
115
+ /**
116
+ * CreateMultiFlowSignQRCode返回参数结构体
117
+ */
118
+ export interface CreateMultiFlowSignQRCodeResponse {
121
119
  /**
122
- * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
120
+ * 签署二维码对象
123
121
  */
124
- UserData?: string;
122
+ QrCode: SignQrCode;
125
123
  /**
126
- * 签署流程描述,最大长度1000个字符
124
+ * 签署链接对象
127
125
  */
128
- FlowDescription?: string;
126
+ SignUrls: SignUrl;
129
127
  /**
130
- * 发送类型:
131
- true:无序签
132
- false:有序签
133
- 注:默认为false(有序签),请和模板中的配置保持一致
128
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
134
129
  */
135
- Unordered?: boolean;
130
+ RequestId?: string;
131
+ }
132
+ /**
133
+ * DescribeThirdPartyAuthCode返回参数结构体
134
+ */
135
+ export interface DescribeThirdPartyAuthCodeResponse {
136
136
  /**
137
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
137
+ * 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
138
138
  */
139
- CustomShowMap?: string;
139
+ VerifyStatus: string;
140
140
  /**
141
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
142
- 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
143
-
144
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
141
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
145
142
  */
146
- NeedSignReview?: boolean;
143
+ RequestId?: string;
144
+ }
145
+ /**
146
+ * CreateIntegrationEmployees请求参数结构体
147
+ */
148
+ export interface CreateIntegrationEmployeesRequest {
147
149
  /**
148
- * 暂未开放
150
+ * 操作人信息,userId必填
149
151
  */
150
- CallbackUrl?: string;
152
+ Operator: UserInfo;
151
153
  /**
152
- * 应用相关信息
154
+ * 待创建员工的信息,Mobile和DisplayName必填
153
155
  */
154
- Agent?: Agent;
156
+ Employees: Array<Staff>;
155
157
  }
156
158
  /**
157
- * DescribeFileUrls返回参数结构体
159
+ * CreateFlowEvidenceReport请求参数结构体
158
160
  */
159
- export interface DescribeFileUrlsResponse {
161
+ export interface CreateFlowEvidenceReportRequest {
160
162
  /**
161
- * URL信息
163
+ * 调用方用户信息,userId 必填
162
164
  */
163
- FileUrls: Array<FileUrl>;
165
+ Operator: UserInfo;
164
166
  /**
165
- * URL数量
167
+ * 签署流程编号
166
168
  */
167
- TotalCount: number;
169
+ FlowId: string;
170
+ }
171
+ /**
172
+ * StartFlow返回参数结构体
173
+ */
174
+ export interface StartFlowResponse {
175
+ /**
176
+ * 返回描述,START-发起成功, REVIEW-提交审核成功,EXECUTING-已提交发起任务
177
+ */
178
+ Status: string;
168
179
  /**
169
180
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
170
181
  */
171
182
  RequestId?: string;
172
183
  }
173
184
  /**
174
- * 二期接口返回的模板的信息结构
185
+ * 集成版企业角色信息
175
186
  */
176
- export interface TemplateInfo {
187
+ export interface StaffRole {
177
188
  /**
178
- * 模板ID
189
+ * 角色id
190
+ 注意:此字段可能返回 null,表示取不到有效值。
179
191
  */
180
- TemplateId?: string;
192
+ RoleId: string;
181
193
  /**
182
- * 模板名字
194
+ * 角色名称
195
+ 注意:此字段可能返回 null,表示取不到有效值。
183
196
  */
184
- TemplateName?: string;
197
+ RoleName: string;
198
+ }
199
+ /**
200
+ * 创建流程的签署方信息
201
+ */
202
+ export interface FlowCreateApprover {
185
203
  /**
186
- * 模板描述信息
204
+ * 参与者类型:
205
+ 0:企业
206
+ 1:个人
207
+ 3:企业静默签署
208
+ 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
187
209
  */
188
- Description?: string;
210
+ ApproverType: number;
189
211
  /**
190
- * 模板关联的资源IDs
212
+ * 如果签署方为企业,需要填入企业全称
191
213
  */
192
- DocumentResourceIds?: Array<string>;
214
+ OrganizationName?: string;
193
215
  /**
194
- * 返回的文件信息结构
216
+ * 签署方经办人姓名
195
217
  */
196
- FileInfos?: Array<FileInfo>;
218
+ ApproverName?: string;
197
219
  /**
198
- * 附件关联的资源ID是
220
+ * 签署方经办人手机号码
199
221
  */
200
- AttachmentResourceIds?: Array<string>;
222
+ ApproverMobile?: string;
201
223
  /**
202
- * 签署顺序
224
+ * 签署方经办人证件类型ID_CARD 身份证
225
+ HONGKONG_AND_MACAO 港澳居民来往内地通行证
226
+ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
203
227
  */
204
- SignOrder?: Array<number>;
228
+ ApproverIdCardType?: string;
205
229
  /**
206
- * 签署参与者的信息
230
+ * 签署方经办人证件号码
207
231
  */
208
- Recipients?: Array<Recipient>;
232
+ ApproverIdCardNumber?: string;
209
233
  /**
210
- * 模板信息结构
234
+ * 签署方经办人在模板中的角色ID
211
235
  */
212
- Components?: Array<Component>;
236
+ RecipientId?: string;
213
237
  /**
214
- * 签署区模板信息结构
238
+ * 签署意愿确认渠道,WEIXINAPP:人脸识别
215
239
  */
216
- SignComponents?: Array<Component>;
217
- /**
218
- * 模板状态(-1:不可用;0:草稿态;1:正式态)
219
- */
220
- Status?: number;
221
- /**
222
- * 模板的创建人
223
- */
224
- Creator?: string;
240
+ VerifyChannel?: Array<string>;
225
241
  /**
226
- * 模板创建的时间戳(精确到秒)
242
+ * 是否发送短信,sms--短信通知,none--不通知,默认为sms;发起方=签署方时不发送短信
227
243
  */
228
- CreatedOn?: number;
244
+ NotifyType?: string;
229
245
  /**
230
- * 发起人角色信息
246
+ * 签署前置条件:是否需要阅读全文,默认为不需要
231
247
  */
232
- Promoter?: Recipient;
233
- }
234
- /**
235
- * CreateDocument返回参数结构体
236
- */
237
- export interface CreateDocumentResponse {
248
+ IsFullText?: boolean;
238
249
  /**
239
- * 签署流程电子文档ID
250
+ * 签署前置条件:阅读时长限制,单位秒,默认为不需要
240
251
  */
241
- DocumentId: string;
252
+ PreReadTime?: number;
242
253
  /**
243
- * 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
244
- 注意:此字段可能返回 null,表示取不到有效值。
254
+ * 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个。
245
255
  */
246
- PreviewFileUrl: string;
256
+ UserId?: string;
247
257
  /**
248
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
258
+ * 当前只支持true,默认为true
249
259
  */
250
- RequestId?: string;
251
- }
252
- /**
253
- * DescribeIntegrationEmployees请求参数结构体
254
- */
255
- export interface DescribeIntegrationEmployeesRequest {
260
+ Required?: boolean;
256
261
  /**
257
- * 操作人信息,userId必填
262
+ * 签署人用户来源,企微侧用户请传入:WEWORKAPP
258
263
  */
259
- Operator: UserInfo;
264
+ ApproverSource?: string;
260
265
  /**
261
- * 返回最大数量,最大为20
266
+ * 客户自定义签署人标识,64位长度,保证唯一。非企微场景不使用此字段
262
267
  */
263
- Limit: number;
268
+ CustomApproverTag?: string;
264
269
  /**
265
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
266
- 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
270
+ * 快速注册相关信息,目前暂未开放!
267
271
  */
268
- Filters?: Array<Filter>;
272
+ RegisterInfo?: RegisterInfo;
269
273
  /**
270
- * 偏移量,默认为0,最大为20000
274
+ * 签署人个性化能力值
271
275
  */
272
- Offset?: number;
276
+ ApproverOption?: ApproverOption;
273
277
  }
274
278
  /**
275
- * StartFlow请求参数结构体
279
+ * CreateConvertTaskApi请求参数结构体
276
280
  */
277
- export interface StartFlowRequest {
281
+ export interface CreateConvertTaskApiRequest {
278
282
  /**
279
- * 调用方用户信息,userId 必填
283
+ * 资源类型 取值范围doc,docx,html,excel之一
280
284
  */
281
- Operator: UserInfo;
285
+ ResourceType: string;
282
286
  /**
283
- * 签署流程编号,由CreateFlow接口返回
287
+ * 资源名称,长度限制为256字符
284
288
  */
285
- FlowId: string;
289
+ ResourceName: string;
286
290
  /**
287
- * 客户端Token,保持接口幂等性,最大长度64个字符
291
+ * 资源Id,通过UploadFiles获取
288
292
  */
289
- ClientToken?: string;
293
+ ResourceId: string;
290
294
  /**
291
- * 应用相关信息
295
+ * 操作者信息
296
+ */
297
+ Operator?: UserInfo;
298
+ /**
299
+ * 应用号信息
292
300
  */
293
301
  Agent?: Agent;
294
- }
295
- /**
296
- * CancelFlow返回参数结构体
297
- */
298
- export interface CancelFlowResponse {
299
302
  /**
300
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
303
+ * 暂未开放
301
304
  */
302
- RequestId?: string;
305
+ Organization?: OrganizationInfo;
303
306
  }
304
307
  /**
305
- * CreateDocument请求参数结构体
308
+ * 应用相关信息
306
309
  */
307
- export interface CreateDocumentRequest {
310
+ export declare type Agent = null;
311
+ /**
312
+ * 签署人详情信息
313
+ */
314
+ export interface FlowApproverDetail {
308
315
  /**
309
- * 调用方用户信息,userId 必填
316
+ * 签署人信息
317
+ 注意:此字段可能返回 null,表示取不到有效值。
310
318
  */
311
- Operator: UserInfo;
319
+ ApproveMessage?: string;
312
320
  /**
313
- * 签署流程编号,由CreateFlow接口返回
321
+ * 签署人名字
314
322
  */
315
- FlowId: string;
323
+ ApproveName: string;
316
324
  /**
317
- * 用户上传的模板ID
325
+ * 签署人的状态
326
+ 0:还没有发起
327
+ 1:流程中 没有开始处理
328
+ 2:待处理
329
+ 3:签署态
330
+ 4:拒绝态
331
+ 5:过期没人处理
332
+ 6:取消态
333
+ 7:还没有预发起
334
+ 8:待填写
335
+ 9:因为各种原因而终止
318
336
  */
319
- TemplateId: string;
337
+ ApproveStatus: number;
320
338
  /**
321
- * 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起
339
+ * 模板配置时候的签署人id,与控件绑定
322
340
  */
323
- FileNames: Array<string>;
341
+ ReceiptId: string;
324
342
  /**
325
- * 内容控件信息数组
343
+ * 客户自定义userId
344
+ 注意:此字段可能返回 null,表示取不到有效值。
326
345
  */
327
- FormFields?: Array<FormField>;
346
+ CustomUserId: string;
328
347
  /**
329
- * 是否需要生成预览文件 默认不生成;
330
- 预览链接有效期300秒;
348
+ * 签署人手机号
331
349
  */
332
- NeedPreview?: boolean;
350
+ Mobile: string;
333
351
  /**
334
- * 客户端Token,保持接口幂等性,最大长度64个字符
352
+ * 签署顺序
335
353
  */
336
- ClientToken?: string;
354
+ SignOrder: number;
337
355
  /**
338
- * 应用相关信息
356
+ * 签署人签署时间
339
357
  */
340
- Agent?: Agent;
341
- }
342
- /**
343
- * 签署人个性化能力信息
344
- */
345
- export interface ApproverOption {
358
+ ApproveTime: number;
346
359
  /**
347
- * 是否可以拒签 false-可以拒签,默认 true-不可以拒签
360
+ * 参与者类型
361
+ 注意:此字段可能返回 null,表示取不到有效值。
348
362
  */
349
- NoRefuse?: boolean;
363
+ ApproveType: string;
350
364
  /**
351
- * 是否可以转发 false-可以转发,默认 true-不可以转发
365
+ * 签署人侧用户来源
366
+ 注意:此字段可能返回 null,表示取不到有效值。
352
367
  */
353
- NoTransfer?: boolean;
354
- }
355
- /**
356
- * 集成版员工部门信息
357
- */
358
- export interface Department {
368
+ ApproverSource: string;
359
369
  /**
360
- * 部门id
370
+ * 客户自定义签署人标识
371
+ 注意:此字段可能返回 null,表示取不到有效值。
361
372
  */
362
- DepartmentId: string;
373
+ CustomApproverTag: string;
363
374
  /**
364
- * 部门名称
375
+ * 签署人企业Id
376
+ 注意:此字段可能返回 null,表示取不到有效值。
365
377
  */
366
- DepartmentName: string;
378
+ OrganizationId: string;
379
+ /**
380
+ * 签署人企业名称
381
+ 注意:此字段可能返回 null,表示取不到有效值。
382
+ */
383
+ OrganizationName: string;
367
384
  }
368
385
  /**
369
- * CreateSchemeUrl请求参数结构体
386
+ * DescribeFlowTemplates请求参数结构体
370
387
  */
371
- export interface CreateSchemeUrlRequest {
388
+ export interface DescribeFlowTemplatesRequest {
372
389
  /**
373
390
  * 调用方用户信息,userId 必填
374
391
  */
375
392
  Operator: UserInfo;
376
393
  /**
377
- * 企业名称
378
- */
379
- OrganizationName?: string;
380
- /**
381
- * 姓名,最大长度50个字符
382
- */
383
- Name?: string;
384
- /**
385
- * 手机号,大陆手机号11位
394
+ * 搜索条件,具体参考Filter结构体。本接口取值:template-id:按照【 **模板唯一标识** 】进行过滤
386
395
  */
387
- Mobile?: string;
396
+ Filters?: Array<Filter>;
388
397
  /**
389
- * 链接类型
390
- HTTP:跳转电子签小程序的http_url,
391
- APP:第三方APP或小程序跳转电子签小程序的path。
392
- 默认为HTTP类型
398
+ * 查询个数,默认20,最大200
393
399
  */
394
- EndPoint?: string;
400
+ Limit?: number;
395
401
  /**
396
- * 签署流程编号 (PathType=1时必传)
402
+ * 查询偏移位置,默认0
397
403
  */
398
- FlowId?: string;
404
+ Offset?: number;
399
405
  /**
400
- * 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
406
+ * 查询内容:0-模板列表及详情(默认),1-仅模板列表
401
407
  */
402
- PathType?: number;
408
+ ContentType?: number;
403
409
  /**
404
- * 是否自动回跳 true:是, false:否。该参数只针对"APP" 类型的签署链接有效
410
+ * 暂未开放
405
411
  */
406
- AutoJumpBack?: boolean;
412
+ GenerateSource?: number;
407
413
  /**
408
414
  * 应用相关信息
409
415
  */
410
416
  Agent?: Agent;
411
417
  }
412
418
  /**
413
- * 删除员工结果
419
+ * 二期接口返回的模板的信息结构
414
420
  */
415
- export interface DeleteStaffsResult {
421
+ export interface TemplateInfo {
416
422
  /**
417
- * 删除员工的成功数据
418
- 注意:此字段可能返回 null,表示取不到有效值。
423
+ * 模板ID
419
424
  */
420
- SuccessEmployeeData: Array<SuccessDeleteStaffData>;
425
+ TemplateId?: string;
421
426
  /**
422
- * 删除员工的失败数据
423
- 注意:此字段可能返回 null,表示取不到有效值。
427
+ * 模板名字
424
428
  */
425
- FailedEmployeeData: Array<FailedDeleteStaffData>;
426
- }
427
- /**
428
- * DescribeThirdPartyAuthCode请求参数结构体
429
- */
430
- export interface DescribeThirdPartyAuthCodeRequest {
429
+ TemplateName?: string;
431
430
  /**
432
- * 电子签小程序跳转客户小程序时携带的授权查看码
431
+ * 模板描述信息
433
432
  */
434
- AuthCode: string;
435
- }
436
- /**
437
- * 下载文件的URL信息
438
- */
439
- export interface FileUrl {
433
+ Description?: string;
440
434
  /**
441
- * 下载文件的URL
435
+ * 模板关联的资源IDs
442
436
  */
443
- Url: string;
437
+ DocumentResourceIds?: Array<string>;
444
438
  /**
445
- * 下载文件的附加信息
446
- 注意:此字段可能返回 null,表示取不到有效值。
439
+ * 返回的文件信息结构
447
440
  */
448
- Option: string;
449
- }
450
- /**
451
- * DeleteIntegrationEmployees返回参数结构体
452
- */
453
- export interface DeleteIntegrationEmployeesResponse {
441
+ FileInfos?: Array<FileInfo>;
454
442
  /**
455
- * 员工删除数据
443
+ * 附件关联的资源ID是
456
444
  */
457
- DeleteEmployeeResult: DeleteStaffsResult;
445
+ AttachmentResourceIds?: Array<string>;
458
446
  /**
459
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
447
+ * 签署顺序
460
448
  */
461
- RequestId?: string;
462
- }
463
- /**
464
- * 查询过滤条件
465
- */
466
- export interface Filter {
449
+ SignOrder?: Array<number>;
467
450
  /**
468
- * 查询过滤条件的Key
451
+ * 签署参与者的信息
469
452
  */
470
- Key: string;
453
+ Recipients?: Array<Recipient>;
471
454
  /**
472
- * 查询过滤条件的Value列表
455
+ * 模板信息结构
473
456
  */
474
- Values: Array<string>;
475
- }
476
- /**
477
- * DeleteIntegrationEmployees请求参数结构体
478
- */
479
- export interface DeleteIntegrationEmployeesRequest {
457
+ Components?: Array<Component>;
480
458
  /**
481
- * 操作人信息,userId必填
459
+ * 签署区模板信息结构
482
460
  */
483
- Operator: UserInfo;
461
+ SignComponents?: Array<Component>;
484
462
  /**
485
- * 待移除员工的信息,userId和openId二选一,必填一个
463
+ * 模板状态(-1:不可用;0:草稿态;1:正式态)
486
464
  */
487
- Employees: Array<Staff>;
488
- }
489
- /**
490
- * DescribeIntegrationEmployees返回参数结构体
491
- */
492
- export interface DescribeIntegrationEmployeesResponse {
465
+ Status?: number;
493
466
  /**
494
- * 员工数据列表
495
- 注意:此字段可能返回 null,表示取不到有效值。
467
+ * 模板的创建人
496
468
  */
497
- Employees: Array<Staff>;
469
+ Creator?: string;
498
470
  /**
499
- * 偏移量,默认为0,最大为20000
500
- 注意:此字段可能返回 null,表示取不到有效值。
471
+ * 模板创建的时间戳(精确到秒)
501
472
  */
502
- Offset: number;
473
+ CreatedOn?: number;
503
474
  /**
504
- * 返回最大数量,最大为20
475
+ * 发起人角色信息
505
476
  */
506
- Limit: number;
477
+ Promoter?: Recipient;
478
+ }
479
+ /**
480
+ * CreateDocument返回参数结构体
481
+ */
482
+ export interface CreateDocumentResponse {
507
483
  /**
508
- * 符合条件的员工数量
484
+ * 签署流程电子文档ID
509
485
  */
510
- TotalCount: number;
486
+ DocumentId: string;
511
487
  /**
512
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
488
+ * 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
489
+ 注意:此字段可能返回 null,表示取不到有效值。
513
490
  */
514
- RequestId?: string;
515
- }
516
- /**
517
- * CreateFlowApprovers返回参数结构体
518
- */
519
- export interface CreateFlowApproversResponse {
491
+ PreviewFileUrl: string;
520
492
  /**
521
493
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
522
494
  */
523
495
  RequestId?: string;
524
496
  }
525
497
  /**
526
- * DescribeFlowInfo请求参数结构体
498
+ * DescribeIntegrationEmployees请求参数结构体
527
499
  */
528
- export interface DescribeFlowInfoRequest {
500
+ export interface DescribeIntegrationEmployeesRequest {
529
501
  /**
530
- * 需要查询的流程ID列表,限制最大100个
502
+ * 操作人信息,userId必填
531
503
  */
532
- FlowIds: Array<string>;
504
+ Operator: UserInfo;
533
505
  /**
534
- * 调用方用户信息
506
+ * 返回最大数量,最大为20
535
507
  */
536
- Operator?: UserInfo;
537
- }
538
- /**
539
- * 发起流程快速注册相关信息
540
- */
541
- export interface RegisterInfo {
508
+ Limit: number;
542
509
  /**
543
- * 法人姓名
510
+ * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
511
+ 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
544
512
  */
545
- LegalName: string;
513
+ Filters?: Array<Filter>;
546
514
  /**
547
- * 社会统一信用代码
515
+ * 偏移量,默认为0,最大为20000
548
516
  */
549
- Uscc: string;
517
+ Offset?: number;
550
518
  }
551
519
  /**
552
- * CancelFlow请求参数结构体
520
+ * CreateFlow请求参数结构体
553
521
  */
554
- export interface CancelFlowRequest {
522
+ export interface CreateFlowRequest {
555
523
  /**
556
524
  * 调用方用户信息,userId 必填
557
525
  */
558
526
  Operator: UserInfo;
559
527
  /**
560
- * 签署流程id
528
+ * 签署流程名称,最大长度200个字符
561
529
  */
562
- FlowId: string;
530
+ FlowName: string;
563
531
  /**
564
- * 撤销原因,最长200个字符;
532
+ * 签署流程参与者信息,最大限制50方
565
533
  */
566
- CancelMessage: string;
534
+ Approvers: Array<FlowCreateApprover>;
567
535
  /**
568
- * 应用相关信息
536
+ * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
569
537
  */
570
- Agent?: Agent;
571
- }
572
- /**
573
- * DescribeFlowBriefs返回参数结构体
574
- */
575
- export interface DescribeFlowBriefsResponse {
538
+ FlowType?: string;
576
539
  /**
577
- * 流程列表
540
+ * 客户端Token,保持接口幂等性,最大长度64个字符
578
541
  */
579
- FlowBriefs: Array<FlowBrief>;
542
+ ClientToken?: string;
580
543
  /**
581
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
544
+ * 暂未开放
582
545
  */
583
- RequestId?: string;
584
- }
585
- /**
586
- * 模板控件信息
587
- */
588
- export interface Component {
546
+ RelatedFlowId?: string;
589
547
  /**
590
- * 如果是Component控件类型,则可选的字段为:
591
- TEXT - 普通文本控件;
592
- MULTI_LINE_TEXT - 多行文本控件;
593
- CHECK_BOX - 勾选框控件;
594
- FILL_IMAGE - 图片控件;
595
- DYNAMIC_TABLE - 动态表格控件;
596
- ATTACHMENT - 附件控件;
597
- SELECTOR - 选择器控件;
598
- DATE - 日期控件;默认是格式化为xxxx年xx月xx日
599
-
600
- 如果是SignComponent控件类型,则可选的字段为
601
- SIGN_SEAL - 签署印章控件;
602
- SIGN_DATE - 签署日期控件;
603
- DATE, 日期控件,默认是格式化为xxxx年xx月xx日
604
- SIGN_SIGNATURE - 用户签名控件;
605
- SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
606
- SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
607
-
608
- 表单域的控件不能作为印章和签名控件
548
+ * 签署流程的签署截止时间。
549
+ 值为unix时间戳,精确到秒,不传默认为当前时间一年后
609
550
  */
610
- ComponentType: string;
551
+ DeadLine?: number;
611
552
  /**
612
- * 参数控件宽度,单位pt
553
+ * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
613
554
  */
614
- ComponentWidth: number;
555
+ UserData?: string;
615
556
  /**
616
- * 参数控件高度,单位pt
557
+ * 签署流程描述,最大长度1000个字符
617
558
  */
618
- ComponentHeight: number;
559
+ FlowDescription?: string;
619
560
  /**
620
- * 参数控件所在页码,取值为:1-N
561
+ * 发送类型:
562
+ true:无序签
563
+ false:有序签
564
+ 注:默认为false(有序签),请和模板中的配置保持一致
621
565
  */
622
- ComponentPage: number;
566
+ Unordered?: boolean;
623
567
  /**
624
- * 参数控件X位置,单位pt
568
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
625
569
  */
626
- ComponentPosX: number;
570
+ CustomShowMap?: string;
627
571
  /**
628
- * 参数控件Y位置,单位pt
572
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
573
+ 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
574
+
575
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
629
576
  */
630
- ComponentPosY: number;
577
+ NeedSignReview?: boolean;
631
578
  /**
632
- * 控件所属文件的序号(模板中的resourceId排列序号,取值为:0-N)
579
+ * 暂未开放
633
580
  */
634
- FileIndex: number;
581
+ CallbackUrl?: string;
635
582
  /**
636
- * GenerateMode==KEYWORD 指定关键字
583
+ * 应用相关信息
637
584
  */
638
- ComponentId?: string;
585
+ Agent?: Agent;
586
+ }
587
+ /**
588
+ * 下载文件的URL信息
589
+ */
590
+ export interface FileUrl {
639
591
  /**
640
- * GenerateMode==FIELD 指定表单域名称
592
+ * 下载文件的URL
641
593
  */
642
- ComponentName?: string;
594
+ Url: string;
643
595
  /**
644
- * 是否必选,默认为false
596
+ * 下载文件的附加信息
597
+ 注意:此字段可能返回 null,表示取不到有效值。
645
598
  */
646
- ComponentRequired?: boolean;
599
+ Option: string;
600
+ }
601
+ /**
602
+ * DescribeThirdPartyAuthCode请求参数结构体
603
+ */
604
+ export interface DescribeThirdPartyAuthCodeRequest {
647
605
  /**
648
- * 扩展参数:
649
- ComponentType为SIGN_SIGNATURE类型可以控制签署方式
650
- {“ComponentTypeLimit”: [“xxx”]}
651
- xxx可以为:
652
- HANDWRITE – 手写签名
653
- BORDERLESS_ESIGN – 自动生成无边框腾讯体
654
- OCR_ESIGN -- AI智能识别手写签名
655
- ESIGN -- 个人印章类型
656
- 如:{“ComponentTypeLimit”: [“BORDERLESS_ESIGN”]}
606
+ * 电子签小程序跳转客户小程序时携带的授权查看码
657
607
  */
658
- ComponentExtra?: string;
608
+ AuthCode: string;
609
+ }
610
+ /**
611
+ * DescribeFlowInfo请求参数结构体
612
+ */
613
+ export interface DescribeFlowInfoRequest {
659
614
  /**
660
- * 控件关联的签署人ID
615
+ * 需要查询的流程ID列表,限制最大100个
661
616
  */
662
- ComponentRecipientId?: string;
617
+ FlowIds: Array<string>;
663
618
  /**
664
- * 控件填充vaule,ComponentType和传入值类型对应关系:
665
- TEXT - 文本内容
666
- MULTI_LINE_TEXT - 文本内容
667
- CHECK_BOX - true/false
668
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
669
- SELECTOR - 选项值
670
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
671
- DATE - 默认是格式化为xxxx年xx月xx日
672
- SIGN_SEAL - 印章ID,于控制台查询获取
673
- SIGN_PAGING_SEAL - 可以指定印章ID,于控制台查询获取
619
+ * 调用方用户信息
674
620
  */
675
- ComponentValue?: string;
621
+ Operator?: UserInfo;
622
+ }
623
+ /**
624
+ * 机构信息
625
+ */
626
+ export interface OrganizationInfo {
676
627
  /**
677
- * 是否是表单域类型,默认不存在
628
+ * 机构在平台的编号
678
629
  */
679
- IsFormType?: boolean;
630
+ OrganizationId?: string;
680
631
  /**
681
- * NORMAL 正常模式,使用坐标制定签署控件位置
682
- FIELD 表单域,需使用ComponentName指定表单域名称
683
- KEYWORD 关键字,使用ComponentId指定关键字
632
+ * 用户渠道
684
633
  */
685
- GenerateMode?: string;
634
+ Channel?: string;
686
635
  /**
687
- * 日期控件类型字号
636
+ * 用户在渠道的机构编号
688
637
  */
689
- ComponentDateFontSize?: number;
638
+ OrganizationOpenId?: string;
690
639
  /**
691
- * 指定关键字时横坐标偏移量,单位pt
640
+ * 用户真实的IP
692
641
  */
693
- OffsetX?: number;
642
+ ClientIp?: string;
694
643
  /**
695
- * 指定关键字时纵坐标偏移量,单位pt
644
+ * 机构的代理IP
696
645
  */
697
- OffsetY?: number;
646
+ ProxyIp?: string;
698
647
  }
699
648
  /**
700
- * CreateMultiFlowSignQRCode返回参数结构体
649
+ * 补充签署人信息
701
650
  */
702
- export interface CreateMultiFlowSignQRCodeResponse {
651
+ export interface FillApproverInfo {
703
652
  /**
704
- * 签署二维码对象
653
+ * 签署人签署Id
705
654
  */
706
- QrCode: SignQrCode;
655
+ RecipientId: string;
707
656
  /**
708
- * 签署链接对象
657
+ * 签署人来源
658
+ WEWORKAPP: 企业微信
709
659
  */
710
- SignUrls: SignUrl;
660
+ ApproverSource: string;
711
661
  /**
712
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
662
+ * 企业自定义账号Id
663
+ WEWORKAPP场景下指企业自有应用获取企微明文的userid
713
664
  */
714
- RequestId?: string;
665
+ CustomUserId: string;
715
666
  }
716
667
  /**
717
- * 创建流程的签署方信息
668
+ * 此结构体 (Caller) 用于描述调用方属性。
718
669
  */
719
- export interface FlowCreateApprover {
670
+ export interface Caller {
720
671
  /**
721
- * 参与者类型:
722
- 0:企业
723
- 1:个人
724
- 3:企业静默签署
725
- 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
672
+ * 应用号
726
673
  */
727
- ApproverType: number;
674
+ ApplicationId?: string;
728
675
  /**
729
- * 如果签署方为企业,需要填入企业全称
676
+ * 主机构ID
730
677
  */
731
- OrganizationName?: string;
678
+ OrganizationId?: string;
732
679
  /**
733
- * 签署方经办人姓名
680
+ * 经办人的用户ID
734
681
  */
735
- ApproverName?: string;
682
+ OperatorId?: string;
736
683
  /**
737
- * 签署方经办人手机号码
684
+ * 下属机构ID
738
685
  */
739
- ApproverMobile?: string;
686
+ SubOrganizationId?: string;
687
+ }
688
+ /**
689
+ * 合同文件验签单个结果结构体
690
+ */
691
+ export interface PdfVerifyResult {
740
692
  /**
741
- * 签署方经办人证件类型ID_CARD 身份证
742
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
743
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
693
+ * 验签结果
744
694
  */
745
- ApproverIdCardType?: string;
695
+ VerifyResult: number;
746
696
  /**
747
- * 签署方经办人证件号码
697
+ * 签署平台
748
698
  */
749
- ApproverIdCardNumber?: string;
699
+ SignPlatform: string;
750
700
  /**
751
- * 签署方经办人在模板中的角色ID
701
+ * 签署人名称
752
702
  */
753
- RecipientId?: string;
703
+ SignerName: string;
754
704
  /**
755
- * 签署意愿确认渠道,WEIXINAPP:人脸识别
705
+ * 签署时间
756
706
  */
757
- VerifyChannel?: Array<string>;
707
+ SignTime: number;
758
708
  /**
759
- * 是否发送短信,sms--短信通知,none--不通知,默认为sms;发起方=签署方时不发送短信
709
+ * 签名算法
760
710
  */
761
- NotifyType?: string;
711
+ SignAlgorithm: string;
762
712
  /**
763
- * 签署前置条件:是否需要阅读全文,默认为不需要
713
+ * 签名证书序列号
764
714
  */
765
- IsFullText?: boolean;
715
+ CertSn: string;
766
716
  /**
767
- * 签署前置条件:阅读时长限制,单位秒,默认为不需要
717
+ * 证书起始时间
768
718
  */
769
- PreReadTime?: number;
719
+ CertNotBefore: number;
770
720
  /**
771
- * 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个。
721
+ * 证书过期时间
772
722
  */
773
- UserId?: string;
723
+ CertNotAfter: number;
774
724
  /**
775
- * 当前只支持true,默认为true
725
+ * 签名域横坐标
776
726
  */
777
- Required?: boolean;
727
+ ComponentPosX: number;
778
728
  /**
779
- * 签署人用户来源,企微侧用户请传入:WEWORKAPP
729
+ * 签名域纵坐标
780
730
  */
781
- ApproverSource?: string;
731
+ ComponentPosY: number;
782
732
  /**
783
- * 客户自定义签署人标识,64位长度,保证唯一。非企微场景不使用此字段
733
+ * 签名域宽度
784
734
  */
785
- CustomApproverTag?: string;
735
+ ComponentWidth: number;
786
736
  /**
787
- * 快速注册相关信息,目前暂未开放!
737
+ * 签名域高度
788
738
  */
789
- RegisterInfo?: RegisterInfo;
739
+ ComponentHeight: number;
790
740
  /**
791
- * 签署人个性化能力值
741
+ * 签名域所在页码
792
742
  */
793
- ApproverOption?: ApproverOption;
743
+ ComponentPage: number;
794
744
  }
795
745
  /**
796
- * UploadFiles返回参数结构体
746
+ * 删除员工失败数据
797
747
  */
798
- export interface UploadFilesResponse {
748
+ export interface FailedDeleteStaffData {
799
749
  /**
800
- * 文件id数组
750
+ * 员工在电子签的userId
751
+ 注意:此字段可能返回 null,表示取不到有效值。
801
752
  */
802
- FileIds: Array<string>;
753
+ UserId: string;
803
754
  /**
804
- * 上传成功文件数量
755
+ * 员工在第三方平台的openId
756
+ 注意:此字段可能返回 null,表示取不到有效值。
805
757
  */
806
- TotalCount: number;
758
+ OpenId: string;
807
759
  /**
808
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
760
+ * 失败原因
809
761
  */
810
- RequestId?: string;
762
+ Reason: string;
811
763
  }
812
764
  /**
813
- * CreateIntegrationEmployees返回参数结构体
765
+ * CreateBatchCancelFlowUrl返回参数结构体
814
766
  */
815
- export interface CreateIntegrationEmployeesResponse {
767
+ export interface CreateBatchCancelFlowUrlResponse {
816
768
  /**
817
- * 创建员工的结果
769
+ * 批量撤回签署流程链接
818
770
  */
819
- CreateEmployeeResult: CreateStaffResult;
771
+ BatchCancelFlowUrl: string;
820
772
  /**
821
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
773
+ * 签署流程撤回失败信息
822
774
  */
823
- RequestId?: string;
824
- }
825
- /**
826
- * DescribeThirdPartyAuthCode返回参数结构体
827
- */
828
- export interface DescribeThirdPartyAuthCodeResponse {
775
+ FailMessages: Array<string>;
829
776
  /**
830
- * 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
777
+ * 签署连接过期时间字符串:年月日-时分秒
831
778
  */
832
- VerifyStatus: string;
779
+ UrlExpireOn: string;
833
780
  /**
834
781
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
835
782
  */
836
783
  RequestId?: string;
837
784
  }
838
785
  /**
839
- * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
786
+ * DescribeIntegrationEmployees返回参数结构体
840
787
  */
841
- export interface FlowDetailInfo {
788
+ export interface DescribeIntegrationEmployeesResponse {
842
789
  /**
843
- * 合同(流程)的Id
790
+ * 员工数据列表
791
+ 注意:此字段可能返回 null,表示取不到有效值。
844
792
  */
845
- FlowId: string;
793
+ Employees: Array<Staff>;
846
794
  /**
847
- * 合同(流程)的名字
795
+ * 偏移量,默认为0,最大为20000
796
+ 注意:此字段可能返回 null,表示取不到有效值。
848
797
  */
849
- FlowName: string;
798
+ Offset: number;
850
799
  /**
851
- * 合同(流程)的类型
852
- 注意:此字段可能返回 null,表示取不到有效值。
800
+ * 返回最大数量,最大为20
853
801
  */
854
- FlowType: string;
802
+ Limit: number;
855
803
  /**
856
- * 合同(流程)的状态
857
- 1:未签署
858
- 2:部分签署
859
- 3:已退回
860
- 4:完成签署
861
- 5:已过期
862
- 6:已取消
804
+ * 符合条件的员工数量
863
805
  */
864
- FlowStatus: number;
806
+ TotalCount: number;
865
807
  /**
866
- * 合同(流程)的信息
867
- 注意:此字段可能返回 null,表示取不到有效值。
808
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
868
809
  */
869
- FlowMessage: string;
810
+ RequestId?: string;
811
+ }
812
+ /**
813
+ * 删除员工的成功数据
814
+ */
815
+ export interface SuccessDeleteStaffData {
870
816
  /**
871
- * 流程的描述
872
- 注意:此字段可能返回 null,表示取不到有效值。
817
+ * 员工名
873
818
  */
874
- FlowDescription: string;
819
+ DisplayName: string;
875
820
  /**
876
- * 合同(流程)的创建时间戳
821
+ * 员工手机号
877
822
  */
878
- CreatedOn: number;
823
+ Mobile: string;
879
824
  /**
880
- * 合同(流程)的签署人数组
825
+ * 员工在电子签平台的id
881
826
  */
882
- FlowApproverInfos: Array<FlowApproverDetail>;
827
+ UserId: string;
883
828
  }
884
829
  /**
885
- * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
830
+ * CreateConvertTaskApi返回参数结构体
886
831
  */
887
- export interface UploadFile {
832
+ export interface CreateConvertTaskApiResponse {
888
833
  /**
889
- * Base64编码后的文件内容
834
+ * 转换任务Id
890
835
  */
891
- FileBody: string;
836
+ TaskId: string;
892
837
  /**
893
- * 文件名,最大长度不超过200字符
838
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
894
839
  */
895
- FileName?: string;
840
+ RequestId?: string;
896
841
  }
897
842
  /**
898
- * CreateFlowByFiles返回参数结构体
843
+ * CreateFlowSignReview请求参数结构体
899
844
  */
900
- export interface CreateFlowByFilesResponse {
845
+ export interface CreateFlowSignReviewRequest {
901
846
  /**
902
- * 签署流程编号。
903
-
904
- 注:如入参 是否需要预览 NeedPreview 设置为 true,不会正式发起合同,此处不会有值返回;如入参 是否需要预览 NeedPreview 设置为 false,此处会正常返回签署流程编号 FlowId。
847
+ * 调用方用户信息,userId 必填
848
+ */
849
+ Operator: UserInfo;
850
+ /**
851
+ * 签署流程编号
905
852
  */
906
853
  FlowId: string;
907
854
  /**
908
- * 合同预览链接。
909
-
910
- 注:如入参 是否需要预览 NeedPreview 设置为 true,会开启“预览模式”,此处会返回预览链接;如入参 是否需要预览 NeedPreview 设置为 false,此处不会有值返回。
911
- 注意:此字段可能返回 null,表示取不到有效值。
855
+ * 企业内部审核结果
856
+ PASS: 通过
857
+ REJECT: 拒绝
912
858
  */
913
- PreviewUrl: string;
859
+ ReviewType: string;
914
860
  /**
915
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
861
+ * 审核原因
862
+ 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
916
863
  */
917
- RequestId?: string;
864
+ ReviewMessage?: string;
865
+ /**
866
+ * 应用相关信息
867
+ */
868
+ Agent?: Agent;
918
869
  }
919
870
  /**
920
871
  * 创建员工的失败数据
@@ -934,108 +885,164 @@ export interface FailedCreateStaffData {
934
885
  Reason: string;
935
886
  }
936
887
  /**
937
- * DescribeFlowBriefs请求参数结构体
888
+ * CreateFlowByFiles请求参数结构体
938
889
  */
939
- export interface DescribeFlowBriefsRequest {
890
+ export interface CreateFlowByFilesRequest {
940
891
  /**
941
892
  * 调用方用户信息,userId 必填
942
893
  */
943
894
  Operator: UserInfo;
944
895
  /**
945
- * 需要查询的流程ID列表,限制最大20个
896
+ * 签署流程名称,最大长度200个字符
946
897
  */
947
- FlowIds: Array<string>;
898
+ FlowName: string;
948
899
  /**
949
- * 应用相关信息
900
+ * 签署参与者信息,最大限制50方
950
901
  */
951
- Agent?: Agent;
952
- }
953
- /**
954
- * 创建员工的成功数据
955
- */
956
- export interface SuccessCreateStaffData {
902
+ Approvers: Array<ApproverInfo>;
957
903
  /**
958
- * 员工名
904
+ * 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
959
905
  */
960
- DisplayName: string;
906
+ FileIds: Array<string>;
961
907
  /**
962
- * 员工手机号
908
+ * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
963
909
  */
964
- Mobile: string;
910
+ FlowType?: string;
965
911
  /**
966
- * 员工在电子签平台的id
912
+ * 经办人内容控件配置
967
913
  */
968
- UserId: string;
969
- }
970
- /**
971
- * 签署参与者信息
972
- */
973
- export interface Recipient {
914
+ Components?: Array<Component>;
974
915
  /**
975
- * 签署参与者ID
916
+ * 被抄送人的信息列表。
917
+ 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
976
918
  */
977
- RecipientId?: string;
919
+ CcInfos?: Array<CcInfo>;
978
920
  /**
979
- * 参与者类型(ENTERPRISE/INDIVIDUAL)
921
+ * 是否需要预览,true:预览模式,false:非预览(默认);
922
+ 预览链接有效期300秒;
923
+
924
+ 注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
980
925
  */
981
- RecipientType?: string;
926
+ NeedPreview?: boolean;
982
927
  /**
983
- * 描述信息
928
+ * 签署流程描述,最大长度1000个字符
984
929
  */
985
- Description?: string;
930
+ FlowDescription?: string;
986
931
  /**
987
- * 角色名称
932
+ * 签署流程的签署截止时间。
933
+ 值为unix时间戳,精确到秒,不传默认为当前时间一年后
988
934
  */
989
- RoleName?: string;
935
+ Deadline?: number;
990
936
  /**
991
- * 是否需要验证,默认为false
937
+ * 发送类型:
938
+ true:无序签
939
+ false:有序签
940
+ 注:默认为false(有序签)
992
941
  */
993
- RequireValidation?: boolean;
942
+ Unordered?: boolean;
994
943
  /**
995
- * 是否需要签署,默认为true
944
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
996
945
  */
997
- RequireSign?: boolean;
946
+ CustomShowMap?: string;
998
947
  /**
999
- * 添加序列
948
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
949
+ 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
950
+
951
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1000
952
  */
1001
- RoutingOrder?: number;
953
+ NeedSignReview?: boolean;
1002
954
  /**
1003
- * 是否需要发送,默认为true
955
+ * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
1004
956
  */
1005
- RequireDelivery?: boolean;
957
+ UserData?: string;
1006
958
  /**
1007
- * 邮箱地址
959
+ * 应用号信息
1008
960
  */
1009
- Email?: string;
961
+ Agent?: Agent;
1010
962
  /**
1011
- * 电话号码
963
+ * 签署人校验方式
964
+ VerifyCheck: 人脸识别(默认)
965
+ MobileCheck:手机号验证
966
+ 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
1012
967
  */
1013
- Mobile?: string;
968
+ ApproverVerifyType?: string;
969
+ }
970
+ /**
971
+ * DescribeFileUrls请求参数结构体
972
+ */
973
+ export interface DescribeFileUrlsRequest {
1014
974
  /**
1015
- * 关联的用户ID
975
+ * 调用方用户信息,UserId 必填
1016
976
  */
1017
- UserId?: string;
977
+ Operator: UserInfo;
1018
978
  /**
1019
- * 发送方式(EMAIL/MOBILE)
979
+ * 文件对应的业务类型,目前支持:
980
+ - 流程 "FLOW",如需下载合同文件请选择此项
981
+ - 模板 "TEMPLATE"
982
+ - 文档 "DOCUMENT"
983
+ - 印章 “SEAL”
1020
984
  */
1021
- DeliveryMethod?: string;
985
+ BusinessType: string;
1022
986
  /**
1023
- * 附属信息
987
+ * 业务编号的数组,如流程编号、模板编号、文档编号、印章编号。如需下载合同文件请传入FlowId
988
+ 最大支持20个资源
1024
989
  */
1025
- RecipientExtra?: string;
990
+ BusinessIds: Array<string>;
991
+ /**
992
+ * 下载后的文件命名,只有FileType为zip的时候生效
993
+ */
994
+ FileName?: string;
995
+ /**
996
+ * 文件类型,"JPG", "PDF","ZIP"等
997
+ */
998
+ FileType?: string;
999
+ /**
1000
+ * 指定资源起始偏移量,默认0
1001
+ */
1002
+ Offset?: number;
1003
+ /**
1004
+ * 指定资源数量,查询全部资源则传入-1
1005
+ */
1006
+ Limit?: number;
1007
+ /**
1008
+ * 下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)
1009
+ */
1010
+ UrlTtl?: number;
1011
+ /**
1012
+ * 暂不开放
1013
+ */
1014
+ CcToken?: string;
1015
+ /**
1016
+ * 暂不开放
1017
+ */
1018
+ Scene?: string;
1019
+ /**
1020
+ * 应用相关信息
1021
+ */
1022
+ Agent?: Agent;
1026
1023
  }
1027
1024
  /**
1028
- * VerifyPdf请求参数结构体
1025
+ * 电子文档的控件填充信息
1029
1026
  */
1030
- export interface VerifyPdfRequest {
1027
+ export interface FormField {
1031
1028
  /**
1032
- * 合同Id,流程Id
1029
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
1030
+ TEXT - 文本内容
1031
+ MULTI_LINE_TEXT - 文本内容
1032
+ CHECK_BOX - true/false
1033
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1034
+ SELECTOR - 选项值
1035
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
1033
1036
  */
1034
- FlowId: string;
1037
+ ComponentValue: string;
1035
1038
  /**
1036
- * 调用方用户信息,userId 必填
1039
+ * 控件id,和ComponentName选择一项传入即可
1037
1040
  */
1038
- Operator?: UserInfo;
1041
+ ComponentId?: string;
1042
+ /**
1043
+ * 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
1044
+ */
1045
+ ComponentName?: string;
1039
1046
  }
1040
1047
  /**
1041
1048
  * 用户信息
@@ -1063,442 +1070,464 @@ export interface UserInfo {
1063
1070
  ProxyIp?: string;
1064
1071
  }
1065
1072
  /**
1066
- * 补充签署人信息
1073
+ * CreateFlowApprovers请求参数结构体
1067
1074
  */
1068
- export interface FillApproverInfo {
1075
+ export interface CreateFlowApproversRequest {
1069
1076
  /**
1070
- * 签署人签署Id
1077
+ * 调用方用户信息,userId 必填
1071
1078
  */
1072
- RecipientId: string;
1079
+ Operator: UserInfo;
1073
1080
  /**
1074
- * 签署人来源
1075
- WEWORKAPP: 企业微信
1081
+ * 签署流程编号
1076
1082
  */
1077
- ApproverSource: string;
1083
+ FlowId: string;
1078
1084
  /**
1079
- * 企业自定义账号Id
1080
- WEWORKAPP场景下指企业自有应用获取企微明文的userid
1085
+ * 补充签署人信息
1081
1086
  */
1082
- CustomUserId: string;
1087
+ Approvers: Array<FillApproverInfo>;
1083
1088
  }
1084
1089
  /**
1085
- * 一码多扫签署二维码签署信息
1090
+ * 企业员工信息
1086
1091
  */
1087
- export interface SignUrl {
1092
+ export interface Staff {
1088
1093
  /**
1089
- * 小程序签署链接
1094
+ * 用户在电子签平台的id
1090
1095
  */
1091
- AppSignUrl: string;
1096
+ UserId?: string;
1092
1097
  /**
1093
- * 签署链接有效时间
1098
+ * 显示的用户名/昵称
1094
1099
  */
1095
- EffectiveTime: string;
1100
+ DisplayName?: string;
1096
1101
  /**
1097
- * 移动端签署链接
1102
+ * 用户手机号
1098
1103
  */
1099
- HttpSignUrl: string;
1100
- }
1101
- /**
1102
- * VerifyPdf返回参数结构体
1103
- */
1104
- export interface VerifyPdfResponse {
1104
+ Mobile?: string;
1105
1105
  /**
1106
- * 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
1106
+ * 用户邮箱
1107
+ 注意:此字段可能返回 null,表示取不到有效值。
1107
1108
  */
1108
- VerifyResult: number;
1109
+ Email?: string;
1109
1110
  /**
1110
- * 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域
1111
- ;5-文件签名格式错误
1111
+ * 用户在第三方平台id
1112
+ 注意:此字段可能返回 null,表示取不到有效值。
1112
1113
  */
1113
- PdfVerifyResults: Array<PdfVerifyResult>;
1114
+ OpenId?: string;
1114
1115
  /**
1115
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1116
+ * 员工角色
1117
+ 注意:此字段可能返回 null,表示取不到有效值。
1116
1118
  */
1117
- RequestId?: string;
1119
+ Roles?: Array<StaffRole>;
1120
+ /**
1121
+ * 员工部门
1122
+ 注意:此字段可能返回 null,表示取不到有效值。
1123
+ */
1124
+ Department?: Department;
1125
+ /**
1126
+ * 员工是否实名
1127
+ */
1128
+ Verified?: boolean;
1129
+ /**
1130
+ * 员工创建时间戳
1131
+ */
1132
+ CreatedOn?: number;
1133
+ /**
1134
+ * 员工实名时间戳
1135
+ 注意:此字段可能返回 null,表示取不到有效值。
1136
+ */
1137
+ VerifiedOn?: number;
1118
1138
  }
1119
1139
  /**
1120
- * CreateIntegrationEmployees请求参数结构体
1140
+ * CreateFlowEvidenceReport返回参数结构体
1121
1141
  */
1122
- export interface CreateIntegrationEmployeesRequest {
1142
+ export interface CreateFlowEvidenceReportResponse {
1123
1143
  /**
1124
- * 操作人信息,userId必填
1144
+ * 出证报告 URL(有效期5分钟)
1125
1145
  */
1126
- Operator: UserInfo;
1146
+ ReportUrl: string;
1127
1147
  /**
1128
- * 待创建员工的信息,Mobile和DisplayName必填
1148
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1129
1149
  */
1130
- Employees: Array<Staff>;
1150
+ RequestId?: string;
1131
1151
  }
1132
1152
  /**
1133
- * 参与者信息
1153
+ * DescribeFileUrls返回参数结构体
1134
1154
  */
1135
- export interface ApproverInfo {
1155
+ export interface DescribeFileUrlsResponse {
1136
1156
  /**
1137
- * 参与者类型:
1138
- 0:企业
1139
- 1:个人
1140
- 3:企业静默签署
1141
- 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
1157
+ * URL信息
1142
1158
  */
1143
- ApproverType: number;
1159
+ FileUrls: Array<FileUrl>;
1144
1160
  /**
1145
- * 本环节需要操作人的名字
1161
+ * URL数量
1146
1162
  */
1147
- ApproverName: string;
1163
+ TotalCount: number;
1148
1164
  /**
1149
- * 本环节需要操作人的手机号
1165
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1150
1166
  */
1151
- ApproverMobile: string;
1152
- /**
1153
- * 本环节操作人签署控件配置
1154
- */
1155
- SignComponents: Array<Component>;
1167
+ RequestId?: string;
1168
+ }
1169
+ /**
1170
+ * 授权用户
1171
+ */
1172
+ export interface AuthorizedUser {
1156
1173
  /**
1157
- * 如果是企业,则为企业的名字
1174
+ * 用户id
1158
1175
  */
1159
- OrganizationName?: string;
1176
+ UserId: string;
1177
+ }
1178
+ /**
1179
+ * CreateDocument请求参数结构体
1180
+ */
1181
+ export interface CreateDocumentRequest {
1160
1182
  /**
1161
- * 身份证号
1183
+ * 调用方用户信息,userId 必填
1162
1184
  */
1163
- ApproverIdCardNumber?: string;
1185
+ Operator: UserInfo;
1164
1186
  /**
1165
- * 证件类型
1166
- ID_CARD 身份证
1167
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
1168
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
1187
+ * 签署流程编号,由CreateFlow接口返回
1169
1188
  */
1170
- ApproverIdCardType?: string;
1189
+ FlowId: string;
1171
1190
  /**
1172
- * sms--短信,none--不通知
1191
+ * 用户上传的模板ID
1173
1192
  */
1174
- NotifyType?: string;
1193
+ TemplateId: string;
1175
1194
  /**
1176
- * 1--收款人、2--开具人、3--见证人
1195
+ * 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起
1177
1196
  */
1178
- ApproverRole?: number;
1197
+ FileNames: Array<string>;
1179
1198
  /**
1180
- * 签署意愿确认渠道,WEIXINAPP:人脸识别
1199
+ * 内容控件信息数组
1181
1200
  */
1182
- VerifyChannel?: Array<string>;
1201
+ FormFields?: Array<FormField>;
1183
1202
  /**
1184
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
1203
+ * 是否需要生成预览文件 默认不生成;
1204
+ 预览链接有效期300秒;
1185
1205
  */
1186
- PreReadTime?: number;
1206
+ NeedPreview?: boolean;
1187
1207
  /**
1188
- * 签署人userId,传此字段则不用传姓名、手机号
1208
+ * 客户端Token,保持接口幂等性,最大长度64个字符
1189
1209
  */
1190
- UserId?: string;
1210
+ ClientToken?: string;
1191
1211
  /**
1192
- * 签署人用户来源,企微侧用户请传入:WEWORKAPP
1212
+ * 应用相关信息
1193
1213
  */
1194
- ApproverSource?: string;
1214
+ Agent?: Agent;
1215
+ }
1216
+ /**
1217
+ * DescribeOrganizationSeals返回参数结构体
1218
+ */
1219
+ export interface DescribeOrganizationSealsResponse {
1195
1220
  /**
1196
- * 客户自定义签署人标识,64位长度,保证唯一,非企微场景不使用此字段
1221
+ * 在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多
1197
1222
  */
1198
- CustomApproverTag?: string;
1223
+ TotalCount: number;
1199
1224
  /**
1200
- * 签署人个性化能力值
1225
+ * 查询到的印章结果数组
1201
1226
  */
1202
- ApproverOption?: ApproverOption;
1203
- }
1204
- /**
1205
- * CreateFlowSignReview返回参数结构体
1206
- */
1207
- export interface CreateFlowSignReviewResponse {
1227
+ Seals: Array<OccupiedSeal>;
1208
1228
  /**
1209
1229
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1210
1230
  */
1211
1231
  RequestId?: string;
1212
1232
  }
1213
1233
  /**
1214
- * 此结构体 (Caller) 用于描述调用方属性。
1234
+ * DeleteIntegrationEmployees请求参数结构体
1215
1235
  */
1216
- export interface Caller {
1217
- /**
1218
- * 应用号
1219
- */
1220
- ApplicationId?: string;
1221
- /**
1222
- * 主机构ID
1223
- */
1224
- OrganizationId?: string;
1236
+ export interface DeleteIntegrationEmployeesRequest {
1225
1237
  /**
1226
- * 经办人的用户ID
1238
+ * 操作人信息,userId必填
1227
1239
  */
1228
- OperatorId?: string;
1240
+ Operator: UserInfo;
1229
1241
  /**
1230
- * 下属机构ID
1242
+ * 待移除员工的信息,userId和openId二选一,必填一个
1231
1243
  */
1232
- SubOrganizationId?: string;
1244
+ Employees: Array<Staff>;
1233
1245
  }
1234
1246
  /**
1235
- * DescribeFlowTemplates返回参数结构体
1247
+ * 一码多扫签署二维码对象
1236
1248
  */
1237
- export interface DescribeFlowTemplatesResponse {
1249
+ export interface SignQrCode {
1238
1250
  /**
1239
- * 模板详情列表
1251
+ * 二维码id
1240
1252
  */
1241
- Templates: Array<TemplateInfo>;
1253
+ QrCodeId: string;
1242
1254
  /**
1243
- * 查询到的总个数
1255
+ * 二维码url
1244
1256
  */
1245
- TotalCount: number;
1257
+ QrCodeUrl: string;
1246
1258
  /**
1247
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1259
+ * 二维码过期时间
1248
1260
  */
1249
- RequestId?: string;
1261
+ ExpiredTime: number;
1250
1262
  }
1251
1263
  /**
1252
- * 删除员工失败数据
1264
+ * GetTaskResultApi请求参数结构体
1253
1265
  */
1254
- export interface FailedDeleteStaffData {
1266
+ export interface GetTaskResultApiRequest {
1255
1267
  /**
1256
- * 员工在电子签的userId
1257
- 注意:此字段可能返回 null,表示取不到有效值。
1268
+ * 任务Id,通过CreateConvertTaskApi得到
1258
1269
  */
1259
- UserId: string;
1270
+ TaskId: string;
1260
1271
  /**
1261
- * 员工在第三方平台的openId
1262
- 注意:此字段可能返回 null,表示取不到有效值。
1272
+ * 操作人信息
1263
1273
  */
1264
- OpenId: string;
1274
+ Operator?: UserInfo;
1265
1275
  /**
1266
- * 失败原因
1276
+ * 应用号信息
1267
1277
  */
1268
- Reason: string;
1278
+ Agent?: Agent;
1279
+ /**
1280
+ * 暂未开放
1281
+ */
1282
+ Organization?: OrganizationInfo;
1269
1283
  }
1270
1284
  /**
1271
- * CreateFlowEvidenceReport请求参数结构体
1285
+ * 发起流程快速注册相关信息
1272
1286
  */
1273
- export interface CreateFlowEvidenceReportRequest {
1287
+ export interface RegisterInfo {
1274
1288
  /**
1275
- * 调用方用户信息,userId 必填
1289
+ * 法人姓名
1276
1290
  */
1277
- Operator: UserInfo;
1291
+ LegalName: string;
1278
1292
  /**
1279
- * 签署流程编号
1293
+ * 社会统一信用代码
1280
1294
  */
1281
- FlowId: string;
1295
+ Uscc: string;
1282
1296
  }
1283
1297
  /**
1284
- * CreateBatchCancelFlowUrl返回参数结构体
1298
+ * CreateIntegrationEmployees返回参数结构体
1285
1299
  */
1286
- export interface CreateBatchCancelFlowUrlResponse {
1287
- /**
1288
- * 批量撤回签署流程链接
1289
- */
1290
- BatchCancelFlowUrl: string;
1291
- /**
1292
- * 签署流程撤回失败信息
1293
- */
1294
- FailMessages: Array<string>;
1300
+ export interface CreateIntegrationEmployeesResponse {
1295
1301
  /**
1296
- * 签署连接过期时间字符串:年月日-时分秒
1302
+ * 创建员工的结果
1297
1303
  */
1298
- UrlExpireOn: string;
1304
+ CreateEmployeeResult: CreateStaffResult;
1299
1305
  /**
1300
1306
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1301
1307
  */
1302
1308
  RequestId?: string;
1303
1309
  }
1304
1310
  /**
1305
- * 创建员工的结果
1311
+ * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
1306
1312
  */
1307
- export interface CreateStaffResult {
1308
- /**
1309
- * 创建员工的成功列表
1310
- 注意:此字段可能返回 null,表示取不到有效值。
1311
- */
1312
- SuccessEmployeeData: Array<SuccessCreateStaffData>;
1313
+ export interface FlowDetailInfo {
1313
1314
  /**
1314
- * 创建员工的失败列表
1315
- 注意:此字段可能返回 null,表示取不到有效值。
1315
+ * 合同(流程)的Id
1316
1316
  */
1317
- FailedEmployeeData: Array<FailedCreateStaffData>;
1318
- }
1319
- /**
1320
- * UploadFiles请求参数结构体
1321
- */
1322
- export interface UploadFilesRequest {
1317
+ FlowId: string;
1323
1318
  /**
1324
- * 文件对应业务类型
1325
- 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
1326
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
1327
- 3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
1319
+ * 合同(流程)的名字
1328
1320
  */
1329
- BusinessType: string;
1321
+ FlowName: string;
1330
1322
  /**
1331
- * 调用方信息
1323
+ * 合同(流程)的类型
1324
+ 注意:此字段可能返回 null,表示取不到有效值。
1332
1325
  */
1333
- Caller?: Caller;
1326
+ FlowType: string;
1334
1327
  /**
1335
- * 上传文件内容数组,最多支持20个文件
1328
+ * 合同(流程)的状态
1329
+ 1:未签署
1330
+ 2:部分签署
1331
+ 3:已退回
1332
+ 4:完成签署
1333
+ 5:已过期
1334
+ 6:已取消
1336
1335
  */
1337
- FileInfos?: Array<UploadFile>;
1336
+ FlowStatus: number;
1338
1337
  /**
1339
- * 不再使用,上传文件链接数组,最多支持20个URL
1338
+ * 合同(流程)的信息
1339
+ 注意:此字段可能返回 null,表示取不到有效值。
1340
1340
  */
1341
- FileUrls?: string;
1341
+ FlowMessage: string;
1342
1342
  /**
1343
- * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
1344
- true--是,处理置白
1345
- false--否,不处理
1343
+ * 流程的描述
1344
+ 注意:此字段可能返回 null,表示取不到有效值。
1346
1345
  */
1347
- CoverRect?: boolean;
1346
+ FlowDescription: string;
1348
1347
  /**
1349
- * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
1350
- 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
1348
+ * 合同(流程)的创建时间戳
1351
1349
  */
1352
- FileType?: string;
1350
+ CreatedOn: number;
1353
1351
  /**
1354
- * 用户自定义ID数组,与上传文件一一对应
1352
+ * 合同(流程)的签署人数组
1355
1353
  */
1356
- CustomIds?: Array<string>;
1354
+ FlowApproverInfos: Array<FlowApproverDetail>;
1357
1355
  }
1358
1356
  /**
1359
- * 一码多扫签署二维码对象
1357
+ * CreateFlowByFiles返回参数结构体
1360
1358
  */
1361
- export interface SignQrCode {
1359
+ export interface CreateFlowByFilesResponse {
1362
1360
  /**
1363
- * 二维码id
1361
+ * 签署流程编号。
1362
+
1363
+ 注:如入参 是否需要预览 NeedPreview 设置为 true,不会正式发起合同,此处不会有值返回;如入参 是否需要预览 NeedPreview 设置为 false,此处会正常返回签署流程编号 FlowId。
1364
1364
  */
1365
- QrCodeId: string;
1365
+ FlowId: string;
1366
1366
  /**
1367
- * 二维码url
1367
+ * 合同预览链接。
1368
+
1369
+ 注:如入参 是否需要预览 NeedPreview 设置为 true,会开启“预览模式”,此处会返回预览链接;如入参 是否需要预览 NeedPreview 设置为 false,此处不会有值返回。
1370
+ 注意:此字段可能返回 null,表示取不到有效值。
1368
1371
  */
1369
- QrCodeUrl: string;
1372
+ PreviewUrl: string;
1370
1373
  /**
1371
- * 二维码过期时间
1374
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1372
1375
  */
1373
- ExpiredTime: number;
1376
+ RequestId?: string;
1374
1377
  }
1375
1378
  /**
1376
- * 集成版企业角色信息
1379
+ * UploadFiles返回参数结构体
1377
1380
  */
1378
- export interface StaffRole {
1381
+ export interface UploadFilesResponse {
1379
1382
  /**
1380
- * 角色id
1381
- 注意:此字段可能返回 null,表示取不到有效值。
1383
+ * 文件id数组
1382
1384
  */
1383
- RoleId: string;
1385
+ FileIds: Array<string>;
1384
1386
  /**
1385
- * 角色名称
1386
- 注意:此字段可能返回 null,表示取不到有效值。
1387
+ * 上传成功文件数量
1387
1388
  */
1388
- RoleName: string;
1389
+ TotalCount: number;
1390
+ /**
1391
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1392
+ */
1393
+ RequestId?: string;
1389
1394
  }
1390
1395
  /**
1391
- * DescribeFileUrls请求参数结构体
1396
+ * 创建员工的成功数据
1392
1397
  */
1393
- export interface DescribeFileUrlsRequest {
1398
+ export interface SuccessCreateStaffData {
1394
1399
  /**
1395
- * 调用方用户信息,UserId 必填
1400
+ * 员工名
1396
1401
  */
1397
- Operator: UserInfo;
1402
+ DisplayName: string;
1398
1403
  /**
1399
- * 文件对应的业务类型,目前支持:
1400
- - 流程 "FLOW",如需下载合同文件请选择此项
1401
- - 模板 "TEMPLATE"
1402
- - 文档 "DOCUMENT"
1403
- - 印章 “SEAL”
1404
+ * 员工手机号
1404
1405
  */
1405
- BusinessType: string;
1406
+ Mobile: string;
1406
1407
  /**
1407
- * 业务编号的数组,如流程编号、模板编号、文档编号、印章编号。如需下载合同文件请传入FlowId
1408
- 最大支持20个资源
1408
+ * 员工在电子签平台的id
1409
1409
  */
1410
- BusinessIds: Array<string>;
1410
+ UserId: string;
1411
+ }
1412
+ /**
1413
+ * 签署参与者信息
1414
+ */
1415
+ export interface Recipient {
1411
1416
  /**
1412
- * 下载后的文件命名,只有FileType为zip的时候生效
1417
+ * 签署参与者ID
1413
1418
  */
1414
- FileName?: string;
1419
+ RecipientId?: string;
1415
1420
  /**
1416
- * 文件类型,"JPG", "PDF","ZIP"等
1421
+ * 参与者类型(ENTERPRISE/INDIVIDUAL)
1417
1422
  */
1418
- FileType?: string;
1423
+ RecipientType?: string;
1419
1424
  /**
1420
- * 指定资源起始偏移量,默认0
1425
+ * 描述信息
1421
1426
  */
1422
- Offset?: number;
1427
+ Description?: string;
1423
1428
  /**
1424
- * 指定资源数量,查询全部资源则传入-1
1429
+ * 角色名称
1425
1430
  */
1426
- Limit?: number;
1431
+ RoleName?: string;
1427
1432
  /**
1428
- * 下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)
1433
+ * 是否需要验证,默认为false
1429
1434
  */
1430
- UrlTtl?: number;
1435
+ RequireValidation?: boolean;
1431
1436
  /**
1432
- * 暂不开放
1437
+ * 是否需要签署,默认为true
1433
1438
  */
1434
- CcToken?: string;
1439
+ RequireSign?: boolean;
1435
1440
  /**
1436
- * 暂不开放
1441
+ * 添加序列
1437
1442
  */
1438
- Scene?: string;
1443
+ RoutingOrder?: number;
1439
1444
  /**
1440
- * 应用相关信息
1445
+ * 是否需要发送,默认为true
1441
1446
  */
1442
- Agent?: Agent;
1443
- }
1444
- /**
1445
- * 机构信息
1446
- */
1447
- export interface OrganizationInfo {
1447
+ RequireDelivery?: boolean;
1448
1448
  /**
1449
- * 机构在平台的编号
1449
+ * 邮箱地址
1450
1450
  */
1451
- OrganizationId?: string;
1451
+ Email?: string;
1452
1452
  /**
1453
- * 用户渠道
1453
+ * 电话号码
1454
1454
  */
1455
- Channel?: string;
1455
+ Mobile?: string;
1456
1456
  /**
1457
- * 用户在渠道的机构编号
1457
+ * 关联的用户ID
1458
1458
  */
1459
- OrganizationOpenId?: string;
1459
+ UserId?: string;
1460
1460
  /**
1461
- * 用户真实的IP
1461
+ * 发送方式(EMAIL/MOBILE)
1462
1462
  */
1463
- ClientIp?: string;
1463
+ DeliveryMethod?: string;
1464
1464
  /**
1465
- * 机构的代理IP
1465
+ * 附属信息
1466
1466
  */
1467
- ProxyIp?: string;
1467
+ RecipientExtra?: string;
1468
1468
  }
1469
1469
  /**
1470
- * StartFlow返回参数结构体
1470
+ * VerifyPdf请求参数结构体
1471
1471
  */
1472
- export interface StartFlowResponse {
1472
+ export interface VerifyPdfRequest {
1473
1473
  /**
1474
- * 返回描述,START-发起成功, REVIEW-提交审核成功,EXECUTING-已提交发起任务
1474
+ * 合同Id,流程Id
1475
1475
  */
1476
- Status: string;
1476
+ FlowId: string;
1477
+ /**
1478
+ * 调用方用户信息,userId 必填
1479
+ */
1480
+ Operator?: UserInfo;
1481
+ }
1482
+ /**
1483
+ * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
1484
+ */
1485
+ export interface UploadFile {
1486
+ /**
1487
+ * Base64编码后的文件内容
1488
+ */
1489
+ FileBody: string;
1490
+ /**
1491
+ * 文件名,最大长度不超过200字符
1492
+ */
1493
+ FileName?: string;
1494
+ }
1495
+ /**
1496
+ * CreateFlowSignReview返回参数结构体
1497
+ */
1498
+ export interface CreateFlowSignReviewResponse {
1477
1499
  /**
1478
1500
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1479
1501
  */
1480
1502
  RequestId?: string;
1481
1503
  }
1482
1504
  /**
1483
- * GetTaskResultApi请求参数结构体
1505
+ * 查询过滤条件
1484
1506
  */
1485
- export interface GetTaskResultApiRequest {
1507
+ export interface Filter {
1486
1508
  /**
1487
- * 任务Id,通过CreateConvertTaskApi得到
1509
+ * 查询过滤条件的Key
1488
1510
  */
1489
- TaskId: string;
1511
+ Key: string;
1490
1512
  /**
1491
- * 操作人信息
1513
+ * 查询过滤条件的Value列表
1492
1514
  */
1493
- Operator?: UserInfo;
1515
+ Values: Array<string>;
1516
+ }
1517
+ /**
1518
+ * 创建员工的结果
1519
+ */
1520
+ export interface CreateStaffResult {
1494
1521
  /**
1495
- * 应用号信息
1522
+ * 创建员工的成功列表
1523
+ 注意:此字段可能返回 null,表示取不到有效值。
1496
1524
  */
1497
- Agent?: Agent;
1525
+ SuccessEmployeeData: Array<SuccessCreateStaffData>;
1498
1526
  /**
1499
- * 暂未开放
1527
+ * 创建员工的失败列表
1528
+ 注意:此字段可能返回 null,表示取不到有效值。
1500
1529
  */
1501
- Organization?: OrganizationInfo;
1530
+ FailedEmployeeData: Array<FailedCreateStaffData>;
1502
1531
  }
1503
1532
  /**
1504
1533
  * 二期接口返回的模板中文件的信息结构
@@ -1522,492 +1551,615 @@ export interface FileInfo {
1522
1551
  CreatedOn?: number;
1523
1552
  }
1524
1553
  /**
1525
- * CreateBatchCancelFlowUrl请求参数结构体
1554
+ * CreateSchemeUrl返回参数结构体
1526
1555
  */
1527
- export interface CreateBatchCancelFlowUrlRequest {
1556
+ export interface CreateSchemeUrlResponse {
1528
1557
  /**
1529
- * 调用方用户信息,userId 必填
1558
+ * 小程序链接地址
1530
1559
  */
1531
- Operator: UserInfo;
1560
+ SchemeUrl: string;
1532
1561
  /**
1533
- * 需要执行撤回的签署流程id数组,最多100个
1562
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1534
1563
  */
1535
- FlowIds: Array<string>;
1564
+ RequestId?: string;
1536
1565
  }
1537
1566
  /**
1538
- * 删除员工的成功数据
1567
+ * 指定签署人限制项
1539
1568
  */
1540
- export interface SuccessDeleteStaffData {
1569
+ export interface ApproverRestriction {
1541
1570
  /**
1542
- * 员工名
1571
+ * 指定签署人名字
1543
1572
  */
1544
- DisplayName: string;
1573
+ Name?: string;
1545
1574
  /**
1546
- * 员工手机号
1575
+ * 指定签署人手机号
1547
1576
  */
1548
- Mobile: string;
1577
+ Mobile?: string;
1549
1578
  /**
1550
- * 员工在电子签平台的id
1579
+ * 指定签署人证件类型
1551
1580
  */
1552
- UserId: string;
1581
+ IdCardType?: string;
1582
+ /**
1583
+ * 指定签署人证件号码
1584
+ */
1585
+ IdCardNumber?: string;
1553
1586
  }
1554
1587
  /**
1555
- * CreateMultiFlowSignQRCode请求参数结构体
1588
+ * GetTaskResultApi返回参数结构体
1556
1589
  */
1557
- export interface CreateMultiFlowSignQRCodeRequest {
1558
- /**
1559
- * 用户信息
1560
- */
1561
- Operator: UserInfo;
1590
+ export interface GetTaskResultApiResponse {
1562
1591
  /**
1563
- * 模板ID
1592
+ * 任务Id
1564
1593
  */
1565
- TemplateId: string;
1594
+ TaskId: string;
1566
1595
  /**
1567
- * 签署流程名称,最大长度不超过200字符
1596
+ * 任务状态,需要关注的状态
1597
+ 0 :NeedTranform - 任务已提交
1598
+ 4 :Processing - 文档转换中
1599
+ 8 :TaskEnd - 任务处理完成
1600
+ -2 :DownloadFailed - 下载失败
1601
+ -6 :ProcessFailed - 转换失败
1602
+ -13:ProcessTimeout - 转换文件超时
1568
1603
  */
1569
- FlowName: string;
1604
+ TaskStatus: number;
1570
1605
  /**
1571
- * 最大可发起签署流程份数,默认5份
1572
- 发起流程数量超过此上限后二维码自动失效
1606
+ * 状态描述,需要关注的状态
1607
+ NeedTranform - 任务已提交
1608
+ Processing - 文档转换中
1609
+ TaskEnd - 任务处理完成
1610
+ DownloadFailed - 下载失败
1611
+ ProcessFailed - 转换失败
1612
+ ProcessTimeout - 转换文件超时
1573
1613
  */
1574
- MaxFlowNum?: number;
1614
+ TaskMessage: string;
1575
1615
  /**
1576
- * 签署流程有效天数 默认7天 最高设置不超过30天
1616
+ * 资源Id,也是FileId,用于文件发起使用
1577
1617
  */
1578
- FlowEffectiveDay?: number;
1618
+ ResourceId: string;
1579
1619
  /**
1580
- * 二维码有效天数 默认7天 最高设置不超过90天
1620
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1581
1621
  */
1582
- QrEffectiveDay?: number;
1622
+ RequestId?: string;
1623
+ }
1624
+ /**
1625
+ * CancelMultiFlowSignQRCode请求参数结构体
1626
+ */
1627
+ export interface CancelMultiFlowSignQRCodeRequest {
1583
1628
  /**
1584
- * 限制二维码用户条件
1629
+ * 用户信息
1585
1630
  */
1586
- Restrictions?: Array<ApproverRestriction>;
1631
+ Operator: UserInfo;
1587
1632
  /**
1588
- * 回调地址,最大长度1000字符串
1589
- 回调时机:
1590
- 用户通过签署二维码发起签署流程时,企业额度不足导致失败
1633
+ * 二维码id
1591
1634
  */
1592
- CallbackUrl?: string;
1635
+ QrCodeId: string;
1593
1636
  /**
1594
1637
  * 应用信息
1595
1638
  */
1596
1639
  Agent?: Agent;
1597
- /**
1598
- * 限制二维码用户条件(已弃用)
1599
- */
1600
- ApproverRestrictions?: ApproverRestriction;
1601
- }
1602
- /**
1603
- * CreateConvertTaskApi返回参数结构体
1604
- */
1605
- export interface CreateConvertTaskApiResponse {
1606
- /**
1607
- * 转换任务Id
1608
- */
1609
- TaskId: string;
1610
- /**
1611
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1612
- */
1613
- RequestId?: string;
1614
1640
  }
1615
1641
  /**
1616
- * CreateFlowSignReview请求参数结构体
1642
+ * StartFlow请求参数结构体
1617
1643
  */
1618
- export interface CreateFlowSignReviewRequest {
1644
+ export interface StartFlowRequest {
1619
1645
  /**
1620
1646
  * 调用方用户信息,userId 必填
1621
1647
  */
1622
1648
  Operator: UserInfo;
1623
1649
  /**
1624
- * 签署流程编号
1650
+ * 签署流程编号,由CreateFlow接口返回
1625
1651
  */
1626
1652
  FlowId: string;
1627
1653
  /**
1628
- * 企业内部审核结果
1629
- PASS: 通过
1630
- REJECT: 拒绝
1654
+ * 客户端Token,保持接口幂等性,最大长度64个字符
1631
1655
  */
1632
- ReviewType: string;
1633
- /**
1634
- * 审核原因
1635
- 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
1636
- */
1637
- ReviewMessage?: string;
1656
+ ClientToken?: string;
1638
1657
  /**
1639
1658
  * 应用相关信息
1640
1659
  */
1641
1660
  Agent?: Agent;
1642
1661
  }
1643
1662
  /**
1644
- * CreateConvertTaskApi请求参数结构体
1663
+ * 签署人个性化能力信息
1645
1664
  */
1646
- export interface CreateConvertTaskApiRequest {
1665
+ export interface ApproverOption {
1647
1666
  /**
1648
- * 资源类型 取值范围doc,docx,html,excel之一
1667
+ * 是否可以拒签 false-可以拒签,默认 true-不可以拒签
1649
1668
  */
1650
- ResourceType: string;
1669
+ NoRefuse?: boolean;
1651
1670
  /**
1652
- * 资源名称,长度限制为256字符
1671
+ * 是否可以转发 false-可以转发,默认 true-不可以转发
1653
1672
  */
1654
- ResourceName: string;
1673
+ NoTransfer?: boolean;
1674
+ }
1675
+ /**
1676
+ * DeleteIntegrationEmployees返回参数结构体
1677
+ */
1678
+ export interface DeleteIntegrationEmployeesResponse {
1655
1679
  /**
1656
- * 资源Id,通过UploadFiles获取
1680
+ * 员工删除数据
1657
1681
  */
1658
- ResourceId: string;
1682
+ DeleteEmployeeResult: DeleteStaffsResult;
1659
1683
  /**
1660
- * 操作者信息
1684
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1661
1685
  */
1662
- Operator?: UserInfo;
1686
+ RequestId?: string;
1687
+ }
1688
+ /**
1689
+ * DescribeOrganizationSeals请求参数结构体
1690
+ */
1691
+ export interface DescribeOrganizationSealsRequest {
1663
1692
  /**
1664
- * 应用号信息
1693
+ * 调用方用户信息,userId 必填
1665
1694
  */
1666
- Agent?: Agent;
1695
+ Operator: UserInfo;
1667
1696
  /**
1668
- * 暂未开放
1697
+ * 返回最大数量,最大为100
1669
1698
  */
1670
- Organization?: OrganizationInfo;
1699
+ Limit: number;
1700
+ /**
1701
+ * 偏移量,默认为0,最大为20000
1702
+ */
1703
+ Offset?: number;
1704
+ /**
1705
+ * 查询信息类型,为0时不返回授权用户,为1时返回
1706
+ */
1707
+ InfoType?: number;
1708
+ /**
1709
+ * 印章id(没有输入返回所有)
1710
+ */
1711
+ SealId?: string;
1671
1712
  }
1672
1713
  /**
1673
- * DescribeFlowInfo返回参数结构体
1714
+ * CancelFlow请求参数结构体
1674
1715
  */
1675
- export interface DescribeFlowInfoResponse {
1716
+ export interface CancelFlowRequest {
1676
1717
  /**
1677
- * 签署流程信息
1718
+ * 调用方用户信息,userId 必填
1678
1719
  */
1679
- FlowDetailInfos: Array<FlowDetailInfo>;
1720
+ Operator: UserInfo;
1680
1721
  /**
1681
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1722
+ * 签署流程id
1682
1723
  */
1683
- RequestId?: string;
1724
+ FlowId: string;
1725
+ /**
1726
+ * 撤销原因,最长200个字符;
1727
+ */
1728
+ CancelMessage: string;
1729
+ /**
1730
+ * 应用相关信息
1731
+ */
1732
+ Agent?: Agent;
1684
1733
  }
1685
1734
  /**
1686
- * CreateSchemeUrl返回参数结构体
1735
+ * 参与者信息
1687
1736
  */
1688
- export interface CreateSchemeUrlResponse {
1737
+ export interface ApproverInfo {
1689
1738
  /**
1690
- * 小程序链接地址
1739
+ * 参与者类型:
1740
+ 0:企业
1741
+ 1:个人
1742
+ 3:企业静默签署
1743
+ 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
1691
1744
  */
1692
- SchemeUrl: string;
1745
+ ApproverType: number;
1693
1746
  /**
1694
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1747
+ * 本环节需要操作人的名字
1695
1748
  */
1696
- RequestId?: string;
1749
+ ApproverName: string;
1750
+ /**
1751
+ * 本环节需要操作人的手机号
1752
+ */
1753
+ ApproverMobile: string;
1754
+ /**
1755
+ * 本环节操作人签署控件配置
1756
+ */
1757
+ SignComponents: Array<Component>;
1758
+ /**
1759
+ * 如果是企业,则为企业的名字
1760
+ */
1761
+ OrganizationName?: string;
1762
+ /**
1763
+ * 身份证号
1764
+ */
1765
+ ApproverIdCardNumber?: string;
1766
+ /**
1767
+ * 证件类型
1768
+ ID_CARD 身份证
1769
+ HONGKONG_AND_MACAO 港澳居民来往内地通行证
1770
+ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
1771
+ */
1772
+ ApproverIdCardType?: string;
1773
+ /**
1774
+ * sms--短信,none--不通知
1775
+ */
1776
+ NotifyType?: string;
1777
+ /**
1778
+ * 1--收款人、2--开具人、3--见证人
1779
+ */
1780
+ ApproverRole?: number;
1781
+ /**
1782
+ * 签署意愿确认渠道,WEIXINAPP:人脸识别
1783
+ */
1784
+ VerifyChannel?: Array<string>;
1785
+ /**
1786
+ * 合同的强制预览时间:3~300s,未指定则按合同页数计算
1787
+ */
1788
+ PreReadTime?: number;
1789
+ /**
1790
+ * 签署人userId,传此字段则不用传姓名、手机号
1791
+ */
1792
+ UserId?: string;
1793
+ /**
1794
+ * 签署人用户来源,企微侧用户请传入:WEWORKAPP
1795
+ */
1796
+ ApproverSource?: string;
1797
+ /**
1798
+ * 客户自定义签署人标识,64位长度,保证唯一,非企微场景不使用此字段
1799
+ */
1800
+ CustomApproverTag?: string;
1801
+ /**
1802
+ * 签署人个性化能力值
1803
+ */
1804
+ ApproverOption?: ApproverOption;
1697
1805
  }
1698
1806
  /**
1699
- * CreateFlowByFiles请求参数结构体
1807
+ * 模板控件信息
1700
1808
  */
1701
- export interface CreateFlowByFilesRequest {
1809
+ export interface Component {
1702
1810
  /**
1703
- * 调用方用户信息,userId 必填
1811
+ * 如果是Component控件类型,则可选的字段为:
1812
+ TEXT - 普通文本控件;
1813
+ MULTI_LINE_TEXT - 多行文本控件;
1814
+ CHECK_BOX - 勾选框控件;
1815
+ FILL_IMAGE - 图片控件;
1816
+ DYNAMIC_TABLE - 动态表格控件;
1817
+ ATTACHMENT - 附件控件;
1818
+ SELECTOR - 选择器控件;
1819
+ DATE - 日期控件;默认是格式化为xxxx年xx月xx日
1820
+
1821
+ 如果是SignComponent控件类型,则可选的字段为
1822
+ SIGN_SEAL - 签署印章控件;
1823
+ SIGN_DATE - 签署日期控件;
1824
+ DATE, 日期控件,默认是格式化为xxxx年xx月xx日
1825
+ SIGN_SIGNATURE - 用户签名控件;
1826
+ SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
1827
+ SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
1828
+
1829
+ 表单域的控件不能作为印章和签名控件
1704
1830
  */
1705
- Operator: UserInfo;
1831
+ ComponentType: string;
1706
1832
  /**
1707
- * 签署流程名称,最大长度200个字符
1833
+ * 参数控件宽度,单位pt
1708
1834
  */
1709
- FlowName: string;
1835
+ ComponentWidth: number;
1710
1836
  /**
1711
- * 签署参与者信息,最大限制50方
1837
+ * 参数控件高度,单位pt
1712
1838
  */
1713
- Approvers: Array<ApproverInfo>;
1839
+ ComponentHeight: number;
1714
1840
  /**
1715
- * 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
1841
+ * 参数控件所在页码,取值为:1-N
1716
1842
  */
1717
- FileIds: Array<string>;
1843
+ ComponentPage: number;
1718
1844
  /**
1719
- * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
1845
+ * 参数控件X位置,单位pt
1720
1846
  */
1721
- FlowType?: string;
1847
+ ComponentPosX: number;
1722
1848
  /**
1723
- * 经办人内容控件配置
1849
+ * 参数控件Y位置,单位pt
1724
1850
  */
1725
- Components?: Array<Component>;
1851
+ ComponentPosY: number;
1726
1852
  /**
1727
- * 被抄送人的信息列表。
1728
- 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
1853
+ * 控件所属文件的序号(模板中的resourceId排列序号,取值为:0-N)
1729
1854
  */
1730
- CcInfos?: Array<CcInfo>;
1855
+ FileIndex: number;
1731
1856
  /**
1732
- * 是否需要预览,true:预览模式,false:非预览(默认);
1733
- 预览链接有效期300秒;
1734
-
1735
- 注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
1857
+ * GenerateMode==KEYWORD 指定关键字
1736
1858
  */
1737
- NeedPreview?: boolean;
1859
+ ComponentId?: string;
1738
1860
  /**
1739
- * 签署流程描述,最大长度1000个字符
1861
+ * GenerateMode==FIELD 指定表单域名称
1740
1862
  */
1741
- FlowDescription?: string;
1863
+ ComponentName?: string;
1742
1864
  /**
1743
- * 签署流程的签署截止时间。
1744
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
1865
+ * 是否必选,默认为false
1745
1866
  */
1746
- Deadline?: number;
1867
+ ComponentRequired?: boolean;
1747
1868
  /**
1748
- * 发送类型:
1749
- true:无序签
1750
- false:有序签
1751
- 注:默认为false(有序签)
1869
+ * 扩展参数:
1870
+ ComponentType为SIGN_SIGNATURE类型可以控制签署方式
1871
+ {“ComponentTypeLimit”: [“xxx”]}
1872
+ xxx可以为:
1873
+ HANDWRITE – 手写签名
1874
+ BORDERLESS_ESIGN – 自动生成无边框腾讯体
1875
+ OCR_ESIGN -- AI智能识别手写签名
1876
+ ESIGN -- 个人印章类型
1877
+ 如:{“ComponentTypeLimit”: [“BORDERLESS_ESIGN”]}
1752
1878
  */
1753
- Unordered?: boolean;
1879
+ ComponentExtra?: string;
1754
1880
  /**
1755
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1881
+ * 控件关联的签署人ID
1756
1882
  */
1757
- CustomShowMap?: string;
1883
+ ComponentRecipientId?: string;
1758
1884
  /**
1759
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
1760
- 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1761
-
1762
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1885
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
1886
+ TEXT - 文本内容
1887
+ MULTI_LINE_TEXT - 文本内容
1888
+ CHECK_BOX - true/false
1889
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1890
+ SELECTOR - 选项值
1891
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
1892
+ DATE - 默认是格式化为xxxx年xx月xx日
1893
+ SIGN_SEAL - 印章ID,于控制台查询获取
1894
+ SIGN_PAGING_SEAL - 可以指定印章ID,于控制台查询获取
1763
1895
  */
1764
- NeedSignReview?: boolean;
1896
+ ComponentValue?: string;
1765
1897
  /**
1766
- * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
1898
+ * 是否是表单域类型,默认不存在
1767
1899
  */
1768
- UserData?: string;
1900
+ IsFormType?: boolean;
1769
1901
  /**
1770
- * 应用号信息
1902
+ * NORMAL 正常模式,使用坐标制定签署控件位置
1903
+ FIELD 表单域,需使用ComponentName指定表单域名称
1904
+ KEYWORD 关键字,使用ComponentId指定关键字
1771
1905
  */
1772
- Agent?: Agent;
1906
+ GenerateMode?: string;
1773
1907
  /**
1774
- * 签署人校验方式
1775
- VerifyCheck: 人脸识别(默认)
1776
- MobileCheck:手机号验证
1777
- 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
1908
+ * 日期控件类型字号
1778
1909
  */
1779
- ApproverVerifyType?: string;
1910
+ ComponentDateFontSize?: number;
1911
+ /**
1912
+ * 指定关键字时横坐标偏移量,单位pt
1913
+ */
1914
+ OffsetX?: number;
1915
+ /**
1916
+ * 指定关键字时纵坐标偏移量,单位pt
1917
+ */
1918
+ OffsetY?: number;
1780
1919
  }
1781
1920
  /**
1782
- * 指定签署人限制项
1921
+ * DescribeFlowBriefs请求参数结构体
1783
1922
  */
1784
- export interface ApproverRestriction {
1923
+ export interface DescribeFlowBriefsRequest {
1785
1924
  /**
1786
- * 指定签署人名字
1925
+ * 调用方用户信息,userId 必填
1787
1926
  */
1788
- Name?: string;
1927
+ Operator: UserInfo;
1789
1928
  /**
1790
- * 指定签署人手机号
1929
+ * 需要查询的流程ID列表,限制最大20个
1791
1930
  */
1792
- Mobile?: string;
1931
+ FlowIds: Array<string>;
1793
1932
  /**
1794
- * 指定签署人证件类型
1933
+ * 应用相关信息
1795
1934
  */
1796
- IdCardType?: string;
1935
+ Agent?: Agent;
1936
+ }
1937
+ /**
1938
+ * 一码多扫签署二维码签署信息
1939
+ */
1940
+ export interface SignUrl {
1797
1941
  /**
1798
- * 指定签署人证件号码
1942
+ * 小程序签署链接
1799
1943
  */
1800
- IdCardNumber?: string;
1944
+ AppSignUrl: string;
1945
+ /**
1946
+ * 签署链接有效时间
1947
+ */
1948
+ EffectiveTime: string;
1949
+ /**
1950
+ * 移动端签署链接
1951
+ */
1952
+ HttpSignUrl: string;
1801
1953
  }
1802
1954
  /**
1803
- * CancelMultiFlowSignQRCode返回参数结构体
1955
+ * VerifyPdf返回参数结构体
1804
1956
  */
1805
- export interface CancelMultiFlowSignQRCodeResponse {
1957
+ export interface VerifyPdfResponse {
1958
+ /**
1959
+ * 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
1960
+ */
1961
+ VerifyResult: number;
1962
+ /**
1963
+ * 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域
1964
+ ;5-文件签名格式错误
1965
+ */
1966
+ PdfVerifyResults: Array<PdfVerifyResult>;
1806
1967
  /**
1807
1968
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1808
1969
  */
1809
1970
  RequestId?: string;
1810
1971
  }
1811
1972
  /**
1812
- * CreateFlow返回参数结构体
1973
+ * 删除员工结果
1813
1974
  */
1814
- export interface CreateFlowResponse {
1975
+ export interface DeleteStaffsResult {
1815
1976
  /**
1816
- * 签署流程编号
1977
+ * 删除员工的成功数据
1978
+ 注意:此字段可能返回 null,表示取不到有效值。
1817
1979
  */
1818
- FlowId: string;
1980
+ SuccessEmployeeData: Array<SuccessDeleteStaffData>;
1819
1981
  /**
1820
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1982
+ * 删除员工的失败数据
1983
+ 注意:此字段可能返回 null,表示取不到有效值。
1821
1984
  */
1822
- RequestId?: string;
1985
+ FailedEmployeeData: Array<FailedDeleteStaffData>;
1823
1986
  }
1824
1987
  /**
1825
- * 应用相关信息
1826
- */
1827
- export declare type Agent = null;
1828
- /**
1829
- * 电子文档的控件填充信息
1988
+ * DescribeFlowBriefs返回参数结构体
1830
1989
  */
1831
- export interface FormField {
1832
- /**
1833
- * 控件填充vaule,ComponentType和传入值类型对应关系:
1834
- TEXT - 文本内容
1835
- MULTI_LINE_TEXT - 文本内容
1836
- CHECK_BOX - true/false
1837
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1838
- SELECTOR - 选项值
1839
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
1840
- */
1841
- ComponentValue: string;
1990
+ export interface DescribeFlowBriefsResponse {
1842
1991
  /**
1843
- * 控件id,和ComponentName选择一项传入即可
1992
+ * 流程列表
1844
1993
  */
1845
- ComponentId?: string;
1994
+ FlowBriefs: Array<FlowBrief>;
1846
1995
  /**
1847
- * 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
1996
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1848
1997
  */
1849
- ComponentName?: string;
1998
+ RequestId?: string;
1850
1999
  }
1851
2000
  /**
1852
- * 签署人详情信息
2001
+ * 持有的电子印章信息
1853
2002
  */
1854
- export interface FlowApproverDetail {
2003
+ export interface OccupiedSeal {
1855
2004
  /**
1856
- * 签署人信息
1857
- 注意:此字段可能返回 null,表示取不到有效值。
2005
+ * 电子印章编号
1858
2006
  */
1859
- ApproveMessage?: string;
2007
+ SealId: string;
1860
2008
  /**
1861
- * 签署人名字
2009
+ * 电子印章名称
1862
2010
  */
1863
- ApproveName: string;
2011
+ SealName: string;
1864
2012
  /**
1865
- * 签署人的状态
1866
- 0:还没有发起
1867
- 1:流程中 没有开始处理
1868
- 2:待处理
1869
- 3:签署态
1870
- 4:拒绝态
1871
- 5:过期没人处理
1872
- 6:取消态
1873
- 7:还没有预发起
1874
- 8:待填写
1875
- 9:因为各种原因而终止
2013
+ * 电子印章授权时间戳
1876
2014
  */
1877
- ApproveStatus: number;
2015
+ CreateOn: number;
1878
2016
  /**
1879
- * 模板配置时候的签署人id,与控件绑定
2017
+ * 电子印章授权人
1880
2018
  */
1881
- ReceiptId: string;
2019
+ Creator: string;
1882
2020
  /**
1883
- * 客户自定义userId
1884
- 注意:此字段可能返回 null,表示取不到有效值。
2021
+ * 电子印章策略Id
1885
2022
  */
1886
- CustomUserId: string;
2023
+ SealPolicyId: string;
1887
2024
  /**
1888
- * 签署人手机号
2025
+ * 印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)
1889
2026
  */
1890
- Mobile: string;
2027
+ SealStatus: string;
1891
2028
  /**
1892
- * 签署顺序
2029
+ * 审核失败原因
2030
+ 注意:此字段可能返回 null,表示取不到有效值。
1893
2031
  */
1894
- SignOrder: number;
2032
+ FailReason: string;
1895
2033
  /**
1896
- * 签署人签署时间
2034
+ * 印章图片url,5分钟内有效
1897
2035
  */
1898
- ApproveTime: number;
2036
+ Url: string;
1899
2037
  /**
1900
- * 参与者类型
1901
- 注意:此字段可能返回 null,表示取不到有效值。
2038
+ * 印章类型
1902
2039
  */
1903
- ApproveType: string;
2040
+ SealType: string;
1904
2041
  /**
1905
- * 签署人侧用户来源
1906
- 注意:此字段可能返回 null,表示取不到有效值。
2042
+ * 用印申请是否为永久授权
1907
2043
  */
1908
- ApproverSource: string;
2044
+ IsAllTime: boolean;
1909
2045
  /**
1910
- * 客户自定义签署人标识
2046
+ * 授权人列表
1911
2047
  注意:此字段可能返回 null,表示取不到有效值。
1912
2048
  */
1913
- CustomApproverTag: string;
2049
+ AuthorizedUsers: Array<AuthorizedUser>;
2050
+ }
2051
+ /**
2052
+ * DescribeFlowTemplates返回参数结构体
2053
+ */
2054
+ export interface DescribeFlowTemplatesResponse {
1914
2055
  /**
1915
- * 签署人企业Id
1916
- 注意:此字段可能返回 null,表示取不到有效值。
2056
+ * 模板详情列表
1917
2057
  */
1918
- OrganizationId: string;
2058
+ Templates: Array<TemplateInfo>;
1919
2059
  /**
1920
- * 签署人企业名称
1921
- 注意:此字段可能返回 null,表示取不到有效值。
2060
+ * 查询到的总个数
1922
2061
  */
1923
- OrganizationName: string;
2062
+ TotalCount: number;
2063
+ /**
2064
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2065
+ */
2066
+ RequestId?: string;
1924
2067
  }
1925
2068
  /**
1926
- * DescribeFlowTemplates请求参数结构体
2069
+ * CreateBatchCancelFlowUrl请求参数结构体
1927
2070
  */
1928
- export interface DescribeFlowTemplatesRequest {
2071
+ export interface CreateBatchCancelFlowUrlRequest {
1929
2072
  /**
1930
2073
  * 调用方用户信息,userId 必填
1931
2074
  */
1932
2075
  Operator: UserInfo;
1933
2076
  /**
1934
- * 搜索条件,具体参考Filter结构体。本接口取值:template-id:按照【 **模板唯一标识** 】进行过滤
2077
+ * 需要执行撤回的签署流程id数组,最多100个
1935
2078
  */
1936
- Filters?: Array<Filter>;
2079
+ FlowIds: Array<string>;
2080
+ }
2081
+ /**
2082
+ * CreateMultiFlowSignQRCode请求参数结构体
2083
+ */
2084
+ export interface CreateMultiFlowSignQRCodeRequest {
1937
2085
  /**
1938
- * 查询个数,默认20,最大200
2086
+ * 用户信息
1939
2087
  */
1940
- Limit?: number;
2088
+ Operator: UserInfo;
1941
2089
  /**
1942
- * 查询偏移位置,默认0
2090
+ * 模板ID
1943
2091
  */
1944
- Offset?: number;
2092
+ TemplateId: string;
1945
2093
  /**
1946
- * 查询内容:0-模板列表及详情(默认),1-仅模板列表
2094
+ * 签署流程名称,最大长度不超过200字符
1947
2095
  */
1948
- ContentType?: number;
2096
+ FlowName: string;
1949
2097
  /**
1950
- * 暂未开放
2098
+ * 最大可发起签署流程份数,默认5份
2099
+ 发起流程数量超过此上限后二维码自动失效
1951
2100
  */
1952
- GenerateSource?: number;
2101
+ MaxFlowNum?: number;
1953
2102
  /**
1954
- * 应用相关信息
2103
+ * 签署流程有效天数 默认7天 最高设置不超过30天
1955
2104
  */
1956
- Agent?: Agent;
1957
- }
1958
- /**
1959
- * GetTaskResultApi返回参数结构体
1960
- */
1961
- export interface GetTaskResultApiResponse {
2105
+ FlowEffectiveDay?: number;
1962
2106
  /**
1963
- * 任务Id
2107
+ * 二维码有效天数 默认7天 最高设置不超过90天
1964
2108
  */
1965
- TaskId: string;
2109
+ QrEffectiveDay?: number;
1966
2110
  /**
1967
- * 任务状态,需要关注的状态
1968
- 0 :NeedTranform - 任务已提交
1969
- 4 :Processing - 文档转换中
1970
- 8 :TaskEnd - 任务处理完成
1971
- -2 :DownloadFailed - 下载失败
1972
- -6 :ProcessFailed - 转换失败
1973
- -13:ProcessTimeout - 转换文件超时
2111
+ * 限制二维码用户条件
1974
2112
  */
1975
- TaskStatus: number;
2113
+ Restrictions?: Array<ApproverRestriction>;
1976
2114
  /**
1977
- * 状态描述,需要关注的状态
1978
- NeedTranform - 任务已提交
1979
- Processing - 文档转换中
1980
- TaskEnd - 任务处理完成
1981
- DownloadFailed - 下载失败
1982
- ProcessFailed - 转换失败
1983
- ProcessTimeout - 转换文件超时
2115
+ * 回调地址,最大长度1000字符串
2116
+ 回调时机:
2117
+ 用户通过签署二维码发起签署流程时,企业额度不足导致失败
1984
2118
  */
1985
- TaskMessage: string;
2119
+ CallbackUrl?: string;
1986
2120
  /**
1987
- * 资源Id,也是FileId,用于文件发起使用
2121
+ * 应用信息
1988
2122
  */
1989
- ResourceId: string;
2123
+ Agent?: Agent;
2124
+ /**
2125
+ * 限制二维码用户条件(已弃用)
2126
+ */
2127
+ ApproverRestrictions?: ApproverRestriction;
2128
+ }
2129
+ /**
2130
+ * DescribeFlowInfo返回参数结构体
2131
+ */
2132
+ export interface DescribeFlowInfoResponse {
2133
+ /**
2134
+ * 签署流程信息
2135
+ */
2136
+ FlowDetailInfos: Array<FlowDetailInfo>;
1990
2137
  /**
1991
2138
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1992
2139
  */
1993
2140
  RequestId?: string;
1994
2141
  }
1995
2142
  /**
1996
- * CreateFlowApprovers请求参数结构体
2143
+ * 抄送信息
1997
2144
  */
1998
- export interface CreateFlowApproversRequest {
2145
+ export interface CcInfo {
1999
2146
  /**
2000
- * 调用方用户信息,userId 必填
2147
+ * 被抄送人手机号
2001
2148
  */
2002
- Operator: UserInfo;
2149
+ Mobile?: string;
2150
+ }
2151
+ /**
2152
+ * CreateFlow返回参数结构体
2153
+ */
2154
+ export interface CreateFlowResponse {
2003
2155
  /**
2004
2156
  * 签署流程编号
2005
2157
  */
2006
2158
  FlowId: string;
2007
2159
  /**
2008
- * 补充签署人信息
2160
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2009
2161
  */
2010
- Approvers: Array<FillApproverInfo>;
2162
+ RequestId?: string;
2011
2163
  }
2012
2164
  /**
2013
2165
  * 流程信息摘要
@@ -2058,61 +2210,11 @@ export interface FlowBrief {
2058
2210
  FlowMessage: string;
2059
2211
  }
2060
2212
  /**
2061
- * 抄送信息
2062
- */
2063
- export interface CcInfo {
2064
- /**
2065
- * 被抄送人手机号
2066
- */
2067
- Mobile?: string;
2068
- }
2069
- /**
2070
- * 企业员工信息
2213
+ * CancelMultiFlowSignQRCode返回参数结构体
2071
2214
  */
2072
- export interface Staff {
2073
- /**
2074
- * 用户在电子签平台的id
2075
- */
2076
- UserId?: string;
2077
- /**
2078
- * 显示的用户名/昵称
2079
- */
2080
- DisplayName?: string;
2081
- /**
2082
- * 用户手机号
2083
- */
2084
- Mobile?: string;
2085
- /**
2086
- * 用户邮箱
2087
- 注意:此字段可能返回 null,表示取不到有效值。
2088
- */
2089
- Email?: string;
2090
- /**
2091
- * 用户在第三方平台id
2092
- 注意:此字段可能返回 null,表示取不到有效值。
2093
- */
2094
- OpenId?: string;
2095
- /**
2096
- * 员工角色
2097
- 注意:此字段可能返回 null,表示取不到有效值。
2098
- */
2099
- Roles?: Array<StaffRole>;
2100
- /**
2101
- * 员工部门
2102
- 注意:此字段可能返回 null,表示取不到有效值。
2103
- */
2104
- Department?: Department;
2105
- /**
2106
- * 员工是否实名
2107
- */
2108
- Verified?: boolean;
2109
- /**
2110
- * 员工创建时间戳
2111
- */
2112
- CreatedOn?: number;
2215
+ export interface CancelMultiFlowSignQRCodeResponse {
2113
2216
  /**
2114
- * 员工实名时间戳
2115
- 注意:此字段可能返回 null,表示取不到有效值。
2217
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2116
2218
  */
2117
- VerifiedOn?: number;
2219
+ RequestId?: string;
2118
2220
  }