การจัดการเทมเพลตอีเมล

นักพัฒนาสามารถใช้ เทมเพลต เพื่อส่งเนื้อหาที่คล้ายกันไปยังผู้ใช้ที่แตกต่างกันในปริมาณมากได้อย่างง่ายดาย

สามารถเรียกดู เพิ่ม ลบ และแก้ไขเทมเพลตอีเมลผ่าน API ได้

การเรียกดู (การเรียกดูแบบกลุ่ม)

ส่งคืนข้อมูลพื้นฐานเกี่ยวกับเทมเพลตอีเมล

URL

https://email.api.engagelab.cc/v1/templates
              
              https://email.api.engagelab.cc/v1/templates

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

GET
              
              GET

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

หัวข้อ ประเภท จำเป็น คำอธิบาย
Authorization string true Basic base64(api_user:api_key)

พารามิเตอร์การเรียกดู

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
offset int ไม่ ตำแหน่งเริ่มต้นของการเรียกดู ช่วง [0-] ค่าเริ่มต้นคือ 0
limit int ไม่ จำนวนการเรียกดู ช่วง [0-100] ค่าเริ่มต้นคือ 100
name string ไม่ ชื่อเทมเพลตอีเมล การเรียกดูแบบไม่ตรงตัว
template_invoke_name string ไม่ ชื่อเรียกใช้เทมเพลตอีเมล การเรียกดูแบบตรงตัว

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

curl -X GET -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/templates?offset=0&limit=3'
              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates?offset=0&limit=3'

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

ฟิลด์ คำอธิบาย
template_id รหัสเทมเพลต
name ชื่อเทมเพลตอีเมล
template_invoke_name ชื่อเรียกใช้เทมเพลตอีเมล
html เนื้อหาเทมเพลต
preview_text สรุปเทมเพลต
subject หัวข้อเทมเพลต
create_time เวลาสร้างเทมเพลตอีเมล
update_time เวลาปรับปรุงเทมเพลตอีเมล

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "result": [{ "template_id": 82522, "name": "dffddf", "template_invoke_name": "dffdfd", "html": null, "text": null, "subject": "fdfdfd😅🙂🙂🙂🙂", "preview_text": "", "create_time": "2022-11-10 15:47:05", "update_time": "2022-11-10 15:47:05" }] , "count":10, "total":20 }
              
              
{
    "result":  [{
                "template_id": 82522,
                "name": "dffddf",
                "template_invoke_name": "dffdfd",
                "html": null,
                "text": null,
                "subject": "fdfdfd😅🙂🙂🙂🙂",
                "preview_text": "",
                "create_time": "2022-11-10 15:47:05",
                "update_time": "2022-11-10 15:47:05"
            }]
     ,
     "count":10,
     "total":20
}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }
              
              {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

การเรียกดู

ส่งคืนข้อมูลรายละเอียดเกี่ยวกับเทมเพลตอีเมลเดี่ยว

URL

https://email.api.engagelab.cc/v1/templates/{template_id}
              
              https://email.api.engagelab.cc/v1/templates/{template_id}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

DELETE
              
              DELETE

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

หัวข้อ ประเภท จำเป็น คำอธิบาย
Authorization string true Basic base64(api_user:api_key)

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

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/templates/11111111'
              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates/11111111'

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

ฟิลด์ คำอธิบาย
template_id รหัสเทมเพลต
name ชื่อเทมเพลตอีเมล
template_invoke_name ชื่อเรียกใช้เทมเพลตอีเมล
html เนื้อหาเทมเพลต
preview_text สรุปอีเมล
subject หัวข้อเทมเพลต
create_time เวลาสร้างเทมเพลตอีเมล
update_time เวลาปรับปรุงเทมเพลตอีเมล

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "result":{ "template_id": 76707, "name": "libo01s", "template_invoke_name": "libo01d", "html": "The is first email", "text": null, "subject": "happyaaa", "preview_text": "", "create_time": "2019-07-22T11:52:45+0800", "update_time": "2019-08-01T11:29:19+0800" } }
              
              
{
     "result":{
            "template_id": 76707,
            "name": "libo01s",
            "template_invoke_name": "libo01d",
            "html": "The is first email",
            "text": null,
            "subject": "happyaaa",
            "preview_text": "",
            "create_time": "2019-07-22T11:52:45+0800",
            "update_time": "2019-08-01T11:29:19+0800"
        }
}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }
              
              {
    
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

การเพิ่ม

URL

https://email.api.engagelab.cc/v1/templates
              
              https://email.api.engagelab.cc/v1/templates

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-Type:

Content-Type: application/json;charset=utf-8
              
              Content-Type: application/json;charset=utf-8

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

POST
              
              POST

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

หัวข้อ ประเภท จำเป็น คำอธิบาย
Authorization string true Basic base64(api_user:api_key)

พารามิเตอร์ในเนื้อหา

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
name string ใช่ ชื่อเทมเพลตอีเมล สูงสุด 32 ตัวอักษร
template_invoke_name string ใช่ ชื่อเรียกใช้เทมเพลตอีเมล 4~64 ตัวอักษร
html string ใช่ เนื้อหาในรูปแบบ HTML
subject string ใช่ หัวข้อเทมเพลต สูงสุด 255 ตัวอักษร รองรับอีโมจิ
preview_text string ไม่ สรุปเทมเพลต สูงสุด 255 ตัวอักษร

หมายเหตุ:

  1. สามารถใช้ตัวแปรในเนื้อหา HTML ได้
  2. ขนาดรวมของอีเมลต้องไม่เกิน 70MB เมื่อส่ง

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

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "html": "xxx", "subject": "sususubej"}' 'https://email.api.engagelab.cc/v1/templates'
              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "html": "xxx", "subject": "sususubej"}'
     'https://email.api.engagelab.cc/v1/templates'

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

ฟิลด์ คำอธิบาย
template_id รหัสเทมเพลต
name ชื่อเทมเพลตอีเมล
template_invoke_name ชื่อเรียกใช้เทมเพลตอีเมล
preview_text สรุปอีเมล
html เนื้อหาในรูปแบบ HTML ของเทมเพลต
subject หัวข้อเทมเพลต
create_time เวลาสร้างเทมเพลตอีเมล
update_time เวลาปรับปรุงเทมเพลตอีเมล

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "result": { "template_id": 82525, "name": "zhongg", "template_invoke_name": "gjtest122", "html": "This first template for apiv3", "subject": "xxxxxxx", "preview_text": "", "create_time": "2022-11-14T15:31:17+0800", "update_time": "" } }
              
              {
    "result": {
            "template_id": 82525,
            "name": "zhongg",
            "template_invoke_name": "gjtest122",
            "html": "This first template for apiv3",
            "subject": "xxxxxxx",
            "preview_text": "",
            "create_time": "2022-11-14T15:31:17+0800",
            "update_time": ""
    }
}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }
              
              {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

การลบ

URL

https://email.api.engagelab.cc/v1/templates/{template_id}
              
              https://email.api.engagelab.cc/v1/templates/{template_id}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

DELETE
              
              DELETE

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

หัวข้อ ประเภท จำเป็น คำอธิบาย
Authorization string true Basic base64(api_user:api_key)

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

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/templates/11111111'
              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates/11111111'

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

พารามิเตอร์ คำอธิบาย
count จำนวนเทมเพลตอีเมลที่ลบสำเร็จ

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "count": 1 }
              
               { "count": 1 }

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

การแก้ไข

ใช้เพื่อแก้ไขชื่อเทมเพลต เนื้อหา หัวข้อ และประเภทของเทมเพลต

URL

https://email.api.engagelab.cc/v1/templates/{template_id}
              
              https://email.api.engagelab.cc/v1/templates/{template_id}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-Type:

Content-Type: application/json;charset=utf-8
              
              Content-Type: application/json;charset=utf-8

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

PUT
              
              PUT

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

หัวข้อ ประเภท จำเป็น คำอธิบาย
Authorization string true Basic base64(api_user:api_key)

พารามิเตอร์ในเนื้อหา

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
name string ไม่ ชื่อเทมเพลตอีเมล สูงสุด 32 ตัวอักษร
template_invoke_name string ไม่ ชื่อเรียกใช้เทมเพลตอีเมล 4~64 ตัวอักษร
html string ไม่ เนื้อหาในรูปแบบ HTML
subject string ไม่ หัวข้อเทมเพลต สูงสุด 255 ตัวอักษร รองรับอีโมจิ
preview_text string ไม่ สรุปอีเมล สูงสุด 255 ตัวอักษร

หมายเหตุ:

  1. สามารถใช้ตัวแปรในเนื้อหา HTML ได้
  2. ขนาดรวมของอีเมลต้องไม่เกิน 70MB เมื่อส่ง

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

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"template_invoke_name": "myCustomTemplate"}' 'https://email.api.engagelab.cc/v1/templates/11111111'
              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"template_invoke_name": "myCustomTemplate"}'
     'https://email.api.engagelab.cc/v1/templates/11111111'

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

พารามิเตอร์ คำอธิบาย
count จำนวนเทมเพลตที่แก้ไขสำเร็จ

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "count": 1 }
              
               { 
 "count": 1 
 }

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}

            
โค้ดนี้โชว์เป็นหน้าต่างลอย
icon
ติดต่อฝ่ายขาย