Ir para o conteúdo

Lista completa de métodos da biblioteca#

Método Descrição Documentação
account.getSettings Este método é usado para obter as configurações atuais da conta GetSettings
account.getStateInstance Este método é usado para obter o estado da conta GetStateInstance
account.getStatusInstance Este método é usado para obter o status da conexão do socket da instância da conta com o WhatsApp GetStatusInstance
account.logout Este método é usado para fazer logout da conta Logout
account.qr Este método é usado para obter o código QR QR
account.reboot Este método é usado para reiniciar a conta Reboot
account.setProfilePicture Este método é usado para definir a imagem de perfil da conta SetProfilePicture
account.setSettings Este método é usado para configurar as configurações da conta SetSettings
groups.addGroupParticipant Este método adiciona um participante a um chat em grupo AddGroupParticipant
groups.createGroup Este método cria um chat em grupo. IMPORTANTE: Se você tentar criar um grupo com um número inexistente, o WhatsApp pode bloquear o número do remetente. CreateGroup
groups.getGroupData Este método obtém os dados de um chat em grupo GetGroupData
groups.leaveGroup Este método faz com que o usuário saia do chat em grupo atual LeaveGroup
groups.removeAdmin Este método remove as permissões de administrador de um participante em um chat em grupo RemoveAdmin
groups.removeGroupParticipant Este método remove um participante de um chat em grupo RemoveGroupParticipant
groups.setGroupAdmin Este método atribui a um participante a função de administrador em um chat em grupo SetGroupAdmin
groups.setGroupPicture Este método define a imagem de perfil de um chat em grupo SetGroupPicture
groups.updateGroupName Este método atualiza o nome de um chat em grupo UpdateGroupName
journals.getChatHistory Este método retorna o histórico de mensagens de um chat GetChatHistory
journals.lastIncomingMessages Este método retorna as últimas mensagens de entrada da conta. Por padrão, são retornadas as mensagens das últimas 24 horas lastIncomingMessages
journals.lastOutgoingMessages Este método retorna as últimas mensagens enviadas da conta. Por padrão, são retornadas as mensagens das últimas 24 horas LastOutgoingMessages
marking.readChat Este método marca as mensagens de um chat como lidas. Todas as mensagens em um chat ou apenas uma mensagem específica podem ser marcadas como lidas ReadChat
device.getDeviceInfo Este método obtém informações sobre o dispositivo (telefone) em que o aplicativo WhatsApp Business está sendo executado GetDeviceInfo
queues.clearMessagesQueue Este método limpa a fila de mensagens a serem enviadas ClearMessagesQueue
queues.showMessagesQueue Este método obtém a lista de mensagens na fila de envio ShowMessagesQueue
receiving.deleteNotification Este método é usado para excluir uma notificação de entrada da fila de notificações DeleteNotification
receiving.receiveNotification Este método é usado para receber uma notificação de entrada da fila de notificações ReceiveNotification
sending.sendButtons Este método é usado para enviar uma mensagem com botões para um chat privado ou em grupo SendButtons
sending.sendContact Este método é usado para enviar uma mensagem com um contato SendContact
sending.sendFileByUpload Este método é usado para enviar um arquivo carregado por meio de um formulário SendFileByUpload
sending.sendFileByUrl Este método é usado para enviar um arquivo carregado a partir de uma URL SendFileByUrl
sending.sendLink Este método é usado para enviar uma mensagem com um link, para o qual serão adicionados uma visualização de imagem, um título e uma descrição SendLink
sending.sendListMessage Este método é usado para enviar uma mensagem com um botão de seleção de uma lista de valores para um chat privado ou em grupo SendListMessage
sending.sendLocation Este método é usado para enviar uma mensagem de localização SendLocation
sending.sendMessage Este método é usado para enviar uma mensagem de texto para um chat privado ou em grupo SendMessage
sending.sendTemplateButtons Este método é usado para enviar uma mensagem com botões interativos de uma lista de modelos para um chat privado ou em grupo SendTemplateButtons
serviceMethods.checkWhatsapp Este método verifica se existe uma conta WhatsApp em um número de telefone CheckWhatsapp
serviceMethods.getAvatar Este método obtém o avatar de um correspondente ou de um chat em grupo GetAvatar
serviceMethods.getContactInfo Este método é usado para obter informações sobre um contato GetContactInfo
serviceMethods.getContacts Este método é usado para obter a lista de contatos da conta atual GetContacts
serviceMethods.setDisappearingChat Este método é usado para alterar as configurações de mensagens que desaparecem em chats. As configurações padrão do aplicativo devem ser usadas: 0 (desativado), 86400 (24 horas), 604800 (7 dias), 7776000 (90 dias) SetDisappearingChat
serviceMethods.archiveChat Este método arquiva um chat. Chats com pelo menos uma mensagem de entrada podem ser arquivados ArchiveChat
serviceMethods.deleteMessage Este método exclui uma mensagem de um chat DeleteMessage
serviceMethods.unarchiveChat Este método desarquiva um chat UnarchiveChat
serviceMethods.setDisappearingChat Este método é usado para alterar as configurações de mensagens que desaparecem em chats SetDisappearingChat
webhooks.startReceivingNotifications Este método é usado para iniciar a recepção de webhooks
webhooks.stopReceivingNotifications Este método é usado para interromper a recepção de webhooks