Skip to main content

Error Handling

All client methods throw on failure. Errors are typed for easy handling.

Error Classes

import {
WhatsmeowError, // Base class for all whatsmeow errors
TimeoutError, // IPC command timed out
ProcessExitedError // Go binary crashed or exited
} from "@whatsmeow-node/whatsmeow-node";

Common Error Codes

CodeSourceMeaning
ERR_TIMEOUTTSIPC command timed out (default: 30s)
ERR_PROCESS_EXITEDTSGo binary crashed or exited
ERR_NOT_INITGoinit() not called yet
ERR_INVALID_ARGSGoMissing or invalid arguments
ERR_INVALID_JIDGoMalformed JID string
ERR_UNKNOWN_CMDGoUnrecognized IPC command
ERR_ALREADY_INITGoinit() called more than once
ERR_STOREGoFailed to open session database

Method-Specific Error Codes

Each method has its own error code so you can identify exactly what failed:

AreaError Codes
ConnectionERR_CONNECT, ERR_PAIR, ERR_QR, ERR_LOGOUT
MessagingERR_SEND, ERR_REVOKE, ERR_MARK_READ, ERR_PARSE
MediaERR_UPLOAD, ERR_DOWNLOAD, ERR_READ_FILE, ERR_TEMPFILE, ERR_WRITE
GroupsERR_CREATE_GROUP, ERR_GROUP_INFO, ERR_GROUPS, ERR_GROUP_TOPIC, ERR_SET_GROUP_NAME, ERR_SET_GROUP_DESC, ERR_SET_GROUP_PHOTO, ERR_SET_GROUP_ANNOUNCE, ERR_SET_GROUP_LOCKED, ERR_SET_MEMBER_ADD_MODE, ERR_SET_JOIN_APPROVAL, ERR_INVITE_LINK, ERR_JOIN_GROUP, ERR_LEAVE_GROUP, ERR_UPDATE_PARTICIPANTS, ERR_GROUP_REQUESTS, ERR_UPDATE_REQUESTS
CommunitiesERR_LINK_GROUP, ERR_UNLINK_GROUP, ERR_SUB_GROUPS, ERR_LINKED_PARTICIPANTS
NewslettersERR_CREATE_NEWSLETTER, ERR_NEWSLETTERS, ERR_NEWSLETTER_INFO, ERR_NEWSLETTER_MESSAGES, ERR_NEWSLETTER_UPDATES, ERR_NEWSLETTER_SUBSCRIBE, ERR_NEWSLETTER_REACTION, ERR_NEWSLETTER_MARK_VIEWED, ERR_NEWSLETTER_MUTE, ERR_FOLLOW_NEWSLETTER, ERR_UNFOLLOW_NEWSLETTER
ContactsERR_CHECK, ERR_USER_INFO, ERR_USER_DEVICES, ERR_PROFILE_PIC, ERR_BUSINESS_PROFILE, ERR_SET_STATUS
PrivacyERR_GET_PRIVACY, ERR_SET_PRIVACY, ERR_GET_STATUS_PRIVACY, ERR_SET_DISAPPEARING, ERR_BLOCKLIST, ERR_UPDATE_BLOCKLIST
PresenceERR_PRESENCE, ERR_CHAT_PRESENCE, ERR_SUBSCRIBE_PRESENCE
QR & LinksERR_QR_LINK, ERR_RESOLVE_QR, ERR_RESOLVE_BIZ_LINK
PollsERR_POLL_VOTE
BotsERR_BOT_LIST, ERR_BOT_PROFILES
App StateERR_FETCH_APP_STATE, ERR_MARK_NOT_DIRTY
CryptoERR_DECRYPT, ERR_ENCRYPT
CallsERR_REJECT_CALL
OtherERR_SET_PASSIVE, ERR_ACCEPT_TOS

Basic Handling

try {
await client.sendMessage(jid, { conversation: "hello" });
} catch (err) {
if (err instanceof WhatsmeowError) {
console.error(`WhatsApp error [${err.code}]: ${err.message}`);
}
}

Handling Specific Errors

try {
const profile = await client.getBusinessProfile(jid);
} catch (err) {
if (err instanceof WhatsmeowError) {
switch (err.code) {
case "ERR_BUSINESS_PROFILE":
console.log("Not a business account");
break;
case "ERR_INVALID_JID":
console.error("Bad JID format");
break;
default:
throw err;
}
}
}