ส่ง

อินเทอร์เฟซนี้ใช้โดยแพลตฟอร์ม EngageLab เพื่อสร้างรหัสยืนยันและส่งมอบตามกลยุทธ์ช่องทางที่ระบุไว้ในเทมเพลต

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

จุดสิ้นสุด

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)

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

ส่วนหัวคำขอ

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

            

เนื้อหาคำขอ

              
              {
    "to": "+8618701235678",
    "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 เป็นช่องทางสำรองในกรณีที่การส่งล้มเหลว อินเทอร์เฟซจะส่งคืนค่า whatsapp หากการส่งล้มเหลวหลังจากเวลาที่กำหนด ระบบจะใช้ช่องทาง SMS เพื่อส่งข้อความ

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

รหัสสถานะ HTTP จะเป็น 4xx หรือ 5xx และเนื้อหาการตอบกลับจะรวมฟิลด์ดังต่อไปนี้:

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

            

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