Blocks API

Jika Anda mengalami pendaftaran mencurigakan dan tidak ingin mengirim email ke alamat atau domain tertentu, Anda dapat menambahkan domain atau alamat email spesifik ke daftar blokir. Alamat email dalam daftar ini akan diblokir oleh sistem. Anda dapat melakukan pencarian, penambahan, dan penghapusan pada daftar ini.

Alamat Endpoint

Pusat Data	URL
Singapura	https://email.api.engagelab.cc
Turki	https://emailapi-tr.engagelab.com

Saat menggunakan REST API, pastikan pusat data yang dipilih sesuai dengan base URL yang digunakan.

POST /v1/blocks

Pencarian

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(api_user:api_key)

Deskripsi Parameter Query

Parameter	Tipe	Wajib	Deskripsi
start_date	string	ya	Tanggal mulai, format `yyyy-MM-dd`
end_date	string	ya	Tanggal akhir, format `yyyy-MM-dd`
email_or_domain	string	ya	Email atau domain (misal: `11@gmail.com`, `hotmail.com`)
api_user	string	tidak	Block API_USER, default `all`
offset	int	tidak	posisi awal, default 0
limit	int	tidak	jumlah, default 100

Tips:

Rentang waktu tidak boleh lebih dari 3 bulan.

Contoh Permintaan:

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

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
block_id	ID blokir
api_user	Block API_USER
email_or_domain	Email atau domain yang diblokir
create_time	Waktu pembuatan
expire_time	Waktu kedaluwarsa

Contoh Nilai Balik

{ "result": [ { "block_id": 122, "api_user": "all", "email_or_domain": "11@gmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" }, { "block_id": 123, "api_user": "all", "email_or_domain": "hotmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" }, { "block_id": 124, "api_user": "all", "email_or_domain": "22@yahoo.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" } ], "count": 3, "total": 10 }

              
              {
  "result": [
    {
      "block_id": 122,
      "api_user": "all",
      "email_or_domain": "11@gmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },
    {
      "block_id": 123,
      "api_user": "all",
      "email_or_domain": "hotmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },
    {
      "block_id": 124,
      "api_user": "all",
      "email_or_domain": "22@yahoo.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    }
  ],
  "count": 3,
  "total": 10
}

Tampilkan blok kode ini di jendela mengambang

Menambah

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

POST

              
              POST

Tampilkan blok kode ini di jendela mengambang

Header

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(api_user:api_key)

Deskripsi Parameter Body

Parameter	Tipe	Wajib	Deskripsi
api_user	string	tidak	Block API_USER, default `all`
email_or_domain	array	ya	Email atau domain, contoh: `["11@gmail.com","hotmail.com","22@yahoo.com"]`
expire_time	string	ya	Waktu kedaluwarsa, format `yyyy-MM-dd`

Contoh Permintaan:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"api_user": "123456abc","email_or_domain": ["11@gmail.com","hotmail.com","22@yahoo.com"],"expire_time":"2023-12-31"}' \ 'https://email.api.engagelab.cc/v1/blocks'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"api_user": "123456abc","email_or_domain": ["11@gmail.com","hotmail.com","22@yahoo.com"],"expire_time":"2023-12-31"}' \
     'https://email.api.engagelab.cc/v1/blocks'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
api_user	Block API_USER
email_or_domain	Email atau domain
create_time	Waktu pembuatan
expire_time	Waktu kedaluwarsa

Contoh Nilai Balik

{ "result": [ { "api_user": "all", "email_or_domain": "11@gmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" }, { "api_user": "all", "email_or_domain": "hotmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" }, { "api_user": "all", "email_or_domain": "22@yahoo.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" } ] }

              
              {
   "result": [
    {
      "api_user": "all",
      "email_or_domain": "11@gmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },
    {
      "api_user": "all",
      "email_or_domain": "hotmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },
    {
      "api_user": "all",
      "email_or_domain": "22@yahoo.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    }
  ]
}

Tampilkan blok kode ini di jendela mengambang

Menghapus Blokir

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Header

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(api_user:api_key)

Deskripsi Parameter Body

Parameter	Tipe	Wajib	Deskripsi
api_user	string	tidak	Block API_USER
email_or_domain	array	ya	Domain atau alamat email yang diblokir

Contoh Permintaan:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"api_user":"123456abc","email_or_domain":["xjmfc@example.com","gmail.com"]}' \ 'https://email.api.engagelab.cc/v1/blocks'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"api_user":"123456abc","email_or_domain":["xjmfc@example.com","gmail.com"]}' \
     'https://email.api.engagelab.cc/v1/blocks'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
count	Jumlah item yang berhasil dihapus

Contoh Nilai Balik

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang