Aturan

Pusat Data dan URL Dasar

Saat menggunakan REST API, pastikan pusat data yang dipilih sesuai dengan URL dasar yang benar.

POST/v1/mail/<modul>

Format Permintaan API

https://email.api.engagelab.cc/v1/<modul>/<aksi>

Modul: nama modul fungsi, misal modul mail, modul addresslist.

Aksi: aksi dari setiap modul, misal send, add.

Kode Pengembalian API

API mengembalikan data dalam format JSON. Contoh sebagai berikut:

              
              # permintaan berhasil
{
  "result": {}
}
# Autentikasi gagal
{
  "code": 30000,
  "message": "Authentication failed",
}
# Pengambilan data berhasil
{
   "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: Informasi data

Kode status HTTP

Deskripsi Format Alamat Email

Format alamat email: local_part@domain_part, terdiri dari local_part, @, dan domain_part. Alamat email yang valid harus memenuhi aturan berikut:

• local_part@domain_part panjang minimal 6 karakter dan maksimal 128 karakter;
• local_part maksimal 96 karakter dan tidak boleh mengandung karakter @;
• domain_part hanya boleh berisi a-zA-Z0-9 -. Tidak boleh diawali atau diakhiri dengan -. Total panjang tidak melebihi 255 karakter, dan setiap segmen tidak lebih dari 63 karakter. Top-level domain hanya boleh terdiri dari 2 hingga 20 huruf alfabet (besar/kecil);

Kamus Zona Waktu

Kamus Zona Waktu Kalender

Kamus Rate

Kondisi Filter

Struktur Kondisi Filter

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

# Kondisi filter: createTime >= '2021-10-11' atau Name mengandung 'left'

            

Penjelasan Kondisi Filter