การตรวจสอบรหัส OTP
ที่อยู่สำหรับเรียกใช้
POST https://otp.api.engagelab.cc/v1/verifications
การยืนยันตัวตนในการเรียกใช้
โปรดดู การยืนยันตัวตนในการเรียกใช้ เพื่อเรียนรู้วิธีการยืนยันตัวตน API
ตัวอย่างคำขอ
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 | จำเป็น | message id ที่ตรงกับรหัส OTP ซึ่งส่งกลับมาจากอินเทอร์เฟซ /messages |
| verify_code | String | จำเป็น | รหัส OTP ที่ต้องการตรวจสอบ |
พารามิเตอร์การตอบกลับ
การตอบกลับเมื่อสำเร็จ
| ฟิลด์ | ประเภท | ตัวเลือก | คำอธิบาย |
|---|---|---|---|
| message_id | String | จำเป็น | message id ที่ตรงกับรหัส OTP ซึ่งส่งกลับมาจากอินเทอร์เฟซ /v1/messages |
| verify_code | String | จำเป็น | รหัส OTP ที่ต้องการตรวจสอบ |
| verified | Boolean | จำเป็น | ผลการตรวจสอบ true หมายถึงตรวจสอบสำเร็จ false หมายถึงตรวจสอบล้มเหลว |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
โปรดทราบว่าสำหรับคำขอตรวจสอบรหัส OTP ของข้อความเดียวกัน หากตรวจสอบรหัส OTP สำเร็จแล้ว เมื่อเรียกอินเทอร์เฟซตรวจสอบนี้อีกครั้ง อินเทอร์เฟซจะส่งกลับผลล้มเหลว พร้อมข้อความแจ้งว่ารหัสตรวจสอบของข้อความนี้ได้ทำการตรวจสอบเสร็จสิ้นแล้ว กล่าวคือไม่รองรับการตรวจสอบรหัส OTP ที่ตรวจสอบสำเร็จแล้วซ้ำอีกครั้ง
การตอบกลับเมื่อล้มเหลว
http status code เป็น 4xx หรือ 5xx เนื้อหาการตอบกลับมีฟิลด์ดังนี้:
| ฟิลด์ | ประเภท | ตัวเลือก | คำอธิบาย |
|---|---|---|---|
| code | int | จำเป็น | รหัสข้อผิดพลาด ดูรายละเอียดได้ที่คำอธิบายรหัสข้อผิดพลาด |
| message | String | จำเป็น | รายละเอียดข้อผิดพลาด |
{
"code": 3003,
"message": "verify code has expired"
}
{
"code": 3003,
"message": "verify code has expired"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
รหัสข้อผิดพลาด
| รหัสข้อผิดพลาด | http code | คำอธิบาย |
|---|---|---|
| 1000 | 500 | ข้อผิดพลาดภายใน |
| 2001 | 401 | การยืนยันตัวตนล้มเหลว ไม่ได้แนบ token ที่ถูกต้อง |
| 2002 | 401 | การยืนยันตัวตนล้มเหลว token หมดอายุหรือถูกปิดใช้งานแล้ว |
| 2004 | 403 | ไม่มีสิทธิ์เรียกใช้ API นี้ |
| 3001 | 400 | รูปแบบพารามิเตอร์ของคำขอไม่ถูกต้อง โปรดตรวจสอบว่าเนื้อหา JSON เป็นไปตามรูปแบบพารามิเตอร์หรือไม่ |
| 3002 | 400 | พารามิเตอร์ของคำขอไม่ถูกต้อง โปรดตรวจสอบว่าพารามิเตอร์ของคำขอเป็นไปตามข้อกำหนดหรือไม่ |
| 3003 | 400 | รหัส OTP หมดอายุหรือถูกตรวจสอบแล้ว สำหรับการตอบกลับด้วยรหัสข้อผิดพลาดนี้ จำเป็นต้องส่งข้อความรหัส OTP ใหม่อีกครั้ง |
| 3011 | 400 | รหัส OTP หมดอายุ |
| 4001 | 400 | ไม่พบข้อความนี้ |
