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

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

จุดสิ้นสุดของ API

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

การตรวจสอบสิทธิ์

ใช้ HTTP Basic Authentication สำหรับการตรวจสอบสิทธิ์ เพิ่ม Authorization ใน HTTP Header:

              
              Authorization: Basic ${base64_auth_string}

            

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

รูปแบบคำขอ

หัวข้อคำขอ

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

            

เนื้อหาคำขอ

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

            

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

วัตถุคำขอแสดงในรูปแบบ JSON ดังนั้นหัวข้อคำขอต้องรวม Content-Type: application/json

คำอธิบายสำหรับ params

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

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

1. การส่งรหัสยืนยันที่กำหนดเอง:

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

            

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

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

            

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

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

            

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

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

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

            

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

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

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

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

            

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