郵件標籤

最新更新:2023-03-14

標籤為用戶發送郵件提供了另一個維度的統計方式。

你可以使用 API 對標籤進行査詢,添加,删除,修改操作。

査詢(批量査詢)

返回標籤的清單資訊

URL

https://email.api.engagelab.cc/v1/labels
          https://email.api.engagelab.cc/v1/labels

        
此代碼塊在浮窗中顯示

HTTP 請求方式

GET
          GET

        
此代碼塊在浮窗中顯示

請求 Headers

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

Query 請求參數

參數 類型 必須 說明
offset int 査詢起始位置,取值區間 [0-],默認為 0
limit int 査詢個數,取值區間 [0-100],默認為 100
label_name string 模糊查詢

請求示例

curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
          curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

        
此代碼塊在浮窗中顯示

響應說明

字段 說明
label_id 標籤 ID
label_name 標籤名稱
create_time 標籤創建時間
update_time 標籤修改時間

響應示例

Response-success

HTTP Status: 200

{ "total": 28, "count": 28, "result": [ { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } ] }
          
 {
       
       "total": 28,
        "count": 28,
        "result": [
            {
                "label_id": 598802,
                "label_name": "xjm226",
                "create_time": "2022-11-14T14:27:48+0800",
                "update_time": "2022-11-14T14:27:48+0800"
            }
        ]
    }

        
此代碼塊在浮窗中顯示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          {
    
    "code": 30000,
    "message": "Unauthorized."
}

        
此代碼塊在浮窗中顯示

查询

URL

https://email.api.engagelab.cc/v1/labels/{label_id}
          https://email.api.engagelab.cc/v1/labels/{label_id}

        
此代碼塊在浮窗中顯示

HTTP 請求方式

GET
          GET

        
此代碼塊在浮窗中顯示

請求 Headers

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

請求示例

curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
          
curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

        
此代碼塊在浮窗中顯示

響應說明

字段 說明
label_id 標籤 ID
label_name 標籤名稱
create_time 標籤創建時間
update_time 標籤修改時間

響應示例

Response-success

HTTP Status: 200

{ "result": { "label_id": 598100, "label_name": "xiaoxiao" "create_time": "2022-08-09T13:49:46+0800", "update_time": "2022-11-12T14:12:12+0800" } }
          {
        "result": {
            "label_id": 598100,
            "label_name": "xiaoxiao"
            "create_time": "2022-08-09T13:49:46+0800",
            "update_time": "2022-11-12T14:12:12+0800"
          }
    
}

        
此代碼塊在浮窗中顯示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          {
    
    "code": 30000,
    "message": "Unauthorized."
}

        
此代碼塊在浮窗中顯示

添加

URL

https://email.api.engagelab.cc/v1/labels
          https://email.api.engagelab.cc/v1/labels

        
此代碼塊在浮窗中顯示

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 參數說明

參數 類型 必須 說明
label_name string 需要添加的標籤名稱。最長 64 字符。

說明:

  • label 創建限制上限為 10 萬個

請求示例

curl -X POST "https://email.api.engagelab.cc/v1/labels" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name":"beijing user", }'
          curl -X POST "https://email.api.engagelab.cc/v1/labels" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "label_name":"beijing user",
}'

        
此代碼塊在浮窗中顯示

響應說明

字段 說明
label_id 標籤 ID
label_name 標籤名稱
create_time 創建時間
update_time 更新時間

響應示例

Response-success

HTTP Status: 200

{ "result": { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:34+0800", "update_time": "2022-11-14T14:27:34+0800" } }
          {
    "result": {
            "label_id": 598802,
            "label_name": "xjm226",
            "create_time": "2022-11-14T14:27:34+0800",
            "update_time": "2022-11-14T14:27:34+0800"
    }
    
}

        
此代碼塊在浮窗中顯示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          {
    "code": 30000,
    "message": "Unauthorized."
}

        
此代碼塊在浮窗中顯示

刪除

URL

https://email.api.engagelab.cc/v1/labels/{label_id}
          https://email.api.engagelab.cc/v1/labels/{label_id}

        
此代碼塊在浮窗中顯示

HTTP 請求方式

DELETE
          DELETE

        
此代碼塊在浮窗中顯示

請求 Headers

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

請求示例

curl -X DELETE "https://email.api.engagelab.cc/v1/labels/21122" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
          curl -X DELETE "https://email.api.engagelab.cc/v1/labels/21122" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

        
此代碼塊在浮窗中顯示

響應說明

字段 說明
count 成功删除的個數

響應示例

Response-success

HTTP Status: 200

{ "count": 1 }
          {
    "count": 1
}

        
此代碼塊在浮窗中顯示

Response-error

HTTP Status :401

{ "code": 12001, "message": "Unauthorized." }
          {
    "code": 12001,
    "message": "Unauthorized."
}

        
此代碼塊在浮窗中顯示

修改

URL

https://email.api.engagelab.cc/v1/labels/{label_id}
          https://email.api.engagelab.cc/v1/labels/{label_id}

        
此代碼塊在浮窗中顯示

Content-Type:

application/json; charset=utf-8
          application/json; charset=utf-8

        
此代碼塊在浮窗中顯示

HTTP 請求方式

PUT
          PUT

        
此代碼塊在浮窗中顯示

請求 Headers

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

Body 參數說明

參數 類型 必須 說明
label_name string 新的標籤名稱。最長 64 字符。

請求示例

curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name":"travel", }'
          curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "label_name":"travel",
}'

        
此代碼塊在浮窗中顯示

響應說明

字段 說明
count 修改成功的個數

響應示例

Response-success

HTTP Status: 200

{ "count": 1 }
          {
    "count": 1
}

        
此代碼塊在浮窗中顯示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          {
    "code": 30000,
    "message": "Unauthorized."
}

        
此代碼塊在浮窗中顯示
在文档中心打开