メールテンプレート管理

開発者はテンプレートを使用して、類似した内容を複数のユーザーに一括で簡単に送信できます。

メールテンプレートはAPIを通じてクエリ、追加、削除、修正が可能です。

クエリ（バッチクエリ）

メールテンプレートに関する基本情報を返します。

URL

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

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

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

HTTPリクエストメソッド

GET

GET

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

リクエストヘッダー

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

クエリパラメータ

パラメータ	タイプ	必須	説明
offset	int	No	クエリ開始位置、範囲[0-]、デフォルトは0。
limit	int	No	クエリ数、範囲[0-100]、デフォルトは100。
name	string	No	メールテンプレート名。あいまい検索。
template_invoke_name	string	No	メールテンプレート呼び出し名。完全一致検索。

リクエスト例

curl -X GET -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/templates?offset=0&limit=3'

              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates?offset=0&limit=3'

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

レスポンス説明

フィールド	説明
template_id	テンプレートID
name	メールテンプレート名
template_invoke_name	メールテンプレート呼び出し名
html	テンプレート内容
preview_text	テンプレート概要
subject	テンプレート件名
create_time	メールテンプレート作成時間
update_time	メールテンプレート更新時間

レスポンス例

Response-success

HTTP Status: 200

{ "result": [{ "template_id": 82522, "name": "dffddf", "template_invoke_name": "dffdfd", "html": null, "text": null, "subject": "fdfdfd😅🙂🙂🙂🙂", "preview_text": "", "create_time": "2022-11-10 15:47:05", "update_time": "2022-11-10 15:47:05" }] , "count":10, "total":20 }

              
              
{
    "result":  [{
                "template_id": 82522,
                "name": "dffddf",
                "template_invoke_name": "dffdfd",
                "html": null,
                "text": null,
                "subject": "fdfdfd😅🙂🙂🙂🙂",
                "preview_text": "",
                "create_time": "2022-11-10 15:47:05",
                "update_time": "2022-11-10 15:47:05"
            }]
     ,
     "count":10,
     "total":20
}

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

Response-error

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

              
              {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

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

クエリ

単一のメールテンプレートに関する詳細情報を返します。

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

              
              https://email.api.engagelab.cc/v1/templates/{template_id}

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

HTTPリクエストメソッド

DELETE

              
              DELETE

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

リクエストヘッダー

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

リクエスト例

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/templates/11111111'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates/11111111'

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

レスポンス説明

フィールド	説明
template_id	テンプレートID
name	メールテンプレート名
template_invoke_name	メールテンプレート呼び出し名
html	テンプレート内容
preview_text	メール概要
subject	テンプレートタイトル
create_time	メールテンプレート作成時間
update_time	メールテンプレート更新時間

レスポンス例

Response-success

HTTP Status: 200

{ "result":{ "template_id": 76707, "name": "libo01s", "template_invoke_name": "libo01d", "html": "The is first email", "text": null, "subject": "happyaaa", "preview_text": "", "create_time": "2019-07-22T11:52:45+0800", "update_time": "2019-08-01T11:29:19+0800" } }

              
              
{
     "result":{
            "template_id": 76707,
            "name": "libo01s",
            "template_invoke_name": "libo01d",
            "html": "The is first email",
            "text": null,
            "subject": "happyaaa",
            "preview_text": "",
            "create_time": "2019-07-22T11:52:45+0800",
            "update_time": "2019-08-01T11:29:19+0800"
        }
}

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

Response-error

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

              
              {
    
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

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

追加

URL

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

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

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

Content-Type:

Content-Type: application/json;charset=utf-8

              
              Content-Type: application/json;charset=utf-8

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

HTTPリクエストメソッド

POST

              
              POST

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

リクエストヘッダー

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

ボディパラメータ

パラメータ	タイプ	必須	説明
name	string	Yes	メールテンプレート名。最大32文字。
template_invoke_name	string	Yes	メールテンプレート呼び出し名。4~64文字。
html	string	Yes	HTML形式の内容
subject	string	Yes	テンプレートタイトル。最大255文字、絵文字対応。
preview_text	string	No	テンプレート概要。最大255文字。

注意:

HTMLコンテンツ内で変数を使用できます。

メール送信時の総サイズは70MBを超えない必要があります。

リクエスト例

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "html": "xxx", "subject": "sususubej"}' 'https://email.api.engagelab.cc/v1/templates'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "html": "xxx", "subject": "sususubej"}'
     'https://email.api.engagelab.cc/v1/templates'

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

レスポンス説明

フィールド	説明
template_id	テンプレートID
name	メールテンプレート名
template_invoke_name	メールテンプレート呼び出し名
preview_text	メール概要
html	テンプレートHTML形式内容
subject	テンプレートタイトル
create_time	メールテンプレート作成時間
update_time	メールテンプレート更新時間

レスポンス例

Response-success

HTTP Status: 200

{ "result": { "template_id": 82525, "name": "zhongg", "template_invoke_name": "gjtest122", "html": "This first template for apiv3", "subject": "xxxxxxx", "preview_text": "", "create_time": "2022-11-14T15:31:17+0800", "update_time": "" } }

              
              {
    "result": {
            "template_id": 82525,
            "name": "zhongg",
            "template_invoke_name": "gjtest122",
            "html": "This first template for apiv3",
            "subject": "xxxxxxx",
            "preview_text": "",
            "create_time": "2022-11-14T15:31:17+0800",
            "update_time": ""
    }
}

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

Response-error

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

              
              {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

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

削除

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

              
              https://email.api.engagelab.cc/v1/templates/{template_id}

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

HTTPリクエストメソッド

DELETE

              
              DELETE

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

リクエストヘッダー

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

リクエスト例

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/templates/11111111'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates/11111111'

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

レスポンス説明

パラメータ	説明
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/templates/{template_id}

              
              https://email.api.engagelab.cc/v1/templates/{template_id}

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

Content-Type:

Content-Type: application/json;charset=utf-8

              
              Content-Type: application/json;charset=utf-8

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

HTTPリクエストメソッド

PUT

PUT

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

リクエストヘッダー

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

ボディパラメータ

パラメータ	タイプ	必須	説明
name	string	No	メールテンプレート名。最大32文字。
template_invoke_name	string	No	メールテンプレート呼び出し名。4~64文字。
html	string	No	HTML形式の内容
subject	string	No	テンプレートタイトル。最大255文字、絵文字対応。
preview_text	string	No	メール概要。最大255文字。

注意:

HTMLコンテンツ内で変数を使用できます。

メール送信時の総サイズは70MBを超えない必要があります。

リクエスト例

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"template_invoke_name": "myCustomTemplate"}' 'https://email.api.engagelab.cc/v1/templates/11111111'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"template_invoke_name": "myCustomTemplate"}'
     'https://email.api.engagelab.cc/v1/templates/11111111'

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

レスポンス説明

パラメータ	説明
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."
}

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