-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathwebhook-events-example.js
More file actions
709 lines (614 loc) Β· 21.6 KB
/
webhook-events-example.js
File metadata and controls
709 lines (614 loc) Β· 21.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
// Comprehensive webhook events handling example for WuzAPI
// This example shows how to handle different types of WhatsApp events via webhooks
//
// TOKEN USAGE OPTIONS:
//
// Option 1: Traditional global token (used in this example)
// const client = new WuzapiClient({
// apiUrl: "http://localhost:8080",
// token: "your-user-token-here",
// });
//
// Option 2: Flexible per-request tokens
// const client = new WuzapiClient({
// apiUrl: "http://localhost:8080",
// // No global token
// });
//
// Then for each API call, add the second parameter:
// await client.chat.sendText(messageData, { token: "user-specific-token" });
// await client.session.getStatus({ token: "user-specific-token" });
//
// This allows using different tokens for different operations in the same client instance.
import WuzapiClient, {
getMessageContent,
EventType,
hasS3Media,
hasBase64Media,
hasBothMedia,
} from "wuzapi";
import express from "express";
const app = express();
app.use(express.json());
// Initialize the client (using traditional global token approach)
const client = new WuzapiClient({
apiUrl: "http://localhost:8080",
token: "your-user-token-here",
});
// Event handlers for different types of WhatsApp events
const eventHandlers = {
// Message events
handleMessage: async (event) => {
const { Info, Message, IsEphemeral, IsViewOnce } = event;
const from = Info.RemoteJid.replace("@s.whatsapp.net", "");
const isGroup = Info.RemoteJid.includes("@g.us");
console.log(`π¨ New message from ${from}${isGroup ? " (group)" : ""}`);
if (IsEphemeral) console.log("β±οΈ Ephemeral message");
if (IsViewOnce) console.log("ποΈ View once message");
// Use the utility function to get message content and type
const messageContent = getMessageContent(Message);
if (!messageContent) {
console.log("β Unknown message type");
return;
}
// Handle different message types based on the structured content
switch (messageContent.type) {
case "text":
console.log(`π¬ Text: ${messageContent.content}`);
// Auto-reply example
if (messageContent.content.toLowerCase().includes("hello")) {
await client.chat.sendText({
Phone: from,
Body: "π Hello! Thanks for your message.",
});
// With flexible tokens, you would add: , { token: "user-specific-token" }
}
break;
case "extendedText":
console.log(`π Extended text: ${messageContent.content.text}`);
if (messageContent.content.canonicalUrl) {
console.log(`π Link: ${messageContent.content.canonicalUrl}`);
}
break;
case "image":
console.log(
`πΌοΈ Image: ${messageContent.content.caption || "No caption"}`
);
console.log(
`π Dimensions: ${messageContent.content.width}x${messageContent.content.height}`
);
// Example: Download image if needed
if (messageContent.content.url && messageContent.content.mediaKey) {
try {
const media = await client.chat.downloadImage({
Url: messageContent.content.url,
MediaKey: Array.from(messageContent.content.mediaKey),
Mimetype: messageContent.content.mimetype,
FileSHA256: Array.from(messageContent.content.fileSha256),
FileLength: messageContent.content.fileLength,
});
console.log("β
Image downloaded successfully");
} catch (error) {
console.log("β Failed to download image:", error.message);
}
}
break;
case "video":
console.log(
`π₯ Video: ${messageContent.content.caption || "No caption"}`
);
console.log(`β±οΈ Duration: ${messageContent.content.seconds}s`);
if (messageContent.content.gifPlayback) {
console.log("π¬ GIF playback enabled");
}
break;
case "audio":
console.log(`π΅ Audio message: ${messageContent.content.seconds}s`);
if (messageContent.content.ptt) {
console.log("π€ Voice note (Push-to-talk)");
}
break;
case "document":
console.log(
`π Document: ${
messageContent.content.fileName || messageContent.content.title
}`
);
console.log(`π Size: ${messageContent.content.fileLength} bytes`);
console.log(`π Type: ${messageContent.content.mimetype}`);
if (messageContent.content.pageCount) {
console.log(`π Pages: ${messageContent.content.pageCount}`);
}
break;
case "sticker":
console.log(`π Sticker`);
if (messageContent.content.isAnimated) {
console.log("π¬ Animated sticker");
}
if (messageContent.content.isLottie) {
console.log("π¨ Lottie sticker");
}
break;
case "location":
const { degreesLatitude, degreesLongitude, name, address } =
messageContent.content;
console.log(`π Location: ${degreesLatitude}, ${degreesLongitude}`);
if (name) console.log(`π·οΈ Name: ${name}`);
if (address) console.log(`π Address: ${address}`);
if (messageContent.content.isLiveLocation) {
console.log("π‘ Live location sharing");
}
break;
case "contact":
console.log(`π€ Contact: ${messageContent.content.displayName}`);
break;
case "contactsArray":
console.log(
`π₯ Multiple contacts: ${
messageContent.content.contacts?.length || 0
} contacts`
);
break;
case "buttons":
console.log(
`π Interactive buttons: ${messageContent.content.contentText}`
);
console.log(
`π’ ${messageContent.content.buttons?.length || 0} buttons`
);
break;
case "list":
console.log(`π List message: ${messageContent.content.title}`);
console.log(
`π ${messageContent.content.sections?.length || 0} sections`
);
break;
case "template":
console.log(`π Template message`);
if (messageContent.content.hydratedTemplate) {
console.log(
`π° Title: ${messageContent.content.hydratedTemplate.title}`
);
}
break;
case "buttonsResponse":
console.log(
`β
Button response: ${messageContent.content.selectedDisplayText}`
);
console.log(`π Button ID: ${messageContent.content.selectedButtonId}`);
break;
case "listResponse":
console.log(`β
List response: ${messageContent.content.title}`);
if (messageContent.content.singleSelectReply) {
console.log(
`π Selected: ${messageContent.content.singleSelectReply.selectedRowId}`
);
}
break;
case "groupInvite":
console.log(`π₯ Group invite: ${messageContent.content.groupName}`);
console.log(`π Invite code: ${messageContent.content.inviteCode}`);
break;
case "poll":
console.log(`π Poll: ${messageContent.content.name}`);
console.log(
`π’ Options: ${messageContent.content.options?.length || 0}`
);
console.log(
`β
Max selections: ${
messageContent.content.selectableOptionsCount || 1
}`
);
break;
case "pollUpdate":
console.log(`π³οΈ Poll vote update`);
break;
case "reaction":
console.log(`π Reaction: ${messageContent.content.text}`);
console.log(`π To message: ${messageContent.content.key?.id}`);
break;
case "protocol":
console.log(`βοΈ Protocol message: ${messageContent.content.type}`);
break;
case "ephemeral":
console.log(`β±οΈ Ephemeral message wrapper`);
// Handle the nested message
if (messageContent.content.message) {
const nestedContent = getMessageContent(
messageContent.content.message
);
if (nestedContent) {
console.log(`β³ Contains: ${nestedContent.type}`);
}
}
break;
case "viewOnce":
console.log(`ποΈ View once message wrapper`);
// Handle the nested message
if (messageContent.content.message) {
const nestedContent = getMessageContent(
messageContent.content.message
);
if (nestedContent) {
console.log(`β³ Contains: ${nestedContent.type}`);
}
}
break;
default:
console.log(`β Unhandled message type: ${messageContent.type}`);
}
},
// Receipt events (message delivery/read confirmations)
handleReceipt: async (event) => {
const { MessageSource, MessageIDs, Type, Timestamp } = event;
const from = MessageSource.Chat.User;
console.log(
`π Receipt from ${from}: ${Type} for ${MessageIDs.length} message(s)`
);
switch (Type) {
case "delivery":
console.log(`β
Messages delivered to ${from}`);
break;
case "read":
console.log(`π Messages read by ${from}`);
break;
case "played":
console.log(`βΆοΈ Voice/video messages played by ${from}`);
break;
}
},
// Presence events (typing, online/offline status)
handlePresence: async (event) => {
const { From, Unavailable, LastSeen } = event;
const user = From.User;
if (Unavailable) {
console.log(`π΄ ${user} went offline (last seen: ${LastSeen})`);
} else {
console.log(`π’ ${user} is online`);
}
},
// Chat presence events (typing indicators)
handleChatPresence: async (event) => {
const { MessageSource, State, Media } = event;
const from = MessageSource.Sender.User;
const isGroup = MessageSource.IsGroup;
if (State === "composing") {
if (Media === "text") {
console.log(`β¨οΈ ${from} is typing${isGroup ? " in group" : ""}...`);
} else {
console.log(
`π ${from} is sending ${Media}${isGroup ? " in group" : ""}...`
);
}
} else if (State === "paused") {
console.log(`βΈοΈ ${from} stopped typing`);
}
},
// Group events
handleGroupInfo: async (event) => {
const { JID, GroupName, Participants, Sender } = event;
console.log(`π₯ Group info updated for ${GroupName} (${JID.User})`);
console.log(`π€ Updated by: ${Sender.User}`);
console.log(`π₯ Participants: ${Participants.length}`);
},
handleJoinedGroup: async (event) => {
const { Reason, Type, Participants } = event;
console.log(`π Joined group! Reason: ${Reason}, Type: ${Type}`);
console.log(`π₯ Group has ${Participants.length} participants`);
},
// Connection events
handleConnected: async (event) => {
console.log("π’ Connected to WhatsApp!");
},
handleDisconnected: async (event) => {
console.log("π΄ Disconnected from WhatsApp");
},
handleLoggedOut: async (event) => {
const { Reason, OnConnect } = event;
console.log(`πͺ Logged out from WhatsApp. Reason: ${Reason}`);
if (OnConnect) {
console.log("β οΈ Logout occurred during connection");
}
},
// QR Code events
handleQR: async (event) => {
const { Codes } = event;
console.log("π± New QR codes received:");
Codes.forEach((code, index) => {
console.log(`π· QR Code ${index + 1}: ${code}`);
});
},
// Picture events (profile/group picture changes)
handlePicture: async (event) => {
const { JID, Author, Remove, Timestamp } = event;
const target = JID.User;
const changer = Author.User;
if (Remove) {
console.log(`ποΈ ${changer} removed profile picture for ${target}`);
} else {
console.log(`πΌοΈ ${changer} updated profile picture for ${target}`);
}
},
// Contact events
handleContact: async (event) => {
const { JID, Found, FullName, PushName, BusinessName } = event;
console.log(`π€ Contact info: ${FullName || PushName} (${JID.User})`);
if (BusinessName) {
console.log(`π’ Business: ${BusinessName}`);
}
console.log(`β
Found in WhatsApp: ${Found}`);
},
// Push name changes
handlePushName: async (event) => {
const { JID, OldPushName, NewPushName } = event;
console.log(
`π ${JID.User} changed name from "${OldPushName}" to "${NewPushName}"`
);
},
// Error events
handleUndecryptableMessage: async (event) => {
const { Info, IsUnavailable, UnavailableType, DecryptFailMode } = event;
console.log(`β Failed to decrypt message from ${Info.Source.Sender.User}`);
console.log(
`π Unavailable: ${IsUnavailable}, Type: ${UnavailableType}, Mode: ${DecryptFailMode}`
);
},
handleStreamError: async (event) => {
const { Code } = event;
console.log(`π¨ Stream error: ${Code}`);
},
};
// Main webhook endpoint
app.post("/webhook", async (req, res) => {
try {
const webhookPayload = req.body;
// Log the raw payload for debugging
console.log(
"π¨ Webhook received:",
JSON.stringify(webhookPayload, null, 2)
);
// Handle S3 media information if present
if (hasS3Media(webhookPayload)) {
console.log("βοΈ S3 Media Information:");
console.log(`π URL: ${webhookPayload.s3.url}`);
console.log(`ποΈ Bucket: ${webhookPayload.s3.bucket}`);
console.log(`π Key: ${webhookPayload.s3.key}`);
console.log(`π Size: ${webhookPayload.s3.size} bytes`);
console.log(`π Type: ${webhookPayload.s3.mimeType}`);
console.log(`π File: ${webhookPayload.s3.fileName}`);
}
if (hasBase64Media(webhookPayload)) {
console.log("π¦ Base64 media included");
console.log(`π Type: ${webhookPayload.mimeType}`);
console.log(`π File: ${webhookPayload.fileName}`);
console.log(`π Size: ${webhookPayload.base64.length} chars`);
}
if (hasBothMedia(webhookPayload)) {
console.log("π Both S3 and Base64 media provided");
}
// Extract the actual event data
const eventData = webhookPayload.event || webhookPayload;
// Determine event type using the EventType enum and handle accordingly
const eventType = detectEventType(eventData);
console.log(`π·οΈ Event Type: ${eventType}`);
switch (eventType) {
case EventType.MESSAGE:
await eventHandlers.handleMessage(eventData);
break;
case EventType.RECEIPT:
await eventHandlers.handleReceipt(eventData);
break;
case EventType.PRESENCE:
await eventHandlers.handlePresence(eventData);
break;
case EventType.CHAT_PRESENCE:
await eventHandlers.handleChatPresence(eventData);
break;
case EventType.GROUP_INFO:
await eventHandlers.handleGroupInfo(eventData);
break;
case EventType.JOINED_GROUP:
await eventHandlers.handleJoinedGroup(eventData);
break;
case EventType.QR:
await eventHandlers.handleQR(eventData);
break;
case EventType.PICTURE:
await eventHandlers.handlePicture(eventData);
break;
case EventType.CONTACT:
await eventHandlers.handleContact(eventData);
break;
case EventType.PUSH_NAME:
await eventHandlers.handlePushName(eventData);
break;
case EventType.UNDECRYPTABLE_MESSAGE:
await eventHandlers.handleUndecryptableMessage(eventData);
break;
case EventType.STREAM_ERROR:
await eventHandlers.handleStreamError(eventData);
break;
case EventType.CONNECTED:
await eventHandlers.handleConnected(eventData);
break;
case EventType.DISCONNECTED:
await eventHandlers.handleDisconnected(eventData);
break;
case EventType.LOGGED_OUT:
await eventHandlers.handleLoggedOut(eventData);
break;
default:
console.log(`π€· Unknown or unhandled event type: ${eventType}`);
console.log("π Event data:", eventData);
}
res.status(200).json({ success: true });
} catch (error) {
console.error("β Webhook processing error:", error);
res.status(500).json({ error: error.message });
}
});
// Helper function to detect event type from event data structure
function detectEventType(eventData) {
// Check for specific event patterns to determine type
if (eventData.Message && eventData.Info) {
return EventType.MESSAGE;
}
if (eventData.MessageIDs && eventData.Type) {
return EventType.RECEIPT;
}
if (eventData.From && typeof eventData.Unavailable !== "undefined") {
return EventType.PRESENCE;
}
if (eventData.State && eventData.MessageSource) {
return EventType.CHAT_PRESENCE;
}
if (eventData.GroupName && eventData.Participants) {
return EventType.GROUP_INFO;
}
if (eventData.Reason && eventData.Type && eventData.Participants) {
return EventType.JOINED_GROUP;
}
if (eventData.Codes) {
return EventType.QR;
}
if (
eventData.JID &&
eventData.Author &&
typeof eventData.Remove !== "undefined"
) {
return EventType.PICTURE;
}
if (eventData.Found !== undefined && eventData.FullName) {
return EventType.CONTACT;
}
if (eventData.OldPushName && eventData.NewPushName) {
return EventType.PUSH_NAME;
}
if (eventData.IsUnavailable !== undefined) {
return EventType.UNDECRYPTABLE_MESSAGE;
}
if (eventData.Code && !eventData.Expire) {
return EventType.STREAM_ERROR;
}
// Handle events with explicit type field
if (eventData.event_type) {
switch (eventData.event_type) {
case "connected":
return EventType.CONNECTED;
case "disconnected":
return EventType.DISCONNECTED;
case "logged_out":
return EventType.LOGGED_OUT;
}
}
// Try to detect by checking specific fields
if (eventData.Connected !== undefined) {
return EventType.CONNECTED;
}
return "Unknown";
}
// Health check endpoint
app.get("/health", (req, res) => {
res.status(200).json({
status: "healthy",
timestamp: new Date().toISOString(),
uptime: process.uptime(),
});
});
// Webhook verification endpoint (if needed)
app.get("/webhook", (req, res) => {
// Handle webhook verification if your system requires it
const challenge = req.query.challenge;
if (challenge) {
res.status(200).send(challenge);
} else {
res.status(200).json({ message: "Webhook endpoint is active" });
}
});
// Initialize the webhook server
async function initializeWebhookServer() {
try {
console.log("π§ Initializing webhook server...");
// Test WuzAPI connection
const isConnected = await client.ping();
// With flexible tokens: await client.ping({ token: "user-specific-token" });
if (!isConnected) {
throw new Error("Cannot connect to WuzAPI server");
}
console.log("β
Connected to WuzAPI");
// Connect to WhatsApp with full event subscription using EventType enum
await client.session.connect({
Subscribe: [
EventType.MESSAGE,
EventType.RECEIPT,
EventType.PRESENCE,
EventType.CHAT_PRESENCE,
EventType.GROUP_INFO,
EventType.CONTACT,
EventType.PUSH_NAME,
EventType.PICTURE,
EventType.QR,
EventType.CONNECTED,
EventType.DISCONNECTED,
EventType.LOGGED_OUT,
EventType.UNDECRYPTABLE_MESSAGE,
EventType.STREAM_ERROR,
],
Immediate: false,
});
// With flexible tokens: add second parameter { token: "user-specific-token" }
console.log("π± Connected to WhatsApp");
// Check login status
const status = await client.session.getStatus();
// With flexible tokens: await client.session.getStatus({ token: "user-specific-token" });
if (!status.LoggedIn) {
console.log("π± Not logged in. Please scan QR code...");
const qr = await client.session.getQRCode();
// With flexible tokens: await client.session.getQRCode({ token: "user-specific-token" });
console.log("π· QR Code:", qr.QRCode);
} else {
console.log("β
Already logged in to WhatsApp");
}
// Set webhook URL
const webhookUrl =
process.env.WEBHOOK_URL || "http://localhost:3000/webhook";
await client.webhook.setWebhook(webhookUrl, ["All"]);
// With flexible tokens: await client.webhook.setWebhook(webhookUrl, ["All"], { token: "user-specific-token" });
console.log(`π Webhook configured: ${webhookUrl}`);
// Start the server
const port = process.env.PORT || 3000;
app.listen(port, () => {
console.log(`π Webhook server running on port ${port}`);
console.log(`π‘ Webhook endpoint: http://localhost:${port}/webhook`);
console.log(`π₯ Health check: http://localhost:${port}/health`);
console.log("π Ready to receive WhatsApp events!");
});
} catch (error) {
console.error("β Webhook server initialization failed:", error);
process.exit(1);
}
}
// Graceful shutdown
process.on("SIGINT", async () => {
console.log("\nπ Shutting down webhook server...");
try {
await client.session.disconnect();
// With flexible tokens: await client.session.disconnect({ token: "user-specific-token" });
console.log("β
Disconnected from WhatsApp");
} catch (error) {
console.error("β Error during shutdown:", error);
}
process.exit(0);
});
// Handle uncaught exceptions
process.on("uncaughtException", (error) => {
console.error("π₯ Uncaught Exception:", error);
process.exit(1);
});
process.on("unhandledRejection", (reason, promise) => {
console.error("π₯ Unhandled Rejection at:", promise, "reason:", reason);
process.exit(1);
});
// Start the server
initializeWebhookServer();
export { app, client, eventHandlers };