Neste tutorial, vamos aprender como usar Ultramsg Nodejs-WhatsApp-sdk para usar WhatsAppAPI com Nodejs<\/p>\n\n
npm i ultramsg-whatsapp-api<\/code><\/code><\/pre>\n\nExemplo de uso<\/h2>\n\nconst ultramsg = require('ultramsg-whatsapp-api');\nconst instance_id= \"instance1150\" \/\/ Ultramsg.com instance id\nconst ultramsg_token= \"tof7lsdJasdloaa57e\" \/\/ Ultramsg.com token\nconst api = new ultramsg(instance_id,ultramsg_token);\n(async function () {\n var to = \"put_your_mobile_number_here\"\n var body = \"Hello world\" \n const response = await api.sendChatMessage(to,body);\n console.log(response)\n})(); <\/code><\/pre>\n\nNOTA:<\/strong> voc\u00ea precisa substituir instance_id e token pelo seu na conta ultramsg.com, se voc\u00ea n\u00e3o tiver uma conta, crie uma aqui<\/a> .<\/p><\/blockquote>\n\nEnviar mensagem<\/h2>\n\nvar to=\"put_your_mobile_number_here\"; \nvar body=\"Hello world\";\nvar priority=10;\nvar referenceId=\"SDK\";\nconst response = await api.sendChatMessage(to,body,priority,referenceId);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\n- para<\/b> : seu n\u00famero para teste com formato internacional, por exemplo, +14155552671 ou chatID para contato ou grupo, por exemplo, 14155552671@c.us ou 14155552671-441234567890@g.us<\/li>
- body<\/strong> : Texto da mensagem, string UTF-8 ou UTF-16 com emoji.<\/li>
- prioridade:<\/strong> Este par\u00e2metro \u00e9 opcional,<\/li><\/ul>\n\n
Voc\u00ea pode us\u00e1-lo para criar uma fila profissional para mensagens<\/a> , As mensagens com menor valor de prioridade s\u00e3o enviadas primeiro.<\/p>\n\nexemplo de uso:<\/p>\n\n
prioridade = 0: para alta prioridade como mensagens OTP.<\/p>\n\n
prioridade = 5: usado com mensagens gerais.<\/p>\n\n
prioridade =10: ofertas promocionais n\u00e3o urgentes e notifica\u00e7\u00f5es para seus clientes.<\/p>\n\n
Valor padr\u00e3o:<\/strong> 10<\/p>\n\n- referenceId<\/strong> : seu ID de refer\u00eancia<\/a> personalizado para esta mensagem.<\/li><\/ul>\n\n
Enviar imagem<\/h2>\n\nvar to=\"put_your_mobile_number_here\"; \nvar caption=\"image Caption\"; \nvar image=\"https:\/\/file-example.s3-accelerate.amazonaws.com\/images\/test.jpg\"; \nvar priority=10;\nvar referenceId=\"SDK\"\nvar nocache=false; \nconst response = await api.sendImageMessage(to,caption,image,priority,referenceId,nocache);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\n- legenda<\/strong> : imagem Legenda, string UTF-8 ou UTF-16 com emoji.<\/li>
- image<\/strong> : imagem de link HTTP ou arquivo codificado em base64<\/li><\/ul>\n\n
Extens\u00f5es suportadas ( jpg , jpeg, gif , png , svg , webp , bmp) .<\/p>\n\n
Tamanho m\u00e1ximo do arquivo: 16 MB.<\/p>\n\n
Comprimento m\u00e1ximo da Base64<\/a> : 2.000.000<\/p>\n\n- nocache<\/strong> : padr\u00e3o falso<\/li><\/ul>\n\n
false: use um arquivo carregado anteriormente em vez de carreg\u00e1-lo com cada solicita\u00e7\u00e3o<\/p>\n\n
true: fazendo upload de cada solicita\u00e7\u00e3o<\/p>\n\n
Enviar documento<\/h2>\n\nvar to=\"put_your_mobile_number_here\"; \nvar filename=\"cv.pdf\"; \nvar document=\"https:\/\/file-example.s3-accelerate.amazonaws.com\/documents\/cv.pdf\"; \nconst response = await api.sendDocumentMessage(to,filename,document);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\n- nome do arquivo:<\/strong> nome do arquivo, por exemplo 1.jpg ou Hello.pdf<\/li>
- documento:<\/strong> arquivo de link HTTP ou arquivo codificado em base64<\/li><\/ul>\n\n
A maioria das extens\u00f5es suportadas como (zip, xlsx, csv, txt, pptx, docx ….etc).<\/p>\n\n
Tamanho m\u00e1ximo do arquivo: 100 MB.<\/p>\n\n
Comprimento m\u00e1ximo da Base64: 2.000.000<\/p>\n\n
Enviar \u00e1udio<\/h2>\n\nvar to=\"put_your_mobile_number_here\"; \nvar audio=\"https:\/\/file-example.s3-accelerate.amazonaws.com\/audio\/2.mp3\"; \nconst response = await api.sendAudioMessage(to,audio);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\n- audio<\/strong> : \u00e1udio de link HTTP ou \u00e1udio codificado em base64<\/li><\/ul>\n\n
Extens\u00f5es suportadas (mp3, aac, ogg).<\/p>\n\n
Tamanho m\u00e1ximo do arquivo: 16 MB.<\/p>\n\n
Comprimento m\u00e1ximo da Base64: 2.000.000<\/p>\n\n
Enviar voz<\/h2>\n\nvar to=\"put_your_mobile_number_here\"; \nvar audio=\"https:\/\/file-example.s3-accelerate.amazonaws.com\/voice\/oog_example.ogg\"; \nconst response = await api.sendVoiceMessage(to,audio);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\n- audio<\/strong> : arquivo ogg de \u00e1udio de link HTTP com codec opus ou arquivo ogg base64 no codec opus<\/li><\/ul>\n\n
Tamanho m\u00e1ximo do arquivo: 16 MB.<\/p>\n\n
Comprimento m\u00e1ximo da Base64: 2.000.000<\/p>\n\n
Enviar v\u00eddeo<\/h2>\n\nvar to=\"put_your_mobile_number_here\"; \nvar caption=\"video Caption\"; \nvar video=\"https:\/\/file-example.s3-accelerate.amazonaws.com\/video\/test.mp4\"; \nconst response = await api.sendVideoMessage(to,caption,video);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\n- video<\/strong> : v\u00eddeo de link HTTP ou v\u00eddeo codificado em base64<\/li><\/ul>\n\n
Extens\u00f5es suportadas (mp4, 3gp, mov).<\/p>\n\n
Tamanho m\u00e1ximo do arquivo: 16 MB.<\/p>\n\n
Comprimento m\u00e1ximo da Base64: 2.000.000<\/p>\n\n
<\/a><\/h2>\n\nEnviar Link<\/h2>\n\nvar to=\"put_your_mobile_number_here\"; \nvar link=\"https:\/\/ultramsg.com\"; \nconst response = await api.sendLinkMessage(to,link);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nlink: link<\/strong> HTTP ou HTTPS<\/p>\n\nEnviar contato<\/h2>\n\nvar to=\"put_your_mobile_number_here\"; \nvar contact=\"14000000001@c.us\"; \nconst response = await api.sendContactMessage(to,contact);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\n- contact:<\/strong> exemplo de matriz de ID de contato ou IDs de contato:<\/li><\/ul>\n\n
Exemplo<\/p>\n\n
14000000001@c.us<\/p>\n\n
ou<\/p>\n\n
14000000001@c.us,14000000002@c.us,14000000003@c.us<\/p>\n\n
Comprimento m\u00e1ximo: 300 caracteres, quase 15 contatos<\/p>\n\n
Enviar localiza\u00e7\u00e3o<\/h2>\n\nvar to=\"put_your_mobile_number_here\"; \nvar address=\"ABC company \\n Sixth floor , office 38\"; \nvar lat=\"25.197197\"; \nvar lng=\"55.2721877\"; \nconst response = await api.sendLocationMessage(to,address,lat,lng);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\n- address<\/strong> : Texto sob o local.<\/li><\/ul>\n\n
Suporta duas linhas. Para usar duas linhas, use o s\u00edmbolo \\n.<\/p>\n\n
Comprimento m\u00e1ximo: 300 caracteres.<\/p>\n\n
- lat<\/strong> : latitude<\/li>
- lng<\/strong> : longitude<\/li><\/ul>\n\n
Enviar Vcard<\/h2>\n\nvar to=\"put_your_mobile_number_here\"; \nvar vcard=`BEGIN:VCARD\nVERSION:3.0\nN:lastname;firstname\nFN:firstname lastname\nTEL;TYPE=CELL;waid=14000000001:14000000002\nNICKNAME:nickname\nBDAY:01.01.1987\nX-GENDER:M\nNOTE:note\nADR;TYPE=home\nADR;TYPE=work\nEND:VCARD`; \nconst response = await api.sendVcardMessage(to,vcard);\nconsole.log(response)<\/code><\/code><\/pre>\n\n- vcard<\/strong> : valor de texto vcard 3.0<\/li><\/ul>\n\n
Comprimento m\u00e1ximo: 4096 caracteres<\/p>\n\n
Obter mensagens<\/h2>\n\nvar page=1;\nvar limit=100;\nvar status=\"all\";\nvar sort=\"asc\";\nvar id=\"\";\nvar referenceId=\"\";\nvar from=\"\";\nvar to=\"\";\nvar ack=\"\";\nconst response = await api.getMessages(page,limit,status,sort,id,referenceId,from,to,ack);\nconsole.log(response)<\/code><\/code><\/pre>\n\n- page<\/strong> : n\u00famero da p\u00e1gina de pagina\u00e7\u00e3o<\/li>
- limite<\/strong> : n\u00famero de mensagens por solicita\u00e7\u00e3o. valor m\u00e1ximo : 100 .<\/li>
- status<\/strong> : Status das mensagens [enviadas, fila, n\u00e3o enviadas]
- enviado: recebe as mensagens enviadas.<\/li>
- queue: obt\u00e9m mensagens de fila.<\/li>
- n\u00e3o enviados: recebe mensagens n\u00e3o enviadas.<\/li>
- invalid : obt\u00e9m mensagens inv\u00e1lidas .<\/li>
- all: obt\u00e9m todas as mensagens.<\/li><\/ul><\/li>
- classificar<\/strong> :
- asc: mensagens classificadas por ID do menor para o maior.<\/li>
- desc: mensagens classificadas por ID do maior para o menor.<\/li><\/ul><\/li>
- id<\/strong> : filtrar mensagens por ID de mensagem.<\/li>
- referenceId<\/strong> : filtre as mensagens pelo seu ID de refer\u00eancia personalizado.<\/li>
- de<\/strong> : filtrar mensagens pelo n\u00famero do remetente do WhatsApp, por exemplo, 14155552671@c.us.<\/li>
- para<\/strong> : filtrar mensagens por n\u00famero de destinat\u00e1rio, por exemplo, 14155552671@c.us ou 14155552671-441234567890@g.us.<\/li>
- ack<\/strong> : filtra mensagens por status de ack de mensagem [ pendente , servidor , dispositivo , lido , reproduzido ] .<\/li><\/ul>\n\n
Obter estat\u00edsticas de mensagens<\/h2>\n\nconst response = await api.getMessageStatistics();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObter status da inst\u00e2ncia<\/h2>\n\nconst response = await api.getInstanceStatus();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObter imagem QR da inst\u00e2ncia<\/h2>\n\nconst response = await api.getInstanceQr();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObter c\u00f3digo QR da inst\u00e2ncia<\/h2>\n\nconst response = await api.getInstanceQrCode();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObter informa\u00e7\u00f5es da inst\u00e2ncia<\/h2>\n\n
Obtenha informa\u00e7\u00f5es do telefone conectado: n\u00famero, nome, imagem etc.<\/p>\n\n
const response = await api.getInstanceMe();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObter configura\u00e7\u00f5es da inst\u00e2ncia<\/h2>\n\nconst response = await api.getInstanceSettings();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nsendDelay : Atraso em segundos entre o envio da mensagem, padr\u00e3o 1 segundo<\/p>\n\n
webhook_url: URL Http ou https para receber notifica\u00e7\u00f5es.<\/p>\n\n
webhook_message_ack : notifica\u00e7\u00f5es on\/off ack (mensagem entregue e mensagem visualizada) em webhooks.<\/p>\n\n
webhook_message_received: ativa\/desativa notifica\u00e7\u00f5es em webhooks quando a mensagem \u00e9 recebida.<\/p>\n\n
webhook_message_create : notifica\u00e7\u00f5es de ativa\u00e7\u00e3o\/desativa\u00e7\u00e3o em webhooks quando a mensagem \u00e9 criada .<\/p>\n\n
webhook_message_download_media : liga\/desliga para obter documentos\/arquivos de m\u00eddia recebidos.<\/p>\n\n
Logout da inst\u00e2ncia<\/h2>\n\n
Saia do WhatsApp Web para obter um novo c\u00f3digo QR.<\/p>\n\n
const response = await api.sendInstanceLogout();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nRein\u00edcio da inst\u00e2ncia<\/h2>\n\n
Reinicie sua inst\u00e2ncia.<\/p>\n\n
const response = await api.sendInstanceRestart();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nAtualiza\u00e7\u00e3o das configura\u00e7\u00f5es da inst\u00e2ncia<\/h2>\n\nvar sendDelay=1;\nvar webhook_url=\"\";\nvar webhook_message_received=false;\nvar webhook_message_create=false;\nvar webhook_message_ack=false;\nvar webhook_message_download_media=false;\n\nconst response = await api.sendInstanceSettings(sendDelay,webhook_url,webhook_message_received,webhook_message_create,webhook_message_ack,webhook_message_download_media);\nconsole.log(response)<\/code><\/code><\/pre>\n\n- sendDelay<\/strong> : Atraso<\/a> em segundos entre o envio da mensagem.<\/li>
- webhook_url<\/strong> : URL Http ou https para receber notifica\u00e7\u00f5es.<\/li>
- webhook_message_received<\/strong> : notifica\u00e7\u00f5es true\/false em webhooks quando a mensagem \u00e9 recebida.<\/li>
- webhook_message_create<\/strong> : notifica\u00e7\u00f5es true\/false em webhooks quando a mensagem cria .<\/li>
- webhook_message_ack<\/strong> : notifica\u00e7\u00f5es true\/false ack (mensagem entregue e mensagem visualizada) em webhooks.<\/li><\/ul>\n\n
Obter a lista de bate-papos<\/h2>\n\nconst response = await api.getChats();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nobter a \u00faltima mensagem da conversa de bate-papo<\/h2>\n\n- chatId<\/strong> : chatID para contato ou grupo, por exemplo, 14155552671@c.us ou 14155552671-441234567890@g.us<\/li>
- limite<\/strong> : n\u00famero de mensagens por solicita\u00e7\u00e3o.<\/li><\/ul>\n\n
valor m\u00e1ximo: 1000.<\/p>\n\n
var chatId=\"14155552671@c.us\";\nvar limit=100;\nconst response = await api.getChatsMessages(chatId,limit);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObtenha a lista de contatos<\/h2>\n\nconst response = await api.getContacts();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObter informa\u00e7\u00f5es de contato<\/h2>\n\n
chatId<\/strong> : chatID para contato, por exemplo, 14155552671@c.us<\/p>\n\nvar chatId=\"14155552671@c.us\"; \nconst response = await api.getContact(chatId);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObt\u00e9m todos os contatos bloqueados<\/h2>\n\nconst response = await api.getBlockedContacts();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nbloquear contato do WhatsApp<\/h2>\n\n
chatId<\/strong> : chatID para contato, por exemplo, 14155552671@c.us<\/p>\n\nvar chatId=\"14155552671@c.us\"; \nconst response = await api.blockContact(chatId);\nconsole.log(response)<\/code><\/pre>\n\n<\/a><\/h2>\n\nDesbloquear contato do WhatsApp<\/h2>\n\n
chatId<\/strong> : chatID para contato, por exemplo, 14155552671@c.us<\/p>\n\nvar chatId=\"14155552671@c.us\"; \nconst response = await api.unblockContact(chatId);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nVerifique se o n\u00famero \u00e9 usu\u00e1rio do WhatsApp<\/h2>\n\n
chatId<\/strong> : chatID para contato, por exemplo, 14155552671@c.us<\/p>\n\nvar chatId=\"14155552671@c.us\"; \nconst response = await api.checkContact(chatId);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nReceba mensagens do WhatsApp<\/h2>\n\n
voc\u00ea pode receber mensagens do WhatsApp usando webhooks, voc\u00ea pode ver este artigo<\/a> .<\/p>\n\nFinalmente<\/h2>\n\n
Voc\u00ea pode visitar o projeto no github<\/a><\/p>\n\nAPI do WhatsApp Nodejs-sdk vers\u00e3o atual: 1.0.1 no NPM<\/a> <\/p>\n\n<\/p>\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
Introdu\u00e7\u00e3o Neste tutorial, vamos aprender como usar Ultramsg Nodejs-WhatsApp-sdk para usar WhatsAppAPI com Nodejs Instala\u00e7\u00e3o … <\/p>\n