Route

Anda dapat menggunakan API untuk melakukan query, menambah, mengubah, dan menghapus route penerimaan. Route yang Anda konfigurasi harus terlebih dahulu dicatat melalui konfigurasi MX. Kami dapat meneruskan pesan balasan ke kotak surat yang Anda tentukan atau mengirim pesan ke URL yang ditentukan.

Alamat Endpoint

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

Saat menggunakan REST API, pastikan data center yang dipilih sesuai dengan base URL yang benar.

POST/v1/routes

Query (Batch)

URL

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

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

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

Parameter	Tipe	Wajib	Deskripsi
offset	int	tidak	posisi offset, [0-], default 0
limit	int	tidak	jumlah, [0-100], default 100

Contoh Permintaan

curl "https://email.api.engagelab.cc/v1/routes?offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/routes?offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
route_id	ID route
expression	route penerimaan
action	URL/Email
api_user_route	Wajib diisi jika action disetel ke "Email".
create_time	waktu pembuatan
update_time	waktu modifikasi

Contoh Nilai Balik:

Response-success

HTTP Status: 200

{ "result": [ { "route_id": 1, "expression":"xjmfc", "action":"test@engagelab.com", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800", "api_user_route":"test" } ], "total": 1, "count": 1 }

              
              {
   "result": [
        {    
            "route_id": 1,
            "expression":"xjmfc",
            "action":"test@engagelab.com",
            "create_time": "2022-11-14T14:27:48+0800",
            "update_time": "2022-11-14T14:27:48+0800",
            "api_user_route":"test"
        }
    ],
    "total": 1,
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Query

URL

https://email.api.engagelab.cc/v1/routes/{route_id}

              
              https://email.api.engagelab.cc/v1/routes/{route_id}

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)

Contoh Permintaan

curl -X GET "https://email.api.engagelab.cc/v1/routes/112" \ --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \ --header "Content-Type: application/json"

              
              curl -X GET "https://email.api.engagelab.cc/v1/routes/112" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
route_id	ID route
expression	route penerimaan
action	URL/Email
api_user_route	Wajib diisi jika action disetel ke "Email".
create_time	waktu pembuatan
update_time	waktu modifikasi

Contoh Nilai Balik:

Response-success

HTTP Status: 200

{ "result": { "route_id": 1, "expression":"xjmfc", "action":"test@engagelab.com", "api_user_route": "sctest", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }

              
              {
   "result": {    
        "route_id": 1,
        "expression":"xjmfc",
        "action":"test@engagelab.com",
        "api_user_route": "sctest",
        "create_time": "2022-11-14T14:27:48+0800",
        "update_time": "2022-11-14T14:27:48+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Tambah

Setiap pengguna dapat menambah hingga 1000 route penerimaan.

URL

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

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

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

Parameter	Tipe	Wajib	Deskripsi
expression	string	ya	route penerimaan. Format: 'regular expression@domain'; juga bisa berupa alamat email spesifik. Domain/email domain harus sudah diverifikasi atau dapat digunakan.
action	string	ya	URL/Email
api_user_route	string	*	Wajib diisi jika action disetel ke "Email". Saat meneruskan ke email, API-USER ini yang digunakan untuk pengiriman.

Contoh Permintaan

curl -X POST "https://email.api.engagelab.cc/v1/routes" \ --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \ --header "Content-Type: application/json" \ --data '{ "expression":"hongkong@aizl.net", "action":"test@engagelab.com" }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/routes" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
  "expression":"hongkong@aizl.net",
  "action":"test@engagelab.com"
}'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
route_id	ID route
expression	route penerimaan
action	URL /Email
api_user_route	Wajib diisi jika action disetel ke "Email".
create_time	waktu pembuatan
update_time	waktu modifikasi

Contoh Nilai Balik:

{ "result": { "route_id": 598802, "expression":".*@123.com", "action":"test@engagelab.com", "api_user_route":"test233", "create_time": "2022-11-14T14:27:34+0800", "update_time": "2022-11-14T14:27:34+0800" } }

              
              {
   "result": {
        "route_id": 598802,
        "expression":".*@123.com",
        "action":"test@engagelab.com",
        "api_user_route":"test233",
        "create_time": "2022-11-14T14:27:34+0800",
        "update_time": "2022-11-14T14:27:34+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Ubah

URL

https://email.api.engagelab.cc/v1/routes/{route_id}

              
              https://email.api.engagelab.cc/v1/routes/{route_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

PUT

PUT

Tampilkan blok kode ini di jendela mengambang

Header

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

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
expression	string	*	route penerimaan
action	string	*	URL/Email
api_user_route	string	*	Wajib diisi jika action disetel ke "Email".

Contoh Permintaan

curl -X PUT "https://email.api.engagelab.cc/v1/routes/12333" \ --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \ --header "Content-Type: application/json" \ --data '{ "expression":"travel", "action":"test@engagelab.com" }'

              
              curl -X PUT "https://email.api.engagelab.cc/v1/routes/12333" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
  "expression":"travel",
  "action":"test@engagelab.com"
}'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
count	jumlah route penerimaan yang diubah

Contoh Nilai Balik:

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Response-error

HTTP Status: 401

{ "code": 30000, "message": "Autentikasi gagal." }

              
              {
    "code": 30000,
    "message": "Autentikasi gagal."
}

Tampilkan blok kode ini di jendela mengambang

Hapus

URL

https://email.api.engagelab.cc/v1/routes/{route_id}

              
              https://email.api.engagelab.cc/v1/routes/{route_id}

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)

Contoh Permintaan

curl -X DELETE "https://email.api.engagelab.cc/v1/routes/21122" \ --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://email.api.engagelab.cc/v1/routes/21122" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
count	jumlah route penerimaan yang dihapus

Contoh Nilai Balik:

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang