ชื่อโดเมน
ผู้ใช้จำเป็นต้องกำหนดค่าโดเมนการส่งเพื่อส่งอีเมลได้ตามปกติ
คุณสามารถใช้ API เพื่อสอบถาม เพิ่ม และแก้ไขชื่อโดเมน
ที่อยู่การโทร
| ศูนย์ข้อมูล | URL |
|---|---|
| สิงคโปร์ | https://email.api.engagelab.cc |
| ตุรกี | https://emailapi-tr.engagelab.com |
เมื่อใช้ REST API ให้แน่ใจว่าศูนย์ข้อมูลที่เลือกตรงกับ URL พื้นฐานที่เหมาะสม
POST/v1/domains
การสอบถาม (การสอบถามแบบกลุ่ม)
ใช้อินเทอร์เฟซนี้เพื่อสอบถามข้อมูลพื้นฐานเกี่ยวกับชื่อโดเมน
URL
https://email.api.engagelab.cc/v1/domains
https://email.api.engagelab.cc/v1/domains
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์การสอบถาม
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | No | ชื่อโดเมน ชื่อหลายชื่อคั่นด้วย ; |
| type | int | No | ประเภทโดเมน: 0 (โดเมนทดสอบ), 1 (โดเมนปกติ) |
ตัวอย่างคำร้องขอ
curl "https://email.api.engagelab.cc/v1/domains?name=engagelab.com;xjm.cc" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/domains?name=engagelab.com;xjm.cc" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| Field | Description |
|---|---|
| domain_id | รหัสโดเมน |
| name | ชื่อโดเมน |
| type | ประเภทโดเมน |
| spf | ระเบียน SPF |
| domain | ระเบียนโฮสต์ SPF |
| value | ค่าการกำหนดค่า SPF สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ (true หรือ false) |
| dkim | ระเบียน DKIM |
| domain | ระเบียนโฮสต์ DKIM สำหรับโดเมนนี้ |
| value | ค่าการกำหนดค่า DKIM สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ (true หรือ false) |
| mx | ระเบียน MX |
| domain | ระเบียนโฮสต์ MX สำหรับโดเมนนี้ |
| value | ค่าการกำหนดค่า MX สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ (true หรือ false) |
| dmarc | ระเบียน DMARC |
| domain | ระเบียนโฮสต์ DMARC สำหรับโดเมนนี้ |
| value | ค่าการกำหนดค่า DMARC สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ (true หรือ false) |
| create_time | เวลาสร้างโดเมน |
| update_time | เวลาปรับปรุงโดเมน |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"result": [
{
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
],
"count": 1
}
{
"result": [
{
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
],
"count": 1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การเพิ่ม
ใช้อินเทอร์เฟซนี้เพื่อเพิ่มชื่อโดเมน
URL
https://email.api.engagelab.cc/v1/domains
https://email.api.engagelab.cc/v1/domains
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
POST
POST
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์ในเนื้อหา
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | ชื่อโดเมน ต้องเป็นไปตามรูปแบบโดเมน สามารถมีได้เฉพาะ [0-9a-zA-Z-.] ความยาว 4~255 ตัวอักษร เช่น mail.test.best |
หมายเหตุ
1.ผู้ใช้แต่ละคนสามารถเพิ่มโดเมนได้สูงสุด 5 โดเมน
1.ผู้ใช้แต่ละคนสามารถเพิ่มโดเมนได้สูงสุด 5 โดเมน
โค้ดนี้โชว์เป็นหน้าต่างลอย
ตัวอย่างคำร้องขอ
curl -X POST "https://email.api.engagelab.cc/v1/domains"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"m1314520.com",
}'
curl -X POST "https://email.api.engagelab.cc/v1/domains"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"m1314520.com",
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
ส่งคืนข้อมูลโดเมนทั้งหมดที่ตรงตามเกณฑ์
| Field | Description |
|---|---|
| domain_id | รหัสโดเมน |
| name | ชื่อโดเมน |
| type | ประเภทโดเมน |
| spf | ระเบียน SPF |
| domain | ระเบียนโฮสต์ SPF |
| value | ค่าการกำหนดค่า SPF สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ |
| dkim | ระเบียน DKIM |
| domain | ระเบียนโฮสต์ DKIM สำหรับโดเมนนี้ |
| value | ค่าการกำหนดค่า DKIM สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ (true หรือ false) |
| mx | ระเบียน MX |
| domain | ระเบียนโฮสต์ MX สำหรับโดเมนนี้ |
| value | ค่าการกำหนดค่า MX สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ (true หรือ false) |
| dmarc | ระเบียน DMARC |
| domain | ระเบียนโฮสต์ DMARC สำหรับโดเมนนี้ |
| value | ค่าการกำหนดค่า DMARC สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ (true หรือ false) |
| create_time | เวลาสร้างโดเมน |
| update_time | เวลาปรับปรุงโดเมน |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
}
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :400
{
"code": 31003,
"message": "Domain name format error"
}
{
"code": 31003,
"message": "Domain name format error"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การแก้ไข
ใช้อินเทอร์เฟซนี้เพื่อแก้ไขชื่อโดเมน
URL
https://email.api.engagelab.cc/v1/domains/{domain_id}
https://email.api.engagelab.cc/v1/domains/{domain_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
PUT
PUT
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์ในเนื้อหา
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | ชื่อโดเมนใหม่ ต้องเป็นไปตามรูปแบบโดเมน สามารถมีได้เฉพาะ [0-9a-zA-Z-.] ความยาว 4~255 ตัวอักษร เช่น mail.test.best |
หมายเหตุ
ไม่สามารถแก้ไขโดเมนที่มีการตรวจสอบรายการการกำหนดค่าแล้ว
ตัวอย่างคำร้องขอ
curl -X PUT "https://email.api.engagelab.cc/v1/domains/22332"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"aizl.net",
}'
curl -X PUT "https://email.api.engagelab.cc/v1/domains/22332"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"aizl.net",
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
ส่งคืนข้อมูลโดเมนทั้งหมดที่ตรงตามเกณฑ์
| Field | Description |
|---|---|
| domain_id | รหัสโดเมน |
| name | ชื่อโดเมน |
| type | ประเภทโดเมน |
| verify | ค่าการตรวจสอบโดเมน |
| spf | ระเบียน SPF |
| domain | ระเบียนโฮสต์ SPF |
| value | ค่าการกำหนดค่า SPF สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ (true หรือ false) |
| dkim | ระเบียน DKIM |
| domain | ระเบียนโฮสต์ DKIM สำหรับโดเมนนี้ |
| value | ค่าการกำหนดค่า DKIM สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ |
| mx | ระเบียน MX |
| domain | ระเบียนโฮสต์ MX สำหรับโดเมนนี้ |
| value | ค่าการกำหนดค่า MX สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ (true หรือ false) |
| dmarc | ระเบียน DMARC |
| domain | ระเบียนโฮสต์ DMARC สำหรับโดเมนนี้ |
| value | ค่าการกำหนดค่า DMARC สำหรับโดเมนนี้ |
| verify | การกำหนดค่าสำเร็จ (true หรือ false) |
| create_time | เวลาสร้างโดเมน |
| update_time | เวลาปรับปรุงโดเมน |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-11-22T13:39:05+0800"
}
}
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-11-22T13:39:05+0800"
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :400
{
"code": 31003,
"message": "Domain name format error"
}
{
"code": 31003,
"message": "Domain name format error"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การตรวจสอบ
ใช้อินเทอร์เฟซนี้เพื่อตรวจสอบชื่อโดเมน (ข้อมูลจะอัปเดตทุก 10 นาที)
URL
https://email.api.engagelab.cc/v1/domains/check
https://email.api.engagelab.cc/v1/domains/check
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| Header | Type | Required | Type |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์การสอบถาม
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | No | ชื่อโดเมน ชื่อหลายชื่อคั่นด้วย ; |
หมายเหตุ
ส่งคืนว่าการกำหนดค่าของโดเมนที่มีอยู่ผ่านหรือไม่
ตัวอย่างคำร้องขอ
curl -X POST "https://email.api.engagelab.cc/v1/domains/check?name=aizl.net;m1214520.com"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X POST "https://email.api.engagelab.cc/v1/domains/check?name=aizl.net;m1214520.com"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
ส่งคืนข้อมูลโดเมนทั้งหมดที่ตรงตามเกณฑ์
| Field | Description |
|---|---|
| name | ชื่อโดเมน |
| type | ประเภทโดเมน |
| config | ข้อมูลการกำหนดค่า |
| dkim | การกำหนดค่าผ่าน (true หรือ false) |
| mx | การกำหนดค่าผ่าน (true หรือ false) |
| spf | การกำหนดค่าผ่าน (true หรือ false) |
| dmarc | การกำหนดค่าผ่าน (true หรือ false) |
| status | 0 หมายถึงไม่สามารถใช้งานได้; 1 หมายถึงสามารถใช้งานได้; 2 หมายถึงผ่าน |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"result": [
{
"name": "abc.com",
"type": 1,
"config": {
"dkim": false,
"mx": false,
"spf": false,
"dmarc": false
},
"status": 2,
}
]
}
{
"result": [
{
"name": "abc.com",
"type": 1,
"config": {
"dkim": false,
"mx": false,
"spf": false,
"dmarc": false
},
"status": 2,
}
]
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
