รายงานผลการตรวจสอบ
หลังจาก EngageLab ส่งรหัส OTP แล้ว หากคุณตรวจสอบเสร็จในระบบของคุณเอง คุณสามารถเรียก API นี้เพื่อรายงานผลการตรวจสอบที่สำเร็จสำหรับสถิติ backfill
API นี้ฟรี และรับเฉพาะผลการตรวจสอบที่สำเร็จ
ที่อยู่สำหรับเรียกใช้
POST https://otp.api.engagelab.cc/v1/backfill
การยืนยันตัวตนในการเรียกใช้
โปรดดู การยืนยันตัวตนในการเรียกใช้ เพื่อเรียนรู้วิธีการยืนยันตัวตน API
โปรดใช้ API Key ที่กำหนดค่าไว้สำหรับแอปพลิเคชันที่ส่งข้อความนั้น และตรวจสอบว่า API Key มีสิทธิ์การตรวจสอบ (verify)
ตัวอย่างคำขอ
Header ของคำขอ
POST /v1/backfill HTTP/1.1
Content-Type: application/json
Authorization: Basic ${base64_auth_string}
เนื้อหาคำขอ
{
"message_id": "1725407449772531712",
"verified_at": 1793116800
}
พารามิเตอร์ของคำขอ
เนื้อหาคำขอใช้รูปแบบ JSON โปรดตั้งค่าส่วนหัว Content-Type: application/json
| พารามิเตอร์ | ประเภท | ตัวเลือก | คำอธิบาย |
|---|---|---|---|
| message_id | String | จำเป็น | รหัสข้อความของรหัส OTP ซึ่งส่งกลับจาก API การส่ง |
| verified_at | Integer | จำเป็น | เวลาที่ตรวจสอบสำเร็จ เป็น Unix timestamp หน่วยเป็นวินาที |
พารามิเตอร์การตอบกลับ
การตอบกลับเมื่อสำเร็จ
รหัสสถานะ HTTP 200 หมายความว่าแพลตฟอร์มได้บันทึกผลการตรวจสอบที่สำเร็จในครั้งนี้แล้ว
| ฟิลด์ | ประเภท | ตัวเลือก | คำอธิบาย |
|---|---|---|---|
| code | Integer | จำเป็น | เป็น 0 เมื่อสำเร็จ |
| message | String | จำเป็น | คำอธิบายผลลัพธ์ เมื่อสำเร็จจะเป็น success |
{
"code": 0,
"message": "success"
}
การตอบกลับเมื่อล้มเหลว
รหัสสถานะ HTTP เป็น 4xx หรือ 5xx และเนื้อหาการตอบกลับมีรหัสข้อผิดพลาดพร้อมคำอธิบายข้อผิดพลาด ตัวอย่างเช่น เมื่อข้อความตรวจสอบสำเร็จแล้ว API จะส่งกลับ HTTP 400:
| ฟิลด์ | ประเภท | ตัวเลือก | คำอธิบาย |
|---|---|---|---|
| code | Integer | จำเป็น | รหัสข้อผิดพลาด ดูคำอธิบายรหัสข้อผิดพลาดด้านล่าง |
| message | String | จำเป็น | คำอธิบายข้อผิดพลาด |
{
"code": 3012,
"message": "verify code has already validated"
}
รหัสข้อผิดพลาด
| รหัสข้อผิดพลาด | http code | คำอธิบาย |
|---|---|---|
| 1000 | 500 | ข้อผิดพลาดภายในบริการ โปรดลองอีกครั้งในภายหลัง |
| 2001 | 401 | ข้อมูลการยืนยันตัวตนขาดหายไปหรือไม่ถูกต้อง |
| 2002 | 401 | API Key หมดอายุหรือถูกปิดใช้งาน |
| 2002 | 403 | แอปพลิเคชันปัจจุบันไม่พร้อมใช้งาน |
| 2004 | 403 | API Key ไม่มีสิทธิ์เรียก API นี้ |
| 3001 | 400 | JSON ของคำขอไม่ถูกต้อง หรือชนิดของพารามิเตอร์ไม่ถูกต้อง |
| 3002 | 400 | ค่าพารามิเตอร์ไม่ถูกต้อง เวลาอยู่นอกช่วงที่อนุญาต หรือข้อความไม่รองรับ backfill |
| 3012 | 400 | ข้อความตรวจสอบสำเร็จแล้ว ไม่จำเป็นต้องรายงานซ้ำ |
| 4001 | 400 | ไม่พบข้อความ หรือข้อความไม่ได้เป็นของแอปพลิเคชันปัจจุบัน |
โปรดจัดการข้อผิดพลาดตาม code ส่วน message ใช้อธิบายสาเหตุที่เฉพาะเจาะจง
ข้อควรทราบ
- รองรับเฉพาะข้อความรหัส OTP ที่ส่งสำเร็จ ข้อความที่เคยตรวจสอบไม่ผ่านหรือหมดเวลาบนแพลตฟอร์ม ยังสามารถรายงานผลการตรวจสอบที่คุณตรวจสอบสำเร็จเองได้
- การรายงานครั้งแรกต้องทำให้เสร็จภายในไม่ถึง 30 วันหลังจากส่งข้อความเดิม โดยยึดตามเวลาที่แพลตฟอร์มได้รับคำขอ
- เวลาที่ตรวจสอบสำเร็จต้องไม่เร็วกว่าเวลาที่ส่งข้อความเดิม และต้องไม่ช้ากว่าเวลาที่แพลตฟอร์มได้รับคำขอนี้
- หลังจากข้อความถูกบันทึกว่าตรวจสอบสำเร็จผ่าน API นี้หรือ API การตรวจสอบรหัส OTP แล้ว การรายงานหรือการตรวจสอบซ้ำจะส่งกลับ
3012
เมื่อ backfill สำเร็จ แพลตฟอร์มจะพุชสถานะข้อความที่เกี่ยวข้องตาม การตั้งค่าการเรียกกลับ ของแอปพลิเคชัน
