กฎทั่วไป

รูปแบบการร้องขอ API

https://email.api.engagelab.cc/v1/<module>/<action>

Module: ชื่อของโมดูลฟังก์ชัน ตัวอย่างเช่น: mail (โมดูลอีเมล), address_list (รายการที่อยู่) เป็นต้น

Action: การดำเนินการของแต่ละโมดูล เช่น การส่ง การเพิ่ม

รหัสการตอบกลับ API

ผลลัพธ์ที่ส่งคืนโดย API อยู่ในรูปแบบ JSON ดังตัวอย่างด้านล่าง:

              
              # ร้องขอสำเร็จ
{
 
  "result": {}
}
# การตรวจสอบสิทธิ์ล้มเหลว
{
  "code": 30000,
  "message": "Authentication failed",
}

# การดึงข้อมูลสำเร็จ
{
    
   "total": 28,
   "count": 28,
   "result": [
            {
                "label_id": 598802,
                "label_name": "xjm226",
                "create_time": "2022-11-10T15:47:05+0800",
                "update_time": "2022-11-10T15:47:05+0800"
            }
        ]
    
}

            

• httpStatus: 200
• result: Data information

รหัสสถานะ HTTP

คำอธิบายรูปแบบอีเมล

รูปแบบที่อยู่อีเมล: local_part@domain_part ซึ่งประกอบด้วย local_part, @ และ domain_part ที่อยู่อีเมลที่ถูกต้องต้องปฏิบัติตามกฎดังต่อไปนี้:

• local_part@domain_part ต้องมีความยาวอย่างน้อย 6 ตัวอักษรและไม่เกิน 128 ตัวอักษร;
• ความยาวสูงสุดของสตริง local_part คือ 96 ตัวอักษร และไม่สามารถมีตัวอักษร @;
• domain_part สามารถมีเฉพาะ a-zA-Z0-9-. และไม่สามารถเริ่มต้นหรือสิ้นสุดด้วย - โดยมีความยาวรวมไม่เกิน 255 ตัวอักษร แต่ละส่วนไม่เกิน 63 ตัวอักษร และโดเมนระดับบนสุดต้องประกอบด้วยตัวอักษรภาษาอังกฤษตัวพิมพ์ใหญ่หรือตัวพิมพ์เล็ก 2~20 ตัวอักษร;

พจนานุกรมเขตเวลา

พจนานุกรมเขตเวลาปฏิทิน

อัตราพจนานุกรม

เงื่อนไขการกรอง

โครงสร้างเงื่อนไขการกรอง

              
              {
    "condition": {
        "relation": "or",
        "items": [
            {
                "field_name": "createTime",
                "op": ">=",
                "value": "2021-10-11"
            },
            {
                "field_name": "Name",
                "op": "contain",
                "value": "left"
            }
        ]
    }
}

# เงื่อนไขการกรอง: createTime >= '2021-10-11' หรือ Name มีคำว่า 'Left'

            

คำอธิบายเงื่อนไขการกรอง