การส่งรหัส OTP

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

หากคุณต้องการสร้างรหัส OTP ด้วยตนเองแทนการสร้างผ่านแพลตฟอร์ม EngageLab คุณสามารถเรียกใช้อินเทอร์เฟซ การส่งรหัส OTP กำหนดเองของ EngageLab ได้

ที่อยู่สำหรับเรียกใช้

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

การยืนยันตัวตนในการเรียกใช้

โปรดดู การยืนยันตัวตนในการเรียกใช้ เพื่อเรียนรู้วิธีทำการยืนยันตัวตน API

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

ส่วนหัวคำขอ

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

            

เนื้อหาคำขอ

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

            

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

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

คำอธิบายเกี่ยวกับ params

1. สำหรับฟิลด์ที่เทมเพลตกำหนดไว้ล่วงหน้า เช่น from_id หากไม่ส่งค่าฟิลด์ params เมื่อส่งข้อความจะใช้ from_id ที่เทมเพลตกำหนดไว้ล่วงหน้า
2. หากส่งค่าฟิลด์ params เช่น params:{"from_id":"12345"} เมื่อส่งข้อความ from_id ของเทมเพลตจะถูกแทนที่ด้วย 12345
3. สำหรับฟิลด์ตัวแปรที่กำหนดเองในเนื้อหาเทมเพลตตอนสร้างเทมเพลต ก็ต้องกำหนดค่าผ่าน params เช่นกัน เช่น เนื้อหาเทมเพลต Hi {{name}}, your verify code is {{code}} กรณีนี้ต้องกำหนดค่าพารามิเตอร์ params:{"name":"Bob"}
4. ตัวแปรพิเศษของช่องทาง Email: สำหรับช่องทาง Email รองรับการแทนที่หัวข้ออีเมล (subject) ชื่อผู้ส่ง (from_name) อีเมลผู้ส่ง (from_mail) ฯลฯ แบบไดนามิกผ่าน params สำหรับการใช้งานขั้นสูงโดยละเอียด โปรดดู สร้างเทมเพลต - การใช้งานขั้นสูงของตัวแปรเทมเพลต Email

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

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

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

            

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

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

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

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

            

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

ตารางด้านล่างอธิบายเฉพาะข้อผิดพลาดที่ API นี้ส่งคืนในขั้นตอนการยืนยันตัวตน การตรวจสอบก่อนส่ง และการส่งแบบซิงโครนัส ความล้มเหลวในการจัดส่งแบบอะซิงโครนัสหลังผู้ให้บริการรับข้อความแล้วจะไม่ถูกส่งคืนผ่าน API นี้ ให้ดึงผ่านการสอบถามสถานะข้อความหรือ callback

ผู้เรียกควรใช้ code เพื่อตัดสินประเภทข้อผิดพลาด ใช้ message เพื่อแสดงเหตุผลเฉพาะหรือช่วยในการแก้ไขปัญหา ไม่แนะนำให้พึ่งพาข้อความ message ที่ตายตัวในการเขียนตรรกะทางธุรกิจ

คำอธิบายข้อผิดพลาดการจำกัดอัตราและปริมาณการส่ง

• 3004 คือการควบคุมความถี่การส่ง OTP ตามเทมเพลต หน้าต่างจำกัดอิงตามการตั้งค่าเทมเพลต และอาจไม่เท่ากับระยะเวลาที่ใช้ได้ของรหัสยืนยัน
• 6001 และ 6002 คือการควบคุมความถี่เพื่อความปลอดภัยในมิติหมายเลขหรือ IP ของผู้ใช้ปลายทาง
• 6003 และ 6008 ระบุว่าคำขอนี้ถึงขีดจำกัดปริมาณการส่งแล้ว หลังจากถึงขีดจำกัดและเข้าสู่สถานะระงับ คำขอถัดไปอาจส่งคืน 6007
• เมื่อได้รับ HTTP 429 โปรดอย่ารีทรายทันทีอย่างต่อเนื่อง ให้ลองใหม่ในภายหลัง และหากยังเกิดขึ้นต่อเนื่อง ให้ติดต่อผู้ดูแลระบบหรือฝ่ายสนับสนุนทางเทคนิค
• 5011 ถึง 5019 ครอบคลุมเฉพาะความล้มเหลวที่ระบุได้ในขั้นตอนการส่งแบบซิงโครนัส สถานะเช่นหมายเลขว่าง ปิดเครื่อง หรือผู้ให้บริการปฏิเสธหลังผู้ให้บริการรับข้อความแล้ว ยังอาจถูกส่งคืนผ่านสถานะข้อความแบบอะซิงโครนัสหรือ callback