{"id":14987176,"url":"https://github.com/ultramsg/whatsapp-nodejs-sdk","last_synced_at":"2025-06-10T09:33:30.546Z","repository":{"id":57689853,"uuid":"491589287","full_name":"ultramsg/whatsapp-nodejs-sdk","owner":"ultramsg","description":"Lightweight library for WhatsApp API to send the whatsappp messages in nodejs provided by ultramsg.com","archived":false,"fork":false,"pushed_at":"2024-08-13T16:35:53.000Z","size":19,"stargazers_count":0,"open_issues_count":4,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-04T11:23:33.628Z","etag":null,"topics":["nodejs","sdk","whatsapp","whatsapp-api","whatsapp-api-node","whatsapp-api-nodejs","whatsapp-bot","whatsapp-chat","whatsapp-web"],"latest_commit_sha":null,"homepage":"https://ultramsg.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ultramsg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-12T16:27:22.000Z","updated_at":"2022-05-15T13:44:13.000Z","dependencies_parsed_at":"2024-09-24T15:43:22.427Z","dependency_job_id":null,"html_url":"https://github.com/ultramsg/whatsapp-nodejs-sdk","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"7d83f3a0be397e20be78d479d031e8b8049fa3ed"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultramsg%2Fwhatsapp-nodejs-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultramsg%2Fwhatsapp-nodejs-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultramsg%2Fwhatsapp-nodejs-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultramsg%2Fwhatsapp-nodejs-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ultramsg","download_url":"https://codeload.github.com/ultramsg/whatsapp-nodejs-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultramsg%2Fwhatsapp-nodejs-sdk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":258664772,"owners_count":22738032,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs","sdk","whatsapp","whatsapp-api","whatsapp-api-node","whatsapp-api-nodejs","whatsapp-bot","whatsapp-chat","whatsapp-web"],"created_at":"2024-09-24T14:14:12.755Z","updated_at":"2025-06-10T09:33:30.517Z","avatar_url":"https://github.com/ultramsg.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Ultramsg.com](https://ultramsg.com/?utm_source=github\u0026utm_medium=nodejs\u0026utm_campaign=api) WhatsApp API nodejs SDK\r\n\r\n Lightweight library for WhatsApp API to send the whatsappp messages in nodejs provided by  [Ultramsg.com](https://ultramsg.com/?utm_source=github\u0026utm_medium=nodejs\u0026utm_campaign=api)\r\n\r\n# Installation\r\n \r\n```\r\nnpm i ultramsg-whatsapp-api\r\n```\r\n\r\n\r\n# Example usage\r\n\r\n```js\r\nconst ultramsg = require('ultramsg-whatsapp-api');\r\nconst instance_id= \"instance1150\" // Ultramsg.com instance id\r\nconst ultramsg_token= \"tof7lsdJasdloaa57e\"  // Ultramsg.com token\r\nconst api = new ultramsg(instance_id,ultramsg_token);\r\n(async function () {\r\n    var to = \"put_your_mobile_number_here\"\r\n    var body = \"Hello world\" \r\n    const response = await api.sendChatMessage(to,body);\r\n   console.log(response)\r\n})(); \r\n```\r\n \u003e **NOTE:**  you need replace instance_id and token with yours in [ultramsg.com](https://ultramsg.com/?utm_source=github\u0026utm_medium=nodejs\u0026utm_campaign=api) account if you don't have account create one from [here](https://ultramsg.com/?utm_source=github\u0026utm_medium=nodejs\u0026utm_campaign=api)\r\n\r\n\r\n\r\n## Send Message\r\n* **to** :  your number for testing with international format e.g. +14155552671 or chatID for contact or group e.g 14155552671@c.us or 14155552671-441234567890@g.us\r\n* **body** : Message text, UTF-8 or UTF-16 string with emoji .\r\n* **priority** : This parameter is optional,\r\n\r\nYou can use it to create a professional queue for messages, The Messages with less priority value are sent first.\r\n\r\nexample of usage :\r\n\r\npriority = 0: for High priority like OTP messages.\r\n\r\npriority = 5: used with general messages.\r\n\r\npriority =10: Non-urgent promotional offers and notifications to your customers.\r\n\r\n**Default value** : 10\r\n* **referenceId** : Your custom reference ID for this message.\r\n```js\r\nvar to=\"put_your_mobile_number_here\"; \r\nvar body=\"Hello world\";\r\nvar priority=10;\r\nvar referenceId=\"SDK\";\r\nconst response = await api.sendChatMessage(to,body,priority,referenceId);\r\nconsole.log(response)\r\n```\r\n\r\n## Send Image \r\n* **caption** : image Caption, UTF-8 or UTF-16 string with emoji .\r\n* **image** : HTTP link image or base64-encoded file\r\n\r\nSupported extensions ( jpg , jpeg , gif , png , svg , webp , bmp ) .\r\n\r\nMax file size : 16MB .\r\n\r\nMax Base64 length : 2,000,000\r\n\r\n* **nocache** : default false\r\n\r\nfalse : use a previously uploaded file instead of uploading it with each request\r\n\r\ntrue : uploading it each request\r\n\r\n```js\r\nvar to=\"put_your_mobile_number_here\"; \r\nvar caption=\"image Caption\"; \r\nvar image=\"https://file-example.s3-accelerate.amazonaws.com/images/test.jpg\"; \r\nvar priority=10;\r\nvar referenceId=\"SDK\"\r\nvar nocache=false; \r\nconst response = await api.sendImageMessage(to,caption,image,priority,referenceId,nocache);\r\nconsole.log(response)\r\n```\r\n## Send Document \r\n* **filename** : File name, for example 1.jpg or Hello.pdf\r\n* **document** : HTTP link file or base64-encoded file\r\n\r\nSupported most extensions like ( zip , xlsx , csv , txt , pptx , docx ....etc ) .\r\n\r\nMax file size : 100MB .\r\n\r\nMax Base64 length : 2,000,000\r\n\r\n```js\r\nvar to=\"put_your_mobile_number_here\"; \r\nvar filename=\"cv.pdf\"; \r\nvar document=\"https://file-example.s3-accelerate.amazonaws.com/documents/cv.pdf\"; \r\nconst response = await api.sendDocumentMessage(to,filename,document);\r\nconsole.log(response)\r\n```\r\n\r\n## Send Audio \r\n* **audio** : HTTP link audio or base64-encoded audio \r\n\r\nSupported extensions ( mp3 , aac , ogg ) .\r\n\r\nMax file size : 16MB .\r\n\r\nMax Base64 length : 2,000,000\r\n\r\n```js \r\nvar to=\"put_your_mobile_number_here\"; \r\nvar audio=\"https://file-example.s3-accelerate.amazonaws.com/audio/2.mp3\"; \r\nconst response = await api.sendAudioMessage(to,audio);\r\nconsole.log(response)\r\n```\r\n## Send Voice \r\n* **audio** : HTTP link audio ogg-file with opus codec or base64 ogg-file in opus codec\r\n\r\nMax file size : 16MB .\r\n\r\nMax Base64 length : 2,000,000\r\n\r\n```js \r\nvar to=\"put_your_mobile_number_here\"; \r\nvar audio=\"https://file-example.s3-accelerate.amazonaws.com/voice/oog_example.ogg\"; \r\nconst response = await api.sendVoiceMessage(to,audio);\r\nconsole.log(response)\r\n```\r\n\r\n## Send Video \r\n* **video** : HTTP link video or base64-encoded video  \r\n\r\nSupported extensions ( mp4 , 3gp , mov ) .\r\n\r\nMax file size : 16MB .\r\n\r\nMax Base64 length : 2,000,000\r\n\r\n```js \r\nvar to=\"put_your_mobile_number_here\"; \r\nvar caption=\"video Caption\"; \r\nvar video=\"https://file-example.s3-accelerate.amazonaws.com/video/test.mp4\"; \r\nconst response = await api.sendVideoMessage(to,caption,video);\r\nconsole.log(response)\r\n```\r\n## Send Link \r\n* **link** : HTTP or HTTPS link\r\n\r\n```js \r\nvar to=\"put_your_mobile_number_here\"; \r\nvar link=\"https://ultramsg.com\"; \r\nconst response = await api.sendLinkMessage(to,link);\r\nconsole.log(response)\r\n```\r\n## Send Contact \r\n* **contact** :Contact ID or Contact IDs array example :\r\n\r\nExample\r\n\r\n14000000001@c.us\r\n\r\nor\r\n\r\n14000000001@c.us,14000000002@c.us,14000000003@c.us\r\n\r\nMax length : 300 char, almost 15 contacts\r\n```js \r\nvar to=\"put_your_mobile_number_here\"; \r\nvar contact=\"14000000001@c.us\"; \r\nconst response = await api.sendContactMessage(to,contact);\r\nconsole.log(response)\r\n```\r\n## Send Location \r\n* **address** : Text under the location.\r\n\r\nSupports two lines. To use two lines, use the \\n symbol.\r\n\r\nMax length : 300 char .\r\n* **lat** : Latitude\r\n* **lng** : longitude\r\n```js \r\nvar to=\"put_your_mobile_number_here\"; \r\nvar address=\"ABC company \\n Sixth floor , office 38\"; \r\nvar lat=\"25.197197\"; \r\nvar lng=\"55.2721877\"; \r\nconst response = await api.sendLocationMessage(to,address,lat,lng);\r\nconsole.log(response)\r\n```\r\n## Send Vcard \r\n* **vcard** : Text value vcard 3.0\r\n\r\nMax length : 4096 char\r\n\r\n```js \r\nvar to=\"put_your_mobile_number_here\"; \r\nvar vcard=`BEGIN:VCARD\r\nVERSION:3.0\r\nN:lastname;firstname\r\nFN:firstname lastname\r\nTEL;TYPE=CELL;waid=14000000001:14000000002\r\nNICKNAME:nickname\r\nBDAY:01.01.1987\r\nX-GENDER:M\r\nNOTE:note\r\nADR;TYPE=home\r\nADR;TYPE=work\r\nEND:VCARD`; \r\nconst response = await api.sendVcardMessage(to,vcard);\r\nconsole.log(response)\r\n```\r\n## Resend messages by status \r\n* **status** : unsent or expired\r\n\r\n```js  \r\nvar status=\"expired\"; \r\nconst response = await api.resendByStatus(status);\r\nconsole.log(response)\r\n```\r\n## Resend message by ID \r\n* **id** : message id\r\n\r\n```js  \r\nvar id=\"123\"; \r\nconst response = await api.resendById(id);\r\nconsole.log(response)\r\n```\r\n\r\n\r\n## Get Messages\r\nget the messages that sent by api\r\n\r\n* **page** : pagination page number\r\n* **limit** : number of messages per request . max value : 100 .\r\n* **status** : Messages status [sent , queue , unsent]\r\n  - sent : get sent messages .\r\n  - queue : get queue messages .\r\n  - unsent : get unsent messages .\r\n  - invalid : get invalid messages .\r\n  - all : get all messages .\r\n* **sort** :  \r\n  - asc : sorted messages by ID from smallest to largest .\r\n  - desc : sorted messages by ID from largest to smallest .\r\n* **id** : filter messages by message ID .\r\n* **referenceId** : filter messages by your custom reference ID .\r\n* **from** : filter messages by WhatsApp sender number e.g 14155552671@c.us .\r\n* **to** : filter messages by recipient number  e.g 14155552671@c.us or 14155552671-441234567890@g.us .\r\n* **ack** : filter messages by message ack status [ pending , server , device , read , played ] .\r\n\r\n\r\n```js \r\nvar page=1;\r\nvar limit=100;\r\nvar status=\"all\";\r\nvar sort=\"asc\";\r\nvar id=\"\";\r\nvar referenceId=\"\";\r\nvar from=\"\";\r\nvar to=\"\";\r\nvar ack=\"\";\r\nconst response = await api.getMessages(page,limit,status,sort,id,referenceId,from,to,ack);\r\nconsole.log(response)\r\n```\r\n\r\n## Get Messages Statistics \r\n\r\n```js \r\nconst response = await api.getMessageStatistics();\r\nconsole.log(response)\r\n```\r\n\r\n## Get Instance Status \r\n\r\n```js \r\nconst response = await api.getInstanceStatus();\r\nconsole.log(response)\r\n```\r\n\r\n## Get Instance QR Image\r\n\r\n```js \r\nconst response = await api.getInstanceQr();\r\nconsole.log(response)\r\n```\r\n## Get Instance QR Code \r\n\r\n```js  \r\nconst response = await api.getInstanceQrCode();\r\nconsole.log(response)\r\n```\r\n## Get Instance Screenshot \r\n \r\n```js  \r\nconst response = await api.getInstanceScreenshot();\r\nconsole.log(response)\r\n```\r\nor base64\r\n```js\r\nconst response = await api.getInstanceScreenshot(\"base64\");\r\nconsole.log(response)\r\n```\r\n## Get Instance Info\r\nGet connected phone informations : number , name , image etc..\r\n```js\r\nconst response = await api.getInstanceMe();\r\nconsole.log(response)\r\n```\r\n## Get Instance Settings\r\nsendDelay : Delay in seconds between sending message, Default 1 second\r\n\r\nwebhook_url : Http or https URL for receiving notifications .\r\n\r\nwebhook_message_ack : on/off ack (message delivered and message viewed) notifications in webhooks.\r\n\r\nwebhook_message_received : on/off notifications in webhooks when message received .\r\n\r\nwebhook_message_create : on/off notifications in webhooks when message create .\r\n\r\nwebhook_message_download_media  :  on/off to get received document / media files.\r\n```js\r\nconst response = await api.getInstanceSettings();\r\nconsole.log(response)\r\n```\r\n\r\n## Instance Takeover\r\nReturns the active session if the device has connected to another instance of Web WhatsApp\r\n\r\n```js  \r\nconst response = await api.sendInstanceTakeover();\r\nconsole.log(response)\r\n```\r\n## Instance Logout\r\nLogout from WhatsApp Web to get new QR code.\r\n\r\n```js  \r\nconst response = await api.sendInstanceLogout();\r\nconsole.log(response)\r\n```\r\n## Instance Restart\r\nRestart your instance.\r\n\r\n```js  \r\nconst response = await api.sendInstanceRestart();\r\nconsole.log(response)\r\n```\r\n## Instance Settings Update\r\n* **sendDelay** : Delay in seconds between sending message .\r\n\r\n* **webhook_url** : Http or https URL for receiving notifications .\r\n\r\n* **webhook_message_received** : true/false notifications in webhooks when message received .\r\n\r\n* **webhook_message_create** : true/false notifications in webhooks when message create .\r\n\r\n* **webhook_message_ack** : true/false ack (message delivered and message viewed) notifications in webhooks.\r\n\r\n```js  \r\nvar sendDelay=1;\r\nvar webhook_url=\"\";\r\nvar webhook_message_received=false;\r\nvar webhook_message_create=false;\r\nvar webhook_message_ack=false;\r\nvar webhook_message_download_media=false;\r\n\r\nconst response = await api.sendInstanceSettings(sendDelay,webhook_url,webhook_message_received,webhook_message_create,webhook_message_ack,webhook_message_download_media);\r\nconsole.log(response)\r\n```\r\n\r\n## Get the chats list\r\n\r\n```js  \r\nconst response = await api.getChats();\r\nconsole.log(response)\r\n```\r\n\r\n## get last message from chat conversation\r\n\r\n* **chatId** : chatID for contact or group e.g 14155552671@c.us or 14155552671-441234567890@g.us\r\n* **limit** : number of messages per request .\r\n\r\nmax value : 1000 .\r\n\r\n```js  \r\nvar chatId=\"14155552671@c.us\";\r\nvar limit=100;\r\nconst response = await api.getChatsMessages(chatId,limit);\r\nconsole.log(response)\r\n```\r\n\r\n\r\n## Get the contacts list\r\n\r\n```js  \r\nconst response = await api.getContacts();\r\nconsole.log(response)\r\n```\r\n\r\n## Get contact info\r\n\r\n* **chatId** : chatID for contact e.g 14155552671@c.us \r\n\r\n```js  \r\nvar chatId=\"14155552671@c.us\"; \r\nconst response = await api.getContact(chatId);\r\nconsole.log(response)\r\n```\r\n\r\n\r\n## Gets all blocked contacts\r\n\r\n```js  \r\nconst response = await api.getBlockedContacts();\r\nconsole.log(response)\r\n```\r\n\r\n## block contact from WhatsApp\r\n\r\n* **chatId** : chatID for contact e.g 14155552671@c.us \r\n\r\n```js  \r\nvar chatId=\"14155552671@c.us\"; \r\nconst response = await api.blockContact(chatId);\r\nconsole.log(response)\r\n```\r\n\r\n## Unblock contact from WhatsApp\r\n\r\n* **chatId** : chatID for contact e.g 14155552671@c.us \r\n\r\n```js  \r\nvar chatId=\"14155552671@c.us\"; \r\nconst response = await api.unblockContact(chatId);\r\nconsole.log(response)\r\n```\r\n\r\n## Check if number is WhatsApp user\r\n\r\n* **chatId** : chatID for contact e.g 14155552671@c.us \r\n\r\n```js  \r\nvar chatId=\"14155552671@c.us\"; \r\nconst response = await api.checkContact(chatId);\r\nconsole.log(response)\r\n```\r\n\r\n\r\n\r\n# Support\r\nUse **Issues** to contact me","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fultramsg%2Fwhatsapp-nodejs-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fultramsg%2Fwhatsapp-nodejs-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fultramsg%2Fwhatsapp-nodejs-sdk/lists"}