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 page documents all client methods alphabetically in a single flat namespace for easy reference.
Add label to chat
Prop Value Namespace labelsAction updateFunctionality business-onlyPositional parameter order label, chatIdAliases labels.addDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/labels/addaddLabelActive Alias PUT/api/addLabeladdLabelActive
Client Namespaced client HTTP API
const result = await client. addLabel ({ label: "label" , chatId: "447123456789@c.us" , }); const result = await client.labels. add ({ label: "label" , chatId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/labels/add" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "label": "label", "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Add participant to group
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, contactIdAliases addGroupParticipant, groups.addParticipantDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/addParticipantaddParticipantActive Alias PUT/api/addGroupParticipantaddGroupParticipantActive Alias PUT/api/addParticipantaddParticipantActive
Client Namespaced client HTTP API
const result = await client. addParticipant ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); const result = await client.groups. addParticipant ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/groups/addParticipant" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "contactId": "447123456789@c.us" }' Prop Value Return type boolean
Approve group join request
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, contactIdAliases groups.approveJoinRequestDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/approveJoinRequestapproveGroupJoinRequestActive Alias PUT/api/approveGroupJoinRequestapproveGroupJoinRequestActive
Client Namespaced client HTTP API
const result = await client. approveGroupJoinRequest ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); const result = await client.groups. approveJoinRequest ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/groups/approveJoinRequest" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "contactId": "447123456789@c.us" }' Prop Value Return type string | boolean
Archive a chat
Prop Value Namespace chatsAction updateFunctionality bothPositional parameter order chatIdAliases chats.archiveDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/chats/archivearchiveChatActive Alias PUT/api/archiveChatarchiveChatActive
Client Namespaced client HTTP API
const result = await client. archiveChat ({ chatId: "447123456789@c.us" , }); const result = await client.chats. archive ({ chatId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/chats/archive" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Block a contact
Prop Value Namespace contactsAction updateFunctionality bothPositional parameter order contactIdAliases contactBlock, contacts.block, contacts.contactBlockDeprecated aliases contactBlock, contacts.contactBlockLicense noneWAPI override contactBlockDeprecated No
Type Method Path Name Status Primary PUT/api/contacts/blockblockContactActive Alias PUT/api/blockContactblockContactActive Deprecated alias PUT/api/contactBlockcontactBlockDeprecated Deprecated alias PUT/api/contacts/contactBlockcontacts.contactBlockDeprecated
Client Namespaced client HTTP API
const result = await client. blockContact ({ contactId: "447123456789@c.us" , }); const result = await client.contacts. block ({ contactId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/contacts/block" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "contactId": "447123456789@c.us" }' Prop Value Return type boolean
Check if number is on WhatsApp
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace contactsAction readFunctionality bothPositional parameter order contactIdAliases contacts.checkNumberStatusDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/contacts/checkNumberStatuscheckNumberStatusActive Alias GET/api/checkNumberStatuscheckNumberStatusActive
Client Namespaced client HTTP API
const result = await client. checkNumberStatus ({ contactId: "447123456789@c.us" , }); const result = await client.contacts. checkNumberStatus ({ contactId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/contacts/checkNumberStatus" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "contactId=447123456789@c.us" Prop Value Return type unknown
Check read receipts setting
Prop Value Namespace contactsAction readFunctionality bothPositional parameter order contactIdAliases contacts.checkReadReceipts, contacts.getReadReceipts, getReadReceiptsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/contacts/checkReadReceiptscheckReadReceiptsActive Alias GET/api/checkReadReceiptscheckReadReceiptsActive Alias GET/api/contacts/getReadReceiptscontacts.getReadReceiptsActive Alias GET/api/getReadReceiptsgetReadReceiptsActive
Client Namespaced client HTTP API
const result = await client. checkReadReceipts ({ contactId: "447123456789@c.us" , }); const result = await client.contacts. checkReadReceipts ({ contactId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/contacts/checkReadReceipts" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "contactId=447123456789@c.us" Prop Value Return type boolean | string
Clear chat history
Prop Value Namespace chatsAction deleteFunctionality bothPositional parameter order chatIdAliases chats.clearDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary DELETE/api/chats/clearclearChatActive Alias DELETE/api/clearChatclearChatActive
Client Namespaced client HTTP API
const result = await client. clearChat ({ chatId: "447123456789@c.us" , }); const result = await client.chats. clear ({ chatId: "447123456789@c.us" , }); curl -X DELETE "http://localhost:8080/api/chats/clear" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Create new group
🧵 Restricted Licensed feature
Restricted feature
May require a restricted license for gated or host-account-specific flows.
Prop Value Namespace groupsAction sendFunctionality bothPositional parameter order name, contactsAliases groups.createDeprecated aliases - License restrictedWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/groups/createcreateGroupActive Alias POST/api/createGroupcreateGroupActive
Client Namespaced client HTTP API
const result = await client. createGroup ({ name: "name" , contacts: "447123456789@c.us" , }); const result = await client.groups. create ({ name: "name" , contacts: "447123456789@c.us" , }); curl -X POST "http://localhost:8080/api/groups/create" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "name": "name", "contacts": "447123456789@c.us" }' Prop Value Return type unknown
Decrypts media from a message
Prop Value Namespace mediaAction readFunctionality bothPositional parameter order messageAliases media.decryptDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/media/decryptdecryptMediaActive Alias POST/api/decryptMediadecryptMediaActive
Client Namespaced client HTTP API
const result = await client. decryptMedia ({ message: {}, }); const result = await client.media. decrypt ({ message: {}, }); curl -X POST "http://localhost:8080/api/media/decrypt" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "message": {} }' Prop Value Return type string
Delete all statuses
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace statusAction deleteFunctionality bothPositional parameter order - Aliases deleteAllStatuses, status.deleteAllDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary DELETE/api/status/deleteAlldeleteAllStatusActive Alias DELETE/api/deleteAllStatusdeleteAllStatusActive Alias DELETE/api/deleteAllStatusesdeleteAllStatusesActive
Client Namespaced client HTTP API
const result = await client. deleteAllStatus ({}); const result = await client.status. deleteAll ({}); curl -X DELETE "http://localhost:8080/api/status/deleteAll" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown
Delete a chat
Prop Value Namespace chatsAction deleteFunctionality bothPositional parameter order chatIdAliases chats.deleteDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary DELETE/api/chats/deletedeleteChatActive Alias DELETE/api/deleteChatdeleteChatActive
Client Namespaced client HTTP API
const result = await client. deleteChat ({ chatId: "447123456789@c.us" , }); const result = await client.chats. delete ({ chatId: "447123456789@c.us" , }); curl -X DELETE "http://localhost:8080/api/chats/delete" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Deletes a message
Prop Value Namespace messagesAction deleteFunctionality bothPositional parameter order chatId, messageId, onlyLocalAliases messages.deleteDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary DELETE/api/messages/deletedeleteMessageActive Alias DELETE/api/deleteMessagedeleteMessageActive
Client Namespaced client HTTP API
const result = await client. deleteMessage ({ chatId: "447123456789@c.us" , messageId: [ "false_447123456789@c.us_ABC123" , "false_447123456789@c.us_DEF456" ], onlyLocal: true , }); const result = await client.messages. delete ({ chatId: "447123456789@c.us" , messageId: [ "false_447123456789@c.us_ABC123" , "false_447123456789@c.us_DEF456" ], onlyLocal: true , }); curl -X DELETE "http://localhost:8080/api/messages/delete" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us", "messageId": [ "false_447123456789@c.us_ABC123", "false_447123456789@c.us_DEF456" ], "onlyLocal": true }' Prop Value Return type boolean
Delete status
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace statusAction deleteFunctionality bothPositional parameter order statusesToDeleteAliases status.deleteDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary DELETE/api/status/deletedeleteStatusActive Alias DELETE/api/deleteStatusdeleteStatusActive
Client Namespaced client HTTP API
const result = await client. deleteStatus ({ statusesToDelete: [], }); const result = await client.status. delete ({ statusesToDelete: [], }); curl -X DELETE "http://localhost:8080/api/status/delete" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "statusesToDelete": [] }' Prop Value Return type unknown
Demote participant from admin
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, contactIdAliases demoteGroupParticipant, groups.demoteParticipantDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/demoteParticipantdemoteParticipantActive Alias PUT/api/demoteGroupParticipantdemoteGroupParticipantActive Alias PUT/api/demoteParticipantdemoteParticipantActive
Client Namespaced client HTTP API
const result = await client. demoteParticipant ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); const result = await client.groups. demoteParticipant ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/groups/demoteParticipant" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "contactId": "447123456789@c.us" }' Prop Value Return type boolean | string
Downloads and decrypts media from a message to a file
Prop Value Namespace mediaAction readFunctionality bothPositional parameter order message, pathAliases media.downloadDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/media/downloaddownloadMediaActive Alias POST/api/downloadMediadownloadMediaActive
Client Namespaced client HTTP API
const result = await client. downloadMedia ({ message: {}, path: "path" , }); const result = await client.media. download ({ message: {}, path: "path" , }); curl -X POST "http://localhost:8080/api/media/download" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "message": {}, "path": "path" }' Prop Value Return type string
Forwards messages to a chat
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, messages, skipMyMessagesAliases messages.forwardDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/forwardforwardMessagesActive Alias POST/api/forwardMessagesforwardMessagesActive
Client Namespaced client HTTP API
const result = await client. forwardMessages ({ to: "447123456789@c.us" , messages: [ "false_447123456789@c.us_ABC123" , "false_447123456789@c.us_DEF456" ], skipMyMessages: false , }); const result = await client.messages. forward ({ to: "447123456789@c.us" , messages: [ "false_447123456789@c.us_ABC123" , "false_447123456789@c.us_DEF456" ], skipMyMessages: false , }); curl -X POST "http://localhost:8080/api/messages/forward" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "messages": [ "false_447123456789@c.us_ABC123", "false_447123456789@c.us_DEF456" ], "skipMyMessages": false }' Prop Value Return type object { _serialized }[] | boolean
Get all chat IDs
Prop Value Namespace chatIdsAction readFunctionality bothPositional parameter order - Aliases chatIds.all, chatIds.getAll, chatIds.list, chats.ids, listChatIdsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/chatIds/getAllgetAllChatIdsActive Alias GET/api/chatIds/allchatIds.allActive Alias GET/api/chatIds/listchatIds.listActive Alias GET/api/chats/idschats.idsActive Alias GET/api/getAllChatIdsgetAllChatIdsActive Alias GET/api/listChatIdslistChatIdsActive
Client Namespaced client HTTP API
const result = await client. getAllChatIds ({}); const result = await client.chatIds. getAll ({}); curl -X GET "http://localhost:8080/api/chatIds/getAll" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type string[]
Retrieves all chats
Prop Value Namespace chatsAction readFunctionality bothPositional parameter order withNewMessagesOnlyAliases chats.all, chats.getAll, chats.list, listChatsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/chats/getAllgetAllChatsActive Alias GET/api/chats/allchats.allActive Alias GET/api/chats/listchats.listActive Alias GET/api/getAllChatsgetAllChatsActive Alias GET/api/listChatslistChatsActive
Client Namespaced client HTTP API
const result = await client. getAllChats ({ withNewMessagesOnly: false , }); const result = await client.chats. getAll ({ withNewMessagesOnly: false , }); curl -G "http://localhost:8080/api/chats/getAll" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "withNewMessagesOnly=false" Prop Value Return type unknown[]
Get all communities
Prop Value Namespace communitiesAction readFunctionality bothPositional parameter order - Aliases communities.all, communities.getAll, communities.list, listCommunitiesDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/communities/getAllgetAllCommunitiesActive Alias GET/api/communities/allcommunities.allActive Alias GET/api/communities/listcommunities.listActive Alias GET/api/getAllCommunitiesgetAllCommunitiesActive Alias GET/api/listCommunitieslistCommunitiesActive
Client Namespaced client HTTP API
const result = await client. getAllCommunities ({}); const result = await client.communities. getAll ({}); curl -X GET "http://localhost:8080/api/communities/getAll" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type string[]
Retrieves all contacts
Prop Value Namespace contactsAction readFunctionality bothPositional parameter order - Aliases contacts.all, contacts.getAll, contacts.list, listContactsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/contacts/getAllgetAllContactsActive Alias GET/api/contacts/allcontacts.allActive Alias GET/api/contacts/listcontacts.listActive Alias GET/api/getAllContactsgetAllContactsActive Alias GET/api/listContactslistContactsActive
Client Namespaced client HTTP API
const result = await client. getAllContacts ({}); const result = await client.contacts. getAll ({}); curl -X GET "http://localhost:8080/api/contacts/getAll" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown[]
Get all groups
Prop Value Namespace groupsAction readFunctionality bothPositional parameter order withNewMessagesOnlyAliases groups.all, groups.getAll, groups.list, listGroupsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/groups/getAllgetAllGroupsActive Alias GET/api/getAllGroupsgetAllGroupsActive Alias GET/api/groups/allgroups.allActive Alias GET/api/groups/listgroups.listActive Alias GET/api/listGroupslistGroupsActive
Client Namespaced client HTTP API
const result = await client. getAllGroups ({ withNewMessagesOnly: false , }); const result = await client.groups. getAll ({ withNewMessagesOnly: false , }); curl -G "http://localhost:8080/api/groups/getAll" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "withNewMessagesOnly=false" Prop Value Return type unknown[]
Get all labels
Prop Value Namespace labelsAction readFunctionality business-onlyPositional parameter order - Aliases labels.all, labels.getAll, labels.list, listLabelsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/labels/getAllgetAllLabelsActive Alias GET/api/getAllLabelsgetAllLabelsActive Alias GET/api/labels/alllabels.allActive Alias GET/api/labels/listlabels.listActive Alias GET/api/listLabelslistLabelsActive
Client Namespaced client HTTP API
const result = await client. getAllLabels ({}); const result = await client.labels. getAll ({}); curl -X GET "http://localhost:8080/api/labels/getAll" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown[]
Retrieves all messages in the session
Prop Value Namespace messagesAction readFunctionality bothPositional parameter order chatId, includeMe, includeNotificationsAliases listMessages, messages.all, messages.getAll, messages.listDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/messages/getAllgetAllMessagesActive Alias GET/api/getAllMessagesgetAllMessagesActive Alias GET/api/listMessageslistMessagesActive Alias GET/api/messages/allmessages.allActive Alias GET/api/messages/listmessages.listActive
Client Namespaced client HTTP API
const result = await client. getAllMessages ({ chatId: "447123456789@c.us" , includeMe: true , includeNotifications: true , }); const result = await client.messages. getAll ({ chatId: "447123456789@c.us" , includeMe: true , includeNotifications: true , }); curl -G "http://localhost:8080/api/messages/getAll" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "chatId=447123456789@c.us" \ --data-urlencode "includeMe=true" \ --data-urlencode "includeNotifications=true" Prop Value Return type unknown[]
Get phone battery level
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases session.getBatteryLevelDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/session/getBatteryLevelgetBatteryLevelActive Alias GET/api/getBatteryLevelgetBatteryLevelActive
Client Namespaced client HTTP API
const result = await client. getBatteryLevel ({}); const result = await client.session. getBatteryLevel ({}); curl -X GET "http://localhost:8080/api/session/getBatteryLevel" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type number
Get blocked contact IDs
Prop Value Namespace contactsAction readFunctionality bothPositional parameter order - Aliases contacts.getBlockedIdsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/contacts/getBlockedIdsgetBlockedIdsActive Alias GET/api/getBlockedIdsgetBlockedIdsActive
Client Namespaced client HTTP API
const result = await client. getBlockedIds ({}); const result = await client.contacts. getBlockedIds ({}); curl -X GET "http://localhost:8080/api/contacts/getBlockedIds" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type string[]
Get business products
Prop Value Namespace businessAction readFunctionality bothPositional parameter order contactIdAliases business.getProducts, business.getProfilesProducts, getBusinessProfilesProductsDeprecated aliases business.getProfilesProducts, getBusinessProfilesProductsLicense noneWAPI override getBusinessProfilesProductsDeprecated No
Type Method Path Name Status Primary GET/api/business/getProductsgetBusinessProductsActive Deprecated alias GET/api/business/getProfilesProductsbusiness.getProfilesProductsDeprecated Alias GET/api/getBusinessProductsgetBusinessProductsActive Deprecated alias GET/api/getBusinessProfilesProductsgetBusinessProfilesProductsDeprecated
Client Namespaced client HTTP API
const result = await client. getBusinessProducts ({ contactId: "447123456789@c.us" , }); const result = await client.business. getProducts ({ contactId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/business/getProducts" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "contactId=447123456789@c.us" Prop Value Return type unknown
Get business profile
Prop Value Namespace businessAction readFunctionality bothPositional parameter order contactIdAliases business.getProfileDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/business/getProfilegetBusinessProfileActive Alias GET/api/getBusinessProfilegetBusinessProfileActive
Client Namespaced client HTTP API
const result = await client. getBusinessProfile ({ contactId: "447123456789@c.us" , }); const result = await client.business. getProfile ({ contactId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/business/getProfile" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "contactId=447123456789@c.us" Prop Value Return type unknown
Get specific chat by ID
Prop Value Namespace chatsAction readFunctionality bothPositional parameter order chatIdAliases chats.get, chats.getById, getChatByIdDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/chats/getgetChatActive Alias GET/api/chats/getByIdchats.getByIdActive Alias GET/api/getChatgetChatActive Alias GET/api/getChatByIdgetChatByIdActive
Client Namespaced client HTTP API
const result = await client. getChat ({ chatId: "447123456789@c.us" , }); const result = await client.chats. get ({ chatId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/chats/get" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "chatId=447123456789@c.us" Prop Value Return type unknown
Get chats by label
Prop Value Namespace labelsAction readFunctionality business-onlyPositional parameter order labelAliases labels.getChats, labels.getChatsByDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/labels/getChatsgetChatsByLabelActive Alias GET/api/getChatsByLabelgetChatsByLabelActive Alias GET/api/labels/getChatsBylabels.getChatsByActive
Client Namespaced client HTTP API
const result = await client. getChatsByLabel ({ label: "label" , }); const result = await client.labels. getChats ({ label: "label" , }); curl -G "http://localhost:8080/api/labels/getChats" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "label=label" Prop Value Return type unknown[]
Get chats with non-contacts
Prop Value Namespace chatsAction readFunctionality bothPositional parameter order - Aliases chats.getWithNonContactsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/chats/getWithNonContactsgetChatWithNonContactsActive Alias GET/api/getChatWithNonContactsgetChatWithNonContactsActive
Client Namespaced client HTTP API
const result = await client. getChatWithNonContacts ({}); const result = await client.chats. getWithNonContacts ({}); curl -X GET "http://localhost:8080/api/chats/getWithNonContacts" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown[]
Get common groups with contact
Prop Value Namespace contactsAction readFunctionality bothPositional parameter order contactIdAliases contacts.getCommonGroupsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/contacts/getCommonGroupsgetCommonGroupsActive Alias GET/api/getCommonGroupsgetCommonGroupsActive
Client Namespaced client HTTP API
const result = await client. getCommonGroups ({ contactId: "447123456789@c.us" , }); const result = await client.contacts. getCommonGroups ({ contactId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/contacts/getCommonGroups" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "contactId=447123456789@c.us" Prop Value Return type unknown
Get community admin IDs
Prop Value Namespace communitiesAction readFunctionality bothPositional parameter order communityIdAliases communities.getAdminIdsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/communities/getAdminIdsgetCommunityAdminIdsActive Alias GET/api/getCommunityAdminIdsgetCommunityAdminIdsActive
Client Namespaced client HTTP API
const result = await client. getCommunityAdminIds ({ communityId: "447123456789-1445627445@g.us" , }); const result = await client.communities. getAdminIds ({ communityId: "447123456789-1445627445@g.us" , }); curl -G "http://localhost:8080/api/communities/getAdminIds" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "communityId=447123456789-1445627445@g.us" Prop Value Return type unknown
Get community admins
Prop Value Namespace communitiesAction readFunctionality bothPositional parameter order communityIdAliases communities.getAdminsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/communities/getAdminsgetCommunityAdminsActive Alias GET/api/getCommunityAdminsgetCommunityAdminsActive
Client Namespaced client HTTP API
const result = await client. getCommunityAdmins ({ communityId: "447123456789-1445627445@g.us" , }); const result = await client.communities. getAdmins ({ communityId: "447123456789-1445627445@g.us" , }); curl -G "http://localhost:8080/api/communities/getAdmins" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "communityId=447123456789-1445627445@g.us" Prop Value Return type unknown
Get community metadata
Prop Value Namespace communitiesAction readFunctionality bothPositional parameter order communityIdAliases communities.getInfoDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/communities/getInfogetCommunityInfoActive Alias GET/api/getCommunityInfogetCommunityInfoActive
Client Namespaced client HTTP API
const result = await client. getCommunityInfo ({ communityId: "447123456789-1445627445@g.us" , }); const result = await client.communities. getInfo ({ communityId: "447123456789-1445627445@g.us" , }); curl -G "http://localhost:8080/api/communities/getInfo" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "communityId=447123456789-1445627445@g.us" Prop Value Return type unknown
Get community participant IDs
Prop Value Namespace communitiesAction readFunctionality bothPositional parameter order communityIdAliases communities.getParticipantIdsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/communities/getParticipantIdsgetCommunityParticipantIdsActive Alias GET/api/getCommunityParticipantIdsgetCommunityParticipantIdsActive
Client Namespaced client HTTP API
const result = await client. getCommunityParticipantIds ({ communityId: "447123456789-1445627445@g.us" , }); const result = await client.communities. getParticipantIds ({ communityId: "447123456789-1445627445@g.us" , }); curl -G "http://localhost:8080/api/communities/getParticipantIds" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "communityId=447123456789-1445627445@g.us" Prop Value Return type unknown
Get community participants
Prop Value Namespace communitiesAction readFunctionality bothPositional parameter order communityIdAliases communities.getParticipantsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/communities/getParticipantsgetCommunityParticipantsActive Alias GET/api/getCommunityParticipantsgetCommunityParticipantsActive
Client Namespaced client HTTP API
const result = await client. getCommunityParticipants ({ communityId: "447123456789-1445627445@g.us" , }); const result = await client.communities. getParticipants ({ communityId: "447123456789-1445627445@g.us" , }); curl -G "http://localhost:8080/api/communities/getParticipants" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "communityId=447123456789-1445627445@g.us" Prop Value Return type unknown
Get connection state
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases session.getConnectionStateDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/session/getConnectionStategetConnectionStateActive Alias GET/api/getConnectionStategetConnectionStateActive
Client Namespaced client HTTP API
const result = await client. getConnectionState ({}); const result = await client.session. getConnectionState ({}); curl -X GET "http://localhost:8080/api/session/getConnectionState" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown
Get specific contact
Prop Value Namespace contactsAction readFunctionality bothPositional parameter order contactIdAliases contacts.getDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/contacts/getgetContactActive Alias GET/api/getContactgetContactActive
Client Namespaced client HTTP API
const result = await client. getContact ({ contactId: "447123456789@c.us" , }); const result = await client.contacts. get ({ contactId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/contacts/get" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "contactId=447123456789@c.us" Prop Value Return type unknown
Get enabled features
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases session.getFeaturesDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/session/getFeaturesgetFeaturesActive Alias GET/api/getFeaturesgetFeaturesActive
Client Namespaced client HTTP API
const result = await client. getFeatures ({}); const result = await client.session. getFeatures ({}); curl -X GET "http://localhost:8080/api/session/getFeatures" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown
Get group admins
Prop Value Namespace groupsAction readFunctionality bothPositional parameter order groupIdAliases groups.getAdminsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/groups/getAdminsgetGroupAdminsActive Alias GET/api/getGroupAdminsgetGroupAdminsActive
Client Namespaced client HTTP API
const result = await client. getGroupAdmins ({ groupId: "447123456789-1445627445@g.us" , }); const result = await client.groups. getAdmins ({ groupId: "447123456789-1445627445@g.us" , }); curl -G "http://localhost:8080/api/groups/getAdmins" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "groupId=447123456789-1445627445@g.us" Prop Value Return type unknown[]
Get group metadata
Prop Value Namespace groupsAction readFunctionality bothPositional parameter order groupIdAliases groups.getInfoDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/groups/getInfogetGroupInfoActive Alias GET/api/getGroupInfogetGroupInfoActive
Client Namespaced client HTTP API
const result = await client. getGroupInfo ({ groupId: "447123456789-1445627445@g.us" , }); const result = await client.groups. getInfo ({ groupId: "447123456789-1445627445@g.us" , }); curl -G "http://localhost:8080/api/groups/getInfo" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "groupId=447123456789-1445627445@g.us" Prop Value Return type unknown
Get group invite link
Prop Value Namespace groupsAction readFunctionality bothPositional parameter order groupIdAliases groups.getInviteLinkDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/groups/getInviteLinkgetGroupInviteLinkActive Alias GET/api/getGroupInviteLinkgetGroupInviteLinkActive
Client Namespaced client HTTP API
const result = await client. getGroupInviteLink ({ groupId: "447123456789-1445627445@g.us" , }); const result = await client.groups. getInviteLink ({ groupId: "447123456789-1445627445@g.us" , }); curl -G "http://localhost:8080/api/groups/getInviteLink" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "groupId=447123456789-1445627445@g.us" Prop Value Return type string
Retrieves members of a group
Prop Value Namespace groupsAction readFunctionality bothPositional parameter order groupIdAliases groups.getMembersDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/groups/getMembersgetGroupMembersActive Alias GET/api/getGroupMembersgetGroupMembersActive
Client Namespaced client HTTP API
const result = await client. getGroupMembers ({ groupId: "447123456789-1445627445@g.us" , }); const result = await client.groups. getMembers ({ groupId: "447123456789-1445627445@g.us" , }); curl -G "http://localhost:8080/api/groups/getMembers" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "groupId=447123456789-1445627445@g.us" Prop Value Return type unknown[]
Get group member IDs
Prop Value Namespace groupsAction readFunctionality bothPositional parameter order groupIdAliases getGroupMemberIds, groups.getMemberIds, groups.getMembersIdDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/groups/getMemberIdsgetGroupMembersIdActive Alias GET/api/getGroupMemberIdsgetGroupMemberIdsActive Alias GET/api/getGroupMembersIdgetGroupMembersIdActive Alias GET/api/groups/getMembersIdgroups.getMembersIdActive
Client Namespaced client HTTP API
const result = await client. getGroupMembersId ({ groupId: "447123456789-1445627445@g.us" , }); const result = await client.groups. getMemberIds ({ groupId: "447123456789-1445627445@g.us" , }); curl -G "http://localhost:8080/api/groups/getMemberIds" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "groupId=447123456789-1445627445@g.us" Prop Value Return type string[]
Get host phone number
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases session.getHostNumberDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/session/getHostNumbergetHostNumberActive Alias GET/api/getHostNumbergetHostNumberActive
Client Namespaced client HTTP API
const result = await client. getHostNumber ({}); const result = await client.session. getHostNumber ({}); curl -X GET "http://localhost:8080/api/session/getHostNumber" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type string
Get groups where kicked
Prop Value Namespace groupsAction readFunctionality bothPositional parameter order - Aliases groups.getKickedDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/groups/getKickedgetKickedGroupsActive Alias GET/api/getKickedGroupsgetKickedGroupsActive
Client Namespaced client HTTP API
const result = await client. getKickedGroups ({}); const result = await client.groups. getKicked ({}); curl -X GET "http://localhost:8080/api/groups/getKicked" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type string[]
Get license type
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases session.getLicenseTypeDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/session/getLicenseTypegetLicenseTypeActive Alias GET/api/getLicenseTypegetLicenseTypeActive
Client Namespaced client HTTP API
const result = await client. getLicenseType ({}); const result = await client.session. getLicenseType ({}); curl -X GET "http://localhost:8080/api/session/getLicenseType" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown | boolean
Get loaded message count
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases getAmountOfLoadedMessages, session.getAmountOfLoadedMessages, session.getLoadedMessageCountDeprecated aliases getAmountOfLoadedMessages, session.getAmountOfLoadedMessagesLicense noneWAPI override getAmountOfLoadedMessagesDeprecated No
Type Method Path Name Status Primary GET/api/session/getLoadedMessageCountgetLoadedMessageCountActive Deprecated alias GET/api/getAmountOfLoadedMessagesgetAmountOfLoadedMessagesDeprecated Alias GET/api/getLoadedMessageCountgetLoadedMessageCountActive Deprecated alias GET/api/session/getAmountOfLoadedMessagessession.getAmountOfLoadedMessagesDeprecated
Client Namespaced client HTTP API
const result = await client. getLoadedMessageCount ({}); const result = await client.session. getLoadedMessageCount ({}); curl -X GET "http://localhost:8080/api/session/getLoadedMessageCount" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type number
Get host account info
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases session.getMeDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/session/getMegetMeActive Alias GET/api/getMegetMeActive
Client Namespaced client HTTP API
const result = await client. getMe ({}); const result = await client.session. getMe ({}); curl -X GET "http://localhost:8080/api/session/getMe" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown
Retrieves a specific message by ID
Prop Value Namespace messagesAction readFunctionality bothPositional parameter order messageIdAliases getMessage, messages.get, messages.getByIdDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/messages/getgetMessageByIdActive Alias GET/api/getMessagegetMessageActive Alias GET/api/getMessageByIdgetMessageByIdActive Alias GET/api/messages/getByIdmessages.getByIdActive
Client Namespaced client HTTP API
const result = await client. getMessageById ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); const result = await client.messages. get ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); curl -G "http://localhost:8080/api/messages/get" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "messageId=false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" Prop Value Return type unknown
Get message delivery info
Prop Value Namespace messagesAction readFunctionality bothPositional parameter order messageIdAliases messages.getInfoDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/messages/getInfogetMessageInfoActive Alias GET/api/getMessageInfogetMessageInfoActive
Client Namespaced client HTTP API
const result = await client. getMessageInfo ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); const result = await client.messages. getInfo ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); curl -G "http://localhost:8080/api/messages/getInfo" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "messageId=false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" Prop Value Return type unknown
Get messages formatted for LLMs
Prop Value Namespace messagesAction readFunctionality bothPositional parameter order chatId, lastAliases getGptArray, messages.getForLLM, messages.getGptArrayDeprecated aliases getGptArray, messages.getGptArrayLicense noneWAPI override getGptArrayDeprecated No
Type Method Path Name Status Primary GET/api/messages/getForLLMgetMessagesForLLMActive Deprecated alias GET/api/getGptArraygetGptArrayDeprecated Alias GET/api/getMessagesForLLMgetMessagesForLLMActive Deprecated alias GET/api/messages/getGptArraymessages.getGptArrayDeprecated
Client Namespaced client HTTP API
const result = await client. getMessagesForLLM ({ chatId: "447123456789@c.us" , last: 1 , }); const result = await client.messages. getForLLM ({ chatId: "447123456789@c.us" , last: 1 , }); curl -G "http://localhost:8080/api/messages/getForLLM" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "chatId=447123456789@c.us" \ --data-urlencode "last=1" Prop Value Return type unknown
Get last message sent by host
Prop Value Namespace messagesAction readFunctionality bothPositional parameter order chatIdAliases messages.getMyLastDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/messages/getMyLastgetMyLastMessageActive Alias GET/api/getMyLastMessagegetMyLastMessageActive
Client Namespaced client HTTP API
const result = await client. getMyLastMessage ({ chatId: "447123456789@c.us" , }); const result = await client.messages. getMyLast ({ chatId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/messages/getMyLast" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "chatId=447123456789@c.us" Prop Value Return type unknown
Get profile of number
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace contactsAction readFunctionality bothPositional parameter order contactIdAliases contacts.getNumberProfileDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/contacts/getNumberProfilegetNumberProfileActive Alias GET/api/getNumberProfilegetNumberProfileActive
Client Namespaced client HTTP API
const result = await client. getNumberProfile ({ contactId: "447123456789@c.us" , }); const result = await client.contacts. getNumberProfile ({ contactId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/contacts/getNumberProfile" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "contactId=447123456789@c.us" Prop Value Return type unknown
Get order details
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace businessAction readFunctionality bothPositional parameter order idAliases business.getOrderDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/business/getOrdergetOrderActive Alias GET/api/getOrdergetOrderActive
Client Namespaced client HTTP API
const result = await client. getOrder ({ id: "id" , }); const result = await client.business. getOrder ({ id: "id" , }); curl -G "http://localhost:8080/api/business/getOrder" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "id=id" Prop Value Return type unknown
Get process statistics
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases session.getProcessStatsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/session/getProcessStatsgetProcessStatsActive Alias GET/api/getProcessStatsgetProcessStatsActive
Client Namespaced client HTTP API
const result = await client. getProcessStats ({}); const result = await client.session. getProcessStats ({}); curl -X GET "http://localhost:8080/api/session/getProcessStats" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown
Get profile picture from server
Prop Value Namespace contactsAction readFunctionality bothPositional parameter order chatIdAliases contacts.getProfilePicFromServer, contacts.getProfilePicture, getProfilePicFromServerDeprecated aliases contacts.getProfilePicFromServer, getProfilePicFromServerLicense noneWAPI override getProfilePicFromServerDeprecated No
Type Method Path Name Status Primary GET/api/contacts/getProfilePicturegetProfilePictureActive Deprecated alias GET/api/contacts/getProfilePicFromServercontacts.getProfilePicFromServerDeprecated Deprecated alias GET/api/getProfilePicFromServergetProfilePicFromServerDeprecated Alias GET/api/getProfilePicturegetProfilePictureActive
Client Namespaced client HTTP API
const result = await client. getProfilePicture ({ chatId: "447123456789@c.us" , }); const result = await client.contacts. getProfilePicture ({ chatId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/contacts/getProfilePicture" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "chatId=447123456789@c.us" Prop Value Return type string
Take screenshot
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order chatId, width, heightAliases session.getSnapshot, session.takeScreenshot, takeScreenshotDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/session/getSnapshotgetSnapshotActive Alias GET/api/getSnapshotgetSnapshotActive Alias GET/api/session/takeScreenshotsession.takeScreenshotActive Alias GET/api/takeScreenshottakeScreenshotActive
Client Namespaced client HTTP API
const result = await client. getSnapshot ({ chatId: "447123456789@c.us" , width: 1 , height: 1 , }); const result = await client.session. getSnapshot ({ chatId: "447123456789@c.us" , width: 1 , height: 1 , }); curl -G "http://localhost:8080/api/session/getSnapshot" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "chatId=447123456789@c.us" \ --data-urlencode "width=1" \ --data-urlencode "height=1" Prop Value Return type string
Get starred messages
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace messagesAction readFunctionality bothPositional parameter order chatIdAliases messages.getStarredDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/messages/getStarredgetStarredMessagesActive Alias GET/api/getStarredMessagesgetStarredMessagesActive
Client Namespaced client HTTP API
const result = await client. getStarredMessages ({ chatId: "447123456789@c.us" , }); const result = await client.messages. getStarred ({ chatId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/messages/getStarred" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "chatId=447123456789@c.us" Prop Value Return type unknown[]
Get specific status
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace mystatusAction readFunctionality bothPositional parameter order contactIdAliases mystatus.getStatusDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/mystatus/getStatusgetStatusActive Alias GET/api/getStatusgetStatusActive
Client Namespaced client HTTP API
const result = await client. getStatus ({ contactId: "447123456789@c.us" , }); const result = await client.mystatus. getStatus ({ contactId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/mystatus/getStatus" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "contactId=447123456789@c.us" Prop Value Return type unknown
Get all stories
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace statusAction readFunctionality bothPositional parameter order - Aliases getStatuses, status.get, status.getAll, status.getStoriesDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/status/getAllgetStoriesActive Alias GET/api/getStatusesgetStatusesActive Alias GET/api/getStoriesgetStoriesActive Alias GET/api/status/getstatus.getActive Alias GET/api/status/getStoriesstatus.getStoriesActive
Client Namespaced client HTTP API
const result = await client. getStories ({}); const result = await client.status. getAll ({}); curl -X GET "http://localhost:8080/api/status/getAll" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown[]
Get unsent/pending messages
Prop Value Namespace messagesAction readFunctionality bothPositional parameter order - Aliases messages.getUnsentDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/messages/getUnsentgetUnsentMessagesActive Alias GET/api/getUnsentMessagesgetUnsentMessagesActive
Client Namespaced client HTTP API
const result = await client. getUnsentMessages ({}); const result = await client.messages. getUnsent ({}); curl -X GET "http://localhost:8080/api/messages/getUnsent" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown[]
Get user agent
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order userAgentAliases getGeneratedUserAgent, session.getGeneratedUserAgent, session.getUserAgentDeprecated aliases getGeneratedUserAgent, session.getGeneratedUserAgentLicense noneWAPI override getGeneratedUserAgentDeprecated No
Type Method Path Name Status Primary GET/api/session/getUserAgentgetUserAgentActive Deprecated alias GET/api/getGeneratedUserAgentgetGeneratedUserAgentDeprecated Alias GET/api/getUserAgentgetUserAgentActive Deprecated alias GET/api/session/getGeneratedUserAgentsession.getGeneratedUserAgentDeprecated
Client Namespaced client HTTP API
const result = await client. getUserAgent ({ userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)" , }); const result = await client.session. getUserAgent ({ userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)" , }); curl -G "http://localhost:8080/api/session/getUserAgent" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "userAgent=Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)" Prop Value Return type string
Extract vCards from message
Prop Value Namespace messagesAction readFunctionality bothPositional parameter order messageIdAliases messages.getVCardsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/messages/getVCardsgetVCardsActive Alias GET/api/getVCardsgetVCardsActive
Client Namespaced client HTTP API
const result = await client. getVCards ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); const result = await client.messages. getVCards ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); curl -G "http://localhost:8080/api/messages/getVCards" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "messageId=false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" Prop Value Return type string[]
Get WhatsApp Web version
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases getWhatsAppVersion, session.getWAVersion, session.getWhatsAppVersionDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/session/getWAVersiongetWAVersionActive Alias GET/api/getWAVersiongetWAVersionActive Alias GET/api/getWhatsAppVersiongetWhatsAppVersionActive Alias GET/api/session/getWhatsAppVersionsession.getWhatsAppVersionActive
Client Namespaced client HTTP API
const result = await client. getWAVersion ({}); const result = await client.session. getWAVersion ({}); curl -X GET "http://localhost:8080/api/session/getWAVersion" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type string
Health check
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases session.healthCheckDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/session/healthCheckhealthCheckActive Alias GET/api/healthCheckhealthCheckActive
Client Namespaced client HTTP API
const result = await client. healthCheck ({}); const result = await client.session. healthCheck ({}); curl -X GET "http://localhost:8080/api/session/healthCheck" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type unknown
Check if chat is online
Prop Value Namespace chatsAction readFunctionality bothPositional parameter order chatIdAliases chats.isOnlineDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary GET/api/chats/isOnlineisChatOnlineActive Alias GET/api/isChatOnlineisChatOnlineActive
Client Namespaced client HTTP API
const result = await client. isChatOnline ({ chatId: "447123456789@c.us" , }); const result = await client.chats. isOnline ({ chatId: "447123456789@c.us" , }); curl -G "http://localhost:8080/api/chats/isOnline" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode "chatId=447123456789@c.us" Prop Value Return type boolean | string
Check if phone is charging
Prop Value Namespace sessionAction readFunctionality bothPositional parameter order - Aliases getIsPlugged, session.getIsPlugged, session.isPluggedDeprecated aliases getIsPlugged, session.getIsPluggedLicense noneWAPI override getIsPluggedDeprecated No
Type Method Path Name Status Primary GET/api/session/isPluggedisPluggedActive Deprecated alias GET/api/getIsPluggedgetIsPluggedDeprecated Alias GET/api/isPluggedisPluggedActive Deprecated alias GET/api/session/getIsPluggedsession.getIsPluggedDeprecated
Client Namespaced client HTTP API
const result = await client. isPlugged ({}); const result = await client.session. isPlugged ({}); curl -X GET "http://localhost:8080/api/session/isPlugged" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{}' This method does not define input parameters.
Prop Value Return type boolean
Join group via invite link
🧵 Restricted Licensed feature
Restricted feature
May require a restricted license for gated or host-account-specific flows.
Prop Value Namespace groupsAction sendFunctionality bothPositional parameter order link, returnChatObjAliases groups.join, groups.joinViaLink, joinGroupDeprecated aliases - License restrictedWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/groups/joinjoinGroupViaLinkActive Alias POST/api/groups/joinViaLinkgroups.joinViaLinkActive Alias POST/api/joinGroupjoinGroupActive Alias POST/api/joinGroupViaLinkjoinGroupViaLinkActive
Client Namespaced client HTTP API
const result = await client. joinGroupViaLink ({ link: "link" , returnChatObj: true , }); const result = await client.groups. join ({ link: "link" , returnChatObj: true , }); curl -X POST "http://localhost:8080/api/groups/join" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "link": "link", "returnChatObj": true }' Prop Value Return type string | boolean | number | unknown
Leave a group
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupIdAliases groups.leaveDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/leaveleaveGroupActive Alias PUT/api/leaveGroupleaveGroupActive
Client Namespaced client HTTP API
const result = await client. leaveGroup ({ groupId: "447123456789-1445627445@g.us" , }); const result = await client.groups. leave ({ groupId: "447123456789-1445627445@g.us" , }); curl -X PUT "http://localhost:8080/api/groups/leave" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us" }' Prop Value Return type unknown
Loads earlier messages from a chat
Prop Value Namespace messagesAction readFunctionality bothPositional parameter order chatId, count, includeMeAliases loadOlderMessages, messages.loadEarlier, messages.loadOlderDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/loadEarlierloadEarlierMessagesActive Alias POST/api/loadEarlierMessagesloadEarlierMessagesActive Alias POST/api/loadOlderMessagesloadOlderMessagesActive Alias POST/api/messages/loadOldermessages.loadOlderActive
Client Namespaced client HTTP API
const result = await client. loadEarlierMessages ({ chatId: "447123456789@c.us" , count: 1 , includeMe: true , }); const result = await client.messages. loadEarlier ({ chatId: "447123456789@c.us" , count: 1 , includeMe: true , }); curl -X POST "http://localhost:8080/api/messages/loadEarlier" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us", "count": 1, "includeMe": true }' Prop Value Return type unknown[]
Mark chat as read
Prop Value Namespace chatsAction updateFunctionality bothPositional parameter order chatIdAliases chats.markAsReadDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/chats/markAsReadmarkAsReadActive Alias PUT/api/markAsReadmarkAsReadActive
Client Namespaced client HTTP API
const result = await client. markAsRead ({ chatId: "447123456789@c.us" , }); const result = await client.chats. markAsRead ({ chatId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/chats/markAsRead" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Mark chat as unread
Prop Value Namespace chatsAction updateFunctionality bothPositional parameter order chatIdAliases chats.markAsUnreadDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/chats/markAsUnreadmarkAsUnreadActive Alias PUT/api/markAsUnreadmarkAsUnreadActive
Client Namespaced client HTTP API
const result = await client. markAsUnread ({ chatId: "447123456789@c.us" , }); const result = await client.chats. markAsUnread ({ chatId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/chats/markAsUnread" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Mute a chat
Prop Value Namespace chatsAction updateFunctionality bothPositional parameter order chatId, muteDurationAliases chats.muteDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/chats/mutemuteChatActive Alias PUT/api/muteChatmuteChatActive
Client Namespaced client HTTP API
const result = await client. muteChat ({ chatId: "447123456789@c.us" , muteDuration: 1 , }); const result = await client.chats. mute ({ chatId: "447123456789@c.us" , muteDuration: 1 , }); curl -X PUT "http://localhost:8080/api/chats/mute" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us", "muteDuration": 1 }' Prop Value Return type string | boolean | number
Pin a chat
Prop Value Namespace chatsAction updateFunctionality bothPositional parameter order chatIdAliases chats.pinDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/chats/pinpinChatActive Alias PUT/api/pinChatpinChatActive
Client Namespaced client HTTP API
const result = await client. pinChat ({ chatId: "447123456789@c.us" , }); const result = await client.chats. pin ({ chatId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/chats/pin" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Post image status
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace statusAction sendFunctionality bothPositional parameter order image, captionAliases status.postImageDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/status/postImagepostImageStatusActive Alias POST/api/postImageStatuspostImageStatusActive
Client Namespaced client HTTP API
const result = await client. postImageStatus ({ image: "image" , caption: "caption" , }); const result = await client.status. postImage ({ image: "image" , caption: "caption" , }); curl -X POST "http://localhost:8080/api/status/postImage" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "image": "image", "caption": "caption" }' Prop Value Return type unknown
Post text status
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace statusAction sendFunctionality bothPositional parameter order text, backgroundColor, fontAliases status.postTextDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/status/postTextpostTextStatusActive Alias POST/api/postTextStatuspostTextStatusActive
Client Namespaced client HTTP API
const result = await client. postTextStatus ({ text: "text" , backgroundColor: "backgroundColor" , font: 1 , }); const result = await client.status. postText ({ text: "text" , backgroundColor: "backgroundColor" , font: 1 , }); curl -X POST "http://localhost:8080/api/status/postText" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "text": "text", "backgroundColor": "backgroundColor", "font": 1 }' Prop Value Return type unknown
Post video status
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace statusAction sendFunctionality bothPositional parameter order video, captionAliases status.postVideoDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/status/postVideopostVideoStatusActive Alias POST/api/postVideoStatuspostVideoStatusActive
Client Namespaced client HTTP API
const result = await client. postVideoStatus ({ video: "video" , caption: "caption" , }); const result = await client.status. postVideo ({ video: "video" , caption: "caption" , }); curl -X POST "http://localhost:8080/api/status/postVideo" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "video": "video", "caption": "caption" }' Prop Value Return type unknown
Promote participant to admin
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, contactIdAliases groups.promoteParticipant, promoteGroupParticipantDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/promoteParticipantpromoteParticipantActive Alias PUT/api/promoteGroupParticipantpromoteGroupParticipantActive Alias PUT/api/promoteParticipantpromoteParticipantActive
Client Namespaced client HTTP API
const result = await client. promoteParticipant ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); const result = await client.groups. promoteParticipant ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/groups/promoteParticipant" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "contactId": "447123456789@c.us" }' Prop Value Return type boolean | string
React to message with emoji
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order messageId, emojiAliases messages.reactDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/reactreactActive Alias POST/api/reactreactActive
Client Namespaced client HTTP API
const result = await client. react ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , emoji: "emoji" , }); const result = await client.messages. react ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , emoji: "emoji" , }); curl -X POST "http://localhost:8080/api/messages/react" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "messageId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB", "emoji": "emoji" }' Prop Value Return type boolean
Reject group join request
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, contactIdAliases groups.rejectJoinRequestDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/rejectJoinRequestrejectGroupJoinRequestActive Alias PUT/api/rejectGroupJoinRequestrejectGroupJoinRequestActive
Client Namespaced client HTTP API
const result = await client. rejectGroupJoinRequest ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); const result = await client.groups. rejectJoinRequest ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/groups/rejectJoinRequest" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "contactId": "447123456789@c.us" }' Prop Value Return type string | boolean
Remove label from chat
Prop Value Namespace labelsAction updateFunctionality business-onlyPositional parameter order label, chatIdAliases labels.removeDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/labels/removeremoveLabelActive Alias PUT/api/removeLabelremoveLabelActive
Client Namespaced client HTTP API
const result = await client. removeLabel ({ label: "label" , chatId: "447123456789@c.us" , }); const result = await client.labels. remove ({ label: "label" , chatId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/labels/remove" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "label": "label", "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Remove participant from group
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, contactIdAliases groups.removeParticipant, removeGroupParticipantDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/removeParticipantremoveParticipantActive Alias PUT/api/removeGroupParticipantremoveGroupParticipantActive Alias PUT/api/removeParticipantremoveParticipantActive
Client Namespaced client HTTP API
const result = await client. removeParticipant ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); const result = await client.groups. removeParticipant ({ groupId: "447123456789-1445627445@g.us" , contactId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/groups/removeParticipant" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "contactId": "447123456789@c.us" }' Prop Value Return type boolean
Revoke group invite link
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupIdAliases groups.revokeInviteLinkDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/revokeInviteLinkrevokeGroupInviteLinkActive Alias PUT/api/revokeGroupInviteLinkrevokeGroupInviteLinkActive
Client Namespaced client HTTP API
const result = await client. revokeGroupInviteLink ({ groupId: "447123456789-1445627445@g.us" , }); const result = await client.groups. revokeInviteLink ({ groupId: "447123456789-1445627445@g.us" , }); curl -X PUT "http://localhost:8080/api/groups/revokeInviteLink" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us" }' Prop Value Return type string | boolean
Sends an advanced button message with media (deprecated)
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, body, buttons, text, footer, filenameAliases messages.sendAdvancedButtonsDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendAdvancedButtonssendAdvancedButtonsActive Alias POST/api/sendAdvancedButtonssendAdvancedButtonsActive
Client Namespaced client HTTP API
const result = await client. sendAdvancedButtons ({ to: "447123456789@c.us" , body: "body" , buttons: [], text: "text" , footer: "footer" , filename: "filename" , }); const result = await client.messages. sendAdvancedButtons ({ to: "447123456789@c.us" , body: "body" , buttons: [], text: "text" , footer: "footer" , filename: "filename" , }); curl -X POST "http://localhost:8080/api/messages/sendAdvancedButtons" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "body": "body", "buttons": [], "text": "text", "footer": "footer", "filename": "filename" }' Prop Value Return type object { _serialized } | boolean
Sends an audio file to a chat
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, file, filename, quotedMsgIdAliases messages.sendAudioDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendAudiosendAudioActive Alias POST/api/sendAudiosendAudioActive
Client Namespaced client HTTP API
const result = await client. sendAudio ({ to: "447123456789@c.us" , file: "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA..." , filename: "document.pdf" , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); const result = await client.messages. sendAudio ({ to: "447123456789@c.us" , file: "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA..." , filename: "document.pdf" , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); curl -X POST "http://localhost:8080/api/messages/sendAudio" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "file": "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA...", "filename": "document.pdf", "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" }' Prop Value Return type object { _serialized } | boolean
Sends a banner image
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, base64Aliases messages.sendBannerDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendBannersendBannerActive Alias POST/api/sendBannersendBannerActive
Client Namespaced client HTTP API
const result = await client. sendBanner ({ to: "447123456789@c.us" , base64: "base64" , }); const result = await client.messages. sendBanner ({ to: "447123456789@c.us" , base64: "base64" , }); curl -X POST "http://localhost:8080/api/messages/sendBanner" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "base64": "base64" }' Prop Value Return type object { _serialized } | boolean
Sends a button message (deprecated)
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, body, buttons, title, footerAliases messages.sendButtonsDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendButtonssendButtonsActive Alias POST/api/sendButtonssendButtonsActive
Client Namespaced client HTTP API
const result = await client. sendButtons ({ to: "447123456789@c.us" , body: "body" , buttons: [], title: "title" , footer: "footer" , }); const result = await client.messages. sendButtons ({ to: "447123456789@c.us" , body: "body" , buttons: [], title: "title" , footer: "footer" , }); curl -X POST "http://localhost:8080/api/messages/sendButtons" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "body": "body", "buttons": [], "title": "title", "footer": "footer" }' Prop Value Return type object { _serialized } | boolean
Sends a single contact
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, contactIdAliases messages.sendContactDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendContactsendContactActive Alias POST/api/sendContactsendContactActive
Client Namespaced client HTTP API
const result = await client. sendContact ({ to: "447123456789@c.us" , contactId: [], }); const result = await client.messages. sendContact ({ to: "447123456789@c.us" , contactId: [], }); curl -X POST "http://localhost:8080/api/messages/sendContact" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "contactId": [] }' Prop Value Return type object { _serialized } | boolean
Sends a file or document to a chat
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, file, filename, captionAliases messages.sendFileDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendFilesendFileActive Alias POST/api/sendFilesendFileActive
Client Namespaced client HTTP API
const result = await client. sendFile ({ to: "447123456789@c.us" , file: "data:application/pdf;base64,JVBERi0xLjQK..." , filename: "document.pdf" , caption: "Check out this image!" , }); const result = await client.messages. sendFile ({ to: "447123456789@c.us" , file: "data:application/pdf;base64,JVBERi0xLjQK..." , filename: "document.pdf" , caption: "Check out this image!" , }); curl -X POST "http://localhost:8080/api/messages/sendFile" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "file": "data:application/pdf;base64,JVBERi0xLjQK...", "filename": "document.pdf", "caption": "Check out this image!" }' Prop Value Return type object { _serialized } | string
Downloads a file from a URL and sends it to a chat
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, url, filename, caption, headersAliases messages.sendFileFromUrlDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendFileFromUrlsendFileFromUrlActive Alias POST/api/sendFileFromUrlsendFileFromUrlActive
Client Namespaced client HTTP API
const result = await client. sendFileFromUrl ({ to: "447123456789@c.us" , url: "url" , filename: "filename" , caption: "caption" , headers: {}, }); const result = await client.messages. sendFileFromUrl ({ to: "447123456789@c.us" , url: "url" , filename: "filename" , caption: "caption" , headers: {}, }); curl -X POST "http://localhost:8080/api/messages/sendFileFromUrl" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "url": "url", "filename": "filename", "caption": "caption", "headers": {} }' Prop Value Return type string | boolean
Sends an image to a chat
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, imgData, filename, caption, id, waitForIdAliases messages.sendImageDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendImagesendImageActive Alias POST/api/sendImagesendImageActive
Client Namespaced client HTTP API
const result = await client. sendImage ({ to: "447123456789@c.us" , imgData: "data:image/png;base64,iVBORw0KGgo..." , filename: "document.pdf" , caption: "Check out this image!" , id: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , waitForId: true , }); const result = await client.messages. sendImage ({ to: "447123456789@c.us" , imgData: "data:image/png;base64,iVBORw0KGgo..." , filename: "document.pdf" , caption: "Check out this image!" , id: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , waitForId: true , }); curl -X POST "http://localhost:8080/api/messages/sendImage" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "imgData": "data:image/png;base64,iVBORw0KGgo...", "filename": "document.pdf", "caption": "Check out this image!", "id": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB", "waitForId": true }' Prop Value Return type object { _serialized } | boolean | string
Sends a link with auto-generated preview
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, url, text, thumbnail, quotedMsgId, customSizeAliases messages.sendLink, messages.sendLinkWithAutoPreview, sendLinkDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendLinkWithAutoPreviewsendLinkWithAutoPreviewActive Alias POST/api/messages/sendLinkmessages.sendLinkActive Alias POST/api/sendLinksendLinkActive Alias POST/api/sendLinkWithAutoPreviewsendLinkWithAutoPreviewActive
Client Namespaced client HTTP API
const result = await client. sendLinkWithAutoPreview ({ to: "447123456789@c.us" , url: "url" , text: "Hello, world!" , thumbnail: "thumbnail" , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , customSize: {}, }); const result = await client.messages. sendLinkWithAutoPreview ({ to: "447123456789@c.us" , url: "url" , text: "Hello, world!" , thumbnail: "thumbnail" , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , customSize: {}, }); curl -X POST "http://localhost:8080/api/messages/sendLinkWithAutoPreview" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "url": "url", "text": "Hello, world!", "thumbnail": "thumbnail", "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB", "customSize": {} }' Prop Value Return type object { _serialized } | boolean
Sends a list/menu message (deprecated)
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, sections, title, description, actionTextAliases messages.sendList, sendListDeprecated aliases - License insidersWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendListsendListMessageActive Alias POST/api/sendListsendListActive Alias POST/api/sendListMessagesendListMessageActive
Client Namespaced client HTTP API
const result = await client. sendListMessage ({ to: "447123456789@c.us" , sections: [], title: "title" , description: "description" , actionText: "actionText" , }); const result = await client.messages. sendList ({ to: "447123456789@c.us" , sections: [], title: "title" , description: "description" , actionText: "actionText" , }); curl -X POST "http://localhost:8080/api/messages/sendList" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "sections": [], "title": "title", "description": "description", "actionText": "actionText" }' Prop Value Return type object { _serialized } | boolean
Sends a location to a chat
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, lat, lng, loc, address, urlAliases messages.sendLocationDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendLocationsendLocationActive Alias POST/api/sendLocationsendLocationActive
Client Namespaced client HTTP API
const result = await client. sendLocation ({ to: "447123456789@c.us" , lat: 51.5074 , lng: - 0.1278 , loc: "London, UK" , address: "address" , url: "url" , }); const result = await client.messages. sendLocation ({ to: "447123456789@c.us" , lat: 51.5074 , lng: - 0.1278 , loc: "London, UK" , address: "address" , url: "url" , }); curl -X POST "http://localhost:8080/api/messages/sendLocation" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "lat": 51.5074, "lng": -0.1278, "loc": "London, UK", "address": "address", "url": "url" }' Prop Value Return type object { _serialized } | boolean
Sends a link preview message with custom thumbnail
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order thumb, url, title, description, content, to, quotedMsgId, customSizeAliases messages.sendLinkWithThumbnail, messages.sendWithThumb, sendLinkWithThumbnailDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendLinkWithThumbnailsendMessageWithThumbActive Alias POST/api/messages/sendWithThumbmessages.sendWithThumbActive Alias POST/api/sendLinkWithThumbnailsendLinkWithThumbnailActive Alias POST/api/sendMessageWithThumbsendMessageWithThumbActive
Client Namespaced client HTTP API
const result = await client. sendMessageWithThumb ({ thumb: "thumb" , url: "url" , title: "title" , description: "description" , content: "Hello, world!" , to: "447123456789@c.us" , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , customSize: {}, }); const result = await client.messages. sendLinkWithThumbnail ({ thumb: "thumb" , url: "url" , title: "title" , description: "description" , content: "Hello, world!" , to: "447123456789@c.us" , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , customSize: {}, }); curl -X POST "http://localhost:8080/api/messages/sendLinkWithThumbnail" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "thumb": "thumb", "url": "url", "title": "title", "description": "description", "content": "Hello, world!", "to": "447123456789@c.us", "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB", "customSize": {} }' Prop Value Return type object { _serialized } | boolean
Sends multiple contacts
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, contactIdsAliases messages.sendContacts, messages.sendMultipleContacts, sendContactsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendContactssendMultipleContactsActive Alias POST/api/messages/sendMultipleContactsmessages.sendMultipleContactsActive Alias POST/api/sendContactssendContactsActive Alias POST/api/sendMultipleContactssendMultipleContactsActive
Client Namespaced client HTTP API
const result = await client. sendMultipleContacts ({ to: "447123456789@c.us" , contactIds: "447123456789@c.us" , }); const result = await client.messages. sendContacts ({ to: "447123456789@c.us" , contactIds: "447123456789@c.us" , }); curl -X POST "http://localhost:8080/api/messages/sendContacts" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "contactIds": "447123456789@c.us" }' Prop Value Return type object { _serialized } | boolean
Sends a payment request message
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, amount, currency, messageAliases messages.sendPaymentRequestDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendPaymentRequestsendPaymentRequestActive Alias POST/api/sendPaymentRequestsendPaymentRequestActive
Client Namespaced client HTTP API
const result = await client. sendPaymentRequest ({ to: "447123456789@c.us" , amount: 1 , currency: "currency" , message: "message" , }); const result = await client.messages. sendPaymentRequest ({ to: "447123456789@c.us" , amount: 1 , currency: "currency" , message: "message" , }); curl -X POST "http://localhost:8080/api/messages/sendPaymentRequest" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "amount": 1, "currency": "currency", "message": "message" }' Prop Value Return type object { _serialized } | boolean
Sends a poll message
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, name, options, selectableCountAliases messages.sendPollDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendPollsendPollActive Alias POST/api/sendPollsendPollActive
Client Namespaced client HTTP API
const result = await client. sendPoll ({ to: "447123456789@c.us" , name: "name" , options: [], selectableCount: 1 , }); const result = await client.messages. sendPoll ({ to: "447123456789@c.us" , name: "name" , options: [], selectableCount: 1 , }); curl -X POST "http://localhost:8080/api/messages/sendPoll" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "name": "name", "options": [], "selectableCount": 1 }' Prop Value Return type object { _serialized } | boolean
Sends a voice note (push-to-talk) to a chat
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, file, quotedMsgIdAliases messages.sendPtt, messages.sendVoiceNote, sendVoiceNoteDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendPttsendPttActive Alias POST/api/messages/sendVoiceNotemessages.sendVoiceNoteActive Alias POST/api/sendPttsendPttActive Alias POST/api/sendVoiceNotesendVoiceNoteActive
Client Namespaced client HTTP API
const result = await client. sendPtt ({ to: "447123456789@c.us" , file: "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA..." , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); const result = await client.messages. sendPtt ({ to: "447123456789@c.us" , file: "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA..." , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); curl -X POST "http://localhost:8080/api/messages/sendPtt" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "file": "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA...", "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" }' Prop Value Return type object { _serialized } | boolean
Sends a reply to a message that includes @mentions
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, content, replyMessageId, hideTags, mentionsAliases messages.sendReplyWithMentionsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendReplyWithMentionssendReplyWithMentionsActive Alias POST/api/sendReplyWithMentionssendReplyWithMentionsActive
Client Namespaced client HTTP API
const result = await client. sendReplyWithMentions ({ to: "447123456789@c.us" , content: "Hello, world!" , replyMessageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , hideTags: true , mentions: [ "447123456789@c.us" , "441234567890@c.us" ], }); const result = await client.messages. sendReplyWithMentions ({ to: "447123456789@c.us" , content: "Hello, world!" , replyMessageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , hideTags: true , mentions: [ "447123456789@c.us" , "441234567890@c.us" ], }); curl -X POST "http://localhost:8080/api/messages/sendReplyWithMentions" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "content": "Hello, world!", "replyMessageId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB", "hideTags": true, "mentions": [ "447123456789@c.us", "441234567890@c.us" ] }' Prop Value Return type object { _serialized } | boolean
Mark message as seen
Prop Value Namespace messagesAction updateFunctionality bothPositional parameter order chatIdAliases messages.sendSeenDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/messages/sendSeensendSeenActive Alias PUT/api/sendSeensendSeenActive
Client Namespaced client HTTP API
const result = await client. sendSeen ({ chatId: "447123456789@c.us" , }); const result = await client.messages. sendSeen ({ chatId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/messages/sendSeen" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Sends a text message to a chat
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, content, optionsAliases messages.sendTextDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendTextsendTextActive Alias POST/api/sendTextsendTextActive
Client Namespaced client HTTP API
const result = await client. sendText ({ to: "447123456789@c.us" , content: "Hello, world!" , options: { "quotedMsg" : "messageId" , "mentionedJidList" :[ "447123456789@c.us" ]}, }); const result = await client.messages. sendText ({ to: "447123456789@c.us" , content: "Hello, world!" , options: { "quotedMsg" : "messageId" , "mentionedJidList" :[ "447123456789@c.us" ]}, }); curl -X POST "http://localhost:8080/api/messages/sendText" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "content": "Hello, world!", "options": { "quotedMsg": "messageId", "mentionedJidList": [ "447123456789@c.us" ] } }' Prop Value Return type object { _serialized } | boolean | string
Sends a text message that includes @mentions
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, content, hideTags, mentionsAliases messages.sendTextWithMentionsDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendTextWithMentionssendTextWithMentionsActive Alias POST/api/sendTextWithMentionssendTextWithMentionsActive
Client Namespaced client HTTP API
const result = await client. sendTextWithMentions ({ to: "447123456789@c.us" , content: "Hello, world!" , hideTags: true , mentions: [ "447123456789@c.us" , "441234567890@c.us" ], }); const result = await client.messages. sendTextWithMentions ({ to: "447123456789@c.us" , content: "Hello, world!" , hideTags: true , mentions: [ "447123456789@c.us" , "441234567890@c.us" ], }); curl -X POST "http://localhost:8080/api/messages/sendTextWithMentions" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "content": "Hello, world!", "hideTags": true, "mentions": [ "447123456789@c.us", "441234567890@c.us" ] }' Prop Value Return type object { _serialized } | boolean
Sends a contact card (vCard)
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, vcard, contactName, contactNumberAliases messages.sendVCardDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendVCardsendVCardActive Alias POST/api/sendVCardsendVCardActive
Client Namespaced client HTTP API
const result = await client. sendVCard ({ to: "447123456789@c.us" , vcard: "vcard" , contactName: "contactName" , contactNumber: "contactNumber" , }); const result = await client.messages. sendVCard ({ to: "447123456789@c.us" , vcard: "vcard" , contactName: "contactName" , contactNumber: "contactNumber" , }); curl -X POST "http://localhost:8080/api/messages/sendVCard" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "vcard": "vcard", "contactName": "contactName", "contactNumber": "contactNumber" }' Prop Value Return type boolean
Sends a video as an animated GIF
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, file, filename, caption, quotedMsgIdAliases messages.sendVideoAsGifDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary POST/api/messages/sendVideoAsGifsendVideoAsGifActive Alias POST/api/sendVideoAsGifsendVideoAsGifActive
Client Namespaced client HTTP API
const result = await client. sendVideoAsGif ({ to: "447123456789@c.us" , file: "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21..." , filename: "document.pdf" , caption: "Check out this image!" , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); const result = await client.messages. sendVideoAsGif ({ to: "447123456789@c.us" , file: "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21..." , filename: "document.pdf" , caption: "Check out this image!" , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); curl -X POST "http://localhost:8080/api/messages/sendVideoAsGif" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "file": "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21...", "filename": "document.pdf", "caption": "Check out this image!", "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" }' Prop Value Return type object { _serialized } | boolean
Sends a YouTube link with auto-generated preview
Prop Value Namespace messagesAction sendFunctionality bothPositional parameter order to, url, text, thumbnail, quotedMsgId, customSizeAliases messages.sendYoutubeLink, messages.sendYouTubeLink, sendYoutubeLinkDeprecated aliases messages.sendYoutubeLink, sendYoutubeLinkLicense noneWAPI override sendYoutubeLinkDeprecated No
Type Method Path Name Status Primary POST/api/messages/sendYouTubeLinksendYouTubeLinkActive Deprecated alias POST/api/messages/sendYoutubeLinkmessages.sendYoutubeLinkDeprecated Deprecated alias POST/api/sendYoutubeLinksendYoutubeLinkDeprecated Alias POST/api/sendYouTubeLinksendYouTubeLinkActive
Client Namespaced client HTTP API
const result = await client. sendYouTubeLink ({ to: "447123456789@c.us" , url: "url" , text: "Hello, world!" , thumbnail: "thumbnail" , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , customSize: {}, }); const result = await client.messages. sendYouTubeLink ({ to: "447123456789@c.us" , url: "url" , text: "Hello, world!" , thumbnail: "thumbnail" , quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , customSize: {}, }); curl -X POST "http://localhost:8080/api/messages/sendYouTubeLink" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "to": "447123456789@c.us", "url": "url", "text": "Hello, world!", "thumbnail": "thumbnail", "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB", "customSize": {} }' Prop Value Return type object { _serialized } | boolean
Set ephemeral messages for chat
Prop Value Namespace chatsAction updateFunctionality bothPositional parameter order chatId, ephemeralAliases chats.setEphemeralDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/chats/setEphemeralsetChatEphemeralActive Alias PUT/api/setChatEphemeralsetChatEphemeralActive
Client Namespaced client HTTP API
const result = await client. setChatEphemeral ({ chatId: "447123456789@c.us" , ephemeral: 1 , }); const result = await client.chats. setEphemeral ({ chatId: "447123456789@c.us" , ephemeral: 1 , }); curl -X PUT "http://localhost:8080/api/chats/setEphemeral" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us", "ephemeral": 1 }' Prop Value Return type boolean
Set group description
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, descriptionAliases groups.setDescriptionDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/setDescriptionsetGroupDescriptionActive Alias PUT/api/setGroupDescriptionsetGroupDescriptionActive
Client Namespaced client HTTP API
const result = await client. setGroupDescription ({ groupId: "447123456789-1445627445@g.us" , description: "description" , }); const result = await client.groups. setDescription ({ groupId: "447123456789-1445627445@g.us" , description: "description" , }); curl -X PUT "http://localhost:8080/api/groups/setDescription" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "description": "description" }' Prop Value Return type boolean
Restrict group editing to admins only
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, onlyAdminsAliases groups.setEditAdminsOnly, groups.setEditToAdminsOnlyDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/setEditAdminsOnlysetGroupEditToAdminsOnlyActive Alias PUT/api/groups/setEditToAdminsOnlygroups.setEditToAdminsOnlyActive Alias PUT/api/setGroupEditToAdminsOnlysetGroupEditToAdminsOnlyActive
Client Namespaced client HTTP API
const result = await client. setGroupEditToAdminsOnly ({ groupId: "447123456789-1445627445@g.us" , onlyAdmins: true , }); const result = await client.groups. setEditAdminsOnly ({ groupId: "447123456789-1445627445@g.us" , onlyAdmins: true , }); curl -X PUT "http://localhost:8080/api/groups/setEditAdminsOnly" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "onlyAdmins": true }' Prop Value Return type boolean
Set group icon
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, imageAliases groups.setIconDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/setIconsetGroupIconActive Alias PUT/api/setGroupIconsetGroupIconActive
Client Namespaced client HTTP API
const result = await client. setGroupIcon ({ groupId: "447123456789-1445627445@g.us" , image: "image" , }); const result = await client.groups. setIcon ({ groupId: "447123456789-1445627445@g.us" , image: "image" , }); curl -X PUT "http://localhost:8080/api/groups/setIcon" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "image": "image" }' Prop Value Return type boolean
Set group title
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, titleAliases groups.setTitleDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/setTitlesetGroupTitleActive Alias PUT/api/setGroupTitlesetGroupTitleActive
Client Namespaced client HTTP API
const result = await client. setGroupTitle ({ groupId: "447123456789-1445627445@g.us" , title: "title" , }); const result = await client.groups. setTitle ({ groupId: "447123456789-1445627445@g.us" , title: "title" , }); curl -X PUT "http://localhost:8080/api/groups/setTitle" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "title": "title" }' Prop Value Return type boolean
Restrict group to admins only
Prop Value Namespace groupsAction updateFunctionality bothPositional parameter order groupId, onlyAdminsAliases groups.setAdminsOnly, groups.setToAdminsOnlyDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/groups/setAdminsOnlysetGroupToAdminsOnlyActive Alias PUT/api/groups/setToAdminsOnlygroups.setToAdminsOnlyActive Alias PUT/api/setGroupToAdminsOnlysetGroupToAdminsOnlyActive
Client Namespaced client HTTP API
const result = await client. setGroupToAdminsOnly ({ groupId: "447123456789-1445627445@g.us" , onlyAdmins: true , }); const result = await client.groups. setAdminsOnly ({ groupId: "447123456789-1445627445@g.us" , onlyAdmins: true , }); curl -X PUT "http://localhost:8080/api/groups/setAdminsOnly" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "groupId": "447123456789-1445627445@g.us", "onlyAdmins": true }' Prop Value Return type boolean
Set host name
Prop Value Namespace sessionAction updateFunctionality personal-onlyPositional parameter order nameAliases session.setDisplayName, session.setMyName, session.setName, setDisplayNameDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/session/setNamesetMyNameActive Alias PUT/api/session/setDisplayNamesession.setDisplayNameActive Alias PUT/api/session/setMyNamesession.setMyNameActive Alias PUT/api/setDisplayNamesetDisplayNameActive Alias PUT/api/setMyNamesetMyNameActive
Client Namespaced client HTTP API
const result = await client. setMyName ({ name: "OpenWA Bot" , }); const result = await client.session. setName ({ name: "OpenWA Bot" , }); curl -X PUT "http://localhost:8080/api/session/setName" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "name": "OpenWA Bot" }' Prop Value Return type boolean
Set host status
Prop Value Namespace sessionAction updateFunctionality bothPositional parameter order statusTextAliases session.setMyStatus, session.setStatus, session.setStatusText, setStatusTextDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/session/setStatussetMyStatusActive Alias PUT/api/session/setMyStatussession.setMyStatusActive Alias PUT/api/session/setStatusTextsession.setStatusTextActive Alias PUT/api/setMyStatussetMyStatusActive Alias PUT/api/setStatusTextsetStatusTextActive
Client Namespaced client HTTP API
const result = await client. setMyStatus ({ statusText: "Available" , }); const result = await client.session. setStatus ({ statusText: "Available" , }); curl -X PUT "http://localhost:8080/api/session/setStatus" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "statusText": "Available" }' Prop Value Return type boolean
Set profile picture
🧵 Insiders Licensed feature
Insiders feature
May require an insiders license for advanced or early-access capabilities.
Prop Value Namespace sessionAction updateFunctionality bothPositional parameter order imageAliases session.setProfilePic, session.setProfilePicture, setProfilePicDeprecated aliases session.setProfilePic, setProfilePicLicense insidersWAPI override setProfilePicDeprecated No
Type Method Path Name Status Primary PUT/api/session/setProfilePicturesetProfilePictureActive Deprecated alias PUT/api/session/setProfilePicsession.setProfilePicDeprecated Deprecated alias PUT/api/setProfilePicsetProfilePicDeprecated Alias PUT/api/setProfilePicturesetProfilePictureActive
Client Namespaced client HTTP API
const result = await client. setProfilePicture ({ image: "data:image/png;base64,iVBORw0KGgo..." , }); const result = await client.session. setProfilePicture ({ image: "data:image/png;base64,iVBORw0KGgo..." , }); curl -X PUT "http://localhost:8080/api/session/setProfilePicture" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "image": "data:image/png;base64,iVBORw0KGgo..." }' Prop Value Return type boolean
Star a message
Prop Value Namespace messagesAction updateFunctionality bothPositional parameter order messageIdAliases messages.starDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/messages/starstarMessageActive Alias PUT/api/starMessagestarMessageActive
Client Namespaced client HTTP API
const result = await client. starMessage ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); const result = await client.messages. star ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); curl -X PUT "http://localhost:8080/api/messages/star" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "messageId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" }' Prop Value Return type boolean
Unarchive a chat
Prop Value Namespace chatsAction updateFunctionality bothPositional parameter order chatIdAliases chats.unarchiveDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/chats/unarchiveunarchiveChatActive Alias PUT/api/unarchiveChatunarchiveChatActive
Client Namespaced client HTTP API
const result = await client. unarchiveChat ({ chatId: "447123456789@c.us" , }); const result = await client.chats. unarchive ({ chatId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/chats/unarchive" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Unblock a contact
Prop Value Namespace contactsAction updateFunctionality bothPositional parameter order contactIdAliases contacts.contactUnblock, contacts.unblock, contactUnblockDeprecated aliases contacts.contactUnblock, contactUnblockLicense noneWAPI override contactUnblockDeprecated No
Type Method Path Name Status Primary PUT/api/contacts/unblockunblockContactActive Deprecated alias PUT/api/contacts/contactUnblockcontacts.contactUnblockDeprecated Deprecated alias PUT/api/contactUnblockcontactUnblockDeprecated Alias PUT/api/unblockContactunblockContactActive
Client Namespaced client HTTP API
const result = await client. unblockContact ({ contactId: "447123456789@c.us" , }); const result = await client.contacts. unblock ({ contactId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/contacts/unblock" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "contactId": "447123456789@c.us" }' Prop Value Return type boolean
Unmute a chat
Prop Value Namespace chatsAction updateFunctionality bothPositional parameter order chatIdAliases chats.unmuteDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/chats/unmuteunmuteChatActive Alias PUT/api/unmuteChatunmuteChatActive
Client Namespaced client HTTP API
const result = await client. unmuteChat ({ chatId: "447123456789@c.us" , }); const result = await client.chats. unmute ({ chatId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/chats/unmute" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us" }' Prop Value Return type string | boolean | number
Unpin a chat
Prop Value Namespace chatsAction updateFunctionality bothPositional parameter order chatIdAliases chats.unpinDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/chats/unpinunpinChatActive Alias PUT/api/unpinChatunpinChatActive
Client Namespaced client HTTP API
const result = await client. unpinChat ({ chatId: "447123456789@c.us" , }); const result = await client.chats. unpin ({ chatId: "447123456789@c.us" , }); curl -X PUT "http://localhost:8080/api/chats/unpin" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "chatId": "447123456789@c.us" }' Prop Value Return type boolean
Unstar a message
Prop Value Namespace messagesAction updateFunctionality bothPositional parameter order messageIdAliases messages.unstarDeprecated aliases - License noneWAPI override - Deprecated No
Type Method Path Name Status Primary PUT/api/messages/unstarunstarMessageActive Alias PUT/api/unstarMessageunstarMessageActive
Client Namespaced client HTTP API
const result = await client. unstarMessage ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); const result = await client.messages. unstar ({ messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" , }); curl -X PUT "http://localhost:8080/api/messages/unstar" \ -H "content-type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ --data '{ "messageId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB" }' Prop Value Return type boolean
Was this helpful? Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!
