1.シークレットキー認証の導入 * v2.0 APIを呼び出す際、ヘッダにシークレットキーを設定して呼び出す必要があります。 2. 大量送信照会API追加 * 大量送信件の照会APIが追加されました。
[APIドメイン]
環境 | ドメイン |
---|---|
Real | https://email.api.nhncloudservice.com |
[Header]
Content-Type: application/json;charset=UTF-8
Header
X-Secret-Key: [a-zA-Z0-9]{8}
CONSOLE > Notification > Email > URL & AppKeyで確認/作成できます。
[curl例注意事項]
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/sender/mail |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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 |
statsId | String | X | 統計ID(発信検索条件には含まれません) |
[注意]
[例1]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/mail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"senderAddress": "support@example.com",
"senderName": "送信者名",
"title": "サンプルタイトル",
"body": "サンプル内容",
"receiverList": [{
"receiveMailAddr": "customer1@example.com",
"receiveName": "顧客1",
"receiveType": "MRT0"
}, {
"receiveMailAddr": "customer2@example.com",
"receiveName": "顧客2",
"receiveType": "MRT1"
}
],
"userId": "USER",
"statsId": "statsId"
}'
[例2 - テンプレートの使用]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/mail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"templateId": "TEMPLATE1",
"templateParameter": {
"key": "value"
},
"receiverList": [{
"receiveMailAddr": "customer1@example.com",
"receiveName": "顧客1",
"receiveType": "MRT0"
}, {
"receiveMailAddr": "customer2@example.com",
"receiveName": "顧客2",
"receiveType": "MRT1"
}
],
"userId": "USER",
"statsId": "statsId"
}'
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"data": {
"requestId": "20190101000000ABCDEFG0",
"results": [
{
"receiveMailAddr": "receiver@nhn.com",
"receiveName": "receiver",
"receiveType": "MRT0",
"resultCode": 0,
"resultMessage": "success"
}
]
}
}
}
値 | タイプ | 説明 |
---|---|---|
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 | 受信者送信リクエスト結果メッセージ |
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/sender/eachMail |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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 |
statsId | String | X | 統計ID(発信検索条件には含まれません) |
[注意]
[例1]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/eachMail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"senderAddress": "support@example.com",
"senderName": "送信者名",
"title": "サンプルタイトル",
"body": "サンプル内容",
"attachFileIdList": [1, 2],
"receiverList": [{
"receiveMailAddr": "customer1@example.com",
"receiveName": "顧客1"
}
],
"userId": "USER",
"statsId": "statsId"
}'
[例2 - テンプレートの使用]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/eachMail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"templateId": "TEMPLATE1",
"receiverList": [{
"receiveMailAddr": "customer1@example.com",
"receiveName": "顧客1",
"templateParameter": {
"key": "value"
}
}
],
"userId": "USER",
"statsId": "statsId"
}'
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"data": {
"requestId": "20190101000000ABCDEFG0",
"results": [
{
"receiveMailAddr": "receiver@nhn.com",
"receiveName": "receiver",
"receiveType": "MRT0",
"resultCode": 0,
"resultMessage": "success"
}
]
}
}
}
値 | タイプ | 説明 |
---|---|---|
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 | 受信者送信リクエスト結果メッセージ |
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/sender/ad-mail |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[例1]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/ad-mail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"senderAddress": "support@example.com",
"senderName": "送信者名",
"title": "(広告)サンプルタイトル",
"body": "サンプル内容 <br /> ##BLOCK_RECEIVER_LINK## <br />##EN_BLOCK_RECEIVER_LINK##",
"receiverList": [{
"receiveMailAddr": "customer1@example.com",
"receiveName": "顧客1",
"receiveType": "MRT0"
}, {
"receiveMailAddr": "customer2@example.com",
"receiveName": "顧客2",
"receiveType": "MRT1"
}
],
"userId": "USER",
"statsId": "statsId"
}'
[例2 - テンプレートの使用]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/ad-mail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"templateId": "TEMPLATE1",
"templateParameter": {
"key": "value"
},
"receiverList": [{
"receiveMailAddr": "customer1@example.com",
"receiveName": "顧客1",
"receiveType": "MRT0"
}, {
"receiveMailAddr": "customer2@example.com",
"receiveName": "顧客2",
"receiveType": "MRT1"
}
],
"userId": "USER",
"statsId": "statsId"
}'
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/sender/ad-eachMail |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[例1]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/ad-eachMail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"senderAddress": "support@example.com",
"senderName": "送信者名",
"title": "(広告)サンプルタイトル",
"body": "サンプル内容 <br /> ##BLOCK_RECEIVER_LINK## <br />##EN_BLOCK_RECEIVER_LINK##",
"attachFileIdList": [1, 2],
"receiverList": [{
"receiveMailAddr": "customer1@example.com",
"receiveName": "顧客1"
}
],
"userId": "USER",
"statsId": "statsId"
}'
[例2 - テンプレートの使用]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/ad-eachMail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"templateId": "TEMPLATE1",
"receiverList": [{
"receiveMailAddr": "customer1@example.com",
"receiveName": "顧客1",
"templateParameter": {
"key": "value"
}
}
],
"userId": "USER",
"statsId": "statsId"
}'
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/sender/auth-mail |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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 |
statsId | String | X | 統計ID(発信検索条件には含まれません) |
[注意]
認証メールの性格上、次のように異なる特性があります。
[例1]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/auth-mail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"senderAddress": "support@example.com",
"senderName": "送信者名",
"title": "サンプルタイトル",
"body": "サンプル内容",
"receiver": {
"receiveMailAddr": "customer1@example.com",
"receiveName": "顧客1"
},
"userId": "USER",
"statsId": "statsId"
}'
[例2 - テンプレートの使用]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/auth-mail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"templateId": "TEMPLATE1",
"receiver": {
"receiveMailAddr": "customer1@example.com",
"receiveName": "顧客1",
"templateParameter": {
"key": "value"
}
},
"userId": "USER",
"statsId": "statsId"
}'
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"data": {
"requestId": "20190101000000ABCDEFG0",
"results": [
{
"receiveMailAddr": "receiver@nhn.com",
"receiveName": "receiver",
"receiveType": "MRT0",
"resultCode": 0,
"resultMessage": "success"
}
]
}
}
}
値 | タイプ | 説明 |
---|---|---|
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 | 受信者送信リクエスト結果メッセージ |
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/sender/tagMail |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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 |
adYn | String | X | 広告かどうか(default 'N') |
autoSendYn | String | X | 自動送信かどうか(default 'Y') |
attachFileIdList | List:Integer | X | 添付ファイルリスト |
tagExpression | List:String | O | タグ表現式 (タグID含む) |
customHeaders | Map | X | ユーザー指定ヘッダ |
userId | String | X | 送信セパレータ ex)admin,system |
statsId | String | X | 統計ID(発信検索条件には含まれません) |
[注意]
[例1]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/tagMail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"senderAddress": "support@example.com",
"senderName": "送信者名",
"title": "サンプルタイトル",
"body": "サンプル内容",
"attachFileIdList": [1, 2],
"tagExpression": ["tag1", "AND", "tag2"],
"userId": "USER",
"statsId": "statsId"
}'
[例2 - テンプレートの使用]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/tagMail' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"templateId": "TEMPLATE1",
"tagExpression": ["tag1", "AND", "tag2"],
"userId": "USER",
"statsId": "statsId"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20190101000000ABCDEFG0"
}
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- data | Object | データ領域 |
-- requestId | String | リクエストID |
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/attachfile/binaryUpload |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Request body]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
fileName | String | O | ファイル名 |
fileBody | Byte[] | O | ファイルのByte[]値 |
createUser | String | X | ファイルアップロードユーザー情報 |
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/attachfile/binaryUpload' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-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 | ファイル名 |
* title:##title_name##さん、こんにちは!
* body:##body_content## 送信します。
->
* title:クラウド顧客1さん、こんにちは!
* body:test2送信します。
* 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/v2.1/appKeys/{appKey}/sender/mails |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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) |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/mails?startSendDate='"${START_DATE}"'&endSendDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"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",
"dsnCode": "2.5.0",
"dsnMessage": "SUCCESS",
"statsId": "statsId"
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
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 | 発信者グループキー |
-- dsnCode | String | DSN(Delivery Status Notification) ステータスコード |
-- dsnMessage | String | DSN(Delivery Status Notification) ステータスメッセージ |
-- statsId | String | 統計データグルーピングのためのキー |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/sender/mail/{requestId}/{mailSeq} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
requestId | String | リクエストID |
mailSeq | Integer | メールの順番 |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/mail/'"${REQUEST_ID}"'/'"${MAIL_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"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",
"dsnCode": "2.5.0",
"dsnMessage": "SUCCESS"
}
],
"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",
"statsId": "statsId"
}
}
}
値 | タイプ | 説明 |
---|---|---|
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 | 開封日時 |
--- dsnCode | String | DSN(Delivery Status Notification) ステータスコード |
--- dsnMessage | String | DSN(Delivery Status Notification) ステータスメッセージ |
-- attachFileList | List | 添付ファイルリスト |
--- fileType | String | 添付ファイルタイプ MAIL: メールに添付されたファイル、TEMPLATE:テンプレートに添付されたファイル |
--- fileId | Integer | ファイルID |
--- fileName | String | 添付ファイル名 |
--- filePath | String | 添付ファイルパス |
--- fileSize | Integer | 添付ファイルサイズ(byte) |
--- createDate | String | 作成日時 |
-- customHeaders | Map | ユーザー指定ヘッダ |
-- senderGroupingKey | String | 発信者グループキー |
-- statsId | String | 統計データグルーピングのためのキー |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/mass-mails |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
requestId | String | O | リクエストID |
startSendDate | String | O | 送信日開始値(yyyy-MM-dd HH:mm:ss) |
endSendDate | String | O | 送信日終了値(yyyy-MM-dd HH:mm:ss) |
senderMail | String | X | 送信メールアドレス |
senderName | String | X | 送信者名 |
templateId | String | X | テンプレートID |
sendStatus | String | X | 送信ステータスコード WAIT:待機、 READY:送信準備、 SENDREADY:送信準備完了、 SENDWAIT:送信待機、 SENDING:送信中、 COMPLETE:送信完了、 FAIL:送信失敗、 CANCEL:送信キャンセル |
pageNum | Integer | X | ページ番号1(デフォルト値) |
pageSize | Integer | X | 照会件数15(デフォルト値) |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/mass-mails?startSendDate='"${START_DATE}"'&endSendDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header":{
"isSuccessful":true,
"resultCode":0,
"resultMessage":"SUCCESS"
},
"body":{
"pageNum":1,
"pageSize":15,
"totalCount":1,
"data":[
{
"requestId":"202108061843001hIOqv82",
"requestDate":"2021-08-06 18:43:00",
"sendStatus":"COMPLETE",
"sendStatusName":"送信完了",
"templateId":"templateId",
"templateName":"templateName",
"senderName":"NHN Cloud",
"senderAddress":"email@nhncloud.com",
"title":"title",
"body":"body",
"adYn":"N",
"createDate":"2021-08-06 18:43:03",
"updateDate":"2021-08-06 18:43:03",
"statsId": "statsId"
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- pageNum | Integer | 現在のページ番号 |
- pageSize | Integer | 照会されたデータ件数 |
- totalCount | Integer | 総データ件数 |
- data | Object | データ領域 |
-- requestId | String | リクエストID |
-- requestDate | String | リクエスト日時 |
-- sendStatus | String | 送信ステータスコード WAIT:待機、 READY:送信準備、 SENDREADY:送信準備完了、 SENDWAIT:送信待機、 SENDING:送信中、 COMPLETE:送信完了、 FAIL:送信失敗、 CANCEL:送信キャンセル |
-- sendStatusName | String | 送信ステータス名 |
-- templateId | String | テンプレートID |
-- templateName | String | テンプレート名 |
-- senderName | String | 送信者名 |
-- senderAddress | String | 送信者メールアドレス |
-- title | String | メールタイトル |
-- body | String | メール内容 |
-- adYn | String | 広告かどうか |
-- createDate | String | 作成日時 |
-- updateDate | String | 修正日時 |
-- statsId | String | 統計データグルーピングのためのキー |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/mass-mails/{requestId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
requestId | String | リクエストID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
receiveMailAddr | String | X | 受信メールアドレス |
startReceiveDate | String | X | 受信日開始値(yyyy-MM-dd HH:mm:ss) |
endReceiveDate | String | X | 受信日終了値(yyyy-MM-dd HH:mm:ss) |
mailStatusCode | String | X | 送信ステータスコード SST0:送信準備、 SST1:送信中、 SST2:送信完了、 SST3:送信失敗、 SST7: 未認証 |
pageNum | Integer | X | ページ番号1(デフォルト値) |
pageSize | Integer | X | 照会件数15(デフォルト値) |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/mass-mails/'"${REQUEST_ID}"'?startSendDate='"${START_DATE}"'&endSendDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header":{
"isSuccessful":true,
"resultCode":0,
"resultMessage":"SUCCESS"
},
"body":{
"pageNum":1,
"pageSize":15,
"totalCount":1,
"data":[
{
"requestId":"20210806120100sA3CcWU2",
"mailSeq":1,
"mailStatusCode":"SST2",
"mailStatusName":"送信完了",
"resultId":"<20210806120100sA3CcWU2@tcmmsapp-92a901>",
"receiveType":"MRT0",
"receiveTypeName":"受信者",
"receiveName":"name",
"receiveMailAddr":"email@nhncloud.com",
"isReceived":true,
"resultDate":"2021-08-06 13:02:00",
"isOpened":true,
"openedDate":"2021-08-06 12:34:30",
"dsnCode":"2.5.0",
"dsnMessage":"SUCCESS",
"createDate":"2021-08-06 12:01:41",
"updateDate":"2021-08-06 12:02:00",
"statsId": "statsId"
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- pageNum | Integer | 現在のページ番号 |
-pageSize | Integer | 照会されたデータ件数 |
- totalCount | Integer | 総データ件数 |
- data | List | データ領域 |
-- requestId | String | リクエストID |
-- mailSeq | Integer | メール順番 |
-- mailStatusCode | String | メールステータスコード SST0:送信準備、 SST1:送信中、 SST2:送信完了、 SST3:送信失敗、 SST7: 未認証 |
-- mailStatusName | String | メール状態名 |
-- resultId | String | SMTP ID |
-- receiveType | String | 受信者タイプ MRT0 : 受信者 , MRT1 :CC、 MRT2 : BCC |
-- receiveTypeName | String | 受信者タイプ 名 |
-- receiveName | String | 受信者名 |
-- receiveMailAddr | String | 受信者メールアドレス |
-- isReceived | Boolean | 受信したかどうか |
-- resultDate | String | 受信日時 |
-- isOpened | Boolean | 既読かどうか |
-- openedDate | String | 既読日時 |
-- dsnCode | String | DSN(Delivery Status Notification)ステータスコード |
-- dsnMessage | String | DSN(Delivery Status Notification)状態メッセージ |
-- createDate | String | 作成日時 |
-- updateDate | String | 修正日時 |
-- statsId | String | 統計データグルーピングのためのキー |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/mass-mails/{requestId}/{mailSeq} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
requestId | String | リクエストID |
mailSeq | Integer | メール順番 |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/mass-mails/'"${REQUEST_ID}"'/'"${MAIL_SEQ}"' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header":{
"isSuccessful":true,
"resultCode":0,
"resultMessage":"SUCCESS"
},
"body":{
"data":{
"requestId":"20210806123100Q60Z9I72",
"templateId":"test",
"templateName":"3443423",
"mailStatusCode":"SST2",
"mailStatusName":"送信完了",
"requestDate":"2021-08-06 12:31:00",
"senderName":"name",
"senderAddress":"email@nhncloud.com",
"resultId":"<20210806123100Q60Z9I72@tcmmsapp-92a901>",
"resultDate":"2021-08-06 12:34:30",
"title":"test",
"body":"test",
"customHeaders":null,
"receiverList":[
{
"requestId":"20210806123100Q60Z9I72",
"mailSeq":"1",
"receiveType":"MRT0",
"receiveTypeName":"受信者",
"receiveMailAddr":"email@nhncloud.com",
"isReceived":true,
"resultDate":"2021-08-06 12:34:30",
"isOpened":true,
"openedDate":"2021-08-06 12:34:30",
"dsnCode":"2.5.0",
"dsnMessage":"SUCCESS"
}
],
"attachFileList":[
{
"fileType":"TEMPLATE",
"fileId":38915,
"fileName":"file",
"filePath":"1014535/toast-mt-2021-08-06/1229/38915",
"fileSize":1679,
"createDate":"2021-08-06 12:29:14"
}
],
"statsId": "statsId"
}
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- data | List | データ領域 |
-- requestId | String | リクエストID |
-- templateId | String | テンプレートID |
-- templateName | String | テンプレート名 |
-- mailStatusCode | String | メールステータスコード SST0:送信準備、 SST1:送信中、 SST2:送信完了、 SST3:送信失敗、 SST7: 未認証 |
-- mailStatusName | String | メール状態名 |
-- requestDate | String | リクエスト時間 |
-- senderName | String | 送信者名 |
-- senderAddress | String | 送信者アドレス |
-- resultId | String | SMTP ID |
-- resultDate | String | 実際の送信時間 |
-- title | String | タイトル |
-- body | String | 内容 |
-- customHeaders | Map | ユーザー指定ヘッダ |
-- receiverList | List | 受信者リスト |
--- requestId | String | リクエストID |
--- mailSeq | Integer | メールの順番 |
--- receiveType | String | 受信者タイプ(MRT0 : 受信者 , MRT1 :CC、 MRT2 : BCC) |
--- receiveTypeName | String | 受信者タイプ名 |
--- receiveMailAddr | String | 受信者メールアドレス |
--- isReceived | Boolean | 受信したかどうか |
--- resultDate | String | 受信日時 |
--- isOpened | Boolean | 既読かどうか |
--- openedDate | String | 既読日時 |
--- dsnCode | String | DSN(Delivery Status Notification)ステータスコード |
--- dsnMessage | String | DSN(Delivery Status Notification)状態メッセージ |
-- attachFileList | List | 添付ファイルリスト |
--- fileType | String | 添付ファイルタイプ(MAIL:メールに添付されたファイル、 TEMPLATE:テンプレートに添付されたファイル) |
--- fileId | Integer | ファイルID |
--- fileName | String | 添付ファイルの名前 |
--- filePath | String | 添付ファイルのパス |
--- fileSize | Integer | 添付ファイルのサイズ(byte) |
--- createDate | String | 作成日時 |
-- statsId | String | 統計データグルーピングのためのキー |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/tagMails |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
requestId | String | O | リクエストID |
startSendDate | String | O | 送信日の開始値(yyyy-MM-dd HH:mm:ss) |
endSendDate | String | O | 送信日終了値(yyyy-MM-dd HH:mm:ss) |
senderMail | String | X | 送信メールアドレス |
senderName | String | X | 送信者名 |
templateId | String | X | テンプレートID |
sendStatus | String | X | 送信ステータスコード WAIT:待機、READY:送信準備、 SENDREADY:送信準備完了、SENDWAIT:送信待機、 SENDING:送信中、COMPLETE:送信完了、 FAIL:送信失敗、CANCEL:送信取消 |
pageNum | Integer | X | ページ番号(Default:1) |
pageSize | Integer | X | 照会件数(Default:15) |
[注意]
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/tagMails?startSendDate='"${START_DATE}"'&endSendDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"pageNum": Integer,
"pageSize": Integer,
"totalCount": Integer,
"data": [
{
"requestId": String,
"requestIp": String,
"requestDate": String,
"tagSendStatus": String,
"tagExpression": List:String,
"templateId": String,
"templateName": String,
"senderName": String,
"senderMailAddress": String,
"title": String,
"body": String,
"attachYn": String,
"adYn": String,
"createUser": String,
"createDate": String,
"updateUser": String,
"updateDate": String,
"statsId": String
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- pageNum | Integer | 現在のページ番号 |
-pageSize | Integer | 照会されたデータ件数 |
- totalCount | Integer | 総データ件数 |
- data | List | データ領域 |
-- requestId | String | リクエストID |
-- requestIp | String | リクエストIP |
-- requestDate | String | リクエスト時間 |
-- tagSendStatus | String | 送信ステータスコード WAIT:待機、READY:送信準備、 SENDREADY:送信準備完了、SENDWAIT:送信待機、 SENDING:送信中、COMPLETE:送信完了、 FAIL:送信失敗、CANCEL:送信取消 |
-- tagExpression | List:String | タグ表現式 (タグID含む) |
-- templateId | String | テンプレートID |
-- templateName | String | テンプレート名 |
-- senderName | String | 送信者名 |
-- senderMail | String | 送信者のアドレス |
-- title | String | タイトル |
-- body | String | 内容 |
-- attachYn | String | 添付ファイルの有無 |
-- adYn | String | 広告かどうか |
-- createUser | String | 作成者 |
-- createDate | String | 作成日時 |
-- updateUser | String | 修正者 |
-- updateDate | String | 修正日時 |
-- statsId | String | 통계 데이터 그룹핑을 위한 키 |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/tagMails/{requestId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
requestId | String | リクエストID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
receiveMail | String | X | 受信メールアドレス |
startReceiveDate | String | X | 受信日の開始値(yyyy-MM-dd HH:mm:ss) |
endReceiveDate | String | X | 受信日の終了値(yyyy-MM-dd HH:mm:ss) |
receiveStatus | String | X | 送信ステータスコード SST0:送信準備、SST1:送信中 SST2:送信完了、SST3:送信失敗、 SST7:認証なし |
pageNum | Integer | X | ページ番号(Default:1) |
pageSize | Integer | X | 照会件数(Default:15) |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/tagMails/'"${REQUEST_ID}"'?startSendDate='"${START_DATE}"'&endSendDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"pageNum": Integer,
"pageSize": Integer,
"totalCount": Integer,
"data": [
{
"requestId": String,
"mailSequence": Integer,
"receiveMail": String,
"mailStatusCode": String,
"mailStatusName": String,
"resultId": String,
"resultDate": String,
"readYn": String,
"readDate": String,
"dsnCode": String,
"dsnMessage": String,
"createUser": String,
"createDate": String,
"updateUser": String,
"updateDate": String,
"statsId": String
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- pageNum | Integer | 現在のページ番号 |
-pageSize | Integer | 照会されたデータ件数 |
- totalCount | Integer | 総データ件数 |
- data | List | データ領域 |
-- requestId | String | リクエストID |
-- mailSequence | Integer | メールの順番 |
-- receiveMail | String | 受信者のアドレス |
-- mailStatusCode | String | メールステータスコード SST0:送信準備、SST1:送信中、 SST2:送信完了、SST3:送信失敗、 SST7:認証なし |
-- mailStatusName | String | メールのステータス名 |
-- resultId | String | SMTP ID |
-- resultDate | String | 実際の送信時間 |
-- readYn | String | 既読かどうか |
-- readDate | String | 読んだ時間 |
-- dsnCode | String | DSN(Delivery Status Notification) ステータスコード |
-- dsnMessage | String | DSN(Delivery Status Notification) ステータスメッセージ |
-- createUser | String | 作成者 |
-- createDate | String | 作成日時 |
-- updateUser | String | 修正者 |
-- updateDate | String | 修正日時 |
-- statsId | String | 통계 데이터 그룹핑을 위한 키 |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/tagMails/{requestId}/{mailSequence} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
requestId | String | リクエストID |
mailSequence | Integer | メールの順番 |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/tagMails/'"${REQUEST_ID}"'/'"${MAIL_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"data": {
"requestId": String,
"requestIp": String,
"templateId": String,
"templateName": String,
"mailStatusCode": String,
"mailStatusName": String,
"requestDate": String,
"resultDate": String,
"senderName": String,
"senderMail": String",
"resultId": String,
"title": String,
"body": String",
"receivers": [
{
"requestId": String,
"receiveType": String,
"receiveTypeName": String,
"receiveMailAddr": String,
"readYn": String,
"readDate": String,
"dsnCode": String,
"dsnMessage": String,
"mailSequence": String
}
],
"attachFileList": [
{
"fileType": String,
"fileId": Integer,
"fileName": String,
"filePath": String,
"fileSize": Integer,
"createDate": String,
"statsId": String
}
],
"statsId": "statsId"
}
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- pageNum | Integer | 現在のページ番号 |
-pageSize | Integer | 照会されたデータ件数 |
- totalCount | Integer | 総データ件数 |
- data | List | データ領域 |
-- requestId | String | リクエストID |
-- requestIp | String | リクエストIP |
-- templateId | String | テンプレートID |
-- templateName | String | テンプレート名 |
-- mailStatusCode | String | メールステータスコード SST0:送信準備、SST1:送信中、 SST2:送信完了、SST3:送信失敗、 SST7:認証なし |
-- mailStatusName | String | メールのステータス名 |
-- requestDate | String | リクエスト時間 |
-- resultDate | String | 結果時間 |
-- senderName | String | 送信者名 |
-- senderMail | String | 送信者のアドレス |
-- resultId | String | SMTP ID |
-- title | String | タイトル |
-- body | String | 内容 |
-- receivers | List | 受信者リスト |
--- requestId | String | リクエストID |
--- receiveType | String | 受信者タイプ(MRT0:受信者、MRT1:CC、MRT2:BCC) |
--- receiveTypeName | String | 受信者タイプ名 |
--- receiveMailAddr | String | 受信者メールアドレス |
--- readYn | String | 既読かどうか |
--- readDate | String | 読んだ時間 |
--- dsnCode | String | DSN(Delivery Status Notification) ステータスコード |
--- dsnMessage | String | DSN(Delivery Status Notification) ステータスメッセージ |
--- mailSequence | String | メールの順番 |
-- attachFileList | List | 添付ファイルリスト |
--- fileType | String | 添付ファイルタイプ(MAIL:メールに添付されたファイル、TEMPLATE:テンプレートに添付されたファイル) |
--- fileId | Integer | ファイルID |
--- fileName | String | 添付ファイル名 |
--- filePath | String | 添付ファイルパス |
--- fileSize | Integer | 添付ファイルサイズ(byte) |
--- createDate | String | 作成日時 |
-- customHeaders | Map | ユーザー指定ヘッダ |
-- statsId | String | 統計データグルーピングのためのキー |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/sender/reservations |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
requestId | String | X | リクエストID |
startSendDate | String | X | 送信日の開始値(yyyy-MM-dd HH:mm:ss) |
endSendDate | String | X | 送信日の終了値(yyyy-MM-dd HH:mm:ss) |
senderMail | String | X | 送信メールアドレス |
receiveMail | String | X | 受信メールアドレス |
templateId | String | X | テンプレートID |
pageNum | Integer | X | ページ番号(Default:1) |
pageSize | Integer | X | 照会件数(Default:15) |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/reservations' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header":{
"isSuccessful":true,
"resultCode":0,
"resultMessage":"SUCCESS"
},
"body":{
"totalCount":1,
"pageNum": 1,
"pageSize": 15,
"data":[
{
"requestId":"20200605175300tu5z04e1",
"mailSeq":0,
"title":"Title",
"templateId":"TemplateId",
"templateName":"TemplateName",
"senderAddress":"sender@example.com",
"senderName":"senderName",
"receiveMailAddr":"receiver@example.com",
"receiveName":"receiverName",
"receiveType":"MRT0",
"receiveTypeName":"受信者",
"requestDate":"2020-06-05 17:53:00",
"mailStatusCode":"SST4",
"mailStatusName":"予約待機",
"senderGroupingKey":"senderKey",
"statsId": "statsId"
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- pageNum | Integer | 現在のページ番号 |
- pageSize | Integer | 照会されたデータ件数 |
- totalCount | Integer | 総データ件数 |
- data | List | データ領域 |
-- requestId | String | リクエストID |
-- mailSeq | Integer | メールの順番 |
-- title | String | メールのタイトル |
-- templateId | String | テンプレートID |
-- templateName | String | テンプレート名 |
-- senderAddress | String | 送信者のメールアドレス |
-- senderName | String | 送信者名 |
-- receiveMailAddr | String | 受信者のメールアドレス |
-- receiveName | String | 受信者名 |
-- receiveType | String | 受信者タイプ(MRT0:受信者、MRT1:CC、MRT2:BCC) |
-- receiveTypeName | String | 受信者タイプ名 |
-- requestDate | String | 送信日時 |
-- mailStatusCode | String | 送信ステータスコード SST0:送信準備、SST1:送信中 SST2:送信完了、SST3:送信失敗 SST4: 予約待ち、 SST7:認証なし |
-- mailStatusName | String | 送信ステータス名 |
-- senderGroupingKey | String | 送信者グループキー(最大100文字) |
--- statsId | String | 統計データグルーピングのためのキー |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/sender/reservations/{requestId}/{mailSeq} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
requestId | String | リクエストID |
mailSeq | Integer | メールの順番 |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/reservations/'"${REQUEST_ID}"'/'"${MAIL_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header":{
"isSuccessful":true,
"resultCode":0,
"resultMessage":"SUCCESS"
},
"body":{
"data":{
"requestId":"202006050000008j6bx5Q1",
"mailSeq":0,
"title":"Title",
"body":"Body",
"templateId": "TemplateId",
"templateName":"TemplateName",
"senderAddress":"sender@example.com",
"senderName":"senderName",
"requestDate":"2020-06-05 00:00:00",
"mailStatusCode":"SST4",
"mailStatusName":"予約待機",
"receivers":[
{
"requestId":"202006050000008j6bx5Q1",
"mailSeq":0,
"receiveType":"MRT0",
"receiveTypeName":"受信者",
"receiveName":"receiverName",
"receiveMailAddr":"receiver@example.com"
}
],
"attachFileList":[
{
"fileType":"Mail",
"fileId": 123456,
"fileName":"attachement.jpg",
"filePath":"28578/toast-mt-2020-06-03/2344/183037",
"fileSize":8074,
"createDate":"2020-06-03 23:44:27"
}
],
"customHeaders":{
"Content-Type": "text/html"
},
"senderGroupingKey":"senderKey",
"statsId": "statsId"
}
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- data | Object | データ領域 |
-- requestId | String | リクエストID |
-- mailSeq | Integer | メールの順番 |
-- title | String | タイトル |
-- body | String | 内容 |
-- templateId | String | テンプレートID |
-- templateName | String | テンプレート名 |
-- senderAddress | String | 送信者のアドレス |
-- senderName | String | 送信者名 |
-- requestDate | String | リクエスト時間 |
-- mailStatusCode | String | 送信ステータスコード SST0:送信準備、SST1:送信中 SST2:送信完了、SST3:送信失敗 SST4: 予約待ち、 SST7:認証なし |
-- mailStatusName | String | 送信ステータス名 |
-- receiverLis | List | 受信者リスト |
--- requestId | String | リクエストID |
--- mailSeq | Integer | メールの順番 |
--- receiveType | String | 受信者タイプ(MRT0:受信者、MRT1:CC、MRT2:BCC) |
--- receiveName | String | 受信者名 |
--- receiveTypeName | String | 受信者タイプ名 |
--- receiveMailAddr | String | 受信者メールアドレス |
-- attachFileList | List | 添付ファイルリスト |
--- fileType | String | 添付ファイルタイプ MAIL: メールに添付されたファイル、TEMPLATE:テンプレートに添付されたファイル |
--- fileId | Integer | ファイルID |
--- fileName | String | 添付ファイル名 |
--- filePath | String | 添付ファイルパス |
--- fileSize | Integer | 添付ファイルサイズ(byte) |
--- createDate | String | 作成日時 |
-- customHeaders | Map | ユーザー指定ヘッダ |
-- senderGroupingKey | String | 送信者グループキー(最大100文字) |
-- statsId | String | 統計データグルーピングのためのキー |
[URL]
Http method | URI |
---|---|
PUT | /email/v2.1/appKeys/{appKey}/sender/reservations/{requestId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
requestId | String | リクエストID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X PUT \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/reservations/'"${REQUEST_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header" : {
"isSuccessful" : true,
"resultCode" : 0,
"resultMessage" : "SUCCESS"
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
PUT | /email/v2.1/appKeys/{appKey}/sender/reservations/{requestId}/{mailSeq} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
requestId | String | リクエストID |
mailSeq | Integer | メールの順番 |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X PUT \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/reservations/'"${REQUEST_ID}"'/'"${MAIL_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header" : {
"isSuccessful" : true,
"resultCode" : 0,
"resultMessage" : "SUCCESS"
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
PUT | /email/v2.1/appKeys/{appKey}/sender/reservations/search-cancels |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Request body]
{
"searchParameter" : {
"requestId" : "202006051209288SxRXhejd20",
"startSendDate" : "2020-02-01 00:00",
"endSendDate" : "2020-02-01 10:00",
"senderMail" : "sender@example.com",
"receiveMail" : "receiver@example.com",
"templateId" : "templateId"
},
"updateUser" : "UpdateUser"
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
searchParameter.requestId | String | X | リクエストID |
searchParameter.startSendDate | String | O | 送信日の開始値(yyyy-MM-dd HH:mm) |
searchParameter.endSendDate | String | O | 送信日の終了値(yyyy-MM-dd HH:mm) |
searchParameter.senderMail | String | X | 送信者のアドレス |
searchParameter.receiveMail | String | X | 受信者メールアドレス |
searchParameter.templateId | String | X | テンプレートID |
updateUser | String | O | 予約キャンセルリクエスト者 |
curl -X PUT \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/reservations/search-cancels' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
-d '{
"searchParameter": {
"requestId": "202006051209288SxRXhejd20",
"startSendDate": "2020-02-01 00:00",
"endSendDate": "2020-02-01 10:00",
"senderMail": "sender@example.com",
"receiveMail": "receiver@example.com",
"templateId": "templateId"
},
"updateUser": "UpdateUser"
}'
{
"header" : {
"resultCode" : 0,
"resultMessage" : "success",
"isSuccessful" : true
},
"body" : {
"data" : {
"reservationCancelId" : "202006051209288SxRXhejd20",
"requestedDateTime" : "2020-06-05 16:09:24",
"reservationCancelStatus" : "READY"
}
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- data | Object | データ領域 |
-- reservationCancelId | String | 予約キャンセルID |
-- requestedDateTime | String | 予約キャンセルリクエスト時間(yyyy-MM-dd HH:mm:ss) |
-- reservationCancelStatus | String | 予約キャンセル状態 - READY :予約準備 - PROCESSING :予約キャンセル中 - COMPLETED :予約キャンセル完了 - FAILED :予約キャンセル失敗 |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/sender/reservations/search-cancels |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
startRequestedDateTime | String | X | 予約キャンセルリクエスト開始時間(yyyy-MM-dd HH:mm:ss) |
endRequestedDateTime | String | X | 予約キャンセルリクエスト終了時間(yyyy-MM-dd HH:mm:ss) |
reservationCancelId | String | X | 予約キャンセルID |
pageNum | Integer | X | ページ番号(デフォルト値:1) |
pageSize | Integer | X | 照会件数(デフォルト値:15) |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/sender/reservations/search-cancels' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header" : {
"resultCode" : 0,
"resultMessage" : "success",
"isSuccessful" : true
},
"body" : {
"pageNum" : 1,
"pageSize" : 15,
"totalCount" : 1,
"data" : [
{
"reservationCancelId" : "202006051209288SxRXhejd20",
"searchParameter" : {
"serviceId" : 12345,
"requestId" : "2020060asdasd8SxRXhejd20",
"startSendDate" : "2020-06-01 00:00:00",
"endSendDate" : "2020-06-11 00:00:00",
"senderMail" : "sender@example.com",
"receiveMail" : "receiver@example.com",
"templateId" : "templateId",
"sendStatus" : null,
"searchedBySendDate" : true
},
"requestedDateTime" : "2020-06-05 12:09:28",
"completedDateTime" : "2020-06-05 12:16:05",
"reservationCancelStatus" : "COMPLETED",
"totalCount" : 3,
"successCount" : 3,
"createUser" : "tester",
"createdDateTime" : "2020-06-05 12:09:28",
"updatedDateTime" : "2020-06-05 12:16:05"
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- pageNum | Integer | 現在のページ番号 |
- pageSize | Integer | 照会されたデータ件数 |
- totalCount | Integer | 総データ件数 |
- data | List | データ領域 |
-- reservationCancelId | String | 予約キャンセルID |
-- searchParameter | Map |
予約キャンセルリクエストパラメータ |
-- requestedDateTime | String | 予約キャンセルリクエスト時間 |
-- completedDateTime | String | 予約キャンセル完了時間 |
-- reservationCancelStatus | String | 予約キャンセル状態 - READY :予約準備 - PROCESSING :予約キャンセル中 - COMPLETED :予約キャンセル完了 - FAILED :予約キャンセル失敗 |
-- totalCount | Integer | 予約キャンセル対象件数 |
-- successCount | Integer | 予約キャンセル成功件数 |
-- createUser | Integer | 予約キャンセル要求者 |
-- createdDateTime | String | 予約キャンセルリクエスト作成時間 |
-- updatedDateTime | String | 予約キャンセル修正時間 |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/categories |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のアプリケーションキー |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
useYn | String | X | 使用有無Y、N |
categoryParentId | Integer | X | 親カテゴリーID |
pageNum | Integer | X | ページ番号(デフォルト値:1) |
pageSize | Integer | X | 照会件数(デフォルト値:15) |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/categories' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"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/v2.1/appKeys/{appKey}/categories/{categoryId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のアプリケーションキー |
categoryId | String | カテゴリーID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/categories/'"${CATEGORY_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"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/v2.1/appKeys/{appKey}/categories |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のアプリケーションキー |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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 \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/categories'
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-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/v2.1/appKeys/{appKey}/categories/{categoryId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のアプリケーションキー |
categoryId | Integer | カテゴリーID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Request body]
値 | タイプ | 最大文字数 | 必須 | 説明 |
---|---|---|---|---|
categoryName | String | 200 | X | カテゴリー名 |
categoryDesc | String | 1000 | X | カテゴリーの説明 |
useYn | String | 1 | X | 使用有無Y、N |
userId | String | 50 | X | ユーザーID |
curl -X PUT \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/categories/'"${CATEGORY_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"categoryName": "Category",
"categoryDesc": "Top Category",
"useYn": "Y",
"userId": "USER"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
DELETE | /email/v2.1/appKeys/{appKey}/categories/{categoryId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のアプリケーションキー |
categoryId | Integer | カテゴリーID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X DELETE \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/categories/'"${CATEGORY_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/templates |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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 \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/templates' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 1,
"data": [
{
"templateId": "TEMPLATE",
"categoryId": 12345,
"categoryName": "Category",
"templateName": "Template",
"templateDesc": "Template",
"useYn": "Y",
"delYn": "N",
"title": "Title",
"createDate": "2019-01-01 00:00:00.0",
"updateDate": "2019-01-01 00:00:00.0"
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
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/v2.1/appKeys/{appKey}/templates/{templateId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
templateId | String | テンプレートID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/templates/'"${TEMPLATE_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"data": {
"templateId": "TEMPLATE",
"categoryId": 12345,
"categoryName": "Category",
"templateName": "Template",
"templateDesc": "Template",
"useYn": "Y",
"delYn": "N",
"sendMailAddress": "test@nhn.com",
"title": "Title",
"templateType": "DEFAULT",
"body": "Body",
"createDate": "2019-01-01 00:00:00.0",
"updateDate": "2019-01-01 00:00:00.0",
"attachFileList": [
{
"fileType": "TEMPLATE",
"fileId": 12345,
"fileName": "test.csv",
"filePath": "file/path",
"fileSize": 10,
"createDate": "2019-01-01 00:00:00.0"
}
]
}
}
}
値 | タイプ | 説明 |
---|---|---|
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/v2.1/appKeys/{appKey}/templates |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のアプリケーションキー |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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 \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/templates' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"categoryId": 1,
"templateId": "TEAMPLTE_ID",
"templateName": "Name",
"templateDesc": "Description",
"useYn": "Y",
"sendMailAddress": "test@example.com",
"title": "Title",
"templateType": "DEFAULT",
"body": "Body",
"attachFileIdList": [1, 2, 3],
"userId": "USER"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/templates/attachfile/binaryUpload |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のアプリケーションキー |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Request body]
値 | タイプ | 最大文字数 | 必須 | 説明 |
---|---|---|---|---|
fileName | String | 100 | O | ファイル名 |
fileBody | Byte[] | - | O | ファイルのバイト[]値 |
userId | String | 50 | X | ユーザーID |
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/templates/attachfile/binaryUpload' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-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/v2.1/appKeys/{appKey}/templates/{templateId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のアプリケーションキー |
templateId | String | テンプレートID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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 \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/templates/'"${TEMPLATE_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"templateName": "Template Name",
"templateDesc": "Template Description",
"useYn": "Y",
"sendMailAddress": "test@example.com",
"title": "Title",
"templateType": "DEFAULT",
"body": "Body",
"attachFileIdList": [1, 2, 3],
"userId": "USER"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
DELETE | /email/v2.1/appKeys/{appKey}/templates/{templateId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のアプリケーションキー |
templateId | String | テンプレートID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X DELETE \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/templates/'"${TEMPLATE_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/tags |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
pageNum | Integer | X | ページ番号(Default:1) |
pageSize | Integer | X | 照会件数(Default:15) |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/tags' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"pageNum": 1,
"pageSize": 1,
"totalCount": 1,
"data": [
{
"tagId": "ABCD1234",
"tagName": "TAG",
"createdDate": "2019-01-01 00:00:00",
"updatedDate": "2019-01-01 00:00:00"
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- data | List | データ領域 |
-- tagId | String | タグID |
-- tagName | String | タグ名 |
-- createdDate | String | 作成日時 |
-- updatedDate | String | 修正日時 |
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/tags |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Request body]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
tagName | String | O | タグ名 |
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/tags' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"tagName": "API-Guide-Sample"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"tagId": "ABCD1234"
}
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- data | List | データ領域 |
-- tagId | String | タグID |
[URL]
Http method | URI |
---|---|
PUT | /email/v2.1/appKeys/{appKey}/tags/{tagId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
tagId | String | タグID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Request body]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
tagName | String | O | タグ名 |
curl -X PUT \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/tags/'"${TAG_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"tagName": "API-Guide-Sample"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
DELETE | /email/v2.1/appKeys/{appKey}/tags/{tagId} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
tagId | String | タグID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X DELETE \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/tags/'"${TAG_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/uids |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
wheres | List:String | X | 照会条件。英数字、括弧で構成された文字列。括弧は1個、AND、ORは3個まで使用できる。 (例) tagId1,AND,tagId2 |
offsetUid | String | X | offset UID |
offset | Integer | X | offset(Default : 0) |
limit | Integer | X | 照会件数(Default:15) |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/uids' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"uids": [
{
"uid": "UID",
"tags": [
{
"tagId": "ABCD1234",
"tagName": "TAG",
"createdDate": "2019-01-01 00:00:00",
"updatedDate": "2019-01-01 00:00:00"
}
],
"contacts": [
{
"contactType": "EMAIL_ADDRESS",
"contact": "test@nhn.com",
"createdDate": "2019-01-01 00:00:00"
}
]
}
],
"isLast": false,
"totalCount": 5
}
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- data | List | データ領域 |
-- uids | List | UIDリスト |
--- uid | String | UID |
--- tags | List | タグ情報リスト |
---- tagId | String | タグID |
---- tagName | String | タグ名 |
---- createDate | String | タグ作成日時 |
---- updateDate | String | タグ修正日時 |
--- contacts | List | 連絡先リスト |
---- contactType | String | 連絡先タイプ(EMAIL_ADDRESS) |
---- contact | String | 連絡先(メールアドレス)) |
---- createDate | String | 連絡先作成日時 |
-- isLast | Boolean | 最後のリストかどうか |
-- totalCount | Integer | 総データ件数 |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/uids/{uid} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
uid | String | UID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"uid": "UID",
"tags": [
{
"tagId": "ABCD1234",
"tagName": "TAG",
"createdDate": "2019-01-01 00:00:00",
"updatedDate": "2019-01-01 00:00:00"
}
],
"contacts": [
{
"contactType": "EMAIL_ADDRESS",
"contact": "test@nhn.com",
"createdDate": "2019-01-01 00:00:00"
}
]
}
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
body | Object | 本文領域 |
- data | List | データ領域 |
-- uid | String | UID |
-- tags | List | タグ情報リスト |
--- tagId | String | タグID |
--- tagName | String | タグ名 |
--- createDate | String | タグ作成日時 |
--- updateDate | String | タグ修正日時 |
-- contacts | List | 連絡先リスト |
--- contactType | String | 連絡先タイプ |
--- contact | String | 連絡先(メールアドレス) |
--- createDate | String | 連絡先作成日時 |
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/uids |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Request body]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
uid | String | O | UID |
tagIds | List:String | O | タグIDリスト |
contacts | List | O | メールアドレスリスト |
-contactType | String | O | 連絡先タイプ |
-contact | String | O | 連絡先(メールアドレス) |
[注意]
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/uids' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"uids": [{
"uid": "sample-uid",
"tagIds": [],
"contacts": [{
"contactType": "EMAIL_ADDRESS",
"contact": "customer1@example.com"
}
]
}
]
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
DELETE | /email/v2.1/appKeys/{appKey}/uids/{uid} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
uid | String | UID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X DELETE \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
POST | /email/v2.1/appKeys/{appKey}/uids/{uid}/email-addresses |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
uid | String | UID |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Request body]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
emailAddress | String | O | メールアドレス |
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}"'/email-addresses' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"emailAddress": "customer1@example.com"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
DELETE | /email/v2.1/appKeys/{appKey}/uids/{uid}/email-addresses/{emailAddress} |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
uid | String | UID |
emailAddress | String | メールアドレス |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
curl -X DELETE \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}"'/email-addresses/'"${EMAIL_ADDR}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/statistics/view |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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 \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/statistics/view?from='"${FROM}"'&to='"${TO}"'&searchType='"${SEARCH_TYPE}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": [
{
"divisionName": "Tue",
"requestedCount": 1,
"sentCount": 1,
"receivedCount": 1,
"openedCount": 0,
"sentRate": "100.00",
"receivedRate": "100.00",
"openedRate": "0.00"
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
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/v2.1/appKeys/{appKey}/block-receivers |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[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 |
curl -X GET \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/block-receivers' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"totalCount": 1,
"data": [
{
"mailAddress": "block@nhn.com",
"blockDate": "2019-01-01 00:00:00.0"
}
]
}
}
値 | タイプ | 説明 |
---|---|---|
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/v2.1/appKeys/{appKey}/block-receivers |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Request body]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
blockReceiverList | ㅣList | O | 受信拒否リスト |
- mailAddress | String | O | 受信拒否メールアドレス |
- blockDate | String | X | 受信拒否日(yyyy-MM-dd HH:mm:ss) |
curl -X POST \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/block-receivers' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"blockReceiverList": [{
"mailAddress": "customer1@example.com",
"blockDate": "2018-03-01 00:00:00"
}
]
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
PUT | /email/v2.1/appKeys/{appKey}/block-receivers |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Request body]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
deleted | Boolean | O | 受信拒否削除を明示するフィールド |
blockReceiverList | ㅣList | O | 受信拒否リスト |
- mailAddress | String | O | 受信拒否メールアドレス |
curl -X PUT \
'https://email.api.nhncloudservice.com/email/v2.1/appKeys/'"${APP_KEY}"'/block-receivers' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"'' \
-d '{
"deleted": true,
"blockReceiverList": [{
"mailAddress": "customer1@example.com"
}
]
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/stats |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
eventCategory | String | O | イベントのカテゴリー。 MESSAGE |
statisticsType | String | X | 検索された統計データの表現形式。 NORMAL(デフォルト値), MINUTELY, HOURLY, DAILY, BY_DAY |
timeUnit | String | X | 統計データの時間単位。デフォルト値は照会期間に応じて決定、 MINUTES, HOURS, DAYS |
from | String | X | 照会範囲の開始値、最近30日まで(ISO 8601, e.g. YYYY-MM-DDThh:mm:ss.SSSTZD, 2018-04-24T06:00:00.000%2B09:00) |
to | String | X | 照会範囲の終了値、最近30日まで(ISO 8601, e.g. YYYY-MM-DDThh:mm:ss.SSSTZD, 2018-04-24T06:00:00.000%2B09:00) |
extra1s | Array String | X | eventCategoryがMESSAGEの場合、メールタイプでフィルタリング可能。 NORMAL, MASS, TAG, SMTP |
extra2s | Array String | X | eventCategoryがMESSAGEの場合、送信ドメインでフィルタリング可能。 |
extra3s | Array String | X | eventCategoryがMESSAGEの場合、受信ドメインでフィルタリング可能。 |
messageId | String | X | メッセージID |
statsIds | Array String | X | 統計イベントキーID |
templateIds | Array String | X | テンプレートID |
statsCriteria | Array String | X | 合計時の統計基準。設定しない場合はデフォルト値で合計を計算。 EVENT(デフォルト値)、EXTRA_1, EXTRA_2, EXTRA_3, TEMPLATE_ID |
curl -X GET \
https://email.api.nhncloudservice.com/email/v2.1/appkeys/'"${APP_KEY}"'/stats?eventCategory='"${EVENT_CATEGORY}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"stats": [{
"eventDateTime": "2020-08-12T00:00:00.000+09:00",
"events": {
"{statsCriteriaValue}.RECEIVED": 0,
"{statsCriteriaValue}.SENT_FAILED": 0,
"{statsCriteriaValue}.SENT": 0,
"{statsCriteriaValue}.OPENED": 0
}
}]
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
stats | Object | 本文領域 |
- eventDateTime | String | イベント発生時間 |
- events | List | データ領域 |
-- {statsCriteriaValue} | String | {statsCriteriaValue}は照会条件として入力したstatsCriteriaの値です。 |
--- REQUESTED | Integer | リクエスト件数 |
--- SENT | Integer | 送信件数 |
--- SENT_FAILED | Integer | 失敗件数 |
--- RECEIVED | Integer | 成功件数 |
--- OPENED | Integer | 読んだ件数 |
[URL]
Http method | URI |
---|---|
GET | /email/v2.1/appKeys/{appKey}/stats/total |
[Path parameter]
値 | タイプ | 説明 |
---|---|---|
appKey | String | 固有のappKey |
[Header]
{
"X-Secret-Key": String
}
値 | タイプ | 必須 | 説明 |
---|---|---|---|
X-Secret-Key | String | O | 固有のsecretKey [参考] |
[Query parameter]
値 | タイプ | 必須 | 説明 |
---|---|---|---|
eventCategory | String | O | イベントのカテゴリー。 MESSAGE |
statisticsType | String | X | 検索された統計データの表現形式。 NORMAL(デフォルト値), MINUTELY, HOURLY, DAILY, BY_DAY |
timeUnit | String | X | 統計データの時間単位。デフォルト値は照会期間に応じて決定、 MINUTES, HOURS, DAYS |
from | String | X | 照会範囲の開始値、最近30日まで(ISO 8601, e.g. YYYY-MM-DDThh:mm:ss.SSSTZD, 2018-04-24T06:00:00.000%2B09:00) |
to | String | X | 照会範囲の終了値、最近30日まで(ISO 8601, e.g. YYYY-MM-DDThh:mm:ss.SSSTZD, 2018-04-24T06:00:00.000%2B09:00) |
extra1s | Array String | X | eventCategoryがMESSAGEの場合、メールタイプでフィルタリング可能。 NORMAL, MASS, TAG, SMTP |
extra2s | Array String | X | eventCategoryがMESSAGEの場合、送信ドメインでフィルタリング可能。 |
extra3s | Array String | X | eventCategoryがMESSAGEの場合、受信ドメインでフィルタリング可能。 |
messageId | String | X | メッセージID |
statsIds | Array String | X | 統計イベントキーID |
templateIds | Array String | X | テンプレートID |
statsCriteria | Array String | X | 合計時の統計基準。設定しない場合はデフォルト値で合計を計算。 EVENT(デフォルト値)、EXTRA_1, EXTRA_2, EXTRA_3, TEMPLATE_ID |
curl -X GET \
https://email.api.nhncloudservice.com/email/v2.1/appkeys/'"${APP_KEY}"'/stats?eventCategory='"${EVENT_CATEGORY}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: '"${SECRET_KEY}"''
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"total" : {
"SENT" : 120,
"SENT_FAILED" : 50,
"RECEIVED": 0,
"OPENED": 0
}
}
値 | タイプ | 説明 |
---|---|---|
header | Object | ヘッダ領域 |
- isSuccessful | Boolean | 成否 |
- resultCode | Integer | 失敗コード |
- resultMessage | String | 失敗メッセージ |
total | Object | 本文領域 |
- {statsCriteriaValue}.REQUESTED | Integer | リクエスト件数 |
- {statsCriteriaValue}.SENT | Integer | 送信件数 |
- {statsCriteriaValue}.SENT_FAILED | Integer | 失敗件数 |
- {statsCriteriaValue}.RECEIVED | Integer | 成功件数 |
- {statsCriteriaValue}.OPENED | Integer | 読んだ件数 |