การส่ง OTP

API สำหรับส่ง OTP นี้จะสร้างรหัสยืนยันผ่านแพลตฟอร์ม EngageLab และจัดส่งตามกลยุทธ์ของช่องทางที่ระบุไว้ในเทมเพลต

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

Endpoint

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

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

ใช้ HTTP Basic Authentication และเพิ่ม Authorization ลงใน HTTP header ดังนี้:

              
              Authorization: Basic ${base64_auth_string}

            

อัลกอริทึมสำหรับสร้าง base64_auth_string คือ base64(dev_key:dev_secret)

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

Request Header

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

            

Request Body

              
              {
  "to": "+6591234567",
  "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"
}

            

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