การตรวจสอบความถูกต้องของ OTP
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)
ตัวอย่างคำขอ
Request 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
โค้ดนี้โชว์เป็นหน้าต่างลอย
Request Body
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
พารามิเตอร์คำขอ
| Parameter | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | ID ของข้อความที่สอดคล้องกับรหัสยืนยัน ซึ่งส่งกลับโดย API /messages |
| verify_code | String | Required | รหัสยืนยันที่ต้องการตรวจสอบความถูกต้อง |
พารามิเตอร์การตอบกลับ
การตอบกลับเมื่อสำเร็จ
| Field | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | ID ของข้อความที่สอดคล้องกับรหัสยืนยัน ซึ่งส่งกลับโดย API /v1/messages |
| verify_code | String | Required | รหัสยืนยันที่ต้องการตรวจสอบความถูกต้อง |
| verified | Boolean | Required | ผลการตรวจสอบความถูกต้อง โดย true หมายถึงตรวจสอบสำเร็จ และ false หมายถึงตรวจสอบไม่สำเร็จ |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
หมายเหตุ: หากมีการส่งคำขอตรวจสอบสำหรับรหัสยืนยันของข้อความเดิม และรหัสดังกล่าวได้รับการตรวจสอบสำเร็จแล้ว คำขอใด ๆ ที่ส่งมายัง API ตรวจสอบนี้ในภายหลังจะล้มเหลว และส่งกลับข้อความที่ระบุว่ารหัสยืนยันสำหรับข้อความนี้ได้รับการตรวจสอบแล้ว กล่าวอีกนัยหนึ่ง รหัสยืนยันที่ได้รับการตรวจสอบสำเร็จแล้วจะไม่สามารถตรวจสอบซ้ำได้อีก
การตอบกลับเมื่อไม่สำเร็จ
HTTP status code จะเป็น 4xx หรือ 5xx และเนื้อหาการตอบกลับจะมีฟิลด์ดังต่อไปนี้:
| Field | Type | Required | Description |
|---|---|---|---|
| code | int | Required | รหัสข้อผิดพลาด สำหรับรายละเอียด โปรดดู Error Codes |
| message | String | Required | รายละเอียดข้อผิดพลาด |
{
"code": 3003,
"message": "verify code has expired"
}
{
"code": 3003,
"message": "verify code has expired"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
รหัสข้อผิดพลาด
| Error Code | HTTP Code | Description |
|---|---|---|
| 1000 | 500 | ข้อผิดพลาดภายใน |
| 2001 | 401 | การยืนยันตัวตนล้มเหลว: ไม่มีการระบุ token ที่ถูกต้อง |
| 2002 | 401 | การยืนยันตัวตนล้มเหลว: token หมดอายุหรือถูกปิดใช้งานแล้ว |
| 2004 | 403 | ไม่มีสิทธิ์เรียกใช้ API นี้ |
| 3001 | 400 | รูปแบบพารามิเตอร์คำขอไม่ถูกต้อง โปรดตรวจสอบว่าเนื้อหา JSON เป็นไปตามรูปแบบพารามิเตอร์ที่กำหนดหรือไม่ |
| 3002 | 400 | พารามิเตอร์คำขอไม่ถูกต้อง โปรดตรวจสอบว่าพารามิเตอร์คำขอเป็นไปตามข้อกำหนดหรือไม่ |
| 3003 | 400 | รหัสยืนยันหมดอายุหรือได้รับการตรวจสอบแล้ว สำหรับการตอบกลับที่มีรหัสข้อผิดพลาดนี้ จำเป็นต้องส่งข้อความรหัสยืนยันใหม่ |
| 4001 | 400 | ไม่พบข้อความ |
