การส่งรหัส OTP แบบกำหนดเอง

หากคุณต้องการสร้างรหัสยืนยันด้วยตนเองแทนการให้แพลตฟอร์ม EngageLab สร้างให้ คุณสามารถเรียกใช้ API นี้ได้

API นี้ใช้สำหรับส่งรหัสยืนยันที่สร้างไว้ล่วงหน้าโดยเฉพาะ และจะไม่สร้างรหัสยืนยันด้วยตัวเอง หลังจากส่งรหัสยืนยันแล้ว ก็ไม่จำเป็นต้องเรียก API สำหรับยืนยันเพื่อตรวจสอบความถูกต้องของรหัสดังกล่าว

หากคุณต้องการให้แพลตฟอร์ม EngageLab สร้างรหัสยืนยัน คุณสามารถเรียกใช้ API EngageLab OTP Verification Code Delivery ได้

Endpoint

POST https://otp.api.engagelab.cc/v1/codes

การยืนยันตัวตน

ใช้ HTTP Basic Authentication โดยเพิ่ม Authorization ลงใน HTTP header:

              
              Authorization: Basic ${base64_auth_string}

            

อัลกอริทึมการสร้าง base64_auth_string ข้างต้นคือ base64(dev_key:dev_secret)

ตัวอย่างคำขอ

Request Header

              
              POST /v1/codes HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Request Body

              
              {
  "to": "+6591234567",
  "code": "398210",
  "template": {
    "id": "test-template-1",
    "language": "default",
    "params": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

            

พารามิเตอร์คำขอ

ออบเจ็กต์คำขอแสดงในรูปแบบ JSON ดังนั้น request header ต้องมี Content-Type: application/json

คำอธิบายของ params

1. สำหรับฟิลด์เทมเพลตที่ตั้งค่าไว้ล่วงหน้า เช่น from_id หากไม่ได้ระบุค่าของฟิลด์ param_vars ระบบจะใช้ from_id ที่ตั้งค่าไว้ล่วงหน้าในเทมเพลตเมื่อส่งข้อความ
2. หากระบุค่าของฟิลด์ param_vars เช่น param_vars:{"from_id":"12345"} เมื่อส่งข้อความ from_id ของเทมเพลตจะถูกแทนที่ด้วย 12345
3. ฟิลด์ตัวแปรแบบกำหนดเองในเนื้อหาเทมเพลตที่สร้างไว้ระหว่างการสร้างเทมเพลตก็กำหนดค่าผ่าน param_vars เช่นกัน ตัวอย่างเช่น หากเนื้อหาเทมเพลตคือ Hi {{name}}, your verify code is {{code}} จำเป็นต้องมีพารามิเตอร์การกำหนดค่า param_vars:{"name":"Bob"}

พารามิเตอร์การตอบกลับ

การตอบกลับเมื่อสำเร็จ

              
              {
  "message_id": "1725407449772531712",
  "send_channel": "sms"
}

            

โปรดทราบว่าค่า send_channel ที่ส่งกลับมาไม่ได้แสดงถึงช่องทางสุดท้ายที่ใช้ในการส่งข้อความไปยังผู้ใช้ แต่แสดงเฉพาะช่องทางที่กำลังใช้งานอยู่ในขณะนั้นเท่านั้น ตัวอย่างเช่น หากมีการกำหนดกลยุทธ์ของเทมเพลตไว้ว่าเมื่อการส่งผ่านช่องทาง WhatsApp ล้มเหลว ระบบจะลองส่งใหม่ผ่านช่องทาง SMS โดยอัตโนมัติ ค่าที่ API ตอบกลับจะเป็น whatsapp และหลังจากผ่านไประยะหนึ่ง หากตรวจพบว่าการส่งล้มเหลว ระบบจะส่งผ่านช่องทาง SMS

การตอบกลับเมื่อล้มเหลว

HTTP status code เป็น 4xx หรือ 5xx และ response body มีฟิลด์ดังต่อไปนี้:

              
              {
  "code": 5001,
  "message": "sms send fail"
}

            

รหัสข้อผิดพลาด