Pengirim

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 benar.

POST/v1/marketing/senders

Membuat

URL

https://email.api.engagelab.cc/v1/marketing/senders

              
              https://email.api.engagelab.cc/v1/marketing/senders

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

POST

              
              POST

Tampilkan blok kode ini di jendela mengambang

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Parameter Body

Parameter	Tipe	Wajib	Deskripsi
from_name	string	ya	Nama pengirim
email	string	ya	Alamat email pengirim. Harus dalam format email dan memiliki domain sesuai dengan domain_name.
domain_name	string	ya	Nama domain (harus sudah dikonfigurasi)
api_user	string	ya	Nama ApiUser

Catatan:

domain_name dan api_user harus saling sesuai.

Contoh Permintaan

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders --data '{ "from_name": "Linghu", "email": "xjmfc@126.com", "domain_name": "126.com", "api_user": "test_abc" }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders --data '{
  "from_name": "Linghu",
  "email": "xjmfc@126.com",
  "domain_name": "126.com",
  "api_user": "test_abc"
}'

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Respons-Berhasil

HttpStatus: 200

{ "result": { "sender_id": 449, "name": "Qiaofeng2", "email": "zhou@aizl.net", "domain_id": 147886, "domain_name": "aizl.net", "api_user": "xiaojinmin_new", "create_time": "2022-05-24T14:04:19+0800", "update_time": "2022-05-24T15:35:09+0800" } }

              
              {
     "result": {
        "sender_id": 449,
        "name": "Qiaofeng2",
        "email": "zhou@aizl.net",
        "domain_id": 147886,
        "domain_name": "aizl.net",
        "api_user": "xiaojinmin_new",
        "create_time": "2022-05-24T14:04:19+0800",
        "update_time": "2022-05-24T15:35:09+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

HttpStatus: 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/marketing/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Contoh Permintaan

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/857

              
              curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/857

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Respons-Berhasil

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Perbarui

URL

https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

PUT

PUT

Tampilkan blok kode ini di jendela mengambang

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Parameter Body

Parameter	Tipe	Wajib	Deskripsi
from_name	string	tidak	Nama pengirim
email	string	tidak	Alamat pengirim, harus dalam format email dengan domain_name sebagai akhiran domain
domain_name	string	tidak	Domain (harus sudah dikonfigurasi)
api_user	string	tidak	Nama API_USER

Catatan:

Nilai dari from_name, email, domain_name, dan api_user tidak boleh berupa string kosong atau null.

Contoh Permintaan

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/37 --data '{ "from_name": "Linghu", "email": "xjmfc@126.com", "domain_name": "test.com", "api_user": "test_abc" }'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/37 --data '{
  "from_name": "Linghu",
  "email": "xjmfc@126.com",
  "domain_name": "test.com",
  "api_user": "test_abc"
}'

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Respons-Berhasil

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Detail Pengirim

URL

https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

GET

GET

Tampilkan blok kode ini di jendela mengambang

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Contoh Permintaan

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/1

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/1

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Respons-Berhasil

HttpStatus: 200

              
              {
    "result": {
        "sender_id": 449,
        "name": "Qiaofeng2",
        "email": "zhou@aizl.net",
        "domain_id": 147886,
        "domain_name": "aizl.net",
        "api_user": "xiaojinmin_new",
        "create_time": "2022-05-24T14:04:19+0800",
        "update_time": "2022-05-24T15:35:09+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Daftar Pengirim

URL

https://email.api.engagelab.cc/v1/marketing/senders

              
              https://email.api.engagelab.cc/v1/marketing/senders

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

GET

GET

Tampilkan blok kode ini di jendela mengambang

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Parameter Query

Parameter	Tipe	Wajib	Deskripsi
limit	integer	tidak	Jumlah data yang diambil, rentang: [1-100], default: 10
offset	integer	tidak	Posisi awal untuk query, rentang: [0-], default: 0

Contoh Permintaan

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders?offset=0&limit=10

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders?offset=0&limit=10

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Parameter	Tipe	Deskripsi
list	array[object]	Daftar pengirim
sender_id	integer	ID Pengirim
name	string	Nama pengirim
email	string	Alamat email pengirim
domain_id	integer	ID Domain
domain_name	string	Nama domain
api_user	string	Nama APIUSER
create_time	string	Waktu pembuatan
update_time	string	Waktu pembaruan
total	integer	Jumlah total data

Contoh Respons

Respons-Berhasil

HttpStatus: 200

{ "result": [ { "sender_id": 388, "name": "xjmfc", "email": "xjmfc@aizl.net", "domain_id": 147886, "domain_name": "aizl.net", "api_user": "xiaojinmin", "create_time": "2022-05-24T14:04:19+0800", "update_time": "2022-05-24T15:35:09+0800" } ], "total": 3, "count": 1 }

              
              {
    "result": [
        {
            "sender_id": 388,
            "name": "xjmfc",
            "email": "xjmfc@aizl.net",
            "domain_id": 147886,
            "domain_name": "aizl.net",
            "api_user": "xiaojinmin",
            "create_time": "2022-05-24T14:04:19+0800",
            "update_time": "2022-05-24T15:35:09+0800"
        }
    ],
    "total": 3,
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

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

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

Tampilkan blok kode ini di jendela mengambang