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

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

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

หากคุณต้องการให้แพลตฟอร์ม EngageLab สร้างรหัสยืนยัน คุณสามารถเรียกใช้ API EngageLab OTP 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)

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

Header ของคำขอ

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

            

เนื้อหาของคำขอ

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

            

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

วัตถุคำขอแสดงในรูปแบบ JSON ดังนั้นส่วนหัวของคำขอต้องรวม 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 จะเป็น 4xx หรือ 5xx และเนื้อหาการตอบกลับจะรวมฟิลด์ดังต่อไปนี้:

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

            

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