Перейти к содержанию

Полный список методов библиотеки#

Метод API Описание Documentation link
account.getSettings() Метод предназначен для получения текущих настроек аккаунта GetSettings
account.setSettings() Метод предназначен для установки настроек аккаунта SetSettings
account.getStateInstance() Метод предназначен для получения состояния аккаунта GetStateInstance
account.getStatusInstance() Метод предназначен для получения состояния сокета соединения инстанса аккаунта с WhatsApp GetStatusInstance
account.reboot() Метод предназначен для перезапуска аккаунта Reboot
account.logout() Метод предназначен для разлогинивания аккаунта Logout
account.qr() Метод предназначен для получения QR-кода QR
account.getAuthorizationCode() Метод предназначен для авторизации экземпляра по номеру телефона. Метод используется как альтернатива методу QR. GetAuthorizationCode
account.setProfilePicture() Метод предназначен для установки аватара аккаунта SetProfilePicture
device.getDeviceInfo() Метод предназначен для получения информации об устройстве (телефоне), на котором запущено приложение WhatsApp Business GetDeviceInfo
groups.createGroup() Метод предназначен для создания группового чата CreateGroup
groups.updateGroupName() Метод изменяет наименование группового чата UpdateGroupName
groups.getGroupData() Метод получает данные группового чата GetGroupData
groups.addGroupParticipant() Метод добавляет участника в групповой чат AddGroupParticipant
groups.removeGroupParticipant() Метод удаляет участника из группового чата RemoveGroupParticipant
groups.setGroupAdmin() Метод назначает участника группового чата администратором SetGroupAdmin
groups.removeAdmin() Метод лишает участника прав администрирования группового чата RemoveAdmin
groups.setGroupPicture() Метод устанавливает аватар группы SetGroupPicture
groups.leaveGroup() Метод производит выход пользователя текущего аккаунта из группового чата LeaveGroup
journals.getChatHistory() Метод возвращает историю сообщений чата GetChatHistory
journals.getMessage() Метод возвращает сообщение чата GetMessage
journals.lastIncomingMessages() Метод возвращает крайние входящие сообщения аккаунта LastIncomingMessages
journals.lastOutgoingMessages() Метод возвращает крайние отправленные сообщения аккаунта LastOutgoingMessages
queues.showMessagesQueue() Метод предназначен для получения списка сообщений, находящихся в очереди на отправку ShowMessagesQueue
queues.clearMessagesQueue() Метод предназначен для очистки очереди сообщений на отправку ClearMessagesQueue
readMark.readChat() Метод предназначен для отметки сообщений в чате прочитанными ReadChat
receiving.receiveNotification() Метод предназначен для получения одного входящего уведомления из очереди уведомлений ReceiveNotification
receiving.deleteNotification() Метод предназначен для удаления входящего уведомления из очереди уведомлений DeleteNotification
receiving.downloadFile() Метод предназначен для скачивания принятых и отправленных файлов DownloadFile
sending.sendMessage() Метод предназначен для отправки текстового сообщения в личный или групповой чат SendMessage
sending.sendButtons() Метод предназначен для отправки сообщения с кнопками в личный или групповой чат SendButtons
sending.sendTemplateButtons() Метод предназначен для отправки сообщения с интерактивными кнопками из перечня шаблонов в личный или групповой чат SendTemplateButtons
sending.sendPoll() Метод предназначен для отправки опроса в личный или групповой чат SendPoll
sending.sendListMessage() Метод предназначен для отправки сообщения с кнопкой выбора из списка значений в личный или групповой чат SendListMessage
sending.sendFileByUpload() Метод предназначен для отправки файла, загружаемого через форму (form-data) SendFileByUpload
sending.sendFileByUrl() Метод предназначен для отправки файла, загружаемого по ссылке SendFileByUrl
sending.uploadFile() Метод предназначен для загрузки файла в облачное хранилище, который можно отправить методом SendFileByUrl UploadFile
sending.sendLocation() Метод предназначен для отправки сообщения геолокации SendLocation
sending.sendContact() Метод предназначен для отправки сообщения с контактом SendContact
sending.sendLink() Метод предназначен для отправки сообщения со ссылкой, по которой будут добавлены превью изображения, заголовок и описание SendLink
sending.forwardMessages() Метод предназначен для пересылки сообщений в личный или групповой чат ForwardMessages
service.checkWhatsapp() Метод проверяет наличие аккаунта WhatsApp на номере телефона CheckWhatsapp
service.getAvatar() Метод возвращает аватар корреспондента или группового чата GetAvatar
service.getContacts() Метод предназначен для получения списка контактов текущего аккаунта GetContacts
service.getContactInfo() Метод предназначен для получения информации о контакте GetContactInfo
service.deleteMessage() Метод удаляет сообщение из чата DeleteMessage
service.archiveChat() Метод архивирует чат ArchiveChat
service.unarchiveChat() Метод разархивирует чат UnarchiveChat
service.setDisappearingChat() Метод предназначен для изменения настроек исчезающих сообщений в чатах SetDisappearingChat
webhook.start() Метод предназначен для старта получения новых уведомлений
webhook.stop() Метод предназначен для остановки получения новых уведомлений