account.getSettings | The method is used to get the current settings of the account | GetSettings |
account.getWaSettings | The method is used to get information about the WhatsApp account | GetWaSettings |
account.setSettings | The method is used to set the account settings | SetSettings |
account.getStateInstance | The method is used to get the state of the account | GetStateInstance |
account.getStatusInstance | The method is used to get the socket connection state of the account instance with WhatsApp | GetStatusInstance |
account.reboot | The method is used to restart the account | Reboot |
account.logout | The method is used to log out from the account | Logout |
account.qr | The method is used to get a QR code | QR |
account.setProfilePicture | The method is used to set the avatar of the account | SetProfilePicture |
account.getAuthorizationCode | The method is used to authorize an instance by phone number | GetAuthorizationCode |
device.getDeviceInfo | The method is used to get information about the device (phone) on which the WhatsApp Business application is running | GetDeviceInfo |
groups.createGroup | The method is used to create a group chat | CreateGroup |
groups.updateGroupName | The method is used to change the name of the group chat | UpdateGroupName |
groups.getGroupData | The method is used to get group chat data | GetGroupData |
groups.addGroupParticipant | The method is used to add a participant to the group chat | AddGroupParticipant |
groups.removeGroupParticipant | The method is used to remove the participant from the group chat | RemoveGroupParticipant |
groups.setGroupAdmin | The method is used to set a member of a group chat as an administrator | SetGroupAdmin |
groups.removeAdmin | The method is used to remove the participant of group chat administration rights | RemoveAdmin |
groups.setGroupPicture | The methodis used to set the avatar of the group | SetGroupPicture |
groups.leaveGroup | The method is used to log the user of the current account out of the group chat | LeaveGroup |
journals.getChatHistory | The method is used to get the chat message history | GetChatHistory |
journals.getMessage | The method is used to get a chat message | GetMessage |
journals.lastIncomingMessages | The method is used to get the most recent incoming messages of the account | LastIncomingMessages |
journals.lastOutgoingMessages | The method is used to get the last sent messages of the account | LastOutgoingMessages |
queues.showMessagesQueue | The method is used to get the list of messages that are in the queue to be sent | ShowMessagesQueue |
queues.clearMessagesQueue | The method is used to clear the queue of messages to be sent | ClearMessagesQueue |
marking.readChat | The method is used to mark chat messages as read | ReadChat |
receiving.receiveNotification | The method is used to receive a single incoming notification from the notification queue | ReceiveNotification |
receiving.deleteNotification | The method is used to remove an incoming notification from the notification queue | DeleteNotification |
receiving.downloadFile | The method is used to download files | 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 a message with 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 loaded through a form (form-data) | SendFileByUpload |
sending.sendFileByUrl | The method is used to send a file downloaded via a link | SendFileByUrl |
sending.uploadFile | The method is used to upload a file to the cloud storage, which can be sent using the sendFileByUrl method | UploadFile |
sending.sendLocation | The method is used to send a geolocation message | SendLocation |
sending.sendContact | The method is used to send a message with 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 | SendLink |
sending.forwardMessages | The method is used to forward messages to a personal or group chat | ForwardMessages |
sending.sendPoll | The method is used to send messages with a poll to a private or group chat | SendPoll |
serviceMethods.checkWhatsapp | The method is used to check if there is a WhatsApp account on the phone number | CheckWhatsapp |
serviceMethods.getAvatar | The method is used to get the avatar of the correspondent or group chat | GetAvatar |
serviceMethods.getContacts | The method is used to get a list of contacts of the current account | GetContacts |
serviceMethods.getContactInfo | The method is used to get information about the contact | GetContactInfo |
serviceMethods.editMessage | The method is used to edit the text message in a chat | EditMessage |
serviceMethods.deleteMessage | The method is used to delete the message from chat | DeleteMessage |
serviceMethods.archiveChat | The method is used to archive the chat | ArchiveChat |
serviceMethods.unarchiveChat | The method is used to unarchive the chat | UnarchiveChat |
serviceMethods.setDisappearingChat | The method is used to change the settings of disappearing messages in chats | SetDisappearingChat |
webhooks.startReceivingNotifications | The method is used to start receiving new notifications | |
webhooks.stopReceivingNotifications | The method is used to stop receiving new notifications | |
statuses.sendTextStatus | The method is used to send a text status | SendTextStatus |
statuses.sendVoiceStatus | The method is used to send a voice status | SendVoiceStatus |
statuses.sendMediaStatus | The method is used to send a pictures or video status | SendMediaStatus |
statuses.getIncomingStatuses | The is used to get the incoming status messages of the instance | GetIncomingStatuses |
statuses.getOutgoingStatuses | The method is used to get the outgoing statuses of the account | GetOutgoingStatuses |
statuses.getStatusStatistic | The method is used to get an array of recipients marked sent/delivered/read for a given status | GetStatusStatistic |
statuses.deleteStatus | The method is used to delete status | DeleteStatus |