API v1.5 ガイド - NHN Cloud 使用ガイド

Notification > Email > API v1.5ガイド

[APIドメイン]

環境	ドメイン
Real	https://email.api.nhncloudservice.com

[Header]

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

[curl例注意事項]

Windows cmdではcurl例が正常にリクエストされないことがあります。

メールの送信

一般メールの送信

リクエスト

[URL]

Http method	URI
POST	/email/v1.5/appKeys/{appKey}/sender/mail

[Path parameter]

値	タイプ	説明
appKey	String	固有のappKey

[Request body]

値	タイプ	必須	説明
senderAddress	String	O	送信者のメール
senderName	String	X	送信者名
requestDate	String	X	送信日時が未入力の時は現在時間で送信(yyyy-MM-dd HH:mm:ss)
title	String	O	タイトル
body	String	O	内容
attachFileIdList	List:Integer	X	アップロードした添付ファイルid
templateId	String	X	送信テンプレートID
templateType	String	X	テンプレートタイプ DEFAULT(default)、FREEMARKER)
templateParameter	Object	X	置換パラメータ(メールのタイトル/内容置換時に入力)
- #key#	String	X	置換キー(##key##)
- #value#	Object	X	置換キーにマッピングされるValue値
receiverList	List	O	受信者リスト最大1000人まで送信可能(受信者、CC含む)
- receiveMailAddr	String	O	受信者のメールアドレス
- receiveName	String	X	受信者名
- receiveType	String	O	受信者タイプ(MRT0：受信者、MRT1：CC、MRT2：BCC)
customHeaders	Map	X	ユーザー指定ヘッダ
senderGroupingKey	String	X	発信者グループキー
userId	String	X	送信セパレータ ex)admin,system

[注意]

templateを使用する場合、title、bodyは任意のフィールドです。(入力時、入力された値がtemplateより優先適用)

[例1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/mail -d '{"senderAddress":"support@nhnent.com","senderName":"送信者名","title":"サンプルタイトル","body":"サンプル内容","receiverList":[{"receiveMailAddr":"customer1@nhnent.com","receiveName":"顧客1","receiveType":"MRT0"},{"receiveMailAddr":"customer2@nhnent.com","receiveName":"顧客2","receiveType":"MRT1"}],"userId":"USER"}'

[例2 - テンプレートの使用]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/mail -d '{"templateId":"TEMPLATE1","templateParameter":{"key":"value"},"receiverList":[{"receiveMailAddr":"customer1@nhnent.com","receiveName":"顧客1","receiveType":"MRT0"},{"receiveMailAddr":"customer2@nhnent.com","receiveName":"顧客2","receiveType":"MRT1"}],"userId":"USER"}'

レスポンス

{
    "header": {
        "isSuccessful": boolean,
        "resultCode": Integer,
        "resultMessage": String
    },
    "body": {
        "data": {
            "requestId": String,
            "results": [
                {
                    "receiveMailAddr": String,
                    "receiveName": String,
                    "receiveType": String,
                    "resultCode": Integer,
                    "resultMessage": String
                }
            ]
        }
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- data	Object	データ領域
-- requestId	String	リクエストID
-- results	List	送信結果
--- receiveMailAddr	String	受信者のメールアドレス
--- receiveName	String	受信者名
--- receiveType	String	受信者タイプ(MRT0：受信者、MRT1：CC、MRT2：BCC)
--- resultCode	Integer	受信者送信リクエスト結果コード
--- resultMessage	String	受信者送信リクエスト結果メッセージ

v1.5の変更事項

発信者グループキーフィールドを追加しました。リクエスト単位で設定できます。
送信リクエストをする時、senderGroupingKeyフィールドを指定して、リクエスト照会時に活用できます。

個別メール送信

受信者が複数人いる時、それぞれの受信者に個別にメールを送信する機能です。複数人に送っても、受信者には本人のみ表示されます。

リクエスト

[URL]

Http method	URI
POST	/email/v1.5/appKeys/{appKey}/sender/eachMail

[Path parameter]

値	タイプ	説明
appKey	String	固有のappKey

[Request body]

値	タイプ	必須	説明
senderAddress	String	O	送信者のメール
senderName	String	X	送信者名
requestDate	String	X	送信日時、未入力時は現在時間で送信(yyyy-MM-dd HH:mm:ss)
title	String	O	タイトル
body	String	O	内容
attachFileIdList	List:Integer	X	アップロードした添付ファイルid
templateType	String	X	テンプレートタイプ DEFAULT(default)、FREEMARKER)
templateId	String	X	送信テンプレートID
receiverList	List	O	受信者リスト最大1000人まで送信可能
- receiveMailAddr	String	O	受信者のメールアドレス
- receiveName	String	X	受信者名
- templateParameter	Object	X	置換パラメータ(メールのタイトル/内容置換時の入力)
-- #key#	String	X	置換キー(##key##)
-- #value#	Object	X	置換キーにマッピングされるValue値
customHeaders	Map	X	ユーザー指定ヘッダ
senderGroupingKey	String	X	発信者グループキー
userId	String	X	送信セパレータ ex)admin,system

[注意]

templateを使用する場合、title、bodyは必須から除外(入力時に入力された値がtemplateより優先適用)

[例1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/eachMail -d '{"senderAddress":"support@nhnent.com","senderName":"送信者名","title":"サンプルタイトル","body":"サンプル内容","attachFileIdList":[1, 2],"receiverList":[{"receiveMailAddr":"customer1@nhnent.com","receiveName":"顧客1"}],"userId":"USER"}'

[例2 - テンプレートの使用]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/mail -d '{"templateId":"TEMPLATE1","receiverList":[{"receiveMailAddr":"customer1@nhnent.com","receiveName":"顧客1","templateParameter":{"key":"value"}}],"userId":"USER"}'

レスポンス

{
    "header": {
        "isSuccessful": boolean,
        "resultCode": Integer,
        "resultMessage": String
    },
    "body": {
        "data": {
            "requestId": String,
            "results": [
                {
                    "receiveMailAddr": String,
                    "receiveName": String,
                    "receiveType": String,
                    "resultCode": Integer,
                    "resultMessage": String
                }
            ]
        }
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- data	Object	データ領域
-- requestId	String	リクエストID
-- results	List	送信結果
--- receiveMailAddr	String	受信者のメールアドレス
--- receiveName	String	受信者名
--- receiveType	String	受信者タイプ(MRT0：受信者、MRT1：CC、MRT2：BCC)
--- resultCode	Integer	受信者送信リクエスト結果コード
--- resultMessage	String	受信者送信リクエスト結果メッセージ

v1.5の変更事項

発信者グループキーフィールドを追加しました。リクエスト単位で設定できます。
送信リクエストをする時、senderGroupingKeyフィールドを指定して、リクエスト照会時に活用できます。

広告性一般メール送信

リクエスト、レスポンス情報は、一般メール送信と同じです。

広告メール送信時の注意事項

タイトルに必ず(広告)文言を挿入する必要があります。
詳細は[広告性メール送信]を参照してください。

[URL]

Http method	URI
POST	/email/v1.5/appKeys/{appKey}/sender/ad-mail

[例1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/ad-mail -d '{"senderAddress":"support@nhnent.com","senderName":"送信者名","title":"(広告)サンプルタイトル","body":"サンプル内容<br /> ##BLOCK_RECEIVER_LINK## <br />##EN_BLOCK_RECEIVER_LINK##","receiverList":[{"receiveMailAddr":"customer1@nhnent.com","receiveName":"顧客1","receiveType":"MRT0"},{"receiveMailAddr":"customer2@nhnent.com","receiveName":"顧客2","receiveType":"MRT1"}],"userId":"USER"}'

[例2 - テンプレートの使用]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/ad-mail -d '{"templateId":"TEMPLATE1","templateParameter":{"key":"value"},"receiverList":[{"receiveMailAddr":"customer1@nhnent.com","receiveName":"顧客1","receiveType":"MRT0"},{"receiveMailAddr":"customer2@nhnent.com","receiveName":"顧客2","receiveType":"MRT1"}],"userId":"USER"}'

広告性個別メール送信

URLの最後のみad-eachMailに変わり、残りは個別メール送信と同じです。

[URL]

Http method	URI
POST	/email/v1.5/appKeys/{appKey}/sender/ad-eachMail

[例1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/ad-eachMail -d '{"senderAddress":"support@nhnent.com","senderName":"送信者名","title":"(広告)サンプルタイトル","body":"サンプル内容<br /> ##BLOCK_RECEIVER_LINK## <br />##EN_BLOCK_RECEIVER_LINK##","attachFileIdList":[1, 2],"receiverList":[{"receiveMailAddr":"customer1@nhnent.com","receiveName":"顧客1"}],"userId":"USER"}'

[例2 - テンプレートの使用]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/ad-eachMail -d '{"templateId":"TEMPLATE1","receiverList":[{"receiveMailAddr":"customer1@nhnent.com","receiveName":"顧客1","templateParameter":{"key":"value"}}],"userId":"USER"}'

認証メールの送信

リクエスト

[URL]

Http method	URI
POST	/email/v1.5/appKeys/{appKey}/sender/auth-mail

[Path parameter]

値	タイプ	説明
appKey	String	固有のappKey

[Request body]

値	タイプ	必須	説明
senderAddress	String	O	送信者のメール
senderName	String	X	送信者名
requestDate	String	X	送信日時、未入力時は現在時間で送信(yyyy-MM-dd HH:mm:ss)
title	String	O	タイトル
body	String	O	内容
templateId	String	X	送信テンプレートID
receiver	Object	O	受信者
- receiveMailAddr	String	O	受信者のメールアドレス
- receiveName	String	X	受信者名
- templateParameter	Object	X	置換パラメータ(メールのタイトル/内容置換時の入力)
-- #key#	String	X	置換キー(##key##)
-- #value#	Object	X	置換キーにマッピングされるValue値
customHeaders	Map	X	ユーザー指定ヘッダ
userId	String	X	送信セパレータ ex)admin,system

[注意]

templateを使用する場合、title、bodyは必須から除外(入力時に入力された値がtemplateより優先適用)

一般メールと異なる点

認証メールの性格上、次のように異なる特性があります。

単件送信(1人の受信者)のみ可能です。
添付ファイル機能をサポートしません。添付ファイルが含まれるテンプレートはサポートしません。

[例1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/auth-mail -d '{"senderAddress":"support@nhnent.com","senderName":"送信者名","title":"サンプルタイトル","body":"サンプル内容","receiver":{"receiveMailAddr":"customer1@nhnent.com","receiveName":"顧客1"},"userId":"USER"}'

[例2 - テンプレートの使用]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/auth-mail -d '{"templateId":"TEMPLATE1","receiver":{"receiveMailAddr":"customer1@nhnent.com","receiveName":"顧客1","templateParameter":{"key":"value"}},"userId":"USER"}'

レスポンス

{
    "header": {
        "isSuccessful":boolean,
        "resultCode":Integer,
        "resultMessage":String
    },
    "body": {
        "data": {
            "requestId":String,
            "statusCode":String
        }
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- data	Object	データ領域
-- requestId	String	リクエストID
-- statusCode	String	リクエストステータスコード(Y：送信準備、N：送信準備失敗)
### 添付ファイルのアップロード

リクエスト

[URL]

Http method	URI
POST	/email/v1.5/appKeys/{appKey}/attachfile/binaryUpload

[Path parameter]

値	タイプ	説明
appKey	String	固有のappKey

[Request body]

{
    "fileName": String,
    "createUser": String,
    "fileBody": Byte[]
}

値	タイプ	必須	説明
fileName	String	O	ファイル名
fileBody	Byte[]	O	ファイルのByte[]値
createUser	String	X	ファイルアップロードユーザー情報

[例]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/attachfile/binaryUpload -d '{"fileName":"file.csv","createUser":"USER","fileBody":[]}'

レスポンス

{
  "header": {
    "isSuccessful":  Boolean,
    "resultCode": Integer,
    "resultMessage": String
  },
  "body": {
    "data": {
      "fileId": Integer,
      "fileName": String
    }
  }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- data	Object	データ領域
-- fileId	Integer	ファイルID
-- fileName	String	ファイル名

タイトル/本文置換

基本タイプ

(##置換Key##)形式で入力すると、ユーザーが入力したtemplateParameterで置換できます。

* title：##title_name##さん、こんにちは！
* body：##body_content## 送信します。
->
* title：クラウド顧客1さん、こんにちは！
* body：test2送信します。

FreeMarkerタイプ

FreeMarkerテンプレートエンジンをサポートします。
テンプレート言語を使用してユーザーが入力したtemplateParameterに置換できます。

* title：${title_name}さん、こんにちは！
* body：${body_content}送信します。
->
* title：クラウド顧客1さん、こんにちは！
* body：test2送信します。

一般メールのリクエスト例

{
    "senderAddress" : "support@nhnent.com",
    "templateId": "template1",
    "templateParameter" : {"title_name": "クラウド顧客1", "body_content": "test1"},
    "receiverList" : [
        {
            "receiveMailAddr" : "customer1@nhnent.com",
            "receiveType" : "MRT0"
        }

    ],
    "userId" : "tester"
}

個別メールのリクエスト例

{
    "senderAddress" : "support@nhnent.com",
    "templateId": "template1",
    "receiverList" : [
        {
            "receiveMailAddr" : "customer1@nhnent.com",
            "templateParameter" : {"title_name": "クラウド顧客1", "body_content": "test1"}
        },
        {
            "receiveMailAddr" : "customer2@nhnent.com",
            "templateParameter" : {"title_name": "クラウド顧客2", "body_content": "test2"}
        }

    ],
    "userId" : "tester"
}

メール照会

メール送信リストの照会

リクエスト

[URL]

Http method	URI
GET	/email/v1.5/appKeys/{appKey}/sender/mails

[Path parameter]

値	タイプ	説明
appKey	String	固有のappKey

[Query parameter]

値	タイプ	必須	説明
requestId	String	O	リクエストID
startSendDate	String	O	送信日の開始値(yyyy-MM-dd HH:mm:ss)
endSendDate	String	X	送信日の終了値(yyyy-MM-dd HH:mm:ss)
startReceiveDate	String	X	受信日の開始値(yyyy-MM-dd HH:mm:ss)
endReceiveDate	String	X	受信日の終了値(yyyy-MM-dd HH:mm:ss)
senderAddress	String	X	送信メールアドレス
senderName	String	X	送信者名
receiveMailAddr	String	X	受信メールアドレス
templateId	String	X	テンプレート番号
mailStatusCode	String	X	送信ステータスコード SST0：送信準備、SST1：送信中、 SST2：送信完了、SST3：送信失敗、 SST7：認証なし
isReceived	Boolean	X	受信情報
isOpened	Boolean	X	既読情報
senderGroupingKey	String	X	発信者グループキー
pageNum	Integer	X	ページ番号(Default：1)
pageSize	Integer	X	照会件数(Default：15)

requestIdまたはstartSendDate、endSendDateリクエストフィールドは必須です。

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/mails?startSendDate=2018-03-01+00%3A00&endSendDate=2018-03-07+23%3A59&pageSize=10"

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "pageNum": 1,
        "pageSize": 10,
        "totalCount": 1,
        "data": [
            {
                "requestId": "20190101000000ABCDEFG0",
                "mailSeq": 0,
                "requestDate": "2019-01-01 00:00:00",
                "templateId": "Template",
                "templateName": "Template Name",
                "senderName": "Sender",
                "senderAddress": "sender@nhn.com",
                "title": "Title",
                "mailStatusCode": "SST2",
                "mailStatusName": "",
                "isReceived": true,
                "resultDate": "2019-01-01 00:00:00",
                "isOpened": true,
                "openedDate": "2019-01-01 00:00:00",
                "receiveMailAddr": "receiver@nhn.com",
                "receiveType": "MRT0",
                "receiveTypeName": "",
                "receiveName": "Receiver",
                "senderGroupingKey": "A_GROUP"
            }
        ]
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- pageNum	Integer	現在のページ番号
- pageSize	Integer	照会されたデータ件数
- totalCount	Integer	総データ件数
- data	List	データ領域
-- requestId	String	リクエストID
-- mailSeq	Integer	メールの順番
-- requestDate	String	送信日時
-- templateId	String	テンプレートID
-- templateName	String	テンプレート名
-- senderName	String	送信者名
-- senderAddress	String	送信者のメールアドレス
-- title	String	メールのタイトル
-- mailStatusCode	String	送信ステータスコード SST0：送信準備、SST1：送信中 SST2：送信完了、SST3：送信失敗、 SST7：認証なし
-- mailStatusName	String	送信ステータス名
-- isReceived	Boolean	受信情報
-- resultDate	String	受信日時
-- isOpened	Boolean	既読情報
-- openedDate	String	開封日時
-- receiveMailAddr	String	受信者のメールアドレス
-- receiveType	String	受信者タイプ(MRT0：受信者、MRT1：CC、MRT2：BCC)
-- receiveTypeName	String	受信者タイプ名
-- receiveName	String	受信者名
-- senderGroupingKey	String	発信者グループキー

v1.5の変更事項

発信者グループキーフィールドsenderGroupingKeyを追加しました。
受信情報フィールドisReceivedを追加しました。
既読情報フィールドisOpenedを追加しました。
開封日時フィールドopenedDateを追加しました。
リクエストフィールドのうち、送信ステータスコードを表すフィールドの名前をmailStatusCodeに変更しました。
受信者のメールアドレスを表すフィールドの名前をreceiveMailAddrに変更しました。
送信者のメールアドレスを表すフィールドの名前をsenderAddressに変更しました。

メール送信詳細の照会

リクエスト

[URL]

Http method	URI
GET	/email/v1.5/appKeys/{appKey}/sender/mail/{requestId}/{mailSeq}

[Path parameter]

値	タイプ	説明
appKey	String	固有のappKey
requestId	String	リクエストID
mailSeq	Integer	メールの順番

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/sender/mail/{requestId}/{mailSeq}"

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "requestId": "20190101000000ABCDEFG0",
            "mailSeq": 0,
            "requestIp": "127.0.0.1",
            "requestDate": "2019-01-01 00:00:00",
            "mailStatusCode": "SST2",
            "mailStatusName": "",
            "templateId": "Template",
            "templateName": "Template Name",
            "senderName": "Sender",
            "senderAddress": "sender@nhn.com",
            "resultId": "<20190101000000ABCDEFG0@test>",
            "title": "Title",
            "body": "Body",
            "receiverList": [
                {
                    "requestId": "20190101000000ABCDEFG0",
                    "mailSeq": 0,
                    "receiveType": "MRT0",
                    "receiveTypeName": "",
                    "receiveName": "Receiver",
                    "receiveMailAddr": "receiver@nhn.com",
                    "isReceived": true,
                    "resultDate": "2019-01-01 00:00:00",
                    "isOpened": true,
                    "openedDate": "2019-01-01 00:00:00"
                }
            ],
            "attachFileList": [
                {
                    "fileType": "MAIL",
                    "fileId": 1,
                    "fileName": "test.jpg",
                    "filePath": "file/path",
                    "fileSize": 1,
                    "createDate": "2019-01-01 00:00:00"
                }
            ],
            "customHeaders": {
                "Content-Type": "text/html"
            },
            "senderGroupingKey": "A_GROUP"
        }
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- data	Object	データ領域
-- requestId	String	リクエストID
-- mailSeq	Integer	メールの順番
-- requestIp	String	リクエストIP
-- requestDate	String	リクエスト時間
-- mailStatusCode	String	送信ステータスコード SST0：送信準備、SST1：送信中 SST2：送信完了、SST3：送信失敗、 SST7：認証なし
-- mailStatusName	String	送信ステータス名
-- templateId	String	テンプレートID
-- templateName	String	テンプレート名
-- senderName	String	送信者名
-- senderAddress	String	送信者のアドレス
-- resultId	String	送信結果ID
-- title	String	タイトル
-- body	String	内容
-- receiverList	List	受信者リスト
--- requestId	String	リクエストID
--- mailSeq	Integer	メールの順番
--- receiveType	String	受信者タイプ(MRT0：受信者、MRT1：CC、MRT2：BCC)
--- receiveTypeName	String	受信者タイプ名
--- receiveName	String	受信者名
--- receiveMailAddr	String	受信者メールアドレス
--- isReceived	Boolean	受信情報
--- resultDate	String	受信日時
--- isOpened	Boolean	既読情報
--- openedDate	String	開封日時
-- attachFileList	List	添付ファイルリスト
--- fileType	String	添付ファイルタイプ MAIL: メールに添付されたファイル、TEMPLATE：テンプレートに添付されたファイル
--- fileId	Integer	ファイルID
--- fileName	String	添付ファイル名
--- filePath	String	添付ファイルパス
--- fileSize	Integer	添付ファイルサイズ(byte)
--- createDate	String	作成日時
-- customHeaders	Map	ユーザー指定ヘッダ
-- senderGroupingKey	String	発信者グループキー

v1.5からの変更点

発信者グループキーフィールドsenderGroupingKeyを追加しました。
受信者リストのフィールドの名前をreceiverListに変更しました。
受信情報フィールドisReceivedを追加しました。
受信者の既読情報フィールドの名前をisOpenedに変更しました。
受信者の開封日時のフィールドの名前をopenedDateに変更しました。
送信者のメールアドレスを表すフィールドの名前をsenderAddressに変更しました。

カテゴリーの管理

カテゴリーリストの照会

リクエスト

[URL]

Http method	URI
GET	/email/v1.5/appKeys/{appKey}/categories

[Path parameter]

値	タイプ	説明
appKey	String	固有のアプリケーションキー

[Query parameter]

値	タイプ	必須	説明
useYn	String	X	使用有無Y、N
categoryParentId	Integer	X	親カテゴリーID
pageNum	Integer	X	ページ番号(デフォルト値：1)
pageSize	Integer	X	照会件数(デフォルト値：15)

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/categories?useYn=Y&categoryParentId=1&pageNum=1&pageSize=10"

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "pageNum": 1,
        "pageSize": 15,
        "totalCount": 3,
        "data": [
            {
                "categoryId": 12345,
                "categoryParentId": 0,
                "depth": 0,
                "categoryName": "Category",
                "categoryDesc": "Top Category",
                "useYn": "Y",
                "createUser": "user",
                "createDate": "2019-07-23 00:00:00.0",
                "updateUser": "user",
                "updateDate": "2019-07-23 00:00:00.0",
            }
        ]
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- pageNum	Integer	現在のページ番号
- pageSize	Integer	照会されたデータ件数
- totalCount	Integer	総データ件数
- data	List	データ領域
-- categoryId	Integer	カテゴリーID
-- categoryParentId	Integer	親カテゴリーID(最上位カテゴリーの場合は0)
-- depth	Integer	深さ(depth)(最上位カテゴリーの場合は0)
-- categoryName	String	カテゴリー名
-- categoryDesc	String	カテゴリーの説明
-- useYn	String	使用有無
-- createUser	String	作成者
-- createDate	String	作成日時
-- updateUser	String	修正者
-- updateDate	String	修正日時

カテゴリー詳細照会

リクエスト

[URL]

Http method	URI
GET	/email/v1.5/appKeys/{appKey}/categories/{categoryId}

[Path parameter]

値	タイプ	説明
appKey	String	固有のアプリケーションキー
categoryId	String	カテゴリーID

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/categories/{categoryId}"

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "categoryId": 12345,
            "categoryParentId": 0,
            "depth": 0,
            "categoryName": "Category",
            "categoryDesc": "Top Category",
            "useYn": "Y",
            "createUser": "user",
            "createDate": "2019-07-23 00:00:00.0",
            "updateUser": "user",
            "updateDate": "2019-07-23 00:00:00.0"
        }
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- data	List	データ領域
-- categoryId	Integer	カテゴリーID
-- categoryParentId	Integer	親カテゴリーID(最上位カテゴリーの場合は0)
-- depth	Integer	深さ(depth)(最上位カテゴリーの場合は0)
-- categoryName	String	カテゴリー名
-- categoryDesc	String	カテゴリーの説明
-- useYn	String	使用有無
-- createUser	String	作成者
-- createDate	String	作成日時
-- updateUser	String	修正者
-- updateDate	String	修正日時

カテゴリーの登録

リクエスト

[URL]

Http method	URI
POST	/email/v1.5/appKeys/{appKey}/categories

[Path parameter]

値	タイプ	説明
appKey	String	固有のアプリケーションキー

[Request body]

値	タイプ	最大文字数	必須	説明
categoryParentId	Integer	-	X	親カテゴリーID 最上位カテゴリーID(デフォルト値)
categoryName	String	200	O	カテゴリー名
categoryDesc	String	1000	X	カテゴリーの説明
useYn	String	1	X	使用有無Y(デフォルト値)、N
userId	String	50	X	ユーザーID

[例]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/categories -d '{"categoryParentId":12345,"categoryName":"Category","categoryDesc":"Top Category","useYn":"Y","userId":"USER"}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "categoryId": 12346
        }
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- data	Object	データ領域
-- categoryId	Integer	カテゴリーID

カテゴリーの修正

リクエスト

[URL]

Http method	URI
PUT	/email/v1.5/appKeys/{appKey}/categories/{categoryId}

[Path parameter]

値	タイプ	説明
appKey	String	固有のアプリケーションキー
categoryId	Integer	カテゴリーID

[Request body]

値	タイプ	最大文字数	必須	説明
categoryName	String	200	X	カテゴリー名
categoryDesc	String	1000	X	カテゴリーの説明
useYn	String	1	X	使用有無Y、N
userId	String	50	X	ユーザーID

[例]

curl -X PUT -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/categories/{categoryId} -d '{"categoryName":"Category","categoryDesc":"Top Category","useYn":"Y","userId":"USER"}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ

カテゴリーの削除

リクエスト

[URL]

Http method	URI
DELETE	/email/v1.5/appKeys/{appKey}/categories/{categoryId}

[Path parameter]

値	タイプ	説明
appKey	String	固有のアプリケーションキー
categoryId	Integer	カテゴリーID

[例]

curl -X DELETE -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/categories/{categoryId}

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ

テンプレートの照会

テンプレートリスト照会

リクエスト

[URL]

Http method	URI
GET	/email/v1.5/appKeys/{appKey}/templates

[Path parameter]

値	タイプ	説明
appKey	String	固有のappKey

[Query parameter]

値	タイプ	必須	説明
categoryId	Integer	X	カテゴリーID
useYn	String	X	使用有無(Y/N)
pageNum	Integer	X	ページ番号(Default：1)
pageSize	Integer	X	照会件数(Default：15)
all	Boolean	X	全てのテンプレートリストを照会するかどうか

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/templates?useYn=Y&pageNum=1&pageSize=10"

レスポンス

{
    "header": {
        "resultCode": Integer,
        "resultMessage": String,
        "isSuccessful": Boolean
    },
    "body": {
        "pageNum": Integer,
        "pageSize": Integer,
        "totalCount": Integer,
        "data": [
            {
                "templateId": String,
                "categoryId": Integer,
                "categoryName": String,
                "templateName": String,
                "templateDesc": String,
                "useYn": String,
                "delYn": String,
                "title": String,
                "createDate": String,
                "updateDate": String
            }
        ]
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- pageNum	Integer	現在のページ番号
- pageSize	Integer	照会されたデータ件数
- totalCount	Integer	総データ件数
- data	List	データ領域
-- templateId	String	テンプレートID
-- categoryId	Integer	カテゴリーID
-- categoryName	String	カテゴリー名
-- templateName	String	テンプレート名
-- templateDesc	String	テンプレートの説明
-- useYn	String	使用有無
-- delYn	String	削除されているかどうか
-- title	String	メールのタイトル
-- createDate	String	作成日時
-- updateDate	String	修正日時

テンプレート詳細照会

リクエスト

[URL]

Http method	URI
GET	/email/v1.5/appKeys/{appKey}/templates/{templateId}

[Path parameter]

値	タイプ	説明
appKey	String	固有のappKey
templateId	String	テンプレートID

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/templates/{templateId}"

レスポンス

{
    "header": {
        "resultCode": Integer,
        "resultMessage": String,
        "isSuccessful": Boolean
    },
    "body": {
        "data": {
            "templateId": String,
            "categoryId": Integer,
            "categoryName": String,
            "templateName": String,
            "templateDesc": String,
            "useYn": String,
            "delYn": String,
            "sendMailAddress": String,
            "title": String,
            "templateType": String,
            "body": String,
            "createDate": String,
            "updateDate": String,
            "attachFileList": [
                {
                    "fileType": String,
                    "fileId": Integer,
                    "fileName": String,
                    "filePath": String,
                    "fileSize": Integer,
                    "createDate": String
                }
            ]
        }
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- data	List	データ領域
-- templateId	String	テンプレートID
-- categoryId	Integer	カテゴリーID
-- categoryName	String	カテゴリー名
-- templateName	String	テンプレート名
-- templateDesc	String	テンプレートの説明
-- useYn	String	使用有無(Y=使用中、N=使用しない)
-- delYn	String	削除されているかどうか(Y=削除、N=削除されていない)
-- sendMailAddress	String	送信メールアドレス
-- title	String	メールアドレス
-- templateType	String	テンプレートタイプ DEFAULT(default)、FREEMARKER)
-- body	String	メール内容
-- createDate	String	作成日時
-- updateDate	String	修正日時
-- attachFileList	List	添付ファイルリスト
--- fileType	String	添付ファイルタイプ(MAIL：メールに添付されたファイル、TEMPLATE：テンプレートに添付されたファイル)
--- fileId	Integer	ファイルID
--- fileName	String	添付ファイル名
--- filePath	String	添付ファイルパス
--- fileSize	Integer	添付ファイルサイズ(byte)
--- createDate	String	作成日時

テンプレートの登録

リクエスト

[URL]

Http method	URI
POST	/email/v1.5/appKeys/{appKey}/templates

[Path parameter]

値	タイプ	説明
appKey	String	固有のアプリケーションキー

[Request body]

値	タイプ	最大文字数	必須	説明
categoryId	Integer	-	O	カテゴリーID
templateId	String	50	O	テンプレートID
templateName	String	200	O	テンプレート名
templateDesc	String	4000	X	テンプレートの説明
useYn	String	1	X	使用有無Y(デフォルト値)、N
sendMailAddress	String	300	O	発信メールアドレス
title	String	500	O	メールタイトル
templateType	String	10	X	テンプレートタイプ DEFAULT(デフォルト値)、FREEMARKER
body	String	-	O	メール本文
attachFileIdList	List	-	X	添付ファイルID(fileId)
userId	String	50	X	ユーザーID

[例]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/templates -d '{"categoryId":1,"templateId":"TEAMPLTE_ID","templateName":"テンプレート名","templateDesc":"テンプレートの説明","useYn":"Y","sendMailAddress":"test@nhn.com","title":"メールタイトル","templateType":"DEFAULT","body":"メールの内容","attachFileIdList":[1,2,3],"userId":"USER"}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ

テンプレート添付ファイルのアップロード

リクエスト

[URL]

Http method	URI
POST	/email/v1.5/appKeys/{appKey}/templates/attachfile/binaryUpload

[Path parameter]

値	タイプ	説明
appKey	String	固有のアプリケーションキー

[Request body]

値	タイプ	最大長	必須	説明
fileName	String	-	O	ファイル名
fileBody	Byte[]	-	O	ファイルのByte[]値
userId	String	50	X	ユーザーID

[例]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/templates/attachfile/binaryUpload -d '{"fileName":"file.csv","userId":"USER","fileBody":[]}'

レスポンス

{
  "header": {
    "isSuccessful":  true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  },
  "body": {
    "data": {
      "fileId": 1,
      "fileName": "file.csv"
    }
  }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- data	Object	データ領域
-- fileId	Integer	ファイルID
-- fileName	String	ファイル名

テンプレートの修正

リクエスト

[URL]

Http method	URI
PUT	/email/v1.5/appKeys/{appKey}/templates/{templateId}

[Path parameter]

値	タイプ	説明
appKey	String	固有のアプリケーションキー
templateId	String	テンプレートID

[Request body]

値	タイプ	最大文字数	必須	説明
templateName	String	200	X	テンプレート名
templateDesc	String	4000	X	テンプレートの説明
useYn	String	1	X	使用有無Y、N
sendMailAddress	String	300	X	発信メールアドレス
title	String	500	X	メールタイトル
templateType	String	10	X	テンプレートタイプ DEFAULT(デフォルト値)、FREEMARKER
body	String	-	X	メール本文
attachFileIdList	List	-	X	添付ファイルID(fileId)
userId	String	50	X	ユーザーID

[例]

curl -X PUT -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/templates/{templateId} -d '{"templateName":"テンプレート名","templateDesc":"テンプレートの説明","useYn":"Y","sendMailAddress":"test@nhn.com","title":"メールタイトル","templateType":"DEFAULT","body":"メールの内容","attachFileIdList":[1,2,3],"userId":"USER"}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ

テンプレートの削除

リクエスト

[URL]

Http method	URI
DELETE	/email/v1.5/appKeys/{appKey}/templates/{templateId}

[Path parameter]

値	タイプ	説明
appKey	String	固有のアプリケーションキー
templateId	String	テンプレートID

[例]

curl -X DELETE -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/templates/{templateId}

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
## 統計照会

統合統計照会

リクエスト

[URL]

Http method	URI
GET	/email/v1.5/appKeys/{appKey}/statistics/view

[Path parameter]

値	タイプ	説明
appKey	String	固有のappKey

[Query parameter]

値	タイプ	必須	説明
from	String	O	統計照会の開始日 yyyy-mm-dd HH:mm
to	String	O	統計照会の終了日 yyyy-mm-dd HH:mm
searchType	String	O	統計区分 DATE：日付別、TIME：時間別、DAY：曜日別
mailTypes	String	X	メールタイプ NORMAL：一般、MASS：大量複数入力可能(mailTypes=NORMAL&mailTypes=MASS)
adYn	String	X	広告かどうか Y：広告、N：広告ではない入力しなければ全て
templateId	String	X	テンプレートID

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/statistics/view?from=2018-03-21+00%3A00&to=2018-03-23+00%3A00&searchType=DATE&mailTypes=NORMAL&adYn=Y&templateId=templateId1"

レスポンス

{
    "isSuccessful": Boolean,
    "resultCode": Integer,
    "resultMessage": String
},
    "body" : {
        "data" : [
          {
                  "divisionName": String,
                  "requestedCount": long,
                  "sentCount": long,
                  "receivedCount": long,
                  "openedCount": long,
                  "sentRate": String,
                  "receivedRate": String,
                  "openedRate": String
        }
        ]
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- data	List	データ領域
-- divisionName	String	統計基準(日付/時間/曜日)
-- requestedCount	Long	送信リクエストカウント
-- sentCount	Long	送信カウント
-- receivedCount	Long	受信カウント
-- openedCount	Long	開封カウント
-- sentRate	String	送信率
-- receivedRate	String	受信率
-- openedRate	String	開封率

受信拒否管理

受信拒否照会

リクエスト

[URL]

Http method	URI
GET	/email/v1.5/appKeys/{appKey}/block-receivers

[Path parameter]

値	タイプ	説明
appKey	String	固有のappKey

[Query parameter]

値	タイプ	必須	説明
mailAddress	String	X	受信拒否リストに登録されているメールアドレス
startBlockDate	String	X	受信拒否日開始値 (yyyy-MM-dd HH:mm:ss)
endBlockDate	String	X	受信拒否日終了値 (yyyy-MM-dd HH:mm:ss)
pageNum	Integer	X	ページ番号(Default：1)
pageSize	Integer	X	照会件数(Default：15)

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/block-receivers?mailAddress=customer1@nhnent.com&pageNum=1&pageSize=10"

レスポンス

{
    "header": {
        "isSuccessful": boolean,
        "resultCode": Integer,
        "resultMessage": String
    },
    "body": {
        "totalCount": Integer,
        "data": [
            {
                "mailAddress": String,
                "blockDate": String
            }
        ]
    }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ
body	Object	本文領域
- pageNum	Integer	現在のページ番号
-pageSize	Integer	照会されたデータ件数
- totalCount	Integer	総データ件数
- data	List	データ領域
-- mailAddress	String	受信拒否メールアドレス
-- blockDate	String	受信拒否日(yyyy-MM-dd HH:mm:ss.S)

受信拒否登録

リクエスト

[URL]

Http method	URI
POST	/email/v1.5/appKeys/{appKey}/block-receivers

[Request body]

値	タイプ	必須	説明
blockReceiverList	ㅣList	O	受信拒否リスト
- mailAddress	String	O	受信拒否メールアドレス
- blockDate	String	X	受信拒否日(yyyy-MM-dd HH:mm:ss)

[例]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/block-receivers -d '{"blockReceiverList":[{"mailAddress":"customer1@nhnent.com","blockDate":"2018-03-01 00:00:00"}]}'

レスポンス

{
  "header": {
    "isSuccessful":  Boolean,
    "resultCode": Integer,
    "resultMessage": String
  }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ

受信拒否削除

リクエスト

[URL]

Http method	URI
PUT	/email/v1.5/appKeys/{appKey}/block-receivers

[Request body]

値	タイプ	必須	説明
deleted	Boolean	O	受信拒否削除を明示するフィールド
blockReceiverList	ㅣList	O	受信拒否リスト
- mailAddress	String	O	受信拒否メールアドレス

[例]

curl -X PUT -H "Content-Type: application/json;charset=UTF-8" https://email.api.nhncloudservice.com/email/v1.5/appKeys/{appKey}/block-receivers -d '{"deleted":true,"blockReceiverList":[{"mailAddress":"customer1@nhnent.com"}]}'

レスポンス

{
  "header": {
    "isSuccessful":  Boolean,
    "resultCode": Integer,
    "resultMessage": String
  }
}

値	タイプ	説明
header	Object	ヘッダ領域
- isSuccessful	Boolean	成否
- resultCode	Integer	失敗コード
- resultMessage	String	失敗メッセージ

Notification > Email > API v1.5ガイド
メールの送信
一般メールの送信
個別メール送信
広告性一般メール送信
広告性個別メール送信
認証メールの送信
タイトル/本文置換
メール照会
メール送信リストの照会
メール送信詳細の照会
カテゴリーの管理
カテゴリーリストの照会
カテゴリー詳細照会
カテゴリーの登録
カテゴリーの修正
カテゴリーの削除
テンプレートの照会
テンプレートリスト照会
テンプレート詳細照会
テンプレートの登録
テンプレート添付ファイルのアップロード
テンプレートの修正
テンプレートの削除
統合統計照会
受信拒否管理
受信拒否照会
受信拒否登録
受信拒否削除

TOP