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', // optional, for identity verification
metadata: { plan: 'pro' },
properties: { // custom contact properties
account_type: 'enterprise', // keys defined in Agent Settings
region: 'eu-west'
}
});Respondo.track(name, properties?)
ప్రస్తుత సందర్శకుడి కోసం క్లయింట్-సైడ్ ఈవెంట్ను నమోదు చేస్తుంది (ఉదా. కొనుగోలు, ప్లాన్ అప్గ్రేడ్). ఈవెంట్లు ఈవెంట్-ట్రిగ్గర్డ్ Tours ను మొదలుపెట్టగలవు, టూర్ గోల్స్ లెక్కలో చేరతాయి. keepalive తో best-effort డెలివరీ — నావిగేషన్కు సరిగ్గా ముందు (చెక్అవుట్ రీడైరెక్ట్) పంపిన ఈవెంట్లు కూడా చేరతాయి. 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() వాడండి.
// Remove widget from the page
Respondo.destroy();
// Reinitialize later if needed (resumes the same conversation)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });Respondo.reset()
లాగ్అవుట్ / షేర్డ్-డివైస్ మార్పిడి కోసం. అనామక visitor id, నిల్వ చేసిన సంభాషణ, సెషన్ టోకెన్లను బ్రౌజర్ నుంచి తొలగిస్తుంది; సెషన్ టోకెన్ను సర్వర్ వైపు రద్దు చేస్తుంది — దాంతో దాని కాపీలు పనిచేయడం ఆగిపోతాయి; ఆపై కొత్త అనామక విడ్జెట్ను మళ్లీ మౌంట్ చేస్తుంది. మీ యాప్ లాగ్అవుట్ హుక్ నుంచి దీన్ని కాల్ చేయండి.
// On logout — wipe identity, conversation and session, start fresh
Respondo.reset();ఆటోమేటిక్ డేటా సేకరణ
ప్రతి సంభాషణతో పాటు కింది సమాచారాన్ని విడ్జెట్ ఆటోమేటిక్గా సేకరించి భద్రపరుస్తుంది:
| డేటా | మూలం |
|---|---|
| క్లయింట్ IP | HTTP హెడర్లు |
| బ్రౌజర్ / OS | User-Agent హెడర్ |
| భాష | Accept-Language హెడర్ |
| టైమ్జోన్ | Intl API (JavaScript) |
| పేజీ URL | window.location |
| రెఫరర్ | Referer హెడర్ |