เอกสารประกอบ

JavaScript API

เมธอดส่วนกลางที่ใช้ได้หลังจากโหลดสคริปต์วิดเจ็ต

Respondo.init(config)#

เริ่มต้นและติดตั้งวิดเจ็ต ต้องเรียกหนึ่งครั้ง คืนค่าอินสแตนซ์ของวิดเจ็ต

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

Respondo.identify(identity)#

แนบตัวตนผู้ใช้เข้ากับเซสชันปัจจุบัน เรียกหลังจากล็อกอิน

Respondo.identify({
  email: 'user@example.com',
  name: 'John Doe',
  userId: 'usr_123',
  userHash: 'hmac_sha256_signature', // ทางเลือก สำหรับการยืนยันตัวตน
  metadata: { plan: 'pro' },
  properties: {                      // คุณสมบัติของผู้ติดต่อแบบกำหนดเอง
    account_type: 'enterprise',      // คีย์ที่กำหนดใน Agent Settings
    region: 'eu-west'
  }
});

Respondo.track(name, properties?)#

บันทึกอีเวนต์ฝั่งไคลเอนต์สำหรับผู้เยี่ยมชมปัจจุบัน (เช่น การซื้อ การอัปเกรดแพ็กเกจ) อีเวนต์สามารถเริ่ม Tour แบบ event-triggered และนับเข้าเป้าหมายของ tour ได้ การส่งเป็นแบบ best-effort ด้วย keepalive ดังนั้นอีเวนต์ที่ยิงก่อนการนำทางพอดี (เช่น redirect ไป checkout) ก็ยังไปถึง เรียกหลังจาก init()

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

Respondo.destroy()#

ลบวิดเจ็ตออกจากหน้าเว็บ มีประโยชน์สำหรับ SPA เมื่อนำทางไปยังหน้าที่ไม่ควรแสดง วิดเจ็ต มันไม่ล้างตัวตนของผู้เยี่ยมชมหรือบทสนทนาที่จัดเก็บไว้ — สำหรับการล็อกเอาต์ ให้ใช้ Respondo.reset()

// ลบวิดเจ็ตออกจากหน้าเว็บ
Respondo.destroy();

// เริ่มต้นใหม่ในภายหลังหากจำเป็น (กลับสู่บทสนทนาเดิม)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });

Respondo.reset()#

สำหรับการล็อกเอาต์ / การส่งต่ออุปกรณ์ที่ใช้ร่วมกัน ล้าง visitor id นิรนาม บทสนทนาที่จัดเก็บไว้ และ session token ออกจากเบราว์เซอร์ เพิกถอน session token ฝั่งเซิร์ฟเวอร์เพื่อให้สำเนาของมันใช้ไม่ได้อีก แล้ว mount วิดเจ็ตนิรนามใหม่ เรียกจาก hook ล็อกเอาต์ของแอปคุณ

// เมื่อล็อกเอาต์ — ล้างตัวตน บทสนทนา และเซสชัน แล้วเริ่มใหม่
Respondo.reset();

การเก็บข้อมูลอัตโนมัติ

วิดเจ็ตจะเก็บและจัดเก็บข้อมูลต่อไปนี้โดยอัตโนมัติในแต่ละบทสนทนา:

ข้อมูลแหล่งที่มา
Client IPHTTP headers
เบราว์เซอร์ / OSUser-Agent header
ภาษาAccept-Language header
เขตเวลาIntl API (JavaScript)
Page URLwindow.location
ReferrerReferer header