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

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

Endpoint

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)

รูปแบบคำขอ

Request Headers

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

            

Request Body

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

            

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

อ็อบเจ็กต์คำขอจะแสดงในรูปแบบ JSON ดังนั้น Request Header ต้องมี 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": "+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 โดยอัตโนมัติ การตอบกลับของ API จะส่งกลับเป็น whatsapp หลังจากระบบตรวจพบความล้มเหลวในการส่งภายในช่วงเวลาหนึ่งแล้ว ระบบจึงจะส่งผ่านช่องทาง SMS

การตอบกลับเมื่อไม่สำเร็จ

HTTP status code คือ 4xx หรือ 5xx และ Response Body จะมีฟิลด์ต่อไปนี้

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

            

Error Codes