JavaScript API
विजेट स्क्रिप्ट लोड करने के बाद उपलब्ध ग्लोबल मेथड।
Respondo.init(config)
विजेट को इनिशियलाइज़ और माउंट करता है। एक बार कॉल करना ज़रूरी है। विजेट इंस्टेंस लौटाता है।
const widget = Respondo.init({
agentId: 'YOUR_AGENT_ID'
});Respondo.identify(identity)
मौजूदा सेशन से यूज़र पहचान जोड़ता है। लॉगिन के बाद कॉल करें। ईमेल या userId के साथ यह कॉन्टैक्ट तुरंत बना देता है, भले ही यूज़र कभी चैट न खोले। signedUpAt (Date, Unix सेकंड या ISO 8601 स्ट्रिंग) वह समय है जब यूज़र ने आपके प्रोडक्ट में साइन अप किया; इसके बिना कॉन्टैक्ट की साइन-अप तारीख खाली रहती है।
Respondo.identify({
email: 'user@example.com',
name: 'John Doe',
userId: 'usr_123',
signedUpAt: '2024-05-31T10:00:00Z',
userHash: 'hmac_sha256_signature', // वैकल्पिक, पहचान सत्यापन के लिए
metadata: { plan: 'pro' },
properties: { // कस्टम कॉन्टैक्ट प्रॉपर्टीज़
account_type: 'enterprise', // Agent Settings में परिभाषित कीज़
region: 'eu-west'
}
});Respondo.track(name, properties?)
मौजूदा विज़िटर के लिए एक क्लाइंट-साइड इवेंट रिकॉर्ड करता है (उदा. ख़रीद, प्लान अपग्रेड)। इवेंट इवेंट-ट्रिगर वाले Tours शुरू कर सकते हैं और टूर लक्ष्यों में गिने जाते हैं। keepalive के साथ बेस्ट-एफ़र्ट डिलीवरी, इसलिए नेविगेशन से ठीक पहले (चेकआउट रीडायरेक्ट) भेजे गए इवेंट भी पहुँच जाते हैं। init() के बाद कॉल करें।
इवेंट उन पॉप-अप सर्वे को भी खोलते हैं जो उनका इंतज़ार करते हैं (When and where): मेल खाते पेज पर तुरंत, या 30 मिनट के भीतर ऐसे पेज पर पहुँचने पर — जैसे रीडायरेक्ट के बाद।
Respondo.track('purchase_completed', {
plan: 'pro',
amount: 49
});Respondo.startSurvey(surveyId)
किसी भी पेज पर एक सक्रिय पॉप-अप सर्वे अभी खोलता है, और Show on, पेज नियम, पेज पर बिताया समय, ट्रिगर इवेंट और ऑडियंस को छोड़ देता है। आईडी सर्वे एडिटर से कॉपी करें (Additional ways to share)। जिस सर्वे का विज़िटर जवाब दे चुका है, वह दोबारा नहीं दिखता। विजेट के लोड होने से पहले भी कॉल किया जा सकता है।
Respondo.startSurvey('<survey-id>');Respondo.open(message?) / Respondo.close()
आपके अपने बटनों से मैसेंजर खोलता या बंद करता है। open को कोई स्ट्रिंग दें ताकि मैसेज फ़ील्ड पहले से भरा हुआ खुले। Respondo.init() के बाद कॉल करें; लॉन्चर के दिखते-दिखते की गई कॉल उसके दिखते ही लागू हो जाती है।
Respondo.open();
Respondo.open('I have a question about my invoice');
Respondo.close();Respondo.destroy()
विजेट को पेज से हटाता है। SPA के लिए उपयोगी, जब ऐसे पेजों पर नेविगेट किया जाए जहाँ विजेट नहीं दिखना चाहिए। यह विज़िटर की पहचान या स्टोर की गई बातचीत को साफ़ नहीं करता — लॉगआउट के लिए Respondo.reset() का उपयोग करें।
// विजेट को पेज से हटाएँ
Respondo.destroy();
// ज़रूरत पड़ने पर बाद में फिर से इनिशियलाइज़ करें (वही बातचीत फिर से शुरू होती है)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });Respondo.reset()
लॉगआउट / साझा-डिवाइस हैंडऑफ़। ब्राउज़र से एनॉनिमस विज़िटर id, स्टोर की गई बातचीत और सेशन टोकन साफ़ करता है, सेशन टोकन को सर्वर-साइड रद्द कर देता है ताकि उसकी कॉपियाँ काम करना बंद कर दें, और एक ताज़ा एनॉनिमस विजेट फिर से माउंट करता है। इसे अपने ऐप के लॉगआउट हुक से कॉल करें।
// लॉगआउट पर — पहचान, बातचीत और सेशन मिटाएँ, नई शुरुआत करें
Respondo.reset();स्वचालित डेटा संग्रह
विजेट प्रत्येक बातचीत के साथ निम्नलिखित को अपने आप कैप्चर और स्टोर करता है:
| डेटा | स्रोत |
|---|---|
| क्लाइंट IP | HTTP हेडर |
| ब्राउज़र / OS | User-Agent हेडर |
| भाषा | Accept-Language हेडर |
| टाइमज़ोन | Intl API (JavaScript) |
| पेज URL | window.location |
| रेफ़रर | Referer हेडर |