Dokumentasyon

JavaScript API

Mga global na method na magagamit pagkatapos ma-load ang script ng widget.

Respondo.init(config)

Ini-initialize at ini-mount ang widget. Kailangang tawagin nang isang beses. Ibinabalik nito ang instance ng widget.

const widget = Respondo.init({
  agentId: 'YOUR_AGENT_ID'
});

Respondo.identify(identity)

Ikinakabit ang pagkakakilanlan ng user sa kasalukuyang sesyon. Tawagin ito pagkatapos mag-log in. Kapag may email o userId, agad nitong ginagawa ang contact, kahit hindi kailanman buksan ng user ang chat. signedUpAt (Date, Unix seconds o ISO 8601 string) ang oras ng pag-sign up ng user sa iyong produkto; kung wala ito, mananatiling blangko ang petsa ng pag-sign up ng contact.

Respondo.identify({
  email: 'user@example.com',
  name: 'John Doe',
  userId: 'usr_123',
  signedUpAt: '2024-05-31T10:00:00Z',
  userHash: 'hmac_sha256_signature', // opsyonal, para sa pagpapatunay ng pagkakakilanlan
  metadata: { plan: 'pro' },
  properties: {                      // custom na katangian ng contact
    account_type: 'enterprise',      // mga key na nakatakda sa Mga Setting ng Ahente
    region: 'eu-west'
  }
});

Respondo.track(name, properties?)

Nagtatala ng client-side na event para sa kasalukuyang bisita (hal. pagbili, pag-upgrade ng plano). Puwedeng magpasimula ang mga event ng mga Tour na naka-trigger sa event at mabilang sa mga layunin ng tour. Best-effort ang paghahatid gamit ang keepalive, kaya nakakarating pa rin ang mga event na pinaputok bago mag-navigate (redirect sa checkout). Tawagin pagkatapos ng init().

Binubuksan din ng mga event ang mga pop-up survey na naghihintay sa kanila (When and where): agad sa tumutugmang page, o pagdating sa ganoong page sa loob ng 30 minuto, halimbawa pagkatapos ng redirect.

Respondo.track('purchase_completed', {
  plan: 'pro',
  amount: 49
});

Respondo.startSurvey(surveyId)

Binubuksan ngayon ang isang live na pop-up survey, sa kahit anong page, nang hindi tinitingnan ang Show on, mga page rule, oras sa page, trigger event at audience. Kopyahin ang id sa survey editor (Additional ways to share). Hindi na muling ipinapakita ang survey na nasagot na ng bisita. Puwedeng tawagin bago matapos mag-load ang widget.

Respondo.startSurvey('<survey-id>');

Respondo.open(message?) / Respondo.close()

Binubuksan o isinasara ang messenger mula sa sarili ninyong mga button. Magpasa ng string sa open para magsimula nang may laman na ang message field. Tawagin pagkatapos ng Respondo.init(); ang call na ginawa habang lumilitaw pa ang launcher ay ilalapat sa sandaling lumitaw ito.

Respondo.open();
Respondo.open('I have a question about my invoice');
Respondo.close();

Respondo.destroy()

Inaalis ang widget sa pahina. Kapaki-pakinabang sa mga SPA kapag lumilipat sa mga pahinang hindi dapat lumitaw ang widget. Hindi nito binubura ang identity ng bisita o ang nakaimbak na usapan — para sa pag-log out, gamitin ang Respondo.reset().

// Alisin ang widget sa pahina
Respondo.destroy();

// I-initialize muli mamaya kung kailangan (ipinagpapatuloy ang parehong usapan)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });

Respondo.reset()

Pag-log out / paglilipat sa shared na device. Binubura nito ang anonymous na visitor id, ang nakaimbak na usapan, at ang session token sa browser, pinapawalang-bisa ang session token sa panig ng server para hindi na gumana ang mga kopya nito, at muling nagmo-mount ng sariwang anonymous na widget. Tawagin ito mula sa logout hook ng app ninyo.

// Kapag nag-log out — burahin ang identity, usapan at session, magsimulang muli
Respondo.reset();

Awtomatikong pagkolekta ng datos

Awtomatikong kinukuha at iniimbak ng widget ang sumusunod sa bawat usapan:

DatosPinagmulan
IP ng kliyenteMga HTTP header
Browser / OSHeader na User-Agent
WikaHeader na Accept-Language
Time zoneIntl API (JavaScript)
URL ng pahinawindow.location
ReferrerHeader na Referer