Nyaraka

JavaScript API

Mbinu za jumla (global) zinazopatikana baada ya kupakia skripti ya wijeti.

Respondo.init(config)

Huanzisha na kupachika wijeti. Lazima iitwe mara moja. Hurejesha nakala ya wijeti (instance).

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

Respondo.identify(identity)

Huambatisha utambulisho wa mtumiaji kwenye kipindi cha sasa. Iite baada ya kuingia. Ikiwa na barua pepe au userId, huunda mwasiliani mara moja, hata kama mtumiaji hajawahi kufungua gumzo. signedUpAt (Date, sekunde za Unix au mfuatano wa ISO 8601) ni wakati mtumiaji alijisajili kwenye bidhaa yako; bila hiyo, tarehe ya usajili ya mwasiliani hubaki tupu.

Respondo.identify({
  email: 'user@example.com',
  name: 'John Doe',
  userId: 'usr_123',
  signedUpAt: '2024-05-31T10:00:00Z',
  userHash: 'hmac_sha256_signature', // si lazima, kwa uthibitisho wa utambulisho
  metadata: { plan: 'pro' },
  properties: {                      // sifa maalum za mawasiliano
    account_type: 'enterprise',      // funguo hufafanuliwa katika Agent Settings
    region: 'eu-west'
  }
});

Respondo.track(name, properties?)

Hurekodi tukio la upande wa mteja kwa mgeni wa sasa (k.m. ununuzi, kupandisha mpango). Matukio yanaweza kuanzisha Ziara zinazochochewa na matukio na kuhesabika katika malengo ya ziara. Uwasilishaji wa kadri ya uwezo kwa keepalive, hivyo matukio yaliyotumwa kabla tu ya kuondoka ukurasani (uelekezaji wa checkout) bado hufika. Ita baada ya init().

Matukio pia hufungua tafiti ibukizi zinazoyasubiri (When and where): mara moja kwenye ukurasa unaolingana, au unapofika kwenye ukurasa kama huo ndani ya dakika 30, kwa mfano baada ya kuelekezwa upya.

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

Respondo.startSurvey(surveyId)

Hufungua sasa utafiti ibukizi ulio hai, kwenye ukurasa wowote, bila kuzingatia Show on, sheria za kurasa, muda kwenye ukurasa, tukio linaloanzisha na hadhira. Nakili kitambulisho kwenye kihariri cha utafiti (Additional ways to share). Utafiti ambao mgeni ameshaujibu hauonyeshwi tena. Unaweza kuitwa kabla wijeti haijamaliza kupakia.

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

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

Hufungua au hufunga dirisha la ujumbe kutoka kwa vitufe vyako mwenyewe. Pitisha mfuatano kwa open ili kuanza na sehemu ya ujumbe ikiwa imejazwa tayari. Iite baada ya Respondo.init(); mwito unaofanywa wakati kitufe cha kuzindua bado kinajitokeza hutekelezwa mara tu kinapoonekana.

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

Respondo.destroy()

Huondoa wijeti kwenye ukurasa. Inafaa kwa SPA unapoelekea kurasa ambazo wijeti haipaswi kuonekana. Haifuti utambulisho wa mgeni wala mazungumzo yaliyohifadhiwa — kwa kutoka kwenye akaunti, tumia Respondo.reset().

// Ondoa wijeti kwenye ukurasa
Respondo.destroy();

// Anzisha upya baadaye ikihitajika (huendeleza mazungumzo yale yale)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });

Respondo.reset()

Kutoka kwenye akaunti / makabidhiano ya kifaa cha pamoja. Hufuta kitambulisho cha mgeni asiyejulikana, mazungumzo yaliyohifadhiwa, na tokeni ya kipindi kutoka kwenye kivinjari, hutengua tokeni ya kipindi upande wa seva ili nakala zake ziache kufanya kazi, na hupachika upya wijeti mpya isiyojulikana. Iite kutoka hatua ya kutoka (logout) ya programu yako.

// Wakati wa kutoka — futa utambulisho, mazungumzo na kipindi, anza upya
Respondo.reset();

Ukusanyaji wa data kiotomatiki

Wijeti hunasa na kuhifadhi kiotomatiki yafuatayo kwa kila mazungumzo:

DataChanzo
IP ya mtejaVichwa vya HTTP
Kivinjari / OSKichwa cha User-Agent
LughaKichwa cha Accept-Language
Saa za eneoIntl API (JavaScript)
URL ya ukurasawindow.location
ReferrerKichwa cha Referer