ตรวจสอบ
API Endpoint
POST https://otp.api.engagelab.cc/v1/verifications
การตรวจสอบสิทธิ์
ใช้ HTTP Basic Authentication โดยเพิ่ม Authorization ใน HTTP Header:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
โค้ดนี้โชว์เป็นหน้าต่างลอย
อัลกอริทึมการสร้าง base64_auth_string ด้านบนคือ: base64(dev_key:dev_secret)
ตัวอย่างคำขอ
Header ของคำขอ
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
โค้ดนี้โชว์เป็นหน้าต่างลอย
เนื้อหาคำขอ
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
พารามิเตอร์ของคำขอ
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| message_id | String | จำเป็น | รหัสข้อความที่สอดคล้องกับรหัสยืนยัน ซึ่งส่งคืนโดย API /messages |
| verify_code | String | จำเป็น | รหัสยืนยันที่ต้องการตรวจสอบ |
พารามิเตอร์ของการตอบกลับ
การตอบกลับสำเร็จ
| ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| message_id | String | จำเป็น | รหัสข้อความที่สอดคล้องกับรหัสยืนยัน ซึ่งส่งคืนโดย API /v1/messages |
| verify_code | String | จำเป็น | รหัสยืนยันที่ต้องการตรวจสอบ |
| verified | Boolean | จำเป็น | ผลการตรวจสอบ, true หมายถึงการตรวจสอบสำเร็จ, false หมายถึงการตรวจสอบล้มเหลว |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
หมายเหตุ: สำหรับคำขอตรวจสอบรหัสยืนยันข้อความเดียวกัน หากการตรวจสอบรหัสยืนยันสำเร็จ คำขอในภายหลังที่ใช้ API การตรวจสอบนี้จะล้มเหลว โดยระบุว่ารหัสยืนยันสำหรับข้อความนี้ได้รับการตรวจสอบแล้ว; ไม่รองรับการตรวจสอบซ้ำของรหัสที่ตรวจสอบสำเร็จแล้ว
การตอบกลับล้มเหลว
รหัสสถานะ HTTP จะเป็น 4xx หรือ 5xx และเนื้อหาการตอบกลับจะมีฟิลด์ดังต่อไปนี้:
| ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| code | int | จำเป็น | รหัสข้อผิดพลาด, ดูรายละเอียดใน Error Codes |
| message | String | จำเป็น | รายละเอียดข้อผิดพลาด |
{
"code": 3003,
"message": "verify code has expired"
}
{
"code": 3003,
"message": "verify code has expired"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
รหัสข้อผิดพลาด
| รหัสข้อผิดพลาด | รหัส HTTP | คำอธิบาย |
|---|---|---|
| 1000 | 500 | ข้อผิดพลาดภายใน |
| 2001 | 401 | การตรวจสอบสิทธิ์ล้มเหลว, โทเค็นที่ให้มาไม่ถูกต้อง |
| 2002 | 401 | การตรวจสอบสิทธิ์ล้มเหลว, โทเค็นหมดอายุหรือถูกปิดใช้งาน |
| 2004 | 403 | ไม่มีสิทธิ์ในการเรียกใช้ API นี้ |
| 3001 | 400 | รูปแบบพารามิเตอร์คำขอไม่ถูกต้อง, ตรวจสอบว่าเนื้อหา JSON ตรงตามข้อกำหนดของรูปแบบพารามิเตอร์หรือไม่ |
| 3002 | 400 | พารามิเตอร์คำขอไม่ถูกต้อง, ตรวจสอบว่าพารามิเตอร์คำขอตรงตามข้อกำหนดหรือไม่ |
| 3003 | 400 | รหัสยืนยันหมดอายุหรือได้รับการตรวจสอบแล้ว, จำเป็นต้องส่งข้อความรหัสยืนยันใหม่สำหรับรหัสข้อผิดพลาดนี้ |
| 4001 | 400 | ข้อความไม่พบ |
