เมื่อใช้ Public API ของ Lumo คุณสามารถเข้าถึงข้อมูลของ Lumo จากระบบหรือเครื่องมือของคุณเอง และนำไปใช้ร่วมกับกลไกเฉพาะของคุณได้ บทความนี้จะอธิบายภาพรวมของ Public API และขั้นตอนจนถึงการเริ่มใช้งาน รายละเอียดข้อกำหนดสำหรับการนำไปใช้งานสามารถตรวจสอบได้ที่ "เอกสาร API" ภายใน Lumo
Public API คืออะไร
Public API คือกลไกสำหรับการดึงข้อมูลของ Lumo จากระบบหรือแอปพลิเคชันภายนอกด้วยโปรแกรม
คุณสามารถเรียกใช้ข้อมูลของ Lumo จากระบบของคุณเองได้โดยไม่ต้องใช้หน้าจอเว็บของ Lumo และนำข้อมูลที่สะสมไว้มาใช้ร่วมกับแพลตฟอร์มการวิเคราะห์หรือเครื่องมือของคุณ เพื่อช่วยให้การทำงานเป็นอัตโนมัติและมีประสิทธิภาพยิ่งขึ้น
เป็นฟังก์ชันสำหรับวิศวกร การใช้งานจำเป็นต้องมีความรู้ในการพัฒนาระบบด้วย API
สิ่งที่ทำได้ด้วย API
Public API สามารถดึงประวัติแชท ผลการส่ง และข้อมูลลูกค้า รวมถึงส่งข้อความ LINE และเชื่อมโยง ID ได้
| สิ่งที่ทำได้ | เนื้อหา |
|---|---|
| การดึงประวัติแชท | ดึงประวัติแชทที่สนทนากับลูกค้าผ่าน LINE Official Account โดยระบุช่วงเวลา |
| การดึงผลการส่ง | ดึงรายการและรายละเอียดของการส่งข้อความ สถิติต่าง ๆ เช่น การเปิดและการคลิก และรายละเอียดแยกตามผู้รับ |
| การค้นหาข้อมูลลูกค้า | ค้นหาข้อมูลลูกค้าใน Lumo จาก LINE User ID พร้อมกับช่องทางที่เพื่อนเข้ามา (ครั้งแรกและล่าสุด) |
| การส่งข้อความ | ส่งข้อความ LINE ไปยังเพื่อนที่ระบุ โดยใช้เทมเพลตของการส่งอัตโนมัติ และระบุหมายเลขโทรศัพท์เพื่อส่งข้อความแจ้งเตือน LINE ถึงผู้ที่ไม่ได้เป็นเพื่อนได้ด้วย |
| การเชื่อมโยง ID | เชื่อมเพื่อนใน LINE เข้ากับข้อมูลสมาชิก (ผู้ติดต่อ HubSpot) โดยเริ่มจาก LINE Login บนเว็บไซต์ของคุณ (เมื่อเชื่อมต่อ HubSpot) |
คุณสามารถดึงเฉพาะข้อมูลที่ต้องการได้โดยระบุ LINE Official Account ที่ต้องการ รวมถึงช่วงเวลาและจำนวนรายการที่จะดึง คุณนำผลการส่งเข้าสู่แพลตฟอร์มวิเคราะห์ข้อมูลของคุณเอง หรือส่งข้อความ LINE โดยใช้เหตุการณ์ในระบบของคุณเองเป็นตัวกระตุ้นก็ได้ ฟังก์ชันที่ใช้ได้จะเพิ่มขึ้นเรื่อย ๆ ต่อจากนี้
การเชื่อมโยง ID ใช้ได้เมื่อคุณติดตั้ง LINE Login ไว้บนเว็บไซต์สมาชิกของคุณ เมื่อส่งแอ็กเซสโทเค็นที่ได้ตอนเข้าสู่ระบบมาให้ Lumo เพื่อนใน LINE ของลูกค้าคนนั้นจะเชื่อมกับข้อมูลสมาชิกที่จับคู่ด้วยคุณสมบัติผู้ติดต่อ HubSpot ที่ระบุไว้ คุณจึงเริ่มการติดตามผลทาง LINE โดยเริ่มจากการสมัครสมาชิกได้ โดยไม่ต้องพัฒนาหน้าจอเพิ่ม ใช้ได้กับ LINE Official Account ที่เชื่อมต่อ HubSpot แล้ว
รายการล่าสุดของฟังก์ชันที่ใช้ได้และรายละเอียดข้อกำหนด สามารถตรวจสอบได้ที่ "เอกสาร API" ภายใน Lumo
ส่งข้อความแจ้งเตือน LINE ไปยังหมายเลขโทรศัพท์
ในการส่งข้อความ หากระบุหมายเลขโทรศัพท์ (phoneNumber) แทน LINE User ID ของเพื่อน (to) คุณจะส่งข้อความแจ้งเตือน LINE ถึงผู้ที่ไม่ได้เป็นเพื่อนได้ LINE Official Account ต้องได้รับอนุมัติให้ใช้ข้อความแจ้งเตือน LINE แล้ว
| รายการ | เนื้อหา |
|---|---|
phoneNumber |
หมายเลขโทรศัพท์ปลายทาง ใช้แทน to ระบุเฉพาะหมายเลขที่ลูกค้าให้ไว้ว่าเป็นหมายเลขของตนเอง ระบบจะแฮชหมายเลขเมื่อรับคำขอ และไม่จัดเก็บ |
phoneCountryCode |
รหัสประเทศเมื่อหมายเลขโทรศัพท์ไม่อยู่ในรูปแบบสากล ระบุเป็นตัวเลข 1 ถึง 4 หลัก (เช่น 81) หากไม่ระบุ ระบบจะอ่านเป็นหมายเลขของประเทศของ LINE Official Account |
externalId |
ID ของบุคคลนั้นในระบบของคุณเอง ระบุพร้อมกับ externalIdSource |
externalIdSource |
ชื่อของประเภท ID ที่ externalId สังกัด (เช่น membership) ระบุพร้อมกับ externalId |
กฎการส่ง
การตอบกลับว่ารับคำขอแล้วหมายถึงการส่งเข้าคิวแล้ว และไม่ได้บอกว่าการแจ้งเตือนส่งถึงหรือไม่
- LINE จะส่งการแจ้งเตือนถึงผู้ที่ลงทะเบียนหมายเลขโทรศัพท์นั้นไว้ใน LINE โดย Lumo ไม่สามารถตรวจสอบได้ว่าเป็นหมายเลขของบุคคลนั้นจริงหรือไม่
- หากหมายเลขไม่ได้ลงทะเบียนใน LINE หรือ LINE ปฏิเสธการส่ง การแจ้งเตือนจะไม่ถึง และการตอบกลับจะไม่รายงานผลนั้น
- ข้อความอัตโนมัติที่มีข้อความแจ้งเตือน LINE ตั้งแต่ 2 ข้อความขึ้นไปส่งไม่ได้
- ความเร็วในการส่งคือประมาณ 4 ข้อความต่อวินาทีต่อ LINE Official Account และใช้โควตาร่วมกับการส่งข้อความแจ้งเตือน LINE อื่น ๆ ของบัญชีเดียวกัน ส่วนที่เกินจะรอแล้วลองส่งใหม่ แต่คำขอที่ยังส่งไม่ได้หลังผ่านไปหลายสิบนาทีจะไม่ถูกส่ง หากส่งจำนวนมาก ให้กระจายเวลาส่ง
- หากส่งข้อความอัตโนมัติเดียวกันไปยังหมายเลขโทรศัพท์เดียวกันตั้งแต่ 2 ครั้งขึ้นไปในวันเดียวกัน บันทึกการส่งจะรวมเป็น 1 รายการ
- แม้ระบุข้อความอัตโนมัติที่อยู่ระหว่างการทดสอบ A/B การส่งไปยังหมายเลขโทรศัพท์จะไม่สุ่มรูปแบบ และจะส่งรายการที่ระบุตามเดิม
เชื่อม ID เมื่อแตะปุ่มของการแจ้งเตือน
เมื่อเปิด "เชื่อมโยง ID เมื่อแตะปุ่ม" ในข้อความอัตโนมัติ ผู้ที่แตะปุ่มของการแจ้งเตือนและผ่านการเข้าสู่ระบบด้วย LINE จะถูกบันทึกเป็นเพื่อนที่เป็นปลายทางของการแจ้งเตือนนั้น หากระบุ externalId และ externalIdSource ไว้ เพื่อนคนนั้นจะถูกเชื่อมกับ ID ของคุณเองด้วย
- เฉพาะคนแรกที่แตะปุ่มภายใน 72 ชั่วโมงหลังส่ง
- เฉพาะการแจ้งเตือนที่ยืนยันได้ว่าส่งถึงแล้ว
- หาก ID นั้นเชื่อมกับเพื่อนคนอื่นอยู่แล้ว หรือเพื่อนเชื่อมกับ ID อื่นของประเภทเดียวกันอยู่แล้ว ระบบจะไม่เปลี่ยนแปลงสิ่งใด
- หากสวิตช์ปิดอยู่ จะไม่มีการเชื่อม ID
ข้อกำหนดโดยละเอียดของแต่ละรายการ ดูได้ที่ "เอกสาร API" ใน Lumo
หากต้องการเริ่มใช้งาน
หากต้องการใช้ Public API ให้ออกคีย์ API ในพื้นที่ทำงานของแผน Enterprise และนำไปใช้งานเพื่อให้ระบบของคุณสามารถเรียกใช้ข้อมูลของ Lumo ได้
Public API ใช้ได้กับแผน Enterprise คีย์ API คือกุญแจที่ Lumo ใช้ยืนยันตัวตนการเข้าถึงจากระบบของคุณ การออกและการจัดการคีย์ API ทำได้ที่ "คีย์ API" ในการตั้งค่าพื้นที่ทำงาน เฉพาะผู้ดูแลของพื้นที่ทำงานเท่านั้นที่ออกและสร้างคีย์ API ใหม่ได้
การออกคีย์ API
ออกคีย์ API ในการตั้งค่าพื้นที่ทำงาน
- เปิด "การตั้งค่าพื้นที่ทำงาน" แล้วเลือก "คีย์ API"
- คลิก "สร้างคีย์ API"
- คัดลอกคีย์ API ที่แสดงแล้วบันทึกไว้ในที่ปลอดภัย
คีย์ API จะแสดงเพียงครั้งเดียวตอนออกคีย์ กรุณาเก็บไว้ในที่ปลอดภัย เนื่องจากไม่สามารถแสดงซ้ำได้หลังปิดหน้าจอ หากทำหาย จะต้องสร้างใหม่
การนำไปใช้ในระบบ
นำคีย์ API ที่ออกแล้วไปใช้งานเพื่อให้ระบบของคุณสามารถเรียกใช้ข้อมูลของ Lumo ได้
ข้อกำหนดที่จำเป็นสำหรับการนำไปใช้งาน เช่น วิธีสร้างคำขอและรูปแบบข้อมูลที่ดึงได้ สามารถตรวจสอบได้จาก "ดูเอกสาร API"
การจัดการคีย์ API
คีย์ API ที่ออกแล้วสามารถตรวจสอบและสร้างใหม่ได้ที่ "คีย์ API" ในการตั้งค่าพื้นที่ทำงาน
| การดำเนินการ | เนื้อหา |
|---|---|
| แสดง | คีย์ที่ออกแล้วจะแสดงแบบปกปิดเพียงไม่กี่อักขระแรก คัดลอกคีย์เต็มได้เฉพาะทันทีหลังออกคีย์เท่านั้น ไม่สามารถแสดงหรือคัดลอกซ้ำภายหลังได้ |
| สร้างใหม่ | ยกเลิกคีย์ API ปัจจุบันและออกคีย์ API ใหม่ |
การสร้างคีย์ API ใหม่
หากทำคีย์ API หาย หรือมีความเป็นไปได้ว่าบุคคลภายนอกล่วงรู้ ให้สร้างคีย์ API ใหม่ เฉพาะผู้ดูแลของพื้นที่ทำงานเท่านั้นที่สร้างใหม่ได้
- เปิด "คีย์ API" ในการตั้งค่าพื้นที่ทำงาน
- คลิก "สร้างใหม่"
- คลิก "สร้างใหม่" ในกล่องโต้ตอบยืนยัน
เมื่อสร้างใหม่ คีย์ API ก่อนหน้าจะถูกยกเลิก และการดำเนินการนี้ไม่สามารถเลิกทำได้ หลังสร้างใหม่ กรุณาตั้งค่าคีย์ API ใหม่ในระบบของคุณอีกครั้ง
เพื่อการใช้งานอย่างปลอดภัย
คีย์ API คือกุญแจที่สามารถเข้าถึงข้อมูลของ Lumo ได้ กรุณาจัดการอย่างเข้มงวดเพื่อไม่ให้บุคคลภายนอกล่วงรู้
- กรุณาอย่าแชร์คีย์ API กับบุคคลภายนอก
- กรุณาอย่าเขียนคีย์ API ลงในซอร์สโค้ดหรือ repository สาธารณะโดยตรง
- หากมีความเป็นไปได้ว่าคีย์ API รั่วไหล กรุณาสร้างใหม่ทันที
- API มีขีดจำกัดจำนวนคำขอต่อช่วงเวลาหนึ่ง หากเกินขีดจำกัด คำขอจะถูกจำกัดชั่วคราว
- ในการส่งข้อความ ใส่เฮดเดอร์
Idempotency-Keyไปกับแต่ละคำขอได้ ต่อให้ส่งซ้ำด้วยคีย์เดียวกันก็จะไม่ถูกส่งซ้ำสองครั้ง จึงส่งใหม่ได้อย่างสบายใจตอนที่การเชื่อมต่อไม่เสถียร
รายละเอียดข้อจำกัดในการใช้งาน เช่น ขีดจำกัดจำนวนคำขอ สามารถตรวจสอบได้ที่ "เอกสาร API" ภายใน Lumo
คำถามที่พบบ่อย
รวบรวมคำถามที่พบบ่อยเกี่ยวกับการใช้ Public API ไว้ที่นี่
ทำคีย์ API หาย
เนื่องจากคีย์ API แสดงเพียงครั้งเดียวตอนออกคีย์ จึงไม่สามารถแสดงซ้ำได้ กรุณาสร้างใหม่จาก "คีย์ API" ในการตั้งค่าพื้นที่ทำงาน หลังสร้างใหม่ คุณจะต้องตั้งค่าคีย์ API ใหม่ในระบบของคุณอีกครั้ง
สามารถดึงข้อมูลแบบใดได้บ้าง
คุณสามารถดึงประวัติแชท ผลการส่งข้อความ (สถิติและรายละเอียดแยกตามผู้รับ) และข้อมูลลูกค้าที่ตรงกับ LINE User ID ได้ ในข้อมูลลูกค้าจะได้ช่องทางที่เพื่อนเข้ามา (ครั้งแรกและล่าสุด) มาด้วย นอกจากนี้ยังส่งข้อความ LINE โดยใช้เทมเพลตของการส่งอัตโนมัติ และเชื่อมโยง ID โดยเริ่มจาก LINE Login ได้ด้วย ฟังก์ชันที่ใช้ได้จะเพิ่มขึ้นเรื่อย ๆ ต่อจากนี้
ใช้งานได้กับแผนใดบ้าง
Public API ใช้ได้กับแผน Enterprise ในแผนอื่น เมื่อกด "สร้างคีย์ API" จะแสดงคำแนะนำให้อัปเกรด และไม่สามารถออกคีย์ได้ การอัปเกรดแผนทำได้จาก "การตั้งค่า" > "การใช้งานและการเรียกเก็บเงิน"
รายละเอียดวิธีการนำไปใช้งานตรวจสอบได้ที่ไหน
จาก "ดูเอกสาร API" ที่อยู่ใน "คีย์ API" ในการตั้งค่าพื้นที่ทำงาน คุณสามารถตรวจสอบข้อกำหนดที่จำเป็นสำหรับการนำไปใช้งาน เช่น วิธีสร้างคำขอและรูปแบบข้อมูลที่ดึงได้