All client methods
Alphabetical index of every client method, linking to its namespace reference.
All client methods
Generated file warning: this page is generated by
packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.
This is an alphabetical index of all 123 client methods. Each method links to its full reference on the namespace page (parameters, usage, HTTP route, and response).
| Method | Namespace | Description | License |
|---|---|---|---|
addLabel | labels | Add label to chat | - |
addParticipant | groups | Add participant to group | - |
approveGroupJoinRequest | groups | Approve group join request | - |
archiveChat | chats | Archive a chat | - |
blockContact | contacts | Block a contact | - |
checkNumberStatus | contacts | Check if number is on WhatsApp | insiders |
checkReadReceipts | contacts | Check read receipts setting | - |
clearChat | chats | Clear chat history | - |
createGroup | groups | Create new group | restricted |
decryptMedia | media | Decrypts media from a message | - |
deleteAllStatus | status | Delete all statuses | insiders |
deleteChat | chats | Delete a chat | - |
deleteMessage | messages | Deletes a message | - |
deleteStatus | status | Delete status | insiders |
demoteParticipant | groups | Demote participant from admin | - |
downloadMedia | media | Downloads and decrypts media from a message to a file | - |
forwardMessages | messages | Forwards messages to a chat | - |
getAllChatIds | chatIds | Get all chat IDs | - |
getAllChats | chats | Retrieves all chats | - |
getAllCommunities | communities | Get all communities | - |
getAllContacts | contacts | Retrieves all contacts | - |
getAllGroups | groups | Get all groups | - |
getAllLabels | labels | Get all labels | - |
getAllMessages | messages | Retrieves all messages in the session | - |
getBatteryLevel | session | Get phone battery level | - |
getBlockedIds | contacts | Get blocked contact IDs | - |
getBusinessProducts | business | Get business products | - |
getBusinessProfile | business | Get business profile | - |
getChat | chats | Get specific chat by ID | - |
getChatsByLabel | labels | Get chats by label | - |
getChatWithNonContacts | chats | Get chats with non-contacts | - |
getCommonGroups | contacts | Get common groups with contact | - |
getCommunityAdminIds | communities | Get community admin IDs | - |
getCommunityAdmins | communities | Get community admins | - |
getCommunityInfo | communities | Get community metadata | - |
getCommunityParticipantIds | communities | Get community participant IDs | - |
getCommunityParticipants | communities | Get community participants | - |
getConnectionState | session | Get connection state | - |
getContact | contacts | Get specific contact | - |
getFeatures | session | Get enabled features | - |
getGroupAdmins | groups | Get group admins | - |
getGroupInfo | groups | Get group metadata | - |
getGroupInviteLink | groups | Get group invite link | - |
getGroupMembers | groups | Retrieves members of a group | - |
getGroupMembersId | groups | Get group member IDs | - |
getHostNumber | session | Get host phone number | - |
getKickedGroups | groups | Get groups where kicked | - |
getLicenseType | session | Get license type | - |
getLoadedMessageCount | session | Get loaded message count | - |
getMe | session | Get host account info | - |
getMessageById | messages | Retrieves a specific message by ID | - |
getMessageInfo | messages | Get message delivery info | - |
getMessagesForLLM | messages | Get messages formatted for LLMs | - |
getMyLastMessage | messages | Get last message sent by host | - |
getNumberProfile | contacts | Get profile of number | insiders |
getOrder | business | Get order details | insiders |
getProcessStats | session | Get process statistics | - |
getProfilePicture | contacts | Get profile picture from server | - |
getSnapshot | session | Take screenshot | - |
getStarredMessages | messages | Get starred messages | insiders |
getStatus | mystatus | Get specific status | insiders |
getStories | status | Get all stories | insiders |
getUnsentMessages | messages | Get unsent/pending messages | - |
getUserAgent | session | Get user agent | - |
getVCards | messages | Extract vCards from message | - |
getWAVersion | session | Get WhatsApp Web version | - |
healthCheck | session | Health check | - |
isChatOnline | chats | Check if chat is online | - |
isPlugged | session | Check if phone is charging | - |
joinGroupViaLink | groups | Join group via invite link | restricted |
leaveGroup | groups | Leave a group | - |
loadEarlierMessages | messages | Loads earlier messages from a chat | - |
markAsRead | chats | Mark chat as read | - |
markAsUnread | chats | Mark chat as unread | - |
muteChat | chats | Mute a chat | - |
pinChat | chats | Pin a chat | - |
postImageStatus | status | Post image status | insiders |
postTextStatus | status | Post text status | insiders |
postVideoStatus | status | Post video status | insiders |
promoteParticipant | groups | Promote participant to admin | - |
react | messages | React to message with emoji | - |
rejectGroupJoinRequest | groups | Reject group join request | - |
removeLabel | labels | Remove label from chat | - |
removeParticipant | groups | Remove participant from group | - |
revokeGroupInviteLink | groups | Revoke group invite link | - |
sendAdvancedButtons | messages | Sends an advanced button message with media (deprecated) | insiders |
sendAudio | messages | Sends an audio file to a chat | - |
sendBanner | messages | Sends a banner image | - |
sendButtons | messages | Sends a button message (deprecated) | insiders |
sendContact | messages | Sends a single contact | - |
sendFile | messages | Sends a file or document to a chat | - |
sendFileFromUrl | messages | Downloads a file from a URL and sends it to a chat | - |
sendImage | messages | Sends an image to a chat | - |
sendLinkWithAutoPreview | messages | Sends a link with auto-generated preview | - |
sendListMessage | messages | Sends a list/menu message (deprecated) | insiders |
sendLocation | messages | Sends a location to a chat | - |
sendMessageWithThumb | messages | Sends a link preview message with custom thumbnail | - |
sendMultipleContacts | messages | Sends multiple contacts | - |
sendPaymentRequest | messages | Sends a payment request message | - |
sendPoll | messages | Sends a poll message | - |
sendPtt | messages | Sends a voice note (push-to-talk) to a chat | - |
sendReplyWithMentions | messages | Sends a reply to a message that includes @mentions | - |
sendSeen | messages | Mark message as seen | - |
sendText | messages | Sends a text message to a chat | - |
sendTextWithMentions | messages | Sends a text message that includes @mentions | - |
sendVCard | messages | Sends a contact card (vCard) | - |
sendVideoAsGif | messages | Sends a video as an animated GIF | - |
sendYouTubeLink | messages | Sends a YouTube link with auto-generated preview | - |
setChatEphemeral | chats | Set ephemeral messages for chat | - |
setGroupDescription | groups | Set group description | - |
setGroupEditToAdminsOnly | groups | Restrict group editing to admins only | - |
setGroupIcon | groups | Set group icon | - |
setGroupTitle | groups | Set group title | - |
setGroupToAdminsOnly | groups | Restrict group to admins only | - |
setMyName | session | Set host name | - |
setMyStatus | session | Set host status | - |
setProfilePicture | session | Set profile picture | insiders |
starMessage | messages | Star a message | - |
unarchiveChat | chats | Unarchive a chat | - |
unblockContact | contacts | Unblock a contact | - |
unmuteChat | chats | Unmute a chat | - |
unpinChat | chats | Unpin a chat | - |
unstarMessage | messages | Unstar a message | - |
Was this helpful?
Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!