Chat & JID Utilities

Utility functions for working with WhatsApp JIDs (Jabber IDs) and chat identifiers

JID (Jabber ID) utilities help you work with WhatsApp’s user and chat identifiers, validate them, and extract information from them.

jidNormalizedUser

Normalizes a JID to use the standard WhatsApp server format.

export const jidNormalizedUser = (jid: string | undefined): string

jid · string | undefined

The JID to normalize

return · string

Normalized JID (converts ‘c.us’ to ‘s.whatsapp.net’)

Example:

import { jidNormalizedUser } from '@whiskeysockets/baileys'

const jid1 = '[e-mail]'
const normalized1 = jidNormalizedUser(jid1)
console.log(normalized1) // "[e-mail]"

const jid2 = '[e-mail]'
const normalized2 = jidNormalizedUser(jid2)
console.log(normalized2) // "[e-mail]"

const groupJid = '[e-mail]'
const normalizedGroup = jidNormalizedUser(groupJid)
console.log(normalizedGroup) // "[e-mail]" (unchanged)

When to use:

• Before comparing JIDs
• When storing JIDs in databases
• To ensure consistent JID format across your application

---

jidDecode

Decodes a JID into its component parts.

export const jidDecode = (jid: string | undefined): FullJid | undefined

jid · string | undefined

The JID to decode

return · FullJid | undefined

Object containing user, server, device, and domainType, or undefined if invalid

FullJid Type

type FullJid = {
  user: string
  server: JidServer
  device?: number
  domainType?: number
}

Example:

import { jidDecode } from '@whiskeysockets/baileys'

// Regular user
const decoded1 = jidDecode('[e-mail]')
console.log(decoded1)
// {
//   user: '1234567890',
//   server: 's.whatsapp.net',
//   domainType: 0
// }

// User with device ID
const decoded2 = jidDecode('1234567890:[e-mail]')
console.log(decoded2)
// {
//   user: '1234567890',
//   server: 's.whatsapp.net',
//   device: 5,
//   domainType: 0
// }

// Group
const decoded3 = jidDecode('[e-mail]')
console.log(decoded3)
// {
//   user: '123456789',
//   server: 'g.us',
//   domainType: 0
// }

// LID (Linked ID)
const decoded4 = jidDecode('abcd1234@lid')
console.log(decoded4)
// {
//   user: 'abcd1234',
//   server: 'lid',
//   domainType: 1
// }

When to use:

• To extract the user ID from a JID
• To determine the server type
• To get device information from multi-device JIDs

---

jidEncode

Encodes JID components into a complete JID string.

export const jidEncode = (
  user: string | number | null,
  server: JidServer,
  device?: number,
  agent?: number
): string

user · string | number | null · required

The user identifier

server · JidServer · required

Server type: ‘c.us’, ‘g.us’, ‘s.whatsapp.net’, ‘broadcast’, ‘lid’, etc.

device · number

Device ID for multi-device

agent · number

Agent ID

return · string

Complete JID string

Example:

import { jidEncode } from '@whiskeysockets/baileys'

// Regular user
const jid1 = jidEncode('1234567890', 's.whatsapp.net')
console.log(jid1) // "[e-mail]"

// Group
const jid2 = jidEncode('123456789', 'g.us')
console.log(jid2) // "[e-mail]"

// With device ID
const jid3 = jidEncode('1234567890', 's.whatsapp.net', 5)
console.log(jid3) // "1234567890:[e-mail]"

// Status broadcast
const jid4 = jidEncode('status', 'broadcast')
console.log(jid4) // "status@broadcast"

When to use:

• To construct JIDs programmatically
• When building multi-device JIDs
• For creating group or broadcast JIDs

---

isJidGroup

Checks if a JID represents a group.

export const isJidGroup = (jid: string | undefined): boolean

jid · string | undefined

The JID to check

return · boolean

True if the JID is a group (@g.us)

Example:

import { isJidGroup } from '@whiskeysockets/baileys'

const groupJid = '[e-mail]'
console.log(isJidGroup(groupJid)) // true

const userJid = '[e-mail]'
console.log(isJidGroup(userJid)) // false

const broadcastJid = 'status@broadcast'
console.log(isJidGroup(broadcastJid)) // false

When to use:

• To determine if a message is from a group
• Before performing group-specific operations
• For routing logic based on chat type

---

isJidBroadcast

Checks if a JID represents a broadcast list.

export const isJidBroadcast = (jid: string | undefined): boolean

jid · string | undefined

The JID to check

return · boolean

True if the JID is a broadcast (@broadcast)

Example:

import { isJidBroadcast } from '@whiskeysockets/baileys'

const broadcastJid = 'status@broadcast'
console.log(isJidBroadcast(broadcastJid)) // true

const userJid = '[e-mail]'
console.log(isJidBroadcast(userJid)) // false

When to use:

• To identify broadcast messages
• For handling status updates
• To filter broadcast-specific events

---

isJidStatusBroadcast

Checks if a JID is specifically the status broadcast.

export const isJidStatusBroadcast = (jid: string): boolean

jid · string · required

The JID to check

return · boolean

True if the JID is exactly ‘status@broadcast’

Example:

import { isJidStatusBroadcast } from '@whiskeysockets/baileys'

const statusJid = 'status@broadcast'
console.log(isJidStatusBroadcast(statusJid)) // true

const userJid = '[e-mail]'
console.log(isJidStatusBroadcast(userJid)) // false

When to use:

• To identify WhatsApp status messages
• For filtering status updates
• Different from regular broadcasts

---

isJidNewsletter

Checks if a JID represents a newsletter/channel.

export const isJidNewsletter = (jid: string | undefined): boolean

jid · string | undefined

The JID to check

return · boolean

True if the JID is a newsletter (@newsletter)

Example:

import { isJidNewsletter } from '@whiskeysockets/baileys'

const newsletterJid = '123456789@newsletter'
console.log(isJidNewsletter(newsletterJid)) // true

const groupJid = '[e-mail]'
console.log(isJidNewsletter(groupJid)) // false

When to use:

• To identify newsletter/channel messages
• Before performing newsletter-specific operations
• Newsletter messages use different upload mechanisms

---

isLidUser

Checks if a JID is a LID (Linked ID) user.

export const isLidUser = (jid: string | undefined): boolean

jid · string | undefined

The JID to check

return · boolean

True if the JID ends with ‘@lid’

Example:

import { isLidUser } from '@whiskeysockets/baileys'

const lidJid = 'abcd1234@lid'
console.log(isLidUser(lidJid)) // true

const regularJid = '[e-mail]'
console.log(isLidUser(regularJid)) // false

When to use:

• To identify linked device users
• For handling privacy-focused identifiers
• LIDs are used for enhanced privacy in some regions

---

areJidsSameUser

Checks if two JIDs represent the same user (ignoring device ID).

export const areJidsSameUser = (
  jid1: string | undefined,
  jid2: string | undefined
): boolean

jid1 · string | undefined

First JID to compare

jid2 · string | undefined

Second JID to compare

return · boolean

True if both JIDs have the same user ID

Example:

import { areJidsSameUser } from '@whiskeysockets/baileys'

// Same user, different devices
const jid1 = '[e-mail]'
const jid2 = '1234567890:[e-mail]'
console.log(areJidsSameUser(jid1, jid2)) // true

// Different users
const jid3 = '[e-mail]'
const jid4 = '[e-mail]'
console.log(areJidsSameUser(jid3, jid4)) // false

// Same user, different server formats
const jid5 = '[e-mail]'
const jid6 = '[e-mail]'
console.log(areJidsSameUser(jid5, jid6)) // true

When to use:

• To compare users across different devices
• For deduplication
• When checking message participants