简体中文
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 配置是否成功
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": 147907, "name": "alyssaop.tech", "type": 1, "spf": { "domain": "alyssaop.tech", "value": "v=spf1 include:spf.email.engagelab.com -all", "verify": false }, "dkim": { "domain": "mail._domainkey.alyssaop.tech", "value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCCDZT8FxjRHDLIUs1UNvY9IgVFuA7Y22vAtf54Erw1V4Q98TnHM7CdQEeYQyB8Ca3Kp4TXx/ThaL/sRjTB54h++W4GnXE/pDR8hvmIWyRpq87qJx/jei1MPJLpZd35uYxzO2o4NubFvNSfh8qjKH/+Y5Y7U9H7ROWjW9AkVSQETwIDAQAB", "verify": false }, "mx": { "domain": "alyssaop.tech", "value": "mx1.engagelab.com", "verify": false }, "dmarc": { "domain": "_dmarc.alyssaop.tech", "value": "v=DMARC1;p=reject;ruf=mailto:dmarc@alyssaop.tech;rua=mailto:dmarc_report@alyssaop.tech", "verify": false }, "create_time": "2023-01-09T15:39:14+0800", "update_time": "2023-01-09T15:39:14+0800" } }
          
{
    "result": {
        "domain_id": 147907,
        "name": "alyssaop.tech",
        "type": 1,
        "spf": {
            "domain": "alyssaop.tech",
            "value": "v=spf1 include:spf.email.engagelab.com -all",
            "verify": false
        },
        "dkim": {
            "domain": "mail._domainkey.alyssaop.tech",
            "value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCCDZT8FxjRHDLIUs1UNvY9IgVFuA7Y22vAtf54Erw1V4Q98TnHM7CdQEeYQyB8Ca3Kp4TXx/ThaL/sRjTB54h++W4GnXE/pDR8hvmIWyRpq87qJx/jei1MPJLpZd35uYxzO2o4NubFvNSfh8qjKH/+Y5Y7U9H7ROWjW9AkVSQETwIDAQAB",
            "verify": false
        },
        "mx": {
            "domain": "alyssaop.tech",
            "value": "mx1.engagelab.com",
            "verify": false
        },
        "dmarc": {
            "domain": "_dmarc.alyssaop.tech",
            "value": "v=DMARC1;p=reject;ruf=mailto:dmarc@alyssaop.tech;rua=mailto:dmarc_report@alyssaop.tech",
            "verify": false
        },
        "create_time": "2023-01-09T15:39:14+0800",
        "update_time": "2023-01-09T15:39:14+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 配置是否成功
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 是否配置通过（true or false）
mx 是否配置通过（true or false）
spf 是否配置通过（true or false）
dmarc 是否配置通过（true or 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": "Unauthorized." }
          {
    "code": 30000,
    "message": "Unauthorized."
}
此代码块在浮窗中显示
在文档中心打开