Skip to content

Full list of all methods#

API Method Description Documentation link
Account().GetSettings The method is used to get the current settings of the instance GetSettings
Account().SetSettings The method is used to set an inatsnce settings SetSettings
Account().GetStateInstance The method is used to get the instance state GetStateInstance
Account().GetStatusInstance The method is used to get the status of the account instance socket connection with WhatsApp GetStatusInstance
Account().Reboot The method is used to reboot an instance Reboot
Account().Logout The method is used to log out an instance Logout
Account().QR The method is used to get QR code QR
Account().SetProfilePicture The method is used to set an account picture SetProfilePicture
Device().GetDeviceInfo The method is used to get information about the device (phone) running WhatsApp Business application GetDeviceInfo
Groups().CreateGroup The method is used to create a group chat CreateGroup
Groups().UpdateGroupName The method is used to change a group chat name UpdateGroupName
Groups().GetGroupData The method is used to get a group chat data GetGroupData
Groups().AddGroupParticipant The method is used to add a participant into a group AddGroupParticipant
Groups().RemoveGroupParticipant The method is used to delete a participant from a group chat RemoveGroupParticipant
Groups().SetGroupAdmin The method is used to set a participant as a group administrator SetGroupAdmin
Groups().RemoveAdmin The method is used to remove administrator rights from a participant RemoveAdmin
Groups().SetGroupPicture The method is used to set a group picture SetGroupPicture
Groups().LeaveGroup The method is used to leave a group chat LeaveGroup
Journals().GetChatHistory The method is used to get a chat history GetChatHistory
Journals().GetMessage The method is used to get a message GetMessage
Journals().LastIncomingMessages The method is used to get last incoming messages LastIncomingMessages
Journals().LastOutgoingMessages The method is used to get last outgoing messages LastOutgoingMessages
Queues().ShowMessagesQueue The method is used to get messages that are in the outgoing messages queue ShowMessagesQueue
Queues().ClearMessagesQueue The method is used to clear messages from the outgoing message queue ClearMessagesQueue
ReadMark().ReadChat The method is used to mark a chat as read ReadChat
Receiving().ReceiveNotification The method is used to receive a notification from the incoming notification queue ReceiveNotification
Receiving().DeleteNotification The method is used to delete a notification from the incoming notification queue DeleteNotification
Receiving().DownloadFile The method is used to download file from outgoing or incoming message DownloadFile
Sending().SendMessage The method is used to send a text message to a personal or group chat SendMessage
Sending().SendButtons The method is used to send buttons to a personal or group chat SendButtons
Sending().SendTemplateButtons The method is used to send a message with interactive buttons from the list of templates in a personal or group chat SendTemplateButtons
Sending().SendListMessage The method is used to send a message with a selection button from a list of values to a personal or group chat SendListMessage
Sending().SendFileByUpload The method is used to send a file through a form (form-data) SendFileByUpload
Sending().SendFileByUrl The method is used to send a file by URL SendFileByUrl
Sending().SendLocation The method is used to send a location SendLocation
Sending().SendContact The method is used to send a contact SendContact
Sending().SendLink The method is used to send a message with a link that will add an image preview, title and description (Not used) SendLink
Sending().ForwardMessages The method is used to forward messages to a personal or group chat ForwardMessages
Service().CheckWhatsapp The method is used to check if there is a WhatsApp account on the phone number CheckWhatsapp
Service().GetAvatar The method is used to get the avatar of the personal or group chat GetAvatar
Service().GetContacts The method is used to get contacts of current account GetContacts
Service().GetContactInfo The method is used to get information of the contact GetContactInfo
Service().EditMessage The method is used to edit the text message in a chat EditMessage
Service().DeleteMessage The method is used to delete a messages from a chat DeleteMessage
Service().ArchiveChat The method is used to archive a chat ArchiveChat
Service().UnarchiveChat The method is used to unarchive a chat UnarchiveChat
Service().SetDisappearingChat The method is used to change the settings of disappearing messages in chats SetDisappearingChat