การส่งข้อความกำหนดเอง

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

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

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

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

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

รูปแบบคำขอ

ส่วนหัวคำขอ

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

            

เนื้อหาคำขอ

              
              {
    "to": "+6591234567", 
    "template":{
      "id":"test-template-1",
      "params": {
        "code": "codevalue",
        "var1":"value1"
        }
    }
}

            

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

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

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

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

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

1. ส่งรหัส OTP กำหนดเอง:

              
              {
    "to": "+6591234567", 
    "template":{
      "id":"code-template",
      "params": {
        "code": "123456"        
        }
    }
}

            

2. ส่งเนื้อหาการแจ้งเตือนกำหนดเอง:

              
              {
    "to": "+6591234567",
    "template": {
        "id": "notification-template",
        "params": {
            "order": "123456"
        }
    }
}

            

3. ส่งเนื้อหาการตลาดกำหนดเอง:

              
              {
    "to": ["+6591234567"],
    "template": {
        "id": "marketing-template",
        "params": {
            "name": "EngageLab",
            "promotion": "30%"
        }
    }
}

            

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

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

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

            

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

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

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

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

            

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