वेबहुक्स का परिचय

संकल्पना

इस विषय में, हम API WhatsApp Web द्वारा उपयोग किए गए वेबहुक्स के उत्तरों पर चर्चा करेंगे।

महत्वपूर्ण

आपका एंडपॉइंट POST अनुरोधों को स्वीकार करना चाहिए ताकि आप इवेंट्स की सूचनाएं प्राप्त कर सकें।

ध्यान रखें: जब आप इंस्टेंस बनाते हैं, तो आपको उन URLs को सूचित करना होगा जहाँ आप सूचनाएँ प्राप्त करना चाहते हैं।

यह क्या है और इसका क्या उपयोग है?

वेबहुक्स का उपयोग संदेशों के भेजने और प्राप्त करने के बारे में सूचित करने के लिए किया जाता है, साथ ही आपके इंस्टेंस की वर्तमान स्थिति के बारे में भी।

इंस्टेंस वह पृष्ठ है जिसे हम आपकी व्हाट्सएप अकाउंट के लिए प्रबंधित करते हैं।

यदि आप अपनी एप्लिकेशन को API WhatsApp Web के साथ एकीकृत कर रहे हैं, तो आपको वेबहुक्स के लिए एंडपॉइंट्स सेट करने होंगे ताकि आप व्हाट्सएप से जुड़ी सभी इंटरएक्शन की सूचनाएँ प्राप्त कर सकें।

हमारे वेबहुक्स

• Delivery: जब एक संदेश भेजा जाता है तो सूचित करता है।
• Receive: जब भी कोई आपके नंबर के साथ इंटरैक्ट करता है तो सूचित करता है।
• Status: एक संदेश की स्थिति की जांच करने की अनुमति देता है: प्राप्त, पढ़ा, उत्तर दिया या हटा दिया।
• Disconnected: आपके डिवाइस और व्हाट्सएप के बीच संचार में विघटन को सूचित करता है।
• Connected: आपके डिवाइस और व्हाट्सएप के बीच संचार की शुरुआत को सूचित करता है।

वेबहुक सेटअप

आप अपनी इंस्टेंस का वेबहुक सेटअप अपनी अकाउंट में जाकर कर सकते हैं:

जब आप एक नई इंस्टेंस बनाएंगे, तो आप संदेश प्राप्त करने के लिए सेटिंग्स जोड़ सकते हैं।

पैनल के माध्यम से सेटअप

प्रशासन पैनल में जाएं, "इंस्टेंस" पर क्लिक करें, इच्छित इंस्टेंस को देखें और सेटिंग्स संपादित करें।

संदेश भेजते समय वेबहुक

API के माध्यम से वेबहुक URL बदलें

यह एपीआई संदेश भेजने के लिए वेबहुक URL को PUT अनुरोध के माध्यम से बदलने की अनुमति देती है।

बेस URL

बेस URL: https://apiwhatsappweb.com/api/config/sent

प्रमाणीकरण

अनुरोधों को प्रमाणित करने के लिए, आपको API कुंजी (apiKey) और इंस्टेंस ID (id) हेडर (Header) में शामिल करना होगा।

{
    "apiKey": "यहाँ अपनी API कुंजी डालें",
    "id": "यहाँ अपनी इंस्टेंस ID डालें"
}

वेबहुक कैसे बदलें

अनुरोध बॉडी

अनुरोध बॉडी में एक JSON ऑब्जेक्ट होना चाहिए जिसका निम्नलिखित संरचना हो:

{
    "URL": "https://Your_Website_here.com/api/config/sent" 
    // वह URL भेजें जहाँ आप सूचनाएँ प्राप्त करना चाहते हैं
}

महत्वपूर्ण

API WhatsApp Web केवल HTTPS वेबहुक्स को स्वीकार करता है।

वेबहुक्स के उत्तर

संदेश भेजने का वेबहुक आपको सूचित करता है जब संदेश सफलतापूर्वक भेजा जाता है।

उत्तर का उदाहरण

{
    "message": "संदेश सफलतापूर्वक भेजा गया!",
    "messageSent": "आपके द्वारा भेजा गया संदेश",
    "number": "संपर्क का नंबर",
    "messageId": "संदेश की पहचान" // यह संदेश की स्थिति को बाद में एक्सेस करने की अनुमति देता है
}

{
    messageId: 'संदेश की पहचान', //यह आपको संदेश की स्थिति बाद में एक्सेस करने की अनुमति देता है,
    message: 'किसी और द्वारा भेजा गया संदेश',  //संदेश स्वचालित रूप से 30 दिनों में समाप्त हो जाते हैं
    number: "भेजा गया नंबर",
    photo: 'फोटो', //यदि यह फोटो नहीं है तो यह null होगा
    video: 'वीडियो', //यदि यह फोटो नहीं है तो यह null होगा,
    senderName: 'उपयोगकर्ता का नाम', //यदि नहीं है तो यह 'Unknown' होगा
    instanceName: 'प्लेटफ़ॉर्म पर पंजीकृत इंस्टेंस का नाम',
    instanceId: "प्लेटफ़ॉर्म पर पंजीकृत इंस्टेंस का ID",
    whatsappStatus: {
      message: "प्राप्त",
      description: 'किसी और द्वारा भेजा गया संदेश',
      title: 'शीर्षक' || null,
      url: 'किसी और द्वारा भेजा गया URL', //यदि नहीं है तो यह null होगा
      groupInvite: 'समूह के लिए निमंत्रण' //यदि नहीं है तो यह null होगा
    }
};
    

{
    instanceName: "वह इंस्टेंस जिसका डिस्कनेक्शन हुआ", 
    instanceId: "वह इंस्टेंस ID जिसका डिस्कनेक्शन हुआ",
    status: 'Disconnected',
    whatsappStatus: { message: "Disconnected" }
};
    

{
    instanceName: "वह इंस्टेंस जिसका कनेक्शन हुआ",
    instanceId: "वह इंस्टेंस ID जिसका कनेक्शन हुआ",
    status: 'Connected',
    whatsappStatus: { message: "Connected" }
};