追蹤域名
管理您的追蹤域名。
查詢
獲取追蹤域名列表
URL
https://email.api.engagelab.cc/v1/tracking-domains
https://email.api.engagelab.cc/v1/tracking-domains
此代碼塊在浮窗中顯示
HTTP 請求方法
GET
GET
此代碼塊在浮窗中顯示
請求 Headers
| Headers | 類型 | 是否必填 | 描述 |
|---|---|---|---|
| Authorization | String | true | Basic base64(apiUser:apiKey) |
查詢參數描述
| 參數 | 類型 | 是否必填 | 描述 |
|---|---|---|---|
| name | string | 否 | 域名 |
| offset | int | 否 | 偏移位置，[0-]，預設為 0 |
| limit | int | 否 | 數量，[0-100]，預設為 100 |
請求範例
curl "https://email.api.engagelab.cc/v1/tracking-domains?name=engagelab.com"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/tracking-domains?name=engagelab.com"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代碼塊在浮窗中顯示
返回值描述
| 參數 | 描述 |
|---|---|
| domain_id | 域名 ID |
| name | 域名名稱 |
| cname | 有關域名 CNAME 記錄的詳細資訊 |
| verify | 配置是否成功（true 或 false） |
| verify_message | 描述 CNAME 記錄的訊息，若記錄正確則為 null |
| required_record | 要配置的 CNAME 記錄 |
| existed_record | 使用者配置的 CNAME 記錄 |
| cert | 有關域名證書的詳細資訊 |
| verify | 配置是否成功（true 或 false） |
| verify_message | 證書未上傳、證書正在配置、證書已生效、證書已過期 |
| expired_date | 過期日期 |
| create_time | 域名創建時間 |
| update_time | 域名修改時間 |
返回值範例
Response-success
HTTP Status: 200
{
"result": [
{
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
},
{
"domain_id": 1000402,
"name": "track.myMail.com",
"create_time": "2025-04-18T13:05:57+0800",
"update_time": "2025-04-18T13:05:57+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
},
"cert": {
"verify": false,
"verify_message": "the certificate has not been uploaded",
"expired_date": ""
}
}
],
"total": 2,
"count": 2
}
{
"result": [
{
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
},
{
"domain_id": 1000402,
"name": "track.myMail.com",
"create_time": "2025-04-18T13:05:57+0800",
"update_time": "2025-04-18T13:05:57+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
},
"cert": {
"verify": false,
"verify_message": "the certificate has not been uploaded",
"expired_date": ""
}
}
],
"total": 2,
"count": 2
}
此代碼塊在浮窗中顯示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代碼塊在浮窗中顯示
添加
將追蹤域名添加至您的帳戶。
URL
https://email.api.engagelab.cc/v1/tracking-domains
https://email.api.engagelab.cc/v1/tracking-domains
此代碼塊在浮窗中顯示
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
此代碼塊在浮窗中顯示
HTTP 請求方法
POST
POST
此代碼塊在浮窗中顯示
請求 Headers
| Headers | 類型 | 是否必填 | 描述 |
|---|---|---|---|
| Authorization | String | true | Basic base64(apiUser:apiKey) |
Body 參數描述
| 參數 | 類型 | 是否必填 | 描述 |
|---|---|---|---|
| name | string | 是 | 域名名稱 |
提示：
您最多可以新增 5 個自定義追蹤域名。一旦配置驗證成功，域名名稱將無法修改。不正確的配置可能導致電子郵件中的鏈接無法點擊、追蹤數據不準確等。
由於 Chrome 和其他瀏覽器的升級，未來將禁止加載 HTTP 資源，這可能導致內容被錯誤標記（例如，不安全）並引起追蹤數據問題。強烈建議上傳 HTTPS 配置的 SSL 證書並啟用 HTTPS 追蹤。
請求範例
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"track.leonww.asia"
}'
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"track.leonww.asia"
}'
此代碼塊在浮窗中顯示
返回值描述
| 參數 | 描述 |
|---|---|
| domain_id | 域名 ID |
| name | 域名名稱 |
| cname | 有關域名 CNAME 記錄的詳細資訊 |
| verify | 配置是否成功（true 或 false） |
| verify_message | 描述 CNAME 記錄的訊息，若記錄正確則為 null |
| required_record | 要配置的 CNAME 記錄 |
| existed_record | 現有的 CNAME 記錄 |
| create_time | 域名創建時間 |
| update_time | 域名修改時間 |
返回值範例
Response-success
HTTP Status: 200
{
"result":
{
"domain_id": 1000423,
"name": "track.leonww.asia",
"create_time": "2025-09-03T13:42:41+0800",
"update_time": "2025-09-03T13:42:41+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
}
}
}
{
"result":
{
"domain_id": 1000423,
"name": "track.leonww.asia",
"create_time": "2025-09-03T13:42:41+0800",
"update_time": "2025-09-03T13:42:41+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
}
}
}
此代碼塊在浮窗中顯示
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/tracking-domains/{domain_id}
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}
此代碼塊在浮窗中顯示
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
此代碼塊在浮窗中顯示
HTTP 請求方法
PUT
PUT
此代碼塊在浮窗中顯示
請求Headers
| Header | 類型 | 是否必填 | 描述 |
|---|---|---|---|
| Authorization | String | true | Basic base64(apiUser:apiKey) |
Body 參數描述
| 參數 | 類型 | 是否必填 | 描述 |
|---|---|---|---|
| name | string | 是 | 域名名稱。必須符合域名格式，只能包含字母數字字符、連字號（-）和句號（.），且長度必須在 4 到 255 個字符之間（例如 mail.test.best）。 |
請求範例
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-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/tracking-domains/22332"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"aizl.net",
}'
此代碼塊在浮窗中顯示
返回值範例
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
此代碼塊在浮窗中顯示
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/tracking-domains/{domain_id}/verify
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
此代碼塊在浮窗中顯示
HTTP 請求方法
GET
GET
此代碼塊在浮窗中顯示
注意
返回已驗證配置的域名。
返回已驗證配置的域名。
此代碼塊在浮窗中顯示
請求示例
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/verify"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/verify"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代碼塊在浮窗中顯示
返回值描述
| 參數 | 描述 |
|---|---|
| domain_id | 域名 ID |
| name | 域名名稱 |
| cname | 有關域名 CNAME 記錄的詳細資訊 |
| verify | 配置是否成功（true 或 false） |
| verify_message | 描述 CNAME 記錄的訊息，若記錄正確則為 null |
| required_record | 要配置的 CNAME 記錄 |
| existed_record | 現有的 CNAME 記錄 |
| cert | 有關域名證書的詳細資訊 |
| verify | 配置是否成功（true 或 false） |
| verify_message | 證書未上傳、證書正在配置、證書已生效、證書已過期 |
| expired_date | 過期日期 |
| create_time | 域名創建時間 |
| update_time | 域名修改時間 |
返回值範例
Response-success
HTTP Status: 200
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
此代碼塊在浮窗中顯示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代碼塊在浮窗中顯示
添加證書
添加追蹤域名的證書
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
此代碼塊在浮窗中顯示
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
此代碼塊在浮窗中顯示
HTTP 請求方法
POST
POST
此代碼塊在浮窗中顯示
Body 參數描述
| 參數 | 類型 | 是否必填 | 描述 |
|---|---|---|---|
| cert_content | string | 是 | 表示證書內容。該值必須為 PEM 編碼格式。 |
| cert_key | string | 是 | 表示證書私鑰。該值必須為 PEM 編碼格式。 |
請求範例
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--data '{
"cert_content":"...",
"cert_key":"...",
}'
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--data '{
"cert_content":"...",
"cert_key":"...",
}'
此代碼塊在浮窗中顯示
返回值描述
| 參數 | 描述 |
|---|---|
| domain_id | 域名 ID |
| name | 域名名稱 |
| cert | 有關域名證書的詳細資訊 |
| verify | 配置是否成功（true 或 false） |
| verify_message | 證書未上傳、證書正在配置、證書已生效、證書已過期 |
| expired_date | 過期日期 |
| create_time | 域名創建時間 |
| update_time | 域名修改時間 |
返回值範例
Response-success
HTTP Status: 200
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cert": {
"verify": false,
"verify_message": "the certificate is being configured",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cert": {
"verify": false,
"verify_message": "the certificate is being configured",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
此代碼塊在浮窗中顯示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代碼塊在浮窗中顯示
更新證書
更新追蹤域名的證書
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
此代碼塊在浮窗中顯示
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
此代碼塊在浮窗中顯示
HTTP 請求方法
PUT
PUT
此代碼塊在浮窗中顯示
Body 參數描述
| 參數 | 類型 | 是否必填 | 描述 |
|---|---|---|---|
| cert_content | string | 是 | 表示證書內容。該值必須為 PEM 編碼格式。 |
| cert_key | string | 是 | 表示證書私鑰。該值必須為 PEM 編碼格式。 |
請求範例
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代碼塊在浮窗中顯示
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
此代碼塊在浮窗中顯示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代碼塊在浮窗中顯示
更新 API_USER
更新與 API_USER 關聯的追蹤域名和追蹤開關配置
URL
https://email.api.engagelab.cc/v1/api_users/{api_user}
https://email.api.engagelab.cc/v1/api_users/{api_user}
此代碼塊在浮窗中顯示
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
此代碼塊在浮窗中顯示
HTTP 請求方法
PUT
PUT
此代碼塊在浮窗中顯示
Body 參數描述
| 參數 | 類型 | 是否必填 | 描述 |
|---|---|---|---|
| domain_name | string | 否 | 綁定到 API_USER 的域名 |
| track_domain_name | string | 否 | 綁定到 API_USER 的追蹤域名 |
| open_tracking | boolean | 否 | 是否啟用開啟追蹤。值：false（禁用），true（啟用）。預設為 false。 |
| click_tracking | boolean | 否 | 是否啟用點擊追蹤。值：false（禁用），true（啟用）；預設為 false。 |
| unsubscribe_tracking | boolean | 否 | 是否啟用退訂追蹤。值：false（禁用），true（啟用）；預設為 true。 |
請求範例
curl -X PUT "https://email.api.engagelab.cc/v1/api_users/{api_user}"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X PUT "https://email.api.engagelab.cc/v1/api_users/{api_user}"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代碼塊在浮窗中顯示
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
此代碼塊在浮窗中顯示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代碼塊在浮窗中顯示
