En este tutorial, aprenderemos a usar Ultramsg Nodejs-WhatsApp-sdk para usar WhatsAppAPI con Nodejs<\/p>\n\n
npm i ultramsg-whatsapp-api<\/code><\/code><\/pre>\n\nEjemplo 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> debe reemplazar el ID de instancia y el token con el suyo en la cuenta de ultramsg.com si no tiene una cuenta, cree una desde aqu\u00ed<\/a> .<\/p><\/blockquote>\n\nEnviar mensaje<\/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- a<\/b> : su n\u00famero para realizar pruebas con formato internacional, por ejemplo, +14155552671 o chatID para contacto o grupo, por ejemplo, 14155552671@c.us o 14155552671-441234567890@g.us<\/li>
- cuerpo<\/strong> : texto del mensaje, cadena UTF-8 o UTF-16 con emoji.<\/li>
- prioridad:<\/strong> este par\u00e1metro es opcional,<\/li><\/ul>\n\n
Puede usarlo para crear una cola profesional para mensajes<\/a> . Los mensajes con menos valor de prioridad se env\u00edan primero.<\/p>\n\nejemplo de uso:<\/p>\n\n
prioridad = 0: para alta prioridad como mensajes OTP.<\/p>\n\n
prioridad = 5: se usa con mensajes generales.<\/p>\n\n
prioridad =10: ofertas promocionales no urgentes y notificaciones a tus clientes.<\/p>\n\n
Valor predeterminado:<\/strong> 10<\/p>\n\n- referenceId<\/strong> : su ID de referencia<\/a> personalizado para este mensaje.<\/li><\/ul>\n\n
Enviar imagen<\/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- subt\u00edtulo<\/strong> : t\u00edtulo de imagen, cadena UTF-8 o UTF-16 con emoji.<\/li>
- imagen<\/strong> : imagen de enlace HTTP o archivo codificado en base64<\/li><\/ul>\n\n
Extensiones compatibles (jpg, jpeg, gif, png, svg, webp, bmp).<\/p>\n\n
Tama\u00f1o m\u00e1ximo de archivo: 16 MB.<\/p>\n\n
Longitud m\u00e1xima de Base64<\/a> : 2,000,000<\/p>\n\n- nocache<\/strong> : por defecto falso<\/li><\/ul>\n\n
falso: use un archivo cargado previamente en lugar de cargarlo con cada solicitud<\/p>\n\n
verdadero: subirlo cada solicitud<\/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- filename:<\/strong> nombre del archivo, por ejemplo, 1.jpg o Hello.pdf<\/li>
- documento:<\/strong> archivo de enlace HTTP o archivo codificado en base64<\/li><\/ul>\n\n
Compatible con la mayor\u00eda de las extensiones como (zip, xlsx, csv, txt, pptx, docx, etc.).<\/p>\n\n
Tama\u00f1o m\u00e1ximo de archivo: 100 MB.<\/p>\n\n
Longitud m\u00e1xima de Base64: 2,000,000<\/p>\n\n
Enviar sonido<\/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> : audio de enlace HTTP o audio codificado en base64<\/li><\/ul>\n\n
Extensiones compatibles (mp3, aac, ogg).<\/p>\n\n
Tama\u00f1o m\u00e1ximo de archivo: 16 MB.<\/p>\n\n
Longitud m\u00e1xima de 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> : archivo ogg de audio de enlace HTTP con c\u00f3dec opus o archivo ogg base64 en c\u00f3dec opus<\/li><\/ul>\n\n
Tama\u00f1o m\u00e1ximo de archivo: 16 MB.<\/p>\n\n
Longitud m\u00e1xima de 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> : video de enlace HTTP o video codificado en base64<\/li><\/ul>\n\n
Extensiones compatibles (mp4, 3gp, mov).<\/p>\n\n
Tama\u00f1o m\u00e1ximo de archivo: 16 MB.<\/p>\n\n
Longitud m\u00e1xima de Base64: 2,000,000<\/p>\n\n
<\/a><\/h2>\n\nEnviar enlace<\/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\nenlace: enlace<\/strong> HTTP o HTTPS<\/p>\n\nEnviar contacto<\/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- contacto:<\/strong> ID de contacto o ejemplo de matriz de ID de contacto:<\/li><\/ul>\n\n
Ejemplo<\/p>\n\n
14000000001@c.us<\/p>\n\n
o<\/p>\n\n
14000000001@c.us,14000000002@c.us,14000000003@c.us<\/p>\n\n
Longitud m\u00e1xima: 300 caracteres, casi 15 contactos<\/p>\n\n
Enviar ubicaci\u00f3n<\/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- direcci\u00f3n<\/strong> : texto debajo de la ubicaci\u00f3n.<\/li><\/ul>\n\n
Admite dos l\u00edneas. Para usar dos l\u00edneas, use el s\u00edmbolo \\n.<\/p>\n\n
Longitud m\u00e1xima: 300 caracteres.<\/p>\n\n
- lat<\/strong> : Latitud<\/li>
- lng<\/strong> : longitud<\/li><\/ul>\n\n
Enviar tarjeta virtual<\/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
Longitud m\u00e1xima: 4096 caracteres<\/p>\n\n
Obtener mensajes<\/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- p\u00e1gina<\/strong> : n\u00famero de p\u00e1gina de paginaci\u00f3n<\/li>
- l\u00edmite<\/strong> : n\u00famero de mensajes por solicitud. valor m\u00e1ximo : 100 .<\/li>
- estado<\/strong> : estado de los mensajes [enviado, cola, no enviado]
- enviado: recibir mensajes enviados.<\/li>
- cola: obtener mensajes de la cola.<\/li>
- no enviado: obtener mensajes no enviados.<\/li>
- inv\u00e1lido: recibe mensajes inv\u00e1lidos.<\/li>
- all: recibe todos los mensajes.<\/li><\/ul><\/li>
- ordenar<\/strong> :
- asc: mensajes ordenados por ID de menor a mayor.<\/li>
- desc: mensajes ordenados por ID de mayor a menor.<\/li><\/ul><\/li>
- id<\/strong> : filtrar mensajes por ID de mensaje.<\/li>
- referenceId<\/strong> : filtre los mensajes por su ID de referencia personalizado.<\/li>
- de<\/strong> : filtrar mensajes por n\u00famero de remitente de WhatsApp, por ejemplo, 14155552671@c.us.<\/li>
- para<\/strong> : filtrar mensajes por n\u00famero de destinatario, por ejemplo, 14155552671@c.us o 14155552671-441234567890@g.us.<\/li>
- acuse<\/strong> de recibo: filtre los mensajes por el estado del acuse de recibo del mensaje [pendiente, servidor, dispositivo, le\u00eddo, reproducido].<\/li><\/ul>\n\n
Obtener estad\u00edsticas de mensajes<\/h2>\n\nconst response = await api.getMessageStatistics();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObtener estado de instancia<\/h2>\n\nconst response = await api.getInstanceStatus();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObtener imagen QR de instancia<\/h2>\n\nconst response = await api.getInstanceQr();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObtenga el c\u00f3digo QR de la instancia<\/h2>\n\nconst response = await api.getInstanceQrCode();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObtener informaci\u00f3n de la instancia<\/h2>\n\n
Obtenga informaci\u00f3n del tel\u00e9fono conectado: n\u00famero, nombre, imagen, etc.<\/p>\n\n
const response = await api.getInstanceMe();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObtener configuraci\u00f3n de instancia<\/h2>\n\nconst response = await api.getInstanceSettings();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nsendDelay: Retraso en segundos entre el env\u00edo del mensaje, por defecto 1 segundo<\/p>\n\n
webhook_url: URL Http o https para recibir notificaciones.<\/p>\n\n
webhook_message_ack: on\/off ack (mensaje entregado y mensaje visto) notificaciones en webhooks.<\/p>\n\n
webhook_message_received: notificaciones de encendido\/apagado en webhooks cuando se recibe un mensaje.<\/p>\n\n
webhook_message_create: activar\/desactivar notificaciones en webhooks cuando se crea un mensaje.<\/p>\n\n
webhook_message_download_media: activar\/desactivar para recibir documentos\/archivos multimedia.<\/p>\n\n
Cierre de sesi\u00f3n de instancia<\/h2>\n\n
Cierre la sesi\u00f3n de WhatsApp Web para obtener un nuevo c\u00f3digo QR.<\/p>\n\n
const response = await api.sendInstanceLogout();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nReinicio de instancia<\/h2>\n\n
Reinicie su instancia.<\/p>\n\n
const response = await api.sendInstanceRestart();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nActualizaci\u00f3n de la configuraci\u00f3n de la instancia<\/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> : Retraso<\/a> en segundos entre el env\u00edo del mensaje.<\/li>
- webhook_url<\/strong> : URL Http o https para recibir notificaciones.<\/li>
- webhook_message_received<\/strong> : notificaciones verdaderas\/falsas en webhooks cuando se recibe un mensaje.<\/li>
- webhook_message_create<\/strong> : notificaciones verdaderas\/falsas en webhooks cuando se crea un mensaje.<\/li>
- webhook_message_ack<\/strong> : notificaciones de reconocimiento verdadero\/falso (mensaje entregado y mensaje visto) en webhooks.<\/li><\/ul>\n\n
Obtener la lista de chats<\/h2>\n\nconst response = await api.getChats();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nobtener el \u00faltimo mensaje de la conversaci\u00f3n de chat<\/h2>\n\n- chatId<\/strong> : chatID para contacto o grupo, por ejemplo, 14155552671@c.us o 14155552671-441234567890@g.us<\/li>
- l\u00edmite<\/strong> : n\u00famero de mensajes por solicitud.<\/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\nObtener la lista de contactos<\/h2>\n\nconst response = await api.getContacts();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObtener informaci\u00f3n de contacto<\/h2>\n\n
chatId<\/strong> : ID de chat para contacto, por ejemplo, 14155552671@c.us<\/p>\n\nvar chatId=\"14155552671@c.us\"; \nconst response = await api.getContact(chatId);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nObtiene todos los contactos bloqueados<\/h2>\n\nconst response = await api.getBlockedContacts();\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nbloquear contacto de whatsapp<\/h2>\n\n
chatId<\/strong> : ID de chat para contacto, por ejemplo, 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 contacto de WhatsApp<\/h2>\n\n
chatId<\/strong> : ID de chat para contacto, por ejemplo, 14155552671@c.us<\/p>\n\nvar chatId=\"14155552671@c.us\"; \nconst response = await api.unblockContact(chatId);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nComprobar si el n\u00famero es usuario de WhatsApp<\/h2>\n\n
chatId<\/strong> : ID de chat para contacto, por ejemplo, 14155552671@c.us<\/p>\n\nvar chatId=\"14155552671@c.us\"; \nconst response = await api.checkContact(chatId);\nconsole.log(response)\n<\/code><\/code><\/pre>\n\nRecibir mensajes de WhatsApp<\/h2>\n\n
Puedes recibir mensajes de WhatsApp usando webhooks, puedes ver este art\u00edculo<\/a> .<\/p>\n\nPor fin<\/h2>\n\n
Puedes visitar el proyecto en github<\/a><\/p>\n\nWhatsApp API Nodejs-sdk versi\u00f3n actual: 1.0.1 en NPM<\/a> <\/p>\n\n<\/p>\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
Introducci\u00f3n En este tutorial, aprenderemos a usar Ultramsg Nodejs-WhatsApp-sdk para usar WhatsAppAPI con Nodejs Instalaci\u00f3n … <\/p>\n