อินเทอร์เฟซ API แม่แบบ

              
              Authorization: Basic ${base64_auth_string}

            

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

            

              
              {
    "template_id": "test-template-1",       // รหัสเทมเพลตที่กำหนดเอง ต้องไม่ซ้ำในแอปพลิเคชัน
    "description": "Test Template 1",       // คำอธิบายของเทมเพลต
    "send_channel_strategy": "whatsapp|sms",    // กลยุทธ์การส่งเทมเพลต รองรับ 4 ประเภท: whatsapp/sms/voice/email ใช้ | เพื่อระบุกลยุทธ์สำรอง
    "brand_name": "Brand Name",             // ชื่อแบรนด์ ใช้ในลายเซ็นสำหรับบางประเทศ/ภูมิภาคในเนื้อหาเทมเพลต (เช่น จำเป็นสำหรับช่อง SMS ในบางประเทศ/ภูมิภาค)
    "verify_code_config": {                 // การตั้งค่ารหัสยืนยัน จำเป็นเมื่อเทมเพลตรวมถึงประเภทการยืนยัน
        "verify_code_type": 1,              // ประเภทของรหัสยืนยัน ช่วง [1,7]
        "verify_code_len": 6,               // ความยาวของรหัสยืนยัน ช่วง [4,10]
        "verify_code_ttl": 1                // ระยะเวลาความถูกต้องของรหัสยืนยัน ช่วง [1,10] หมายเหตุ: เมื่อกลยุทธ์รวมถึง whatsapp ค่าได้เฉพาะ 1, 5 หรือ 10
    },
    "whatsapp_config": {                    // การตั้งค่ากลยุทธ์ WhatsApp มีผลเมื่อกลยุทธ์การส่งรวมถึง WhatsApp
        "template_type": 1,                 // ประเภทเทมเพลต WhatsApp ปัจจุบันรองรับเฉพาะเทมเพลตเริ่มต้น ค่า 1
        "template_default_config": {        // การตั้งค่าเทมเพลตเริ่มต้น WhatsApp มีผลสำหรับประเภทเทมเพลตเริ่มต้น
            "contain_security": false,      // รวมถึงการแจ้งเตือนความปลอดภัยหรือไม่
            "contain_expire": false         // รวมถึงเนื้อหาหมดอายุหรือไม่
        }
    },
    "sms_config": {                         // การตั้งค่ากลยุทธ์ SMS มีผลเมื่อกลยุทธ์การส่งรวมถึง SMS
        "template_type": 2,                 // ประเภทเทมเพลต SMS ค่า: 1-เทมเพลตเริ่มต้น/2-เทมเพลตที่กำหนดเอง
        "template_default_config": {        // การตั้งค่าเทมเพลตเริ่มต้น SMS มีผลสำหรับประเภทเทมเพลตเริ่มต้น
            "contain_security": false,      // รวมถึงการแจ้งเตือนความปลอดภัยหรือไม่
            "contain_expire": false         // รวมถึงเนื้อหาหมดอายุหรือไม่
        },
        "template_custom_config": {         // การตั้งค่าเทมเพลตที่กำหนดเอง SMS มีผลสำหรับประเภทเทมเพลตที่กำหนดเอง
            "custom_sub_type": "authentication",    // ประเภทเทมเพลตที่กำหนดเอง ค่า: authentication-รหัสยืนยัน/marketing-การตลาด/utility-การแจ้งเตือน
            "custom_content": "xxx",                // เนื้อหาเทมเพลตที่กำหนดเอง หมายเหตุ: สำหรับประเภท authentication ต้องรวมตัวแปร {{code}}
            "custom_country_codes": "HK,PH"         // ประเทศ/ภูมิภาคเป้าหมายสำหรับเทมเพลตที่กำหนดเอง ใช้เป็นข้อมูลอ้างอิงระหว่างการตรวจสอบเทมเพลต กรอกตามต้องการ มิฉะนั้นอาจส่งผลต่อการส่ง
        }
    },
    "voice_config": {                       // การตั้งค่ากลยุทธ์เสียง มีผลเมื่อกลยุทธ์การส่งรวมถึงเสียง
        "template_type": 1,                 // ประเภทเทมเพลตเสียง ปัจจุบันรองรับเฉพาะเทมเพลตเริ่มต้น ค่า 1
        "template_default_config": {        // การตั้งค่าเทมเพลตเริ่มต้นเสียง มีผลสำหรับประเภทเทมเพลตเริ่มต้น
            "contain_security": false,      // รวมถึงการแจ้งเตือนความปลอดภัยหรือไม่
            "contain_expire": false         // รวมถึงเนื้อหาหมดอายุหรือไม่
        }
    },
    "email_config": {                       // การตั้งค่ากลยุทธ์อีเมล มีผลเมื่อกลยุทธ์การส่งรวมถึงอีเมล
        "template_name": "Email Template Name",     // ชื่อเทมเพลตอีเมล
        "template_custom_configs": [{       // การตั้งค่าเทมเพลตที่กำหนดเองอีเมล หมายเหตุเป็นอาร์เรย์ของอ็อบเจ็กต์ แยกตามภาษา
            "language": "default",          // ภาษา ค่า default เป็นค่าเริ่มต้น เนื้อหาเทมเพลตสามารถจับคู่ตามพารามิเตอร์ภาษาในระหว่างการส่ง
            "pre_from_name": "test",        // ชื่อผู้ส่งที่ตั้งไว้ล่วงหน้า
            "pre_from_mail": "test@test.com",   // อีเมลผู้ส่งที่ตั้งไว้ล่วงหน้า
            "pre_subject": "test",          // หัวข้ออีเมลที่ตั้งไว้ล่วงหน้า
            "template_content": "เนื้อหาเทมเพลตอีเมลที่ตั้งไว้ล่วงหน้า จำเป็น ตัวแปรที่กำหนดเองเช่น {{self}} รหัสยืนยันคือ {{code}}",    // เนื้อหาอีเมล รองรับ HTML ตัวแปรต้องอยู่ในวงเล็บปีกกา {{ }}
            "pre_param_map": {              // ค่าเริ่มต้นสำหรับตัวแปรในเนื้อหาอีเมล หากค่าไม่ถูกระบุระหว่างการส่ง ค่าที่ตั้งไว้ล่วงหน้าจะมาแทนที่ตัวแปร ประกาศเป็นคู่คีย์-ค่า ค่าเป็นสตริง
                "self": "นี่คือค่าที่ตั้งไว้ล่วงหน้าสำหรับตัวแปร self"
            }
        }]
    },
    "pwa_config": {                         // การตั้งค่าที่เกี่ยวข้องกับ PWA เป็นตัวเลือก
        "pwa_platform": "xx",               // แพลตฟอร์ม PWA ที่ใช้ สำหรับค่าที่เฉพาะเจาะจง ติดต่อฝ่ายสนับสนุนทางเทคนิค
        "pwa_code": "xx"                    // รหัสในแพลตฟอร์ม PWA ที่ใช้
    }
}

            

              
              {
    "code": 0,
    "message": "success"
}

            

              
              {
    "code": 3003,
    "message": "not contains any channel config"
}

            

              
              Authorization: Basic ${base64_auth_string}

            

              
              DELETE /v1/template-configs/{templateId}  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

              
              {
    "code": 0,
    "message": "success"
}

            

              
              {
    "code": 4001,
    "message": "config not exist"
}

            

              
              Authorization: Basic ${base64_auth_string}

            

              
              GET /v1/template-configs  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

              
              [{
    "template_id": "test-template-1",       // รหัสแม่แบบที่กำหนดเอง ไม่ซ้ำกันภายในแอปพลิเคชัน
    "description": "Test Template 1",       // คำอธิบายของแม่แบบ
    "send_channel_strategy": "whatsapp|sms",    // กลยุทธ์การส่งของแม่แบบ รองรับ whatsapp/sms/voice/email กลยุทธ์ที่รวมกันใช้ตัวอักษร "|" เพื่อระบุ fallback
    "brand_name": "Brand Name",             // ชื่อแบรนด์ ใช้เป็นลายเซ็นในเนื้อหาแม่แบบสำหรับบางประเทศ/ภูมิภาค (เช่น จำเป็นสำหรับช่องทาง SMS ในบางประเทศ/ภูมิภาค)
    "verify_code_config": {                 // การกำหนดค่ารหัสยืนยัน ส่งคืนเมื่อแม่แบบมีประเภทของรหัสยืนยัน
        "verify_code_type": 1,              // ประเภทของรหัสยืนยัน ช่วง [1,7]
        "verify_code_len": 6,               // ความยาวของรหัสยืนยัน ช่วง [4,10]
        "verify_code_ttl": 1                // ระยะเวลาความถูกต้องของรหัสยืนยัน ช่วง [1,10] หมายเหตุ: เมื่อกลยุทธ์รวมถึง whatsapp ค่าได้เพียง 1, 5 หรือ 10
    },
    "whatsapp_config": {                    // การกำหนดค่าสำหรับกลยุทธ์ whatsapp ส่งคืนเมื่อกลยุทธ์การส่งรวมถึง whatsapp
        "template_type": 1                  // ประเภทแม่แบบ whatsapp ปัจจุบันรองรับเฉพาะแม่แบบเริ่มต้น ค่าแบบคงที่คือ 1
    },
    "sms_config": {                         // การกำหนดค่าสำหรับกลยุทธ์ SMS ส่งคืนเมื่อกลยุทธ์การส่งรวมถึง SMS
        "template_type": 2,                 // ประเภทแม่แบบ SMS ค่า: 1-แม่แบบเริ่มต้น/2-แม่แบบกำหนดเอง
        "template_parts": 1                 // ส่วนการคำนวณค่าบริการสำหรับแม่แบบ SMS หากแม่แบบยาวเกินไป ราคาที่เฉพาะเจาะจง = ส่วนค่าบริการ * ราคาต่อหน่วย
    },
    "voice_config": {                       // การกำหนดค่าสำหรับกลยุทธ์เสียง ส่งคืนเมื่อกลยุทธ์การส่งรวมถึงเสียง
        "template_type": 1                  // ประเภทแม่แบบเสียง ปัจจุบันรองรับเฉพาะแม่แบบเริ่มต้น ค่าแบบคงที่คือ 1
    },
    "email_config": {                       // การกำหนดค่าสำหรับกลยุทธ์อีเมล ส่งคืนเมื่อกลยุทธ์การส่งรวมถึงอีเมล
        "template_name": "Email Template Name" // ชื่อแม่แบบอีเมล
    },
    "pwa_config": {                         // การกำหนดค่าที่เกี่ยวข้องกับ PWA ส่งคืนเมื่อมีการกำหนดค่า PWA
        "pwa_platform": "xx",               // แพลตฟอร์ม PWA ที่ใช้
        "pwa_code": "xx"                    // รหัสที่ใช้ในแพลตฟอร์ม PWA
    },
    "created_time": 1234567890,             // เวลาสร้างแม่แบบในรูปแบบ timestamp แม่นยำถึงวินาที
    "status": 1,                            // สถานะแม่แบบ ค่า: 1-รอการตรวจสอบ/2-อนุมัติ/3-ปฏิเสธ
    "audit_remark": "xx"                    // หมายเหตุการตรวจสอบ โดยทั่วไปใช้ดูเหตุผลการปฏิเสธเมื่อการตรวจสอบถูกปฏิเสธ
},...]      // หมายเหตุ: นี่คืออาร์เรย์ของอ็อบเจ็กต์

            

              
              {
    "code": 4001,
    "message": "config not exist"
}

            

              
              Authorization: Basic ${base64_auth_string}

            

              
              GET /v1/template-configs/custom-template-id  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

              
              {
    "template_id": "test-template-1",       // รหัสแม่แบบที่กำหนดเอง ไม่ซ้ำกันภายในแอปพลิเคชัน
    "description": "Test Template 1",       // คำอธิบายของแม่แบบ
    "send_channel_strategy": "whatsapp|sms",    // กลยุทธ์การส่งของแม่แบบ รองรับ whatsapp/sms/voice/email กลยุทธ์ที่รวมกันใช้ตัวอักษร "|" เพื่อระบุ fallback
    "brand_name": "Brand Name",             // ชื่อแบรนด์ ใช้เป็นลายเซ็นในเนื้อหาแม่แบบสำหรับบางประเทศ/ภูมิภาค (เช่น จำเป็นสำหรับช่องทาง SMS ในบางประเทศ/ภูมิภาค)
    "verify_code_config": {                 // การกำหนดค่ารหัสยืนยัน ส่งคืนเมื่อแม่แบบมีประเภทของรหัสยืนยัน
        "verify_code_type": 1,              // ประเภทของรหัสยืนยัน ช่วง [1,7]
        "verify_code_len": 6,               // ความยาวของรหัสยืนยัน ช่วง [4,10]
        "verify_code_ttl": 1                // ระยะเวลาความถูกต้องของรหัสยืนยัน ช่วง [1,10] หมายเหตุ: เมื่อกลยุทธ์รวมถึง whatsapp ค่าได้เพียง 1, 5 หรือ 10
    },
    "whatsapp_config": {                    // การกำหนดค่าสำหรับกลยุทธ์ whatsapp ส่งคืนเมื่อกลยุทธ์การส่งรวมถึง whatsapp
        "template_type": 1                  // ประเภทแม่แบบ whatsapp ปัจจุบันรองรับเฉพาะแม่แบบเริ่มต้น ค่าแบบคงที่คือ 1
    },
    "sms_config": {                         // การกำหนดค่าสำหรับกลยุทธ์ SMS ส่งคืนเมื่อกลยุทธ์การส่งรวมถึง SMS
        "template_type": 2,                 // ประเภทแม่แบบ SMS ค่า: 1-แม่แบบเริ่มต้น/2-แม่แบบกำหนดเอง
        "template_parts": 1,                // ส่วนการคำนวณค่าบริการสำหรับแม่แบบ SMS หากแม่แบบยาวเกินไป ราคาที่เฉพาะเจาะจง = ส่วนค่าบริการ * ราคาต่อหน่วย
        "template_custom_config": {         // การกำหนดค่าแม่แบบ SMS แบบกำหนดเอง ใช้ได้เมื่อประเภทแม่แบบ SMS เป็นแบบกำหนดเอง
            "custom_sub_type": "authentication",    // ประเภทแม่แบบกำหนดเอง ค่า: authentication-รหัสยืนยัน/marketing-การตลาด/utility-การแจ้งเตือน
            "custom_content": "xxx"                // เนื้อหาแม่แบบกำหนดเอง หมายเหตุ: หากประเภทย่อยคือ authentication (รหัสยืนยัน) จะต้องมีตัวแปร {{code}}
        }
    },
    "voice_config": {                       // การกำหนดค่าสำหรับกลยุทธ์เสียง ส่งคืนเมื่อกลยุทธ์การส่งรวมถึงเสียง
        "template_type": 1                  // ประเภทแม่แบบเสียง ปัจจุบันรองรับเฉพาะแม่แบบเริ่มต้น ค่าแบบคงที่คือ 1
    },
    "email_config": {                       // การกำหนดค่าสำหรับกลยุทธ์อีเมล ส่งคืนเมื่อกลยุทธ์การส่งรวมถึงอีเมล
        "template_name": "Email Template Name", // ชื่อแม่แบบอีเมล
        "template_custom_configs": [{       // การกำหนดค่าแม่แบบอีเมลแบบกำหนดเอง ใช้ได้เมื่อประเภทแม่แบบอีเมลเป็นแบบกำหนดเอง หมายเหตุ: นี่คืออาร์เรย์ของอ็อบเจ็กต์ โดยหลักแยกตามภาษาเพื่อการกำหนดค่าหลายภาษา
            "language": "default",          // ภาษา "default" คือค่าเริ่มต้น เมื่อส่งข้อความสามารถจับคู่เนื้อหาแม่แบบต่างๆ ตามพารามิเตอร์ภาษา
            "pre_from_name": "test",        // ชื่อผู้ส่งที่ตั้งไว้ล่วงหน้า
            "pre_from_mail": "test@test.com",   // อีเมลผู้ส่งที่ตั้งไว้ล่วงหน้า
            "pre_subject": "test",          // หัวข้ออีเมลที่ตั้งไว้ล่วงหน้า
            "template_content": "เนื้อหาแม่แบบอีเมลที่ตั้งไว้ล่วงหน้า จำเป็น ตัวแปรที่กำหนดเองเช่น {{self}} รหัสยืนยันคือ {{code}}", // เนื้อหาอีเมล รองรับ HTML ตัวแปรต้องอยู่ในวงเล็บปีกกา {{}} สองชั้น
            "pre_param_map": {              // ค่าเริ่มต้นสำหรับตัวแปรในเนื้อหาอีเมล หากไม่มีการระบุค่าตัวแปรระหว่างการส่ง ค่าเริ่มต้นด้านล่างจะใช้แทนตัวแปร ประกาศเป็นคู่คีย์-ค่า
                "self": "นี่คือค่าดีฟอลต์สำหรับตัวแปร self"
            }
        }]
    },
    "pwa_config": {                         // การกำหนดค่าที่เกี่ยวข้องกับ PWA ส่งคืนเมื่อมีการกำหนดค่า PWA
        "pwa_platform": "xx",               // แพลตฟอร์ม PWA ที่ใช้
        "pwa_code": "xx"                    // รหัสที่ใช้ในแพลตฟอร์ม PWA
    },
    "created_time": 1234567890,             // เวลาสร้างแม่แบบในรูปแบบ timestamp แม่นยำถึงวินาที
    "status": 1,                            // สถานะแม่แบบ ค่า: 1-รอการตรวจสอบ/2-อนุมัติ/3-ปฏิเสธ
    "audit_remark": "xx"                    // หมายเหตุการตรวจสอบ โดยทั่วไปใช้ดูเหตุผลการปฏิเสธเมื่อการตรวจสอบถูกปฏิเสธ
}

            

              
              {
    "code": 4001,
    "message": "config not exist"
}