Aliases
Function aliases and parameter key aliases across all methods.
Aliases
Generated file warning: this page is generated by
packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.
Function aliases
Alternative names (including namespaced forms) that resolve to a canonical method.
| Canonical method | Alias | Deprecated | Kind |
|---|---|---|---|
addLabel | labels.add | No | Namespaced |
addParticipant | addGroupParticipant | No | Flat |
addParticipant | groups.addParticipant | No | Namespaced |
approveGroupJoinRequest | groups.approveJoinRequest | No | Namespaced |
archiveChat | chats.archive | No | Namespaced |
blockContact | contactBlock | Yes | Flat |
blockContact | contacts.block | No | Namespaced |
blockContact | contacts.contactBlock | Yes | Namespaced |
checkNumberStatus | contacts.checkNumberStatus | No | Namespaced |
checkReadReceipts | contacts.checkReadReceipts | No | Namespaced |
checkReadReceipts | contacts.getReadReceipts | No | Namespaced |
checkReadReceipts | getReadReceipts | No | Flat |
clearChat | chats.clear | No | Namespaced |
createGroup | groups.create | No | Namespaced |
decryptMedia | media.decrypt | No | Namespaced |
deleteAllStatus | deleteAllStatuses | No | Flat |
deleteAllStatus | status.deleteAll | No | Namespaced |
deleteChat | chats.delete | No | Namespaced |
deleteMessage | messages.delete | No | Namespaced |
deleteStatus | status.delete | No | Namespaced |
demoteParticipant | demoteGroupParticipant | No | Flat |
demoteParticipant | groups.demoteParticipant | No | Namespaced |
downloadMedia | media.download | No | Namespaced |
forwardMessages | messages.forward | No | Namespaced |
getAllChatIds | chatIds.all | No | Namespaced |
getAllChatIds | chatIds.getAll | No | Namespaced |
getAllChatIds | chatIds.list | No | Namespaced |
getAllChatIds | chats.ids | No | Namespaced |
getAllChatIds | listChatIds | No | Flat |
getAllChats | chats.all | No | Namespaced |
getAllChats | chats.getAll | No | Namespaced |
getAllChats | chats.list | No | Namespaced |
getAllChats | listChats | No | Flat |
getAllCommunities | communities.all | No | Namespaced |
getAllCommunities | communities.getAll | No | Namespaced |
getAllCommunities | communities.list | No | Namespaced |
getAllCommunities | listCommunities | No | Flat |
getAllContacts | contacts.all | No | Namespaced |
getAllContacts | contacts.getAll | No | Namespaced |
getAllContacts | contacts.list | No | Namespaced |
getAllContacts | listContacts | No | Flat |
getAllGroups | groups.all | No | Namespaced |
getAllGroups | groups.getAll | No | Namespaced |
getAllGroups | groups.list | No | Namespaced |
getAllGroups | listGroups | No | Flat |
getAllLabels | labels.all | No | Namespaced |
getAllLabels | labels.getAll | No | Namespaced |
getAllLabels | labels.list | No | Namespaced |
getAllLabels | listLabels | No | Flat |
getAllMessages | listMessages | No | Flat |
getAllMessages | messages.all | No | Namespaced |
getAllMessages | messages.getAll | No | Namespaced |
getAllMessages | messages.list | No | Namespaced |
getBatteryLevel | session.getBatteryLevel | No | Namespaced |
getBlockedIds | contacts.getBlockedIds | No | Namespaced |
getBusinessProducts | business.getProducts | No | Namespaced |
getBusinessProducts | business.getProfilesProducts | Yes | Namespaced |
getBusinessProducts | getBusinessProfilesProducts | Yes | Flat |
getBusinessProfile | business.getProfile | No | Namespaced |
getChat | chats.get | No | Namespaced |
getChat | chats.getById | No | Namespaced |
getChat | getChatById | No | Flat |
getChatsByLabel | labels.getChats | No | Namespaced |
getChatsByLabel | labels.getChatsBy | No | Namespaced |
getChatWithNonContacts | chats.getWithNonContacts | No | Namespaced |
getCommonGroups | contacts.getCommonGroups | No | Namespaced |
getCommunityAdminIds | communities.getAdminIds | No | Namespaced |
getCommunityAdmins | communities.getAdmins | No | Namespaced |
getCommunityInfo | communities.getInfo | No | Namespaced |
getCommunityParticipantIds | communities.getParticipantIds | No | Namespaced |
getCommunityParticipants | communities.getParticipants | No | Namespaced |
getConnectionState | session.getConnectionState | No | Namespaced |
getContact | contacts.get | No | Namespaced |
getFeatures | session.getFeatures | No | Namespaced |
getGroupAdmins | groups.getAdmins | No | Namespaced |
getGroupInfo | groups.getInfo | No | Namespaced |
getGroupInviteLink | groups.getInviteLink | No | Namespaced |
getGroupMembers | groups.getMembers | No | Namespaced |
getGroupMembersId | getGroupMemberIds | No | Flat |
getGroupMembersId | groups.getMemberIds | No | Namespaced |
getGroupMembersId | groups.getMembersId | No | Namespaced |
getHostNumber | session.getHostNumber | No | Namespaced |
getKickedGroups | groups.getKicked | No | Namespaced |
getLicenseType | session.getLicenseType | No | Namespaced |
getLoadedMessageCount | getAmountOfLoadedMessages | Yes | Flat |
getLoadedMessageCount | session.getAmountOfLoadedMessages | Yes | Namespaced |
getLoadedMessageCount | session.getLoadedMessageCount | No | Namespaced |
getMe | session.getMe | No | Namespaced |
getMessageById | getMessage | No | Flat |
getMessageById | messages.get | No | Namespaced |
getMessageById | messages.getById | No | Namespaced |
getMessageInfo | messages.getInfo | No | Namespaced |
getMessagesForLLM | getGptArray | Yes | Flat |
getMessagesForLLM | messages.getForLLM | No | Namespaced |
getMessagesForLLM | messages.getGptArray | Yes | Namespaced |
getMyLastMessage | messages.getMyLast | No | Namespaced |
getNumberProfile | contacts.getNumberProfile | No | Namespaced |
getOrder | business.getOrder | No | Namespaced |
getProcessStats | session.getProcessStats | No | Namespaced |
getProfilePicture | contacts.getProfilePicFromServer | Yes | Namespaced |
getProfilePicture | contacts.getProfilePicture | No | Namespaced |
getProfilePicture | getProfilePicFromServer | Yes | Flat |
getSnapshot | session.getSnapshot | No | Namespaced |
getSnapshot | session.takeScreenshot | No | Namespaced |
getSnapshot | takeScreenshot | No | Flat |
getStarredMessages | messages.getStarred | No | Namespaced |
getStatus | mystatus.getStatus | No | Namespaced |
getStories | getStatuses | No | Flat |
getStories | status.get | No | Namespaced |
getStories | status.getAll | No | Namespaced |
getStories | status.getStories | No | Namespaced |
getUnsentMessages | messages.getUnsent | No | Namespaced |
getUserAgent | getGeneratedUserAgent | Yes | Flat |
getUserAgent | session.getGeneratedUserAgent | Yes | Namespaced |
getUserAgent | session.getUserAgent | No | Namespaced |
getVCards | messages.getVCards | No | Namespaced |
getWAVersion | getWhatsAppVersion | No | Flat |
getWAVersion | session.getWAVersion | No | Namespaced |
getWAVersion | session.getWhatsAppVersion | No | Namespaced |
healthCheck | session.healthCheck | No | Namespaced |
isChatOnline | chats.isOnline | No | Namespaced |
isPlugged | getIsPlugged | Yes | Flat |
isPlugged | session.getIsPlugged | Yes | Namespaced |
isPlugged | session.isPlugged | No | Namespaced |
joinGroupViaLink | groups.join | No | Namespaced |
joinGroupViaLink | groups.joinViaLink | No | Namespaced |
joinGroupViaLink | joinGroup | No | Flat |
leaveGroup | groups.leave | No | Namespaced |
loadEarlierMessages | loadOlderMessages | No | Flat |
loadEarlierMessages | messages.loadEarlier | No | Namespaced |
loadEarlierMessages | messages.loadOlder | No | Namespaced |
markAsRead | chats.markAsRead | No | Namespaced |
markAsUnread | chats.markAsUnread | No | Namespaced |
muteChat | chats.mute | No | Namespaced |
pinChat | chats.pin | No | Namespaced |
postImageStatus | status.postImage | No | Namespaced |
postTextStatus | status.postText | No | Namespaced |
postVideoStatus | status.postVideo | No | Namespaced |
promoteParticipant | groups.promoteParticipant | No | Namespaced |
promoteParticipant | promoteGroupParticipant | No | Flat |
react | messages.react | No | Namespaced |
rejectGroupJoinRequest | groups.rejectJoinRequest | No | Namespaced |
removeLabel | labels.remove | No | Namespaced |
removeParticipant | groups.removeParticipant | No | Namespaced |
removeParticipant | removeGroupParticipant | No | Flat |
revokeGroupInviteLink | groups.revokeInviteLink | No | Namespaced |
sendAdvancedButtons | messages.sendAdvancedButtons | No | Namespaced |
sendAudio | messages.sendAudio | No | Namespaced |
sendBanner | messages.sendBanner | No | Namespaced |
sendButtons | messages.sendButtons | No | Namespaced |
sendContact | messages.sendContact | No | Namespaced |
sendFile | messages.sendFile | No | Namespaced |
sendFileFromUrl | messages.sendFileFromUrl | No | Namespaced |
sendImage | messages.sendImage | No | Namespaced |
sendLinkWithAutoPreview | messages.sendLink | No | Namespaced |
sendLinkWithAutoPreview | messages.sendLinkWithAutoPreview | No | Namespaced |
sendLinkWithAutoPreview | sendLink | No | Flat |
sendListMessage | messages.sendList | No | Namespaced |
sendListMessage | sendList | No | Flat |
sendLocation | messages.sendLocation | No | Namespaced |
sendMessageWithThumb | messages.sendLinkWithThumbnail | No | Namespaced |
sendMessageWithThumb | messages.sendWithThumb | No | Namespaced |
sendMessageWithThumb | sendLinkWithThumbnail | No | Flat |
sendMultipleContacts | messages.sendContacts | No | Namespaced |
sendMultipleContacts | messages.sendMultipleContacts | No | Namespaced |
sendMultipleContacts | sendContacts | No | Flat |
sendPaymentRequest | messages.sendPaymentRequest | No | Namespaced |
sendPoll | messages.sendPoll | No | Namespaced |
sendPtt | messages.sendPtt | No | Namespaced |
sendPtt | messages.sendVoiceNote | No | Namespaced |
sendPtt | sendVoiceNote | No | Flat |
sendReplyWithMentions | messages.sendReplyWithMentions | No | Namespaced |
sendSeen | messages.sendSeen | No | Namespaced |
sendText | messages.sendText | No | Namespaced |
sendTextWithMentions | messages.sendTextWithMentions | No | Namespaced |
sendVCard | messages.sendVCard | No | Namespaced |
sendVideoAsGif | messages.sendVideoAsGif | No | Namespaced |
sendYouTubeLink | messages.sendYoutubeLink | Yes | Namespaced |
sendYouTubeLink | messages.sendYouTubeLink | No | Namespaced |
sendYouTubeLink | sendYoutubeLink | Yes | Flat |
setChatEphemeral | chats.setEphemeral | No | Namespaced |
setGroupDescription | groups.setDescription | No | Namespaced |
setGroupEditToAdminsOnly | groups.setEditAdminsOnly | No | Namespaced |
setGroupEditToAdminsOnly | groups.setEditToAdminsOnly | No | Namespaced |
setGroupIcon | groups.setIcon | No | Namespaced |
setGroupTitle | groups.setTitle | No | Namespaced |
setGroupToAdminsOnly | groups.setAdminsOnly | No | Namespaced |
setGroupToAdminsOnly | groups.setToAdminsOnly | No | Namespaced |
setMyName | session.setDisplayName | No | Namespaced |
setMyName | session.setMyName | No | Namespaced |
setMyName | session.setName | No | Namespaced |
setMyName | setDisplayName | No | Flat |
setMyStatus | session.setMyStatus | No | Namespaced |
setMyStatus | session.setStatus | No | Namespaced |
setMyStatus | session.setStatusText | No | Namespaced |
setMyStatus | setStatusText | No | Flat |
setProfilePicture | session.setProfilePic | Yes | Namespaced |
setProfilePicture | session.setProfilePicture | No | Namespaced |
setProfilePicture | setProfilePic | Yes | Flat |
starMessage | messages.star | No | Namespaced |
unarchiveChat | chats.unarchive | No | Namespaced |
unblockContact | contacts.contactUnblock | Yes | Namespaced |
unblockContact | contacts.unblock | No | Namespaced |
unblockContact | contactUnblock | Yes | Flat |
unmuteChat | chats.unmute | No | Namespaced |
unpinChat | chats.unpin | No | Namespaced |
unstarMessage | messages.unstar | No | Namespaced |
Parameter key aliases
Alternative object keys accepted for a canonical parameter.
| Canonical key | Alias | Branded type | Example |
|---|---|---|---|
chatId | chatId | ChatId | "447123456789@c.us" |
chatId | contactId | ChatId | "447123456789@c.us" |
chatId | id | ChatId | "447123456789@c.us" |
contactId | id | ContactId | "447123456789@c.us" |
contactIds | id | ContactId | "447123456789@c.us" |
contacts | id | ContactId | "447123456789@c.us" |
content | body | Content | "Hello, world!" |
content | message | Content | "Hello, world!" |
content | text | Content | "Hello, world!" |
groupId | chatId | GroupChatId | "447123456789-1445627445@g.us" |
groupId | groupChatId | GroupChatId | "447123456789-1445627445@g.us" |
id | id | MessageId | "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" |
id | msgId | MessageId | "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" |
messageId | id | MessageId | "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" |
messageId | messages | MessageId[] | ["false_447123456789@c.us_ABC123","false_447123456789@c.us_DEF456"] |
messageId | msgId | MessageId | "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" |
messages | messages | MessageId[] | ["false_447123456789@c.us_ABC123","false_447123456789@c.us_DEF456"] |
name | newName | - | "OpenWA Bot" |
quotedMsgId | id | MessageId | "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" |
quotedMsgId | msgId | MessageId | "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" |
replyMessageId | id | MessageId | "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" |
replyMessageId | msgId | MessageId | "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" |
statusText | newStatus | - | "Available" |
text | body | Content | "Hello, world!" |
text | message | Content | "Hello, world!" |
text | text | Content | "Hello, world!" |
to | chatId | ChatId | "447123456789@c.us" |
userAgent | userA | - | "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)" |
Was this helpful?
Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!