繁體中文
English
繁體中文
简体中文
にほんご
ภาษาไทย
登入 註冊
icon AppPush icon WebPush icon WhatsApp icon Email icon SMS icon OTP
EngageLab 檔案 > Email > REST API > 域名
EngageLab 檔案 > Email > REST API > 域名

域名

最新更新：2023-03-14

用戶需要配寘發信域名才能正常的發送郵件。

你可以使用 API 進行域名的査詢，添加，修改操作。

査詢（批量査詢）

通過此接口査詢域名的基本資訊

URL

https://email.api.engagelab.cc/v1/domains
          https://email.api.engagelab.cc/v1/domains
此代碼塊在浮窗中顯示

HTTP 請求方式

GET
          GET
此代碼塊在浮窗中顯示

請求 Headers

Header 類型 必須 說明
Authorization String true Basic base64(api_user:api_key)

Query 參數說明

參數 類型 必須 說明
name string 否 域名名稱。多個 name 用; 分隔
type int 否 域名類型：0（測試域名），1（普通域名）

請求示例

curl "https://email.api.engagelab.cc/v1/domains?name=engagelab.com" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
          curl "https://email.api.engagelab.cc/v1/domains?name=engagelab.com" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代碼塊在浮窗中顯示

響應說明

字段 說明
domain_id 域名 ID
name 域名名稱
type 域名類型
spf spf 記錄
domain SPF 的主機記錄
value 此域名 SPF 需要配寘的值
verify 配寘是否成功（true or false）
dkim dkim 記錄
domain 此域名 DKIM 的主機記錄
value 此域名 DKIM 需要配寘的值
verify 配寘是否成功（true or false）
mx mx 記錄
domain 此域名 MX 的主機記錄
value 此域名 MX 需要配寘的值
verify 配寘是否成功（true or false）
dmarc Dmarc 記錄
domain 此域名 Dmarc 的主機記錄
value 此域名 Dmarc 需要配寘的值
verify 配寘是否成功（true or 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": "Unauthorized." }
          { 
    "code": 30000,
    "message": "Unauthorized."
}
此代碼塊在浮窗中顯示

添加

通過此接口添加域名

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
此代碼塊在浮窗中顯示

請求 Headers

Header 類型 必須 說明
Authorization String true Basic base64(api_user:api_key)

Body 參數說明

參數 類型 必須 說明
name string 是 域名名稱。需符合域名格式，只能包含 [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",
}'
此代碼塊在浮窗中顯示

響應說明

返回符合條件所有域名訊息。

字段 說明
domain_id 域名 ID
name 域名名稱
type 域名類型
spf spf 記錄
domain SPF 的主機記錄
value 此域名 SPF 的配寘值
verify 配寘是否成功 (true or false)
dkim dkim 記錄
domain 此域名 DKIM 的主機記錄
value 此域名 DKIM 配寘值
verify 配寘是否成功 (true or false)
mx mx 記錄
domain 此域名 MX 的主機記錄
value 此域名 MX 配寘的值
verify 配寘是否成功 (true or false)
dmarc Dmarc 記錄
domain 此域名 Dmarc 的主機記錄
value 此域名 Dmarc 配寘的值
verify 配寘是否成功 (true or 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}
此代碼塊在浮窗中顯示

HTTP 請求方式

PUT
          PUT
此代碼塊在浮窗中顯示

請求 Headers

Header 類型 必須 說明
Authorization String true Basic base64(api_user:api_key)

Body 參數說明

參數 類型 必須 說明
name string 是 新域名名稱。需符合域名格式，只能包含 [0-9a-zA-Z-.]，4~255 個字符，例如：mail.test.best。

說明

已有配寘項驗證通過的域名不能修改

請求示例

curl -X PUT "https://email.engagelab.com/v1/domains/22332" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "name":"aizl.net", }'
          
curl -X PUT "https://email.engagelab.com/v1/domains/22332" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "name":"aizl.net",
}'
此代碼塊在浮窗中顯示

響應說明

返回符合條件所有域名資訊。

字段 說明
domain_id 域名 ID
name 域名名稱
type 域名類型
verify 域名驗證值
spf spf 記錄
domain SPF 的主機記錄
value 此域名 SPF 的配寘值
verify 配寘是否成功 (true or false)
dkim dkim 記錄
domain 此域名 DKIM 的主機記錄
value 此域名 DKIM 配寘的值
verify 配寘是否成功 (true or false)
mx mx 記錄
domain 此域名 MX 的主機記錄
value 此域名 MX 配寘的值
verify 配寘是否成功 (true or false)
dmarc Dmarc 記錄
domain 此域名 Dmarc 的主機記錄
value 此域名 Dmarc 配寘的值
verify 配寘是否成功 (true or 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"
}
此代碼塊在浮窗中顯示

驗證

通過此接口驗證域名（數據每 10min 更新一次）

URL

https://email.api.engagelab.cc/v1/domains/check
          https://email.api.engagelab.cc/v1/domains/check
此代碼塊在浮窗中顯示

HTTP 請求方式

get
          get
此代碼塊在浮窗中顯示

請求 Headers

Header 類型 必須 說明
Authorization String true Basic base64(api_user:api_key)

Query 參數說明

參數 類型 必須 說明
name string 否 域名名稱。多個用; 分隔。

說明

返回已有域名的配寘是否通過

請求示例

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>>"
此代碼塊在浮窗中顯示

響應說明

返回符合條件所有域名資訊。

字段 說明
name 域名名稱
type 域名類型
config 配寘資訊
─dkim 是否配寘
─mx 是否配寘
─spf 是否配寘
─dmarc 是否配寘
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": 0, } ] }
          {
        "result": [
            {
                "name": "abc.com",
                "type": 1,
                "config": {
                    "dkim": false,
                    "mx": false,
                    "spf": false,
                    "dmarc": false
                },
                "status": 0,
            }
        ]
    
}
此代碼塊在浮窗中顯示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          {
    "code": 30000,
    "message": "Unauthorized."
}
此代碼塊在浮窗中顯示
在文档中心打开