परिचय
इस ट्यूटोरियल में, हम सीखेंगे कि Ultramsg Nodejs-WhatsApp-sdk को Nodejs के साथ WhatsAppAPI का उपयोग करने के लिए कैसे उपयोग करें
WhatsApp API Nodejs-sdk इंस्टालेशन
npm i ultramsg-whatsapp-apiउदाहरण उपयोग
const ultramsg = require('ultramsg-whatsapp-api');
const instance_id= "instance1150" // Ultramsg.com instance id
const ultramsg_token= "tof7lsdJasdloaa57e" // Ultramsg.com token
const api = new ultramsg(instance_id,ultramsg_token);
(async function () {
var to = "put_your_mobile_number_here"
var body = "Hello world"
const response = await api.sendChatMessage(to,body);
console.log(response)
})(); नोट: यदि आपके पास खाता नहीं है तो आपको ultramsg.com खाते में अपने साथ instance_id और टोकन बदलने की आवश्यकता है ।
मेसेज भेजें
var to="put_your_mobile_number_here";
var body="Hello world";
var priority=10;
var referenceId="SDK";
const response = await api.sendChatMessage(to,body,priority,referenceId);
console.log(response)
- करने के लिए : अंतरराष्ट्रीय प्रारूप के साथ परीक्षण के लिए आपका नंबर जैसे, +14155552671 या संपर्क या समूह के लिए चैट आईडी जैसे [email protected] या [email protected]
- मुख्य भाग : संदेश टेक्स्ट, इमोजी के साथ UTF-8 या UTF-16 स्ट्रिंग।
- प्राथमिकता: यह पैरामीटर वैकल्पिक है,
आप संदेशों के लिए एक पेशेवर कतार बनाने के लिए इसका उपयोग कर सकते हैं, कम प्राथमिकता वाले संदेश पहले भेजे जाते हैं।
उपयोग का उदाहरण:
प्राथमिकता = 0: ओटीपी संदेशों की तरह उच्च प्राथमिकता के लिए।
प्राथमिकता = 5: सामान्य संदेशों के साथ प्रयोग किया जाता है।
प्राथमिकता =10: आपके ग्राहकों को गैर-जरूरी प्रचार ऑफ़र और सूचनाएं।
डिफ़ॉल्ट मान: 10
- संदर्भ आईडी : इस संदेश के लिए आपकी कस्टम संदर्भ आईडी ।
छवि भेजें
var to="put_your_mobile_number_here";
var caption="image Caption";
var image="https://file-example.s3-accelerate.amazonaws.com/images/test.jpg";
var priority=10;
var referenceId="SDK"
var nocache=false;
const response = await api.sendImageMessage(to,caption,image,priority,referenceId,nocache);
console.log(response)
- कैप्शन : इमेज कैप्शन, इमोजी के साथ UTF-8 या UTF-16 स्ट्रिंग.
- छवि : HTTP लिंक छवि या बेस 64-एन्कोडेड फ़ाइल
समर्थित एक्सटेंशन (जेपीजी, जेपीईजी, जीआईएफ, पीएनजी, एसवीजी, वेबपी, बीएमपी)।
अधिकतम फ़ाइल आकार: 16 एमबी।
अधिकतम बेस 64 लंबाई: 2,000,000
- nocache : डिफ़ॉल्ट गलत
गलत: प्रत्येक अनुरोध के साथ अपलोड करने के बजाय पहले अपलोड की गई फ़ाइल का उपयोग करें
सत्य: प्रत्येक अनुरोध को अपलोड करना
दस्तावेज़ भेजें
var to="put_your_mobile_number_here";
var filename="cv.pdf";
var document="https://file-example.s3-accelerate.amazonaws.com/documents/cv.pdf";
const response = await api.sendDocumentMessage(to,filename,document);
console.log(response)
- फ़ाइल का नाम: फ़ाइल का नाम, उदाहरण के लिए 1.jpg या Hello.pdf
- दस्तावेज़: HTTP लिंक फ़ाइल या बेस 64-एन्कोडेड फ़ाइल
समर्थित अधिकांश एक्सटेंशन जैसे ( zip , xlsx , csv , txt , pptx , docx ….etc ) ।
अधिकतम फ़ाइल आकार: 100 एमबी।
अधिकतम बेस 64 लंबाई: 2,000,000
ऑडियो भेजें
var to="put_your_mobile_number_here";
var audio="https://file-example.s3-accelerate.amazonaws.com/audio/2.mp3";
const response = await api.sendAudioMessage(to,audio);
console.log(response)
- ऑडियो : HTTP लिंक ऑडियो या बेस 64-एन्कोडेड ऑडियो
समर्थित एक्सटेंशन (एमपी 3, एएसी, ओग)।
अधिकतम फ़ाइल आकार: 16 एमबी।
अधिकतम बेस 64 लंबाई: 2,000,000
आवाज भेजें
var to="put_your_mobile_number_here";
var audio="https://file-example.s3-accelerate.amazonaws.com/voice/oog_example.ogg";
const response = await api.sendVoiceMessage(to,audio);
console.log(response)
- ऑडियो : ओपस कोडेक के साथ HTTP लिंक ऑडियो ओग-फाइल या ओपस कोडेक में बेस 64 ओग-फाइल
अधिकतम फ़ाइल आकार: 16 एमबी।
अधिकतम बेस 64 लंबाई: 2,000,000
वीडियो भेजना
var to="put_your_mobile_number_here";
var caption="video Caption";
var video="https://file-example.s3-accelerate.amazonaws.com/video/test.mp4";
const response = await api.sendVideoMessage(to,caption,video);
console.log(response)
- वीडियो : HTTP लिंक वीडियो या बेस 64-एन्कोडेड वीडियो
समर्थित एक्सटेंशन ( mp4 , 3gp , mov ) .
अधिकतम फ़ाइल आकार: 16 एमबी।
अधिकतम बेस 64 लंबाई: 2,000,000
लिंक भेजें
var to="put_your_mobile_number_here";
var link="https://ultramsg.com";
const response = await api.sendLinkMessage(to,link);
console.log(response)
लिंक: HTTP या HTTPS लिंक
संपर्क भेजें
var to="put_your_mobile_number_here";
var contact="[email protected]";
const response = await api.sendContactMessage(to,contact);
console.log(response)
- संपर्क: संपर्क आईडी या संपर्क आईडी सरणी उदाहरण:
उदाहरण
या
[email protected],[email protected],[email protected]
अधिकतम लंबाई: 300 वर्ण, लगभग 15 संपर्क
स्थान भेजें
var to="put_your_mobile_number_here";
var address="ABC company \n Sixth floor , office 38";
var lat="25.197197";
var lng="55.2721877";
const response = await api.sendLocationMessage(to,address,lat,lng);
console.log(response)
- पता : स्थान के तहत पाठ।
दो पंक्तियों का समर्थन करता है। दो पंक्तियों का उपयोग करने के लिए, \n प्रतीक का प्रयोग करें।
अधिकतम लंबाई: 300 वर्ण।
- अक्षांश : अक्षांश
- एलएनजी : देशांतर
वीकार्ड भेजें
var to="put_your_mobile_number_here";
var vcard=`BEGIN:VCARD
VERSION:3.0
N:lastname;firstname
FN:firstname lastname
TEL;TYPE=CELL;waid=14000000001:14000000002
NICKNAME:nickname
BDAY:01.01.1987
X-GENDER:M
NOTE:note
ADR;TYPE=home
ADR;TYPE=work
END:VCARD`;
const response = await api.sendVcardMessage(to,vcard);
console.log(response)- vcard : टेक्स्ट वैल्यू vcard 3.0
अधिकतम लंबाई: 4096 चार
संदेश प्राप्त करें
var page=1;
var limit=100;
var status="all";
var sort="asc";
var id="";
var referenceId="";
var from="";
var to="";
var ack="";
const response = await api.getMessages(page,limit,status,sort,id,referenceId,from,to,ack);
console.log(response)- पेज : पेजिनेशन पेज नंबर
- सीमा : प्रति अनुरोध संदेशों की संख्या। अधिकतम मूल्य: 100।
- स्थिति : संदेश की स्थिति [भेजे गए, कतार में, नहीं भेजे गए]
- भेजा गया: भेजे गए संदेश प्राप्त करें।
- कतार: कतार संदेश प्राप्त करें।
- अप्रेषित: न भेजे गए संदेश प्राप्त करें।
- अमान्य: अमान्य संदेश प्राप्त करें।
- सभी: सभी संदेश प्राप्त करें।
- क्रमबद्ध करें:
- asc : आईडी के आधार पर संदेशों को सबसे छोटे से सबसे बड़े तक क्रमबद्ध किया जाता है।
- desc : आईडी के आधार पर संदेशों को सबसे बड़े से सबसे छोटे में क्रमबद्ध किया जाता है।
- आईडी : संदेश आईडी द्वारा संदेशों को फ़िल्टर करें।
- संदर्भ आईडी: अपने कस्टम संदर्भ आईडी द्वारा संदेशों को फ़िल्टर करें।
- से : व्हाट्सएप प्रेषक संख्या द्वारा संदेशों को फ़िल्टर करें जैसे [email protected]।
- को : प्राप्तकर्ता संख्या द्वारा संदेशों को फ़िल्टर करें जैसे [email protected] या [email protected]।
- ack : संदेश ack स्थिति [लंबित, सर्वर, डिवाइस, रीड, प्ले] द्वारा संदेशों को फ़िल्टर करें।
संदेश सांख्यिकी प्राप्त करें
const response = await api.getMessageStatistics();
console.log(response)
इंस्टेंस स्थिति प्राप्त करें
const response = await api.getInstanceStatus();
console.log(response)
इंस्टेंस क्यूआर इमेज प्राप्त करें
const response = await api.getInstanceQr();
console.log(response)
इंस्टेंस क्यूआर कोड प्राप्त करें
const response = await api.getInstanceQrCode();
console.log(response)
इंस्टेंस जानकारी प्राप्त करें
कनेक्टेड फ़ोन जानकारी प्राप्त करें: नंबर, नाम, छवि आदि।
const response = await api.getInstanceMe();
console.log(response)
इंस्टेंस सेटिंग्स प्राप्त करें
const response = await api.getInstanceSettings();
console.log(response)
sendDelay : संदेश भेजने के बीच सेकंड में देरी, डिफ़ॉल्ट 1 सेकंड
webhook_url : सूचनाएं प्राप्त करने के लिए Http या https URL।
webhook_message_ack : webhooks में ऑन/ऑफ ack (मैसेज डिलीवर और मैसेज देखा गया) नोटिफिकेशन।
webhook_message_received: संदेश प्राप्त होने पर वेबहुक में सूचनाएं चालू/बंद करें।
webhook_message_create : संदेश बनाते समय वेबहुक में सूचनाएं चालू/बंद करें।
webhook_message_download_media : प्राप्त दस्तावेज़/मीडिया फ़ाइलें प्राप्त करने के लिए चालू/बंद।
इंस्टेंस लॉगआउट
नया क्यूआर कोड प्राप्त करने के लिए व्हाट्सएप वेब से लॉगआउट करें।
const response = await api.sendInstanceLogout();
console.log(response)
इंस्टेंस पुनरारंभ
अपना उदाहरण पुनरारंभ करें।
const response = await api.sendInstanceRestart();
console.log(response)
इंस्टेंस सेटिंग्स अपडेट
var sendDelay=1;
var webhook_url="";
var webhook_message_received=false;
var webhook_message_create=false;
var webhook_message_ack=false;
var webhook_message_download_media=false;
const response = await api.sendInstanceSettings(sendDelay,webhook_url,webhook_message_received,webhook_message_create,webhook_message_ack,webhook_message_download_media);
console.log(response)- SendDelay : संदेश भेजने के बीच सेकंड में देरी ।
- webhook_url : सूचनाएं प्राप्त करने के लिए Http या https URL।
- webhook_message_received : संदेश प्राप्त होने पर वेबहुक में सही/गलत सूचनाएं।
- webhook_message_create : संदेश बनाते समय वेबहुक में सही/गलत सूचनाएं।
- webhook_message_ack : webhooks में सही/गलत ack (संदेश दिया गया और संदेश देखा गया) सूचनाएं।
चैट सूची प्राप्त करें
const response = await api.getChats();
console.log(response)
चैट वार्तालाप से अंतिम संदेश प्राप्त करें
- चैट आईडी : संपर्क या समूह के लिए चैट आईडी जैसे [email protected] या [email protected]
- सीमा : प्रति अनुरोध संदेशों की संख्या।
अधिकतम मूल्य: 1000।
var chatId="[email protected]";
var limit=100;
const response = await api.getChatsMessages(chatId,limit);
console.log(response)
संपर्क सूची प्राप्त करें
const response = await api.getContacts();
console.log(response)
संपर्क जानकारी प्राप्त करें
चैट आईडी: संपर्क के लिए चैट आईडी जैसे [email protected]
var chatId="[email protected]";
const response = await api.getContact(chatId);
console.log(response)
सभी अवरुद्ध संपर्क प्राप्त करता है
const response = await api.getBlockedContacts();
console.log(response)
व्हाट्सएप से संपर्क ब्लॉक करें
चैट आईडी: संपर्क के लिए चैट आईडी जैसे [email protected]
var chatId="[email protected]";
const response = await api.blockContact(chatId);
console.log(response)व्हाट्सएप से संपर्क को अनब्लॉक करें
चैट आईडी: संपर्क के लिए चैट आईडी जैसे [email protected]
var chatId="[email protected]";
const response = await api.unblockContact(chatId);
console.log(response)
जांचें कि क्या नंबर व्हाट्सएप यूजर है
चैट आईडी: संपर्क के लिए चैट आईडी जैसे [email protected]
var chatId="[email protected]";
const response = await api.checkContact(chatId);
console.log(response)
व्हाट्सएप संदेश प्राप्त करें
आप वेबहुक का उपयोग करके व्हाट्सएप संदेश प्राप्त कर सकते हैं, आप इस लेख को देख सकते हैं।
आखिरकार
आप परियोजना को जीथब पर देख सकते हैं
WhatsApp API Nodejs-sdk करेंट वर्: 1.0.1 एनपीएम पर