メールラベル

ラベルは、メール統計に追加の次元を提供します。

APIを使用して、ラベルのクエリ、追加、削除、変更を行うことができます。

クエリ（バッチクエリ）

ラベル情報のリストを返します。

URL

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

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

このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

GET

GET

このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー	タイプ	必須	説明
Authorization	String	true	Basic base64(api_user:api_key)

クエリリクエストパラメータ

パラメータ	タイプ	必須	説明
offset	int	No	クエリの開始位置、範囲[0-]、デフォルトは0
limit	int	No	クエリするアイテム数、範囲[0-100]、デフォルトは100
label_name	string	No	あいまいクエリ

リクエスト例

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": "Authentication failed." }

              
              {  
    "code": 30000,
    "message": "Authentication failed."
}

このコードブロックはフローティングウィンドウ内に表示されます

クエリ

URL

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

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

このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

GET

GET

このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー	タイプ	必須	説明
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": "Authentication failed." }

              
              {
    
    "code": 30000,
    "message": "Authentication failed."
}

このコードブロックはフローティングウィンドウ内に表示されます

追加

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

このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー	タイプ	必須	説明
Authorization	String	true	Basic base64(api_user:api_key)

ボディパラメータ説明

パラメータ	タイプ	必須	説明
label_name	string	Yes	追加するラベル名。最大64文字まで。

注意: ラベル作成の最大制限は100,000です。

リクエスト例

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":"hongkong", }'

              
              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":"hongkong",
}'

このコードブロックはフローティングウィンドウ内に表示されます

レスポンス説明

フィールド	説明
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 :400

{ "code": 30105, "message": "The label name should be 1-255 characters" }

              
              {
    "code": 30105,
    "message": "The label name should be 1-255 characters"
}

このコードブロックはフローティングウィンドウ内に表示されます

削除

URL

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

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

このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

DELETE

              
              DELETE

このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー	タイプ	必須	説明
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": 30000, "message": "Authentication failed." }

              
              {
    "code": 30000,
    "message": "Authentication failed."
}

このコードブロックはフローティングウィンドウ内に表示されます

修正

URL

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

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

このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

PUT

PUT

このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー	タイプ	必須	説明
Authorization	String	true	Basic base64(api_user:api_key)

ボディパラメータ説明

パラメータ	タイプ	必須	説明
label_name	string	Yes	新しいラベル名。最大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": "Authentication failed." }

              
              {
    "code": 30000,
    "message": "Authentication failed."
}

このコードブロックはフローティングウィンドウ内に表示されます