@zapyapi/sdk 1.0.0-beta.1
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/README.md +308 -0
- package/index.cjs +1176 -0
- package/index.js +1149 -0
- package/package.json +55 -0
- package/src/client.d.ts +98 -0
- package/src/client.d.ts.map +1 -0
- package/src/errors.d.ts +70 -0
- package/src/errors.d.ts.map +1 -0
- package/src/generated/Api.d.ts +1542 -0
- package/src/generated/Api.d.ts.map +1 -0
- package/src/index.d.ts +38 -0
- package/src/index.d.ts.map +1 -0
- package/src/resources/base.resource.d.ts +17 -0
- package/src/resources/base.resource.d.ts.map +1 -0
- package/src/resources/index.d.ts +8 -0
- package/src/resources/index.d.ts.map +1 -0
- package/src/resources/instances.resource.d.ts +75 -0
- package/src/resources/instances.resource.d.ts.map +1 -0
- package/src/resources/messages.resource.d.ts +159 -0
- package/src/resources/messages.resource.d.ts.map +1 -0
- package/src/resources/webhooks.resource.d.ts +115 -0
- package/src/resources/webhooks.resource.d.ts.map +1 -0
- package/src/types/common.types.d.ts +89 -0
- package/src/types/common.types.d.ts.map +1 -0
- package/src/types/enums.d.ts +142 -0
- package/src/types/enums.d.ts.map +1 -0
- package/src/types/index.d.ts +11 -0
- package/src/types/index.d.ts.map +1 -0
- package/src/types/instances.types.d.ts +114 -0
- package/src/types/instances.types.d.ts.map +1 -0
- package/src/types/messages.types.d.ts +166 -0
- package/src/types/messages.types.d.ts.map +1 -0
- package/src/types/webhook-config.types.d.ts +60 -0
- package/src/types/webhook-config.types.d.ts.map +1 -0
- package/src/types/webhook-events.types.d.ts +232 -0
- package/src/types/webhook-events.types.d.ts.map +1 -0
- package/src/utils/index.d.ts +6 -0
- package/src/utils/index.d.ts.map +1 -0
- package/src/utils/phone.d.ts +38 -0
- package/src/utils/phone.d.ts.map +1 -0
- package/src/utils/webhook-signature.d.ts +69 -0
- package/src/utils/webhook-signature.d.ts.map +1 -0
- package/src/version.d.ts +3 -0
- package/src/version.d.ts.map +1 -0
|
@@ -0,0 +1,1542 @@
|
|
|
1
|
+
export interface ResponsePaginated {
|
|
2
|
+
/** Lista de dados */
|
|
3
|
+
data: any[][];
|
|
4
|
+
/**
|
|
5
|
+
* Indica se é a primeira página
|
|
6
|
+
* @example true
|
|
7
|
+
*/
|
|
8
|
+
isFirstPage: boolean;
|
|
9
|
+
/**
|
|
10
|
+
* Indica se é a última página
|
|
11
|
+
* @example true
|
|
12
|
+
*/
|
|
13
|
+
isLastPage: boolean;
|
|
14
|
+
/**
|
|
15
|
+
* Número da página atual
|
|
16
|
+
* @example 1
|
|
17
|
+
*/
|
|
18
|
+
currentPage: number;
|
|
19
|
+
/**
|
|
20
|
+
* Número da página anterior
|
|
21
|
+
* @example 1
|
|
22
|
+
*/
|
|
23
|
+
previousPage: object;
|
|
24
|
+
/**
|
|
25
|
+
* Número da próxima página
|
|
26
|
+
* @example 1
|
|
27
|
+
*/
|
|
28
|
+
nextPage: object;
|
|
29
|
+
/**
|
|
30
|
+
* Número total de páginas
|
|
31
|
+
* @example 1
|
|
32
|
+
*/
|
|
33
|
+
pageCount: number;
|
|
34
|
+
/**
|
|
35
|
+
* Número total de itens
|
|
36
|
+
* @example 1
|
|
37
|
+
*/
|
|
38
|
+
totalCount: number;
|
|
39
|
+
}
|
|
40
|
+
export interface ListInstancesResponseDto {
|
|
41
|
+
/**
|
|
42
|
+
* Identificador único da instância do WhatsApp
|
|
43
|
+
* @example "instance-123"
|
|
44
|
+
*/
|
|
45
|
+
instanceId: string;
|
|
46
|
+
/**
|
|
47
|
+
* Nome legível da instância
|
|
48
|
+
* @example "Minha Instância WhatsApp"
|
|
49
|
+
*/
|
|
50
|
+
name: object | null;
|
|
51
|
+
/**
|
|
52
|
+
* Status da instância
|
|
53
|
+
* @example "created"
|
|
54
|
+
*/
|
|
55
|
+
status: "stopped" | "manually_stopped" | "connecting" | "pending_qr_code_scan" | "connected" | "error" | "created" | "qr_timeout" | "payment_pending";
|
|
56
|
+
/**
|
|
57
|
+
* JID do WhatsApp quando conectado
|
|
58
|
+
* @example "5511999999999@c.us"
|
|
59
|
+
*/
|
|
60
|
+
whatsappJid: object | null;
|
|
61
|
+
/**
|
|
62
|
+
* LID do WhatsApp quando conectado
|
|
63
|
+
* @example "5511999999999@lid"
|
|
64
|
+
*/
|
|
65
|
+
whatsappLid: object | null;
|
|
66
|
+
/**
|
|
67
|
+
* ID do WhatsApp quando conectado
|
|
68
|
+
* @example "5511999999999"
|
|
69
|
+
*/
|
|
70
|
+
whatsappId: object | null;
|
|
71
|
+
/**
|
|
72
|
+
* Nome de exibição do WhatsApp quando conectado
|
|
73
|
+
* @example "Minha Empresa"
|
|
74
|
+
*/
|
|
75
|
+
whatsappName: object | null;
|
|
76
|
+
/**
|
|
77
|
+
* URL da foto de perfil do WhatsApp quando conectado
|
|
78
|
+
* @example "https://example.com/profile-pic.jpg"
|
|
79
|
+
*/
|
|
80
|
+
whatsappProfilePicUrl: object | null;
|
|
81
|
+
/**
|
|
82
|
+
* Data e hora de criação da instância
|
|
83
|
+
* @format date-time
|
|
84
|
+
* @example "2023-01-01T00:00:00.000Z"
|
|
85
|
+
*/
|
|
86
|
+
createdAt: string;
|
|
87
|
+
/**
|
|
88
|
+
* Data e hora da última atualização da instância
|
|
89
|
+
* @format date-time
|
|
90
|
+
* @example "2023-01-01T00:00:00.000Z"
|
|
91
|
+
*/
|
|
92
|
+
updatedAt: string;
|
|
93
|
+
}
|
|
94
|
+
export interface QRCodeResponseDto {
|
|
95
|
+
/**
|
|
96
|
+
* Identificador da instância do WhatsApp
|
|
97
|
+
* @example "minha-instancia-whatsapp"
|
|
98
|
+
*/
|
|
99
|
+
instanceId: string;
|
|
100
|
+
/**
|
|
101
|
+
* Código QR em formato base64 ou string
|
|
102
|
+
* @example "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
|
|
103
|
+
*/
|
|
104
|
+
qrCode: string;
|
|
105
|
+
/**
|
|
106
|
+
* Timestamp de expiração do código QR (em milissegundos)
|
|
107
|
+
* @example 1672531200000
|
|
108
|
+
*/
|
|
109
|
+
expiresAt: number;
|
|
110
|
+
/**
|
|
111
|
+
* Número da tentativa de geração do QR code
|
|
112
|
+
* @example 1
|
|
113
|
+
*/
|
|
114
|
+
attempt: number;
|
|
115
|
+
}
|
|
116
|
+
export type EmptyResponseDto = object;
|
|
117
|
+
export interface BadRequestErrorDto {
|
|
118
|
+
/**
|
|
119
|
+
* Código de status HTTP
|
|
120
|
+
* @example 400
|
|
121
|
+
*/
|
|
122
|
+
statusCode: number;
|
|
123
|
+
/**
|
|
124
|
+
* Mensagem de erro
|
|
125
|
+
* @example "Dados da requisição inválidos"
|
|
126
|
+
*/
|
|
127
|
+
message: string;
|
|
128
|
+
/**
|
|
129
|
+
* Código de erro específico (opcional)
|
|
130
|
+
* @example "RESOURCE_NOT_FOUND"
|
|
131
|
+
*/
|
|
132
|
+
error?: string;
|
|
133
|
+
/**
|
|
134
|
+
* Timestamp do erro
|
|
135
|
+
* @example "2023-01-01T00:00:00.000Z"
|
|
136
|
+
*/
|
|
137
|
+
timestamp: string;
|
|
138
|
+
/**
|
|
139
|
+
* Caminho da requisição
|
|
140
|
+
* @example "/api/instances/123"
|
|
141
|
+
*/
|
|
142
|
+
path: string;
|
|
143
|
+
}
|
|
144
|
+
export interface UnauthorizedErrorDto {
|
|
145
|
+
/**
|
|
146
|
+
* Código de status HTTP
|
|
147
|
+
* @example 401
|
|
148
|
+
*/
|
|
149
|
+
statusCode: number;
|
|
150
|
+
/**
|
|
151
|
+
* Mensagem de erro
|
|
152
|
+
* @example "Não autorizado - API key inválida ou ausente"
|
|
153
|
+
*/
|
|
154
|
+
message: string;
|
|
155
|
+
/**
|
|
156
|
+
* Código de erro específico (opcional)
|
|
157
|
+
* @example "RESOURCE_NOT_FOUND"
|
|
158
|
+
*/
|
|
159
|
+
error?: string;
|
|
160
|
+
/**
|
|
161
|
+
* Timestamp do erro
|
|
162
|
+
* @example "2023-01-01T00:00:00.000Z"
|
|
163
|
+
*/
|
|
164
|
+
timestamp: string;
|
|
165
|
+
/**
|
|
166
|
+
* Caminho da requisição
|
|
167
|
+
* @example "/api/instances/123"
|
|
168
|
+
*/
|
|
169
|
+
path: string;
|
|
170
|
+
}
|
|
171
|
+
export interface CreateInstanceRequestDto {
|
|
172
|
+
/**
|
|
173
|
+
* Human readable name for the instance
|
|
174
|
+
* @example "My WhatsApp Instance"
|
|
175
|
+
*/
|
|
176
|
+
name?: string;
|
|
177
|
+
}
|
|
178
|
+
export interface ManagerInstanceResponseDto {
|
|
179
|
+
/**
|
|
180
|
+
* Unique identifier for the WhatsApp instance
|
|
181
|
+
* @example "instance-123"
|
|
182
|
+
*/
|
|
183
|
+
instanceId: string;
|
|
184
|
+
/**
|
|
185
|
+
* Human readable name for the instance
|
|
186
|
+
* @example "My WhatsApp Instance"
|
|
187
|
+
*/
|
|
188
|
+
name: object;
|
|
189
|
+
/**
|
|
190
|
+
* Status of the instance
|
|
191
|
+
* @example "created"
|
|
192
|
+
*/
|
|
193
|
+
status: "stopped" | "manually_stopped" | "connecting" | "pending_qr_code_scan" | "connected" | "error" | "created" | "qr_timeout" | "payment_pending";
|
|
194
|
+
}
|
|
195
|
+
export interface ForbiddenErrorDto {
|
|
196
|
+
/**
|
|
197
|
+
* Código de status HTTP
|
|
198
|
+
* @example 403
|
|
199
|
+
*/
|
|
200
|
+
statusCode: number;
|
|
201
|
+
/**
|
|
202
|
+
* Mensagem de erro
|
|
203
|
+
* @example "Acesso negado - Sem acesso ao recurso"
|
|
204
|
+
*/
|
|
205
|
+
message: string;
|
|
206
|
+
/**
|
|
207
|
+
* Código de erro específico (opcional)
|
|
208
|
+
* @example "RESOURCE_NOT_FOUND"
|
|
209
|
+
*/
|
|
210
|
+
error?: string;
|
|
211
|
+
/**
|
|
212
|
+
* Timestamp do erro
|
|
213
|
+
* @example "2023-01-01T00:00:00.000Z"
|
|
214
|
+
*/
|
|
215
|
+
timestamp: string;
|
|
216
|
+
/**
|
|
217
|
+
* Caminho da requisição
|
|
218
|
+
* @example "/api/instances/123"
|
|
219
|
+
*/
|
|
220
|
+
path: string;
|
|
221
|
+
}
|
|
222
|
+
export interface NotFoundErrorDto {
|
|
223
|
+
/**
|
|
224
|
+
* Código de status HTTP
|
|
225
|
+
* @example 404
|
|
226
|
+
*/
|
|
227
|
+
statusCode: number;
|
|
228
|
+
/**
|
|
229
|
+
* Mensagem de erro
|
|
230
|
+
* @example "Recurso não encontrado"
|
|
231
|
+
*/
|
|
232
|
+
message: string;
|
|
233
|
+
/**
|
|
234
|
+
* Código de erro específico (opcional)
|
|
235
|
+
* @example "RESOURCE_NOT_FOUND"
|
|
236
|
+
*/
|
|
237
|
+
error?: string;
|
|
238
|
+
/**
|
|
239
|
+
* Timestamp do erro
|
|
240
|
+
* @example "2023-01-01T00:00:00.000Z"
|
|
241
|
+
*/
|
|
242
|
+
timestamp: string;
|
|
243
|
+
/**
|
|
244
|
+
* Caminho da requisição
|
|
245
|
+
* @example "/api/instances/123"
|
|
246
|
+
*/
|
|
247
|
+
path: string;
|
|
248
|
+
}
|
|
249
|
+
export interface WebhookConfigResponseDto {
|
|
250
|
+
/**
|
|
251
|
+
* Webhook configuration ID
|
|
252
|
+
* @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
253
|
+
*/
|
|
254
|
+
id: string;
|
|
255
|
+
/**
|
|
256
|
+
* Webhook URL
|
|
257
|
+
* @example "https://your-server.com/webhook"
|
|
258
|
+
*/
|
|
259
|
+
url: string;
|
|
260
|
+
/**
|
|
261
|
+
* Whether a secret is configured (secret is never exposed)
|
|
262
|
+
* @example true
|
|
263
|
+
*/
|
|
264
|
+
hasSecret: boolean;
|
|
265
|
+
/**
|
|
266
|
+
* Whether the webhook is active
|
|
267
|
+
* @example true
|
|
268
|
+
*/
|
|
269
|
+
isActive: boolean;
|
|
270
|
+
/**
|
|
271
|
+
* Whether the webhook is paused due to delivery failures
|
|
272
|
+
* @example false
|
|
273
|
+
*/
|
|
274
|
+
isPaused: boolean;
|
|
275
|
+
/**
|
|
276
|
+
* When the webhook was paused (ISO 8601)
|
|
277
|
+
* @example "2024-01-15T10:30:00.000Z"
|
|
278
|
+
*/
|
|
279
|
+
pausedAt?: string;
|
|
280
|
+
/**
|
|
281
|
+
* Creation timestamp (ISO 8601)
|
|
282
|
+
* @example "2024-01-15T10:30:00.000Z"
|
|
283
|
+
*/
|
|
284
|
+
createdAt: string;
|
|
285
|
+
/**
|
|
286
|
+
* Last update timestamp (ISO 8601)
|
|
287
|
+
* @example "2024-01-15T10:30:00.000Z"
|
|
288
|
+
*/
|
|
289
|
+
updatedAt: string;
|
|
290
|
+
}
|
|
291
|
+
export interface UpsertWebhookConfigRequestDto {
|
|
292
|
+
/**
|
|
293
|
+
* Webhook URL (must be HTTPS)
|
|
294
|
+
* @example "https://your-server.com/webhook"
|
|
295
|
+
*/
|
|
296
|
+
url: string;
|
|
297
|
+
/**
|
|
298
|
+
* Secret for HMAC-SHA256 signature verification (16-256 characters). Pass empty string to clear.
|
|
299
|
+
* @minLength 16
|
|
300
|
+
* @maxLength 256
|
|
301
|
+
* @example "your-webhook-secret-key"
|
|
302
|
+
*/
|
|
303
|
+
secret?: string;
|
|
304
|
+
/**
|
|
305
|
+
* Whether the webhook is active
|
|
306
|
+
* @example true
|
|
307
|
+
*/
|
|
308
|
+
isActive: boolean;
|
|
309
|
+
}
|
|
310
|
+
export interface WebhookQueueStatusResponseDto {
|
|
311
|
+
/**
|
|
312
|
+
* Number of webhooks pending delivery
|
|
313
|
+
* @example 5
|
|
314
|
+
*/
|
|
315
|
+
pendingCount: number;
|
|
316
|
+
/**
|
|
317
|
+
* Number of webhooks that failed permanently
|
|
318
|
+
* @example 0
|
|
319
|
+
*/
|
|
320
|
+
failedCount: number;
|
|
321
|
+
/**
|
|
322
|
+
* Number of webhooks paused due to delivery issues
|
|
323
|
+
* @example 0
|
|
324
|
+
*/
|
|
325
|
+
pausedCount: number;
|
|
326
|
+
/**
|
|
327
|
+
* Number of successfully delivered webhooks
|
|
328
|
+
* @example 150
|
|
329
|
+
*/
|
|
330
|
+
deliveredCount: number;
|
|
331
|
+
}
|
|
332
|
+
export interface WebhookResumeResponseDto {
|
|
333
|
+
/**
|
|
334
|
+
* Number of webhooks resumed
|
|
335
|
+
* @example 5
|
|
336
|
+
*/
|
|
337
|
+
resumedCount: number;
|
|
338
|
+
}
|
|
339
|
+
export interface SendMessageDto {
|
|
340
|
+
/**
|
|
341
|
+
* WhatsApp number or group ID to send the message to
|
|
342
|
+
* @example "5511999999999@c.us"
|
|
343
|
+
*/
|
|
344
|
+
to: string;
|
|
345
|
+
/**
|
|
346
|
+
* Text message content to send
|
|
347
|
+
* @example "Hello, this is a test message!"
|
|
348
|
+
*/
|
|
349
|
+
message: string;
|
|
350
|
+
/**
|
|
351
|
+
* Whatsapp Message ID of the message to quote/reply to
|
|
352
|
+
* @example "73C5222F61C8DB541672CE65D79C7E4B"
|
|
353
|
+
*/
|
|
354
|
+
quoteMessageId?: object | null;
|
|
355
|
+
}
|
|
356
|
+
export interface CommonSendMessageResponseDto {
|
|
357
|
+
/**
|
|
358
|
+
* Internal unique identifier for the message
|
|
359
|
+
* @example "b6652d6e-8e5d-4ee3-a16a-bfc560b64448"
|
|
360
|
+
*/
|
|
361
|
+
id: string;
|
|
362
|
+
/**
|
|
363
|
+
* WhatsApp identifier for the message
|
|
364
|
+
* @example "3EB01CEDFD9A2E927BED83"
|
|
365
|
+
*/
|
|
366
|
+
messageId: string;
|
|
367
|
+
}
|
|
368
|
+
export interface SendImageMessageDto {
|
|
369
|
+
/**
|
|
370
|
+
* WhatsApp number or group ID to send the image to
|
|
371
|
+
* @example "5511999999999@c.us"
|
|
372
|
+
*/
|
|
373
|
+
to: string;
|
|
374
|
+
/**
|
|
375
|
+
* Base64 encoded image file or URL to the image
|
|
376
|
+
* @example "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCAABAAEDASIAAhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAv/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFQEBAQAAAAAAAAAAAAAAAAAAAAX/xAAUEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwCdABmX/9k="
|
|
377
|
+
*/
|
|
378
|
+
image: string;
|
|
379
|
+
/**
|
|
380
|
+
* Caption text to accompany the image
|
|
381
|
+
* @example "Check out this image!"
|
|
382
|
+
*/
|
|
383
|
+
caption?: string;
|
|
384
|
+
/**
|
|
385
|
+
* Whatsapp Message ID of the message to quote/reply to
|
|
386
|
+
* @example "73C5222F61C8DB541672CE65D79C7E4B"
|
|
387
|
+
*/
|
|
388
|
+
quoteMessageId?: string;
|
|
389
|
+
/**
|
|
390
|
+
* Whether the image should be viewed only once
|
|
391
|
+
* @default false
|
|
392
|
+
* @example false
|
|
393
|
+
*/
|
|
394
|
+
viewOnce?: boolean;
|
|
395
|
+
}
|
|
396
|
+
export interface SendVideoMessageDto {
|
|
397
|
+
/**
|
|
398
|
+
* WhatsApp number or group ID to send the video to
|
|
399
|
+
* @example "5511999999999@c.us"
|
|
400
|
+
*/
|
|
401
|
+
to: string;
|
|
402
|
+
/**
|
|
403
|
+
* Base64 encoded video file or URL to the video
|
|
404
|
+
* @example "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1wNDEAAAAIZnJlZQAACKBtZGF0AAAC..."
|
|
405
|
+
*/
|
|
406
|
+
video: string;
|
|
407
|
+
/**
|
|
408
|
+
* Caption text to accompany the video
|
|
409
|
+
* @example "Check out this video!"
|
|
410
|
+
*/
|
|
411
|
+
caption?: string;
|
|
412
|
+
/**
|
|
413
|
+
* Whatsapp Message ID of the message to quote/reply to
|
|
414
|
+
* @example "73C5222F61C8DB541672CE65D79C7E4B"
|
|
415
|
+
*/
|
|
416
|
+
quoteMessageId?: string;
|
|
417
|
+
/**
|
|
418
|
+
* Whether the video should be viewed only once
|
|
419
|
+
* @default false
|
|
420
|
+
* @example false
|
|
421
|
+
*/
|
|
422
|
+
viewOnce?: boolean;
|
|
423
|
+
}
|
|
424
|
+
export interface SendAudioNoteMessageDto {
|
|
425
|
+
/** WhatsApp number or group ID to send the audio note to */
|
|
426
|
+
to: string;
|
|
427
|
+
/**
|
|
428
|
+
* Base64 encoded audio note file or URL to the audio file
|
|
429
|
+
* @example "data:audio/ogg;base64,T2dnUwACAAAAAAAAAADqnjMlAAAAAOyyzPIBHgF2b3JiaXMAAAAAAUAfAABAHwAAQB8AAEAfAACZAU9nZ1MAAAAAAAAAAAAA6p4zJQEAAAANJGeqCj3//////////5ADdm9yYmlzLQAAAFhpcGguT3JnIGxpYlZvcmJpcyBJIDIwMTAxMTAxIChTY2hhdWZlbnVnZ2V0KQAAAAABBXZvcmJpcw=="
|
|
430
|
+
*/
|
|
431
|
+
audio: string;
|
|
432
|
+
/**
|
|
433
|
+
* Whatsapp Message ID of the message to quote/reply to
|
|
434
|
+
* @example "73C5222F61C8DB541672CE65D79C7E4B"
|
|
435
|
+
*/
|
|
436
|
+
quoteMessageId?: string;
|
|
437
|
+
/**
|
|
438
|
+
* Whether the audio note should be viewed only once
|
|
439
|
+
* @default false
|
|
440
|
+
* @example false
|
|
441
|
+
*/
|
|
442
|
+
viewOnce?: boolean;
|
|
443
|
+
}
|
|
444
|
+
export interface SendAudioFileMessageDto {
|
|
445
|
+
/** WhatsApp number or group ID to send the audio to */
|
|
446
|
+
to: string;
|
|
447
|
+
/**
|
|
448
|
+
* Base64 encoded audio file or URL to the audio file
|
|
449
|
+
* @example "data:audio/mp3;base64,UklGRnoGAABXQVZFZm10IBAAAAABAAEA..."
|
|
450
|
+
*/
|
|
451
|
+
audio: string;
|
|
452
|
+
/**
|
|
453
|
+
* Whatsapp Message ID of the message to quote/reply to
|
|
454
|
+
* @example "73C5222F61C8DB541672CE65D79C7E4B"
|
|
455
|
+
*/
|
|
456
|
+
quoteMessageId?: string;
|
|
457
|
+
}
|
|
458
|
+
export interface SendDocumentMessageDto {
|
|
459
|
+
/**
|
|
460
|
+
* WhatsApp number or group ID to send the document to
|
|
461
|
+
* @example "5511999999999@c.us"
|
|
462
|
+
*/
|
|
463
|
+
to: string;
|
|
464
|
+
/**
|
|
465
|
+
* Base64 encoded document file or URL to the document
|
|
466
|
+
* @example "data:application/pdf;base64,JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PAovTGVuZ3RoIDYgMCBSCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCj4+CnN0cmVhbQ=="
|
|
467
|
+
*/
|
|
468
|
+
document: string;
|
|
469
|
+
/**
|
|
470
|
+
* Caption text to accompany the document
|
|
471
|
+
* @example "Here is the requested document"
|
|
472
|
+
*/
|
|
473
|
+
caption?: string;
|
|
474
|
+
/**
|
|
475
|
+
* Whatsapp Message ID of the message to quote/reply to
|
|
476
|
+
* @example "73C5222F61C8DB541672CE65D79C7E4B"
|
|
477
|
+
*/
|
|
478
|
+
quoteMessageId?: string;
|
|
479
|
+
/**
|
|
480
|
+
* Name of the document file
|
|
481
|
+
* @example "document.pdf"
|
|
482
|
+
*/
|
|
483
|
+
fileName?: string;
|
|
484
|
+
}
|
|
485
|
+
export interface ForwardMessageDto {
|
|
486
|
+
/** WhatsApp number or group ID to forward the message to */
|
|
487
|
+
to: string;
|
|
488
|
+
/**
|
|
489
|
+
* Whatsapp Message ID of the message to forward
|
|
490
|
+
* @example "73C5222F61C8DB541672CE65D79C7E4B"
|
|
491
|
+
*/
|
|
492
|
+
messageId: string;
|
|
493
|
+
}
|
|
494
|
+
export interface EditMessageDto {
|
|
495
|
+
/**
|
|
496
|
+
* Whatsapp Message ID of the message to edit
|
|
497
|
+
* @example "73C5222F61C8DB541672CE65D79C7E4B@c.us_3EB0C767D71CC8C55E"
|
|
498
|
+
*/
|
|
499
|
+
messageId: string;
|
|
500
|
+
/**
|
|
501
|
+
* New text content for the message
|
|
502
|
+
* @example "This is the edited message content"
|
|
503
|
+
*/
|
|
504
|
+
message: string;
|
|
505
|
+
}
|
|
506
|
+
export interface ReadMessageDto {
|
|
507
|
+
/**
|
|
508
|
+
* Whatsapp Message ID of the message to mark as read
|
|
509
|
+
* @example "73C5222F61C8DB541672CE65D79C7E4B"
|
|
510
|
+
*/
|
|
511
|
+
messageId: string;
|
|
512
|
+
}
|
|
513
|
+
export interface ReadMessageResponseDto {
|
|
514
|
+
/**
|
|
515
|
+
* WhatsApp identifier for the message that was read
|
|
516
|
+
* @example "3EB01CEDFD9A2E927BED83"
|
|
517
|
+
*/
|
|
518
|
+
messageId: string;
|
|
519
|
+
}
|
|
520
|
+
export interface DeleteMessageDto {
|
|
521
|
+
/**
|
|
522
|
+
* Whatsapp Message ID of the message to delete
|
|
523
|
+
* @example "73C5222F61C8DB541672CE65D79C7E4B"
|
|
524
|
+
*/
|
|
525
|
+
messageId: string;
|
|
526
|
+
}
|
|
527
|
+
export interface GetMessageMediaDownloadLinkResponseDto {
|
|
528
|
+
/**
|
|
529
|
+
* URL to download the media file
|
|
530
|
+
* @example "https://example.com/media/document.pdf"
|
|
531
|
+
*/
|
|
532
|
+
url: string;
|
|
533
|
+
/**
|
|
534
|
+
* URL expiration time in seconds
|
|
535
|
+
* @example 3600
|
|
536
|
+
*/
|
|
537
|
+
urlExpiresIn: number;
|
|
538
|
+
/**
|
|
539
|
+
* File name
|
|
540
|
+
* @example "document.pdf"
|
|
541
|
+
*/
|
|
542
|
+
fileName: string;
|
|
543
|
+
}
|
|
544
|
+
export interface ManagerInstancesControllerListInstancesParams {
|
|
545
|
+
/**
|
|
546
|
+
* Número da página
|
|
547
|
+
* @min 1
|
|
548
|
+
* @default 1
|
|
549
|
+
* @example 1
|
|
550
|
+
*/
|
|
551
|
+
page?: number;
|
|
552
|
+
/**
|
|
553
|
+
* Número de itens por página
|
|
554
|
+
* @min 1
|
|
555
|
+
* @max 10
|
|
556
|
+
* @default 100
|
|
557
|
+
* @example 10
|
|
558
|
+
*/
|
|
559
|
+
limit?: number;
|
|
560
|
+
}
|
|
561
|
+
export interface ManagerInstancesControllerGetQrCodeParams {
|
|
562
|
+
/**
|
|
563
|
+
* Identificador da instância do WhatsApp
|
|
564
|
+
* @example "minha-instancia-whatsapp"
|
|
565
|
+
*/
|
|
566
|
+
instanceId: string;
|
|
567
|
+
}
|
|
568
|
+
export interface ManagerInstancesControllerRestartInstanceParams {
|
|
569
|
+
/**
|
|
570
|
+
* Identificador da instância do WhatsApp
|
|
571
|
+
* @example "minha-instancia-whatsapp"
|
|
572
|
+
*/
|
|
573
|
+
instanceId: string;
|
|
574
|
+
}
|
|
575
|
+
export interface ManagerInstancesControllerLogoutInstanceParams {
|
|
576
|
+
/**
|
|
577
|
+
* Identificador da instância do WhatsApp
|
|
578
|
+
* @example "minha-instancia-whatsapp"
|
|
579
|
+
*/
|
|
580
|
+
instanceId: string;
|
|
581
|
+
}
|
|
582
|
+
export interface ManagerInstancesControllerDeleteInstanceParams {
|
|
583
|
+
/**
|
|
584
|
+
* Identificador da instância do WhatsApp
|
|
585
|
+
* @example "minha-instancia-whatsapp"
|
|
586
|
+
*/
|
|
587
|
+
instanceId: string;
|
|
588
|
+
}
|
|
589
|
+
export interface SendMessageControllerSendTextMessageParams {
|
|
590
|
+
/**
|
|
591
|
+
* Identificador da instância do WhatsApp
|
|
592
|
+
* @example "minha-instancia-whatsapp"
|
|
593
|
+
*/
|
|
594
|
+
instanceId: string;
|
|
595
|
+
}
|
|
596
|
+
export interface SendMessageControllerSendImageMessageParams {
|
|
597
|
+
/**
|
|
598
|
+
* Identificador da instância do WhatsApp
|
|
599
|
+
* @example "minha-instancia-whatsapp"
|
|
600
|
+
*/
|
|
601
|
+
instanceId: string;
|
|
602
|
+
}
|
|
603
|
+
export interface SendMessageControllerSendVideoMessageParams {
|
|
604
|
+
/**
|
|
605
|
+
* Identificador da instância do WhatsApp
|
|
606
|
+
* @example "minha-instancia-whatsapp"
|
|
607
|
+
*/
|
|
608
|
+
instanceId: string;
|
|
609
|
+
}
|
|
610
|
+
export interface SendMessageControllerSendAudioNoteMessageParams {
|
|
611
|
+
/**
|
|
612
|
+
* Identificador da instância do WhatsApp
|
|
613
|
+
* @example "minha-instancia-whatsapp"
|
|
614
|
+
*/
|
|
615
|
+
instanceId: string;
|
|
616
|
+
}
|
|
617
|
+
export interface SendMessageControllerSendAudioFileMessageParams {
|
|
618
|
+
/**
|
|
619
|
+
* Identificador da instância do WhatsApp
|
|
620
|
+
* @example "minha-instancia-whatsapp"
|
|
621
|
+
*/
|
|
622
|
+
instanceId: string;
|
|
623
|
+
}
|
|
624
|
+
export interface SendMessageControllerSendDocumentMessageParams {
|
|
625
|
+
/**
|
|
626
|
+
* Identificador da instância do WhatsApp
|
|
627
|
+
* @example "minha-instancia-whatsapp"
|
|
628
|
+
*/
|
|
629
|
+
instanceId: string;
|
|
630
|
+
}
|
|
631
|
+
export interface SendMessageControllerForwardMessageParams {
|
|
632
|
+
/**
|
|
633
|
+
* Identificador da instância do WhatsApp
|
|
634
|
+
* @example "minha-instancia-whatsapp"
|
|
635
|
+
*/
|
|
636
|
+
instanceId: string;
|
|
637
|
+
}
|
|
638
|
+
export interface SendMessageControllerEditMessageParams {
|
|
639
|
+
/**
|
|
640
|
+
* Identificador da instância do WhatsApp
|
|
641
|
+
* @example "minha-instancia-whatsapp"
|
|
642
|
+
*/
|
|
643
|
+
instanceId: string;
|
|
644
|
+
}
|
|
645
|
+
export interface SendMessageControllerReadMessageParams {
|
|
646
|
+
/**
|
|
647
|
+
* Identificador da instância do WhatsApp
|
|
648
|
+
* @example "minha-instancia-whatsapp"
|
|
649
|
+
*/
|
|
650
|
+
instanceId: string;
|
|
651
|
+
}
|
|
652
|
+
export interface SendMessageControllerDeleteMessageParams {
|
|
653
|
+
/**
|
|
654
|
+
* Identificador da instância do WhatsApp
|
|
655
|
+
* @example "minha-instancia-whatsapp"
|
|
656
|
+
*/
|
|
657
|
+
instanceId: string;
|
|
658
|
+
}
|
|
659
|
+
export interface SendMessageControllerGetMessageMediaDownloadLinkParams {
|
|
660
|
+
/**
|
|
661
|
+
* Identificador da instância do WhatsApp
|
|
662
|
+
* @example "minha-instancia-whatsapp"
|
|
663
|
+
*/
|
|
664
|
+
instanceId: string;
|
|
665
|
+
/**
|
|
666
|
+
* ID da mensagem do WhatsApp contendo mídia
|
|
667
|
+
* @example "3EB01CEDFD9A2E927BED83"
|
|
668
|
+
*/
|
|
669
|
+
messageId: string;
|
|
670
|
+
}
|
|
671
|
+
export declare namespace Instances {
|
|
672
|
+
/**
|
|
673
|
+
* @description Lista todas as instâncias do WhatsApp
|
|
674
|
+
* @tags Instâncias
|
|
675
|
+
* @name ManagerInstancesControllerListInstances
|
|
676
|
+
* @summary Listar Instâncias
|
|
677
|
+
* @request GET:/api/instances
|
|
678
|
+
* @secure
|
|
679
|
+
* @response `200` `(ResponsePaginated & {
|
|
680
|
+
data?: (ListInstancesResponseDto)[],
|
|
681
|
+
|
|
682
|
+
})` Lista paginada de instâncias obtida com sucesso
|
|
683
|
+
* @response `400` `BadRequestErrorDto` Dados da requisição inválidos
|
|
684
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
685
|
+
*/
|
|
686
|
+
namespace ManagerInstancesControllerListInstances {
|
|
687
|
+
type RequestParams = {};
|
|
688
|
+
type RequestQuery = {
|
|
689
|
+
/**
|
|
690
|
+
* Número da página
|
|
691
|
+
* @min 1
|
|
692
|
+
* @default 1
|
|
693
|
+
* @example 1
|
|
694
|
+
*/
|
|
695
|
+
page?: number;
|
|
696
|
+
/**
|
|
697
|
+
* Número de itens por página
|
|
698
|
+
* @min 1
|
|
699
|
+
* @max 10
|
|
700
|
+
* @default 100
|
|
701
|
+
* @example 10
|
|
702
|
+
*/
|
|
703
|
+
limit?: number;
|
|
704
|
+
};
|
|
705
|
+
type RequestBody = never;
|
|
706
|
+
type RequestHeaders = {};
|
|
707
|
+
type ResponseBody = ResponsePaginated & {
|
|
708
|
+
data?: ListInstancesResponseDto[];
|
|
709
|
+
};
|
|
710
|
+
}
|
|
711
|
+
/**
|
|
712
|
+
* No description
|
|
713
|
+
* @tags Instâncias
|
|
714
|
+
* @name ManagerInstancesControllerCreateInstance
|
|
715
|
+
* @summary Create a new WhatsApp instance (Partner only - post-paid subscriptions required)
|
|
716
|
+
* @request POST:/api/instances
|
|
717
|
+
* @secure
|
|
718
|
+
* @response `201` `ManagerInstanceResponseDto` Instance created successfully
|
|
719
|
+
* @response `400` `void` Bad request
|
|
720
|
+
*/
|
|
721
|
+
namespace ManagerInstancesControllerCreateInstance {
|
|
722
|
+
type RequestParams = {};
|
|
723
|
+
type RequestQuery = {};
|
|
724
|
+
type RequestBody = CreateInstanceRequestDto;
|
|
725
|
+
type RequestHeaders = {};
|
|
726
|
+
type ResponseBody = ManagerInstanceResponseDto;
|
|
727
|
+
}
|
|
728
|
+
/**
|
|
729
|
+
* @description Obtém o código QR para conectar a instância do WhatsApp
|
|
730
|
+
* @tags Instâncias
|
|
731
|
+
* @name ManagerInstancesControllerGetQrCode
|
|
732
|
+
* @summary Obter Código QR
|
|
733
|
+
* @request GET:/api/instances/{instanceId}/qr
|
|
734
|
+
* @secure
|
|
735
|
+
* @response `200` `QRCodeResponseDto` Código QR obtido com sucesso
|
|
736
|
+
* @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
|
|
737
|
+
* @response `404` `NotFoundErrorDto` Recurso não encontrado
|
|
738
|
+
*/
|
|
739
|
+
namespace ManagerInstancesControllerGetQrCode {
|
|
740
|
+
type RequestParams = {
|
|
741
|
+
/**
|
|
742
|
+
* Identificador da instância do WhatsApp
|
|
743
|
+
* @example "minha-instancia-whatsapp"
|
|
744
|
+
*/
|
|
745
|
+
instanceId: string;
|
|
746
|
+
};
|
|
747
|
+
type RequestQuery = {};
|
|
748
|
+
type RequestBody = never;
|
|
749
|
+
type RequestHeaders = {};
|
|
750
|
+
type ResponseBody = QRCodeResponseDto;
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
* @description Reinicia uma instância do WhatsApp
|
|
754
|
+
* @tags Instâncias
|
|
755
|
+
* @name ManagerInstancesControllerRestartInstance
|
|
756
|
+
* @summary Reiniciar Instância do WhatsApp
|
|
757
|
+
* @request POST:/api/instances/{instanceId}/restart
|
|
758
|
+
* @secure
|
|
759
|
+
* @response `200` `EmptyResponseDto` Instância reiniciada com sucesso
|
|
760
|
+
* @response `400` `BadRequestErrorDto` Dados da requisição inválidos
|
|
761
|
+
* @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
|
|
762
|
+
* @response `404` `NotFoundErrorDto` Recurso não encontrado
|
|
763
|
+
*/
|
|
764
|
+
namespace ManagerInstancesControllerRestartInstance {
|
|
765
|
+
type RequestParams = {
|
|
766
|
+
/**
|
|
767
|
+
* Identificador da instância do WhatsApp
|
|
768
|
+
* @example "minha-instancia-whatsapp"
|
|
769
|
+
*/
|
|
770
|
+
instanceId: string;
|
|
771
|
+
};
|
|
772
|
+
type RequestQuery = {};
|
|
773
|
+
type RequestBody = never;
|
|
774
|
+
type RequestHeaders = {};
|
|
775
|
+
type ResponseBody = EmptyResponseDto;
|
|
776
|
+
}
|
|
777
|
+
/**
|
|
778
|
+
* @description Desloga uma instância do WhatsApp
|
|
779
|
+
* @tags Instâncias
|
|
780
|
+
* @name ManagerInstancesControllerLogoutInstance
|
|
781
|
+
* @summary Deslogar Instância do WhatsApp
|
|
782
|
+
* @request POST:/api/instances/{instanceId}/logout
|
|
783
|
+
* @secure
|
|
784
|
+
* @response `200` `EmptyResponseDto` Instância deslogada com sucesso
|
|
785
|
+
* @response `400` `BadRequestErrorDto` Dados da requisição inválidos
|
|
786
|
+
* @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
|
|
787
|
+
* @response `404` `NotFoundErrorDto` Recurso não encontrado
|
|
788
|
+
*/
|
|
789
|
+
namespace ManagerInstancesControllerLogoutInstance {
|
|
790
|
+
type RequestParams = {
|
|
791
|
+
/**
|
|
792
|
+
* Identificador da instância do WhatsApp
|
|
793
|
+
* @example "minha-instancia-whatsapp"
|
|
794
|
+
*/
|
|
795
|
+
instanceId: string;
|
|
796
|
+
};
|
|
797
|
+
type RequestQuery = {};
|
|
798
|
+
type RequestBody = never;
|
|
799
|
+
type RequestHeaders = {};
|
|
800
|
+
type ResponseBody = EmptyResponseDto;
|
|
801
|
+
}
|
|
802
|
+
/**
|
|
803
|
+
* @description Exclui permanentemente uma instância do WhatsApp. Esta ação é irreversível.
|
|
804
|
+
* @tags Instâncias
|
|
805
|
+
* @name ManagerInstancesControllerDeleteInstance
|
|
806
|
+
* @summary Excluir Instância do WhatsApp (Somente Parceiros)
|
|
807
|
+
* @request DELETE:/api/instances/{instanceId}
|
|
808
|
+
* @secure
|
|
809
|
+
* @response `204` `void` Instância excluída com sucesso
|
|
810
|
+
* @response `400` `BadRequestErrorDto` Dados da requisição inválidos
|
|
811
|
+
* @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
|
|
812
|
+
* @response `404` `NotFoundErrorDto` Recurso não encontrado
|
|
813
|
+
*/
|
|
814
|
+
namespace ManagerInstancesControllerDeleteInstance {
|
|
815
|
+
type RequestParams = {
|
|
816
|
+
/**
|
|
817
|
+
* Identificador da instância do WhatsApp
|
|
818
|
+
* @example "minha-instancia-whatsapp"
|
|
819
|
+
*/
|
|
820
|
+
instanceId: string;
|
|
821
|
+
};
|
|
822
|
+
type RequestQuery = {};
|
|
823
|
+
type RequestBody = never;
|
|
824
|
+
type RequestHeaders = {};
|
|
825
|
+
type ResponseBody = void;
|
|
826
|
+
}
|
|
827
|
+
}
|
|
828
|
+
export declare namespace Webhooks {
|
|
829
|
+
/**
|
|
830
|
+
* @description Get the webhook configuration for the authenticated user. Returns null if no webhook is configured.
|
|
831
|
+
* @tags Webhooks
|
|
832
|
+
* @name WebhookControllerGetConfig
|
|
833
|
+
* @summary Get Webhook Configuration
|
|
834
|
+
* @request GET:/api/webhooks/config
|
|
835
|
+
* @secure
|
|
836
|
+
* @response `200` `WebhookConfigResponseDto` Webhook configuration retrieved successfully
|
|
837
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
838
|
+
*/
|
|
839
|
+
namespace WebhookControllerGetConfig {
|
|
840
|
+
type RequestParams = {};
|
|
841
|
+
type RequestQuery = {};
|
|
842
|
+
type RequestBody = never;
|
|
843
|
+
type RequestHeaders = {};
|
|
844
|
+
type ResponseBody = WebhookConfigResponseDto;
|
|
845
|
+
}
|
|
846
|
+
/**
|
|
847
|
+
* @description Create or update the webhook configuration for the authenticated user. Only one webhook URL can be configured per user, and all instance events will be sent to this URL.
|
|
848
|
+
* @tags Webhooks
|
|
849
|
+
* @name WebhookControllerUpsertConfig
|
|
850
|
+
* @summary Configure Webhook
|
|
851
|
+
* @request PUT:/api/webhooks/config
|
|
852
|
+
* @secure
|
|
853
|
+
* @response `200` `WebhookConfigResponseDto` Webhook configuration saved successfully
|
|
854
|
+
* @response `400` `BadRequestErrorDto` Dados da requisição inválidos
|
|
855
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
856
|
+
*/
|
|
857
|
+
namespace WebhookControllerUpsertConfig {
|
|
858
|
+
type RequestParams = {};
|
|
859
|
+
type RequestQuery = {};
|
|
860
|
+
type RequestBody = UpsertWebhookConfigRequestDto;
|
|
861
|
+
type RequestHeaders = {};
|
|
862
|
+
type ResponseBody = WebhookConfigResponseDto;
|
|
863
|
+
}
|
|
864
|
+
/**
|
|
865
|
+
* @description Delete the webhook configuration and all queued webhooks for the authenticated user.
|
|
866
|
+
* @tags Webhooks
|
|
867
|
+
* @name WebhookControllerDeleteConfig
|
|
868
|
+
* @summary Delete Webhook Configuration
|
|
869
|
+
* @request DELETE:/api/webhooks/config
|
|
870
|
+
* @secure
|
|
871
|
+
* @response `204` `void` Webhook configuration deleted successfully
|
|
872
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
873
|
+
*/
|
|
874
|
+
namespace WebhookControllerDeleteConfig {
|
|
875
|
+
type RequestParams = {};
|
|
876
|
+
type RequestQuery = {};
|
|
877
|
+
type RequestBody = never;
|
|
878
|
+
type RequestHeaders = {};
|
|
879
|
+
type ResponseBody = void;
|
|
880
|
+
}
|
|
881
|
+
/**
|
|
882
|
+
* @description Get the status of the webhook delivery queue, including counts of pending, failed, paused, and delivered webhooks.
|
|
883
|
+
* @tags Webhooks
|
|
884
|
+
* @name WebhookControllerGetQueueStatus
|
|
885
|
+
* @summary Get Queue Status
|
|
886
|
+
* @request GET:/api/webhooks/queue/status
|
|
887
|
+
* @secure
|
|
888
|
+
* @response `200` `WebhookQueueStatusResponseDto` Queue status retrieved successfully
|
|
889
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
890
|
+
*/
|
|
891
|
+
namespace WebhookControllerGetQueueStatus {
|
|
892
|
+
type RequestParams = {};
|
|
893
|
+
type RequestQuery = {};
|
|
894
|
+
type RequestBody = never;
|
|
895
|
+
type RequestHeaders = {};
|
|
896
|
+
type ResponseBody = WebhookQueueStatusResponseDto;
|
|
897
|
+
}
|
|
898
|
+
/**
|
|
899
|
+
* @description Resume all paused and failed webhooks. This will unpause the webhook configuration and reset all paused/failed items to pending.
|
|
900
|
+
* @tags Webhooks
|
|
901
|
+
* @name WebhookControllerResumeAll
|
|
902
|
+
* @summary Resume Webhooks
|
|
903
|
+
* @request POST:/api/webhooks/queue/resume
|
|
904
|
+
* @secure
|
|
905
|
+
* @response `200` `WebhookResumeResponseDto` Webhooks resumed successfully
|
|
906
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
907
|
+
*/
|
|
908
|
+
namespace WebhookControllerResumeAll {
|
|
909
|
+
type RequestParams = {};
|
|
910
|
+
type RequestQuery = {};
|
|
911
|
+
type RequestBody = never;
|
|
912
|
+
type RequestHeaders = {};
|
|
913
|
+
type ResponseBody = WebhookResumeResponseDto;
|
|
914
|
+
}
|
|
915
|
+
}
|
|
916
|
+
export declare namespace Message {
|
|
917
|
+
/**
|
|
918
|
+
* @description Envia uma mensagem de texto para um contato ou grupo do WhatsApp
|
|
919
|
+
* @tags Mensagens
|
|
920
|
+
* @name SendMessageControllerSendTextMessage
|
|
921
|
+
* @summary Enviar Mensagem de Texto
|
|
922
|
+
* @request POST:/api/message/{instanceId}/text
|
|
923
|
+
* @secure
|
|
924
|
+
* @response `201` `CommonSendMessageResponseDto` Mensagem enviada com sucesso
|
|
925
|
+
* @response `400` `void` Dados da requisição inválidos
|
|
926
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
927
|
+
*/
|
|
928
|
+
namespace SendMessageControllerSendTextMessage {
|
|
929
|
+
type RequestParams = {
|
|
930
|
+
/**
|
|
931
|
+
* Identificador da instância do WhatsApp
|
|
932
|
+
* @example "minha-instancia-whatsapp"
|
|
933
|
+
*/
|
|
934
|
+
instanceId: string;
|
|
935
|
+
};
|
|
936
|
+
type RequestQuery = {};
|
|
937
|
+
type RequestBody = SendMessageDto;
|
|
938
|
+
type RequestHeaders = {};
|
|
939
|
+
type ResponseBody = CommonSendMessageResponseDto;
|
|
940
|
+
}
|
|
941
|
+
/**
|
|
942
|
+
* @description Envia uma mensagem de imagem para um contato ou grupo do WhatsApp
|
|
943
|
+
* @tags Mensagens
|
|
944
|
+
* @name SendMessageControllerSendImageMessage
|
|
945
|
+
* @summary Enviar Mensagem de Imagem
|
|
946
|
+
* @request POST:/api/message/{instanceId}/image
|
|
947
|
+
* @secure
|
|
948
|
+
* @response `201` `CommonSendMessageResponseDto` Mensagem de imagem enviada com sucesso
|
|
949
|
+
* @response `400` `void` Dados da requisição inválidos ou formato de imagem inválido
|
|
950
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
951
|
+
*/
|
|
952
|
+
namespace SendMessageControllerSendImageMessage {
|
|
953
|
+
type RequestParams = {
|
|
954
|
+
/**
|
|
955
|
+
* Identificador da instância do WhatsApp
|
|
956
|
+
* @example "minha-instancia-whatsapp"
|
|
957
|
+
*/
|
|
958
|
+
instanceId: string;
|
|
959
|
+
};
|
|
960
|
+
type RequestQuery = {};
|
|
961
|
+
type RequestBody = SendImageMessageDto;
|
|
962
|
+
type RequestHeaders = {};
|
|
963
|
+
type ResponseBody = CommonSendMessageResponseDto;
|
|
964
|
+
}
|
|
965
|
+
/**
|
|
966
|
+
* @description Envia uma mensagem de vídeo para um contato ou grupo do WhatsApp
|
|
967
|
+
* @tags Mensagens
|
|
968
|
+
* @name SendMessageControllerSendVideoMessage
|
|
969
|
+
* @summary Enviar Mensagem de Vídeo
|
|
970
|
+
* @request POST:/api/message/{instanceId}/video
|
|
971
|
+
* @secure
|
|
972
|
+
* @response `201` `CommonSendMessageResponseDto` Mensagem de vídeo enviada com sucesso
|
|
973
|
+
* @response `400` `void` Dados da requisição inválidos ou formato de vídeo inválido
|
|
974
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
975
|
+
*/
|
|
976
|
+
namespace SendMessageControllerSendVideoMessage {
|
|
977
|
+
type RequestParams = {
|
|
978
|
+
/**
|
|
979
|
+
* Identificador da instância do WhatsApp
|
|
980
|
+
* @example "minha-instancia-whatsapp"
|
|
981
|
+
*/
|
|
982
|
+
instanceId: string;
|
|
983
|
+
};
|
|
984
|
+
type RequestQuery = {};
|
|
985
|
+
type RequestBody = SendVideoMessageDto;
|
|
986
|
+
type RequestHeaders = {};
|
|
987
|
+
type ResponseBody = CommonSendMessageResponseDto;
|
|
988
|
+
}
|
|
989
|
+
/**
|
|
990
|
+
* @description Envia uma nota de voz para um contato ou grupo do WhatsApp
|
|
991
|
+
* @tags Mensagens
|
|
992
|
+
* @name SendMessageControllerSendAudioNoteMessage
|
|
993
|
+
* @summary Enviar Mensagem de Áudio (Nota de Voz)
|
|
994
|
+
* @request POST:/api/message/{instanceId}/audio-note
|
|
995
|
+
* @secure
|
|
996
|
+
* @response `201` `CommonSendMessageResponseDto` Nota de voz enviada com sucesso
|
|
997
|
+
* @response `400` `void` Dados da requisição inválidos ou formato de áudio inválido
|
|
998
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
999
|
+
*/
|
|
1000
|
+
namespace SendMessageControllerSendAudioNoteMessage {
|
|
1001
|
+
type RequestParams = {
|
|
1002
|
+
/**
|
|
1003
|
+
* Identificador da instância do WhatsApp
|
|
1004
|
+
* @example "minha-instancia-whatsapp"
|
|
1005
|
+
*/
|
|
1006
|
+
instanceId: string;
|
|
1007
|
+
};
|
|
1008
|
+
type RequestQuery = {};
|
|
1009
|
+
type RequestBody = SendAudioNoteMessageDto;
|
|
1010
|
+
type RequestHeaders = {};
|
|
1011
|
+
type ResponseBody = CommonSendMessageResponseDto;
|
|
1012
|
+
}
|
|
1013
|
+
/**
|
|
1014
|
+
* @description Envia um arquivo de áudio para um contato ou grupo do WhatsApp
|
|
1015
|
+
* @tags Mensagens
|
|
1016
|
+
* @name SendMessageControllerSendAudioFileMessage
|
|
1017
|
+
* @summary Enviar Arquivo de Áudio
|
|
1018
|
+
* @request POST:/api/message/{instanceId}/audio-file
|
|
1019
|
+
* @secure
|
|
1020
|
+
* @response `201` `CommonSendMessageResponseDto` Arquivo de áudio enviado com sucesso
|
|
1021
|
+
* @response `400` `void` Dados da requisição inválidos ou formato de áudio inválido
|
|
1022
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
1023
|
+
*/
|
|
1024
|
+
namespace SendMessageControllerSendAudioFileMessage {
|
|
1025
|
+
type RequestParams = {
|
|
1026
|
+
/**
|
|
1027
|
+
* Identificador da instância do WhatsApp
|
|
1028
|
+
* @example "minha-instancia-whatsapp"
|
|
1029
|
+
*/
|
|
1030
|
+
instanceId: string;
|
|
1031
|
+
};
|
|
1032
|
+
type RequestQuery = {};
|
|
1033
|
+
type RequestBody = SendAudioFileMessageDto;
|
|
1034
|
+
type RequestHeaders = {};
|
|
1035
|
+
type ResponseBody = CommonSendMessageResponseDto;
|
|
1036
|
+
}
|
|
1037
|
+
/**
|
|
1038
|
+
* @description Envia um arquivo de documento para um contato ou grupo do WhatsApp
|
|
1039
|
+
* @tags Mensagens
|
|
1040
|
+
* @name SendMessageControllerSendDocumentMessage
|
|
1041
|
+
* @summary Enviar Documento
|
|
1042
|
+
* @request POST:/api/message/{instanceId}/document
|
|
1043
|
+
* @secure
|
|
1044
|
+
* @response `201` `CommonSendMessageResponseDto` Documento enviado com sucesso
|
|
1045
|
+
* @response `400` `void` Dados da requisição inválidos ou formato de documento inválido
|
|
1046
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
1047
|
+
*/
|
|
1048
|
+
namespace SendMessageControllerSendDocumentMessage {
|
|
1049
|
+
type RequestParams = {
|
|
1050
|
+
/**
|
|
1051
|
+
* Identificador da instância do WhatsApp
|
|
1052
|
+
* @example "minha-instancia-whatsapp"
|
|
1053
|
+
*/
|
|
1054
|
+
instanceId: string;
|
|
1055
|
+
};
|
|
1056
|
+
type RequestQuery = {};
|
|
1057
|
+
type RequestBody = SendDocumentMessageDto;
|
|
1058
|
+
type RequestHeaders = {};
|
|
1059
|
+
type ResponseBody = CommonSendMessageResponseDto;
|
|
1060
|
+
}
|
|
1061
|
+
/**
|
|
1062
|
+
* @description Encaminha uma mensagem existente para outro contato ou grupo do WhatsApp
|
|
1063
|
+
* @tags Mensagens
|
|
1064
|
+
* @name SendMessageControllerForwardMessage
|
|
1065
|
+
* @summary Encaminhar Mensagem
|
|
1066
|
+
* @request POST:/api/message/{instanceId}/forward
|
|
1067
|
+
* @secure
|
|
1068
|
+
* @response `201` `CommonSendMessageResponseDto` Mensagem encaminhada com sucesso
|
|
1069
|
+
* @response `400` `void` Dados da requisição inválidos ou mensagem não encontrada
|
|
1070
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
1071
|
+
*/
|
|
1072
|
+
namespace SendMessageControllerForwardMessage {
|
|
1073
|
+
type RequestParams = {
|
|
1074
|
+
/**
|
|
1075
|
+
* Identificador da instância do WhatsApp
|
|
1076
|
+
* @example "minha-instancia-whatsapp"
|
|
1077
|
+
*/
|
|
1078
|
+
instanceId: string;
|
|
1079
|
+
};
|
|
1080
|
+
type RequestQuery = {};
|
|
1081
|
+
type RequestBody = ForwardMessageDto;
|
|
1082
|
+
type RequestHeaders = {};
|
|
1083
|
+
type ResponseBody = CommonSendMessageResponseDto;
|
|
1084
|
+
}
|
|
1085
|
+
/**
|
|
1086
|
+
* @description Edita o conteúdo de uma mensagem de texto existente
|
|
1087
|
+
* @tags Mensagens
|
|
1088
|
+
* @name SendMessageControllerEditMessage
|
|
1089
|
+
* @summary Editar Mensagem
|
|
1090
|
+
* @request POST:/api/message/{instanceId}/edit
|
|
1091
|
+
* @secure
|
|
1092
|
+
* @response `201` `CommonSendMessageResponseDto` Mensagem editada com sucesso
|
|
1093
|
+
* @response `400` `void` Dados da requisição inválidos ou mensagem não pode ser editada
|
|
1094
|
+
* @response `404` `void` Instância do WhatsApp ou mensagem não encontrada
|
|
1095
|
+
*/
|
|
1096
|
+
namespace SendMessageControllerEditMessage {
|
|
1097
|
+
type RequestParams = {
|
|
1098
|
+
/**
|
|
1099
|
+
* Identificador da instância do WhatsApp
|
|
1100
|
+
* @example "minha-instancia-whatsapp"
|
|
1101
|
+
*/
|
|
1102
|
+
instanceId: string;
|
|
1103
|
+
};
|
|
1104
|
+
type RequestQuery = {};
|
|
1105
|
+
type RequestBody = EditMessageDto;
|
|
1106
|
+
type RequestHeaders = {};
|
|
1107
|
+
type ResponseBody = CommonSendMessageResponseDto;
|
|
1108
|
+
}
|
|
1109
|
+
/**
|
|
1110
|
+
* @description Marca uma mensagem como lida (envia confirmação de leitura)
|
|
1111
|
+
* @tags Mensagens
|
|
1112
|
+
* @name SendMessageControllerReadMessage
|
|
1113
|
+
* @summary Marcar Mensagem como Lida
|
|
1114
|
+
* @request POST:/api/message/{instanceId}/read
|
|
1115
|
+
* @secure
|
|
1116
|
+
* @response `201` `ReadMessageResponseDto` Mensagem marcada como lida com sucesso
|
|
1117
|
+
* @response `400` `void` Dados da requisição inválidos
|
|
1118
|
+
* @response `404` `void` Instância do WhatsApp ou mensagem não encontrada
|
|
1119
|
+
*/
|
|
1120
|
+
namespace SendMessageControllerReadMessage {
|
|
1121
|
+
type RequestParams = {
|
|
1122
|
+
/**
|
|
1123
|
+
* Identificador da instância do WhatsApp
|
|
1124
|
+
* @example "minha-instancia-whatsapp"
|
|
1125
|
+
*/
|
|
1126
|
+
instanceId: string;
|
|
1127
|
+
};
|
|
1128
|
+
type RequestQuery = {};
|
|
1129
|
+
type RequestBody = ReadMessageDto;
|
|
1130
|
+
type RequestHeaders = {};
|
|
1131
|
+
type ResponseBody = ReadMessageResponseDto;
|
|
1132
|
+
}
|
|
1133
|
+
/**
|
|
1134
|
+
* @description Exclui uma mensagem para todos no chat
|
|
1135
|
+
* @tags Mensagens
|
|
1136
|
+
* @name SendMessageControllerDeleteMessage
|
|
1137
|
+
* @summary Excluir Mensagem
|
|
1138
|
+
* @request DELETE:/api/message/{instanceId}/delete
|
|
1139
|
+
* @secure
|
|
1140
|
+
* @response `204` `void` Mensagem excluída com sucesso
|
|
1141
|
+
* @response `400` `void` Dados da requisição inválidos ou mensagem não pode ser excluída
|
|
1142
|
+
* @response `404` `void` Instância do WhatsApp ou mensagem não encontrada
|
|
1143
|
+
*/
|
|
1144
|
+
namespace SendMessageControllerDeleteMessage {
|
|
1145
|
+
type RequestParams = {
|
|
1146
|
+
/**
|
|
1147
|
+
* Identificador da instância do WhatsApp
|
|
1148
|
+
* @example "minha-instancia-whatsapp"
|
|
1149
|
+
*/
|
|
1150
|
+
instanceId: string;
|
|
1151
|
+
};
|
|
1152
|
+
type RequestQuery = {};
|
|
1153
|
+
type RequestBody = DeleteMessageDto;
|
|
1154
|
+
type RequestHeaders = {};
|
|
1155
|
+
type ResponseBody = void;
|
|
1156
|
+
}
|
|
1157
|
+
/**
|
|
1158
|
+
* @description Obtém um link de download para conteúdo de mídia de uma mensagem
|
|
1159
|
+
* @tags Mensagens
|
|
1160
|
+
* @name SendMessageControllerGetMessageMediaDownloadLink
|
|
1161
|
+
* @summary Obter Link de Download de Mídia
|
|
1162
|
+
* @request GET:/api/message/{instanceId}/media-download-link/{messageId}
|
|
1163
|
+
* @secure
|
|
1164
|
+
* @response `200` `GetMessageMediaDownloadLinkResponseDto` Link de download de mídia obtido com sucesso
|
|
1165
|
+
* @response `400` `void` Formato de ID da mensagem inválido
|
|
1166
|
+
* @response `404` `void` Instância do WhatsApp, mensagem ou mídia não encontrada
|
|
1167
|
+
*/
|
|
1168
|
+
namespace SendMessageControllerGetMessageMediaDownloadLink {
|
|
1169
|
+
type RequestParams = {
|
|
1170
|
+
/**
|
|
1171
|
+
* Identificador da instância do WhatsApp
|
|
1172
|
+
* @example "minha-instancia-whatsapp"
|
|
1173
|
+
*/
|
|
1174
|
+
instanceId: string;
|
|
1175
|
+
/**
|
|
1176
|
+
* ID da mensagem do WhatsApp contendo mídia
|
|
1177
|
+
* @example "3EB01CEDFD9A2E927BED83"
|
|
1178
|
+
*/
|
|
1179
|
+
messageId: string;
|
|
1180
|
+
};
|
|
1181
|
+
type RequestQuery = {};
|
|
1182
|
+
type RequestBody = never;
|
|
1183
|
+
type RequestHeaders = {};
|
|
1184
|
+
type ResponseBody = GetMessageMediaDownloadLinkResponseDto;
|
|
1185
|
+
}
|
|
1186
|
+
}
|
|
1187
|
+
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
1188
|
+
export type QueryParamsType = Record<string | number, any>;
|
|
1189
|
+
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
1190
|
+
/** set parameter to `true` for call `securityWorker` for this request */
|
|
1191
|
+
secure?: boolean;
|
|
1192
|
+
/** request path */
|
|
1193
|
+
path: string;
|
|
1194
|
+
/** content type of request body */
|
|
1195
|
+
type?: ContentType;
|
|
1196
|
+
/** query params */
|
|
1197
|
+
query?: QueryParamsType;
|
|
1198
|
+
/** format of response (i.e. response.json() -> format: "json") */
|
|
1199
|
+
format?: ResponseType;
|
|
1200
|
+
/** request body */
|
|
1201
|
+
body?: unknown;
|
|
1202
|
+
}
|
|
1203
|
+
export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
|
|
1204
|
+
export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
|
|
1205
|
+
securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
|
|
1206
|
+
secure?: boolean;
|
|
1207
|
+
format?: ResponseType;
|
|
1208
|
+
}
|
|
1209
|
+
export declare enum ContentType {
|
|
1210
|
+
Json = "application/json",
|
|
1211
|
+
JsonApi = "application/vnd.api+json",
|
|
1212
|
+
FormData = "multipart/form-data",
|
|
1213
|
+
UrlEncoded = "application/x-www-form-urlencoded",
|
|
1214
|
+
Text = "text/plain"
|
|
1215
|
+
}
|
|
1216
|
+
export declare class HttpClient<SecurityDataType = unknown> {
|
|
1217
|
+
instance: AxiosInstance;
|
|
1218
|
+
private securityData;
|
|
1219
|
+
private securityWorker?;
|
|
1220
|
+
private secure?;
|
|
1221
|
+
private format?;
|
|
1222
|
+
constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
|
|
1223
|
+
setSecurityData: (data: SecurityDataType | null) => void;
|
|
1224
|
+
protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
|
|
1225
|
+
protected stringifyFormItem(formItem: unknown): string;
|
|
1226
|
+
protected createFormData(input: Record<string, unknown>): FormData;
|
|
1227
|
+
request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T>>;
|
|
1228
|
+
}
|
|
1229
|
+
/**
|
|
1230
|
+
* @title Zapy API - Gerenciador de Instâncias WhatsApp
|
|
1231
|
+
* @version 1.0.0
|
|
1232
|
+
* @contact Suporte Zapy API <contato@zapyapi.com> (http://app.zapyapi.com/)
|
|
1233
|
+
*
|
|
1234
|
+
*
|
|
1235
|
+
* Formatos de Mensagem
|
|
1236
|
+
* - Números de Telefone: Formato brasileiro (11999999999) ou internacional (5511999999999)
|
|
1237
|
+
* - IDs do WhatsApp: Pessoal (@c.us), Grupos (@g.us), LIDs (@lid)
|
|
1238
|
+
* - Mídia: Arquivos codificados em Base64 ou URLs públicas
|
|
1239
|
+
*
|
|
1240
|
+
* Suporte
|
|
1241
|
+
* Para suporte técnico e documentação, visite nosso site.
|
|
1242
|
+
* https://app.zapyapi.com/
|
|
1243
|
+
*
|
|
1244
|
+
*/
|
|
1245
|
+
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
1246
|
+
instances: {
|
|
1247
|
+
/**
|
|
1248
|
+
* @description Lista todas as instâncias do WhatsApp
|
|
1249
|
+
*
|
|
1250
|
+
* @tags Instâncias
|
|
1251
|
+
* @name ManagerInstancesControllerListInstances
|
|
1252
|
+
* @summary Listar Instâncias
|
|
1253
|
+
* @request GET:/api/instances
|
|
1254
|
+
* @secure
|
|
1255
|
+
* @response `200` `(ResponsePaginated & {
|
|
1256
|
+
data?: (ListInstancesResponseDto)[],
|
|
1257
|
+
|
|
1258
|
+
})` Lista paginada de instâncias obtida com sucesso
|
|
1259
|
+
* @response `400` `BadRequestErrorDto` Dados da requisição inválidos
|
|
1260
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
1261
|
+
*/
|
|
1262
|
+
managerInstancesControllerListInstances: (query: ManagerInstancesControllerListInstancesParams, params?: RequestParams) => Promise<AxiosResponse<ResponsePaginated & {
|
|
1263
|
+
data?: ListInstancesResponseDto[];
|
|
1264
|
+
}, any, {}>>;
|
|
1265
|
+
/**
|
|
1266
|
+
* No description
|
|
1267
|
+
*
|
|
1268
|
+
* @tags Instâncias
|
|
1269
|
+
* @name ManagerInstancesControllerCreateInstance
|
|
1270
|
+
* @summary Create a new WhatsApp instance (Partner only - post-paid subscriptions required)
|
|
1271
|
+
* @request POST:/api/instances
|
|
1272
|
+
* @secure
|
|
1273
|
+
* @response `201` `ManagerInstanceResponseDto` Instance created successfully
|
|
1274
|
+
* @response `400` `void` Bad request
|
|
1275
|
+
*/
|
|
1276
|
+
managerInstancesControllerCreateInstance: (data: CreateInstanceRequestDto, params?: RequestParams) => Promise<AxiosResponse<ManagerInstanceResponseDto, any, {}>>;
|
|
1277
|
+
/**
|
|
1278
|
+
* @description Obtém o código QR para conectar a instância do WhatsApp
|
|
1279
|
+
*
|
|
1280
|
+
* @tags Instâncias
|
|
1281
|
+
* @name ManagerInstancesControllerGetQrCode
|
|
1282
|
+
* @summary Obter Código QR
|
|
1283
|
+
* @request GET:/api/instances/{instanceId}/qr
|
|
1284
|
+
* @secure
|
|
1285
|
+
* @response `200` `QRCodeResponseDto` Código QR obtido com sucesso
|
|
1286
|
+
* @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
|
|
1287
|
+
* @response `404` `NotFoundErrorDto` Recurso não encontrado
|
|
1288
|
+
*/
|
|
1289
|
+
managerInstancesControllerGetQrCode: ({ instanceId, ...query }: ManagerInstancesControllerGetQrCodeParams, params?: RequestParams) => Promise<AxiosResponse<QRCodeResponseDto, any, {}>>;
|
|
1290
|
+
/**
|
|
1291
|
+
* @description Reinicia uma instância do WhatsApp
|
|
1292
|
+
*
|
|
1293
|
+
* @tags Instâncias
|
|
1294
|
+
* @name ManagerInstancesControllerRestartInstance
|
|
1295
|
+
* @summary Reiniciar Instância do WhatsApp
|
|
1296
|
+
* @request POST:/api/instances/{instanceId}/restart
|
|
1297
|
+
* @secure
|
|
1298
|
+
* @response `200` `EmptyResponseDto` Instância reiniciada com sucesso
|
|
1299
|
+
* @response `400` `BadRequestErrorDto` Dados da requisição inválidos
|
|
1300
|
+
* @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
|
|
1301
|
+
* @response `404` `NotFoundErrorDto` Recurso não encontrado
|
|
1302
|
+
*/
|
|
1303
|
+
managerInstancesControllerRestartInstance: ({ instanceId, ...query }: ManagerInstancesControllerRestartInstanceParams, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
1304
|
+
/**
|
|
1305
|
+
* @description Desloga uma instância do WhatsApp
|
|
1306
|
+
*
|
|
1307
|
+
* @tags Instâncias
|
|
1308
|
+
* @name ManagerInstancesControllerLogoutInstance
|
|
1309
|
+
* @summary Deslogar Instância do WhatsApp
|
|
1310
|
+
* @request POST:/api/instances/{instanceId}/logout
|
|
1311
|
+
* @secure
|
|
1312
|
+
* @response `200` `EmptyResponseDto` Instância deslogada com sucesso
|
|
1313
|
+
* @response `400` `BadRequestErrorDto` Dados da requisição inválidos
|
|
1314
|
+
* @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
|
|
1315
|
+
* @response `404` `NotFoundErrorDto` Recurso não encontrado
|
|
1316
|
+
*/
|
|
1317
|
+
managerInstancesControllerLogoutInstance: ({ instanceId, ...query }: ManagerInstancesControllerLogoutInstanceParams, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
1318
|
+
/**
|
|
1319
|
+
* @description Exclui permanentemente uma instância do WhatsApp. Esta ação é irreversível.
|
|
1320
|
+
*
|
|
1321
|
+
* @tags Instâncias
|
|
1322
|
+
* @name ManagerInstancesControllerDeleteInstance
|
|
1323
|
+
* @summary Excluir Instância do WhatsApp (Somente Parceiros)
|
|
1324
|
+
* @request DELETE:/api/instances/{instanceId}
|
|
1325
|
+
* @secure
|
|
1326
|
+
* @response `204` `void` Instância excluída com sucesso
|
|
1327
|
+
* @response `400` `BadRequestErrorDto` Dados da requisição inválidos
|
|
1328
|
+
* @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
|
|
1329
|
+
* @response `404` `NotFoundErrorDto` Recurso não encontrado
|
|
1330
|
+
*/
|
|
1331
|
+
managerInstancesControllerDeleteInstance: ({ instanceId, ...query }: ManagerInstancesControllerDeleteInstanceParams, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
1332
|
+
};
|
|
1333
|
+
webhooks: {
|
|
1334
|
+
/**
|
|
1335
|
+
* @description Get the webhook configuration for the authenticated user. Returns null if no webhook is configured.
|
|
1336
|
+
*
|
|
1337
|
+
* @tags Webhooks
|
|
1338
|
+
* @name WebhookControllerGetConfig
|
|
1339
|
+
* @summary Get Webhook Configuration
|
|
1340
|
+
* @request GET:/api/webhooks/config
|
|
1341
|
+
* @secure
|
|
1342
|
+
* @response `200` `WebhookConfigResponseDto` Webhook configuration retrieved successfully
|
|
1343
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
1344
|
+
*/
|
|
1345
|
+
webhookControllerGetConfig: (params?: RequestParams) => Promise<AxiosResponse<WebhookConfigResponseDto, any, {}>>;
|
|
1346
|
+
/**
|
|
1347
|
+
* @description Create or update the webhook configuration for the authenticated user. Only one webhook URL can be configured per user, and all instance events will be sent to this URL.
|
|
1348
|
+
*
|
|
1349
|
+
* @tags Webhooks
|
|
1350
|
+
* @name WebhookControllerUpsertConfig
|
|
1351
|
+
* @summary Configure Webhook
|
|
1352
|
+
* @request PUT:/api/webhooks/config
|
|
1353
|
+
* @secure
|
|
1354
|
+
* @response `200` `WebhookConfigResponseDto` Webhook configuration saved successfully
|
|
1355
|
+
* @response `400` `BadRequestErrorDto` Dados da requisição inválidos
|
|
1356
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
1357
|
+
*/
|
|
1358
|
+
webhookControllerUpsertConfig: (data: UpsertWebhookConfigRequestDto, params?: RequestParams) => Promise<AxiosResponse<WebhookConfigResponseDto, any, {}>>;
|
|
1359
|
+
/**
|
|
1360
|
+
* @description Delete the webhook configuration and all queued webhooks for the authenticated user.
|
|
1361
|
+
*
|
|
1362
|
+
* @tags Webhooks
|
|
1363
|
+
* @name WebhookControllerDeleteConfig
|
|
1364
|
+
* @summary Delete Webhook Configuration
|
|
1365
|
+
* @request DELETE:/api/webhooks/config
|
|
1366
|
+
* @secure
|
|
1367
|
+
* @response `204` `void` Webhook configuration deleted successfully
|
|
1368
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
1369
|
+
*/
|
|
1370
|
+
webhookControllerDeleteConfig: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
1371
|
+
/**
|
|
1372
|
+
* @description Get the status of the webhook delivery queue, including counts of pending, failed, paused, and delivered webhooks.
|
|
1373
|
+
*
|
|
1374
|
+
* @tags Webhooks
|
|
1375
|
+
* @name WebhookControllerGetQueueStatus
|
|
1376
|
+
* @summary Get Queue Status
|
|
1377
|
+
* @request GET:/api/webhooks/queue/status
|
|
1378
|
+
* @secure
|
|
1379
|
+
* @response `200` `WebhookQueueStatusResponseDto` Queue status retrieved successfully
|
|
1380
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
1381
|
+
*/
|
|
1382
|
+
webhookControllerGetQueueStatus: (params?: RequestParams) => Promise<AxiosResponse<WebhookQueueStatusResponseDto, any, {}>>;
|
|
1383
|
+
/**
|
|
1384
|
+
* @description Resume all paused and failed webhooks. This will unpause the webhook configuration and reset all paused/failed items to pending.
|
|
1385
|
+
*
|
|
1386
|
+
* @tags Webhooks
|
|
1387
|
+
* @name WebhookControllerResumeAll
|
|
1388
|
+
* @summary Resume Webhooks
|
|
1389
|
+
* @request POST:/api/webhooks/queue/resume
|
|
1390
|
+
* @secure
|
|
1391
|
+
* @response `200` `WebhookResumeResponseDto` Webhooks resumed successfully
|
|
1392
|
+
* @response `401` `UnauthorizedErrorDto` Não autorizado - API key inválida ou ausente
|
|
1393
|
+
*/
|
|
1394
|
+
webhookControllerResumeAll: (params?: RequestParams) => Promise<AxiosResponse<WebhookResumeResponseDto, any, {}>>;
|
|
1395
|
+
};
|
|
1396
|
+
message: {
|
|
1397
|
+
/**
|
|
1398
|
+
* @description Envia uma mensagem de texto para um contato ou grupo do WhatsApp
|
|
1399
|
+
*
|
|
1400
|
+
* @tags Mensagens
|
|
1401
|
+
* @name SendMessageControllerSendTextMessage
|
|
1402
|
+
* @summary Enviar Mensagem de Texto
|
|
1403
|
+
* @request POST:/api/message/{instanceId}/text
|
|
1404
|
+
* @secure
|
|
1405
|
+
* @response `201` `CommonSendMessageResponseDto` Mensagem enviada com sucesso
|
|
1406
|
+
* @response `400` `void` Dados da requisição inválidos
|
|
1407
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
1408
|
+
*/
|
|
1409
|
+
sendMessageControllerSendTextMessage: ({ instanceId, ...query }: SendMessageControllerSendTextMessageParams, data: SendMessageDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
|
|
1410
|
+
/**
|
|
1411
|
+
* @description Envia uma mensagem de imagem para um contato ou grupo do WhatsApp
|
|
1412
|
+
*
|
|
1413
|
+
* @tags Mensagens
|
|
1414
|
+
* @name SendMessageControllerSendImageMessage
|
|
1415
|
+
* @summary Enviar Mensagem de Imagem
|
|
1416
|
+
* @request POST:/api/message/{instanceId}/image
|
|
1417
|
+
* @secure
|
|
1418
|
+
* @response `201` `CommonSendMessageResponseDto` Mensagem de imagem enviada com sucesso
|
|
1419
|
+
* @response `400` `void` Dados da requisição inválidos ou formato de imagem inválido
|
|
1420
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
1421
|
+
*/
|
|
1422
|
+
sendMessageControllerSendImageMessage: ({ instanceId, ...query }: SendMessageControllerSendImageMessageParams, data: SendImageMessageDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
|
|
1423
|
+
/**
|
|
1424
|
+
* @description Envia uma mensagem de vídeo para um contato ou grupo do WhatsApp
|
|
1425
|
+
*
|
|
1426
|
+
* @tags Mensagens
|
|
1427
|
+
* @name SendMessageControllerSendVideoMessage
|
|
1428
|
+
* @summary Enviar Mensagem de Vídeo
|
|
1429
|
+
* @request POST:/api/message/{instanceId}/video
|
|
1430
|
+
* @secure
|
|
1431
|
+
* @response `201` `CommonSendMessageResponseDto` Mensagem de vídeo enviada com sucesso
|
|
1432
|
+
* @response `400` `void` Dados da requisição inválidos ou formato de vídeo inválido
|
|
1433
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
1434
|
+
*/
|
|
1435
|
+
sendMessageControllerSendVideoMessage: ({ instanceId, ...query }: SendMessageControllerSendVideoMessageParams, data: SendVideoMessageDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
|
|
1436
|
+
/**
|
|
1437
|
+
* @description Envia uma nota de voz para um contato ou grupo do WhatsApp
|
|
1438
|
+
*
|
|
1439
|
+
* @tags Mensagens
|
|
1440
|
+
* @name SendMessageControllerSendAudioNoteMessage
|
|
1441
|
+
* @summary Enviar Mensagem de Áudio (Nota de Voz)
|
|
1442
|
+
* @request POST:/api/message/{instanceId}/audio-note
|
|
1443
|
+
* @secure
|
|
1444
|
+
* @response `201` `CommonSendMessageResponseDto` Nota de voz enviada com sucesso
|
|
1445
|
+
* @response `400` `void` Dados da requisição inválidos ou formato de áudio inválido
|
|
1446
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
1447
|
+
*/
|
|
1448
|
+
sendMessageControllerSendAudioNoteMessage: ({ instanceId, ...query }: SendMessageControllerSendAudioNoteMessageParams, data: SendAudioNoteMessageDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
|
|
1449
|
+
/**
|
|
1450
|
+
* @description Envia um arquivo de áudio para um contato ou grupo do WhatsApp
|
|
1451
|
+
*
|
|
1452
|
+
* @tags Mensagens
|
|
1453
|
+
* @name SendMessageControllerSendAudioFileMessage
|
|
1454
|
+
* @summary Enviar Arquivo de Áudio
|
|
1455
|
+
* @request POST:/api/message/{instanceId}/audio-file
|
|
1456
|
+
* @secure
|
|
1457
|
+
* @response `201` `CommonSendMessageResponseDto` Arquivo de áudio enviado com sucesso
|
|
1458
|
+
* @response `400` `void` Dados da requisição inválidos ou formato de áudio inválido
|
|
1459
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
1460
|
+
*/
|
|
1461
|
+
sendMessageControllerSendAudioFileMessage: ({ instanceId, ...query }: SendMessageControllerSendAudioFileMessageParams, data: SendAudioFileMessageDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
|
|
1462
|
+
/**
|
|
1463
|
+
* @description Envia um arquivo de documento para um contato ou grupo do WhatsApp
|
|
1464
|
+
*
|
|
1465
|
+
* @tags Mensagens
|
|
1466
|
+
* @name SendMessageControllerSendDocumentMessage
|
|
1467
|
+
* @summary Enviar Documento
|
|
1468
|
+
* @request POST:/api/message/{instanceId}/document
|
|
1469
|
+
* @secure
|
|
1470
|
+
* @response `201` `CommonSendMessageResponseDto` Documento enviado com sucesso
|
|
1471
|
+
* @response `400` `void` Dados da requisição inválidos ou formato de documento inválido
|
|
1472
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
1473
|
+
*/
|
|
1474
|
+
sendMessageControllerSendDocumentMessage: ({ instanceId, ...query }: SendMessageControllerSendDocumentMessageParams, data: SendDocumentMessageDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
|
|
1475
|
+
/**
|
|
1476
|
+
* @description Encaminha uma mensagem existente para outro contato ou grupo do WhatsApp
|
|
1477
|
+
*
|
|
1478
|
+
* @tags Mensagens
|
|
1479
|
+
* @name SendMessageControllerForwardMessage
|
|
1480
|
+
* @summary Encaminhar Mensagem
|
|
1481
|
+
* @request POST:/api/message/{instanceId}/forward
|
|
1482
|
+
* @secure
|
|
1483
|
+
* @response `201` `CommonSendMessageResponseDto` Mensagem encaminhada com sucesso
|
|
1484
|
+
* @response `400` `void` Dados da requisição inválidos ou mensagem não encontrada
|
|
1485
|
+
* @response `404` `void` Instância do WhatsApp não encontrada
|
|
1486
|
+
*/
|
|
1487
|
+
sendMessageControllerForwardMessage: ({ instanceId, ...query }: SendMessageControllerForwardMessageParams, data: ForwardMessageDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
|
|
1488
|
+
/**
|
|
1489
|
+
* @description Edita o conteúdo de uma mensagem de texto existente
|
|
1490
|
+
*
|
|
1491
|
+
* @tags Mensagens
|
|
1492
|
+
* @name SendMessageControllerEditMessage
|
|
1493
|
+
* @summary Editar Mensagem
|
|
1494
|
+
* @request POST:/api/message/{instanceId}/edit
|
|
1495
|
+
* @secure
|
|
1496
|
+
* @response `201` `CommonSendMessageResponseDto` Mensagem editada com sucesso
|
|
1497
|
+
* @response `400` `void` Dados da requisição inválidos ou mensagem não pode ser editada
|
|
1498
|
+
* @response `404` `void` Instância do WhatsApp ou mensagem não encontrada
|
|
1499
|
+
*/
|
|
1500
|
+
sendMessageControllerEditMessage: ({ instanceId, ...query }: SendMessageControllerEditMessageParams, data: EditMessageDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
|
|
1501
|
+
/**
|
|
1502
|
+
* @description Marca uma mensagem como lida (envia confirmação de leitura)
|
|
1503
|
+
*
|
|
1504
|
+
* @tags Mensagens
|
|
1505
|
+
* @name SendMessageControllerReadMessage
|
|
1506
|
+
* @summary Marcar Mensagem como Lida
|
|
1507
|
+
* @request POST:/api/message/{instanceId}/read
|
|
1508
|
+
* @secure
|
|
1509
|
+
* @response `201` `ReadMessageResponseDto` Mensagem marcada como lida com sucesso
|
|
1510
|
+
* @response `400` `void` Dados da requisição inválidos
|
|
1511
|
+
* @response `404` `void` Instância do WhatsApp ou mensagem não encontrada
|
|
1512
|
+
*/
|
|
1513
|
+
sendMessageControllerReadMessage: ({ instanceId, ...query }: SendMessageControllerReadMessageParams, data: ReadMessageDto, params?: RequestParams) => Promise<AxiosResponse<ReadMessageResponseDto, any, {}>>;
|
|
1514
|
+
/**
|
|
1515
|
+
* @description Exclui uma mensagem para todos no chat
|
|
1516
|
+
*
|
|
1517
|
+
* @tags Mensagens
|
|
1518
|
+
* @name SendMessageControllerDeleteMessage
|
|
1519
|
+
* @summary Excluir Mensagem
|
|
1520
|
+
* @request DELETE:/api/message/{instanceId}/delete
|
|
1521
|
+
* @secure
|
|
1522
|
+
* @response `204` `void` Mensagem excluída com sucesso
|
|
1523
|
+
* @response `400` `void` Dados da requisição inválidos ou mensagem não pode ser excluída
|
|
1524
|
+
* @response `404` `void` Instância do WhatsApp ou mensagem não encontrada
|
|
1525
|
+
*/
|
|
1526
|
+
sendMessageControllerDeleteMessage: ({ instanceId, ...query }: SendMessageControllerDeleteMessageParams, data: DeleteMessageDto, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
1527
|
+
/**
|
|
1528
|
+
* @description Obtém um link de download para conteúdo de mídia de uma mensagem
|
|
1529
|
+
*
|
|
1530
|
+
* @tags Mensagens
|
|
1531
|
+
* @name SendMessageControllerGetMessageMediaDownloadLink
|
|
1532
|
+
* @summary Obter Link de Download de Mídia
|
|
1533
|
+
* @request GET:/api/message/{instanceId}/media-download-link/{messageId}
|
|
1534
|
+
* @secure
|
|
1535
|
+
* @response `200` `GetMessageMediaDownloadLinkResponseDto` Link de download de mídia obtido com sucesso
|
|
1536
|
+
* @response `400` `void` Formato de ID da mensagem inválido
|
|
1537
|
+
* @response `404` `void` Instância do WhatsApp, mensagem ou mídia não encontrada
|
|
1538
|
+
*/
|
|
1539
|
+
sendMessageControllerGetMessageMediaDownloadLink: ({ instanceId, messageId, ...query }: SendMessageControllerGetMessageMediaDownloadLinkParams, params?: RequestParams) => Promise<AxiosResponse<GetMessageMediaDownloadLinkResponseDto, any, {}>>;
|
|
1540
|
+
};
|
|
1541
|
+
}
|
|
1542
|
+
//# sourceMappingURL=Api.d.ts.map
|